Merge pull request #83 from step-security/auto-cherry-pick

chore: Cherry-picked changes from upstream

Author: Raj-StepSecurity

.github/dependabot.yml

@@ -4,6 +4,11 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+    ignore:
+      # ignore this dependency
+      # it seems a bug with dependabot as pining to commit sha should not
+      # trigger a new version similar to https://github.com/docker/buildx/pull/2222#issuecomment-1919092153
+      - dependency-name: "docker/actions-toolkit"
     labels:
       - "dependencies"
       - "bot"

README.md

@@ -111,6 +111,7 @@ The following inputs can be used as `step.with` keys
 | `daemon-config` | String |                       | [Docker daemon JSON configuration](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file) |
 | `context`       | String | `setup-docker-action` | Docker context name.                                                                                                        |
 | `set-host`      | Bool   | `false`               | Set `DOCKER_HOST` environment variable to docker socket path.                                                               |
+| `rootless`      | Bool   | `false`               | Start daemon in rootless mode                                                                                               |
 
 ### outputs
 

__tests__/context.test.ts

@@ -19,12 +19,17 @@ describe('getInputs', () => {
       new Map<string, string>([
         ['version', 'v24.0.8'],
         ['set-host', 'false'],
+        ['rootless', 'false'],
       ]),
       {
-        version: 'v24.0.8',
-        channel: '',
+        source: {
+          type: 'archive',
+          version: 'v24.0.8',
+          channel: 'stable'
+        },
         context: '',
         daemonConfig: '',
+        rootless: false,
         setHost: false
       } as context.Inputs
     ],
@@ -36,28 +41,150 @@ describe('getInputs', () => {
         ['context', 'foo'],
         ['daemon-config', `{"debug":true,"features":{"containerd-snapshotter":true}}`],
         ['set-host', 'false'],
+        ['rootless', 'false'],
       ]),
       {
-        version: 'v24.0.0-rc.4',
-        channel: 'test',
+        source: {
+          type: 'archive',
+          version: 'v24.0.0-rc.4',
+          channel: 'test'
+        },
         context: 'foo',
         daemonConfig: `{"debug":true,"features":{"containerd-snapshotter":true}}`,
+        rootless: false,
         setHost: false
       } as context.Inputs
     ],
     [
       2,
       new Map<string, string>([
         ['set-host', 'true'],
+        ['rootless', 'false'],
       ]),
       {
-        version: 'latest',
-        channel: '',
+        source: {
+          type: 'archive',
+          version: 'latest',
+          channel: 'stable',
+        },
         context: '',
         daemonConfig: '',
+        rootless: false,
         setHost: true
       } as context.Inputs
-    ]
+    ],
+    [
+    3,
+      new Map<string, string>([
+        ['version', 'type=image,tag=master'],
+        ['context', 'foo'],
+        ['daemon-config', `{"debug":true,"features":{"containerd-snapshotter":true}}`],
+        ['set-host', 'false'],
+        ['rootless', 'false'],
+      ]),
+      {
+        source: {
+          type: 'image',
+          tag: 'master',
+        },
+        context: 'foo',
+        daemonConfig: `{"debug":true,"features":{"containerd-snapshotter":true}}`,
+        rootless: false,
+        setHost: false
+      } as context.Inputs
+    ],
+    [
+      4,
+      new Map<string, string>([
+        ['version', 'type=image'],
+        ['set-host', 'false'],
+        ['rootless', 'false'],
+      ]),
+      {
+        source: {
+          type: 'image',
+          tag: 'latest',
+        },
+        context: '',
+        daemonConfig: '',
+        rootless: false,
+        setHost: false
+      } as context.Inputs
+    ],
+    [
+      5,
+      new Map<string, string>([
+        ['version', 'type=archive'],
+        ['set-host', 'false'],
+        ['rootless', 'false'],
+      ]),
+      {
+        source: {
+          type: 'archive',
+          version: 'latest',
+          channel: 'stable',
+        },
+        setHost: false,
+        context: '',
+        daemonConfig: '',
+        rootless: false,
+      } as context.Inputs
+    ],
+    [
+      6,
+      new Map<string, string>([
+        ['version', 'version=v27.2.0,channel=test'],
+        ['set-host', 'false'],
+        ['rootless', 'false'],
+      ]),
+      {
+        source: {
+          type: 'archive',
+          version: 'v27.2.0',
+          channel: 'test',
+        },
+        setHost: false,
+        context: '',
+        daemonConfig: '',
+        rootless: false,
+      } as context.Inputs
+    ],
+    [
+      7,
+      new Map<string, string>([
+        ['version', 'type=image,tag=27.2.1'],
+        ['set-host', 'false'],
+        ['rootless', 'false'],
+      ]),
+      {
+        source: {
+          type: 'image',
+          tag: '27.2.1',
+        },
+        setHost: false,
+        context: '',
+        daemonConfig: '',
+        rootless: false,
+      } as context.Inputs
+    ],
+    [
+      8,
+      new Map<string, string>([
+        ['version', 'type=image,tag=27.2.1'],
+        ['set-host', 'false'],
+        ['rootless', 'true']
+      ]),
+      {
+        source: {
+          type: 'image',
+          tag: '27.2.1',
+        },
+        setHost: false,
+        context: '',
+        daemonConfig: '',
+        rootless: true,
+      } as context.Inputs
+    ],
   ])(
     '[%d] given %p as inputs, returns %p',
     async (num: number, inputs: Map<string, string>, expected: context.Inputs) => {

action.yml

@@ -23,6 +23,10 @@ inputs:
     description: 'Set DOCKER_HOST environment variable to docker socket path'
     default: 'false'
     required: false
+  rootless:
+    description: 'Enable Docker rootless mode'
+    default: 'false'
+    required: false
 
 outputs:
   sock:

dist/index.js

@@ -1,19 +1,98 @@
 import * as core from '@actions/core';
+import {InstallSource} from '@docker/actions-toolkit/lib/docker/install';
+import {parse} from 'csv-parse/sync';
 
 export interface Inputs {
-  version: string;
-  channel: string;
+  source: InstallSource;
   daemonConfig?: string;
   context: string;
   setHost: boolean;
+  rootless: boolean;
 }
 
 export function getInputs(): Inputs {
+  const rawVersion = core.getInput('version') || 'latest';
+  const source = parseSource(rawVersion);
+  const channel = core.getInput('channel');
+  if (channel && source.type === 'archive') {
+    source.channel = channel;
+  }
+
   return {
-    version: core.getInput('version') || 'latest',
-    channel: core.getInput('channel'),
+    source: source,
     daemonConfig: core.getInput('daemon-config'),
     context: core.getInput('context'),
-    setHost: core.getBooleanInput('set-host')
+    setHost: core.getBooleanInput('set-host'),
+    rootless: core.getBooleanInput('rootless')
   };
 }
+
+function parseSource(input: string): InstallSource {
+  let [type, version, channel, tag] = ['archive', 'latest', 'stable', 'latest'];
+
+  const fields = parse(input, {
+    relaxColumnCount: true,
+    skipEmptyLines: true
+  })[0];
+  for (const field of fields) {
+    const parts = field
+      .toString()
+      .split(/(?<=^[^=]+?)=/)
+      .map(item => item.trim());
+
+    switch (parts[0]) {
+      case 'type':
+        type = parts[1];
+        break;
+      case 'version':
+        version = parts[1];
+        break;
+      case 'channel':
+        channel = parts[1];
+        break;
+      case 'tag':
+        tag = parts[1];
+        break;
+      default:
+        if (fields.length === 1) {
+          version = parts[0];
+          break;
+        }
+        throw new Error(`Invalid field: ${parts[0]}`);
+    }
+  }
+
+  if (!type) {
+    throw new Error(`Invalid type: ${type}`);
+  }
+  if (!channel) {
+    throw new Error(`Invalid channel: ${channel}`);
+  }
+  if (!version) {
+    throw new Error(`Invalid version: ${version}`);
+  }
+  if (!tag) {
+    throw new Error(`Invalid tag: ${tag}`);
+  }
+
+  let src: InstallSource;
+  switch (type) {
+    case 'archive':
+      src = {
+        type: 'archive',
+        version: version,
+        channel: channel
+      };
+      break;
+    case 'image':
+      src = {
+        type: 'image',
+        tag: tag
+      };
+      break;
+    default:
+      throw new Error(`Invalid version: ${input}`);
+  }
+
+  return src;
+}

dist/index.js.map

@@ -1,6 +1,6 @@
+import * as crypto from 'crypto';
 import os from 'os';
 import path from 'path';
-import * as uuid from 'uuid';
 import * as core from '@actions/core';
 import * as actionsToolkit from '@docker/actions-toolkit';
 import {Install} from '@docker/actions-toolkit/lib/docker/install';
@@ -31,21 +31,21 @@ actionsToolkit.run(
     await validateSubscription();
 
     const input: context.Inputs = context.getInputs();
-    const runDir = path.join(os.homedir(), `setup-docker-action-${uuid.v4().slice(0, 8)}`);
+    const runDir = path.join(os.homedir(), `setup-docker-action-${crypto.randomUUID().slice(0, 8)}`);
 
     if (input.context == 'default') {
       throw new Error(`'default' context cannot be used.`);
     }
 
     const install = new Install({
       runDir: runDir,
-      version: input.version,
-      channel: input.channel || 'stable',
+      source: input.source,
+      rootless: input.rootless,
       contextName: input.context || 'setup-docker-action',
       daemonConfig: input.daemonConfig
     });
     let toolDir;
-    if (!(await Docker.isAvailable()) || input.version) {
+    if (!(await Docker.isAvailable()) || input.source) {
       await core.group(`Download docker`, async () => {
         toolDir = await install.download();
       });