Implementing Code coverage in Azure DevOps and GitHub Actions

Implementing Code coverage in Azure DevOps and GitHub Actions

Code coverage is a crucial metric to ensure test completeness. Here’s how to implement it in Azure DevOps and GitHub Actions.

1. Azure DevOps Implementation

1. Set Up Test and Coverage Tools

Choose the appropriate tools based on your language:

• .NET: Coverlet, integrated with dotnet test.

• Java: JaCoCo.

• Python: pytest-cov.

• JavaScript/TypeScript: nyc (Istanbul).

2. Configure Azure Pipelines

Define your pipeline using YAML and ensure test and coverage tools are included.

Example Pipeline Configuration for .NET:

xxxxxxxxxx
23
1
trigger:
2
- main
3
pool:
4
  vmImage: 'windows-latest'
5
variables:
6
  buildConfiguration: 'Release'
7
stages:
8
- stage: Build
9
  displayName: "Build and Test"
10
  jobs:
11
   - job: BuildAndTest
12
    displayName: "Build and Run Tests"
13
    steps:
14
   - task: UseDotNet@2
15
      inputs:
16
        packageType: sdk
17
        version: '6.x'
18
   - script: dotnet restore
19
      displayName: "Restore NuGet Packages"
20
   - script: dotnet build --configuration $(buildConfiguration)
21
      displayName: "Build Solution"
22
   - script: dotnet test --configuration $(buildConfiguration) --collect:"Code Coverage" --results-directory $(System.DefaultWorkingDirectory)/TestResults
23
      displayName: "Run Tests with Coverage"

3. Add Code Coverage Tasks

Publish code coverage results to Azure DevOps for visualization.

Example (JaCoCo for Java):

xxxxxxxxxx
5
1
- task: PublishCodeCoverageResults@1
2
  inputs:
3
    codeCoverageTool: 'JaCoCo'
4
    summaryFileLocation: '$(System.DefaultWorkingDirectory)/TestResults/Coverage/coverage.xml'
5
    reportDirectory: '$(System.DefaultWorkingDirectory)/TestResults/CoverageReport'

Example (Coverlet for .NET):

xxxxxxxxxx
4
1
- task: PublishCodeCoverageResults@1
2
  inputs:
3
    codeCoverageTool: 'cobertura'
4
    summaryFileLocation: '$(System.DefaultWorkingDirectory)/TestResults/coverage.cobertura.xml'

4. Publish Code Coverage Reports

Ensure test results and coverage are published to the pipeline summary.

xxxxxxxxxx
5
1
- task: PublishTestResults@2
2
  inputs:
3
    testResultsFormat: 'TRX'
4
    testResultsFiles: '**/.trx'
5
    mergeTestResults: true

2. GitHub Actions Implementation

1. Set Up Test and Coverage Tools

Install and configure tools for your language in the actions workflow:

• .NET: Coverlet.

• Java: JaCoCo.

• Python: pytest-cov.

• JavaScript/TypeScript: nyc (Istanbul).

2. Create GitHub Actions Workflow

Define the workflow in a .github/workflows/ci.yml file.

3. Configure Workflow Steps

Example for a .NET application:

xxxxxxxxxx
29
1
name: CI
2
on:
3
  push:
4
    branches:
5
     - main
6
  pull_request:
7
    branches:
8
     - main
9
jobs:
10
  build-and-test:
11
    runs-on: ubuntu-latest
12
    steps:
13
   - name: Checkout code
14
      uses: actions/checkout@v3
15
   - name: Setup .NET
16
      uses: actions/setup-dotnet@v3
17
      with:
18
        dotnet-version: 6.0
19
   - name: Install dependencies
20
      run: dotnet restore
21
   - name: Build
22
      run: dotnet build --configuration Release
23
   - name: Run Tests with Code Coverage
24
      run: dotnet test --configuration Release --collect:"Code Coverage" --results-directory ./TestResults
25
   - name: Upload Coverage Results
26
      uses: actions/upload-artifact@v3
27
      with:
28
        name: code-coverage
29
        path: ./TestResults

4. Add Coverage Report Publishing

Use a tool like or to publish the coverage report.

Example for Codecov:

• Add Codecov to your workflow:

  xxxxxxxxxx
  5
  1
  - name: Upload to Codecov
  2
  uses: codecov/codecov-action@v3
  3
  with:
  4
     files: ./TestResults/coverage.cobertura.xml
  5
     token: ${{ secrets.CODECOV_TOKEN }}
  

• Retrieve the token from the Codecov dashboard for your repository and store it as a GitHub secret.

Summary