Merge pull request #272 from DuendeSoftware/beh/im-tests-on-net48

Run IdentityModel Tests on Windows

Author: bhazen

.github/workflow-gen/Program.cs

@@ -9,27 +9,32 @@
     new("ignore-this",
         ["IgnoreThis"],
         ["IgnoreThis.Tests"],
-        "it"),
+        "it",
+        [GitHubHostedRunners.UbuntuLatest]),
 
     new("access-token-management",
         ["AccessTokenManagement", "AccessTokenManagement.OpenIdConnect"],
         ["AccessTokenManagement.Tests"],
-        "atm"),
+        "atm",
+        [GitHubHostedRunners.UbuntuLatest]),
 
     new("identity-model",
         ["IdentityModel"],
         ["IdentityModel.Tests"],
-        "im"),
+        "im",
+        [GitHubHostedRunners.UbuntuLatest, GitHubHostedRunners.WindowsLatest]),
 
     new("identity-model-oidc-client",
         ["IdentityModel.OidcClient", "IdentityModel.OidcClient.Extensions"],
         ["IdentityModel.OidcClient.Tests"],
-        "imoc"),
+        "imoc",
+        [GitHubHostedRunners.UbuntuLatest]),
 
     new("introspection",
         ["AspNetCore.Authentication.OAuth2Introspection"],
         ["AspNetCore.Authentication.OAuth2Introspection.Tests"],
-        "intro"),
+        "intro",
+        [GitHubHostedRunners.UbuntuLatest]),
 ];
 
 foreach (var component in components)
@@ -68,8 +73,22 @@ void GenerateCiWorkflow(Component component)
 
     var job = workflow
         .Job("build")
-        .Name("Build")
-        .RunsOn(GitHubHostedRunners.UbuntuLatest)
+        .Name("Build");
+
+    if (component.RunsOn.Length == 1)
+    {
+        job.RunsOn(component.RunsOn[0]);
+    }
+    else
+    {
+        job.Strategy()
+            .Matrix(("os", component.RunsOn))
+            .FailFast(false)
+            .Job
+            .RunsOn("${{ matrix.os }}");
+    }
+
+    job = job
         .Defaults().Run("bash", component.Name)
         .Job;
 
@@ -90,12 +109,23 @@ void GenerateCiWorkflow(Component component)
 
     job.StepVerifyFormatting();
 
+    var runsOnIncludesWindows = component.RunsOn.Contains(GitHubHostedRunners.WindowsLatest);
     foreach (var testProject in component.Tests)
     {
-        job.StepTest(component.Name, testProject);
+        job.StepTest(component.Name, testProject, runsOnIncludesWindows);
+
+        if (runsOnIncludesWindows)
+        {
+            job.StepTest(component.Name, testProject, false, "net481");
+        }
     }
 
-    job.StepUploadTestResultsAsArtifact(component);
+    job.StepUploadTestResultsAsArtifact(component, runsOnIncludesWindows);
+
+    if (runsOnIncludesWindows)
+    {
+        job.StepUploadTestResultsAsArtifact(component, false, "net481");
+    }
 
     job.StepToolRestore();
 
@@ -235,6 +265,11 @@ void GenerateUploadTestResultsWorkflow()
         foreach (var testProject in component.Tests)
         {
             job.StepGenerateReportFromTestArtifact(component, testProject);
+
+            if (component.RunsOn.Contains(GitHubHostedRunners.WindowsLatest))
+            {
+                job.StepGenerateReportFromTestArtifact(component, $"{testProject}-net481", "test-results-net481");
+            }
         }
     }
 
@@ -249,7 +284,7 @@ void WriteWorkflow(Workflow workflow, string fileName)
     Console.WriteLine($"Wrote workflow to {filePath}");
 }
 
-record Component(string Name, string[] Projects, string[] Tests, string TagPrefix)
+record Component(string Name, string[] Projects, string[] Tests, string TagPrefix, string[] RunsOn)
 {
     public string CiWorkflowName => $"{Name}/ci";
     public string ReleaseWorkflowName => $"{Name}/release";
@@ -270,39 +305,74 @@ public static void StepSetupDotNet(this Job job)
     public static Step IfRefMain(this Step step)
         => step.If("github.ref == 'refs/heads/main'");
 
-    public static void StepTest(this Job job, string componentName, string testProject)
+    internal static Step IfWindows(this Step step)
+        => step.If("matrix.os == 'windows-latest'");
+
+    internal static Step IfNotWindows(this Step step)
+        => step.If("matrix.os != 'windows-latest'");
+
+    public static void StepTest(this Job job, string componentName, string testProject, bool excludeOnWindows, string? framework = null)
     {
+        var testProjectFullName = $"{testProject}{(framework == null ? string.Empty : $"-{framework}")}";
         var path = $"test/{testProject}";
-        var logFileName = $"{testProject}.trx";
+        var logFileName = $"{testProjectFullName}.trx";
         var flags = $"--logger \"console;verbosity=normal\" " +
                     $"--logger \"trx;LogFileName={logFileName}\" " +
                     $"--collect:\"XPlat Code Coverage\"";
-        job.Step()
-            .Name($"Test - {testProject}")
+
+        if (framework != null)
+        {
+            flags += $" --framework {framework}";
+        }
+
+        var testStep = job.Step()
+            .Name($"Test - {testProjectFullName}")
             .Run($"dotnet test -c Release {path} {flags}");
 
+        if (excludeOnWindows)
+        {
+            testStep.IfNotWindows();
+        }
+
+        if (framework == "net481")
+        {
+            testStep.IfWindows();
+        }
     }
 
-    internal static void StepUploadTestResultsAsArtifact(this Job job, Component component)
-        => job.Step()
-            .Name($"Test report")
+    internal static void StepUploadTestResultsAsArtifact(this Job job, Component component, bool excludeOnWindows, string? framework = null)
+    {
+        var nameSuffix = framework == null ? string.Empty : $"-{framework}";
+        var uploadStep = job.Step()
+            .Name($"Test report{nameSuffix}")
             .If("success() || failure()")
             .Uses("actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882") // 4.4.3
             .With(
-                ("name", "test-results"),
+                ("name", $"test-results{nameSuffix}"),
                 ("path", string.Join(Environment.NewLine, component.Tests
-                    .Select(testProject => $"{component.Name}/test/{testProject}/TestResults/{testProject}.trx"))),
+                    .Select(testProject => $"{component.Name}/test/{testProject}/TestResults/{testProject}{nameSuffix}.trx"))),
                 ("retention-days", "5"));
 
