feat: download and test with the latest release

packages/compass-smoke-tests/package.json

@@ -34,6 +34,7 @@
     "@mongodb-js/eslint-config-compass": "^1.2.2",
     "@mongodb-js/prettier-config-compass": "^1.1.2",
     "@mongodb-js/tsconfig-compass": "^1.1.2",
+    "debug": "^4.3.4",
     "depcheck": "^1.4.1",
     "eslint": "^7.25.0",
     "hadron-build": "^25.6.2",

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

@@ -2,12 +2,18 @@ import assert from 'node:assert/strict';
 import fs from 'node:fs';
 import path from 'node:path';
 
+import createDebug from 'debug';
 import { handler as writeBuildInfo } from 'hadron-build/commands/info';
 
 import { type PackageKind } from './packages';
 import { type SmokeTestsContext } from './context';
 import { pick } from 'lodash';
 
+const debug = createDebug('compass-smoke-tests:build-info');
+
+const SUPPORTED_CHANNELS = ['dev', 'beta', 'stable'] as const;
+type Channel = typeof SUPPORTED_CHANNELS[number];
+
 function assertObjectHasKeys(
   obj: unknown,
   name: string,
@@ -25,13 +31,21 @@ function assertObjectHasKeys(
 
 // subsets of the hadron-build info result
 
-export const commonKeys = ['productName'] as const;
-export type CommonBuildInfo = Record<typeof commonKeys[number], string>;
+export const commonKeys = ['productName', 'channel'] as const;
+export type CommonBuildInfo = Record<typeof commonKeys[number], string> & {
+  channel: Channel;
+};
 
 export function assertCommonBuildInfo(
   buildInfo: unknown
 ): asserts buildInfo is CommonBuildInfo {
   assertObjectHasKeys(buildInfo, 'buildInfo', commonKeys);
+  assert(
+    SUPPORTED_CHANNELS.includes((buildInfo as { channel: Channel }).channel),
+    `Expected ${
+      (buildInfo as { channel: Channel }).channel
+    } to be in ${SUPPORTED_CHANNELS.join(',')}`
+  );
 }
 
 export const windowsFilenameKeys = [
@@ -231,11 +245,11 @@ export function writeAndReadPackageDetails(
     arch: context.arch,
     out: path.resolve(context.sandboxPath, 'target.json'),
   };
-  console.log({ infoArgs });
+  debug({ infoArgs });
 
   // These are known environment variables that will affect the way
   // writeBuildInfo works. Log them as a reminder and for our own sanity
-  console.log(
+  debug(
     'info env vars',
     pick(process.env, [
       'HADRON_DISTRIBUTION',

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

@@ -6,6 +6,7 @@ import path from 'node:path';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { pick } from 'lodash';
+import createDebug from 'debug';
 import { execute } from './execute';
 import {
   type PackageDetails,
@@ -15,12 +16,15 @@ import {
 import { createSandbox } from './directories';
 import { downloadFile } from './downloads';
 import { type PackageKind, SUPPORTED_PACKAGES } from './packages';
+import { getLatestRelease } from './releases';
 import { type SmokeTestsContext } from './context';
 
 import { installMacDMG } from './installers/mac-dmg';
 import { installMacZIP } from './installers/mac-zip';
 import { installWindowsZIP } from './installers/windows-zip';
 
+const debug = createDebug('compass-smoke-tests');
+
 const SUPPORTED_PLATFORMS = ['win32', 'darwin', 'linux'] as const;
 const SUPPORTED_ARCHS = ['x64', 'arm64'] as const;
 
@@ -165,9 +169,9 @@ async function run() {
     sandboxPath: createSandbox(),
   };
 
-  console.log(`Running tests in ${context.sandboxPath}`);
+  debug(`Running tests in ${context.sandboxPath}`);
 
-  console.log(
+  debug(
     'context',
     pick(context, [
       'forceDownload',
@@ -179,7 +183,7 @@ async function run() {
     ])
   );
 
-  const { kind, filepath, appName } = await getTestSubject(context);
+  const { kind, filepath, buildInfo, appName } = await getTestSubject(context);
   const install = getInstaller(kind);
 
   try {
@@ -195,7 +199,34 @@ async function run() {
       await uninstall();
     }
   } finally {
-    console.log('Cleaning up sandbox');
+    debug('Cleaning up sandbox');
+    fs.rmSync(context.sandboxPath, { recursive: true });
+  }
+
+  debug('update from latest release to this package');
+  const releasepath = await getLatestRelease(
+    buildInfo.channel,
+    context.arch,
+    kind,
+    context.forceDownload
+  );
+
+  try {
+    const appName = buildInfo.productName;
+
+    const { appPath, uninstall } = install({
+      appName,
+      filepath: releasepath,
+      destinationPath: context.sandboxPath,
+    });
+
+    try {
+      runTest({ appName, appPath });
+    } finally {
+      await uninstall();
+    }
+  } finally {
+    debug('Cleaning up sandbox');
     fs.rmSync(context.sandboxPath, { recursive: true });
   }
 }
@@ -231,7 +262,7 @@ function runTest({ appName, appPath }: RunTestOptions) {
 
 run()
   .then(function () {
-    console.log('done');
+    debug('done');
   })
   .catch(function (err) {
     console.error(err.stack);

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

@@ -3,8 +3,12 @@ import fs from 'node:fs';
 import path from 'node:path';
 import stream from 'node:stream';
 
+import createDebug from 'debug';
+
 import { ensureDownloadsDirectory } from './directories';
 
+const debug = createDebug('compass-smoke-tests:downloads');
+
 type DownloadFileOptions = {
   url: string;
   targetFilename: string;
@@ -33,7 +37,7 @@ export async function downloadFile({
     if (clearCache) {
       fs.rmSync(cacheDirectoryPath, { recursive: true, force: true });
     } else {
-      console.log('Skipped downloading', url, '(cache existed)');
+      debug(`Skipped downloading ${url} (cache existed)`);
       return outputPath;
     }
   }
@@ -44,7 +48,7 @@ export async function downloadFile({
 
   // Write the response to file
   assert(response.body, 'Expected a response body');
-  console.log('Downloading', url);
+  debug(`Downloading ${url} to ${outputPath}`);
   await stream.promises.pipeline(
     response.body,
     fs.createWriteStream(outputPath)

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

@@ -1,9 +1,13 @@
 import path from 'node:path';
 import fs from 'node:fs';
 
+import createDebug from 'debug';
+
 import type { InstalledAppInfo, InstallablePackage } from './types';
 import { execute } from '../execute';
 
+const debug = createDebug('compass-smoke-tests:installers:mac-dmg');
+
 export function installMacDMG({
   appName,
   filepath,
@@ -35,7 +39,7 @@ export function installMacDMG({
     );
 
     if (fs.existsSync(settingsDir)) {
-      console.log(`${settingsDir} already exists. Removing.`);
+      debug(`${settingsDir} already exists. Removing.`);
       fs.rmSync(settingsDir, { recursive: true });
     }
   }

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

@@ -1,9 +1,13 @@
 import path from 'node:path';
 import fs from 'node:fs';
 
+import createDebug from 'debug';
+
 import type { InstalledAppInfo, InstallablePackage } from './types';
 import { execute } from '../execute';
 
+const debug = createDebug('compass-smoke-tests:installers:mac-zip');
+
 export function installMacZIP({
   appName,
   filepath,
@@ -25,7 +29,7 @@ export function installMacZIP({
     );
 
     if (fs.existsSync(settingsDir)) {
-      console.log(`${settingsDir} already exists. Removing.`);
+      debug(`${settingsDir} already exists. Removing.`);
       fs.rmSync(settingsDir, { recursive: true });
     }
   }

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

@@ -0,0 +1,91 @@
+import { downloadFile } from './downloads';
+import { type PackageKind } from './packages';
+
+type Arch = 'arm64' | 'x64';
+
+type PlatformShortName =
+  | 'darwin-arm64'
+  | 'darwin-x64'
+  | 'windows'
+  | 'linux_deb'
+  | 'linux_rpm';
+
+function getPlatformShortName(
+  arch: Arch,
+  kind: PackageKind
+): PlatformShortName {
+  if (arch === 'arm64') {
+    if (kind === 'osx_dmg' || kind === 'osx_zip') {
+      return 'darwin-arm64';
+    }
+  }
+  if (arch === 'x64') {
+    if (kind === 'osx_dmg' || kind === 'osx_zip') {
+      return 'darwin-x64';
+    }
+    if (
+      kind === 'windows_setup' ||
+      kind === 'windows_msi' ||
+      kind === 'windows_zip'
+    ) {
+      return 'windows';
+    }
+    if (kind === 'linux_deb' || kind === 'linux_tar') {
+      return 'linux_deb';
+    }
+    if (kind === 'linux_rpm' || kind === 'rhel_tar') {
+      return 'linux_rpm';
+    }
+  }
+
+  throw new Error(`Unsupported arch/kind combo: ${arch}/${kind}`);
+}
+
+type PlatformExtension = 'dmg' | 'exe' | 'deb' | 'rpm';
+
+function getPlatformExtension(
+  arch: Arch,
+  kind: PackageKind
+): PlatformExtension {
+  if (arch === 'arm64') {
+    if (kind === 'osx_dmg' || kind === 'osx_zip') {
+      return 'dmg';
+    }
+  }
+  if (arch === 'x64') {
+    if (kind === 'osx_dmg' || kind === 'osx_zip') {
+      return 'dmg';
+    }
+    if (
+      kind === 'windows_setup' ||
+      kind === 'windows_msi' ||
+      kind === 'windows_zip'
+    ) {
+      return 'exe';
+    }
+    if (kind === 'linux_deb' || kind === 'linux_tar') {
+      return 'deb';
+    }
+    if (kind === 'linux_rpm' || kind === 'rhel_tar') {
+      return 'rpm';
+    }
+  }
+
+  throw new Error(`Unsupported arch/kind combo: ${arch}/${kind}`);
+}
+
+export async function getLatestRelease(
+  channel: 'dev' | 'beta' | 'stable',
+  arch: Arch,
+  kind: PackageKind,
+  forceDownload?: boolean
+): Promise<string> {
+  const shortName = getPlatformShortName(arch, kind);
+  const extension = getPlatformExtension(arch, kind);
+
+  return await downloadFile({
+    url: `http://compass.mongodb.com/api/v2/download/latest/compass/${channel}/${shortName}`,
+    targetFilename: `latest-${channel}.${extension}`,
+    clearCache: forceDownload,
+  });
+}