Merge pull request #612 from pjbreaux/feature.modify_609

Feature.modify 609

Author: zancas

f5/bigip/resource.py

@@ -166,6 +166,11 @@ class BooleansToReduceHaveSameValue(F5SDKError):
     pass
 
 
+class AttemptedMutationOfReadOnly(F5SDKError):
+    """Read only parameters cannot be set."""
+    pass
+
+
 class PathElement(LazyAttributeMixin):
     """Base class to represent a URI path element that does not contain data.
 
@@ -433,12 +438,54 @@ def __init__(self, container):
         """
         super(ResourceBase, self).__init__(container)
 
-    def _update(self, **kwargs):
-        """wrapped with update, override that in a subclass to customize"""
+    def _modify(self, **patch):
+        """Wrapped with modify, override in a subclass to customize."""
+
+        requests_params, patch_uri, session, read_only = \
+            self._prepare_put_or_patch(patch)
+        self._check_for_boolean_pair_reduction(patch)
+
+        read_only_mutations = []
+        for attr in read_only:
+            if attr in patch:
+                read_only_mutations.append(attr)
+        if read_only_mutations:
+            msg = 'Attempted to mutate read-only attribute(s): %s' \
+                % read_only_mutations
+            raise AttemptedMutationOfReadOnly(msg)
+
+        response = session.patch(patch_uri, json=patch, **requests_params)
+        self._local_update(response.json())
+
+    def modify(self, **patch):
+        """Modify the configuration of the resource on device based on patch
+
+        """
+
+        self._modify(**patch)
+
+    def _check_for_boolean_pair_reduction(self, kwargs):
+        """Check if boolean pairs should be reduced in this resource."""
+
+        if 'reduction_forcing_pairs' in self._meta_data:
+            for key1, key2 in self._meta_data['reduction_forcing_pairs']:
+                kwargs = self._reduce_boolean_pair(kwargs, key1, key2)
+        return kwargs
+
+    def _prepare_put_or_patch(self, kwargs):
+        """Retrieve the appropriate request items for put or patch calls."""
+
         requests_params = self._handle_requests_params(kwargs)
         update_uri = self._meta_data['uri']
         session = self._meta_data['bigip']._meta_data['icr_session']
         read_only = self._meta_data.get('read_only_attributes', [])
+        return requests_params, update_uri, session, read_only
+
+    def _update(self, **kwargs):
+        """wrapped with update, override that in a subclass to customize"""
+
+        requests_params, update_uri, session, read_only = \
+            self._prepare_put_or_patch(kwargs)
 
         # Get the current state of the object on BIG-IP® and check the
         # generation Use pop here because we don't want force in the data_dict
@@ -447,10 +494,7 @@ def _update(self, **kwargs):
             # generation has a known server-side error
             self._check_generation()
 
-        # Reduce any boolean pairs as specified by the meta_data entry below
-        if 'reduction_forcing_pairs' in self._meta_data:
-            for key1, key2 in self._meta_data['reduction_forcing_pairs']:
-                kwargs = self._reduce_boolean_pair(kwargs, key1, key2)
+        kwargs = self._check_for_boolean_pair_reduction(kwargs)
 
         # Save the meta data so we can add it back into self after we
         # load the new object.

f5/bigip/test/test_resource.py

@@ -16,6 +16,7 @@
 import pytest
 import requests
 
+from f5.bigip.resource import AttemptedMutationOfReadOnly
 from f5.bigip.resource import BooleansToReduceHaveSameValue
 from f5.bigip.resource import Collection
 from f5.bigip.resource import DeviceProvidesIncompatibleKey
@@ -35,6 +36,7 @@
 from f5.bigip.resource import UnnamedResource
 from f5.bigip.resource import UnregisteredKind
 from f5.bigip.resource import URICreationCollision
+from f5.bigip.tm.cm.sync_status import Sync_Status
 from f5.bigip.tm.ltm.virtual import Virtual
 from f5.sdk_exception import UnsupportedMethod
 
