Export and test ensureTestShellAfterHook

Author: kraenhansen

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

@@ -1,7 +1,7 @@
-import { TestShell } from './test-shell';
+import { ensureTestShellAfterHook, TestShell } from './test-shell';
 
 describe('TestShell', function () {
-  context('sub-suite', function () {
+  context('hooks and tests', function () {
     before(async function () {
       const shell = this.startTestShell({ args: ['--nodb'] });
       await shell.waitForPrompt();
@@ -28,6 +28,24 @@ describe('TestShell', function () {
     });
   });
 
+  context('adding an after each running after cleanup', function () {
+    beforeEach(async function () {
+      const shell = this.startTestShell({ args: ['--nodb'] });
+      await shell.waitForPrompt();
+    });
+
+    // Calling this before the "afterEach" below, ensures the cleanup hook gets added before it
+    ensureTestShellAfterHook('afterEach', this);
+
+    afterEach(function () {
+      TestShell.assertNoOpenShells();
+    });
+
+    it('works', function () {
+      /* */
+    });
+  });
+
   after(function () {
     TestShell.assertNoOpenShells();
   });

packages/e2e-tests/test/test-shell.ts

@@ -359,17 +359,19 @@ type AfterEachInjectedSuite = {
 };
 
 /**
- * Registers an after (all or each) hook to kill test shells started during the hooks or tests
+ * Registers an after (all or each) hook to kill test shells started during the hooks or tests.
+ * You don't have to call this from tests, but you can if you want to register an after (each) hook
+ * which runs after the shells have been killed.
  */
-function ensureAfterHook(
+export function ensureTestShellAfterHook(
   hookName: 'afterEach',
   suite: Mocha.Suite
 ): asserts suite is AfterEachInjectedSuite & Mocha.Suite;
-function ensureAfterHook(
+export function ensureTestShellAfterHook(
   hookName: 'afterAll',
   suite: Mocha.Suite
 ): asserts suite is AfterAllInjectedSuite & Mocha.Suite;
-function ensureAfterHook(
+export function ensureTestShellAfterHook(
   hookName: 'afterEach' | 'afterAll',
   suite: Partial<AfterAllInjectedSuite & AfterEachInjectedSuite> & Mocha.Suite
 ): void {
@@ -409,19 +411,19 @@ Mocha.Context.prototype.startTestShell = function (
       runnable.originalTitle === '"before each" hook' ||
       runnable.originalTitle === '"after each" hook'
     ) {
-      ensureAfterHook('afterEach', parent);
+      ensureTestShellAfterHook('afterEach', parent);
       parent[TEST_SHELLS_AFTER_EACH].add(shell);
     } else if (
       runnable.originalTitle === '"before all" hook' ||
       runnable.originalTitle === '"after all" hook'
     ) {
-      ensureAfterHook('afterAll', parent);
+      ensureTestShellAfterHook('afterAll', parent);
       parent[TEST_SHELLS_AFTER_ALL].add(shell);
     } else {
       throw new Error(`Unexpected ${runnable.originalTitle || runnable.title}`);
     }
   } else if (runnable instanceof Mocha.Test) {
-    ensureAfterHook('afterEach', parent);
+    ensureTestShellAfterHook('afterEach', parent);
     parent[TEST_SHELLS_AFTER_EACH].add(shell);
   } else {
     throw new Error('Unexpected Runnable: Expected a Hook or a Test');