@actions/core: abstract @actions/core usage

Introduce a simple abstraction of the @actions/core module, such that we
can provide a different implementation in the future (for Azure
Pipelines, for example).

Rename 'run' to 'setup' (which is the sibling to 'cleanup'), and add a
new 'run' function that takes only an ICore implementation, using
@actions/core.

Signed-off-by: Matthew John Cheetham <[email protected]>

Author: mjcheetham

main.ts

@@ -1,4 +1,5 @@
-import * as core from '@actions/core'
+import {ICore} from './src/core'
+import {ActionsCore} from './src/actions_core'
 import {mkdirp} from './src/downloader'
 import {restoreCache, saveCache} from '@actions/cache'
 import process from 'process'
@@ -11,9 +12,6 @@ import {
 import {getViaCIArtifacts} from './src/ci_artifacts'
 import * as fs from 'fs'
 
-const flavor = core.getInput('flavor')
-const architecture = core.getInput('architecture')
-
 /**
  * Some Azure VM types have a temporary disk which is local to the VM and therefore provides
  * _much_ faster disk IO than the OS Disk (or any other attached disk).
@@ -23,7 +21,7 @@ const architecture = core.getInput('architecture')
  *
  * https://learn.microsoft.com/en-us/azure/virtual-machines/managed-disks-overview#temporary-disk
  */
-function getDriveLetterPrefix(): string {
+function getDriveLetterPrefix(core: ICore): string {
   if (fs.existsSync('D:/')) {
     core.info('Found a fast, temporary disk on this VM (D:/). Will use that.')
     return 'D:/'
@@ -32,7 +30,11 @@ function getDriveLetterPrefix(): string {
   return 'C:/'
 }
 
-async function run(): Promise<void> {
+async function setup(
+  core: ICore,
+  flavor: string,
+  architecture: string
+): Promise<void> {
   try {
     if (process.platform !== 'win32') {
       core.warning(
@@ -47,10 +49,10 @@ async function run(): Promise<void> {
 
     const {artifactName, download, id} =
       flavor === 'minimal'
-        ? await getViaCIArtifacts(architecture, githubToken)
-        : await getViaGit(flavor, architecture, githubToken)
+        ? await getViaCIArtifacts(core, architecture, githubToken)
+        : await getViaGit(core, flavor, architecture, githubToken)
     const outputDirectory =
-      core.getInput('path') || `${getDriveLetterPrefix()}${artifactName}`
+      core.getInput('path') || `${getDriveLetterPrefix(core)}${artifactName}`
     core.setOutput('result', outputDirectory)
 
     let useCache: boolean
@@ -158,7 +160,7 @@ async function run(): Promise<void> {
   }
 }
 
-function cleanup(): void {
+function cleanup(core: ICore, flavor: string, architecture: string): void {
   if (core.getInput('cleanup') !== 'true') {
     core.info(
       `Won't clean up SDK files as the 'cleanup' input was not provided or doesn't equal 'true'.`
@@ -168,7 +170,7 @@ function cleanup(): void {
 
   const outputDirectory =
     core.getInput('path') ||
-    `${getDriveLetterPrefix()}${
+    `${getDriveLetterPrefix(core)}${
       getArtifactMetadata(flavor, architecture).artifactName
     }`
 
@@ -203,20 +205,22 @@ function cleanup(): void {
   core.info(`Finished cleaning up ${outputDirectory}.`)
 }
 
-/**
- * Indicates whether the POST action is running
- */
-export const isPost = !!core.getState('isPost')
-
-if (!isPost) {
-  run()
-  /*
-   * Publish a variable so that when the POST action runs, it can determine it should run the cleanup logic.
-   * This is necessary since we don't have a separate entry point.
-   * Inspired by https://github.com/actions/checkout/blob/v3.1.0/src/state-helper.ts#L56-L60
-   */
-  core.saveState('isPost', 'true')
-} else {
-  // If the POST action is running, we cleanup our artifacts
-  cleanup()
+async function run(core: ICore): Promise<void> {
+  const flavor = core.getInput('flavor')
+  const architecture = core.getInput('architecture')
+  const isPost = !!core.getState('isPost')
+  if (!isPost) {
+    setup(core, flavor, architecture)
+    /*
+     * Publish a variable so that when the POST action runs, it can determine it should run the cleanup logic.
+     * This is necessary since we don't have a separate entry point.
+     * Inspired by https://github.com/actions/checkout/blob/v3.1.0/src/state-helper.ts#L56-L60
+     */
+    core.saveState('isPost', 'true')
+  } else {
+    // If the POST action is running, we cleanup our artifacts
+    cleanup(core, flavor, architecture)
+  }
 }
+
+run(new ActionsCore())

src/actions_core.ts

@@ -0,0 +1,52 @@
+import {ICore} from '../src/core'
+import * as core from '@actions/core'
+
+export class ActionsCore implements ICore {
+  getInput(name: string): string {
+    return core.getInput(name)
+  }
+
+  setOutput(name: string, value: string): void {
+    core.setOutput(name, value)
+  }
+
+  addPath(inputPath: string): void {
+    core.addPath(inputPath)
+  }
+
+  exportVariable(name: string, value: string): void {
+    core.exportVariable(name, value)
+  }
+
+  info(message: string): void {
+    core.info(message)
+  }
+
+  warning(message: string): void {
+    core.warning(message)
+  }
+
+  error(message: string): void {
+    core.error(message)
+  }
+
+  setFailed(message: string): void {
+    core.setFailed(message)
+  }
+
+  startGroup(name: string): void {
+    core.startGroup(name)
+  }
+
+  endGroup(): void {
+    core.endGroup()
+  }
+
+  saveState(name: string, value: string): void {
+    core.saveState(name, value)
+  }
+
+  getState(name: string): string {
+    return core.getState(name)
+  }
+}

src/ci_artifacts.ts

@@ -1,4 +1,4 @@
-import * as core from '@actions/core'
+import {ICore} from './core'
 import {Octokit} from '@octokit/rest'
 import {getArtifactMetadata} from './git'
 import {spawn} from 'child_process'
@@ -11,6 +11,7 @@ async function sleep(milliseconds: number): Promise<void> {
 }
 
 export async function getViaCIArtifacts(
+  core: ICore,
   architecture: string,
   githubToken?: string
 ): Promise<{

src/core.ts

@@ -0,0 +1,81 @@
+/**
+ * Interface abstracting the core functionality needed for GitHub Actions and Azure Pipelines.
+ * This allows us to avoid module shimming and provide clean implementations for different platforms.
+ */
+export interface ICore {
+  /**
+   * Gets an input from the action/task configuration.
+   * @param name The name of the input
+   * @returns The input value or empty string if not found
+   */
+  getInput(name: string): string
+
+  /**
+   * Sets an output for the action/task.
+   * @param name The name of the output
+   * @param value The output value
+   */
+  setOutput(name: string, value: string): void
+
+  /**
+   * Adds a path to the PATH environment variable.
+   * @param inputPath The path to add
+   */
+  addPath(inputPath: string): void
+
+  /**
+   * Exports a variable to the environment.
+   * @param name The variable name
+   * @param value The variable value
+   */
+  exportVariable(name: string, value: string): void
+
+  /**
+   * Logs an informational message.
+   * @param message The message to log
+   */
+  info(message: string): void
+
+  /**
+   * Logs a warning message.
+   * @param message The warning message
+   */
+  warning(message: string): void
+
+  /**
+   * Logs an error message.
+   * @param message The error message
+   */
+  error(message: string): void
+
+  /**
+   * Sets the action/task as failed with the given message.
+   * @param message The failure message
+   */
+  setFailed(message: string): void
+
+  /**
+   * Starts a group for log output organization.
+   * @param name The group name
+   */
+  startGroup(name: string): void
+
+  /**
+   * Ends the current log group.
+   */
+  endGroup(): void
+
+  /**
+   * Saves state for post-job execution.
+   * @param name The state name
+   * @param value The state value
+   */
+  saveState(name: string, value: string): void
+
+  /**
+   * Gets previously saved state.
+   * @param name The state name
+   * @returns The state value or empty string if not found
+   */
+  getState(name: string): string
+}

src/git.ts

@@ -1,4 +1,4 @@
-import * as core from '@actions/core'
+import {ICore} from './core'
 import {spawnAndWaitForExitCode, SpawnReturnArgs} from './spawn'
 import {Octokit} from '@octokit/rest'
 import {delimiter} from 'path'
@@ -49,6 +49,7 @@ export function getArtifactMetadata(
 }
 
 export async function clone(
+  core: ICore,
   url: string,
   destination: string,
   verbose: number | boolean,
@@ -96,6 +97,7 @@ async function updateHEAD(
 }
 
 export async function getViaGit(
+  core: ICore,
   flavor: string,
   architecture: string,
   githubToken?: string
@@ -155,10 +157,13 @@ export async function getViaGit(
     ): Promise<void> => {
       core.startGroup(`Cloning ${repo}`)
       const partialCloneArg = flavor === 'full' ? [] : ['--filter=blob:none']
-      await clone(`https://github.com/${owner}/${repo}`, `.tmp`, verbose, [
-        '--bare',
-        ...partialCloneArg
-      ])
+      await clone(
+        core,
+        `https://github.com/${owner}/${repo}`,
+        `.tmp`,
+        verbose,
+        ['--bare', ...partialCloneArg]
+      )
       core.endGroup()
 
       let child: SpawnReturnArgs
@@ -177,6 +182,7 @@ export async function getViaGit(
         await updateHEAD('.tmp', head_sha)
         core.startGroup('Cloning build-extra')
         await clone(
+          core,
           `https://github.com/${owner}/build-extra`,
           '.tmp/build-extra',
           verbose