Merge pull request #524 from crazy-max/bump-aws

bump @aws-sdk/client-ecr and @aws-sdk/client-ecr-public to 3.347.1

.eslintrc.json

@@ -2,7 +2,7 @@
   "env": {
     "node": true,
     "es2021": true,
-    "jest/globals": true
+    "jest": true
   },
   "extends": [
     "eslint:recommended",

.github/workflows/ci.yml

@@ -143,7 +143,7 @@ jobs:
         uses: actions/checkout@v3
       -
         name: Configure AWS Credentials
-        uses: aws-actions/configure-aws-credentials@v1
+        uses: aws-actions/configure-aws-credentials@v2
         with:
           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
@@ -190,7 +190,7 @@ jobs:
         uses: actions/checkout@v3
       -
         name: Configure AWS Credentials
-        uses: aws-actions/configure-aws-credentials@v1
+        uses: aws-actions/configure-aws-credentials@v2
         with:
           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

.github/workflows/test.yml

@@ -6,9 +6,6 @@ on:
       - 'master'
       - 'releases/v*'
   pull_request:
-    branches:
-      - 'master'
-      - 'releases/v*'
 
 jobs:
   test:
@@ -17,14 +14,9 @@ jobs:
       -
         name: Checkout
         uses: actions/checkout@v3
-      -
-        name: Validate
-        uses: docker/bake-action@v1
-        with:
-          targets: validate
       -
         name: Test
-        uses: docker/bake-action@v1
+        uses: docker/bake-action@v3
         with:
           targets: test
       -

.github/workflows/validate.yml

@@ -0,0 +1,41 @@
+name: validate
+
+on:
+  push:
+    branches:
+      - 'master'
+      - 'releases/v*'
+  pull_request:
+
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    outputs:
+      targets: ${{ steps.targets.outputs.matrix }}
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Targets matrix
+        id: targets
+        run: |
+          echo "matrix=$(docker buildx bake validate --print | jq -cr '.group.validate.targets')" >> $GITHUB_OUTPUT
+
+  validate:
+    runs-on: ubuntu-latest
+    needs:
+      - prepare
+    strategy:
+      fail-fast: false
+      matrix:
+        target: ${{ fromJson(needs.prepare.outputs.targets) }}
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Validate
+        uses: docker/bake-action@v3
+        with:
+          targets: ${{ matrix.target }}

.gitignore

@@ -1,11 +1,6 @@
-/.dev
 node_modules/
 lib
 
-# Jetbrains
-/.idea
-/*.iml
-
 # Rest of the file pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
 # Logs
 logs

README.md

@@ -1,7 +1,7 @@
 [![GitHub release](https://img.shields.io/github/release/docker/login-action.svg?style=flat-square)](https://github.com/docker/login-action/releases/latest)
 [![GitHub marketplace](https://img.shields.io/badge/marketplace-docker--login-blue?logo=github&style=flat-square)](https://github.com/marketplace/actions/docker-login)
-[![CI workflow](https://img.shields.io/github/workflow/status/docker/login-action/ci?label=ci&logo=github&style=flat-square)](https://github.com/docker/login-action/actions?workflow=ci)
-[![Test workflow](https://img.shields.io/github/workflow/status/docker/login-action/test?label=test&logo=github&style=flat-square)](https://github.com/docker/login-action/actions?workflow=test)
+[![CI workflow](https://img.shields.io/github/actions/workflow/status/docker/login-action/ci.yml?branch=master&label=ci&logo=github&style=flat-square)](https://github.com/docker/login-action/actions?workflow=ci)
+[![Test workflow](https://img.shields.io/github/actions/workflow/status/docker/login-action/test.yml?branch=master&label=test&logo=github&style=flat-square)](https://github.com/docker/login-action/actions?workflow=test)
 [![Codecov](https://img.shields.io/codecov/c/github/docker/login-action?logo=codecov&style=flat-square)](https://codecov.io/gh/docker/login-action)
 
 ## About
@@ -47,7 +47,7 @@ jobs:
     steps:
       -
         name: Login to Docker Hub
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
@@ -72,7 +72,7 @@ jobs:
     steps:
       -
         name: Login to GitHub Container Registry
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
@@ -100,13 +100,15 @@ jobs:
     steps:
       -
         name: Login to GitLab
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: registry.gitlab.com
           username: ${{ secrets.GITLAB_USERNAME }}
           password: ${{ secrets.GITLAB_PASSWORD }}
 ```
 
+If you have [Two-Factor Authentication](https://gitlab.com/help/user/profile/account/two_factor_authentication) enabled, use a [Personal Access Token](https://gitlab.com/help/user/profile/personal_access_tokens) instead of a password.
+
 ### Azure Container Registry (ACR)
 
 [Create a service principal](https://docs.microsoft.com/en-us/azure/container-registry/container-registry-auth-service-principal#create-a-service-principal)
@@ -126,7 +128,7 @@ jobs:
     steps:
       -
         name: Login to ACR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: <registry-name>.azurecr.io
           username: ${{ secrets.AZURE_CLIENT_ID }}
@@ -168,7 +170,7 @@ jobs:
         service_account: '<service_account>'
 
     - name: Login to GCR
-      uses: docker/login-action@v1
+      uses: docker/login-action@v2
       with:
         registry: gcr.io
         username: oauth2accesstoken
@@ -200,7 +202,7 @@ jobs:
     steps:
       -
         name: Login to GCR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: gcr.io
           username: _json_key
@@ -235,7 +237,7 @@ jobs:
           service_account: '<service_account>'
       
       - name: Login to GAR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: <location>-docker.pkg.dev
           username: oauth2accesstoken
@@ -269,7 +271,7 @@ jobs:
     steps:
       -
         name: Login to GAR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: <location>-docker.pkg.dev
           username: _json_key
@@ -298,7 +300,7 @@ jobs:
     steps:
       -
         name: Login to ECR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: <aws-account-number>.dkr.ecr.<region>.amazonaws.com
           username: ${{ secrets.AWS_ACCESS_KEY_ID }}
@@ -321,7 +323,7 @@ jobs:
     steps:
       -
         name: Login to ECR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: <aws-account-number>.dkr.ecr.<region>.amazonaws.com
           username: ${{ secrets.AWS_ACCESS_KEY_ID }}
@@ -355,7 +357,7 @@ jobs:
           aws-region: <region>
       -
         name: Login to ECR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: <aws-account-number>.dkr.ecr.<region>.amazonaws.com
 ```
@@ -381,7 +383,7 @@ jobs:
     steps:
       -
         name: Login to Public ECR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: public.ecr.aws
           username: ${{ secrets.AWS_ACCESS_KEY_ID }}
@@ -415,7 +417,7 @@ jobs:
     steps:
       -
         name: Login to OCIR
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: <region>.ocir.io
           username: ${{ secrets.OCI_USERNAME }}
@@ -441,7 +443,7 @@ jobs:
     steps:
       -
         name: Login to Quay.io
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: quay.io
           username: ${{ secrets.QUAY_USERNAME }}

__tests__/context.test.ts

@@ -7,5 +7,5 @@ test('with password and username getInputs does not throw error', async () => {
   process.env['INPUT_LOGOUT'] = 'true';
   expect(() => {
     getInputs();
-  }).not.toThrowError();
+  }).not.toThrow();
 });

__tests__/main.test.ts

@@ -1,26 +1,21 @@
 import {expect, jest, test} from '@jest/globals';
 import osm = require('os');
 
-import {run} from '../src/main';
+import {main} from '../src/main';
 import * as docker from '../src/docker';
 import * as stateHelper from '../src/state-helper';
 
-import * as core from '@actions/core';
-
 test('errors without username and password', async () => {
   jest.spyOn(osm, 'platform').mockImplementation(() => 'linux');
   process.env['INPUT_LOGOUT'] = 'true'; // default value
-  const coreSpy = jest.spyOn(core, 'setFailed');
-
-  await run();
-  expect(coreSpy).toHaveBeenCalledWith('Username and password required');
+  await expect(main()).rejects.toThrow(new Error('Username and password required'));
 });
 
 test('successful with username and password', async () => {
   jest.spyOn(osm, 'platform').mockImplementation(() => 'linux');
   const setRegistrySpy = jest.spyOn(stateHelper, 'setRegistry');
   const setLogoutSpy = jest.spyOn(stateHelper, 'setLogout');
-  const dockerSpy = jest.spyOn(docker, 'login').mockImplementation(jest.fn());
+  const dockerSpy = jest.spyOn(docker, 'login').mockImplementation(() => Promise.resolve());
 
   const username = 'dbowie';
   process.env[`INPUT_USERNAME`] = username;
@@ -34,7 +29,7 @@ test('successful with username and password', async () => {
   const logout = false;
   process.env['INPUT_LOGOUT'] = String(logout);
 
-  await run();
+  await main();
 
   expect(setRegistrySpy).toHaveBeenCalledWith('');
   expect(setLogoutSpy).toHaveBeenCalledWith(logout);
@@ -45,8 +40,7 @@ test('calls docker login', async () => {
   jest.spyOn(osm, 'platform').mockImplementation(() => 'linux');
   const setRegistrySpy = jest.spyOn(stateHelper, 'setRegistry');
   const setLogoutSpy = jest.spyOn(stateHelper, 'setLogout');
-  const dockerSpy = jest.spyOn(docker, 'login');
-  dockerSpy.mockImplementation(jest.fn());
+  const dockerSpy = jest.spyOn(docker, 'login').mockImplementation(() => Promise.resolve());
 
   const username = 'dbowie';
   process.env[`INPUT_USERNAME`] = username;
@@ -63,7 +57,7 @@ test('calls docker login', async () => {
   const logout = true;
   process.env['INPUT_LOGOUT'] = String(logout);
 
-  await run();
+  await main();
 
   expect(setRegistrySpy).toHaveBeenCalledWith(registry);
   expect(setLogoutSpy).toHaveBeenCalledWith(logout);

jest.config.ts

@@ -1,10 +1,29 @@
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+
+const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'docker-login-action-')).split(path.sep).join(path.posix.sep);
+
+process.env = Object.assign({}, process.env, {
+  TEMP: tmpDir,
+  GITHUB_REPOSITORY: 'docker/login-action',
+  RUNNER_TEMP: path.join(tmpDir, 'runner-temp').split(path.sep).join(path.posix.sep),
+  RUNNER_TOOL_CACHE: path.join(tmpDir, 'runner-tool-cache').split(path.sep).join(path.posix.sep)
+}) as {
+  [key: string]: string;
+};
+
 module.exports = {
   clearMocks: true,
   moduleFileExtensions: ['js', 'ts'],
-  setupFiles: ["dotenv/config"],
   testMatch: ['**/*.test.ts'],
   transform: {
     '^.+\\.ts$': 'ts-jest'
   },
+  moduleNameMapper: {
+    '^csv-parse/sync': '<rootDir>/node_modules/csv-parse/dist/cjs/sync.cjs'
+  },
+  collectCoverageFrom: ['src/**/{!(main.ts),}.ts'],
+  coveragePathIgnorePatterns: ['lib/', 'node_modules/', '__tests__/'],
   verbose: true
-}
+};

