better assertions

Author: lerouxb

packages/compass-smoke-tests/src/installers/mac-dmg.ts

@@ -1,5 +1,9 @@
 import path from 'node:path';
 import fs from 'node:fs';
+import {
+  assertFileNotQuarantined,
+  removeApplicationSupportForApp,
+} from './mac-utils';
 
 import type { InstalledAppInfo, InstallablePackage } from './types';
 import { execute } from '../execute';
@@ -24,27 +28,9 @@ export function installMacDMG({
     execute('hdiutil', ['detach', volumePath]);
   }
 
-  // TODO: Consider instrumenting the app to use a settings directory in the sandbox
-  // TODO: Move this somewhere shared between mac installers
-  if (process.env.HOME) {
-    const settingsDir = path.resolve(
-      process.env.HOME,
-      'Library',
-      'Application Support',
-      appName
-    );
+  removeApplicationSupportForApp(appName);
 
-    if (fs.existsSync(settingsDir)) {
-      console.log(`${settingsDir} already exists. Removing.`);
-      fs.rmSync(settingsDir, { recursive: true });
-    }
-  }
-
-  execute('xattr', ['-dr', 'com.apple.quarantine', appPath]);
-
-  // see if the executable will run without being quarantined or similar
-  // TODO: Move this somewhere shared between mac installers
-  execute(path.resolve(appPath, 'Contents/MacOS', appName), ['--version']);
+  assertFileNotQuarantined(appPath);
 
   return {
     appPath: appPath,

packages/compass-smoke-tests/src/installers/mac-utils.ts

@@ -0,0 +1,42 @@
+import assert from 'node:assert/strict';
+import { execSync } from 'node:child_process';
+import fs from 'node:fs';
+import path from 'node:path';
+
+// TODO: Consider instrumenting the app to use a settings directory in the sandbox
+export function removeApplicationSupportForApp(appName: string) {
+  assert(typeof process.env.HOME === 'string', 'HOME env var not set');
+
+  const settingsDir = path.resolve(
+    process.env.HOME,
+    'Library',
+    'Application Support',
+    appName
+  );
+
+  if (fs.existsSync(settingsDir)) {
+    console.log(`${settingsDir} already exists. Removing.`);
+    fs.rmSync(settingsDir, { recursive: true });
+  }
+}
+
+export function assertFileNotQuarantined(appPath: string) {
+  try {
+    execSync(`xattr -p com.apple.quarantine "${appPath}"`, {
+      encoding: 'utf8',
+    });
+    assert.fail(`Expected no com.apple.quarantine attr on ${appPath}`);
+  } catch (err: unknown) {
+    assert(
+      typeof err === 'object' &&
+        err !== null &&
+        'message' in err &&
+        typeof err.message === 'string',
+      'Expected err to be an error'
+    );
+    assert(
+      /No such xattr/.test(err.message),
+      `Expected no com.apple.quarantine attr on ${appPath}`
+    );
+  }
+}

packages/compass-smoke-tests/src/installers/mac-zip.ts

@@ -1,6 +1,8 @@
 import path from 'node:path';
-import fs from 'node:fs';
-
+import {
+  assertFileNotQuarantined,
+  removeApplicationSupportForApp,
+} from './mac-utils';
 import type { InstalledAppInfo, InstallablePackage } from './types';
 import { execute } from '../execute';
 
@@ -14,27 +16,9 @@ export function installMacZIP({
 
   execute('ditto', ['-xk', filepath, destinationPath]);
 
-  // TODO: Consider instrumenting the app to use a settings directory in the sandbox
-  // TODO: Move this somewhere shared between mac installers
-  if (process.env.HOME) {
-    const settingsDir = path.resolve(
-      process.env.HOME,
-      'Library',
-      'Application Support',
-      appName
-    );
-
-    if (fs.existsSync(settingsDir)) {
-      console.log(`${settingsDir} already exists. Removing.`);
-      fs.rmSync(settingsDir, { recursive: true });
-    }
-  }
-
-  execute('xattr', ['-dr', 'com.apple.quarantine', appPath]);
+  removeApplicationSupportForApp(appName);
 
-  // see if the executable will run without being quarantined or similar
-  // TODO: Move this somewhere shared between mac installers
-  execute(path.resolve(appPath, 'Contents/MacOS', appName), ['--version']);
+  assertFileNotQuarantined(appPath);
 
   return {
     appPath: appPath,