@code-pushup/coverage-plugin 0.56.0 → 0.58.0

package/src/lib/runner/lcov/transform.js

@@ -0,0 +1,111 @@
+import { toNumberPrecision, toOrdinal } from '@code-pushup/utils';
+import { INVALID_FUNCTION_NAME } from '../constants.js';
+import { calculateCoverage, mergeConsecutiveNumbers } from './utils.js';
+export function lcovReportToFunctionStat(record) {
+    const validRecord = removeEmptyReport(record);
+    return {
+        totalFound: validRecord.functions.found,
+        totalHit: validRecord.functions.hit,
+        issues: validRecord.functions.hit < validRecord.functions.found
+            ? validRecord.functions.details
+                .filter(detail => !detail.hit)
+                .map((detail) => ({
+                message: `Function ${detail.name} is not called in any test case.`,
+                severity: 'error',
+                source: {
+                    file: validRecord.file,
+                    position: { startLine: detail.line },
+                },
+            }))
+            : [],
+    };
+}
+function removeEmptyReport(record) {
+    const validFunctions = record.functions.details.filter(detail => detail.name !== INVALID_FUNCTION_NAME);
+    if (validFunctions.length === record.functions.found) {
+        return record;
+    }
+    return {
+        ...record,
+        functions: {
+            details: validFunctions,
+            found: validFunctions.length,
+            hit: validFunctions.reduce((acc, fn) => acc + (fn.hit != null && fn.hit > 0 ? 1 : 0), 0),
+        },
+    };
+}
+export function lcovReportToLineStat(record) {
+    const missingCoverage = record.lines.hit < record.lines.found;
+    const lines = missingCoverage
+        ? record.lines.details
+            .filter(detail => !detail.hit)
+            .map(detail => detail.line)
+        : [];
+    const linePositions = mergeConsecutiveNumbers(lines);
+    return {
+        totalFound: record.lines.found,
+        totalHit: record.lines.hit,
+        issues: missingCoverage
+            ? linePositions.map((linePosition) => {
+                const lineReference = linePosition.end == null
+                    ? `Line ${linePosition.start} is`
+                    : `Lines ${linePosition.start}-${linePosition.end} are`;
+                return {
+                    message: `${lineReference} not covered in any test case.`,
+                    severity: 'warning',
+                    source: {
+                        file: record.file,
+                        position: {
+                            startLine: linePosition.start,
+                            endLine: linePosition.end,
+                        },
+                    },
+                };
+            })
+            : [],
+    };
+}
+export function lcovReportToBranchStat(record) {
+    return {
+        totalFound: record.branches.found,
+        totalHit: record.branches.hit,
+        issues: record.branches.hit < record.branches.found
+            ? record.branches.details
+                .filter(detail => !detail.taken)
+                .map((detail) => ({
+                message: `${toOrdinal(detail.branch + 1)} branch is not taken in any test case.`,
+                severity: 'error',
+                source: {
+                    file: record.file,
+                    position: { startLine: detail.line },
+                },
+            }))
+            : [],
+    };
+}
+export const recordToStatFunctionMapper = {
+    branch: lcovReportToBranchStat,
+    line: lcovReportToLineStat,
+    function: lcovReportToFunctionStat,
+};
+/**
+ *
+ * @param stat code coverage result for a given type
+ * @param coverageType code coverage type
+ * @returns Result of complete code ccoverage data coverted to AuditOutput
+ */
+export function lcovCoverageToAuditOutput(stat, coverageType) {
+    const coverage = calculateCoverage(stat.totalHit, stat.totalFound);
+    const MAX_DECIMAL_PLACES = 4;
+    const coveragePercentage = coverage * 100;
+    return {
+        slug: `${coverageType}-coverage`,
+        score: toNumberPrecision(coverage, MAX_DECIMAL_PLACES),
+        value: coveragePercentage,
+        displayValue: `${toNumberPrecision(coveragePercentage, 1)} %`,
+        details: {
+            issues: stat.issues,
+        },
+    };
+}
+//# sourceMappingURL=transform.js.map

