From d5797aa02fdda38c942513c21a0ae7a3eb23046d Mon Sep 17 00:00:00 2001 From: rajaspachipulusu17 Date: Tue, 5 Feb 2019 10:23:07 +0530 Subject: [PATCH] Pluribus Networks role module with Unit tests (#51261) * Pluribus Networks role module with Unit tests * pep8 sanity fixes * Doc fix --- .../modules/network/netvisor/pn_role.py | 236 ++++++++++++++++++ .../modules/network/netvisor/test_pn_role.py | 76 ++++++ 2 files changed, 312 insertions(+) create mode 100644 lib/ansible/modules/network/netvisor/pn_role.py create mode 100644 test/units/modules/network/netvisor/test_pn_role.py diff --git a/lib/ansible/modules/network/netvisor/pn_role.py b/lib/ansible/modules/network/netvisor/pn_role.py new file mode 100644 index 0000000000..4feb3dadac --- /dev/null +++ b/lib/ansible/modules/network/netvisor/pn_role.py @@ -0,0 +1,236 @@ +#!/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_role +author: "Pluribus Networks (@rajaspachipulusu17)" +version_added: "2.8" +short_description: CLI command to create/delete/modify role +description: + - This module can be used to create, delete and modify user roles. +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 role and + C(absent) to delete role and C(update) to modify role. + required: true + type: str + choices: ['present', 'absent', 'update'] + pn_scope: + description: + - local or fabric. + required: false + type: str + choices: ['local', 'fabric'] + pn_access: + description: + - type of access. + required: false + type: str + choices: ['read-only', 'read-write'] + pn_shell: + description: + - allow shell command. + required: false + type: bool + pn_sudo: + description: + - allow sudo from shell. + required: false + type: bool + pn_running_config: + description: + - display running configuration of switch. + required: false + type: bool + pn_name: + description: + - role name. + required: true + type: str + pn_delete_from_users: + description: + - delete from users. + required: false + type: bool +""" + +EXAMPLES = """ +- name: Role create + pn_role: + pn_cliswitch: 'sw01' + state: 'present' + pn_name: 'foo' + pn_scope: 'local' + pn_access: 'read-only' + +- name: Role delete + pn_role: + pn_cliswitch: 'sw01' + state: 'absent' + pn_name: 'foo' + +- name: Role modify + pn_role: + pn_cliswitch: 'sw01' + state: 'update' + pn_name: 'foo' + pn_access: 'read-write' + pn_sudo: true + pn_shell: true +""" + +RETURN = """ +command: + description: the CLI command run on the target node. + returned: always + type: str +stdout: + description: set of responses from the role command. + returned: always + type: list +stderr: + description: set of error responses from the role 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 check_cli(module, cli): + """ + This method checks for idempotency using the role-show command. + If a role with given name exists, return True else False. + :param module: The Ansible module to fetch input parameters + :param cli: The CLI string + """ + role_name = module.params['pn_name'] + + cli += ' role-show format name no-show-headers' + out = module.run_command(cli.split(), use_unsafe_shell=True)[1] + + out = out.split() + + return True if role_name in out else False + + +def main(): + """ This section is for arguments parsing """ + + state_map = dict( + present='role-create', + absent='role-delete', + update='role-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_access=dict(required=False, type='str', + choices=['read-only', 'read-write']), + pn_shell=dict(required=False, type='bool'), + pn_sudo=dict(required=False, type='bool'), + pn_running_config=dict(required=False, type='bool'), + pn_name=dict(required=False, type='str'), + pn_delete_from_users=dict(required=False, type='bool'), + ), + required_if=( + ["state", "present", ["pn_name", "pn_scope"]], + ["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'] + access = module.params['pn_access'] + shell = module.params['pn_shell'] + sudo = module.params['pn_sudo'] + running_config = module.params['pn_running_config'] + name = module.params['pn_name'] + delete_from_users = module.params['pn_delete_from_users'] + + command = state_map[state] + + # Building the CLI command string + cli = pn_cli(module, cliswitch) + + ROLE_EXISTS = check_cli(module, cli) + cli += ' %s name %s ' % (command, name) + + if shell is (False or '') and sudo is True: + module.fail_json( + failed=True, + msg='sudo access requires shell access' + ) + + if command == 'role-modify': + if ROLE_EXISTS is False: + module.fail_json( + failed=True, + msg='Role with name %s does not exist' % name + ) + + if command == 'role-delete': + if ROLE_EXISTS is False: + module.exit_json( + skipped=True, + msg='Role with name %s does not exist' % name + ) + + if command == 'role-create': + if ROLE_EXISTS is True: + module.exit_json( + skipped=True, + msg='Role with name %s already exists' % name + ) + + if scope: + cli += ' scope ' + scope + + if command != 'role-delete': + if access: + cli += ' access ' + access + + cli += booleanArgs(shell, 'shell', 'no-shell') + cli += booleanArgs(sudo, 'sudo', 'no-sudo') + cli += booleanArgs(running_config, 'running-config', 'no-running-config') + + if command == 'role-modify': + if delete_from_users: + cli += ' delete-from-users ' + delete_from_users + + run_cli(module, cli, state_map) + + +if __name__ == '__main__': + main() diff --git a/test/units/modules/network/netvisor/test_pn_role.py b/test/units/modules/network/netvisor/test_pn_role.py new file mode 100644 index 0000000000..b3e1961a9b --- /dev/null +++ b/test/units/modules/network/netvisor/test_pn_role.py @@ -0,0 +1,76 @@ +# 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_role +from units.modules.utils import set_module_args +from .nvos_module import TestNvosModule, load_fixture + + +class TestRoleModule(TestNvosModule): + + module = pn_role + + def setUp(self): + self.mock_run_nvos_commands = patch('ansible.modules.network.netvisor.pn_role.run_cli') + self.run_nvos_commands = self.mock_run_nvos_commands.start() + + self.mock_run_check_cli = patch('ansible.modules.network.netvisor.pn_role.check_cli') + self.run_check_cli = self.mock_run_check_cli.start() + + def tearDown(self): + self.mock_run_nvos_commands.stop() + self.run_check_cli.stop() + + def run_cli_patch(self, module, cli, state_map): + if state_map['present'] == 'role-create': + results = dict( + changed=True, + cli_cmd=cli + ) + elif state_map['absent'] == 'role-delete': + results = dict( + changed=True, + cli_cmd=cli + ) + elif state_map['update'] == 'role-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 + 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_role_create(self): + set_module_args({'pn_cliswitch': 'sw01', 'pn_name': 'foo', + 'pn_scope': 'local', 'pn_access': 'read-only', 'state': 'present'}) + result = self.execute_module(changed=True, state='present') + expected_cmd = '/usr/bin/cli --quiet -e --no-login-prompt switch sw01 role-create name foo scope local access read-only' + self.assertEqual(result['cli_cmd'], expected_cmd) + + def test_role_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 role-delete name foo ' + self.assertEqual(result['cli_cmd'], expected_cmd) + + def test_role_update(self): + set_module_args({'pn_cliswitch': 'sw01', 'pn_name': 'foo', + 'pn_access': 'read-write', 'pn_sudo': True, 'pn_shell': True, 'state': 'update'}) + result = self.execute_module(changed=True, state='update') + expected_cmd = '/usr/bin/cli --quiet -e --no-login-prompt switch sw01 role-modify name foo access read-write shell sudo ' + self.assertEqual(result['cli_cmd'], expected_cmd)