performa/shaker
Code Issues Proposed changes

Adjust new config options to use dash instead of underscore

Browse Source 
There are 3 recently added config options that have underscores instead
of dashes:
 * custom_user_opts (added in I96b6e578eb59813e5e0c8a2fe7a14c5ecc369be7)
 * scenario_availability_zone and scenario_compute_nodes
   (both added in I5459150a0eac9bed6a6a62a126bd9ec0648941fe)
The rest of options are declared with words separated by dashes. This patch
makes name style consistent across the project. The change affects CLI only.

Change-Id: I9d799827a36682fbe7ae73b22bcbaaf2f05afd6e
This commit is contained in:
Ilya Shakhat
2018-12-10 10:22:24 +01:00
parent 249ad453a4
commit 6bddae1810
4 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/tools/shaker-all-in-one.txt
View File

@@ -3,7 +3,7 @@ usage: shaker-all-in-one [-h] [--agent-join-timeout AGENT_JOIN_TIMEOUT]
[--artifacts-dir ARTIFACTS_DIR] [--book BOOK] [--artifacts-dir ARTIFACTS_DIR] [--book BOOK]
[--cleanup] [--cleanup-on-error] [--config-dir DIR] [--cleanup] [--cleanup-on-error] [--config-dir DIR]
[--config-file PATH] [--config-file PATH]
[--custom_user_opts CUSTOM_USER_OPTS] [--debug] [--custom-user-opts CUSTOM_USER_OPTS] [--debug]
[--dns-nameservers DNS_NAMESERVERS] [--dns-nameservers DNS_NAMESERVERS]
[--external-net EXTERNAL_NET] [--external-net EXTERNAL_NET]
[--flavor-disk FLAVOR_DISK] [--flavor-disk FLAVOR_DISK]
@@ -34,8 +34,8 @@ usage: shaker-all-in-one [-h] [--agent-join-timeout AGENT_JOIN_TIMEOUT]
[--polling-interval POLLING_INTERVAL] [--polling-interval POLLING_INTERVAL]
[--report REPORT] [--report-template REPORT_TEMPLATE] [--report REPORT] [--report-template REPORT_TEMPLATE]
[--scenario SCENARIO] [--scenario SCENARIO]
[--scenario_availability_zone SCENARIO_AVAILABILITY_ZONE] [--scenario-availability-zone SCENARIO_AVAILABILITY_ZONE]
[--scenario_compute_nodes SCENARIO_COMPUTE_NODES] [--scenario-compute-nodes SCENARIO_COMPUTE_NODES]
[--server-endpoint SERVER_ENDPOINT] [--server-endpoint SERVER_ENDPOINT]
[--subunit SUBUNIT] [--subunit SUBUNIT]
[--syslog-log-facility SYSLOG_LOG_FACILITY] [--syslog-log-facility SYSLOG_LOG_FACILITY]
@@ -70,7 +70,7 @@ optional arguments:
--config-file PATH Path to a config file to use. Multiple config files --config-file PATH Path to a config file to use. Multiple config files
can be specified, with values in later files taking can be specified, with values in later files taking
precedence. Defaults to None. precedence. Defaults to None.
--custom_user_opts CUSTOM_USER_OPTS --custom-user-opts CUSTOM_USER_OPTS
Set custom user option parameters for the scenario. Set custom user option parameters for the scenario.
The value is specified in YAML, e.g. custom_user_opts The value is specified in YAML, e.g. custom_user_opts
= { key1:value1, key2:value2} The values specified can = { key1:value1, key2:value2} The values specified can
@@ -235,12 +235,12 @@ optional arguments:
"openstack/udp_l3_north_south", "spot/ping", "openstack/udp_l3_north_south", "spot/ping",
"spot/tcp", "spot/udp". Defaults to "spot/tcp", "spot/udp". Defaults to
env[SHAKER_SCENARIO]. env[SHAKER_SCENARIO].
--scenario_availability_zone SCENARIO_AVAILABILITY_ZONE --scenario-availability-zone SCENARIO_AVAILABILITY_ZONE
Comma-separated list of availability_zone. If Comma-separated list of availability_zone. If
specified this setting will override the specified this setting will override the
availability_zone accomodation setting in the scenario availability_zone accomodation setting in the scenario
test definition.Defaults to SCENARIO_AVAILABILITY_ZONE test definition.Defaults to SCENARIO_AVAILABILITY_ZONE
--scenario_compute_nodes SCENARIO_COMPUTE_NODES --scenario-compute-nodes SCENARIO_COMPUTE_NODES
Number of compute_nodes. If specified this setting Number of compute_nodes. If specified this setting
will override the compute_nodes accomodation setting will override the compute_nodes accomodation setting
in the scenario test definition. Defaults to in the scenario test definition. Defaults to

12
doc/source/tools/shaker-spot.txt
View File

