Change run-test to run #901
Merged
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
- CLI command updated from 'run-test' to 'run' - Legacy 'execute-test' command shows helpful suggestion to use 'run' - All unit tests pass (1317 passed, 5 skipped) - Integration tests show core functionality working (15 passed) - End-to-end CLI testing confirms proper functionality Resolves: CLI command change from run-test to run for OSB 2.0.0 Signed-off-by: Aman Ahmad <[email protected]>
aman825
requested review from
IanHoang,
gkamat,
beaioun,
rishabh6788,
VijayanB and
OVI3D0
as code owners
aman825
changed the title
IanHoang
reviewed
Jul 28, 2025
osbenchmark/benchmark.py
Outdated
| Check for common command mistakes and provide helpful suggestions | ||
| Returns True if suggestion was provided, False otherwise | ||
| """ | ||
| if len(sys.argv) > 1 and sys.argv[1] == "execute-test": |
There was a problem hiding this comment.
This is good. One minor suggestion:
Since this method is for common command mistakes, it'd be nice to have a list of deprecated commands that this list can access. This would make the function more robust.
DEPRECATED_SUBCOMMANDS = ["execute-test", "execute"]
if len(sys.argv) > 1 and sys.argv[1] in DEPRECATED_SUBCOMMANDS:
IanHoang
reviewed
Jul 28, 2025
osbenchmark/benchmark.py
Outdated
| @@ -1203,6 +1216,10 @@ def main(): | |||
| # Early init of console output so we start to show everything consistently. | |||
| console.init(quiet=False) | |||
|
|
|||
| # Handle command suggestions before argument parsing | |||
| if handle_command_suggestions(): | |||
| return | |||
There was a problem hiding this comment.
Nit: would replace return with sys.exit(1). While this works, sys.exit(1) is more suitable to clearly communicate to users and developers that this error prevents the tool from operating.
- Add DEPRECATED_SUBCOMMANDS list to handle_command_suggestions() for better maintainability - Change condition from hardcoded 'execute-test' to use list membership check - Replace return with sys.exit(1) for proper command-line error handling This makes it easier to add new deprecated commands and provides clearer program termination behavior with appropriate exit codes. Signed-off-by: Aman Ahmad <[email protected]>
|
Added the suggested changes |
IanHoang
approved these changes
Jul 28, 2025
gkamat
pushed a commit
that referenced
this pull request
Aug 1, 2025
Signed-off-by: Aman Ahmad <[email protected]> Co-authored-by: Aman Ahmad <[email protected]> Signed-off-by: Ian Hoang <[email protected]>
gkamat
pushed a commit
to gkamat/opensearch-benchmark
that referenced
this pull request
Aug 18, 2025
Signed-off-by: Aman Ahmad <[email protected]> Co-authored-by: Aman Ahmad <[email protected]> Signed-off-by: Ian Hoang <[email protected]>
gkamat
pushed a commit
to gkamat/opensearch-benchmark
that referenced
this pull request
Aug 18, 2025
Signed-off-by: Aman Ahmad <[email protected]> Co-authored-by: Aman Ahmad <[email protected]> Signed-off-by: Ian Hoang <[email protected]>
gkamat
pushed a commit
that referenced
this pull request
Aug 19, 2025
Signed-off-by: Aman Ahmad <[email protected]> Co-authored-by: Aman Ahmad <[email protected]> Signed-off-by: Ian Hoang <[email protected]>
IanHoang
pushed a commit
that referenced
this pull request
Aug 20, 2025
Signed-off-by: Aman Ahmad <[email protected]> Co-authored-by: Aman Ahmad <[email protected]> Signed-off-by: Ian Hoang <[email protected]>
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
Updates the CLI command from run-test to run for OpenSearch Benchmark 2.0.0. Legacy command suggestions are maintained for users who might still try the old "execute-test" command, providing helpful guidance to use the new "run" command.
Issues Resolved
#875
Testing
Unit Tests: All 1317 unit tests pass, 5 skipped - confirms no regression in core functionality
Integration Tests: 15 out of 19 integration tests pass - core benchmark functionality working correctly (4 failures are infrastructure-related, not CLI-related)
End-to-End CLI Testing:
Verified opensearch-benchmark run --help works correctly
Verified opensearch-benchmark --help shows "run" as primary command
Verified legacy command suggestion: opensearch-benchmark execute-test shows "Did you mean 'run'?" message
Tested basic CLI functionality with workload listing and command parsing
Manual Testing: Confirmed CLI command structure is correct and user-friendly error messages are displayed for legacy commands
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.