test: more testeable code, multiple comments

Author: Andres Adjimann

action.yml

@@ -20,6 +20,9 @@ inputs:
     app-name:
         description: App name to display on comment
         required: false
+    multiple-comment:
+      description: Add multiple comments
+      required: false
     max_lines:
       description: Maximum numbers of line print
       required: false

dist/main.js

@@ -1,9 +1,8 @@
-import path from "path";
-import fs from "fs";
 import { badgen } from "badgen";
+import path from "path";
 import { percentage } from "./lcov";
 
-const badge = (option, pct) => {
+export const badge = (option, pct) => {
     const { label = "coverage", style = "classic" } = option || {};
     const colorData = {
         "49c31a": [100],
@@ -28,20 +27,27 @@ const badge = (option, pct) => {
     return badgen(badgenArgs);
 };
 
-export const createBadges = (badgePath, toCheck, options) => {
-    const dirName = path.resolve(badgePath);
-    if (!fs.existsSync(dirName)) {
-        fs.mkdirSync(dirName);
-    } else if (!fs.statSync(dirName).isDirectory()) {
-        throw new Error("badge path is not a directory");
+export const badges = ({ rootLcov, lcovArray, options, mkDir, writeBadge }) => {
+    const badgeOptions = {
+        label: options.badgeLabel,
+        style: options.badgeStyle,
+    };
+    const toBadge = lcovArray.map((x) => x);
+    if (rootLcov) {
+        toBadge.push({
+            packageName: "root_package",
+            lcov: rootLcov,
+        });
     }
-    for (const lcovObj of toCheck) {
+    const dirName = path.resolve(options.badgePath);
+    mkDir(dirName);
+    for (const lcovObj of toBadge) {
         const coverage = percentage(lcovObj.lcov);
-        const svgStr = badge(options, coverage.toFixed(2));
+        const svgStr = badge(badgeOptions, coverage.toFixed(2));
         const fileName = path.join(dirName, `${lcovObj.packageName}.svg`);
         console.log("writing badge", fileName);
         try {
-            fs.writeFileSync(fileName, svgStr);
+            writeBadge(fileName, svgStr);
         } catch (err) {
             console.error("Error writing badge", fileName, err.toString());
         }

src/badge.js

@@ -1,19 +1,51 @@
 import { percentage } from "./lcov";
 
-export const checkCoverage = (minCoverage, toCheck) => {
+const checkCoverage = (toCheck) => {
     let accum = 0;
     for (const lcovObj of toCheck) {
         const coverage = percentage(lcovObj.lcov);
-        const isValidBuild = coverage >= minCoverage;
+        const isValidBuild = coverage >= toCheck.minCoverage;
         if (!isValidBuild) {
             return { isValidBuild, coverage, name: lcovObj.packageName };
         }
         accum += coverage;
     }
-
     return {
         isValidBuild: true,
         coverage: toCheck.length === 0 ? 0 : accum / toCheck.length,
         name: "average",
     };
 };
+
+export const checks = ({ rootLcov, lcovArray, options, setFailed, info }) => {
+    const excludedFiles = (options.excluded || "")
+        .split(" ")
+        .map((x) => x.trim())
+        .filter((x) => x.length > 0);
+    const toCheck = lcovArray
+        .filter((x) => !excludedFiles.some((y) => x.packageName === y))
+        .map((x) => ({ minCoverage: options.minCoverage, ...x }));
+    if (rootLcov && !options.excludeRoot) {
+        toCheck.unshift({
+            packageName: "root_package",
+            lcov: rootLcov,
+            minCoverage: options.minCoverage,
+        });
+    }
+    const { isValidBuild, coverage, name } = checkCoverage(toCheck);
+    if (!isValidBuild) {
+        setFailed(
+            `${coverage.toFixed(2)}% for ${name} is less than min_coverage ${
+                options.minCoverage
+            }.`,
+        );
+    } else {
+        info(
+            `Coverage: ${coverage.toFixed(
+                2,
+            )}% is greater than or equal to min_coverage ${
+                options.minCoverage
+            }.`,
+        );
+    }
+};

src/check.js

@@ -1,63 +1,53 @@
 import process from "process";
 import fs from "fs";
 import path from "path";
-import { diff, diffForMonorepo } from "./comment";
-import { getLcovArray, readLcov } from "./monorepo";
-import { checkCoverage } from "./check";
-import { createBadges } from "./badge";
+import { codeCoverageAssistant } from "./codeCoverageAssistant";
+import { getLcovArray } from "./monorepo";
 
-const addPackageName = (x) => ({
-    ...x,
-    ...{ packageName: x.dir.split("/").slice(-2)[0] },
-});
 const main = async () => {
     const file = process.argv[2];
-    const beforeFile = process.argv[3];
-
     const prefix = `${path.dirname(path.dirname(path.resolve(file)))}/`;
-    const options = {
-        repository: "example/foo",
-        commit: "f9d42291812ed03bb197e48050ac38ac6befe4e5",
-        prefix,
-        head: "feat/test",
-        base: "master",
-        maxLines: "10",
+    const baseClient = {
+        upsert: (title, body) => {
+            console.log("--> COMMENT", "title:", title, "body:", body);
+        },
+        mkDir: (dirName) => console.log("Creating directory", dirName),
+        writeBadge: (fileName) => console.log("written", fileName),
+        setFailed: (...x) => console.error("ERROR", ...x),
+        info: (...x) => console.log("INFO:", ...x),
+        options: {
+            repository: "example/foo",
+            prefix,
+            pullRequest: {
+                commit: "f9d42291812ed03bb197e48050ac38ac6befe4e5",
+                head: "feat/test",
+                base: "master",
+            },
+            maxLines: 100,
+            badgePath: "./badges",
+            appName: "someAppName",
+            minCoverage: 80,
+            multipleComment: true,
+        },
     };
-
     if (fs.statSync(file).isDirectory()) {
-        const lcovArrayForMonorepo = (
-            await getLcovArray(file, "lcov.info")
-        ).map(addPackageName);
-        console.log(
-            diffForMonorepo(
-                lcovArrayForMonorepo,
-                await getLcovArray(file, "lcov-base"),
-                options,
-            ),
-        );
-        createBadges("./badges", lcovArrayForMonorepo, {});
-        console.log(checkCoverage(90, lcovArrayForMonorepo));
-    } else {
-        const lcov = await readLcov(file);
-        console.log(
-            diff(lcov, beforeFile && (await readLcov(beforeFile)), options),
-        );
-        createBadges(
-            "./build",
-            {
-                packageName: "root",
-                lcov,
+        await codeCoverageAssistant({
+            ...baseClient,
+            readLCovs: async (fileFilter) => {
+                const arr = await getLcovArray(file, fileFilter);
+                return arr.map((x) => ({
+                    ...x,
+                    packageName: x.dir.split("/").slice(-2)[0],
+                }));
             },
-            {},
-        );
-        console.log(
-            checkCoverage(90, [
-                {
-                    packageName: "root",
-                    lcov,
-                },
-            ]),
-        );
+        });
+    } else {
+        await codeCoverageAssistant({
+            ...baseClient,
+            readLCovs: () => [],
+            lcovFile: file,
+            baseFile: "lcov-base",
+        });
     }
 };
 

src/cli.js

@@ -0,0 +1,40 @@
+import { readLcov } from "./monorepo";
+import { comments } from "./comment";
+import { checks } from "./check";
+import { badges } from "./badge";
+
+export const codeCoverageAssistant = async ({
+    readLCovs,
+    lcovFile,
+    baseFile,
+    options,
+    upsert,
+    mkDir,
+    writeBadge,
+    setFailed,
+    info,
+}) => {
+    const lcovArray = await readLCovs("lcov.info");
+    const lcovBaseArray =
+        lcovArray.length > 0 && (await readLCovs("lcov-base"));
+    // Always process root file if exists.
+    const rootLcov = lcovFile && (await readLcov(lcovFile));
+    const rootBaseLcov = rootLcov && baseFile && (await readLcov(baseFile));
+    // We cannot comment if is not a pull_request
+    if (options.pullRequest && options.maxLines > 0) {
+        await comments({
+            rootLcov,
+            rootBaseLcov,
+            lcovArray,
+            lcovBaseArray,
+            options,
+            upsert,
+        });
+    }
+    if (options.badgePath) {
+        await badges({ rootLcov, lcovArray, options, mkDir, writeBadge });
+    }
+    if (options.minCoverage) {
+        await checks({ rootLcov, lcovArray, options, setFailed, info });
+    }
+};

src/codeCoverageAssistant.js

@@ -1,4 +1,4 @@
-import { details, summary, b, fragment, table, tbody, tr, th, p } from "./html";
+import { b, details, fragment, p, summary, table, tbody, th, tr } from "./html";
 import { percentage } from "./lcov";
 import { tabulate } from "./tabulate";
 
@@ -35,7 +35,6 @@ const comparer = (otherArray) => (current) =>
     ).length === 0;
 
 const renderLcov = (lcov, base, appTitle, options) => {
-    const maxLines = options.maxLines || 15;
     const pbefore = base ? percentage(base) : 0;
     const pafter = base ? percentage(lcov) : 0;
     const pdiff = pafter - pbefore;
@@ -71,7 +70,7 @@ const renderLcov = (lcov, base, appTitle, options) => {
     }
     return [
         table(tbody(tr(...row))),
-        report.length > maxLines
+        report.length > options.maxLines
             ? p("Coverage Report too long to display")
             : details(summary("Coverage Report"), tabulate(report, options)),
         "<br/>",
@@ -81,10 +80,10 @@ const renderLcov = (lcov, base, appTitle, options) => {
 /**
  * Github comment for monorepo
  * @param {Array<{packageName, lcovPath}>} lcovArrayForMonorepo
- * @param {{Array<{packageName, lcovBasePath}>}} lcovBaseArrayForMonorepo
+ * @param {Array<{packageName, lcovPath}>} lcovBaseArrayForMonorepo
  * @param {*} options
  */
-const commentForMonorepo = (
+const renderCommentArray = (
     lcovArrayForMonorepo,
     lcovBaseArrayForMonorepo,
     options,
@@ -110,32 +109,65 @@ const commentForMonorepo = (
 
 /**
  * Github comment for single repo
- * @param {raw lcov} lcov
+ * @param {raw} lcov
+ * @param {raw} baseLcov
+ * @param {string} appTitle
  * @param {*} options
  */
-const comment = (lcov, before, options) => {
-    const { appName, base } = options;
+const renderCommentLine = (lcov, baseLcov, appTitle, options) => {
+    const inner = renderLcov(lcov, baseLcov, appTitle, options);
+    const { base } = options;
     const title = `Coverage after merging into ${b(base)} <p></p>`;
-    return fragment(title, renderLcov(lcov, before, appName, options));
+    return fragment(title, inner);
 };
 
-/**
- * Diff in coverage percentage for single repo
- * @param {raw lcov} lcov
- * @param {raw base lcov} before
- * @param {*} options
- */
-export const diff = (lcov, before, options) => comment(lcov, before, options);
-
-/**
- * Diff in coverage percentage for monorepo
- * @param {Array<{packageName, lcovPath}>} lcovArrayForMonorepo
- * @param {{Array<{packageName, lcovBasePath}>}} lcovBaseArrayForMonorepo
- * @param {*} options
- */
-export const diffForMonorepo = (
-    lcovArrayForMonorepo,
-    lcovBaseArrayForMonorepo,
+export const comments = async ({
+    rootLcov,
+    rootBaseLcov,
+    lcovArray,
+    lcovBaseArray,
     options,
-) =>
-    commentForMonorepo(lcovArrayForMonorepo, lcovBaseArrayForMonorepo, options);
+    upsert,
+}) => {
+    const renderOptions = {
+        maxLines: options.maxLines,
+        prefix: options.prefix,
+        repository: options.repository,
+        commit: options.pullRequest.head.sha,
+        head: options.pullRequest.head.ref,
+        base: options.pullRequest.base.ref,
+    };
+    // Comments
+    if (lcovArray.length > 0) {
+        if (options.multipleComment) {
+            for (const lcovObj of lcovArray) {
+                const baseLcov = lcovBaseArray.find(
+                    (el) => el.packageName === lcovObj.packageName,
+                );
+                const body = renderCommentLine(
+                    lcovObj.lcov,
+                    baseLcov && baseLcov.lcov,
+                    lcovObj.packageName,
+                    renderOptions,
+                );
+                await upsert(`m-${lcovObj.packageName}`, body);
+            }
+        } else {
+            const body = renderCommentArray(
+                lcovArray,
+                lcovBaseArray,
+                renderOptions,
+            );
+            await upsert("single-comment", body);
+        }
+    }
+    if (rootLcov) {
+        const body = renderCommentLine(
+            rootLcov,
+            rootBaseLcov,
+            "root",
+            renderOptions,
+        );
+        await upsert(`root-comment`, body);
+    }
+};