Propagate asynchronous parameter where delete is asynchronous

Author: antechrestos

main/cloudfoundry_client/v3/apps.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Optional
 
 from cloudfoundry_client.json_object import JsonObject
 from cloudfoundry_client.v3.entities import EntityManager
@@ -16,8 +16,8 @@ def restart(self, application_guid: str):
                                                                           self.entity_uri,
                                                                           application_guid))
 
-    def remove(self, application_guid: str):
-        super(AppManager, self)._remove(application_guid)
+    def remove(self, application_guid: str, asynchronous: bool = True) -> Optional[str]:
+        return super(AppManager, self)._remove(application_guid, asynchronous)
 
     def get_env(self, application_guid: str) -> JsonObject:
         return super(AppManager, self)._get("%s%s/%s/env" % (self.target_endpoint, self.entity_uri, application_guid))

main/cloudfoundry_client/v3/buildpacks.py

@@ -30,8 +30,8 @@ def create(
         }
         return super(BuildpackManager, self)._create(data)
 
-    def remove(self, buildpack_guid: str):
-        super(BuildpackManager, self)._remove(buildpack_guid)
+    def remove(self, buildpack_guid: str, asynchronous: bool = True) -> Optional[str]:
+        return super(BuildpackManager, self)._remove(buildpack_guid, asynchronous)
 
     def update(
         self,

main/cloudfoundry_client/v3/domains.py

@@ -50,8 +50,8 @@ def update(self, domain_guid: str, meta_labels: Optional[dict] = None, meta_anno
         data = {"metadata": {"labels": meta_labels, "annotations": meta_annotations}}
         return super(DomainManager, self)._update(domain_guid, data)
 
-    def remove(self, domain_guid: str):
-        super(DomainManager, self)._remove(domain_guid)
+    def remove(self, domain_guid: str, asynchronous: bool = True) -> Optional[str]:
+        return super(DomainManager, self)._remove(domain_guid, asynchronous)
 
     def __create_shared_domain_url(self, domain_guid: str) -> str:
         # TODO use url parser for this

main/cloudfoundry_client/v3/entities.py

@@ -148,6 +148,18 @@ def _delete(self, url: str) -> Optional[str]:
         except (AttributeError, KeyError):
             return None
 
+    def _remove(self, resource_id: str, asynchronous: bool = True) -> Optional[str]:
+        url = "%s%s/%s" % (self.target_endpoint, self.entity_uri, resource_id)
+        job_location = self._delete(url)
+        if job_location is not None:
+            job_url = urlparse(job_location)
+            job_guid = job_url.path.rsplit("/", 1)[-1]
+            if not asynchronous:
+                self.client.v3.jobs.wait_for_job_completion(job_guid)
+            else:
+                return job_guid
+        return None
+
     def _list(self, requested_path: str, entity_type: Optional[ENTITY_TYPE] = None, **kwargs) -> PaginateEntities:
         url_requested = EntityManager._get_url_with_encoded_params("%s%s" % (self.target_endpoint, requested_path), **kwargs)
         for element in self._paginate(url_requested, entity_type):
@@ -194,14 +206,6 @@ def _update(self, resource_id: str, data: dict) -> Entity:
         url = "%s%s/%s" % (self.target_endpoint, self.entity_uri, resource_id)
         return self._patch(url, data)
 
-    def _remove(self, resource_id: str, asynchronous: bool = True):
-        url = "%s%s/%s" % (self.target_endpoint, self.entity_uri, resource_id)
-        job_location = self._delete(url)
-        if not asynchronous and job_location is not None:
-            job_url = urlparse(job_location)
-            job_guid = job_url.path.rsplit("/", 1)[-1]
-            self.client.v3.jobs.wait_for_job_completion(job_guid)
-
     def __iter__(self) -> PaginateEntities:
         return self.list()
 

main/cloudfoundry_client/v3/organization_quotas.py

@@ -37,8 +37,8 @@ class OrganizationQuotaManager(EntityManager):
     def __init__(self, target_endpoint: str, client: "CloudFoundryClient"):
         super().__init__(target_endpoint, client, "/v3/organization_quotas")
 
-    def remove(self, guid: str):
-        super()._remove(guid)
+    def remove(self, guid: str, asynchronous: bool = True) -> Optional[str]:
+        return super()._remove(guid, asynchronous)
 
     def create(
         self,

main/cloudfoundry_client/v3/organizations.py

@@ -27,8 +27,8 @@ def update(
         data = {"name": name, "suspended": suspended, "metadata": {"labels": meta_labels, "annotations": meta_annotations}}
         return super(OrganizationManager, self)._update(guid, data)
 
-    def remove(self, guid: str):
-        super(OrganizationManager, self)._remove(guid)
+    def remove(self, guid: str, asynchronous: bool = True) -> Optional[str]:
+        return super(OrganizationManager, self)._remove(guid, asynchronous)
 
     def assign_default_isolation_segment(self, org_guid: str, iso_seg_guid: str) -> Entity:
         return ToOneRelationship.from_json_object(

main/cloudfoundry_client/v3/roles.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Optional
 
 from cloudfoundry_client.v3.entities import EntityManager
 
@@ -10,5 +10,5 @@ class RoleManager(EntityManager):
     def __init__(self, target_endpoint: str, client: "CloudFoundryClient"):
         super(RoleManager, self).__init__(target_endpoint, client, "/v3/roles")
 
-    def remove(self, role_guid: str):
-        super(RoleManager, self)._remove(role_guid)
+    def remove(self, role_guid: str, asynchronous: bool = True) -> Optional[str]:
+        return super(RoleManager, self)._remove(role_guid, asynchronous)

main/cloudfoundry_client/v3/security_groups.py

@@ -58,8 +58,8 @@ def update(self,
         payload = self._generate_payload(name, rules, globally_enabled, staging_spaces, running_spaces)
         return super()._update(security_group_id, payload)
 
-    def remove(self, security_group_id: str):
-        return super()._remove(security_group_id)
+    def remove(self, security_group_id: str, asynchronous: bool = True) -> Optional[str]:
+        return super()._remove(security_group_id, asynchronous)
 
     def bind_running_security_group_to_spaces(self, security_group_id: str, space_guids: ToManyRelationship) \
             -> ToManyRelationship:

main/cloudfoundry_client/v3/service_brokers.py

@@ -59,5 +59,5 @@ def update(
             payload["metadata"] = metadata
         return super(ServiceBrokerManager, self)._update(guid, payload)
 
-    def remove(self, guid: str):
-        super(ServiceBrokerManager, self)._remove(guid)
+    def remove(self, guid: str, asynchronous: bool = True) -> Optional[str]:
+        return super(ServiceBrokerManager, self)._remove(guid, asynchronous)