@docker/actions-toolkit 0.1.0-beta.9 → 0.1.0-rc.1

package/lib/docker/assets.js

@@ -0,0 +1,339 @@
+"use strict";
+/**
+ * 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.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.colimaYamlData = exports.dockerServiceLogsPs1Data = exports.setupDockerWinPs1Data = exports.setupDockerLinuxShData = exports.colimaYaml = exports.dockerServiceLogsPs1 = exports.setupDockerWinPs1 = exports.setupDockerLinuxSh = void 0;
+const fs_1 = __importDefault(require("fs"));
+const context_1 = require("../context");
+const setupDockerLinuxSh = () => {
+    return get('docker-setup-linux.sh', exports.setupDockerLinuxShData, '0755');
+};
+exports.setupDockerLinuxSh = setupDockerLinuxSh;
+const setupDockerWinPs1 = () => {
+    return get('docker-setup-win.ps1', exports.setupDockerWinPs1Data);
+};
+exports.setupDockerWinPs1 = setupDockerWinPs1;
+const dockerServiceLogsPs1 = () => {
+    return get('docker-service-logs.ps1', exports.dockerServiceLogsPs1Data);
+};
+exports.dockerServiceLogsPs1 = dockerServiceLogsPs1;
+const colimaYaml = () => {
+    return get('colima.yaml', exports.colimaYamlData);
+};
+exports.colimaYaml = colimaYaml;
+const get = (filename, data, mode) => {
+    const assetPath = context_1.Context.tmpName({
+        template: `docker-asset-XXXXXX-${filename}`,
+        tmpdir: context_1.Context.tmpDir()
+    });
+    fs_1.default.writeFileSync(assetPath, data);
+    if (mode) {
+        fs_1.default.chmodSync(assetPath, mode);
+    }
+    return assetPath;
+};
+exports.setupDockerLinuxShData = `
+#!/usr/bin/env bash
+
+set -eu
+
+: "\${TOOLDIR=}"
+: "\${RUNDIR=}"
+: "\${DOCKER_HOST=}"
+
+export PATH="$TOOLDIR::$PATH"
+
+if [ -z "$DOCKER_HOST" ]; then
+  echo >&2 'error: DOCKER_HOST required'
+  false
+fi
+
+if ! command -v dockerd &> /dev/null; then
+  echo >&2 'error: dockerd missing from PATH'
+  false
+fi
+
+mkdir -p "$RUNDIR"
+
+(
+  echo "Starting dockerd"
+  set -x
+  exec dockerd \\
+    --host="$DOCKER_HOST" \\
+    --exec-root="$RUNDIR/execroot" \\
+    --data-root="$RUNDIR/data" \\
+    --pidfile="$RUNDIR/docker.pid" \\
+    --userland-proxy=false \\
+    2>&1 | tee "$RUNDIR/dockerd.log"
+) &
+`;
+exports.setupDockerWinPs1Data = `
+[CmdletBinding()]
+param(
+    [Parameter(Mandatory = $true)]
+    [string]$ToolDir,
+
+    [Parameter(Mandatory = $true)]
+    [string]$RunDir,
+
+    [Parameter(Mandatory = $true)]
+    [string]$DockerHost)
+
+$pwver = (Get-ItemProperty -Path HKLM:\\SOFTWARE\\Microsoft\\PowerShell\\3\\PowerShellEngine -Name 'PowerShellVersion').PowerShellVersion
+Write-Host "PowerShell version: $pwver"
+
+# Create run directory
+New-Item -ItemType Directory "$RunDir" -ErrorAction SilentlyContinue | Out-Null
+
+# Remove existing service
+if (Get-Service docker -ErrorAction SilentlyContinue) {
+  $dockerVersion = (docker version -f "{{.Server.Version}}")
+  Write-Host "Current installed Docker version: $dockerVersion"
+  # stop service
+  Stop-Service -Force -Name docker
+  Write-Host "Service stopped"
+  # remove service
+  sc.exe delete "docker"
+  # removes event log entry. we could use "Remove-EventLog -LogName -Source docker"
+  # but this cmd is not available atm
+  $ErrorActionPreference = "SilentlyContinue"
+  & reg delete "HKLM\\SYSTEM\\CurrentControlSet\\Services\\EventLog\\Application\\docker" /f 2>&1 | Out-Null
+  $ErrorActionPreference = "Stop"
+  Write-Host "Service removed"
+}
+
+$env:DOCKER_HOST = $DockerHost
+Write-Host "DOCKER_HOST: $env:DOCKER_HOST"
+
+Write-Host "Creating service"
+New-Item -ItemType Directory "$RunDir\\moby-root" -ErrorAction SilentlyContinue | Out-Null
+New-Item -ItemType Directory "$RunDir\\moby-exec" -ErrorAction SilentlyContinue | Out-Null
+Start-Process -Wait -NoNewWindow "$ToolDir\\dockerd" \`
+  -ArgumentList \`
+    "--host=$DockerHost", \`
+    "--data-root=$RunDir\\moby-root", \`
+    "--exec-root=$RunDir\\moby-exec", \`
+    "--pidfile=$RunDir\\docker.pid", \`
+    "--register-service"
+Write-Host "Starting service"
+Start-Service -Name docker
+Write-Host "Service started successfully!"
+
+$tries=20
+Write-Host "Waiting for Docker daemon to start..."
+While ($true) {
+  $ErrorActionPreference = "SilentlyContinue"
+  & "$ToolDir\\docker" version | Out-Null
+  $ErrorActionPreference = "Stop"
+  If ($LastExitCode -eq 0) {
+    break
+  }
+  $tries--
+  If ($tries -le 0) {
+    Throw "Failed to get a response from Docker daemon"
+  }
+  Write-Host -NoNewline "."
+  Start-Sleep -Seconds 1
+}
+Write-Host "Docker daemon started successfully!"
+`;
+exports.dockerServiceLogsPs1Data = `
+Get-WinEvent -ea SilentlyContinue \`
+  -FilterHashtable @{ProviderName= "docker"; LogName = "application"} |
+    Sort-Object @{Expression="TimeCreated";Descending=$false} |
+    ForEach-Object {"$($_.TimeCreated.ToUniversalTime().ToString("o")) [$($_.LevelDisplayName)] $($_.Message)"}
+`;
+exports.colimaYamlData = `
+# Number of CPUs to be allocated to the virtual machine.
+# Default: 2
+cpu: 2
+
+# Size of the disk in GiB to be allocated to the virtual machine.
+# NOTE: changing this has no effect after the virtual machine has been created.
+# Default: 60
+disk: 60
+
+# Size of the memory in GiB to be allocated to the virtual machine.
+# Default: 2
+memory: 2
+
+# Architecture of the virtual machine (x86_64, aarch64, host).
+# Default: host
+arch: host
+
+# Container runtime to be used (docker, containerd).
+# Default: docker
+runtime: docker
+
+# Kubernetes configuration for the virtual machine.
+kubernetes:
+  enabled: false
+
+# Auto-activate on the Host for client access.
+# Setting to true does the following on startup
+#  - sets as active Docker context (for Docker runtime).
+#  - sets as active Kubernetes context (if Kubernetes is enabled).
+# Default: true
+autoActivate: false
+
+# Network configurations for the virtual machine.
+network:
+  # Assign reachable IP address to the virtual machine.
+  # NOTE: this is currently macOS only and ignored on Linux.
+  # Default: false
+  address: false
+
+  # Custom DNS resolvers for the virtual machine.
+  #
+  # EXAMPLE
+  # dns: [8.8.8.8, 1.1.1.1]
+  #
+  # Default: []
+  dns: []
+
+  # DNS hostnames to resolve to custom targets using the internal resolver.
+  # This setting has no effect if a custom DNS resolver list is supplied above.
+  # It does not configure the /etc/hosts files of any machine or container.
+  # The value can be an IP address or another host.
+  #
+  # EXAMPLE
+  # dnsHosts:
+  #   example.com: 1.2.3.4
+  dnsHosts:
+    host.docker.internal: host.lima.internal
+
+  # Network driver to use (slirp, gvproxy), (requires vmType \`qemu\`)
+  #   - slirp is the default user mode networking provided by Qemu
+  #   - gvproxy is an alternative to VPNKit based on gVisor https://github.com/containers/gvisor-tap-vsock
+  # Default: gvproxy
+  driver: gvproxy
+
+# Forward the host's SSH agent to the virtual machine.
+# Default: false
+forwardAgent: false
+
+# Docker daemon configuration that maps directly to daemon.json.
+# https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file.
+# NOTE: some settings may affect Colima's ability to start docker. e.g. \`hosts\`.
+#
+# EXAMPLE - disable buildkit
+# docker:
+#   features:
+#     buildkit: false
+#
+# EXAMPLE - add insecure registries
+# docker:
+#   insecure-registries:
+#     - myregistry.com:5000
+#     - host.docker.internal:5000
+#
+# Colima default behaviour: buildkit enabled
+# Default: {}
+docker: {}
+
+# Virtual Machine type (qemu, vz)
+# NOTE: this is macOS 13 only. For Linux and macOS <13.0, qemu is always used.
+#
+# vz is macOS virtualization framework and requires macOS 13
+#
+# Default: qemu
+vmType: qemu
+
+# Volume mount driver for the virtual machine (virtiofs, 9p, sshfs).
+#
+# virtiofs is limited to macOS and vmType \`vz\`. It is the fastest of the options.
+#
+# 9p is the recommended and the most stable option for vmType \`qemu\`.
+#
+# sshfs is faster than 9p but the least reliable of the options (when there are lots
+# of concurrent reads or writes).
+#
+# Default: virtiofs (for vz), sshfs (for qemu)
+mountType: 9p
+
+# The CPU type for the virtual machine (requires vmType \`qemu\`).
+# Options available for host emulation can be checked with: \`qemu-system-$(arch) -cpu help\`.
+# Instructions are also supported by appending to the cpu type e.g. "qemu64,+ssse3".
+# Default: host
+cpuType: host
+
+# For a more general purpose virtual machine, Ubuntu container is optionally provided
+# as a layer on the virtual machine.
+# The underlying virtual machine is still accessible via \`colima ssh --layer=false\` or running \`colima\` in
+# the Ubuntu session.
+#
+# Default: false
+layer: false
+
+# Custom provision scripts for the virtual machine.
+# Provisioning scripts are executed on startup and therefore needs to be idempotent.
+#
+# EXAMPLE - script exected as root
+# provision:
+#   - mode: system
+#     script: apk add htop vim
+#
+# EXAMPLE - script exected as user
+# provision:
+#   - mode: user
+#     script: |
+#       [ -f ~/.provision ] && exit 0;
+#       echo provisioning as $USER...
+#       touch ~/.provision
+#
+# Default: []
+provision:
+  - mode: system
+    script: |
+      mkdir -p /tmp/docker-bins
+      cd /tmp/docker-bins
+      wget -qO- "https://download.docker.com/linux/static/{{dockerChannel}}/{{hostArch}}/docker-{{dockerVersion}}.tgz" | tar xvz --strip 1
+      mv -f /tmp/docker-bins/* /usr/bin/
+
+# Modify ~/.ssh/config automatically to include a SSH config for the virtual machine.
+# SSH config will still be generated in ~/.colima/ssh_config regardless.
+# Default: true
+sshConfig: false
+
+# Configure volume mounts for the virtual machine.
+# Colima mounts user's home directory by default to provide a familiar
+# user experience.
+#
+# EXAMPLE
+# mounts:
+#   - location: ~/secrets
+#     writable: false
+#   - location: ~/projects
+#     writable: true
+#
+# Colima default behaviour: $HOME and /tmp/colima are mounted as writable.
+# Default: []
+mounts: []
+
+# Environment variables for the virtual machine.
+#
+# EXAMPLE
+# env:
+#   KEY: value
+#   ANOTHER_KEY: another value
+#
+# Default: {}
+env: {}
+`;
+//# sourceMappingURL=assets.js.map

package/lib/docker/assets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assets.js","sourceRoot":"","sources":["../../src/docker/assets.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;;;AAEH,4CAAoB;AACpB,wCAAmC;AAE5B,MAAM,kBAAkB,GAAG,GAAW,EAAE;IAC7C,OAAO,GAAG,CAAC,uBAAuB,EAAE,8BAAsB,EAAE,MAAM,CAAC,CAAC;AACtE,CAAC,CAAC;AAFW,QAAA,kBAAkB,sBAE7B;AAEK,MAAM,iBAAiB,GAAG,GAAW,EAAE;IAC5C,OAAO,GAAG,CAAC,sBAAsB,EAAE,6BAAqB,CAAC,CAAC;AAC5D,CAAC,CAAC;AAFW,QAAA,iBAAiB,qBAE5B;AAEK,MAAM,oBAAoB,GAAG,GAAW,EAAE;IAC/C,OAAO,GAAG,CAAC,yBAAyB,EAAE,gCAAwB,CAAC,CAAC;AAClE,CAAC,CAAC;AAFW,QAAA,oBAAoB,wBAE/B;AAEK,MAAM,UAAU,GAAG,GAAW,EAAE;IACrC,OAAO,GAAG,CAAC,aAAa,EAAE,sBAAc,CAAC,CAAC;AAC5C,CAAC,CAAC;AAFW,QAAA,UAAU,cAErB;AAEF,MAAM,GAAG,GAAG,CAAC,QAAgB,EAAE,IAAY,EAAE,IAAa,EAAU,EAAE;IACpE,MAAM,SAAS,GAAG,iBAAO,CAAC,OAAO,CAAC;QAChC,QAAQ,EAAE,uBAAuB,QAAQ,EAAE;QAC3C,MAAM,EAAE,iBAAO,CAAC,MAAM,EAAE;KACzB,CAAC,CAAC;IACH,YAAE,CAAC,aAAa,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAClC,IAAI,IAAI,EAAE;QACR,YAAE,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;KAC/B;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEW,QAAA,sBAAsB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkCrC,CAAC;AAEW,QAAA,qBAAqB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqEpC,CAAC;AAEW,QAAA,wBAAwB,GAAG;;;;;CAKvC,CAAC;AAEW,QAAA,cAAc,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgL7B,CAAC"}

package/lib/{docker.d.ts → docker/docker.d.ts}

@@ -15,7 +15,8 @@
  */
 export declare class Docker {
     static get configDir(): string;
-    static get isAvailable(): boolean;
-    static printVersion(standalone?: boolean): Promise<void>;
-    static printInfo(standalone?: boolean): Promise<void>;
+    static isAvailable(): Promise<boolean>;
+    static context(name?: string): Promise<string>;
+    static printVersion(): Promise<void>;
+    static printInfo(): Promise<void>;
 }

