mirror of
https://github.com/actions/download-artifact.git
synced 2025-04-23 14:46:43 +08:00
387 lines
10 KiB
TypeScript
387 lines
10 KiB
TypeScript
import * as core from '@actions/core'
|
|
import artifact, {ArtifactNotFoundError} from '@actions/artifact'
|
|
import {run} from '../src/download-artifact'
|
|
import {Inputs} from '../src/constants'
|
|
|
|
jest.mock('@actions/github', () => ({
|
|
context: {
|
|
repo: {
|
|
owner: 'actions',
|
|
repo: 'toolkit'
|
|
},
|
|
runId: 123,
|
|
serverUrl: 'https://github.com'
|
|
}
|
|
}))
|
|
|
|
jest.mock('@actions/core')
|
|
|
|
/* eslint-disable no-unused-vars */ /* eslint-disable @typescript-eslint/no-explicit-any */
|
|
const mockInputs = (overrides?: Partial<{[K in Inputs]?: any}>) => {
|
|
const inputs = {
|
|
[Inputs.Name]: 'artifact-name',
|
|
[Inputs.Path]: '/some/artifact/path',
|
|
[Inputs.GitHubToken]: 'warn',
|
|
[Inputs.Repository]: 'owner/some-repository',
|
|
[Inputs.RunID]: 'some-run-id',
|
|
[Inputs.Pattern]: 'some-pattern',
|
|
[Inputs.MergeMultiple]: false,
|
|
[Inputs.ArtifactIds]: '',
|
|
...overrides
|
|
}
|
|
|
|
;(core.getInput as jest.Mock).mockImplementation((name: string) => {
|
|
return inputs[name]
|
|
})
|
|
;(core.getBooleanInput as jest.Mock).mockImplementation((name: string) => {
|
|
return inputs[name]
|
|
})
|
|
|
|
return inputs
|
|
}
|
|
|
|
describe('download', () => {
|
|
beforeEach(async () => {
|
|
mockInputs()
|
|
jest.clearAllMocks()
|
|
|
|
// Mock artifact client methods
|
|
jest
|
|
.spyOn(artifact, 'listArtifacts')
|
|
.mockImplementation(() => Promise.resolve({artifacts: []}))
|
|
jest.spyOn(artifact, 'getArtifact').mockImplementation(name => {
|
|
throw new ArtifactNotFoundError(`Artifact '${name}' not found`)
|
|
})
|
|
jest
|
|
.spyOn(artifact, 'downloadArtifact')
|
|
.mockImplementation(() => Promise.resolve({digestMismatch: false}))
|
|
})
|
|
|
|
test('downloads a single artifact by name', async () => {
|
|
const mockArtifact = {
|
|
id: 123,
|
|
name: 'artifact-name',
|
|
size: 1024,
|
|
digest: 'abc123'
|
|
}
|
|
|
|
jest
|
|
.spyOn(artifact, 'getArtifact')
|
|
.mockImplementation(() => Promise.resolve({artifact: mockArtifact}))
|
|
|
|
await run()
|
|
|
|
expect(artifact.downloadArtifact).toHaveBeenCalledWith(
|
|
mockArtifact.id,
|
|
expect.objectContaining({
|
|
expectedHash: mockArtifact.digest
|
|
})
|
|
)
|
|
expect(core.info).toHaveBeenCalledWith('Total of 1 artifact(s) downloaded')
|
|
|
|
expect(core.setOutput).toHaveBeenCalledWith(
|
|
'download-path',
|
|
expect.any(String)
|
|
)
|
|
|
|
expect(core.info).toHaveBeenCalledWith(
|
|
'Download artifact has finished successfully'
|
|
)
|
|
})
|
|
|
|
test('downloads multiple artifacts when no name or pattern provided', async () => {
|
|
jest.clearAllMocks()
|
|
mockInputs({
|
|
[Inputs.Name]: '',
|
|
[Inputs.Pattern]: ''
|
|
})
|
|
|
|
const mockArtifacts = [
|
|
{id: 123, name: 'artifact1', size: 1024, digest: 'abc123'},
|
|
{id: 456, name: 'artifact2', size: 2048, digest: 'def456'}
|
|
]
|
|
|
|
// Set up artifact mock after clearing mocks
|
|
jest
|
|
.spyOn(artifact, 'listArtifacts')
|
|
.mockImplementation(() => Promise.resolve({artifacts: mockArtifacts}))
|
|
|
|
// Reset downloadArtifact mock as well
|
|
jest
|
|
.spyOn(artifact, 'downloadArtifact')
|
|
.mockImplementation(() => Promise.resolve({digestMismatch: false}))
|
|
|
|
await run()
|
|
|
|
expect(core.info).toHaveBeenCalledWith(
|
|
'No input name, artifact-ids or pattern filtered specified, downloading all artifacts'
|
|
)
|
|
|
|
expect(core.info).toHaveBeenCalledWith('Total of 2 artifact(s) downloaded')
|
|
expect(artifact.downloadArtifact).toHaveBeenCalledTimes(2)
|
|
})
|
|
|
|
test('sets download path output even when no artifacts are found', async () => {
|
|
mockInputs({[Inputs.Name]: ''})
|
|
|
|
await run()
|
|
|
|
expect(core.setOutput).toHaveBeenCalledWith(
|
|
'download-path',
|
|
expect.any(String)
|
|
)
|
|
|
|
expect(core.info).toHaveBeenCalledWith(
|
|
'Download artifact has finished successfully'
|
|
)
|
|
|
|
expect(core.info).toHaveBeenCalledWith('Total of 0 artifact(s) downloaded')
|
|
})
|
|
|
|
test('filters artifacts by pattern', async () => {
|
|
const mockArtifacts = [
|
|
{id: 123, name: 'test-artifact', size: 1024, digest: 'abc123'},
|
|
{id: 456, name: 'prod-artifact', size: 2048, digest: 'def456'}
|
|
]
|
|
|
|
jest
|
|
.spyOn(artifact, 'listArtifacts')
|
|
.mockImplementation(() => Promise.resolve({artifacts: mockArtifacts}))
|
|
|
|
mockInputs({
|
|
[Inputs.Name]: '',
|
|
[Inputs.Pattern]: 'test-*'
|
|
})
|
|
|
|
await run()
|
|
|
|
expect(artifact.downloadArtifact).toHaveBeenCalledTimes(1)
|
|
expect(artifact.downloadArtifact).toHaveBeenCalledWith(
|
|
123,
|
|
expect.anything()
|
|
)
|
|
})
|
|
|
|
test('uses token and repository information when provided', async () => {
|
|
const token = 'ghp_testtoken123'
|
|
|
|
mockInputs({
|
|
[Inputs.Name]: '',
|
|
[Inputs.GitHubToken]: token,
|
|
[Inputs.Repository]: 'myorg/myrepo',
|
|
[Inputs.RunID]: '789'
|
|
})
|
|
|
|
jest
|
|
.spyOn(artifact, 'listArtifacts')
|
|
.mockImplementation(() => Promise.resolve({artifacts: []}))
|
|
|
|
await run()
|
|
|
|
expect(artifact.listArtifacts).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
findBy: {
|
|
token,
|
|
workflowRunId: 789,
|
|
repositoryName: 'myrepo',
|
|
repositoryOwner: 'myorg'
|
|
}
|
|
})
|
|
)
|
|
})
|
|
|
|
test('throws error when repository format is invalid', async () => {
|
|
mockInputs({
|
|
[Inputs.GitHubToken]: 'some-token',
|
|
[Inputs.Repository]: 'invalid-format' // Missing the owner/repo format
|
|
})
|
|
|
|
await expect(run()).rejects.toThrow(
|
|
"Invalid repository: 'invalid-format'. Must be in format owner/repo"
|
|
)
|
|
})
|
|
|
|
test('warns when digest validation fails', async () => {
|
|
const mockArtifact = {
|
|
id: 123,
|
|
name: 'corrupted-artifact',
|
|
size: 1024,
|
|
digest: 'abc123'
|
|
}
|
|
|
|
jest
|
|
.spyOn(artifact, 'getArtifact')
|
|
.mockImplementation(() => Promise.resolve({artifact: mockArtifact}))
|
|
|
|
jest
|
|
.spyOn(artifact, 'downloadArtifact')
|
|
.mockImplementation(() => Promise.resolve({digestMismatch: true}))
|
|
|
|
await run()
|
|
|
|
expect(core.warning).toHaveBeenCalledWith(
|
|
expect.stringContaining('digest validation failed')
|
|
)
|
|
})
|
|
|
|
test('throws error when both name and artifact-ids are provided', async () => {
|
|
mockInputs({
|
|
[Inputs.Name]: 'artifact-name',
|
|
[Inputs.ArtifactIds]: '123'
|
|
})
|
|
|
|
await expect(run()).rejects.toThrow(
|
|
"Inputs 'name' and 'artifact-ids' cannot be used together. Please specify only one."
|
|
)
|
|
})
|
|
|
|
test('throws error when artifact-ids is empty', async () => {
|
|
mockInputs({
|
|
[Inputs.Name]: '',
|
|
[Inputs.ArtifactIds]: ' , '
|
|
})
|
|
|
|
await expect(run()).rejects.toThrow(
|
|
"No valid artifact IDs provided in 'artifact-ids' input"
|
|
)
|
|
})
|
|
|
|
test('throws error when artifact-id is not a number', async () => {
|
|
mockInputs({
|
|
[Inputs.Name]: '',
|
|
[Inputs.ArtifactIds]: '123,abc,456'
|
|
})
|
|
|
|
await expect(run()).rejects.toThrow(
|
|
"Invalid artifact ID: 'abc'. Must be a number."
|
|
)
|
|
})
|
|
|
|
test('downloads a single artifact by ID', async () => {
|
|
const mockArtifact = {
|
|
id: 123,
|
|
name: 'artifact-by-id',
|
|
size: 1024,
|
|
digest: 'def456'
|
|
}
|
|
|
|
mockInputs({
|
|
[Inputs.Name]: '',
|
|
[Inputs.ArtifactIds]: '123'
|
|
})
|
|
|
|
jest
|
|
.spyOn(artifact, 'getArtifact')
|
|
.mockImplementation(() => Promise.resolve({artifact: mockArtifact}))
|
|
|
|
await run()
|
|
|
|
expect(core.debug).toHaveBeenCalledWith(
|
|
'Only one artifact ID provided. Fetching latest artifact by its name and checking the ID'
|
|
)
|
|
expect(artifact.getArtifact).toHaveBeenCalled()
|
|
expect(artifact.downloadArtifact).toHaveBeenCalledWith(
|
|
mockArtifact.id,
|
|
expect.objectContaining({
|
|
expectedHash: mockArtifact.digest
|
|
})
|
|
)
|
|
expect(artifact.listArtifacts).not.toHaveBeenCalled()
|
|
expect(core.info).toHaveBeenCalledWith('Total of 1 artifact(s) downloaded')
|
|
})
|
|
|
|
test('throws error when single artifact ID is not found', async () => {
|
|
mockInputs({
|
|
[Inputs.Name]: '',
|
|
[Inputs.ArtifactIds]: '999'
|
|
})
|
|
|
|
jest.spyOn(artifact, 'getArtifact').mockImplementation(() => {
|
|
return Promise.resolve({artifact: null} as any)
|
|
})
|
|
|
|
await expect(run()).rejects.toThrow(
|
|
"Artifact with ID '999' not found. Please check the ID."
|
|
)
|
|
})
|
|
|
|
test('downloads multiple artifacts by IDs', async () => {
|
|
const mockArtifacts = [
|
|
{id: 123, name: 'artifact1', size: 1024, digest: 'abc123'},
|
|
{id: 456, name: 'artifact2', size: 2048, digest: 'def456'},
|
|
{id: 789, name: 'artifact3', size: 3072, digest: 'ghi789'}
|
|
]
|
|
|
|
mockInputs({
|
|
[Inputs.Name]: '',
|
|
[Inputs.ArtifactIds]: '123, 456'
|
|
})
|
|
|
|
jest
|
|
.spyOn(artifact, 'listArtifacts')
|
|
.mockImplementation(() => Promise.resolve({artifacts: mockArtifacts}))
|
|
|
|
await run()
|
|
|
|
expect(core.info).toHaveBeenCalledWith(
|
|
'Multiple artifact IDs provided. Fetching all artifacts to filter by ID'
|
|
)
|
|
expect(artifact.getArtifact).not.toHaveBeenCalled()
|
|
expect(artifact.listArtifacts).toHaveBeenCalled()
|
|
expect(artifact.downloadArtifact).toHaveBeenCalledTimes(2)
|
|
expect(artifact.downloadArtifact).toHaveBeenCalledWith(
|
|
123,
|
|
expect.anything()
|
|
)
|
|
expect(artifact.downloadArtifact).toHaveBeenCalledWith(
|
|
456,
|
|
expect.anything()
|
|
)
|
|
})
|
|
|
|
test('warns when some artifact IDs are not found', async () => {
|
|
const mockArtifacts = [
|
|
{id: 123, name: 'artifact1', size: 1024, digest: 'abc123'}
|
|
]
|
|
|
|
mockInputs({
|
|
[Inputs.Name]: '',
|
|
[Inputs.ArtifactIds]: '123, 456, 789'
|
|
})
|
|
|
|
jest
|
|
.spyOn(artifact, 'listArtifacts')
|
|
.mockImplementation(() => Promise.resolve({artifacts: mockArtifacts}))
|
|
|
|
await run()
|
|
|
|
expect(core.warning).toHaveBeenCalledWith(
|
|
'Could not find the following artifact IDs: 456, 789'
|
|
)
|
|
expect(artifact.downloadArtifact).toHaveBeenCalledTimes(1)
|
|
expect(artifact.downloadArtifact).toHaveBeenCalledWith(
|
|
123,
|
|
expect.anything()
|
|
)
|
|
})
|
|
|
|
test('throws error when none of the provided artifact IDs are found', async () => {
|
|
const mockArtifacts = [
|
|
{id: 999, name: 'other-artifact', size: 1024, digest: 'xyz999'}
|
|
]
|
|
|
|
mockInputs({
|
|
[Inputs.Name]: '',
|
|
[Inputs.ArtifactIds]: '123, 456'
|
|
})
|
|
|
|
jest
|
|
.spyOn(artifact, 'listArtifacts')
|
|
.mockImplementation(() => Promise.resolve({artifacts: mockArtifacts}))
|
|
|
|
await expect(run()).rejects.toThrow(
|
|
'None of the provided artifact IDs were found'
|
|
)
|
|
})
|
|
})
|