test: updated to Xunit v3 and migrated to Shouldly

Author: kieronlanning

Makefile

@@ -1,7 +1,7 @@
 include .build/common.mk
 
 # Variables
-ROOT_FOLDER = src/
+ROOT_FOLDER = ./src/
 SOLUTION_FILE = $(ROOT_FOLDER)Purview.Telemetry.SourceGenerator.sln
 TEST_PROJECT = $(ROOT_FOLDER)Purview.Telemetry.SourceGenerator.sln
 CONFIGURATION = Release

src/Directory.Packages.props

@@ -5,6 +5,8 @@
   </PropertyGroup>
   <ItemGroup Label="NuGet Package References" Condition="$(IsTestProject) == 'false'">
     <PackageVersion Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />
+    <PackageVersion Include="Verify.XunitV3" />
+    <PackageVersion Include="Verify.XunitV3" />
   </ItemGroup>
   <ItemGroup Label=".NET Packages">
     <PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="$(MSCodeAnalysisCSharpVersion)" />
@@ -26,6 +28,6 @@
     <PackageVersion Include="xunit.analyzers" Version="1.19.0" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="3.0.1" />
     <PackageVersion Include="Verify.SourceGenerators" Version="2.5.0" />
-    <PackageVersion Include="Verify.Xunit" Version="28.9.0" />
+    <PackageVersion Include="Verify.Xunitv3" Version="28.9.0" />
   </ItemGroup>
 </Project>

src/Purview.Telemetry.SourceGenerator.IntegrationTests/Activities/TelemetrySourceGeneratorActivityTests.cs

@@ -1,6 +1,4 @@
-using Xunit.Abstractions;
-
-namespace Purview.Telemetry.SourceGenerator.Activities;
+namespace Purview.Telemetry.SourceGenerator.Activities;
 
 public partial class TelemetrySourceGeneratorActivityTests(ITestOutputHelper testOutputHelper) : IncrementalSourceGeneratorTestBase<TelemetrySourceGenerator>(testOutputHelper)
 {

src/Purview.Telemetry.SourceGenerator.IntegrationTests/Logging/TelemetrySourceGeneratorLoggingTests.cs

@@ -1,6 +1,4 @@
-using Xunit.Abstractions;
-
-namespace Purview.Telemetry.SourceGenerator.Logging;
+namespace Purview.Telemetry.SourceGenerator.Logging;
 
 public partial class TelemetrySourceGeneratorLoggingTests(ITestOutputHelper testOutputHelper) : IncrementalSourceGeneratorTestBase<TelemetrySourceGenerator>(testOutputHelper)
 {

src/Purview.Telemetry.SourceGenerator.IntegrationTests/Metrics/TelemetrySourceGeneratorMetricsTests.cs

@@ -1,6 +1,4 @@
-using Xunit.Abstractions;
-
-namespace Purview.Telemetry.SourceGenerator.Metrics;
+namespace Purview.Telemetry.SourceGenerator.Metrics;
 
 public partial class TelemetrySourceGeneratorMetricsTests(ITestOutputHelper testOutputHelper) : IncrementalSourceGeneratorTestBase<TelemetrySourceGenerator>(testOutputHelper)
 {

src/Purview.Telemetry.SourceGenerator.IntegrationTests/Purview.Telemetry.SourceGenerator.IntegrationTests.csproj

@@ -21,15 +21,7 @@
 		<PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" />
 		<PackageReference Include="Microsoft.Extensions.Logging" />
 		<PackageReference Include="Microsoft.Extensions.DependencyInjection" />
-		<PackageReference Include="Verify.Xunit" />
 		<PackageReference Include="Verify.SourceGenerators" />
-		<PackageReference Update="xunit.analyzers">
-			<PrivateAssets>all</PrivateAssets>
-			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-		</PackageReference>
-		<PackageReference Update="xunit.runner.visualstudio">
-			<PrivateAssets>all</PrivateAssets>
-			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-		</PackageReference>
+		<PackageReference Include="Verify.Xunitv3" />
 	</ItemGroup>
 </Project>

src/Purview.Telemetry.SourceGenerator.IntegrationTests/SourceGeneratorTestBase.cs

@@ -3,7 +3,6 @@
 using Microsoft.CodeAnalysis.Diagnostics;
 using Purview.Telemetry.SourceGenerator.BuildTools;
 using Purview.Telemetry.SourceGenerator.Helpers;
-using Xunit.Abstractions;
 
 namespace Purview.Telemetry.SourceGenerator;
 
@@ -68,7 +67,7 @@ protected void ConfigureGenerator(object generator)
 				testOutputHelper.WriteLine($"{prefix}: {message}");
 
 				if (ThrowOnLoggedOnError)
-					outputType.Should().NotBe(OutputType.Error, message);
+					outputType.ShouldNotBe(OutputType.Error, message);
 			});
 		}
 	}
