Phase 1: Add core infrastructure for project-based testing

Copilot · eleanorjboyd · eleanorjboyd · commit 7af8ea378523 · 2026-01-08T11:02:59.000-08:00
- Created ProjectAdapter and WorkspaceDiscoveryState interfaces
- Added project utility functions (ID generation, scoping, nested project detection)
- Updated PythonResultResolver to support optional projectId parameter
- Modified populateTestTree to create project-scoped test IDs
- Updated TestDiscoveryHandler to handle project-scoped error nodes

Co-authored-by: eleanorjboyd &lt;26030610+eleanorjboyd@users.noreply.github.com&gt;
diff --git a/src/client/testing/testController/common/projectAdapter.ts b/src/client/testing/testController/common/projectAdapter.ts
@@ -0,0 +1,135 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import { TestItem, Uri } from 'vscode';
+import { TestProvider } from '../../types';
+import { ITestDiscoveryAdapter, ITestExecutionAdapter, ITestResultResolver, DiscoveredTestPayload, DiscoveredTestNode } from './types';
+import { PythonEnvironment, PythonProject } from '../../../envExt/types';
+
+/**
+ * Represents a single Python project with its own test infrastructure.
+ * A project is defined as a combination of a Python executable + URI (folder/file).
+ */
+export interface ProjectAdapter {
+    // === IDENTITY ===
+    /**
+     * Unique identifier for this project, generated by hashing the PythonProject object.
+     */
+    projectId: string;
+
+    /**
+     * Display name for the project (e.g., "alice (Python 3.11)").
+     */
+    projectName: string;
+
+    /**
+     * URI of the project root folder or file.
+     */
+    projectUri: Uri;
+
+    /**
+     * Parent workspace URI containing this project.
+     */
+    workspaceUri: Uri;
+
+    // === API OBJECTS (from vscode-python-environments extension) ===
+    /**
+     * The PythonProject object from the environment API.
+     */
+    pythonProject: PythonProject;
+
+    /**
+     * The resolved PythonEnvironment with execution details.
+     * Contains execInfo.run.executable for running tests.
+     */
+    pythonEnvironment: PythonEnvironment;
+
+    // === TEST INFRASTRUCTURE ===
+    /**
+     * Test framework provider ('pytest' | 'unittest').
+     */
+    testProvider: TestProvider;
+
+    /**
+     * Adapter for test discovery.
+     */
+    discoveryAdapter: ITestDiscoveryAdapter;
+
+    /**
+     * Adapter for test execution.
+     */
+    executionAdapter: ITestExecutionAdapter;
+
+    /**
+     * Result resolver for this project (maps test IDs and handles results).
+     */
+    resultResolver: ITestResultResolver;
+
+    // === DISCOVERY STATE ===
+    /**
+     * Raw discovery data before filtering (all discovered tests).
+     * Cleared after ownership resolution to save memory.
+     */
+    rawDiscoveryData?: DiscoveredTestPayload;
+
+    /**
+     * Filtered tests that this project owns (after API verification).
+     * This is the tree structure passed to populateTestTree().
+     */
+    ownedTests?: DiscoveredTestNode;
+
+    // === LIFECYCLE ===
+    /**
+     * Whether discovery is currently running for this project.
+     */
+    isDiscovering: boolean;
+
+    /**
+     * Whether tests are currently executing for this project.
+     */
+    isExecuting: boolean;
+
+    /**
+     * Root TestItem for this project in the VS Code test tree.
+     * All project tests are children of this item.
+     */
+    projectRootTestItem?: TestItem;
+}
+
+/**
+ * Temporary state used during workspace-wide test discovery.
+ * Created at the start of discovery and cleared after ownership resolution.
+ */
+export interface WorkspaceDiscoveryState {
+    /**
+     * The workspace being discovered.
+     */
+    workspaceUri: Uri;
+
+    /**
+     * Maps test file paths to the set of projects that discovered them.
+     * Used to detect overlapping discovery.
+     */
+    fileToProjects: Map<string, Set<ProjectAdapter>>;
+
+    /**
+     * Maps test file paths to their owning project (after API resolution).
+     * Value is the ProjectAdapter whose pythonProject.uri matches API response.
+     */
+    fileOwnership: Map<string, ProjectAdapter>;
+
+    /**
+     * Progress tracking for parallel discovery.
+     */
+    projectsCompleted: Set<string>;
+
+    /**
+     * Total number of projects in this workspace.
+     */
+    totalProjects: number;
+
+    /**
+     * Whether all projects have completed discovery.
+     */
+    isComplete: boolean;
+}
diff --git a/src/client/testing/testController/common/projectUtils.ts b/src/client/testing/testController/common/projectUtils.ts
@@ -0,0 +1,106 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+import * as crypto from 'crypto';
+import { Uri } from 'vscode';
+import { ProjectAdapter } from './projectAdapter';
+import { PythonProject } from '../../../envExt/types';
+
+/**
+ * Generates a unique project ID by hashing the PythonProject object.
+ * This ensures consistent IDs across extension reloads for the same project.
+ * 
+ * @param pythonProject The PythonProject object from the environment API
+ * @returns A unique string identifier for the project
+ */
+export function generateProjectId(pythonProject: PythonProject): string {
+    // Create a stable string representation of the project
+    const projectString = JSON.stringify({
+        name: pythonProject.name,
+        uri: pythonProject.uri.toString(),
+    });
+    
+    // Generate a hash to create a shorter, unique ID
+    const hash = crypto.createHash('sha256').update(projectString).digest('hex');
+    return `project-${hash.substring(0, 12)}`;
+}
+
+/**
+ * Creates a project-scoped VS Code test item ID.
+ * Format: "{projectId}::{testPath}"
+ * 
+ * @param projectId The unique project identifier
+ * @param testPath The test path (e.g., "/workspace/test.py::test_func")
+ * @returns The project-scoped VS Code test ID
+ */
+export function createProjectScopedVsId(projectId: string, testPath: string): string {
+    return `${projectId}::${testPath}`;
+}
+
+/**
+ * Parses a project-scoped VS Code test ID to extract the project ID and test path.
+ * 
+ * @param vsId The VS Code test item ID
+ * @returns Object containing projectId and testPath, or null if invalid
+ */
+export function parseProjectScopedVsId(vsId: string): { projectId: string; testPath: string } | null {
+    const separatorIndex = vsId.indexOf('::');
+    if (separatorIndex === -1) {
+        return null;
+    }
+    
+    return {
+        projectId: vsId.substring(0, separatorIndex),
+        testPath: vsId.substring(separatorIndex + 2),
+    };
+}
+
+/**
+ * Checks if a test file path is within a nested project's directory.
+ * This is used to determine when to query the API for ownership even if
+ * only one project discovered the file.
+ * 
+ * @param testFilePath Absolute path to the test file
+ * @param allProjects All projects in the workspace
+ * @param excludeProject Optional project to exclude from the check (typically the discoverer)
+ * @returns True if the file is within any nested project's directory
+ */
+export function hasNestedProjectForPath(
+    testFilePath: string,
+    allProjects: ProjectAdapter[],
+    excludeProject?: ProjectAdapter,
+): boolean {
+    return allProjects.some(
+        (p) =>
+            p !== excludeProject &&
+            testFilePath.startsWith(p.projectUri.fsPath),
+    );
+}
+
+/**
+ * Finds the project that owns a specific test file based on project URI.
+ * This is typically used after the API returns ownership information.
+ * 
+ * @param projectUri The URI of the owning project (from API)
+ * @param allProjects All projects to search
+ * @returns The ProjectAdapter with matching URI, or undefined if not found
+ */
+export function findProjectByUri(projectUri: Uri, allProjects: ProjectAdapter[]): ProjectAdapter | undefined {
+    return allProjects.find((p) => p.projectUri.fsPath === projectUri.fsPath);
+}
+
+/**
+ * Creates a display name for a project including Python version.
+ * Format: "{projectName} (Python {version})"
+ * 
+ * @param projectName The name of the project
+ * @param pythonVersion The Python version string (e.g., "3.11.2")
+ * @returns Formatted display name
+ */
+export function createProjectDisplayName(projectName: string, pythonVersion: string): string {
+    // Extract major.minor version if full version provided
+    const versionMatch = pythonVersion.match(/^(\d+\.\d+)/);
+    const shortVersion = versionMatch ? versionMatch[1] : pythonVersion;
+    
+    return `${projectName} (Python ${shortVersion})`;
+}
diff --git a/src/client/testing/testController/common/resultResolver.ts b/src/client/testing/testController/common/resultResolver.ts
@@ -26,10 +26,23 @@ export class PythonResultResolver implements ITestResultResolver {
 
     public detailedCoverageMap = new Map<string, FileCoverageDetail[]>();
 
-    constructor(testController: TestController, testProvider: TestProvider, private workspaceUri: Uri) {
+    /**
+     * Optional project ID for scoping test IDs.
+     * When set, all test IDs are prefixed with "{projectId}::" for project-based testing.
+     * When undefined, uses legacy workspace-level IDs for backward compatibility.
+     */
+    private projectId?: string;
+
+    constructor(
+        testController: TestController,
+        testProvider: TestProvider,
+        private workspaceUri: Uri,
+        projectId?: string,
+    ) {
         this.testController = testController;
         this.testProvider = testProvider;
-        // Initialize a new TestItemIndex which will be used to track test items in this workspace
+        this.projectId = projectId;
+        // Initialize a new TestItemIndex which will be used to track test items in this workspace/project
         this.testItemIndex = new TestItemIndex();
     }
 
@@ -46,6 +59,14 @@ export class PythonResultResolver implements ITestResultResolver {
         return this.testItemIndex.vsIdToRunIdMap;
     }
 
+    /**
+     * Gets the project ID for this resolver (if any).
+     * Used for project-scoped test ID generation.
+     */
+    public getProjectId(): string | undefined {
+        return this.projectId;
+    }
+
     public resolveDiscovery(payload: DiscoveredTestPayload, token?: CancellationToken): void {
         PythonResultResolver.discoveryHandler.processDiscovery(
             payload,
@@ -54,6 +75,7 @@ export class PythonResultResolver implements ITestResultResolver {
             this.workspaceUri,
             this.testProvider,
             token,
+            this.projectId,
         );
         sendTelemetryEvent(EventName.UNITTEST_DISCOVERY_DONE, undefined, {
             tool: this.testProvider,
diff --git a/src/client/testing/testController/common/testDiscoveryHandler.ts b/src/client/testing/testController/common/testDiscoveryHandler.ts
@@ -27,6 +27,7 @@ export class TestDiscoveryHandler {
         workspaceUri: Uri,
         testProvider: TestProvider,
         token?: CancellationToken,
+        projectId?: string,
     ): void {
         if (!payload) {
             // No test data is available
@@ -38,10 +39,13 @@ export class TestDiscoveryHandler {
 
         // Check if there were any errors in the discovery process.
         if (rawTestData.status === 'error') {
-            this.createErrorNode(testController, workspaceUri, rawTestData.error, testProvider);
+            this.createErrorNode(testController, workspaceUri, rawTestData.error, testProvider, projectId);
         } else {
             // remove error node only if no errors exist.
-            testController.items.delete(`DiscoveryError:${workspacePath}`);
+            const errorNodeId = projectId
+                ? `${projectId}::DiscoveryError:${workspacePath}`
+                : `DiscoveryError:${workspacePath}`;
+            testController.items.delete(errorNodeId);
         }
 
         if (rawTestData.tests || rawTestData.tests === null) {
@@ -64,6 +68,7 @@ export class TestDiscoveryHandler {
                     vsIdToRunId: testItemIndex.vsIdToRunIdMap,
                 } as any,
                 token,
+                projectId,
             );
         }
     }
@@ -76,21 +81,27 @@ export class TestDiscoveryHandler {
         workspaceUri: Uri,
         error: string[] | undefined,
         testProvider: TestProvider,
+        projectId?: string,
     ): void {
         const workspacePath = workspaceUri.fsPath;
         const testingErrorConst =
             testProvider === 'pytest' ? Testing.errorPytestDiscovery : Testing.errorUnittestDiscovery;
 
         traceError(testingErrorConst, 'for workspace: ', workspacePath, '\r\n', error?.join('\r\n\r\n') ?? '');
 
-        let errorNode = testController.items.get(`DiscoveryError:${workspacePath}`);
+        const errorNodeId = projectId
+            ? `${projectId}::DiscoveryError:${workspacePath}`
+            : `DiscoveryError:${workspacePath}`;
+        let errorNode = testController.items.get(errorNodeId);
         const message = util.format(
             `${testingErrorConst} ${Testing.seePythonOutput}\r\n`,
             error?.join('\r\n\r\n') ?? '',
         );
 
         if (errorNode === undefined) {
             const options = buildErrorNodeOptions(workspaceUri, message, testProvider);
+            // Update the error node ID to include project scope if applicable
+            options.id = errorNodeId;
             errorNode = createErrorTestItem(testController, options);
             testController.items.add(errorNode);
         }
diff --git a/src/client/testing/testController/common/utils.ts b/src/client/testing/testController/common/utils.ts
