Use ILogger interface for unit testing

andyleejordan · andyleejordan · commit e373c15db6b2 · 2022-12-05T13:06:08.000-08:00
diff --git a/src/features/Console.ts b/src/features/Console.ts
@@ -5,7 +5,7 @@ import vscode = require("vscode");
 import { NotificationType, RequestType } from "vscode-languageclient";
 import { LanguageClient } from "vscode-languageclient/node";
 import { ICheckboxQuickPickItem, showCheckboxQuickPick } from "../controls/checkboxQuickPick";
-import { Logger } from "../logging";
+import { ILogger } from "../logging";
 import { getSettings } from "../settings";
 import { LanguageClientConsumer } from "../languageClientConsumer";
 
@@ -170,7 +170,7 @@ export class ConsoleFeature extends LanguageClientConsumer {
     private commands: vscode.Disposable[];
     private handlers: vscode.Disposable[] = [];
 
-    constructor(private logger: Logger) {
+    constructor(private logger: ILogger) {
         super();
         this.commands = [
             vscode.commands.registerCommand("PowerShell.RunSelection", async () => {
diff --git a/src/features/DebugSession.ts b/src/features/DebugSession.ts
@@ -12,7 +12,7 @@ import { getPlatformDetails, OperatingSystem } from "../platform";
 import { PowerShellProcess } from "../process";
 import { IEditorServicesSessionDetails, SessionManager, SessionStatus } from "../session";
 import { getSettings } from "../settings";
-import { Logger } from "../logging";
+import { ILogger } from "../logging";
 import { LanguageClientConsumer } from "../languageClientConsumer";
 import path = require("path");
 import utils = require("../utils");
@@ -65,7 +65,7 @@ export class DebugSessionFeature extends LanguageClientConsumer
         },
     };
 
-    constructor(context: ExtensionContext, private sessionManager: SessionManager, private logger: Logger) {
+    constructor(context: ExtensionContext, private sessionManager: SessionManager, private logger: ILogger) {
         super();
         // Register a debug configuration provider
         context.subscriptions.push(vscode.debug.registerDebugConfigurationProvider("PowerShell", this));
@@ -359,7 +359,7 @@ export class PickPSHostProcessFeature extends LanguageClientConsumer {
     private waitingForClientToken?: vscode.CancellationTokenSource;
     private getLanguageClientResolve?: (value: LanguageClient) => void;
 
-    constructor(private logger: Logger) {
+    constructor(private logger: ILogger) {
         super();
 
         this.command =
@@ -485,7 +485,7 @@ export class PickRunspaceFeature extends LanguageClientConsumer {
     private waitingForClientToken?: vscode.CancellationTokenSource;
     private getLanguageClientResolve?: (value: LanguageClient) => void;
 
-    constructor(private logger: Logger) {
+    constructor(private logger: ILogger) {
         super();
         this.command =
             vscode.commands.registerCommand("PowerShell.PickRunspace", (processId) => {
diff --git a/src/features/ExtensionCommands.ts b/src/features/ExtensionCommands.ts
@@ -9,7 +9,7 @@ import {
     Position, Range, RequestType
 } from "vscode-languageclient";
 import { LanguageClient } from "vscode-languageclient/node";
-import { Logger } from "../logging";
+import { ILogger } from "../logging";
 import { getSettings, validateCwdSetting } from "../settings";
 import { LanguageClientConsumer } from "../languageClientConsumer";
 
@@ -149,7 +149,7 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
     private handlers: vscode.Disposable[] = [];
     private extensionCommands: IExtensionCommand[] = [];
 
-    constructor(private logger: Logger) {
+    constructor(private logger: ILogger) {
         super();
         this.commands = [
             vscode.commands.registerCommand("PowerShell.ShowAdditionalCommands", async () => {
diff --git a/src/features/ExternalApi.ts b/src/features/ExternalApi.ts
@@ -4,7 +4,7 @@
 import * as vscode from "vscode";
 import { v4 as uuidv4 } from "uuid";
 import { LanguageClientConsumer } from "../languageClientConsumer";
-import { Logger } from "../logging";
+import { ILogger } from "../logging";
 import { SessionManager } from "../session";
 
 export interface IExternalPowerShellDetails {
@@ -39,7 +39,7 @@ export class ExternalApiFeature extends LanguageClientConsumer implements IPower
     constructor(
         private extensionContext: vscode.ExtensionContext,
         private sessionManager: SessionManager,
-        private logger: Logger) {
+        private logger: ILogger) {
         super();
     }
 
diff --git a/src/features/GetCommands.ts b/src/features/GetCommands.ts
@@ -4,7 +4,7 @@
 import * as vscode from "vscode";
 import { RequestType0 } from "vscode-languageclient";
 import { LanguageClient } from "vscode-languageclient/node";
-import { Logger } from "../logging";
+import { ILogger } from "../logging";
 import { LanguageClientConsumer } from "../languageClientConsumer";
 import { getSettings } from "../settings";
 
@@ -30,7 +30,7 @@ export class GetCommandsFeature extends LanguageClientConsumer {
     private commandsExplorerProvider: CommandsExplorerProvider;
     private commandsExplorerTreeView: vscode.TreeView<Command>;
 
-    constructor(private logger: Logger) {
+    constructor(private logger: ILogger) {
         super();
         this.commands = [
             vscode.commands.registerCommand("PowerShell.RefreshCommandsExplorer",
diff --git a/src/features/NewFileOrProject.ts b/src/features/NewFileOrProject.ts
@@ -5,15 +5,15 @@ import vscode = require("vscode");
 import { RequestType } from "vscode-languageclient";
 import { LanguageClient } from "vscode-languageclient/node";
 import { LanguageClientConsumer } from "../languageClientConsumer";
-import { Logger } from "../logging";
+import { ILogger } from "../logging";
 
 export class NewFileOrProjectFeature extends LanguageClientConsumer {
 
     private readonly loadIcon = "  $(sync)  ";
     private command: vscode.Disposable;
     private waitingForClientToken?: vscode.CancellationTokenSource;
 
-    constructor(private logger: Logger) {
+    constructor(private logger: ILogger) {
         super();
         this.command =
             vscode.commands.registerCommand("PowerShell.NewProjectFromTemplate", async () => {
diff --git a/src/features/PesterTests.ts b/src/features/PesterTests.ts
@@ -3,7 +3,7 @@
 
 import * as path from "path";
 import vscode = require("vscode");
-import { Logger } from "../logging";
+import { ILogger } from "../logging";
 import { SessionManager } from "../session";
 import { getSettings, chosenWorkspace, validateCwdSetting } from "../settings";
 import utils = require("../utils");
@@ -17,7 +17,7 @@ export class PesterTestsFeature implements vscode.Disposable {
     private commands: vscode.Disposable[];
     private invokePesterStubScriptPath: string;
 
-    constructor(private sessionManager: SessionManager, private logger: Logger) {
+    constructor(private sessionManager: SessionManager, private logger: ILogger) {
         this.invokePesterStubScriptPath = path.resolve(__dirname, "../modules/PowerShellEditorServices/InvokePesterStub.ps1");
         this.commands = [
             // File context-menu command - Run Pester Tests
diff --git a/src/features/RunCode.ts b/src/features/RunCode.ts
@@ -3,7 +3,7 @@
 
 import vscode = require("vscode");
 import { SessionManager } from "../session";
-import { Logger } from "../logging";
+import { ILogger } from "../logging";
 import { getSettings, chosenWorkspace, validateCwdSetting } from "../settings";
 
 enum LaunchType {
@@ -14,7 +14,7 @@ enum LaunchType {
 export class RunCodeFeature implements vscode.Disposable {
     private command: vscode.Disposable;
 
-    constructor(private sessionManager: SessionManager, private logger: Logger) {
+    constructor(private sessionManager: SessionManager, private logger: ILogger) {
         this.command = vscode.commands.registerCommand(
             "PowerShell.RunCode",
             async (runInDebugger: boolean, scriptToRun: string, args: string[]) => {
diff --git a/src/logging.ts b/src/logging.ts
@@ -19,12 +19,19 @@ export enum LogLevel {
  *  This will allow for easy mocking of the logger during unit tests.
  */
 export interface ILogger {
+    getLogFilePath(baseName: string): vscode.Uri;
+    updateLogLevel(logLevelName: string): void;
     write(message: string, ...additionalMessages: string[]): void;
+    writeAndShowInformation(message: string, ...additionalMessages: string[]): Promise<void>;
     writeDiagnostic(message: string, ...additionalMessages: string[]): void;
     writeVerbose(message: string, ...additionalMessages: string[]): void;
     writeWarning(message: string, ...additionalMessages: string[]): void;
     writeAndShowWarning(message: string, ...additionalMessages: string[]): Promise<void>;
     writeError(message: string, ...additionalMessages: string[]): void;
+    writeAndShowError(message: string, ...additionalMessages: string[]): Promise<void>;
+    writeAndShowErrorWithActions(
+        message: string,
+        actions: { prompt: string; action: (() => Promise<void>) | undefined }[]): Promise<void>;
 }
 
 export class Logger implements ILogger {
diff --git a/src/platform.ts b/src/platform.ts
@@ -5,7 +5,7 @@ import * as os from "os";
 import * as path from "path";
 import * as process from "process";
 import { integer } from "vscode-languageserver-protocol";
-import { Logger } from "./logging";
+import { ILogger } from "./logging";
 import { PowerShellAdditionalExePathSettings } from "./settings";
 
 // This uses require so we can rewire it in unit tests!
@@ -86,7 +86,7 @@ export class PowerShellExeFinder {
         private platformDetails: IPlatformDetails,
         // Additional configured PowerShells
         private additionalPowerShellExes: PowerShellAdditionalExePathSettings,
-        private logger: Logger) { }
+        private logger: ILogger) { }
 
     /**
      * Returns the first available PowerShell executable found in the search order.
diff --git a/src/process.ts b/src/process.ts
@@ -4,7 +4,7 @@
 import cp = require("child_process");
 import path = require("path");
 import vscode = require("vscode");
-import { Logger } from "./logging";
+import { ILogger } from "./logging";
 import Settings = require("./settings");
 import utils = require("./utils");
 import { IEditorServicesSessionDetails } from "./session";
@@ -24,7 +24,7 @@ export class PowerShellProcess {
         public exePath: string,
         private bundledModulesPath: string,
         private title: string,
-        private logger: Logger,
+        private logger: ILogger,
         private startPsesArgs: string,
         private sessionFilePath: vscode.Uri,
         private sessionSettings: Settings.Settings) {
diff --git a/src/session.ts b/src/session.ts
@@ -7,7 +7,7 @@ import * as semver from "semver";
 import vscode = require("vscode");
 import TelemetryReporter, { TelemetryEventProperties, TelemetryEventMeasurements } from "@vscode/extension-telemetry";
 import { Message } from "vscode-jsonrpc";
-import { Logger } from "./logging";
+import { ILogger } from "./logging";
 import { PowerShellProcess } from "./process";
 import { Settings, changeSetting, getSettings, getEffectiveConfigurationTarget, validateCwdSetting } from "./settings";
 import utils = require("./utils");
@@ -103,7 +103,7 @@ export class SessionManager implements Middleware {
     constructor(
         private extensionContext: vscode.ExtensionContext,
         private sessionSettings: Settings,
-        private logger: Logger,
+        private logger: ILogger,
         private documentSelector: DocumentSelector,
         hostName: string,
         hostVersion: string,
diff --git a/src/settings.ts b/src/settings.ts
@@ -4,7 +4,7 @@
 import vscode = require("vscode");
 import utils = require("./utils");
 import os = require("os");
-import { Logger } from "./logging";
+import { ILogger } from "./logging";
 
 // TODO: Quite a few of these settings are unused in the client and instead
 // exist just for the server. Those settings do not need to be represented in
@@ -193,7 +193,7 @@ export async function changeSetting(
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     newValue: any,
     configurationTarget: vscode.ConfigurationTarget | boolean | undefined,
-    logger: Logger | undefined): Promise<void> {
+    logger: ILogger | undefined): Promise<void> {
 
     logger?.writeDiagnostic(`Changing '${settingName}' at scope '${configurationTarget} to '${newValue}'`);
 
@@ -209,7 +209,7 @@ export async function changeSetting(
 let hasPrompted = false;
 export let chosenWorkspace: vscode.WorkspaceFolder | undefined = undefined;
 
-export async function validateCwdSetting(logger: Logger): Promise<string> {
+export async function validateCwdSetting(logger: ILogger): Promise<string> {
     let cwd: string | undefined = vscode.workspace.getConfiguration(utils.PowerShellLanguageId).get<string>("cwd");
 
     // Only use the cwd setting if it exists.
diff --git a/test/utils.ts b/test/utils.ts
@@ -3,6 +3,7 @@
 
 import * as path from "path";
 import * as vscode from "vscode";
+import { ILogger } from "../src/logging";
 import { IPowerShellExtensionClient } from "../src/features/ExternalApi";
 
 // This lets us test the rest of our path assumptions against the baseline of
@@ -12,6 +13,46 @@ export const rootPath = path.resolve(__dirname, "../../");
 const packageJSON: any = require(path.resolve(rootPath, "package.json"));
 export const extensionId = `${packageJSON.publisher}.${packageJSON.name}`;
 
+export class TestLogger implements ILogger {
+    getLogFilePath(_baseName: string): vscode.Uri {
+        return vscode.Uri.file("");
+    }
+    updateLogLevel(_logLevelName: string): void {
+        return;
+    }
+    write(_message: string, ..._additionalMessages: string[]): void {
+        return;
+    }
+    writeAndShowInformation(_message: string, ..._additionalMessages: string[]): Promise<void> {
+        return Promise.resolve();
+    }
+    writeDiagnostic(_message: string, ..._additionalMessages: string[]): void {
+        return;
+    }
+    writeVerbose(_message: string, ..._additionalMessages: string[]): void {
+        return;
+    }
+    writeWarning(_message: string, ..._additionalMessages: string[]): void {
+        return;
+    }
+    writeAndShowWarning(_message: string, ..._additionalMessages: string[]): Promise<void> {
+        return Promise.resolve();
+    }
+    writeError(_message: string, ..._additionalMessages: string[]): void {
+        return;
+    }
+    writeAndShowError(_message: string, ..._additionalMessages: string[]): Promise<void> {
+        return Promise.resolve();
+    }
+    writeAndShowErrorWithActions(
+        _message: string,
+        _actions: { prompt: string; action: (() => Promise<void>) | undefined }[]): Promise<void> {
+        return Promise.resolve();
+    }
+}
+
+export const testLogger = new TestLogger();
+
 export async function ensureExtensionIsActivated(): Promise<IPowerShellExtensionClient> {
     const extension = vscode.extensions.getExtension(extensionId);
     if (!extension!.isActive) { await extension!.activate(); }
