FM: future

Author: Thibaud Baas

dataikuapi/fm/future.py

@@ -0,0 +1,85 @@
+import sys, time
+
+class FMFuture(object):
+    """
+    A future on the DSS instance
+    """
+    def __init__(self, client, job_id, state=None, result_wrapper=lambda result: result):
+       self.client = client
+       self.job_id = job_id
+       self.state = state
+       self.state_is_peek = True
+       self.result_wrapper = result_wrapper
+
+    @staticmethod
+    def from_resp(client, resp,result_wrapper=lambda result: result):
+        """Creates a DSSFuture from a parsed JSON response"""
+        return FMFuture(client, resp.get('jobId', None), state=resp, result_wrapper=result_wrapper)
+
+    @classmethod
+    def get_result_wait_if_needed(cls, client, ret):
+        if 'jobId' in ret:
+            future = FMFuture(client, ret["jobId"], ret)
+            future.wait_for_result()
+            return future.get_result()
+        else:
+            return ret['result']
+
+    def abort(self):
+        """
+        Abort the future
+        """
+        return self.client._perform_tenant_empty("DELETE", "/futures/%s" % self.job_id)
+
+    def get_state(self):
+        """
+        Get the status of the future, and its result if it's ready
+        """
+        self.state = self.client._perform_tenant_json(
+            "GET", "/futures/%s" % self.job_id, params={'peek' : False})
+        self.state_is_peek = False
+        return self.state
+
+    def peek_state(self):
+        """
+        Get the status of the future, and its result if it's ready
+        """
+        self.state = self.client._perform_tenant_json(
+            "GET", "/futures/%s" % self.job_id, params={'peek' : True})
+        self.state_is_peek = True
+        return self.state
+
+    def get_result(self):
+        """
+        Get the future result if it's ready, raises an Exception otherwise
+        """
+        if self.state is None or not self.state.get('hasResult', False) or self.state_is_peek:
+            self.get_state()
+        if self.state.get('hasResult', False):
+            return self.result_wrapper(self.state.get('result', None))
+        else:
+            raise Exception("Result not ready")
+
+    def has_result(self):
+        """
+        Checks whether the future has a result ready
+        """
+        if self.state is None or not self.state.get('hasResult', False):
+            self.get_state()
+        return self.state.get('hasResult', False)
+
+    def wait_for_result(self):
+        """
+        Wait and get the future result
+        """
+        if self.state.get('hasResult', False):
+            return self.result_wrapper(self.state.get('result', None))
+        if self.state is None or not self.state.get('hasResult', False) or self.state_is_peek:
+            self.get_state()
+        while not self.state.get('hasResult', False):
+            time.sleep(5)
+            self.get_state()
+        if self.state.get('hasResult', False):
+            return self.result_wrapper(self.state.get('result', None))
+        else:
+            raise Exception("No result")

dataikuapi/fm/instances.py

@@ -1,4 +1,5 @@
 from enum import Enum
+from .future import FMFuture
 
 class FMInstance(object):
     """
@@ -13,20 +14,32 @@ def __init__(self, client, instance_data):
     def reprovision(self):
         """
         Reprovision the physical DSS instance
+
+        :return: A :class:`~dataikuapi.fm.future.FMFuture` representing the reprovision process
+        :rtype: :class:`~dataikuapi.fm.future.FMFuture`
         """
-        self.client._perform_tenant_json("GET", "/instances/%s/actions/reprovision" % self.id)
+        future = self.client._perform_tenant_json("GET", "/instances/%s/actions/reprovision" % self.id)
+        return FMFuture.from_resp(self.client, future)
 
     def deprovision(self):
         """
         Deprovision the physical DSS instance
+
+        :return: A :class:`~dataikuapi.fm.future.FMFuture` representing the deprovision process
+        :rtype: :class:`~dataikuapi.fm.future.FMFuture`
         """
-        self.client._perform_tenant_json("GET", "/instances/%s/actions/deprovision" % self.id)
+        future = self.client._perform_tenant_json("GET", "/instances/%s/actions/deprovision" % self.id)
+        return FMFuture.from_resp(self.client, future)
 
     def restart_dss(self):
         """
         Restart the DSS running on the physical instance
+
+        :return: A :class:`~dataikuapi.fm.future.FMFuture` representing the restart process
+        :rtype: :class:`~dataikuapi.fm.future.FMFuture`
         """
-        self.client._perform_tenant_json("GET", "/instances/%s/actions/restart-dss" % self.id)
+        future = self.client._perform_tenant_json("GET", "/instances/%s/actions/restart-dss" % self.id)
+        return FMFuture.from_resp(self.client, future)
 
     def save(self):
         """

dataikuapi/fmclient.py

