[ViPPET] Implement API route coverage check for functional tests#2009
Open
[ViPPET] Implement API route coverage check for functional tests#2009
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an automated “API route coverage” safety net to the ViPPET functional test suite by recording all HTTP calls made during the pytest session and verifying they cover every endpoint declared in the live OpenAPI spec. Also expands functional coverage for validation-job endpoints.
Changes:
- Introduce a new functional test that compares recorded HTTP calls vs
/openapi.jsonroutes and fails if any endpoints were never exercised. - Update the shared
http_clientfixture to record every outgoing API request for the session. - Add functional coverage for
GET /jobs/validation/statusandGET /jobs/validation/{job_id}in the pipelines validation test.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| tools/visual-pipeline-and-platform-evaluation-tool/vippet/tests/functional/test_z_api_coverage.py | New end-of-suite coverage assertion against the live OpenAPI spec, with an exclusion list. |
| tools/visual-pipeline-and-platform-evaluation-tool/vippet/tests/functional/conftest.py | Wraps the session-scoped HTTP client to accumulate (METHOD, URL) pairs for later coverage checking. |
| tools/visual-pipeline-and-platform-evaluation-tool/vippet/tests/functional/test_pipelines_validate.py | Adds calls/assertions for validation job listing and summary endpoints to close coverage gaps. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
.../visual-pipeline-and-platform-evaluation-tool/vippet/tests/functional/test_z_api_coverage.py
Show resolved
Hide resolved
p-zak
approved these changes
Mar 20, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR introduces an automated API route coverage check for the VIPPET functional test suite. The check verifies that every HTTP endpoint declared in the live OpenAPI spec (
/openapi.json) is exercised at least once during a full test run, preventing newly added or renamed routes from silently falling through without any test coverage.In addition, functional test coverage is added for API endpoints that were previously missing test cases.
Checklist: