Merge c7540347e9 into 292fe2d7ee

Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>

__tests__/context.test.ts

@@ -1,6 +1,17 @@
-import {expect, test} from 'vitest';
+import {afterEach, expect, test} from 'vitest';
+import * as path from 'path';
 
-import {getInputs} from '../src/context.js';
+import {Buildx} from '@docker/actions-toolkit/lib/buildx/buildx.js';
+
+import {getAuthList, getInputs} from '../src/context.js';
+
+afterEach(() => {
+  for (const key of Object.keys(process.env)) {
+    if (key.startsWith('INPUT_')) {
+      delete process.env[key];
+    }
+  }
+});
 
 test('with password and username getInputs does not throw error', async () => {
   process.env['INPUT_USERNAME'] = 'dbowie';
@@ -10,3 +21,15 @@ test('with password and username getInputs does not throw error', async () => {
     getInputs();
   }).not.toThrow();
 });
+
+test('getAuthList uses the default Docker Hub registry when computing scoped config dir', async () => {
+  process.env['INPUT_USERNAME'] = 'dbowie';
+  process.env['INPUT_PASSWORD'] = 'groundcontrol';
+  process.env['INPUT_SCOPE'] = 'myscope';
+  process.env['INPUT_LOGOUT'] = 'false';
+  const [auth] = getAuthList(getInputs());
+  expect(auth).toMatchObject({
+    registry: 'docker.io',
+    configDir: path.join(Buildx.configDir, 'config', 'registry-1.docker.io', 'myscope')
+  });
+});

__tests__/docker.test.ts

@@ -1,26 +1,27 @@
-import {expect, test, vi} from 'vitest';
-import * as path from 'path';
+import {afterEach, beforeEach, expect, test, vi} from 'vitest';
 
 import {Docker} from '@docker/actions-toolkit/lib/docker/docker.js';
 
 import {loginStandard, logout} from '../src/docker.js';
 
