Issues:

Fixes #378, #452, #474, #481, #484, #485

Problem:
Given the latest additions and changes to the core classes some of the sub-modules coding needed change, also during the process few issues were discovered with create method allowing mutually exclusive attributes to be sent to the BIGIP. Also a decision was made to create a helper class to handle required attributes within different parts of code.

Analysis:

Removed the hardcoded payload in failover.py. Kept the legacy method in failover.py for backwards compatibility. Added 2 new helper methods inside PathElement:,

 - _check_exclusive_parameters to handle those exclusive attributes during create/exec_cmd.
 - _check_required_parameters - a static method to handle checking for required paremeters

Modified CommandExecutionMixin _exec_cmd method to utilize the 2 new helpers from PathElement, modified Resource _create method to do the same. Modified _check_load_parameters method inside PathElement to call _check_required_parameters. In addition to the above I have moved self._meta_data['exclusive_attributes'] declaration into ResourceBase. Added new dictionary entry for: self._meta_data['required_command_parameters'] into PathElement to accomodate splitting this from required_creation_parameters as per discussion with @za. The self._meta_data['required_command_parameters'] is empty by default, this is to allow utilizing classes where 'name' attribute is not present or required, also to allow utilizing commands by the means of  utilCmdArgs= argument.

e.g.

    exec_cmd('foocommand', utilCmdArgs='foo bar')

Files modified:

f5\bigip\resource.py
f5\bigip\mixins.py
f5\bigip\tm\cm\device_group.py
f5\bigip\tm\cm\sync_status.py
f5\bigip\tm\cm\traffic_group.py
f5\bigip\tm\cm\trust.py
f5\bigip\tm\cm\trust_domain.py
f5\bigip\tm\ltm\profile.py
f5\bigip\tm\sys\failover.py
f5-common-python\test\functional\cm\test_sync_status.py
f5-common-python\test\functional\tm\sys\test_failover.py

New files added:

f5\bigip\tm\sys\test\test_failover.py
f5\bigip\tm\ltm\test\test_profile_ocsp.py

Author: wojtek0806

f5/bigip/mixins.py

@@ -39,6 +39,11 @@ class UnsupportedTmosVersion(F5SDKError):
     pass
 
 
+class MissingRequiredCommandParameter(F5SDKError):
+    """Various values MUST be provided to execute a command."""
+    pass
+
+
 class LazyAttributesRequired(F5SDKError):
     """Raised when a object accesses a lazy attribute that is not listed"""
     pass
@@ -250,7 +255,13 @@ def _exec_cmd(self, command, **kwargs):
         '''
 
         kwargs['command'] = command
+        self._check_exclusive_parameters(**kwargs)
         requests_params = self._handle_requests_params(kwargs)
+        rset = self._meta_data['required_command_parameters']
+        check = self._check_required_parameters(rset, **kwargs)
+        if check:
+            error_message = 'Missing required params: {}'.format(check[1])
+            raise MissingRequiredCommandParameter(error_message)
         session = self._meta_data['bigip']._meta_data['icr_session']
         response = session.post(
             self._meta_data['uri'], json=kwargs, **requests_params)

f5/bigip/resource.py

@@ -87,11 +87,18 @@
 from requests.exceptions import HTTPError
 
 
+class ExclusiveAttributesPresent(F5SDKError):
+    """Raises this when exclusive attributes are present
+
+    during resource creation
+    """
+    pass
+
+
 class MissingUpdateParameter(F5SDKError):
     """Raises this when update requires specific
 
     parameters together
-
     """
     pass
 
@@ -174,6 +181,12 @@ def __init__(self, container):
         # Supported versions for each class will be defined here.
         # List can be modified downstream in each sub-class
         self._meta_data['supported_versions'] = set(['11.6.0', '12.0.0'])
+        # Commands you can run on a resource or collection, we define it here
+        self._meta_data['allowed_commands'] = []
+        # Define required command parameters
+        self._meta_data['required_command_parameters'] = set()
+        # You can't have more than one of the attributes in any of these sets.
+        self._meta_data['exclusive_attributes'] = []
 
     def _set_meta_data_uri(self):
         base_uri = self.__class__.__name__.lower()
@@ -190,18 +203,15 @@ def _set_meta_data_uri(self):
         self._meta_data['uri'] = final_uri
 
     def _check_load_parameters(self, **kwargs):
-        '''Params given to load should at least satisfy required params.
+        """Params given to load should at least satisfy required params.
 
         :params: kwargs
         :raises: MissingRequiredReadParameter
-        '''
-        key_set = set(kwargs.keys())
-        required_minus_received =\
-            self._meta_data['required_load_parameters'] - key_set
-        if required_minus_received != set():
-            error_message = 'Missing required params: %r'\
-                % required_minus_received
-            raise MissingRequiredReadParameter(error_message)
+        """
+        rset = self._meta_data['required_load_parameters']
+        check = self._check_required_parameters(rset, **kwargs)
+        if check:
+            raise MissingRequiredReadParameter(check[1])
 
     def _local_update(self, rdict):
         """Call this with a response dictionary to update instance attrs.
@@ -295,6 +305,36 @@ def _handle_requests_params(self, kwargs):
             requests_params.update({'params': params})
         return requests_params
 
+    def _check_exclusive_parameters(self, **kwargs):
+        """Check for mutually exclusive attributes in kwargs.
+
+        :raises ExclusiveAttributesPresent
+        """
+        if len(self._meta_data['exclusive_attributes']) > 0:
+            attr_set = set(kwargs.keys())
+            ex_set = set(self._meta_data['exclusive_attributes'][0])
+            common_set = attr_set.intersection(ex_set)
+            if len(common_set) > 1:
+                error = 'Mutually exclusive arguments submitted. ' \
+                        'The following arguments cannot be set ' \
+                        'together: "{}".'.format(', '.join(common_set))
+                raise ExclusiveAttributesPresent(error)
+
+    @staticmethod
+    def _check_required_parameters(rqset, **kwargs):
+        """Helper function to do operation on sets
+
+        ::returns bool and variable
+        """
+        key_set = set(kwargs.keys())
+        required_minus_received = rqset - key_set
+        if required_minus_received != set():
+            error_message = 'Missing required params: {}'\
+                .format(required_minus_received)
+            return True, error_message
+        else:
+            return False
+
     @property
     def raw(self):
         """Display the attributes that the current object has and their values.
