Merge pull request #57 from crazy-max/fix-docker-context

docker: fix context command

README.md

@@ -39,7 +39,7 @@ $ npm install @docker/actions-toolkit
 ## Usage
 
 ```js
-const { Toolkit } = require('@docker/actions-toolkit')
+const { Toolkit } = require('@docker/actions-toolkit/lib/toolkit')
 const toolkit = new Toolkit()
 ```
 

__tests__/buildkit/buildkit.test.ts

@@ -32,9 +32,9 @@ jest.spyOn(Builder.prototype, 'inspect').mockImplementation(async (): Promise<Bu
     lastActivity: new Date('2023-01-16 09:45:23 +0000 UTC'),
     nodes: [
       {
-        buildkitVersion: 'v0.11.0',
-        buildkitdFlags: '--debug --allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host',
-        driverOpts: ['BUILDKIT_STEP_LOG_MAX_SIZE=10485760', 'BUILDKIT_STEP_LOG_MAX_SPEED=10485760', 'JAEGER_TRACE=localhost:6831', 'image=moby/buildkit:latest', 'network=host'],
+        buildkit: 'v0.11.0',
+        'buildkitd-flags': '--debug --allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host',
+        'driver-opts': ['BUILDKIT_STEP_LOG_MAX_SIZE=10485760', 'BUILDKIT_STEP_LOG_MAX_SPEED=10485760', 'JAEGER_TRACE=localhost:6831', 'image=moby/buildkit:latest', 'network=host'],
         endpoint: 'unix:///var/run/docker.sock',
         name: 'builder20',
         platforms: 'linux/amd64,linux/amd64/v2,linux/amd64/v3,linux/arm64,linux/riscv64,linux/ppc64le,linux/s390x,linux/386,linux/mips64le,linux/mips64,linux/arm/v7,linux/arm/v6',

__tests__/buildx/builder.test.ts

@@ -35,9 +35,9 @@ jest.spyOn(Builder.prototype, 'inspect').mockImplementation(async (): Promise<Bu
     lastActivity: new Date('2023-01-16 09:45:23 +0000 UTC'),
     nodes: [
       {
-        buildkitVersion: 'v0.11.0',
-        buildkitdFlags: '--debug --allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host',
-        driverOpts: ['BUILDKIT_STEP_LOG_MAX_SIZE=10485760', 'BUILDKIT_STEP_LOG_MAX_SPEED=10485760', 'JAEGER_TRACE=localhost:6831', 'image=moby/buildkit:latest', 'network=host'],
+        buildkit: 'v0.11.0',
+        'buildkitd-flags': '--debug --allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host',
+        'driver-opts': ['BUILDKIT_STEP_LOG_MAX_SIZE=10485760', 'BUILDKIT_STEP_LOG_MAX_SPEED=10485760', 'JAEGER_TRACE=localhost:6831', 'image=moby/buildkit:latest', 'network=host'],
         endpoint: 'unix:///var/run/docker.sock',
         name: 'builder20',
         platforms: 'linux/amd64,linux/amd64/v2,linux/amd64/v3,linux/arm64,linux/riscv64,linux/ppc64le,linux/s390x,linux/386,linux/mips64le,linux/mips64,linux/arm/v7,linux/arm/v6',
@@ -71,8 +71,8 @@ describe('parseInspect', () => {
            "name": "builder-5cb467f7-0940-47e1-b94b-d51f54054d620",
            "endpoint": "unix:///var/run/docker.sock",
            "status": "running",
-           "buildkitdFlags": "--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host",
-           "buildkitVersion": "v0.10.4",
+           "buildkitd-flags": "--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host",
+           "buildkit": "v0.10.4",
            "platforms": "linux/amd64,linux/amd64/v2,linux/amd64/v3,linux/amd64/v4,linux/arm64,linux/riscv64,linux/386,linux/arm/v7,linux/arm/v6"
          }
        ]
@@ -87,12 +87,12 @@ describe('parseInspect', () => {
          {
            "name": "builder-5f449644-ff29-48af-8344-abb0292d06730",
            "endpoint": "unix:///var/run/docker.sock",
-           "driverOpts": [
+           "driver-opts": [
              "image=moby/buildkit:latest"
            ],
            "status": "running",
-           "buildkitdFlags": "--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host",
-           "buildkitVersion": "v0.10.4",
+           "buildkitd-flags": "--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host",
+           "buildkit": "v0.10.4",
            "platforms": "linux/amd64,linux/amd64/v2,linux/amd64/v3,linux/amd64/v4,linux/386"
          }
        ]
@@ -107,13 +107,13 @@ describe('parseInspect', () => {
          {
            "name": "builder-9929e463-7954-4dc3-89cd-514cca29ff800",
            "endpoint": "unix:///var/run/docker.sock",
-           "driverOpts": [
+           "driver-opts": [
              "image=moby/buildkit:master",
              "network=host"
            ],
            "status": "running",
-           "buildkitdFlags": "--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host",
-           "buildkitVersion": "3fab389",
+           "buildkitd-flags": "--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host",
+           "buildkit": "3fab389",
            "platforms": "linux/amd64,linux/amd64/v2,linux/amd64/v3,linux/amd64/v4,linux/386"
          }
        ]
@@ -129,7 +129,7 @@ describe('parseInspect', () => {
            "name": "default",
            "endpoint": "default",
            "status": "running",
-           "buildkitVersion": "20.10.17",
+           "buildkit": "20.10.17",
            "platforms": "linux/amd64,linux/arm64,linux/riscv64,linux/ppc64le,linux/s390x,linux/386,linux/arm/v7,linux/arm/v6"
          }
        ]
@@ -144,7 +144,7 @@ describe('parseInspect', () => {
          {
            "name": "aws_graviton2",
            "endpoint": "tcp://1.23.45.67:1234",
-           "driverOpts": [
+           "driver-opts": [
              "cert=/home/user/.certs/aws_graviton2/cert.pem",
              "key=/home/user/.certs/aws_graviton2/key.pem",
              "cacert=/home/user/.certs/aws_graviton2/ca.pem"
@@ -163,7 +163,7 @@ describe('parseInspect', () => {
            "name": "builder-17cfff01-48d9-4c3d-9332-9992e308a5100",
            "endpoint": "unix:///var/run/docker.sock",
            "status": "running",
-           "buildkitdFlags": "--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host",
+           "buildkitd-flags": "--allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host",
            "platforms": "linux/amd64,linux/amd64/v2,linux/amd64/v3,linux/386"
          }
        ],
@@ -179,9 +179,9 @@ describe('parseInspect', () => {
        "lastActivity": new Date("2023-01-16T09:45:23.000Z"),
        "nodes": [
          {
-           "buildkitVersion": "v0.11.0",
-           "buildkitdFlags": "--debug --allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host",
-           "driverOpts": [
+           "buildkit": "v0.11.0",
+           "buildkitd-flags": "--debug --allow-insecure-entitlement security.insecure --allow-insecure-entitlement network.host",
+           "driver-opts": [
              "BUILDKIT_STEP_LOG_MAX_SIZE=10485760",
              "BUILDKIT_STEP_LOG_MAX_SPEED=10485760",
              "JAEGER_TRACE=localhost:6831",

__tests__/docker.test.ts

@@ -16,6 +16,7 @@
 
 import {afterEach, beforeEach, describe, expect, it, jest} from '@jest/globals';
 import path from 'path';
+import * as io from '@actions/io';
 import osm = require('os');
 
 import {Docker} from '../src/docker';
@@ -49,12 +50,22 @@ describe('configDir', () => {
 
 describe('isAvailable', () => {
   it('cli', async () => {
-    const execSpy = jest.spyOn(Exec, 'getExecOutput');
+    const ioWhichSpy = jest.spyOn(io, 'which');
     await Docker.isAvailable();
-    // eslint-disable-next-line jest/no-standalone-expect
-    expect(execSpy).toHaveBeenCalledWith(`docker`, [], {
-      silent: true,
-      ignoreReturnCode: true
+    expect(ioWhichSpy).toHaveBeenCalledTimes(1);
+    expect(ioWhichSpy).toHaveBeenCalledWith('docker', true);
+  });
+});
+
+describe('context', () => {
+  it('call docker context show', async () => {
+    const execSpy = jest.spyOn(Exec, 'getExecOutput');
+    await Docker.context().catch(() => {
+      // noop
+    });
+    expect(execSpy).toHaveBeenCalledWith(`docker`, ['context', 'inspect', '--format', '{{.Name}}'], {
+      ignoreReturnCode: true,
+      silent: true
     });
   });
 });

jest.config.ts

@@ -41,7 +41,7 @@ module.exports = {
   moduleNameMapper: {
     '^csv-parse/sync': '<rootDir>/node_modules/csv-parse/dist/cjs/sync.cjs'
   },
-  collectCoverageFrom: ['src/**/{!(toolkit.ts),}.ts'],
+  collectCoverageFrom: ['src/**/{!(index.ts),}.ts'],
   coveragePathIgnorePatterns: ['lib/', 'node_modules/', '__mocks__/', '__tests__/'],
   verbose: true
 };

package.json

@@ -28,8 +28,8 @@
   "author": "Docker Inc.",
   "license": "Apache-2.0",
   "packageManager": "yarn@3.3.1",
-  "main": "lib/toolkit.js",
-  "types": "lib/toolkit.d.ts",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "directories": {
     "lib": "lib",
     "test": "__tests__"
@@ -46,6 +46,7 @@
     "@actions/exec": "^1.1.1",
     "@actions/github": "^5.1.1",
     "@actions/http-client": "^2.0.1",
+    "@actions/io": "^1.1.2",
     "@actions/tool-cache": "^2.0.1",
     "csv-parse": "^5.3.5",
     "jwt-decode": "^3.1.2",

src/buildkit/buildkit.ts

@@ -39,14 +39,14 @@ export class BuildKit {
   }
 
   public async getVersion(node: NodeInfo): Promise<string | undefined> {
-    if (!node.buildkitVersion && node.name) {
+    if (!node.buildkit && node.name) {
       try {
         return await this.getVersionWithinImage(node.name);
       } catch (e) {
         core.warning(e);
       }
     }
-    return node.buildkitVersion;
+    return node.buildkit;
   }
 
   private async getVersionWithinImage(nodeName: string): Promise<string> {
@@ -80,7 +80,7 @@ export class BuildKit {
       builderInfo = await new Builder({buildx: this.buildx}).inspect(builderName);
     }
     for (const node of builderInfo.nodes) {
-      let bkversion = node.buildkitVersion;
+      let bkversion = node.buildkit;
       core.debug(`BuildKit.versionSatisfies ${bkversion}: ${range}`);
       if (!bkversion) {
         try {

src/buildx/builder.ts

@@ -80,7 +80,7 @@ export class Builder {
           break;
         }
         case 'driver options': {
-          node.driverOpts = (value.match(/(\w+)="([^"]*)"/g) || []).map(v => v.replace(/^(.*)="(.*)"$/g, '$1=$2'));
+          node['driver-opts'] = (value.match(/(\w+)="([^"]*)"/g) || []).map(v => v.replace(/^(.*)="(.*)"$/g, '$1=$2'));
           break;
         }
         case 'status': {
@@ -88,11 +88,11 @@ export class Builder {
           break;
         }
         case 'flags': {
-          node.buildkitdFlags = value;
+          node['buildkitd-flags'] = value;
           break;
         }
         case 'buildkit': {
-          node.buildkitVersion = value;
+          node.buildkit = value;
           break;
         }
         case 'platforms': {

src/docker.ts

@@ -17,6 +17,7 @@
 import os from 'os';
 import path from 'path';
 import * as core from '@actions/core';
+import * as io from '@actions/io';
 import {Exec} from './exec';
 
 export class Docker {
@@ -25,24 +26,32 @@ export class Docker {
   }
 
   public static async isAvailable(): Promise<boolean> {
-    const ok: boolean = await Exec.getExecOutput('docker', [], {
-      ignoreReturnCode: true,
-      silent: true
-    })
+    return await io
+      .which('docker', 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;
+        core.debug(`Docker.isAvailable ok: ${res}`);
+        return true;
       })
       .catch(error => {
         core.debug(`Docker.isAvailable error: ${error}`);
         return false;
       });
+  }
 
-    core.debug(`Docker.isAvailable: ${ok}`);
-    return ok;
+  public static async context(name?: string): Promise<string> {
+    const args = ['context', 'inspect', '--format', '{{.Name}}'];
+    if (name) {
+      args.push(name);
+    }
+    return await Exec.getExecOutput(`docker`, args, {
+      ignoreReturnCode: true,
+      silent: true
+    }).then(res => {
+      if (res.stderr.length > 0 && res.exitCode != 0) {
+        throw new Error(res.stderr);
+      }
+      return res.stdout.trim();
+    });
   }
 
   public static async printVersion(): Promise<void> {

src/index.ts

@@ -0,0 +1,42 @@
+/**
+ * Copyright 2023 actions-toolkit authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as core from '@actions/core';
+
+const isPost = !!process.env['STATE_isPost'];
+if (!isPost) {
+  core.saveState('isPost', 'true');
+}
+
+/**
+ * Runs a GitHub Action.
+ * Output will be streamed to the live console.
+ *
+ * @param     main            runs the defined function.
+ * @param     post            runs the defined function at the end of the job if set.
+ * @returns   Promise<void>
+ */
+export async function run(main: () => Promise<void>, post?: () => Promise<void>): Promise<void> {
+  if (!isPost) {
+    try {
+      await main();
+    } catch (e) {
+      core.setFailed(e.message);
+    }
+  } else if (post) {
+    await post();
+  }
+}

src/types/builder.ts

@@ -21,16 +21,6 @@ export interface BuilderInfo {
   nodes: NodeInfo[];
 }
 
-export interface NodeInfo {
-  name?: string;
-  endpoint?: string;
-  driverOpts?: Array<string>;
-  status?: string;
-  buildkitdFlags?: string;
-  buildkitVersion?: string;
-  platforms?: string;
-}
-
 export interface Node {
   name?: string;
   endpoint?: string;
@@ -38,3 +28,8 @@ export interface Node {
   'buildkitd-flags'?: string;
   platforms?: string;
 }
+
+export interface NodeInfo extends Node {
+  status?: string;
+  buildkit?: string;
+}

yarn.lock

@@ -52,7 +52,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@actions/io@npm:^1.1.1":
+"@actions/io@npm:^1.1.1, @actions/io@npm:^1.1.2":
   version: 1.1.2
   resolution: "@actions/io@npm:1.1.2"
   checksum: 3c6583c4557abf6c95e9cfc9b6377045e65ba2c5dd4863f4feedd6be9daf4f6b60e588ab0151d5626b5f8320a37f05b8d44ab5c329b8c19f65be31b0616e1464
@@ -766,6 +766,7 @@ __metadata:
     "@actions/exec": ^1.1.1
     "@actions/github": ^5.1.1
     "@actions/http-client": ^2.0.1
+    "@actions/io": ^1.1.2
     "@actions/tool-cache": ^2.0.1
     "@types/csv-parse": ^1.2.2
     "@types/node": ^16.18.11