chore: Add xUnit.net v3 tests (#1430)

TheConstructor · HofmeisterAn · web-flow · commit d0538371d015 · 2025-04-27T11:06:21.000+02:00
Co-authored-by: Andre Hofmeister &lt;9199345+HofmeisterAn@users.noreply.github.com&gt;
diff --git a/.github/workflows/cicd.yml b/.github/workflows/cicd.yml
@@ -91,7 +91,8 @@ jobs:
           { name: "Testcontainers.Sftp", runs-on: "ubuntu-22.04" },
           { name: "Testcontainers.Weaviate", runs-on: "ubuntu-22.04" },
           { name: "Testcontainers.WebDriver", runs-on: "ubuntu-22.04" },
-          { name: "Testcontainers.Xunit", runs-on: "ubuntu-22.04" }
+          { name: "Testcontainers.Xunit", runs-on: "ubuntu-22.04" },
+          { name: "Testcontainers.XunitV3", runs-on: "ubuntu-22.04" }
         ]
 
     runs-on: ${{ matrix.test-projects.runs-on }}
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -20,6 +20,7 @@
         <PackageVersion Include="ReflectionMagic" Version="5.0.1"/>
         <PackageVersion Include="xunit.runner.visualstudio" Version="3.0.2"/>
         <PackageVersion Include="xunit" Version="2.9.3"/>
+        <PackageVersion Include="xunit.v3" Version="2.0.1"/>
         <!-- xUnit.net extensibility for Testcontainers.Xunit and Testcontainers.XunitV3 packages: -->
         <PackageVersion Include="xunit.extensibility.execution" Version="2.9.3"/>
         <PackageVersion Include="xunit.v3.extensibility.core" Version="1.1.0"/>
diff --git a/Testcontainers.sln b/Testcontainers.sln
@@ -243,6 +243,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.WebDriver.Te
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Xunit.Tests", "tests\Testcontainers.Xunit.Tests\Testcontainers.Xunit.Tests.csproj", "{E901DF14-6F05-4FC2-825A-3055FAD33561}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.XunitV3.Tests", "tests\Testcontainers.XunitV3.Tests\Testcontainers.XunitV3.Tests.csproj", "{B2E8B7FB-7D1E-4DD3-A25E-34DE4386B1EB}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -709,6 +711,10 @@ Global
 		{E901DF14-6F05-4FC2-825A-3055FAD33561}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{E901DF14-6F05-4FC2-825A-3055FAD33561}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{E901DF14-6F05-4FC2-825A-3055FAD33561}.Release|Any CPU.Build.0 = Release|Any CPU
