@ronaldphilipsen/local-action 0.0.0-stage → 7.1.0

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

@@ -0,0 +1,340 @@
+import { jest } from '@jest/globals'
+import * as core from '../../../../__fixtures__/@actions/core.js'
+import { ResetCoreMetadata } from '../../../../src/stubs/core/core.js'
+import { EnvMeta, ResetEnvMetadata } from '../../../../src/stubs/env.js'
+
+const isGhes = jest.fn().mockReturnValue(false)
+const getGitHubWorkspaceDir = jest.fn().mockReturnValue('/github/workspace')
+const getUploadChunkSize = jest.fn().mockReturnValue(8 * 1024 * 1024)
+const uploadArtifact = jest.fn()
+const downloadArtifactInternal = jest.fn()
+const downloadArtifactPublic = jest.fn()
+const listArtifactsInternal = jest.fn()
+const listArtifactsPublic = jest.fn()
+const getArtifactInternal = jest.fn()
+const getArtifactPublic = jest.fn()
+const deleteArtifactInternal = jest.fn()
+const deleteArtifactPublic = jest.fn()
+
+jest.unstable_mockModule(
+  '../../../../src/stubs/artifact/internal/shared/config.js',
+  () => ({
+    isGhes,
+    getGitHubWorkspaceDir,
+    getUploadChunkSize
+  })
+)
+jest.unstable_mockModule(
+  '../../../../src/stubs/artifact/internal/upload/upload-artifact.js',
+  () => ({
+    uploadArtifact
+  })
+)
+jest.unstable_mockModule(
+  '../../../../src/stubs/artifact/internal/download/download-artifact.js',
+  () => ({
+    downloadArtifactPublic,
+    downloadArtifactInternal
+  })
+)
+jest.unstable_mockModule(
+  '../../../../src/stubs/artifact/internal/find/list-artifacts.js',
+  () => ({
+    listArtifactsInternal,
+    listArtifactsPublic
+  })
+)
+jest.unstable_mockModule(
+  '../../../../src/stubs/artifact/internal/find/get-artifact.js',
+  () => ({
+    getArtifactInternal,
+    getArtifactPublic
+  })
+)
+jest.unstable_mockModule(
+  '../../../../src/stubs/artifact/internal/delete/delete-artifact.js',
+  () => ({
+    deleteArtifactInternal,
+    deleteArtifactPublic
+  })
+)
+jest.unstable_mockModule('../../../../src/stubs/core/core.js', () => core)
+
+const { DefaultArtifactClient } =
+  await import('../../../../src/stubs/artifact/internal/client.js')
+
+describe('DefaultArtifactClient', () => {
+  beforeEach(() => {
+    // Set environment variables
+    process.env.LOCAL_ACTION_WORKSPACE = '/tmp/artifacts'
+    process.env.LOCAL_ACTION_ARTIFACT_PATH = '/tmp/artifacts'
+
+    // Reset metadata
+    ResetEnvMetadata()
+    ResetCoreMetadata()
+
+    EnvMeta.artifacts = [{ name: 'artifact-name', id: 1, size: 0 }]
+  })
+
+  afterEach(() => {
+    jest.resetAllMocks()
+
+    // Unset environment variables
+    delete process.env.LOCAL_ACTION_WORKSPACE
+    delete process.env.LOCAL_ACTION_ARTIFACT_PATH
+  })
+
+  describe('uploadArtifact', () => {
+    it('Throws if LOCAL_ACTION_WORKSPACE is not set', async () => {
+      delete process.env.LOCAL_ACTION_WORKSPACE
+
+      const client = new DefaultArtifactClient()
+
+      await expect(
+        client.uploadArtifact('artifact-name', ['file1', 'file2'], 'root')
+      ).rejects.toThrow(
+        'LOCAL_ACTION_WORKSPACE must be set when interacting with @actions/artifact!'
+      )
+    })
+
+    it('Throws if LOCAL_ACTION_ARTIFACT_PATH is not set', async () => {
+      delete process.env.LOCAL_ACTION_ARTIFACT_PATH
+
+      const client = new DefaultArtifactClient()
+
+      await expect(
+        client.uploadArtifact('artifact-name', ['file1', 'file2'], 'root')
+      ).rejects.toThrow()
+    })
+
+    it('Throws if running on GHES', async () => {
+      isGhes.mockReturnValue(true)
+
+      const client = new DefaultArtifactClient()
+
+      await expect(
+        client.uploadArtifact('artifact-name', ['file1', 'file2'], 'root')
+      ).rejects.toThrow()
+    })
+
+    it('Uploads an artifact', async () => {
+      const client = new DefaultArtifactClient()
+
+      await client.uploadArtifact('artifact-name', ['file1', 'file2'], 'root')
+
+      expect(uploadArtifact).toHaveBeenCalled()
+    })
+  })
+
+  describe('downloadArtifact', () => {
+    it('Throws if LOCAL_ACTION_WORKSPACE is not set', async () => {
+      delete process.env.LOCAL_ACTION_WORKSPACE
+
+      const client = new DefaultArtifactClient()
+
+      await expect(client.downloadArtifact(1)).rejects.toThrow(
+        'LOCAL_ACTION_WORKSPACE must be set when interacting with @actions/artifact!'
+      )
+    })
+
+    it('Throws if LOCAL_ACTION_ARTIFACT_PATH is not set', async () => {
+      delete process.env.LOCAL_ACTION_ARTIFACT_PATH
+
+      const client = new DefaultArtifactClient()
+
+      await expect(client.downloadArtifact(1)).rejects.toThrow()
+    })
+
+    it('Throws if running on GHES', async () => {
+      isGhes.mockReturnValue(true)
+
+      const client = new DefaultArtifactClient()
+
+      await expect(client.downloadArtifact(1)).rejects.toThrow()
+    })
+
+    it('Downloads an artifact (internal)', async () => {
+      const client = new DefaultArtifactClient()
+
+      await client.downloadArtifact(1)
+
+      expect(downloadArtifactInternal).toHaveBeenCalled()
+      expect(downloadArtifactPublic).not.toHaveBeenCalled()
+    })
+
+    it('Downloads an artifact (public)', async () => {
+      const client = new DefaultArtifactClient()
+
+      await client.downloadArtifact(1, {
+        findBy: {
+          repositoryOwner: 'owner',
+          repositoryName: 'repo',
+          workflowRunId: 1,
+          token: 'token'
+        }
+      })
+
+      expect(downloadArtifactInternal).not.toHaveBeenCalled()
+      expect(downloadArtifactPublic).toHaveBeenCalled()
+    })
+  })
+
+  describe('listArtifacts', () => {
+    it('Throws if LOCAL_ACTION_WORKSPACE is not set', async () => {
+      delete process.env.LOCAL_ACTION_WORKSPACE
+
+      const client = new DefaultArtifactClient()
+
+      await expect(client.listArtifacts()).rejects.toThrow(
+        'LOCAL_ACTION_WORKSPACE must be set when interacting with @actions/artifact!'
+      )
+    })
+
+    it('Throws if LOCAL_ACTION_ARTIFACT_PATH is not set', async () => {
+      delete process.env.LOCAL_ACTION_ARTIFACT_PATH
+
+      const client = new DefaultArtifactClient()
+
+      await expect(client.listArtifacts()).rejects.toThrow()
+    })
+
+    it('Throws if running on GHES', async () => {
+      isGhes.mockReturnValue(true)
+
+      const client = new DefaultArtifactClient()
+
+      await expect(client.listArtifacts()).rejects.toThrow()
+    })
+
+    it('Lists artifacts (internal)', async () => {
+      const client = new DefaultArtifactClient()
+
+      await client.listArtifacts()
+
+      expect(listArtifactsInternal).toHaveBeenCalled()
+      expect(listArtifactsPublic).not.toHaveBeenCalled()
+    })
+
+    it('Lists artifacts (public)', async () => {
+      const client = new DefaultArtifactClient()
+
+      await client.listArtifacts({
+        findBy: {
+          repositoryOwner: 'owner',
+          repositoryName: 'repo',
+          workflowRunId: 1,
+          token: 'token'
+        }
+      })
+
+      expect(listArtifactsInternal).not.toHaveBeenCalled()
+      expect(listArtifactsPublic).toHaveBeenCalled()
+    })
+  })
+
+  describe('getArtifact', () => {
+    it('Throws if LOCAL_ACTION_WORKSPACE is not set', async () => {
+      delete process.env.LOCAL_ACTION_WORKSPACE
+
+      const client = new DefaultArtifactClient()
+
+      await expect(client.getArtifact('artifact-name')).rejects.toThrow(
+        'LOCAL_ACTION_WORKSPACE must be set when interacting with @actions/artifact!'
+      )
+    })
+
+    it('Throws if LOCAL_ACTION_ARTIFACT_PATH is not set', async () => {
+      delete process.env.LOCAL_ACTION_ARTIFACT_PATH
+
+      const client = new DefaultArtifactClient()
+
+      await expect(client.getArtifact('artifact-name')).rejects.toThrow()
+    })
+
+    it('Throws if running on GHES', async () => {
+      isGhes.mockReturnValue(true)
+
+      const client = new DefaultArtifactClient()
+
+      await expect(client.getArtifact('artifact-name')).rejects.toThrow()
+    })
+
+    it('Gets an artifact (internal)', async () => {
+      const client = new DefaultArtifactClient()
+
+      await client.getArtifact('artifact-name')
+
+      expect(getArtifactInternal).toHaveBeenCalled()
+      expect(getArtifactPublic).not.toHaveBeenCalled()
+    })
+
+    it('Gets an artifact (public)', async () => {
+      const client = new DefaultArtifactClient()
+
+      await client.getArtifact('artifact-name', {
+        findBy: {
+          repositoryOwner: 'owner',
+          repositoryName: 'repo',
+          workflowRunId: 1,
+          token: 'token'
+        }
+      })
+
+      expect(getArtifactInternal).not.toHaveBeenCalled()
+      expect(getArtifactPublic).toHaveBeenCalled()
+    })
+  })
+
+  describe('deleteArtifact', () => {
+    it('Throws if LOCAL_ACTION_WORKSPACE is not set', async () => {
+      delete process.env.LOCAL_ACTION_WORKSPACE
+
+      const client = new DefaultArtifactClient()
+
+      await expect(client.deleteArtifact('artifact-name')).rejects.toThrow(
+        'LOCAL_ACTION_WORKSPACE must be set when interacting with @actions/artifact!'
+      )
+    })
+
+    it('Throws if LOCAL_ACTION_ARTIFACT_PATH is not set', async () => {
+      delete process.env.LOCAL_ACTION_ARTIFACT_PATH
+
+      const client = new DefaultArtifactClient()
+
+      await expect(client.deleteArtifact('artifact-name')).rejects.toThrow()
+    })
+
+    it('Throws if running on GHES', async () => {
+      isGhes.mockReturnValue(true)
+
+      const client = new DefaultArtifactClient()
+
+      await expect(client.deleteArtifact('artifact-name')).rejects.toThrow()
+    })
+
+    it('Deletes an artifact (internal)', async () => {
+      const client = new DefaultArtifactClient()
+
+      await client.deleteArtifact('artifact-name')
+
+      expect(deleteArtifactInternal).toHaveBeenCalled()
+      expect(deleteArtifactPublic).not.toHaveBeenCalled()
+    })
+
+    it('Deletes an artifact (public)', async () => {
+      const client = new DefaultArtifactClient()
+
+      await client.deleteArtifact('artifact-name', {
+        findBy: {
+          repositoryOwner: 'owner',
+          repositoryName: 'repo',
+          workflowRunId: 1,
+          token: 'token'
+        }
+      })
+
+      expect(deleteArtifactInternal).not.toHaveBeenCalled()
+      expect(deleteArtifactPublic).toHaveBeenCalled()
+    })
+  })
+})

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

