Pluribus Networks ipv6 security reguard vlan module with UT (#58319)
This commit is contained in:
rajaspachipulusu17
Sumit Jaiswal
parent
63b606ee94
commit
753f998262
2 changed files with 245 additions and 0 deletions
|
|
@ -0,0 +1,183 @@
|
|||
#!/usr/bin/python
|
||||
# Copyright: (c) 2018, Pluribus Networks
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = """
|
||||
---
|
||||
module: pn_ipv6security_raguard_vlan
|
||||
author: "Pluribus Networks (@rajaspachipulusu17)"
|
||||
version_added: "2.9"
|
||||
short_description: CLI command to add/remove ipv6security-raguard-vlan
|
||||
description:
|
||||
- This module can be used to Add vlans to RA Guard Policy and Remove vlans to RA Guard Policy.
|
||||
options:
|
||||
pn_cliswitch:
|
||||
description:
|
||||
- Target switch to run the CLI on.
|
||||
required: false
|
||||
type: str
|
||||
state:
|
||||
description:
|
||||
- ipv6security-raguard-vlan configuration command.
|
||||
required: false
|
||||
type: str
|
||||
choices: ['present', 'absent']
|
||||
default: 'present'
|
||||
pn_vlans:
|
||||
description:
|
||||
- Vlans attached to RA Guard Policy.
|
||||
required: true
|
||||
type: str
|
||||
pn_name:
|
||||
description:
|
||||
- RA Guard Policy Name.
|
||||
required: true
|
||||
type: str
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
- name: ipv6 security raguard vlan add
|
||||
pn_ipv6security_raguard_vlan:
|
||||
pn_cliswitch: "sw01"
|
||||
pn_name: "foo"
|
||||
pn_vlans: "100-105"
|
||||
|
||||
- name: ipv6 security raguard vlan add
|
||||
pn_ipv6security_raguard_vlan:
|
||||
pn_cliswitch: "sw01"
|
||||
pn_name: "foo"
|
||||
pn_vlans: "100"
|
||||
|
||||
- name: ipv6 security raguard vlan remove
|
||||
pn_ipv6security_raguard_vlan:
|
||||
pn_cliswitch: "sw01"
|
||||
pn_name: "foo"
|
||||
pn_vlans: "100-105"
|
||||
state: 'absent'
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
command:
|
||||
description: the CLI command run on the target node.
|
||||
returned: always
|
||||
type: str
|
||||
stdout:
|
||||
description: set of responses from the ipv6security-raguard-vlan command.
|
||||
returned: always
|
||||
type: list
|
||||
stderr:
|
||||
description: set of error responses from the ipv6security-raguard-vlan command.
|
||||
returned: on error
|
||||
type: list
|
||||
changed:
|
||||
description: indicates whether the CLI caused changes on the target.
|
||||
returned: always
|
||||
type: bool
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.network.netvisor.pn_nvos import pn_cli, run_cli
|
||||
from ansible.module_utils.network.netvisor.netvisor import run_commands
|
||||
|
||||
|
||||
def check_cli(module, cli):
|
||||
"""
|
||||
This method checks for idempotency using the ipv6-security-reguard command.
|
||||
If a name exists, return True if name exists else False.
|
||||
:param module: The Ansible module to fetch input parameters
|
||||
:param cli: The CLI string
|
||||
"""
|
||||
name = module.params['pn_name']
|
||||
vlans = module.params['pn_vlans']
|
||||
show = cli
|
||||
|
||||
cli += ' ipv6security-raguard-show format name no-show-headers'
|
||||
out = run_commands(module, cli)[1]
|
||||
|
||||
if out:
|
||||
out = out.split()
|
||||
|
||||
NAME_EXISTS = True if name in out else False
|
||||
|
||||
show += ' vlan-show format id no-show-headers'
|
||||
out = run_commands(module, show)[1]
|
||||
if out:
|
||||
out = out.split()
|
||||
|
||||
if vlans and '-' in vlans:
|
||||
vlan_list = list()
|
||||
vlans = vlans.strip().split('-')
|
||||
for vlan in range(int(vlans[0]), int(vlans[1]) + 1):
|
||||
vlan_list.append(str(vlan))
|
||||
|
||||
for vlan in vlan_list:
|
||||
if vlan not in out:
|
||||
module.fail_json(
|
||||
failed=True,
|
||||
msg='vlan id %s does not exist. Make sure you create vlan before adding it' % vlan
|
||||
)
|
||||
else:
|
||||
if vlans not in out:
|
||||
module.fail_json(
|
||||
failed=True,
|
||||
msg='vlan id %s does not exist. Make sure you create vlan before adding it' % vlans
|
||||
)
|
||||
|
||||
return NAME_EXISTS
|
||||
|
||||
|
||||
def main():
|
||||
""" This section is for arguments parsing """
|
||||
|
||||
state_map = dict(
|
||||
present='ipv6security-raguard-vlan-add',
|
||||
absent='ipv6security-raguard-vlan-remove'
|
||||
)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
pn_cliswitch=dict(required=False, type='str'),
|
||||
state=dict(required=False, type='str', choices=state_map.keys(), default='present'),
|
||||
pn_vlans=dict(required=True, type='str'),
|
||||
pn_name=dict(required=True, type='str'),
|
||||
)
|
||||
)
|
||||
|
||||
# Accessing the arguments
|
||||
cliswitch = module.params['pn_cliswitch']
|
||||
state = module.params['state']
|
||||
vlans = module.params['pn_vlans']
|
||||
name = module.params['pn_name']
|
||||
|
||||
command = state_map[state]
|
||||
|
||||
# Building the CLI command string
|
||||
cli = pn_cli(module, cliswitch)
|
||||
|
||||
NAME_EXISTS = check_cli(module, cli)
|
||||
|
||||
cli += ' %s name %s ' % (command, name)
|
||||
|
||||
if command:
|
||||
if NAME_EXISTS is False:
|
||||
module.exit_json(
|
||||
skipped=True,
|
||||
msg='ipv6security raguard with name %s does not exist' % name
|
||||
)
|
||||
if vlans:
|
||||
cli += ' vlans ' + vlans
|
||||
|
||||
run_cli(module, cli, state_map)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
|
|
@ -0,0 +1,62 @@
|
|||
# Copyright: (c) 2018, Pluribus Networks
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
import json
|
||||
|
||||
from units.compat.mock import patch
|
||||
from ansible.modules.network.netvisor import pn_ipv6security_raguard_vlan
|
||||
from units.modules.utils import set_module_args
|
||||
from .nvos_module import TestNvosModule, load_fixture
|
||||
|
||||
|
||||
class TestIPV6SecurityReguardVlanModule(TestNvosModule):
|
||||
|
||||
module = pn_ipv6security_raguard_vlan
|
||||
|
||||
def setUp(self):
|
||||
self.mock_run_nvos_commands = patch('ansible.modules.network.netvisor.pn_ipv6security_raguard_vlan.run_cli')
|
||||
self.run_nvos_commands = self.mock_run_nvos_commands.start()
|
||||
|
||||
self.mock_run_check_cli = patch('ansible.modules.network.netvisor.pn_ipv6security_raguard_vlan.check_cli')
|
||||
self.run_check_cli = self.mock_run_check_cli.start()
|
||||
|
||||
def tearDown(self):
|
||||
self.mock_run_nvos_commands.stop()
|
||||
self.mock_run_check_cli.stop()
|
||||
|
||||
def run_cli_patch(self, module, cli, state_map):
|
||||
if state_map['present'] == 'ipv6security-raguard-vlan-add':
|
||||
results = dict(
|
||||
changed=True,
|
||||
cli_cmd=cli
|
||||
)
|
||||
elif state_map['absent'] == 'ipv6security-raguard-vlan-add':
|
||||
results = dict(
|
||||
changed=True,
|
||||
cli_cmd=cli
|
||||
)
|
||||
module.exit_json(**results)
|
||||
|
||||
def load_fixtures(self, commands=None, state=None, transport='cli'):
|
||||
self.run_nvos_commands.side_effect = self.run_cli_patch
|
||||
if state == 'present':
|
||||
self.run_check_cli.return_value = True
|
||||
if state == 'absent':
|
||||
self.run_check_cli.return_value = True
|
||||
|
||||
def test_ipv6security_reguard_vlan_add(self):
|
||||
set_module_args({'pn_cliswitch': 'sw01', 'pn_name': 'foo',
|
||||
'pn_vlans': '100-105', 'state': 'present'})
|
||||
result = self.execute_module(changed=True, state='present')
|
||||
expected_cmd = ' switch sw01 ipv6security-raguard-vlan-add name foo vlans 100-105'
|
||||
self.assertEqual(result['cli_cmd'], expected_cmd)
|
||||
|
||||
def test_ipv6security_reguard_vlan_remove(self):
|
||||
set_module_args({'pn_cliswitch': 'sw01', 'pn_name': 'foo',
|
||||
'pn_vlans': '100-105', 'state': 'absent'})
|
||||
result = self.execute_module(changed=True, state='absent')
|
||||
expected_cmd = ' switch sw01 ipv6security-raguard-vlan-remove name foo vlans 100-105'
|
||||
self.assertEqual(result['cli_cmd'], expected_cmd)
|
||||
Loading…
Reference in a new issue