package.json

@@ -27,28 +27,26 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.6.0",
-    "@actions/exec": "^1.1.1",
-    "@actions/io": "^1.1.2",
-    "@aws-sdk/client-ecr": "^3.53.0",
-    "@aws-sdk/client-ecr-public": "^3.53.0",
-    "http-proxy-agent": "^5.0.0",
-    "https-proxy-agent": "^5.0.1"
+    "@actions/core": "^1.10.0",
+    "@aws-sdk/client-ecr": "^3.347.1",
+    "@aws-sdk/client-ecr-public": "^3.347.1",
+    "@docker/actions-toolkit": "^0.2.0",
+    "http-proxy-agent": "^7.0.0",
+    "https-proxy-agent": "^7.0.0"
   },
   "devDependencies": {
-    "@types/node": "^16.11.26",
-    "@typescript-eslint/eslint-plugin": "^5.14.0",
-    "@typescript-eslint/parser": "^5.14.0",
-    "@vercel/ncc": "^0.33.3",
-    "dotenv": "^16.0.0",
-    "eslint": "^8.11.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-jest": "^26.1.1",
-    "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^27.2.5",
-    "prettier": "^2.3.1",
-    "ts-jest": "^27.1.2",
-    "ts-node": "^10.7.0",
-    "typescript": "^4.4.4"
+    "@types/node": "^16.18.21",
+    "@typescript-eslint/eslint-plugin": "^5.56.0",
+    "@typescript-eslint/parser": "^5.56.0",
+    "@vercel/ncc": "^0.36.1",
+    "eslint": "^8.36.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.7",
+    "ts-jest": "^29.0.5",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5"
   }
 }

