Integration tests with ASP.NET Core causes missing references from Razor files #1212

BrianVallelunga · 2017-04-12T14:48:48Z

Title

Integration tests with ASP.NET Core causes missing references from Razor files

Functional impact

When attempting to run an integration test against an ASP.NET Core 1.1.1 site using the full .NET Framework, Razor views are unable to resolve references to namespaces like System

Minimal repro steps

Build the attached
IntegrationTestSample.zip
solution.
Run the site and confirm the home index page works
Use the Test Explorer to run the GetHomeReturnsOKAsync test

Expected result

The test should pass with a successful OK response from the server.

Actual result

The test fails with errors such as:

[xUnit.net 00:00:06.8955637] XUnitTestProject1.Tests.GetHomeReturnsOKAsync [FAIL]
[xUnit.net 00:00:06.8973988] Microsoft.AspNetCore.Mvc.Razor.Compilation.CompilationFailedException : One or more compilation failures occurred:
[xUnit.net 00:00:06.8978938] 0q2sc41d.qfp(10,11): error CS0246: The type or namespace name 'System' could not be found (are you missing a using directive or an assembly reference?)
[xUnit.net 00:00:06.8984156] 0q2sc41d.qfp(11,11): error CS0246: The type or namespace name 'System' could not be found (are you missing a using directive or an assembly reference?)
[xUnit.net 00:00:06.8988809] 0q2sc41d.qfp(12,11): error CS0246: The type or namespace name 'System' could not be found (are you missing a using directive or an assembly reference?)
[xUnit.net 00:00:06.8993828] 0q2sc41d.qfp(15,36): error CS0234: The type or namespace name 'ViewFeatures' does not exist in the namespace 'Microsoft.AspNetCore.Mvc' (are you missing an assembly reference?)
[xUnit.net 00:00:06.8998931] 0q2sc41d.qfp(16,11): error CS0246: The type or namespace name 'System' could not be found (are you missing a using directive or an assembly reference?)
[xUnit.net 00:00:06.9003332] 0q2sc41d.qfp(18,86): error CS1980: Cannot define a class or member that utilizes 'dynamic' because the compiler required type 'System.Runtime.CompilerServices.DynamicAttribute' cannot be found. Are you missing a reference?
[xUnit.net 00:00:06.9007670] 0q2sc41d.qfp(18,86): error CS0518: Predefined type 'System.Boolean' is not defined or imported

Further technical details

This seems to be a regression of #755 and aspnet/Mvc#4686

Unlike those other issues, there is no third project involved here. Just the site and test projects.

This was not an issue until we switched to VS 2017 from VS 2015 (with project.json and xproj).

The text was updated successfully, but these errors were encountered:

rynowak · 2017-04-12T14:58:20Z

/cc @pranavkm

BrianVallelunga · 2017-04-24T13:57:56Z

Can anyone reproduce this with the sample I uploaded?

aruss · 2017-04-24T14:13:01Z

Same problem here. With the previous Version it worked as I upgraded to the latest one I can not run integration tests anymore. Also tried your code and it does not work.

hhalim · 2017-04-24T14:23:11Z

@BrianVallelunga I can reproduce using the sample you provided. I also experienced the issue with @using in View not working with referencing dll directly. The dll was created in .net 4.6.1 and my web app is .net core 1.1.1 running in full .net framework in VS2017. I believe this is similar to issue 4686.

BrianVallelunga · 2017-04-24T15:04:52Z

Thanks for the confirmation. Hopefully we can get a workaround soon. This is holding up our move to VS 2017 right now.

NTaylorMullen · 2017-04-24T17:27:34Z

This looks like similar issues we encountered when migrating MVC. Give this a try.

BrianVallelunga · 2017-04-24T17:47:56Z

@NTaylorMullen I tried your suggestion and even manually copied the .deps.json file over to the test project. Unfortunately this did not fix the issue, though I agree that it seems like it could be related.

BrianVallelunga · 2017-04-27T15:23:52Z

Can someone from Microsoft please comment on this?

rynowak · 2017-04-27T16:58:38Z

@pranavkm @NTaylorMullen - any more suggestions here?

rynowak · 2017-04-28T01:50:42Z

@BrianVallelunga - Hi, I tried your project and was able to reproduce the failure, as well as fix it.

