Merge pull request #3577 from Shopify/ar/improve-test-isolation

Enhance test isolation with disposal and sandbox patterns

Author: alexcrocha

vscode/src/test/suite/client.test.ts

@@ -25,15 +25,15 @@ import {
   ShowMessageParams,
   MessageType,
 } from "vscode-languageclient/node";
-import { after, afterEach, before, setup } from "mocha";
+import { after, afterEach, before, beforeEach, setup } from "mocha";
 
 import { Ruby, ManagerIdentifier } from "../../ruby";
 import Client from "../../client";
 import { WorkspaceChannel } from "../../workspaceChannel";
 import { MAJOR, MINOR } from "../rubyVersion";
 
 import { FAKE_TELEMETRY, FakeLogger } from "./fakeTelemetry";
-import { createRubySymlinks } from "./helpers";
+import { createContext, createRubySymlinks } from "./helpers";
 
 async function launchClient(workspaceUri: vscode.Uri) {
   const workspaceFolder: vscode.WorkspaceFolder = {
@@ -42,15 +42,7 @@ async function launchClient(workspaceUri: vscode.Uri) {
     index: 0,
   };
 
-  const context = {
-    extensionMode: vscode.ExtensionMode.Test,
-    subscriptions: [],
-    workspaceState: {
-      get: (_name: string) => undefined,
-      update: (_name: string, _value: any) => Promise.resolve(),
-    },
-    extensionUri: vscode.Uri.file(path.join(workspaceUri.fsPath, "vscode")),
-  } as unknown as vscode.ExtensionContext;
+  const context = createContext();
   const fakeLogger = new FakeLogger();
   const outputChannel = new WorkspaceChannel("fake", fakeLogger as any);
 
@@ -149,6 +141,7 @@ suite("Client", () => {
     "fake.rb",
   );
   let client: Client;
+  let sandbox: sinon.SinonSandbox;
 
   before(async function () {
     // 60000 should be plenty but we're seeing timeouts on Windows in CI
@@ -158,6 +151,10 @@ suite("Client", () => {
     client = await launchClient(workspaceUri);
   });
 
+  beforeEach(() => {
+    sandbox = sinon.createSandbox();
+  });
+
   after(async function () {
     // eslint-disable-next-line no-invalid-this
     this.timeout(20000);
@@ -185,6 +182,7 @@ suite("Client", () => {
   });
 
   afterEach(async () => {
+    sandbox.restore();
     await client.sendNotification("textDocument/didClose", {
       textDocument: {
         uri: documentUri.toString(),
@@ -815,15 +813,14 @@ suite("Client", () => {
       },
     });
 
-    const stub = sinon.stub(vscode.commands, "executeCommand").resolves(null);
+    const stub = sandbox.stub(vscode.commands, "executeCommand").resolves(null);
 
     await client.sendRequest("textDocument/definition", {
       textDocument: {
         uri,
       },
       position: { line: 1, character: 5 },
     });
-    stub.restore();
 
     await client.sendNotification("textDocument/didClose", {
       textDocument: { uri },
@@ -870,7 +867,7 @@ suite("Client", () => {
       },
     });
 
-    const stub = sinon.stub(vscode.commands, "executeCommand").resolves(null);
+    const stub = sandbox.stub(vscode.commands, "executeCommand").resolves(null);
 
     await client.sendRequest("textDocument/signatureHelp", {
       textDocument: {
@@ -879,7 +876,6 @@ suite("Client", () => {
       position: { line: 1, character: 23 },
       context: {},
     });
-    stub.restore();
 
     await client.sendNotification("textDocument/didClose", {
       textDocument: { uri },
@@ -927,7 +923,7 @@ suite("Client", () => {
       },
     });
 
-    const stub = sinon.stub(vscode.commands, "executeCommand").resolves(null);
+    const stub = sandbox.stub(vscode.commands, "executeCommand").resolves(null);
 
     await client.sendRequest("textDocument/documentHighlight", {
       textDocument: {
@@ -936,7 +932,6 @@ suite("Client", () => {
       position: { line: 1, character: 4 },
       context: {},
     });
-    stub.restore();
 
     await client.sendNotification("textDocument/didClose", {
       textDocument: { uri },

vscode/src/test/suite/debugger.test.ts

@@ -14,9 +14,11 @@ import { LOG_CHANNEL, asyncExec } from "../../common";
 import { RUBY_VERSION } from "../rubyVersion";
 
 import { FAKE_TELEMETRY } from "./fakeTelemetry";
-import { createRubySymlinks } from "./helpers";
+import { createContext, createRubySymlinks, FakeContext } from "./helpers";
 
 suite("Debugger", () => {
+  let context: FakeContext;
+
   const original = vscode.workspace
     .getConfiguration("debug")
     .get("saveBeforeStart");
@@ -25,16 +27,19 @@ suite("Debugger", () => {
     await vscode.workspace
       .getConfiguration("debug")
       .update("saveBeforeStart", "none", true);
+
+    context = createContext();
   });
 
   afterEach(async () => {
     await vscode.workspace
       .getConfiguration("debug")
       .update("saveBeforeStart", original, true);
+
+    context.dispose();
   });
 
   test("Provide debug configurations returns the default configs", () => {
-    const context = { subscriptions: [] } as unknown as vscode.ExtensionContext;
     const debug = new Debugger(context, () => {
       return undefined;
     });
@@ -69,7 +74,6 @@ suite("Debugger", () => {
   });
 
   test("Resolve configuration injects Ruby environment", async () => {
-    const context = { subscriptions: [] } as unknown as vscode.ExtensionContext;
     const ruby = {
       env: { bogus: "hello!", overrideMe: "oldValue" },
     } as unknown as Ruby;
@@ -105,7 +109,6 @@ suite("Debugger", () => {
   });
 
   test("Resolve configuration injects Ruby environment and allows users custom environment", async () => {
-    const context = { subscriptions: [] } as unknown as vscode.ExtensionContext;
     const ruby = { env: { bogus: "hello!" } } as unknown as Ruby;
     const workspaceFolder = {
       name: "fake",
@@ -140,7 +143,6 @@ suite("Debugger", () => {
     fs.mkdirSync(path.join(tmpPath, ".ruby-lsp"));
     fs.writeFileSync(path.join(tmpPath, ".ruby-lsp", "Gemfile"), "hello!");
 
-    const context = { subscriptions: [] } as unknown as vscode.ExtensionContext;
     const ruby = { env: { bogus: "hello!" } } as unknown as Ruby;
     const workspaceFolder = {
       name: "fake",
@@ -204,15 +206,6 @@ suite("Debugger", () => {
       'source "https://rubygems.org"\ngem "debug"',
     );
 
-    const extensionPath = path.dirname(path.dirname(path.dirname(__dirname)));
-    const context = {
-      subscriptions: [],
-      workspaceState: {
-        get: () => undefined,
-        update: () => undefined,
-      },
-      extensionUri: vscode.Uri.file(extensionPath),
-    } as unknown as vscode.ExtensionContext;
     const outputChannel = new WorkspaceChannel("fake", LOG_CHANNEL);
     const workspaceFolder: vscode.WorkspaceFolder = {
       uri: vscode.Uri.file(tmpPath),

vscode/src/test/suite/helpers.ts

@@ -70,9 +70,19 @@ export const LSP_WORKSPACE_FOLDER: vscode.WorkspaceFolder = {
   name: path.basename(LSP_WORKSPACE_PATH),
   index: 0,
 };
-export const CONTEXT = {
-  extensionMode: vscode.ExtensionMode.Test,
-  subscriptions: [],
-  workspaceState: new FakeWorkspaceState(),
-  extensionUri: vscode.Uri.joinPath(LSP_WORKSPACE_URI, "vscode"),
-} as unknown as vscode.ExtensionContext;
+
+export type FakeContext = vscode.ExtensionContext & { dispose: () => void };
+
+export function createContext() {
+  const subscriptions: vscode.Disposable[] = [];
+
+  return {
+    extensionMode: vscode.ExtensionMode.Test,
+    subscriptions,
+    workspaceState: new FakeWorkspaceState(),
+    extensionUri: vscode.Uri.joinPath(LSP_WORKSPACE_URI, "vscode"),
+    dispose: () => {
+      subscriptions.forEach((subscription) => subscription.dispose());
+    },
+  } as unknown as FakeContext;
+}

vscode/src/test/suite/launch.test.ts

@@ -6,15 +6,15 @@ import os from "os";
 import * as vscode from "vscode";
 import { State } from "vscode-languageclient/node";
 import sinon from "sinon";
-import { beforeEach } from "mocha";
+import { afterEach, beforeEach } from "mocha";
 
 import { ManagerIdentifier, Ruby } from "../../ruby";
 import Client from "../../client";
 import { WorkspaceChannel } from "../../workspaceChannel";
 import * as common from "../../common";
 
 import { FAKE_TELEMETRY, FakeLogger } from "./fakeTelemetry";
-import { createRubySymlinks } from "./helpers";
+import { createContext, createRubySymlinks, FakeContext } from "./helpers";
 
 suite("Launch integrations", () => {
   const workspacePath = path.dirname(
@@ -27,15 +27,19 @@ suite("Launch integrations", () => {
     index: 0,
   };
 
-  const context = {
-    extensionMode: vscode.ExtensionMode.Test,
-    subscriptions: [],
-    workspaceState: {
-      get: (_name: string) => undefined,
-      update: (_name: string, _value: any) => Promise.resolve(),
-    },
-    extensionUri: vscode.Uri.joinPath(workspaceUri, "vscode"),
-  } as unknown as vscode.ExtensionContext;
+  let context: FakeContext;
+  let sandbox: sinon.SinonSandbox;
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox();
+    context = createContext();
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+    context.dispose();
+  });
+
   const fakeLogger = new FakeLogger();
   const outputChannel = new WorkspaceChannel("fake", fakeLogger as any);
 
@@ -97,9 +101,8 @@ suite("Launch integrations", () => {
   });
 
   test("with launcher mode enabled", async () => {
-    const featureStub = sinon.stub(common, "featureEnabled").returns(true);
+    sandbox.stub(common, "featureEnabled").returns(true);
     const client = await createClient();
-    featureStub.restore();
 
     await startClient(client);
 

vscode/src/test/suite/rails.test.ts

@@ -4,6 +4,7 @@ import path from "path";
 
 import * as vscode from "vscode";
 import sinon from "sinon";
+import { beforeEach, afterEach } from "mocha";
 
 import { Rails } from "../../rails";
 import { Workspace } from "../../workspace";
@@ -21,8 +22,18 @@ suite("Rails", () => {
     index: 0,
   };
 
+  let sandbox: sinon.SinonSandbox;
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox();
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+  });
+
   test("generate", async () => {
-    const executeStub = sinon.stub();
+    const executeStub = sandbox.stub();
     const workspace = {
       workspaceFolder,
       execute: executeStub.resolves({
@@ -31,8 +42,8 @@ suite("Rails", () => {
       }),
     } as unknown as Workspace;
 
-    const showDocumentStub = sinon.stub(vscode.window, "showTextDocument");
-    const executeCommandStub = sinon.stub(vscode.commands, "executeCommand");
+    const showDocumentStub = sandbox.stub(vscode.window, "showTextDocument");
+    sandbox.stub(vscode.commands, "executeCommand");
 
     const selectedWorkspace = undefined;
     const rails = new Rails(() => Promise.resolve(workspace));
@@ -64,12 +75,10 @@ suite("Rails", () => {
           { preview: false },
         ),
     );
-    showDocumentStub.restore();
-    executeCommandStub.restore();
   });
 
   test("destroy", async () => {
-    const executeStub = sinon.stub();
+    const executeStub = sandbox.stub();
     const workspace = {
       workspaceFolder,
       execute: executeStub.resolves({
@@ -78,7 +87,7 @@ suite("Rails", () => {
       }),
     } as unknown as Workspace;
 
-    const executeCommandStub = sinon.stub(vscode.commands, "executeCommand");
+    const executeCommandStub = sandbox.stub(vscode.commands, "executeCommand");
 
     const selectedWorkspace = undefined;
     const rails = new Rails(() => Promise.resolve(workspace));
@@ -110,6 +119,5 @@ suite("Rails", () => {
           vscode.Uri.joinPath(workspaceUri, "app/models/user.rb"),
         ),
     );
-    executeCommandStub.restore();
   });
 });