Merge pull request #496 from caphrim007/add-gtm-irule-support

Adds GTM iRule api support

Author: pjbreaux

conftest.py

@@ -14,6 +14,7 @@
 #
 
 from f5.bigip import BigIP
+from f5.bigip import ManagementRoot
 import mock
 import pytest
 
@@ -76,6 +77,13 @@ def bigip(opt_bigip, opt_username, opt_password, opt_port, scope="module"):
     return b
 
 
+@pytest.fixture
+def mgmt_root(opt_bigip, opt_username, opt_password, opt_port, scope="module"):
+    '''bigip fixture'''
+    m = ManagementRoot(opt_bigip, opt_username, opt_password, port=opt_port)
+    return m
+
+
 @pytest.fixture
 def opt_release(request):
     return request.config.getoption("--release")

f5/bigip/__init__.py

@@ -27,6 +27,7 @@
 from f5.bigip.shared import Shared
 from f5.bigip.tm.auth import Auth as TmAuth
 from f5.bigip.tm.cm import Cm as TmCm
+from f5.bigip.tm.gtm import Gtm
 from f5.bigip.tm.ltm import Ltm
 from f5.bigip.tm.net import Net
 from f5.bigip.tm.shared import Shared as TmShared
@@ -92,4 +93,4 @@ def __init__(self, hostname, username, password, **kwargs):
         super(BigIP, self).__init__(hostname, username, password, **kwargs)
         self._meta_data['uri'] = self._meta_data['uri'] + 'tm/'
         self._meta_data['allowed_lazy_attributes'] =\
-            [TmAuth, TmCm, Ltm, Net, TmShared, Sys, Transactions]
+            [TmAuth, TmCm, Ltm, Gtm, Net, TmShared, Sys, Transactions]

f5/bigip/tm/__init__.py

@@ -20,6 +20,7 @@
 
 from f5.bigip.tm.auth import Auth
 from f5.bigip.tm.cm import Cm
+from f5.bigip.tm.gtm import Gtm
 from f5.bigip.tm.ltm import Ltm
 from f5.bigip.tm.net import Net
 from f5.bigip.tm.shared import Shared
