Add Code Coverage Reporting to Build Pipeline - Fixes #255 (#256)

CHANGELOG.md

@@ -8,6 +8,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Renamed `master` branch to `main` - Fixes [Issue #250](https://github.com/dsccommunity/StorageDsc/issues/250).
+- Added support for publishing code coverage to `CodeCov.io` and
+ Azure Pipelines - Fixes [Issue #255](https://github.com/dsccommunity/StorageDsc/issues/255).
+- Updated build to use `Sampler.GitHubTasks` - Fixes [Issue #254](https://github.com/dsccommunity/StorageDsc/issues/254).
 
 ### Fixed
 

README.md

@@ -5,6 +5,8 @@
 [![Azure DevOps tests](https://img.shields.io/azure-devops/tests/dsccommunity/StorageDsc/30/main)](https://dsccommunity.visualstudio.com/StorageDsc/_test/analytics?definitionId=30&contextType=build)
 [![PowerShell Gallery (with prereleases)](https://img.shields.io/powershellgallery/vpre/StorageDsc?label=StorageDsc%20Preview)](https://www.powershellgallery.com/packages/StorageDsc/)
 [![PowerShell Gallery](https://img.shields.io/powershellgallery/v/StorageDsc?label=StorageDsc)](https://www.powershellgallery.com/packages/StorageDsc/)
+[![codecov](https://codecov.io/gh/dsccommunity/StorageDsc/branch/main/graph/badge.svg)](https://codecov.io/gh/dsccommunity/StorageDsc)
+![Azure DevOps coverage (branch)](https://img.shields.io/azure-devops/coverage/dsccommunity/StorageDsc/14/main)
 
 ## Code of Conduct
 

RequiredModules.psd1

@@ -14,6 +14,7 @@
  ModuleBuilder = 'latest'
  ChangelogManagement = 'latest'
  Sampler = 'latest'
+ 'Sampler.GitHubTasks' = 'latest'
  MarkdownLinkCheck = 'latest'
  'DscResource.Test' = 'latest'
  'DscResource.AnalyzerRules' = 'latest'

azure-pipelines.yml

@@ -11,6 +11,13 @@ trigger:
  exclude:
  - "*-*"
 
+variables:
+ buildFolderName: output
+ buildArtifactName: output
+ testResultFolderName: testResults
+ testArtifactName: testResults
+ sourceFolderName: source
+
 stages:
  - stage: Build
  jobs:
@@ -109,17 +116,56 @@ stages:
  displayName: 'Publish Test Results'
  inputs:
  testResultsFormat: 'NUnit'
- testResultsFiles: 'output/testResults/NUnit*.xml'
+ testResultsFiles: '$(buildFolderName)/$(testResultFolderName)/NUnit*.xml'
  testRunTitle: 'Unit (Windows Server 2016)'
  condition: succeededOrFailed()
 
+ - task: PublishPipelineArtifact@1
+ displayName: 'Publish Test Artifact'
+ inputs:
+ targetPath: '$(buildFolderName)/$(testResultFolderName)/'
+ artifactName: $(testArtifactName)
+ parallel: true
+
+ - job: Code_Coverage
+ displayName: 'Publish Code Coverage'
+ dependsOn: Test_Unit_2016
+ pool:
+ vmImage: 'ubuntu 16.04'
+ timeoutInMinutes: 0
+ steps:
+ - pwsh: |
+ $repositoryOwner,$repositoryName = $env:BUILD_REPOSITORY_NAME -split '/'
+ echo "##vso[task.setvariable variable=RepositoryOwner;isOutput=true]$repositoryOwner"
+ echo "##vso[task.setvariable variable=RepositoryName;isOutput=true]$repositoryName"
+ name: dscBuildVariable
+ displayName: 'Set Environment Variables'
+
+ - task: DownloadBuildArtifacts@0
+ displayName: 'Download Build Artifact'
+ inputs:
+ buildType: 'current'
+ downloadType: 'single'
+ artifactName: $(buildArtifactName)
+ downloadPath: '$(Build.SourcesDirectory)'
+
+ - task: DownloadPipelineArtifact@2
+ displayName: 'Download Test Artifact'
+ inputs:
+ buildType: 'current'
+ artifactName: $(testArtifactName)
+ targetPath: '$(Build.SourcesDirectory)/$(buildFolderName)/$(testResultFolderName)'
+
  - task: PublishCodeCoverageResults@1
- displayName: 'Publish Code Coverage'
- condition: succeededOrFailed()
+ displayName: 'Publish Code Coverage to Azure DevOps'
  inputs:
  codeCoverageTool: 'JaCoCo'
- summaryFileLocation: 'output/testResults/CodeCov*.xml'
- pathToSources: '$(Build.SourcesDirectory)/output/$(DscBuildVariable.RepositoryName)'
+ summaryFileLocation: '$(Build.SourcesDirectory)/$(buildFolderName)/$(testResultFolderName)/JaCoCo_coverage.xml'
+ pathToSources: '$(Build.SourcesDirectory)/$(sourceFolderName)/'
+
+ - script: |
+ bash <(curl -s https://codecov.io/bash) -f "./$(buildFolderName)/$(testResultFolderName)/JaCoCo_coverage.xml"
+ displayName: 'Upload to Codecov.io'
 
  - job: Test_Integration_2016
  displayName: 'Integration (Windows Server 2016)'
@@ -155,7 +201,7 @@ stages:
  displayName: 'Publish Test Results'
  inputs:
  testResultsFormat: 'NUnit'
- testResultsFiles: 'output/testResults/NUnit*.xml'
+ testResultsFiles: '$(buildFolderName)/$(testResultFolderName)/NUnit*.xml'
  testRunTitle: 'Integration (Windows Server 2016)'
  condition: succeededOrFailed()
 
@@ -192,18 +238,10 @@ stages:
  displayName: 'Publish Test Results'
  inputs:
  testResultsFormat: 'NUnit'
- testResultsFiles: 'output/testResults/NUnit*.xml'
+ testResultsFiles: '$(buildFolderName)/$(testResultFolderName)/NUnit*.xml'
  testRunTitle: 'Unit (Windows Server 2019)'
  condition: succeededOrFailed()
 
- - task: PublishCodeCoverageResults@1
- displayName: 'Publish Code Coverage'
- condition: succeededOrFailed()
- inputs:
- codeCoverageTool: 'JaCoCo'
- summaryFileLocation: 'output/testResults/CodeCov*.xml'
- pathToSources: '$(Build.SourcesDirectory)/output/$(dscBuildVariable.RepositoryName)'
-
  - job: Test_Integration_2019
  displayName: 'Integration (Windows Server 2019)'
  pool:
@@ -238,7 +276,7 @@ stages:
  displayName: 'Publish Test Results'
  inputs:
  testResultsFormat: 'NUnit'
- testResultsFiles: 'output/testResults/NUnit*.xml'
+ testResultsFiles: '$(buildFolderName)/$(testResultFolderName)/NUnit*.xml'
  testRunTitle: 'Integration (Windows Server 2019)'
  condition: succeededOrFailed()
 

build.yaml

@@ -64,7 +64,9 @@ Pester:
  - tests/Unit
  ExcludeTag:
  Tag:
- CodeCoverageThreshold: 70
+ CodeCoverageOutputFile: JaCoCo_coverage.xml
+ CodeCoverageOutputFileEncoding: ascii
+ CodeCoverageThreshold: 80
 
 DscTest:
  OutputFormat: NUnitXML
@@ -84,6 +86,8 @@ Resolve-Dependency:
 ModuleBuildTasks:
  Sampler:
  - '*.build.Sampler.ib.tasks'
+ Sampler.GitHubTasks:
+ - '*.ib.tasks'
  DscResource.DocGenerator:
  - 'Task.*'
 

codecov.yml

@@ -0,0 +1,28 @@
+codecov:
+ require_ci_to_pass: no
+ # main should be the baseline for reporting
+ branch: main
+
+comment:
+ layout: "reach, diff, flags, files"
+ behavior: default
+
+coverage:
+ range: 50..80
+ round: down
+ precision: 0
+
+ status:
+ project:
+ default:
+ # Set the overall project code coverage requirement to 70%
+ target: 80
+ patch:
+ default:
+ # Set the pull request requirement to not regress overall coverage by more than 5%
+ # and let codecov.io set the goal for the code changed in the patch.
+ target: auto
+ threshold: 5
+
+fixes:
+ - '^\d+\.\d+\.\d+::source' # move path "X.Y.Z" => "source"