test discovery 2.0 #25760
Draft
test discovery 2.0 #25760
+2,214
−103
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 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 <26030610+eleanorjboyd@users.noreply.github.com>
- Added project-based state maps (workspaceProjects, vsIdToProject, fileUriToProject, projectToVsIds) - Implemented discoverWorkspaceProjects() to query Python Environment API - Created createProjectAdapter() to build ProjectAdapter from PythonProject - Added createDefaultProject() for backward compatibility - Imported necessary types from environment API - Added flag to enable/disable project-based testing Co-authored-by: eleanorjboyd <26030610+eleanorjboyd@users.noreply.github.com>
- Modified activate() to check useProjectBasedTesting flag - Calls discoverWorkspaceProjects() for each workspace when enabled - Populates workspaceProjects map with discovered projects - Created activateLegacyWorkspace() for backward compatibility - Falls back to legacy mode if project discovery fails - Maintains full backward compatibility with flag disabled Co-authored-by: eleanorjboyd <26030610+eleanorjboyd@users.noreply.github.com>
eleanorjboyd
added
feature-request
There was a problem hiding this comment.
Pull request overview
This PR implements project-based test discovery for pytest, enabling multi-project workspace support where each Python project gets its own test tree root with its own Python environment. When the Python Environments API is available, the extension now discovers Python projects within workspaces and creates separate test adapters for each project.
Changes:
- Introduces TestProjectRegistry for managing project lifecycle, discovery, and nested project handling
- Adds ProjectAdapter interface representing individual Python projects with test infrastructure
- Implements Python-side
get_test_root_path()function to support project-scoped test trees - Adds comprehensive unit tests for project registry, utilities, and Python-side functions
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/client/testing/testController/controller.ts | Refactored activation to support project-based and legacy modes, added project discovery orchestration |
| src/client/testing/testController/common/testProjectRegistry.ts | New registry class managing Python project discovery, adapter creation, and nested project ignore lists |
| src/client/testing/testController/common/projectAdapter.ts | New interface defining structure for project-based test infrastructure |
| src/client/testing/testController/common/projectUtils.ts | Utility functions for project ID generation, display names, and adapter creation |
| src/client/testing/testController/common/resultResolver.ts | Added optional projectId parameter for scoping test IDs to projects |
| src/client/testing/testController/common/utils.ts | Modified populateTestTree to support project-scoped test IDs with separator |
| src/client/testing/testController/common/types.ts | Extracted ITestItemMappings interface, added optional project parameter to ITestDiscoveryAdapter |
| src/client/testing/testController/common/testDiscoveryHandler.ts | Updated error node creation to support project-scoped IDs |
| src/client/testing/testController/pytest/pytestDiscoveryAdapter.ts | Added PROJECT_ROOT_PATH env var and --ignore flags for nested projects |
| python_files/vscode_pytest/init.py | Implemented get_test_root_path() function to return project root or cwd for test tree structure |
| src/test/testing/testController/controller.unit.test.ts | Added tests for controller project-based testing functionality |
| src/test/testing/testController/common/testProjectRegistry.unit.test.ts | Comprehensive tests for TestProjectRegistry class |
| src/test/testing/testController/common/projectUtils.unit.test.ts | Tests for project utility functions (getProjectId, parseVsId, createProjectDisplayName) |
| python_files/tests/pytestadapter/test_discovery.py | Added test_project_root_path_env_var() to verify PROJECT_ROOT_PATH behavior |
| python_files/tests/pytestadapter/expected_discovery_test_output.py | Added expected output for PROJECT_ROOT_PATH test scenario |
| .github/instructions/testing_feature_area.instructions.md | Documented project-based testing architecture and workflow |
| .github/instructions/testing-workflow.instructions.md | Added learning about stubbing after refactoring |
src/client/testing/testController/common/testProjectRegistry.ts
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR implements project-based test discovery for pytest, enabling multi-project workspace support. When the Python Environments API is available, the extension now discovers Python projects within workspaces and creates separate test tree roots for each project with its own Python environment.
What's New
Project-Based Testing Architecture
TestProjectRegistry: Manages the lifecycle of Python test projects, including:
ProjectAdapter: Interface representing a single Python project with test infrastructure:
Key Features
--ignoreflagsget_test_root_path()function returns appropriate root for test treeCode Improvements
[test-by-project]across all filescreateTestAdapters()helper methodScope & Limitations
Testing
TestProjectRegistryclassget_test_root_path()functionRelated Issues
first step in: microsoft/vscode-python-environments#987