Update pipeline used in NetworkingDsc (#297)

Author: dan-hughes

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Remove use of prefix.ps1 and suffix.ps1.
   - Added testing on Windows Server 2025.
   - Updated Test stage to use matrix strategy to reduce code duplication.
+  - Refactor pipeline to move integration to separate stage, add merge code coverage task.
 - `Disk`
   - Updated AllocationUnitSize in examples to be a valid UInt32 value instead of a String.
 

azure-pipelines.yml

@@ -54,14 +54,15 @@ stages:
               publishLocation: 'pipeline'
               parallel: true
 
-  - stage: Test
+  - stage: Quality_Test_and_Unit_Test
+    displayName: 'Quality Test and Unit Test'
     dependsOn: Build
     jobs:
       - job: Test_HQRM
         displayName: 'HQRM'
         pool:
           vmImage: 'windows-latest'
-        timeoutInMinutes: 0
+        timeoutInMinutes: '0'
         steps:
           - task: DownloadPipelineArtifact@2
             displayName: 'Download Pipeline Artifact'
@@ -86,28 +87,19 @@ stages:
               testRunTitle: 'HQRM'
             condition: succeededOrFailed()
 
-      - job: Test_Unit_Matrix
-        displayName: 'Unit Tests'
+      - job: Test_Unit
+        displayName: 'Unit'
         strategy:
           matrix:
-            Unit_Windows_Server_2019:
-              osImage: windows-2019
-              testRunTitle: 'Unit (Windows Server 2019)'
-              publishArtifact: true # Publish the test artifact for code coverage
-            Unit_Windows_Server_2022:
-              osImage: windows-2022
-              testRunTitle: 'Unit (Windows Server 2022)'
-              publishArtifact: false
-            Unit_Windows_Server_2025:
-              osImage: windows-2025
-              testRunTitle: 'Unit (Windows Server 2025)'
-              publishArtifact: false
-        variables:
-          testType: Unit
-          configureWinRM: false
+            Windows Server 2019:
+              vmImage: windows-2019
+            Windows Server 2022:
+              vmImage: windows-2022
+            Windows Server 2025:
+              vmImage: windows-2025
         pool:
-          vmImage: $(osImage)
-        timeoutInMinutes: 0
+          vmImage: $(vmImage)
+        timeoutInMinutes: '0'
         steps:
           - task: DownloadPipelineArtifact@2
             displayName: 'Download Pipeline Artifact'
@@ -117,7 +109,7 @@ stages:
               targetPath: '$(Build.SourcesDirectory)/$(buildArtifactName)'
 
           - task: PowerShell@2
-            displayName: 'Run $(testRunTitle) Test'
+            displayName: 'Run Unit Test'
             inputs:
               filePath: './build.ps1'
               arguments: "-Tasks test -PesterScript 'tests/Unit'"
@@ -128,23 +120,21 @@ stages:
             inputs:
               testResultsFormat: NUnit
               testResultsFiles: '$(buildFolderName)/$(testResultFolderName)/NUnit*.xml'
-              testRunTitle: '$(testRunTitle)'
+              testRunTitle: 'Unit $(vmImage)'
             condition: succeededOrFailed()
 
           - task: PublishPipelineArtifact@1
             displayName: 'Publish Test Artifact'
-            condition: eq(variables['publishArtifact'], 'true')
             inputs:
               targetPath: '$(buildFolderName)/$(testResultFolderName)/'
-              artifactName: $(testArtifactName)
-              parallel: true
+              artifactName: '$(testArtifactName)_$(vmImage)'
 
       - job: Code_Coverage
         displayName: 'Publish Code Coverage'
-        dependsOn: Test_Unit_Matrix
+        dependsOn: Test_Unit
         pool:
           vmImage: 'ubuntu-latest'
-        timeoutInMinutes: 0
+        timeoutInMinutes: '0'
         steps:
           - task: DownloadPipelineArtifact@2
             displayName: 'Download Pipeline Artifact'
@@ -157,9 +147,16 @@ stages:
             displayName: 'Download Test Artifact'
             inputs:
               buildType: current
-              artifactName: $(testArtifactName)
               targetPath: '$(Build.SourcesDirectory)/$(buildFolderName)/$(testResultFolderName)'
 
+          - task: PowerShell@2
+            name: merge
+            displayName: 'Merge Code Coverage files'
+            inputs:
+              filePath: './build.ps1'
+              arguments: '-tasks merge'
+              pwsh: true
+
           - task: PublishCodeCoverageResults@1
             displayName: 'Publish Code Coverage to Azure DevOps'
             inputs:
@@ -171,26 +168,23 @@ stages:
               bash <(curl -s https://codecov.io/bash) -f "./$(buildFolderName)/$(testResultFolderName)/JaCoCo_coverage.xml"
             displayName: 'Upload to Codecov.io'
 
-      - job: Test_Integration_Matrix
-        displayName: 'Integration Tests'
+  - stage: Integration_Test
+    displayName: 'Integration Test'
+    dependsOn: Quality_Test_and_Unit_Test
+    jobs:
+      - job: Test_Integration
+        displayName: 'Integration'
         strategy:
           matrix:
-            Integration_Windows_Server_2019:
-              osImage: windows-2019
-              testRunTitle: 'Integration (Windows Server 2019)'
-            Integration_Windows_Server_2022:
-              osImage: windows-2022
-              testRunTitle: 'Integration (Windows Server 2022)'
-            Integration_Windows_Server_2025:
-              osImage: windows-2025
-              testRunTitle: 'Integration (Windows Server 2025)'
-        variables:
-          testType: Integration
-          configureWinRM: true
-          publishArtifact: false
+            Windows Server 2019:
+              vmImage: windows-2019
+            Windows Server 2022:
+              vmImage: windows-2022
+            Windows Server 2025:
+              vmImage: windows-2025
         pool:
-          vmImage: $(osImage)
-        timeoutInMinutes: 0
+          vmImage: $(vmImage)
+        timeoutInMinutes: '0'
         steps:
           - task: DownloadPipelineArtifact@2
             displayName: 'Download Pipeline Artifact'
@@ -199,17 +193,17 @@ stages:
               artifactName: $(buildArtifactName)
               targetPath: '$(Build.SourcesDirectory)/$(buildArtifactName)'
 
-          # Integration tests need WinRM
           - task: PowerShell@2
+            name: configureWinRM
             displayName: 'Configure WinRM'
-            condition: eq(variables['configureWinRM'], 'true')
             inputs:
-              targetType: inline
-              script: winrm quickconfig -quiet
+              targetType: 'inline'
+              script: 'winrm quickconfig -quiet'
               pwsh: false
 
           - task: PowerShell@2
-            displayName: 'Run $(testRunTitle) Test'
+            name: test
+            displayName: 'Run Integration Test'
             inputs:
               filePath: './build.ps1'
               arguments: "-Tasks test -PesterScript 'tests/Integration' -CodeCoverageThreshold 0"
@@ -218,13 +212,15 @@ stages:
           - task: PublishTestResults@2
             displayName: 'Publish Test Results'
             inputs:
-              testResultsFormat: NUnit
+              testResultsFormat: 'NUnit'
               testResultsFiles: '$(buildFolderName)/$(testResultFolderName)/NUnit*.xml'
-              testRunTitle: '$(testRunTitle)'
+              testRunTitle: 'Integration $(testRunTitle)'
             condition: succeededOrFailed()
 
   - stage: Deploy
-    dependsOn: Test
+    dependsOn:
+      - Quality_Test_and_Unit_Test
+      - Integration_Test
     condition: |
       and(
         succeeded(),

build.yaml

@@ -30,8 +30,12 @@ BuildWorkflow:
 
   test:
     - Pester_Tests_Stop_On_Fail
+    - Convert_Pester_Coverage
     - Pester_If_Code_Coverage_Under_Threshold
 
+  merge:
+    - Merge_CodeCoverage_Files
+
   publish:
     - publish_module_to_gallery
     - Publish_Release_To_GitHub
@@ -89,7 +93,6 @@ Pester:
     - tests/Unit
   ExcludeTag:
   Tag:
-  CodeCoverageOutputFile: JaCoCo_coverage.xml
   CodeCoverageOutputFileEncoding: ascii
   CodeCoverageThreshold: 80
 
@@ -104,7 +107,6 @@ Pester:
       CIFormat: Auto
     CodeCoverage:
       CoveragePercentTarget: 80
-      OutputPath: JaCoCo_coverage.xml
       OutputEncoding: ascii
       UseBreakpoints: false
     TestResult:
@@ -113,6 +115,17 @@ Pester:
   ExcludeFromCodeCoverage:
     - Modules/DscResource.Common
 
+####################################################
+#           Code Coverage Configuration            #
+####################################################
+
+CodeCoverage:
+  # Filename of the file that will be outputted by the task Merge_CodeCoverage_Files.
+  CodeCoverageMergedOutputFile: JaCoCo_coverage.xml
+  # File pattern used to search for files under the ./output/testResults folder
+  # by task Merge_CodeCoverage_Files.
+  CodeCoverageFilePattern: Codecov*.xml
+
 ####################################################
 #      Pester Configuration (DscResource.Test)     #
 ####################################################