Skip to content

Change run-test to run #901

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 28, 2025
Merged

Change run-test to run #901

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ccb493c
feat: update CLI command from run-test to run for OSB 2.0.0
Jul 27, 2025
59bbbf1
Improve deprecated command handling and error exit behavior
Jul 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions osbenchmark/benchmark.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ def add_workload_source(subparser):
dest="subcommand",
help="")

test_run_parser = subparsers.add_parser("run-test", help="Run a benchmark")
test_run_parser = subparsers.add_parser("run", help="Run a benchmark")
# change in favor of "list telemetry", "list workloads", "list pipelines"
list_parser = subparsers.add_parser("list", help="List configuration options")
list_parser.add_argument(
Expand Down Expand Up @@ -1115,7 +1115,7 @@ def dispatch_sub_command(arg_parser, args, cfg):
cfg.add(config.Scope.applicationOverride, "builder", "preserve.install", convert.to_bool(args.preserve_install))
cfg.add(config.Scope.applicationOverride, "system", "install.id", args.installation_id)
builder.stop(cfg)
elif sub_command == "run-test":
elif sub_command == "run":
iterations = int(args.test_iterations)
if iterations > 1:
test_runs = []
Expand Down Expand Up @@ -1193,6 +1193,20 @@ def dispatch_sub_command(arg_parser, args, cfg):
return False


def handle_command_suggestions():
"""
Check for common command mistakes and provide helpful suggestions
Returns True if suggestion was provided, False otherwise
"""
DEPRECATED_SUBCOMMANDS = ["execute-test", "execute"]
if len(sys.argv) > 1 and sys.argv[1] in DEPRECATED_SUBCOMMANDS:
console.info("Did you mean 'run'?")
console.info("Example: opensearch-benchmark run --workload=geonames --test-mode")
console.info("For more information, run: opensearch-benchmark run --help")
return True
return False


def main():
check_python_version()
log.install_default_log_config()
Expand All @@ -1203,6 +1217,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():
sys.exit(1)

arg_parser = create_arg_parser()
args = arg_parser.parse_args()

Expand Down
Loading