lots of fun fixes

Author: eleanorjboyd

python_files/tests/pytestadapter/expected_discovery_test_output.py

@@ -1879,19 +1879,32 @@
 
 # This is the expected output for unittest_folder when PROJECT_ROOT_PATH is set to unittest_folder.
 # The root of the tree is unittest_folder (not .data), simulating project-based testing.
-# └── unittest_folder (ROOT - set via PROJECT_ROOT_PATH)
-#    ├── test_add.py
-#    │   └── TestAddFunction
-#    │       ├── test_add_negative_numbers
-#    │       └── test_add_positive_numbers
-#    │   └── TestDuplicateFunction
-#    │       └── test_dup_a
-#    └── test_subtract.py
-#        └── TestSubtractFunction
-#            ├── test_subtract_negative_numbers
-#            └── test_subtract_positive_numbers
-#        └── TestDuplicateFunction
-#            └── test_dup_s
+#
+# **Project Configuration:**
+# In the VS Code Python extension, projects are defined by the Python Environments extension.
+# Each project has a root directory (identified by pyproject.toml, setup.py, etc.).
+# When PROJECT_ROOT_PATH is set, pytest uses that path as the test tree root instead of cwd.
+#
+# **Test Tree Structure:**
+# Without PROJECT_ROOT_PATH (legacy mode):
+#   └── .data (cwd = workspace root)
+#       └── unittest_folder
+#           └── test_add.py, test_subtract.py...
+#
+# With PROJECT_ROOT_PATH set to unittest_folder (project-based mode):
+#   └── unittest_folder (ROOT - set via PROJECT_ROOT_PATH env var)
+#       ├── test_add.py
+#       │   └── TestAddFunction
+#       │       ├── test_add_negative_numbers
+#       │       └── test_add_positive_numbers
+#       │   └── TestDuplicateFunction
+#       │       └── test_dup_a
+#       └── test_subtract.py
+#           └── TestSubtractFunction
+#               ├── test_subtract_negative_numbers
+#               └── test_subtract_positive_numbers
+#           └── TestDuplicateFunction
+#               └── test_dup_s
 #
 # Note: This reuses the unittest_folder paths defined earlier in this file.
 project_root_unittest_folder_expected_output = {

python_files/tests/pytestadapter/test_discovery.py

@@ -428,3 +428,54 @@ def test_project_root_path_env_var():
         ), (
             f"Tests tree does not match expected value. \n Expected: {json.dumps(expected_discovery_test_output.project_root_unittest_folder_expected_output, indent=4)}. \n Actual: {json.dumps(actual_item.get('tests'), indent=4)}"
         )
+
+
+@pytest.mark.skipif(
+    sys.platform == "win32",
+)
+def test_symlink_with_project_root_path():
+    """Test pytest discovery with both symlink and PROJECT_ROOT_PATH set.
+
+    This tests the combination of:
+    1. A symlinked test directory (--rootdir points to symlink)
+    2. PROJECT_ROOT_PATH set to the symlink path
+
+    This simulates project-based testing where the project root is a symlink,
+    ensuring test IDs and paths are correctly resolved through the symlink.
+    """
+    with helpers.create_symlink(helpers.TEST_DATA_PATH, "root", "symlink_folder") as (
+        source,
+        destination,
+    ):
+        assert destination.is_symlink()
+
+        # Run pytest with:
+        # - cwd being the resolved symlink path (simulating subprocess from node)
+        # - PROJECT_ROOT_PATH set to the symlink destination
+        actual = helpers.runner_with_cwd_env(
+            ["--collect-only", f"--rootdir={os.fspath(destination)}"],
+            source,  # cwd is the resolved (non-symlink) path
+            {"PROJECT_ROOT_PATH": os.fspath(destination)},  # Project root is the symlink
+        )
+
+        expected = expected_discovery_test_output.symlink_expected_discovery_output
+        assert actual
+        actual_list: List[Dict[str, Any]] = actual
+        if actual_list is not None:
+            actual_item = actual_list.pop(0)
+            try:
+                assert all(item in actual_item for item in ("status", "cwd", "error")), (
+                    "Required keys are missing"
+                )
+                assert actual_item.get("status") == "success", (
+                    f"Status is not 'success', error is: {actual_item.get('error')}"
+                )
+                # cwd should be the PROJECT_ROOT_PATH (the symlink destination)
+                assert actual_item.get("cwd") == os.fspath(destination), (
+                    f"CWD does not match symlink path: expected {os.fspath(destination)}, got {actual_item.get('cwd')}"
+                )
+                assert actual_item.get("tests") == expected, "Tests do not match expected value"
+            except AssertionError as e:
+                # Print the actual_item in JSON format if an assertion fails
+                print(json.dumps(actual_item, indent=4))
+                pytest.fail(str(e))

src/client/testing/testController/common/projectAdapter.ts

