ci: refactoring the tests-report step into their own ECMAscript module

Author: TheRustifyer

.github/workflows/actions-scripts-tests.yml

@@ -43,20 +43,8 @@ jobs:
         with:
           script: |
             const steps = ${{ toJSON(steps) }};
-            const marker = 'to show where the warning was created)';
-            const output = steps.run_tests.outputs.tests_report;
-            const sanitized = output.split(marker);
-            const msg = (sanitized.length > 1) ? sanitized[1] : sanitized[0];
-
-            const prNumber = context.payload.issue.number;
-
-            if (sanitized.length >= 1) {
-              github.rest.issues.createComment({
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                issue_number: prNumber,
-                body: msg,
-              });
-            } else {
-                core.setFailed('No tests report data available.') 
-            }
+
+            const { default: testReportOnPrComment } = 
+              await import('${{ github.workspace }}/actions_scripts/tests_report_on_pr_comment.js');
+            
+            await testReportOnPrComment(github, context, steps);

actions_scripts/helpers.js

@@ -1,7 +1,6 @@
 // Contains helper functions made to be reusable across the JS scripts
 // of the notifications
 
-// Helper function to determine if the workflow is running locally.
 /**
  * Check if the current run is a local run (e.g., with ACT).
  * @param {Object} context - GitHub Actions context object.
@@ -12,7 +11,23 @@ export function ciLocalRun(context) {
     return (localRun !== undefined) ? localRun : false;
 }
 
-// Helper function to retrieve the username of the actor triggering the workflow.
+/**
+ * Post a comment on the PR to notify the user.
+ * @param {Object} github - GitHub API client.
+ * @param {Object} context - GitHub Actions context object.
+ * @param {number} prNumber - Pull request number.
+ * @param {string} message - Message content to be posted.
+ * @returns {Object} - The response object from the GitHub API.
+ */
+export async function createPrComment(github, context, prNumber, message) {
+    return await github.rest.issues.createComment({
+        owner: context.repo.owner,
+        repo: context.repo.repo,
+        issue_number: prNumber,
+        body: message,
+    });
+}
+
 /**
  * Get the username of the actor from the context.
  * @param {Object} context - GitHub Actions context object.
@@ -27,7 +42,6 @@ export function extractUsername(context) {
         throw new Error("Unable to determine the actor (user) that triggered this deploy. Leaving...");
 }
 
-// Helper function to retrieve the owner of the repository in which the action has been triggered.
 /**
  * Get the username of the actor from the context.
  * @param {Object} context - GitHub Actions context object.

actions_scripts/notify_user.js

@@ -1,4 +1,4 @@
-import { ciLocalRun, extractUsername } from "./helpers.js";
+import { ciLocalRun, extractUsername, createPrComment } from "./helpers.js";
 
 /**
  * Notify the user about the deployment action.
@@ -56,24 +56,6 @@ function generatePrCommentMsg(username, environment, project, infra) {
   return message;
 }
 
-// Helper function to create a PR comment via the GitHub API.
-/**
- * Post a comment on the PR to notify the user.
- * @param {Object} github - GitHub API client.
- * @param {Object} context - GitHub Actions context object.
- * @param {number} prNumber - Pull request number.
- * @param {string} message - Message content to be posted.
- * @returns {Object} - The response object from the GitHub API.
- */
-async function createPrComment(github, context, prNumber, message) {
-  return await github.rest.issues.createComment({
-    owner: context.repo.owner,
-    repo: context.repo.repo,
-    issue_number: prNumber,
-    body: message,
-  });
-}
-
 // Helper function to log the PR comment message in a local environment.
 /**
  * Log the message locally for debugging when running with ACT.

actions_scripts/tests_report_on_pr_comment.js

@@ -0,0 +1,30 @@
+import { ciLocalRun, getRepoOwner } from "./helpers.js";
+
+/**
+ * Generates a new comment on the PR that triggered the workflow with the
+ * report of the tests runned by 'JEST' over the actions scripts
+ */
+export default async (github, context, steps) => {
+    const isLocalRun = ciLocalRun(context);
+
+    const marker = 'to show where the warning was created)';
+    const output = steps.run_tests.outputs.tests_report;
+    const sanitized = output.split(marker);
+    const msg = (sanitized.length > 1) ? sanitized[1] : sanitized[0];
+
+    const prNumber = context.payload.issue.number;
+
+    if (!isLocalRun && sanitized.length >= 1) {
+        github.rest.issues.createComment({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            issue_number: prNumber,
+            body: msg,
+        });
+    } else {
+        if (!isLocalRun)
+            core.setFailed('No tests report data available.');
+        else
+            console.log(`PR message: ${msg}`);
+    }
+};