Pluribus Networks port cos bw module (#50287)

* Pluribus Networks port cos bw module

* Indentation fix

* Documentation fix

* Corrected indetentation for required_one_of

* Added maintainer name in BOTMETA.yml

* Removed maintainer name in BOTMETA.yml as my team is already there

lib/ansible/modules/network/netvisor/pn_port_cos_bw.py

@@ -0,0 +1,158 @@
+#!/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_bw
+author: "Pluribus Networks (@rajaspachipulusu17)"
+version_added: "2.8"
+short_description: CLI command to modify port-cos-bw
+description:
+  - This module can be used to update bw settings for CoS queues.
+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-bw.
+    required: True
+    type: str
+    choices: ['update']
+  pn_max_bw_limit:
+    description:
+      - Maximum b/w in percentage.
+    required: False
+    type: str
+  pn_cos:
+    description:
+      - CoS priority.
+    required: False
+    type: str
+  pn_port:
+    description:
+      - physical port number.
+    required: False
+    type: str
+  pn_weight:
+    description:
+      - Scheduling weight (1 to 127) after b/w guarantee met.
+    required: False
+    type: str
+    choices: ['priority', 'no-priority']
+  pn_min_bw_guarantee:
+    description:
+      - Minimum b/w in precentage.
+    required: False
+    type: str
+"""
+
+EXAMPLES = """
+- name: port cos bw modify
+  pn_port_cos_bw:
+    pn_cliswitch: "sw01"
+    state: "update"
+    pn_port: "1"
+    pn_cos: "0"
+    pn_min_bw_guarantee: "60"
+
+- name: port cos bw modify
+  pn_port_cos_bw:
+    pn_cliswitch: "sw01"
+    state: "update"
+    pn_port: "all"
+    pn_cos: "0"
+"""
+
+RETURN = """
+command:
+  description: the CLI command run on the target node.
+  returned: always
+  type: str
+stdout:
+  description: set of responses from the port-cos-bw command.
+  returned: always
+  type: list
+stderr:
+  description: set of error responses from the port-cos-bw 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-bw-modify'
+    )
+
+    module = AnsibleModule(
+        argument_spec=dict(
+            pn_cliswitch=dict(required=False, type='str'),
+            state=dict(required=True, type='str',
+                       choices=state_map.keys()),
+            pn_max_bw_limit=dict(required=False, type='str'),
+            pn_cos=dict(required=False, type='str'),
+            pn_port=dict(required=False, type='str'),
+            pn_weight=dict(required=False, type='str',
+                           choices=['priority', 'no-priority']),
+            pn_min_bw_guarantee=dict(required=False, type='str'),
+        ),
+        required_if=(
+            ['state', 'update', ['pn_cos', 'pn_port']],
+        ),
+        required_one_of=[['pn_max_bw_limit', 'pn_min_bw_guarantee', 'pn_weight']],
+    )
+
+    # Accessing the arguments
+    cliswitch = module.params['pn_cliswitch']
+    state = module.params['state']
+    max_bw_limit = module.params['pn_max_bw_limit']
+    cos = module.params['pn_cos']
+    port = module.params['pn_port']
+    weight = module.params['pn_weight']
+    min_bw_guarantee = module.params['pn_min_bw_guarantee']
+
+    command = state_map[state]
+
+    # Building the CLI command string
+    cli = pn_cli(module, cliswitch)
+
+    if command == 'port-cos-bw-modify':
+        cli += ' %s ' % command
+        if max_bw_limit:
+            cli += ' max-bw-limit ' + max_bw_limit
+        if cos:
+            cli += ' cos ' + cos
+        if port:
+            cli += ' port ' + port
+        if weight:
+            cli += ' weight ' + weight
+        if min_bw_guarantee:
+            cli += ' min-bw-guarantee ' + min_bw_guarantee
+
+    run_cli(module, cli, state_map)
+
+
+if __name__ == '__main__':
+    main()

test/units/modules/network/netvisor/test_pn_port_cos_bw.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_port_cos_bw
+from units.modules.utils import set_module_args
+from .nvos_module import TestNvosModule, load_fixture
+
+
+class TestAdminServiceModule(TestNvosModule):
+
+    module = pn_port_cos_bw
+
+    def setUp(self):
+        self.mock_run_nvos_commands = patch('ansible.modules.network.netvisor.pn_port_cos_bw.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-bw-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_bw_modify_t1(self):
+        set_module_args({'pn_cliswitch': 'sw01', 'pn_port': '1',
+                         'pn_cos': '0', 'pn_min_bw_guarantee': '60', 'state': 'update'})
+        result = self.execute_module(changed=True, state='update')
+        expected_cmd = '/usr/bin/cli --quiet -e --no-login-prompt  switch sw01 port-cos-bw-modify  cos 0 port 1 min-bw-guarantee 60'
+        self.assertEqual(result['cli_cmd'], expected_cmd)
+
+    def test_pn_port_cos_bw_modify_t2(self):
+        set_module_args({'pn_cliswitch': 'sw01', 'pn_port': 'all',
+                         'pn_cos': '1', 'pn_weight': 'priority', 'state': 'update'})
+        result = self.execute_module(changed=True, state='update')
+        expected_cmd = '/usr/bin/cli --quiet -e --no-login-prompt  switch sw01 port-cos-bw-modify  cos 1 port all weight priority'
+        self.assertEqual(result['cli_cmd'], expected_cmd)