Merge pull request #426 from caphrim007/add-software-update-api

Add the software update API endpoint

Author: zancas

f5/bigip/tm/sys/__init__.py

@@ -39,6 +39,7 @@
 from f5.bigip.tm.sys.httpd import Httpd
 from f5.bigip.tm.sys.ntp import Ntp
 from f5.bigip.tm.sys.performance import Performances
+from f5.bigip.tm.sys.software import Software
 from f5.bigip.tm.sys.sshd import Sshd
 
 
@@ -57,5 +58,6 @@ def __init__(self, tm):
             Failover,
             Dns,
             Sshd,
-            Httpd
+            Httpd,
+            Software
         ]

f5/bigip/tm/sys/software/__init__.py

@@ -0,0 +1,44 @@
+# coding=utf-8
+#
+# 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.
+#
+
+"""BIG-IP® System Software module
+
+REST URI
+    ``http://localhost/mgmt/tm/sys/software``
+
+GUI Path
+    ``System``
+
+REST Kind
+    ``tm:sys:software:*``
+"""
+
+from f5.bigip.resource import OrganizingCollection
+from f5.bigip.tm.sys.software.update import Update
+
+
+class Software(OrganizingCollection):
+    def __init__(self, tm):
+        super(Software, self).__init__(tm)
+        self._meta_data['allowed_lazy_attributes'] = [
+            Update
+        ]
+
+    def __getattribute__(self, name):
+        if name == 'update':
+            return Update(self)
+        return super(Software, self).__getattribute__(name)

f5/bigip/tm/sys/software/test/__init__.py

@@ -0,0 +1,39 @@
+# Copyright 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.
+#
+
+import mock
+import pytest
+
+
+from f5.bigip.mixins import UnsupportedMethod
+from f5.bigip.tm.sys.software.update import Update
+
+
+@pytest.fixture
+def FakeUpdate():
+    fake_sys = mock.MagicMock()
+    return Update(fake_sys)
+
+
+def test_create_raises(FakeUpdate):
+    with pytest.raises(UnsupportedMethod) as EIO:
+        FakeUpdate.create()
+    assert EIO.value.message == "Update does not support the create method"
+
+
+def test_delete_raises(FakeUpdate):
+    with pytest.raises(UnsupportedMethod) as EIO:
+        FakeUpdate.delete()
+    assert EIO.value.message == "Update does not support the delete method"

f5/bigip/tm/sys/software/test/test_update.py

@@ -0,0 +1,46 @@
+# coding=utf-8
+#
+# Copyright 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® system software update module
+
+REST URI
+    ``http://localhost/mgmt/tm/sys/software/update``
+
+GUI Path
+    ``System --> Software Management --> Update Check``
+
+REST Kind
+    ``tm:sys:software:update:updatestate``
+"""
+
+from f5.bigip.mixins import UnnamedResourceMixin
+from f5.bigip.resource import ResourceBase
+
+
+class Update(UnnamedResourceMixin, ResourceBase):
+    """BIG-IP® system software update unnamed resource
+
+        .. note::
+
+        This is an unnamed resource so it has not ~Partition~Name pattern
+        at the end of its URI.
+    """
+    def __init__(self, sys):
+        super(Update, self).__init__(sys)
+        self._meta_data['required_load_parameters'] = set()
+        self._meta_data['required_json_kind'] = \
+            'tm:sys:software:update:updatestate'

f5/bigip/tm/sys/software/update.py

@@ -19,9 +19,10 @@
 
 from f5.utils.util_exceptions import UtilError
 
+
 class MaximumAttemptsReached(UtilError):
-    def __init__(*args, **kwargs):
-        # TODO:   Add logging here!
+    def __init__(self, *args, **kwargs):
+        # TODO(Add logging here!)
         super(MaximumAttemptsReached, self).__init__(*args, **kwargs)
 
 

f5/utils/decorators.py

@@ -15,7 +15,8 @@
 
 from f5.sdk_exception import F5SDKError
 
+
 class UtilError(F5SDKError):
     '''A base exception for all utility exceptions in this library.'''
-    def __init__(self, *arg, **kwargs):
+    def __init__(self, *args, **kwargs):
         super(UtilError, self).__init__(*args, **kwargs)

f5/utils/util_exceptions.py

@@ -0,0 +1,48 @@
+# Copyright 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.
+#
+
+import pytest
+
+
+@pytest.fixture
+def cleaner(request, bigip):
+    initial = bigip.sys.software.update.load()
+
+    def teardown():
+        initial.update()
+    request.addfinalizer(teardown)
+
+
+class TestUpdate(object):
+    def test_load(self, cleaner, bigip):
+        su = bigip.sys.software.update.load()
+        assert su.autoCheck == 'enabled'
+        su.refresh()
+        assert su.autoCheck == 'enabled'
+
+    def test_update_autocheck(self, cleaner, bigip):
+        su = bigip.sys.software.update.load()
+        su.update(autoCheck='disabled')
+        assert su.autoCheck == 'disabled'
+        su.update(autoCheck='enabled')
+        assert su.autoCheck == 'enabled'
+
+    def test_update_frequency(self, cleaner, bigip):
+        frequencies = ['daily', 'monthly', 'weekly']
+        su = bigip.sys.software.update.load()
+
+        for frequency in frequencies:
+            su.update(frequency=frequency)
+            assert su.frequency == frequency