ASA network/service object-group module (#52925)

* add asa_og module

* add test

* fix pep8

* fix some sanity pylint

* fix import error order

* fix import

* replace cmd() method

* rename file and class

* add mock for connection

* fix commands in  replace test function

* fix lines list

* update unit test

* fix 'and' logic for port-object command

* restore previous unit test; fix pep8 and remove debug

* other unit tests

* Add state present, absent, replace

* Update doc; add default for state

* update unit test with state present/absent

* fix typo in unit test

* fix pep8 too many blank lines

* fix show run for service object ASA Ver 8.x

* Add description field; fix bug for state present and absent

* Re-designed module structure for network, service and port objects

* update integration test for new module structure

* fix pep8

* update EXAMPLES and RETURN

* update units tests

* fix module typos in unit test

* removed provider from examples

* fix missing comma in replace test

* fix module name and remove provider

* update license

* remove register; update license; change import order; chage def state

* remove shebang

* fix doc default state

* change import order

* Update year in banner

* fix integration test as set of tasks

* remove arg_spec

* remove extends_documentation_fragment: asa

* Update DOC, remove unused import, change import order

test/units/modules/network/asa/asa_module.py

@@ -0,0 +1,76 @@
+# -*- coding: utf-8 -*-
+
+# (c) 2019, Ansible by Red Hat, inc
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+# Make coding more python3-ish
+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 f:
+        data = f.read()
+
+    try:
+        data = json.loads(data)
+    except Exception:
+        pass
+
+    fixture_data[path] = data
+    return data
+
+
+class TestAsaModule(ModuleTestCase):
+
+    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):
+        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, commands=None):
+        pass

test/units/modules/network/asa/fixtures/asa_og_config.cfg

@@ -0,0 +1,5 @@
+object-group network test_nets
+description ansible_test object-group description
+network-object host 8.8.8.8
+network-object 192.168.0.0 255.255.0.0
+group-object awx_lon

test/units/modules/network/asa/test_asa_og.py

@@ -0,0 +1,107 @@
+# -*- coding: utf-8 -*-
+
+# (c) 2019, Ansible by Red Hat, inc
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+# Make coding more python3-ish
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+from units.compat.mock import patch
+from ansible.modules.network.asa import asa_og
+from units.modules.utils import set_module_args
+from .asa_module import TestAsaModule, load_fixture
+
+
+class TestAsaOgModule(TestAsaModule):
+
+    module = asa_og
+
+    def setUp(self):
+        super(TestAsaOgModule, self).setUp()
+
+        self.mock_get_config = patch('ansible.modules.network.asa.asa_og.get_config')
+        self.get_config = self.mock_get_config.start()
+
+        self.mock_load_config = patch('ansible.modules.network.asa.asa_og.load_config')
+        self.load_config = self.mock_load_config.start()
+
+        self.mock_get_connection = patch('ansible.module_utils.network.asa.asa.get_connection')
+        self.get_connection = self.mock_get_connection.start()
+
+    def tearDown(self):
+        super(TestAsaOgModule, self).tearDown()
+        self.mock_get_config.stop()
+        self.mock_load_config.stop()
+
+    def load_fixtures(self, commands=None):
+        self.get_config.return_value = load_fixture('asa_og_config.cfg').strip()
+        self.load_config.return_value = dict(diff=None, session='session')
+
+    def test_asa_og_idempotent(self):
+        set_module_args(dict(
+            name='test_nets',
+            group_type='network-object',
+            host_ip=['8.8.8.8'],
+            ip_mask=['192.168.0.0 255.255.0.0'],
+            group_object=['awx_lon'],
+            description='ansible_test object-group description',
+            state='present'
+        ))
+        commands = []
+        self.execute_module(changed=False, commands=commands)
+
+    def test_asa_og_add(self):
+        set_module_args(dict(
+            name='test_nets',
+            group_type='network-object',
+            host_ip=['8.8.8.8', '8.8.4.4'],
+            ip_mask=['192.168.0.0 255.255.0.0', '10.0.0.0 255.255.255.0'],
+            group_object=['awx_lon', 'awx_ams'],
+            description='ansible_test object-group description',
+            state='present'
+        ))
+        commands = [
+            'object-group network test_nets',
+            'network-object host 8.8.4.4',
+            'network-object 10.0.0.0 255.255.255.0',
+            'group-object awx_ams'
+        ]
+        self.execute_module(changed=True, commands=commands)
+
+    def test_asa_og_replace(self):
+        set_module_args(dict(
+            name='test_nets',
+            group_type='network-object',
+            host_ip=['8.8.4.4'],
+            ip_mask=['10.0.0.0 255.255.255.0'],
+            group_object=['awx_ams'],
+            description='ansible_test custom description',
+            state='replace'
+        ))
+        commands = [
+            'object-group network test_nets',
+            'description ansible_test custom description',
+            'no network-object host 8.8.8.8',
+            'network-object host 8.8.4.4',
+            'no network-object 192.168.0.0 255.255.0.0',
+            'network-object 10.0.0.0 255.255.255.0',
+            'no group-object awx_lon',
+            'group-object awx_ams'
+        ]
+        self.execute_module(changed=True, commands=commands)
+
+    def test_asa_og_remove(self):
+        set_module_args(dict(
+            name='test_nets',
+            group_type='network-object',
+            host_ip=['8.8.8.8'],
+            group_object=['awx_lon'],
+            state='absent'
+        ))
+        commands = [
+            'object-group network test_nets',
+            'no network-object host 8.8.8.8',
+            'no group-object awx_lon'
+        ]
+        self.execute_module(changed=True, commands=commands)