Create and use test/utils.ensureExtensionIsActivated()

Cleans up some repetitive code and makes tests more stable.

Author: andyleejordan

test/core/paths.test.ts

@@ -6,29 +6,20 @@ import * as fs from "fs";
 import * as path from "path";
 import * as vscode from "vscode";
 import { before } from "mocha";
-
-// This lets us test the rest of our path assumptions against the baseline of
-// this test file existing at `<root>/out/test/core/paths.test.ts`.
-const rootPath = path.resolve(__dirname, "../../../")
-// tslint:disable-next-line: no-var-requires
-const packageJSON: any = require(path.resolve(rootPath, "package.json"));
-const extensionId = `${packageJSON.publisher}.${packageJSON.name}`;
+import utils = require("../utils");
 
 suite("Path assumptions", () => {
-    before(async () => {
-        const extension = vscode.extensions.getExtension(extensionId);
-        if (!extension.isActive) { await extension.activate(); }
-    });
+    before(async () => { await utils.ensureExtensionIsActivated(); });
 
     test("The examples folder can be opened (and exists)", async () => {
         assert(await vscode.commands.executeCommand("PowerShell.OpenExamplesFolder"));
     });
 
     test("The session folder is created in the right place", async () => {
-        assert(fs.existsSync(path.resolve(rootPath, "sessions")));
+        assert(fs.existsSync(path.resolve(utils.rootPath, "sessions")));
     });
 
     test("The logs folder is created in the right place", async () => {
-        assert(fs.existsSync(path.resolve(rootPath, "logs")));
+        assert(fs.existsSync(path.resolve(utils.rootPath, "logs")));
     });
 });

test/features/ExternalApi.test.ts

@@ -2,27 +2,19 @@
 // Licensed under the MIT License.
 
 import * as assert from "assert";
-import * as vscode from "vscode";
 import { before, beforeEach, afterEach } from "mocha";
+import utils = require("../utils");
 import { IExternalPowerShellDetails, IPowerShellExtensionClient } from "../../src/features/ExternalApi";
 
