Merge pull request #38 from crazy-max/dev-deps

Update dev deps

.github/workflows/ci.yml

@@ -43,7 +43,6 @@ jobs:
           driver-opts: network=host
       -
         name: Build and push
-        id: docker_build
         uses: ./
         with:
           builder: ${{ steps.buildx.outputs.name }}
@@ -56,3 +55,54 @@ jobs:
         name: Dump context
         if: always()
         uses: crazy-max/ghaction-dump-context@v1
+
+  error-msg:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Build
+        continue-on-error: true
+        uses: ./
+        with:
+          files: |
+            ./test/config.hcl
+          set: |
+            *.platform=linux/amd64,linux/ppc64le,linux/s390x
+      -
+        name: Dump context
+        if: always()
+        uses: crazy-max/ghaction-dump-context@v1
+
+  error-check:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v2
+      -
+        name: Stop docker
+        run: |
+          sudo systemctl stop docker
+      -
+        name: Build
+        id: bake
+        continue-on-error: true
+        uses: ./
+        with:
+          files: |
+            ./test/config.hcl
+      -
+        name: Check
+        run: |
+          echo "${{ toJson(steps.bake) }}"
+          if [ "${{ steps.bake.outcome }}" != "failure" ] || [ "${{ steps.bake.conclusion }}" != "success" ]; then
+            echo "::error::Should have failed"
+            exit 1
+          fi
+      -
+        name: Dump context
+        if: always()
+        uses: crazy-max/ghaction-dump-context@v1

.prettierrc.json

