mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Pluribus Networks cpu class module with unit tests (#49847)
* Pluribus Networks cpu class module with unit tests * Doc string fixes
This commit is contained in:
rajaspachipulusu17
Abhijeet Kasurde
parent
3163780829
commit
4d88cdd83a
2 changed files with 270 additions and 0 deletions
200
lib/ansible/modules/network/netvisor/pn_cpu_class.py
Normal file
200
lib/ansible/modules/network/netvisor/pn_cpu_class.py
Normal file
|
|
@ -0,0 +1,200 @@
|
|||
#!/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_cpu_class
|
||||
author: "Pluribus Networks (@rajaspachipulusu17)"
|
||||
version_added: "2.8"
|
||||
short_description: CLI command to create/modify/delete cpu-class
|
||||
description:
|
||||
- This module can be used to create, modify and delete CPU class information.
|
||||
options:
|
||||
pn_cliswitch:
|
||||
description:
|
||||
- Target switch to run the CLI on.
|
||||
required: False
|
||||
type: str
|
||||
state:
|
||||
description:
|
||||
- State the action to perform. Use C(present) to create cpu-class and
|
||||
C(absent) to delete cpu-class C(update) to modify the cpu-class.
|
||||
required: True
|
||||
type: str
|
||||
choices: ['present', 'absent', 'update']
|
||||
pn_scope:
|
||||
description:
|
||||
- scope for CPU class.
|
||||
required: false
|
||||
choices: ['local', 'fabric']
|
||||
pn_hog_protect:
|
||||
description:
|
||||
- enable host-based hog protection.
|
||||
required: False
|
||||
type: str
|
||||
choices: ['disable', 'enable', 'enable-and-drop']
|
||||
pn_rate_limit:
|
||||
description:
|
||||
- rate-limit for CPU class.
|
||||
required: False
|
||||
type: str
|
||||
pn_name:
|
||||
description:
|
||||
- name for the CPU class.
|
||||
required: False
|
||||
type: str
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
- name: create cpu class
|
||||
pn_cpu_class:
|
||||
pn_cliswitch: 'sw01'
|
||||
state: 'present'
|
||||
pn_name: 'icmp'
|
||||
pn_rate_limit: '1000'
|
||||
pn_scope: 'local'
|
||||
|
||||
- name: delete cpu class
|
||||
pn_cpu_class:
|
||||
pn_cliswitch: 'sw01'
|
||||
state: 'absent'
|
||||
pn_name: 'icmp'
|
||||
|
||||
|
||||
- name: modify cpu class
|
||||
pn_cpu_class:
|
||||
pn_cliswitch: 'sw01'
|
||||
state: 'update'
|
||||
pn_name: 'icmp'
|
||||
pn_rate_limit: '2000'
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
command:
|
||||
description: the CLI command run on the target node.
|
||||
returned: always
|
||||
type: string
|
||||
stdout:
|
||||
description: set of responses from the cpu-class command.
|
||||
returned: always
|
||||
type: list
|
||||
stderr:
|
||||
description: set of error responses from the cpu-class 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 check_cli(module, cli):
|
||||
"""
|
||||
This method checks for idempotency using the cpu-class-show command.
|
||||
If a user with given name exists, return True else False.
|
||||
:param module: The Ansible module to fetch input parameters
|
||||
:param cli: The CLI string
|
||||
"""
|
||||
name = module.params['pn_name']
|
||||
|
||||
cli += ' cpu-class-show format name no-show-headers'
|
||||
out = module.run_command(cli.split(), use_unsafe_shell=True)[1]
|
||||
out = out.split()
|
||||
|
||||
return True if name in out else False
|
||||
|
||||
|
||||
def main():
|
||||
""" This section is for arguments parsing """
|
||||
|
||||
global state_map
|
||||
state_map = dict(
|
||||
present='cpu-class-create',
|
||||
absent='cpu-class-delete',
|
||||
update='cpu-class-modify'
|
||||
)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
pn_cliswitch=dict(required=False, type='str'),
|
||||
state=dict(required=True, type='str',
|
||||
choices=state_map.keys()),
|
||||
pn_scope=dict(required=False, type='str',
|
||||
choices=['local', 'fabric']),
|
||||
pn_hog_protect=dict(required=False, type='str',
|
||||
choices=['disable', 'enable',
|
||||
'enable-and-drop']),
|
||||
pn_rate_limit=dict(required=False, type='str'),
|
||||
pn_name=dict(required=False, type='str'),
|
||||
),
|
||||
required_if=(
|
||||
['state', 'present', ['pn_name', 'pn_scope', 'pn_rate_limit']],
|
||||
['state', 'absent', ['pn_name']],
|
||||
['state', 'update', ['pn_name']],
|
||||
)
|
||||
)
|
||||
|
||||
# Accessing the arguments
|
||||
cliswitch = module.params['pn_cliswitch']
|
||||
state = module.params['state']
|
||||
scope = module.params['pn_scope']
|
||||
hog_protect = module.params['pn_hog_protect']
|
||||
rate_limit = module.params['pn_rate_limit']
|
||||
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 == 'cpu-class-modify':
|
||||
if NAME_EXISTS is False:
|
||||
module.fail_json(
|
||||
failed=True,
|
||||
msg='cpu class with name %s does not exist' % name
|
||||
)
|
||||
|
||||
if command == 'cpu-class-delete':
|
||||
if NAME_EXISTS is False:
|
||||
module.exit_json(
|
||||
skipped=True,
|
||||
msg='cpu class with name %s does not exist' % name
|
||||
)
|
||||
|
||||
if command == 'cpu-class-create':
|
||||
if NAME_EXISTS is True:
|
||||
module.exit_json(
|
||||
skipped=True,
|
||||
msg='cpu class with name %s already exists' % name
|
||||
)
|
||||
if scope:
|
||||
cli += ' scope %s ' % scope
|
||||
|
||||
if command != 'cpu-class-delete':
|
||||
if hog_protect:
|
||||
cli += ' hog-protect %s ' % hog_protect
|
||||
if rate_limit:
|
||||
cli += ' rate-limit %s ' % rate_limit
|
||||
|
||||
run_cli(module, cli, state_map)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
70
test/units/modules/network/netvisor/test_pn_cpu_class.py
Normal file
70
test/units/modules/network/netvisor/test_pn_cpu_class.py
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
# 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_cpu_class
|
||||
from units.modules.utils import set_module_args
|
||||
from .nvos_module import TestNvosModule, load_fixture
|
||||
|
||||
|
||||
class TestCpuClassModule(TestNvosModule):
|
||||
|
||||
module = pn_cpu_class
|
||||
|
||||
def setUp(self):
|
||||
self.mock_run_nvos_commands = patch('ansible.modules.network.netvisor.pn_cpu_class.run_cli')
|
||||
self.run_nvos_commands = self.mock_run_nvos_commands.start()
|
||||
|
||||
self.mock_run_check_cli = patch('ansible.modules.network.netvisor.pn_cpu_class.check_cli')
|
||||
self.run_check_cli = self.mock_run_check_cli.start()
|
||||
|
||||
def tearDown(self):
|
||||
self.mock_run_nvos_commands.stop()
|
||||
|
||||
def run_cli_patch(self, module, cli, state_map):
|
||||
if state_map['present'] == 'cpu-class-create':
|
||||
results = dict(
|
||||
changed=True,
|
||||
cli_cmd=cli
|
||||
)
|
||||
elif state_map['absent'] == 'cpu-class-delete':
|
||||
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 = False
|
||||
if state == 'absent':
|
||||
self.run_check_cli.return_value = True
|
||||
if state == 'update':
|
||||
self.run_check_cli.return_value = True
|
||||
|
||||
def test_cpu_class_create(self):
|
||||
set_module_args({'pn_cliswitch': 'sw01', 'pn_name': 'icmp',
|
||||
'pn_scope': 'local', 'pn_rate_limit': '1000', 'state': 'present'})
|
||||
result = self.execute_module(changed=True, state='present')
|
||||
expected_cmd = '/usr/bin/cli --quiet -e --no-login-prompt switch sw01 cpu-class-create name icmp scope local rate-limit 1000 '
|
||||
self.assertEqual(result['cli_cmd'], expected_cmd)
|
||||
|
||||
def test_cpu_class_delete(self):
|
||||
set_module_args({'pn_cliswitch': 'sw01', 'pn_name': 'icmp',
|
||||
'state': 'absent'})
|
||||
result = self.execute_module(changed=True, state='absent')
|
||||
expected_cmd = '/usr/bin/cli --quiet -e --no-login-prompt switch sw01 cpu-class-delete name icmp '
|
||||
self.assertEqual(result['cli_cmd'], expected_cmd)
|
||||
|
||||
def test_cpu_class_update(self):
|
||||
set_module_args({'pn_cliswitch': 'sw01', 'pn_name': 'icmp',
|
||||
'pn_rate_limit': '2000', 'state': 'update'})
|
||||
result = self.execute_module(changed=True, state='absent')
|
||||
expected_cmd = '/usr/bin/cli --quiet -e --no-login-prompt switch sw01 cpu-class-modify name icmp rate-limit 2000 '
|
||||
self.assertEqual(result['cli_cmd'], expected_cmd)
|
||||
Loading…
Reference in a new issue