chore(e2e): enable e2e tests to run directly against Atlas (#6381)

syn-zhu · web-flow · commit add5de6478d9 · 2024-10-22T12:04:10.000-04:00
* enable test against atlas

* use const

* update function

* comments

* fix if check

* comments

* comments
diff --git a/packages/compass-e2e-tests/helpers/commands/connect-form.ts b/packages/compass-e2e-tests/helpers/commands/connect-form.ts
@@ -8,6 +8,7 @@ import {
   DEFAULT_CONNECTION_NAME_2,
   DEFAULT_CONNECTION_STRING_1,
   DEFAULT_CONNECTION_STRING_2,
+  TEST_ATLAS_CLOUD_EXTERNAL_URL,
   TEST_MULTIPLE_CONNECTIONS,
 } from '../compass';
 import Debug from 'debug';
@@ -986,6 +987,12 @@ export async function setupDefaultConnections(browser: CompassBrowser) {
   whereas we do have some tests that try and use those. We can easily change
   this in future if needed, though.
   */
+
+  // no need to setup connections if we are running against Atlas
+  if (TEST_ATLAS_CLOUD_EXTERNAL_URL) {
+    return;
+  }
+
   for (const connectionName of [
     DEFAULT_CONNECTION_NAME_1,
     DEFAULT_CONNECTION_NAME_2,
diff --git a/packages/compass-e2e-tests/helpers/compass.ts b/packages/compass-e2e-tests/helpers/compass.ts
@@ -46,6 +46,10 @@ let MONGODB_USE_ENTERPRISE =
 
 // should we test compass-web (true) or compass electron (false)?
 export const TEST_COMPASS_WEB = process.argv.includes('--test-compass-web');
+export const TEST_ATLAS_CLOUD_EXTERNAL_URL =
+  process.env.TEST_ATLAS_CLOUD_EXTERNAL_URL;
+export const TEST_ATLAS_CLOUD_EXTERNAL_GROUP_ID =
+  process.env.TEST_ATLAS_CLOUD_EXTERNAL_GROUP_ID;
 // multiple connections is now the default
 export const TEST_MULTIPLE_CONNECTIONS = true;
 
@@ -75,19 +79,22 @@ export const MONGODB_TEST_SERVER_PORT = Number(
   process.env.MONGODB_TEST_SERVER_PORT ?? 27091
 );
 
-export const DEFAULT_CONNECTION_STRING_1 = `mongodb://127.0.0.1:${MONGODB_TEST_SERVER_PORT}/test`;
+export const DEFAULT_CONNECTION_STRING_1 =
+  process.env.TEST_ATLAS_CLOUD_EXTERNAL_CONNECTION_STRING_1 ||
+  `mongodb://127.0.0.1:${MONGODB_TEST_SERVER_PORT}/test`;
 // NOTE: in browser.setupDefaultConnections() we don't give the first connection an
 // explicit name, so it gets a calculated one based off the connection string
-export const DEFAULT_CONNECTION_NAME_1 = connectionNameFromString(
-  DEFAULT_CONNECTION_STRING_1
-);
+export const DEFAULT_CONNECTION_NAME_1 =
+  process.env.TEST_ATLAS_CLOUD_EXTERNAL_CONNECTION_NAME_1 ||
+  connectionNameFromString(DEFAULT_CONNECTION_STRING_1);
 
 // for testing multiple connections
-export const DEFAULT_CONNECTION_STRING_2 = `mongodb://127.0.0.1:${
-  MONGODB_TEST_SERVER_PORT + 1
-}/test`;
+export const DEFAULT_CONNECTION_STRING_2 =
+  process.env.TEST_ATLAS_CLOUD_EXTERNAL_CONNECTION_STRING_2 ||
+  `mongodb://127.0.0.1:${MONGODB_TEST_SERVER_PORT + 1}/test`;
 // NOTE: in browser.setupDefaultConnections() the second connection gets given an explicit name
-export const DEFAULT_CONNECTION_NAME_2 = 'connection-2';
+export const DEFAULT_CONNECTION_NAME_2 =
+  process.env.TEST_ATLAS_CLOUD_EXTERNAL_CONNECTION_NAME_2 || 'connection-2';
 
 export function updateMongoDBServerInfo() {
   try {
@@ -106,7 +113,7 @@ export function updateMongoDBServerInfo() {
         'server-info',
         '--',
         '--connectionString',
-        `mongodb://127.0.0.1:${String(MONGODB_TEST_SERVER_PORT)}`,
+        DEFAULT_CONNECTION_STRING_1,
       ],
       { encoding: 'utf-8' }
     );
@@ -761,6 +768,16 @@ async function startCompassElectron(
   return compass;
 }
 
+export type StoredAtlasCloudCookies = {
+  name: string;
+  value: string;
+  domain: string;
+  path: string;
+  secure: boolean;
+  httpOnly: boolean;
+  expirationDate: number;
+}[];
+
 export async function startBrowser(
   name: string,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -787,7 +804,47 @@ export async function startBrowser(
     ...webdriverOptions,
     ...wdioOptions,
   })) as CompassBrowser;
-  await browser.navigateTo('http://localhost:7777/');
+
+  if (TEST_ATLAS_CLOUD_EXTERNAL_URL) {
+    // Navigate to a 404 page to set cookies
+    await browser.navigateTo(`https://${TEST_ATLAS_CLOUD_EXTERNAL_URL}/404`);
+
+    const cookiesFile = process.env.TEST_ATLAS_CLOUD_EXTERNAL_COOKIES_FILE;
+    if (!cookiesFile) {
+      throw new Error(
+        'TEST_ATLAS_CLOUD_EXTERNAL_URL is set but TEST_ATLAS_CLOUD_EXTERNAL_COOKIES_FILE is not. Please set TEST_ATLAS_CLOUD_EXTERNAL_COOKIES_FILE to the path of the cookies file.'
+      );
+    }
+    const cookies: StoredAtlasCloudCookies = JSON.parse(
+      await fs.readFile(cookiesFile, 'utf8')
+    );
+
+    // These are the relevant cookies for auth:
+    // https://github.com/10gen/mms/blob/6d27992a6ab9ab31471c8bcdaa4e347aa39f4013/server/src/features/com/xgen/svc/cukes/helpers/Client.java#L122-L130
+    await browser.setCookies(
+      cookies
+        .filter((cookie) => {
+          cookie.name.includes('mmsa-') ||
+            cookie.name.includes('mdb-sat') ||
+            cookie.name.includes('mdb-srt');
+        })
+        .map((cookie) => ({
+          name: cookie.name,
+          value: cookie.value,
+          domain: cookie.domain,
+          path: cookie.path,
+          secure: cookie.secure,
+          httpOnly: cookie.httpOnly,
+        }))
+    );
+
+    await browser.navigateTo(
+      `https://${TEST_ATLAS_CLOUD_EXTERNAL_URL}/v2/${TEST_ATLAS_CLOUD_EXTERNAL_GROUP_ID}#/explorer`
+    );
+  } else {
+    await browser.navigateTo('http://localhost:7777/');
+  }
+
   const compass = new Compass(name, browser, {
     mode: 'web',
     writeCoverage: false,
diff --git a/packages/compass-e2e-tests/index.ts b/packages/compass-e2e-tests/index.ts
@@ -18,6 +18,7 @@ import {
   LOG_PATH,
   removeUserDataDir,
   updateMongoDBServerInfo,
+  TEST_ATLAS_CLOUD_EXTERNAL_URL,
 } from './helpers/compass';
 import ResultLogger from './helpers/result-logger';
 
@@ -60,52 +61,54 @@ async function setup() {
   const disableStartStop = process.argv.includes('--disable-start-stop');
   const shouldTestCompassWeb = process.argv.includes('--test-compass-web');
 
-  // When working on the tests it is faster to just keep the server running.
-  if (!disableStartStop) {
-    debug('Starting MongoDB server');
-    crossSpawn.sync('npm', ['run', 'start-servers'], { stdio: 'inherit' });
-
-    if (shouldTestCompassWeb) {
-      debug('Starting Compass Web');
-      compassWeb = crossSpawn.spawn(
-        'npm',
-        ['run', '--unsafe-perm', 'start-web'],
-        {
-          cwd: path.resolve(__dirname, '..', '..'),
-          env: {
-            ...process.env,
-            OPEN_BROWSER: 'false', // tell webpack dev server not to open the default browser
-            DISABLE_DEVSERVER_OVERLAY: 'true',
-            APP_ENV: 'webdriverio',
-          },
+  if (!TEST_ATLAS_CLOUD_EXTERNAL_URL) {
+    // When working on the tests it is faster to just keep the server running.
+    if (!disableStartStop) {
+      debug('Starting MongoDB server');
+      crossSpawn.sync('npm', ['run', 'start-servers'], { stdio: 'inherit' });
+
+      if (shouldTestCompassWeb) {
+        debug('Starting Compass Web');
+        compassWeb = crossSpawn.spawn(
+          'npm',
+          ['run', '--unsafe-perm', 'start-web'],
+          {
+            cwd: path.resolve(__dirname, '..', '..'),
+            env: {
+              ...process.env,
+              OPEN_BROWSER: 'false', // tell webpack dev server not to open the default browser
+              DISABLE_DEVSERVER_OVERLAY: 'true',
+              APP_ENV: 'webdriverio',
+            },
+          }
+        );
+
+        compassWeb.stdout.pipe(process.stdout);
+        compassWeb.stderr.pipe(process.stderr);
+
+        let serverReady = false;
+        const start = Date.now();
+        while (!serverReady) {
+          if (Date.now() - start >= 120_000) {
+            throw new Error(
+              'The compass-web sandbox is still not running after 120000ms'
+            );
+          }
+          try {
+            const res = await fetch('http://localhost:7777');
+            serverReady = res.ok;
+            debug('Web server ready: %s', serverReady);
+          } catch (err) {
+            debug('Failed to connect to dev server: %s', (err as any).message);
+          }
+          await wait(1000);
         }
-      );
-
-      compassWeb.stdout.pipe(process.stdout);
-      compassWeb.stderr.pipe(process.stderr);
-
-      let serverReady = false;
-      const start = Date.now();
-      while (!serverReady) {
-        if (Date.now() - start >= 120_000) {
-          throw new Error(
-            'The compass-web sandbox is still not running after 120000ms'
-          );
-        }
-        try {
-          const res = await fetch('http://localhost:7777');
-          serverReady = res.ok;
-          debug('Web server ready: %s', serverReady);
-        } catch (err) {
-          debug('Failed to connect to dev server: %s', (err as any).message);
-        }
-        await wait(1000);
+      } else {
+        debug('Writing electron-versions.json');
+        crossSpawn.sync('scripts/write-electron-versions.sh', [], {
+          stdio: 'inherit',
+        });
       }
-    } else {
-      debug('Writing electron-versions.json');
-      crossSpawn.sync('scripts/write-electron-versions.sh', [], {
-        stdio: 'inherit',
-      });
     }
   }
 
@@ -139,34 +142,36 @@ function cleanup() {
   const disableStartStop = process.argv.includes('--disable-start-stop');
   const shouldTestCompassWeb = process.argv.includes('--test-compass-web');
 
-  if (!disableStartStop) {
-    if (shouldTestCompassWeb) {
-      debug('Stopping compass-web');
-      try {
-        if (compassWeb.pid) {
-          debug(`killing compass-web [${compassWeb.pid}]`);
-          kill(compassWeb.pid, 'SIGINT');
-        } else {
-          debug('no pid for compass-web');
+  if (!TEST_ATLAS_CLOUD_EXTERNAL_URL) {
+    if (!disableStartStop) {
+      if (shouldTestCompassWeb) {
+        debug('Stopping compass-web');
+        try {
+          if (compassWeb.pid) {
+            debug(`killing compass-web [${compassWeb.pid}]`);
+            kill(compassWeb.pid, 'SIGINT');
+          } else {
+            debug('no pid for compass-web');
+          }
+        } catch (e) {
+          debug('Failed to stop compass-web', e);
         }
-      } catch (e) {
-        debug('Failed to stop compass-web', e);
       }
-    }
 
-    debug('Stopping MongoDB server');
-    try {
-      crossSpawn.sync('npm', ['run', 'stop-servers'], {
-        // If it's taking too long we might as well kill the process and move on,
-        // mongodb-runner is flaky sometimes and in ci `posttest-ci` script will
-        // take care of additional clean up anyway
-        timeout: 120_000,
-        stdio: 'inherit',
-      });
-    } catch (e) {
-      debug('Failed to stop MongoDB Server', e);
+      debug('Stopping MongoDB server');
+      try {
+        crossSpawn.sync('npm', ['run', 'stop-servers'], {
+          // If it's taking too long we might as well kill the process and move on,
+          // mongodb-runner is flaky sometimes and in ci `posttest-ci` script will
+          // take care of additional clean up anyway
+          timeout: 120_000,
+          stdio: 'inherit',
+        });
+      } catch (e) {
+        debug('Failed to stop MongoDB Server', e);
+      }
+      debug('Done stopping');
     }
-    debug('Done stopping');
   }
 
   // Since the webdriverio update something is messing with the terminal's
@@ -258,9 +263,10 @@ async function main() {
 
   const e2eTestGroupsAmount = parseInt(process.env.E2E_TEST_GROUPS || '1');
   const e2eTestGroup = parseInt(process.env.E2E_TEST_GROUP || '1');
+  const e2eTestFilter = process.env.E2E_TEST_FILTER || '*';
 
-  const rawTests = (
-    await glob('tests/**/*.{test,spec}.ts', {
+  const tests = (
+    await glob(`tests/**/${e2eTestFilter}.{test,spec}.ts`, {
       cwd: __dirname,
     })
   ).filter((value, index, array) => {
@@ -271,15 +277,19 @@ async function main() {
     return index >= minGroupIndex && index <= maxGroupIndex;
   });
 
-  console.info('Test files:', rawTests);
+  console.info('Test files:', tests);
 
   // The only test file that's interested in the first-run experience (at the
   // time of writing) is time-to-first-query.ts and that happens to be
   // alphabetically right at the end. Which is fine, but the first test to run
   // will also get the slow first run experience for no good reason unless it is
   // the time-to-first-query.ts test.
   // So yeah.. this is a bit of a micro optimisation.
-  const tests = [FIRST_TEST, ...rawTests.filter((t) => t !== FIRST_TEST)];
+  tests.sort((a, b) => {
+    if (a === FIRST_TEST) return -1;
+    else if (b === FIRST_TEST) return 1;
+    else return 0;
+  });
 
   // Ensure the insert-data mocha hooks are run.
   tests.unshift(path.join('helpers', 'insert-data.ts'));
