promisified async spawn helper rather

Author: lerouxb

packages/compass-e2e-tests/installers/helpers.ts

@@ -1,19 +1,44 @@
-import type { SpawnSyncReturns } from 'child_process';
+import { spawn } from 'child_process';
+import type { SpawnOptions } from 'child_process';
 
-export function assertSpawnSyncResult(
-  result: SpawnSyncReturns<string>,
-  name: string
-) {
-  if (result.status === null) {
-    if (result.signal !== null) {
-      throw new Error(`${name} terminated due to signal ${result.signal}`);
-    }
-
-    // not supposed to be possible to get here, but just in case
-    throw new Error(`${name} terminated with no status or signal`);
-  }
-
-  if (result.status !== 0) {
-    throw new Error(`${name} failed with exit code ${result.status}`);
-  }
+export function execute(
+  command: string,
+  args: string[],
+  options?: SpawnOptions
+): Promise<void> {
+  return new Promise((resolve, reject) => {
+    const p = spawn(command, args, {
+      stdio: 'inherit',
+      ...options,
+    });
+    p.on('error', (err: any) => {
+      reject(err);
+    });
+    p.on('close', (code: number | null, signal: NodeJS.Signals | null) => {
+      if (code !== null) {
+        if (code === 0) {
+          resolve();
+        } else {
+          reject(
+            new Error(`${command} ${args.join(' ')} exited with code ${code}`)
+          );
+        }
+      } else {
+        if (signal !== null) {
+          reject(
+            new Error(
+              `${command} ${args.join(' ')} exited with signal ${signal}`
+            )
+          );
+        } else {
+          // shouldn't happen
+          reject(
+            new Error(
+              `${command} ${args.join(' ')} exited with no code or signal`
+            )
+          );
+        }
+      }
+    });
+  });
 }

packages/compass-e2e-tests/installers/mac-dmg.ts

@@ -1,19 +1,6 @@
 import { existsSync } from 'fs';
-import { assertSpawnSyncResult } from './helpers';
 import type { InstalledAppInfo, Package } from './types';
-import { spawnSync } from 'child_process';
-
-function exec(command: string, args: string[]) {
-  console.log(command, ...args);
-
-  assertSpawnSyncResult(
-    spawnSync(command, args, {
-      encoding: 'utf8',
-      stdio: 'inherit',
-    }),
-    `${command} ${args.join(' ')}`
-  );
-}
+import { execute } from './helpers';
 
 export async function installMacDMG(
   appName: string,
@@ -25,11 +12,15 @@ export async function installMacDMG(
     throw new Error(`${fullDestinationPath} already exists`);
   }
 
-  exec('hdiutil', ['attach', filepath]);
+  await execute('hdiutil', ['attach', filepath]);
   try {
-    exec('cp', ['-r', `/Volumes/${appName}/${appName}.app`, '/Applications']);
+    await execute('cp', [
+      '-r',
+      `/Volumes/${appName}/${appName}.app`,
+      '/Applications',
+    ]);
   } finally {
-    exec('hdiutil', ['detach', `/Volumes/${appName}`]);
+    await execute('hdiutil', ['detach', `/Volumes/${appName}`]);
   }
 
   return Promise.resolve({

packages/compass-e2e-tests/smoke-test.ts

@@ -1,5 +1,4 @@
 #!/usr/bin/env npx ts-node
-import { spawnSync } from 'child_process';
 import { createWriteStream, existsSync, promises as fs } from 'fs';
 import path from 'path';
 import yargs from 'yargs';
@@ -10,7 +9,7 @@ import { pick } from 'lodash';
 import { handler as writeBuildInfo } from 'hadron-build/commands/info';
 import type { InstalledAppInfo, Package } from './installers/types';
 import { installMacDMG } from './installers/mac-dmg';
-import { assertSpawnSyncResult } from './installers/helpers';
+import { execute } from './installers/helpers';
 
 const argv = yargs(hideBin(process.argv))
   .scriptName('smoke-tests')
@@ -183,7 +182,7 @@ async function run() {
 
     if (appInfo) {
       console.log('testing', appInfo.appPath);
-      testInstalledApp(appInfo);
+      await testInstalledApp(appInfo);
     } else {
       console.log(`no app got installed for ${pkg.filename}`);
     }
@@ -366,8 +365,8 @@ function verifyPackagesExist(packages: Package[]): void {
   }
 }
 
-function testInstalledApp(appInfo: InstalledAppInfo) {
-  const result = spawnSync(
+function testInstalledApp(appInfo: InstalledAppInfo): Promise<void> {
+  return execute(
     'npm',
     [
       'run',
@@ -379,17 +378,13 @@ function testInstalledApp(appInfo: InstalledAppInfo) {
       '--test-filter=time-to-first-query',
     ],
     {
-      encoding: 'utf8',
-      stdio: 'inherit',
       env: {
         ...process.env,
         COMPASS_APP_NAME: appInfo.appName,
         COMPASS_APP_PATH: appInfo.appPath,
       },
     }
   );
-
-  assertSpawnSyncResult(result, 'npm run test-packaged');
 }
 
 run()