+		{B2E8B7FB-7D1E-4DD3-A25E-34DE4386B1EB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{B2E8B7FB-7D1E-4DD3-A25E-34DE4386B1EB}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{B2E8B7FB-7D1E-4DD3-A25E-34DE4386B1EB}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{B2E8B7FB-7D1E-4DD3-A25E-34DE4386B1EB}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -829,5 +835,6 @@ Global
 		{EBA72C3B-57D5-43FF-A5B4-3D55B3B6D4C2} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{CB4F241B-EB79-49D5-A45F-050BEE2191B8} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{E901DF14-6F05-4FC2-825A-3055FAD33561} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
+		{B2E8B7FB-7D1E-4DD3-A25E-34DE4386B1EB} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 	EndGlobalSection
 EndGlobal
diff --git a/tests/Testcontainers.Databases.Tests/Testcontainers.Databases.Tests.csproj b/tests/Testcontainers.Databases.Tests/Testcontainers.Databases.Tests.csproj
@@ -12,6 +12,8 @@
     </ItemGroup>
     <ItemGroup>
         <ProjectReference Include="../Testcontainers.*.Tests/Testcontainers.*.Tests.csproj"/>
+        <ProjectReference Remove="../Testcontainers.Xunit.Tests/Testcontainers.Xunit.Tests.csproj"/>
+        <ProjectReference Remove="../Testcontainers.XunitV3.Tests/Testcontainers.XunitV3.Tests.csproj"/>
         <ProjectReference Remove="Testcontainers.Databases.Tests.csproj"/>
     </ItemGroup>
 </Project>
diff --git a/tests/Testcontainers.Xunit.Tests/AlphabeticalTestCaseOrderer.cs b/tests/Testcontainers.Xunit.Tests/AlphabeticalTestCaseOrderer.cs
@@ -2,8 +2,17 @@ namespace Testcontainers.Xunit.Tests;
 
 public class AlphabeticalTestCaseOrderer : ITestCaseOrderer
 {
-    public IEnumerable<TTestCase> OrderTestCases<TTestCase>(IEnumerable<TTestCase> testCases) where TTestCase : ITestCase
+#if XUNIT_V3
+    public IReadOnlyCollection<TTestCase> OrderTestCases<TTestCase>(IReadOnlyCollection<TTestCase> testCases)
+        where TTestCase : notnull, ITestCase
+    {
+        return testCases.OrderBy(testCase => testCase.TestMethod?.MethodName).ToImmutableList();
+    }
+#else
+    public IEnumerable<TTestCase> OrderTestCases<TTestCase>(IEnumerable<TTestCase> testCases)
+        where TTestCase : ITestCase
     {
         return testCases.OrderBy(testCase => testCase.TestMethod.Method.Name);
     }
+#endif
 }
diff --git a/tests/Testcontainers.Xunit.Tests/PostgreSqlContainer.cs b/tests/Testcontainers.Xunit.Tests/PostgreSqlContainer.cs
@@ -46,7 +46,11 @@ public void ImageShouldMatchDefaultModuleImage()
     public async Task Test1()
     {
         const string sql = "SELECT title FROM album ORDER BY album_id";
+#if XUNIT_V3
+        using var connection = await OpenConnectionAsync(TestContext.Current.CancellationToken);
+#else
         using var connection = await OpenConnectionAsync();
+#endif
         var title = await connection.QueryFirstAsync<string>(sql);
         Assert.Equal("For Those About To Rock We Salute You", title);
     }
diff --git a/tests/Testcontainers.Xunit.Tests/RedisContainerTest`1.cs b/tests/Testcontainers.Xunit.Tests/RedisContainerTest`1.cs
@@ -12,7 +12,11 @@ protected override RedisBuilder Configure(RedisBuilder builder)
 }
 // # --8<-- [end:ConfigureRedisContainer]
 
+#if XUNIT_V3
+[TestCaseOrderer(ordererType: typeof(Testcontainers.Xunit.Tests.AlphabeticalTestCaseOrderer))]
+#else
 [TestCaseOrderer(ordererTypeName: "Testcontainers.Xunit.Tests.AlphabeticalTestCaseOrderer", ordererAssemblyName: "Testcontainers.Xunit.Tests")]