@@ -34,6 +35,7 @@ def __init__(self, bigip):
         self._meta_data['allowed_lazy_attributes'] = [
             Auth,
             Cm,
+            Gtm,
             Ltm,
             Net,
             Shared,

f5/bigip/tm/gtm/__init__.py

@@ -0,0 +1,41 @@
+# coding=utf-8
+#
+# Copyright 2015-2016 F5 Networks Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+"""BIG-IP® Global Traffic Manager™ (GTM®) module.
+
+REST URI
+    ``http://localhost/mgmt/tm/gtm/``
+
+GUI Path
+    ``DNS``
+
+REST Kind
+    ``tm:gtm:*``
+"""
+
+
+from f5.bigip.resource import OrganizingCollection
+from f5.bigip.tm.gtm.rule import Rules
+
+
+class Gtm(OrganizingCollection):
+    """BIG-IP® Global Traffic Manager (GTM) organizing collection."""
+    def __init__(self, tm):
+        super(Gtm, self).__init__(tm)
+        self._meta_data['allowed_lazy_attributes'] = [
+            Rules
+        ]

f5/bigip/tm/gtm/rule.py

@@ -0,0 +1,49 @@
+# coding=utf-8
+#
+# Copyright 2014-2015 F5 Networks Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+"""BIG-IP® Global Traffic Manager (GTM) rule module.
+
+REST URI
+    ``http://localhost/mgmt/tm/gtm/rule``
+
+GUI Path
+    ``DNS --> GSLB : iRules``
+
+REST Kind
+    ``tm:gtm:rule:*``
+"""
+
+from f5.bigip.resource import Collection
+from f5.bigip.resource import Resource
+
+
+class Rules(Collection):
+    """BIG-IP® GTM rule collection"""
+    def __init__(self, ltm):
+        super(Rules, self).__init__(ltm)
+        self._meta_data['allowed_lazy_attributes'] = [Rule]
+        self._meta_data['attribute_registry'] =\
+            {'tm:gtm:rule:rulestate': Rule}
+
+
+class Rule(Resource):
+    """BIG-IP® GTM rule resource"""
+    def __init__(self, rule_s):
+        super(Rule, self).__init__(rule_s)
+        self._meta_data['required_json_kind'] = 'tm:gtm:rule:rulestate'
+        self._meta_data['required_creation_parameters'].update(
+            ('name', 'partition', 'apiAnonymous'))

f5/bigip/tm/gtm/test/__init__.py

@@ -0,0 +1,52 @@
+# Copyright 2015 F5 Networks Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+import mock
+import pytest
+
+from f5.bigip import ManagementRoot
+from f5.bigip.resource import MissingRequiredCreationParameter
+from f5.bigip.tm.gtm.rule import Rule
+
+
+@pytest.fixture
+def FakeRule():
+    fake_rule_s = mock.MagicMock()
+    fake_rule = Rule(fake_rule_s)
+    return fake_rule
+
+
+class TestCreate(object):
+    def test_create_two(self, fakeicontrolsession):
+        b = ManagementRoot('192.168.1.1', 'admin', 'admin')
+        r1 = b.tm.gtm.rules.rule
+        r2 = b.tm.gtm.rules.rule
+        assert r1 is not r2
+
+    def test_create_no_args(self, FakeRule):
+        with pytest.raises(MissingRequiredCreationParameter):
+            FakeRule.create()
+
+    def test_create_partition(self, FakeRule):
+        with pytest.raises(MissingRequiredCreationParameter):
+            FakeRule.create(partition='Common')
+
+    def test_create_name(self, FakeRule):
+        with pytest.raises(MissingRequiredCreationParameter):
+            FakeRule.create(name='myname')
+
+    def test_create_api_anon(self, FakeRule):
+        with pytest.raises(MissingRequiredCreationParameter):
+            FakeRule.create(apiAnonymous='when LB_SELECTED {}')

f5/bigip/tm/gtm/test/test_rule.py

@@ -0,0 +1,178 @@
+# Copyright 2015 F5 Networks Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+import pytest
+
+from f5.bigip.resource import MissingRequiredCreationParameter
+from f5.bigip.tm.gtm.rule import Rule
+from requests.exceptions import HTTPError
+
+
+RULE = '''when LB_SELECTED {
+   set wipHost [LB::server addr]
+}
+'''
+
+
+def delete_rule(mgmt_root, name, partition):
+    r = mgmt_root.tm.gtm.rules.rule
+    try:
+        r.load(name=name, partition=partition)
+    except HTTPError as err:
+        if err.response.status_code != 404:
+            raise
+        return
+    r.delete()
+
+
+def setup_create_test(request, mgmt_root, name, partition):
+    def teardown():
+        delete_rule(mgmt_root, name, partition)
+    request.addfinalizer(teardown)
+
+
+def setup_basic_test(request, mgmt_root, name, partition):
+    def teardown():
+        delete_rule(mgmt_root, name, partition)
+
+    rule1 = mgmt_root.tm.gtm.rules.rule
+    rule1.create(name=name, partition=partition, apiAnonymous=RULE)
+    request.addfinalizer(teardown)
+    return rule1
+
+
+class TestCreate(object):
+    def test_create_no_args(self, mgmt_root):
+        rule1 = mgmt_root.tm.gtm.rules.rule
+        with pytest.raises(MissingRequiredCreationParameter):
+            rule1.create()
+
+    def test_create_no_apianonymous(self, mgmt_root):
+        rule1 = mgmt_root.tm.gtm.rules.rule
+        with pytest.raises(MissingRequiredCreationParameter):
+            rule1.create(name='rule1', partition='Common')
+
+    def test_create(self, request, mgmt_root):
+        setup_create_test(request, mgmt_root, 'rule1', 'Common')
+        rule1 = mgmt_root.tm.gtm.rules.rule
+        rule1.create(name='rule1', partition='Common', apiAnonymous=RULE)
+        assert rule1.name == 'rule1'
+        assert rule1.partition == 'Common'
+        assert rule1.generation and isinstance(rule1.generation, int)
+        assert 'LB_SELECTED' in rule1.apiAnonymous
+        assert rule1.fullPath == '/Common/rule1'
+        assert rule1.kind == 'tm:gtm:rule:rulestate'
+        assert rule1.selfLink.startswith(
+            'https://localhost/mgmt/tm/gtm/rule/~Common~rule1')
+
+    def test_create_optional_args(self, request, mgmt_root):
+        setup_create_test(request, mgmt_root, 'rule1', 'Common')
+        rule1 = mgmt_root.tm.gtm.rules.rule
+        rule1.create(name='rule1', partition='Common',
+                     apiAnonymous=RULE,
+                     check='syntax')
+        assert 'check syntax' in rule1.apiAnonymous
+
+    def test_create_duplicate(self, request, mgmt_root):
+        setup_create_test(request, mgmt_root, 'rule1', 'Common')
+        rule1 = mgmt_root.tm.gtm.rules.rule
+        rule1.create(name='rule1', partition='Common',
+                     apiAnonymous=RULE,
+                     check='syntax')
+        rule2 = mgmt_root.tm.gtm.rules.rule
+        with pytest.raises(HTTPError) as err:
+            rule2.create(name='rule1', partition='Common',
+                         apiAnonymous=RULE,
+                         check='syntax')
+            assert err.response.status_code == 400
+
+
+class TestRefresh(object):
+    def test_refresh(self, request, mgmt_root):
+        setup_basic_test(request, mgmt_root, 'rule1', 'Common')
+        r1 = mgmt_root.tm.gtm.rules.rule.load(
+            name='rule1', partition='Common')
+        r2 = mgmt_root.tm.gtm.rules.rule.load(
+            name='rule1', partition='Common')
+        assert 'check syntax' not in r1.apiAnonymous
+        assert 'check syntax' not in r2.apiAnonymous
+
+        r2.update(apiAnonymous='check syntax\n' + RULE)
+        assert 'check syntax' in r2.apiAnonymous
+        assert 'check syntax' not in r1.apiAnonymous
+
+        r1.refresh()
+        assert 'check syntax' in r1.apiAnonymous
+
+
+class TestLoad(object):
+    def test_load_no_object(self, mgmt_root):
+        with pytest.raises(HTTPError) as err:
+            mgmt_root.tm.gtm.rules.rule.load(
+                name='rule1', partition='Common')
+            assert err.response.status_code == 404
+
+    def test_load(self, request, mgmt_root):
+        setup_basic_test(request, mgmt_root, 'rule1', 'Common')
+        rule1 = mgmt_root.tm.gtm.rules.rule.load(
+            name='rule1', partition='Common')
+        assert 'check syntax' not in rule1.apiAnonymous
+        rule1.update(apiAnonymous='check syntax\n' + RULE)
+        rule2 = mgmt_root.tm.gtm.rules.rule.load(
+            name='rule1', partition='Common')
+        assert 'check syntax' in rule1.apiAnonymous
+        assert 'check syntax' in rule2.apiAnonymous
+
+
+class TestUpdate(object):
+    def test_update(self, request, mgmt_root):
+        rule1 = setup_basic_test(request, mgmt_root, 'rule1', 'Common')
+        rule1.update(apiAnonymous='check syntax\n' + RULE)
+        assert 'check syntax' in rule1.apiAnonymous
+
+    def test_update_samevalue(self, request, mgmt_root):
+        rule1 = setup_basic_test(request, mgmt_root, 'rule1', 'Common')
+        rule1.update(apiAnonymous='check none\n' + RULE)
+        assert 'check syntax' not in rule1.apiAnonymous
+
+
+class TestDelete(object):
+    def test_delete(self, request, mgmt_root):
+        r1 = setup_basic_test(request, mgmt_root, 'rule1', 'Common')
+        r1.delete()
+        with pytest.raises(HTTPError) as err:
+            mgmt_root.tm.gtm.rules.rule.load(
+                name='rule1', partition='Common')
+            assert err.response.status_code == 404
+
+
+class TestRuleCollection(object):
+    def test_rule_collection(self, request, mgmt_root):
+        setup_create_test(request, mgmt_root, 'rule1', 'Common')
+        rule1 = mgmt_root.tm.gtm.rules.rule
+        rule1.create(name='rule1', partition='Common', apiAnonymous=RULE)
+        assert rule1.name == 'rule1'
+        assert rule1.partition == 'Common'
+        assert rule1.generation and isinstance(rule1.generation, int)
+        assert 'LB_SELECTED' in rule1.apiAnonymous
+        assert rule1.fullPath == '/Common/rule1'
+        assert rule1.kind == 'tm:gtm:rule:rulestate'
+        assert rule1.selfLink.startswith(
+            'https://localhost/mgmt/tm/gtm/rule/~Common~rule1')
+
+        rc = mgmt_root.tm.gtm.rules.get_collection()
+        assert isinstance(rc, list)
+        assert len(rc)
+        assert isinstance(rc[0], Rule)