Add installer for windows setup.exe

Author: kraenhansen

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

@@ -22,6 +22,7 @@ import { installMacDMG } from './installers/mac-dmg';
 import { installMacZIP } from './installers/mac-zip';
 import { installWindowsZIP } from './installers/windows-zip';
 import { installWindowsMSI } from './installers/windows-msi';
+import { installWindowsSetup } from './installers/windows-setup';
 
 const SUPPORTED_PLATFORMS = ['win32', 'darwin', 'linux'] as const;
 const SUPPORTED_ARCHS = ['x64', 'arm64'] as const;
@@ -172,6 +173,8 @@ function getInstaller(kind: PackageKind) {
     return installWindowsZIP;
   } else if (kind === 'windows_msi') {
     return installWindowsMSI;
+  } else if (kind === 'windows_setup') {
+    return installWindowsSetup;
   } else {
     throw new Error(`Installer for '${kind}' is not yet implemented`);
   }

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

@@ -0,0 +1,53 @@
+import cp from 'node:child_process';
+
+type RegistryEntry = {
+  key: string;
+  type: string;
+  value: string;
+};
+
+function isRegistryEntry(value: unknown): value is RegistryEntry {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    'key' in value &&
+    typeof value.key === 'string' &&
+    'type' in value &&
+    typeof value.type === 'string' &&
+    'value' in value &&
+    typeof value.value === 'string'
+  );
+}
+
+/**
+ * Parse the putput of a "reg query" call.
+ */
+function parseQueryRegistryOutput(output: string): RegistryEntry[] {
+  const result = output.matchAll(
+    /^\s*(?<key>\w+) +(?<type>\w+) *(?<value>.*)$/gm
+  );
+  return [...result].map(({ groups }) => groups).filter(isRegistryEntry);
+}
+
+/**
+ * Query the Windows registry by key.
+ */
+export function query(key: string) {
+  const result = cp.spawnSync('reg', ['query', key], { encoding: 'utf8' });
+  if (result.status === 0) {
+    const entries = parseQueryRegistryOutput(result.stdout);
+    return Object.fromEntries(entries.map(({ key, value }) => [key, value]));
+  } else if (
+    result.status === 1 &&
+    result.stderr.trim() ===
+      'ERROR: The system was unable to find the specified registry key or value.'
+  ) {
+    return null;
+  } else {
+    throw Error(
+      `Expected either an entry or status code 1, got status ${
+        result.status ?? '?'
+      }: ${result.stderr}`
+    );
+  }
+}

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

@@ -0,0 +1,75 @@
+import path from 'node:path';
+import assert from 'node:assert/strict';
+import fs from 'node:fs';
+import cp from 'node:child_process';
+
+import type { InstalledAppInfo, InstallablePackage } from './types';
+import { execute } from '../execute';
+import * as windowsRegistry from './windows-registry';
+
+type UninstallOptions = {
+  /**
+   * Expect the app to already be uninstalled, warn if that's not the case.
+   */
+  expectMissing?: boolean;
+};
+
+/**
+ * Install using the Windows installer.
+ */
+export function installWindowsSetup({
+  appName,
+  filepath,
+  destinationPath,
+}: InstallablePackage): InstalledAppInfo {
+  const { LOCALAPPDATA: LOCAL_APPDATA_PATH } = process.env;
+  assert(
+    typeof LOCAL_APPDATA_PATH === 'string',
+    'Expected a LOCALAPPDATA environment injected by the shell'
+  );
+  const installDirectory = path.resolve(LOCAL_APPDATA_PATH, appName);
+
+  function uninstall({ expectMissing = false }: UninstallOptions = {}) {
+    const registryEntry = windowsRegistry.query(
+      `HKEY_CURRENT_USER\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\${appName}`
+    );
+    if (registryEntry) {
+      if (expectMissing) {
+        console.warn(
+          'Found an existing registry entry (likely from a previous run)'
+        );
+      }
+      const { UninstallString: uninstallCommand } = registryEntry;
+      assert(
+        typeof uninstallCommand === 'string',
+        'Expected an UninstallString in the registry entry'
+      );
+      console.log(`Running command to uninstall: ${uninstallCommand}`);
+      cp.execSync(uninstallCommand, { stdio: 'inherit' });
+    }
+    // Removing the any remaining files
+    fs.rmSync(installDirectory, { recursive: true, force: true });
+  }
+
+  uninstall({ expectMissing: true });
+
+  // Assert the app is not on the filesystem at the expected location
+  assert(
+    !fs.existsSync(installDirectory),
+    `Delete any existing installations first (found ${installDirectory})`
+  );
+
+  // Run the installer
+  console.warn(
+    "Installing globally, since we haven't discovered a way to specify an install path"
+  );
+  execute(filepath, []);
+
+  const appPath = path.resolve(installDirectory, `${appName}.exe`);
+  execute(appPath, ['--version']);
+
+  return {
+    appPath: installDirectory,
+    uninstall,
+  };
+}