refactor helper

Author: StellaHuang95

src/test/managers/conda/condaEnvManager.findEnvironmentByPath.unit.test.ts

@@ -1,33 +1,11 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import assert from 'assert';
 import * as sinon from 'sinon';
-import { Uri } from 'vscode';
 import { PythonEnvironment, PythonEnvironmentApi } from '../../../api';
 import { isWindows } from '../../../common/utils/platformUtils';
-import { PythonEnvironmentImpl } from '../../../internal.api';
 import { CondaEnvManager } from '../../../managers/conda/condaEnvManager';
 import { NativePythonFinder } from '../.././../managers/common/nativePythonFinder';
-
-/**
- * Helper to create a minimal PythonEnvironment stub with required fields.
- * Only `name`, `environmentPath`, and `version` matter for findEnvironmentByPath.
- */
-function makeEnv(name: string, envPath: string, version: string = '3.12.0'): PythonEnvironment {
-    return new PythonEnvironmentImpl(
-        { id: `${name}-test`, managerId: 'ms-python.python:conda' },
-        {
-            name,
-            displayName: `${name} (${version})`,
-            displayPath: envPath,
-            version,
-            environmentPath: Uri.file(envPath),
-            sysPrefix: envPath,
-            execInfo: {
-                run: { executable: 'python' },
-            },
-        },
-    );
-}
+import { makeMockPythonEnvironment as makeEnv } from '../../mocks/pythonEnvironment';
 
 /**
  * Creates a CondaEnvManager with a given collection, bypassing initialization.

src/test/managers/conda/condaEnvManager.setEvents.unit.test.ts

@@ -2,29 +2,12 @@
 import assert from 'assert';
 import * as sinon from 'sinon';
 import { Uri } from 'vscode';
-import { DidChangeEnvironmentEventArgs, PythonEnvironment, PythonEnvironmentApi, PythonProject } from '../../../api';
+import { DidChangeEnvironmentEventArgs, PythonEnvironmentApi, PythonProject } from '../../../api';
 import { normalizePath } from '../../../common/utils/pathUtils';
-import { PythonEnvironmentImpl } from '../../../internal.api';
 import { CondaEnvManager } from '../../../managers/conda/condaEnvManager';
 import * as condaUtils from '../../../managers/conda/condaUtils';
 import { NativePythonFinder } from '../../../managers/common/nativePythonFinder';
-
-function makeEnv(name: string, envPath: string, version: string = '3.12.0'): PythonEnvironment {
-    return new PythonEnvironmentImpl(
-        { id: `${name}-test`, managerId: 'ms-python.python:conda' },
-        {
-            name,
-            displayName: `${name} (${version})`,
-            displayPath: envPath,
-            version,
-            environmentPath: Uri.file(envPath),
-            sysPrefix: envPath,
-            execInfo: {
-                run: { executable: 'python' },
-            },
-        },
-    );
-}
+import { makeMockPythonEnvironment as makeEnv } from '../../mocks/pythonEnvironment';
 
 function createManager(apiOverrides?: Partial<PythonEnvironmentApi>): CondaEnvManager {
     const api = {

src/test/managers/conda/condaEnvManager.setGlobal.unit.test.ts

@@ -1,29 +1,11 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import assert from 'assert';
 import * as sinon from 'sinon';
-import { Uri } from 'vscode';
-import { PythonEnvironment, PythonEnvironmentApi } from '../../../api';
-import { PythonEnvironmentImpl } from '../../../internal.api';
+import { PythonEnvironmentApi } from '../../../api';
 import { CondaEnvManager } from '../../../managers/conda/condaEnvManager';
 import * as condaUtils from '../../../managers/conda/condaUtils';
 import { NativePythonFinder } from '../../../managers/common/nativePythonFinder';
-
-function makeEnv(name: string, envPath: string, version: string = '3.12.0'): PythonEnvironment {
-    return new PythonEnvironmentImpl(
-        { id: `${name}-test`, managerId: 'ms-python.python:conda' },
-        {
-            name,
-            displayName: `${name} (${version})`,
-            displayPath: envPath,
-            version,
-            environmentPath: Uri.file(envPath),
-            sysPrefix: envPath,
-            execInfo: {
-                run: { executable: 'python' },
-            },
-        },
-    );
-}
+import { makeMockPythonEnvironment as makeEnv } from '../../mocks/pythonEnvironment';
 
 function createManager(): CondaEnvManager {
     const manager = new CondaEnvManager(

src/test/mocks/pythonEnvironment.ts

@@ -0,0 +1,80 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { Uri } from 'vscode';
+import { PythonEnvironment } from '../../api';
+import { PythonEnvironmentImpl } from '../../internal.api';
+
+/**
+ * Options for {@link createMockPythonEnvironment}.
+ */
+export interface MockPythonEnvironmentOptions {
+    /** Environment name, e.g. `myenv`. Defaults to `test-env`. */
+    name?: string;
+    /** Filesystem path for `environmentPath`, `displayPath`, and `sysPrefix`. */
+    envPath: string;
+    /** Version string. Defaults to `3.12.0`. */
+    version?: string;
+    /** Manager id. Defaults to `ms-python.python:conda`. */
+    managerId?: string;
+    /** Environment id. Defaults to `<name>-test`. */
+    id?: string;
+    /** Optional description. */
+    description?: string;
+    /** Optional display name. Defaults to `<name> (<version>)`. */
+    displayName?: string;
+    /** If true, includes an `activation` entry in `execInfo`. */
+    hasActivation?: boolean;
+}
+
+/**
+ * Create a minimal {@link PythonEnvironment} for use in unit tests.
+ *
+ * Shared across manager and view tests so they agree on the shape of a mock
+ * environment. Only fields that tests commonly need are populated; extend this
+ * helper if additional fields become required.
+ */
+export function createMockPythonEnvironment(options: MockPythonEnvironmentOptions): PythonEnvironment {
+    const {
+        name = 'test-env',
+        envPath,
+        version = '3.12.0',
+        managerId = 'ms-python.python:conda',
+        id = `${name}-test`,
+        description,
+        displayName = `${name} (${version})`,
+        hasActivation = false,
+    } = options;
+
+    return new PythonEnvironmentImpl(
+        { id, managerId },
+        {
+            name,
+            displayName,
+            displayPath: envPath,
+            version,
+            description,
+            environmentPath: Uri.file(envPath),
+            sysPrefix: envPath,
+            execInfo: {
+                run: { executable: 'python' },
+                ...(hasActivation && {
+                    activation: [{ executable: envPath.replace('python', 'activate') }],
+                }),
+            },
+        },
+    );
+}
+
+/**
+ * Positional shorthand for {@link createMockPythonEnvironment} used by conda
+ * manager unit tests. Prefer {@link createMockPythonEnvironment} for new tests
+ * that need to customize additional fields.
+ */
+export function makeMockPythonEnvironment(
+    name: string,
+    envPath: string,
+    version: string = '3.12.0',
+): PythonEnvironment {
+    return createMockPythonEnvironment({ name, envPath, version });
+}