mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
nxos_acl fixes (#23915)
* Update nxos_acl * unit tests for nxos_acl * Remove nxos_acl from pep8-legacy
This commit is contained in:
Nathaniel Case
GitHub
parent
bffccb5396
commit
f0914ee3c2
4 changed files with 510 additions and 249 deletions
|
|
@ -16,9 +16,11 @@
|
|||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
#
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.0',
|
||||
ANSIBLE_METADATA = {
|
||||
'metadata_version': '1.0',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
'supported_by': 'community'
|
||||
}
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
|
|
@ -34,7 +36,7 @@ author:
|
|||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- C(state=absent) removes the ACE if it exists.
|
||||
- C(state=delete_acl) deleted the ACL if it exists.
|
||||
- C(state=delete_acl) deletes the ACL if it exists.
|
||||
- For idempotency, use port numbers for the src/dest port
|
||||
params like I(src_port1) and names for the well defined protocols
|
||||
for the I(proto) param.
|
||||
|
|
@ -200,7 +202,6 @@ options:
|
|||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
||||
# configure ACL ANSIBLE
|
||||
- nxos_acl:
|
||||
name: ANSIBLE
|
||||
|
|
@ -214,49 +215,22 @@ EXAMPLES = '''
|
|||
'''
|
||||
|
||||
RETURN = '''
|
||||
proposed:
|
||||
description: k/v pairs of parameters passed into module.
|
||||
returned: always
|
||||
type: dict
|
||||
sample: {"action": "permit", "dest": "any", "name": "ANSIBLE",
|
||||
"proto": "tcp", "seq": "10", "src": "1.1.1.1/24"}
|
||||
existing:
|
||||
description: k/v pairs of existing ACL entries.
|
||||
returned: always
|
||||
type: dict
|
||||
sample: {}
|
||||
end_state:
|
||||
description: k/v pairs of ACL entries after module execution.
|
||||
returned: always
|
||||
type: dict
|
||||
sample: {"action": "permit", "dest": "any", "name": "ANSIBLE",
|
||||
"proto": "tcp", "seq": "10", "src": "1.1.1.1/24"}
|
||||
updates:
|
||||
commands:
|
||||
description: commands sent to the device
|
||||
returned: always
|
||||
type: list
|
||||
sample: ["ip access-list ANSIBLE", "10 permit tcp 1.1.1.1/24 any"]
|
||||
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 load_config, run_commands
|
||||
from ansible.module_utils.nxos import nxos_argument_spec, check_args
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
|
||||
def execute_show_command(command, module, command_type='cli_show'):
|
||||
def execute_show_command(command, module):
|
||||
if module.params['transport'] == 'cli':
|
||||
command += ' | json'
|
||||
cmds = [command]
|
||||
body = run_commands(module, cmds)
|
||||
elif module.params['transport'] == 'nxapi':
|
||||
cmds = [command]
|
||||
body = run_commands(module, cmds)
|
||||
return body
|
||||
|
||||
|
||||
|
|
@ -264,7 +238,6 @@ def get_acl(module, acl_name, seq_number):
|
|||
command = 'show ip access-list'
|
||||
new_acl = []
|
||||
saveme = {}
|
||||
seqs = []
|
||||
acl_body = {}
|
||||
|
||||
body = execute_show_command(command, module)[0]
|
||||
|
|
@ -278,18 +251,19 @@ def get_acl(module, acl_name, seq_number):
|
|||
acl_entries = acl_body['TABLE_seqno']['ROW_seqno']
|
||||
acl_name = acl_body.get('acl_name')
|
||||
except KeyError: # could be raised if no ACEs are configured for an ACL
|
||||
return saveme, [{'acl': 'no_entries'}], seqs
|
||||
return {}, [{'acl': 'no_entries'}]
|
||||
|
||||
if isinstance(acl_entries, dict):
|
||||
acl_entries = [acl_entries]
|
||||
|
||||
for each in acl_entries:
|
||||
temp = collections.OrderedDict()
|
||||
keep = {}
|
||||
temp = {}
|
||||
options = {}
|
||||
remark = each.get('remark')
|
||||
|
||||
temp['name'] = acl_name
|
||||
temp['seq'] = str(each.get('seqno'))
|
||||
temp['options'] = {}
|
||||
remark = each.get('remark')
|
||||
|
||||
if remark:
|
||||
temp['remark'] = remark
|
||||
temp['action'] = 'remark'
|
||||
|
|
@ -305,7 +279,6 @@ def get_acl(module, acl_name, seq_number):
|
|||
temp['dest_port1'] = each.get('dest_port1_num')
|
||||
temp['dest_port2'] = each.get('dest_port2_num')
|
||||
|
||||
options = collections.OrderedDict()
|
||||
options['log'] = each.get('log')
|
||||
options['urg'] = each.get('urg')
|
||||
options['ack'] = each.get('ack')
|
||||
|
|
@ -319,27 +292,23 @@ def get_acl(module, acl_name, seq_number):
|
|||
options['fragments'] = each.get('fragments')
|
||||
options['time_range'] = each.get('timerange')
|
||||
|
||||
keep = {}
|
||||
for key, value in temp.items():
|
||||
if value:
|
||||
keep[key] = value
|
||||
|
||||
options_no_null = {}
|
||||
for key, value in options.items():
|
||||
if value is not None:
|
||||
options_no_null[key] = value
|
||||
|
||||
keep['options'] = options_no_null
|
||||
|
||||
for key, value in temp.items():
|
||||
if value:
|
||||
keep[key] = value
|
||||
# ensure options is always in the dict
|
||||
if keep.get('options', 'DNE') == 'DNE':
|
||||
keep['options'] = {}
|
||||
|
||||
if keep.get('seq') == seq_number:
|
||||
saveme = dict(keep)
|
||||
|
||||
seqs.append(str(keep.get('seq')))
|
||||
new_acl.append(keep)
|
||||
|
||||
return saveme, new_acl, seqs
|
||||
return saveme, new_acl
|
||||
|
||||
|
||||
def _acl_operand(operand, srcp1, sprcp2):
|
||||
|
|
@ -452,8 +421,7 @@ def main():
|
|||
'cs1', 'cs2', 'cs3', 'cs4',
|
||||
'cs5', 'cs6', 'cs7', 'default',
|
||||
'ef']),
|
||||
state=dict(choices=['absent', 'present', 'delete_acl'],
|
||||
default='present'),
|
||||
state=dict(choices=['absent', 'present', 'delete_acl'], default='present'),
|
||||
protocol=dict(choices=['http', 'https'], default='http'),
|
||||
host=dict(required=True),
|
||||
username=dict(type='str'),
|
||||
|
|
@ -471,6 +439,7 @@ def main():
|
|||
warnings = list()
|
||||
check_args(module, warnings)
|
||||
|
||||
results = dict(changed=False, warnings=warnings)
|
||||
|
||||
state = module.params['state']
|
||||
action = module.params['action']
|
||||
|
|
@ -482,8 +451,7 @@ def main():
|
|||
seq = module.params['seq']
|
||||
|
||||
if action == 'remark' and not remark:
|
||||
module.fail_json(msg='when state is action, remark param is also '
|
||||
'required')
|
||||
module.fail_json(msg='when state is action, remark param is also required')
|
||||
|
||||
REQUIRED = ['seq', 'name', 'action', 'proto', 'src', 'dest']
|
||||
ABSENT = ['name', 'seq']
|
||||
|
|
@ -530,14 +498,12 @@ def main():
|
|||
existing_options = {}
|
||||
|
||||
# getting existing existing_core=dict, acl=list, seq=list
|
||||
existing_core, acl, seqs = get_acl(module, name, seq)
|
||||
existing_core, acl = get_acl(module, name, seq)
|
||||
if existing_core:
|
||||
existing_options = existing_core.get('options')
|
||||
existing_core.pop('options')
|
||||
|
||||
end_state = acl
|
||||
commands = []
|
||||
changed = False
|
||||
delta_core = {}
|
||||
delta_options = {}
|
||||
|
||||
|
|
@ -569,7 +535,6 @@ def main():
|
|||
if acl[0].get('acl') != 'no_entries':
|
||||
commands.append(['no ip access-list {0}'.format(name)])
|
||||
|
||||
results = {}
|
||||
cmds = []
|
||||
if commands:
|
||||
preface = []
|
||||
|
|
@ -582,21 +547,14 @@ def main():
|
|||
module.exit_json(changed=True, commands=cmds)
|
||||
else:
|
||||
load_config(module, cmds)
|
||||
changed = True
|
||||
new_existing_core, end_state, seqs = get_acl(module, name, seq)
|
||||
results['changed'] = True
|
||||
if 'configure' in cmds:
|
||||
cmds.pop(0)
|
||||
|
||||
results['proposed'] = proposed
|
||||
results['existing'] = existing_core
|
||||
results['changed'] = changed
|
||||
results['warnings'] = warnings
|
||||
results['updates'] = cmds
|
||||
results['end_state'] = end_state
|
||||
results['commands'] = cmds
|
||||
|
||||
module.exit_json(**results)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
|
||||
|
|
|
|||
|
|
@ -541,7 +541,6 @@ lib/ansible/modules/network/nxos/_nxos_mtu.py
|
|||
lib/ansible/modules/network/nxos/_nxos_template.py
|
||||
lib/ansible/modules/network/nxos/nxos_aaa_server.py
|
||||
lib/ansible/modules/network/nxos/nxos_aaa_server_host.py
|
||||
lib/ansible/modules/network/nxos/nxos_acl.py
|
||||
lib/ansible/modules/network/nxos/nxos_acl_interface.py
|
||||
lib/ansible/modules/network/nxos/nxos_bgp.py
|
||||
lib/ansible/modules/network/nxos/nxos_bgp_af.py
|
||||
|
|
|
|||
|
|
@ -0,0 +1,227 @@
|
|||
{
|
||||
"TABLE_ip_ipv6_mac": {
|
||||
"ROW_ip_ipv6_mac": [
|
||||
{
|
||||
"op_ip_ipv6_mac": "ip",
|
||||
"acl_name": "copp-system-p-acl-bgp",
|
||||
"TABLE_seqno": {
|
||||
"ROW_seqno": [
|
||||
{
|
||||
"seqno": 10,
|
||||
"permitdeny": "permit",
|
||||
"proto_str": "tcp",
|
||||
"src_any": "any",
|
||||
"src_port_op": "gt",
|
||||
"src_port1_num": "1024",
|
||||
"dest_any": "any",
|
||||
"dest_port_op": "eq",
|
||||
"dest_port1_str": "bgp",
|
||||
"dest_port1_num": "179"
|
||||
},
|
||||
{
|
||||
"seqno": 20,
|
||||
"permitdeny": "permit",
|
||||
"proto_str": "tcp",
|
||||
"src_any": "any",
|
||||
"src_port_op": "eq",
|
||||
"src_port1_str": "bgp",
|
||||
"src_port1_num": "179",
|
||||
"dest_any": "any",
|
||||
"dest_port_op": "gt",
|
||||
"dest_port1_num": "1024"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"op_ip_ipv6_mac": "ip",
|
||||
"acl_name": "copp-system-p-acl-cts",
|
||||
"TABLE_seqno": {
|
||||
"ROW_seqno": [
|
||||
{
|
||||
"seqno": 10,
|
||||
"permitdeny": "permit",
|
||||
"proto_str": "tcp",
|
||||
"src_any": "any",
|
||||
"dest_any": "any",
|
||||
"dest_port_op": "eq",
|
||||
"dest_port1_num": "64999"
|
||||
},
|
||||
{
|
||||
"seqno": 20,
|
||||
"permitdeny": "permit",
|
||||
"proto_str": "tcp",
|
||||
"src_any": "any",
|
||||
"src_port_op": "eq",
|
||||
"src_port1_num": "64999",
|
||||
"dest_any": "any"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"op_ip_ipv6_mac": "ip",
|
||||
"acl_name": "copp-system-p-acl-dhcp",
|
||||
"TABLE_seqno": {
|
||||
"ROW_seqno": [
|
||||
{
|
||||
"seqno": 10,
|
||||
"permitdeny": "permit",
|
||||
"proto_str": "udp",
|
||||
"src_any": "any",
|
||||
"src_port_op": "eq",
|
||||
"src_port1_str": "bootpc",
|
||||
"src_port1_num": "68",
|
||||
"dest_any": "any"
|
||||
},
|
||||
{
|
||||
"seqno": 20,
|
||||
"permitdeny": "permit",
|
||||
"proto_str": "udp",
|
||||
"src_any": "any",
|
||||
"src_port_op": "neq",
|
||||
"src_port1_str": "bootps",
|
||||
"src_port1_num": "67",
|
||||
"dest_any": "any",
|
||||
"dest_port_op": "eq",
|
||||
"dest_port1_str": "bootps",
|
||||
"dest_port1_num": "67"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"op_ip_ipv6_mac": "ip",
|
||||
"acl_name": "copp-system-p-acl-dhcp-relay-response",
|
||||
"TABLE_seqno": {
|
||||
"ROW_seqno": [
|
||||
{
|
||||
"seqno": 10,
|
||||
"permitdeny": "permit",
|
||||
"proto_str": "udp",
|
||||
"src_any": "any",
|
||||
"src_port_op": "eq",
|
||||
"src_port1_str": "bootps",
|
||||
"src_port1_num": "67",
|
||||
"dest_any": "any"
|
||||
},
|
||||
{
|
||||
"seqno": 20,
|
||||
"permitdeny": "permit",
|
||||
"proto_str": "udp",
|
||||
"src_any": "any",
|
||||
"dest_any": "any",
|
||||
"dest_port_op": "eq",
|
||||
"dest_port1_str": "bootpc",
|
||||
"dest_port1_num": "68"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"op_ip_ipv6_mac": "ip",
|
||||
"acl_name": "copp-system-p-acl-eigrp",
|
||||
"TABLE_seqno": {
|
||||
"ROW_seqno": {
|
||||
"seqno": 10,
|
||||
"permitdeny": "permit",
|
||||
"proto_str": "eigrp",
|
||||
"src_any": "any",
|
||||
"dest_any": "any"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"op_ip_ipv6_mac": "ip",
|
||||
"acl_name": "copp-system-p-acl-ftp",
|
||||
"TABLE_seqno": {
|
||||
"ROW_seqno": [
|
||||
{
|
||||
"seqno": 10,
|
||||
"permitdeny": "permit",
|
||||
"proto_str": "tcp",
|
||||
"src_any": "any",
|
||||
"dest_any": "any",
|
||||
"dest_port_op": "eq",
|
||||
"dest_port1_str": "ftp-data",
|
||||
"dest_port1_num": "20"
|
||||
},
|
||||
{
|
||||
"seqno": 20,
|
||||
"permitdeny": "permit",
|
||||
"proto_str": "tcp",
|
||||
"src_any": "any",
|
||||
"dest_any": "any",
|
||||
"dest_port_op": "eq",
|
||||
"dest_port1_str": "ftp",
|
||||
"dest_port1_num": "21"
|
||||
},
|
||||
{
|
||||
"seqno": 30,
|
||||
"permitdeny": "permit",
|
||||
"proto_str": "tcp",
|
||||
"src_any": "any",
|
||||
"src_port_op": "eq",
|
||||
"src_port1_str": "ftp-data",
|
||||
"src_port1_num": "20",
|
||||
"dest_any": "any"
|
||||
},
|
||||
{
|
||||
"seqno": 40,
|
||||
"permitdeny": "permit",
|
||||
"proto_str": "tcp",
|
||||
"src_any": "any",
|
||||
"src_port_op": "eq",
|
||||
"src_port1_str": "ftp",
|
||||
"src_port1_num": "21",
|
||||
"dest_any": "any"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"op_ip_ipv6_mac": "ip",
|
||||
"acl_name": "copp-system-p-acl-glbp",
|
||||
"TABLE_seqno": {
|
||||
"ROW_seqno": {
|
||||
"seqno": 10,
|
||||
"permitdeny": "permit",
|
||||
"proto_str": "udp",
|
||||
"src_any": "any",
|
||||
"src_port_op": "eq",
|
||||
"src_port1_num": "3222",
|
||||
"dest_ip_prefix": "224.0.0.0/24",
|
||||
"dest_port_op": "eq",
|
||||
"dest_port1_num": "3222"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"op_ip_ipv6_mac": "ip",
|
||||
"acl_name": "copp-system-p-acl-hsrp",
|
||||
"TABLE_seqno": {
|
||||
"ROW_seqno": [
|
||||
{
|
||||
"seqno": 10,
|
||||
"permitdeny": "permit",
|
||||
"proto_str": "udp",
|
||||
"src_any": "any",
|
||||
"dest_ip_prefix": "224.0.0.2/32",
|
||||
"dest_port_op": "eq",
|
||||
"dest_port1_num": "1985"
|
||||
},
|
||||
{
|
||||
"seqno": 20,
|
||||
"permitdeny": "permit",
|
||||
"proto_str": "udp",
|
||||
"src_any": "any",
|
||||
"dest_ip_prefix": "224.0.0.102/32",
|
||||
"dest_port_op": "eq",
|
||||
"dest_port1_num": "1985"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
77
test/units/modules/network/nxos/test_nxos_acl.py
Normal file
77
test/units/modules/network/nxos/test_nxos_acl.py
Normal file
|
|
@ -0,0 +1,77 @@
|
|||
# (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
|
||||
|
||||
import json
|
||||
|
||||
from ansible.compat.tests.mock import patch
|
||||
from ansible.modules.network.nxos import nxos_acl
|
||||
from .nxos_module import TestNxosModule, load_fixture, set_module_args
|
||||
|
||||
|
||||
class TestNxosAclModule(TestNxosModule):
|
||||
|
||||
module = nxos_acl
|
||||
|
||||
def setUp(self):
|
||||
self.mock_run_commands = patch('ansible.modules.network.nxos.nxos_acl.run_commands')
|
||||
self.run_commands = self.mock_run_commands.start()
|
||||
|
||||
self.mock_load_config = patch('ansible.modules.network.nxos.nxos_acl.load_config')
|
||||
self.load_config = self.mock_load_config.start()
|
||||
|
||||
def tearDown(self):
|
||||
self.mock_run_commands.stop()
|
||||
self.mock_load_config.stop()
|
||||
|
||||
def load_fixtures(self, commands=None):
|
||||
def load_from_file(*args, **kwargs):
|
||||
module, commands = args
|
||||
output = list()
|
||||
|
||||
for item in commands:
|
||||
try:
|
||||
obj = json.loads(item)
|
||||
command = obj['command']
|
||||
except ValueError:
|
||||
command = item
|
||||
filename = str(command).split(' | ')[0].replace(' ', '_')
|
||||
filename = 'nxos_acl/%s.txt' % filename
|
||||
output.append(load_fixture(filename))
|
||||
return output
|
||||
|
||||
self.run_commands.side_effect = load_from_file
|
||||
self.load_config.return_value = None
|
||||
|
||||
def test_nxos_acl(self):
|
||||
set_module_args(dict(name='ANSIBLE', seq=10, action='permit',
|
||||
proto='tcp', src='1.1.1.1/24', dest='any'))
|
||||
result = self.execute_module(changed=True)
|
||||
self.assertEqual(result['commands'], ['ip access-list ANSIBLE', '10 permit tcp 1.1.1.1/24 any'])
|
||||
|
||||
def test_nxos_acl_remove(self):
|
||||
set_module_args(dict(name='copp-system-p-acl-bgp', seq=10, state='absent'))
|
||||
result = self.execute_module(changed=True)
|
||||
self.assertEqual(result['commands'], ['ip access-list copp-system-p-acl-bgp', 'no 10'])
|
||||
|
||||
def test_nxos_acl_delete_acl(self):
|
||||
set_module_args(dict(name='copp-system-p-acl-bgp', state='delete_acl'))
|
||||
result = self.execute_module(changed=True)
|
||||
self.assertEqual(result['commands'], ['no ip access-list copp-system-p-acl-bgp'])
|
||||
Loading…
Reference in a new issue