-    internal static void StepGenerateReportFromTestArtifact(this Job job, Component component, string testProject)
+        if (excludeOnWindows)
+        {
+            uploadStep.IfNotWindows();
+        }
+
+        if (framework == "net481")
+        {
+            uploadStep.IfWindows();
+        }
+    }
+
+    internal static void StepGenerateReportFromTestArtifact(this Job job, Component component, string testProject, string? artifactName = "test-results")
     {
         var path = $"test/{testProject}";
         job.Step()
             .Name($"Test report - {component.Name} - {testProject}")
             .Uses("dorny/test-reporter@31a54ee7ebcacc03a09ea97a7e5465a47b84aea5") // v1.9.1
             .If($"github.event.workflow.name == '{component.CiWorkflowName}'")
             .With(
-                ("artifact", "test-results"),
+                ("artifact", $"{artifactName}"),
                 ("name", $"Test Report - {testProject}"),
                 ("path", $"{testProject}.trx"),
                 ("reporter", "dotnet-trx"),

.github/workflows/generate-test-reports.yml

@@ -51,6 +51,16 @@ jobs:
         reporter: dotnet-trx
         fail-on-error: true
         fail-on-empty: true
+    - name: Test report - identity-model - IdentityModel.Tests-net481
+      if: github.event.workflow.name == 'identity-model/ci'
+      uses: dorny/test-reporter@31a54ee7ebcacc03a09ea97a7e5465a47b84aea5
+      with:
+        artifact: test-results-net481
+        name: Test Report - IdentityModel.Tests-net481
+        path: IdentityModel.Tests-net481.trx
+        reporter: dotnet-trx
+        fail-on-error: true
+        fail-on-empty: true
     - name: Test report - identity-model-oidc-client - IdentityModel.OidcClient.Tests
       if: github.event.workflow.name == 'identity-model-oidc-client/ci'
       uses: dorny/test-reporter@31a54ee7ebcacc03a09ea97a7e5465a47b84aea5

.github/workflows/identity-model-ci.yml

@@ -27,7 +27,7 @@ env:
 jobs:
   build:
     name: Build
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     permissions:
       actions: read
       checks: write
@@ -37,6 +37,12 @@ jobs:
       run:
         shell: bash
         working-directory: identity-model
+    strategy:
+      matrix:
+        os:
+        - ubuntu-latest
+        - windows-latest
+      fail-fast: false
     timeout-minutes: 15
     steps:
     - name: Checkout
@@ -55,14 +61,25 @@ jobs:
     - name: Verify Formatting
       run: dotnet format ../ --verify-no-changes --no-restore
     - name: Test - IdentityModel.Tests
+      if: matrix.os != 'windows-latest'
       run: dotnet test -c Release test/IdentityModel.Tests --logger "console;verbosity=normal" --logger "trx;LogFileName=IdentityModel.Tests.trx" --collect:"XPlat Code Coverage"
+    - name: Test - IdentityModel.Tests-net481
+      if: matrix.os == 'windows-latest'
+      run: dotnet test -c Release test/IdentityModel.Tests --logger "console;verbosity=normal" --logger "trx;LogFileName=IdentityModel.Tests-net481.trx" --collect:"XPlat Code Coverage" --framework net481
     - name: Test report
-      if: success() || failure()
+      if: matrix.os != 'windows-latest'
       uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882
       with:
         name: test-results
         path: identity-model/test/IdentityModel.Tests/TestResults/IdentityModel.Tests.trx
         retention-days: 5
+    - name: Test report-net481
+      if: matrix.os == 'windows-latest'
+      uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882
+      with:
+        name: test-results-net481
+        path: identity-model/test/IdentityModel.Tests/TestResults/IdentityModel.Tests-net481.trx
+        retention-days: 5
     - name: Tool restore
       run: dotnet tool restore
     - name: Pack IdentityModel

identity-model/test/IdentityModel.Tests/HttpClientExtensions/DynamicClientRegistrationTests.cs

@@ -180,7 +180,7 @@ public async Task Extensions_should_be_serializable()
         response.ShouldNotBeNull();
 
         //ensure the extension made it into the request
-        var requestContent = await handler.Request?.Content?.ReadAsStringAsync()!;
+        var requestContent = handler.Body;
         var requestContentJson = JsonSerializer.Deserialize<JsonElement>(requestContent);
         requestContentJson.GetProperty("custom_field").GetString().ShouldBe("data");
     }