@@ -57,7 +59,8 @@ def fake_rsrc():
     r._meta_data['uri'] = 'URI'
     r._meta_data['read_only_attributes'] = [u"READONLY"]
     attrs = {'put.return_value': MockResponse({u"generation": 0}),
-             'get.return_value': MockResponse({u"generation": 0})}
+             'get.return_value': MockResponse({u"generation": 0}),
+             'patch.return_value': MockResponse({u"generation": 0})}
     mock_session = mock.MagicMock(**attrs)
     r._meta_data['bigip']._meta_data = {'icr_session': mock_session}
     return r
@@ -217,16 +220,18 @@ def test__create_with_Collision():
 
 
 class TestResource_update(object):
-    def itest__check_generation_with_mismatch(self):
+    def test__check_generation_with_mismatch(self):
         # generation is borked server-side
         r = Resource(mock.MagicMock())
         r._meta_data['allowed_lazy_attributes'] = []
         r._meta_data['uri'] = 'URI'
         r._meta_data['bigip']._meta_data['icr_session'].get.return_value =\
             MockResponse({u"generation": 0})
+        r._meta_data['bigip']._meta_data['icr_session'].put.return_value =\
+            MockResponse({u"generation": 0})
         r.generation = 1
         with pytest.raises(GenerationMismatch) as GMEIO:
-            r.update(a=u"b")
+            r.update(a=u"b", force=False)
         assert GMEIO.value.message ==\
             'The generation of the object on the BigIP (0)'\
             ' does not match the current object(1)'
@@ -243,6 +248,7 @@ def test__meta_data_state(self):
         pre_meta = r._meta_data.copy()
         r.update(a=u"b")
         assert pre_meta == r._meta_data
+        assert r.raw == r.__dict__
 
     def test_Collection_removal(self):
         r = Resource(mock.MagicMock())
@@ -280,22 +286,22 @@ def test_read_only_removal(self):
 
     def test_reduce_boolean_removes_enabled(self, fake_rsrc):
         fake_rsrc.update(enabled=False)
-        pos, kwargs = fake_rsrc._meta_data['bigip']._meta_data['icr_session'].put.\
-            call_args
+        pos, kwargs = fake_rsrc._meta_data['bigip'].\
+            _meta_data['icr_session'].put.call_args
         assert kwargs['json']['disabled'] is True
         assert 'enabled' not in kwargs['json']
 
     def test_reduce_boolean_removes_disabled(self, fake_rsrc):
         fake_rsrc.update(disabled=False)
-        pos, kwargs = fake_rsrc._meta_data['bigip']._meta_data['icr_session'].put.\
-            call_args
+        pos, kwargs = fake_rsrc._meta_data['bigip'].\
+            _meta_data['icr_session'].put.call_args
         assert kwargs['json']['enabled'] is True
         assert 'disabled' not in kwargs['json']
 
     def test_reduce_boolean_removes_nothing(self, fake_rsrc):
         fake_rsrc.update(partition='Common', name='test_create', enabled=True)
-        pos, kwargs = fake_rsrc._meta_data['bigip']._meta_data['icr_session'].put.\
-            call_args
+        pos, kwargs = fake_rsrc._meta_data['bigip'].\
+            _meta_data['icr_session'].put.call_args
         assert kwargs['json']['enabled'] is True
         assert 'disabled' not in kwargs['json']
 
@@ -313,6 +319,87 @@ def test_reduce_boolean_same_value(self, fake_rsrc):
         assert msg == ex.value.message
 
 
