Task/12361 help refactor v1 - #62
Merged
Merged
Conversation
Group the 24 flat help lines into logical sections (Connection, Test selection, Traffic, Suricata, Results and logging, Advanced) with an aligned two-column layout rendered via a quoted heredoc, instead of one echo per line. Surface defaults inline (traffic duration 300, hugepages 6G, log level INFO) and document the .env fallback variables. Option parsing is unchanged; only the help text presentation differs.
There was a problem hiding this comment.
🟡 Changes recommended
The updated help text claims to document .env fallback variables but currently omits several variables that the script actually uses, making the help inaccurate/incomplete.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR refactors pytest_start.sh help output by replacing many individual echo calls with quoted heredocs and organizing options into clearer sections, while keeping option parsing unchanged.
Changes:
- Replaced
usage()andbinary_search_usage()help output with quoted heredocs. - Grouped main help into logical sections (Connection, Test selection, Traffic, Suricata, Results and logging, Advanced) and surfaced some defaults inline.
- Added a note about
.env-provided defaults (currently incomplete vs the script’s actual environment variable fallbacks).
File summaries
| File | Description |
|---|---|
| pytest_start.sh | Reformats and reorganizes CLI help text using heredocs and sections; no option parsing changes. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Collaborator
|
otherwise accepted |
Create .env.example listing all 13 fallback variables pytest_start.sh consumes, with the corresponding script flags and built-in defaults. Point the README's Environment variables section at it and complete the variable list there (adds the previously undocumented DEFAULT_SUITE_LOG_FILE; the flag mapping now accompanies each entry). Also fix the -h help text to list every variable instead of an ellipsis, so it no longer contradicts the PR description.
Replace real hostnames and MAC address with generic placeholders so the example file doesn't reference specific lab machines.
The lint job needs nothing but ruff, yet it installed the entire requirements.txt (lbr_trex_client, scapy, paramiko, cryptography builds). Extract the pinned ruff version from requirements.txt instead, keeping CI and the declared dependency in sync while making the job faster and less flaky.
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.
Group the 24 flat help lines into logical sections (Connection, Test selection, Traffic, Suricata, Results and logging, Advanced) with an aligned two-column layout rendered via a quoted heredoc, instead of one echo per line. Surface defaults inline (traffic duration 300, hugepages 6G, log level INFO) and document the .env fallback variables. Option parsing is unchanged; only the help text presentation differs.