Merge pull request #558 from pjbreaux/bugfix.endisable

Fix nat test for test_create_disabled_false

Author: zancas

f5/bigip/resource.py

@@ -161,6 +161,11 @@ class UnsupportedOperation(F5SDKError):
     pass
 
 
+class BooleansToReduceHaveSameValue(F5SDKError):
+    '''Dict contains two keys with same boolean value.'''
+    pass
+
+
 class PathElement(LazyAttributeMixin):
     """Base class to represent a URI path element that does not contain data.
 
@@ -442,6 +447,11 @@ 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)
+
         # Save the meta data so we can add it back into self after we
         # load the new object.
         temp_meta = self.__dict__.pop('_meta_data')
@@ -463,6 +473,7 @@ def _update(self, **kwargs):
             data_dict.pop(attr, '')
 
         data_dict.update(kwargs)
+
         response = session.put(update_uri, json=data_dict, **requests_params)
         self._meta_data = temp_meta
         self._local_update(response.json())
@@ -694,6 +705,12 @@ def __init__(self, container):
         self._meta_data['required_load_parameters'] = set(('name',))
         # You can't set these attributes, only 'read' them.
         self._meta_data['read_only_attributes'] = []
+        self._meta_data['reduction_forcing_pairs'] = \
+            [
+                ('enabled', 'disabled'),
+                ('online', 'offline'),
+                ('vlansEnabled', 'vlansDisabled')
+            ]
 
     def _activate_URI(self, selfLinkuri):
         """Call this with a selfLink, after it's returned in _create or _load.
@@ -745,6 +762,30 @@ def _activate_URI(self, selfLinkuri):
                                 'creation_uri_frag': frag,
                                 'allowed_lazy_attributes': attrs})
 
+    def _reduce_boolean_pair(self, config_dict, key1, key2):
+        '''Ensure only one key with a boolean value is present in dict.
+
+        :param config_dict: dict -- dictionary of config or kwargs
+        :param key1: string -- first key name
+        :param key2: string -- second key name
+        :raises: BooleansToReduceHaveSameValue
+        '''
+
+        if key1 in config_dict and key2 in config_dict \
+                and config_dict[key1] == config_dict[key2]:
+            msg = 'Boolean pair, %s and %s, have same value: %s. If both ' \
+                'are given to this method, they cannot be the same, as this ' \
+                'method cannot decide which one should be True.' \
+                % (key1, key2, config_dict[key1])
+            raise BooleansToReduceHaveSameValue(msg)
+        elif key1 in config_dict and not config_dict[key1]:
+            config_dict[key2] = True
+            config_dict.pop(key1)
+        elif key2 in config_dict and not config_dict[key2]:
+            config_dict[key1] = True
+            config_dict.pop(key2)
+        return config_dict
+
     def _create(self, **kwargs):
         """wrapped by `create` override that in subclasses to customize"""
         if 'uri' in self._meta_data:
@@ -756,6 +797,10 @@ def _create(self, **kwargs):
         requests_params = self._handle_requests_params(kwargs)
         self._check_create_parameters(**kwargs)
 
+        # Reduce boolean pairs as specified by the meta_data entry below
+        for key1, key2 in self._meta_data['reduction_forcing_pairs']:
+            kwargs = self._reduce_boolean_pair(kwargs, key1, key2)
+
         # Make convenience variable with short names for this method.
         _create_uri = self._meta_data['container']._meta_data['uri']
         session = self._meta_data['bigip']._meta_data['icr_session']
@@ -809,6 +854,8 @@ def _load(self, **kwargs):
         refresh_session = self._meta_data['bigip']._meta_data['icr_session']
         base_uri = self._meta_data['container']._meta_data['uri']
         kwargs.update(requests_params)
+        for key1, key2 in self._meta_data['reduction_forcing_pairs']:
+            kwargs = self._reduce_boolean_pair(kwargs, key1, key2)
         response = refresh_session.get(base_uri, **kwargs)
         # Make new instance of self
         return self._produce_instance(response)

f5/bigip/test/test_resource.py

@@ -16,6 +16,7 @@
 import pytest
 import requests
 
+from f5.bigip.resource import BooleansToReduceHaveSameValue
 from f5.bigip.resource import Collection
 from f5.bigip.resource import DeviceProvidesIncompatibleKey
 from f5.bigip.resource import ExclusiveAttributesPresent
@@ -38,6 +39,30 @@
 from f5.sdk_exception import UnsupportedMethod
 
 
+@pytest.fixture
+def fake_vs():
+    r = Virtual(mock.MagicMock())
+    MRO = MockResponse({u"kind": u"tm:ltm:virtual:virtualstate",
+                        u"selfLink": u".../~Common~test_create"})
+    r._meta_data['bigip']._meta_data['icr_session'].post.return_value = MRO
+    r._meta_data['required_json_kind'] = u"tm:ltm:virtual:virtualstate"
+    r._meta_data['allowed_lazy_attributes'] = []
+    return r
+
+
+@pytest.fixture
+def fake_rsrc():
+    r = Resource(mock.MagicMock())
+    r._meta_data['allowed_lazy_attributes'] = []
+    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})}
+    mock_session = mock.MagicMock(**attrs)
+    r._meta_data['bigip']._meta_data = {'icr_session': mock_session}
+    return r
+
+
 class MockResponse(object):
     def __init__(self, attr_dict):
         self.__dict__ = attr_dict
@@ -115,17 +140,51 @@ def test_KindTypeMismatch(self):
             "be ''tm:ltm:virtual:virtualstate'' but creation returned "\
             "JSON with kind: u'tm:'"
 