-process.env['RUNNER_TEMP'] = path.join(__dirname, 'runner');
+beforeEach(() => {
+  delete process.env.DOCKER_LOGIN_SKIP_IF_MISSING_CREDS;
+});
+
+afterEach(() => {
+  delete process.env.DOCKER_LOGIN_SKIP_IF_MISSING_CREDS;
+});
 
 test('loginStandard calls exec', async () => {
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore
-  const execSpy = vi.spyOn(Docker, 'getExecOutput').mockImplementation(async () => {
-    return {
-      exitCode: expect.any(Number),
-      stdout: expect.any(Function),
-      stderr: expect.any(Function)
-    };
+  const execSpy = vi.spyOn(Docker, 'getExecOutput').mockResolvedValue({
+    exitCode: 0,
+    stdout: '',
+    stderr: ''
   });
 
   const username = 'dbowie';
   const password = 'groundcontrol';
-  const registry = 'https://ghcr.io';
+  const registry = 'ghcr.io';
 
   await loginStandard(registry, username, password);
 
@@ -30,6 +31,7 @@ test('loginStandard calls exec', async () => {
     // we don't want to check env opt
     callfunc[1].env = undefined;
   }
+
   expect(execSpy).toHaveBeenCalledWith(['login', '--password-stdin', '--username', username, registry], {
     input: Buffer.from(password),
     silent: true,
@@ -37,27 +39,68 @@ test('loginStandard calls exec', async () => {
   });
 });
 
+test('loginStandard throws if username and password are missing', () => {
+  const execSpy = vi.spyOn(Docker, 'getExecOutput');
+  const login = loginStandard('ghcr.io', '', '');
+  expect(execSpy).not.toHaveBeenCalled();
+  return expect(login).rejects.toThrow('Username and password required');
+});
+
+test('loginStandard throws if username is missing', () => {
+  const execSpy = vi.spyOn(Docker, 'getExecOutput');
+  const login = loginStandard('ghcr.io', '', 'groundcontrol');
+  expect(execSpy).not.toHaveBeenCalled();
+  return expect(login).rejects.toThrow('Username required');
+});
+
+test('loginStandard throws if password is missing', () => {
+  const execSpy = vi.spyOn(Docker, 'getExecOutput');
+  const login = loginStandard('ghcr.io', 'dbowie', '');
+  expect(execSpy).not.toHaveBeenCalled();
+  return expect(login).rejects.toThrow('Password required');
+});
+
+test('loginStandard skips if both credentials are missing and env opt-in is enabled', () => {
+  process.env.DOCKER_LOGIN_SKIP_IF_MISSING_CREDS = 'true';
+  const execSpy = vi.spyOn(Docker, 'getExecOutput');
+  const login = loginStandard('ghcr.io', '', '');
+  expect(execSpy).not.toHaveBeenCalled();
+  return expect(login).resolves.toBeUndefined();
+});
+
+test('loginStandard skips if username is missing and env opt-in is enabled', () => {
+  process.env.DOCKER_LOGIN_SKIP_IF_MISSING_CREDS = 'true';
+  const execSpy = vi.spyOn(Docker, 'getExecOutput');
+  const login = loginStandard('ghcr.io', '', 'groundcontrol');
+  expect(execSpy).not.toHaveBeenCalled();
+  return expect(login).resolves.toBeUndefined();
+});
+
+test('loginStandard skips if password is missing and env opt-in is enabled', () => {
+  process.env.DOCKER_LOGIN_SKIP_IF_MISSING_CREDS = 'true';
+  const execSpy = vi.spyOn(Docker, 'getExecOutput');
+  const login = loginStandard('ghcr.io', 'dbowie', '');
+  expect(execSpy).not.toHaveBeenCalled();
+  return expect(login).resolves.toBeUndefined();
+});
+
 test('logout calls exec', async () => {
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore
-  const execSpy = vi.spyOn(Docker, 'getExecOutput').mockImplementation(async () => {
-    return {
-      exitCode: expect.any(Number),
-      stdout: expect.any(Function),
-      stderr: expect.any(Function)
-    };
+  const execSpy = vi.spyOn(Docker, 'getExecOutput').mockResolvedValue({
+    exitCode: 0,
+    stdout: '',
+    stderr: ''
   });
 
-  const registry = 'https://ghcr.io';
-
+  const registry = 'ghcr.io';
   await logout(registry, '');
-
   expect(execSpy).toHaveBeenCalledTimes(1);
+
   const callfunc = execSpy.mock.calls[0];
   if (callfunc && callfunc[1]) {
     // we don't want to check env opt
     callfunc[1].env = undefined;
   }
+
   expect(execSpy).toHaveBeenCalledWith(['logout', registry], {
     ignoreReturnCode: true
   });

src/context.ts

@@ -42,24 +42,26 @@ export function getAuthList(inputs: Inputs): Array<Auth> {
   }
   let auths: Array<Auth> = [];
   if (!inputs.registryAuth) {
+    const registry = inputs.registry || 'docker.io';
     auths.push({
-      registry: inputs.registry || 'docker.io',
+      registry,
       username: inputs.username,
       password: inputs.password,
       scope: inputs.scope,
       ecr: inputs.ecr || 'auto',
-      configDir: scopeToConfigDir(inputs.registry, inputs.scope)
+      configDir: scopeToConfigDir(registry, inputs.scope)
     });
   } else {
     auths = (yaml.load(inputs.registryAuth) as Array<Auth>).map(auth => {
       core.setSecret(auth.password); // redacted in workflow logs
+      const registry = auth.registry || 'docker.io';
       return {
-        registry: auth.registry || 'docker.io',
+        registry,
         username: auth.username,
         password: auth.password,
         scope: auth.scope,
         ecr: auth.ecr || 'auto',
-        configDir: scopeToConfigDir(auth.registry || 'docker.io', auth.scope)
+        configDir: scopeToConfigDir(registry, auth.scope)
       };
     });
   }

src/docker.ts

@@ -1,6 +1,7 @@
 import * as core from '@actions/core';
 
 import {Docker} from '@docker/actions-toolkit/lib/docker/docker.js';
+import {Util} from '@docker/actions-toolkit/lib/util.js';
 
 import * as aws from './aws.js';
 import * as context from './context.js';
@@ -34,6 +35,10 @@ export async function logout(registry: string, configDir: string): Promise<void>
 }
 
 export async function loginStandard(registry: string, username: string, password: string, scope?: string): Promise<void> {
+  if ((!username || !password) && skipLoginIfMissingCredsEnabled()) {
+    core.info(`Skipping login to ${registry}. Username or password is not set and DOCKER_LOGIN_SKIP_IF_MISSING_CREDS is enabled.`);
+    return;
+  }
   if (!username && !password) {
     throw new Error('Username and password required');
   }
@@ -79,3 +84,10 @@ async function loginExec(registry: string, username: string, password: string, s
     core.info('Login Succeeded!');
   });
 }
+
+function skipLoginIfMissingCredsEnabled(): boolean {
+  if (process.env.DOCKER_LOGIN_SKIP_IF_MISSING_CREDS) {
+    return Util.parseBool(process.env.DOCKER_LOGIN_SKIP_IF_MISSING_CREDS);
+  }
+  return false;
+}

yarn.lock

@@ -3639,9 +3639,9 @@ __metadata:
   linkType: hard
 
 "flatted@npm:^3.2.9":
-  version: 3.3.3
-  resolution: "flatted@npm:3.3.3"
-  checksum: 10/8c96c02fbeadcf4e8ffd0fa24983241e27698b0781295622591fc13585e2f226609d95e422bcf2ef044146ffacb6b68b1f20871454eddf75ab3caa6ee5f4a1fe
+  version: 3.4.2
+  resolution: "flatted@npm:3.4.2"
+  checksum: 10/a9e78fe5c2c1fcd98209a015ccee3a6caa953e01729778e83c1fe92e68601a63e1e69cd4e573010ca99eaf585a581b80ccf1018b99283e6cbc2117bcba1e030f
   languageName: node
   linkType: hard