Pluribus Networks stp module with unit test (#51475)
This commit is contained in:
rajaspachipulusu17
Ganesh Nalawade
parent
5e88cd9972
commit
a9b459e406
2 changed files with 256 additions and 0 deletions
205
lib/ansible/modules/network/netvisor/pn_stp.py
Normal file
205
lib/ansible/modules/network/netvisor/pn_stp.py
Normal file
|
|
@ -0,0 +1,205 @@
|
|||
#!/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_stp
|
||||
author: "Pluribus Networks (@rajaspachipulusu17)"
|
||||
version_added: "2.8"
|
||||
short_description: CLI command to modify stp
|
||||
description:
|
||||
- This module can be used to modify Spanning Tree Protocol parameters.
|
||||
options:
|
||||
pn_cliswitch:
|
||||
description:
|
||||
- Target switch to run the CLI on.
|
||||
type: str
|
||||
required: false
|
||||
state:
|
||||
description:
|
||||
- State the action to perform. Use C(update) to stp.
|
||||
type: str
|
||||
required: true
|
||||
choices: ['update']
|
||||
pn_hello_time:
|
||||
description:
|
||||
- STP hello time between 1 and 10 secs.
|
||||
type: str
|
||||
default: '2'
|
||||
pn_enable:
|
||||
description:
|
||||
- enable or disable STP
|
||||
type: bool
|
||||
pn_root_guard_wait_time:
|
||||
description:
|
||||
- root guard wait time between 0 and 300 secs. 0 to disable wait.
|
||||
type: str
|
||||
default: '20'
|
||||
pn_bpdus_bridge_ports:
|
||||
description:
|
||||
- BPDU packets to bridge specific port.
|
||||
type: bool
|
||||
pn_mst_max_hops:
|
||||
description:
|
||||
- maximum hop count for mstp bpdu.
|
||||
type: str
|
||||
default: '20'
|
||||
pn_bridge_id:
|
||||
description:
|
||||
- STP bridge id.
|
||||
type: str
|
||||
pn_max_age:
|
||||
description:
|
||||
- maximum age time between 6 and 40 secs.
|
||||
type: str
|
||||
default: '20'
|
||||
pn_stp_mode:
|
||||
description:
|
||||
- STP mode.
|
||||
type: str
|
||||
choices: ['rstp', 'mstp']
|
||||
pn_mst_config_name:
|
||||
description:
|
||||
- Name for MST Configuration Instance.
|
||||
type: str
|
||||
pn_forwarding_delay:
|
||||
description:
|
||||
- STP forwarding delay between 4 and 30 secs.
|
||||
type: str
|
||||
default: '15'
|
||||
pn_bridge_priority:
|
||||
description:
|
||||
- STP bridge priority.
|
||||
type: str
|
||||
default: '32768'
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
- name: Modify stp
|
||||
pn_stp:
|
||||
pn_cliswitch: "sw01"
|
||||
state: "update"
|
||||
pn_hello_time: "3"
|
||||
pn_stp_mode: "rstp"
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
command:
|
||||
description: the CLI command run on the target node.
|
||||
returned: always
|
||||
type: str
|
||||
stdout:
|
||||
description: set of responses from the stp command.
|
||||
returned: always
|
||||
type: list
|
||||
stderr:
|
||||
description: set of error responses from the stp 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, booleanArgs
|
||||
|
||||
|
||||
def main():
|
||||
""" This section is for arguments parsing """
|
||||
|
||||
state_map = dict(
|
||||
update='stp-modify'
|
||||
)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
pn_cliswitch=dict(required=False, type='str'),
|
||||
state=dict(required=True, type='str',
|
||||
choices=state_map.keys()),
|
||||
pn_hello_time=dict(required=False, type='str', default='2'),
|
||||
pn_enable=dict(required=False, type='bool'),
|
||||
pn_root_guard_wait_time=dict(required=False, type='str', default='20'),
|
||||
pn_bpdus_bridge_ports=dict(required=False, type='bool'),
|
||||
pn_mst_max_hops=dict(required=False, type='str', default='20'),
|
||||
pn_bridge_id=dict(required=False, type='str'),
|
||||
pn_max_age=dict(required=False, type='str', default='20'),
|
||||
pn_stp_mode=dict(required=False, type='str',
|
||||
choices=['rstp', 'mstp']),
|
||||
pn_mst_config_name=dict(required=False, type='str'),
|
||||
pn_forwarding_delay=dict(required=False, type='str', default='15'),
|
||||
pn_bridge_priority=dict(required=False, type='str', default='32768'),
|
||||
),
|
||||
required_one_of=[['pn_enable', 'pn_hello_time',
|
||||
'pn_root_guard_wait_time',
|
||||
'pn_bpdus_bridge_ports',
|
||||
'pn_mst_max_hops',
|
||||
'pn_bridge_id',
|
||||
'pn_max_age',
|
||||
'pn_stp_mode',
|
||||
'pn_mst_config_name',
|
||||
'pn_forwarding_delay',
|
||||
'pn_bridge_priority']]
|
||||
)
|
||||
|
||||
# Accessing the arguments
|
||||
cliswitch = module.params['pn_cliswitch']
|
||||
state = module.params['state']
|
||||
hello_time = module.params['pn_hello_time']
|
||||
enable = module.params['pn_enable']
|
||||
root_guard_wait_time = module.params['pn_root_guard_wait_time']
|
||||
bpdus_bridge_ports = module.params['pn_bpdus_bridge_ports']
|
||||
mst_max_hops = module.params['pn_mst_max_hops']
|
||||
bridge_id = module.params['pn_bridge_id']
|
||||
max_age = module.params['pn_max_age']
|
||||
stp_mode = module.params['pn_stp_mode']
|
||||
mst_config_name = module.params['pn_mst_config_name']
|
||||
forwarding_delay = module.params['pn_forwarding_delay']
|
||||
bridge_priority = module.params['pn_bridge_priority']
|
||||
|
||||
command = state_map[state]
|
||||
|
||||
# Building the CLI command string
|
||||
cli = pn_cli(module, cliswitch)
|
||||
|
||||
if command == 'stp-modify':
|
||||
cli += ' %s ' % command
|
||||
if hello_time:
|
||||
cli += ' hello-time ' + hello_time
|
||||
if root_guard_wait_time:
|
||||
cli += ' root-guard-wait-time ' + root_guard_wait_time
|
||||
if mst_max_hops:
|
||||
cli += ' mst-max-hops ' + mst_max_hops
|
||||
if bridge_id:
|
||||
cli += ' bridge-id ' + bridge_id
|
||||
if max_age:
|
||||
cli += ' max-age ' + max_age
|
||||
if stp_mode:
|
||||
cli += ' stp-mode ' + stp_mode
|
||||
if mst_config_name:
|
||||
cli += ' mst-config-name ' + mst_config_name
|
||||
if forwarding_delay:
|
||||
cli += ' forwarding-delay ' + forwarding_delay
|
||||
if bridge_priority:
|
||||
cli += ' bridge-priority ' + bridge_priority
|
||||
|
||||
cli += booleanArgs(enable, 'enable', 'disable')
|
||||
cli += booleanArgs(bpdus_bridge_ports, 'bpdus-bridge-ports', 'bpdus-all-ports')
|
||||
|
||||
run_cli(module, cli, state_map)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
51
test/units/modules/network/netvisor/test_pn_stp.py
Normal file
51
test/units/modules/network/netvisor/test_pn_stp.py
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
# 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_stp
|
||||
from units.modules.utils import set_module_args
|
||||
from .nvos_module import TestNvosModule, load_fixture
|
||||
|
||||
|
||||
class TestStpModule(TestNvosModule):
|
||||
|
||||
module = pn_stp
|
||||
|
||||
def setUp(self):
|
||||
self.mock_run_nvos_commands = patch('ansible.modules.network.netvisor.pn_stp.run_cli')
|
||||
self.run_nvos_commands = self.mock_run_nvos_commands.start()
|
||||
|
||||
def tearDown(self):
|
||||
self.mock_run_nvos_commands.stop()
|
||||
|
||||
def run_cli_patch(self, module, cli, state_map):
|
||||
if state_map['update'] == 'stp-modify':
|
||||
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
|
||||
|
||||
def test_stp_modify_t1(self):
|
||||
set_module_args({'pn_cliswitch': 'sw01', 'pn_hello_time': '3',
|
||||
'pn_stp_mode': 'rstp', 'state': 'update'})
|
||||
result = self.execute_module(changed=True, state='update')
|
||||
expected_cmd = '/usr/bin/cli --quiet -e --no-login-prompt switch sw01 stp-modify hello-time 3 root-guard-wait-time 20 mst-max-hops 20 max-age 20 '
|
||||
expected_cmd += 'stp-mode rstp forwarding-delay 15 bridge-priority 32768'
|
||||
self.assertEqual(result['cli_cmd'], expected_cmd)
|
||||
|
||||
def test_stp_modify_t2(self):
|
||||
set_module_args({'pn_cliswitch': 'sw01', 'pn_root_guard_wait_time': '50',
|
||||
'state': 'update'})
|
||||
result = self.execute_module(changed=True, state='update')
|
||||
expected_cmd = '/usr/bin/cli --quiet -e --no-login-prompt switch sw01 stp-modify hello-time 2 root-guard-wait-time 50 mst-max-hops 20 '
|
||||
expected_cmd += 'max-age 20 forwarding-delay 15 bridge-priority 32768'
|
||||
self.assertEqual(result['cli_cmd'], expected_cmd)
|
||||
Loading…
Reference in a new issue