mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Pluribus Networks dscp map module with unit tests (#49849)
* Pluribus Networks dscp map module with unit tests * Doc string fix
This commit is contained in:
parent
4d88cdd83a
commit
cf00880ab3
2 changed files with 222 additions and 0 deletions
161
lib/ansible/modules/network/netvisor/pn_dscp_map.py
Normal file
161
lib/ansible/modules/network/netvisor/pn_dscp_map.py
Normal file
|
@ -0,0 +1,161 @@
|
|||
#!/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_dscp_map
|
||||
author: "Pluribus Networks (@rajaspachipulusu17)"
|
||||
version_added: "2.8"
|
||||
short_description: CLI command to create/delete dscp-map
|
||||
description:
|
||||
- This module can be used to create a DSCP priority mapping table.
|
||||
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 dscp-map and
|
||||
C(absent) to delete.
|
||||
required: True
|
||||
type: str
|
||||
choices: ["present", "absent"]
|
||||
pn_name:
|
||||
description:
|
||||
- Name for the DSCP map.
|
||||
required: False
|
||||
type: str
|
||||
pn_scope:
|
||||
description:
|
||||
- Scope for dscp map.
|
||||
required: False
|
||||
choices: ["local", "fabric"]
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
- name: dscp map create
|
||||
pn_dscp_map:
|
||||
pn_cliswitch: "sw01"
|
||||
state: "present"
|
||||
pn_name: "foo"
|
||||
pn_scope: "local"
|
||||
|
||||
- name: dscp map delete
|
||||
pn_dscp_map:
|
||||
pn_cliswitch: "sw01"
|
||||
state: "absent"
|
||||
pn_name: "foo"
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
command:
|
||||
description: the CLI command run on the target node.
|
||||
returned: always
|
||||
type: string
|
||||
stdout:
|
||||
description: set of responses from the dscp-map command.
|
||||
returned: always
|
||||
type: list
|
||||
stderr:
|
||||
description: set of error responses from the dscp-map 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 dscp-map-show name 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 += ' dscp-map-show name %s format name no-show-headers' % name
|
||||
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='dscp-map-create',
|
||||
absent='dscp-map-delete'
|
||||
)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
pn_cliswitch=dict(required=False, type='str'),
|
||||
state=dict(required=True, type='str',
|
||||
choices=state_map.keys()),
|
||||
pn_name=dict(required=False, type='str'),
|
||||
pn_scope=dict(required=False, type='str',
|
||||
choices=['local', 'fabric']),
|
||||
),
|
||||
required_if=(
|
||||
["state", "present", ["pn_name", "pn_scope"]],
|
||||
["state", "absent", ["pn_name"]],
|
||||
)
|
||||
)
|
||||
|
||||
# Accessing the arguments
|
||||
cliswitch = module.params['pn_cliswitch']
|
||||
state = module.params['state']
|
||||
name = module.params['pn_name']
|
||||
scope = module.params['pn_scope']
|
||||
|
||||
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 == 'dscp-map-delete':
|
||||
if NAME_EXISTS is False:
|
||||
module.exit_json(
|
||||
skipped=True,
|
||||
msg='dscp map with name %s does not exist' % name
|
||||
)
|
||||
else:
|
||||
if command == 'dscp-map-create':
|
||||
if NAME_EXISTS is True:
|
||||
module.exit_json(
|
||||
skipped=True,
|
||||
msg='dscp map with name %s already exists' % name
|
||||
)
|
||||
|
||||
if scope:
|
||||
cli += ' scope ' + scope
|
||||
|
||||
run_cli(module, cli, state_map)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
61
test/units/modules/network/netvisor/test_pn_dscp_map.py
Normal file
61
test/units/modules/network/netvisor/test_pn_dscp_map.py
Normal file
|
@ -0,0 +1,61 @@
|
|||
# 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_dscp_map
|
||||
from units.modules.utils import set_module_args
|
||||
from .nvos_module import TestNvosModule, load_fixture
|
||||
|
||||
|
||||
class TestDscpMapModule(TestNvosModule):
|
||||
|
||||
module = pn_dscp_map
|
||||
|
||||
def setUp(self):
|
||||
self.mock_run_nvos_commands = patch('ansible.modules.network.netvisor.pn_dscp_map.run_cli')
|
||||
self.run_nvos_commands = self.mock_run_nvos_commands.start()
|
||||
|
||||
self.mock_run_check_cli = patch('ansible.modules.network.netvisor.pn_dscp_map.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'] == 'dscp-map-create':
|
||||
results = dict(
|
||||
changed=True,
|
||||
cli_cmd=cli
|
||||
)
|
||||
elif state_map['absent'] == 'dscp-map-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
|
||||
|
||||
def test_dscp_map_create(self):
|
||||
set_module_args({'pn_cliswitch': 'sw01', 'pn_name': 'foo',
|
||||
'pn_scope': 'local', 'state': 'present'})
|
||||
result = self.execute_module(changed=True, state='present')
|
||||
expected_cmd = '/usr/bin/cli --quiet -e --no-login-prompt switch sw01 dscp-map-create name foo scope local'
|
||||
self.assertEqual(result['cli_cmd'], expected_cmd)
|
||||
|
||||
def test_dscp_map_delete(self):
|
||||
set_module_args({'pn_cliswitch': 'sw01', 'pn_name': 'foo',
|
||||
'state': 'absent'})
|
||||
result = self.execute_module(changed=True, state='absent')
|
||||
expected_cmd = '/usr/bin/cli --quiet -e --no-login-prompt switch sw01 dscp-map-delete name foo '
|
||||
self.assertEqual(result['cli_cmd'], expected_cmd)
|
Loading…
Reference in a new issue