remove comments

Author: eleanorjboyd

python_files/unittestadapter/pvsc_utils.py

@@ -166,44 +166,6 @@ def get_child_node(name: str, path: str, type_: TestNodeTypeEnum, root: TestNode
     return result  # type:ignore
 
 
-# TODO: Unittest nested project exclusion - commented out for now, focusing on pytest first
-# def should_exclude_file(test_path: str) -> bool:
-#     """Check if a test file should be excluded due to nested project ownership.
-#
-#     Reads NESTED_PROJECTS_TO_IGNORE environment variable (JSON array of paths)
-#     and checks if test_path is under any of those nested project directories.
-#
-#     Args:
-#         test_path: Absolute path to the test file
-#
-#     Returns:
-#         True if the file should be excluded, False otherwise
-#     """
-#     nested_projects_json = os.getenv("NESTED_PROJECTS_TO_IGNORE")
-#     if not nested_projects_json:
-#         return False
-#
-#     try:
-#         nested_paths = json.loads(nested_projects_json)
-#         test_path_obj = pathlib.Path(test_path).resolve()
-#
-#         # Check if test file is under any nested project path
-#         for nested_path in nested_paths:
-#             nested_path_obj = pathlib.Path(nested_path).resolve()
-#             try:
-#                 test_path_obj.relative_to(nested_path_obj)
-#                 # If relative_to succeeds, test_path is under nested_path
-#                 return True
-#             except ValueError:
-#                 # test_path is not under nested_path
-#                 continue
-#
-#         return False
-#     except Exception:
-#         # On any error, don't exclude (safer to show tests than hide them)
-#         return False
-
-
 def build_test_tree(
     suite: unittest.TestSuite, top_level_directory: str
 ) -> Tuple[Union[TestNode, None], List[str]]:
@@ -290,12 +252,6 @@ def build_test_tree(
             path_components = [top_level_directory, *folders, py_filename]
             file_path = os.fsdecode(pathlib.PurePath("/".join(path_components)))
 
-            # PHASE 4: Check if file should be excluded (nested project ownership)
-            # TODO: Commented out for now - focusing on pytest implementation first
-            # if should_exclude_file(file_path):
-            #     # Skip this test - it belongs to a nested project
-            #     continue
-
             current_node = get_child_node(
                 py_filename, file_path, TestNodeTypeEnum.file, current_node
             )

src/client/testing/testController/controller.ts

@@ -70,24 +70,17 @@ export class PythonTestController implements ITestController, IExtensionSingleAc
 
     /**
      * Feature flag for project-based testing.
-     * Set to true to enable multi-project testing support (Phases 2-4 must be complete).
-     * Default: false (use legacy single-workspace mode)
+     * When true, discovers and manages tests per-project using Python Environments API.
+     * When false, uses legacy single-workspace mode.
      */
     private readonly useProjectBasedTesting = true;
 
     // Legacy: Single workspace test adapter per workspace (backward compatibility)
     private readonly testAdapters: Map<Uri, WorkspaceTestAdapter> = new Map();
 
-    // === NEW: PROJECT-BASED STATE ===
-    // Map of workspace URI -> Map of project URI string -> ProjectAdapter
-    // Note: Project URI strings match Python Environments extension's Map<string, PythonProject> keys
+    // Project-based testing: Maps workspace URI -> project ID -> ProjectAdapter
     private readonly workspaceProjects: Map<Uri, Map<string, ProjectAdapter>> = new Map();
 
-    // TODO: Phase 3-4 - Add these maps when implementing execution:
-    // - vsIdToProject: Map<string, ProjectAdapter> - Fast lookup for test execution
-    // - fileUriToProject: Map<string, ProjectAdapter> - File watching and change detection
-    // - projectToVsIds: Map<string, Set<string>> - Project cleanup and refresh
-
     private readonly triggerTypes: TriggerType[] = [];
 
     private readonly testController: TestController;
@@ -333,7 +326,7 @@ export class PythonTestController implements ITestController, IExtensionSingleAc
             const pythonProjects = envExtApi.getPythonProjects();
             traceInfo(`[test-by-project] Found ${pythonProjects.length} total Python projects from API`);
 
-            // Filter projects to only those in this workspace TODO; check this
+            // Filter projects to only those in this workspace
             const workspaceProjects = pythonProjects.filter((project) =>
                 isParentPath(project.uri.fsPath, workspaceUri.fsPath),
             );
@@ -567,14 +560,11 @@ export class PythonTestController implements ITestController, IExtensionSingleAc
     }
 
     /**
-     * Phase 3: Identifies which projects are nested within other projects in the same workspace.
+     * Identifies which projects are nested within other projects in the same workspace.
      * Returns a map of parent project ID -> array of nested child project paths to ignore.
      *
      * Example: If ProjectB (alice/bob/) is nested in ProjectA (alice/),
      * returns: { "projectA-id": ["alice/bob"] }
-     *
-     * Uses simple path prefix matching - a project is nested if its path starts with
-     * another project's path followed by a path separator.
      */
     private computeNestedProjectIgnores(workspaceUri: Uri): Map<string, string[]> {
         const projectIgnores = new Map<string, string[]>();
@@ -623,9 +613,8 @@ export class PythonTestController implements ITestController, IExtensionSingleAc
     }
 
     /**
-     * Phase 2: Discovers tests for all projects within a workspace (project-based testing).
-     * Runs discovery in parallel for all projects and tracks file overlaps for Phase 3.
-     * Each project populates its TestItems independently using the existing discovery flow.
+     * Discovers tests for all projects within a workspace.
+     * Runs discovery in parallel and configures nested project exclusions.
      */
     private async refreshWorkspaceProjects(workspaceUri: Uri): Promise<void> {
         const projectsMap = this.workspaceProjects.get(workspaceUri);
@@ -638,7 +627,7 @@ export class PythonTestController implements ITestController, IExtensionSingleAc
         traceInfo(`[test-by-project] Starting discovery for ${projects.length} project(s) in workspace`);
 
         try {
-            // PHASE 3: Compute nested project relationships BEFORE discovery
+            // Compute nested project relationships BEFORE discovery
             const projectIgnores = this.computeNestedProjectIgnores(workspaceUri);
 
             // Populate each project's ignore list by iterating through projects array directly
@@ -672,34 +661,18 @@ export class PythonTestController implements ITestController, IExtensionSingleAc
 
     /**
      * Runs test discovery for a single project.
-     * Uses the existing discovery flow which populates TestItems automatically.
      */
     private async discoverProject(project: ProjectAdapter, projectsCompleted: Set<string>): Promise<void> {
         try {
             traceInfo(`[test-by-project] Discovering tests for project: ${project.projectName}`);
             project.isDiscovering = true;
 
-            // Run discovery using project's adapter with project's interpreter
-            // This will call the existing discovery flow which populates TestItems via result resolver
-            // Note: The adapter expects the legacy PythonEnvironment type, but for now we can pass
-            // the environment from the API. The adapters internally use execInfo which both types have.
-            //
-            // Pass the ProjectAdapter so discovery adapters can extract project.projectUri.fsPath
-            // and set PROJECT_ROOT_PATH environment variable. This tells Python subprocess where to
-            // trim the test tree, keeping test paths relative to project root instead of workspace root,
-            // while preserving CWD for user's test configurations.
-            //
-            // TODO: Symlink consideration - If project.projectUri.fsPath contains symlinks,
-            // Python's path resolution may differ from Node.js. Discovery adapters should consider
-            // using fs.promises.realpath() to resolve symlinks before passing PROJECT_ROOT_PATH to Python,
-            // similar to handleSymlinkAndRootDir() in pytest. This ensures PROJECT_ROOT_PATH matches
-            // the resolved path Python will use.
             await project.discoveryAdapter.discoverTests(
                 project.projectUri,
                 this.pythonExecFactory,
                 this.refreshCancellation.token,
-                project.pythonEnvironment as any, // Type cast needed - API type vs legacy type
-                project, // Pass project for access to projectUri and other project-specific data
+                project.pythonEnvironment as any,
+                project,
             );
 
             // Mark project as completed

src/client/testing/testController/pytest/pytestDiscoveryAdapter.ts

@@ -79,21 +79,14 @@ export class PytestTestDiscoveryAdapter implements ITestDiscoveryAdapter {
             const cwd = settings.testing.cwd && settings.testing.cwd.length > 0 ? settings.testing.cwd : uri.fsPath;
             pytestArgs = await handleSymlinkAndRootDir(cwd, pytestArgs);
 
-            // PHASE 4: Add --ignore flags for nested projects
-            traceVerbose(
-                `[test-by-project] Checking for nested projects to ignore. Project: ${project?.projectName}, ` +
-                    `nestedProjectPathsToIgnore length: ${project?.nestedProjectPathsToIgnore?.length ?? 0}`,
-            );
+            // Add --ignore flags for nested projects to prevent duplicate discovery
             if (project?.nestedProjectPathsToIgnore?.length) {
                 const ignoreArgs = project.nestedProjectPathsToIgnore.map((nestedPath) => `--ignore=${nestedPath}`);
                 pytestArgs = [...pytestArgs, ...ignoreArgs];
                 traceInfo(
-                    `[test-by-project] Project ${project.projectName} ignoring ${ignoreArgs.length} ` +
-                        `nested project(s): ${ignoreArgs.join(' ')}`,
-                );
-            } else {
-                traceVerbose(
-                    `[test-by-project] No nested projects to ignore for project: ${project?.projectName ?? 'unknown'}`,
+                    `[test-by-project] Project ${project.projectName} ignoring nested project(s): ${ignoreArgs.join(
+                        ' ',
+                    )}`,
                 );
             }
 
@@ -105,13 +98,7 @@ export class PytestTestDiscoveryAdapter implements ITestDiscoveryAdapter {
             // Configure subprocess environment
             const mutableEnv = await configureDiscoveryEnv(this.envVarsService, uri, discoveryPipeName);
 
-            // Set PROJECT_ROOT_PATH for project-based testing
-            // This tells Python where to trim the test tree, keeping test paths relative to project root
-            // instead of workspace root, while preserving CWD for user's test configurations.
-            // Using fsPath for cross-platform compatibility (handles Windows vs Unix paths).
-            // TODO: Symlink consideration - PROJECT_ROOT_PATH may contain symlinks. If handleSymlinkAndRootDir()
-            // resolves the CWD to a different path, PROJECT_ROOT_PATH might not match. Consider resolving
-            // PROJECT_ROOT_PATH symlinks before passing, or adjust Python-side logic to handle both paths.
+            // Set PROJECT_ROOT_PATH for project-based testing (tells Python where to root the test tree)
             if (project) {
                 mutableEnv.PROJECT_ROOT_PATH = project.projectUri.fsPath;
             }

src/client/testing/testController/unittest/testDiscoveryAdapter.ts

@@ -80,29 +80,11 @@ export class UnittestTestDiscoveryAdapter implements ITestDiscoveryAdapter {
             // Configure subprocess environment
             const mutableEnv = await configureDiscoveryEnv(this.envVarsService, uri, discoveryPipeName);
 
-            // Set PROJECT_ROOT_PATH for project-based testing
-            // This tells Python where to trim the test tree, keeping test paths relative to project root
-            // instead of workspace root, while preserving CWD for user's test configurations.
-            // Using fsPath for cross-platform compatibility (handles Windows vs Unix paths).
-            // TODO: Symlink consideration - If CWD or PROJECT_ROOT_PATH contain symlinks, path matching
-            // in Python may fail. Consider resolving symlinks before comparison, or using os.path.realpath()
-            // on the Python side to normalize paths before building test tree.
+            // Set PROJECT_ROOT_PATH for project-based testing (tells Python where to root the test tree)
             if (project) {
                 mutableEnv.PROJECT_ROOT_PATH = project.projectUri.fsPath;
             }
 
-            // PHASE 4: Pass exclusion list via environment variable for unittest
-            // TODO: unittest doesn't have a built-in --ignore flag like pytest, so we'll need to pass the
-            // nested project paths via environment and handle filtering in Python-side discovery.py
-            // Commenting out for now - focusing on pytest implementation first
-            // if (project?.nestedProjectPathsToIgnore?.length) {
-            //     mutableEnv.NESTED_PROJECTS_TO_IGNORE = JSON.stringify(project.nestedProjectPathsToIgnore);
-            //     traceInfo(
-            //         `[test-by-project] Project ${project.projectName} will exclude ${project.nestedProjectPathsToIgnore.length} ` +
-            //         `nested project(s) in Python-side unittest discovery`
-            //     );
-            // }
-
             // Setup process handlers (shared by both execution paths)
             const handlers = createProcessHandlers('unittest', uri, cwd, this.resultResolver, deferredTillExecClose);