feat: add coverage command #81
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Coverage | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| types: | |
| - opened | |
| - synchronize | |
| - reopened | |
| jobs: | |
| Linux: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| version: ['8.3'] | |
| type: ['cli', 'zts'] | |
| distro: ['bookworm'] | |
| outputs: | |
| matrix: ${{ toJson(matrix) }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| submodule: true | |
| - name: Setup buildx | |
| uses: docker/setup-buildx-action@v3 | |
| - name: Build container | |
| run: | | |
| docker compose build --pull --no-cache --build-arg PLATFORM="linux/amd64" --build-arg IMAGE="php" --build-arg TAG="${{ matrix.version }}-${{ matrix.type }}-${{ matrix.distro }}" | |
| - name: Test with gcov | |
| run: | | |
| docker compose run -v "$(pwd)/ext:/ext" --rm shell pskel coverage' | |
| - name: Upload coverage to artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-${{ matrix.version }}-${{ matrix.type }}-${{ matrix.distro }} | |
| path: ${{ github.workspace }}/ext/lcov.info | |
| Coverage: | |
| needs: [Linux] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Download coverage artifacts | |
| uses: actions/download-artifact@v4 | |
| - name: Merge coverages | |
| run: | | |
| sudo apt-get install -y "lcov" | |
| LCOV_FILES="$(find . -name "lcov.info")" | |
| CMD="$(which "lcov")" | |
| for LCOV_FILE in ${LCOV_FILES}; do | |
| CMD+=" -a ${LCOV_FILE}" | |
| done | |
| CMD+=" -o lcov.info" | |
| echo "Merging coverages: ${LCOV_FILES}" | |
| ${CMD} | |
| - name: Report coverage | |
| uses: k1LoW/octocov-action@v1 | |
| with: | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| config: .github/octocov.yml | |
| - name: Review for PR | |
| if: github.event_name == 'pull_request' | |
| uses: actions/github-script@v7 | |
| with: | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| script: | | |
| const fs = require('fs'); | |
| function parseLcovInfo(filename) { | |
| const content = fs.readFileSync(filename, 'utf8'); | |
| const lines = content.split('\n'); | |
| const uncoveredLines = {}; | |
| let currentFile = ''; | |
| for (const line of lines) { | |
| if (line.startsWith('SF:')) { | |
| currentFile = line.slice(3).trim(); | |
| } else if (line.startsWith('DA:')) { | |
| const [lineNo, hits] = line.slice(3).trim().split(',').map(Number); | |
| if (hits === 0) { | |
| if (!uncoveredLines[currentFile]) { | |
| uncoveredLines[currentFile] = []; | |
| } | |
| uncoveredLines[currentFile].push(lineNo); | |
| } | |
| } | |
| } | |
| return uncoveredLines; | |
| } | |
| function groupConsecutiveLines(lines) { | |
| if (lines.length === 0) return []; | |
| lines.sort((a, b) => a - b); | |
| const groups = []; | |
| let currentGroup = [lines[0]]; | |
| for (let i = 1; i < lines.length; i++) { | |
| if (lines[i] === lines[i-1] + 1) { | |
| currentGroup.push(lines[i]); | |
| } else { | |
| groups.push(currentGroup); | |
| currentGroup = [lines[i]]; | |
| } | |
| } | |
| groups.push(currentGroup); | |
| return groups; | |
| } | |
| async function createReviewForUncoveredLines(github, context, uncoveredLines) { | |
| const { owner, repo } = context.repo; | |
| const pull_number = context.payload.pull_request.number; | |
| const { data: files } = await github.rest.pulls.listFiles({ | |
| owner, | |
| repo, | |
| pull_number, | |
| }); | |
| const comments = []; | |
| for (const file of files) { | |
| const filename = file.filename; | |
| if (uncoveredLines['/' + filename]) { | |
| const groups = groupConsecutiveLines(uncoveredLines['/' + filename]); | |
| for (const group of groups) { | |
| const startLine = group[0]; | |
| const endLine = group[group.length - 1]; | |
| const commentBody = 'These lines are not covered by tests.'; | |
| const comment = { | |
| path: filename, | |
| body: commentBody, | |
| line: startLine, | |
| side: 'RIGHT', | |
| }; | |
| if (startLine !== endLine) { | |
| comment.start_line = startLine; | |
| comment.line = endLine; | |
| } | |
| comments.push(comment); | |
| } | |
| } | |
| } | |
| if (comments.length > 0) { | |
| await github.rest.pulls.createReview({ | |
| owner, | |
| repo, | |
| pull_number, | |
| commit_id: context.payload.pull_request.head.sha, | |
| body: 'Review for uncovered lines', | |
| event: 'COMMENT', | |
| comments, | |
| }); | |
| } | |
| } | |
| try { | |
| const uncoveredLines = parseLcovInfo('lcov.info'); | |
| await createReviewForUncoveredLines(github, context, uncoveredLines); | |
| } catch (error) { | |
| core.setFailed(`Action failed with error: ${error}`); | |
| } |