These are a few known issues that we've already worked around in our (MVC team) functional tests. We need to do a better job getting this information out there. I've also started a conversation internally about how we can make this much much easier to figure out for simple MVC apps.

Here's the complete project file with the fixes in place:

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>    
    <TargetFramework>net461</TargetFramework>
    <GenerateBindingRedirectsOutputType>true</GenerateBindingRedirectsOutputType>
    <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
    <PreserveCompilationContext>true</PreserveCompilationContext>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.AspNetCore.TestHost" Version="1.1.1" />
    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0" />
    <PackageReference Include="xunit" Version="2.2.0" />
    <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0" />
  </ItemGroup>

  <ItemGroup>
    <ProjectReference Include="..\IntegrationTestSite\IntegrationTestSite.csproj" />
  </ItemGroup>

  <ItemGroup>
    <Service Include="{82a7f48d-3b50-4b1e-b82e-3ada8210c358}" />
  </ItemGroup>
  
  <ItemGroup>
    <None Include="xunit.runner.json" CopyToOutputDirectory="PreserveNewest" />
  </ItemGroup>

  <!--
    Work around https://github.com/NuGet/Home/issues/4412. MVC uses DependencyContext.Load() which looks next to a .dll
    for a .deps.json. Information isn't available elsewhere. Need the .deps.json file for all web site applications.
  -->
  <Target Name="CopyDepsFiles" AfterTargets="Build" Condition="'$(TargetFramework)'!=''">
    <ItemGroup>
      <DepsFilePaths Include="$([System.IO.Path]::ChangeExtension('%(_ResolvedProjectReferencePaths.FullPath)', '.deps.json'))" />
    </ItemGroup>

    <Copy SourceFiles="%(DepsFilePaths.FullPath)" DestinationFolder="$(OutputPath)" Condition="Exists('%(DepsFilePaths.FullPath)')" />
  </Target>
</Project>

You also need to create an xunit.runner.json - that is just configuration for the xunit runner. The only thing we really need is to disable shadow copy so that the tests run from the bin\Debug\net461 directory.

{
  "shadowCopy": false
}

The juicy workaround here is to get the IntegrationTestSite into the build output directory - that's needed in conjunction with disabling shadow copy.

BrianVallelunga · 2017-05-01T16:38:37Z

I can confirm that this fixes my issue in my main codebase. Thank you for the help and I would encourage this information to be publicized. I'm astounded more people haven't run into this.

rynowak · 2017-05-04T15:52:08Z

We've made a decision to productize and harden the integration testing code that MVC is using to bootstrap our functional test websites. This will include validating common issues like the missing deps file. aspnet/Mvc#6233

I'm going to close this issue out.

rynowak · 2017-05-17T22:07:05Z

Closing this issue since we're following up elsewhere

fh-lchen · 2017-08-09T17:58:52Z

I tried the fix and it is still giving me the same error. Can you share the sample project after it is fixed? Thanks!

drauch · 2017-08-09T19:06:15Z

See aspnet/Mvc#6613

…database. Also added black magic fix to make Startup from another project work. See aspnet/Razor#1212 A better way of doing this is coming in the future.

Ciantic · 2017-09-09T16:41:54Z

I think the main problem is that Visual Studio 15.3.3 asp.net core 2.0 xunit template creates a csproj file that is already broken.

E.g. here is what it created in my project:

https://github.com/Ciantic/OksidiCom.AspNetCore/blob/fb11872b9e5ab9a015909dd34a76c737b05fbdce/test/OksidiCom.UserService.Test/OksidiCom.UserService.Test.csproj

And it gives the Razor compilation error in here:

https://github.com/Ciantic/OksidiCom.AspNetCore/blob/fb11872b9e5ab9a015909dd34a76c737b05fbdce/test/OksidiCom.UserService.Test/Tests.cs#L120 (LoginIssuesToken test)

If there is a simple fix by manipulating the csproj, the VS template for xunit test project should include it already.

rynowak · 2017-09-11T14:45:52Z

Hi, it looks like you are posting on a closed issue/PR/commit!

We're very likely to lose track of your bug/feedback/question unless you:

Open a new issue
Explain very clearly what you need help with
If you think you have found a bug, include detailed repro steps so that we can investigate the problem

Thanks!

evil-shrike · 2017-09-25T18:06:24Z

