feat(smoke-tests): test zip installer for on Windows COMPASS-8710 (#6637)

* Derive a target specific app name

* Implement Windows ZIP installer

* Enable shell when running tests

* Arm the CI to execute the tests

* Add Windows variant

Author: kraenhansen

.evergreen/buildvariants-and-tasks.in.yml

@@ -67,13 +67,12 @@ const SMOKETEST_BUILD_VARIANTS = [
 //    run_on: 'ubuntu2004-large',
 //    depends_on: 'package-ubuntu',
 //  },
-  
-//  {
-//    name: 'smoketest-windows',
-//    display_name: 'Smoketest Windows',
-//    run_on: 'windows-vsCurrent-large',
-//    depends_on: 'package-windows',
-//  },
+  {
+    name: 'smoketest-windows',
+    display_name: 'Smoketest Windows',
+    run_on: 'windows-vsCurrent-large',
+    depends_on: 'package-windows',
+  },
 //  {
 //    name: 'smoketest-rhel',
 //    display_name: 'Smoketest RHEL',

.evergreen/buildvariants-and-tasks.yml

@@ -76,6 +76,14 @@ buildvariants:
       - name: package-compass
       - name: package-compass-isolated
       - name: package-compass-readonly
+  - name: smoketest-windows-compass
+    display_name: Smoketest Windows (compass)
+    run_on: windows-vsCurrent-large
+    depends_on:
+      - name: package-compass
+        variant: package-windows
+    tasks:
+      - name: smoketest-compass
   - name: smoketest-macos-x64-compass
     display_name: Smoketest MacOS Intel (compass)
     run_on: macos-14-gui

.evergreen/functions.yml

@@ -678,17 +678,17 @@ functions:
           # Load environment variables
           eval $(.evergreen/print-compass-env.sh)
 
-          #if [[ "$IS_WINDOWS" == "true" ]]; then
+          if [[ "$IS_WINDOWS" == "true" ]]; then
             # TODO: windows_setup
             # TODO: windows_msi
-            # TODO: windows_zip
-          #fi
+            npm run --unsafe-perm --workspace @mongodb-js/compass-smoke-tests start -- --package=windows_zip
+          fi
 
           if [[ "$IS_OSX" == "true" ]]; then
             echo "Disabling clipboard usage in e2e tests (TODO: https://jira.mongodb.org/browse/BUILD-14780)"
             export COMPASS_E2E_DISABLE_CLIPBOARD_USAGE="true"
             npm run --unsafe-perm --workspace @mongodb-js/compass-smoke-tests start -- --package=osx_dmg
-            # TODO: osx_zip
+            npm run --unsafe-perm --workspace @mongodb-js/compass-smoke-tests start -- --package=osx_zip
           fi
 
           #if [[ "$IS_UBUNTU" == "true" ]]; then

packages/compass-smoke-tests/src/build-info.ts

@@ -41,27 +41,65 @@ export const windowsFilenameKeys = [
   'windows_nupkg_full_filename',
 ] as const;
 export type WindowsBuildInfo = CommonBuildInfo &
-  Record<typeof windowsFilenameKeys[number], string>;
+  Record<typeof windowsFilenameKeys[number], string> & {
+    installerOptions: {
+      name: string;
+    };
+  };
 
 export function assertBuildInfoIsWindows(
   buildInfo: unknown
 ): asserts buildInfo is WindowsBuildInfo {
   assertObjectHasKeys(buildInfo, 'buildInfo', commonKeys);
   assertObjectHasKeys(buildInfo, 'buildInfo', windowsFilenameKeys);
+  assert(typeof buildInfo === 'object', 'Expected buildInfo to be an object');
+  assert(buildInfo !== null, 'Expected buildInfo to be an object');
+  assert(
+    'installerOptions' in buildInfo &&
+      typeof buildInfo.installerOptions === 'object',
+    'Expected buildInfo.installerOptions to be an object'
+  );
+  const { installerOptions } = buildInfo;
+  assert(
+    typeof installerOptions === 'object' &&
+      installerOptions !== null &&
+      'name' in installerOptions &&
+      typeof installerOptions.name === 'string',
+    'Expected buildInfo.installerOptions.name to be a string'
+  );
 }
 
 export const osxFilenameKeys = [
   'osx_dmg_filename',
   'osx_zip_filename',
 ] as const;
 export type OSXBuildInfo = CommonBuildInfo &
-  Record<typeof osxFilenameKeys[number], string>;
+  Record<typeof osxFilenameKeys[number], string> & {
+    installerOptions: {
+      title: string;
+    };
+  };
 
 export function assertBuildInfoIsOSX(
   buildInfo: unknown
 ): asserts buildInfo is OSXBuildInfo {
   assertObjectHasKeys(buildInfo, 'buildInfo', commonKeys);
   assertObjectHasKeys(buildInfo, 'buildInfo', osxFilenameKeys);
+  assert(typeof buildInfo === 'object', 'Expected buildInfo to be an object');
+  assert(buildInfo !== null, 'Expected buildInfo to be an object');
+  assert(
+    'installerOptions' in buildInfo &&
+      typeof buildInfo.installerOptions === 'object',
+    'Expected buildInfo.installerOptions to be an object'
+  );
+  const { installerOptions } = buildInfo;
+  assert(
+    typeof installerOptions === 'object' &&
+      installerOptions !== null &&
+      'title' in installerOptions &&
+      typeof installerOptions.title === 'string',
+    'Expected buildInfo.installerOptions.title to be a string'
+  );
 }
 
 export const ubuntuFilenameKeys = [
@@ -93,6 +131,7 @@ export type PackageDetails = {
   kind: PackageKind;
   filename: string;
   autoUpdatable: boolean;
+  appName: string;
 } & (
   | {
       kind: 'windows_setup' | 'windows_msi' | 'windows_zip';
@@ -129,6 +168,7 @@ export function getPackageDetails(
       kind,
       buildInfo,
       filename: buildInfo[`${kind}_filename`],
+      appName: buildInfo.installerOptions.name,
       autoUpdatable: kind === 'windows_setup',
     };
   } else if (kind === 'osx_dmg' || kind === 'osx_zip') {
@@ -137,6 +177,7 @@ export function getPackageDetails(
       kind,
       buildInfo,
       filename: buildInfo[`${kind}_filename`],
+      appName: buildInfo.installerOptions.title,
       autoUpdatable: true,
     };
   } else if (kind === 'linux_deb' || kind === 'linux_tar') {
@@ -145,6 +186,7 @@ export function getPackageDetails(
       kind,
       buildInfo,
       filename: buildInfo[`${kind}_filename`],
+      appName: buildInfo.productName,
       autoUpdatable: false,
     };
   } else if (kind === 'linux_rpm' || kind === 'rhel_tar') {
@@ -153,6 +195,7 @@ export function getPackageDetails(
       kind,
       buildInfo,
       filename: buildInfo[`${kind}_filename`],
+      appName: buildInfo.productName,
       autoUpdatable: false,
     };
   } else {

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

@@ -6,7 +6,6 @@ import path from 'node:path';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { pick } from 'lodash';
-import { installMacDMG } from './installers/mac-dmg';
 import { execute } from './execute';
 import {
   type PackageDetails,
@@ -17,7 +16,10 @@ import { createSandbox } from './directories';
 import { downloadFile } from './downloads';
 import { type PackageKind, SUPPORTED_PACKAGES } from './packages';
 import { type SmokeTestsContext } from './context';
+
+import { installMacDMG } from './installers/mac-dmg';
 import { installMacZIP } from './installers/mac-zip';
+import { installWindowsZIP } from './installers/windows-zip';
 
 const SUPPORTED_PLATFORMS = ['win32', 'darwin', 'linux'] as const;
 const SUPPORTED_ARCHS = ['x64', 'arm64'] as const;
@@ -150,6 +152,8 @@ function getInstaller(kind: PackageKind) {
     return installMacDMG;
   } else if (kind === 'osx_zip') {
     return installMacZIP;
+  } else if (kind === 'windows_zip') {
+    return installWindowsZIP;
   } else {
     throw new Error(`Installer for '${kind}' is not yet implemented`);
   }
@@ -175,12 +179,10 @@ async function run() {
     ])
   );
 
-  const { kind, buildInfo, filepath } = await getTestSubject(context);
+  const { kind, filepath, appName } = await getTestSubject(context);
   const install = getInstaller(kind);
 
   try {
-    const appName = buildInfo.productName;
-
     const { appPath, uninstall } = install({
       appName,
       filepath,
@@ -216,6 +218,8 @@ function runTest({ appName, appPath }: RunTestOptions) {
       '--test-filter=time-to-first-query',
     ],
     {
+      // We need to use a shell to get environment variables setup correctly
+      shell: true,
       env: {
         ...process.env,
         COMPASS_APP_NAME: appName,

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

@@ -0,0 +1,24 @@
+import path from 'node:path';
+
+import type { InstalledAppInfo, InstallablePackage } from './types';
+import { execute } from '../execute';
+
+export function installWindowsZIP({
+  appName,
+  filepath,
+  destinationPath,
+}: InstallablePackage): InstalledAppInfo {
+  const appPath = path.resolve(destinationPath, `${appName}.exe`);
+
+  execute('unzip', [filepath, '-d', destinationPath]);
+
+  // see if the executable will run without being quarantined or similar
+  execute(appPath, ['--version']);
+
+  return {
+    appPath: destinationPath,
+    uninstall: async function () {
+      /* TODO */
+    },
+  };
+}