modules: network: Add initial support for Ingate modules (#47494)

* modules: network: Add initial support for Ingate modules

* modules: network: Add ingate module ig_unit_information

* module_utils: network: ingate: Use default 'v1' for version

* modules: network: ingate: Remove unused code

test/units/modules/network/ingate/fixtures/test_ig_unit_information.json

@@ -0,0 +1,21 @@
+[
+    {
+        "unit-information": {
+            "lic_email": "dev@ingate.com",
+            "lang": "en",
+            "product": "Software SIParator/Firewall",
+            "installid": "any",
+            "patches": [],
+            "lic_mac": "any",
+            "unitname": "testname",
+            "interfaces": "eth0 eth1 eth2 eth3 eth4 eth5",
+            "modules": "failover vpn sip qturn ems qos rsc voipsm idsips siptrunk sipswitch",
+            "lic_name": "Ingate",
+            "macaddr": "52:54:00:4c:e2:07",
+            "version": "6.2.0-erik",
+            "systemid": "IG-200-840-5001-0",
+            "mode": "Firewall",
+            "serial": "IG-200-840-5001-0"
+        }
+    }
+]

test/units/modules/network/ingate/ingate_module.py

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2018, Ingate Systems AB
+#
+# 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/>.
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import os
+import json
+
+from units.modules.utils import AnsibleExitJson, AnsibleFailJson, ModuleTestCase
+
+
+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 file_desc:
+        data = file_desc.read()
+
+    try:
+        data = json.loads(data)
+    except:
+        pass
+
+    fixture_data[path] = data
+    return data
+
+
+class TestIngateModule(ModuleTestCase):
+
+    def execute_module(self, failed=False, changed=False, fixture=None):
+
+        self.load_fixtures(fixture)
+
+        if failed:
+            result = self.failed()
+            self.assertTrue(result['failed'], result)
+        else:
+            result = self.changed(changed)
+            self.assertEqual(result['changed'], changed, result)
+
+        return result
+
+    def failed(self):
+        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):
+        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, module_name=None):
+        pass

test/units/modules/network/ingate/test_ig_unit_information.py

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2018, Ingate Systems AB
+#
+# 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/>.
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import os
+
+from units.compat.mock import patch
+from ansible.modules.network.ingate import ig_unit_information
+from units.modules.utils import set_module_args
+from .ingate_module import TestIngateModule, load_fixture
+
+
+class TestUnitInformationModule(TestIngateModule):
+
+    module = ig_unit_information
+
+    def setUp(self):
+        super(TestUnitInformationModule, self).setUp()
+
+        self.mock_make_request = patch('ansible.modules.network.ingate.'
+                                       'ig_unit_information.make_request')
+        self.make_request = self.mock_make_request.start()
+        # ATM the Ingate Python SDK is not needed in this unit test.
+        self.module.HAS_INGATESDK = True
+
+    def tearDown(self):
+        super(TestUnitInformationModule, self).tearDown()
+        self.mock_make_request.stop()
+
+    def load_fixtures(self, fixture=None):
+        self.make_request.side_effect = [load_fixture(fixture)]
+
+    def test_ig_unit_information(self):
+        set_module_args(dict(
+            client=dict(
+                version='v1',
+                address='127.0.0.1',
+                scheme='http',
+                username='alice',
+                password='foobar'
+            )))
+        fixture = '%s.%s' % (os.path.basename(__file__).split('.')[0], 'json')
+        result = self.execute_module(fixture=fixture)
+        self.assertTrue('unit-information' in result)