Migrate to xunit.v3 (OrchardCMS#17250)

sebastienros · web-flow · commit 472378b031e3 · 2025-01-21T14:27:16.000Z
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -5,11 +5,6 @@
     <CentralPackageTransitivePinningEnabled>true</CentralPackageTransitivePinningEnabled>
   </PropertyGroup>
 
-  <PropertyGroup>
-    <!-- Special case - this property is used by a DotNetCliToolReference -->
-    <DotNetXunitVersion>2.3.0</DotNetXunitVersion>
-  </PropertyGroup>
-
   <ItemGroup>
     <PackageVersion Include="AngleSharp" Version="1.2.0" />
     <PackageVersion Include="AWSSDK.S3" Version="3.7.411.5" />
@@ -70,9 +65,9 @@
     <PackageVersion Include="StyleCop.Analyzers" Version="1.1.118" />
     <PackageVersion Include="System.Linq.Async" Version="6.0.1" />
     <PackageVersion Include="System.IO.Hashing" Version="8.0.0" />
-    <PackageVersion Include="xunit" Version="2.9.2" />
-    <PackageVersion Include="xunit.analyzers" Version="1.17.0" />
-    <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.2" />
+    <PackageVersion Include="xunit.v3" Version="1.0.0" />
+    <PackageVersion Include="xunit.analyzers" Version="1.18.0" />
+    <PackageVersion Include="xunit.runner.visualstudio" Version="3.0.0" />
     <PackageVersion Include="YesSql" Version="5.2.0" />
     <PackageVersion Include="YesSql.Abstractions" Version="5.2.0" />
     <PackageVersion Include="YesSql.Core" Version="5.2.0" />
diff --git a/test/OrchardCore.Abstractions.Tests/Modules/Manifest/FeatureAttributeTests.Attribute.cs b/test/OrchardCore.Abstractions.Tests/Modules/Manifest/FeatureAttributeTests.Attribute.cs
@@ -4,7 +4,6 @@
 using System.Linq;
 using System.Reflection;
 using Xunit;
-using Xunit.Abstractions;
 
 namespace OrchardCore.Modules.Manifest;
 
diff --git a/test/OrchardCore.Abstractions.Tests/Modules/Manifest/FeatureAttributeTests.cs b/test/OrchardCore.Abstractions.Tests/Modules/Manifest/FeatureAttributeTests.cs
@@ -1,7 +1,6 @@
 using System;
 using System.Linq;
 using Xunit;
-using Xunit.Abstractions;
 
 namespace OrchardCore.Modules.Manifest;
 
diff --git a/test/OrchardCore.Abstractions.Tests/Modules/Manifest/ModuleAttributeTests.Attribute.cs b/test/OrchardCore.Abstractions.Tests/Modules/Manifest/ModuleAttributeTests.Attribute.cs
@@ -1,7 +1,6 @@
 using System;
 using System.Reflection;
 using Xunit;
-using Xunit.Abstractions;
 
 namespace OrchardCore.Modules.Manifest;
 
diff --git a/test/OrchardCore.Abstractions.Tests/Modules/Manifest/ModuleAttributeTests.cs b/test/OrchardCore.Abstractions.Tests/Modules/Manifest/ModuleAttributeTests.cs
@@ -2,7 +2,6 @@
 using System.Linq;
 using OrchardCore.DisplayManagement.Manifest;
 using Xunit;
-using Xunit.Abstractions;
 
 namespace OrchardCore.Modules.Manifest;
 
diff --git a/test/OrchardCore.Abstractions.Tests/Modules/Manifest/ModuleMarkerAttributeTests.cs b/test/OrchardCore.Abstractions.Tests/Modules/Manifest/ModuleMarkerAttributeTests.cs
@@ -6,7 +6,6 @@
 //namespace OrchardCore.Modules.Manifest
 //{
 //    using Xunit;
-//    using Xunit.Abstractions;
 
 //    /// <inheritdoc/>
 //    public class ModuleMarkerAttributeTests : ModuleAttributeTests<ModuleMarkerAttribute>
diff --git a/test/OrchardCore.Abstractions.Tests/Modules/Manifest/ThemeAttributeTests.cs b/test/OrchardCore.Abstractions.Tests/Modules/Manifest/ThemeAttributeTests.cs
@@ -4,7 +4,6 @@
 using System.Linq;
 using OrchardCore.Modules.Manifest;
 using Xunit;
-using Xunit.Abstractions;
 
 namespace OrchardCore.DisplayManagement.Manifest;
 /// <inheritdoc/>
diff --git a/test/OrchardCore.Abstractions.Tests/OrchardCore.Abstractions.Tests.csproj b/test/OrchardCore.Abstractions.Tests/OrchardCore.Abstractions.Tests.csproj
@@ -3,6 +3,7 @@
   <PropertyGroup>
     <TargetFrameworks>$(CommonTargetFrameworks)</TargetFrameworks>
     <RootNamespace>OrchardCore</RootNamespace>
+    <OutputType>Exe</OutputType>
     <!-- Remove the underscores from member name -->
     <NoWarn>$(NoWarn);CA1707;EnableGenerateDocumentationFile</NoWarn>
   </PropertyGroup>
@@ -18,10 +19,9 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" />
     <PackageReference Include="System.Linq.Async" />
     <PackageReference Include="Moq" />
-    <PackageReference Include="xunit" />
+    <PackageReference Include="xunit.v3" />
     <PackageReference Include="xunit.analyzers" />
     <PackageReference Include="xunit.runner.visualstudio" />
-    <DotNetCliToolReference Include="dotnet-xunit" Version="$(DotNetXunitVersion)" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/test/OrchardCore.Benchmarks/OrchardCore.Benchmarks.csproj b/test/OrchardCore.Benchmarks/OrchardCore.Benchmarks.csproj
@@ -4,6 +4,9 @@
     <TargetFrameworks>$(CommonTargetFrameworks)</TargetFrameworks>
     <RootNamespace>OrchardCore.Benchmark</RootNamespace>
     <IsPackable>false</IsPackable>
+    <GenerateTestingPlatformEntryPoint>false</GenerateTestingPlatformEntryPoint>
+    <IsTestProject>false</IsTestProject>
+    <TestProject>false</TestProject>
     <OutputType>Exe</OutputType>
     <!-- Remove the underscores from member name -->
     <NoWarn>$(NoWarn);CA1707;EnableGenerateDocumentationFile</NoWarn>
diff --git a/test/OrchardCore.Tests/Apis/GraphQL/Blog/BlogPostTests.cs b/test/OrchardCore.Tests/Apis/GraphQL/Blog/BlogPostTests.cs
@@ -207,7 +207,7 @@ public async Task ShouldNotBeAbleToExecuteAnyQueriesWithoutPermission()
 
         await context.InitializeAsync();
 
-        var response = await context.GraphQLClient.Client.GetAsync("api/graphql");
+        var response = await context.GraphQLClient.Client.GetAsync("api/graphql", TestContext.Current.CancellationToken);
         Assert.Equal(HttpStatusCode.Unauthorized, response.StatusCode);
     }
 