package/src/lib/runner/lcov/transform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform.js","sourceRoot":"","sources":["../../../../../../../packages/plugin-coverage/src/lib/runner/lcov/transform.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAElE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAExD,OAAO,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAExE,MAAM,UAAU,wBAAwB,CAAC,MAAkB;IACzD,MAAM,WAAW,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAE9C,OAAO;QACL,UAAU,EAAE,WAAW,CAAC,SAAS,CAAC,KAAK;QACvC,QAAQ,EAAE,WAAW,CAAC,SAAS,CAAC,GAAG;QACnC,MAAM,EACJ,WAAW,CAAC,SAAS,CAAC,GAAG,GAAG,WAAW,CAAC,SAAS,CAAC,KAAK;YACrD,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,OAAO;iBAC1B,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;iBAC7B,GAAG,CACF,CAAC,MAAM,EAAS,EAAE,CAAC,CAAC;gBAClB,OAAO,EAAE,YAAY,MAAM,CAAC,IAAI,kCAAkC;gBAClE,QAAQ,EAAE,OAAO;gBACjB,MAAM,EAAE;oBACN,IAAI,EAAE,WAAW,CAAC,IAAI;oBACtB,QAAQ,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,EAAE;iBACrC;aACF,CAAC,CACH;YACL,CAAC,CAAC,EAAE;KACT,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAkB;IAC3C,MAAM,cAAc,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CACpD,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,qBAAqB,CAChD,CAAC;IAEF,IAAI,cAAc,CAAC,MAAM,KAAK,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACrD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO;QACL,GAAG,MAAM;QACT,SAAS,EAAE;YACT,OAAO,EAAE,cAAc;YACvB,KAAK,EAAE,cAAc,CAAC,MAAM;YAC5B,GAAG,EAAE,cAAc,CAAC,MAAM,CACxB,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACzD,CAAC,CACF;SACF;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,MAAkB;IACrD,MAAM,eAAe,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;IAC9D,MAAM,KAAK,GAAG,eAAe;QAC3B,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO;aACjB,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;aAC7B,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;QAC/B,CAAC,CAAC,EAAE,CAAC;IAEP,MAAM,aAAa,GAAG,uBAAuB,CAAC,KAAK,CAAC,CAAC;IAErD,OAAO;QACL,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK;QAC9B,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG;QAC1B,MAAM,EAAE,eAAe;YACrB,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,YAAY,EAAS,EAAE;gBACxC,MAAM,aAAa,GACjB,YAAY,CAAC,GAAG,IAAI,IAAI;oBACtB,CAAC,CAAC,QAAQ,YAAY,CAAC,KAAK,KAAK;oBACjC,CAAC,CAAC,SAAS,YAAY,CAAC,KAAK,IAAI,YAAY,CAAC,GAAG,MAAM,CAAC;gBAE5D,OAAO;oBACL,OAAO,EAAE,GAAG,aAAa,gCAAgC;oBACzD,QAAQ,EAAE,SAAS;oBACnB,MAAM,EAAE;wBACN,IAAI,EAAE,MAAM,CAAC,IAAI;wBACjB,QAAQ,EAAE;4BACR,SAAS,EAAE,YAAY,CAAC,KAAK;4BAC7B,OAAO,EAAE,YAAY,CAAC,GAAG;yBAC1B;qBACF;iBACF,CAAC;YACJ,CAAC,CAAC;YACJ,CAAC,CAAC,EAAE;KACP,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,MAAkB;IACvD,OAAO;QACL,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK;QACjC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG;QAC7B,MAAM,EACJ,MAAM,CAAC,QAAQ,CAAC,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK;YACzC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO;iBACpB,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;iBAC/B,GAAG,CACF,CAAC,MAAM,EAAS,EAAE,CAAC,CAAC;gBAClB,OAAO,EAAE,GAAG,SAAS,CACnB,MAAM,CAAC,MAAM,GAAG,CAAC,CAClB,wCAAwC;gBACzC,QAAQ,EAAE,OAAO;gBACjB,MAAM,EAAE;oBACN,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,QAAQ,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,EAAE;iBACrC;aACF,CAAC,CACH;YACL,CAAC,CAAC,EAAE;KACT,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,MAAM,EAAE,sBAAsB;IAC9B,IAAI,EAAE,oBAAoB;IAC1B,QAAQ,EAAE,wBAAwB;CACnC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CACvC,IAAc,EACd,YAA0B;IAE1B,MAAM,QAAQ,GAAG,iBAAiB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACnE,MAAM,kBAAkB,GAAG,CAAC,CAAC;IAC7B,MAAM,kBAAkB,GAAG,QAAQ,GAAG,GAAG,CAAC;IAE1C,OAAO;QACL,IAAI,EAAE,GAAG,YAAY,WAAW;QAChC,KAAK,EAAE,iBAAiB,CAAC,QAAQ,EAAE,kBAAkB,CAAC;QACtD,KAAK,EAAE,kBAAkB;QACzB,YAAY,EAAE,GAAG,iBAAiB,CAAC,kBAAkB,EAAE,CAAC,CAAC,IAAI;QAC7D,OAAO,EAAE;YACP,MAAM,EAAE,IAAI,CAAC,MAAM;SACpB;KACF,CAAC;AACJ,CAAC"}

package/src/lib/runner/lcov/types.d.ts

@@ -1,5 +1,5 @@
 import type { Issue } from '@code-pushup/models';
