opensearch-benchmark icon indicating copy to clipboard operation
opensearch-benchmark copied to clipboard

Rename execute-test and test_executions

Open IanHoang opened this issue 2 years ago • 2 comments

Is your feature request related to a problem? Please describe.

We should rename execute-test to reduce keystrokes and to make it more concise. As mentioned in #238, we should stray away from using the term execute.

For example, to look at past test executions, users are running opensearch-benchmark list test_executions. We have received feedback that there is inconsistency where some components have hyphens (such as opensearch-plugins and some have underscores (such as test_executions and provision_config_instances).

Describe the solution you'd like

Suggestion: Switch to run. This is a better candidate than start as it could imply that user needs to stop the test even though OSB stops after running all operations and test procedures. We can also rename the class TestExecution to TestRun

We will need to have a breaking changes file and update it whenever we update something like this.

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

IanHoang avatar May 25 '23 16:05 IanHoang

Is this issue being resolved with PR #341?

beaioun avatar Oct 17 '23 23:10 beaioun

@beaioun Yes, that's correct! I should have labeled the issue in the PR.

IanHoang avatar Oct 17 '23 23:10 IanHoang