Fix InputList (#6)

Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
2026-01-22 12:22:21 +01:00 · 2020-12-23 23:44:52 +01:00
parent 7cf3c8378f
commit 17d88abe59
6 changed files with 1515 additions and 61 deletions
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@ ___
  * [inputs](#inputs)
 * [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot)
 * [Limitation](#limitation)
-* [How can I help?](#how-can-i-help)
+* [Contributing](#contributing)
 * [License](#license)

 ## Usage
@@ -68,28 +68,7 @@ jobs:

 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    | List of [bake definition files](https://github.com/docker/buildx#file-definition) |
-| `targets`        | List    | 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`            | CSV     | List of [targets values to override](https://github.com/docker/buildx#--set-targetpatternkeysubkeyvalue) (eg: `targetpattern.key=value`) |
-
-> `List` type can be a comma or newline-delimited string
-> ```yaml
-> targets: default,release
-> ```
-> ```yaml
-> targets: |
->   default
->   release
-> ```
-
-> `CSV` type must be a newline-delimited string
+> `List` type is a newline-delimited string
 > ```yaml
 > set: target.args.mybuildarg=value
 > ```
@@ -99,6 +78,22 @@ Following inputs can be used as `step.with` keys
 >   foo*.args.mybuildarg=value
 > ```

+> `CSV` type is a comma-delimited string
+> ```yaml
+> targets: default,release
+> ```
+
+| 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) |
+| `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`) |
+
 ## Keep up-to-date with GitHub Dependabot

 Since [Dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot)
@@ -119,12 +114,14 @@ updates:

 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).

-## How can I help?
+# Contributing

-All kinds of contributions are welcome :raised_hands:! The most basic way to show your support is to star :star2:
-the project, or to raise issues :speech_balloon: You can also support this project by
-[**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max) :clap: or by making a
-[Paypal donation](https://www.paypal.me/crazyws) to ensure this journey continues indefinitely! :rocket:
+Want to contribute? Awesome! The most basic way to show your support is to star :star2: the project,
+or to raise issues :speech_balloon:. If you want to open a pull request, please read the
+[contributing guidelines](.github/CONTRIBUTING.md).
+
+You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max) or by
+making a [Paypal donation](https://www.paypal.me/crazyws) to ensure this journey continues indefinitely!

 Thanks again for your support, it is much appreciated! :pray:

--- a/tests/context.test.ts
+++ b/tests/context.test.ts
@@ -1,68 +1,156 @@
 import * as context from '../src/context';

 describe('getInputList', () => {
-  it('handles single line correctly', async () => {
+  it('single line correctly', async () => {
    await setInput('foo', 'bar');
    const res = await context.getInputList('foo');
    console.log(res);
    expect(res).toEqual(['bar']);
  });

-  it('handles multiple lines correctly', async () => {
+  it('multiline correctly', async () => {
    setInput('foo', 'bar\nbaz');
    const res = await context.getInputList('foo');
    console.log(res);
    expect(res).toEqual(['bar', 'baz']);
  });

-  it('remove empty lines correctly', async () => {
+  it('empty lines correctly', async () => {
    setInput('foo', 'bar\n\nbaz');
    const res = await context.getInputList('foo');
    console.log(res);
    expect(res).toEqual(['bar', 'baz']);
  });

-  it('handles comma correctly', async () => {
+  it('comma correctly', async () => {
    setInput('foo', 'bar,baz');
    const res = await context.getInputList('foo');
    console.log(res);
    expect(res).toEqual(['bar', 'baz']);
  });

-  it('remove empty result correctly', async () => {
+  it('empty result correctly', async () => {
    setInput('foo', 'bar,baz,');
    const res = await context.getInputList('foo');
    console.log(res);
    expect(res).toEqual(['bar', 'baz']);
  });

-  it('handles different new lines correctly', async () => {
+  it('different new lines correctly', async () => {
    setInput('foo', 'bar\r\nbaz');
    const res = await context.getInputList('foo');
    console.log(res);
    expect(res).toEqual(['bar', 'baz']);
  });

-  it('handles different new lines and comma correctly', async () => {
+  it('different new lines and comma correctly', async () => {
    setInput('foo', 'bar\r\nbaz,bat');
    const res = await context.getInputList('foo');
    console.log(res);
    expect(res).toEqual(['bar', 'baz', 'bat']);
  });

-  it('handles multiple lines and ignoring comma correctly', async () => {
+  it('multiline and ignoring comma correctly', async () => {
    setInput('cache-from', 'user/app:cache\ntype=local,src=path/to/dir');
    const res = await context.getInputList('cache-from', true);
    console.log(res);
    expect(res).toEqual(['user/app:cache', 'type=local,src=path/to/dir']);
  });

-  it('handles different new lines and ignoring comma correctly', async () => {
+  it('different new lines and ignoring comma correctly', async () => {
    setInput('cache-from', 'user/app:cache\r\ntype=local,src=path/to/dir');
    const res = await context.getInputList('cache-from', true);
    console.log(res);
    expect(res).toEqual(['user/app:cache', 'type=local,src=path/to/dir']);
  });
+
+  it('multiline values', async () => {
+    setInput(
+      'secrets',
+      `GIT_AUTH_TOKEN=abcdefgh,ijklmno=0123456789
+"MYSECRET=aaaaaaaa
+bbbbbbb
+ccccccccc"
+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'
+    ]);
+  });
+
+  it('multiline values with empty lines', async () => {
+    setInput(
+      'secrets',
+      `GIT_AUTH_TOKEN=abcdefgh,ijklmno=0123456789
+"MYSECRET=aaaaaaaa
+bbbbbbb
+ccccccccc"
+FOO=bar
+"EMPTYLINE=aaaa
+
+bbbb
+ccc"`
+    );
+    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',
+      `EMPTYLINE=aaaa
+
+bbbb
+ccc`
+    ]);
+  });
+
+  it('multiline values without quotes', async () => {
+    setInput(
+      'secrets',
+      `GIT_AUTH_TOKEN=abcdefgh,ijklmno=0123456789
+MYSECRET=aaaaaaaa
+bbbbbbb
+ccccccccc
+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'
+    ]);
+  });
+
+  it('multiline values escape quotes', async () => {
+    setInput(
+      'secrets',
+      `GIT_AUTH_TOKEN=abcdefgh,ijklmno=0123456789
+"MYSECRET=aaaaaaaa
+bbbb""bbb
+ccccccccc"
+FOO=bar`
+    );
+    const res = await context.getInputList('secrets', true);
+    console.log(res);
+    expect(res).toEqual([
+      'GIT_AUTH_TOKEN=abcdefgh,ijklmno=0123456789',
+      `MYSECRET=aaaaaaaa
+bbbb\"bbb
+ccccccccc`,
+      'FOO=bar'
+    ]);
+  });
 });

 describe('asyncForEach', () => {
--- a/dist/index.js
+++ b/dist/index.js
--- a/package.json
+++ b/package.json
@@ -31,6 +31,7 @@
    "@actions/core": "^1.2.6",
    "@actions/exec": "^1.0.4",
    "@actions/github": "^4.0.0",
+    "csv-parse": "^4.14.2",
    "semver": "^7.3.4",
    "tmp": "^0.2.1"
  },
--- a/src/context.ts
+++ b/src/context.ts
@@ -1,3 +1,4 @@
+import csvparse from 'csv-parse/lib/sync';
 import * as buildx from './buildx';
 import * as core from '@actions/core';

@@ -15,13 +16,13 @@ export interface Inputs {
 export async function getInputs(): Promise<Inputs> {
  return {
    builder: core.getInput('builder'),
-    files: await getInputList('files'),
-    targets: await getInputList('targets'),
+    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')),
-    set: await getInputList('set', true)
+    set: getInputList('set', true)
  };
 }

@@ -64,18 +65,30 @@ async function getCommonArgs(inputs: Inputs): Promise<Array<string>> {
  return args;
 }

-export async function getInputList(name: string, ignoreComma?: boolean): Promise<string[]> {
+export function getInputList(name: string, ignoreComma?: boolean): string[] {
+  let res: Array<string> = [];
+
  const items = core.getInput(name);
  if (items == '') {
-    return [];
+    return res;
  }
-  return items
-    .split(/\r?\n/)
-    .filter(x => x)
-    .reduce<string[]>(
-      (acc, line) => acc.concat(!ignoreComma ? line.split(',').filter(x => x) : line).map(pat => pat.trim()),
-      []
-    );
+
+  for (let output of csvparse(items, {
+    columns: false,
+    relaxColumnCount: true,
+    skipLinesWithEmptyValues: true
+  }) as Array<string[]>) {
+    if (output.length == 1) {
+      res.push(output[0]);
+      continue;
+    } else if (!ignoreComma) {
+      res.push(...output);
+      continue;
+    }
+    res.push(output.join(','));
+  }
+
+  return res.filter(item => item).map(pat => pat.trim());
 }

 export const asyncForEach = async (array, callback) => {
--- a/yarn.lock
+++ b/yarn.lock
@@ -1218,6 +1218,11 @@ cssstyle@^2.2.0:
  dependencies:
    cssom "~0.3.6"

+csv-parse@^4.14.2:
+  version "4.14.2"
+  resolved "https://registry.yarnpkg.com/csv-parse/-/csv-parse-4.14.2.tgz#c1329cff95a99b8773a92c4e62f8bff114b34726"
+  integrity sha512-YE2xlTKtM035/94llhgsp9qFQxGi47EkQJ1pZ+mLT/98GpIsbjkMGAb7Rmu9hNxVfYFOLf10hP+rPVqnoccLgw==
+
 dashdash@^1.12.0:
  version "1.14.1"
  resolved "https://registry.yarnpkg.com/dashdash/-/dashdash-1.14.1.tgz#853cfa0f7cbe2fed5de20326b8dd581035f6e2f0"