Skip to content
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.

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

Add short-hand alternatives for commonly-used command line options #639

Closed
12 tasks
IanHoang opened this issue Sep 12, 2024 · 1 comment
Closed
12 tasks
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@IanHoang
Copy link
Collaborator

IanHoang commented Sep 12, 2024

Is your feature request related to a problem? Please describe

OSB has a few command-line options that offer short hand alternatives. An example is the following, added by @peteralfonsi .

    test_execution_parser.add_argument(
        "--randomization-repeat-frequency",
        "-rf",
        help=f"The repeat_frequency for query randomization. Ignored if randomization is off"
             f"(default: {workload.loader.QueryRandomizerWorkloadProcessor.DEFAULT_RF}).",
        default=workload.loader.QueryRandomizerWorkloadProcessor.DEFAULT_RF)

This improves the user experience and removes the dread of typing out long command-line options.

Describe the solution you'd like

We should include short hand alternatives for the following commonly-used options for each subcommand:

execute-test

  • --workload
  • --target-hosts
  • --client-options
  • --workload-params
  • --test-execution-id
  • --kill-running-processes

compare

  • --baseline
  • --contender

create-workload

  • --workload
  • --indices
  • --target-hosts
  • --client-options

By only focusing on the commonly-used options, we will avoid polluting OSB's namespace with convoluted short flags while also improving the user experience. If an option that's added in the future becomes commonly-used, we can add a short flag then.

If there are other commonly-used options that I missed, please feel free to comment them below.

Describe alternatives you've considered

No response

Additional context

No response

@IanHoang IanHoang added enhancement New feature or request untriaged labels Sep 12, 2024
@IanHoang IanHoang changed the title Add short-hand options to command line Add short-hand alternatives for commonly-used command line options Sep 12, 2024
@IanHoang IanHoang added good first issue Good for newcomers and removed untriaged labels Sep 12, 2024
@OVI3D0
Copy link
Member

OVI3D0 commented Sep 30, 2024

Hey @IanHoang I can take this issue!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
Status: ✅ Done
Status: This Quarter
Development

No branches or pull requests

2 participants