@@ -61,7 +61,7 @@ def get_virtual_networks(self):
         List all Virtual Networks
 
         :return: list of virtual networks
-        :rtype: list of :class:`dataikuapi.fm.tenant.FMVirtualNetwork`
+        :rtype: list of :class:`dataikuapi.fm.virtualnetworks.FMVirtualNetwork`
         """
         vns = self._perform_tenant_json("GET", "/virtual-networks")
         return [ FMVirtualNetwork(self, x) for x in vns]
@@ -73,7 +73,7 @@ def get_virtual_network(self, virtual_network_id):
         :param str virtual_network_id
 
         :return: requested virtual network
-        :rtype: :class:`dataikuapi.fm.tenant.FMVirtualNetwork`
+        :rtype: :class:`dataikuapi.fm.virtualnetworks.FMVirtualNetwork`
         """
         template = self._perform_tenant_json("GET", "/virtual-networks/%s" % virtual_network_id)
         return FMVirtualNetwork(self, template)
@@ -100,7 +100,7 @@ def get_instance_template(self, template_id):
         :param str template_id
 
         :return: requested instance settings template
-        :rtype: :class:`dataikuapi.fm.tenant.FMInstanceSettingsTemplate`
+        :rtype: :class:`dataikuapi.fm.instancesettingstemplates.FMInstanceSettingsTemplate`
         """
         template = self._perform_tenant_json("GET", "/instance-settings-templates/%s" % template_id)
         return FMInstanceSettingsTemplate(self, template)
@@ -118,7 +118,7 @@ def create_instance_template(self, label,
 
         :param str label: The label of the Instance Settings Template
 
-        :param list setupActions: Optional, a list of `:class: FMSetupAction` to be played on an instance
+        :param list setupActions: Optional, a list of :class:`dataikuapi.fm.instancesettingstemplates.FMSetupAction` to be played on an instance
         :param str license: Optional, overrides the license set in Cloud Setup
 
         :param str awsKeyPairName: Optional, AWS Only, the name of an AWS key pair to add to the instance. Needed to get SSH access to the DSS instance, using the centos user.
@@ -137,7 +137,7 @@ def create_instance_template(self, label,
         :param str runtimeManagedIdentity: Optional, Azure Only, the managed identity assigned to the DSS instance at runtime
 
         :return: requested instance settings template
-        :rtype: :class:`dataikuapi.fm.tenant.FMInstanceSettingsTemplate`
+        :rtype: :class:`dataikuapi.fm.instancesettingstemplates.FMInstanceSettingsTemplate`
         """
 
         data = {
@@ -172,7 +172,7 @@ def get_instances(self):
         List all DSS Instances
 
         :return: list of instances
-        :rtype: list of :class:`dataikuapi.fm.tenant.FMInstance`
+        :rtype: list of :class:`dataikuapi.fm.instances.FMInstance`
         """
         instances = self._perform_tenant_json("GET", "/instances")
         return [ FMInstance(self, **x) for x in instances]
@@ -184,7 +184,7 @@ def get_instance(self, instance_id):
         :param str instance_id
 
         :return: Instance
-        :rtype: :class:`dataikuapi.fm.tenant.FMInstance`
+        :rtype: :class:`dataikuapi.fm.instances.FMInstance`
         """
         instance = self._perform_tenant_json("GET", "/instances/%s" % instance_id)
         return FMInstance(self, instance)
@@ -209,7 +209,7 @@ def create_instance(self, instance_settings_template, virtual_network, label, im
         :param int data_volume_size: Optional, Data volume initial size
         :param int data_volume_size_max: Optional, Data volume maximum size
         :param int data_volume_IOPS: Optional, Data volume IOPS
-        :param object data_volume_encryption: Optional, a :class:`FMInstanceEncryptionMode` setting the encryption mode of the data volume
+        :param object data_volume_encryption: Optional, a :class:`dataikuapi.fm.instances.FMInstanceEncryptionMode` setting the encryption mode of the data volume
         :param str data_volume_encryption_key: Optional, the encryption key to use when data_volume_encryption_key is FMInstanceEncryptionMode.CUSTOM
         :param int aws_root_volume_size: Optional, the root volume size
         :param str aws_root_volume_type: Optional, the root volume type
@@ -218,7 +218,7 @@ def create_instance(self, instance_settings_template, virtual_network, label, im
         :param list fm_tags: Optional, list of tags to be applied on the instance in the Fleet Manager
 
         :return: Instance
-        :rtype: :class:`dataikuapi.fm.tenant.FMInstance`
+        :rtype: :class:`dataikuapi.fm.instances.FMInstance`
         """
         data = {
             "virtualNetworkId": virtual_network.id,