@@ -1,14 +1,14 @@
usage: shaker-spot [-h] [--artifacts-dir ARTIFACTS_DIR] [--book BOOK] usage: shaker-spot [-h] [--artifacts-dir ARTIFACTS_DIR] [--book BOOK]
[--config-dir DIR] [--config-file PATH] [--config-dir DIR] [--config-file PATH]
[--custom_user_opts CUSTOM_USER_OPTS] [--debug] [--custom-user-opts CUSTOM_USER_OPTS] [--debug]
[--log-config-append PATH] [--log-date-format DATE_FORMAT] [--log-config-append PATH] [--log-date-format DATE_FORMAT]
[--log-dir LOG_DIR] [--log-file PATH] [--matrix MATRIX] [--log-dir LOG_DIR] [--log-file PATH] [--matrix MATRIX]
[--no-report-on-error] [--nodebug] [--nono-report-on-error] [--no-report-on-error] [--nodebug] [--nono-report-on-error]
[--nouse-journal] [--nouse-json] [--nouse-syslog] [--nouse-journal] [--nouse-json] [--nouse-syslog]
[--nowatch-log-file] [--output OUTPUT] [--report REPORT] [--nowatch-log-file] [--output OUTPUT] [--report REPORT]
[--report-template REPORT_TEMPLATE] [--scenario SCENARIO] [--report-template REPORT_TEMPLATE] [--scenario SCENARIO]
[--scenario_availability_zone SCENARIO_AVAILABILITY_ZONE] [--scenario-availability-zone SCENARIO_AVAILABILITY_ZONE]
[--scenario_compute_nodes SCENARIO_COMPUTE_NODES] [--scenario-compute-nodes SCENARIO_COMPUTE_NODES]
[--subunit SUBUNIT] [--subunit SUBUNIT]
[--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-journal] [--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-journal]
[--use-json] [--use-syslog] [--watch-log-file] [--use-json] [--use-syslog] [--watch-log-file]
@@ -30,7 +30,7 @@ optional arguments:
--config-file PATH Path to a config file to use. Multiple config files --config-file PATH Path to a config file to use. Multiple config files
can be specified, with values in later files taking can be specified, with values in later files taking
precedence. Defaults to None. precedence. Defaults to None.
--custom_user_opts CUSTOM_USER_OPTS --custom-user-opts CUSTOM_USER_OPTS
Set custom user option parameters for the scenario. Set custom user option parameters for the scenario.
The value is specified in YAML, e.g. custom_user_opts The value is specified in YAML, e.g. custom_user_opts
= { key1:value1, key2:value2} The values specified can = { key1:value1, key2:value2} The values specified can
@@ -114,12 +114,12 @@ optional arguments:
"openstack/udp_l3_north_south", "spot/ping", "openstack/udp_l3_north_south", "spot/ping",
"spot/tcp", "spot/udp". Defaults to "spot/tcp", "spot/udp". Defaults to
env[SHAKER_SCENARIO]. env[SHAKER_SCENARIO].
--scenario_availability_zone SCENARIO_AVAILABILITY_ZONE --scenario-availability-zone SCENARIO_AVAILABILITY_ZONE
Comma-separated list of availability_zone. If Comma-separated list of availability_zone. If
specified this setting will override the specified this setting will override the
availability_zone accomodation setting in the scenario availability_zone accomodation setting in the scenario
test definition.Defaults to SCENARIO_AVAILABILITY_ZONE test definition.Defaults to SCENARIO_AVAILABILITY_ZONE
--scenario_compute_nodes SCENARIO_COMPUTE_NODES --scenario-compute-nodes SCENARIO_COMPUTE_NODES
Number of compute_nodes. If specified this setting Number of compute_nodes. If specified this setting
will override the compute_nodes accomodation setting will override the compute_nodes accomodation setting
in the scenario test definition. Defaults to in the scenario test definition. Defaults to

12
doc/source/tools/shaker.txt
View File

