Merge pull request #77 from crazy-max/exec-output

Use built-in `getExecOutput`
docker · Jun 22, 2021 · 9e433e1 · 9e433e1
2 parents 4608add + 39efbd2
commit 9e433e1
Show file tree

Hide file tree

Showing 5 changed files with 107 additions and 170 deletions.
diff --git a/__tests__/docker.test.ts b/__tests__/docker.test.ts
@@ -7,9 +7,14 @@ import * as exec from '@actions/exec';
 process.env['RUNNER_TEMP'] = path.join(__dirname, 'runner');
 
 test('loginStandard calls exec', async () => {
-  const execSpy: jest.SpyInstance = jest.spyOn(exec, 'exec');
-  // don't let exec try to actually run the commands
-  execSpy.mockImplementation(() => {});
+  const execSpy: jest.SpyInstance = jest.spyOn(exec, 'getExecOutput');
+  execSpy.mockImplementation(() =>
+    Promise.resolve({
+      exitCode: expect.any(Number),
+      stdout: expect.any(Function),
+      stderr: expect.any(Function)
+    })
+  );
 
   const username: string = 'dbowie';
   const password: string = 'groundcontrol';
@@ -20,30 +25,25 @@ test('loginStandard calls exec', async () => {
   expect(execSpy).toHaveBeenCalledWith(`docker`, ['login', '--password-stdin', '--username', username, registry], {
     input: Buffer.from(password),
     silent: true,
-    ignoreReturnCode: true,
-    listeners: expect.objectContaining({
-      stdout: expect.any(Function),
-      stderr: expect.any(Function)
-    })
+    ignoreReturnCode: true
   });
 });
 
 test('logout calls exec', async () => {
-  const execSpy: jest.SpyInstance = jest.spyOn(exec, 'exec');
-  // don't let exec try to actually run the commands
-  execSpy.mockImplementation(() => {});
+  const execSpy: jest.SpyInstance = jest.spyOn(exec, 'getExecOutput');
+  execSpy.mockImplementation(() =>
+    Promise.resolve({
+      exitCode: expect.any(Number),
+      stdout: expect.any(Function),
+      stderr: expect.any(Function)
+    })
+  );
 
   const registry: string = 'https://ghcr.io';
 
   await logout(registry);
 
   expect(execSpy).toHaveBeenCalledWith(`docker`, ['logout', registry], {
-    silent: false,
-    ignoreReturnCode: true,
-    input: Buffer.from(''),
-    listeners: expect.objectContaining({
-      stdout: expect.any(Function),
-      stderr: expect.any(Function)
-    })
+    ignoreReturnCode: true
   });
 });
diff --git a/dist/index.js b/dist/index.js
diff --git a/src/aws.ts b/src/aws.ts
@@ -1,6 +1,6 @@
 import * as semver from 'semver';
+import * as exec from '@actions/exec';
 import * as io from '@actions/io';
-import * as execm from './exec';
 
 const ecrRegistryRegex = /^(([0-9]{12})\.dkr\.ecr\.(.+)\.amazonaws\.com(.cn)?)(\/([^:]+)(:.+)?)?$/;
 
@@ -43,15 +43,20 @@ export const getCLI = async (): Promise<string> => {
 };
 
 export const execCLI = async (args: string[]): Promise<string> => {
-  return execm.exec(await getCLI(), args, true).then(res => {
-    if (res.stderr != '' && !res.success) {
-      throw new Error(res.stderr);
-    } else if (res.stderr != '') {
-      return res.stderr.trim();
-    } else {
-      return res.stdout.trim();
-    }
-  });
+  return exec
+    .getExecOutput(await getCLI(), args, {
+      ignoreReturnCode: true,
+      silent: true
+    })
+    .then(res => {
+      if (res.stderr.length > 0 && res.exitCode != 0) {
+        throw new Error(res.stderr.trim());
+      } else if (res.stderr.length > 0) {
+        return res.stderr.trim();
+      } else {
+        return res.stdout.trim();
+      }
+    });
 };
 
 export const getCLIVersion = async (): Promise<string> => {

diff --git a/src/docker.ts b/src/docker.ts
@@ -1,6 +1,6 @@
-import * as core from '@actions/core';
 import * as aws from './aws';
-import * as execm from './exec';
+import * as core from '@actions/core';
+import * as exec from '@actions/exec';
 
 export async function login(registry: string, username: string, password: string): Promise<void> {
   if (await aws.isECR(registry)) {
@@ -11,11 +11,15 @@ export async function login(registry: string, username: string, password: string
 }
 
 export async function logout(registry: string): Promise<void> {
-  await execm.exec('docker', ['logout', registry], false).then(res => {
-    if (res.stderr != '' && !res.success) {
-      core.warning(res.stderr);
-    }
-  });
+  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> {
@@ -32,12 +36,18 @@ export async function loginStandard(registry: string, username: string, password
   } else {
     core.info(`Logging into Docker Hub...`);
   }
-  await execm.exec('docker', loginArgs, true, password).then(res => {
-    if (res.stderr != '' && !res.success) {
-      throw new Error(res.stderr);
-    }
-    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> {
@@ -60,15 +70,20 @@ export async function loginECR(registry: string, username: string, password: str
 
   core.info(`Logging into ${registry}...`);
   loginCmds.forEach((loginCmd, index) => {
-    execm.exec(loginCmd, [], true).then(res => {
-      if (res.stderr != '' && !res.success) {
-        throw new Error(res.stderr);
-      }
-      if (loginCmds.length > 1) {
-        core.info(`Login Succeeded! (${index}/${loginCmds.length})`);
-      } else {
-        core.info('Login Succeeded!');
-      }
-    });
+    exec
+      .getExecOutput(loginCmd, [], {
+        ignoreReturnCode: true,
+        silent: true
+      })
+      .then(res => {
+        if (res.stderr.length > 0 && res.exitCode != 0) {
+          throw new Error(res.stderr.trim());
+        }
+        if (loginCmds.length > 1) {
+          core.info(`Login Succeeded! (${index}/${loginCmds.length})`);
+        } else {
+          core.info('Login Succeeded!');
+        }
+      });
   });
 }
diff --git a/src/exec.ts b/src/exec.ts