-import type { CoverageType } from '../../config';
+import type { CoverageType } from '../../config.js';
 export type LCOVStat = {
     totalFound: number;
     totalHit: number;

package/src/lib/runner/lcov/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/src/lib/runner/lcov/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../../packages/plugin-coverage/src/lib/runner/lcov/types.ts"],"names":[],"mappings":""}

package/src/lib/runner/lcov/utils.d.ts

@@ -1,4 +1,4 @@
-import type { NumberRange } from './types';
+import type { NumberRange } from './types.js';
 /**
  * This function calculates coverage as ratio of tested entities vs total
  * @param hit how many entities were executed in at least one test

package/src/lib/runner/lcov/utils.js

@@ -0,0 +1,25 @@
+/**
+ * This function calculates coverage as ratio of tested entities vs total
+ * @param hit how many entities were executed in at least one test
+ * @param found  how many entities were found overall
+ * @returns coverage between 0 and 1
+ */
+export function calculateCoverage(hit, found) {
+    return found > 0 ? hit / found : 1;
+}
+export function mergeConsecutiveNumbers(numberArr) {
+    return numberArr
+        .toSorted((a, b) => a - b)
+        .reduce((acc, currValue) => {
+        const prevValue = acc.at(-1);
+        if (prevValue != null &&
+            (prevValue.start === currValue - 1 || prevValue.end === currValue - 1)) {
+            return [
+                ...acc.slice(0, -1),
+                { start: prevValue.start, end: currValue },
+            ];
+        }
+        return [...acc, { start: currValue }];
+    }, []);
+}
+//# sourceMappingURL=utils.js.map

package/src/lib/runner/lcov/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../../../packages/plugin-coverage/src/lib/runner/lcov/utils.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAW,EAAE,KAAa;IAC1D,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,SAAmB;IACzD,OAAO,SAAS;SACb,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;SACzB,MAAM,CAAgB,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE;QACxC,MAAM,SAAS,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7B,IACE,SAAS,IAAI,IAAI;YACjB,CAAC,SAAS,CAAC,KAAK,KAAK,SAAS,GAAG,CAAC,IAAI,SAAS,CAAC,GAAG,KAAK,SAAS,GAAG,CAAC,CAAC,EACtE,CAAC;YACD,OAAO;gBACL,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBACnB,EAAE,KAAK,EAAE,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE;aAC3C,CAAC;QACJ,CAAC;QACD,OAAO,CAAC,GAAG,GAAG,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACxC,CAAC,EAAE,EAAE,CAAC,CAAC;AACX,CAAC"}

package/src/lib/utils.d.ts

@@ -1,5 +1,5 @@
 import type { AuditOutputs } from '@code-pushup/models';
-import type { CoverageType } from './config';
+import type { CoverageType } from './config.js';
 export declare const coverageDescription: Record<CoverageType, string>;
 /**
  * Since more code coverage does not necessarily mean better score, this optional override allows for defining custom coverage goals.

package/src/lib/utils.js

@@ -0,0 +1,22 @@
+export const coverageDescription = {
+    branch: 'Measures how many branches were executed after conditional statements in at least one test.',
+    line: 'Measures how many lines of code were executed in at least one test.',
+    function: 'Measures how many functions were called in at least one test.',
+};
+/**
+ * Since more code coverage does not necessarily mean better score, this optional override allows for defining custom coverage goals.
+ * @param outputs original results
+ * @param threshold threshold above which the score is to be 1
+ * @returns Outputs with overriden score (not value) to 1 if it reached a defined threshold.
+ */
+export function applyMaxScoreAboveThreshold(outputs, threshold) {
+    return outputs.map(output => output.score >= threshold ? { ...output, score: 1 } : output);
+}
+export const coverageTypeWeightMapper = {
+    /* eslint-disable @typescript-eslint/no-magic-numbers */
+    function: 6,
+    branch: 3,
+    line: 1,
+    /* eslint-enable @typescript-eslint/no-magic-numbers */
+};
+//# sourceMappingURL=utils.js.map

package/src/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../packages/plugin-coverage/src/lib/utils.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,mBAAmB,GAAiC;IAC/D,MAAM,EACJ,6FAA6F;IAC/F,IAAI,EAAE,qEAAqE;IAC3E,QAAQ,EAAE,+DAA+D;CAC1E,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACzC,OAAqB,EACrB,SAAiB;IAEjB,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAC1B,MAAM,CAAC,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAC7D,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,wBAAwB,GAAiC;IACpE,wDAAwD;IACxD,QAAQ,EAAE,CAAC;IACX,MAAM,EAAE,CAAC;IACT,IAAI,EAAE,CAAC;IACP,uDAAuD;CACxD,CAAC"}