Merge pull request #43 from crazy-max/fix-standalone

fix buildx standalone and check for docker availability

__tests__/buildkit/buildkit.test.ts

@@ -15,7 +15,6 @@
  */
 
 import {beforeEach, describe, expect, it, jest, test} from '@jest/globals';
-import * as semver from 'semver';
 
 import {BuildKit} from '../../src/buildkit/buildkit';
 import {Builder} from '../../src/buildx/builder';
@@ -48,11 +47,15 @@ jest.spyOn(Builder.prototype, 'inspect').mockImplementation(async (): Promise<Bu
 
 describe('getVersion', () => {
   it('valid', async () => {
+    const builder = new Builder({
+      context: new Context()
+    });
+    const builderInfo = await builder.inspect('builder2');
     const buildkit = new BuildKit({
       context: new Context()
     });
-    const version = await buildkit.getVersion('builder2');
-    expect(semver.valid(version)).not.toBeNull();
+    const version = await buildkit.getVersion(builderInfo.nodes[0]);
+    expect(version).toBe('v0.11.0');
   });
 });
 

__tests__/buildx/buildx.test.ts

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

__tests__/docker.test.ts

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

src/buildkit/buildkit.ts

@@ -23,7 +23,7 @@ import {Buildx} from '../buildx/buildx';
 import {Builder} from '../buildx/builder';
 import {Config} from './config';
 
-import {BuilderInfo} from '../types/builder';
+import {BuilderInfo, NodeInfo} from '../types/builder';
 
 export interface BuildKitOpts {
   context: Context;
@@ -46,14 +46,7 @@ export class BuildKit {
       });
   }
 
