Merge pull request #46 from crazy-max/buildx-split-install

buildx: split install from download and build methods

__tests__/buildkit/config.test.ts

@@ -24,8 +24,8 @@ import {Context} from '../../src/context';
 
 const fixturesDir = path.join(__dirname, '..', 'fixtures');
 // prettier-ignore
-const tmpDir = path.join(process.env.TEMP || '/tmp', 'buildkit-config-jest').split(path.sep).join(path.posix.sep);
-const tmpName = path.join(tmpDir, '.tmpname-jest').split(path.sep).join(path.posix.sep);
+const tmpDir = path.join(process.env.TEMP || '/tmp', 'buildkit-config-jest');
+const tmpName = path.join(tmpDir, '.tmpname-jest');
 
 jest.spyOn(Context.prototype, 'tmpDir').mockImplementation((): string => {
   if (!fs.existsSync(tmpDir)) {
@@ -50,7 +50,7 @@ describe('resolve', () => {
     ['debug = true', false, 'debug = true', null],
     [`notfound.toml`, true, '', new Error('config file notfound.toml not found')],
     [
-      `${path.join(fixturesDir, 'buildkitd.toml').split(path.sep).join(path.posix.sep)}`,
+      `${path.join(fixturesDir, 'buildkitd.toml')}`,
       true,
       `debug = true
 [registry."docker.io"]

__tests__/buildx/buildx.test.ts

@@ -27,8 +27,8 @@ import {Context} from '../../src/context';
 import {Cert} from '../../src/types/buildx';
 
 // prettier-ignore
-const tmpDir = path.join(process.env.TEMP || '/tmp', 'buildx-jest').split(path.sep).join(path.posix.sep);
-const tmpName = path.join(tmpDir, '.tmpname-jest').split(path.sep).join(path.posix.sep);
+const tmpDir = path.join(process.env.TEMP || '/tmp', 'buildx-jest');
+const tmpName = path.join(tmpDir, '.tmpname-jest');
 
 jest.spyOn(Context.prototype, 'tmpDir').mockImplementation((): string => {
   if (!fs.existsSync(tmpDir)) {

__tests__/buildx/inputs.test.ts

@@ -25,8 +25,8 @@ import {Inputs} from '../../src/buildx/inputs';
 
 const fixturesDir = path.join(__dirname, '..', 'fixtures');
 // prettier-ignore
-const tmpDir = path.join(process.env.TEMP || '/tmp', 'buildx-inputs-jest').split(path.sep).join(path.posix.sep);
-const tmpName = path.join(tmpDir, '.tmpname-jest').split(path.sep).join(path.posix.sep);
+const tmpDir = path.join(process.env.TEMP || '/tmp', 'buildx-inputs-jest');
+const tmpName = path.join(tmpDir, '.tmpname-jest');
 const metadata = `{
   "containerimage.config.digest": "sha256:059b68a595b22564a1cbc167af369349fdc2ecc1f7bc092c2235cbf601a795fd",
   "containerimage.digest": "sha256:b09b9482c72371486bb2c1d2c2a2633ed1d0b8389e12c8d52b9e052725c0c83c"
@@ -175,7 +175,7 @@ describe('resolveBuildSecret', () => {
     ['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').split(path.sep).join(path.posix.sep)}`, true, 'foo', 'bar', null],
+    [`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) => {
     try {

__tests__/buildx/install.test.ts

@@ -23,7 +23,7 @@ import osm = require('os');
 import {Install} from '../../src/buildx/install';
 
 // prettier-ignore
-const tmpDir = path.join(process.env.TEMP || '/tmp', 'buildx-jest').split(path.sep).join(path.posix.sep);
+const tmpDir = path.join(process.env.TEMP || '/tmp', 'buildx-jest');
 
 beforeEach(() => {
   jest.clearAllMocks();
@@ -43,7 +43,14 @@ describe('download', () => {
   ])(
   'acquires %p of buildx (standalone: %p)', async (version, standalone) => {
       const install = new Install({standalone: standalone});
-      const buildxBin = await install.download(version, tmpDir);
+      const toolPath = await install.download(version);
+      expect(fs.existsSync(toolPath)).toBe(true);
+      let buildxBin: string;
+      if (standalone) {
+        buildxBin = await install.installStandalone(toolPath, tmpDir);
+      } else {
+        buildxBin = await install.installPlugin(toolPath, tmpDir);
+      }
       expect(fs.existsSync(buildxBin)).toBe(true);
     },
     100000
@@ -65,7 +72,7 @@ describe('download', () => {
       jest.spyOn(osm, 'platform').mockImplementation(() => os);
       jest.spyOn(osm, 'arch').mockImplementation(() => arch);
       const install = new Install();
-      const buildxBin = await install.download('latest', tmpDir);
+      const buildxBin = await install.download('latest');
       expect(fs.existsSync(buildxBin)).toBe(true);
     },
     100000
@@ -82,14 +89,18 @@ describe('build', () => {
   // eslint-disable-next-line jest/no-disabled-tests
   it.skip('builds refs/pull/648/head', async () => {
     const install = new Install();
-    const buildxBin = await install.build('https://github.com/docker/buildx.git#refs/pull/648/head', tmpDir);
+    const toolPath = await install.build('https://github.com/docker/buildx.git#refs/pull/648/head');
+    expect(fs.existsSync(toolPath)).toBe(true);
+    const buildxBin = await install.installStandalone(toolPath, tmpDir);
     expect(fs.existsSync(buildxBin)).toBe(true);
   }, 100000);
 
   // eslint-disable-next-line jest/no-disabled-tests
   it.skip('builds 67bd6f4dc82a9cd96f34133dab3f6f7af803bb14', async () => {
     const install = new Install();
-    const buildxBin = await install.build('https://github.com/docker/buildx.git#67bd6f4dc82a9cd96f34133dab3f6f7af803bb14', tmpDir);
+    const toolPath = await install.build('https://github.com/docker/buildx.git#67bd6f4dc82a9cd96f34133dab3f6f7af803bb14');
+    expect(fs.existsSync(toolPath)).toBe(true);
+    const buildxBin = await install.installPlugin(toolPath, tmpDir);
     expect(fs.existsSync(buildxBin)).toBe(true);
   }, 100000);
 });

__tests__/context.test.ts

@@ -22,8 +22,8 @@ import {describe, expect, jest, it, beforeEach, afterEach} from '@jest/globals';
 import {Context} from '../src/context';
 
 // prettier-ignore
-const tmpDir = path.join(process.env.TEMP || '/tmp', 'context-jest').split(path.sep).join(path.posix.sep);
-const tmpName = path.join(tmpDir, '.tmpname-jest').split(path.sep).join(path.posix.sep);
+const tmpDir = path.join(process.env.TEMP || '/tmp', 'context-jest');
+const tmpName = path.join(tmpDir, '.tmpname-jest');
 
 jest.spyOn(Context.prototype, 'tmpDir').mockImplementation((): string => {
   if (!fs.existsSync(tmpDir)) {

__tests__/docker.test.ts

@@ -50,7 +50,7 @@ describe('configDir', () => {
 describe('isAvailable', () => {
   it('cli', async () => {
     const execSpy = jest.spyOn(exec, 'getExecOutput');
-    await Docker.getInstance().isAvailable();
+    await Docker.isAvailable();
     // eslint-disable-next-line jest/no-standalone-expect
     expect(execSpy).toHaveBeenCalledWith(`docker`, undefined, {
       silent: true,
@@ -60,43 +60,21 @@ describe('isAvailable', () => {
 });
 
 describe('printVersion', () => {
-  it('docker cli', () => {
+  it('call docker version', async () => {
     const execSpy = jest.spyOn(exec, 'exec');
-    Docker.printVersion(false).catch(() => {
+    await Docker.printVersion().catch(() => {
       // noop
     });
-    expect(execSpy).toHaveBeenCalledWith(`docker`, ['version'], {
-      failOnStdErr: false
-    });
-  });
-  it('standalone', () => {
-    const execSpy = jest.spyOn(exec, 'exec');
-    Docker.printVersion(true).catch(() => {
-      // noop
-    });
-    expect(execSpy).not.toHaveBeenCalledWith(`docker`, ['version'], {
-      failOnStdErr: false
-    });
+    expect(execSpy).toHaveBeenCalledWith(`docker`, ['version']);
   });
 });
 
 describe('printInfo', () => {
-  it('docker cli', () => {
+  it('call docker info', async () => {
     const execSpy = jest.spyOn(exec, 'exec');
-    Docker.printInfo(false).catch(() => {
+    await Docker.printInfo().catch(() => {
       // noop
     });
-    expect(execSpy).toHaveBeenCalledWith(`docker`, ['info'], {
-      failOnStdErr: false
-    });
-  });
-  it('standalone', () => {
-    const execSpy = jest.spyOn(exec, 'exec');
-    Docker.printInfo(true).catch(() => {
-      // noop
-    });
-    expect(execSpy).not.toHaveBeenCalledWith(`docker`, ['info'], {
-      failOnStdErr: false
-    });
+    expect(execSpy).toHaveBeenCalledWith(`docker`, ['info']);
   });
 });

jest.config.ts

@@ -18,13 +18,13 @@ import fs from 'fs';
 import os from 'os';
 import path from 'path';
 
-const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'docker-actions-toolkit-')).split(path.sep).join(path.posix.sep);
+const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'docker-actions-toolkit-'));
 
 process.env = Object.assign({}, process.env, {
   TEMP: tmpDir,
   GITHUB_REPOSITORY: 'docker/actions-toolkit',
-  RUNNER_TEMP: path.join(tmpDir, 'runner-temp').split(path.sep).join(path.posix.sep),
-  RUNNER_TOOL_CACHE: path.join(tmpDir, 'runner-tool-cache').split(path.sep).join(path.posix.sep)
+  RUNNER_TEMP: path.join(tmpDir, 'runner-temp'),
+  RUNNER_TOOL_CACHE: path.join(tmpDir, 'runner-tool-cache')
 }) as {
   [key: string]: string;
 };

src/buildx/buildx.ts

@@ -55,7 +55,7 @@ export class Buildx {
   }
 
   public async isStandalone(): Promise<boolean> {
-    const standalone = this._standalone ?? !(await Docker.getInstance().isAvailable());
+    const standalone = this._standalone ?? !(await Docker.isAvailable());
     core.debug(`Buildx.isStandalone: ${standalone}`);
     return standalone;
   }
@@ -70,21 +70,26 @@ export class Buildx {
 
   public async isAvailable(): Promise<boolean> {
     const cmd = await this.getCommand([]);
-    return await exec
+
+    const ok: boolean = await exec
       .getExecOutput(cmd.command, cmd.args, {
         ignoreReturnCode: true,
         silent: true
       })
       .then(res => {
         if (res.stderr.length > 0 && res.exitCode != 0) {
+          core.debug(`Buildx.isAvailable cmd err: ${res.stderr}`);
           return false;
         }
         return res.exitCode == 0;
       })
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars
       .catch(error => {
+        core.debug(`Buildx.isAvailable error: ${error}`);
         return false;
       });
+
+    core.debug(`Buildx.isAvailable: ${ok}`);
+    return ok;
   }
 
   public async printInspect(name: string): Promise<void> {

src/buildx/inputs.ts

@@ -29,11 +29,11 @@ export class Inputs {
   }
 
   public getBuildImageIDFilePath(): string {
-    return path.join(this.context.tmpDir(), 'iidfile').split(path.sep).join(path.posix.sep);
+    return path.join(this.context.tmpDir(), 'iidfile');
   }
 
   public getBuildMetadataFilePath(): string {
-    return path.join(this.context.tmpDir(), 'metadata-file').split(path.sep).join(path.posix.sep);
+    return path.join(this.context.tmpDir(), 'metadata-file');
   }
 
   public resolveBuildImageID(): string | undefined {

src/buildx/install.ts

@@ -46,7 +46,7 @@ export class Install {
     this._standalone = opts?.standalone;
   }
 
-  public async download(version: string, dest?: string): Promise<string> {
+  public async download(version: 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}`);
@@ -62,15 +62,10 @@ export class Install {
     }
     core.debug(`Install.download toolPath: ${toolPath}`);
 
-    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);
+    return toolPath;
   }
 
-  public async build(gitContext: string, dest?: string): Promise<string> {
+  public async build(gitContext: string): Promise<string> {
     // eslint-disable-next-line prefer-const
     let [repo, ref] = gitContext.split('#');
     if (ref.length == 0) {
@@ -89,7 +84,7 @@ export class Install {
     let toolPath: string;
     toolPath = tc.find('buildx', vspec);
     if (!toolPath) {
-      const outputDir = path.join(this.context.tmpDir(), 'build-cache').split(path.sep).join(path.posix.sep);
+      const outputDir = path.join(this.context.tmpDir(), 'build-cache');
       const buildCmd = await this.buildCommand(gitContext, outputDir);
       toolPath = await exec
         .getExecOutput(buildCmd.command, buildCmd.args, {
@@ -103,12 +98,48 @@ export class Install {
         });
     }
 
-    dest = dest || Docker.configDir;
-    core.debug(`Install.build dest: ${dest}`);
-    if (await this.isStandalone()) {
-      return this.setStandalone(toolPath, dest);
+    return toolPath;
+  }
+
+  public async installStandalone(toolPath: string, dest?: string): Promise<string> {
+    core.info('Standalone mode');
+    dest = dest || this.context.tmpDir();
+    const toolBinPath = path.join(toolPath, os.platform() == 'win32' ? 'docker-buildx.exe' : 'docker-buildx');
+    const binDir = path.join(dest, 'bin');
+    if (!fs.existsSync(binDir)) {
+      fs.mkdirSync(binDir, {recursive: true});
     }
-    return this.setPlugin(toolPath, dest);
+    const filename: string = os.platform() == 'win32' ? 'buildx.exe' : 'buildx';
+    const buildxPath: string = path.join(binDir, filename);
+    fs.copyFileSync(toolBinPath, buildxPath);
+
+    core.info('Fixing perms');
+    fs.chmodSync(buildxPath, '0755');
+
+    core.addPath(binDir);
+    core.info('Added Buildx to PATH');
+
+    core.info(`Binary path: ${buildxPath}`);
+    return buildxPath;
+  }
+
+  public async installPlugin(toolPath: string, dest?: string): Promise<string> {
+    core.info('Docker plugin mode');
+    dest = dest || Docker.configDir;
+    const toolBinPath = path.join(toolPath, os.platform() == 'win32' ? 'docker-buildx.exe' : 'docker-buildx');
+    const pluginsDir: string = path.join(dest, 'cli-plugins');
+    if (!fs.existsSync(pluginsDir)) {
+      fs.mkdirSync(pluginsDir, {recursive: true});
+    }
+    const filename: string = os.platform() == 'win32' ? 'docker-buildx.exe' : 'docker-buildx';
+    const pluginPath: string = path.join(pluginsDir, filename);
+    fs.copyFileSync(toolBinPath, pluginPath);
+
+    core.info('Fixing perms');
+    fs.chmodSync(pluginPath, '0755');
+
+    core.info(`Plugin path: ${pluginPath}`);
+    return pluginPath;
   }
 
   private async buildCommand(gitContext: string, outputDir: string): Promise<{args: Array<string>; command: string}> {
@@ -143,46 +174,17 @@ export class Install {
   }
 
   private async isStandalone(): Promise<boolean> {
-    const standalone = this._standalone ?? !(await Docker.getInstance().isAvailable());
+    const standalone = this._standalone ?? !(await Docker.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');
-    if (!fs.existsSync(binDir)) {
-      fs.mkdirSync(binDir, {recursive: true});
-    }
-    const filename: string = os.platform() == 'win32' ? 'buildx.exe' : 'buildx';
-    const buildxPath: string = path.join(binDir, filename);
-    fs.copyFileSync(toolBinPath, buildxPath);
-    fs.chmodSync(buildxPath, '0755');
-    core.addPath(binDir);
-    core.debug(`Install.setStandalone buildxPath: ${buildxPath}`);
-    return buildxPath;
-  }
-
-  private async setPlugin(toolPath: string, dest: string): Promise<string> {
-    const toolBinPath = path.join(toolPath, os.platform() == 'win32' ? 'docker-buildx.exe' : 'docker-buildx');
-    const pluginsDir: string = path.join(dest, 'cli-plugins');
-    if (!fs.existsSync(pluginsDir)) {
-      fs.mkdirSync(pluginsDir, {recursive: true});
-    }
-    const filename: string = os.platform() == 'win32' ? 'docker-buildx.exe' : 'docker-buildx';
-    const pluginPath: string = path.join(pluginsDir, filename);
-    fs.copyFileSync(toolBinPath, pluginPath);
-    fs.chmodSync(pluginPath, '0755');
-    core.debug(`Install.setPlugin pluginPath: ${pluginPath}`);
-    return pluginPath;
-  }
-
   private async fetchBinary(version: string): Promise<string> {
     const targetFile: string = os.platform() == 'win32' ? 'docker-buildx.exe' : 'docker-buildx';
     const downloadURL = util.format('https://github.com/docker/buildx/releases/download/v%s/%s', version, this.filename(version));
+    core.info(`Downloading ${downloadURL}`);
     const downloadPath = await tc.downloadTool(downloadURL);
-    core.debug(`downloadURL: ${downloadURL}`);
-    core.debug(`downloadPath: ${downloadPath}`);
+    core.debug(`Install.fetchBinary downloadPath: ${downloadPath}`);
     return await tc.cacheFile(downloadPath, targetFile, 'buildx', version);
   }
 

src/context.ts

@@ -27,7 +27,7 @@ export class Context {
   public buildGitContext: string;
   public provenanceBuilderID: string;
 
-  private readonly _tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'docker-actions-toolkit-')).split(path.sep).join(path.posix.sep);
+  private readonly _tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'docker-actions-toolkit-'));
 
   constructor() {
     this.gitRef = github.context.ref;

src/docker.ts

@@ -20,63 +20,37 @@ 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');
   }
 
-  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 isAvailable(): Promise<boolean> {
+    const ok: boolean = await exec
+      .getExecOutput('docker', undefined, {
+        ignoreReturnCode: true,
+        silent: true
+      })
+      .then(res => {
+        if (res.stderr.length > 0 && res.exitCode != 0) {
+          core.debug(`Docker.isAvailable cmd err: ${res.stderr}`);
+          return false;
+        }
+        return res.exitCode == 0;
+      })
+      .catch(error => {
+        core.debug(`Docker.isAvailable error: ${error}`);
+        return false;
+      });
+
+    core.debug(`Docker.isAvailable: ${ok}`);
+    return ok;
   }
 
-  public static async printVersion(standalone?: boolean): Promise<void> {
-    const noDocker = standalone ?? !(await Docker.getInstance().isAvailable());
-    if (noDocker) {
-      core.debug('Docker.printVersion: Docker is not available, skipping.');
-      return;
-    }
-    await exec.exec('docker', ['version'], {
-      failOnStdErr: false
-    });
+  public static async printVersion(): Promise<void> {
+    await exec.exec('docker', ['version']);
   }
 
-  public static async printInfo(standalone?: boolean): Promise<void> {
-    const noDocker = standalone ?? !(await Docker.getInstance().isAvailable());
-    if (noDocker) {
-      core.debug('Docker.printInfo: Docker is not available, skipping.');
-      return;
-    }
-    await exec.exec('docker', ['info'], {
-      failOnStdErr: false
-    });
+  public static async printInfo(): Promise<void> {
+    await exec.exec('docker', ['info']);
   }
 }