Update nxos_interface_ospf & add test (#26644)

* Update nxos_interface_ospf & add test

lib/ansible/modules/network/nxos/nxos_interface_ospf.py

@@ -124,52 +124,19 @@ EXAMPLES = '''
     ospf: 1
     area: 1
     cost: default
-    username: "{{ un }}"
-    password: "{{ pwd }}"
-    host: "{{ inventory_hostname }}"
 '''
 
 RETURN = '''
-proposed:
+commands:
-    description: k/v pairs of parameters passed into module
-    returned: verbose mode
-    type: dict
-    sample: {"area": "1", "interface": "ethernet1/32", "ospf": "1"}
-existing:
-    description: k/v pairs of existing OSPF configuration
-    returned: verbose mode
-    type: dict
-    sample: {"area": "", "cost": "", "dead_interval": "",
-            "hello_interval": "", "interface": "ethernet1/32",
-            "message_digest": false, "message_digest_algorithm_type": "",
-            "message_digest_encryption_type": "",
-            "message_digest_key_id": "", "message_digest_password": "",
-            "ospf": "", "passive_interface": false}
-end_state:
-    description: k/v pairs of OSPF configuration after module execution
-    returned: verbose mode
-    type: dict
-    sample: {"area": "0.0.0.1", "cost": "", "dead_interval": "",
-            "hello_interval": "", "interface": "ethernet1/32",
-            "message_digest": false, "message_digest_algorithm_type": "",
-            "message_digest_encryption_type": "", "message_digest_key_id": "",
-            "message_digest_password": "", "ospf": "1",
-            "passive_interface": false}
-updates:
     description: commands sent to the device
     returned: always
     type: list
     sample: ["interface Ethernet1/32", "ip router ospf 1 area 0.0.0.1"]
-changed:
-    description: check to see if a change was made on the device
-    returned: always
-    type: boolean
-    sample: true
 '''
 
 
 import re
-from ansible.module_utils.nxos import get_config, load_config, run_commands
+from ansible.module_utils.nxos import get_config, load_config
 from ansible.module_utils.nxos import nxos_argument_spec, check_args
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils.netcfg import CustomNetworkConfig
@@ -179,6 +146,7 @@ BOOL_PARAMS = [
     'message_digest'
 ]
 PARAM_TO_COMMAND_KEYMAP = {
+    'interface': '',
     'cost': 'ip ospf cost',
     'ospf': 'ip router ospf',
     'area': 'ip router ospf',
@@ -187,41 +155,29 @@ PARAM_TO_COMMAND_KEYMAP = {
     'passive_interface': 'ip ospf passive-interface',
     'message_digest': 'ip ospf authentication message-digest',
     'message_digest_key_id': 'ip ospf message-digest-key',
-    'message_digest_algorithm_type': 'ip ospf message-digest-key options',
+    'message_digest_algorithm_type': 'ip ospf message-digest-key',
-    'message_digest_encryption_type': 'ip ospf message-digest-key options',
+    'message_digest_encryption_type': 'ip ospf message-digest-key',
-    'message_digest_password': 'ip ospf message-digest-key options',
+    'message_digest_password': 'ip ospf message-digest-key',
-}
-PARAM_TO_DEFAULT_KEYMAP = {
 }
 
 
-def invoke(name, *args, **kwargs):
+def get_value(arg, config, module):
-    func = globals().get(name)
+    command = PARAM_TO_COMMAND_KEYMAP[arg]
-    if func:
+    has_command = re.search(r'\s+{0}\s*$'.format(command), config, re.M)
-        return func(*args, **kwargs)
+    has_command_val = re.search(r'(?:{0}\s)(?P<value>.*)$'.format(command), config, re.M)
 
-
+    if command == 'ip router ospf':
-def get_custom_value(arg, config, module):
         value = ''
+        if has_command_val:
+            value_list = has_command_val.group('value').split()
             if arg == 'ospf':
-        REGEX = re.compile(r'(?:ip router ospf\s)(?P<value>.*)$', re.M)
+                value = value_list[0]
-        value = ''
-        if 'ip router ospf' in config:
-            parsed = REGEX.search(config).group('value').split()
-            value = parsed[0]
-
             elif arg == 'area':
-        REGEX = re.compile(r'(?:ip router ospf\s)(?P<value>.*)$', re.M)
+                value = value_list[2]
+    elif command == 'ip ospf message-digest-key':
         value = ''
-        if 'ip router ospf' in config:
+        if has_command_val:
-            parsed = REGEX.search(config).group('value').split()
+            value_list = has_command_val.group('value').split()
-            value = parsed[2]
-
-    elif arg.startswith('message_digest_'):
-        REGEX = re.compile(r'(?:ip ospf message-digest-key\s)(?P<value>.*)$', re.M)
-        value = ''
-        if 'ip ospf message-digest-key' in config:
-            value_list = REGEX.search(config).group('value').split()
             if arg == 'message_digest_key_id':
                 value = value_list[0]
             elif arg == 'message_digest_algorithm_type':
@@ -234,48 +190,17 @@ def get_custom_value(arg, config, module):
                     value = 'cisco_type_7'
             elif arg == 'message_digest_password':
                 value = value_list[3]
-
     elif arg == 'passive_interface':
-        REGEX = re.compile(r'\s+{0}\s*$'.format(PARAM_TO_COMMAND_KEYMAP[arg]), re.M)
+        has_no_command = re.search(r'\s+no\s+{0}\s*$'.format(command), config, re.M)
-        NO_REGEX = re.compile(r'\s+no\s+{0}\s*$'.format(PARAM_TO_COMMAND_KEYMAP[arg]), re.M)
         value = False
-        try:
+        if has_command and not has_no_command:
-            if NO_REGEX.search(config):
-                value = False
-            elif REGEX.search(config):
             value = True
-        except TypeError:
-            value = False
-
-    return value
-
-
-def get_value(arg, config, module):
-    custom = [
-        'ospf',
-        'area',
-        'message_digest_key_id',
-        'message_digest_algorithm_type',
-        'message_digest_encryption_type',
-        'message_digest_password',
-        'passive_interface'
-    ]
-
-    if arg in custom:
-        value = get_custom_value(arg, config, module)
     elif arg in BOOL_PARAMS:
-        REGEX = re.compile(r'\s+{0}\s*$'.format(PARAM_TO_COMMAND_KEYMAP[arg]), re.M)
+        value = bool(has_command)
-        value = False
-        try:
-            if REGEX.search(config):
-                value = True
-        except TypeError:
-            value = False
     else:
-        REGEX = re.compile(r'(?:{0}\s)(?P<value>.*)$'.format(PARAM_TO_COMMAND_KEYMAP[arg]), re.M)
         value = ''
-        if PARAM_TO_COMMAND_KEYMAP[arg] in config:
+        if has_command_val:
-            value = REGEX.search(config).group('value')
+            value = has_command_val.group('value')
     return value
 
 
@@ -297,10 +222,6 @@ def apply_key_map(key_map, table):
     for key, value in table.items():
         new_key = key_map.get(key)
         if new_key:
-            value = table.get(key)
-            if value:
-                new_dict[new_key] = value
-            else:
             new_dict[new_key] = value
     return new_dict
 
@@ -412,8 +333,7 @@ def state_absent(module, existing, proposed, candidate):
                 if value:
                     commands.append('no {0}'.format(key))
             elif key == 'ip router ospf':
-                command = 'no {0} {1} area {2}'.format(key, proposed['ospf'],
+                command = 'no {0} {1} area {2}'.format(key, proposed['ospf'], proposed['area'])
-                                                    proposed['area'])
                 if command not in commands:
                     commands.append(command)
             else:
@@ -446,7 +366,7 @@ def main():
         message_digest=dict(required=False, type='bool'),
         message_digest_key_id=dict(required=False, type='str'),
         message_digest_algorithm_type=dict(required=False, type='str', choices=['md5']),
-        message_digest_encryption_type=dict(required=False, type='str', choices=['cisco_type_7','3des']),
+        message_digest_encryption_type=dict(required=False, type='str', choices=['cisco_type_7', '3des']),
         message_digest_password=dict(required=False, type='str', no_log=True),
         state=dict(choices=['present', 'absent'], default='present', required=False),
         include_defaults=dict(default=True),
@@ -468,32 +388,18 @@ def main():
 
     warnings = list()
     check_args(module, warnings)
+    result = {'changed': False, 'commands': [], 'warnings': warnings}
 
     for param in ['message_digest_encryption_type',
                   'message_digest_algorithm_type',
                   'message_digest_password']:
         if module.params[param] == 'default':
-            module.exit_json(msg='Use message_digest_key_id=default to remove'
+            module.exit_json(msg='Use message_digest_key_id=default to remove an existing authentication configuration')
-                                 ' an existing authentication configuration')
 
     state = module.params['state']
-    args =  [
+    args = PARAM_TO_COMMAND_KEYMAP.keys()
-        'interface',
-        'ospf',
-        'area',
-        'cost',
-        'hello_interval',
-        'dead_interval',
-        'passive_interface',
-        'message_digest',
-        'message_digest_key_id',
-        'message_digest_algorithm_type',
-        'message_digest_encryption_type',
-        'message_digest_password'
-    ]
 
-    existing = invoke('get_existing', module, args)
+    existing = get_existing(module, args)
-    end_state = existing
     proposed_args = dict((k, v) for k, v in module.params.items()
                          if v is not None and k in args)
 
@@ -505,37 +411,26 @@ def main():
             elif str(value).lower() == 'false':
                 value = False
             elif str(value).lower() == 'default':
-                value = PARAM_TO_DEFAULT_KEYMAP.get(key)
-                if value is None:
                 value = 'default'
             if existing.get(key) or (not existing.get(key) and value):
                 proposed[key] = value
 
     proposed['area'] = normalize_area(proposed['area'], module)
-    result = {}
-    if (state == 'present' or (state == 'absent' and
-            existing.get('ospf') == proposed['ospf'] and
-            existing.get('area') == proposed['area'])):
 
     candidate = CustomNetworkConfig(indent=3)
-        invoke('state_%s' % state, module, existing, proposed, candidate)
+    if state == 'present':
-        response = load_config(module, candidate)
+        state_present(module, existing, proposed, candidate)
-        result.update(response)
+    elif state == 'absent' and existing.get('ospf') == proposed['ospf'] and existing.get('area') == proposed['area']:
+        state_absent(module, existing, proposed, candidate)
 
-    else:
+    if candidate:
-        result['updates'] = []
+        candidate = candidate.items_text()
-
+        load_config(module, candidate)
-    if module._verbosity > 0:
+        result['changed'] = True
-        end_state = invoke('get_existing', module, args)
+        result['commands'] = candidate
-        result['end_state'] = end_state
-        result['existing'] = existing
-        result['proposed'] = proposed_args
-
-    result['warnings'] = warnings
 
     module.exit_json(**result)
 
 
 if __name__ == '__main__':
     main()
-

test/sanity/pep8/legacy-files.txt

@@ -356,7 +356,6 @@ lib/ansible/modules/network/nxos/nxos_igmp_interface.py
 lib/ansible/modules/network/nxos/nxos_igmp_snooping.py
 lib/ansible/modules/network/nxos/nxos_install_os.py
 lib/ansible/modules/network/nxos/nxos_interface.py
-lib/ansible/modules/network/nxos/nxos_interface_ospf.py
 lib/ansible/modules/network/nxos/nxos_ntp.py
 lib/ansible/modules/network/nxos/nxos_ntp_auth.py
 lib/ansible/modules/network/nxos/nxos_ntp_options.py

test/units/modules/network/nxos/test_nxos_interface_ospf.py

@@ -0,0 +1,49 @@
+# (c) 2016 Red Hat Inc.
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+# Make coding more python3-ish
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+from ansible.compat.tests.mock import patch
+from ansible.modules.network.nxos import nxos_interface_ospf
+from .nxos_module import TestNxosModule, load_fixture, set_module_args
+
+
+class TestNxosInterfaceOspfModule(TestNxosModule):
+
+    module = nxos_interface_ospf
+
+    def setUp(self):
+        self.mock_get_config = patch('ansible.modules.network.nxos.nxos_interface_ospf.get_config')
+        self.get_config = self.mock_get_config.start()
+
+        self.mock_load_config = patch('ansible.modules.network.nxos.nxos_interface_ospf.load_config')
+        self.load_config = self.mock_load_config.start()
+
+    def tearDown(self):
+        self.mock_get_config.stop()
+        self.mock_load_config.stop()
+
+    def load_fixtures(self, commands=None, device=''):
+        module_name = self.module.__name__.rsplit('.', 1)[1]
+        self.get_config.return_value = load_fixture(module_name, 'config.cfg')
+        self.load_config.return_value = None
+
+    def test_nxos_interface_ospf(self):
+        set_module_args(dict(interface='ethernet1/32', ospf=1, area=1))
+        self.execute_module(changed=True, commands=['interface Ethernet1/32', 'ip router ospf 1 area 0.0.0.1'])