mirror of
https://github.com/docker/actions-toolkit.git
synced 2024-11-23 03:16:09 +08:00
366 lines
11 KiB
TypeScript
366 lines
11 KiB
TypeScript
/**
|
|
* Copyright 2023 actions-toolkit authors
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import {afterEach, beforeEach, describe, expect, it, jest, test} from '@jest/globals';
|
|
import fs from 'fs';
|
|
import os from 'os';
|
|
import path from 'path';
|
|
import * as rimraf from 'rimraf';
|
|
|
|
import {Context} from '../../src/context';
|
|
import {Build} from '../../src/buildx/build';
|
|
|
|
const fixturesDir = path.join(__dirname, '..', '.fixtures');
|
|
const tmpDir = fs.mkdtempSync(path.join(process.env.TEMP || os.tmpdir(), 'buildx-build-'));
|
|
const tmpName = path.join(tmpDir, '.tmpname-jest');
|
|
const metadata = JSON.parse(fs.readFileSync(path.join(fixturesDir, 'metadata-build.json'), 'utf-8'));
|
|
|
|
jest.spyOn(Context, 'tmpDir').mockImplementation((): string => {
|
|
fs.mkdirSync(tmpDir, {recursive: true});
|
|
return tmpDir;
|
|
});
|
|
|
|
jest.spyOn(Context, 'tmpName').mockImplementation((): string => {
|
|
return tmpName;
|
|
});
|
|
|
|
afterEach(() => {
|
|
rimraf.sync(tmpDir);
|
|
});
|
|
|
|
describe('resolveImageID', () => {
|
|
it('matches', async () => {
|
|
const imageID = 'sha256:bfb45ab72e46908183546477a08f8867fc40cebadd00af54b071b097aed127a9';
|
|
const build = new Build();
|
|
fs.writeFileSync(build.getImageIDFilePath(), imageID);
|
|
expect(build.resolveImageID()).toEqual(imageID);
|
|
});
|
|
});
|
|
|
|
describe('resolveMetadata', () => {
|
|
it('matches', async () => {
|
|
const build = new Build();
|
|
fs.writeFileSync(build.getMetadataFilePath(), JSON.stringify(metadata));
|
|
expect(build.resolveMetadata()).toEqual(metadata);
|
|
});
|
|
});
|
|
|
|
describe('resolveRef', () => {
|
|
it('matches', async () => {
|
|
const build = new Build();
|
|
fs.writeFileSync(build.getMetadataFilePath(), JSON.stringify(metadata));
|
|
expect(build.resolveRef()).toEqual('default/default/n6ibcp9b2pw108rrz7ywdznvo');
|
|
});
|
|
});
|
|
|
|
describe('resolveProvenance', () => {
|
|
it('matches', async () => {
|
|
const build = new Build();
|
|
fs.writeFileSync(build.getMetadataFilePath(), JSON.stringify(metadata));
|
|
const provenance = build.resolveProvenance();
|
|
expect(provenance).toBeDefined();
|
|
expect(provenance?.buildType).toEqual('https://mobyproject.org/buildkit@v1');
|
|
expect(provenance?.materials).toBeDefined();
|
|
expect(provenance?.materials?.length).toEqual(2);
|
|
});
|
|
});
|
|
|
|
describe('resolveWarnings', () => {
|
|
it('matches', async () => {
|
|
const build = new Build();
|
|
fs.writeFileSync(build.getMetadataFilePath(), JSON.stringify(metadata));
|
|
const warnings = build.resolveWarnings();
|
|
expect(warnings).toBeDefined();
|
|
expect(warnings?.length).toEqual(3);
|
|
});
|
|
});
|
|
|
|
describe('resolveDigest', () => {
|
|
it('matches', async () => {
|
|
const build = new Build();
|
|
fs.writeFileSync(build.getMetadataFilePath(), JSON.stringify(metadata));
|
|
expect(build.resolveDigest()).toEqual('sha256:b09b9482c72371486bb2c1d2c2a2633ed1d0b8389e12c8d52b9e052725c0c83c');
|
|
});
|
|
});
|
|
|
|
describe('getProvenanceInput', () => {
|
|
beforeEach(() => {
|
|
process.env = Object.keys(process.env).reduce((object, key) => {
|
|
if (!key.startsWith('INPUT_')) {
|
|
object[key] = process.env[key];
|
|
}
|
|
return object;
|
|
}, {});
|
|
});
|
|
|
|
// prettier-ignore
|
|
test.each([
|
|
[
|
|
'true',
|
|
'builder-id=https://github.com/docker/actions-toolkit/actions/runs/2188748038/attempts/2'
|
|
],
|
|
[
|
|
'false',
|
|
'false'
|
|
],
|
|
[
|
|
'mode=min',
|
|
'mode=min,builder-id=https://github.com/docker/actions-toolkit/actions/runs/2188748038/attempts/2'
|
|
],
|
|
[
|
|
'mode=max',
|
|
'mode=max,builder-id=https://github.com/docker/actions-toolkit/actions/runs/2188748038/attempts/2'
|
|
],
|
|
[
|
|
'builder-id=foo',
|
|
'builder-id=foo'
|
|
],
|
|
[
|
|
'mode=max,builder-id=foo',
|
|
'mode=max,builder-id=foo'
|
|
],
|
|
[
|
|
'',
|
|
''
|
|
],
|
|
])('given input %p', async (input: string, expected: string) => {
|
|
setInput('provenance', input);
|
|
expect(Build.getProvenanceInput('provenance')).toEqual(expected);
|
|
});
|
|
});
|
|
|
|
describe('resolveProvenanceAttrs', () => {
|
|
// prettier-ignore
|
|
test.each([
|
|
[
|
|
'mode=min',
|
|
'mode=min,builder-id=https://github.com/docker/actions-toolkit/actions/runs/2188748038/attempts/2'
|
|
],
|
|
[
|
|
'mode=max',
|
|
'mode=max,builder-id=https://github.com/docker/actions-toolkit/actions/runs/2188748038/attempts/2'
|
|
],
|
|
[
|
|
'builder-id=foo',
|
|
'builder-id=foo'
|
|
],
|
|
[
|
|
'mode=max,builder-id=foo',
|
|
'mode=max,builder-id=foo'
|
|
],
|
|
[
|
|
'',
|
|
'builder-id=https://github.com/docker/actions-toolkit/actions/runs/2188748038/attempts/2'
|
|
],
|
|
])('given %p', async (input: string, expected: string) => {
|
|
expect(Build.resolveProvenanceAttrs(input)).toEqual(expected);
|
|
});
|
|
});
|
|
|
|
describe('resolveSecret', () => {
|
|
test.each([
|
|
['A_SECRET=abcdef0123456789', false, 'A_SECRET', 'abcdef0123456789', null],
|
|
['GIT_AUTH_TOKEN=abcdefghijklmno=0123456789', false, 'GIT_AUTH_TOKEN', 'abcdefghijklmno=0123456789', null],
|
|
['MY_KEY=c3RyaW5nLXdpdGgtZXF1YWxzCg==', false, 'MY_KEY', 'c3RyaW5nLXdpdGgtZXF1YWxzCg==', null],
|
|
['aaaaaaaa', false, '', '', new Error('aaaaaaaa is not a valid secret')],
|
|
['aaaaaaaa=', false, '', '', new Error('aaaaaaaa= is not a valid secret')],
|
|
['=bbbbbbb', false, '', '', new Error('=bbbbbbb is not a valid secret')],
|
|
[`foo=${path.join(fixturesDir, 'secret.txt')}`, true, 'foo', 'bar', null],
|
|
[`notfound=secret`, true, '', '', new Error('secret file secret not found')]
|
|
])('given %p key and %p secret', async (kvp: string, file: boolean, exKey: string, exValue: string, error: Error | null) => {
|
|
try {
|
|
let secret: string;
|
|
if (file) {
|
|
secret = Build.resolveSecretFile(kvp);
|
|
} else {
|
|
secret = Build.resolveSecretString(kvp);
|
|
}
|
|
expect(secret).toEqual(`id=${exKey},src=${tmpName}`);
|
|
expect(fs.readFileSync(tmpName, 'utf-8')).toEqual(exValue);
|
|
} catch (e) {
|
|
// eslint-disable-next-line jest/no-conditional-expect
|
|
expect(e.message).toEqual(error?.message);
|
|
}
|
|
});
|
|
|
|
test.each([
|
|
['FOO=bar', 'FOO', 'bar', null],
|
|
['FOO=', 'FOO', '', new Error('FOO= is not a valid secret')],
|
|
['=bar', '', '', new Error('=bar is not a valid secret')],
|
|
['FOO=bar=baz', 'FOO', 'bar=baz', null]
|
|
])('given %p key and %p env', async (kvp: string, exKey: string, exValue: string, error: Error | null) => {
|
|
try {
|
|
const secret = Build.resolveSecretEnv(kvp);
|
|
expect(secret).toEqual(`id=${exKey},env=${exValue}`);
|
|
} catch (e) {
|
|
// eslint-disable-next-line jest/no-conditional-expect
|
|
expect(e.message).toEqual(error?.message);
|
|
}
|
|
});
|
|
});
|
|
|
|
describe('resolveCacheToAttrs', () => {
|
|
// prettier-ignore
|
|
test.each([
|
|
[
|
|
'',
|
|
undefined,
|
|
''
|
|
],
|
|
[
|
|
'user/app:cache',
|
|
undefined,
|
|
'user/app:cache'
|
|
],
|
|
[
|
|
'type=inline',
|
|
undefined,
|
|
'type=inline'
|
|
],
|
|
[
|
|
'type=gha',
|
|
undefined,
|
|
'type=gha,repository=docker/actions-toolkit',
|
|
],
|
|
[
|
|
'type=gha,mode=max',
|
|
undefined,
|
|
'type=gha,mode=max,repository=docker/actions-toolkit',
|
|
],
|
|
[
|
|
'type=gha,mode=max',
|
|
'abcd1234',
|
|
'type=gha,mode=max,repository=docker/actions-toolkit,ghtoken=abcd1234',
|
|
],
|
|
[
|
|
'type=gha,repository=foo/bar,mode=max',
|
|
undefined,
|
|
'type=gha,repository=foo/bar,mode=max',
|
|
],
|
|
[
|
|
'type=gha,repository=foo/bar,mode=max',
|
|
'abcd1234',
|
|
'type=gha,repository=foo/bar,mode=max,ghtoken=abcd1234',
|
|
],
|
|
])('given %p', async (input: string, githubToken: string | undefined, expected: string) => {
|
|
expect(Build.resolveCacheToAttrs(input, githubToken)).toEqual(expected);
|
|
});
|
|
});
|
|
|
|
describe('hasLocalExporter', () => {
|
|
// prettier-ignore
|
|
test.each([
|
|
[['type=registry,ref=user/app'], false],
|
|
[['type=docker'], false],
|
|
[['type=local,dest=./release-out'], true],
|
|
[['type=tar,dest=/tmp/image.tar'], false],
|
|
[['type=docker', 'type=tar,dest=/tmp/image.tar'], false],
|
|
[['"type=tar","dest=/tmp/image.tar"'], false],
|
|
[['" type= local" , dest=./release-out'], true],
|
|
[['.'], true]
|
|
])('given %p returns %p', async (exporters: Array<string>, expected: boolean) => {
|
|
expect(Build.hasLocalExporter(exporters)).toEqual(expected);
|
|
});
|
|
});
|
|
|
|
describe('hasTarExporter', () => {
|
|
// prettier-ignore
|
|
test.each([
|
|
[['type=registry,ref=user/app'], false],
|
|
[['type=docker'], false],
|
|
[['type=local,dest=./release-out'], false],
|
|
[['type=tar,dest=/tmp/image.tar'], true],
|
|
[['type=docker', 'type=tar,dest=/tmp/image.tar'], true],
|
|
[['"type=tar","dest=/tmp/image.tar"'], true],
|
|
[['" type= local" , dest=./release-out'], false],
|
|
[['.'], false]
|
|
])('given %p returns %p', async (exporters: Array<string>, expected: boolean) => {
|
|
expect(Build.hasTarExporter(exporters)).toEqual(expected);
|
|
});
|
|
});
|
|
|
|
describe('hasDockerExporter', () => {
|
|
// prettier-ignore
|
|
test.each([
|
|
[['type=registry,ref=user/app'], false, undefined],
|
|
[['type=docker'], true, undefined],
|
|
[['type=local,dest=./release-out'], false, undefined],
|
|
[['type=tar,dest=/tmp/image.tar'], false, undefined],
|
|
[['type=docker', 'type=tar,dest=/tmp/image.tar'], true, undefined],
|
|
[['"type=tar","dest=/tmp/image.tar"'], false, undefined],
|
|
[['" type= local" , dest=./release-out'], false, undefined],
|
|
[['type=docker'], true, false],
|
|
[['type=docker'], true, true],
|
|
[['.'], true, true],
|
|
])('given %p returns %p', async (exporters: Array<string>, expected: boolean, load: boolean | undefined) => {
|
|
expect(Build.hasDockerExporter(exporters, load)).toEqual(expected);
|
|
});
|
|
});
|
|
|
|
describe('hasAttestationType', () => {
|
|
// prettier-ignore
|
|
test.each([
|
|
['type=provenance,mode=min', 'provenance', true],
|
|
['type=sbom,true', 'sbom', true],
|
|
['type=foo,bar', 'provenance', false],
|
|
])('given %p for %p returns %p', async (attrs: string, name: string, expected: boolean) => {
|
|
expect(Build.hasAttestationType(name, attrs)).toEqual(expected);
|
|
});
|
|
});
|
|
|
|
describe('resolveAttestationAttrs', () => {
|
|
// prettier-ignore
|
|
test.each([
|
|
[
|
|
'type=provenance,mode=min',
|
|
'type=provenance,mode=min'
|
|
],
|
|
[
|
|
'type=provenance,true',
|
|
'type=provenance,disabled=false'
|
|
],
|
|
[
|
|
'type=provenance,false',
|
|
'type=provenance,disabled=true'
|
|
],
|
|
[
|
|
'',
|
|
''
|
|
],
|
|
])('given %p', async (input: string, expected: string) => {
|
|
expect(Build.resolveAttestationAttrs(input)).toEqual(expected);
|
|
});
|
|
});
|
|
|
|
describe('hasGitAuthTokenSecret', () => {
|
|
// prettier-ignore
|
|
test.each([
|
|
[['A_SECRET=abcdef0123456789'], false],
|
|
[['GIT_AUTH_TOKEN=abcdefghijklmno=0123456789'], true],
|
|
])('given %p secret', async (kvp: Array<string>, expected: boolean) => {
|
|
expect(Build.hasGitAuthTokenSecret(kvp)).toBe(expected);
|
|
});
|
|
});
|
|
|
|
// See: https://github.com/actions/toolkit/blob/a1b068ec31a042ff1e10a522d8fdf0b8869d53ca/packages/core/src/core.ts#L89
|
|
function getInputName(name: string): string {
|
|
return `INPUT_${name.replace(/ /g, '_').toUpperCase()}`;
|
|
}
|
|
|
|
function setInput(name: string, value: string): void {
|
|
process.env[getInputName(name)] = value;
|
|
}
|