598 lines
13 KiB
TypeScript
598 lines
13 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, describe, expect, it, vi, test} from 'vitest';
|
|
import fs from 'fs';
|
|
import os from 'os';
|
|
import path from 'path';
|
|
import * as rimraf from 'rimraf';
|
|
|
|
import {Bake} from '../../src/buildx/bake.js';
|
|
import {Context} from '../../src/context.js';
|
|
|
|
import {ExecOptions} from '@actions/exec';
|
|
import {BakeDefinition} from '../../src/types/buildx/bake.js';
|
|
import {BuildMetadata} from '../../src/types/buildx/build.js';
|
|
|
|
const fixturesDir = path.join(__dirname, '..', '.fixtures');
|
|
const tmpDir = fs.mkdtempSync(path.join(process.env.TEMP || os.tmpdir(), 'buildx-bake-'));
|
|
const tmpName = path.join(tmpDir, '.tmpname-vi');
|
|
const metadata = JSON.parse(fs.readFileSync(path.join(fixturesDir, 'metadata-bake.json'), 'utf-8'));
|
|
|
|
vi.spyOn(Context, 'tmpDir').mockImplementation((): string => {
|
|
fs.mkdirSync(tmpDir, {recursive: true});
|
|
return tmpDir;
|
|
});
|
|
|
|
vi.spyOn(Context, 'tmpName').mockImplementation((): string => {
|
|
return tmpName;
|
|
});
|
|
|
|
afterEach(() => {
|
|
rimraf.sync(tmpDir);
|
|
});
|
|
|
|
describe('resolveMetadata', () => {
|
|
it('matches', async () => {
|
|
const bake = new Bake();
|
|
fs.writeFileSync(bake.getMetadataFilePath(), JSON.stringify(metadata));
|
|
expect(bake.resolveMetadata()).toEqual(metadata as BuildMetadata);
|
|
});
|
|
});
|
|
|
|
describe('resolveRefs', () => {
|
|
it('matches', async () => {
|
|
const bake = new Bake();
|
|
fs.writeFileSync(bake.getMetadataFilePath(), JSON.stringify(metadata));
|
|
expect(bake.resolveRefs()).toEqual(['default/default/x3tig9yrbzg2bp0ahn840m9hs', 'default/default/f9i6og3j529lrezk83aw9k8fr', 'default/default/yfq4itxr5kgustkcmp8jr4b9m']);
|
|
});
|
|
});
|
|
|
|
describe('resolveWarnings', () => {
|
|
it('matches', async () => {
|
|
const bake = new Bake();
|
|
fs.writeFileSync(bake.getMetadataFilePath(), JSON.stringify(metadata));
|
|
const warnings = bake.resolveWarnings();
|
|
expect(warnings).toBeDefined();
|
|
expect(warnings?.length).toEqual(13);
|
|
});
|
|
});
|
|
|
|
describe('getDefinition', () => {
|
|
// prettier-ignore
|
|
test.each([
|
|
[
|
|
[path.join(fixturesDir, 'bake-01.hcl')],
|
|
['validate'],
|
|
[],
|
|
{silent: true},
|
|
path.join(fixturesDir, 'bake-01-validate.json')
|
|
],
|
|
[
|
|
[path.join(fixturesDir, 'bake-02.hcl')],
|
|
['build'],
|
|
[],
|
|
undefined,
|
|
path.join(fixturesDir, 'bake-02-build.json')
|
|
],
|
|
[
|
|
[path.join(fixturesDir, 'bake-01.hcl')],
|
|
['image'],
|
|
['*.output=type=docker', '*.platform=linux/amd64'],
|
|
undefined,
|
|
path.join(fixturesDir, 'bake-01-overrides.json')
|
|
],
|
|
[
|
|
[path.join(fixturesDir, 'bake-03.hcl')],
|
|
[],
|
|
[],
|
|
undefined,
|
|
path.join(fixturesDir, 'bake-03-default.json')
|
|
],
|
|
])('given %o', async (files: string[], targets: string[], overrides: string[], execOptions: ExecOptions | undefined, out: string) => {
|
|
const bake = new Bake();
|
|
const expectedDef = <BakeDefinition>JSON.parse(fs.readFileSync(out, {encoding: 'utf-8'}).trim())
|
|
expect(await bake.getDefinition({
|
|
files: files,
|
|
targets: targets,
|
|
overrides: overrides
|
|
}, execOptions)).toEqual(expectedDef);
|
|
}, 30 * 60 * 1000);
|
|
});
|
|
|
|
describe('hasLocalExporter', () => {
|
|
// prettier-ignore
|
|
test.each([
|
|
[
|
|
{
|
|
"target": {
|
|
"build": {
|
|
"output": [
|
|
{
|
|
"type": "docker"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
false
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"build": {
|
|
"target": "build"
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
false
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"local": {
|
|
"output": [
|
|
{
|
|
"type": "local",
|
|
"dest": "./release-out"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
true
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"tar": {
|
|
"output": [
|
|
{
|
|
"type": "tar",
|
|
"dest": "/tmp/image.tar"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
false
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"local": {
|
|
"output": [
|
|
{
|
|
"type": "local",
|
|
"dest": "."
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
true
|
|
]
|
|
])('given %o returns %o', async (def: BakeDefinition, expected: boolean) => {
|
|
expect(Bake.hasLocalExporter(def)).toEqual(expected);
|
|
});
|
|
});
|
|
|
|
describe('hasTarExporter', () => {
|
|
// prettier-ignore
|
|
test.each([
|
|
[
|
|
{
|
|
"target": {
|
|
"reg": {
|
|
"output": [
|
|
{
|
|
"type": "registry",
|
|
"ref": "user/app"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
false
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"build": {
|
|
"output": [
|
|
{
|
|
"type": "docker"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
false
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"local": {
|
|
"output": [
|
|
{
|
|
"type": "local",
|
|
"dest": "./release-out"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
false
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"tar": {
|
|
"output": [
|
|
{
|
|
"type": "tar",
|
|
"dest": "/tmp/image.tar"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
true
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"multi": {
|
|
"output": [
|
|
{
|
|
"type": "docker"
|
|
},
|
|
{
|
|
"type": "tar",
|
|
"dest": "/tmp/image.tar"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
true
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"local": {
|
|
"output": [
|
|
{
|
|
"type": "local",
|
|
"dest": "."
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
false
|
|
],
|
|
])('given %o returns %o', async (def: BakeDefinition, expected: boolean) => {
|
|
expect(Bake.hasTarExporter(def)).toEqual(expected);
|
|
});
|
|
});
|
|
|
|
describe('hasDockerExporter', () => {
|
|
// prettier-ignore
|
|
test.each([
|
|
[
|
|
{
|
|
"target": {
|
|
"reg": {
|
|
"output": [
|
|
{
|
|
"type": "registry",
|
|
"ref": "user/app"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
false,
|
|
undefined
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"build": {
|
|
"output": [
|
|
{
|
|
"type": "docker"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
true,
|
|
undefined
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"multi": {
|
|
"output": [
|
|
{
|
|
"type": "docker"
|
|
},
|
|
{
|
|
"type": "tar",
|
|
"dest": "/tmp/image.tar"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
true,
|
|
undefined
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"local": {
|
|
"output": [
|
|
{
|
|
"type": "local",
|
|
"dest": "./release-out"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
false,
|
|
undefined
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"tar": {
|
|
"output": [
|
|
{
|
|
"type": "tar",
|
|
"dest": "/tmp/image.tar"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
false,
|
|
undefined
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"multi": {
|
|
"output": [
|
|
{
|
|
"type": "docker"
|
|
},
|
|
{
|
|
"type": "tar",
|
|
"dest": "/tmp/image.tar"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
true,
|
|
undefined
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"build": {
|
|
"output": [
|
|
{
|
|
"type": "docker"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
true,
|
|
false
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"build": {
|
|
"output": [
|
|
{
|
|
"type": "docker"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
true,
|
|
true
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"build": {
|
|
"output": [
|
|
{
|
|
"type": "local",
|
|
"dest": "."
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
true,
|
|
true
|
|
],
|
|
])('given %o and load: %o returns %o', async (def: BakeDefinition, expected: boolean, load: boolean | undefined) => {
|
|
expect(Bake.hasDockerExporter(def, load)).toEqual(expected);
|
|
});
|
|
});
|
|
|
|
describe('hasGitAuthTokenSecret', () => {
|
|
// prettier-ignore
|
|
test.each([
|
|
[
|
|
{
|
|
"target": {
|
|
"reg": {
|
|
"secret": [
|
|
{
|
|
"id": "A_SECRET",
|
|
"env": "A_SECRET"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
false
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"reg": {
|
|
"secret": [
|
|
{
|
|
"id": "A_SECRET",
|
|
"env": "A_SECRET"
|
|
},
|
|
{
|
|
"id": "GIT_AUTH_TOKEN"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
true
|
|
],
|
|
])('given %o returns %o', async (def: BakeDefinition, expected: boolean) => {
|
|
expect(Bake.hasGitAuthTokenSecret(def)).toEqual(expected);
|
|
});
|
|
});
|
|
|
|
describe('hasProvenanceAttestation', () => {
|
|
// prettier-ignore
|
|
test.each([
|
|
[
|
|
{
|
|
"target": {
|
|
"build": {
|
|
"attest": [
|
|
{
|
|
"type": "provenance",
|
|
"mode": "max"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
true
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"build": {
|
|
"attest": [
|
|
{
|
|
"type": "sbom"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
false
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"build": {
|
|
"attest": [
|
|
{
|
|
"type": "sbom"
|
|
},
|
|
{
|
|
"type": "provenance",
|
|
"mode": "max"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
true
|
|
]
|
|
])('given %o returns %o', async (def: BakeDefinition, expected: boolean) => {
|
|
expect(Bake.hasProvenanceAttestation(def)).toEqual(expected);
|
|
});
|
|
});
|
|
|
|
describe('hasSBOMAttestation', () => {
|
|
// prettier-ignore
|
|
test.each([
|
|
[
|
|
{
|
|
"target": {
|
|
"build": {
|
|
"attest": [
|
|
{
|
|
"type": "provenance",
|
|
"mode": "max"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
false
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"build": {
|
|
"attest": [
|
|
{
|
|
"type": "sbom"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
true
|
|
],
|
|
[
|
|
{
|
|
"target": {
|
|
"build": {
|
|
"attest": [
|
|
{
|
|
"type": "sbom"
|
|
},
|
|
{
|
|
"type": "provenance",
|
|
"mode": "max"
|
|
}
|
|
]
|
|
},
|
|
}
|
|
} as unknown as BakeDefinition,
|
|
true
|
|
]
|
|
])('given %o returns %o', async (def: BakeDefinition, expected: boolean) => {
|
|
expect(Bake.hasSBOMAttestation(def)).toEqual(expected);
|
|
});
|
|
});
|