@@ -9,22 +9,18 @@ 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).
- * Projects are keyed by projectUri.toString()
+ * Projects are uniquely identified by their projectUri (use projectUri.toString() for map keys).
  */
 export interface ProjectAdapter {
     // === IDENTITY ===
-    /**
-     * Project identifier, which is the string representation of the project URI.
-     */
-    projectId: string;
-
     /**
      * Display name for the project (e.g., "alice (Python 3.11)").
      */
     projectName: string;
 
     /**
      * URI of the project root folder or file.
+     * This is the unique identifier for the project.
      */
     projectUri: Uri;
 

src/client/testing/testController/common/projectUtils.ts

@@ -64,7 +64,6 @@ export function createProjectDisplayName(projectName: string, pythonVersion: str
 
 /**
  * Creates test adapters (discovery and execution) for a given test provider.
- * Centralizes adapter creation to avoid code duplication across Controller and TestProjectRegistry.
  *
  * @param testProvider The test framework provider ('pytest' | 'unittest')
  * @param resultResolver The result resolver to use for test results

src/client/testing/testController/common/resultResolver.ts

@@ -28,7 +28,7 @@ export class PythonResultResolver implements ITestResultResolver {
 
     /**
      * Optional project ID for scoping test IDs.
-     * When set, all test IDs are prefixed with "{projectId}|" for project-based testing.
+     * When set, all test IDs are prefixed with `{projectId}@@vsc@@` for project-based testing.
      * When undefined, uses legacy workspace-level IDs for backward compatibility.
      */
     private projectId?: string;

src/client/testing/testController/common/testProjectRegistry.ts

@@ -25,15 +25,23 @@ import { PythonResultResolver } from './resultResolver';
  * - Computing nested project relationships for ignore lists
  * - Fallback to default "legacy" project when API unavailable
  *
- * Key concepts:
- * - Workspace: A VS Code workspace folder (may contain multiple projects)
- * - Project: A Python project within a workspace (has its own pyproject.toml, etc.)
- * - Each project gets its own test tree root and Python environment
+ * **Key concepts:**
+ * - **Workspace:** A VS Code workspace folder (may contain multiple projects)
+ * - **Project:** A Python project within a workspace (identified by pyproject.toml, setup.py, etc.)
+ * - **ProjectUri:** The unique identifier for a project (the URI of the project root directory)
+ * - Each project gets its own test tree root, Python environment, and test adapters
+ *
+ * **Project identification:**
+ * Projects are identified and tracked by their URI (projectUri.toString()). This matches
+ * how the Python Environments extension stores projects in its Map<string, PythonProject>.
  */
 export class TestProjectRegistry {
     /**
-     * Map of workspace URI -> Map of project ID -> ProjectAdapter
-     * Project IDs match Python Environments extension's Map<string, PythonProject> keys
+     * Map of workspace URI -> Map of project URI string -> ProjectAdapter
+     *
+     * Projects are keyed by their URI string (projectUri.toString()) which matches how
+     * the Python Environments extension identifies projects. This enables O(1) lookups
+     * when given a project URI.
      */
     private readonly workspaceProjects: Map<Uri, Map<string, ProjectAdapter>> = new Map();
 
@@ -44,13 +52,6 @@ export class TestProjectRegistry {
         private readonly envVarsService: IEnvironmentVariablesProvider,
     ) {}
 
-    /**
-     * Checks if project-based testing is available (Python Environments API).
-     */
-    public isProjectBasedTestingAvailable(): boolean {
-        return useEnvExtension();
-    }
-
     /**
      * Gets the projects map for a workspace, if it exists.
      */
@@ -103,7 +104,7 @@ export class TestProjectRegistry {
         const projects = this.getProjectsArray(workspaceUri);
 
         for (const project of projects) {
-            const ignorePaths = projectIgnores.get(project.projectId);
+            const ignorePaths = projectIgnores.get(getProjectId(project.projectUri));
             if (ignorePaths && ignorePaths.length > 0) {
                 project.nestedProjectPathsToIgnore = ignorePaths;
                 traceInfo(`[test-by-project] ${project.projectName} will ignore nested: ${ignorePaths.join(', ')}`);
@@ -171,6 +172,12 @@ export class TestProjectRegistry {
 
     /**
      * Creates a ProjectAdapter from a PythonProject.
+     *
+     * Each project gets its own isolated test infrastructure:
+     * - **ResultResolver:** Handles mapping test IDs and processing results for this project
+     * - **DiscoveryAdapter:** Discovers tests scoped to this project's root directory
+     * - **ExecutionAdapter:** Runs tests for this project using its Python environment
+     *
      */
     private async createProjectAdapter(pythonProject: PythonProject, workspaceUri: Uri): Promise<ProjectAdapter> {
         const projectId = getProjectId(pythonProject.uri);
@@ -196,7 +203,6 @@ export class TestProjectRegistry {
         const projectName = createProjectDisplayName(pythonProject.name, pythonEnvironment.version);
 
         return {
-            projectId,
             projectName,
             projectUri: pythonProject.uri,
             workspaceUri,
@@ -246,7 +252,6 @@ export class TestProjectRegistry {
         };
 
         return {
-            projectId: getProjectId(workspaceUri),
             projectName: pythonProject.name,
             projectUri: workspaceUri,
             workspaceUri,
@@ -263,6 +268,9 @@ export class TestProjectRegistry {
 
     /**
      * Identifies nested projects and returns ignore paths for parent projects.
+     *
+     * **Time complexity:** O(n²) where n is the number of projects in the workspace.
+     * For each project, checks all other projects to find nested relationships.
      */
     private computeNestedProjectIgnores(workspaceUri: Uri): Map<string, string[]> {
         const ignoreMap = new Map<string, string[]>();
@@ -274,7 +282,8 @@ export class TestProjectRegistry {
             const nestedPaths: string[] = [];
 
             for (const child of projects) {
-                if (parent.projectId === child.projectId) continue;
+                // Skip self-comparison using URI
+                if (parent.projectUri.toString() === child.projectUri.toString()) continue;
 
                 const parentPath = parent.projectUri.fsPath;
                 const childPath = child.projectUri.fsPath;
@@ -286,7 +295,7 @@ export class TestProjectRegistry {
             }
 
             if (nestedPaths.length > 0) {
-                ignoreMap.set(parent.projectId, nestedPaths);
+                ignoreMap.set(getProjectId(parent.projectUri), nestedPaths);
             }
         }