Replace test categories for OS filter with xUnit attributes

bart-vmware · bart-vmware · commit 1450463186bd · 2025-11-28T12:15:38.000+01:00
diff --git a/.github/workflows/Steeltoe.All.yml b/.github/workflows/Steeltoe.All.yml
@@ -38,7 +38,7 @@ jobs:
         - os: windows-latest
           skipFilter: Category!=Integration
         - os: macos-latest
-          skipFilter: Category!=Integration&Category!=SkipOnMacOS
+          skipFilter: Category!=Integration
     runs-on: ${{ matrix.os }}
     continue-on-error: true
 
@@ -74,7 +74,7 @@ jobs:
       #   When that happens, select 'Always Allow' to grant 'dotnet' access to the certificate key in the future.
       # and the test run fails, but without indicating which test caused it. By setting this, the causing test fails with the next message:
       #   Unable to configure HTTPS endpoint. No server certificate was specified, and the default developer certificate could not be found or is out of date.
-      # To prevent the causing test from failing the test run, disable it on macOS by adding [Trait("Category", "SkipOnMacOS")].
+      # To prevent the causing test from failing the test run, disable it on macOS using SkipOnPlatformFact/Theory.
       shell: bash
       run: echo "DOTNET_GENERATE_ASPNET_CERTIFICATE=false" >> $GITHUB_ENV
 
diff --git a/.github/workflows/component-configuration.yml b/.github/workflows/component-configuration.yml
@@ -25,4 +25,4 @@ jobs:
     with:
       component: Configuration
       OS: ubuntu
-      runConfigServer: true
+      runDockerContainers: true
diff --git a/.github/workflows/component-management.yml b/.github/workflows/component-management.yml
@@ -31,7 +31,6 @@ jobs:
     with:
       component: Management
       OS: macos
-      skipFilter: Category!=SkipOnMacOS
 
   windows:
     uses: ./.github/workflows/component-shared-workflow.yml
diff --git a/.github/workflows/component-shared-workflow.yml b/.github/workflows/component-shared-workflow.yml
@@ -12,7 +12,7 @@ on:
       skipFilter:
         required: false
         type: string
-      runConfigServer:
+      runDockerContainers:
         required: false
         type: boolean
         default: false
@@ -24,14 +24,10 @@ permissions:
 env:
   DOTNET_CLI_TELEMETRY_OPTOUT: 1
   DOTNET_NOLOGO: true
-  SOLUTION_FILE: src/Steeltoe.${{ inputs.component }}.slnf
+  SOLUTION_FILE: 'src/Steeltoe.${{ inputs.component }}.slnf'
   COMMON_TEST_ARGS: >-
     --no-build --configuration Release --collect "XPlat Code Coverage" --logger trx --results-directory ${{ github.workspace }}/dumps
     --settings coverlet.runsettings --blame-crash --blame-hang-timeout 3m
-  SKIP_FILTER_NO_MEMORY_DUMPS: >-
-    ${{ inputs.skipFilter && format('--filter "{0}&Category!=MemoryDumps"', inputs.skipFilter) || '--filter "Category!=MemoryDumps"' }}
-  SKIP_FILTER_WITH_MEMORY_DUMPS: >-
-    ${{ inputs.skipFilter && format('--filter "{0}&Category=MemoryDumps"', inputs.skipFilter) || '--filter "Category=MemoryDumps"' }}
 
 jobs:
   build:
@@ -41,11 +37,11 @@ jobs:
 
     services:
       eurekaServer:
-        image: ${{ inputs.runConfigServer && 'steeltoe.azurecr.io/eureka-server' || null }}
+        image: ${{ inputs.runDockerContainers && 'steeltoe.azurecr.io/eureka-server' || null }}
         ports:
         - 8761:8761
       configServer:
-        image: ${{ inputs.runConfigServer && 'steeltoe.azurecr.io/config-server' || null }}
+        image: ${{ inputs.runDockerContainers && 'steeltoe.azurecr.io/config-server' || null }}
         env:
           eureka.client.enabled: true
           eureka.client.serviceUrl.defaultZone: http://eurekaServer:8761/eureka
@@ -71,7 +67,7 @@ jobs:
       #   When that happens, select 'Always Allow' to grant 'dotnet' access to the certificate key in the future.
       # and the test run fails, but without indicating which test caused it. By setting this, the causing test fails with the next message:
       #   Unable to configure HTTPS endpoint. No server certificate was specified, and the default developer certificate could not be found or is out of date.
