Make ActionState available and add test

Author: mbg

src/init-action.ts

@@ -256,7 +256,7 @@ async function run(
     const repositoryProperties = repositoryPropertiesResult.orElse({});
 
     // Create a unique identifier for this run.
-    getJobUUID(logger);
+    getJobUUID(actionState);
 
     core.exportVariable(EnvVar.INIT_ACTION_HAS_RUN, "true");
 

src/setup-codeql-action.ts

@@ -95,7 +95,7 @@ async function sendCompletedStatusReport(
 
 /** The main behaviour of this action. */
 async function run(
-  actionState: ActionState<["Base", "Logger", "Actions"]>,
+  actionState: ActionState<["Base", "Logger", "Env", "Actions"]>,
 ): Promise<void> {
   // To capture errors appropriately, keep as much code within the try-catch as
   // possible, and only use safe functions outside.
@@ -141,7 +141,7 @@ async function run(
     const actionStateWithFeatures = { ...actionState, features };
 
     // Create a unique identifier for this run.
-    getJobUUID(logger);
+    getJobUUID(actionState);
 
     const statusReportBase = await createStatusReportBase(
       ActionName.SetupCodeQL,

src/status-report.test.ts

@@ -1,5 +1,6 @@
 import test from "ava";
 import * as sinon from "sinon";
+import * as uuid from "uuid";
 
 import * as actionsUtil from "./actions-util";
 import { Config } from "./config-utils";
@@ -12,6 +13,7 @@ import {
   createInitWithConfigStatusReport,
   createStatusReportBase,
   getActionsStatus,
+  getJobUUID,
   InitStatusReport,
   InitWithConfigStatusReport,
 } from "./status-report";
@@ -20,11 +22,18 @@ import {
   setupActionsVars,
   createTestConfig,
   makeMacro,
+  callee,
 } from "./testing-utils";
 import { BuildMode, ConfigurationError, withTmpDir, wrapError } from "./util";
 
 setupTests(test);
 
+test("getJobUUID - generates valid UUIDs", async (t) => {
+  await callee(getJobUUID)
+    .withArgs()
+    .passes((val) => t.true(uuid.validate(val)));
+});
+
 function setupEnvironmentAndStub(tmpDir: string) {
   setupActionsVars(tmpDir, tmpDir, {
     GITHUB_EVENT_NAME: "dynamic",

src/status-report.ts

@@ -3,6 +3,7 @@ import * as os from "os";
 import * as core from "@actions/core";
 import { v4 as uuidV4 } from "uuid";
 
+import type { ActionState } from "./action-common";
 import {
   getWorkflowEventName,
   getOptionalInput,
@@ -64,9 +65,9 @@ export function getDisplayActionName(actionName: ActionName): string {
  * Creates a UUIDv4 for the analysis and returns it.
  * The generated UUID is also exported as an environment variable.
  */
-export function getJobUUID(logger: Logger) {
+export function getJobUUID(action: ActionState<["Logger", "ReadOnlyEnv"]>) {
   const jobRunUuid = uuidV4();
-  logger.info(`Job run UUID is ${jobRunUuid}.`);
+  action.logger.info(`Job run UUID is ${jobRunUuid}.`);
 
   core.exportVariable(EnvVar.JOB_RUN_UUID, jobRunUuid);
   return jobRunUuid;