From ef46627f1f13a6135bc197ec108acecf3cdf3c30 Mon Sep 17 00:00:00 2001 From: Peter Sprygada Date: Tue, 30 Aug 2016 17:12:52 -0400 Subject: [PATCH] added new functionality to ops_command * commands argument now accepts a dict arguments * waitfor has been renamed to wait_for with an alias to waitfor * only show commands are allowed when check mode is specified * config mode is no longer allowed in the command stack * add argument match with valid values any, all Tested on OpenSwitch 0.4.0 --- .../modules/network/openswitch/ops_command.py | 148 ++++++++++++------ 1 file changed, 102 insertions(+), 46 deletions(-) diff --git a/lib/ansible/modules/network/openswitch/ops_command.py b/lib/ansible/modules/network/openswitch/ops_command.py index 27a668ff203..f74ef6191fb 100644 --- a/lib/ansible/modules/network/openswitch/ops_command.py +++ b/lib/ansible/modules/network/openswitch/ops_command.py @@ -37,15 +37,29 @@ options: module is not returned until the condition is satisfied or the number of retires as expired. required: true - waitfor: + wait_for: description: - List of conditions to evaluate against the output of the - command. The task will wait for a each condition to be true + command. The task will wait for each condition to be true before moving forward. If the conditional is not true - within the configured number of I(retries), the task fails. + within the configured number of retries, the task fails. See examples. required: false default: null + aliases: ['waitfor'] + version_added: "2.2" + match: + description: + - The I(match) argument is used in conjunction with the + I(wait_for) argument to specify the match policy. Valid + values are C(all) or C(any). If the value is set to C(all) + then all conditionals in the I(wait_for) must be satisfied. If + the value is set to C(any) then only one of the values must be + satisfied. + required: false + default: all + choices: ['any', 'all'] + version_added: "2.2" retries: description: - Specifies the number of retries a command should by tried @@ -65,21 +79,32 @@ options: """ EXAMPLES = """ +# Note: examples below use the following provider dict to handle +# transport and authentication to the node. +vars: + cli: + host: "{{ inventory_hostname }}" + username: netop + password: netop + transport: cli + - ops_command: commands: - show version - register: output + provider: "{{ cli }}" - ops_command: commands: - show version - waitfor: + wait_for: - "result[0] contains OpenSwitch" + provider: "{{ cli }}" - ops_command: - commands: - - show version - - show interfaces + commands: + - show version + - show interfaces + provider: "{{ cli }}" """ RETURN = """ @@ -101,9 +126,12 @@ failed_conditions: type: list sample: ['...', '...'] """ +from ansible.module_utils.basic import get_exception +from ansible.module_utils.netcli import CommandRunner +from ansible.module_utils.netcli import AddCommandError, FailedConditionsError +from ansible.module_utils.openswitch import NetworkModule, NetworkError -import time - +VALID_KEYS = ['command', 'prompt', 'response'] def to_lines(stdout): for item in stdout: @@ -111,57 +139,85 @@ def to_lines(stdout): item = str(item).split('\n') yield item +def parse_commands(module): + for cmd in module.params['commands']: + if isinstance(cmd, basestring): + cmd = dict(command=cmd, output=None) + elif 'command' not in cmd: + module.fail_json(msg='command keyword argument is required') + elif not set(cmd.keys()).issubset(VALID_KEYS): + module.fail_json(msg='unknown keyword specified') + yield cmd def main(): spec = dict( - commands=dict(type='list'), - waitfor=dict(type='list'), + # { command: , prompt: , response: } + commands=dict(type='list', required=True), + + wait_for=dict(type='list', aliases=['waitfor']), + match=dict(default='all', choices=['all', 'any']), + retries=dict(default=10, type='int'), - interval=dict(default=1, type='int'), - transport=dict(default='cli', choices=['cli']) + interval=dict(default=1, type='int') ) - module = get_module(argument_spec=spec, - supports_check_mode=True) + module = NetworkModule(argument_spec=spec, + connect_on_load=False, + supports_check_mode=True) - commands = module.params['commands'] + commands = list(parse_commands(module)) + conditionals = module.params['wait_for'] or list() - retries = module.params['retries'] - interval = module.params['interval'] + warnings = list() - try: - queue = set() - for entry in (module.params['waitfor'] or list()): - queue.add(Conditional(entry)) - except AttributeError: - exc = get_exception() - module.fail_json(msg=exc.message) + runner = CommandRunner(module) - result = dict(changed=False) + for cmd in commands: + if module.check_mode and not cmd['command'].startswith('show'): + warnings.append('only show commands are supported when using ' + 'check mode, not executing `%s`' % cmd['command']) + else: + if cmd['command'].startswith('conf'): + module.fail_json(msg='ops_command does not support running ' + 'config mode commands. Please use ' + 'ops_config instead') + try: + runner.add_command(**cmd) + except AddCommandError: + exc = get_exception() + warnings.append('duplicate command detected: %s' % cmd) - while retries > 0: - response = module.execute(commands) - result['stdout'] = response + for item in conditionals: + runner.add_conditional(item) - for item in list(queue): - if item(response): - queue.remove(item) + runner.retries = module.params['retries'] + runner.interval = module.params['interval'] + runner.match = module.params['match'] - if not queue: - break + try: + runner.run() + except FailedConditionsError: + exc = get_exception() + module.fail_json(msg=str(exc), failed_conditions=exc.failed_conditions) + except NetworkError: + exc = get_exception() + module.fail_json(msg=str(exc)) - time.sleep(interval) - retries -= 1 - else: - failed_conditions = [item.raw for item in queue] - module.fail_json(msg='timeout waiting for value', failed_conditions=failed_conditions) + result = dict(changed=False, stdout=list()) + for cmd in commands: + try: + output = runner.get_command(cmd['command']) + except ValueError: + output = 'command not executed due to check_mode, see warnings' + result['stdout'].append(output) + + result['warnings'] = warnings result['stdout_lines'] = list(to_lines(result['stdout'])) - return module.exit_json(**result) -from ansible.module_utils.basic import * -from ansible.module_utils.shell import * -from ansible.module_utils.netcfg import * -from ansible.module_utils.openswitch import * + module.exit_json(**result) + + if __name__ == '__main__': - main() + main() +