mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Pluribus Networks port cos rate setting module with UT (#50856)
This commit is contained in:
parent
213b2e633c
commit
a38039bbbe
2 changed files with 258 additions and 0 deletions
207
lib/ansible/modules/network/netvisor/pn_port_cos_rate_setting.py
Normal file
207
lib/ansible/modules/network/netvisor/pn_port_cos_rate_setting.py
Normal file
|
@ -0,0 +1,207 @@
|
|||
#!/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_port_cos_rate_setting
|
||||
author: "Pluribus Networks (@rajaspachipulusu17)"
|
||||
version_added: "2.8"
|
||||
short_description: CLI command to modify port-cos-rate-setting
|
||||
description:
|
||||
- This modules can be used to update the port cos rate limit.
|
||||
options:
|
||||
pn_cliswitch:
|
||||
description:
|
||||
- Target switch to run the CLI on.
|
||||
required: false
|
||||
type: str
|
||||
state:
|
||||
description:
|
||||
- State the action to perform. Use C(update) to modify
|
||||
the port-cos-rate-setting.
|
||||
required: true
|
||||
type: str
|
||||
choices: ['update']
|
||||
pn_cos0_rate:
|
||||
description:
|
||||
- cos0 rate limit (pps) unlimited or 0 to 10000000.
|
||||
required: false
|
||||
type: str
|
||||
pn_cos1_rate:
|
||||
description:
|
||||
- cos1 rate limit (pps) unlimited or 0 to 10000000.
|
||||
required: false
|
||||
type: str
|
||||
pn_cos2_rate:
|
||||
description:
|
||||
- cos2 rate limit (pps) unlimited or 0 to 10000000.
|
||||
required: false
|
||||
type: str
|
||||
pn_cos3_rate:
|
||||
description:
|
||||
- cos3 rate limit (pps) unlimited or 0 to 10000000.
|
||||
required: false
|
||||
type: str
|
||||
pn_cos4_rate:
|
||||
description:
|
||||
- cos4 rate limit (pps) unlimited or 0 to 10000000.
|
||||
required: false
|
||||
type: str
|
||||
pn_cos5_rate:
|
||||
description:
|
||||
- cos5 rate limit (pps) unlimited or 0 to 10000000.
|
||||
required: false
|
||||
type: str
|
||||
pn_cos6_rate:
|
||||
description:
|
||||
- cos6 rate limit (pps) unlimited or 0 to 10000000.
|
||||
required: false
|
||||
type: str
|
||||
pn_cos7_rate:
|
||||
description:
|
||||
- cos7 rate limit (pps) unlimited or 0 to 10000000.
|
||||
required: false
|
||||
type: str
|
||||
pn_port:
|
||||
description:
|
||||
- port.
|
||||
required: false
|
||||
type: str
|
||||
choices: ['control-port', 'data-port', 'span-ports']
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
- name: port cos rate modify
|
||||
pn_port_cos_rate_setting:
|
||||
pn_cliswitch: "sw01"
|
||||
state: "update"
|
||||
pn_port: "control-port"
|
||||
pn_cos1_rate: "1000"
|
||||
pn_cos5_rate: "1000"
|
||||
pn_cos2_rate: "1000"
|
||||
pn_cos0_rate: "1000"
|
||||
|
||||
- name: port cos rate modify
|
||||
pn_port_cos_rate_setting:
|
||||
pn_cliswitch: "sw01"
|
||||
state: "update"
|
||||
pn_port: "data-port"
|
||||
pn_cos1_rate: "2000"
|
||||
pn_cos5_rate: "2000"
|
||||
pn_cos2_rate: "2000"
|
||||
pn_cos0_rate: "2000"
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
command:
|
||||
description: the CLI command run on the target node.
|
||||
returned: always
|
||||
type: str
|
||||
stdout:
|
||||
description: set of responses from the port-cos-rate-setting command.
|
||||
returned: always
|
||||
type: list
|
||||
stderr:
|
||||
description: set of error responses from the port-cos-rate-setting 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
|
||||
|
||||
|
||||
def main():
|
||||
""" This section is for arguments parsing """
|
||||
|
||||
state_map = dict(
|
||||
update='port-cos-rate-setting-modify'
|
||||
)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
pn_cliswitch=dict(required=False, type='str'),
|
||||
state=dict(required=True, type='str',
|
||||
choices=state_map.keys()),
|
||||
pn_cos1_rate=dict(required=False, type='str'),
|
||||
pn_cos5_rate=dict(required=False, type='str'),
|
||||
pn_cos2_rate=dict(required=False, type='str'),
|
||||
pn_cos0_rate=dict(required=False, type='str'),
|
||||
pn_cos6_rate=dict(required=False, type='str'),
|
||||
pn_cos3_rate=dict(required=False, type='str'),
|
||||
pn_cos4_rate=dict(required=False, type='str'),
|
||||
pn_cos7_rate=dict(required=False, type='str'),
|
||||
pn_port=dict(required=False, type='str',
|
||||
choices=['control-port', 'data-port', 'span-ports']),
|
||||
),
|
||||
required_if=(
|
||||
['state', 'update', ['pn_port']],
|
||||
),
|
||||
required_one_of=[['pn_cos0_rate',
|
||||
'pn_cos1_rate',
|
||||
'pn_cos2_rate',
|
||||
'pn_cos3_rate',
|
||||
'pn_cos4_rate',
|
||||
'pn_cos5_rate',
|
||||
'pn_cos6_rate',
|
||||
'pn_cos7_rate']],
|
||||
)
|
||||
|
||||
# Accessing the arguments
|
||||
cliswitch = module.params['pn_cliswitch']
|
||||
state = module.params['state']
|
||||
cos1_rate = module.params['pn_cos1_rate']
|
||||
cos5_rate = module.params['pn_cos5_rate']
|
||||
cos2_rate = module.params['pn_cos2_rate']
|
||||
cos0_rate = module.params['pn_cos0_rate']
|
||||
cos6_rate = module.params['pn_cos6_rate']
|
||||
cos3_rate = module.params['pn_cos3_rate']
|
||||
cos4_rate = module.params['pn_cos4_rate']
|
||||
cos7_rate = module.params['pn_cos7_rate']
|
||||
port = module.params['pn_port']
|
||||
|
||||
command = state_map[state]
|
||||
|
||||
# Building the CLI command string
|
||||
cli = pn_cli(module, cliswitch)
|
||||
|
||||
if command == 'port-cos-rate-setting-modify':
|
||||
cli += ' %s ' % command
|
||||
if cos1_rate:
|
||||
cli += ' cos1-rate ' + cos1_rate
|
||||
if cos5_rate:
|
||||
cli += ' cos5-rate ' + cos5_rate
|
||||
if cos2_rate:
|
||||
cli += ' cos2-rate ' + cos2_rate
|
||||
if cos0_rate:
|
||||
cli += ' cos0-rate ' + cos0_rate
|
||||
if cos6_rate:
|
||||
cli += ' cos6-rate ' + cos6_rate
|
||||
if cos3_rate:
|
||||
cli += ' cos3-rate ' + cos3_rate
|
||||
if cos4_rate:
|
||||
cli += ' cos4-rate ' + cos4_rate
|
||||
if cos7_rate:
|
||||
cli += ' cos7-rate ' + cos7_rate
|
||||
if port:
|
||||
cli += ' port ' + port
|
||||
|
||||
run_cli(module, cli, state_map)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
|
@ -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_port_cos_rate_setting
|
||||
from units.modules.utils import set_module_args
|
||||
from .nvos_module import TestNvosModule, load_fixture
|
||||
|
||||
|
||||
class TestPortCosRateSettingModule(TestNvosModule):
|
||||
|
||||
module = pn_port_cos_rate_setting
|
||||
|
||||
def setUp(self):
|
||||
self.mock_run_nvos_commands = patch('ansible.modules.network.netvisor.pn_port_cos_rate_setting.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'] == 'port-cos-rate-setting-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_pn_port_cos_rate_setting_modify_t1(self):
|
||||
set_module_args({'pn_cliswitch': 'sw01', 'pn_port': 'control-port',
|
||||
'pn_cos1_rate': '4000', 'pn_cos2_rate': '4000', 'pn_cos3_rate': '4000', 'state': 'update'})
|
||||
result = self.execute_module(changed=True, state='update')
|
||||
expected_cmd = '/usr/bin/cli --quiet -e --no-login-prompt switch sw01 port-cos-rate-setting-modify cos1-rate 4000 cos2-rate 4000 '
|
||||
expected_cmd += 'cos3-rate 4000 port control-port'
|
||||
self.assertEqual(result['cli_cmd'], expected_cmd)
|
||||
|
||||
def test_pn_port_cos_rate_setting_modify_t2(self):
|
||||
set_module_args({'pn_cliswitch': 'sw01', 'pn_port': 'data-port',
|
||||
'pn_cos1_rate': '2000', 'pn_cos5_rate': '3000', 'pn_cos2_rate': '4000', 'state': 'update'})
|
||||
result = self.execute_module(changed=True, state='update')
|
||||
expected_cmd = '/usr/bin/cli --quiet -e --no-login-prompt switch sw01 port-cos-rate-setting-modify cos1-rate 2000 cos5-rate 3000 '
|
||||
expected_cmd += 'cos2-rate 4000 port data-port'
|
||||
self.assertEqual(result['cli_cmd'], expected_cmd)
|
Loading…
Reference in a new issue