@@ -0,0 +1,152 @@
+import { jest } from '@jest/globals'
+import * as core from '../../../../../__fixtures__/@actions/core.js'
+import * as github from '../../../../../__fixtures__/@actions/github.js'
+import * as octokit from '../../../../../__fixtures__/@octokit/rest.js'
+import * as fs from '../../../../../__fixtures__/fs.js'
+import { ResetCoreMetadata } from '../../../../../src/stubs/core/core.js'
+import { EnvMeta, ResetEnvMetadata } from '../../../../../src/stubs/env.js'
+
+jest.unstable_mockModule('@octokit/rest', async () => {
+  class Octokit {
+    constructor() {
+      return octokit
+    }
+  }
+
+  return {
+    Octokit
+  }
+})
+jest.unstable_mockModule('fs', () => fs)
+
+const getArtifactPublic =
+  jest.fn<
+    typeof import('../../../../../src/stubs/artifact/internal/find/get-artifact.js').getArtifactPublic
+  >()
+
+jest.unstable_mockModule(
+  '../../../../../src/stubs/artifact/internal/find/get-artifact.js',
+  () => ({
+    getArtifactPublic
+  })
+)
+jest.unstable_mockModule('../../../../../src/stubs/core/core.js', () => core)
+jest.unstable_mockModule(
+  '../../../../../src/stubs/github/github.js',
+  () => github
+)
+
+const deleteArtifact =
+  await import('../../../../../src/stubs/artifact/internal/delete/delete-artifact.js')
+
+const { Octokit } = await import('@octokit/rest')
+const mocktokit = jest.mocked(new Octokit())
+
+describe('delete-artifact', () => {
+  beforeEach(() => {
+    // Reset metadata
+    ResetEnvMetadata()
+    ResetCoreMetadata()
+
+    // Set environment variables
+    process.env.LOCAL_ACTION_ARTIFACT_PATH = '/tmp/artifacts'
+  })
+
+  afterEach(() => {
+    jest.resetAllMocks()
+
+    // Unset environment variables
+    delete process.env.LOCAL_ACTION_ARTIFACT_PATH
+  })
+
+  describe('deleteArtifactPublic', () => {
+    beforeEach(() => {
+      getArtifactPublic.mockResolvedValue({
+        artifact: {
+          name: 'artifact-name',
+          id: 1,
+          size: 0
+        }
+      })
+    })
+
+    it('Deletes an artifact', async () => {
+      mocktokit.rest.actions.deleteArtifact.mockResolvedValue({
+        status: 204,
+        headers: {
+          'x-github-request-id': 'request-id'
+        }
+      } as any)
+
+      const response = await deleteArtifact.deleteArtifactPublic(
+        'artifact-name',
+        1,
+        'owner',
+        'repo',
+        'token'
+      )
+
+      expect(getArtifactPublic).toHaveBeenCalledTimes(1)
+      expect(mocktokit.rest.actions.deleteArtifact).toHaveBeenCalledTimes(1)
+      expect(response).toMatchObject({
+        id: 1
+      })
+    })
+
+    it('Throws if artifact fails to delete', async () => {
+      mocktokit.rest.actions.deleteArtifact.mockResolvedValue({
+        status: 400,
+        headers: {
+          'x-github-request-id': 'request-id'
+        }
+      } as any)
+
+      await expect(
+        deleteArtifact.deleteArtifactPublic(
+          'artifact-name',
+          1,
+          'owner',
+          'repo',
+          'token'
+        )
+      ).rejects.toThrow('Invalid response from GitHub API: 400 (request-id)')
+    })
+  })
+
+  describe('deleteArtifactInternal', () => {
+    it('Deletes an artifact', async () => {
+      EnvMeta.artifacts = [{ name: 'artifact-name', id: 1, size: 0 }]
+
+      const response =
+        await deleteArtifact.deleteArtifactInternal('artifact-name')
+
+      expect(fs.rmSync).toHaveBeenCalledTimes(1)
+      expect(EnvMeta.artifacts.length).toBe(0)
+      expect(response).toMatchObject({
+        id: 1
+      })
+    })
+
+    it('Deletes the latest artifact', async () => {
+      EnvMeta.artifacts = [
+        { name: 'artifact-name', id: 1, size: 0 },
+        { name: 'artifact-name', id: 2, size: 0 }
+      ]
+
+      const response =
+        await deleteArtifact.deleteArtifactInternal('artifact-name')
+
+      expect(fs.rmSync).toHaveBeenCalledTimes(1)
+      expect(EnvMeta.artifacts.length).toBe(1)
+      expect(response).toMatchObject({
+        id: 2
+      })
+    })
+
+    it('Throws if no matching artifact is found', async () => {
+      await expect(
+        deleteArtifact.deleteArtifactInternal('artifact-name')
+      ).rejects.toThrow()
+    })
+  })
+})

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

