Handle enforcing minimal coverage value

Author: bartosz347

dist/main/index.js

@@ -7,10 +7,6 @@ const lcovTotal = require("lcov-total");
 const os = require('os');
 const path = require('path');
 
-function commentIdentifier(workflowName) {
-	return `### [LCOV](https://github.com/marketplace/actions/report-lcov) of commit`
-}
-
 async function run() {
   try {
     await exec.exec('sudo apt-get install -y lcov');
@@ -28,67 +24,73 @@ async function run() {
     const minimumCoverage = core.getInput('minimum-coverage');
     const gitHubToken = core.getInput('github-token').trim();
     const errorMessage = `The code coverage is too low. Expected at least ${minimumCoverage}.`;
-    const isFailure = totalCoverage < minimumCoverage;
+    const isMinimumCoverageReached = totalCoverage >= minimumCoverage;
 
     if (gitHubToken !== '' && github.context.eventName === 'pull_request') {
       const octokit = await github.getOctokit(gitHubToken);
       const summary = await summarize(coverageFile);
       const details = await detail(coverageFile, octokit);
       const sha = github.context.payload.pull_request.head.sha;
       const shaShort = sha.substr(0, 7);
-      let body = `### [LCOV](https://github.com/marketplace/actions/report-lcov) of commit [<code>${shaShort}</code>](${github.context.payload.pull_request.number}/commits/${sha}) during [${github.context.workflow} #${github.context.runNumber}](../actions/runs/${github.context.runId})\n<pre>${summary}\n\nFiles changed coverage rate:${details}</pre>`;
+      const commentHeaderPrefix = '### [LCOV](https://github.com/marketplace/actions/report-lcov) of commit';
+      let body = `${commentHeaderPrefix} [<code>${shaShort}</code>](${github.context.payload.pull_request.number}/commits/${sha}) during [${github.context.workflow} #${github.context.runNumber}](../actions/runs/${github.context.runId})\n<pre>${summary}\n\nFiles changed coverage rate:${details}</pre>`;
 
-      if (isFailure) {
+      if (!isMinimumCoverageReached) {
         body += `\n:no_entry: ${errorMessage}`;
       }
 
-      const updateGitHubComment = commentId =>
-          octokit.issues.updateComment({
-            repo: github.context.repo.repo,
-            owner: github.context.repo.owner,
-            comment_id: commentId,
-            body,
-          })
-
-      if (updateComment == "true") {
-        const issueComments = await octokit.issues.listComments({
-          repo: github.context.repo.repo,
-          owner: github.context.repo.owner,
-          issue_number: github.context.payload.pull_request.number,
-        })
-
-        const existingComment = issueComments.data.find(comment =>
-            comment.body.includes(commentIdentifier(process.env.GITHUB_WORKFLOW)),
-        )
-
-        if (existingComment) {
-          console.log('Update Comment ID: ' + existingComment.id);
-          await updateGitHubComment(existingComment.id);
-          return
-        }
-        console.log('Comment does not exist, create a new one');
-      }
-
-      core.debug("Creating a comment in the PR.")
-      await octokit.issues.createComment({
-        owner: github.context.repo.owner,
-        repo: github.context.repo.repo,
-        issue_number: github.context.payload.pull_request.number,
-        body: body,
-      });
+      updateComment === "true" ? await upsertComment(body, commentHeaderPrefix, octokit) : await createNewComment(body, octokit);
     } else {
       core.info("github-token received is empty. Skipping writing a comment in the PR.");
       core.info("Note: This could happen even if github-token was provided in workflow file. It could be because your github token does not have permissions for commenting in target repo.")
     }
 
-    if (isFailure) {
+    if (!isMinimumCoverageReached) {
       throw Error(errorMessage);
     }
   } catch (error) {
     core.setFailed(error.message);
   }
 }
 
+async function createNewComment(body, octokit) {
+  core.debug("Creating a comment in the PR.")
+
+  await octokit.issues.createComment({
+    repo: github.context.repo.repo,
+    owner: github.context.repo.owner,
+    issue_number: github.context.payload.pull_request.number,
+    body,
+  });
+}
+
+async function upsertComment(body, commentHeaderPrefix, octokit) {
+  const issueComments = await octokit.issues.listComments({
+    repo: github.context.repo.repo,
+    owner: github.context.repo.owner,
+    issue_number: github.context.payload.pull_request.number,
+  });
+
+  const existingComment = issueComments.data.find(comment =>
+    comment.body.includes(commentHeaderPrefix),
+  );
+
+  if (existingComment) {
+    core.debug(`Updating comment, id: ${existingComment.id}.`);
+
+    await octokit.issues.updateComment({
+      repo: github.context.repo.repo,
+      owner: github.context.repo.owner,
+      comment_id: existingComment.id,
+      body,
+    });
+  } else {
+    core.debug(`Commend does not exist, new comment will be created.`);
+
+    await createNewComment();
+  }
+}
+
 async function genhtml(coverageFiles, tmpPath) {
   const workingDirectory = core.getInput('working-directory').trim() || './';
   const artifactName = core.getInput('artifact-name').trim();