fix: Add basic error reporting

Author: thelukewalton

.github/workflows/pull-request.yml

@@ -37,5 +37,5 @@ jobs:
           git config --global user.name "github-actions"
           git config --global user.email "[email protected]"
           git add -A
-          git commit -m 'ci(automated commit): lint format and import sort'
+          git commit -m 'ci(automated commit): Build bundled file'
           git push

.gitignore

@@ -156,13 +156,14 @@ migrate_working_dir/
 # Flutter/Dart/Pub related
 **/doc/api/
 **/ios/Flutter/.last_build_id
-.dart_tool/
+**/.dart_tool/
 .flutter-plugins
 .flutter-plugins-dependencies
 .pub-cache/
 .pub/
 build/
-
-
-
-**/docs/addver
+**/docs/addver
+*/package_config_subset
+tests/pass_repo/.dart_tool/package_config_subset
+tests/pass_repo/.dart_tool/package_config.json
+tests/pass_repo/build/test_cache/build/cache.dill.track.dill

src/main.ts

@@ -1,4 +1,4 @@
-import { getInput } from "@actions/core";
+import { getInput, setFailed } from "@actions/core";
 import { getAnalyze } from "./scripts/analyze";
 import { getOctokit, context } from "@actions/github";
 import { getCoverage, getOldCoverage } from "./scripts/coverage";
@@ -11,17 +11,28 @@ import { push } from "./scripts/push";
 export type stepResponse = { output: string; error: boolean };
 
 const run = async () => {
-  const token = process.env.GITHUB_TOKEN || getInput("token");
-  const octokit = getOctokit(token);
-  const behindByStr = await checkBranchStatus(octokit, context);
-  await setup();
-  const oldCoverage: number | undefined = getOldCoverage();
-  const analyzeStr: stepResponse = await getAnalyze();
-  const testStr: stepResponse = await getTest();
-  const coverageStr: stepResponse = await getCoverage(oldCoverage);
-  const comment = createComment(analyzeStr, testStr, coverageStr, behindByStr);
-  postComment(octokit, comment, context);
-  await push();
+  try {
+    const token = process.env.GITHUB_TOKEN || getInput("token");
+    const octokit = getOctokit(token);
+    const behindByStr = await checkBranchStatus(octokit, context);
+    await setup();
+    const oldCoverage: number | undefined = getOldCoverage();
+
+    const analyzeStr: stepResponse = await getAnalyze();
+    const testStr: stepResponse = await getTest();
+    const coverageStr: stepResponse = await getCoverage(oldCoverage);
+
+    const comment = createComment(analyzeStr, testStr, coverageStr, behindByStr);
+
+    postComment(octokit, comment, context);
+    await push();
+
+    if (analyzeStr.error || testStr.error || coverageStr.error) {
+      setFailed(`${analyzeStr.output}\n${testStr.output}\n${coverageStr.output}`);
+    }
+  } catch (err) {
+    setFailed(`Action failed with error ${err}`);
+  }
 };
 
 run();

src/scripts/analyze.ts

