From 5309d6c131ceda84ec36e7fab06878c8593735bc Mon Sep 17 00:00:00 2001 From: rajaspachipulusu17 Date: Thu, 2 May 2019 18:34:29 +0530 Subject: [PATCH] Pluribus networks fabric local module with UT (#55872) * Pluribus networks fabric local module with UT * Sanity fix * Ansible doc standards * Unit test fix --- .../network/netvisor/pn_fabric_local.py | 168 ++++++++++++++++++ .../network/netvisor/test_pn_fabric_local.py | 49 +++++ 2 files changed, 217 insertions(+) create mode 100644 lib/ansible/modules/network/netvisor/pn_fabric_local.py create mode 100644 test/units/modules/network/netvisor/test_pn_fabric_local.py diff --git a/lib/ansible/modules/network/netvisor/pn_fabric_local.py b/lib/ansible/modules/network/netvisor/pn_fabric_local.py new file mode 100644 index 00000000000..0db5cbed0bb --- /dev/null +++ b/lib/ansible/modules/network/netvisor/pn_fabric_local.py @@ -0,0 +1,168 @@ +#!/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_fabric_local +author: "Pluribus Networks (@rajaspachipulusu17)" +version_added: "2.9" +short_description: CLI command to modify fabric-local +description: + - This module can be used to modify fabric local information. +options: + pn_cliswitch: + description: + - Target switch to run the CLI on. + required: true + type: str + state: + description: + - State the action to perform. Use C(update) to modify the fabric-local. + required: false + type: str + choices: ['update'] + default: 'update' + pn_fabric_network: + description: + - fabric administration network. + required: false + choices: ['in-band', 'mgmt', 'vmgmt'] + default: 'mgmt' + pn_vlan: + description: + - VLAN assigned to fabric. + required: false + type: str + pn_control_network: + description: + - control plane network. + required: false + choices: ['in-band', 'mgmt', 'vmgmt'] + pn_fabric_advertisement_network: + description: + - network to send fabric advertisements on. + required: false + choices: ['inband-mgmt', 'inband-only', 'inband-vmgmt', 'mgmt-only'] +""" + +EXAMPLES = """ +- name: Fabric local module + pn_fabric_local: + pn_cliswitch: "sw01" + pn_vlan: "500" + +- name: Fabric local module + pn_fabric_local: + pn_cliswitch: "sw01" + pn_fabric_advertisement_network: "mgmt-only" +""" + +RETURN = """ +command: + description: the CLI command run on the target node. + returned: always + type: str +stdout: + description: set of responses from the fabric-local command. + returned: always + type: list +stderr: + description: set of error responses from the fabric-local 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 main(): + """ This section is for arguments parsing """ + + state_map = dict( + update='fabric-local-modify' + ) + + argument_spec = dict( + pn_cliswitch=dict(required=True, type='str'), + state=dict(required=False, type='str', choices=state_map.keys(), default='update'), + pn_fabric_network=dict(required=False, type='str', + choices=['mgmt', 'in-band', 'vmgmt'], default='mgmt'), + pn_vlan=dict(required=False, type='str'), + pn_control_network=dict(required=False, type='str', + choices=['in-band', 'mgmt', 'vmgmt']), + pn_fabric_advertisement_network=dict(required=False, type='str', + choices=['inband-mgmt', 'inband-only', 'inband-vmgmt', 'mgmt-only']), + ) + + module = AnsibleModule( + argument_spec=argument_spec, + required_one_of=[['pn_fabric_network', 'pn_vlan', + 'pn_control_network', + 'pn_fabric_advertisement_network']], + ) + + # Accessing the arguments + cliswitch = module.params['pn_cliswitch'] + state = module.params['state'] + fabric_network = module.params['pn_fabric_network'] + vlan = module.params['pn_vlan'] + control_network = module.params['pn_control_network'] + fabric_adv_network = module.params['pn_fabric_advertisement_network'] + + command = state_map[state] + + if vlan: + if int(vlan) < 1 or int(vlan) > 4092: + module.fail_json( + failed=True, + msg='Valid vlan range is 1 to 4092' + ) + cli = pn_cli(module, cliswitch) + cli += ' vlan-show format id no-show-headers' + out = run_commands(module, cli)[1].split() + + if vlan in out and vlan != '1': + module.fail_json( + failed=True, + msg='vlan %s is already in used. Specify unused vlan' % vlan + ) + + # Building the CLI command string + cli = pn_cli(module, cliswitch) + + if command == 'fabric-local-modify': + cli += ' %s ' % command + + if fabric_network: + cli += ' fabric-network ' + fabric_network + + if vlan: + cli += ' vlan ' + vlan + + if control_network: + cli += ' control-network ' + control_network + + if fabric_adv_network: + cli += ' fabric-advertisement-network ' + fabric_adv_network + + run_cli(module, cli, state_map) + + +if __name__ == '__main__': + main() diff --git a/test/units/modules/network/netvisor/test_pn_fabric_local.py b/test/units/modules/network/netvisor/test_pn_fabric_local.py new file mode 100644 index 00000000000..714a6477df4 --- /dev/null +++ b/test/units/modules/network/netvisor/test_pn_fabric_local.py @@ -0,0 +1,49 @@ +# 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_fabric_local +from units.modules.utils import set_module_args +from .nvos_module import TestNvosModule, load_fixture + + +class TestFabricLocalModule(TestNvosModule): + + module = pn_fabric_local + + def setUp(self): + self.mock_run_nvos_commands = patch('ansible.modules.network.netvisor.pn_fabric_local.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'] == 'fabric-local-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_fabric_local_modify_t1(self): + set_module_args({'pn_cliswitch': 'sw01', 'pn_fabric_advertisement_network': 'mgmt-only', + 'state': 'update'}) + result = self.execute_module(changed=True, state='update') + expected_cmd = ' switch sw01 fabric-local-modify fabric-network mgmt fabric-advertisement-network mgmt-only' + self.assertEqual(result['cli_cmd'], expected_cmd) + + def test_fabric_local_modify_t2(self): + set_module_args({'pn_cliswitch': 'sw01', 'pn_fabric_network': 'mgmt', + 'state': 'update'}) + result = self.execute_module(changed=True, state='update') + expected_cmd = ' switch sw01 fabric-local-modify fabric-network mgmt' + self.assertEqual(result['cli_cmd'], expected_cmd)