feat(smoke-tests): test MSI installer for on Windows COMPASS-8707 (#6640)

* Add skipCleanup option

* Throw ExecuteFailure with status and signal

* Add MSI installer

* Update CI to run windows_msi

Author: kraenhansen

.evergreen/functions.yml

@@ -668,9 +668,8 @@ functions:
           eval $(.evergreen/print-compass-env.sh)
 
           if [[ "$IS_WINDOWS" == "true" ]]; then
-            # TODO: windows_setup
-            # TODO: windows_msi
             npm run --unsafe-perm --workspace @mongodb-js/compass-smoke-tests start -- --package=windows_zip
+            npm run --unsafe-perm --workspace @mongodb-js/compass-smoke-tests start -- --package=windows_msi
           fi
 
           if [[ "$IS_OSX" == "true" ]]; then

packages/compass-smoke-tests/src/cli.ts

@@ -20,6 +20,7 @@ import { type SmokeTestsContext } from './context';
 import { installMacDMG } from './installers/mac-dmg';
 import { installMacZIP } from './installers/mac-zip';
 import { installWindowsZIP } from './installers/windows-zip';
+import { installWindowsMSI } from './installers/windows-msi';
 
 const SUPPORTED_PLATFORMS = ['win32', 'darwin', 'linux'] as const;
 const SUPPORTED_ARCHS = ['x64', 'arm64'] as const;
@@ -98,6 +99,11 @@ const argv = yargs(hideBin(process.argv))
   .option('localPackage', {
     type: 'boolean',
     description: 'Use the local package instead of downloading',
+  })
+  .option('skipCleanup', {
+    type: 'boolean',
+    description: 'Do not delete the sandbox after a run',
+    default: false,
   });
 
 type TestSubject = PackageDetails & {
@@ -154,6 +160,8 @@ function getInstaller(kind: PackageKind) {
     return installMacZIP;
   } else if (kind === 'windows_zip') {
     return installWindowsZIP;
+  } else if (kind === 'windows_msi') {
+    return installWindowsMSI;
   } else {
     throw new Error(`Installer for '${kind}' is not yet implemented`);
   }
@@ -195,8 +203,12 @@ async function run() {
       await uninstall();
     }
   } finally {
-    console.log('Cleaning up sandbox');
-    fs.rmSync(context.sandboxPath, { recursive: true });
+    if (context.skipCleanup) {
+      console.log(`Skipped cleaning up sandbox: ${context.sandboxPath}`);
+    } else {
+      console.log(`Cleaning up sandbox: ${context.sandboxPath}`);
+      fs.rmSync(context.sandboxPath, { recursive: true });
+    }
   }
 }
 

packages/compass-smoke-tests/src/context.ts

@@ -9,4 +9,5 @@ export type SmokeTestsContext = {
   forceDownload?: boolean;
   localPackage?: boolean;
   sandboxPath: string;
+  skipCleanup: boolean;
 };

packages/compass-smoke-tests/src/execute.ts

@@ -1,6 +1,19 @@
-import assert from 'node:assert/strict';
 import { spawnSync, type SpawnOptions } from 'node:child_process';
 
+export class ExecuteFailure extends Error {
+  constructor(
+    public command: string,
+    public args: string[],
+    public status: number | null,
+    public signal: NodeJS.Signals | null
+  ) {
+    const commandDetails = `${command} ${args.join(' ')}`;
+    const statusDetails = `status = ${status || 'null'}`;
+    const signalDetails = `signal = ${signal || 'null'})`;
+    super(`${commandDetails} exited with ${statusDetails} ${signalDetails}`);
+  }
+}
+
 export function execute(
   command: string,
   args: string[],
@@ -10,10 +23,7 @@ export function execute(
     stdio: 'inherit',
     ...options,
   });
-  assert(
-    status === 0 && signal === null,
-    `${command} ${args.join(' ')} exited with (status = ${
-      status || 'null'
-    }, signal = ${signal || 'null'})`
-  );
+  if (status !== 0 || signal !== null) {
+    throw new ExecuteFailure(command, args, status, signal);
+  }
 }

packages/compass-smoke-tests/src/installers/types.ts

@@ -16,5 +16,5 @@ export type InstallablePackage = {
 
 export type InstalledAppInfo = {
   appPath: string;
-  uninstall: () => Promise<void>;
+  uninstall: () => void | Promise<void>;
 };

packages/compass-smoke-tests/src/installers/windows-msi.ts

@@ -0,0 +1,49 @@
+import path from 'node:path';
+
+import type { InstalledAppInfo, InstallablePackage } from './types';
+import { execute, ExecuteFailure } from '../execute';
+
+// See https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/msiexec
+
+export function installWindowsMSI({
+  appName,
+  filepath,
+  destinationPath,
+}: InstallablePackage): InstalledAppInfo {
+  const installDirectory = path.resolve(destinationPath, appName);
+  const appPath = path.resolve(installDirectory, `${appName}.exe`);
+
+  function uninstall() {
+    execute('msiexec', ['/uninstall', filepath, '/passive']);
+  }
+
+  // Installing an MSI which is already installed is a no-op
+  // So we uninstall the MSI first (which will use the PackageCode to find the installed application)
+  // It is fine if the uninstall exists with status 1605, as this happens if the app wasn't already installed.
+  try {
+    uninstall();
+  } catch (err) {
+    if (err instanceof ExecuteFailure && err.status === 1605) {
+      console.log(
+        "Uninstalling before installing failed, which is expected if the app wasn't already installed"
+      );
+    } else {
+      throw err;
+    }
+  }
+
+  execute('msiexec', [
+    '/package',
+    filepath,
+    '/passive',
+    `APPLICATIONROOTDIRECTORY=${installDirectory}`,
+  ]);
+
+  // Check that the executable will run without being quarantined or similar
+  execute(appPath, ['--version']);
+
+  return {
+    appPath: installDirectory,
+    uninstall,
+  };
+}