docker/actions-toolkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix buildx standalone and check for docker availability

Browse Source 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
This commit is contained in:
CrazyMax
2023-02-18 10:09:41 +01:00
parent 9b338b58a7
commit 252c717cc3
7 changed files with 80 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
__tests__/buildx/buildx.test.ts
View File

@@ -95,9 +95,7 @@ describe('isAvailable', () => {
context: new Context(), context: new Context(),
standalone: false standalone: false
}); });
buildx.isAvailable().catch(() => { await buildx.isAvailable();
// noop
});
// eslint-disable-next-line jest/no-standalone-expect // eslint-disable-next-line jest/no-standalone-expect
expect(execSpy).toHaveBeenCalledWith(`docker`, ['buildx'], { expect(execSpy).toHaveBeenCalledWith(`docker`, ['buildx'], {
silent: true, silent: true,
@@ -110,9 +108,7 @@ describe('isAvailable', () => {
context: new Context(), context: new Context(),
standalone: true standalone: true
}); });
buildx.isAvailable().catch(() => { await buildx.isAvailable();
// noop
});
// eslint-disable-next-line jest/no-standalone-expect // eslint-disable-next-line jest/no-standalone-expect
expect(execSpy).toHaveBeenCalledWith(`buildx`, [], { expect(execSpy).toHaveBeenCalledWith(`buildx`, [], {
silent: true, silent: true,
@@ -122,13 +118,13 @@ describe('isAvailable', () => {
}); });
describe('printInspect', () => { describe('printInspect', () => {
it('prints builder2 instance', () => { it('prints builder2 instance', async () => {
const execSpy = jest.spyOn(exec, 'exec'); const execSpy = jest.spyOn(exec, 'exec');
const buildx = new Buildx({ const buildx = new Buildx({
context: new Context(), context: new Context(),
standalone: true standalone: true
}); });
buildx.printInspect('builder2').catch(() => { await buildx.printInspect('builder2').catch(() => {
// noop // noop
}); });
expect(execSpy).toHaveBeenCalledWith(`buildx`, ['inspect', 'builder2'], { expect(execSpy).toHaveBeenCalledWith(`buildx`, ['inspect', 'builder2'], {
@@ -138,24 +134,24 @@ describe('printInspect', () => {
}); });
describe('printVersion', () => { describe('printVersion', () => {
it('docker cli', () => { it('docker cli', async () => {
const execSpy = jest.spyOn(exec, 'exec'); const execSpy = jest.spyOn(exec, 'exec');
const buildx = new Buildx({ const buildx = new Buildx({
context: new Context(), context: new Context(),
standalone: false standalone: false
}); });
buildx.printVersion(); await buildx.printVersion();
expect(execSpy).toHaveBeenCalledWith(`docker`, ['buildx', 'version'], { expect(execSpy).toHaveBeenCalledWith(`docker`, ['buildx', 'version'], {
failOnStdErr: false failOnStdErr: false
}); });
}); });
it('standalone', () => { it('standalone', async () => {
const execSpy = jest.spyOn(exec, 'exec'); const execSpy = jest.spyOn(exec, 'exec');
const buildx = new Buildx({ const buildx = new Buildx({
context: new Context(), context: new Context(),
standalone: true standalone: true
}); });
buildx.printVersion(); await buildx.printVersion();
expect(execSpy).toHaveBeenCalledWith(`buildx`, ['version'], { expect(execSpy).toHaveBeenCalledWith(`buildx`, ['version'], {
failOnStdErr: false failOnStdErr: false
}); });

2
__tests__/docker.test.ts
View File

@@ -50,7 +50,7 @@ describe('configDir', () => {
describe('isAvailable', () => { describe('isAvailable', () => {
it('cli', async () => { it('cli', async () => {
const execSpy = jest.spyOn(exec, 'getExecOutput'); const execSpy = jest.spyOn(exec, 'getExecOutput');
Docker.getInstance().available; await Docker.getInstance().isAvailable();
// eslint-disable-next-line jest/no-standalone-expect // eslint-disable-next-line jest/no-standalone-expect
expect(execSpy).toHaveBeenCalledWith(`docker`, undefined, { expect(execSpy).toHaveBeenCalledWith(`docker`, undefined, {
silent: true, silent: true,

5
src/buildkit/buildkit.ts
View File

@@ -58,6 +58,7 @@ export class BuildKit {
} }
private async getVersionWithinImage(nodeName: string): Promise<string> { private async getVersionWithinImage(nodeName: string): Promise<string> {
core.debug(`BuildKit.getVersionWithinImage nodeName: ${nodeName}`);
return exec return exec
.getExecOutput(`docker`, ['inspect', '--format', '{{.Config.Image}}', `${Buildx.containerNamePrefix}${nodeName}`], { .getExecOutput(`docker`, ['inspect', '--format', '{{.Config.Image}}', `${Buildx.containerNamePrefix}${nodeName}`], {
ignoreReturnCode: true, ignoreReturnCode: true,
@@ -65,6 +66,7 @@ export class BuildKit {
}) })
.then(bkitimage => { .then(bkitimage => {
if (bkitimage.exitCode == 0 && bkitimage.stdout.length > 0) { if (bkitimage.exitCode == 0 && bkitimage.stdout.length > 0) {
core.debug(`BuildKit.getVersionWithinImage image: ${bkitimage.stdout.trim()}`);
return exec return exec
.getExecOutput(`docker`, ['run', '--rm', bkitimage.stdout.trim(), '--version'], { .getExecOutput(`docker`, ['run', '--rm', bkitimage.stdout.trim(), '--version'], {
ignoreReturnCode: true, ignoreReturnCode: true,
@@ -93,14 +95,17 @@ export class BuildKit {
}).inspect(builderName); }).inspect(builderName);
} }
for (const node of builderInfo.nodes) { for (const node of builderInfo.nodes) {
core.debug(`BuildKit.versionSatisfies ${node}: ${range}`);
let bkversion = node.buildkitVersion; let bkversion = node.buildkitVersion;
if (!bkversion) { if (!bkversion) {
try { try {
bkversion = await this.getVersionWithinImage(node.name || ''); bkversion = await this.getVersionWithinImage(node.name || '');
} catch (e) { } catch (e) {
core.debug(`BuildKit.versionSatisfies ${node}: can't get version`);
return false; return false;
} }
} }
core.debug(`BuildKit.versionSatisfies ${node}: version ${bkversion}`);
// BuildKit version reported by moby is in the format of `v0.11.0-moby` // BuildKit version reported by moby is in the format of `v0.11.0-moby`
if (builderInfo.driver == 'docker' && !bkversion.endsWith('-moby')) { if (builderInfo.driver == 'docker' && !bkversion.endsWith('-moby')) {
return false; return false;

2
src/buildx/builder.ts
View File

@@ -40,7 +40,7 @@ export class Builder {
} }
public async inspect(name: string): Promise<BuilderInfo> { public async inspect(name: string): Promise<BuilderInfo> {
const cmd = this.buildx.getCommand(['inspect', name]); const cmd = await this.buildx.getCommand(['inspect', name]);
return await exec return await exec
.getExecOutput(cmd.command, cmd.args, { .getExecOutput(cmd.command, cmd.args, {
ignoreReturnCode: true, ignoreReturnCode: true,

28
src/buildx/buildx.ts
View File

@@ -32,16 +32,17 @@ export interface BuildxOpts {
} }
export class Buildx { export class Buildx {
private readonly context: Context;
private _version: string | undefined; private _version: string | undefined;
private readonly _standalone: boolean | undefined;
private readonly context: Context;
public readonly inputs: Inputs; public readonly inputs: Inputs;
public readonly standalone: boolean;
public static readonly containerNamePrefix = 'buildx_buildkit_'; public static readonly containerNamePrefix = 'buildx_buildkit_';
constructor(opts: BuildxOpts) { constructor(opts: BuildxOpts) {
this._standalone = opts?.standalone;
this.context = opts.context; this.context = opts.context;
this.standalone = opts?.standalone ?? !Docker.getInstance().available;
this.inputs = new Inputs(this.context); this.inputs = new Inputs(this.context);
} }
@@ -53,15 +54,22 @@ export class Buildx {
return path.join(Buildx.configDir, 'certs'); return path.join(Buildx.configDir, 'certs');
} }
public getCommand(args: Array<string>) { public async isStandalone(): Promise<boolean> {
const standalone = this._standalone ?? !(await Docker.getInstance().isAvailable());
core.debug(`Buildx.isStandalone: ${standalone}`);
return standalone;
}
public async getCommand(args: Array<string>) {
const standalone = await this.isStandalone();
return { return {
command: this.standalone ? 'buildx' : 'docker', command: standalone ? 'buildx' : 'docker',
args: this.standalone ? args : ['buildx', ...args] args: standalone ? args : ['buildx', ...args]
}; };
} }
public async isAvailable(): Promise<boolean> { public async isAvailable(): Promise<boolean> {
const cmd = this.getCommand([]); const cmd = await this.getCommand([]);
return await exec return await exec
.getExecOutput(cmd.command, cmd.args, { .getExecOutput(cmd.command, cmd.args, {
ignoreReturnCode: true, ignoreReturnCode: true,
@@ -80,7 +88,7 @@ export class Buildx {
} }
public async printInspect(name: string): Promise<void> { public async printInspect(name: string): Promise<void> {
const cmd = this.getCommand(['inspect', name]); const cmd = await this.getCommand(['inspect', name]);
await exec.exec(cmd.command, cmd.args, { await exec.exec(cmd.command, cmd.args, {
failOnStdErr: false failOnStdErr: false
}); });
@@ -89,7 +97,7 @@ export class Buildx {
get version() { get version() {
return (async () => { return (async () => {
if (!this._version) { if (!this._version) {
const cmd = this.getCommand(['version']); const cmd = await this.getCommand(['version']);
this._version = await exec this._version = await exec
.getExecOutput(cmd.command, cmd.args, { .getExecOutput(cmd.command, cmd.args, {
ignoreReturnCode: true, ignoreReturnCode: true,
@@ -107,7 +115,7 @@ export class Buildx {
} }
public async printVersion() { public async printVersion() {
const cmd = this.getCommand(['version']); const cmd = await this.getCommand(['version']);
await exec.exec(cmd.command, cmd.args, { await exec.exec(cmd.command, cmd.args, {
failOnStdErr: false failOnStdErr: false
}); });

29
src/buildx/install.ts
View File

@@ -37,17 +37,19 @@ export interface InstallOpts {
} }
export class Install { export class Install {
private readonly _standalone: boolean | undefined;
private readonly context: Context; private readonly context: Context;
private readonly standalone: boolean;
constructor(opts?: InstallOpts) { constructor(opts?: InstallOpts) {
this.context = opts?.context || new Context(); this.context = opts?.context || new Context();
this.standalone = opts?.standalone ?? !Docker.getInstance().available; this._standalone = opts?.standalone;
} }
public async download(version: string, dest?: string): Promise<string> { public async download(version: string, dest?: string): Promise<string> {
const release: GitHubRelease = await Install.getRelease(version); const release: GitHubRelease = await Install.getRelease(version);
const fversion = release.tag_name.replace(/^v+|v+$/g, ''); const fversion = release.tag_name.replace(/^v+|v+$/g, '');
core.debug(`Install.download version: ${fversion}`);
let toolPath: string; let toolPath: string;
toolPath = tc.find('buildx', fversion, this.platform()); toolPath = tc.find('buildx', fversion, this.platform());
@@ -58,9 +60,11 @@ export class Install {
} }
toolPath = await this.fetchBinary(fversion); toolPath = await this.fetchBinary(fversion);
} }
core.debug(`Install.download toolPath: ${toolPath}`);
dest = dest || (this.standalone ? this.context.tmpDir() : Docker.configDir); dest = dest || ((await this.isStandalone()) ? this.context.tmpDir() : Docker.configDir);
if (this.standalone) { core.debug(`Install.download dest: ${dest}`);
if (await this.isStandalone()) {
return this.setStandalone(toolPath, dest); return this.setStandalone(toolPath, dest);
} }
return this.setPlugin(toolPath, dest); return this.setPlugin(toolPath, dest);
@@ -100,7 +104,8 @@ export class Install {
} }
dest = dest || Docker.configDir; dest = dest || Docker.configDir;
if (this.standalone) { core.debug(`Install.build dest: ${dest}`);
if (await this.isStandalone()) {
return this.setStandalone(toolPath, dest); return this.setStandalone(toolPath, dest);
} }
return this.setPlugin(toolPath, dest); return this.setPlugin(toolPath, dest);
@@ -111,10 +116,10 @@ export class Install {
const buildxPluginFound = await new Buildx({context: this.context, standalone: false}).isAvailable(); const buildxPluginFound = await new Buildx({context: this.context, standalone: false}).isAvailable();
let buildStandalone = false; let buildStandalone = false;
if (this.standalone && buildxStandaloneFound) { if ((await this.isStandalone()) && buildxStandaloneFound) {
core.debug(`Install.buildCommand: Buildx standalone found, build with it`); core.debug(`Install.buildCommand: Buildx standalone found, build with it`);
buildStandalone = true; buildStandalone = true;
} else if (!this.standalone && buildxPluginFound) { } else if (!(await this.isStandalone()) && buildxPluginFound) {
core.debug(`Install.buildCommand: Buildx plugin found, build with it`); core.debug(`Install.buildCommand: Buildx plugin found, build with it`);
buildStandalone = false; buildStandalone = false;
} else if (buildxStandaloneFound) { } else if (buildxStandaloneFound) {
@@ -128,7 +133,7 @@ export class Install {
} }
//prettier-ignore //prettier-ignore
return new Buildx({context: this.context, standalone: buildStandalone}).getCommand([ return await new Buildx({context: this.context, standalone: buildStandalone}).getCommand([
'build', 'build',
'--target', 'binaries', '--target', 'binaries',
'--build-arg', 'BUILDKIT_CONTEXT_KEEP_GIT_DIR=1', '--build-arg', 'BUILDKIT_CONTEXT_KEEP_GIT_DIR=1',
@@ -137,6 +142,12 @@ export class Install {
]); ]);
} }
private async isStandalone(): Promise<boolean> {
const standalone = this._standalone ?? !(await Docker.getInstance().isAvailable());
core.debug(`Install.isStandalone: ${standalone}`);
return standalone;
}
private async setStandalone(toolPath: string, dest: string): Promise<string> { private async setStandalone(toolPath: string, dest: string): Promise<string> {
const toolBinPath = path.join(toolPath, os.platform() == 'win32' ? 'docker-buildx.exe' : 'docker-buildx'); const toolBinPath = path.join(toolPath, os.platform() == 'win32' ? 'docker-buildx.exe' : 'docker-buildx');
const binDir = path.join(dest, 'bin'); const binDir = path.join(dest, 'bin');
@@ -148,6 +159,7 @@ export class Install {
fs.copyFileSync(toolBinPath, buildxPath); fs.copyFileSync(toolBinPath, buildxPath);
fs.chmodSync(buildxPath, '0755'); fs.chmodSync(buildxPath, '0755');
core.addPath(binDir); core.addPath(binDir);
core.debug(`Install.setStandalone buildxPath: ${buildxPath}`);
return buildxPath; return buildxPath;
} }
@@ -161,6 +173,7 @@ export class Install {
const pluginPath: string = path.join(pluginsDir, filename); const pluginPath: string = path.join(pluginsDir, filename);
fs.copyFileSync(toolBinPath, pluginPath); fs.copyFileSync(toolBinPath, pluginPath);
fs.chmodSync(pluginPath, '0755'); fs.chmodSync(pluginPath, '0755');
core.debug(`Install.setPlugin pluginPath: ${pluginPath}`);
return pluginPath; return pluginPath;
} }

53
src/docker.ts
View File

@@ -32,35 +32,34 @@ export class Docker {
return process.env.DOCKER_CONFIG || path.join(os.homedir(), '.docker'); return process.env.DOCKER_CONFIG || path.join(os.homedir(), '.docker');
} }
get available() { public async isAvailable(): Promise<boolean> {
return (async () => { if (this._available === undefined) {
if (!this._available) { await exec
this._available = await exec .getExecOutput('docker', undefined, {
.getExecOutput('docker', undefined, { ignoreReturnCode: true,
ignoreReturnCode: true, silent: true
silent: true })
}) .then(res => {
.then(res => { if (res.stderr.length > 0 && res.exitCode != 0) {
if (res.stderr.length > 0 && res.exitCode != 0) { core.debug(`Docker.available error: ${res.stderr}`);
core.debug(`Docker.isAvailable error: ${res.stderr}`); this._available = false;
return false; } else {
} else { core.debug(`Docker.available ok`);
core.debug(`Docker.isAvailable ok`); this._available = res.exitCode == 0;
return res.exitCode == 0; }
} })
}) // eslint-disable-next-line @typescript-eslint/no-unused-vars
// eslint-disable-next-line @typescript-eslint/no-unused-vars .catch(error => {
.catch(error => { core.debug(`Docker.available failed: ${error}`);
core.debug(`Docker.isAvailable failed: ${error}`); this._available = false;
return false; });
}); }
} core.debug(`Docker.available: ${this._available}`);
return this._available; return this._available ?? false;
})();
} }
public static async printVersion(standalone?: boolean): Promise<void> { public static async printVersion(standalone?: boolean): Promise<void> {
const noDocker = standalone ?? !Docker.getInstance().available; const noDocker = standalone ?? !(await Docker.getInstance().isAvailable());
if (noDocker) { if (noDocker) {
core.debug('Docker.printVersion: Docker is not available, skipping.'); core.debug('Docker.printVersion: Docker is not available, skipping.');
return; return;
@@ -71,7 +70,7 @@ export class Docker {
} }
public static async printInfo(standalone?: boolean): Promise<void> { public static async printInfo(standalone?: boolean): Promise<void> {
const noDocker = standalone ?? !Docker.getInstance().available; const noDocker = standalone ?? !(await Docker.getInstance().isAvailable());
if (noDocker) { if (noDocker) {
core.debug('Docker.printInfo: Docker is not available, skipping.'); core.debug('Docker.printInfo: Docker is not available, skipping.');
return; return;