Add regression tests for paths and RunPesterTestsFromFile command

Author: andyleejordan

src/features/Examples.ts

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+import * as fs from "fs";
 import path = require("path");
 import vscode = require("vscode");
 
@@ -15,6 +16,10 @@ export class ExamplesFeature implements vscode.Disposable {
                 "vscode.openFolder",
                 vscode.Uri.file(this.examplesPath),
                 true);
+
+            // Return existence of the path for testing. The `vscode.openFolder`
+            // command should do this, but doesn't (yet).
+            return fs.existsSync(this.examplesPath)
         });
     }
 

src/features/PesterTests.ts

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 import * as path from "path";
+import * as fs from "fs";
 import vscode = require("vscode");
 import { SessionManager } from "../session";
 import Settings = require("../settings");
@@ -24,42 +25,45 @@ export class PesterTestsFeature implements vscode.Disposable {
         this.command = vscode.commands.registerCommand(
             "PowerShell.RunPesterTestsFromFile",
             (fileUri) => {
-                this.launchAllTestsInActiveEditor(LaunchType.Run, fileUri);
+                return this.launchAllTestsInActiveEditor(LaunchType.Run, fileUri);
             });
         // File context-menu command - Debug Pester Tests
         this.command = vscode.commands.registerCommand(
             "PowerShell.DebugPesterTestsFromFile",
             (fileUri) => {
-                this.launchAllTestsInActiveEditor(LaunchType.Debug, fileUri);
+                return this.launchAllTestsInActiveEditor(LaunchType.Debug, fileUri);
             });
         // This command is provided for usage by PowerShellEditorServices (PSES) only
         this.command = vscode.commands.registerCommand(
             "PowerShell.RunPesterTests",
             (uriString, runInDebugger, describeBlockName?, describeBlockLineNumber?, outputPath?) => {
-                this.launchTests(uriString, runInDebugger, describeBlockName, describeBlockLineNumber, outputPath);
+                return this.launchTests(uriString, runInDebugger, describeBlockName, describeBlockLineNumber, outputPath);
             });
     }
 
     public dispose() {
         this.command.dispose();
     }
 
-    private launchAllTestsInActiveEditor(launchType: LaunchType, fileUri: vscode.Uri) {
+    private async launchAllTestsInActiveEditor(
+        launchType: LaunchType,
+        fileUri: vscode.Uri): Promise<boolean> {
+
         const uriString = (fileUri || vscode.window.activeTextEditor.document.uri).toString();
         const launchConfig = this.createLaunchConfig(uriString, launchType);
-        this.launch(launchConfig);
+        return this.launch(launchConfig);
     }
 
     private async launchTests(
         uriString: string,
         runInDebugger: boolean,
         describeBlockName?: string,
         describeBlockLineNumber?: number,
-        outputPath?: string) {
+        outputPath?: string): Promise<boolean> {
 
         const launchType = runInDebugger ? LaunchType.Debug : LaunchType.Run;
         const launchConfig = this.createLaunchConfig(uriString, launchType, describeBlockName, describeBlockLineNumber, outputPath);
-        this.launch(launchConfig);
+        return this.launch(launchConfig);
     }
 
     private createLaunchConfig(
@@ -126,9 +130,9 @@ export class PesterTestsFeature implements vscode.Disposable {
         return launchConfig;
     }
 
-    private launch(launchConfig) {
+    private async launch(launchConfig): Promise<boolean> {
         // Create or show the interactive console
-        // TODO #367: Check if "newSession" mode is configured
+        // TODO: #367 Check if "newSession" mode is configured
         vscode.commands.executeCommand("PowerShell.ShowSessionConsole", true);
 
         // Write out temporary debug session file
@@ -137,6 +141,10 @@ export class PesterTestsFeature implements vscode.Disposable {
             this.sessionManager.getSessionDetails());
 
         // TODO: Update to handle multiple root workspaces.
-        vscode.debug.startDebugging(vscode.workspace.workspaceFolders[0], launchConfig);
+        //
+        // Ensure the necessary script exists (for testing). The debugger will
+        // start regardless, but we also pass its success along.
+        return fs.existsSync(this.invokePesterStubScriptPath)
+            && vscode.debug.startDebugging(vscode.workspace.workspaceFolders[0], launchConfig);
     }
 }

test/core/paths.test.ts

@@ -0,0 +1,34 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import * as assert from "assert";
+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}`;
+
+suite("Path assumptions", () => {
+    before(async () => {
+        const extension = vscode.extensions.getExtension(extensionId);
+        if (!extension.isActive) { await extension.activate(); }
+    });
+
+    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")));
+    });
+
+    test("The logs folder is created in the right place", async () => {
+        assert(fs.existsSync(path.resolve(rootPath, "logs")));
+    });
+});

test/features/ExternalApi.test.ts

@@ -105,6 +105,6 @@ suite("ExternalApi feature - Other APIs", () => {
         assert.notStrictEqual(versionDetails.version, "");
         assert.notStrictEqual(versionDetails.version, null);
 
-        // Start up can take some time... so set the time out to 30s
+        // Start up can take some time...so set the timeout to 30 seconds.
     }).timeout(30000);
 });

test/features/RunCode.test.ts

@@ -2,6 +2,8 @@
 // Licensed under the MIT License.
 
 import * as assert from "assert";
+import * as fs from "fs";
+import * as path from "path";
 import rewire = require("rewire");
 import vscode = require("vscode");
 
@@ -35,4 +37,12 @@ suite("RunCode tests", () => {
 
         assert.deepEqual(actual, expected);
     });
+
+    test("Can run Pester tests from file", async () => {
+        const pesterTests = path.resolve(__dirname, "../../../examples/Tests/SampleModule.Tests.ps1");
+        assert(fs.existsSync(pesterTests));
+        await vscode.commands.executeCommand("vscode.open", vscode.Uri.file(pesterTests));
+        assert(await vscode.commands.executeCommand("PowerShell.RunPesterTestsFromFile"));
+        // Start up can take some time...so set the timeout to 30 seconds.
+    }).timeout(30000);
 });