@@ -362,8 +402,6 @@ def __init__(self, container):
         :param container: instance is an attribute of a ResourceBase container
         """
         super(ResourceBase, self).__init__(container)
-        # Commands you can run on a resource or collection, we define it here
-        self._meta_data['allowed_commands'] = []
 
     def _update(self, **kwargs):
         """wrapped with update, override that in a subclass to customize"""
@@ -603,8 +641,6 @@ def __init__(self, container):
         self._meta_data['required_creation_parameters'] = set(('name',))
         # Refresh fails without these.
         self._meta_data['required_load_parameters'] = set(('name',))
-        # You can't have more than one of the attrs in any of these sets.
-        self._meta_data['exclusive_attributes'] = []
         # You can't set these attributes, only 'read' them.
         self._meta_data['read_only_attributes'] = []
 
@@ -665,14 +701,15 @@ def _create(self, **kwargs):
                     "resource, the _meta_data['uri'] is %s and it should"\
                     " not be changed." % (self._meta_data['uri'])
             raise URICreationCollision(error)
+        self._check_exclusive_parameters(**kwargs)
         requests_params = self._handle_requests_params(kwargs)
-        key_set = set(kwargs.keys())
-        required_minus_received =\
-            self._meta_data['required_creation_parameters'] - key_set
-        if required_minus_received != set():
-            error_message = 'Missing required params: %r'\
-                % required_minus_received
-            raise MissingRequiredCreationParameter(error_message)
+
+        # Using helper method to check for required keys.
+        # Defining convenience variables to make code readable
+        rset = self._meta_data['required_creation_parameters']
+        check = self._check_required_parameters(rset, **kwargs)
+        if check:
+            raise MissingRequiredCreationParameter(check[1])
 
         # Make convenience variable with short names for this method.
         _create_uri = self._meta_data['container']._meta_data['uri']

f5/bigip/tm/cm/device_group.py

@@ -35,9 +35,6 @@ class Device_Groups(Collection):
     """BIG-IP® cluster device-groups collection."""
     def __init__(self, cm):
         super(Device_Groups, self).__init__(cm)
-        endpoint = 'device-group'
-        self._meta_data['uri'] =\
-            self._meta_data['container']._meta_data['uri'] + endpoint + '/'
         self._meta_data['allowed_lazy_attributes'] = [Device_Group]
         self._meta_data['attribute_registry'] =\
             {'tm:cm:device:device-groupstate': Device_Group}

f5/bigip/tm/cm/sync_status.py

@@ -28,17 +28,14 @@
 """
 
 from f5.bigip.mixins import UnnamedResourceMixin
-from f5.bigip.resource import Resource
+from f5.bigip.resource import ResourceBase
 
 
-class Sync_Status(Resource, UnnamedResourceMixin):
+class Sync_Status(ResourceBase, UnnamedResourceMixin):
     '''A Resource concrete subclass.'''
     def __init__(self, cm):
         '''Autogenerated constructor.'''
         super(Sync_Status, self).__init__(cm)
-        base_uri = type(self).__name__.replace('_', '-').lower()
-        self._meta_data['uri'] =\
-            self._meta_data['container']._meta_data['uri'] + base_uri
         self._meta_data['template_generated'] = True
         self._meta_data['required_json_kind'] =\
             u"tm:cm:sync-status:sync-statusstats"

f5/bigip/tm/cm/traffic_group.py

@@ -35,9 +35,6 @@ class Traffic_Groups(Collection):
     """BIG-IP® cluster traffic-group collection"""
     def __init__(self, cm):
         super(Traffic_Groups, self).__init__(cm)
-        endpoint = 'traffic-group'
-        self._meta_data['uri'] =\
-            self._meta_data['container']._meta_data['uri'] + endpoint + '/'
         self._meta_data['allowed_lazy_attributes'] = [Traffic_Group]
         self._meta_data['attribute_registry'] =\
             {'tm:cm:traffic-group:traffic-groupstate': Traffic_Group}