-    def test_success(self):
-        r = Virtual(mock.MagicMock())
-        MRO = MockResponse({u"kind": u"tm:ltm:virtual:virtualstate",
-                            u"selfLink": u".../~Common~test_create"})
-        r._meta_data['bigip']._meta_data['icr_session'].post.return_value = MRO
-        r._meta_data['required_json_kind'] = u"tm:ltm:virtual:virtualstate"
-        r._meta_data['allowed_lazy_attributes'] = []
-        x = r.create(partition="Common", name="test_create")
+    def test_success(self, fake_vs):
+        x = fake_vs.create(partition="Common", name="test_create")
         assert x.kind == u"tm:ltm:virtual:virtualstate"
         assert x.selfLink == u".../~Common~test_create"
 
+    def test_reduce_boolean_removes_enabled(self, fake_vs):
+        assert fake_vs._meta_data['reduction_forcing_pairs'] == \
+            [
+                ('enabled', 'disabled'),
+                ('online', 'offline'),
+                ('vlansEnabled', 'vlansDisabled')
+            ]
+        fake_vs.create(partition="Common", name="test_create", enabled=False)
+        pos, kwargs = fake_vs._meta_data['bigip']._meta_data['icr_session'].post.\
+            call_args
+        assert kwargs['json']['disabled'] is True
+        assert 'enabled' not in kwargs['json']
+
+    def test_reduce_boolean_removes_disabled(self, fake_vs):
+        fake_vs.create(partition='Common', name='test_create', disabled=False)
+        pos, kwargs = fake_vs._meta_data['bigip']._meta_data['icr_session'].post.\
+            call_args
+        assert kwargs['json']['enabled'] is True
+        assert 'disabled' not in kwargs['json']
+
+    def test_reduce_boolean_removes_nothing(self, fake_vs):
+        fake_vs.create(partition='Common', name='test_create', enabled=True)
+        pos, kwargs = fake_vs._meta_data['bigip']._meta_data['icr_session'].post.\
+            call_args
+        assert kwargs['json']['enabled'] is True
+        assert 'disabled' not in kwargs['json']
+
+    def test_reduce_boolean_same_value(self, fake_vs):
+        with pytest.raises(BooleansToReduceHaveSameValue) as ex:
+            fake_vs.create(
+                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
+
 
 def test__activate_URI():
     r = Resource(mock.MagicMock())
@@ -219,6 +278,40 @@ def test_read_only_removal(self):
             _meta_data['icr_session'].put.call_args[1]['json']
         assert 'READONLY' not in submitted
 
+    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
+        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
+        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
+        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.update(
+                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):

f5/bigip/tm/gtm/datacenter.py

@@ -49,13 +49,6 @@ def __init__(self, dc_s):
             'tm:gtm:datacenter:datacenterstate'
         self._meta_data['exclusive_attributes'].append(('enabled', 'disabled'))
 
-    def _endis_able(self, config_dict):
-        if 'enabled' in config_dict and not config_dict['enabled']:
-            config_dict['disabled'] = True
-        elif 'disabled' in config_dict and not config_dict['disabled']:
-            config_dict['enabled'] = True
-        return config_dict
-
     def _endis_attrs(self):
         """Manipulate return value to equal negation of set value
 
@@ -121,25 +114,18 @@ def _endis_attrs(self):
         return None
 
     def create(self, **kwargs):
-        kwargs = self._endis_able(kwargs)
-
-        if 'enabled' in kwargs and kwargs['enabled']:
-            del kwargs['disabled']
-        if 'disabled' in kwargs and kwargs['disabled']:
-            del kwargs['enabled']
-
         inst = self._create(**kwargs)
         inst._endis_attrs()
         return inst
 
     def load(self, **kwargs):
-        kwargs = self._endis_able(kwargs)
+        kwargs = self._reduce_boolean_pair(kwargs, 'enabled', 'disabled')
         inst = self._load(**kwargs)
         inst._endis_attrs()
         return inst
 
     def refresh(self, **kwargs):
-        kwargs = self._endis_able(kwargs)
+        kwargs = self._reduce_boolean_pair(kwargs, 'enabled', 'disabled')
         self._refresh(**kwargs)
         self._endis_attrs()
         return self
@@ -149,6 +135,5 @@ def update(self, **kwargs):
             kwargs['enabled'] = self.__dict__.pop('enabled')
         elif 'disabled' in self.__dict__ and 'disabled' not in kwargs:
             kwargs['disabled'] = self.__dict__.pop('disabled')
-        kwargs = self._endis_able(kwargs)
         self._update(**kwargs)
         self._endis_attrs()

f5/bigip/tm/ltm/nat.py

@@ -89,24 +89,15 @@ def create(self, **kwargs):
                         % kwargs['trafficGroup'])
             except KeyError:
                 pass
-        kwargs = self._endis_able(kwargs)
         new_instance = self._create(**kwargs)
         return new_instance
 
-    def _endis_able(self, config_dict):
-        if 'enabled' in config_dict and not config_dict['enabled']:
-            config_dict['disabled'] = True
-        elif 'disabled' in config_dict and not config_dict['disabled']:
-            config_dict['enabled'] = True
-        return config_dict
-
     def update(self, **kwargs):
         # This is an example implementation of read-only params
         stash_translation_address = self.__dict__.pop('translationAddress')
         if 'enabled' in self.__dict__ and 'enabled' not in kwargs:
             kwargs['enabled'] = self.__dict__.pop('enabled')
         elif 'disabled' in self.__dict__ and 'disabled' not in kwargs:
             kwargs['disabled'] = self.__dict__.pop('disabled')
-        kwargs = self._endis_able(kwargs)
         self._update(**kwargs)
         self.__dict__['translationAddress'] = stash_translation_address