coverage.yaml

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Code Coverage
on:
  pull_request:
  pull_request_target:
    types: [labeled]

# Declare default permissions as read only.
permissions: read-all

jobs:
  coverage:
    if: "${{ github.event.action != 'labeled' || github.event.label.name == 'tests: run' }}"
    runs-on: ubuntu-latest
    permissions:
      issues: write
      pull-requests: write
    steps:
      - name: Remove PR Label
        if: "${{ github.event.action == 'labeled' && github.event.label.name == 'tests: run' }}"
        uses: actions/github-script@d7906e4ad0b1822421a7e6a35d5ca353c962f410 # v6.4.1
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          script: |
            try {
              await github.rest.issues.removeLabel({
                name: 'tests: run',
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: context.payload.pull_request.number
              });
            } catch (e) {
              console.log('Failed to remove label. Another job may have already removed it!');
            }

      - name: Setup Python
        uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0
        with:
          python-version: "3.10"

      - run: pip install nox coverage

      - name: Checkout base branch
        uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
        with:
          ref: ${{ github.base_ref }}

      - name: Calculate base code coverage
        run: |
          nox --sessions unit-3.10
          coverage report --show-missing
          export CUR_COVER=$(coverage report | awk '$1 == "TOTAL" {print $NF+0}')
          echo "CUR_COVER=$CUR_COVER" >> $GITHUB_ENV
          coverage erase

      - name: Checkout PR branch
        uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
        with:
          ref: ${{ github.event.pull_request.head.sha }}
          repository: ${{ github.event.pull_request.head.repo.full_name }}

      - name: Calculate PR code coverage
        run: |
          nox --sessions unit-3.10
          coverage report --show-missing
          export PR_COVER=$(coverage report | awk '$1 == "TOTAL" {print $NF+0}')
          echo "PR_COVER=$PR_COVER" >> $GITHUB_ENV
          coverage erase

      - name: Verify code coverage. If your reading this and the step has failed, please add tests to cover your changes.
        run: |
          echo "BASE BRANCH CODE COVERAGE is ${{ env.CUR_COVER }}%"
          echo "PULL REQUEST CODE COVERAGE is ${{ env.PR_COVER }}%"
          if [ "${{ env.PR_COVER }}" -lt "${{ env.CUR_COVER }}"  ]; then
            exit 1;
          fi