package/lib/{docker.js → docker/docker.js}

@@ -54,57 +54,51 @@ exports.Docker = void 0;
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 const core = __importStar(require("@actions/core"));
-const exec = __importStar(require("@actions/exec"));
+const io = __importStar(require("@actions/io"));
+const exec_1 = require("../exec");
 class Docker {
     static get configDir() {
         return process.env.DOCKER_CONFIG || path_1.default.join(os_1.default.homedir(), '.docker');
     }
-    static get isAvailable() {
-        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;
+    static isAvailable() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield io
+                .which('docker', true)
+                .then(res => {
+                core.debug(`Docker.isAvailable ok: ${res}`);
+                return true;
+            })
+                .catch(error => {
+                core.debug(`Docker.isAvailable error: ${error}`);
+                return false;
+            });
         });
-        return dockerAvailable;
     }
-    static printVersion(standalone) {
+    static context(name) {
         return __awaiter(this, void 0, void 0, function* () {
-            const noDocker = standalone !== null && standalone !== void 0 ? standalone : !Docker.isAvailable;
-            if (noDocker) {
-                core.debug('Docker.printVersion: Docker is not available, skipping.');
-                return;
+            const args = ['context', 'inspect', '--format', '{{.Name}}'];
+            if (name) {
+                args.push(name);
             }
-            yield exec.exec('docker', ['version'], {
-                failOnStdErr: false
+            return yield exec_1.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();
             });
         });
     }
-    static printInfo(standalone) {
+    static printVersion() {
         return __awaiter(this, void 0, void 0, function* () {
-            const noDocker = standalone !== null && standalone !== void 0 ? standalone : !Docker.isAvailable;
-            if (noDocker) {
-                core.debug('Docker.printInfo: Docker is not available, skipping.');
-                return;
-            }
-            yield exec.exec('docker', ['info'], {
-                failOnStdErr: false
-            });
+            yield exec_1.Exec.exec('docker', ['version']);
+        });
+    }
+    static printInfo() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield exec_1.Exec.exec('docker', ['info']);
         });
     }
 }

