refactor(tests): global test setup

Author: justinmk

packages/neovim/package.json

@@ -86,6 +86,9 @@
       "json",
       "node"
     ],
+    "setupFilesAfterEnv": [
+      "<rootDir>/src/testSetup.ts"
+    ],
     "testEnvironment": "node",
     "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.ts$",
     "coverageDirectory": "./coverage/",

packages/neovim/src/api/Buffer.test.ts

@@ -1,5 +1,5 @@
 /* eslint-env jest */
-import * as testUtil from '../testUtil';
+import * as testSetup from '../testSetup';
 
 function wait(ms: number): Promise<void> {
   return new Promise(resolve => {
@@ -10,7 +10,7 @@ function wait(ms: number): Promise<void> {
 }
 
 describe('Buffer API', () => {
-  let nvim: ReturnType<typeof testUtil.getNvim>;
+  let nvim: ReturnType<typeof testSetup.getNvim>;
 
   // utility to allow each test to be run in its
   // own buffer
@@ -32,12 +32,7 @@ describe('Buffer API', () => {
   }
 
   beforeAll(async () => {
-    testUtil.startNvim2();
-    nvim = testUtil.getNvim();
-  });
-
-  afterAll(() => {
-    testUtil.stopNvim2();
+    nvim = testSetup.getNvim();
   });
 
   it(
@@ -384,15 +379,10 @@ describe('Buffer API', () => {
 });
 
 describe('Buffer event updates', () => {
-  let nvim: ReturnType<typeof testUtil.getNvim>;
+  let nvim: ReturnType<typeof testSetup.getNvim>;
 
   beforeAll(async () => {
-    testUtil.startNvim2();
-    nvim = testUtil.getNvim();
-  });
-
-  afterAll(() => {
-    testUtil.stopNvim2();
+    nvim = testSetup.getNvim();
   });
 
   beforeEach(async () => {

packages/neovim/src/api/Neovim.test.ts

@@ -1,18 +1,13 @@
 /* eslint-env jest */
 import * as path from 'node:path';
 import { Neovim } from './Neovim';
-import * as testUtil from '../testUtil';
+import * as testSetup from '../testSetup';
 
 describe('Neovim API', () => {
-  let nvim: ReturnType<typeof testUtil.getNvim>;
+  let nvim: ReturnType<typeof testSetup.getNvim>;
 
   beforeAll(async () => {
-    testUtil.startNvim2();
-    nvim = testUtil.getNvim();
-  });
-
-  afterAll(() => {
-    testUtil.stopNvim2();
+    nvim = testSetup.getNvim();
   });
 
   it('sets transport when initialized', () => {

packages/neovim/src/api/Tabpage.test.ts

@@ -1,20 +1,13 @@
 /* eslint-env jest */
-import * as testUtil from '../testUtil';
+import * as testSetup from '../testSetup';
 
 describe('Tabpage API', () => {
-  let nvim: ReturnType<typeof testUtil.getNvim>;
+  let nvim: ReturnType<typeof testSetup.getNvim>;
 
   beforeAll(async () => {
-    testUtil.startNvim2();
-    nvim = testUtil.getNvim();
+    nvim = testSetup.getNvim();
   });
 
-  afterAll(() => {
-    testUtil.stopNvim2();
-  });
-
-  beforeEach(() => {});
-
   it('gets the current Tabpage', async () => {
     const tabpage = await nvim.tabpage;
     expect(tabpage).toBeInstanceOf(nvim.Tabpage);

packages/neovim/src/api/Window.test.ts

@@ -1,20 +1,13 @@
 /* eslint-env jest */
-import * as testUtil from '../testUtil';
+import * as testSetup from '../testSetup';
 
 describe('Window API', () => {
-  let nvim: ReturnType<typeof testUtil.getNvim>;
+  let nvim: ReturnType<typeof testSetup.getNvim>;
 
   beforeAll(async () => {
-    testUtil.startNvim2();
-    nvim = testUtil.getNvim();
+    nvim = testSetup.getNvim();
   });
 
-  afterAll(() => {
-    testUtil.stopNvim2();
-  });
-
-  beforeEach(() => {});
-
   it('gets the current Window', async () => {
     const win = await nvim.window;
     expect(win).toBeInstanceOf(nvim.Window);

packages/neovim/src/attach/attach.test.ts

@@ -2,15 +2,15 @@
 import { attach } from './attach';
 import { Logger } from '../utils/logger';
 import * as testUtil from '../testUtil';
+import * as testSetup from '../testSetup';
 
 describe('Nvim API', () => {
-  let nvim: ReturnType<typeof testUtil.getNvim>;
+  let nvim: ReturnType<typeof testSetup.getNvim>;
   let requests;
   let notifications;
 
   beforeAll(async () => {
-    testUtil.startNvim2();
-    nvim = testUtil.getNvim();
+    nvim = testSetup.getNvim();
 
     nvim.on('request', (method, args, resp) => {
       requests.push({ method, args });
@@ -21,10 +21,6 @@ describe('Nvim API', () => {
     });
   });
 
-  afterAll(() => {
-    testUtil.stopNvim2();
-  });
-
   beforeEach(() => {
     requests = [];
     notifications = [];
@@ -125,7 +121,7 @@ describe('Nvim API', () => {
   });
 
   it('emits "disconnect" after quit', done => {
-    const proc = testUtil.getNvimProc();
+    const proc = testSetup.getNvimProc();
     const disconnectMock = jest.fn();
     nvim.on('disconnect', disconnectMock);
     nvim.quit();

packages/neovim/src/testSetup.ts

@@ -1,5 +1,35 @@
 // Global test setup. Runs before each test.
 
-import { findNvimOrFail } from './testUtil';
+import * as testUtil from './testUtil';
+import * as jest from '@jest/globals'
 
-findNvimOrFail();
+testUtil.findNvimOrFail();
+
+let proc: ReturnType<typeof testUtil.startNvim>[0];
+let nvim: ReturnType<typeof testUtil.startNvim>[1];
+
+/**
+ * Gets the current Nvim client being used in the current test.
+ */
+export function getNvim() {
+  return nvim!;
+}
+
+export function getNvimProc() {
+  return proc!;
+}
+
+jest.beforeAll(() => {
+  const testName = jest.expect.getState().testPath;
+  console.log('xxxxxxxxxxxx BEFORE %O', testName);
+  [proc, nvim] = testUtil.startNvim(true);
+});
+
+jest.afterAll(() => {
+  const testName = jest.expect.getState().currentTestName;
+  console.log('xxxxxxxxxxxx AFTER %O', testName);
+  testUtil.stopNvim(proc);
+  testUtil.stopNvim(nvim);
+  proc = undefined;
+  nvim = undefined;
+});

packages/neovim/src/testUtil.ts

@@ -3,20 +3,9 @@ import { NeovimClient } from './api/client';
 import { attach } from './attach';
 import { findNvim } from './utils/findNvim';
 
-let proc: cp.ChildProcessWithoutNullStreams;
-let nvim: NeovimClient;
-
-/**
- * Gets the current Nvim client being used in the current test.
- */
-export function getNvim(): NeovimClient {
-  return nvim;
-}
-
-export function getNvimProc(): cp.ChildProcessWithoutNullStreams {
-  return proc;
-}
-
+export function startNvim(): [cp.ChildProcessWithoutNullStreams, NeovimClient]
+export function startNvim(doAttach: false): [cp.ChildProcessWithoutNullStreams, undefined]
+export function startNvim(doAttach: true): [cp.ChildProcessWithoutNullStreams, NeovimClient]
 export function startNvim(
   doAttach: boolean = true
 ): [cp.ChildProcessWithoutNullStreams, NeovimClient | undefined] {
@@ -33,23 +22,15 @@ export function startNvim(
 export function stopNvim(
   proc_: cp.ChildProcessWithoutNullStreams | NeovimClient
 ) {
-  if (proc_ instanceof NeovimClient) {
+  if (!proc_) {
+    return;
+  } else if (proc_ instanceof NeovimClient) {
     proc_.quit();
   } else if (proc_ && proc_.connected) {
     proc_.disconnect();
   }
 }
 
-export function startNvim2(): void {
-  [proc, nvim] = startNvim();
-}
-
-// TODO: use jest beforeAll/afterAll instead of requiring the tests to do this explicitly.
-export function stopNvim2(): void {
-  stopNvim(proc);
-  stopNvim(nvim);
-}
-
 export function findNvimOrFail() {
   const minVersion = '0.9.5';
   const found = findNvim({ minVersion });
@@ -58,7 +39,3 @@ export function findNvimOrFail() {
   }
   return found.matches[0].path;
 }
-
-// beforeAll(async () => {
-//   [proc, nvim] = testUtil.startNvim();
-// });