wrapper function for vscode for testing

Author: eleanorjboyd

src/common/window.apis.ts

@@ -27,6 +27,8 @@ import {
     TerminalShellExecutionStartEvent,
     TerminalShellIntegrationChangeEvent,
     TextEditor,
+    TreeView,
+    TreeViewOptions,
     Uri,
     window,
     WindowState,
@@ -377,3 +379,7 @@ export function onDidChangeWindowState(
 ): Disposable {
     return window.onDidChangeWindowState(listener, thisArgs, disposables);
 }
+
+export function createTreeView<T>(viewId: string, options: TreeViewOptions<T>): TreeView<T> {
+    return window.createTreeView(viewId, options);
+}

src/features/envCommands.ts

@@ -1,15 +1,6 @@
 import * as fs from 'fs-extra';
 import * as path from 'path';
-import {
-    commands,
-    ProgressLocation,
-    QuickInputButtons,
-    TaskExecution,
-    TaskRevealKind,
-    Terminal,
-    Uri,
-    workspace,
-} from 'vscode';
+import { ProgressLocation, QuickInputButtons, TaskExecution, TaskRevealKind, Terminal, Uri, workspace } from 'vscode';
 import {
     CreateEnvironmentOptions,
     PythonEnvironment,
@@ -28,6 +19,7 @@ import {
 } from '../internal.api';
 import { removePythonProjectSetting, setEnvironmentManager, setPackageManager } from './settings/settingHelpers';
 
+import { executeCommand } from '../common/command.api';
 import { clipboardWriteText } from '../common/env.apis';
 import {} from '../common/errors/utils';
 import { Pickers } from '../common/localize';
@@ -470,7 +462,7 @@ export async function addPythonProjectCommand(
             'Open Folder',
         );
         if (r === 'Open Folder') {
-            await commands.executeCommand('vscode.openFolder');
+            await executeCommand('vscode.openFolder');
             return;
         }
     }
@@ -747,7 +739,7 @@ export async function copyPathToClipboard(item: unknown): Promise<void> {
 export async function revealProjectInExplorer(item: unknown): Promise<void> {
     if (item instanceof ProjectItem) {
         const projectUri = item.project.uri;
-        await commands.executeCommand('revealInExplorer', projectUri);
+        await executeCommand('revealInExplorer', projectUri);
     } else {
         traceVerbose(`Invalid context for reveal project in explorer: ${item}`);
     }
@@ -758,7 +750,7 @@ export async function revealProjectInExplorer(item: unknown): Promise<void> {
  */
 export async function revealEnvInManagerView(item: unknown, managerView: EnvManagerView): Promise<void> {
     if (item instanceof ProjectEnvironment) {
-        await commands.executeCommand('env-managers.focus');
+        await executeCommand('env-managers.focus');
         await managerView.reveal(item.environment);
         return;
     }

src/features/views/envManagersView.ts

@@ -1,7 +1,8 @@
-import { Disposable, Event, EventEmitter, ProviderResult, TreeDataProvider, TreeItem, TreeView, window } from 'vscode';
+import { Disposable, Event, EventEmitter, ProviderResult, TreeDataProvider, TreeItem, TreeView } from 'vscode';
 import { DidChangeEnvironmentEventArgs, EnvironmentGroupInfo, PythonEnvironment } from '../../api';
 import { ProjectViews } from '../../common/localize';
 import { createSimpleDebounce } from '../../common/utils/debounce';
+import { createTreeView } from '../../common/window.apis';
 import {
     DidChangeEnvironmentManagerEventArgs,
     DidChangePackageManagerEventArgs,
@@ -42,7 +43,7 @@ export class EnvManagerView implements TreeDataProvider<EnvTreeItem>, Disposable
         public providers: EnvironmentManagers,
         private stateManager: ITemporaryStateManager,
     ) {
-        this.treeView = window.createTreeView<EnvTreeItem>('env-managers', {
+        this.treeView = createTreeView<EnvTreeItem>('env-managers', {
             treeDataProvider: this,
         });
 

src/test/features/envCommands.unit.test.ts

@@ -1,8 +1,9 @@
 import * as assert from 'assert';
 import * as sinon from 'sinon';
 import * as typeMoq from 'typemoq';
-import { commands, Uri } from 'vscode';
+import { Uri } from 'vscode';
 import { PythonEnvironment, PythonProject } from '../../api';
+import * as commandApi from '../../common/command.api';
 import * as managerApi from '../../common/pickers/managers';
 import * as projectApi from '../../common/pickers/projects';
 import { createAnyEnvironmentCommand, revealEnvInManagerView } from '../../features/envCommands';
@@ -185,7 +186,7 @@ suite('Reveal Env In Manager View Command Tests', () => {
     setup(() => {
         managerView = typeMoq.Mock.ofType<EnvManagerView>();
         setupNonThenable(managerView);
-        executeCommandStub = sinon.stub(commands, 'executeCommand');
+        executeCommandStub = sinon.stub(commandApi, 'executeCommand');
     });
 
     teardown(() => {

src/test/features/views/envManagersView.unit.test.ts

@@ -1,7 +1,8 @@
 import * as sinon from 'sinon';
 import * as typeMoq from 'typemoq';
-import { EventEmitter, TreeView, Uri, window } from 'vscode';
+import { EventEmitter, TreeView, Uri } from 'vscode';
 import { PythonEnvironment } from '../../../api';
+import * as windowApis from '../../../common/window.apis';
 import { EnvManagerView } from '../../../features/views/envManagersView';
 import { ITemporaryStateManager } from '../../../features/views/temporaryStateManager';
 import { EnvTreeItem } from '../../../features/views/treeViewItems';
@@ -65,7 +66,7 @@ suite('EnvManagerView.reveal Tests', () => {
         setupNonThenable(treeView);
 
         // Stub window.createTreeView
-        createTreeViewStub = sinon.stub(window, 'createTreeView').returns(treeView.object);
+        createTreeViewStub = sinon.stub(windowApis, 'createTreeView').returns(treeView.object);
     });
 
     teardown(() => {
@@ -203,7 +204,7 @@ suite('EnvManagerView.reveal Tests', () => {
 
         // Re-stub createTreeView to return the updated mock
         createTreeViewStub.restore();
-        createTreeViewStub = sinon.stub(window, 'createTreeView').returns(treeView.object);
+        createTreeViewStub = sinon.stub(windowApis, 'createTreeView').returns(treeView.object);
 
         const view = new EnvManagerView(envManagers.object, stateManager.object);