Use getExecOutput for gcloud commands (#279)

Crafting our own buffers is more efficient, but we have to actually flush those buffers before reading, to ensure we have 100% of the output. This is error prone and incredibly verbose. Using `getExecOutput` instead sacrifices a negligible performance overhead for a much less callback-y design.

Author: sethvargo

.github/workflows/unit.yml

@@ -17,6 +17,7 @@ jobs:
     name: 'unit'
     runs-on: '${{ matrix.os }}'
     strategy:
+      fail-fast: false
       matrix:
         os:
         - 'ubuntu-latest'

src/deploy-cloudrun.ts

@@ -15,7 +15,7 @@
  */
 
 import * as core from '@actions/core';
-import { exec } from '@actions/exec';
+import { getExecOutput } from '@actions/exec';
 import * as toolCache from '@actions/tool-cache';
 import * as setupGcloud from '@google-github-actions/setup-cloud-sdk';
 import path from 'path';
@@ -186,37 +186,20 @@ export async function run(): Promise<void> {
     }
 
     const toolCommand = setupGcloud.getToolCommand();
+    const options = { silent: true };
+    const commandString = `${toolCommand} ${cmd.join(' ')}`;
+    core.info(`Running: ${commandString}`);
 
-    // Get output of gcloud cmd.
-    let output = '';
-    const stdout = (data: Buffer): void => {
-      output += data.toString();
-    };
-    let errOutput = '';
-    const stderr = (data: Buffer): void => {
-      errOutput += data.toString();
-    };
-
-    const options = {
-      listeners: {
-        stderr,
-        stdout,
-      },
-      silent: true,
-    };
-    core.info(`running: ${toolCommand} ${cmd.join(' ')}`);
     // Run gcloud cmd.
-    try {
-      await exec(toolCommand, cmd, options);
-      // Set url as output.
-      setUrlOutput(output + errOutput);
-    } catch (error) {
-      if (errOutput) {
-        throw new Error(errOutput);
-      } else {
-        throw new Error(convertUnknown(error));
-      }
+    const output = await getExecOutput(toolCommand, cmd, options);
+    if (output.exitCode !== 0) {
+      const errMsg = output.stderr || `command exited ${output.exitCode}, but stderr had no output`;
+      throw new Error(`failed to execute gcloud command \`${commandString}\`: ${errMsg}`);
     }
+
+    // gcloud outputs status information to stderr.
+    // TODO: update this to use JSON or YAML machine-readable output instead.
+    setUrlOutput(output.stdout + output.stderr);
   } catch (error) {
     core.setFailed(convertUnknown(error));
   }

tests/e2e.test.ts

@@ -16,7 +16,7 @@
 
 import { expect } from 'chai';
 import { GoogleAuth } from 'google-auth-library';
-import { exec } from '@actions/exec';
+import { getExecOutput } from '@actions/exec';
 import * as _ from 'lodash';
 import 'mocha';
 import { run_v1 } from 'googleapis';
@@ -52,18 +52,7 @@ describe('E2E tests', function () {
     }
     toolCommand = 'gcloud';
     if (SERVICE) {
-      sleep(10000);
       // get Service yaml
-      let output = '';
-      const stdout = (data: Buffer): void => {
-        output += data.toString();
-      };
-      const options = {
-        listeners: {
-          stdout,
-        },
-        silent: true,
-      };
       let cmd = [
         'run',
         'services',
@@ -76,8 +65,17 @@ describe('E2E tests', function () {
         '--region',
         'us-central1',
       ];
-      await exec(toolCommand, cmd, options);
-      service = yaml.load(output) as run_v1.Schema$Service;
+
+      const options = { silent: true };
+      const commandString = `${toolCommand} ${cmd.join(' ')}`;
+      const output = await getExecOutput(toolCommand, cmd, options);
+      if (output.exitCode !== 0) {
+        const errMsg =
+          output.stderr || `command exited ${output.exitCode}, but stderr had no output`;
+        throw new Error(`failed to execute gcloud command \`${commandString}\`: ${errMsg}`);
+      }
+
+      service = yaml.load(output.stdout) as run_v1.Schema$Service;
       if (!service) console.log('no service found');
     }
   });
@@ -207,17 +205,8 @@ describe('E2E tests', function () {
       let attempt = 0;
       let revisions = [];
       while (attempt < max && revisions.length < parseInt(COUNT)) {
-        await sleep(1000);
-        let output = '';
-        const stdout = (data: Buffer): void => {
-          output += data.toString();
-        };
-        const options = {
-          listeners: {
-            stdout,
-          },
-          silent: true,
-        };
+        await sleep(1000 * attempt);
+
         let cmd = [
           'run',
           'revisions',
@@ -231,8 +220,17 @@ describe('E2E tests', function () {
           '--region',
           'us-central1',
         ];
-        await exec(toolCommand, cmd, options);
-        revisions = JSON.parse(output);
+
+        const options = { silent: true };
+        const commandString = `${toolCommand} ${cmd.join(' ')}`;
+
+        const output = await getExecOutput(toolCommand, cmd, options);
+        if (output.exitCode !== 0) {
+          const errMsg =
+            output.stderr || `command exited ${output.exitCode}, but stderr had no output`;
+          throw new Error(`failed to execute gcloud command \`${commandString}\`: ${errMsg}`);
+        }
+        revisions = JSON.parse(output.stdout);
       }
 
       expect(revisions.length).to.equal(parseInt(COUNT));