test that you can auto-update from the just-packaged version

Author: lerouxb

packages/compass-e2e-tests/installers/helpers.ts

@@ -8,14 +8,20 @@ export function execute(
 ): Promise<void> {
   return new Promise((resolve, reject) => {
     console.log(command, ...args);
+
     const p = spawn(command, args, {
       stdio: 'inherit',
       ...options,
     });
+
     p.on('error', (err: any) => {
       reject(err);
     });
+
     p.on('close', (code: number | null, signal: NodeJS.Signals | null) => {
+      process.off('exit', killChild);
+      process.off('SIGINT', interruptChild);
+
       if (code !== null) {
         if (code === 0) {
           resolve();
@@ -41,5 +47,11 @@ export function execute(
         }
       }
     });
+
+    // Exit child process if main process exits
+    const killChild = () => p.kill();
+    const interruptChild = () => p.kill('SIGINT');
+    process.once('exit', killChild);
+    process.once('SIGINT', interruptChild);
   });
 }

packages/compass-e2e-tests/smoke-test.ts

@@ -284,33 +284,6 @@ async function downloadFile(url: string, targetFile: string): Promise<void> {
   });
 }
 
-/*
-function testInstalledApp(
-  pkg: Package,
-  appInfo: InstalledAppInfo
-): Promise<void> {
-  return execute(
-    'npm',
-    [
-      'run',
-      '--unsafe-perm',
-      'test-packaged',
-      '--workspace',
-      'compass-e2e-tests',
-      '--',
-      '--test-filter=time-to-first-query',
-    ],
-    {
-      env: {
-        ...process.env,
-        COMPASS_APP_NAME: pkg.appName,
-        COMPASS_APP_PATH: appInfo.appPath,
-      },
-    }
-  );
-}
-*/
-
 run()
   .then(function () {
     console.log('done');

packages/compass-e2e-tests/smoketests/auto-update-from.ts

@@ -1,13 +1,35 @@
-import { expect } from 'chai';
-import {
-  init,
-  cleanup,
-  //screenshotIfFailed,
-  Selectors,
-} from '../helpers/compass';
-
+import { execute } from '../installers/helpers';
 import type { Package } from '../installers/types';
 
+function testInstalledApp(
+  pkg: Package,
+  appPath: string,
+  env: Record<string, string>
+): Promise<void> {
+  return execute(
+    'npm',
+    [
+      'run',
+      '--unsafe-perm',
+      'test-packaged',
+      '--workspace',
+      'compass-e2e-tests',
+      '--',
+      '--test-filter=auto-update',
+    ],
+    {
+      env: {
+        ...process.env,
+        HADRON_AUTO_UPDATE_ENDPOINT_OVERRIDE: 'http://localhost:8080',
+        AUTO_UPDATE_UPDATABLE: pkg.updatable.toString(),
+        COMPASS_APP_NAME: pkg.appName,
+        COMPASS_APP_PATH: appPath,
+        ...env,
+      },
+    }
+  );
+}
+
 export async function testAutoUpdateFrom(pkg: Package) {
   // install the app
   console.log(`installing ${pkg.packageFilepath}`);
@@ -18,49 +40,16 @@ export async function testAutoUpdateFrom(pkg: Package) {
 
   console.log(appPath);
 
-  process.env.COMPASS_APP_NAME = pkg.appName;
-  process.env.COMPASS_APP_PATH = appPath;
-
   try {
     // TODO: start the autoupdate server
     try {
-      // run the app and wait for it to auto-update
-      const compass = await init('auto-update from', { firstRun: true });
-      const { browser } = compass;
-
-      await browser.$(Selectors.AutoUpdateToast).waitForDisplayed();
-
-      if (pkg.updatable) {
-        await browser.$(Selectors.AutoUpdateRestartButton).waitForDisplayed();
-      } else {
-        // When auto-update is not supported the toast contains a link to down
-        const linkElement = browser.$(Selectors.AutoUpdateDownloadLink);
-        await browser.$(linkElement).waitForDisplayed();
-        expect(await linkElement.getAttribute('href')).to.equal(
-          'https://www.mongodb.com/try/download/compass'
-        );
-      }
-
-      await cleanup(compass);
-
-      if (pkg.updatable) {
-        // run the app again and check that the version changed
-        const compass = await init('auto-update from restart', {
-          firstRun: false,
-        });
-        const { browser } = compass;
-        await browser.$(Selectors.AutoUpdateToast).waitForDisplayed();
-        await browser
-          .$(Selectors.AutoUpdateReleaseNotesLink)
-          .waitForDisplayed();
-      }
+      await testInstalledApp(pkg, appPath, {
+        AUTO_UPDATE_FROM: 'true',
+      });
     } finally {
       // TODO: stop the autoupdate server
     }
   } finally {
-    delete process.env.COMPASS_APP_NAME;
-    delete process.env.COMPASS_APP_PATH;
-
     // remove the app
     await uninstall();
   }

packages/compass-e2e-tests/tests/auto-update.test.ts

@@ -0,0 +1,66 @@
+import { expect } from 'chai';
+import {
+  init,
+  cleanup,
+  //screenshotIfFailed,
+  Selectors,
+} from '../helpers/compass';
+
+describe('Auto-update', function () {
+  it('auto-update from', async function () {
+    if (!process.env.AUTO_UPDATE_FROM) {
+      // we don't want this test to execute along with all the others under
+      // normal circumstances because it is destructive - it overwrites Compass
+      // itself
+      this.skip();
+    }
+
+    // run the app and wait for it to auto-update
+    const compass = await init('auto-update from', { firstRun: true });
+    try {
+      const { browser } = compass;
+
+      await browser.$(Selectors.AutoUpdateToast).waitForDisplayed();
+
+      if (process.env.AUTO_UPDATE_UPDATABLE === 'true') {
+        await browser.$(Selectors.AutoUpdateRestartButton).waitForDisplayed();
+      } else {
+        // When auto-update is not supported the toast contains a link to down
+        const linkElement = browser.$(Selectors.AutoUpdateDownloadLink);
+        await browser.$(linkElement).waitForDisplayed();
+        expect(await linkElement.getAttribute('href')).to.equal(
+          'https://www.mongodb.com/try/download/compass'
+        );
+      }
+    } finally {
+      await cleanup(compass);
+    }
+
+    if (process.env.AUTO_UPDATE_UPDATABLE === 'true') {
+      // run the app again and check that the version changed
+      const compass = await init('auto-update from restart', {
+        firstRun: false,
+      });
+      try {
+        const { browser } = compass;
+        await browser.$(Selectors.AutoUpdateToast).waitForDisplayed();
+        await browser
+          .$(Selectors.AutoUpdateReleaseNotesLink)
+          .waitForDisplayed();
+      } finally {
+        await cleanup(compass);
+      }
+    }
+  });
+
+  it('auto-update to', function () {
+    if (!process.env.AUTO_UPDATE_TO) {
+      // we don't want this test to execute along with all the others under
+      // normal circumstances because it is destructive - it overwrites Compass
+      // itself
+      this.skip();
+    }
+
+    // TODO
+  });
+});