-      # To prevent the causing test from failing the test run, disable it on macOS by adding [Trait("Category", "SkipOnMacOS")].
+      # To prevent the causing test from failing the test run, disable it on macOS using SkipOnPlatformFact/Theory.
       shell: bash
       run: echo "DOTNET_GENERATE_ASPNET_CERTIFICATE=false" >> $GITHUB_ENV
 
@@ -86,33 +82,38 @@ jobs:
     - name: Build solution
       run: dotnet build ${{ env.SOLUTION_FILE }} --no-restore --configuration Release --verbosity minimal
 
+    - name: Set skip filters for tests
+      shell: bash
+      run: |
+        echo SKIP_FILTER_NO_MEMORY_DUMPS="${{ inputs.skipFilter && format('{0}&Category!=MemoryDumps', inputs.skipFilter) || 'Category!=MemoryDumps' }}" >> $GITHUB_ENV
+        echo SKIP_FILTER_WITH_MEMORY_DUMPS="${{ inputs.skipFilter && format('{0}&Category=MemoryDumps', inputs.skipFilter) || 'Category=MemoryDumps' }}" >> $GITHUB_ENV
+
     - name: Test (net10.0)
-      run: dotnet test ${{ env.SOLUTION_FILE }} --framework net10.0 ${{ env.SKIP_FILTER_NO_MEMORY_DUMPS }} ${{ env.COMMON_TEST_ARGS }}
+      run: dotnet test ${{ env.SOLUTION_FILE }} --framework net10.0 --filter "${{ env.SKIP_FILTER_NO_MEMORY_DUMPS }}" ${{ env.COMMON_TEST_ARGS }}
 
     - name: Test (net10.0) (memory dumps)
       if: ${{ inputs.component == 'Management' }}
-      run: dotnet test ${{ env.SOLUTION_FILE }} --framework net10.0 ${{ env.SKIP_FILTER_WITH_MEMORY_DUMPS }} ${{ env.COMMON_TEST_ARGS }}
+      run: dotnet test ${{ env.SOLUTION_FILE }} --framework net10.0 --filter "${{ env.SKIP_FILTER_WITH_MEMORY_DUMPS }}" ${{ env.COMMON_TEST_ARGS }}
 
     - name: Test (net9.0)
-      run: dotnet test ${{ env.SOLUTION_FILE }} --framework net9.0 ${{ env.SKIP_FILTER_NO_MEMORY_DUMPS }} ${{ env.COMMON_TEST_ARGS }}
+      run: dotnet test ${{ env.SOLUTION_FILE }} --framework net9.0 --filter "${{ env.SKIP_FILTER_NO_MEMORY_DUMPS }}" ${{ env.COMMON_TEST_ARGS }}
 
     - name: Test (net9.0) (memory dumps)
       if: ${{ inputs.component == 'Management' }}
-      run: dotnet test ${{ env.SOLUTION_FILE }} --framework net9.0 ${{ env.SKIP_FILTER_WITH_MEMORY_DUMPS }} ${{ env.COMMON_TEST_ARGS }}
+      run: dotnet test ${{ env.SOLUTION_FILE }} --framework net9.0 --filter "${{ env.SKIP_FILTER_WITH_MEMORY_DUMPS }}" ${{ env.COMMON_TEST_ARGS }}
 
     - name: Test (net8.0)
-      run: dotnet test ${{ env.SOLUTION_FILE }} --framework net8.0 ${{ env.SKIP_FILTER_NO_MEMORY_DUMPS }} ${{ env.COMMON_TEST_ARGS }}
+      run: dotnet test ${{ env.SOLUTION_FILE }} --framework net8.0 --filter "${{ env.SKIP_FILTER_NO_MEMORY_DUMPS }}" ${{ env.COMMON_TEST_ARGS }}
 
     - name: Test (net8.0) (memory dumps)
       if: ${{ inputs.component == 'Management' }}
-      run: dotnet test ${{ env.SOLUTION_FILE }} --framework net8.0 ${{ env.SKIP_FILTER_WITH_MEMORY_DUMPS }} ${{ env.COMMON_TEST_ARGS }}
-
+      run: dotnet test ${{ env.SOLUTION_FILE }} --framework net8.0 --filter "${{ env.SKIP_FILTER_WITH_MEMORY_DUMPS }}" ${{ env.COMMON_TEST_ARGS }}
 
     - name: Upload crash/hang dumps (on failure)
       if: ${{ failure() }}
       uses: actions/upload-artifact@v5
       with:
