docs: update e2e README with comprehensive test suite reference#747
Open
docs: update e2e README with comprehensive test suite reference#747
Conversation
The README was outdated (3 of 15 test classes, ~35 of 62 base tests, 3 of 11 fixture directories). Rewritten to accurately document all scenarios, markers, CI/CD execution, fixtures, and test categories.
This reverts commit c568f68.
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
The
tests/e2e/README.mdwas significantly outdated — it documented only 3 of 15 test classes, ~35 of 62 base tests, and 3 of 11 fixture directories. This PR rewrites it to accurately reflect the current state of the E2E test suite.Closes
N/A
Related Issue(s)
N/A
Type of Change
Test Framework Affected
Network as Code (NaC) Architecture Affected
Platform Tested
N/A — documentation-only change.
Key Changes
.github/workflows/test.yml(Linux + Windows matrix)@pytest.mark.e2e,@pytest.mark.windows,skipif)E2EScenariodataclass fieldsTesting Done
Test Commands Used
# Documentation-only change — no test commands neededChecklist
Additional Notes
All counts and details were verified against the actual source files (
config.py,conftest.py,test_e2e_scenarios.py,html_helpers.py,.github/workflows/test.yml).