actions/publish-immutable-action
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
028b95005016dca9289faf2493bb045982298704
publish-immutable-action/__tests__/main.test.ts
T

641 lines
18 KiB
TypeScript
Raw Blame History

// /**
// * Unit tests for the action's main functionality, src/main.ts
// *
// * These should be run as if the action was called from a workflow.
// * Specifically, the inputs listed in `action.yml` should be set as environment
// * variables following the pattern `INPUT_<INPUT_NAME>`.
// */
// import * as core from '@actions/core'
// import * as attest from '@actions/attest'
// import * as main from '../src/main'
// import * as cfg from '../src/config'
// import * as fsHelper from '../src/fs-helper'
// import * as ghcr from '../src/ghcr-client'
// import * as ociContainer from '../src/oci-container'
// import * as oci from '@sigstore/oci'
describe('run', () => {
it('does not fail when running in a test', () => {
// This is a dummy test to ensure that the run function does not fail when running in a test
})
})
// const ghcrUrl = new URL('https://ghcr.io')
// // Mock the GitHub Actions core library
// let setFailedMock: jest.SpyInstance
// let setOutputMock: jest.SpyInstance
// // Mock the FS Helper
// let createTempDirMock: jest.SpyInstance
// let createArchivesMock: jest.SpyInstance
// let stageActionFilesMock: jest.SpyInstance
// let ensureCorrectShaCheckedOutMock: jest.SpyInstance
// // Mock OCI container lib
// let calculateManifestDigestMock: jest.SpyInstance
// // Mock GHCR client
// let publishOCIArtifactMock: jest.SpyInstance
// // Mock the config resolution
// let resolvePublishActionOptionsMock: jest.SpyInstance
// // Mock generating attestation
// let generateAttestationMock: jest.SpyInstance
// // Mock uploading attestation with oci lib
// let attachArtifactToImageMock: jest.SpyInstance
// describe('run', () => {
// beforeEach(() => {
// jest.clearAllMocks()
// // Core mocks
// setFailedMock = jest.spyOn(core, 'setFailed').mockImplementation()
// setOutputMock = jest.spyOn(core, 'setOutput').mockImplementation()
// // FS mocks
// createTempDirMock = jest
// .spyOn(fsHelper, 'createTempDir')
// .mockImplementation()
// createArchivesMock = jest
// .spyOn(fsHelper, 'createArchives')
// .mockImplementation()
// stageActionFilesMock = jest
// .spyOn(fsHelper, 'stageActionFiles')
// .mockImplementation()
// ensureCorrectShaCheckedOutMock = jest
// .spyOn(fsHelper, 'ensureTagAndRefCheckedOut')
// .mockImplementation()
// // OCI Container mocks
// calculateManifestDigestMock = jest
// .spyOn(ociContainer, 'sha256Digest')
// .mockImplementation()
// // GHCR Client mocks
// publishOCIArtifactMock = jest
// .spyOn(ghcr, 'pub')
// .mockImplementation()
// // Config mocks
// resolvePublishActionOptionsMock = jest
// .spyOn(cfg, 'resolvePublishActionOptions')
// .mockImplementation()
// // Attestation mocks
// generateAttestationMock = jest
// .spyOn(attest, 'attestProvenance')
// .mockImplementation()
// attachArtifactToImageMock = jest
// .spyOn(oci, 'attachArtifactToImage')
// .mockImplementation()
// })
// it('fails if the action ref is not a tag', async () => {
// const options = baseOptions()
// options.ref = 'refs/heads/main' // This is a branch, not a tag
// resolvePublishActionOptionsMock.mockReturnValueOnce(options)
// await main.run()
// expect(setFailedMock).toHaveBeenCalledWith(
// 'The ref refs/heads/main is not a valid tag reference.'
// )
// })
// it('fails if the value of the tag ref is not a valid semver', async () => {
// const tags = ['test', 'v1.0', 'chicken', '111111']
// for (const tag of tags) {
// const options = baseOptions()
// options.ref = `refs/tags/${tag}`
// resolvePublishActionOptionsMock.mockReturnValueOnce(options)
// await main.run()
// expect(setFailedMock).toHaveBeenCalledWith(
// `${tag} is not a valid semantic version tag, and so cannot be uploaded to the action package.`
// )
// }
// })
// it('fails if ensuring the correct SHA is checked out errors', async () => {
// resolvePublishActionOptionsMock.mockReturnValue(baseOptions())
// ensureCorrectShaCheckedOutMock.mockImplementation(() => {
// throw new Error('Something went wrong')
// })
// // Run the action
// await main.run()
// // Check the results
// expect(setFailedMock).toHaveBeenCalledWith('Something went wrong')
// })
// it('fails if creating staging temp directory fails', async () => {
// resolvePublishActionOptionsMock.mockReturnValue(baseOptions())
// ensureCorrectShaCheckedOutMock.mockImplementation(() => {})
// createTempDirMock.mockImplementation(() => {
// throw new Error('Something went wrong')
// })
// // Run the action
// await main.run()
// // Check the results
// expect(setFailedMock).toHaveBeenCalledWith('Something went wrong')
// })
// it('fails if staging files fails', async () => {
// resolvePublishActionOptionsMock.mockReturnValue(baseOptions())
// ensureCorrectShaCheckedOutMock.mockImplementation(() => {})
// createTempDirMock.mockImplementation(() => {
// return 'tmpDir/staging'
// })
// stageActionFilesMock.mockImplementation(() => {
// throw new Error('Something went wrong')
// })
// // Run the action
// await main.run()
// // Check the results
// expect(setFailedMock).toHaveBeenCalledWith('Something went wrong')
// })
// it('fails if creating archives temp directory fails', async () => {
// resolvePublishActionOptionsMock.mockReturnValue(baseOptions())
// ensureCorrectShaCheckedOutMock.mockImplementation(() => {})
// createTempDirMock.mockImplementation((_, path: string) => {
// if (path === 'staging') {
// return 'staging'
// }
// throw new Error('Something went wrong')
// })
// stageActionFilesMock.mockImplementation(() => {})
// // Run the action
// await main.run()
// // Check the results
// expect(setFailedMock).toHaveBeenCalledWith('Something went wrong')
// })
// it('fails if creating archives fails', async () => {
// resolvePublishActionOptionsMock.mockReturnValue(baseOptions())
// ensureCorrectShaCheckedOutMock.mockImplementation(() => {})
// createTempDirMock.mockImplementation(() => {
// return 'stagingOrArchivesDir'
// })
// stageActionFilesMock.mockImplementation(() => {})
// createArchivesMock.mockImplementation(() => {
// throw new Error('Something went wrong')
// })
// // Run the action
// await main.run()
// // Check the results
// expect(setFailedMock).toHaveBeenCalledWith('Something went wrong')
// })
// it('fails if creating attestation fails', async () => {
// resolvePublishActionOptionsMock.mockReturnValue(baseOptions())
// ensureCorrectShaCheckedOutMock.mockImplementation(() => {})
// createTempDirMock.mockImplementation(() => {
// return 'stagingOrArchivesDir'
// })
// stageActionFilesMock.mockImplementation(() => {})
// calculateManifestDigestMock.mockImplementation(() => {
// return 'sha256:my-test-digest'
// })
// createArchivesMock.mockImplementation(() => {
// return {
// zipFile: {
// path: 'test',
// size: 5,
// sha256: '123'
// },
// tarFile: {
// path: 'test2',
// size: 52,
// sha256: '1234'
// }
// }
// })
// publishOCIArtifactMock.mockImplementation(() => {
// return {
// packageURL: 'https://ghcr.io/v2/test-org/test-repo:1.2.3',
// publishedDigest: 'sha256:my-test-digest'
// }
// })
// generateAttestationMock.mockImplementation(async () => {
// throw new Error('Something went wrong')
// })
// // Run the action
// await main.run()
// // Check the results
// expect(setFailedMock).toHaveBeenCalledWith('Something went wrong')
// })
// it('fails if uploading attestation to GHCR fails', async () => {
// resolvePublishActionOptionsMock.mockReturnValue(baseOptions())
// ensureCorrectShaCheckedOutMock.mockImplementation(() => {})
// createTempDirMock.mockImplementation(() => {
// return 'stagingOrArchivesDir'
// })
// stageActionFilesMock.mockImplementation(() => {})
// createArchivesMock.mockImplementation(() => {
// return {
// zipFile: {
// path: 'test',
// size: 5,
// sha256: '123'
// },
// tarFile: {
// path: 'test2',
// size: 52,
// sha256: '1234'
// }
// }
// })
// calculateManifestDigestMock.mockImplementation(() => {
// return 'sha256:my-test-digest'
// })
// generateAttestationMock.mockImplementation(async options => {
// expect(options).toHaveProperty('skipWrite', true)
// return {
// attestationID: 'test-attestation-id',
// certificate: 'test',
// bundle: {
// mediaType: 'application/vnd.cncf.notary.v2+jwt',
// verificationMaterial: {
// publicKey: {
// hint: 'test-hint'
// }
// }
// }
// }
// })
// attachArtifactToImageMock.mockImplementation(() => {
// throw new Error('Something went wrong')
// })
// // Run the action
// await main.run()
// // Check the results
// expect(setFailedMock).toHaveBeenCalledWith('Something went wrong')
// })
// it('fails if publishing OCI artifact fails', async () => {
// resolvePublishActionOptionsMock.mockReturnValue(baseOptions())
// ensureCorrectShaCheckedOutMock.mockImplementation(() => {})
// createTempDirMock.mockImplementation(() => {
// return 'stagingOrArchivesDir'
// })
// stageActionFilesMock.mockImplementation(() => {})
// createArchivesMock.mockImplementation(() => {
// return {
// zipFile: {
// path: 'test',
// size: 5,
// sha256: '123'
// },
// tarFile: {
// path: 'test2',
// size: 52,
// sha256: '1234'
// }
// }
// })
// calculateManifestDigestMock.mockImplementation(() => {
// return 'sha256:my-test-digest'
// })
// generateAttestationMock.mockImplementation(async options => {
// expect(options).toHaveProperty('skipWrite', true)
// return {
// attestationID: 'test-attestation-id',
// certificate: 'test',
// bundle: {
// mediaType: 'application/vnd.cncf.notary.v2+jwt',
// verificationMaterial: {
// publicKey: {
// hint: 'test-hint'
// }
// }
// }
// }
// })
// attachArtifactToImageMock.mockImplementation(() => {
// return {
// digest: 'sha256:my-test-attestation-digest',
// urls: [
// 'ghcr.io/v2/test-org/test-package/manifests/sha256:my-test-attestation-digest'
// ]
// }
// })
// publishOCIArtifactMock.mockImplementation(() => {
// throw new Error('Something went wrong')
// })
// // Run the action
// await main.run()
// // Check the results
// expect(setFailedMock).toHaveBeenCalledWith('Something went wrong')
// })
// it('fails if unexpected digest returned from GHCR', async () => {
// resolvePublishActionOptionsMock.mockReturnValue(baseOptions())
// ensureCorrectShaCheckedOutMock.mockImplementation(() => {})
// createTempDirMock.mockImplementation(() => {
// return 'stagingOrArchivesDir'
// })
// stageActionFilesMock.mockImplementation(() => {})
// createArchivesMock.mockImplementation(() => {
// return {
// zipFile: {
// path: 'test',
// size: 5,
// sha256: '123'
// },
// tarFile: {
// path: 'test2',
// size: 52,
// sha256: '1234'
// }
// }
// })
// calculateManifestDigestMock.mockImplementation(() => {
// return 'sha256:my-test-digest'
// })
// generateAttestationMock.mockImplementation(async options => {
// expect(options).toHaveProperty('skipWrite', true)
// return {
// attestationID: 'test-attestation-id',
// certificate: 'test',
// bundle: {
// mediaType: 'application/vnd.cncf.notary.v2+jwt',
// verificationMaterial: {
// publicKey: {
// hint: 'test-hint'
// }
// }
// }
// }
// })
// attachArtifactToImageMock.mockImplementation(() => {
// return {
// digest: 'sha256:some-other-digest',
// urls: [
// 'ghcr.io/v2/test-org/test-package/manifests/sha256:some-other-digest'
// ]
// }
// })
// publishOCIArtifactMock.mockImplementation(() => {
// return {
// packageURL: 'https://ghcr.io/v2/test-org/test-repo:1.2.3',
// publishedDigest: 'sha256:some-other-digest'
// }
// })
// // Run the action
// await main.run()
// // Check the results
// expect(setFailedMock).toHaveBeenCalledWith(
// 'Unexpected digest returned for manifest. Expected sha256:my-test-digest, got sha256:some-other-digest'
// )
// })
// it('uploads the artifact, returns package metadata from GHCR, and skips writing attestation in enterprise', async () => {
// const options = baseOptions()
// options.isEnterprise = true
// resolvePublishActionOptionsMock.mockReturnValue(options)
// ensureCorrectShaCheckedOutMock.mockImplementation(() => {})
// createTempDirMock.mockImplementation(() => {
// return 'stagingOrArchivesDir'
// })
// stageActionFilesMock.mockImplementation(() => {})
// createArchivesMock.mockImplementation(() => {
// return {
// zipFile: {
// path: 'test',
// size: 5,
// sha256: '123'
// },
// tarFile: {
// path: 'test2',
// size: 52,
// sha256: '1234'
// }
// }
// })
// calculateManifestDigestMock.mockImplementation(() => {
// return 'sha256:my-test-digest'
// })
// publishOCIArtifactMock.mockImplementation(() => {
// return {
// packageURL: 'https://ghcr.io/v2/test-org/test-repo:1.2.3',
// publishedDigest: 'sha256:my-test-digest'
// }
// })
// // Run the action
// await main.run()
// // Check the results
// expect(publishOCIArtifactMock).toHaveBeenCalledTimes(1)
// // Check outputs
// expect(setOutputMock).toHaveBeenCalledTimes(3)
// expect(setOutputMock).toHaveBeenCalledWith(
// 'package-url',
// 'https://ghcr.io/v2/test-org/test-repo:1.2.3'
// )
// expect(setOutputMock).toHaveBeenCalledWith(
// 'package-manifest',
// expect.any(String)
// )
// expect(setOutputMock).toHaveBeenCalledWith(
// 'package-manifest-sha',
// 'sha256:my-test-digest'
// )
// })
// it('uploads the artifact, returns package metadata from GHCR, and creates an attestation in non-enterprise for public repo', async () => {
// resolvePublishActionOptionsMock.mockReturnValue(baseOptions())
// ensureCorrectShaCheckedOutMock.mockImplementation(() => {})
// createTempDirMock.mockImplementation(() => {
// return 'stagingOrArchivesDir'
// })
// stageActionFilesMock.mockImplementation(() => {})
// createArchivesMock.mockImplementation(() => {
// return {
// zipFile: {
// path: 'test',
// size: 5,
// sha256: '123'
// },
// tarFile: {
// path: 'test2',
// size: 52,
// sha256: '1234'
// }
// }
// })
// calculateManifestDigestMock.mockImplementation(() => {
// return 'sha256:my-test-digest'
// })
// generateAttestationMock.mockImplementation(async options => {
// expect(options).toHaveProperty('skipWrite', true)
// return {
// attestationID: 'test-attestation-id',
// certificate: 'test',
// bundle: {
// mediaType: 'application/vnd.cncf.notary.v2+jwt',
// verificationMaterial: {
// publicKey: {
// hint: 'test-hint'
// }
// }
// }
// }
// })
// attachArtifactToImageMock.mockImplementation(async () => {
// return {
// digest: 'sha256:my-test-attestation-digest',
// urls: [
// 'ghcr.io/v2/test-org/test-package/manifests/sha256:my-test-attestation-digest'
// ]
// }
// })
// publishOCIArtifactMock.mockImplementation(() => {
// return {
// packageURL: 'https://ghcr.io/v2/test-org/test-repo:1.2.3',
// publishedDigest: 'sha256:my-test-digest'
// }
// })
// // Run the action
// await main.run()
// // Check the results
// expect(publishOCIArtifactMock).toHaveBeenCalledTimes(1)
// // Check outputs
// expect(setOutputMock).toHaveBeenCalledTimes(5)
// expect(setOutputMock).toHaveBeenCalledWith(
// 'attestation-manifest-sha',
// 'sha256:my-test-attestation-digest'
// )
// expect(setOutputMock).toHaveBeenCalledWith(
// 'attestation-url',
// 'ghcr.io/v2/test-org/test-package/manifests/sha256:my-test-attestation-digest'
// )
// expect(setOutputMock).toHaveBeenCalledWith(
// 'package-url',
// 'https://ghcr.io/v2/test-org/test-repo:1.2.3'
// )
// expect(setOutputMock).toHaveBeenCalledWith(
// 'package-manifest',
// expect.any(String)
// )
// expect(setOutputMock).toHaveBeenCalledWith(
// 'package-manifest-sha',
// 'sha256:my-test-digest'
// )
// })
// })
// function baseOptions(): cfg.PublishActionOptions {
// return {
// nameWithOwner: 'nameWithOwner',
// workspaceDir: 'workspaceDir',
// event: 'release',
// apiBaseUrl: 'apiBaseUrl',
// runnerTempDir: 'runnerTempDir',
// sha: 'sha',
// repositoryId: 'repositoryId',
// repositoryOwnerId: 'repositoryOwnerId',
// isEnterprise: false,
// containerRegistryUrl: ghcrUrl,
// token: 'token',
// ref: 'refs/tags/v1.2.3',
// repositoryVisibility: 'public'
// }
// }
Reference in New Issue View Git Blame Copy Permalink