-        name: FailedTestOutput-${{ inputs.OS }}
+        name: FailedTestOutput-${{ inputs.OS }}-latest
         path: |
           ${{ github.workspace }}/dumps/**/*.dmp
           ${{ github.workspace }}/dumps/**/Sequence_*.xml
@@ -122,7 +123,7 @@ jobs:
       if: ${{ !cancelled() }}
       uses: dorny/test-reporter@v2
       with:
-        name: ${{ inputs.OS }} test results
+        name: ${{ inputs.OS }}-latest test results
         reporter: dotnet-trx
         path: '**/*.trx'
         fail-on-empty: 'true'
diff --git a/src/Common/test/Certificates.Test/ConfigureCertificateOptionsTest.cs b/src/Common/test/Certificates.Test/ConfigureCertificateOptionsTest.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information.
 
+using System.Runtime.InteropServices;
 using System.Security.Cryptography;
 using System.Security.Cryptography.X509Certificates;
 using System.Text.Json;
@@ -50,10 +51,9 @@ public void ConfigureCertificateOptions_BadPath_NoCertificate(string certificate
         options.Certificate.Should().BeNull();
     }
 
-    [Theory]
+    [SkipOnPlatformTheory(nameof(OSPlatform.OSX))]
     [InlineData("")]
     [InlineData(CertificateName)]
-    [Trait("Category", "SkipOnMacOS")]
     public void ConfigureCertificateOptions_ThrowsOnEmptyFile(string certificateName)
     {
         var appSettings = new Dictionary<string, string?>
diff --git a/src/Common/test/TestResources/SkipOnPlatformFactAttribute.cs b/src/Common/test/TestResources/SkipOnPlatformFactAttribute.cs
@@ -0,0 +1,29 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information.
+
+using System.Runtime.InteropServices;
+using Xunit;
+using Xunit.v3;
+
+namespace Steeltoe.Common.TestResources;
+
+/// <summary>
+/// Skips running the decorated test on the specified platforms.
+/// </summary>
+/// <remarks>
+/// A common reason for skipping tests on macOS is because the ASP.NET dev certificate is not trusted. See
+/// https://github.com/dotnet/aspnetcore/issues/42273.
+/// </remarks>
+[XunitTestCaseDiscoverer(typeof(FactDiscoverer))]
+[AttributeUsage(AttributeTargets.Method)]
+public sealed class SkipOnPlatformFactAttribute : FactAttribute
+{
+    public SkipOnPlatformFactAttribute(params string[] platformNames)
+    {
+        foreach (OSPlatform platform in platformNames.Select(OSPlatform.Create))
+        {
+            Assert.SkipWhen(RuntimeInformation.IsOSPlatform(platform), $"Skipping test on platform {platform}.");
+        }
+    }
+}
diff --git a/src/Common/test/TestResources/SkipOnPlatformTheoryAttribute.cs b/src/Common/test/TestResources/SkipOnPlatformTheoryAttribute.cs
@@ -0,0 +1,29 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information.
+
+using System.Runtime.InteropServices;
+using Xunit;
+using Xunit.v3;
+
+namespace Steeltoe.Common.TestResources;
+
+/// <summary>
+/// Skips running the decorated test on the specified platforms.
+/// </summary>
+/// <remarks>
+/// A common reason for skipping tests on macOS is because the ASP.NET dev certificate is not trusted. See
+/// https://github.com/dotnet/aspnetcore/issues/42273.
+/// </remarks>
+[XunitTestCaseDiscoverer(typeof(TheoryDiscoverer))]
+[AttributeUsage(AttributeTargets.Method)]
+public sealed class SkipOnPlatformTheoryAttribute : TheoryAttribute
+{
+    public SkipOnPlatformTheoryAttribute(params string[] platformNames)
+    {
+        foreach (OSPlatform platform in platformNames.Select(OSPlatform.Create))
+        {
+            Assert.SkipWhen(RuntimeInformation.IsOSPlatform(platform), $"Skipping test on platform {platform}.");
+        }
+    }
+}
diff --git a/src/Discovery/test/Consul.Test/Discovery/PostConfigureConsulDiscoveryOptionsTest.cs b/src/Discovery/test/Consul.Test/Discovery/PostConfigureConsulDiscoveryOptionsTest.cs
@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information.
 
 using System.Diagnostics;
+using System.Runtime.InteropServices;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging.Abstractions;
@@ -107,8 +108,7 @@ public async Task CanUseNetworkInterfaces()
         inetUtilsMock.Verify(n => n.FindFirstNonLoopbackHostInfo(), Times.Once);
     }
 
