PFM-TASK-6308 refactor: enhance coverage evaluation and reporting for affected projects

Author: senthanal

tools/scripts/run-many/affected-projects.ts

@@ -21,7 +21,7 @@ export function getAffectedProjects(
   jobCount: number,
   base: string,
   ref: string
-) {
+): string {
   let allAffectedProjects = [];
   if (target === 'e2e' && ref === '') {
     allAffectedProjects = Utils.getAllProjects(false, null, target);
@@ -32,5 +32,17 @@ export function getAffectedProjects(
   const projects = distributeProjectsEvenly(allAffectedProjects, jobCount);
   console.log(`Affected Projects:`);
   console.table(projects);
+
+  // Handle case when no projects are assigned to this job index
+  if (jobIndex - 1 >= projects.length || !projects[jobIndex - 1] || projects[jobIndex - 1].length === 0) {
+    return '';
+  }
+
   return projects[jobIndex - 1].join(',');
 }
+
+// Check if there are any affected projects
+export function hasAffectedProjects(base: string, target?: string): boolean {
+  const projects = Utils.getAllProjects(true, base, target);
+  return projects.length > 0;
+}

tools/scripts/run-many/coverage-evaluator.ts

@@ -30,15 +30,15 @@ export function evaluateCoverage(projects: string[], thresholds: ThresholdConfig
     core.info('No coverage thresholds defined, skipping evaluation');
     return true; // No thresholds defined, pass by default
   }
-  
+
   let allProjectsPassed = true;
   const coverageResults: ProjectCoverageResult[] = [];
-  
+
   core.info(`Evaluating coverage for ${projects.length} projects`);
-  
+
   for (const project of projects) {
     const projectThresholds = getProjectThresholds(project, thresholds);
-    
+
     // Skip projects with null thresholds
     if (projectThresholds === null) {
       core.info(`Coverage evaluation skipped for ${project}`);
@@ -50,9 +50,9 @@ export function evaluateCoverage(projects: string[], thresholds: ThresholdConfig
       });
       continue;
     }
-    
+
     const coveragePath = path.resolve(process.cwd(), `coverage/${project}/coverage-summary.json`);
-    
+
     if (!fs.existsSync(coveragePath)) {
       core.warning(`No coverage report found for ${project} at ${coveragePath}`);
       coverageResults.push({
@@ -64,42 +64,42 @@ export function evaluateCoverage(projects: string[], thresholds: ThresholdConfig
       allProjectsPassed = false;
       continue;
     }
-    
+
     try {
       const coverageData = JSON.parse(fs.readFileSync(coveragePath, 'utf8'));
       const summary = coverageData.total as CoverageSummary;
-      
+
       let projectPassed = true;
       const failedMetrics: string[] = [];
-      
+
       // Check each metric if threshold is defined
       if (projectThresholds.lines !== undefined && summary.lines.pct < projectThresholds.lines) {
         projectPassed = false;
         failedMetrics.push(`lines: ${summary.lines.pct.toFixed(2)}% < ${projectThresholds.lines}%`);
       }
-      
+
       if (projectThresholds.statements !== undefined && summary.statements.pct < projectThresholds.statements) {
         projectPassed = false;
         failedMetrics.push(`statements: ${summary.statements.pct.toFixed(2)}% < ${projectThresholds.statements}%`);
       }
-      
+
       if (projectThresholds.functions !== undefined && summary.functions.pct < projectThresholds.functions) {
         projectPassed = false;
         failedMetrics.push(`functions: ${summary.functions.pct.toFixed(2)}% < ${projectThresholds.functions}%`);
       }
-      
+
       if (projectThresholds.branches !== undefined && summary.branches.pct < projectThresholds.branches) {
         projectPassed = false;
         failedMetrics.push(`branches: ${summary.branches.pct.toFixed(2)}% < ${projectThresholds.branches}%`);
       }
-      
+
       if (!projectPassed) {
         core.error(`Project ${project} failed coverage thresholds: ${failedMetrics.join(', ')}`);
         allProjectsPassed = false;
       } else {
         core.info(`Project ${project} passed all coverage thresholds`);
       }
-      
+
       coverageResults.push({
         project,
         thresholds: projectThresholds,
@@ -122,10 +122,10 @@ export function evaluateCoverage(projects: string[], thresholds: ThresholdConfig
       allProjectsPassed = false;
     }
   }
-  
+
   // Post results to PR comment
   postCoverageComment(coverageResults);
-  
+
   return allProjectsPassed;
 }
 
@@ -134,9 +134,15 @@ export function evaluateCoverage(projects: string[], thresholds: ThresholdConfig
  */
 function formatCoverageComment(results: ProjectCoverageResult[], artifactUrl: string): string {
   let comment = '## Test Coverage Results\n\n';
+
+  if (results.length === 0) {
+    comment += 'No projects were evaluated for coverage.\n';
+    return comment;
+  }
+
   comment += '| Project | Metric | Threshold | Actual | Status |\n';
   comment += '|---------|--------|-----------|--------|--------|\n';
-  
+
   results.forEach(result => {
     if (result.status === 'SKIPPED') {
       comment += `| ${result.project} | All | N/A | N/A | ⏩ SKIPPED |\n`;
@@ -147,28 +153,28 @@ function formatCoverageComment(results: ProjectCoverageResult[], artifactUrl: st
       metrics.forEach((metric, index) => {
         // Skip metrics that don't have a threshold
         if (!result.thresholds[metric]) return;
-        
+
         const threshold = result.thresholds[metric];
         const actual = result.actual[metric].toFixed(2);
         const status = actual >= threshold ? '✅ PASSED' : '❌ FAILED';
-        
+
         // Only include project name in the first row for this project
         const projectCell = index === 0 ? result.project : '';
-        
+
         comment += `| ${projectCell} | ${metric} | ${threshold}% | ${actual}% | ${status} |\n`;
       });
     }
   });
-  
+
   // Add overall status
   const overallStatus = results.every(r => r.status !== 'FAILED') ? '✅ PASSED' : '❌ FAILED';
   comment += `\n### Overall Status: ${overallStatus}\n`;
-  
+
   // Add link to detailed HTML reports
   if (artifactUrl) {
     comment += `\n📊 [View Detailed HTML Coverage Reports](${artifactUrl})\n`;
   }
-  
+
   return comment;
 }
 
@@ -178,12 +184,24 @@ function formatCoverageComment(results: ProjectCoverageResult[], artifactUrl: st
 function postCoverageComment(results: ProjectCoverageResult[]): void {
   // The actual artifact URL will be provided by GitHub Actions in the workflow
   const artifactUrl = process.env.COVERAGE_ARTIFACT_URL || '';
-  
+
   const comment = formatCoverageComment(results, artifactUrl);
-  
+
   // Write to a file that will be used by thollander/actions-comment-pull-request action
   const gitHubCommentsFile = path.resolve(process.cwd(), 'coverage-report.txt');
   fs.writeFileSync(gitHubCommentsFile, comment);
-  
+
   core.info('Coverage results saved for PR comment');
 }
+
+/**
+ * Generates a coverage report when no projects are affected
+ */
+export function generateEmptyCoverageReport(): void {
+  const comment = '## Test Coverage Results\n\n⏩ No projects were affected by this change that require coverage evaluation.\n';
+
+  const gitHubCommentsFile = path.resolve(process.cwd(), 'coverage-report.txt');
+  fs.writeFileSync(gitHubCommentsFile, comment);
+
+  core.info('Empty coverage report generated (no affected projects)');
+}

tools/scripts/run-many/run-many.ts

@@ -1,9 +1,10 @@
 import { getAffectedProjects } from './affected-projects';
 import { execSync } from 'child_process';
 import * as core from '@actions/core';
+import * as fs from 'fs';
 import * as path from 'path';
 import { getCoverageThresholds } from './threshold-handler';
-import { evaluateCoverage } from './coverage-evaluator';
+import { evaluateCoverage, generateEmptyCoverageReport } from './coverage-evaluator';
 
 function getE2ECommand(command: string, base: string): string {
   command = command.concat(` -c ci --base=${base} --verbose`);
@@ -31,6 +32,12 @@ function runCommand(command: string): void {
   }
 }
 
+function ensureDirectoryExists(dirPath: string): void {
+  if (!fs.existsSync(dirPath)) {
+    fs.mkdirSync(dirPath, { recursive: true });
+  }
+}
+
 function main() {
   const target = process.argv[2];
   const jobIndex = Number(process.argv[3]);
@@ -46,22 +53,24 @@ function main() {
 
   core.info(`Inputs:\n target ${target},\n jobIndex: ${jobIndex},\n jobCount ${jobCount},\n base ${base},\n ref ${ref}`)
 
-  const projectsString = getAffectedProjects(target, jobIndex, jobCount, base, ref);
-  const projects = projectsString ? projectsString.split(',') : [];
-
   // Check if coverage gate is enabled
   const coverageEnabled = !!process.env.COVERAGE_THRESHOLDS;
 
-  if (coverageEnabled && target === 'test') {
-    core.info('Coverage gate is enabled');
-  }
+  // Get the affected projects
+  const projectsString = getAffectedProjects(target, jobIndex, jobCount, base, ref);
+  const projects = projectsString ? projectsString.split(',') : [];
+
+  // Check if there are any affected projects (for first job only, to avoid duplicate reports)
+  const areAffectedProjects = projects.length > 0;
+  const isFirstJob = jobIndex === 1;
 
   // Modified command construction
   const runManyProjectsCmd = `npx nx run-many --targets=${target} --projects="${projectsString}"`;
   let cmd = `${runManyProjectsCmd} --parallel=false --prod`;
 
   // Add coverage flag if enabled and target is test
   if (coverageEnabled && target === 'test') {
+    core.info('Coverage gate is enabled');
     // Add coverage reporters for HTML, JSON, and JUnit output
     cmd += ' --coverage --coverageReporters=json,lcov,text,clover,html,json-summary --reporters=default,jest-junit';
   }
@@ -70,7 +79,7 @@ function main() {
     cmd = getE2ECommand(cmd, base);
   }
 
-  if (projects.length > 0) {
+  if (areAffectedProjects) {
     runCommand(cmd);
 
     // Evaluate coverage if enabled and target is test
@@ -90,6 +99,15 @@ function main() {
     }
   } else {
     core.info('No affected projects :)');
+
+    // Generate empty coverage report for first job only when coverage is enabled
+    if (coverageEnabled && target === 'test' && isFirstJob) {
+      // Ensure coverage directory exists for artifact upload
+      ensureDirectoryExists(path.resolve(process.cwd(), 'coverage'));
+
+      // Generate empty report
+      generateEmptyCoverageReport();
+    }
   }
 }
 

tools/scripts/run-many/threshold-handler.ts

@@ -24,12 +24,12 @@ export function getCoverageThresholds(): ThresholdConfig {
   try {
     const thresholdConfig = JSON.parse(process.env.COVERAGE_THRESHOLDS);
     core.info(`Successfully parsed coverage thresholds`);
-    
+
     // Validate structure
     if (!thresholdConfig.global) {
       core.warning('No global thresholds defined in configuration');
     }
-    
+
     return thresholdConfig;
   } catch (error) {
     core.error(`Error parsing COVERAGE_THRESHOLDS: ${error.message}`);