@rynowak
I have the same issue (as many others who try to use TestServer I guess) but the suggested workaround isn't working for me.
I've added the mentioned Target in csproj, created a xunit.runner.json, but still having the following error:
(trimmed output)

Microsoft.AspNetCore.Mvc.Razor.Compilation.CompilationFailedException: 'One or more compilation failures occurred:
ooebhccx.1bd(4,62): error CS0012: The type 'Attribute' is defined in an assembly that is not referenced. You must add a reference to assembly 'netstandard, Version=2.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51'.
ooebhccx.1bd(4,81): error CS0518: Predefined type 'System.String' is not defined or imported
ooebhccx.1bd(4,112): error CS0518: Predefined type 'System.Type' is not defined or imported

The test projects targets netcore2.0. It references Microsoft.AspNetCore.All, Microsoft.AspNetCore.TestHost, and Microsoft.NET.Test.Sdk.

I checked that the output dir (bin\Debug\netcoreapp2.0) contains *.deps.json and xunit.runner.json.

The error happens even for empty views - I have errors even if View's content is just <!doctype html>.

evil-shrike · 2017-09-25T18:44:37Z

Also please note that the issue was closed before .NET Core 2.0 was released. It could makes sense if it was going to be fixed in the upcoming release. But it's not. I'm having it in netcore2.0 rtm:

<PackageReference Include="Microsoft.AspNetCore.All" Version="2.0.0" />
<PackageReference Include="Microsoft.AspNetCore.TestHost" Version="2.0.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.3.0" />

Please reopen the issue.

The mentioned issue aspnet/Mvc#6233 is also closed. So it's pretty unclear what developers are supposed to do or expect.

Here's a demo project - https://github.com/evil-shrike/aspnetcore-tests-bug

pranavkm · 2017-09-25T18:56:56Z

@evil-shrike you'll need to target the Web Sdk (Sdk="Microsoft.NET.Sdk.Web") to get the right kind of information stashed in the deps file. (alternatively you can set <PreserveCompilationContext>true</PreserveCompilationContext>)

evil-shrike · 2017-09-25T20:34:18Z

@pranavkm such a tiny detail :) Setting PreserveCompilationContext has solved the problem. Thanks!
Shouldn't it be mentioned in the doc somewhere?

pranavkm · 2017-09-25T20:41:45Z

@evil-shrike that would help. Would you like to send a PR for it?

evil-shrike · 2017-09-25T21:12:09Z

@pranavkm ok, I'll make a PR.
I'm trying to repeat the minimal number of steps to get it working and found that setting PreserveCompilationContext=true is enough (without adding Target, or xunit.runner.json). Could you confirm that it should be enough?

pranavkm · 2017-09-25T21:28:01Z

Yup, it's definitely the minimum feature to enable to get view compilation working.

bgever · 2017-09-28T08:28:48Z

@rynowak's solution to add the manual step to copy .deps.json files worked for me, and the documented PreserveCompilationContext had no effect.

Details in this SO Q&A: https://stackoverflow.com/questions/46464373/asp-net-core-testserver-results-in-http-500-for-razor-views/46464374

bgever · 2018-02-13T03:33:45Z

Good news, looks like a fix for this is on the ASP.NET Core 2.1 roadmap: (emphasis mine)

Functional testing infrastructure

Writing functional tests for an MVC app allows you to test handling of a request end-to-end including running routing, filters, controllers, actions, views and pages. While writing in-memory functional tests for MVC apps is possible with ASP.NET Core 2.0 it requires significant setup.

For 2.1 we will provide an test fixture implementation that handles the typical pitfalls when trying to test MVC applications using TestServer:

Copy the .deps file from your project into the test assembly bin folder

Specify the content root of the application’s project root so that static files and views can be found

Streamline setting up your app on TestServer

drauch · 2018-02-13T12:15:11Z

@bgever : Optimally the solution will allow shadow copying

pranavkm self-assigned this Apr 27, 2017

pranavkm added the investigate label Apr 27, 2017

This was referenced Apr 28, 2017

Consider adding an xunit.runner.json to xunit projects dotnet/templating#704

Closed

dotnet restore does not capture transitive framework assemblies from project references NuGet/Home#4412

Open

rynowak closed this as completed May 17, 2017

drauch mentioned this issue Aug 1, 2017

Run functional tests (web tests) without disabling shadow copying aspnet/Mvc#6613

