PFM-TASK-6308 refactor: improve coverage file detection and reporting for projects

Author: senthanal

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

@@ -9,9 +9,12 @@ jest.mock('fs', () => ({
   existsSync: jest.fn(),
   readFileSync: jest.fn(),
   writeFileSync: jest.fn(),
+  readdirSync: jest.fn(),
+  statSync: jest.fn(),
 }));
 jest.mock('path', () => ({
   resolve: jest.fn((_, p) => p),
+  join: jest.fn((...args) => args.join('/')),
 }));
 jest.mock('@actions/core', () => ({
   info: jest.fn(),
@@ -69,12 +72,13 @@ describe('coverage-evaluator', () => {
       mockGetProjectThresholds.mockReturnValue({ lines: 80, statements: 75 });
 
       const mockExistsSync = fs.existsSync as jest.Mock;
+      // All potential coverage file paths return false
       mockExistsSync.mockReturnValue(false);
 
       const result = evaluateCoverage(['project-a'], { global: {}, projects: {} });
 
       expect(result).toBe(1);
-      expect(core.warning).toHaveBeenCalledWith('No coverage report found for project-a at coverage/project-a/coverage-summary.json');
+      expect(core.warning).toHaveBeenCalledWith('No coverage report found for project-a');
 
       // Verify that the comment shows individual thresholds with "No Data"
       const writeFileSyncMock = fs.writeFileSync as jest.Mock;
@@ -94,7 +98,8 @@ describe('coverage-evaluator', () => {
       });
 
       const mockExistsSync = fs.existsSync as jest.Mock;
-      mockExistsSync.mockReturnValue(true);
+      // First path (specific project path) returns true
+      mockExistsSync.mockImplementation((path) => path.includes('coverage/project-a/coverage-summary.json'));
 
       const mockReadFileSync = fs.readFileSync as jest.Mock;
       mockReadFileSync.mockReturnValue(JSON.stringify({
@@ -132,7 +137,7 @@ describe('coverage-evaluator', () => {
       });
 
       const mockExistsSync = fs.existsSync as jest.Mock;
-      mockExistsSync.mockReturnValue(true);
+      mockExistsSync.mockImplementation((path) => path.includes('coverage/project-a/coverage-summary.json'));
 
       const mockReadFileSync = fs.readFileSync as jest.Mock;
       mockReadFileSync.mockReturnValue(JSON.stringify({
@@ -169,7 +174,7 @@ describe('coverage-evaluator', () => {
       });
 
       const mockExistsSync = fs.existsSync as jest.Mock;
-      mockExistsSync.mockReturnValue(true);
+      mockExistsSync.mockImplementation((path) => path.includes('coverage/project-a/coverage-summary.json'));
 
       const mockReadFileSync = fs.readFileSync as jest.Mock;
       mockReadFileSync.mockImplementation(() => {
@@ -179,7 +184,7 @@ describe('coverage-evaluator', () => {
       const result = evaluateCoverage(['project-a'], { global: {}, projects: {} });
 
       expect(result).toBe(1);
-      expect(core.error).toHaveBeenCalledWith('Error processing coverage for project-a: Test error');
+      expect(core.error).toHaveBeenCalledWith('Error reading coverage file coverage/project-a/coverage-summary.json: Test error');
 
       // Verify that the comment shows individual thresholds with "No Data"
       const writeFileSyncMock = fs.writeFileSync as jest.Mock;
@@ -200,7 +205,7 @@ describe('coverage-evaluator', () => {
       });
 
       const mockExistsSync = fs.existsSync as jest.Mock;
-      mockExistsSync.mockReturnValue(true);
+      mockExistsSync.mockImplementation((path) => path.includes('coverage/project-a/coverage-summary.json'));
 
       const mockReadFileSync = fs.readFileSync as jest.Mock;
       mockReadFileSync.mockReturnValue(JSON.stringify({
@@ -231,7 +236,7 @@ describe('coverage-evaluator', () => {
       mockGetProjectThresholds.mockReturnValue({});
 
       const mockExistsSync = fs.existsSync as jest.Mock;
-      mockExistsSync.mockReturnValue(true);
+      mockExistsSync.mockImplementation((path) => path.includes('coverage/project-a/coverage-summary.json'));
 
       const mockReadFileSync = fs.readFileSync as jest.Mock;
       mockReadFileSync.mockReturnValue(JSON.stringify({
@@ -250,6 +255,77 @@ describe('coverage-evaluator', () => {
       expect(core.info).toHaveBeenCalledWith('Project project-a passed all coverage thresholds');
     });
 
+    it('should find coverage files in alternative locations', () => {
+      const mockGetProjectThresholds = getProjectThresholds as jest.Mock;
+      mockGetProjectThresholds.mockReturnValue({
+        lines: 80,
+        statements: 80,
+        functions: 75,
+        branches: 70
+      });
+
+      const mockExistsSync = fs.existsSync as jest.Mock;
+      // First path fails, second path (apps/) succeeds
+      mockExistsSync.mockImplementation((path) => {
+        return path.includes('coverage/apps/project-a/coverage-summary.json');
+      });
+
+      const mockReadFileSync = fs.readFileSync as jest.Mock;
+      mockReadFileSync.mockReturnValue(JSON.stringify({
+        total: {
+          lines: { pct: 85 },
+          statements: { pct: 85 },
+          functions: { pct: 80 },
+          branches: { pct: 75 }
+        }
+      }));
+
+      const result = evaluateCoverage(['project-a'], { global: {}, projects: {} });
+
+      expect(result).toBe(0);
+      expect(core.info).toHaveBeenCalledWith('Found coverage file for project-a at: coverage/apps/project-a/coverage-summary.json');
+      expect(core.info).toHaveBeenCalledWith('Project project-a passed all coverage thresholds');
+    });
+
+    it('should handle global coverage file with project-specific data', () => {
+      const mockGetProjectThresholds = getProjectThresholds as jest.Mock;
+      mockGetProjectThresholds.mockReturnValue({
+        lines: 80,
+        statements: 80,
+        functions: 75,
+        branches: 70
+      });
+
+      const mockExistsSync = fs.existsSync as jest.Mock;
+      // Only the global coverage file exists
+      mockExistsSync.mockImplementation((path) => {
+        return path.includes('coverage/coverage-summary.json');
+      });
+
+      const mockReadFileSync = fs.readFileSync as jest.Mock;
+      // Global file contains data for multiple projects
+      mockReadFileSync.mockReturnValue(JSON.stringify({
+        'project-a': {
+          lines: { pct: 85 },
+          statements: { pct: 85 },
+          functions: { pct: 80 },
+          branches: { pct: 75 }
+        },
+        'project-b': {
+          lines: { pct: 90 },
+          statements: { pct: 90 },
+          functions: { pct: 85 },
+          branches: { pct: 80 }
+        }
+      }));
+
+      const result = evaluateCoverage(['project-a'], { global: {}, projects: {} });
+
+      expect(result).toBe(0);
+      expect(core.info).toHaveBeenCalledWith('Using project-specific coverage for project-a from global file');
+      expect(core.info).toHaveBeenCalledWith('Project project-a passed all coverage thresholds');
+    });
+
     it('should count multiple failures correctly', () => {
       // First project passes
       // Second project is skipped
@@ -283,7 +359,7 @@ describe('coverage-evaluator', () => {
         if (path.includes('project-d')) {
           return false; // No coverage file for project-d
         }
-        return true;
+        return path.includes('project-a') || path.includes('project-c');
       });
 
       const mockReadFileSync = fs.readFileSync as jest.Mock;
@@ -342,6 +418,32 @@ describe('coverage-evaluator', () => {
       // Artifact URL is included
       expect(comment).toContain('📊 [View Detailed HTML Coverage Reports](https://example.com/artifact)');
     });
+
+    it('should list available coverage files when debugging', () => {
+      const mockGetProjectThresholds = getProjectThresholds as jest.Mock;
+      mockGetProjectThresholds.mockReturnValue({ lines: 80 });
+
+      const mockExistsSync = fs.existsSync as jest.Mock;
+      mockExistsSync.mockImplementation((path) => {
+        // Coverage directory exists, but no project-specific files
+        return path === 'coverage';
+      });
+
+      const mockReaddirSync = fs.readdirSync as jest.Mock;
+      const mockStatSync = fs.statSync as jest.Mock;
+
+      // Mock directory structure
+      mockReaddirSync.mockReturnValue(['other-project', 'coverage-summary.json']);
+      mockStatSync.mockImplementation((path) => ({
+        isDirectory: () => path.includes('other-project')
+      }));
+
+      const result = evaluateCoverage(['project-a'], { global: {}, projects: {} });
+
+      expect(result).toBe(1);
+      expect(core.warning).toHaveBeenCalledWith('No coverage report found for project-a');
+      expect(core.warning).toHaveBeenCalledWith('No coverage file found for project-a. Available coverage files:');
+    });
   });
 
   describe('generateEmptyCoverageReport', () => {