feat(check-coverage): Added a coverage check locally and during the build process

Author: bp-cos

.github/scripts/check-coverage-thresholds.js

@@ -0,0 +1,31 @@
+const fs = require('fs');
+const { execSync } = require('child_process');
+const coverage = require('../../coverage/coverage-summary.json');
+const jestConfig = require('../../jest.config.js');
+
+const summary = coverage.total;
+const thresholds = jestConfig.coverageThreshold.global;
+
+let failed = false;
+const errors = [];
+for (const key of ['branches', 'functions', 'lines', 'statements']) {
+  const current = summary[key].pct;
+  const threshold = thresholds[key];
+  if (current > threshold) {
+    errors.push(
+      `Coverage for ${key} (${current}%) is above the threshold (${threshold}%).\n\tPlease update the coverageThreshold.global.${key} in the jest.config.js to ${current}!`
+    )
+    failed = true;
+  }
+}
+
+if (failed) {
+  execSync('clear', { stdio: 'inherit' });
+  console.log('\n\nCongratulations! You have successfully run the coverage check and added tests.');
+  console.log('\n\nThe jest.config.js file is not insync with your new test additions.');
+  console.log('Please update the coverage thresholds in jest.config.js.');
+  console.log('You will need to commit again once you have updated the jst.config.js file.');
+  console.log('This is only necessary until we hit 100% coverage.\n\n');
+  errors.forEach(err => console.error(`${err}\n`));
+  process.exit(1);
+}

.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Run Jest Tests
+
+on:
+  pull_request:
+    branches: ['*'] # or change to match your default branch
+  push:
+    branches: ['*']
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.13.1
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run Jest tests with coverage
+        run: npm run ci
+
+      - name: Check coverage thresholds
+        run: npm run test:check-coverage-thresholds

.husky/pre-push

@@ -4,3 +4,8 @@ npm run test:coverage || {
   printf "\n\nERROR: Testing errors or coverage issues were found. Please address them before proceeding.\n\n\n\n"
   exit 1
 }
+
+npm run test:check-coverage-thresholds || {
+  printf "\n\nERROR: Coverage thresholds were not met. Please address them before proceeding.\n\n\n\n"
+  exit 1
+}

jest.config.js

@@ -1,6 +1,8 @@
 module.exports = {
   preset: 'jest-preset-angular',
   setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
+  collectCoverage: true,
+  coverageReporters: ['json-summary', 'lcov', 'clover'],
   moduleNameMapper: {
     '^@osf/(.*)$': '<rootDir>/src/app/$1',
     '^@core/(.*)$': '<rootDir>/src/app/core/$1',
@@ -32,10 +34,10 @@ module.exports = {
   extensionsToTreatAsEsm: ['.ts'],
   coverageThreshold: {
     global: {
-      statements: 37.83,
       branches: 11.89,
       functions: 12.12,
       lines: 37.27,
+      statements: 37.83,
     },
   },
   testPathIgnorePatterns: [

package.json

@@ -9,6 +9,7 @@
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
+    "test:check-coverage-thresholds": "node .github/scripts/check-coverage-thresholds.js",
     "ci": "npm run lint && npm run test:coverage",
     "lint": "ng lint",
     "lint:fix": "ng lint --fix",