diff --git a/test/OrchardCore.Tests/Apis/GraphQL/ContentItemsFieldTypeTests.cs b/test/OrchardCore.Tests/Apis/GraphQL/ContentItemsFieldTypeTests.cs
@@ -29,7 +29,7 @@ public class ContentItemsFieldTypeTests : IAsyncLifetime
     protected string _prefix;
     protected string _tempFilename;
 
-    public async Task InitializeAsync()
+    public async ValueTask InitializeAsync()
     {
         var connectionStringTemplate = @"Data Source={0};Cache=Shared";
 
@@ -61,7 +61,7 @@ public async Task InitializeAsync()
         await CreateTablesAsync(_prefixedStore);
     }
 
-    public Task DisposeAsync()
+    public ValueTask DisposeAsync()
     {
         _store.Dispose();
         _store = null;
@@ -95,7 +95,7 @@ public Task DisposeAsync()
             }
         }
 
-        return Task.CompletedTask;
+        return ValueTask.CompletedTask;
     }
 
     private static async Task CreateTablesAsync(IStore store)
diff --git a/test/OrchardCore.Tests/Apis/Lucene/LuceneQueryTests.cs b/test/OrchardCore.Tests/Apis/Lucene/LuceneQueryTests.cs
@@ -35,7 +35,7 @@ public async Task BoostingTitleShouldHaveTitlesContainingOrchardAppearFirst()
 
         var query = JConvert.SerializeObject(dynamicQuery);
 
