Refactored code of report generation (#6)

* Created PR threshold, refactored report's code

* Rebuilt index.js

* Fixed test

* Added check for coverage threshold

Author: ArtiomTr

.eslintrc

@@ -21,6 +21,12 @@
         "@typescript-eslint/no-non-null-assertion": "off",
         "@typescript-eslint/ban-types": "off",
         "no-console": "off",
+        "prettier/prettier": [
+            "error",
+            {
+                "endOfLine": "auto"
+            }
+        ],
         "simple-import-sort/imports": [
             "warn",
             {

.prettierrc

@@ -1,5 +1,6 @@
 {
     "tabWidth": 4,
     "printWidth": 80,
-    "singleQuote": true
+    "singleQuote": true,
+    "endOfLine": "auto"
 }

action.yml

@@ -7,15 +7,19 @@ branding:
 inputs:
     github_token:
         required: true
-        description: 'a github access token'
+        description: 'A github access token'
     test_script:
         required: false
-        description: 'a custom npm script to test'
+        description: 'A custom npm script to test'
         default: npx jest --silent --coverage --coverageReporters="text" --coverageReporters="text-summary"
+    threshold:
+        required: false
+        description: 'Coverage threshold. If total line coverage is less than threshold, PR will be rejected'
 runs:
     using: 'docker'
     image: 'Dockerfile'
     args:
         - ${{ inputs.github_token }}
         - ${{ inputs.test_script }}
         - ${{ inputs.directory }}
+        - ${{ inputs.threshold }}

dist/index.js

@@ -5,6 +5,7 @@
     "description": "",
     "main": "index.js",
     "scripts": {
+        "test": "jest",
         "test:coverage": "jest --silent --coverage --coverageReporters=\"text\" --coverageReporters=\"text-summary\"",
         "test:watch": "jest --watch",
         "start": "webpack --watch --mode development",

package.json

@@ -1,13 +1,16 @@
 import { getRawCoverage } from './getRawCoverage';
 import { parseCoverage } from './parseCoverage';
-import { ParsedCoverageDetails } from './parseCoverageDetails';
-import { ParsedCoverageSummary } from './parseCoverageSummary';
+import { ReportData } from '../report/generateReport';
 
 export const collectCoverage = async (
     testCommand: string,
     branch?: string
-): Promise<[ParsedCoverageSummary, ParsedCoverageDetails]> => {
+): Promise<ReportData> => {
     const source = await getRawCoverage(testCommand, branch);
 
-    return parseCoverage(source);
+    if (typeof source === 'string') {
+        return parseCoverage(source);
+    } else {
+        return source;
+    }
 };

src/collect-coverage/parseCoverage.ts

@@ -1,7 +1,13 @@
-import { setFailed } from '@actions/core';
 import { exec } from '@actions/exec';
 
-export const getRawCoverage = async (testCommand: string, branch?: string) => {
+import { FailReason } from '../report/generateReport';
+
+export const getRawCoverage = async (
+    testCommand: string,
+    branch?: string
+): Promise<
+    string | { success: false; failReason: FailReason.TESTS_FAILED }
+> => {
     if (branch) {
         try {
             await exec(`git fetch ${branch} --depth=1`);
@@ -23,7 +29,8 @@ export const getRawCoverage = async (testCommand: string, branch?: string) => {
             },
         });
     } catch (error) {
-        setFailed(`Test execution failed with message: "${error.message}"`);
+        console.error(`Test execution failed with message: "${error.message}"`);
+        return { success: false, failReason: FailReason.TESTS_FAILED };
     }
 
     return output;

src/collect-coverage/collectCoverage.ts renamed to src/collect/collectCoverage.ts

@@ -0,0 +1,18 @@
+import { parseCoverageDetails } from './parseCoverageDetails';
+import { parseCoverageSummary } from './parseCoverageSummary';
+import { FailReason, ReportData } from '../report/generateReport';
+
+export const parseCoverage = (source: string): ReportData => {
+    if (!source.includes('-') || !source.includes('=')) {
+        return {
+            success: false,
+            failReason: FailReason.INVALID_COVERAGE_FORMAT,
+        };
+    }
+
+    return {
+        success: true,
+        summary: parseCoverageSummary(source),
+        details: parseCoverageDetails(source),
+    };
+};

src/collect-coverage/getRawCoverage.ts renamed to src/collect/getRawCoverage.ts

@@ -0,0 +1,3 @@
+import { heading } from '../format/strings.json';
+
+export const MESSAGE_HEADING = `## ${heading}`;

src/collect/parseCoverage.ts

@@ -1,5 +1,5 @@
 import { formatCoverageDetailsPart } from './formatCoverageDetailsPart';
-import { ParsedCoverageDetails } from '../../collect-coverage/parseCoverageDetails';
+import { ParsedCoverageDetails } from '../../collect/parseCoverageDetails';
 import { getDecreasedCoverage } from '../getters/getDecreasedCoverage';
 import { getNewFilesCoverage } from '../getters/getNewFilesCoverage';
 import { details } from '../strings.json';

src/collect-coverage/parseCoverageDetails.ts renamed to src/collect/parseCoverageDetails.ts

@@ -1,7 +1,7 @@
 import markdownTable from 'markdown-table';
 
 import { getFileCoverageDetailRow } from './getFileCoverageDetailRow';
-import { ParsedCoverageDetails } from '../../collect-coverage/parseCoverageDetails';
+import { ParsedCoverageDetails } from '../../collect/parseCoverageDetails';
 import { details } from '../strings.json';
 import { createMarkdownSpoiler } from '../utils/createMarkdownSpoiler';
 import { formatHeadingAndTable } from '../utils/formatHeadingAndTable';

src/collect-coverage/parseCoverageSummary.ts renamed to src/collect/parseCoverageSummary.ts

@@ -1,4 +1,4 @@
-import { FileCoverageDetail } from '../../collect-coverage/parseCoverageDetails';
+import { FileCoverageDetail } from '../../collect/parseCoverageDetails';
 import { formatPercentage } from '../utils/formatPercentage';
 
 export const getFileCoverageDetailRow = (

src/constants/MESSAGE_HEADING.ts

@@ -1,17 +1,15 @@
 import { formatCoverageDetails } from './details/formatCoverageDetails';
 import { formatCoverageSummary } from './summary/formatCoverageSummary';
-import { ParsedCoverageDetails } from '../collect-coverage/parseCoverageDetails';
-import { ParsedCoverageSummary } from '../collect-coverage/parseCoverageSummary';
-import { MESSAGE_HEADING } from '../fetchPreviousComment';
+import { ParsedCoverageDetails } from '../collect/parseCoverageDetails';
+import { ParsedCoverageSummary } from '../collect/parseCoverageSummary';
 
-export const getCommentBody = (
+export const getFormattedCoverage = (
     headSummary: ParsedCoverageSummary,
     baseSummary: ParsedCoverageSummary,
     headDetails: ParsedCoverageDetails,
     baseDetails: ParsedCoverageDetails
 ): string => {
     return [
-        MESSAGE_HEADING,
         formatCoverageSummary(headSummary, baseSummary),
         formatCoverageDetails(headDetails, baseDetails),
     ]

src/comment-body/details/formatCoverageDetails.ts renamed to src/format/details/formatCoverageDetails.ts

@@ -0,0 +1,25 @@
+import { errorIcon, errors } from './strings.json';
+import { FailReason } from '../report/generateReport';
+
+const insertArgs = (
+    text: string,
+    args: Record<string, string | number | undefined>
+) => {
+    Object.keys(args).forEach(
+        (argName) =>
+            args[argName] !== undefined &&
+            args[argName] !== null &&
+            (text = text.replace(`{{ ${argName} }}`, args[argName] as string))
+    );
+    return text;
+};
+
+export const getFormattedFailReason = (
+    reason: FailReason,
+    coverageThreshold?: number,
+    currentCoverage?: number
+): string =>
+    `${errorIcon} ${insertArgs(errors[reason], {
+        coverageThreshold,
+        currentCoverage,
+    })}`;

src/comment-body/details/formatCoverageDetailsPart.ts renamed to src/format/details/formatCoverageDetailsPart.ts

@@ -1,7 +1,7 @@
 import {
     FileCoverageDetail,
     ParsedCoverageDetails,
-} from '../../collect-coverage/parseCoverageDetails';
+} from '../../collect/parseCoverageDetails';
 
 const coverageLessThan = (
     first: FileCoverageDetail,

src/comment-body/details/getFileCoverageDetailRow.ts renamed to src/format/details/getFileCoverageDetailRow.ts

@@ -1,4 +1,4 @@
-import { ParsedCoverageDetails } from '../../collect-coverage/parseCoverageDetails';
+import { ParsedCoverageDetails } from '../../collect/parseCoverageDetails';
 
 export const getNewFilesCoverage = (
     headDetails: ParsedCoverageDetails,

src/comment-body/getCommentBody.ts renamed to src/format/getFormattedCoverage.ts

@@ -1,7 +1,14 @@
 {
     "increaseIcon": "🔼",
     "decreaseIcon": "🔻",
+    "errorIcon": "❌",
     "heading": "jest coverage report 🧪",
+    "errors": {
+        "testsFailed": "The test suite failed. Please, check the console output for more details.",
+        "invalidFormat": "Output of test script has invalid format. Check [documentation](https://github.com/ArtiomTr/jest-coverage-report-action#jest-coverage-report-) for more details.",
+        "tooSmallCoverage": "Total coverage is too small. Current coverage is {{ currentCoverage }}, but it should be at least {{ coverageThreshold }}.",
+        "unknownError": "Something went wrong. If this is an issue of jest-coverage-report-action, please report about it [here](https://github.com/ArtiomTr/jest-coverage-report-action/issues/new)."
+    },
     "summary": {
         "heading": "Total coverage",
         "columnHeaders": ["Category", "Percentage", "Covered / Total"],

src/format/getFormattedFailReason.ts

@@ -1,6 +1,6 @@
 import table from 'markdown-table';
 
-import { ParsedCoverageSummary } from '../../collect-coverage/parseCoverageSummary';
+import { ParsedCoverageSummary } from '../../collect/parseCoverageSummary';
 import { summary } from '../strings.json';
 import { formatPercentage } from '../utils/formatPercentage';
 

src/comment-body/getters/getDecreasedCoverage.ts renamed to src/format/getters/getDecreasedCoverage.ts

@@ -3,9 +3,8 @@ import { argv } from 'process';
 import { setFailed } from '@actions/core';
 import { context, getOctokit } from '@actions/github';
 
-import { collectCoverage } from './collect-coverage/collectCoverage';
-import { getCommentBody } from './comment-body/getCommentBody';
-import { fetchPreviousComment } from './fetchPreviousComment';
+import { collectCoverage } from './collect/collectCoverage';
+import { FailReason, generateReport } from './report/generateReport';
 
 async function run() {
     try {
@@ -20,43 +19,46 @@ async function run() {
             );
         }
 
-        const [token, testScript] = argv.slice(2);
+        const [token, testScript, coverageThresholdStr] = argv.slice(2);
 
-        const octokit = getOctokit(token);
+        const coverageThreshold = coverageThresholdStr
+            ? parseFloat(coverageThresholdStr)
+            : undefined;
 
-        const [headSummary, headDetails] = await collectCoverage(testScript);
-        const [baseSummary, baseDetails] = await collectCoverage(testScript);
+        if (
+            coverageThreshold !== undefined &&
+            (coverageThreshold > 100 || coverageThreshold < 0)
+        ) {
+            throw new Error(
+                `Specified threshold '${coverageThreshold}' is not valid. Threshold should be more than 0 and less than 100.`
+            );
+        }
 
-        const previousComment = await fetchPreviousComment(
-            octokit,
-            repo,
-            pull_request
-        );
+        const octokit = getOctokit(token);
 
-        const body = getCommentBody(
-            headSummary,
-            baseSummary,
-            headDetails,
-            baseDetails
-        );
+        const headReport = await collectCoverage(testScript);
+        const baseReport = await collectCoverage(testScript);
 
-        try {
-            if (previousComment) {
-                await octokit.issues.deleteComment({
-                    ...repo,
-                    comment_id: (previousComment as { id: number }).id,
-                });
-            }
-            await octokit.issues.createComment({
-                ...repo,
-                issue_number: pull_request.number,
-                body,
-            });
-        } catch (error) {
-            console.error(
-                "Error deleting and/or creating comment. This can happen for PR's originating from a fork without write permissions."
-            );
+        if (
+            coverageThreshold !== undefined &&
+            headReport.success &&
+            headReport.summary &&
+            headReport.details &&
+            !headReport.failReason &&
+            headReport.summary.lines.percentage < coverageThreshold
+        ) {
+            headReport.success = false;
+            headReport.failReason = FailReason.TOO_SMALL_TOTAL_COVERAGE;
         }
+
+        await generateReport(
+            headReport,
+            baseReport,
+            coverageThreshold,
+            repo,
+            pull_request,
+            octokit
+        );
     } catch (error) {
         setFailed(error.message);
     }

src/comment-body/getters/getNewFilesCoverage.ts renamed to src/format/getters/getNewFilesCoverage.ts

@@ -1,10 +1,8 @@
 import { getOctokit } from '@actions/github';
 
-import { heading } from './comment-body/strings.json';
+import { MESSAGE_HEADING } from '../constants/MESSAGE_HEADING';
 
-export const MESSAGE_HEADING = `## ${heading}`;
-
-export async function fetchPreviousComment(
+export async function fetchPreviousReport(
     octokit: ReturnType<typeof getOctokit>,
     repo: { owner: string; repo: string },
     pr: { number: number }
@@ -20,5 +18,6 @@ export async function fetchPreviousComment(
     const sizeLimitComment = commentList.find((comment) =>
         (comment as { body: string }).body.startsWith(MESSAGE_HEADING)
     );
+
     return !sizeLimitComment ? null : sizeLimitComment;
 }