-// tslint:disable-next-line: no-var-requires
-const PackageJSON: any = require("../../../package.json");
-const testExtensionId = `${PackageJSON.publisher}.${PackageJSON.name}`;
-
 suite("ExternalApi feature - Registration API", () => {
     let powerShellExtensionClient: IPowerShellExtensionClient;
     before(async () => {
-        const powershellExtension = vscode.extensions.getExtension<IPowerShellExtensionClient>(testExtensionId);
-        if (!powershellExtension.isActive) {
-            powerShellExtensionClient = await powershellExtension.activate();
-            return;
-        }
+        const powershellExtension = await utils.ensureExtensionIsActivated();
         powerShellExtensionClient = powershellExtension!.exports as IPowerShellExtensionClient;
     });
 
     test("It can register and unregister an extension", () => {
-        const sessionId: string = powerShellExtensionClient.registerExternalExtension(testExtensionId);
+        const sessionId: string = powerShellExtensionClient.registerExternalExtension(utils.extensionId);
         assert.notStrictEqual(sessionId , "");
         assert.notStrictEqual(sessionId , null);
         assert.strictEqual(
@@ -31,7 +23,7 @@ suite("ExternalApi feature - Registration API", () => {
     });
 
     test("It can register and unregister an extension with a version", () => {
-        const sessionId: string = powerShellExtensionClient.registerExternalExtension(testExtensionId, "v2");
+        const sessionId: string = powerShellExtensionClient.registerExternalExtension(utils.extensionId, "v2");
         assert.notStrictEqual(sessionId , "");
         assert.notStrictEqual(sessionId , null);
         assert.strictEqual(
@@ -48,12 +40,12 @@ suite("ExternalApi feature - Registration API", () => {
     });
 
     test("It can't register the same extension twice", async () => {
-        const sessionId: string = powerShellExtensionClient.registerExternalExtension(testExtensionId);
+        const sessionId: string = powerShellExtensionClient.registerExternalExtension(utils.extensionId);
         try {
             assert.throws(
-                () => powerShellExtensionClient.registerExternalExtension(testExtensionId),
+                () => powerShellExtensionClient.registerExternalExtension(utils.extensionId),
                 {
-                    message: `The extension '${testExtensionId}' is already registered.`
+                    message: `The extension '${utils.extensionId}' is already registered.`
                 });
         } finally {
             powerShellExtensionClient.unregisterExternalExtension(sessionId);
@@ -74,16 +66,12 @@ suite("ExternalApi feature - Other APIs", () => {
     let powerShellExtensionClient: IPowerShellExtensionClient;
 
     before(async () => {
-        const powershellExtension = vscode.extensions.getExtension<IPowerShellExtensionClient>(testExtensionId);
-        if (!powershellExtension.isActive) {
-            powerShellExtensionClient = await powershellExtension.activate();
-            return;
-        }
+        const powershellExtension = await utils.ensureExtensionIsActivated();
         powerShellExtensionClient = powershellExtension!.exports as IPowerShellExtensionClient;
     });
 
     beforeEach(() => {
-        sessionId = powerShellExtensionClient.registerExternalExtension(testExtensionId);
+        sessionId = powerShellExtensionClient.registerExternalExtension(utils.extensionId);
     });
 
     afterEach(() => {

test/features/ISECompatibility.test.ts

@@ -3,16 +3,21 @@
 
 import * as assert from "assert";
 import * as vscode from "vscode";
+import { before } from "mocha";
 import { ISECompatibilityFeature } from "../../src/features/ISECompatibility";
+import utils = require("../utils");
 
 suite("ISECompatibility feature", () => {
+    before(async () => { await utils.ensureExtensionIsActivated(); } );
+
     test("It sets ISE Settings", async () => {
         await vscode.commands.executeCommand("PowerShell.EnableISEMode");
         for (const iseSetting of ISECompatibilityFeature.settings) {
             const currently = vscode.workspace.getConfiguration(iseSetting.path).get(iseSetting.name);
             assert.equal(currently, iseSetting.value);
         }
     });
+
     test("It unsets ISE Settings", async () => {
         // Change state to something that DisableISEMode will change
         await vscode.workspace.getConfiguration("workbench").update("colorTheme", "PowerShell ISE", true);
@@ -24,6 +29,7 @@ suite("ISECompatibility feature", () => {
             assert.notEqual(currently, iseSetting.value);
         }
     }).timeout(10000);
+
     test("It leaves Theme after being changed after enabling ISE Mode", async () => {
         await vscode.commands.executeCommand("PowerShell.EnableISEMode");
         assert.equal(vscode.workspace.getConfiguration("workbench").get("colorTheme"), "PowerShell ISE");

test/features/RunCode.test.ts

@@ -4,8 +4,10 @@
 import * as assert from "assert";
 import * as fs from "fs";
 import * as path from "path";
+import { before } from "mocha";
 import rewire = require("rewire");
 import vscode = require("vscode");
+import utils = require("../utils");
 
 // Setup function that is not exported.
 const customViews = rewire("../../src/features/RunCode");
@@ -17,6 +19,8 @@ enum LaunchType {
 }
 
 suite("RunCode tests", () => {
+    before(async () => { await utils.ensureExtensionIsActivated(); } );
+
     test("Can create the launch config", () => {
         const commandToRun: string = "Invoke-Build";
         const args: string[] = ["Clean"];

test/utils.ts

@@ -0,0 +1,20 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+"use strict";
+
+import * as path from "path";
+import * as vscode from "vscode";
+
+// This lets us test the rest of our path assumptions against the baseline of
+// this test file existing at `<root>/out/test/utils.js`.
+export const rootPath = path.resolve(__dirname, "../../")
+// tslint:disable-next-line: no-var-requires
+const packageJSON: any = require(path.resolve(rootPath, "package.json"));
+export const extensionId = `${packageJSON.publisher}.${packageJSON.name}`;
+
+export async function ensureExtensionIsActivated(): Promise<vscode.Extension<any>> {
+    const extension = vscode.extensions.getExtension(extensionId);
+    if (!extension.isActive) { await extension.activate(); }
+    return extension;
+}