f5/bigip/tm/cm/trust.py

@@ -18,11 +18,11 @@
 from f5.bigip.mixins import CommandExecutionMixin
 from f5.bigip.mixins import ExclusiveAttributesMixin
 from f5.bigip.mixins import UnnamedResourceMixin
-from f5.bigip.resource import Resource
+from f5.bigip.resource import PathElement
 
 
-class Add_To_Trust(UnnamedResourceMixin, ExclusiveAttributesMixin,
-                   CommandExecutionMixin, Resource):
+class Add_To_Trust(PathElement, UnnamedResourceMixin, ExclusiveAttributesMixin,
+                   CommandExecutionMixin):
     """BIG-IP® Add-To-Trust resource
 
     Use this object to set or overwrite device trust
@@ -33,15 +33,16 @@ def __init__(self, cm):
         super(Add_To_Trust, self).__init__(cm)
         self._meta_data['exclusive_attributes'].append(
             ('caDevice', 'nonCaDevice'))
-        self._meta_data['required_creation_parameters'].update(
-            ('device', 'deviceName', 'username', 'password'))
+        self._meta_data['required_command_parameters'].update(
+            ('name', 'device', 'deviceName', 'username', 'password'))
         self._meta_data['required_json_kind'] = \
             'tm:cm:add-to-trust:runstate'
         self._meta_data['allowed_commands'].append('run')
         self._meta_data['supported_versions'].discard('11.6.0')
 
 
-class Remove_From_Trust(UnnamedResourceMixin, CommandExecutionMixin, Resource):
+class Remove_From_Trust(PathElement, UnnamedResourceMixin,
+                        CommandExecutionMixin):
     """BIG-IP®« Remove-From-Trust resource
 
     Use this object to remove device trust
@@ -55,8 +56,8 @@ class Remove_From_Trust(UnnamedResourceMixin, CommandExecutionMixin, Resource):
 
     def __init__(self, cm):
         super(Remove_From_Trust, self).__init__(cm)
-        self._meta_data['required_creation_parameters'].update(
-            ('deviceName',))
+        self._meta_data['required_command_parameters'].update(
+            ('deviceName', 'name'))
         self._meta_data['required_json_kind'] = \
             'tm:cm:remove-from-trust:runstate'
         self._meta_data['allowed_commands'].append('run')

f5/bigip/tm/cm/trust_domain.py

@@ -36,9 +36,6 @@ class Trust_Domains(Collection):
 
     def __init__(self, cm):
         super(Trust_Domains, self).__init__(cm)
-        endpoint = 'trust-domain'
-        self._meta_data['uri'] =\
-            self._meta_data['container']._meta_data['uri'] + endpoint + '/'
         self._meta_data['allowed_lazy_attributes'] = [Trust_Domain]
         self._meta_data['attribute_registry'] = \
             {'tm:cm:trust-domain:trust-domainstate': Trust_Domain}

f5/bigip/tm/ltm/profile.py

@@ -28,6 +28,7 @@
 
 
 from f5.bigip.resource import Collection
+from f5.bigip.resource import MissingUpdateParameter
 from f5.bigip.resource import OrganizingCollection
 from f5.bigip.resource import Resource
 from f5.bigip.resource import UnsupportedOperation
@@ -632,6 +633,26 @@ def create(self, **kwargs):
 
         return self
 
+    def update(self, **kwargs):
+        """When setting useProxyServer to enable we need to supply
+
+            proxyServerPool value as well
+        """
+        if 'useProxyServer' in kwargs and \
+                kwargs['useProxyServer'] == 'enabled':
+            if 'proxyServerPool' not in kwargs:
+                error = 'Missing proxyServerPool parameter value.'
+                raise MissingUpdateParameter(error)
+        if hasattr(self, 'useProxyServer'):
+            if getattr(self, 'useProxyServer') == 'enabled' and \
+                    not hasattr(self, 'proxyServerPool'):
+                error = 'Missing proxyServerPool parameter value.'
+                raise MissingUpdateParameter(error)
+
+        self._update(**kwargs)
+
+        return self
+
 
 class One_Connects(Collection):
     """BIG-IP® One_Connect profile collection."""

f5/bigip/tm/ltm/test/test_profile_ocsp.py

@@ -0,0 +1,37 @@
+# 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.resource import MissingUpdateParameter
+from f5.bigip.tm.ltm.profile import Ocsp_Stapling_Params
+
+
+@pytest.fixture
+def FakeProfile():
+    fake_profiles = mock.MagicMock()
+    fake_profile = Ocsp_Stapling_Params(fake_profiles)
+    return fake_profile
+
+
+class Test_OCSP_update(object):
+
+    def test_without_proxyserverpool(self):
+        profile = FakeProfile()
+        profile.useProxyServer = 'enabled'
+        with pytest.raises(MissingUpdateParameter) as err:
+            profile.update()
+        assert 'Missing proxyServerPool parameter value' in err.value.message