Issue #1463 - Add delete_collection support

Problem: users want odata requests_params support for collections

Solution: This PR adds the method

Files Changed:

- f5/bigip/resource.py (changed)
- f5/sdk_exception.py (changed)
- f5/bigip/test/functional/test_resource.py (changed)

Author: f5-rahm

f5/bigip/resource.py

@@ -120,6 +120,7 @@
 from f5.sdk_exception import MissingRequiredCommandParameter
 from f5.sdk_exception import MissingRequiredCreationParameter
 from f5.sdk_exception import MissingRequiredReadParameter
+from f5.sdk_exception import MissingRequiredRequestsParameter
 from f5.sdk_exception import RequestParamKwargCollision
 from f5.sdk_exception import UnregisteredKind
 from f5.sdk_exception import UnsupportedMethod
@@ -817,6 +818,34 @@ def get_collection(self, **kwargs):
                     raise UnregisteredKind(error_message)
         return list_of_contents
 
+    def _delete_collection(self, **kwargs):
+        """wrapped with delete_collection, override that in a sublcass to customize """
+        error_message = "The request must include \"requests_params\": {\"params\": \"options=<glob pattern>\"} as kwarg"
+        try:
+            if kwargs['requests_params']['params'].split('=')[0] != 'options':
+                raise MissingRequiredRequestsParameter(error_message)
+        except KeyError:
+            raise
+
+        requests_params = self._handle_requests_params(kwargs)
+        delete_uri = self._meta_data['uri']
+        session = self._meta_data['bigip']._meta_data['icr_session']
+
+        session.delete(delete_uri, **requests_params)
+
+    def delete_collection(self, **kwargs):
+        """One can not simply delete a collection.
+
+        This is to support odata usage via the options request parameter:
+
+        ``requests_params={'params': 'options=glob_pattern'}``
+
+        where glob_pattern can be used to delete one or all of a particular
+        collection. Not submitting the requests params will fail, and specifying
+        patterns that match default resources will fail as well.
+        """
+        self._delete_collection(**kwargs)
+
 
 class Resource(ResourceBase):
     """Base class to represent a Configurable Resource on the device.

f5/bigip/test/functional/test_resource.py

@@ -15,6 +15,7 @@
 
 import pytest
 
+from f5.sdk_exception import MissingRequiredRequestsParameter
 from icontrol.exceptions import iControlUnexpectedHTTPError
 
 
@@ -29,3 +30,20 @@ def test_load_example_resource(request, mgmt_root):
     assert x.kind == 'tm:ltm:pool:poolcollectionstate'
     assert x.kind != 'tm:ltm:pool:poolstate'
     assert x.items[0].get('name') is None
+
+
+def test_missing_required_requests_parameters(request, mgmt_root):
+    with pytest.raises(MissingRequiredRequestsParameter) as error:
+        # SHould be options, not option
+        mgmt_root.tm.ltm.profile.tcps.delete_collection(requests_params={'params': 'option=*'})
+    assert 'The request must include "requests_params": {"params": "options=' in str(error.value.message)
+
+    with pytest.raises(KeyError) as error:
+        # Should be params, not param
+        mgmt_root.tm.ltm.profile.tcps.delete_collection(requests_params={'param': 'option=*'})
+    assert 'params' in str(error.value.message)
+
+    with pytest.raises(KeyError) as error:
+        # request_params should be present
+        mgmt_root.tm.ltm.profile.tcps.delete_collection()
+    assert 'requests_params' in str(error.value.message)

f5/sdk_exception.py

@@ -134,6 +134,10 @@ class MissingRequiredReadParameter(F5SDKError):
     pass
 
 
+class MissingRequiredRequestsParameter(F5SDKError):
+    """Raises this when a request parameter is required"""
+
+
 class MissingUpdateParameter(F5SDKError):
     """Raises this when update requires specific parameters together."""
     pass