-    [Fact]
-    [Trait("Category", "SkipOnMacOS")]
+    [SkipOnPlatformFact(nameof(OSPlatform.OSX))]
     public async Task CanUseNetworkInterfacesWithoutReverseDnsOnIP()
     {
         var appSettings = new Dictionary<string, string?>
diff --git a/src/Discovery/test/Eureka.Test/DynamicPortAssignmentTest.cs b/src/Discovery/test/Eureka.Test/DynamicPortAssignmentTest.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information.
 
+using System.Runtime.InteropServices;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
@@ -11,8 +12,7 @@ namespace Steeltoe.Discovery.Eureka.Test;
 
 public sealed class DynamicPortAssignmentTest
 {
-    [Fact]
-    [Trait("Category", "SkipOnMacOS")]
+    [SkipOnPlatformFact(nameof(OSPlatform.OSX))]
     public async Task Applies_dynamically_assigned_ports_after_startup()
     {
         var appSettings = new Dictionary<string, string?>
diff --git a/src/Discovery/test/Eureka.Test/EurekaServiceCollectionExtensionsTest.cs b/src/Discovery/test/Eureka.Test/EurekaServiceCollectionExtensionsTest.cs
@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information.
 
 using System.Diagnostics;
+using System.Runtime.InteropServices;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
@@ -55,8 +56,7 @@ public async Task AddEurekaDiscoveryClient_UsesManagementOptions()
         options.Value.StatusPageUrlPath.Should().Be("/actuator/info");
     }
 
-    [Fact]
-    [Trait("Category", "SkipOnMacOS")]
+    [SkipOnPlatformFact(nameof(OSPlatform.OSX))]
     public async Task AddEurekaDiscoveryClient_UsesServerTimeout()
     {
         var appSettings = new Dictionary<string, string?>
diff --git a/src/Discovery/test/Eureka.Test/PostConfigureEurekaInstanceOptionsTest.cs b/src/Discovery/test/Eureka.Test/PostConfigureEurekaInstanceOptionsTest.cs
@@ -5,6 +5,7 @@
 using System.Diagnostics;
 using System.Globalization;
 using System.Reflection;
+using System.Runtime.InteropServices;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection.Extensions;
@@ -217,8 +218,7 @@ public async Task Can_use_network_interfaces()
         instanceOptions.IPAddress.Should().Be("254.254.254.254");
     }
 
-    [Fact]
-    [Trait("Category", "SkipOnMacOS")]
+    [SkipOnPlatformFact(nameof(OSPlatform.OSX))]
     public async Task Can_use_network_interfaces_without_reverse_DNS_on_IP()
     {
         var appSettings = new Dictionary<string, string?>
diff --git a/src/Discovery/test/HttpClients.Test/DiscoveryWebApplicationBuilderExtensionsTest.cs b/src/Discovery/test/HttpClients.Test/DiscoveryWebApplicationBuilderExtensionsTest.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information.
 
+using System.Runtime.InteropServices;
 using FluentAssertions.Extensions;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.Configuration;
@@ -61,8 +62,7 @@ public async Task AddConsulDiscoveryClient_WebApplicationBuilder_AddsServiceDisc
         host.Services.GetServices<IHostedService>().OfType<DiscoveryClientHostedService>().Should().ContainSingle();
     }
 
-    [Fact]
-    [Trait("Category", "SkipOnMacOS")]
+    [SkipOnPlatformFact(nameof(OSPlatform.OSX))]
     public async Task AddEurekaDiscoveryClient_WorksWithGlobalServiceDiscovery()
     {
         WebApplicationBuilder builder = TestWebApplicationBuilderFactory.Create();
diff --git a/src/Management/test/Endpoint.Test/ManagementPort/ManagementEndpointServedOnDifferentPortTest.cs b/src/Management/test/Endpoint.Test/ManagementPort/ManagementEndpointServedOnDifferentPortTest.cs
diff --git a/src/Management/test/Endpoint.Test/SpringBootAdminClient/HostBuilderTest.cs b/src/Management/test/Endpoint.Test/SpringBootAdminClient/HostBuilderTest.cs
diff --git a/src/Security/test/Authorization.Certificate.Test/CertificateAuthorizationTest.cs b/src/Security/test/Authorization.Certificate.Test/CertificateAuthorizationTest.cs
diff --git a/src/Security/test/DataProtection.Redis.Test/RedisDataProtectionBuilderExtensionsTest.cs b/src/Security/test/DataProtection.Redis.Test/RedisDataProtectionBuilderExtensionsTest.cs
diff --git a/src/Steeltoe.All.sln.DotSettings b/src/Steeltoe.All.sln.DotSettings
