Merge pull request #81 from github/report-action-aborted

Report that an action has been aborted on configuration failures

lib/setup-tracer.js

@@ -127,22 +127,28 @@ function concatTracerConfigs(configs) {
     return { env, spec };
 }
 async function run() {
+    let languages;
     try {
         if (util.should_abort('init', false) || !await util.reportActionStarting('init')) {
             return;
         }
-        // The config file MUST be parsed in the init action
-        const config = await configUtils.loadConfig();
         core.startGroup('Load language configuration');
-        const languages = await util.getLanguages();
+        const config = await configUtils.loadConfig();
+        languages = await util.getLanguages();
         // If the languages parameter was not given and no languages were
         // detected then fail here as this is a workflow configuration error.
         if (languages.length === 0) {
-            core.setFailed("Did not detect any languages to analyze. Please update input in workflow.");
-            return;
+            throw new Error("Did not detect any languages to analyze. Please update input in workflow.");
         }
-        core.endGroup();
         analysisPaths.includeAndExcludeAnalysisPaths(config, languages);
+        core.endGroup();
+    }
+    catch (e) {
+        core.setFailed(e.message);
+        await util.reportActionAborted('init', e.message);
+        return;
+    }
+    try {
         const sourceRoot = path.resolve();
         core.startGroup('Setup CodeQL tools');
         const codeqlSetup = await setuptools.setupCodeQL();

lib/util.js

@@ -327,6 +327,16 @@ async function reportActionSucceeded(action) {
     await sendStatusReport(await createStatusReport(action, 'success'));
 }
 exports.reportActionSucceeded = reportActionSucceeded;
+/**
+ * Report that an action has been aborted.
+ *
+ * Note that the started_at date is always that of the `init` action, since
+ * this is likely to give a more useful duration when inspecting events.
+ */
+async function reportActionAborted(action, cause) {
+    await sendStatusReport(await createStatusReport(action, 'aborted', cause));
+}
+exports.reportActionAborted = reportActionAborted;
 /**
  * Get the array of all the tool names contained in the given sarif contents.
  *

src/setup-tracer.ts

@@ -139,30 +139,37 @@ function concatTracerConfigs(configs: { [lang: string]: TracerConfig }): TracerC
   return { env, spec };
 }
 
-
-
 async function run() {
+
+  let languages: string[];
+
   try {
     if (util.should_abort('init', false) || !await util.reportActionStarting('init')) {
       return;
     }
 
-    // The config file MUST be parsed in the init action
-    const config = await configUtils.loadConfig();
-
     core.startGroup('Load language configuration');
 
-    const languages = await util.getLanguages();
+    const config = await configUtils.loadConfig();
+
+    languages = await util.getLanguages();
     // If the languages parameter was not given and no languages were
     // detected then fail here as this is a workflow configuration error.
     if (languages.length === 0) {
-      core.setFailed("Did not detect any languages to analyze. Please update input in workflow.");
-      return;
+      throw new Error("Did not detect any languages to analyze. Please update input in workflow.");
     }
 
+    analysisPaths.includeAndExcludeAnalysisPaths(config, languages);
+
     core.endGroup();
 
-    analysisPaths.includeAndExcludeAnalysisPaths(config, languages);
+  } catch (e) {
+    core.setFailed(e.message);
+    await util.reportActionAborted('init', e.message);
+    return;
+  }
+
+  try {
 
     const sourceRoot = path.resolve();
 

src/util.ts

@@ -365,6 +365,16 @@ export async function reportActionSucceeded(action: string) {
   await sendStatusReport(await createStatusReport(action, 'success'));
 }
 
+/**
+ * Report that an action has been aborted.
+ *
+ * Note that the started_at date is always that of the `init` action, since
+ * this is likely to give a more useful duration when inspecting events.
+ */
+export async function reportActionAborted(action: string, cause?: string) {
+  await sendStatusReport(await createStatusReport(action, 'aborted', cause));
+}
+
 /**
  * Get the array of all the tool names contained in the given sarif contents.
  *