refactors nxos_vrf_af module (#28208)

* refactors nxos_vrf_af module

fixes #27595

* fix up unit test cases

* add commands to result dict

* add route-target on afi create

* adds deprecation note to safi argument
This commit is contained in:
Peter Sprygada 2017-08-16 10:11:12 -04:00 committed by Nathaniel Case
parent 37524b798d
commit 6886153b54
2 changed files with 45 additions and 137 deletions

View file

@ -45,6 +45,7 @@ options:
safi: safi:
description: description:
- Sub Address-Family Identifier (SAFI). - Sub Address-Family Identifier (SAFI).
- Deprecated in 2.4
required: true required: true
choices: ['unicast', 'multicast'] choices: ['unicast', 'multicast']
default: null default: null
@ -68,7 +69,6 @@ EXAMPLES = '''
- nxos_vrf_af: - nxos_vrf_af:
vrf: ntc vrf: ntc
afi: ipv4 afi: ipv4
safi: unicast
route_target_both_auto_evpn: True route_target_both_auto_evpn: True
state: present state: present
''' '''
@ -80,120 +80,23 @@ commands:
type: list type: list
sample: ["vrf context ntc", "address-family ipv4 unicast"] sample: ["vrf context ntc", "address-family ipv4 unicast"]
''' '''
from ansible.module_utils.nxos import get_config, load_config
import re
from ansible.module_utils.nxos import get_config, load_config, run_commands
from ansible.module_utils.nxos import nxos_argument_spec, check_args from ansible.module_utils.nxos import nxos_argument_spec, check_args
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.netcfg import CustomNetworkConfig from ansible.module_utils.netcfg import NetworkConfig
BOOL_PARAMS = ['route_target_both_auto_evpn']
PARAM_TO_COMMAND_KEYMAP = {
'route_target_both_auto_evpn': 'route-target both auto evpn'
}
PARAM_TO_DEFAULT_KEYMAP = {}
def get_value(arg, config, module):
command = PARAM_TO_COMMAND_KEYMAP.get(arg)
if arg in BOOL_PARAMS:
command_re = re.compile(r'\s+{0}\s*$'.format(command), re.M)
value = False
try:
if command_re.search(config):
value = True
except TypeError:
value = False
else:
command_re = re.compile(r'(?:{0}\s)(?P<value>.*)$'.format(command), re.M)
value = ''
if command in config:
value = command_re.search(config).group('value')
return value
def get_existing(module, args):
existing = {}
netcfg = CustomNetworkConfig(indent=2, contents=get_config(module))
parents = ['vrf context {0}'.format(module.params['vrf'])]
parents.append('address-family {0} {1}'.format(module.params['afi'],
module.params['safi']))
config = netcfg.get_section(parents)
if config:
splitted_config = config.splitlines()
vrf_index = False
for index in range(0, len(splitted_config) - 1):
if 'vrf' in splitted_config[index].strip():
vrf_index = index
break
if vrf_index:
config = '\n'.join(splitted_config[0:vrf_index])
for arg in args:
if arg not in ['afi', 'safi', 'vrf']:
existing[arg] = get_value(arg, config, module)
existing['afi'] = module.params['afi']
existing['safi'] = module.params['safi']
existing['vrf'] = module.params['vrf']
return existing
def apply_key_map(key_map, table):
new_dict = {}
for key in table:
new_key = key_map.get(key)
if new_key:
new_dict[new_key] = table.get(key)
return new_dict
def state_present(module, existing, proposed, candidate):
commands = list()
proposed_commands = apply_key_map(PARAM_TO_COMMAND_KEYMAP, proposed)
existing_commands = apply_key_map(PARAM_TO_COMMAND_KEYMAP, existing)
for key, value in proposed_commands.items():
if value is True:
commands.append(key)
elif value is False:
commands.append('no {0}'.format(key))
elif value == 'default':
if existing_commands.get(key):
existing_value = existing_commands.get(key)
commands.append('no {0} {1}'.format(key, existing_value))
else:
command = '{0} {1}'.format(key, value.lower())
commands.append(command)
parents = ['vrf context {0}'.format(module.params['vrf'])]
parents.append('address-family {0} {1}'.format(module.params['afi'],
module.params['safi']))
candidate.add(commands, parents=parents)
def state_absent(module, existing, proposed, candidate):
commands = []
parents = ['vrf context {0}'.format(module.params['vrf'])]
commands.append('no address-family {0} {1}'.format(module.params['afi'],
module.params['safi']))
candidate.add(commands, parents=parents)
def main(): def main():
argument_spec = dict( argument_spec = dict(
vrf=dict(required=True, type='str'), vrf=dict(required=True),
safi=dict(required=True, type='str', choices=['unicast', 'multicast']), afi=dict(required=True, choices=['ipv4', 'ipv6']),
afi=dict(required=True, type='str', choices=['ipv4', 'ipv6']),
route_target_both_auto_evpn=dict(required=False, type='bool'), route_target_both_auto_evpn=dict(required=False, type='bool'),
m_facts=dict(required=False, default=False, type='bool'),
state=dict(choices=['present', 'absent'], default='present', required=False) m_facts=dict(default=False, type='bool'),
safi=dict(choices=['unicast', 'multicast'], removed_in_version="2.4"),
state=dict(choices=['present', 'absent'], default='present')
) )
argument_spec.update(nxos_argument_spec) argument_spec.update(nxos_argument_spec)
@ -202,38 +105,46 @@ def main():
warnings = list() warnings = list()
check_args(module, warnings) check_args(module, warnings)
result = dict(changed=False, warnings=warnings)
state = module.params['state'] result = {'changed': False, 'warnings': warnings}
args = PARAM_TO_COMMAND_KEYMAP.keys()
existing = get_existing(module, args)
proposed_args = dict((k, v) for k, v in module.params.items()
if v is not None and k in args)
proposed = {} config_text = get_config(module)
for key, value in proposed_args.items(): config = NetworkConfig(indent=2, contents=config_text)
if key != 'interface':
if str(value).lower() == 'default':
value = PARAM_TO_DEFAULT_KEYMAP.get(key)
if value is None:
value = 'default'
if existing.get(key) != value:
proposed[key] = value
candidate = CustomNetworkConfig(indent=3) path = ['vrf context %s' % module.params['vrf'],
if state == 'present': 'address-family %s unicast' % module.params['afi']]
state_present(module, existing, proposed, candidate)
elif state == 'absent' and existing:
state_absent(module, existing, proposed, candidate)
if candidate: try:
candidate = candidate.items_text() current = config.get_block_config(path)
load_config(module, candidate) except ValueError:
current = None
commands = list()
if not current and module.params['state'] == 'present':
commands.append('address-family %s unicast' % module.params['afi'])
if module.params['route_target_both_auto_evpn']:
commands.append('route-target both auto evpn')
elif current and module.params['state'] == 'absent':
commands.append('no address-family %s unicast' % module.params['afi'])
elif current:
if module.params['route_target_both_auto_evpn']:
commands.append('address-family %s unicast' % module.params['afi'])
if 'route-target both auto evpn' in current:
commands.append('route-target both auto evpn')
else:
commands.append('no route-target both auto evpn')
if commands:
commands.insert(0, 'vrf context %s' % module.params['vrf'])
if not module.check_mode:
load_config(module, commands)
result['changed'] = True result['changed'] = True
result['commands'] = candidate
else: result['commands'] = commands
result['commands'] = []
module.exit_json(**result) module.exit_json(**result)

View file

@ -31,8 +31,6 @@ class TestNxosVrfafModule(TestNxosModule):
module = nxos_vrf_af module = nxos_vrf_af
def setUp(self): def setUp(self):
self.mock_run_commands = patch('ansible.modules.network.nxos.nxos_vrf_af.run_commands')
self.run_commands = self.mock_run_commands.start()
self.mock_load_config = patch('ansible.modules.network.nxos.nxos_vrf_af.load_config') self.mock_load_config = patch('ansible.modules.network.nxos.nxos_vrf_af.load_config')
self.load_config = self.mock_load_config.start() self.load_config = self.mock_load_config.start()
@ -40,7 +38,6 @@ class TestNxosVrfafModule(TestNxosModule):
self.get_config = self.mock_get_config.start() self.get_config = self.mock_get_config.start()
def tearDown(self): def tearDown(self):
self.mock_run_commands.stop()
self.mock_load_config.stop() self.mock_load_config.stop()
self.mock_get_config.stop() self.mock_get_config.stop()