-        var content = await context.Client.GetAsync($"api/lucene/content?indexName={index}&query={query}");
+        var content = await context.Client.GetAsync($"api/lucene/content?indexName={index}&query={query}", TestContext.Current.CancellationToken);
         var queryResults = await content.Content.ReadAsAsync<LuceneQueryResults>();
 
         // Test
@@ -70,7 +70,7 @@ public async Task BoostingBodyShouldHaveTitlesNotContainingOrchardAppearFirst()
         };
 
         var query = JConvert.SerializeObject(dynamicQuery);
-        var content = await context.Client.GetAsync($"api/lucene/content?indexName={index}&query={query}");
+        var content = await context.Client.GetAsync($"api/lucene/content?indexName={index}&query={query}", TestContext.Current.CancellationToken);
         var queryResults = await content.Content.ReadAsAsync<LuceneQueryResults>();
 
         // Test
@@ -109,7 +109,7 @@ public async Task SimpleQueryWildcardHasResults()
 
         var query = JConvert.SerializeObject(dynamicQuery);
 
-        var content = await context.Client.GetAsync($"api/lucene/content?indexName={index}&query={query}");
+        var content = await context.Client.GetAsync($"api/lucene/content?indexName={index}&query={query}", TestContext.Current.CancellationToken);
         var queryResults = await content.Content.ReadAsAsync<LuceneQueryResults>();
 
         // Test