Closed

pranavkm mentioned this issue Aug 28, 2017

The type 'Attribute' is defined in an assembly that is not referenced. dotnet/standard#474

Closed

evil-shrike mentioned this issue Sep 25, 2017

Update integration-testing.md dotnet/AspNetCore.Docs#4394

Merged

dustinmoris mentioned this issue Dec 22, 2017

Productize and harden our functional testing infrastructure aspnet/Mvc#6233

Closed

mlorbetske mentioned this issue Jul 13, 2018

Consider adding an xunit.runner.json to xunit projects dotnet/test-templates#2

Closed

ins0mniaque mentioned this issue Sep 12, 2021

Razor View as an input string soundaranbu/Razor.Templating.Core#26

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Integration tests with ASP.NET Core causes missing references from Razor files #1212

Integration tests with ASP.NET Core causes missing references from Razor files #1212

BrianVallelunga commented Apr 12, 2017 •

edited

Loading

rynowak commented Apr 12, 2017

BrianVallelunga commented Apr 24, 2017

aruss commented Apr 24, 2017 •

edited

Loading

hhalim commented Apr 24, 2017

BrianVallelunga commented Apr 24, 2017

NTaylorMullen commented Apr 24, 2017

BrianVallelunga commented Apr 24, 2017

BrianVallelunga commented Apr 27, 2017

rynowak commented Apr 27, 2017

rynowak commented Apr 28, 2017 •

edited

Loading

BrianVallelunga commented May 1, 2017 •

edited

Loading

rynowak commented May 4, 2017

rynowak commented May 17, 2017

fh-lchen commented Aug 9, 2017

drauch commented Aug 9, 2017

Ciantic commented Sep 9, 2017 •

edited

Loading

rynowak commented Sep 11, 2017

evil-shrike commented Sep 25, 2017 •

edited

Loading

evil-shrike commented Sep 25, 2017

pranavkm commented Sep 25, 2017

evil-shrike commented Sep 25, 2017 •

edited

Loading

pranavkm commented Sep 25, 2017

evil-shrike commented Sep 25, 2017

pranavkm commented Sep 25, 2017

bgever commented Sep 28, 2017

bgever commented Feb 13, 2018

Functional testing infrastructure

drauch commented Feb 13, 2018

Integration tests with ASP.NET Core causes missing references from Razor files #1212

Integration tests with ASP.NET Core causes missing references from Razor files #1212

Comments

BrianVallelunga commented Apr 12, 2017 • edited Loading

Title

Functional impact

Minimal repro steps

Expected result

Actual result

Further technical details

rynowak commented Apr 12, 2017

BrianVallelunga commented Apr 24, 2017

aruss commented Apr 24, 2017 • edited Loading

hhalim commented Apr 24, 2017

BrianVallelunga commented Apr 24, 2017

NTaylorMullen commented Apr 24, 2017

BrianVallelunga commented Apr 24, 2017

BrianVallelunga commented Apr 27, 2017

rynowak commented Apr 27, 2017

rynowak commented Apr 28, 2017 • edited Loading

BrianVallelunga commented May 1, 2017 • edited Loading

rynowak commented May 4, 2017

rynowak commented May 17, 2017

fh-lchen commented Aug 9, 2017

drauch commented Aug 9, 2017

Ciantic commented Sep 9, 2017 • edited Loading

rynowak commented Sep 11, 2017

evil-shrike commented Sep 25, 2017 • edited Loading

evil-shrike commented Sep 25, 2017

pranavkm commented Sep 25, 2017

evil-shrike commented Sep 25, 2017 • edited Loading

pranavkm commented Sep 25, 2017

evil-shrike commented Sep 25, 2017

pranavkm commented Sep 25, 2017

bgever commented Sep 28, 2017

bgever commented Feb 13, 2018

Functional testing infrastructure

drauch commented Feb 13, 2018

BrianVallelunga commented Apr 12, 2017 •

edited

Loading

aruss commented Apr 24, 2017 •

edited

Loading

rynowak commented Apr 28, 2017 •

edited

Loading

BrianVallelunga commented May 1, 2017 •

edited

Loading

Ciantic commented Sep 9, 2017 •

edited

Loading

evil-shrike commented Sep 25, 2017 •

edited

Loading

evil-shrike commented Sep 25, 2017 •

edited

Loading