+class TestResource_modify(object):
+
+    def test__meta_data_state(self):
+        r = Resource(mock.MagicMock())
+        r._meta_data['allowed_lazy_attributes'] = []
+        r._meta_data['uri'] = 'URI'
+        r._meta_data['bigip']._meta_data['icr_session'].get.return_value =\
+            MockResponse({u"generation": 0})
+        r._meta_data['bigip']._meta_data['icr_session'].patch.return_value =\
+            MockResponse({u"generation": 0})
+        r.generation = 0
+        pre_meta = r._meta_data.copy()
+        r.modify(a=u"b")
+        assert pre_meta == r._meta_data
+
+    def test_Collection_removal(self):
+        r = Resource(mock.MagicMock())
+        r._meta_data['allowed_lazy_attributes'] = []
+        r._meta_data['uri'] = 'URI'
+        attrs = {'patch.return_value': MockResponse({u"generation": 0}),
+                 'get.return_value': MockResponse({u"generation": 0})}
+        mock_session = mock.MagicMock(**attrs)
+        r._meta_data['bigip']._meta_data = {'icr_session': mock_session}
+        r.generation = 0
+        r.contained = Collection(mock.MagicMock())
+        assert 'contained' in r.__dict__
+        r.modify(a=u"b")
+        submitted = r._meta_data['bigip']. \
+            _meta_data['icr_session'].patch.call_args[1]['json']
+
+        assert 'contained' not in submitted
+
+    def test_read_only_validate(self):
+        r = Resource(mock.MagicMock())
+        r._meta_data['allowed_lazy_attributes'] = []
+        r._meta_data['uri'] = 'URI'
+        r._meta_data['read_only_attributes'] = [u"READONLY"]
+        attrs = {'patch.return_value': MockResponse({u"generation": 0}),
+                 'get.return_value': MockResponse({u"generation": 0})}
+        mock_session = mock.MagicMock(**attrs)
+        r._meta_data['bigip']._meta_data = {'icr_session': mock_session}
+        r.generation = 0
+        with pytest.raises(AttemptedMutationOfReadOnly) as AMOROEIO:
+            r.modify(READONLY=True)
+        assert "READONLY" in AMOROEIO.value.message
+
+    def test_reduce_boolean_removes_enabled(self, fake_rsrc):
+        fake_rsrc.modify(enabled=False)
+        pos, kwargs = fake_rsrc._meta_data['bigip'].\
+            _meta_data['icr_session'].patch.call_args
+        assert kwargs['json']['disabled'] is True
+        assert 'enabled' not in kwargs['json']
+
+    def test_reduce_boolean_removes_disabled(self, fake_rsrc):
+        fake_rsrc.modify(disabled=False)
+        pos, kwargs = fake_rsrc._meta_data['bigip'].\
+            _meta_data['icr_session'].patch.call_args
+        assert kwargs['json']['enabled'] is True
+        assert 'disabled' not in kwargs['json']
+
+    def test_reduce_boolean_removes_nothing(self, fake_rsrc):
+        fake_rsrc.modify(partition='Common', name='test_create', enabled=True)
+        pos, kwargs = fake_rsrc._meta_data['bigip'].\
+            _meta_data['icr_session'].patch.call_args
+        assert kwargs['json']['enabled'] is True
+        assert 'disabled' not in kwargs['json']
+
+    def test_reduce_boolean_same_value(self, fake_rsrc):
+        with pytest.raises(BooleansToReduceHaveSameValue) as ex:
+            fake_rsrc.modify(
+                partition='Common',
+                name='test_create',
+                enabled=True,
+                disabled=True
+            )
+        msg = 'Boolean pair, enabled and disabled, have same value: True. ' \
+            'If both are given to this method, they cannot be the same, as ' \
+            'this method cannot decide which one should be True.'
+        assert msg == ex.value.message
+
+
 class TestResource_delete(object):
     def test_success(self):
         r = Resource(mock.MagicMock())
@@ -455,6 +542,34 @@ def test_success(self):
         x = r.load(partition='Common', name='test_load')
         assert x.selfLink == mockuri
 
+    def test_URICreationCollision(self):
+        r = Virtual(mock.MagicMock())
+        r._meta_data['allowed_lazy_attributes'] = []
+        mockuri = "https://localhost:443/mgmt/tm/ltm/virtual/~Common~test_load"
+        attrs = {'get.return_value':
+                 MockResponse(
+                     {
+                         u"generation": 0,
+                         u"selfLink": mockuri,
+                         u"kind": u"tm:ltm:virtual:virtualstate"
+                     }
+                 )}
+        mock_session = mock.MagicMock(**attrs)
+        r._meta_data['bigip']._meta_data =\
+            {'icr_session': mock_session,
+             'hostname': 'TESTDOMAINNAME',
+             'uri': 'https://TESTDOMAIN:443/mgmt/tm/'}
+        r.generation = 0
+        x = r.load(partition='Common', name='test_load')
+        assert x.selfLink == mockuri
+        with pytest.raises(URICreationCollision) as UCCEIO:
+            x.load(uri='URI')
+        assert UCCEIO.value.message ==\
+            "There was an attempt to assign a new uri to this resource, the"\
+            " _meta_data['uri'] is "\
+            "https://TESTDOMAIN:443/mgmt/tm/ltm/virtual/"\
+            "~Common~test_load/ and it should not be changed."
+
 
 class TestResource_exists(object):
     def test_loadable(self):