@@ -158,7 +158,7 @@ public async Task TwoWildcardQueriesWithBoostHasResults()
                     }
                 }
             """;
-            var content = await context.Client.GetAsync($"api/lucene/content?indexName={index}&query={query}");
+            var content = await context.Client.GetAsync($"api/lucene/content?indexName={index}&query={query}", TestContext.Current.CancellationToken);
             var queryResults = await content.Content.ReadAsAsync<LuceneQueryResults>();
             var contentItems = queryResults.Items.Select(x => JObject.FromObject(x).Deserialize<ContentItem>());
 
@@ -183,7 +183,7 @@ public async Task LuceneQueryTemplateWithSpecialCharactersShouldNotThrowError()
         var index = "ArticleIndex";
         var queryTemplate = "\r\r\n{% assign testVariable = \"48yvsghn194eft8axztaves25h\" %}\n\n{\n  \"query\": {\n    \"bool\": {\n      \"must\": [\n        { \"term\" : { \"Content.ContentItem.ContentType\" : \"Article\" } },\n        { \"term\": { \"Content.ContentItem.Published\" : \"true\" } },\n      ]\n    }\n  }\n}";
 
-        var content = await context.Client.GetAsync($"api/lucene/content?indexName={index}&query={queryTemplate}");
+        var content = await context.Client.GetAsync($"api/lucene/content?indexName={index}&query={queryTemplate}", TestContext.Current.CancellationToken);
         var queryResults = await content.Content.ReadAsAsync<LuceneQueryResults>();
 
         // Assert
diff --git a/test/OrchardCore.Tests/CIFact.cs b/test/OrchardCore.Tests/CIFact.cs
@@ -1,10 +1,21 @@
+using Xunit.v3;
 using SystemEnvironment = System.Environment;
 
+#nullable enable
+
 namespace OrchardCore.Tests;
 
-public class CIFactAttribute : FactAttribute
+[AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]
+public class CIFactAttribute : Attribute, IFactAttribute
 {
-    public override string Skip
+    /// <inheritdoc/>
+    public string? DisplayName { get; set; }
+
+    /// <inheritdoc/>
+    public bool Explicit { get; set; }
+
+    /// <inheritdoc/>
+    public string? Skip
     {
         get
         {
@@ -19,4 +30,16 @@ public override string Skip
             return null!;
         }
     }
+
+    /// <inheritdoc/>
+    public Type? SkipType { get; set; }
+
+    /// <inheritdoc/>
+    public string? SkipUnless { get; set; }
+
+    /// <inheritdoc/>
+    public string? SkipWhen { get; set; }
+
+    /// <inheritdoc/>
+    public int Timeout { get; set; }
 }
diff --git a/test/OrchardCore.Tests/Modules/OrchardCore.OpenId/ApplicationControllerTests.cs b/test/OrchardCore.Tests/Modules/OrchardCore.OpenId/ApplicationControllerTests.cs
@@ -33,7 +33,9 @@ public async Task UsersShouldBeAbleToCreateApplicationIfAllowed()
     {
         var mockOpenIdScopeManager = new Mock<IOpenIdScopeManager>();
         var mockData = Array.Empty<object>();
+#pragma warning disable xUnit1051 // Calls to methods which accept CancellationToken should use TestContext.Current.CancellationToken
         mockOpenIdScopeManager.Setup(m => m.ListAsync(null, null, default)).Returns(mockData.ToAsyncEnumerable());
+#pragma warning restore xUnit1051 // Calls to methods which accept CancellationToken should use TestContext.Current.CancellationToken
         var controller = new ApplicationController(
             Mock.Of<IShapeFactory>(),
             Mock.Of<IOptions<PagerOptions>>(),
diff --git a/test/OrchardCore.Tests/Modules/OrchardCore.Resources/SubResourceIntegrityTests.cs b/test/OrchardCore.Tests/Modules/OrchardCore.Resources/SubResourceIntegrityTests.cs
@@ -7,7 +7,7 @@ namespace OrchardCore.Tests.Modules.OrchardCore.Resources;
 public class SubResourceIntegrityTests
 {
     [CIFact]
-    public async Task SavedSubResourceIntegritiesShouldMatchCurrentResources()
+    public static async Task SavedSubResourceIntegritiesShouldMatchCurrentResources()
     {
         // Arrange
         var resourceOptions = Options.Create(new ResourceOptions());
diff --git a/test/OrchardCore.Tests/OrchardCore.Tests.csproj b/test/OrchardCore.Tests/OrchardCore.Tests.csproj
@@ -3,6 +3,7 @@
   <PropertyGroup>
     <TargetFrameworks>$(CommonTargetFrameworks)</TargetFrameworks>
     <!-- Remove the underscores from member name -->
+    <OutputType>Exe</OutputType>
     <NoWarn>$(NoWarn);CA1707;EnableGenerateDocumentationFile</NoWarn>
   </PropertyGroup>
 
@@ -69,10 +70,9 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" />
     <PackageReference Include="System.Linq.Async" />
     <PackageReference Include="Moq" />
-    <PackageReference Include="xunit" />
+    <PackageReference Include="xunit.v3" />
     <PackageReference Include="xunit.analyzers" />
     <PackageReference Include="xunit.runner.visualstudio" />
-    <DotNetCliToolReference Include="dotnet-xunit" Version="$(DotNetXunitVersion)" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/test/OrchardCore.Tests/OrchardCore.Users/AccountControllerTests.cs b/test/OrchardCore.Tests/OrchardCore.Users/AccountControllerTests.cs

Original file line number	Diff line number	Diff line change
`@@ -207,7 +207,7 @@ public async Task ShouldNotBeAbleToExecuteAnyQueriesWithoutPermission()`
`207`	`207`
`208`	`208`	`await context.InitializeAsync();`
`209`	`209`
`210`		`- var response = await context.GraphQLClient.Client.GetAsync("api/graphql");`
	`210`	`+ var response = await context.GraphQLClient.Client.GetAsync("api/graphql", TestContext.Current.CancellationToken);`
`211`	`211`	`Assert.Equal(HttpStatusCode.Unauthorized, response.StatusCode);`
`212`	`212`	`}`
`213`	`213`