Refactored TestShell to ensure killAll is called

kraenhansen · kraenhansen · commit 426e2c9236e1 · 2024-09-17T20:14:51.000+02:00
diff --git a/packages/e2e-tests/test/e2e-analytics.spec.ts b/packages/e2e-tests/test/e2e-analytics.spec.ts
@@ -1,7 +1,7 @@
 import { expect } from 'chai';
 import { startTestCluster } from '../../../testing/integration-testing-hooks';
 import { eventually } from '../../../testing/eventually';
-import { TestShell } from './test-shell';
+import { cleanTestShellsAfter, TestShell } from './test-shell';
 
 describe('e2e Analytics Node', function () {
   const replSetName = 'replicaSet';
@@ -13,7 +13,7 @@ describe('e2e Analytics Node', function () {
     { args: ['--replSet', replSetName] }
   );
 
-  after(TestShell.cleanup);
+  cleanTestShellsAfter();
 
   before(async function () {
     if (process.env.MONGOSH_TEST_FORCE_API_STRICT) {
diff --git a/packages/e2e-tests/test/e2e-auth.spec.ts b/packages/e2e-tests/test/e2e-auth.spec.ts
@@ -2,7 +2,7 @@ import { expect } from 'chai';
 import type { Db, Document, MongoClientOptions } from 'mongodb';
 import { MongoClient } from 'mongodb';
 import { eventually } from '../../../testing/eventually';
-import { TestShell } from './test-shell';
+import { cleanTestShellsAfterEach, TestShell } from './test-shell';
 import {
   skipIfApiStrict,
   startSharedTestServer,
@@ -107,6 +107,8 @@ describe('Auth e2e', function () {
   let examplePrivilege2: Document;
 
   describe('with regular URI', function () {
+    cleanTestShellsAfterEach();
+
     beforeEach(async function () {
       const connectionString = await testServer.connectionString();
       dbName = `test-${Date.now()}`;
@@ -137,7 +139,6 @@ describe('Auth e2e', function () {
 
       await client.close();
     });
-    afterEach(TestShell.cleanup);
 
     describe('user management', function () {
       describe('createUser', function () {
@@ -1144,6 +1145,7 @@ describe('Auth e2e', function () {
 
       await client.close();
     });
-    afterEach(TestShell.cleanup);
+
+    cleanTestShellsAfterEach();
   });
 });
diff --git a/packages/e2e-tests/test/e2e-aws.spec.ts b/packages/e2e-tests/test/e2e-aws.spec.ts
@@ -1,6 +1,6 @@
 import { expect } from 'chai';
 import { spawnSync } from 'child_process';
-import { TestShell } from './test-shell';
+import { cleanTestShellsAfterEach, TestShell } from './test-shell';
 
 function assertEnvVariable(variableName: string): string {
   if (process.env.MONGOSH_TEST_FORCE_API_STRICT) {
@@ -84,6 +84,8 @@ function getConnectionString(username?: string, password?: string): string {
 }
 
 describe('e2e AWS AUTH', function () {
+  cleanTestShellsAfterEach();
+
   this.timeout(60_000); // AWS auth tests can take longer than the default timeout in CI
   let expectedAssumedRole: string;
 
@@ -117,8 +119,6 @@ describe('e2e AWS AUTH', function () {
     ).replace('arn:aws:iam::', 'arn:aws:sts::')}/*`;
   });
 
-  afterEach(TestShell.cleanup);
-
   context('without environment variables being present', function () {
     context('specifying explicit parameters', function () {
       it('connects with access key and secret', async function () {
diff --git a/packages/e2e-tests/test/e2e-banners.spec.ts b/packages/e2e-tests/test/e2e-banners.spec.ts
@@ -2,11 +2,11 @@ import {
   skipIfApiStrict,
   startSharedTestServer,
 } from '../../../testing/integration-testing-hooks';
-import { TestShell } from './test-shell';
+import { cleanTestShellsAfterEach, TestShell } from './test-shell';
 
 describe('e2e startup banners', function () {
   skipIfApiStrict();
-  afterEach(TestShell.cleanup);
+  cleanTestShellsAfterEach();
 
   const testServer = startSharedTestServer();
 
diff --git a/packages/e2e-tests/test/e2e-bson.spec.ts b/packages/e2e-tests/test/e2e-bson.spec.ts
@@ -2,10 +2,12 @@ import { expect } from 'chai';
 import type { Db } from 'mongodb';
 import { MongoClient } from 'mongodb';
 import { bson } from '@mongosh/service-provider-core';
-import { TestShell } from './test-shell';
+import { cleanTestShellsAfterEach, TestShell } from './test-shell';
 import { startSharedTestServer } from '../../../testing/integration-testing-hooks';
 
 describe('BSON e2e', function () {
+  cleanTestShellsAfterEach();
+
   const testServer = startSharedTestServer();
   let db: Db;
   let client: MongoClient;
@@ -30,7 +32,7 @@ describe('BSON e2e', function () {
 
     await client.close();
   });
-  afterEach(TestShell.cleanup);
+
   describe('printed BSON', function () {
     const outputDoc = {
       ObjectId: "ObjectId('5f16b8bebe434dc98cdfc9ca')",
diff --git a/packages/e2e-tests/test/e2e-direct.spec.ts b/packages/e2e-tests/test/e2e-direct.spec.ts
@@ -5,11 +5,11 @@ import {
 } from '../../../testing/integration-testing-hooks';
 import { eventually } from '../../../testing/eventually';
 import { expect } from 'chai';
-import { TestShell } from './test-shell';
+import { TestShell, cleanTestShellsAfterEach } from './test-shell';
 
 describe('e2e direct connection', function () {
   skipIfApiStrict();
-  afterEach(TestShell.cleanup);
+  cleanTestShellsAfterEach();
 
   const tabtab = async (shell: TestShell) => {
     await new Promise((resolve) => setTimeout(resolve, 400));
@@ -82,11 +82,6 @@ describe('e2e direct connection', function () {
         await shell.executeLine('db.testcollection.insertOne({})');
         shell.writeInputLine('exit');
       });
-      after(async function () {
-        const shell = TestShell.start({ args: [await rs0.connectionString()] });
-        await shell.executeLine(`db.getSiblingDB("${dbname}").dropDatabase()`);
-        shell.writeInputLine('exit');
-      });
 
       context('connecting to secondary members directly', function () {
         it('works when specifying a connection string', async function () {
diff --git a/packages/e2e-tests/test/e2e-editor.spec.ts b/packages/e2e-tests/test/e2e-editor.spec.ts
@@ -2,7 +2,7 @@ import { expect } from 'chai';
 import path from 'path';
 import { promises as fs } from 'fs';
 import { eventually } from '../../../testing/eventually';
-import { TestShell } from './test-shell';
+import { cleanTestShellsAfterEach, TestShell } from './test-shell';
 import {
   useTmpdir,
   fakeExternalEditor,
@@ -15,6 +15,8 @@ describe('external editor e2e', function () {
   let env: Record<string, string>;
   let shell: TestShell;
 
+  cleanTestShellsAfterEach();
+
   beforeEach(async function () {
     const homeInfo = setTemporaryHomeDirectory();
 
@@ -42,7 +44,6 @@ describe('external editor e2e', function () {
   });
 
   afterEach(async function () {
-    await TestShell.killall.call(this);
     try {
       await fs.rm(homedir, { recursive: true, force: true });
     } catch (err: any) {
diff --git a/packages/e2e-tests/test/e2e-fle.spec.ts b/packages/e2e-tests/test/e2e-fle.spec.ts
@@ -1,6 +1,6 @@
 import { expect } from 'chai';
 import { MongoClient } from 'mongodb';
-import { TestShell } from './test-shell';
+import { cleanTestShellsAfterEach, TestShell } from './test-shell';
 import { eventually } from '../../../testing/eventually';
 import {
   startTestServer,
@@ -16,6 +16,8 @@ import { inspect } from 'util';
 import path from 'path';
 
 describe('FLE tests', function () {
+  cleanTestShellsAfterEach();
+
   const testServer = startTestServer('e2e-fle', {
     topology: 'replset',
     secondaries: 0,
@@ -56,7 +58,6 @@ describe('FLE tests', function () {
     await client.db(dbname).dropDatabase();
     await client.close();
   });
-  afterEach(TestShell.cleanup);
 
   function* awsTestCases() {
     for (const useApiStrict of [false, true]) {
diff --git a/packages/e2e-tests/test/e2e-oidc.spec.ts b/packages/e2e-tests/test/e2e-oidc.spec.ts
@@ -6,7 +6,7 @@ import {
 import { promises as fs } from 'fs';
 import type { OIDCMockProviderConfig } from '@mongodb-js/oidc-mock-provider';
 import { OIDCMockProvider } from '@mongodb-js/oidc-mock-provider';
-import { TestShell } from './test-shell';
+import { cleanTestShellsAfterEach, TestShell } from './test-shell';
 import path from 'path';
 import { expect } from 'chai';
 import { createServer as createHTTPSServer } from 'https';
@@ -30,6 +30,7 @@ import {
  * happens in isolation.
  */
 describe('OIDC auth e2e', function () {
+  cleanTestShellsAfterEach();
   skipIfApiStrict(); // connectionStatus is unversioned.
 
   let getTokenPayload: typeof oidcMockProviderConfig.getTokenPayload;
@@ -164,8 +165,6 @@ describe('OIDC auth e2e', function () {
     ]);
   });
 
-  afterEach(TestShell.cleanup);
-
   async function verifyUser(
     shell: TestShell,
     username: string,
diff --git a/packages/e2e-tests/test/e2e-proxy.spec.ts b/packages/e2e-tests/test/e2e-proxy.spec.ts
@@ -11,7 +11,7 @@ import {
   startSharedTestServer,
   startTestServer,
 } from '../../../testing/integration-testing-hooks';
-import { TestShell } from './test-shell';
+import { cleanTestShellsAfterEach, TestShell } from './test-shell';
 import type { Server as HTTPSServer } from 'https';
 import { createServer as createHTTPSServer } from 'https';
 import {
@@ -40,7 +40,7 @@ describe('e2e proxy support', function () {
   skipIfApiStrict();
   skipIfEnvServerVersion('< 7.0');
 
-  afterEach(TestShell.cleanup);
+  cleanTestShellsAfterEach();
 
   const tmpdir = useTmpdir();
   const testServer = startSharedTestServer();
diff --git a/packages/e2e-tests/test/e2e-snapshot.spec.ts b/packages/e2e-tests/test/e2e-snapshot.spec.ts
@@ -2,7 +2,7 @@ import {
   skipIfApiStrict,
   startSharedTestServer,
 } from '../../../testing/integration-testing-hooks';
-import { TestShell } from './test-shell';
+import { cleanTestShellsAfterEach, TestShell } from './test-shell';
 import { expect } from 'chai';
 
 const setDifference = <T>(a: T[], b: T[]) => a.filter((e) => !b.includes(e));
@@ -17,7 +17,8 @@ const commonPrefix = (a: string, b: string): string =>
 
 describe('e2e snapshot support', function () {
   skipIfApiStrict();
-  afterEach(TestShell.cleanup);
+
+  cleanTestShellsAfterEach();
 
   const testServer = startSharedTestServer();
 
diff --git a/packages/e2e-tests/test/e2e-snippet.spec.ts b/packages/e2e-tests/test/e2e-snippet.spec.ts
@@ -1,11 +1,13 @@
 import { promises as fs } from 'fs';
 import path from 'path';
 import { expect } from 'chai';
-import { TestShell } from './test-shell';
+import { cleanTestShellsAfterEach, TestShell } from './test-shell';
 import { useTmpdir } from './repl-helpers';
 import { eventually } from '../../../testing/eventually';
 
 describe('snippet integration tests', function () {
+  cleanTestShellsAfterEach();
+
   this.timeout(120_000);
   const tmpdir = useTmpdir();
 
@@ -44,7 +46,6 @@ describe('snippet integration tests', function () {
       { recursive: true }
     );
   });
-  afterEach(TestShell.cleanup);
 
   it('allows managing snippets', async function () {
     shell.writeInputLine('snippet install analyze-schema');
diff --git a/packages/e2e-tests/test/e2e-tls.spec.ts b/packages/e2e-tests/test/e2e-tls.spec.ts
@@ -9,7 +9,7 @@ import {
   getCertPath,
   connectionStringWithLocalhost,
 } from './repl-helpers';
-import { TestShell } from './test-shell';
+import { cleanTestShellsAfterEach, TestShell } from './test-shell';
 
 const CA_CERT = getCertPath('ca.crt');
 const NON_CA_CERT = getCertPath('non-ca.crt');
@@ -30,6 +30,8 @@ const CRL_INCLUDING_SERVER = getCertPath('ca-server.crl');
  * and compliance with user-specified behavior that is specific to TLS connectivity.
  */
 describe('e2e TLS', function () {
+  cleanTestShellsAfterEach();
+
   let homedir: string;
   let env: Record<string, string>;
   let logBasePath: string;
@@ -64,7 +66,6 @@ describe('e2e TLS', function () {
       console.error('Could not remove fake home directory:', err);
     }
   });
-  afterEach(TestShell.cleanup);
 
   context(
     'connecting without client cert to server with valid cert',
@@ -87,7 +88,6 @@ describe('e2e TLS', function () {
         shell.kill();
         await shell.waitForExit();
       });
-      afterEach(TestShell.cleanup);
 
       const server = startTestServer('e2e-tls-no-cli-valid-srv', {
         args: [
@@ -323,8 +323,6 @@ describe('e2e TLS', function () {
       await shell.executeLine('db.shutdownServer({ force: true })');
       shell.kill();
       await shell.waitForExit();
-
-      await TestShell.cleanup.call(this);
     });
 
     const server = startTestServer('e2e-tls-valid-cli-valid-srv', {
@@ -625,7 +623,6 @@ describe('e2e TLS', function () {
       });
       await shell.waitForPrompt();
       await shell.executeLine('db.shutdownServer({ force: true })');
-      await TestShell.killall();
     });
 
     const server = startTestServer('e2e-tls-invalid-srv', {
diff --git a/packages/e2e-tests/test/e2e.spec.ts b/packages/e2e-tests/test/e2e.spec.ts
@@ -3,7 +3,7 @@ import { expect } from 'chai';
 import type { Db } from 'mongodb';
 import { MongoClient } from 'mongodb';
 import { eventually } from '../../../testing/eventually';
-import { TestShell } from './test-shell';
+import { cleanTestShellsAfterEach, TestShell } from './test-shell';
 import {
   skipIfServerVersion,
   startSharedTestServer,
@@ -29,7 +29,7 @@ const jsContextFlagCombinations: `--jsContext=${'plain-vm' | 'repl'}`[][] = [
 describe('e2e', function () {
   const testServer = startSharedTestServer();
 
-  afterEach(TestShell.cleanup);
+  cleanTestShellsAfterEach();
 
   describe('--version', function () {
     it('shows version', async function () {
@@ -1378,7 +1378,6 @@ describe('e2e', function () {
     });
 
     afterEach(async function () {
-      await TestShell.killall.call(this);
       try {
         await fs.rm(homedir, { recursive: true, force: true });
       } catch (err: any) {
diff --git a/packages/e2e-tests/test/test-shell.ts b/packages/e2e-tests/test/test-shell.ts
