Build Error in Source Generator Test Project with TUnit 0.25.21+

[nandor23]

Issue

I'm encountering a build error in a source generator test project. The source generator uses System.Text.Json, and to make it work, all transitive dependencies of System.Text.Json must be packaged with the source generator.
The problem is most likely something internal to TUnit, since building the project with TUnit 0.25.21 succeeds, but any newer version produces a build error. The build also succeeds with XUnit.

One of the build errors is the following:

0>UaDetector_SourceGenerator_Tests_Tests_HintSourceGeneratorTests_ReportDiagnostic_WhenJsonIsInvalid.g.cs(8,53): 
Error CS0433 : The type 'IAsyncEnumerable<T>' exists in both 'Microsoft.Bcl.AsyncInterfaces, Version=9.0.0.10, 
Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51' and 'System.Runtime, Version=10.0.0.0, Culture=neutral, 
PublicKeyToken=b03f5f7f11d50a3a'

It seems like there is some reference collision in the classes generated by TUnit.

Steps to Reproduce:

1. Clone the UaDetector repository
2. Update TUnit package version from 0.25.21 to the latest version (Central Package Management is used)
3. Navigate to the tests/UaDetector.SourceGenerator.Tests project
4. Build the project

csproj files

UaDetector.SourceGenerator.csproj

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
    <IncludeBuildOutput>false</IncludeBuildOutput>
    <IsRoslynComponent>true</IsRoslynComponent>
    <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
  </PropertyGroup>
  
  <ItemGroup>
    <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" PrivateAssets="All" />
    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" PrivateAssets="All" />
    <PackageReference Include="PolySharp" PrivateAssets="All" />
  </ItemGroup>

  <ItemGroup Label="Package References">
    <PackageReference Include="System.Text.Json" PrivateAssets="All" GeneratePathProperty="true" />
    <PackageReference Include="System.Text.Encodings.Web" PrivateAssets="All" GeneratePathProperty="true" />
    <PackageReference Include="System.Text.Encoding.CodePages" PrivateAssets="All" GeneratePathProperty="true" />
    <PackageReference Include="Microsoft.Bcl.HashCode" PrivateAssets="All" GeneratePathProperty="true" />
    <PackageReference Include="Microsoft.Bcl.AsyncInterfaces" PrivateAssets="All" GeneratePathProperty="true" />
    <PackageReference Include="System.Buffers" PrivateAssets="All" GeneratePathProperty="true" />
    <PackageReference Include="System.Memory" PrivateAssets="All" GeneratePathProperty="true" />
    <PackageReference Include="System.Runtime.CompilerServices.Unsafe" PrivateAssets="All" GeneratePathProperty="true" />
    <PackageReference Include="System.Threading.Tasks.Extensions" PrivateAssets="All" GeneratePathProperty="true" />
    <PackageReference Include="System.Numerics.Vectors" PrivateAssets="All" GeneratePathProperty="true" />
    <PackageReference Include="System.Reflection.Metadata" PrivateAssets="All" GeneratePathProperty="true" />
  </ItemGroup>

  <PropertyGroup>
    <GetTargetPathDependsOn>$(GetTargetPathDependsOn);GetDependencyTargetPaths</GetTargetPathDependsOn>
  </PropertyGroup>

  <Target Name="GetDependencyTargetPaths">
    <ItemGroup>
      <TargetPathWithTargetPlatformMoniker Include="$(PkgSystem_Text_Json)\lib\netstandard2.0\System.Text.Json.dll" IncludeRuntimeDependency="false" />
      <TargetPathWithTargetPlatformMoniker Include="$(PkgSystem_Text_Encodings_Web)\lib\netstandard2.0\System.Text.Encodings.Web.dll" IncludeRuntimeDependency="false" />
      <TargetPathWithTargetPlatformMoniker Include="$(PkgSystem_Text_Encoding_CodePages)\lib\netstandard2.0\System.Text.Encoding.CodePages.dll" IncludeRuntimeDependency="false" />
      <TargetPathWithTargetPlatformMoniker Include="$(PkgMicrosoft_Bcl_HashCode)\lib\netstandard2.0\Microsoft.Bcl.HashCode.dll" IncludeRuntimeDependency="false" />
      <TargetPathWithTargetPlatformMoniker Include="$(PkgMicrosoft_Bcl_AsyncInterfaces)\lib\netstandard2.0\Microsoft.Bcl.AsyncInterfaces.dll" IncludeRuntimeDependency="false" />
      <TargetPathWithTargetPlatformMoniker Include="$(PkgSystem_Buffers)\lib\netstandard2.0\System.Buffers.dll" IncludeRuntimeDependency="false" />
      <TargetPathWithTargetPlatformMoniker Include="$(PkgSystem_Memory)\lib\netstandard2.0\System.Memory.dll" IncludeRuntimeDependency="false" />
      <TargetPathWithTargetPlatformMoniker Include="$(PkgSystem_Runtime_CompilerServices_Unsafe)\lib\netstandard2.0\System.Runtime.CompilerServices.Unsafe.dll" IncludeRuntimeDependency="false" />
      <TargetPathWithTargetPlatformMoniker Include="$(PkgSystem_Threading_Tasks_Extensions)\lib\netstandard2.0\System.Threading.Tasks.Extensions.dll" IncludeRuntimeDependency="false" />
      <TargetPathWithTargetPlatformMoniker Include="$(PkgSystem_Numerics_Vectors)\lib\netstandard2.0\System.Numerics.Vectors.dll" IncludeRuntimeDependency="false" />
      <TargetPathWithTargetPlatformMoniker Include="$(PkgSystem_Reflection_Metadata)\lib\netstandard2.0\System.Reflection.Metadata.dll" IncludeRuntimeDependency="false" />
    </ItemGroup>
  </Target>
