Refactors bigip_selfip (#31732)

In this refactor we moved to the most recent coding standards for
both F5 and Ansible. Many bugs were fixed and some features were
also added (such as ipv6 support).

test/units/modules/network/f5/fixtures/load_tm_net_self.json

@@ -0,0 +1,26 @@
+{
+  "kind": "tm:net:self:selfstate",
+  "name": "net1",
+  "partition": "Common",
+  "fullPath": "/Common/net1",
+  "generation": 7,
+  "selfLink": "https://localhost/mgmt/tm/net/self/~Common~net1?ver=13.0.0",
+  "address": "10.10.10.10%1/24",
+  "addressSource": "from-user",
+  "floating": "disabled",
+  "inheritedTrafficGroup": "false",
+  "trafficGroup": "/Common/traffic-group-local-only",
+  "trafficGroupReference": {
+    "link": "https://localhost/mgmt/tm/cm/traffic-group/~Common~traffic-group-local-only?ver=13.0.0"
+  },
+  "unit": 0,
+  "vlan": "/Common/net1",
+  "vlanReference": {
+    "link": "https://localhost/mgmt/tm/net/vlan/~Common~net1?ver=13.0.0"
+  },
+  "allowService": [
+    "tcp:80",
+    "udp:53",
+    "gre:0"
+  ]
+}

test/units/modules/network/f5/test_bigip_selfip.py

@@ -0,0 +1,221 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2017 F5 Networks 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/>.
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import os
+import json
+import pytest
+import sys
+
+from nose.plugins.skip import SkipTest
+if sys.version_info < (2, 7):
+    raise SkipTest("F5 Ansible modules require Python >= 2.7")
+
+from ansible.compat.tests import unittest
+from ansible.compat.tests.mock import patch, Mock
+from ansible.module_utils import basic
+from ansible.module_utils._text import to_bytes
+from ansible.module_utils.f5_utils import AnsibleF5Client
+from ansible.module_utils.f5_utils import F5ModuleError
+
+try:
+    from library.bigip_selfip import Parameters
+    from library.bigip_selfip import ApiParameters
+    from library.bigip_selfip import ModuleManager
+    from library.bigip_selfip import ArgumentSpec
+    from ansible.module_utils.f5_utils import iControlUnexpectedHTTPError
+except ImportError:
+    try:
+        from ansible.modules.network.f5.bigip_selfip import Parameters
+        from ansible.modules.network.f5.bigip_selfip import ApiParameters
+        from ansible.modules.network.f5.bigip_selfip import ModuleManager
+        from ansible.modules.network.f5.bigip_selfip import ArgumentSpec
+        from ansible.module_utils.f5_utils import iControlUnexpectedHTTPError
+    except ImportError:
+        raise SkipTest("F5 Ansible modules require the f5-sdk Python library")
+
+fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
+fixture_data = {}
+
+
+def set_module_args(args):
+    args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
+    basic._ANSIBLE_ARGS = to_bytes(args)
+
+
+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 TestParameters(unittest.TestCase):
+    def test_module_parameters(self):
+        args = dict(
+            address='10.10.10.10',
+            allow_service=[
+                'tcp:80',
+                'udp:53',
+                'gre'
+            ],
+            name='net1',
+            netmask='255.255.255.0',
+            partition='Common',
+            route_domain='1',
+            state='present',
+            traffic_group='traffic-group-local-only',
+            vlan='net1'
+        )
+        p = Parameters(args)
+        assert p.address == '10.10.10.10%1/24'
+        assert p.allow_service == set(['tcp:80', 'udp:53', 'gre:0'])
+        assert p.name == 'net1'
+        assert p.netmask == 24
+        assert p.route_domain == 1
+        assert p.traffic_group == '/Common/traffic-group-local-only'
+        assert p.vlan == '/Common/net1'
+
+    def test_module_invalid_service(self):
+        args = dict(
+            allow_service=[
+                'tcp:80',
+                'udp:53',
+                'grp'
+            ]
+        )
+        p = Parameters(args)
+        with pytest.raises(F5ModuleError) as ex:
+            assert p.allow_service == set(['tcp:80', 'udp:53', 'grp'])
+        assert 'The provided protocol' in str(ex)
+
+    def test_api_parameters(self):
+        args = dict(
+            address='10.10.10.10%1/24',
+            allowService=[
+                'tcp:80',
+                'udp:53',
+                'gre'
+            ],
+            name='net1',
+            state='present',
+            trafficGroup='/Common/traffic-group-local-only',
+            vlan='net1'
+        )
+        p = ApiParameters(args)
+        assert p.address == '10.10.10.10%1/24'
+        assert p.allow_service == set(['tcp:80', 'udp:53', 'gre'])
+        assert p.name == 'net1'
+        assert p.netmask == 24
+        assert p.route_domain == 1
+        assert p.traffic_group == '/Common/traffic-group-local-only'
+        assert p.vlan == '/Common/net1'
+
+
+@patch('ansible.module_utils.f5_utils.AnsibleF5Client._get_mgmt_root',
+       return_value=True)
+class TestManager(unittest.TestCase):
+
+    def setUp(self):
+        self.spec = ArgumentSpec()
+
+    def test_create_selfip(self, *args):
+        set_module_args(dict(
+            address='10.10.10.10',
+            allow_service=[
+                'tcp:80',
+                'udp:53',
+                'gre'
+            ],
+            name='net1',
+            netmask='255.255.255.0',
+            partition='Common',
+            route_domain='1',
+            state='present',
+            traffic_group='traffic-group-local-only',
+            vlan='net1',
+            password='passsword',
+            server='localhost',
+            user='admin'
+        ))
+
+        client = AnsibleF5Client(
+            argument_spec=self.spec.argument_spec,
+            supports_check_mode=self.spec.supports_check_mode,
+            f5_product_name=self.spec.f5_product_name
+        )
+        mm = ModuleManager(client)
+
+        # Override methods to force specific logic in the module to happen
+        mm.exists = Mock(side_effect=[False, True])
+        mm.create_on_device = Mock(return_value=True)
+
+        results = mm.exec_module()
+
+        assert results['changed'] is True
+
+    def test_create_selfip_idempotent(self, *args):
+        set_module_args(dict(
+            address='10.10.10.10',
+            allow_service=[
+                'tcp:80',
+                'udp:53',
+                'gre'
+            ],
+            name='net1',
+            netmask='255.255.255.0',
+            partition='Common',
+            route_domain='1',
+            state='present',
+            traffic_group='traffic-group-local-only',
+            vlan='net1',
+            password='passsword',
+            server='localhost',
+            user='admin'
+        ))
+
+        current = ApiParameters(load_fixture('load_tm_net_self.json'))
+
+        client = AnsibleF5Client(
+            argument_spec=self.spec.argument_spec,
+            supports_check_mode=self.spec.supports_check_mode,
+            f5_product_name=self.spec.f5_product_name
+        )
+        mm = ModuleManager(client)
+
+        # Override methods to force specific logic in the module to happen
+        mm.exists = Mock(side_effect=[True, True])
+        mm.read_current_from_device = Mock(return_value=current)
+
+        results = mm.exec_module()
+
+        assert results['changed'] is False