Merge pull request #229 from bp-cos/feature/build-process

feat(build-process-updates). Introduced thresholds, pre-push and volta to the angular project

Author: bp-cos

.github/counter/counter.test.display.js

@@ -0,0 +1,17 @@
+const fs = require('fs');
+const path = require('path');
+
+const filePath = path.join(__dirname, 'counter.txt');
+
+try {
+  // Read current value
+  let current = 0;
+  if (fs.existsSync(filePath)) {
+    const content = fs.readFileSync(filePath, 'utf8').trim();
+    current = parseInt(content, 10) || 0;
+  }
+
+  console.info(`\n\nTests ran: ${current}\n\n`);
+} catch (err) {
+  console.error('Error updating counter:', err.message);
+}

.github/counter/counter.test.increment.js

@@ -0,0 +1,22 @@
+const fs = require('fs');
+const path = require('path');
+
+const filePath = path.join(__dirname, 'counter.txt');
+
+try {
+  // Read current value
+  let current = 0;
+  if (fs.existsSync(filePath)) {
+    const content = fs.readFileSync(filePath, 'utf8').trim();
+    current = parseInt(content, 10) || 0;
+  }
+
+  // Increment
+  const updated = current + 1;
+
+  // Write back
+  fs.writeFileSync(filePath, String(updated));
+  console.info(`\n\nCounter updated: ${current} → ${updated}\n\n`);
+} catch (err) {
+  console.error('Error updating counter:', err.message);
+}

.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

.gitignore

@@ -37,6 +37,8 @@ yarn-error.log
 testem.log
 /typings
 
+.github/counter/counter.txt
+
 # System files
 .DS_Store
 Thumbs.db

.husky/pre-commit

@@ -1 +1,4 @@
-npx lint-staged
+npx lint-staged || {
+  printf "\n\nERROR: Linting issues were found in the committed files. Please address them before proceeding.\n\n\n\n"
+  exit 1
+}

.husky/pre-push

@@ -0,0 +1,11 @@
+npm run build
+
+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,9 @@
 module.exports = {
   preset: 'jest-preset-angular',
   setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
+  globalSetup: '<rootDir>/jest.global-setup.ts',
+  collectCoverage: true,
+  coverageReporters: ['json-summary', 'lcov', 'clover'],
   moduleNameMapper: {
     '^@osf/(.*)$': '<rootDir>/src/app/$1',
     '^@core/(.*)$': '<rootDir>/src/app/core/$1',
@@ -30,6 +33,14 @@ module.exports = {
     '!src/app/**/public-api.ts',
   ],
   extensionsToTreatAsEsm: ['.ts'],
+  coverageThreshold: {
+    global: {
+      branches: 11.89,
+      functions: 12.12,
+      lines: 37.27,
+      statements: 37.83,
+    },
+  },
   testPathIgnorePatterns: [
     '<rootDir>/src/app/features/registry/',
     '<rootDir>/src/app/features/project/',

jest.global-setup.ts

@@ -0,0 +1,9 @@
+import { execSync } from 'child_process';
+
+export default async function globalSetup(): Promise<void> {
+  try {
+    execSync('node .github/counter/counter.test.increment.js', { stdio: 'inherit' });
+  } catch (err) {
+    console.error('Test counter failed to increment:', err);
+  }
+}

package.json

@@ -6,9 +6,13 @@
     "start": "ng serve",
     "build": "ng build",
     "watch": "ng build --watch --configuration development",
-    "test": "jest",
+    "test": "jest && npm run test:display",
     "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage",
+    "test:coverage": "jest --coverage && npm run test:display",
+    "test:check-coverage-thresholds": "node .github/scripts/check-coverage-thresholds.js",
+    "test:counter": "node .github/counter/counter.test.increment.js",
+    "test:display": "node .github/counter/counter.test.display.js",
+    "ci": "npm run lint && jest --coverage",
     "lint": "ng lint",
     "lint:fix": "ng lint --fix",
     "format": "prettier --write .",
@@ -90,5 +94,9 @@
       "prettier --write",
       "eslint --fix"
     ]
+  },
+  "volta": {
+    "node": "22.13.1",
+    "npm": "10.9.2"
   }
 }