Add test coverage report

Author: huntharo

.github/actions/coverage-report/action.yml

@@ -0,0 +1,41 @@
+name: 'Parse Coverage and Post Comment'
+description: 'Parses a coverage report and posts a comment on a PR'
+inputs:
+  lcov-file:
+    description: 'Path to the lcov.info file'
+    required: true
+  title:
+    description: 'Title of the comment'
+    default: 'Code Coverage Report'
+
+runs:
+  using: 'composite'
+  steps:
+    - name: Parse Coverage
+      shell: bash
+      if: github.event_name == 'pull_request'
+      id: parse
+      run: |
+        ./.github/actions/coverage-report/scripts/parse-coverage.js ${{ inputs.lcov-file }} > coverage-summary.txt
+        echo "coverage-summary<<EOF" >> $GITHUB_OUTPUT
+        cat coverage-summary.txt >> $GITHUB_OUTPUT
+        echo "EOF" >> $GITHUB_OUTPUT
+
+    - name: Find Coverage Comment
+      if: github.event_name == 'pull_request'
+      uses: peter-evans/find-comment@v3
+      id: fc
+      with:
+        issue-number: ${{ github.event.pull_request.number }}
+        comment-author: 'github-actions[bot]'
+        body-includes: '### 📊 ${{ inputs.title }}'
+
+    - name: Post Coverage Comment
+      uses: peter-evans/create-or-update-comment@v4
+      with:
+        comment-id: ${{ steps.fc.outputs.comment-id }}
+        edit-mode: replace
+        issue-number: ${{ github.event.pull_request.number }}
+        body: |
+          ### 📊 ${{ inputs.title }}
+          ${{ steps.parse.outputs.coverage-summary }}

.github/actions/coverage-report/scripts/parse-coverage.js

@@ -0,0 +1,126 @@
+#!/usr/bin/env node
+const lcovParse = require("lcov-parse");
+const fs = require("fs");
+
+const lcovPath = process.argv[2];
+const needsImprovementBelow = parseFloat(
+  process.argv.length >= 4 ? process.argv[3] : "90"
+);
+const poorBelow = parseFloat(process.argv[4] >= 5 ? process.argv[4] : "50");
+
+if (!lcovPath || isNaN(needsImprovementBelow) || isNaN(poorBelow)) {
+  console.error(
+    "Please provide the path to the lcov.info file and the 'needs-improvement-below' and 'poor-below' percentages as command-line arguments."
+  );
+  process.exit(1);
+}
+
+if (!fs.existsSync(lcovPath)) {
+  console.error(
+    `The file ${lcovPath} does not exist. Please provide the path to the lcov.info file.`
+  );
+  process.exit(1);
+}
+
+const outputFormat = "markdown";
+
+if (outputFormat === "markdown") {
+  console.log(
+    "| File | Lines | Lines Hit / Found | Uncovered Lines | Branches |"
+  );
+  console.log("| --- | --- | --- | --- | --- |");
+}
+
+function shortenPath(path, maxLength) {
+  if (path.length <= maxLength) {
+    return path;
+  }
+
+  const start = path.substring(0, maxLength / 2 - 2); // -2 for the '..' in the middle
+  const end = path.substring(path.length - maxLength / 2, path.length);
+
+  return `${start}..${end}`;
+}
+
+function getEmoji(lineCoverage, needsImprovementBelow, poorBelow) {
+  if (lineCoverage >= needsImprovementBelow) {
+    return "✅"; // white-check emoji
+  } else if (
+    lineCoverage < needsImprovementBelow &&
+    lineCoverage >= poorBelow
+  ) {
+    return "🟡"; // yellow-ball emoji
+  } else {
+    return "❌"; // red-x emoji
+  }
+}
+
+lcovParse(lcovPath, function (err, data) {
+  if (err) {
+    console.error(err);
+  } else {
+    let totalLinesHit = 0;
+    let totalLinesFound = 0;
+    let totalBranchesHit = 0;
+    let totalBranchesFound = 0;
+
+    data.forEach((file) => {
+      totalLinesHit += file.lines.hit;
+      totalLinesFound += file.lines.found;
+      totalBranchesHit += file.branches.hit;
+      totalBranchesFound += file.branches.found;
+      const relativePath = shortenPath(
+        file.file.replace(process.cwd(), ""),
+        50
+      );
+      const lineCoverage = ((file.lines.hit / file.lines.found) * 100).toFixed(
+        1
+      );
+      const branchCoverage = (
+        (file.branches.hit / file.branches.found) *
+        100
+      ).toFixed(1);
+      let emoji = getEmoji(lineCoverage, needsImprovementBelow, poorBelow);
+      if (outputFormat === "markdown") {
+        console.log(
+          `| ${relativePath} | ${emoji}&nbsp;${lineCoverage}% | ${
+            file.lines.hit
+          }&nbsp;/&nbsp;${file.lines.found} | ${
+            file.lines.found - file.lines.hit
+          } | ${file.branches.found === 0 ? "-" : `${branchCoverage}%`} |`
+        );
+      } else {
+        console.log(
+          `${emoji} File: ${relativePath}, Line Coverage: ${lineCoverage}%, Branch Coverage: ${branchCoverage}%`
+        );
+      }
+    });
+
+    const overallLineCoverage = (
+      (totalLinesHit / totalLinesFound) *
+      100
+    ).toFixed(1);
+    const overallBranchCoverage = (
+      (totalBranchesHit / totalBranchesFound) *
+      100
+    ).toFixed(1);
+    const totalUncoveredLines = totalLinesFound - totalLinesHit;
+    const overallEmoji = getEmoji(
+      overallLineCoverage,
+      needsImprovementBelow,
+      poorBelow
+    );
+
+    if (outputFormat === "markdown") {
+      console.log(
+        `| Overall | ${overallEmoji}&nbsp;${overallLineCoverage}% | ${totalLinesHit}&nbsp;/&nbsp;${totalLinesFound} | ${totalUncoveredLines} | ${
+          totalBranchesFound === 0 ? "-" : `${overallBranchCoverage}%`
+        } |`
+      );
+    } else {
+      console.log(
+        `Overall Line Coverage: ${overallLineCoverage}%, Overall Branch Coverage: ${overallBranchCoverage}%`
+      );
+    }
+  }
+});

.github/workflows/ci.yml

@@ -48,3 +48,10 @@ jobs:
 
       - name: Test
         run: npm run test
+
+      - name: Upload code coverage
+        if: github.event_name == 'pull_request' && needs.check-access.outputs.has-token-access == 'true'
+        uses: ./.github/actions/coverage-report
+        with:
+          lcov-file: coverage/lcov.info
+          title: Node.js Code Coverage Report

jest.config.js

@@ -42,7 +42,7 @@ module.exports = {
   //   "lcov",
   //   "clover"
   // ],
-  coverageReporters: ['html', 'text'],
+  coverageReporters: ['lcov', 'html', 'text'],
 
   // An object that configures minimum threshold enforcement for coverage results
   // coverageThreshold: undefined,