@@ -2,7 +2,7 @@ usage: shaker [-h] [--agent-join-timeout AGENT_JOIN_TIMEOUT]
[--agent-loss-timeout AGENT_LOSS_TIMEOUT] [--agent-loss-timeout AGENT_LOSS_TIMEOUT]
[--artifacts-dir ARTIFACTS_DIR] [--book BOOK] [--artifacts-dir ARTIFACTS_DIR] [--book BOOK]
[--cleanup-on-error] [--config-dir DIR] [--config-file PATH] [--cleanup-on-error] [--config-dir DIR] [--config-file PATH]
[--custom_user_opts CUSTOM_USER_OPTS] [--debug] [--custom-user-opts CUSTOM_USER_OPTS] [--debug]
[--dns-nameservers DNS_NAMESERVERS] [--dns-nameservers DNS_NAMESERVERS]
[--external-net EXTERNAL_NET] [--flavor-name FLAVOR_NAME] [--external-net EXTERNAL_NET] [--flavor-name FLAVOR_NAME]
[--image-name IMAGE_NAME] [--log-config-append PATH] [--image-name IMAGE_NAME] [--log-config-append PATH]
@@ -23,8 +23,8 @@ usage: shaker [-h] [--agent-join-timeout AGENT_JOIN_TIMEOUT]
[--os-username <auth-username>] [--output OUTPUT] [--os-username <auth-username>] [--output OUTPUT]
[--polling-interval POLLING_INTERVAL] [--report REPORT] [--polling-interval POLLING_INTERVAL] [--report REPORT]
[--report-template REPORT_TEMPLATE] [--scenario SCENARIO] [--report-template REPORT_TEMPLATE] [--scenario SCENARIO]
[--scenario_availability_zone SCENARIO_AVAILABILITY_ZONE] [--scenario-availability-zone SCENARIO_AVAILABILITY_ZONE]
[--scenario_compute_nodes SCENARIO_COMPUTE_NODES] [--scenario-compute-nodes SCENARIO_COMPUTE_NODES]
[--server-endpoint SERVER_ENDPOINT] [--subunit SUBUNIT] [--server-endpoint SERVER_ENDPOINT] [--subunit SUBUNIT]
[--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-journal] [--syslog-log-facility SYSLOG_LOG_FACILITY] [--use-journal]
[--use-json] [--use-syslog] [--watch-log-file] [--use-json] [--use-syslog] [--watch-log-file]
@@ -56,7 +56,7 @@ optional arguments:
--config-file PATH Path to a config file to use. Multiple config files --config-file PATH Path to a config file to use. Multiple config files
can be specified, with values in later files taking can be specified, with values in later files taking
precedence. Defaults to None. precedence. Defaults to None.
--custom_user_opts CUSTOM_USER_OPTS --custom-user-opts CUSTOM_USER_OPTS
Set custom user option parameters for the scenario. Set custom user option parameters for the scenario.
The value is specified in YAML, e.g. custom_user_opts The value is specified in YAML, e.g. custom_user_opts
= { key1:value1, key2:value2} The values specified can = { key1:value1, key2:value2} The values specified can
@@ -195,12 +195,12 @@ optional arguments:
"openstack/udp_l3_north_south", "spot/ping", "openstack/udp_l3_north_south", "spot/ping",
"spot/tcp", "spot/udp". Defaults to "spot/tcp", "spot/udp". Defaults to
env[SHAKER_SCENARIO]. env[SHAKER_SCENARIO].
--scenario_availability_zone SCENARIO_AVAILABILITY_ZONE --scenario-availability-zone SCENARIO_AVAILABILITY_ZONE
Comma-separated list of availability_zone. If Comma-separated list of availability_zone. If
specified this setting will override the specified this setting will override the
availability_zone accomodation setting in the scenario availability_zone accomodation setting in the scenario
test definition.Defaults to SCENARIO_AVAILABILITY_ZONE test definition.Defaults to SCENARIO_AVAILABILITY_ZONE
--scenario_compute_nodes SCENARIO_COMPUTE_NODES --scenario-compute-nodes SCENARIO_COMPUTE_NODES
Number of compute_nodes. If specified this setting Number of compute_nodes. If specified this setting
will override the compute_nodes accomodation setting will override the compute_nodes accomodation setting
in the scenario test definition. Defaults to in the scenario test definition. Defaults to

6
shaker/engine/config.py
View File

@@ -215,19 +215,19 @@ SCENARIO_OPTS = [
deprecated_for_removal=True, deprecated_for_removal=True,
default=(utils.env('SHAKER_NO_REPORT_ON_ERROR') or False), default=(utils.env('SHAKER_NO_REPORT_ON_ERROR') or False),
help='Do not generate report for failed scenarios'), help='Do not generate report for failed scenarios'),
cfg.ListOpt('scenario_availability_zone', cfg.ListOpt('scenario-availability-zone',
default=utils.env('SCENARIO_AVAILABILITY_ZONE'), default=utils.env('SCENARIO_AVAILABILITY_ZONE'),
help='Comma-separated list of availability_zone. If specified ' help='Comma-separated list of availability_zone. If specified '
'this setting will override the availability_zone ' 'this setting will override the availability_zone '
'accomodation setting in the scenario test definition.' 'accomodation setting in the scenario test definition.'
'Defaults to SCENARIO_AVAILABILITY_ZONE'), 'Defaults to SCENARIO_AVAILABILITY_ZONE'),
cfg.IntOpt('scenario_compute_nodes', cfg.IntOpt('scenario-compute-nodes',
default=utils.env('SCENARIO_COMPUTE_NODES'), default=utils.env('SCENARIO_COMPUTE_NODES'),
help='Number of compute_nodes. If specified this setting will ' help='Number of compute_nodes. If specified this setting will '
'override the compute_nodes accomodation setting in the ' 'override the compute_nodes accomodation setting in the '
'scenario test definition. ' 'scenario test definition. '
'Defaults to SCENARIO_COMPUTE_NODES'), 'Defaults to SCENARIO_COMPUTE_NODES'),
cfg.Opt('custom_user_opts', cfg.Opt('custom-user-opts',
default=utils.env('CUSTOM_USER_OPTS'), default=utils.env('CUSTOM_USER_OPTS'),
type=Yaml(), type=Yaml(),
help='Set custom user option parameters for the scenario. ' help='Set custom user option parameters for the scenario. '