+#endif
 public sealed partial class RedisContainerTest
 {
     [Fact]
diff --git a/tests/Testcontainers.Xunit.Tests/RedisContainerTest`2.cs b/tests/Testcontainers.Xunit.Tests/RedisContainerTest`2.cs
@@ -17,7 +17,11 @@ public sealed partial class RedisContainerTest(RedisContainerFixture fixture)
     : IClassFixture<RedisContainerFixture>;
 // # --8<-- [end:InjectContainerFixture]
 
+#if XUNIT_V3
+[TestCaseOrderer(ordererType: typeof(Testcontainers.Xunit.Tests.AlphabeticalTestCaseOrderer))]
+#else
 [TestCaseOrderer(ordererTypeName: "Testcontainers.Xunit.Tests.AlphabeticalTestCaseOrderer", ordererAssemblyName: "Testcontainers.Xunit.Tests")]
+#endif
 public sealed partial class RedisContainerTest
 {
     [Fact]
diff --git a/tests/Testcontainers.Xunit.Tests/Testcontainers.Xunit.Tests.csproj b/tests/Testcontainers.Xunit.Tests/Testcontainers.Xunit.Tests.csproj
@@ -7,15 +7,17 @@
     <ItemGroup>
         <PackageReference Include="Microsoft.NET.Test.Sdk"/>
         <PackageReference Include="coverlet.collector"/>
-        <PackageReference Include="Dapper"/>
         <PackageReference Include="xunit.runner.visualstudio"/>
         <PackageReference Include="xunit"/>
+        <PackageReference Include="Dapper"/>
+        <PackageReference Include="Npgsql"/>
+        <PackageReference Include="StackExchange.Redis"/>
     </ItemGroup>
     <ItemGroup>
         <ProjectReference Include="../../src/Testcontainers.Xunit/Testcontainers.Xunit.csproj"/>
+        <ProjectReference Include="../../src/Testcontainers.PostgreSql/Testcontainers.PostgreSql.csproj"/>
+        <ProjectReference Include="../../src/Testcontainers.Redis/Testcontainers.Redis.csproj"/>
         <ProjectReference Include="../Testcontainers.Commons/Testcontainers.Commons.csproj"/>
-        <ProjectReference Include="../Testcontainers.Redis.Tests/Testcontainers.Redis.Tests.csproj"/>
-        <ProjectReference Include="../Testcontainers.PostgreSql.Tests/Testcontainers.PostgreSql.Tests.csproj"/>
     </ItemGroup>
     <ItemGroup>
         <None Update="Chinook_PostgreSql_AutoIncrementPKs.sql">
diff --git a/tests/Testcontainers.Xunit.Tests/Usings.cs b/tests/Testcontainers.Xunit.Tests/Usings.cs
@@ -1,4 +1,5 @@
 global using System.Collections.Generic;
+global using System.Collections.Immutable;
 global using System.Data.Common;
 global using System.Linq;
 global using System.Threading.Tasks;
@@ -9,5 +10,9 @@
 global using Testcontainers.PostgreSql;
 global using Testcontainers.Redis;
 global using Xunit;
+#if XUNIT_V3
+global using Xunit.v3;
+#else
 global using Xunit.Abstractions;
+#endif
 global using Xunit.Sdk;
diff --git a/tests/Testcontainers.XunitV3.Tests/.editorconfig b/tests/Testcontainers.XunitV3.Tests/.editorconfig
@@ -0,0 +1 @@
+root = true
diff --git a/tests/Testcontainers.XunitV3.Tests/Testcontainers.XunitV3.Tests.csproj b/tests/Testcontainers.XunitV3.Tests/Testcontainers.XunitV3.Tests.csproj
@@ -0,0 +1,32 @@
+<Project Sdk="Microsoft.NET.Sdk">
+    <PropertyGroup>
+        <TargetFrameworks>net9.0</TargetFrameworks>
+        <IsPackable>false</IsPackable>
+        <IsPublishable>false</IsPublishable>
+        <OutputType>Exe</OutputType>
+        <DefineConstants>$(DefineConstants);XUNIT_V3</DefineConstants>
+    </PropertyGroup>
+    <ItemGroup>
+        <PackageReference Include="Microsoft.NET.Test.Sdk"/>
+        <PackageReference Include="coverlet.collector"/>
+        <PackageReference Include="xunit.runner.visualstudio"/>
+        <PackageReference Include="xunit.v3"/>
+        <PackageReference Include="Dapper"/>
+        <PackageReference Include="Npgsql"/>
+        <PackageReference Include="StackExchange.Redis"/>
+    </ItemGroup>
+    <ItemGroup>
+        <ProjectReference Include="../../src/Testcontainers.XunitV3/Testcontainers.XunitV3.csproj"/>
+        <ProjectReference Include="../../src/Testcontainers.PostgreSql/Testcontainers.PostgreSql.csproj"/>
+        <ProjectReference Include="../../src/Testcontainers.Redis/Testcontainers.Redis.csproj"/>
+        <ProjectReference Include="../Testcontainers.Commons/Testcontainers.Commons.csproj"/>
+    </ItemGroup>
+    <ItemGroup>
+        <Compile Include="../Testcontainers.Xunit.Tests/*.cs"/>
+    </ItemGroup>
+    <ItemGroup>
+        <None Include="../Testcontainers.Xunit.Tests/Chinook_PostgreSql_AutoIncrementPKs.sql">
+            <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+        </None>
+    </ItemGroup>
+</Project>

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,8 @@ jobs:`
`91`	`91`	`{ name: "Testcontainers.Sftp", runs-on: "ubuntu-22.04" },`
`92`	`92`	`{ name: "Testcontainers.Weaviate", runs-on: "ubuntu-22.04" },`
`93`	`93`	`{ name: "Testcontainers.WebDriver", runs-on: "ubuntu-22.04" },`
`94`		`- { name: "Testcontainers.Xunit", runs-on: "ubuntu-22.04" }`
	`94`	`+ { name: "Testcontainers.Xunit", runs-on: "ubuntu-22.04" },`
	`95`	`+ { name: "Testcontainers.XunitV3", runs-on: "ubuntu-22.04" }`
`95`	`96`	`]`
`96`	`97`
`97`	`98`	`runs-on: ${{ matrix.test-projects.runs-on }}`
Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,17 @@ namespace Testcontainers.Xunit.Tests;`
`2`	`2`
`3`	`3`	`public class AlphabeticalTestCaseOrderer : ITestCaseOrderer`
`4`	`4`	`{`
`5`		`- public IEnumerable<TTestCase> OrderTestCases<TTestCase>(IEnumerable<TTestCase> testCases) where TTestCase : ITestCase`
	`5`	`+#if XUNIT_V3`
	`6`	`+ public IReadOnlyCollection<TTestCase> OrderTestCases<TTestCase>(IReadOnlyCollection<TTestCase> testCases)`
	`7`	`+ where TTestCase : notnull, ITestCase`
	`8`	`+ {`
	`9`	`+ return testCases.OrderBy(testCase => testCase.TestMethod?.MethodName).ToImmutableList();`
	`10`	`+ }`
	`11`	`+#else`
	`12`	`+ public IEnumerable<TTestCase> OrderTestCases<TTestCase>(IEnumerable<TTestCase> testCases)`
	`13`	`+ where TTestCase : ITestCase`
`6`	`14`	`{`
`7`	`15`	`return testCases.OrderBy(testCase => testCase.TestMethod.Method.Name);`
`8`	`16`	`}`
	`17`	`+#endif`
`9`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,11 @@ public void ImageShouldMatchDefaultModuleImage()`
`46`	`46`	`public async Task Test1()`
`47`	`47`	`{`
`48`	`48`	`const string sql = "SELECT title FROM album ORDER BY album_id";`
	`49`	`+#if XUNIT_V3`
	`50`	`+ using var connection = await OpenConnectionAsync(TestContext.Current.CancellationToken);`
	`51`	`+#else`
`49`	`52`	`using var connection = await OpenConnectionAsync();`
	`53`	`+#endif`
`50`	`54`	`var title = await connection.QueryFirstAsync<string>(sql);`
`51`	`55`	`Assert.Equal("For Those About To Rock We Salute You", title);`
`52`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,11 @@ protected override RedisBuilder Configure(RedisBuilder builder)`
`12`	`12`	`}`
`13`	`13`	`// # --8<-- [end:ConfigureRedisContainer]`
`14`	`14`
	`15`	`+#if XUNIT_V3`
	`16`	`+[TestCaseOrderer(ordererType: typeof(Testcontainers.Xunit.Tests.AlphabeticalTestCaseOrderer))]`
	`17`	`+#else`
`15`	`18`	`[TestCaseOrderer(ordererTypeName: "Testcontainers.Xunit.Tests.AlphabeticalTestCaseOrderer", ordererAssemblyName: "Testcontainers.Xunit.Tests")]`
	`19`	`+#endif`
`16`	`20`	`public sealed partial class RedisContainerTest`
`17`	`21`	`{`
`18`	`22`	`[Fact]`