python-coverage-action/.github/workflows/ci.yml at main · simlab-vs/python-coverage-action · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
name: CI

on:
  push:
  pull_request:
  workflow_dispatch:

jobs:
  check:
    name: Format, lint, typecheck
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-node@v7
        with:
          node-version: '24.x'
          cache: 'npm'
      - run: npm ci
      - run: npm run format:check
      - run: npm run lint
      - run: npm run typecheck

  unit-tests:
    name: Unit tests
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-node@v7
        with:
          node-version: '24.x'
          cache: 'npm'
      - run: npm ci
      - run: npm test

  check-dist:
    name: Check dist/ is up to date
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-node@v7
        with:
          node-version: '24.x'
          cache: 'npm'
      - run: npm ci
      - run: npm run build
      - name: Verify dist/ has no uncommitted changes
        run: |
          if ! git diff --exit-code -- dist; then
            echo "::error::dist/ is out of date. Run 'npm run pack' and commit the result."
            exit 1
          fi

  integration-test:
    name: Integration test
    needs: [unit-tests, check-dist]
    runs-on: ubuntu-24.04
    permissions:
      contents: read
      pull-requests: write
    steps:
      - uses: actions/checkout@v7

      # A real report from a real run, so the action is exercised against
      # coverage.py's actual output rather than a fixture someone hand-wrote.
      # The fixture leaves one branch of `divide` untested, so the project is
      # deliberately short of 100%.
      - name: Measure the fixture project
        run: |
          python3 -m pip install --quiet coverage
          cd tests/fixtures/project
          python3 -m coverage run --branch -m unittest discover -s . -p 'test_*.py'
          python3 -m coverage json -o "$GITHUB_WORKSPACE/coverage.json"

      - id: coverage
        name: Report, with a requirement the fixture meets
        uses: ./
        with:
          coverageFile: coverage.json
          minimumProjectCoverage: '10'

      - name: The output must be a percentage below 100
        run: |
          project='${{ steps.coverage.outputs.projectCoverage }}'
          echo "project coverage: $project"
          awk -v value="$project" 'BEGIN {
            if (value <= 0 || value >= 100) {
              print "::error::expected a percentage short of 100, got " value
              exit 1
            }
          }'

      # The gate has to fail the run, not just report: a threshold nothing can
      # meet must come back as a failed step.
      - id: gate
        name: Report, with a requirement nothing can meet
        uses: ./
        continue-on-error: true
        with:
          coverageFile: coverage.json
          minimumProjectCoverage: '100'
          comment: 'false'
      - name: That step must have failed
        run: |
          if [ '${{ steps.gate.outcome }}' != 'failure' ]; then
            echo "::error::the 100% requirement did not fail the step"
            exit 1
          fi

      # Only a pull request has a diff and a place to comment, so the rest of
      # the path is checked when the workflow runs as one.
      - name: The comment must be on the pull request
        if: github.event_name == 'pull_request'
        env:
          GH_TOKEN: ${{ github.token }}
        run: |
          bodies="$(gh api "repos/$GITHUB_REPOSITORY/issues/${{ github.event.number }}/comments" \
            --paginate --jq '.[].body')"
          if ! grep -q '<!-- python-coverage-action -->' <<< "$bodies"; then
            echo "::error::the action posted no comment on this pull request"
            exit 1
          fi