-  public async getVersion(builderName: string): Promise<string | undefined> {
-    const builderInfo = await this.getBuilderInfo(builderName);
-    if (builderInfo.nodes.length == 0) {
-      // a builder always have on node, should not happen.
-      return undefined;
-    }
-    // TODO: get version for all nodes
-    const node = builderInfo.nodes[0];
+  public async getVersion(node: NodeInfo): Promise<string | undefined> {
     if (!node.buildkitVersion && node.name) {
       try {
         return await this.getVersionWithinImage(node.name);
@@ -65,6 +58,7 @@ export class BuildKit {
   }
 
   private async getVersionWithinImage(nodeName: string): Promise<string> {
+    core.debug(`BuildKit.getVersionWithinImage nodeName: ${nodeName}`);
     return exec
       .getExecOutput(`docker`, ['inspect', '--format', '{{.Config.Image}}', `${Buildx.containerNamePrefix}${nodeName}`], {
         ignoreReturnCode: true,
@@ -72,6 +66,7 @@ export class BuildKit {
       })
       .then(bkitimage => {
         if (bkitimage.exitCode == 0 && bkitimage.stdout.length > 0) {
+          core.debug(`BuildKit.getVersionWithinImage image: ${bkitimage.stdout.trim()}`);
           return exec
             .getExecOutput(`docker`, ['run', '--rm', bkitimage.stdout.trim(), '--version'], {
               ignoreReturnCode: true,
@@ -92,17 +87,25 @@ export class BuildKit {
       });
   }
 
-  public async versionSatisfies(builderName: string, range: string): Promise<boolean> {
-    const builderInfo = await this.getBuilderInfo(builderName);
+  public async versionSatisfies(builderName: string, range: string, builderInfo?: BuilderInfo): Promise<boolean> {
+    if (!builderInfo) {
+      builderInfo = await new Builder({
+        context: this.context,
+        buildx: this.buildx
+      }).inspect(builderName);
+    }
     for (const node of builderInfo.nodes) {
+      core.debug(`BuildKit.versionSatisfies ${node}: ${range}`);
       let bkversion = node.buildkitVersion;
       if (!bkversion) {
         try {
           bkversion = await this.getVersionWithinImage(node.name || '');
         } catch (e) {
+          core.debug(`BuildKit.versionSatisfies ${node}: can't get version`);
           return false;
         }
       }
+      core.debug(`BuildKit.versionSatisfies ${node}: version ${bkversion}`);
       // BuildKit version reported by moby is in the format of `v0.11.0-moby`
       if (builderInfo.driver == 'docker' && !bkversion.endsWith('-moby')) {
         return false;
@@ -113,12 +116,4 @@ export class BuildKit {
     }
     return true;
   }
-
-  private async getBuilderInfo(name: string): Promise<BuilderInfo> {
-    const builder = new Builder({
-      context: this.context,
-      buildx: this.buildx
-    });
-    return builder.inspect(name);
-  }
 }

src/buildx/builder.ts

@@ -40,7 +40,7 @@ export class Builder {
   }
 
   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
       .getExecOutput(cmd.command, cmd.args, {
         ignoreReturnCode: true,

src/buildx/buildx.ts

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

src/buildx/install.ts

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

src/docker.ts

@@ -20,36 +20,46 @@ import * as core from '@actions/core';
 import * as exec from '@actions/exec';
 
 export class Docker {
+  private static instance?: Docker;
+  static getInstance = (): Docker => (Docker.instance = Docker.instance ?? new Docker());
+
+  private _available: boolean | undefined;
+
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  private constructor() {}
+
   static get configDir(): string {
     return process.env.DOCKER_CONFIG || path.join(os.homedir(), '.docker');
   }
 
-  static get isAvailable(): boolean {
-    let dockerAvailable = false;
-    exec
-      .getExecOutput('docker', undefined, {
-        ignoreReturnCode: true,
-        silent: true
-      })
-      .then(res => {
-        if (res.stderr.length > 0 && res.exitCode != 0) {
-          core.debug(`Docker.isAvailable error: ${res.stderr}`);
-          dockerAvailable = false;
-        } else {
-          core.debug(`Docker.isAvailable ok`);
-          dockerAvailable = res.exitCode == 0;
-        }
-      })
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
-      .catch(error => {
-        core.debug(`Docker.isAvailable failed: ${error}`);
-        dockerAvailable = false;
-      });
-    return dockerAvailable;
+  public async isAvailable(): Promise<boolean> {
+    if (this._available === undefined) {
+      await exec
+        .getExecOutput('docker', undefined, {
+          ignoreReturnCode: true,
+          silent: true
+        })
+        .then(res => {
+          if (res.stderr.length > 0 && res.exitCode != 0) {
+            core.debug(`Docker.available error: ${res.stderr}`);
+            this._available = false;
+          } else {
+            core.debug(`Docker.available ok`);
+            this._available = res.exitCode == 0;
+          }
+        })
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        .catch(error => {
+          core.debug(`Docker.available failed: ${error}`);
+          this._available = false;
+        });
+    }
+    core.debug(`Docker.available: ${this._available}`);
+    return this._available ?? false;
   }
 
   public static async printVersion(standalone?: boolean): Promise<void> {
-    const noDocker = standalone ?? !Docker.isAvailable;
+    const noDocker = standalone ?? !(await Docker.getInstance().isAvailable());
     if (noDocker) {
       core.debug('Docker.printVersion: Docker is not available, skipping.');
       return;
@@ -60,7 +70,7 @@ export class Docker {
   }
 
   public static async printInfo(standalone?: boolean): Promise<void> {
-    const noDocker = standalone ?? !Docker.isAvailable;
+    const noDocker = standalone ?? !(await Docker.getInstance().isAvailable());
     if (noDocker) {
       core.debug('Docker.printInfo: Docker is not available, skipping.');
       return;

src/toolkit.ts

@@ -41,7 +41,7 @@ export class Toolkit {
     this.context = new Context();
     this.github = new GitHub({token: opts.githubToken});
     this.buildx = new Buildx({context: this.context});
-    this.buildxInstall = new Install({context: this.context, standalone: this.buildx.standalone});
+    this.buildxInstall = new Install({context: this.context});
     this.builder = new Builder({context: this.context, buildx: this.buildx});
     this.buildkit = new BuildKit({context: this.context, buildx: this.buildx});
   }