@@ -57,9 +57,9 @@ export const getAnalyze = async (): Promise<stepResponse> => {
     const output = `${ANALYZE_FAILURE}; ${issuesFound}</br>
         <details><summary>See details</summary>
         <table>
-        <tr><th></th><th>Type</th><th>File name</th><th>Details</th></tr>${errorString.join(
-          ""
-        )}${warningString.join("")}${infoString.join("")}</table></details>
+        <tr><th></th><th>Type</th><th>File name</th><th>Details</th></tr>${errorString.join("")}${warningString.join(
+      ""
+    )}${infoString.join("")}</table></details>
         `;
 
     response = { output: output, error: true };
@@ -84,6 +84,4 @@ export const getErrEmoji = (errType: analyzeErrTypes) => {
 };
 
 export const generateTableRow = (err: analyzeDetails, type: analyzeErrTypes) =>
-  `<tr><td>${getErrEmoji(type)}</td><td>Error</td><td>${err.file}</td><td>${
-    err.details
-  }</td></tr>`;
+  `<tr><td>${getErrEmoji(type)}</td><td>Error</td><td>${err.file}</td><td>${err.details}</td></tr>`;

src/scripts/comment.ts

@@ -11,8 +11,7 @@ export const createComment = (
   coverage: stepResponse,
   behindBy: stepResponse
 ): string => {
-  const isSuccess =
-    !analyze.error && !test.error && !coverage.error && !behindBy.error;
+  const isSuccess = !analyze.error && !test.error && !coverage.error && !behindBy.error;
 
   let output = `<h2>PR Checks complete</h2>
 <ul>
@@ -29,11 +28,7 @@ ${SIGNATURE}
   return output;
 };
 
-export async function postComment(
-  octokit: InstanceType<typeof GitHub>,
-  commentMessage: string,
-  context: Context
-) {
+export async function postComment(octokit: InstanceType<typeof GitHub>, commentMessage: string, context: Context) {
   startGroup(`Commenting on PR`);
 
   const pr = {

src/scripts/runTests.ts

@@ -24,16 +24,11 @@ export const getTest = async (): Promise<stepResponse> => {
       const objStr = "[" + stdout.split("\n").join(",").slice(0, -1) + "]";
       const obj = JSON.parse(objStr);
       let failIds: string[] = [];
-      obj.forEach(
-        (element: { type: string; result: string; testID: string }) => {
-          if (
-            element.type == "testDone" &&
-            element.result.toLowerCase() == "error"
-          ) {
-            failIds.push(element.testID);
-          }
+      obj.forEach((element: { type: string; result: string; testID: string }) => {
+        if (element.type == "testDone" && element.result.toLowerCase() == "error") {
+          failIds.push(element.testID);
         }
-      );
+      });
       let initialString = "";
       if (failIds.length > 1) {
         initialString = `${failIds.length} tests failed`;
@@ -50,43 +45,29 @@ export const getTest = async (): Promise<stepResponse> => {
             test: { hasOwnProperty: (arg0: string) => any; id: any };
           }) =>
             (e.hasOwnProperty("testID") && e.testID == e1) ||
-            (e.hasOwnProperty("test") &&
-              e.test.hasOwnProperty("id") &&
-              e.test.id == e1)
+            (e.hasOwnProperty("test") && e.test.hasOwnProperty("id") && e.test.id == e1)
         );
         const entry1 = allEntries.find(
-          (e: {
-            hasOwnProperty: (arg0: string) => any;
-            test: { hasOwnProperty: (arg0: string) => any };
-          }) => e.hasOwnProperty("test") && e.test.hasOwnProperty("id")
+          (e: { hasOwnProperty: (arg0: string) => any; test: { hasOwnProperty: (arg0: string) => any } }) =>
+            e.hasOwnProperty("test") && e.test.hasOwnProperty("id")
         );
         let testName = "Error getting test name";
         if (entry1) {
           testName = entry1.test.name.split("/test/").slice(-1);
         }
         const entry2 = allEntries.find(
-          (e: {
-            hasOwnProperty: (arg0: string) => any;
-            stackTrace: string | any[];
-          }) => e.hasOwnProperty("stackTrace") && e.stackTrace.length > 1
+          (e: { hasOwnProperty: (arg0: string) => any; stackTrace: string | any[] }) =>
+            e.hasOwnProperty("stackTrace") && e.stackTrace.length > 1
         );
         const entry3 = allEntries.find(
-          (e: {
-            hasOwnProperty: (arg0: string) => any;
-            message: string | string[];
-          }) =>
-            e.hasOwnProperty("message") &&
-            e.message.length > 1 &&
-            e.message.includes("EXCEPTION CAUGHT BY FLUTTER")
+          (e: { hasOwnProperty: (arg0: string) => any; message: string | string[] }) =>
+            e.hasOwnProperty("message") && e.message.length > 1 && e.message.includes("EXCEPTION CAUGHT BY FLUTTER")
         );
         const entry4 = allEntries.find(
-          (e: {
-            hasOwnProperty: (arg0: string) => any;
-            error: string | any[];
-          }) => e.hasOwnProperty("error") && e.error.length > 1
+          (e: { hasOwnProperty: (arg0: string) => any; error: string | any[] }) =>
+            e.hasOwnProperty("error") && e.error.length > 1
         );
-        let testDetails =
-          "Unable to get test details. Run flutter test to replicate";
+        let testDetails = "Unable to get test details. Run flutter test to replicate";
         if (entry2) {
           testDetails = entry2.stackTrace;
         } else if (entry3) {
@@ -95,13 +76,7 @@ export const getTest = async (): Promise<stepResponse> => {
           testDetails = entry4.error;
         }
 
-        errorString.push(
-          "<details><summary>" +
-            testName +
-            "</br></summary>`" +
-            testDetails +
-            "`</details>"
-        );
+        errorString.push("<details><summary>" + testName + "</br></summary>`" + testDetails + "`</details>");
       });
 
       const output = `⛔️ - ${initialString}</br >

tests/src/scripts/coverage.test.ts

@@ -1,10 +1,6 @@
 import { exec, execSync } from "child_process";
 import { stepResponse } from "../../../src/main";
-import {
-  COV_FAILURE,
-  getCoverage,
-  getOldCoverage,
-} from "../../../src/scripts/coverage";
+import { COV_FAILURE, getCoverage, getOldCoverage } from "../../../src/scripts/coverage";
 const oldCoverage = 83.33;
 
 test("should return stepResponse object", () => {

tests/src/scripts/runTests.test.ts

@@ -1,8 +1,4 @@
-import {
-  getTest,
-  TEST_ERROR,
-  TEST_SUCCESS,
-} from "../../../src/scripts/runTests";
+import { getTest, TEST_ERROR, TEST_SUCCESS } from "../../../src/scripts/runTests";
 
 test("all tests pass", async () => {
   process.chdir("tests/pass_repo");