chore(e2e-tests): add TestShell#eventually and refactor TestShell#executeLine and TestShell#waitForPrompt

packages/e2e-tests/test/e2e-analytics.spec.ts

@@ -46,7 +46,7 @@ describe('e2e Analytics Node', function () {
         );
         expect(helloIsWritablePrimary).to.contain('true');
       },
-      { timeout: 20_000 }
+      { timeout: 40_000 }
     );
   });
 

packages/e2e-tests/test/e2e-auth.spec.ts

@@ -1,7 +1,6 @@
 import { expect } from 'chai';
 import type { Db, Document, MongoClientOptions } from 'mongodb';
 import { MongoClient } from 'mongodb';
-import { eventually } from '../../../testing/eventually';
 import type { TestShell } from './test-shell';
 import {
   skipIfApiStrict,
@@ -298,7 +297,7 @@ describe('Auth e2e', function () {
         it('dropAllUsers', async function () {
           await shell.executeLine(`use ${dbName}`);
           shell.writeInputLine('db.dropAllUsers()');
-          await eventually(() => {
+          await shell.eventually(() => {
             try {
               shell.assertContainsOutput('{ n: 2, ok: 1 }');
             } catch {
@@ -508,7 +507,7 @@ describe('Auth e2e', function () {
         it('dropAllRoles', async function () {
           await shell.executeLine(`use ${dbName}`);
           shell.writeInputLine('db.dropAllRoles()');
-          await eventually(() => {
+          await shell.eventually(() => {
             try {
               shell.assertContainsOutput('{ n: 2, ok: 1 }');
             } catch {
@@ -737,7 +736,7 @@ describe('Auth e2e', function () {
         it('throws if pwd is wrong', async function () {
           await shell.executeLine(`use ${dbName}`);
           shell.writeInputLine('db.auth("anna", "pwd2")');
-          await eventually(
+          await shell.eventually(
             () => {
               shell.assertContainsError('Authentication failed');
             },
@@ -752,7 +751,7 @@ describe('Auth e2e', function () {
           shell.writeInputLine(
             'db.auth({ user: "anna", pwd: "pwd2", mechanism: "not a mechanism"})'
           );
-          await eventually(
+          await shell.eventually(
             () => {
               expect(shell.output).to.match(
                 /MongoParseError: authMechanism one of .+, got not a mechanism/
@@ -1067,7 +1066,7 @@ describe('Auth e2e', function () {
             'SCRAM-SHA-1',
           ],
         });
-        await eventually(() => {
+        await shell.eventually(() => {
           expect(shell.output).to.match(
             /MongoServerError: Authentication failed|Unable to use SCRAM-SHA-1/
           );
@@ -1088,7 +1087,7 @@ describe('Auth e2e', function () {
             'SCRAM-SHA-256',
           ],
         });
-        await eventually(() => {
+        await shell.eventually(() => {
           expect(shell.output).to.match(
             /MongoServerError: Authentication failed|Unable to use SCRAM-SHA-256/
           );

packages/e2e-tests/test/e2e-direct.spec.ts

@@ -64,12 +64,17 @@ describe('e2e direct connection', function () {
           `rs.initiate(${JSON.stringify(replSetConfig)})`
         );
         shell.assertContainsOutput('ok: 1');
-        await eventually(async () => {
-          await shell.executeLine('db.isMaster()');
-          shell.assertContainsOutput('ismaster: true');
-          shell.assertContainsOutput(`me: '${await rs0.hostport()}'`);
-          shell.assertContainsOutput(`setName: '${replSetId}'`);
-        });
+        await eventually(
+          async () => {
+            const output = await shell.executeLine('db.isMaster()');
+            expect(output).contains('ismaster: true');
+            expect(output).contains(`me: '${await rs0.hostport()}'`);
+            expect(output).contains(`setName: '${replSetId}'`);
+          },
+          {
+            timeout: 20_000,
+          }
+        );
 
         await shell.executeLine('use admin');
         await shell.executeLine(
@@ -204,7 +209,7 @@ describe('e2e direct connection', function () {
           await shell.waitForPrompt();
           shell.writeInput('db.testc');
           await tabtab(shell);
-          await eventually(() => {
+          await shell.eventually(() => {
             shell.assertContainsOutput('db.testcollection');
           });
         });
@@ -370,7 +375,7 @@ describe('e2e direct connection', function () {
           await shell.waitForPrompt();
           shell.writeInput('db.testc');
           await tabtab(shell);
-          await eventually(() => {
+          await shell.eventually(() => {
             shell.assertContainsOutput('db.testcollection');
           });
         });

packages/e2e-tests/test/e2e-editor.spec.ts

@@ -1,7 +1,6 @@
 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 { ensureTestShellAfterHook } from './test-shell-context';
 import {
@@ -73,7 +72,7 @@ describe('external editor e2e', function () {
 
       expect(result).to.include('"editor" has been changed');
       shell.writeInputLine(shellOriginalInput);
-      await eventually(() => {
+      await shell.eventually(() => {
         shell.assertContainsOutput(shellModifiedInput);
       });
     });
@@ -97,7 +96,7 @@ describe('external editor e2e', function () {
 
       expect(result).to.include('"editor" has been changed');
       shell.writeInputLine(shellOriginalInput);
-      await eventually(() => {
+      await shell.eventually(() => {
         shell.assertContainsOutput(shellModifiedInput);
       });
     });
@@ -118,7 +117,7 @@ describe('external editor e2e', function () {
 
       expect(result).to.include('"editor" has been changed');
       shell.writeInputLine(shellOriginalInput);
-      await eventually(() => {
+      await shell.eventually(() => {
         shell.assertContainsOutput(shellModifiedInput);
       });
     });
@@ -145,7 +144,7 @@ describe('external editor e2e', function () {
 
       expect(result).to.include('"editor" has been changed');
       shell.writeInputLine(shellOriginalInput);
-      await eventually(() => {
+      await shell.eventually(() => {
         shell.assertContainsOutput(shellModifiedInput);
       });
     });
@@ -163,7 +162,7 @@ describe('external editor e2e', function () {
 
       expect(result).to.include('"editor" has been changed');
       shell.writeInputLine(shellOriginalInput);
-      await eventually(() => {
+      await shell.eventually(() => {
         shell.assertContainsError('failed with an exit code 1');
       });
     });
@@ -182,7 +181,7 @@ describe('external editor e2e', function () {
 
       expect(result).to.include('"editor" has been changed');
       shell.writeInputLine('edit');
-      await eventually(() => {
+      await shell.eventually(() => {
         shell.assertContainsOutput(output);
       });
     });
@@ -216,7 +215,7 @@ describe('external editor e2e', function () {
           "const name = 'I want to test a sequence of writeInputLine'"
         );
         shell.writeInputLine('edit name');
-        await eventually(() => {
+        await shell.eventually(() => {
           shell.assertContainsOutput(shellModifiedInput);
         });
       });
@@ -254,7 +253,7 @@ describe('external editor e2e', function () {
 
           expect(result).to.include('"editor" has been changed');
           shell.writeInputLine(shellOriginalInput);
-          await eventually(() => {
+          await shell.eventually(() => {
             shell.assertContainsOutput(shellModifiedInput);
           });
         });
@@ -279,7 +278,7 @@ describe('external editor e2e', function () {
 
           expect(result).to.include('"editor" has been changed');
           shell.writeInputLine(shellOriginalInput);
-          await eventually(() => {
+          await shell.eventually(() => {
             shell.assertContainsOutput(shellModifiedInput);
           });
         });
@@ -303,7 +302,7 @@ describe('external editor e2e', function () {
 
           expect(result).to.include('"editor" has been changed');
           shell.writeInputLine(shellOriginalInput);
-          await eventually(() => {
+          await shell.eventually(() => {
             shell.assertContainsOutput(shellModifiedInput);
           });
         });

packages/e2e-tests/test/e2e-snippet.spec.ts

@@ -47,7 +47,7 @@ describe('snippet integration tests', function () {
 
   it('allows managing snippets', async function () {
     shell.writeInputLine('snippet install analyze-schema');
-    await eventually(
+    await shell.eventually(
       () => {
         shell.assertContainsOutput(
           'Installed new snippets analyze-schema. Do you want to load them now?'
@@ -77,7 +77,7 @@ describe('snippet integration tests', function () {
       return this.skip(); // https://jira.mongodb.org/browse/MONGOSH-746
     }
     shell.writeInput('snippet insta\t');
-    await eventually(() => {
+    await shell.eventually(() => {
       shell.assertContainsOutput('snippet install');
     });
   });