</Project>

UaDetector.SourceGenerator.Tests.csproj

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net10.0</TargetFramework>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Analyzer.Testing" />
    <PackageReference Include="Microsoft.CodeAnalysis.CSharp.SourceGenerators.Testing" />
    <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" />
    <PackageReference Include="TUnit" />
    <PackageReference Include="System.Formats.Asn1" />
  </ItemGroup>

  <ItemGroup>
    <ProjectReference Include="..\..\src\UaDetector.SourceGenerator\UaDetector.SourceGenerator.csproj" />
  </ItemGroup>
</Project>

[thomhurst]

Looks like a runtime package version mismatch. You've got runtime V10 and Bcl v9. I'd try syncing these up to the same major version

[thomhurst]

The source generator uses System.Text.Json, and to make it work, all transitive dependencies of System.Text.Json must be packaged with the source generator.

You shouldn't need to bring is custom packages to get the source generator working (apart from maybe Polyfill) - at least I haven't had to. What happens when you remove all those?

[nandor23]

This is not related to a version mismatch. Using v10 of Bcl or targeting net9 in test project produces the same result.

You shouldn't need to bring is custom packages to get the source generator working (apart from maybe Polyfill) - at least I haven't had to. What happens when you remove all those?

Those are transitive packages to make System.Text.Json work in the source generator. They must be packaged: dotnet/sdk#17775

[thomhurst]

Ohhh I completely misread this issue. I thought we were talking about the TUnit source generator! Apologies.

Does putting TUnit in reflection mode fix this?

<PropertyGroup>
    <EnableTUnitSourceGeneration>false</EnableTUnitSourceGeneration>
</PropertyGroup>

And then running with dotnet test -- --reflection

[nandor23]

I am unable to run dotnet test -- --reflection.

With TUnit updated to the latest version I am unable to run dotnet test and dotnet test --. The following error is thrown:

Testing with VSTest target is no longer supported by Microsoft.Testing.Platform on .NET 10 SDK 
and later. If you use dotnet test, you should opt-in to the new dotnet test experience. 
For more information, see https://aka.ms/dotnet-test-mtp-error

I followed the instructions, and applied the config to global.json, but it's not respected.

"test": {
  "runner": "Microsoft.Testing.Platform"
}

Changes can be seen at: nandor23/UaDetector@main...fix/tunit, only TUnit and global.json were updated

[thomhurst]

Hmm - that's an sdk issue. Are you on .net 10 rc2? (it changed between rc1 and rc2)

dotnet run should work.

[nandor23]

I've updated the sdk to .net10 rc2.

And then running with dotnet test -- --reflection

Unfortunately this doesn't work, the error is the same as before.

[thomhurst]

And you added this?

<PropertyGroup>
    <EnableTUnitSourceGeneration>false</EnableTUnitSourceGeneration>
</PropertyGroup>

[thomhurst]

Can you try v0.90.17 ?

[nandor23]

I’ve tried setting EnableTUnitSourceGeneration to both false and true, but it doesn’t work.

Can you try v0.90.17 ?

I tried it, error is the same. I also tested with both net9 and net10

There are 3 type of errors in total:

0>UaDetector_SourceGenerator_Tests_Tests_Analyzers_CombinedRegexAnalyzerTests_ReportDiagnostic_WhenRegexSourceAttributeIsMissing.g.cs(8,53): 
Error CS0433 : The type 'IAsyncEnumerable<T>' exists in both 'Microsoft.Bcl.AsyncInterfaces, Version=9.0.0.10, 
Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51' and 'System.Runtime, Version=10.0.0.0, Culture=neutral, 
PublicKeyToken=b03f5f7f11d50a3a'

0>UaDetector_SourceGenerator_Tests_Tests_Analyzers_CombinedRegexAnalyzerTests_ReportDiagnostic_WhenRegexSourceAttributeIsMissing.g.cs(6,163): 
Error CS0738 : 'UaDetector_SourceGenerator_Tests_Tests_Analyzers_CombinedRegexAnalyzerTests_ReportDiagnostic_WhenRegexSourceAttributeIsMissing_TestSource' 
does not implement interface member 'ITestSource.GetTestsAsync(string, CancellationToken)'. 
'UaDetector_SourceGenerator_Tests_Tests_Analyzers_CombinedRegexAnalyzerTests_ReportDiagnostic_WhenRegexSourceAtt
ributeIsMissing_TestSource.GetTestsAsync(string, CancellationToken)' cannot implement
 'ITestSource.GetTestsAsync(string, CancellationToken)' because it does not have the matching return type of 'IAsyncEnumerable<TestMetadata>'.

0>UaDetector_SourceGenerator_Tests_Tests_Analyzers_CombinedRegexAnalyzerTests_ReportDiagnostic_WhenRegexSourceA
ttributeIsMissing.g.cs(8,180): Error CS0433 : The type 'EnumeratorCancellationAttribute' exists in both 
'Microsoft.Bcl.AsyncInterfaces, Version=9.0.0.10, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51' and 'System.Runtime, 
Version=10.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a'