Merge pull request #36 from crazy-max/update-input-list

util: opt to escape quotes for input list

__tests__/buildx/install.test.ts

@@ -14,31 +14,36 @@
  * limitations under the License.
  */
 
-import {describe, expect, it, jest, test, beforeEach} from '@jest/globals';
+import {describe, expect, it, jest, test, beforeEach, afterEach} from '@jest/globals';
 import * as fs from 'fs';
 import * as path from 'path';
+import * as rimraf from 'rimraf';
 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);
+
 beforeEach(() => {
   jest.clearAllMocks();
 });
 
-describe('install', () => {
-  // prettier-ignore
-  const tmpDir = path.join(process.env.TEMP || '/tmp', 'buildx-install-jest').split(path.sep).join(path.posix.sep);
+afterEach(function () {
+  rimraf.sync(tmpDir);
+});
 
+describe('download', () => {
   // prettier-ignore
   test.each([
-    ['v0.4.1', false],
+    ['v0.9.1', false],
     ['latest', false],
-    ['v0.4.1', true],
+    ['v0.9.1', true],
     ['latest', true]
   ])(
   'acquires %p of buildx (standalone: %p)', async (version, standalone) => {
       const install = new Install({standalone: standalone});
-      const buildxBin = await install.install(version, tmpDir);
+      const buildxBin = await install.download(version, tmpDir);
       expect(fs.existsSync(buildxBin)).toBe(true);
     },
     100000
@@ -60,7 +65,7 @@ describe('install', () => {
       jest.spyOn(osm, 'platform').mockImplementation(() => os);
       jest.spyOn(osm, 'arch').mockImplementation(() => arch);
       const install = new Install();
-      const buildxBin = await install.install('latest', tmpDir);
+      const buildxBin = await install.download('latest', tmpDir);
       expect(fs.existsSync(buildxBin)).toBe(true);
     },
     100000
@@ -73,6 +78,22 @@ describe('install', () => {
   });
 });
 
+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);
+    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);
+    expect(fs.existsSync(buildxBin)).toBe(true);
+  }, 100000);
+});
+
 describe('getRelease', () => {
   it('returns latest buildx GitHub release', async () => {
     const release = await Install.getRelease('latest');

__tests__/util.test.ts

@@ -69,16 +69,22 @@ describe('getInputList', () => {
 
   it('multiline and ignoring comma correctly', async () => {
     setInput('cache-from', 'user/app:cache\ntype=local,src=path/to/dir');
-    const res = Util.getInputList('cache-from', true);
+    const res = Util.getInputList('cache-from', {ignoreComma: true});
     expect(res).toEqual(['user/app:cache', 'type=local,src=path/to/dir']);
   });
 
   it('different new lines and ignoring comma correctly', async () => {
     setInput('cache-from', 'user/app:cache\r\ntype=local,src=path/to/dir');
-    const res = Util.getInputList('cache-from', true);
+    const res = Util.getInputList('cache-from', {ignoreComma: true});
     expect(res).toEqual(['user/app:cache', 'type=local,src=path/to/dir']);
   });
 
+  it('escape surrounding quotes', async () => {
+    setInput('platforms', 'linux/amd64\n"linux/arm64,linux/arm/v7"');
+    const res = Util.getInputList('platforms', {escapeQuotes: true});
+    expect(res).toEqual(['linux/amd64', 'linux/arm64', 'linux/arm/v7']);
+  });
+
   it('multiline values', async () => {
     setInput(
       'secrets',
@@ -88,7 +94,7 @@ bbbbbbb
 ccccccccc"
 FOO=bar`
     );
-    const res = Util.getInputList('secrets', true);
+    const res = Util.getInputList('secrets', {ignoreComma: true});
     expect(res).toEqual([
       'GIT_AUTH_TOKEN=abcdefgh,ijklmno=0123456789',
       `MYSECRET=aaaaaaaa
@@ -111,7 +117,7 @@ FOO=bar
 bbbb
 ccc"`
     );
-    const res = Util.getInputList('secrets', true);
+    const res = Util.getInputList('secrets', {ignoreComma: true});
     expect(res).toEqual([
       'GIT_AUTH_TOKEN=abcdefgh,ijklmno=0123456789',
       `MYSECRET=aaaaaaaa
@@ -134,7 +140,7 @@ bbbbbbb
 ccccccccc
 FOO=bar`
     );
-    const res = Util.getInputList('secrets', true);
+    const res = Util.getInputList('secrets', {ignoreComma: true});
     expect(res).toEqual(['GIT_AUTH_TOKEN=abcdefgh,ijklmno=0123456789', 'MYSECRET=aaaaaaaa', 'bbbbbbb', 'ccccccccc', 'FOO=bar']);
   });
 
@@ -145,7 +151,7 @@ FOO=bar`
       `"GPG_KEY=${pgp}"
 FOO=bar`
     );
-    const res = Util.getInputList('secrets', true);
+    const res = Util.getInputList('secrets', {ignoreComma: true});
     expect(res).toEqual([`GPG_KEY=${pgp}`, 'FOO=bar']);
   });
 
@@ -158,7 +164,7 @@ bbbb""bbb
 ccccccccc"
 FOO=bar`
     );
-    const res = Util.getInputList('secrets', true);
+    const res = Util.getInputList('secrets', {ignoreComma: true});
     expect(res).toEqual([
       'GIT_AUTH_TOKEN=abcdefgh,ijklmno=0123456789',
       `MYSECRET=aaaaaaaa

package.json

@@ -1,5 +1,6 @@
 {
   "name": "@docker/actions-toolkit",
+  "version": "0.0.0+unknown",
   "description": "Toolkit for Docker (GitHub) Actions",
   "scripts": {
     "build": "tsc",

src/buildx/buildx.ts

@@ -22,7 +22,6 @@ import * as semver from 'semver';
 import {Docker} from '../docker';
 import {Context} from '../context';
 import {Inputs} from './inputs';
-import {Install} from './install';
 
 import {Cert} from '../types/buildx';
 
@@ -36,13 +35,11 @@ export class Buildx {
   private _version: string | undefined;
 
   public readonly inputs: Inputs;
-  public readonly install: Install;
   public readonly standalone: boolean;
 
   constructor(opts: BuildxOpts) {
     this.context = opts.context;
     this.inputs = new Inputs(this.context);
-    this.install = new Install({standalone: opts.standalone});
     this.standalone = opts?.standalone ?? !Docker.isAvailable;
   }
 

src/buildx/install.ts

@@ -18,27 +18,37 @@ import fs from 'fs';
 import os from 'os';
 import path from 'path';
 import * as core from '@actions/core';
+import * as exec from '@actions/exec';
 import * as httpm from '@actions/http-client';
 import * as tc from '@actions/tool-cache';
 import * as semver from 'semver';
 import * as util from 'util';
 
+import {Buildx} from './buildx';
+import {Context} from '../context';
+import {Docker} from '../docker';
+import {Git} from '../git';
+
 import {GitHubRelease} from '../types/github';
 
 export interface InstallOpts {
+  context?: Context;
   standalone?: boolean;
 }
 
 export class Install {
-  private readonly opts: InstallOpts;
+  private readonly context: Context;
+  private readonly standalone: boolean;
 
   constructor(opts?: InstallOpts) {
-    this.opts = opts || {};
+    this.context = opts?.context || new Context();
+    this.standalone = opts?.standalone ?? !Docker.isAvailable;
   }
 
-  public async install(version: string, dest: string): Promise<string> {
+  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, '');
+
     let toolPath: string;
     toolPath = tc.find('buildx', fversion, this.platform());
     if (!toolPath) {
@@ -46,14 +56,87 @@ export class Install {
       if (!semver.valid(c)) {
         throw new Error(`Invalid Buildx version "${fversion}".`);
       }
-      toolPath = await this.download(fversion);
+      toolPath = await this.fetchBinary(fversion);
     }
-    if (this.opts.standalone) {
+
+    dest = dest || (this.standalone ? this.context.tmpDir() : Docker.configDir);
+    if (this.standalone) {
       return this.setStandalone(toolPath, dest);
     }
     return this.setPlugin(toolPath, dest);
   }
 
+  public async build(gitContext: string, dest?: string): Promise<string> {
+    // eslint-disable-next-line prefer-const
+    let [repo, ref] = gitContext.split('#');
+    if (ref.length == 0) {
+      ref = 'master';
+    }
+
+    let vspec: string;
+    // TODO: include full ref as fingerprint. Use commit sha as best-effort in the meantime.
+    if (ref.match(/^[0-9a-fA-F]{40}$/)) {
+      vspec = ref;
+    } else {
+      vspec = await Git.getRemoteSha(repo, ref);
+    }
+    core.debug(`Tool version spec ${vspec}`);
+
+    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 buildCmd = await this.buildCommand(gitContext, outputDir);
+      toolPath = await exec
+        .getExecOutput(buildCmd.command, buildCmd.args, {
+          ignoreReturnCode: true
+        })
+        .then(res => {
+          if (res.stderr.length > 0 && res.exitCode != 0) {
+            core.warning(res.stderr.trim());
+          }
+          return tc.cacheFile(`${outputDir}/buildx`, os.platform() == 'win32' ? 'docker-buildx.exe' : 'docker-buildx', 'buildx', vspec);
+        });
+    }
+
+    dest = dest || Docker.configDir;
+    if (this.standalone) {
+      return this.setStandalone(toolPath, dest);
+    }
+    return this.setPlugin(toolPath, dest);
+  }
+
+  private async buildCommand(gitContext: string, outputDir: string): Promise<{args: Array<string>; command: string}> {
+    const buildxStandaloneFound = await new Buildx({context: this.context, standalone: true}).isAvailable();
+    const buildxPluginFound = await new Buildx({context: this.context, standalone: false}).isAvailable();
+
+    let buildStandalone = false;
+    if (this.standalone && buildxStandaloneFound) {
+      core.debug(`Buildx standalone found, build with it`);
+      buildStandalone = true;
+    } else if (!this.standalone && buildxPluginFound) {
+      core.debug(`Buildx plugin found, build with it`);
+      buildStandalone = false;
+    } else if (buildxStandaloneFound) {
+      core.debug(`Buildx plugin not found, but standalone found so trying to build with it`);
+      buildStandalone = true;
+    } else if (buildxPluginFound) {
+      core.debug(`Buildx standalone not found, but plugin found so trying to build with it`);
+      buildStandalone = false;
+    } else {
+      throw new Error(`Neither buildx standalone or plugin have been found to build from ref ${gitContext}`);
+    }
+
+    //prettier-ignore
+    return new Buildx({context: this.context, standalone: buildStandalone}).getCommand([
+      'build',
+      '--target', 'binaries',
+      '--build-arg', 'BUILDKIT_CONTEXT_KEEP_GIT_DIR=1',
+      '--output', `type=local,dest=${outputDir}`,
+      gitContext
+    ]);
+  }
+
   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');
@@ -81,7 +164,7 @@ export class Install {
     return pluginPath;
   }
 
-  private async download(version: string): Promise<string> {
+  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));
     const downloadPath = await tc.downloadTool(downloadURL);

src/toolkit.ts

@@ -16,6 +16,7 @@
 
 import {Context} from './context';
 import {Buildx} from './buildx/buildx';
+import {Install} from './buildx/install';
 import {BuildKit} from './buildkit/buildkit';
 import {GitHub} from './github';
 
@@ -31,12 +32,14 @@ export class Toolkit {
   public context: Context;
   public github: GitHub;
   public buildx: Buildx;
+  public buildxInstall: Install;
   public buildkit: BuildKit;
 
   constructor(opts: ToolkitOpts = {}) {
     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.buildkit = new BuildKit({context: this.context, buildx: this.buildx});
   }
 }

src/types/builder.ts

@@ -30,3 +30,11 @@ export interface NodeInfo {
   buildkitVersion?: string;
   platforms?: string;
 }
+
+export interface Node {
+  name?: string;
+  endpoint?: string;
+  'driver-opts'?: Array<string>;
+  'buildkitd-flags'?: string;
+  platforms?: string;
+}

src/util.ts

@@ -17,8 +17,13 @@
 import * as core from '@actions/core';
 import {parse} from 'csv-parse/sync';
 
+export interface InputListOpts {
+  ignoreComma?: boolean;
+  escapeQuotes?: boolean;
+}
+
 export class Util {
-  public static getInputList(name: string, ignoreComma?: boolean): string[] {
+  public static getInputList(name: string, opts?: InputListOpts): string[] {
     const res: Array<string> = [];
 
     const items = core.getInput(name);
@@ -31,18 +36,22 @@ export class Util {
       relaxQuotes: true,
       comment: '#',
       relaxColumnCount: true,
-      skipEmptyLines: true
+      skipEmptyLines: true,
+      quote: opts?.escapeQuotes ?? `"`
     });
 
     for (const record of records as Array<string[]>) {
       if (record.length == 1) {
-        res.push(record[0]);
-        continue;
-      } else if (!ignoreComma) {
+        if (opts?.ignoreComma) {
+          res.push(record[0]);
+        } else {
+          res.push(...record[0].split(','));
+        }
+      } else if (!opts?.ignoreComma) {
         res.push(...record);
-        continue;
+      } else {
+        res.push(record.join(','));
       }
-      res.push(record.join(','));
     }
 
     return res.filter(item => item).map(pat => pat.trim());