Skip to content

Commit

Permalink
Merge pull request #2830 from StackStorm/register_content_fail_on_fai…
Browse files Browse the repository at this point in the history 
…lure

Update st2-register-content to fail on failue (exit with non-zero) by default
  • Loading branch information
@Kami
Kami authored Jul 27, 2016
2 parents f414296 + edabd50 commit 51eafa4
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 18 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ In development
* Allow administrator to configure maximum limit which can be specified using ``?limit``
query parameters when making API calls to get all / list endpoints. For backward compatibility
and safety reasons, the default value still is ``100``. (improvement)
* Update ``st2-register-content`` script to exit with non-zero on failure (e.g. invalid resource
metadata, etc.) by default. For backward compatibility reasons, ``--register-fail-on-failure``
flag was left there, but it now doesn't do anything since this is the default behavior. For ease
of migrations, users can revert to the old behavior by using new
``--register-no-fail-on-failure`` flag. (improvement)

1.5.1 - July 13, 2016
---------------------
Expand Down
5 changes: 3 additions & 2 deletions st2common/bin/st2ctl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ function print_usage() {
echo " --register-policies Register all policies."
echo " --register-configs Register all configuration files."
echo " --register-setup-virtualenvs Create Python virtual environments for all the registered packs."
echo " --register-fail-on-failure Exit with non-zero if resource registration fails."
echo " --register-fail-on-failure Exit with non-zero if some resource registration fails. Deprecated. This is now a default behavior."
echo " --register-no-fail-on-failure Don't exit with non-zero if some resource registration fails."
echo " --verbose Output additional debug and informational messages."
echo ""
echo "Most commands require elevated privileges."
Expand Down Expand Up @@ -114,7 +115,7 @@ function reopen_component_log_files() {
}

function register_content() {
ALLOWED_REGISTER_FLAGS='--register-all --register-actions --register-aliases --register-policies --register-rules --register-sensors --register-triggers --register-configs --register-setup-virtualenvs --register-fail-on-failure --verbose'
ALLOWED_REGISTER_FLAGS='--register-all --register-actions --register-aliases --register-policies --register-rules --register-sensors --register-triggers --register-configs --register-setup-virtualenvs --register-fail-on-failure --register-no-fail-on-failure --verbose'
DEFAULT_REGISTER_FLAGS='--register-actions --register-aliases --register-sensors --register-triggers --register-configs'
SUDO_FLAGS='--register-setup-virtualenvs'
flags="${@}"
Expand Down
24 changes: 14 additions & 10 deletions st2common/st2common/content/bootstrap.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,12 @@ def register_opts():
cfg.BoolOpt('setup-virtualenvs', default=False, help=('Setup Python virtual environments '
'all the Python runner actions.')),

cfg.BoolOpt('fail-on-failure', default=False, help=('Exit with non-zero of resource '
'registration fails.'))
cfg.BoolOpt('no-fail-on-failure', default=False,
help=('Don\'t exit with non-zero if some resource registration fails.')),
# Note: Fail on failure is now a default behavior. This flag is only left here for backward
# compatibility reasons, but it's not actually used.
cfg.BoolOpt('fail-on-failure', default=False,
help=('Exit with non-zero if some resource registration fails.'))
]
try:
cfg.CONF.register_cli_opts(content_opts, group='register')
Expand All @@ -80,7 +84,7 @@ def setup_virtualenvs():
LOG.info('=========================================================')

pack_dir = cfg.CONF.register.pack
fail_on_failure = cfg.CONF.register.fail_on_failure
fail_on_failure = not cfg.CONF.register.no_fail_on_failure

registrar = ResourceRegistrar()

Expand Down Expand Up @@ -117,7 +121,7 @@ def setup_virtualenvs():

def register_triggers():
pack_dir = cfg.CONF.register.pack
fail_on_failure = cfg.CONF.register.fail_on_failure
fail_on_failure = not cfg.CONF.register.no_fail_on_failure

registered_count = 0

Expand All @@ -139,7 +143,7 @@ def register_triggers():

def register_sensors():
pack_dir = cfg.CONF.register.pack
fail_on_failure = cfg.CONF.register.fail_on_failure
fail_on_failure = not cfg.CONF.register.no_fail_on_failure

registered_count = 0

Expand All @@ -163,7 +167,7 @@ def register_actions():
# Register runnertypes and actions. The order is important because actions require action
# types to be present in the system.
pack_dir = cfg.CONF.register.pack
fail_on_failure = cfg.CONF.register.fail_on_failure
fail_on_failure = not cfg.CONF.register.no_fail_on_failure

registered_count = 0

Expand Down Expand Up @@ -195,7 +199,7 @@ def register_actions():
def register_rules():
# Register ruletypes and rules.
pack_dir = cfg.CONF.register.pack
fail_on_failure = cfg.CONF.register.fail_on_failure
fail_on_failure = not cfg.CONF.register.no_fail_on_failure

registered_count = 0

Expand Down Expand Up @@ -223,7 +227,7 @@ def register_rules():

def register_aliases():
pack_dir = cfg.CONF.register.pack
fail_on_failure = cfg.CONF.register.fail_on_failure
fail_on_failure = not cfg.CONF.register.no_fail_on_failure

registered_count = 0

Expand All @@ -245,7 +249,7 @@ def register_aliases():
def register_policies():
# Register policy types and policies.
pack_dir = cfg.CONF.register.pack
fail_on_failure = cfg.CONF.register.fail_on_failure
fail_on_failure = not cfg.CONF.register.no_fail_on_failure

registered_type_count = 0

Expand Down Expand Up @@ -278,7 +282,7 @@ def register_policies():

def register_configs():
pack_dir = cfg.CONF.register.pack
fail_on_failure = cfg.CONF.register.fail_on_failure
fail_on_failure = not cfg.CONF.register.no_fail_on_failure

registered_count = 0

Expand Down
17 changes: 11 additions & 6 deletions st2common/tests/integration/test_register_content_script.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ def test_register_from_pack_success(self):
def test_register_from_pack_fail_on_failure_pack_dir_doesnt_exist(self):
# No fail on failure flag, should succeed
pack_dir = 'doesntexistblah'
cmd = BASE_REGISTER_ACTIONS_CMD_ARGS + ['--register-pack=%s' % (pack_dir)]
cmd = BASE_REGISTER_ACTIONS_CMD_ARGS + ['--register-pack=%s' % (pack_dir),
'--register-no-fail-on-failure']
exit_code, _, _ = run_command(cmd=cmd)
self.assertEqual(exit_code, 0)

Expand All @@ -59,7 +60,8 @@ def test_register_from_pack_fail_on_failure_pack_dir_doesnt_exist(self):
def test_register_from_pack_action_metadata_fails_validation(self):
# No fail on failure flag, should succeed
pack_dir = os.path.join(get_fixtures_packs_base_path(), 'dummy_pack_4')
cmd = BASE_REGISTER_ACTIONS_CMD_ARGS + ['--register-pack=%s' % (pack_dir)]
cmd = BASE_REGISTER_ACTIONS_CMD_ARGS + ['--register-pack=%s' % (pack_dir),
'--register-no-fail-on-failure']
exit_code, _, stderr = run_command(cmd=cmd)
self.assertTrue('Registered 0 actions.' in stderr)
self.assertEqual(exit_code, 0)
Expand All @@ -83,7 +85,8 @@ def test_register_from_packs_doesnt_throw_on_missing_pack_resource_folder(self):
self.assertTrue('Registered 0 sensors.' in stderr)
self.assertEqual(exit_code, 0)

cmd = [SCRIPT_PATH, '--config-file=conf/st2.tests1.conf', '-v', '--register-all']
cmd = [SCRIPT_PATH, '--config-file=conf/st2.tests1.conf', '-v', '--register-all',
'--register-no-fail-on-failure']
exit_code, _, stderr = run_command(cmd=cmd)
self.assertTrue('Registered 0 actions.' in stderr)
self.assertTrue('Registered 0 sensors.' in stderr)
Expand All @@ -92,7 +95,8 @@ def test_register_from_packs_doesnt_throw_on_missing_pack_resource_folder(self):

def test_register_all_and_register_setup_virtualenvs(self):
# Verify that --register-all works in combinations with --register-setuo-virtualenvs
cmd = BASE_CMD_ARGS + ['--register-all', '--register-setup-virtualenvs']
cmd = BASE_CMD_ARGS + ['--register-all', '--register-setup-virtualenvs',
'--register-no-fail-on-failure']
exit_code, stdout, stderr = run_command(cmd=cmd)
self.assertTrue('Registering actions' in stderr)
self.assertTrue('Registering rules' in stderr)
Expand All @@ -103,15 +107,16 @@ def test_register_setup_virtualenvs(self):
# Single pack
pack_dir = os.path.join(get_fixtures_packs_base_path(), 'dummy_pack_1')

cmd = BASE_CMD_ARGS + ['--register-pack=%s' % (pack_dir), '--register-setup-virtualenvs']
cmd = BASE_CMD_ARGS + ['--register-pack=%s' % (pack_dir), '--register-setup-virtualenvs',
'--register-no-fail-on-failure']
exit_code, stdout, stderr = run_command(cmd=cmd)

self.assertTrue('Setting up virtualenv for pack "dummy_pack_1"' in stderr)
self.assertTrue('Setup virtualenv for 1 pack(s)' in stderr)
self.assertEqual(exit_code, 0)

# All packs
cmd = BASE_CMD_ARGS + ['--register-setup-virtualenvs']
cmd = BASE_CMD_ARGS + ['--register-setup-virtualenvs', '--register-no-fail-on-failure']
exit_code, stdout, stderr = run_command(cmd=cmd)
self.assertTrue('Setup virtualenv for 5 pack(s)' in stderr)
self.assertEqual(exit_code, 0)

0 comments on commit 51eafa4

Please sign in to comment.