@@ -621,4 +736,25 @@ def test_create_raises(self):
     def test_delete_raises(self):
         unnamed_resource = UnnamedResource(mock.MagicMock())
         with pytest.raises(UnsupportedMethod):
-            unnamed_resource.create()
+            unnamed_resource.delete()
+
+    def test_load(self):
+        r = Sync_Status(mock.MagicMock())
+        r._meta_data['allowed_lazy_attributes'] = []
+        mockuri = "https://localhost:443/mgmt/tm/cm/sync-status"
+        attrs = {'get.return_value':
+                 MockResponse(
+                     {
+                         u"generation": 0,
+                         u"selfLink": mockuri,
+                         u"kind": u"tm:cm:sync-status:sync-statusstats"
+                     }
+                 )}
+        mock_session = mock.MagicMock(**attrs)
+        r._meta_data['bigip']._meta_data =\
+            {'icr_session': mock_session,
+             'hostname': 'TESTDOMAINNAME',
+             'uri': 'https://TESTDOMAIN:443/mgmt/tm/'}
+        r.generation = 0
+        x = r.load(partition='Common', name='test_load')
+        assert x.selfLink == 'https://localhost:443/mgmt/tm/cm/sync-status'

test/functional/auth/test_password_policy.py

@@ -15,6 +15,8 @@
 
 from pprint import pprint as pp
 
+import copy
+
 
 class TestPasswordPolicy(object):
     def test_load(self, bigip):
@@ -31,3 +33,16 @@ def test_update(self, bigip):
         assert password_policy.maxLoginFailures == 10
         password_policy.update(maxLoginFailures=0)
         assert password_policy.maxLoginFailures == 0
+
+    def test_modify(self, mgmt_root):
+        password_policy = mgmt_root.tm.auth.password_policy.load()
+        original_dict = copy.copy(password_policy.__dict__)
+        max_fails = 'maxLoginFailures'
+        password_policy.modify(maxLoginFailures=25)
+        for k, v in original_dict.items():
+            if k != max_fails:
+                original_dict[k] = password_policy.__dict__[k]
+            elif k == max_fails:
+                password_policy.__dict__[k] == 'Cool mod test'
+        password_policy.modify(maxLoginFailures=0)
+        assert password_policy.maxLoginFailures == 0

test/functional/tm/ltm/test_virtual.py

@@ -18,6 +18,7 @@
 from f5.bigip.resource import MissingRequiredCreationParameter
 from f5.bigip.resource import MissingRequiredReadParameter
 
+import copy
 from pprint import pprint as pp
 import pytest
 
@@ -63,6 +64,19 @@ def test_virtual_create_refresh_update_delete_load(
         virtual2 = vc1.virtual.load(partition='Common', name='vstest1')
         assert virtual2.selfLink == virtual1.selfLink
 
+    def test_virtual_modify(self, request, mgmt_root, setup_device_snapshot):
+        virtual1, vc1 = setup_virtual_test(
+            request, mgmt_root, 'Common', 'modtest1'
+        )
+        original_dict = copy.copy(virtual1.__dict__)
+        desc = 'description'
+        virtual1.modify(description='Cool mod test')
+        for k, v in original_dict.items():
+            if k != desc:
+                original_dict[k] = virtual1.__dict__[k]
+            elif k == desc:
+                virtual1.__dict__[k] == 'Cool mod test'
+
 
 def test_profiles_CE(
         mgmt_root, opt_release, setup_device_snapshot