@@ -1,5 +1,5 @@
 {
-  "printWidth": 120,
+  "printWidth": 240,
   "tabWidth": 2,
   "useTabs": false,
   "semi": true,

README.md

@@ -11,7 +11,10 @@ of  this action in your workflow (i.e `docker/bake-action@v1.1.3`).
 
 ## About
 
-GitHub Action to use Docker [Buildx Bake](https://github.com/docker/buildx#buildx-bake-options-target) as a high-level build command.
+GitHub Action to use Docker [Buildx Bake](https://github.com/docker/buildx/blob/master/docs/reference/buildx_bake.md)
+as a high-level build command.
+
+![Screenshot](.github/bake-action.png)
 
 ___
 
@@ -19,18 +22,16 @@ ___
 * [Customizing](#customizing)
   * [inputs](#inputs)
 * [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot)
-* [Limitation](#limitation)
 
 ## Usage
 
 ```yaml
 name: ci
+
 on:
-  pull_request:
-    branches: master
   push:
-    branches: master
-    tags:
+    branches:
+      - 'master'
 
 jobs:
   bake:
@@ -39,9 +40,6 @@ jobs:
       -
         name: Checkout
         uses: actions/checkout@v2
-      -
-        name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
       -
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v1
@@ -55,10 +53,6 @@ jobs:
         name: Build and push
         uses: docker/bake-action@master
         with:
-          files: |
-            ./config.hcl
-          targets: |
-            release
           push: true
 ```
 
@@ -86,13 +80,13 @@ Following inputs can be used as `step.with` keys
 | Name             | Type     | Description                        |
 |------------------|----------|------------------------------------|
 | `builder`        | String   | Builder instance (see [setup-buildx](https://github.com/docker/setup-buildx-action) action) |
-| `files`          | List/CSV | List of [bake definition files](https://github.com/docker/buildx#file-definition) |
+| `files`          | List/CSV | List of [bake definition files](https://github.com/docker/buildx/blob/master/docs/reference/buildx_bake.md#file) |
 | `targets`        | List/CSV | List of bake targets |
 | `no-cache`       | Bool     | Do not use cache when building the image (default `false`) |
 | `pull`           | Bool     | Always attempt to pull a newer version of the image (default `false`) |
 | `load`           | Bool     | Load is a shorthand for `--set=*.output=type=docker` (default `false`) |
 | `push`           | Bool     | Push is a shorthand for `--set=*.output=type=registry` (default `false`) |
-| `set`            | List     | List of [targets values to override](https://github.com/docker/buildx#--set-targetpatternkeysubkeyvalue) (eg: `targetpattern.key=value`) |
+| `set`            | List     | List of [targets values to override](https://github.com/docker/buildx/blob/master/docs/reference/buildx_bake.md#set) (eg: `targetpattern.key=value`) |
 
 ## Keep up-to-date with GitHub Dependabot
 
@@ -109,7 +103,3 @@ updates:
     schedule:
       interval: "daily"
 ```
-
-## Limitation
-
-This action is only available for Linux [virtual environments](https://help.github.com/en/articles/virtual-environments-for-github-actions#supported-virtual-environments-and-hardware-resources).

__tests__/buildx.test.ts

@@ -2,9 +2,26 @@ import * as semver from 'semver';
 import * as buildx from '../src/buildx';
 import * as exec from '@actions/exec';
 
+describe('isAvailable', () => {
+  const execSpy: jest.SpyInstance = jest.spyOn(exec, 'getExecOutput');
+  execSpy.mockImplementation(() =>
+    Promise.resolve({
+      exitCode: expect.any(Number),
+      stdout: expect.any(Function),
+      stderr: expect.any(Function)
+    })
+  );
+
+  buildx.isAvailable();
+
+  expect(execSpy).toHaveBeenCalledWith(`docker`, ['buildx'], {
+    silent: true,
+    ignoreReturnCode: true
+  });
+});
+
 describe('getVersion', () => {
   it('valid', async () => {
-    await exec.exec('docker', ['buildx', 'version']);
     const version = await buildx.getVersion();
     console.log(`version: ${version}`);
     expect(semver.valid(version)).not.toBeNull();
@@ -15,8 +32,9 @@ describe('parseVersion', () => {
   test.each([
     ['github.com/docker/buildx 0.4.1+azure bda4882a65349ca359216b135896bddc1d92461c', '0.4.1'],
     ['github.com/docker/buildx v0.4.1 bda4882a65349ca359216b135896bddc1d92461c', '0.4.1'],
-    ['github.com/docker/buildx v0.4.2 fb7b670b764764dc4716df3eba07ffdae4cc47b2', '0.4.2']
+    ['github.com/docker/buildx v0.4.2 fb7b670b764764dc4716df3eba07ffdae4cc47b2', '0.4.2'],
+    ['github.com/docker/buildx f117971 f11797113e5a9b86bd976329c5dbb8a8bfdfadfa', 'f117971']
   ])('given %p', async (stdout, expected) => {
-    expect(await buildx.parseVersion(stdout)).toEqual(expected);
+    expect(buildx.parseVersion(stdout)).toEqual(expected);
   });
 });

__tests__/context.test.ts

@@ -1,3 +1,4 @@
+import * as os from 'os';
 import * as context from '../src/context';
 
 describe('getInputList', () => {
@@ -123,13 +124,7 @@ FOO=bar`
     );
     const res = await context.getInputList('secrets', true);
     console.log(res);
-    expect(res).toEqual([
-      'GIT_AUTH_TOKEN=abcdefgh,ijklmno=0123456789',
-      'MYSECRET=aaaaaaaa',
-      'bbbbbbb',
-      'ccccccccc',
-      'FOO=bar'
-    ]);
+    expect(res).toEqual(['GIT_AUTH_TOKEN=abcdefgh,ijklmno=0123456789', 'MYSECRET=aaaaaaaa', 'bbbbbbb', 'ccccccccc', 'FOO=bar']);
   });
 
   it('multiline values escape quotes', async () => {
@@ -166,7 +161,28 @@ describe('asyncForEach', () => {
   });
 });
 
-// See: https://github.com/actions/toolkit/blob/master/packages/core/src/core.ts#L67
+describe('setOutput', () => {
+  beforeEach(() => {
+    process.stdout.write = jest.fn();
+  });
+
+  it('setOutput produces the correct command', () => {
+    context.setOutput('some output', 'some value');
+    assertWriteCalls([`::set-output name=some output::some value${os.EOL}`]);
+  });
+
+  it('setOutput handles bools', () => {
+    context.setOutput('some output', false);
+    assertWriteCalls([`::set-output name=some output::false${os.EOL}`]);
+  });
+
+  it('setOutput handles numbers', () => {
+    context.setOutput('some output', 1.01);
+    assertWriteCalls([`::set-output name=some output::1.01${os.EOL}`]);
+  });
+});
+
+// See: https://github.com/actions/toolkit/blob/a1b068ec31a042ff1e10a522d8fdf0b8869d53ca/packages/core/src/core.ts#L89
 function getInputName(name: string): string {
   return `INPUT_${name.replace(/ /g, '_').toUpperCase()}`;
 }
@@ -174,3 +190,11 @@ function getInputName(name: string): string {
 function setInput(name: string, value: string): void {
   process.env[getInputName(name)] = value;
 }
+
+// Assert that process.stdout.write calls called only with the given arguments.
+function assertWriteCalls(calls: string[]): void {
+  expect(process.stdout.write).toHaveBeenCalledTimes(calls.length);
+  for (let i = 0; i < calls.length; i++) {
+    expect(process.stdout.write).toHaveBeenNthCalledWith(i + 1, calls[i]);
+  }
+}

codecov.yml

@@ -0,0 +1,3 @@
+comment: false
+github_checks:
+  annotations: false

jest.config.js

@@ -1,5 +1,6 @@
 module.exports = {
   clearMocks: true,
+  restoreMocks: true,
   moduleFileExtensions: ['js', 'ts'],
   setupFiles: ["dotenv/config"],
   testEnvironment: 'node',

package.json

@@ -28,23 +28,23 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
-    "@actions/core": "^1.2.6",
-    "@actions/exec": "^1.0.4",
-    "csv-parse": "^4.15.3",
+    "@actions/core": "^1.4.0",
+    "@actions/exec": "^1.1.0",
+    "csv-parse": "^4.16.0",
     "semver": "^7.3.5"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.3",
-    "@types/node": "^14.0.14",
+    "@types/jest": "^26.0.23",
+    "@types/node": "^14.17.4",
     "@types/tmp": "^0.2.0",
-    "@vercel/ncc": "^0.23.0",
-    "dotenv": "^8.2.0",
-    "jest": "^26.1.0",
-    "jest-circus": "^26.1.0",
-    "jest-runtime": "^26.1.0",
-    "prettier": "^2.0.5",
-    "ts-jest": "^26.1.1",
-    "typescript": "^3.9.5",
+    "@vercel/ncc": "^0.28.6",
+    "dotenv": "^8.6.0",
+    "jest": "^26.6.3",
+    "jest-circus": "^26.6.3",
+    "jest-runtime": "^26.6.3",
+    "prettier": "^2.3.2",
+    "ts-jest": "^26.5.6",
+    "typescript": "^4.3.4",
     "typescript-formatter": "^7.2.2"
   }
 }

src/buildx.ts

@@ -1,28 +1,38 @@
 import * as semver from 'semver';
-import * as exec from './exec';
+import * as exec from '@actions/exec';
 
 export async function isAvailable(): Promise<Boolean> {
-  return await exec.exec(`docker`, ['buildx'], true).then(res => {
-    if (res.stderr != '' && !res.success) {
-      return false;
-    }
-    return res.success;
-  });
+  return await exec
+    .getExecOutput('docker', ['buildx'], {
+      ignoreReturnCode: true,
+      silent: true
+    })
+    .then(res => {
+      if (res.stderr.length > 0 && res.exitCode != 0) {
+        return false;
+      }
+      return res.exitCode == 0;
+    });
 }
 
 export async function getVersion(): Promise<string> {
-  return await exec.exec(`docker`, ['buildx', 'version'], true).then(res => {
-    if (res.stderr != '' && !res.success) {
-      throw new Error(res.stderr);
-    }
-    return parseVersion(res.stdout);
-  });
+  return await exec
+    .getExecOutput('docker', ['buildx', 'version'], {
+      ignoreReturnCode: true,
+      silent: true
+    })
+    .then(res => {
+      if (res.stderr.length > 0 && res.exitCode != 0) {
+        throw new Error(res.stderr);
+      }
+      return parseVersion(res.stdout);
+    });
 }
 
-export async function parseVersion(stdout: string): Promise<string> {
-  const matches = /\sv?([0-9.]+)/.exec(stdout);
+export function parseVersion(stdout: string): string {
+  const matches = /\sv?([0-9a-f]{7}|[0-9.]+)/.exec(stdout);
   if (!matches) {
-    throw new Error(`Cannot parse Buildx version`);
+    throw new Error(`Cannot parse buildx version`);
   }
-  return semver.clean(matches[1]);
+  return matches[1];
 }

src/context.ts

@@ -1,6 +1,7 @@
 import csvparse from 'csv-parse/lib/sync';
 import * as buildx from './buildx';
 import * as core from '@actions/core';
+import {issueCommand} from '@actions/core/lib/command';
 
 export interface Inputs {
   builder: string;
@@ -18,10 +19,10 @@ export async function getInputs(): Promise<Inputs> {
     builder: core.getInput('builder'),
     files: getInputList('files'),
     targets: getInputList('targets'),
-    noCache: /true/i.test(core.getInput('no-cache')),
-    pull: /true/i.test(core.getInput('pull')),
-    load: /true/i.test(core.getInput('load')),
-    push: /true/i.test(core.getInput('push')),
+    noCache: core.getBooleanInput('no-cache'),
+    pull: core.getBooleanInput('pull'),
+    load: core.getBooleanInput('load'),
+    push: core.getBooleanInput('push'),
     set: getInputList('set', true)
   };
 }
@@ -96,3 +97,8 @@ export const asyncForEach = async (array, callback) => {
     await callback(array[index], index, array);
   }
 };
+
+// FIXME: Temp fix https://github.com/actions/toolkit/issues/777
+export function setOutput(name: string, value: any): void {
+  issueCommand('set-output', {name}, value);
+}

src/exec.ts

@@ -1,34 +0,0 @@
-import * as aexec from '@actions/exec';
-import {ExecOptions} from '@actions/exec';
-
-export interface ExecResult {
-  success: boolean;
-  stdout: string;
-  stderr: string;
-}
-
-export const exec = async (command: string, args: string[] = [], silent: boolean): Promise<ExecResult> => {
-  let stdout: string = '';
-  let stderr: string = '';
-
-  const options: ExecOptions = {
-    silent: silent,
-    ignoreReturnCode: true
-  };
-  options.listeners = {
-    stdout: (data: Buffer) => {
-      stdout += data.toString();
-    },
-    stderr: (data: Buffer) => {
-      stderr += data.toString();
-    }
-  };
-
-  const returnCode: number = await aexec.exec(command, args, options);
-
-  return {
-    success: returnCode === 0,
-    stdout: stdout.trim(),
-    stderr: stderr.trim()
-  };
-};

src/main.ts

@@ -1,4 +1,3 @@
-import * as os from 'os';
 import * as buildx from './buildx';
 import * as context from './context';
 import * as core from '@actions/core';
@@ -6,28 +5,33 @@ import * as exec from '@actions/exec';
 
 async function run(): Promise<void> {
   try {
-    if (os.platform() !== 'linux') {
-      core.setFailed('Only supported on linux platform');
-      return;
-    }
+    core.startGroup(`Docker info`);
+    await exec.exec('docker', ['version']);
+    await exec.exec('docker', ['info']);
+    core.endGroup();
 
     if (!(await buildx.isAvailable())) {
-      core.setFailed(`Buildx is required. See https://github.com/docker/setup-buildx-action to set up buildx.`);
+      core.setFailed(`Docker buildx is required. See https://github.com/docker/setup-buildx-action to set up buildx.`);
       return;
     }
 
-    const buildxVersion = await buildx.getVersion();
-    core.info(`📣 Buildx version: ${buildxVersion}`);
+    const bxVersion = await buildx.getVersion();
+    const inputs: context.Inputs = await context.getInputs();
+    const args: string[] = await context.getArgs(inputs, bxVersion);
 
-    let inputs: context.Inputs = await context.getInputs();
-    const args: string[] = await context.getArgs(inputs, buildxVersion);
-
-    core.startGroup(`💡 Bake definition`);
+    core.startGroup(`Bake definition`);
     await exec.exec('docker', [...args, '--print']);
     core.endGroup();
 
-    core.info(`🏃 Building...`);
-    await exec.exec('docker', args);
+    await exec
+      .getExecOutput('docker', args, {
+        ignoreReturnCode: true
+      })
+      .then(res => {
+        if (res.stderr.length > 0 && res.exitCode != 0) {
+          throw new Error(`buildx bake failed with: ${res.stderr.match(/(.*)\s*$/)![0].trim()}`);
+        }
+      });
   } catch (error) {
     core.setFailed(error.message);
   }