@@ -0,0 +1,119 @@
+import { jest } from '@jest/globals'
+import * as core from '../../../../../__fixtures__/@actions/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/core.js'
+import { EnvMeta, ResetEnvMetadata } from '../../../../../src/stubs/env.js'
+
+const readStream = {
+  on: () => readStream,
+  pipe: () => readStream
+}
+
+jest.unstable_mockModule('crypto', () => crypto)
+jest.unstable_mockModule('fs', () => fs)
+jest.unstable_mockModule('stream/promises', () => stream)
+
+jest.unstable_mockModule('../../../../../src/stubs/core/core.js', () => core)
+
+const downloadArtifact =
+  await import('../../../../../src/stubs/artifact/internal/download/download-artifact.js')
+
+describe('download-artifact', () => {
+  beforeEach(() => {
+    // Reset environment variables
+    process.env.LOCAL_ACTION_ARTIFACT_PATH = '/tmp/artifacts'
+
+    // Reset metadata
+    ResetEnvMetadata()
+    ResetCoreMetadata()
+
+    // Reset mocks
+    fs.createReadStream.mockImplementation(() => readStream)
+
+    EnvMeta.artifacts = [{ name: 'artifact-name', id: 1, size: 0 }]
+  })
+
+  afterEach(() => {
+    jest.resetAllMocks()
+
+    // Unset environment variables
+    delete process.env.LOCAL_ACTION_ARTIFACT_PATH
+  })
+
+  describe('scrubQueryParameters', () => {
+    it('Scrubs query parameters from a URL', () => {
+      const url = 'https://example.com?foo=bar&baz=qux'
+      const scrubbedUrl = downloadArtifact.scrubQueryParameters(url)
+      expect(scrubbedUrl).toBe('https://example.com/')
+    })
+  })
+
+  describe('exists', () => {
+    it('Returns true if the path exists', () => {
+      fs.accessSync.mockReturnValue(undefined)
+      const result = downloadArtifact.exists('/tmp/artifacts')
+      expect(result).toBe(true)
+    })
+
+    it('Returns false if the path does not exist', () => {
+      fs.accessSync.mockImplementation(() => {
+        throw { code: 'ENOENT' }
+      })
+      const result = downloadArtifact.exists('/tmp/artifacts')
+      expect(result).toBe(false)
+    })
+
+    it('Throws if an error other than ENOENT occurs', () => {
+      fs.accessSync.mockReset().mockImplementation(() => {
+        throw { code: 'EPERM' }
+      })
+      expect(() => downloadArtifact.exists('/tmp/artifacts')).toThrow()
+    })
+  })
+
+  describe('downloadArtifactInternal', () => {
+    it('Downloads an artifact', async () => {
+      await downloadArtifact.downloadArtifactInternal(1)
+
+      expect(fs.createReadStream).toHaveBeenCalledTimes(1)
+      expect(stream.finished).toHaveBeenCalledTimes(1)
+    })
+
+    it('Downloads the first artifact if multiple are found', async () => {
+      EnvMeta.artifacts = [
+        { name: 'artifact-name-1', id: 1, size: 0 },
+        { name: 'artifact-name-2', id: 1, size: 0 }
+      ]
+
+      await downloadArtifact.downloadArtifactInternal(1)
+
+      expect(fs.createReadStream).toHaveBeenCalledTimes(1)
+      expect(fs.createReadStream).toHaveBeenCalledWith(
+        '/tmp/artifacts/artifact-name-1.zip'
+      )
+      expect(stream.finished).toHaveBeenCalledTimes(1)
+    })
+
+    it('Throws if an artifact is not found', async () => {
+      EnvMeta.artifacts = []
+
+      await expect(
+        downloadArtifact.downloadArtifactInternal(1)
+      ).rejects.toThrow()
+    })
+
+    it('Throws if an error occurs while downloading', async () => {
+      fs.createReadStream.mockImplementation(() => {
+        throw new Error('Download error')
+      })
+
+      await expect(
+        downloadArtifact.downloadArtifactInternal(1)
+      ).rejects.toThrow(
+        'Unable to download and extract artifact: Download error'
+      )
+    })
+  })
+})