@@ -80,10 +79,10 @@ protected static AdditionalText Text(string path, string content, bool autoInclu
 		=> new InMemoryAdditionalText(path, (autoIncludeUsings ? TestHelpers.DefaultUsingSet : "") + content);
 
 	protected static AdditionalText[] Texts(params (string path, string content)[] pairs)
-		=> pairs.Select(pair => new InMemoryAdditionalText(pair.path, pair.content)).ToArray();
+		=> [.. pairs.Select(pair => new InMemoryAdditionalText(pair.path, pair.content))];
 
 	protected static AdditionalText[] Texts(params (string path, string content, (string key, string value)[]? options)[] pairs)
-		=> pairs.Select(pair => new InMemoryAdditionalText(pair.path, pair.content, pair.options)).ToArray();
+		=> [.. pairs.Select(pair => new InMemoryAdditionalText(pair.path, pair.content, pair.options))];
 
 	protected static ImmutableDictionary<string, string> Options(params (string key, string value)[] pairs)
 		=> pairs.ToImmutableDictionary(pair => pair.key, pair => pair.value);
@@ -106,7 +105,7 @@ protected Type GetType(GenerationResult result, string typeName)
 	{
 		var assembly = GetAssembly(result);
 
-		return assembly.GetType(typeName, true).Should().NotBeNull().And.Subject;
+		return assembly.GetType(typeName, true).ShouldNotBeNull();
 	}
 
 	protected Assembly GetAssembly(GenerationResult result)
@@ -118,8 +117,8 @@ protected Assembly GetAssembly(GenerationResult result)
 		using (var stream = new MemoryStream())
 		{
 			var emitResult = result.Compilation.Emit(stream);
-			emitResult.Should().NotBeNull();
-			emitResult.Success.Should().BeTrue(string.Join("\n", emitResult.Diagnostics));
+			emitResult.ShouldNotBeNull();
+			emitResult.Success.ShouldBeTrue(string.Join("\n", emitResult.Diagnostics));
 
 			assembly = Assembly.Load(stream.GetBuffer());
 		}
@@ -206,8 +205,7 @@ protected async Task<GenerationResult> GenerateAsync(
 		runResult.Results
 			.Where(m => m.Exception != null)
 			.Select(m => m.Exception)
-			.Should()
-			.BeEmpty();
+			.ShouldBeEmpty();
 
 		return new(runResult, diagnostics, outputCompilation);
 	}

src/Purview.Telemetry.SourceGenerator.IntegrationTests/TelemetrySourceGeneratorTests.cs

@@ -1,6 +1,4 @@
-using Xunit.Abstractions;
-
-namespace Purview.Telemetry.SourceGenerator;
+namespace Purview.Telemetry.SourceGenerator;
 
 public partial class TelemetrySourceGeneratorTests(ITestOutputHelper testOutputHelper) : IncrementalSourceGeneratorTestBase<TelemetrySourceGenerator>(testOutputHelper)
 {

src/Purview.Telemetry.SourceGenerator.IntegrationTests/TestHelpers.cs

@@ -187,9 +187,9 @@ public static async Task Verify(GenerationResult generationResult,
 			diag = diag.Where(m => m.Severity == DiagnosticSeverity.Error);
 
 		if (validateNonEmptyDiagnostics)
-			diag.Should().NotBeEmpty();
+			diag.ShouldNotBeEmpty();
 		else
-			diag.Should().BeEmpty();
+			diag.ShouldBeEmpty();
 
 		if (!validationCompilation)
 			return;
@@ -206,8 +206,7 @@ public static async Task Verify(GenerationResult generationResult,
 			result
 				.Diagnostics
 				.Where(m => !m.Id.StartsWith("TSG", StringComparison.Ordinal))
-				.Should()
-				.BeEmpty(string.Join(Environment.NewLine, result.Diagnostics.Select(d => d.ToString() + Environment.NewLine + "-----------------------------------------------------")));
+				.ShouldBeEmpty(string.Join(Environment.NewLine, result.Diagnostics.Select(d => d.ToString() + Environment.NewLine + "-----------------------------------------------------")));
 		}
 	}
 }