New module aireos_command (#26769)

* Adding ciscowlc_command module and unit tests.

* Adding __init__.py for unit test.

* Fixing PEP8 W503.

* Renaming module from ciscowlc_command to aire_command.

* Renaming aire_command to aireos_command.

test/units/modules/network/aireos/aireos_module.py

@@ -0,0 +1,114 @@
+# (c) 2016 Red Hat Inc.
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+# Make coding more python3-ish
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import os
+import json
+
+from ansible.compat.tests import unittest
+from ansible.compat.tests.mock import patch
+from ansible.module_utils import basic
+from ansible.module_utils._text import to_bytes
+
+
+def set_module_args(args):
+    args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
+    basic._ANSIBLE_ARGS = to_bytes(args)
+
+fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
+fixture_data = {}
+
+
+def load_fixture(name):
+    path = os.path.join(fixture_path, name)
+
+    if path in fixture_data:
+        return fixture_data[path]
+
+    with open(path) as f:
+        data = f.read()
+
+    try:
+        data = json.loads(data)
+    except:
+        pass
+
+    fixture_data[path] = data
+    return data
+
+
+class AnsibleExitJson(Exception):
+    pass
+
+
+class AnsibleFailJson(Exception):
+    pass
+
+
+class TestCiscoWlcModule(unittest.TestCase):
+
+    def execute_module(self, failed=False, changed=False, commands=None, sort=True, defaults=False):
+
+        self.load_fixtures(commands)
+
+        if failed:
+            result = self.failed()
+            self.assertTrue(result['failed'], result)
+        else:
+            result = self.changed(changed)
+            self.assertEqual(result['changed'], changed, result)
+
+        if commands is not None:
+            if sort:
+                self.assertEqual(sorted(commands), sorted(result['commands']), result['commands'])
+            else:
+                self.assertEqual(commands, result['commands'], result['commands'])
+
+        return result
+
+    def failed(self):
+        def fail_json(*args, **kwargs):
+            kwargs['failed'] = True
+            raise AnsibleFailJson(kwargs)
+
+        with patch.object(basic.AnsibleModule, 'fail_json', fail_json):
+            with self.assertRaises(AnsibleFailJson) as exc:
+                self.module.main()
+
+        result = exc.exception.args[0]
+        self.assertTrue(result['failed'], result)
+        return result
+
+    def changed(self, changed=False):
+        def exit_json(*args, **kwargs):
+            if 'changed' not in kwargs:
+                kwargs['changed'] = False
+            raise AnsibleExitJson(kwargs)
+
+        with patch.object(basic.AnsibleModule, 'exit_json', exit_json):
+            with self.assertRaises(AnsibleExitJson) as exc:
+                self.module.main()
+
+        result = exc.exception.args[0]
+        self.assertEqual(result['changed'], changed, result)
+        return result
+
+    def load_fixtures(self, commands=None):
+        pass

test/units/modules/network/aireos/fixtures/show_sysinfo

@@ -0,0 +1,43 @@
+Manufacturer's Name.............................. Cisco Systems Inc.
+Product Name..................................... Cisco Controller
+Product Version.................................. 8.2.110.0
+RTOS Version..................................... 8.2.110.0
+Bootloader Version............................... 8.0.100.0
+Emergency Image Version.......................... 8.0.100.0
+
+Build Type....................................... DATA + WPS
+
+System Name...................................... SOMEHOST
+System Location.................................. USA
+System Contact................................... SN:E228240;ASSET:LSMTCc1
+System ObjectID.................................. 1.3.6.1.4.1.9.1.1615
+Redundancy Mode.................................. Disabled
+IP Address....................................... 10.10.10.10
+IPv6 Address..................................... ::
+System Up Time................................... 328 days 7 hrs 54 mins 49 secs
+System Timezone Location......................... (GMT) London, Lisbon, Dublin, Edinburgh
+System Stats Realtime Interval................... 5
+System Stats Normal Interval..................... 180
+
+Configured Country............................... US  - United States
+Operating Environment............................ Commercial (10 to 35 C)
+Internal Temp Alarm Limits....................... 10 to 38 C
+Internal Temperature............................. +18 C
+Fan Status....................................... OK
+
+                                                    RAID Volume Status
+Drive 0.......................................... Good
+Drive 1.......................................... Good
+
+State of 802.11b Network......................... Enabled
+State of 802.11a Network......................... Enabled
+Number of WLANs.................................. 1
+Number of Active Clients......................... 0
+
+Burned-in MAC Address............................ AA:AA:AA:AA:AA:AA
+Power Supply 1................................... Present, OK
+Power Supply 2................................... Present, OK
+Maximum number of APs supported.................. 6000
+System Nas-Id....................................
+WLC MIC Certificate Types........................ SHA1/SHA2
+Licensing Type................................... RTU

test/units/modules/network/aireos/test_aireos_command.py

@@ -0,0 +1,104 @@
+# (c) 2016 Red Hat Inc.
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+# Make coding more python3-ish
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import json
+
+from ansible.compat.tests.mock import patch
+from ansible.modules.network.aireos import aireos_command
+from .aireos_module import TestCiscoWlcModule, load_fixture, set_module_args
+
+
+class TestCiscoWlcCommandModule(TestCiscoWlcModule):
+
+    module = aireos_command
+
+    def setUp(self):
+        self.mock_run_commands = patch('ansible.modules.network.aireos.aireos_command.run_commands')
+        self.run_commands = self.mock_run_commands.start()
+
+    def tearDown(self):
+        self.mock_run_commands.stop()
+
+    def load_fixtures(self, commands=None):
+
+        def load_from_file(*args, **kwargs):
+            module, commands = args
+            output = list()
+
+            for item in commands:
+                try:
+                    obj = json.loads(item['command'])
+                    command = obj['command']
+                except ValueError:
+                    command = item['command']
+                filename = str(command).replace(' ', '_')
+                output.append(load_fixture(filename))
+            return output
+
+        self.run_commands.side_effect = load_from_file
+
+    def test_aireos_command_simple(self):
+        set_module_args(dict(commands=['show sysinfo']))
+        result = self.execute_module()
+        self.assertEqual(len(result['stdout']), 1)
+        self.assertTrue(result['stdout'][0].startswith('Manufacturer\'s Name'))
+
+    def test_aireos_command_multiple(self):
+        set_module_args(dict(commands=['show sysinfo', 'show sysinfo']))
+        result = self.execute_module()
+        self.assertEqual(len(result['stdout']), 2)
+        self.assertTrue(result['stdout'][0].startswith('Manufacturer\'s Name'))
+
+    def test_aireos_command_wait_for(self):
+        wait_for = 'result[0] contains "Cisco Systems Inc"'
+        set_module_args(dict(commands=['show sysinfo'], wait_for=wait_for))
+        self.execute_module()
+
+    def test_aireos_command_wait_for_fails(self):
+        wait_for = 'result[0] contains "test string"'
+        set_module_args(dict(commands=['show sysinfo'], wait_for=wait_for))
+        self.execute_module(failed=True)
+        self.assertEqual(self.run_commands.call_count, 10)
+
+    def test_aireos_command_retries(self):
+        wait_for = 'result[0] contains "test string"'
+        set_module_args(dict(commands=['show sysinfo'], wait_for=wait_for, retries=2))
+        self.execute_module(failed=True)
+        self.assertEqual(self.run_commands.call_count, 2)
+
+    def test_aireos_command_match_any(self):
+        wait_for = ['result[0] contains "Cisco Systems Inc"',
+                    'result[0] contains "test string"']
+        set_module_args(dict(commands=['show sysinfo'], wait_for=wait_for, match='any'))
+        self.execute_module()
+
+    def test_aireos_command_match_all(self):
+        wait_for = ['result[0] contains "Cisco Systems Inc"',
+                    'result[0] contains "Cisco Controller"']
+        set_module_args(dict(commands=['show sysinfo'], wait_for=wait_for, match='all'))
+        self.execute_module()
+
+    def test_aireos_command_match_all_failure(self):
+        wait_for = ['result[0] contains "Cisco Systems Inc"',
+                    'result[0] contains "test string"']
+        commands = ['show sysinfo', 'show sysinfo']
+        set_module_args(dict(commands=commands, wait_for=wait_for, match='all'))
+        self.execute_module(failed=True)