@actions/core Platform Support (#138)

This PR adds support for the
[`platform`](https://github.com/actions/toolkit/tree/main/packages/core#platform-helper)
functionality in the `@actions/core` package.

It also organizes the stubs to more closely reflect the
`@actions/toolkit` repository structure, so that maintaining and
updating stubs is a bit less of a nuisance.

Author: ncalteen

README.md

@@ -14,6 +14,14 @@ actions can be run directly on your workstation.
 >
 > This tool currently only supports JavaScript and TypeScript actions!
 
+The following table tracks the versions of the GitHub Actions Toolkit that are
+currently implemented by this tool.
+
+| Package             | Version  |
+| ------------------- | -------- |
+| `@actions/artifact` | `2.2.0`  |
+| `@actions/core`     | `1.11.1` |
+
 ## v2 Changes
 
 As of version `2.0.0`, the `local-action` tool has been updated to require

__fixtures__/exec.ts

@@ -0,0 +1,9 @@
+import { jest } from '@jest/globals'
+
+export const exec = jest.fn().mockImplementation(() => {})
+export const getExecOutput = jest.fn().mockImplementation(() => {})
+
+export default {
+  exec,
+  getExecOutput
+}

__tests__/command.test.ts

@@ -1,6 +1,6 @@
 import { jest } from '@jest/globals'
 import { Command } from 'commander'
-import { ResetCoreMetadata } from '../src/stubs/core.js'
+import { ResetCoreMetadata } from '../src/stubs/core/core.js'
 import { ResetEnvMetadata } from '../src/stubs/env.js'
 
 const action = jest.fn()

__tests__/commands/run.test.ts

@@ -1,6 +1,6 @@
 import { jest } from '@jest/globals'
 import * as core from '../../__fixtures__/core.js'
-import { ResetCoreMetadata } from '../../src/stubs/core.js'
+import { ResetCoreMetadata } from '../../src/stubs/core/core.js'
 import { EnvMeta, ResetEnvMetadata } from '../../src/stubs/env.js'
 
 const quibbleEsm = jest.fn().mockImplementation(() => {})

__tests__/index.test.ts

@@ -1,5 +1,5 @@
 import { jest } from '@jest/globals'
-import { ResetCoreMetadata } from '../src/stubs/core.js'
+import { ResetCoreMetadata } from '../src/stubs/core/core.js'
 import { ResetEnvMetadata } from '../src/stubs/env.js'
 
 const makeProgram = jest.fn().mockResolvedValue({

__tests__/stubs/artifact/internal/client.test.ts

@@ -1,6 +1,6 @@
 import { jest } from '@jest/globals'
 import * as core from '../../../../__fixtures__/core.js'
-import { ResetCoreMetadata } from '../../../../src/stubs/core.js'
+import { ResetCoreMetadata } from '../../../../src/stubs/core/core.js'
 import { EnvMeta, ResetEnvMetadata } from '../../../../src/stubs/env.js'
 
 const isGhes = jest.fn().mockReturnValue(false)
@@ -58,7 +58,7 @@ jest.unstable_mockModule(
     deleteArtifactPublic
   })
 )
-jest.unstable_mockModule('../../../../src/stubs/core.js', () => core)
+jest.unstable_mockModule('../../../../src/stubs/core/core.js', () => core)
 
 const { DefaultArtifactClient } = await import(
   '../../../../src/stubs/artifact/internal/client.js'

__tests__/stubs/artifact/internal/delete/delete-artifact.test.ts

@@ -1,11 +1,11 @@
 import { jest } from '@jest/globals'
 import * as core from '../../../../../__fixtures__/core.js'
 import * as fs from '../../../../../__fixtures__/fs.js'
-import { ResetCoreMetadata } from '../../../../../src/stubs/core.js'
+import { ResetCoreMetadata } from '../../../../../src/stubs/core/core.js'
 import { EnvMeta, ResetEnvMetadata } from '../../../../../src/stubs/env.js'
 
 jest.unstable_mockModule('fs', () => fs)
-jest.unstable_mockModule('../../../../../src/stubs/core.js', () => core)
+jest.unstable_mockModule('../../../../../src/stubs/core/core.js', () => core)
 
 const deleteArtifact = await import(
   '../../../../../src/stubs/artifact/internal/delete/delete-artifact.js'

__tests__/stubs/artifact/internal/download/download-artifact.test.ts

@@ -3,7 +3,7 @@ import * as core from '../../../../../__fixtures__/core.js'
 import * as crypto from '../../../../../__fixtures__/crypto.js'
 import * as fs from '../../../../../__fixtures__/fs.js'
 import * as stream from '../../../../../__fixtures__/stream/promises.js'
-import { ResetCoreMetadata } from '../../../../../src/stubs/core.js'
+import { ResetCoreMetadata } from '../../../../../src/stubs/core/core.js'
 import { EnvMeta, ResetEnvMetadata } from '../../../../../src/stubs/env.js'
 
 const readStream = {
@@ -14,7 +14,7 @@ const readStream = {
 jest.unstable_mockModule('crypto', () => crypto)
 jest.unstable_mockModule('fs', () => fs)
 jest.unstable_mockModule('stream/promises', () => stream)
-jest.unstable_mockModule('../../../../../src/stubs/core.js', () => core)
+jest.unstable_mockModule('../../../../../src/stubs/core/core.js', () => core)
 
 const downloadArtifact = await import(
   '../../../../../src/stubs/artifact/internal/download/download-artifact.js'

__tests__/stubs/artifact/internal/find/get-artifact.test.ts

@@ -1,9 +1,9 @@
 import { jest } from '@jest/globals'
 import * as core from '../../../../../__fixtures__/core.js'
-import { ResetCoreMetadata } from '../../../../../src/stubs/core.js'
+import { ResetCoreMetadata } from '../../../../../src/stubs/core/core.js'
 import { EnvMeta, ResetEnvMetadata } from '../../../../../src/stubs/env.js'
 
-jest.unstable_mockModule('../../../../../src/stubs/core.js', () => core)
+jest.unstable_mockModule('../../../../../src/stubs/core/core.js', () => core)
 
 const getArtifact = await import(
   '../../../../../src/stubs/artifact/internal/find/get-artifact.js'

__tests__/stubs/artifact/internal/find/list-artifacts.test.ts

@@ -1,6 +1,6 @@
 import { jest } from '@jest/globals'
 import * as core from '../../../../../__fixtures__/core.js'
-import { ResetCoreMetadata } from '../../../../../src/stubs/core.js'
+import { ResetCoreMetadata } from '../../../../../src/stubs/core/core.js'
 import { EnvMeta, ResetEnvMetadata } from '../../../../../src/stubs/env.js'
 
 jest.unstable_mockModule('@actions/core', () => core)

__tests__/stubs/artifact/internal/shared/config.test.ts

@@ -1,6 +1,6 @@
 import { jest } from '@jest/globals'
 import { getGitHubWorkspaceDir } from '../../../../../src/stubs/artifact/internal/shared/config.js'
-import { ResetCoreMetadata } from '../../../../../src/stubs/core.js'
+import { ResetCoreMetadata } from '../../../../../src/stubs/core/core.js'
 import { ResetEnvMetadata } from '../../../../../src/stubs/env.js'
 
 describe('config', () => {

__tests__/stubs/artifact/internal/shared/user-agent.test.ts

@@ -1,6 +1,6 @@
 import { jest } from '@jest/globals'
 import { getUserAgentString } from '../../../../../src/stubs/artifact/internal/shared/user-agent.js'
-import { ResetCoreMetadata } from '../../../../../src/stubs/core.js'
+import { ResetCoreMetadata } from '../../../../../src/stubs/core/core.js'
 import { ResetEnvMetadata } from '../../../../../src/stubs/env.js'
 
 describe('user-agent', () => {

__tests__/stubs/artifact/internal/upload/upload-artifact.test.ts

@@ -4,7 +4,7 @@ import * as core from '../../../../../__fixtures__/core.js'
 import * as crypto from '../../../../../__fixtures__/crypto.js'
 import * as fs from '../../../../../__fixtures__/fs.js'
 import * as stream from '../../../../../__fixtures__/stream/promises.js'
-import { ResetCoreMetadata } from '../../../../../src/stubs/core.js'
+import { ResetCoreMetadata } from '../../../../../src/stubs/core/core.js'
 import { EnvMeta, ResetEnvMetadata } from '../../../../../src/stubs/env.js'
 
 const validateArtifactName = jest.fn()
@@ -27,7 +27,7 @@ const writeStream = {
 jest.unstable_mockModule('crypto', () => crypto)
 jest.unstable_mockModule('fs', () => fs)
 jest.unstable_mockModule('stream/promises', () => stream)
-jest.unstable_mockModule('../../../../../src/stubs/core.js', () => core)
+jest.unstable_mockModule('../../../../../src/stubs/core/core.js', () => core)
 jest.unstable_mockModule(
   '../../../../../src/stubs/artifact/internal/upload/upload-zip-specification.js',
   () => ({

__tests__/stubs/core-stubs.test.ts __tests__/stubs/core/core.test.ts

@@ -1,5 +1,4 @@
 import { jest } from '@jest/globals'
-import path from 'path'
 import {
   CoreMeta,
   ResetCoreMetadata,
@@ -24,13 +23,10 @@ import {
   setOutput,
   setSecret,
   startGroup,
-  toPlatformPath,
-  toPosixPath,
-  toWin32Path,
   warning
-} from '../../src/stubs/core.js'
-import { EnvMeta, ResetEnvMetadata } from '../../src/stubs/env.js'
-import type { CoreMetadata } from '../../src/types.js'
+} from '../../../src/stubs/core/core.js'
+import { EnvMeta, ResetEnvMetadata } from '../../../src/stubs/env.js'
+import type { CoreMetadata } from '../../../src/types.js'
 
 /** Empty CoreMetadata Object */
 const empty: CoreMetadata = {
@@ -597,33 +593,5 @@ describe('Core', () => {
         await expect(getIDToken()).rejects.toThrow('Not implemented')
       })
     })
-
-    describe('toPosixPath()', () => {
-      it('Returns a POSIX path', () => {
-        expect(toPosixPath('C:\\Users\\mona\\Desktop')).toEqual(
-          'C:/Users/mona/Desktop'
-        )
-      })
-    })
-
-    describe('toWin32Path()', () => {
-      it('Returns a WIN32 path', () => {
-        expect(toWin32Path('C:/Users/mona/Desktop')).toEqual(
-          'C:\\Users\\mona\\Desktop'
-        )
-      })
-    })
-
-    describe('toPlatformPath()', () => {
-      it('Returns a platform-specific path', () => {
-        expect(toPlatformPath('C:/Users/mona/Desktop')).toEqual(
-          `C:${path.sep}Users${path.sep}mona${path.sep}Desktop`
-        )
-
-        expect(toPosixPath('C:\\Users\\mona\\Desktop')).toEqual(
-          `C:${path.sep}Users${path.sep}mona${path.sep}Desktop`
-        )
-      })
-    })
   })
 })

__tests__/stubs/core/path-utils.test.ts

@@ -0,0 +1,46 @@
+import { jest } from '@jest/globals'
+import path from 'path'
+import { ResetCoreMetadata } from '../../../src/stubs/core/core.js'
+import {
+  toPlatformPath,
+  toPosixPath,
+  toWin32Path
+} from '../../../src/stubs/core/path-utils.js'
+import { ResetEnvMetadata } from '../../../src/stubs/env.js'
+
+// Prevent output during tests
+jest.spyOn(console, 'log').mockImplementation(() => {})
+jest.spyOn(console, 'table').mockImplementation(() => {})
+
+describe('path-utils', () => {
+  beforeEach(() => {
+    // Reset metadata
+    ResetEnvMetadata()
+    ResetCoreMetadata()
+  })
+
+  afterEach(() => {
+    // Reset all spies
+    jest.resetAllMocks()
+  })
+
+  describe('toWin32Path()', () => {
+    it('Returns a WIN32 path', () => {
+      expect(toWin32Path('C:/Users/mona/Desktop')).toEqual(
+        'C:\\Users\\mona\\Desktop'
+      )
+    })
+  })
+
+  describe('toPlatformPath()', () => {
+    it('Returns a platform-specific path', () => {
+      expect(toPlatformPath('C:/Users/mona/Desktop')).toEqual(
+        `C:${path.sep}Users${path.sep}mona${path.sep}Desktop`
+      )
+
+      expect(toPosixPath('C:\\Users\\mona\\Desktop')).toEqual(
+        `C:${path.sep}Users${path.sep}mona${path.sep}Desktop`
+      )
+    })
+  })
+})

__tests__/stubs/summary-stubs.test.ts __tests__/stubs/core/summary.test.ts

@@ -2,8 +2,8 @@ import { jest } from '@jest/globals'
 import fs from 'fs'
 import { EOL } from 'os'
 import path from 'path'
-import { CoreMeta, ResetCoreMetadata } from '../../src/stubs/core.js'
-import { Summary } from '../../src/stubs/summary.js'
+import { CoreMeta, ResetCoreMetadata } from '../../../src/stubs/core/core.js'
+import { Summary } from '../../../src/stubs/core/summary.js'
 
 let summary: Summary = new Summary()
 

__tests__/stubs/env-stubs.test.ts __tests__/stubs/env.test.ts

@@ -1,5 +1,5 @@
 import { jest } from '@jest/globals'
-import { ResetCoreMetadata } from '../../src/stubs/core.js'
+import { ResetCoreMetadata } from '../../src/stubs/core/core.js'
 import { EnvMeta, ResetEnvMetadata } from '../../src/stubs/env.js'
 import type { EnvMetadata } from '../../src/types.js'
 

__tests__/utils/output.test.ts

@@ -1,5 +1,5 @@
 import { jest } from '@jest/globals'
-import { ResetCoreMetadata } from '../../src/stubs/core.js'
+import { ResetCoreMetadata } from '../../src/stubs/core/core.js'
 import { ResetEnvMetadata } from '../../src/stubs/env.js'
 import { printTitle } from '../../src/utils/output.js'
 

docs/supported-functionality.md

@@ -66,7 +66,7 @@ to the `local-action` command.
 | `toPosixPath()`       | :white_check_mark: |                                 |
 | `toWin32Path()`       | :white_check_mark: |                                 |
 | `toPlatformPath()`    | :white_check_mark: |                                 |
-| `platform.*`          | :no_entry:         |                                 |
+| `platform.*`          | :white_check_mark: |                                 |
 
 ## Under Investigation
 

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@github/local-action",
   "description": "Local Debugging for GitHub Actions",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "type": "module",
   "author": "Nick Alteen <ncalteen@github.com>",
   "private": false,

package.json

@@ -2,7 +2,7 @@ import { config } from 'dotenv'
 import { createRequire } from 'module'
 import quibble from 'quibble'
 import { ARTIFACT_STUBS } from '../stubs/artifact/artifact.js'
-import { CORE_STUBS, CoreMeta } from '../stubs/core.js'
+import { CORE_STUBS, CoreMeta } from '../stubs/core/core.js'
 import { EnvMeta } from '../stubs/env.js'
 import type { Action } from '../types.js'
 import { printTitle } from '../utils/output.js'

src/commands/run.ts

@@ -1,4 +1,4 @@
-import { warning } from '../../core.js'
+import { warning } from '../../core/core.js'
 import {
   deleteArtifactInternal,
   deleteArtifactPublic

src/stubs/artifact/internal/client.ts

@@ -6,7 +6,7 @@ import { retry } from '@octokit/plugin-retry'
 import fs from 'fs'
 import path from 'path'
 import { EnvMeta } from '../../../../stubs/env.js'
-import * as core from '../../../core.js'
+import * as core from '../../../core/core.js'
 import { getArtifactPublic } from '../find/get-artifact.js'
 import { getRetryOptions } from '../find/retry-options.js'
 import {

src/stubs/artifact/internal/delete/delete-artifact.ts

@@ -5,7 +5,7 @@ import path from 'path'
 import { finished } from 'stream/promises'
 import unzip from 'unzip-stream'
 import { EnvMeta } from '../../../../stubs/env.js'
-import * as core from '../../../core.js'
+import * as core from '../../../core/core.js'
 import { getGitHubWorkspaceDir } from '../shared/config.js'
 import { ArtifactNotFoundError } from '../shared/errors.js'
 import type {

src/stubs/artifact/internal/download/download-artifact.ts

@@ -4,7 +4,7 @@ import type { OctokitOptions } from '@octokit/core'
 import { requestLog } from '@octokit/plugin-request-log'
 import { retry } from '@octokit/plugin-retry'
 import { EnvMeta } from '../../../../stubs/env.js'
-import * as core from '../../../core.js'
+import * as core from '../../../core/core.js'
 import {
   ArtifactNotFoundError,
   InvalidResponseError

src/stubs/artifact/internal/find/get-artifact.ts

@@ -4,7 +4,7 @@ import type { OctokitOptions } from '@octokit/core'
 import { requestLog } from '@octokit/plugin-request-log'
 import { retry } from '@octokit/plugin-retry'
 import { EnvMeta } from '../../../../stubs/env.js'
-import * as core from '../../../core.js'
+import * as core from '../../../core/core.js'
 import type { Artifact, ListArtifactsResponse } from '../shared/interfaces.js'
 import { getUserAgentString } from '../shared/user-agent.js'
 import { getRetryOptions } from './retry-options.js'

src/stubs/artifact/internal/find/list-artifacts.ts

@@ -5,7 +5,7 @@
 
 import type { OctokitOptions } from '@octokit/core'
 import type { RequestRequestOptions } from '@octokit/types'
-import * as core from '../../../core.js'
+import * as core from '../../../core/core.js'
 
 export type RetryOptions = {
   doNotRetry?: number[]

src/stubs/artifact/internal/find/retry-options.ts

@@ -3,7 +3,7 @@
  */
 /* istanbul ignore file */
 
-import { info } from '../../../core.js'
+import { info } from '../../../core/core.js'
 
 /**
  * Invalid characters that cannot be in the artifact name or an uploaded file. Will be rejected

src/stubs/artifact/internal/upload/path-and-artifact-name-validation.ts

@@ -3,7 +3,7 @@ import fs from 'fs'
 import path from 'path'
 import { finished } from 'stream/promises'
 import { EnvMeta } from '../../../../stubs/env.js'
-import * as core from '../../../core.ts'
+import * as core from '../../../core/core.ts'
 import { FilesNotFoundError, InvalidResponseError } from '../shared/errors.js'
 import type {
   Artifact,

src/stubs/artifact/internal/upload/upload-artifact.ts

@@ -5,7 +5,7 @@
 
 import * as fs from 'fs'
 import { normalize, resolve } from 'path'
-import * as core from '../../../core.js'
+import * as core from '../../../core/core.js'
 import { validateFilePath } from './path-and-artifact-name-validation.js'
 
 export interface UploadZipSpecification {