src/aws.ts

@@ -96,6 +96,8 @@ export const getRegistriesData = async (registry: string, username?: string, pas
     }
     const authToken = Buffer.from(authTokenResponse.authorizationData.authorizationToken, 'base64').toString('utf-8');
     const creds = authToken.split(':', 2);
+    core.setSecret(creds[0]); // redacted in workflow logs
+    core.setSecret(creds[1]); // redacted in workflow logs
     return [
       {
         registry: 'public.ecr.aws',
@@ -122,6 +124,8 @@ export const getRegistriesData = async (registry: string, username?: string, pas
     for (const authData of authTokenResponse.authorizationData) {
       const authToken = Buffer.from(authData.authorizationToken || '', 'base64').toString('utf-8');
       const creds = authToken.split(':', 2);
+      core.setSecret(creds[0]); // redacted in workflow logs
+      core.setSecret(creds[1]); // redacted in workflow logs
       regDatas.push({
         registry: authData.proxyEndpoint || '',
         username: creds[0],

src/docker.ts

@@ -1,6 +1,6 @@
 import * as aws from './aws';
 import * as core from '@actions/core';
-import * as exec from '@actions/exec';
+import {Exec} from '@docker/actions-toolkit/lib/exec';
 
 export async function login(registry: string, username: string, password: string, ecr: string): Promise<void> {
   if (/true/i.test(ecr) || (ecr == 'auto' && aws.isECR(registry))) {
@@ -11,15 +11,13 @@ export async function login(registry: string, username: string, password: string
 }
 
 export async function logout(registry: string): Promise<void> {
-  await exec
-    .getExecOutput('docker', ['logout', registry], {
-      ignoreReturnCode: true
-    })
-    .then(res => {
-      if (res.stderr.length > 0 && res.exitCode != 0) {
-        core.warning(res.stderr.trim());
-      }
-    });
+  await Exec.getExecOutput('docker', ['logout', registry], {
+    ignoreReturnCode: true
+  }).then(res => {
+    if (res.stderr.length > 0 && res.exitCode != 0) {
+      core.warning(res.stderr.trim());
+    }
+  });
 }
 
 export async function loginStandard(registry: string, username: string, password: string): Promise<void> {
@@ -36,18 +34,16 @@ export async function loginStandard(registry: string, username: string, password
   } else {
     core.info(`Logging into Docker Hub...`);
   }
-  await exec
-    .getExecOutput('docker', loginArgs, {
-      ignoreReturnCode: true,
-      silent: true,
-      input: Buffer.from(password)
-    })
-    .then(res => {
-      if (res.stderr.length > 0 && res.exitCode != 0) {
-        throw new Error(res.stderr.trim());
-      }
-      core.info(`Login Succeeded!`);
-    });
+  await Exec.getExecOutput('docker', loginArgs, {
+    ignoreReturnCode: true,
+    silent: true,
+    input: Buffer.from(password)
+  }).then(res => {
+    if (res.stderr.length > 0 && res.exitCode != 0) {
+      throw new Error(res.stderr.trim());
+    }
+    core.info(`Login Succeeded!`);
+  });
 }
 
 export async function loginECR(registry: string, username: string, password: string): Promise<void> {
@@ -55,17 +51,15 @@ export async function loginECR(registry: string, username: string, password: str
   const regDatas = await aws.getRegistriesData(registry, username, password);
   for (const regData of regDatas) {
     core.info(`Logging into ${regData.registry}...`);
-    await exec
-      .getExecOutput('docker', ['login', '--password-stdin', '--username', regData.username, regData.registry], {
-        ignoreReturnCode: true,
-        silent: true,
-        input: Buffer.from(regData.password)
-      })
-      .then(res => {
-        if (res.stderr.length > 0 && res.exitCode != 0) {
-          throw new Error(res.stderr.trim());
-        }
-        core.info('Login Succeeded!');
-      });
+    await Exec.getExecOutput('docker', ['login', '--password-stdin', '--username', regData.username, regData.registry], {
+      ignoreReturnCode: true,
+      silent: true,
+      input: Buffer.from(regData.password)
+    }).then(res => {
+      if (res.stderr.length > 0 && res.exitCode != 0) {
+        throw new Error(res.stderr.trim());
+      }
+      core.info('Login Succeeded!');
+    });
   }
 }

src/main.ts

@@ -1,28 +1,21 @@
-import * as core from '@actions/core';
+import * as actionsToolkit from '@docker/actions-toolkit';
+
 import * as context from './context';
 import * as docker from './docker';
 import * as stateHelper from './state-helper';
 
-export async function run(): Promise<void> {
-  try {
-    const input: context.Inputs = context.getInputs();
-    stateHelper.setRegistry(input.registry);
-    stateHelper.setLogout(input.logout);
-    await docker.login(input.registry, input.username, input.password, input.ecr);
-  } catch (error) {
-    core.setFailed(error.message);
-  }
+export async function main(): Promise<void> {
+  const input: context.Inputs = context.getInputs();
+  stateHelper.setRegistry(input.registry);
+  stateHelper.setLogout(input.logout);
+  await docker.login(input.registry, input.username, input.password, input.ecr);
 }
 
-async function logout(): Promise<void> {
+async function post(): Promise<void> {
   if (!stateHelper.logout) {
     return;
   }
   await docker.logout(stateHelper.registry);
 }
 
-if (!stateHelper.IsPost) {
-  run();
-} else {
-  logout();
-}
+actionsToolkit.run(main, post);

src/state-helper.ts

@@ -1,6 +1,5 @@
 import * as core from '@actions/core';
 
-export const IsPost = !!process.env['STATE_isPost'];
 export const registry = process.env['STATE_registry'] || '';
 export const logout = /true/i.test(process.env['STATE_logout'] || '');
 
@@ -11,7 +10,3 @@ export function setRegistry(registry: string) {
 export function setLogout(logout: boolean) {
   core.saveState('logout', logout);
 }
-
-if (!IsPost) {
-  core.saveState('isPost', 'true');
-}

tsconfig.json

@@ -1,19 +1,21 @@
 {
   "compilerOptions": {
+    "esModuleInterop": true,
     "target": "es6",
     "module": "commonjs",
+    "strict": true,
     "newLine": "lf",
     "outDir": "./lib",
     "rootDir": "./src",
-    "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
-    "strict": true,
     "noImplicitAny": false,
+    "resolveJsonModule": true,
     "useUnknownInCatchVariables": false,
   },
   "exclude": [
+    "./__tests__/**/*",
+    "./lib/**/*",
     "node_modules",
-    "**/*.test.ts",
     "jest.config.ts"
   ]
 }