chore(plugin-coverage): include project path for issues reference

Author: Tlacenka

code-pushup.config.ts

@@ -48,12 +48,30 @@ const config: CoreConfig = {
     coveragePlugin({
       coverageType: ['branch', 'function', 'line'],
       reports: [
-        'coverage/cli/unit-tests/lcov.info',
-        'coverage/core/unit-tests/lcov.info',
-        'coverage/models/unit-tests/lcov.info',
-        'coverage/utils/unit-tests/lcov.info',
-        'coverage/plugin-eslint/unit-tests/lcov.info',
-        'coverage/plugin-coverage/unit-tests/lcov.info',
+        {
+          resultsPath: 'coverage/cli/unit-tests/lcov.info',
+          pathToProject: 'packages/cli',
+        },
+        {
+          resultsPath: 'coverage/core/unit-tests/lcov.info',
+          pathToProject: 'packages/core',
+        },
+        {
+          resultsPath: 'coverage/models/unit-tests/lcov.info',
+          pathToProject: 'packages/models',
+        },
+        {
+          resultsPath: 'coverage/utils/unit-tests/lcov.info',
+          pathToProject: 'packages/utils',
+        },
+        {
+          resultsPath: 'coverage/plugin-eslint/unit-tests/lcov.info',
+          pathToProject: 'packages/plugin-eslint',
+        },
+        {
+          resultsPath: 'coverage/plugin-coverage/unit-tests/lcov.info',
+          pathToProject: 'packages/plugin-coverage',
+        },
       ],
     }),
     fileSizePlugin({

e2e/cli-e2e/mocks/fixtures/code-pushup.config.coverage.ts

@@ -38,7 +38,12 @@ export default {
   plugins: [
     coveragePlugin({
       coverageType: ['branch', 'function', 'line'],
-      reports: [join('e2e', 'cli-e2e', 'mocks', 'fixtures', 'lcov.info')],
+      reports: [
+        {
+          resultsPath: join('e2e', 'cli-e2e', 'mocks', 'fixtures', 'lcov.info'),
+          pathToProject: join('packages', 'cli'),
+        },
+      ],
     }),
   ],
 } satisfies CoreConfig;

e2e/cli-e2e/tests/__snapshots__/collect.e2e.test.ts.snap

@@ -40,7 +40,7 @@ exports[`CLI collect > should run Code coverage plugin and create report.json 1`
                 "message": "Branch 1 is not taken in any test case.",
                 "severity": "error",
                 "source": {
-                  "file": "src/lib/partly-covered/utils.ts",
+                  "file": "packages/cli/src/lib/partly-covered/utils.ts",
                   "position": {
                     "startLine": 6,
                   },
@@ -50,7 +50,7 @@ exports[`CLI collect > should run Code coverage plugin and create report.json 1`
                 "message": "Branch 1 is not taken in any test case.",
                 "severity": "error",
                 "source": {
-                  "file": "src/lib/partly-covered/utils.ts",
+                  "file": "packages/cli/src/lib/partly-covered/utils.ts",
                   "position": {
                     "startLine": 10,
                   },
@@ -60,7 +60,7 @@ exports[`CLI collect > should run Code coverage plugin and create report.json 1`
                 "message": "Branch 0 is not taken in any test case.",
                 "severity": "error",
                 "source": {
-                  "file": "src/lib/not-covered/sorting.ts",
+                  "file": "packages/cli/src/lib/not-covered/sorting.ts",
                   "position": {
                     "startLine": 7,
                   },
@@ -70,7 +70,7 @@ exports[`CLI collect > should run Code coverage plugin and create report.json 1`
                 "message": "Branch 1 is not taken in any test case.",
                 "severity": "error",
                 "source": {
-                  "file": "src/lib/not-covered/sorting.ts",
+                  "file": "packages/cli/src/lib/not-covered/sorting.ts",
                   "position": {
                     "startLine": 7,
                   },
@@ -92,7 +92,7 @@ exports[`CLI collect > should run Code coverage plugin and create report.json 1`
                 "message": "Function formatReportScore is not called in any test case.",
                 "severity": "error",
                 "source": {
-                  "file": "src/lib/partly-covered/utils.ts",
+                  "file": "packages/cli/src/lib/partly-covered/utils.ts",
                   "position": {
                     "startLine": 2,
                   },
@@ -102,7 +102,7 @@ exports[`CLI collect > should run Code coverage plugin and create report.json 1`
                 "message": "Function sortReport is not called in any test case.",
                 "severity": "error",
                 "source": {
-                  "file": "src/lib/not-covered/sorting.ts",
+                  "file": "packages/cli/src/lib/not-covered/sorting.ts",
                   "position": {
                     "startLine": 1,
                   },
@@ -124,7 +124,7 @@ exports[`CLI collect > should run Code coverage plugin and create report.json 1`
                 "message": "Lines 7-9 are not covered in any test case.",
                 "severity": "warning",
                 "source": {
-                  "file": "src/lib/partly-covered/utils.ts",
+                  "file": "packages/cli/src/lib/partly-covered/utils.ts",
                   "position": {
                     "endLine": 9,
                     "startLine": 7,
@@ -135,7 +135,7 @@ exports[`CLI collect > should run Code coverage plugin and create report.json 1`
                 "message": "Lines 1-5 are not covered in any test case.",
                 "severity": "warning",
                 "source": {
-                  "file": "src/lib/not-covered/sorting.ts",
+                  "file": "packages/cli/src/lib/not-covered/sorting.ts",
                   "position": {
                     "endLine": 5,
                     "startLine": 1,

packages/plugin-coverage/README.md

@@ -1,6 +1,6 @@
 # @code-pushup/coverage-plugin
 
-**Code PushUp plugin for tracking code coverage.**
+🧪 **Code PushUp plugin for tracking code coverage.** ☂️
 
 This plugin allows you to measure and track code coverage on your project.
 
@@ -20,8 +20,7 @@ Measured coverage types are mapped to Code PushUp audits in the following way
 
    Pass coverage types you wish to track (line, branch or function), paths to the code coverage results in LCOV format and optionally define your code coverage tool to be run first.
 
-   > [!IMPORTANT]
-   > Please note that when you define the tool command, you still need to define the paths to the coverage results.
+   📌 Please note that when you define the tool command, you still need to define the paths to all relevant coverage results.
 
    The configuration will look similarly to the following:
 
@@ -34,7 +33,7 @@ Measured coverage types are mapped to Code PushUp audits in the following way
        // ...
        await coveragePlugin({
          coverageType: ['branch', 'function', 'line'],
-         reports: ['coverage/cli/lcov.info'],
+         reports: [{ resultsPath: 'coverage/cli/lcov.info', pathToProject: 'packages/cli' }],
          coverageToolCommand: {
            command: 'npx',
            args: ['jest', '--coverage', '--coverageReporters=lcov'],
@@ -46,8 +45,7 @@ Measured coverage types are mapped to Code PushUp audits in the following way
 
 4. (Optional) Reference audits which you wish to include in custom categories (use `npx code-pushup print-config` to list audits and groups).
 
-   > [!TIP]
-   > Assign weights based on what influence each coverage type should have on the overall category score (assign weight 0 to only include as extra info, without influencing category score).
+   💡 Assign weights based on what influence each coverage type should have on the overall category score (assign weight 0 to only include as extra info, without influencing category score).
 
    ```js
    export default {
@@ -124,7 +122,7 @@ It recognises the following entities:
 The plugin accepts the following parameters:
 
 - `coverageType`: An array of types of coverage that you wish to track. Supported values: `function`, `branch`, `line`.
-- `reports`: Array of paths to files with code coverage results. LCOV format is supported for now.
+- `reports`: Array of information about files with code coverage results - paths to results, path to project root the results belong to. LCOV format is supported for now.
 - (optional) `coverageToolCommand`: If you wish to run your coverage tool to generate the results first, you may define it here.
 - (optional) `perfectScoreThreshold`: If your coverage goal is not 100%, you may define it here in range 0-1. Any score above the defined threshold will be given the perfect score. The value will stay unaffected.
 

packages/plugin-coverage/src/lib/config.ts

@@ -3,6 +3,17 @@ import { z } from 'zod';
 export const coverageTypeSchema = z.enum(['function', 'branch', 'line']);
 export type CoverageType = z.infer<typeof coverageTypeSchema>;
 
+export const coverageReportSchema = z.object({
+  resultsPath: z.string().includes('lcov'),
+  pathToProject: z
+    .string({
+      description:
+        'Path from workspace root to project root. Necessary for LCOV reports.',
+    })
+    .optional(),
+});
+export type CoverageReport = z.infer<typeof coverageReportSchema>;
+
 export const coveragePluginConfigSchema = z.object({
   coverageToolCommand: z
     .object({
@@ -18,7 +29,7 @@ export const coveragePluginConfigSchema = z.object({
     .optional(),
   coverageType: z.array(coverageTypeSchema).min(1),
   reports: z
-    .array(z.string().includes('lcov'), {
+    .array(coverageReportSchema, {
       description:
         'Path to all code coverage report files. Only LCOV format is supported for now.',
     })

packages/plugin-coverage/src/lib/config.unit.test.ts

@@ -6,7 +6,12 @@ describe('coveragePluginConfigSchema', () => {
     expect(() =>
       coveragePluginConfigSchema.parse({
         coverageType: ['branch', 'function'],
-        reports: ['coverage/cli/lcov.info'],
+        reports: [
+          {
+            resultsPath: 'coverage/cli/lcov.info',
+            pathToProject: 'packages/cli',
+          },
+        ],
         coverageToolCommand: {
           command: 'npx nx run-many',
           args: ['-t', 'test', '--coverage'],
@@ -20,7 +25,7 @@ describe('coveragePluginConfigSchema', () => {
     expect(() =>
       coveragePluginConfigSchema.parse({
         coverageType: ['line'],
-        reports: ['coverage/cli/lcov.info'],
+        reports: [{ resultsPath: 'coverage/cli/lcov.info' }],
       } satisfies CoveragePluginConfig),
     ).not.toThrow();
   });
@@ -29,7 +34,7 @@ describe('coveragePluginConfigSchema', () => {
     expect(() =>
       coveragePluginConfigSchema.parse({
         coverageType: [],
-        reports: ['coverage/cli/lcov.info'],
+        reports: [{ resultsPath: 'coverage/cli/lcov.info' }],
       } satisfies CoveragePluginConfig),
     ).toThrow('too_small');
   });
@@ -47,8 +52,8 @@ describe('coveragePluginConfigSchema', () => {
     expect(() =>
       coveragePluginConfigSchema.parse({
         coverageType: ['line'],
-        reports: ['coverage/cli/coverage-final.json'],
-      }),
+        reports: [{ resultsPath: 'coverage/cli/coverage-final.json' }],
+      } satisfies CoveragePluginConfig),
     ).toThrow(/Invalid input: must include.+lcov/);
   });
 
@@ -68,7 +73,7 @@ describe('coveragePluginConfigSchema', () => {
     expect(() =>
       coveragePluginConfigSchema.parse({
         coverageType: ['line'],
-        reports: ['coverage/cli/lcov.info'],
+        reports: [{ resultsPath: 'coverage/cli/lcov.info' }],
         perfectScoreThreshold: 110,
       } satisfies CoveragePluginConfig),
     ).toThrow('too_big');

packages/plugin-coverage/src/lib/coverage-plugin.integration.test.ts

@@ -4,11 +4,18 @@ import { CoveragePluginConfig } from './config';
 import { coveragePlugin } from './coverage-plugin';
 
 describe('coveragePluginConfigSchema', () => {
+  const LCOV_PATH = join(
+    'packages',
+    'plugin-coverage',
+    'mocks',
+    'single-record-lcov.info',
+  );
+
   it('should initialise a Code coverage plugin', () => {
     expect(
       coveragePlugin({
         coverageType: ['function'],
-        reports: [join('packages', 'plugin-coverage', 'mocks', 'lcov.info')],
+        reports: [{ resultsPath: LCOV_PATH }],
       }),
     ).toStrictEqual(
       expect.objectContaining({
@@ -23,7 +30,7 @@ describe('coveragePluginConfigSchema', () => {
     expect(
       coveragePlugin({
         coverageType: ['function', 'branch'],
-        reports: [join('packages', 'plugin-coverage', 'mocks', 'lcov.info')],
+        reports: [{ resultsPath: LCOV_PATH }],
       }),
     ).toStrictEqual(
       expect.objectContaining({
@@ -43,7 +50,7 @@ describe('coveragePluginConfigSchema', () => {
     expect(
       coveragePlugin({
         coverageType: ['line'],
-        reports: [join('packages', 'plugin-coverage', 'mocks', 'lcov.info')],
+        reports: [{ resultsPath: LCOV_PATH }],
         coverageToolCommand: {
           command: 'npm run-many',
           args: ['-t', 'test', '--coverage'],
@@ -66,7 +73,7 @@ describe('coveragePluginConfigSchema', () => {
     expect(
       coveragePlugin({
         coverageType: ['line'],
-        reports: [join('packages', 'plugin-coverage', 'mocks', 'lcov.info')],
+        reports: [{ resultsPath: LCOV_PATH }],
       } satisfies CoveragePluginConfig),
     ).toStrictEqual(
       expect.objectContaining({

packages/plugin-coverage/src/lib/runner/lcov/__snapshots__/runner.integration.test.ts.snap

@@ -9,7 +9,7 @@ exports[`lcovResultsToAuditOutputs > should correctly convert lcov results to Au
           "message": "Branch 0 is not taken in any test case.",
           "severity": "error",
           "source": {
-            "file": "src/lib/utils.ts",
+            "file": "packages/cli/src/lib/utils.ts",
             "position": {
               "startLine": 6,
             },
@@ -19,7 +19,7 @@ exports[`lcovResultsToAuditOutputs > should correctly convert lcov results to Au
           "message": "Branch 0 is not taken in any test case.",
           "severity": "error",
           "source": {
-            "file": "src/lib/utils.ts",
+            "file": "packages/cli/src/lib/utils.ts",
             "position": {
               "startLine": 10,
             },
@@ -46,7 +46,7 @@ exports[`lcovResultsToAuditOutputs > should correctly convert lcov results to Au
           "message": "Lines 7-9 are not covered in any test case.",
           "severity": "warning",
           "source": {
-            "file": "src/lib/utils.ts",
+            "file": "packages/cli/src/lib/utils.ts",
             "position": {
               "endLine": 9,
               "startLine": 7,

packages/plugin-coverage/src/lib/runner/lcov/runner.integration.test.ts

@@ -11,7 +11,17 @@ describe('lcovResultsToAuditOutputs', () => {
      * Lines: 10 found, 7 covered (70% coverage) - merged into one issue with line range
      */
     const results = await lcovResultsToAuditOutputs(
-      [join('packages', 'plugin-coverage', 'mocks', 'single-record-lcov.info')],
+      [
+        {
+          resultsPath: join(
+            'packages',
+            'plugin-coverage',
+            'mocks',
+            'single-record-lcov.info',
+          ),
+          pathToProject: join('packages', 'cli'),
+        },
+      ],
       ['branch', 'function', 'line'],
     );
     expect(results).toMatchSnapshot();

packages/plugin-coverage/src/lib/runner/lcov/runner.ts

@@ -1,7 +1,10 @@
+import { join } from 'node:path';
 import type { LCOVRecord } from 'parse-lcov';
 import { AuditOutputs } from '@code-pushup/models';
-import { exists, readTextFile } from '@code-pushup/utils';
-import { CoverageType } from '../../config';
+import { readTextFile, toUnixPath } from '@code-pushup/utils';
+//TODO fix, why doesnt it know the exists import??
+import { exists } from '../../../../../models/src/lib/implementation/utils';
+import { CoverageReport, CoverageType } from '../../config';
 import { parseLcov } from './parse-lcov';
 import {
   lcovCoverageToAuditOutput,
@@ -19,15 +22,24 @@ import { LCOVStat, LCOVStats } from './types';
  * @returns Audit outputs with complete coverage data.
  */
 export async function lcovResultsToAuditOutputs(
-  reports: string[],
+  reports: CoverageReport[],
   coverageTypes: CoverageType[],
 ): Promise<AuditOutputs> {
   const parsedReports = await Promise.all(
     reports.map(report =>
-      readTextFile(report).then(reportContent => parseLcov(reportContent)),
+      readTextFile(toUnixPath(report.resultsPath))
+        .then(reportContent => parseLcov(reportContent))
+        .then(records =>
+          records.map<LCOVRecord>(record => ({
+            ...record,
+            file:
+              report.pathToProject == null
+                ? record.file
+                : join(report.pathToProject, record.file),
+          })),
+        ),
     ),
   );
-
   if (parsedReports.length !== reports.length) {
     throw new Error('Some provided LCOV reports were not valid.');
   }