package/lib/docker/docker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docker.js","sourceRoot":"","sources":["../../src/docker/docker.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,4CAAoB;AACpB,gDAAwB;AACxB,oDAAsC;AACtC,gDAAkC;AAClC,kCAA6B;AAE7B,MAAa,MAAM;IACjB,MAAM,KAAK,SAAS;QAClB,OAAO,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,cAAI,CAAC,IAAI,CAAC,YAAE,CAAC,OAAO,EAAE,EAAE,SAAS,CAAC,CAAC;IACzE,CAAC;IAEM,MAAM,CAAO,WAAW;;YAC7B,OAAO,MAAM,EAAE;iBACZ,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC;iBACrB,IAAI,CAAC,GAAG,CAAC,EAAE;gBACV,IAAI,CAAC,KAAK,CAAC,0BAA0B,GAAG,EAAE,CAAC,CAAC;gBAC5C,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;iBACD,KAAK,CAAC,KAAK,CAAC,EAAE;gBACb,IAAI,CAAC,KAAK,CAAC,6BAA6B,KAAK,EAAE,CAAC,CAAC;gBACjD,OAAO,KAAK,CAAC;YACf,CAAC,CAAC,CAAC;QACP,CAAC;KAAA;IAEM,MAAM,CAAO,OAAO,CAAC,IAAa;;YACvC,MAAM,IAAI,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;YAC7D,IAAI,IAAI,EAAE;gBACR,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACjB;YACD,OAAO,MAAM,WAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,EAAE;gBAC9C,gBAAgB,EAAE,IAAI;gBACtB,MAAM,EAAE,IAAI;aACb,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;gBACZ,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,IAAI,CAAC,EAAE;oBAC9C,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;iBAC7B;gBACD,OAAO,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YAC3B,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;IAEM,MAAM,CAAO,YAAY;;YAC9B,MAAM,WAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;QACzC,CAAC;KAAA;IAEM,MAAM,CAAO,SAAS;;YAC3B,MAAM,WAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QACtC,CAAC;KAAA;CACF;AAzCD,wBAyCC"}

package/lib/docker/install.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 { GitHubRelease } from '../types/github';
+export interface InstallOpts {
+    version?: string;
+    channel?: string;
+    runDir: string;
+    contextName?: string;
+}
+export declare class Install {
+    private readonly runDir;
+    private readonly version;
+    private readonly channel;
+    private readonly contextName;
+    private _version;
+    private _toolDir;
+    constructor(opts: InstallOpts);
+    get toolDir(): string;
+    download(): Promise<string>;
+    install(): Promise<void>;
+    private installDarwin;
+    private installLinux;
+    private installWindows;
+    tearDown(): Promise<void>;
+    private tearDownDarwin;
+    private tearDownLinux;
+    private tearDownWindows;
+    private downloadURL;
+    private static platformOS;
+    private static platformArch;
+    private static colimaInstalled;
+    static getRelease(version: string): Promise<GitHubRelease>;
+}