Add infra status wrapper class

Author: Agathe Guillemot

dataikuapi/dss/apideployer.py

@@ -152,7 +152,7 @@ def get_service(self, service_id):
 
 class DSSAPIDeployerInfra(object):
     """
-    A Deployment infrastructure on the API Deployer
+    An API Deployer infrastructure.
 
     Do not create this directly, use :meth:`~dataikuapi.dss.apideployer.DSSAPIDeployer.get_infra`
     """
@@ -163,6 +163,16 @@ def __init__(self, client, infra_id):
     def id(self):
         return self.infra_id
 
+    def get_status(self):
+        """
+        Returns status information about this infrastructure
+
+        :rtype: a :class:`dataikuapi.dss.apideployer.DSSAPIDeployerInfraStatus`
+        """
+        light = self.client._perform_json("GET", "/api-deployer/infras/%s" % (self.infra_id))
+
+        return DSSAPIDeployerInfraStatus(self.client, self.infra_id, light)
+
     def get_settings(self):
         """
         Gets the settings of this infra. If you want to modify the settings, you need to
@@ -186,7 +196,8 @@ def delete(self):
 
 
 class DSSAPIDeployerInfraSettings(object):
-    """The settings of an API Deployer Infra. 
+    """
+    The settings of an API Deployer infrastructure
 
     Do not create this directly, use :meth:`~dataikuapi.dss.apideployer.DSSAPIDeployerInfra.get_settings`
     """
@@ -238,6 +249,34 @@ def save(self):
                 body = self.settings)
 
 
+class DSSAPIDeployerInfraStatus(object):
+    """
+    The status of an API Deployer infrastructure.
+
+    Do not create this directly, use :meth:`~dataikuapi.dss.apideployer.DSSAPIDeployerInfra.get_status`
+    """
+    def __init__(self, client, infra_id, light_status):
+        self.client = client
+        self.infra_id = infra_id
+        self.light_status = light_status
+
+    def list_deployments(self):
+        """
+        Returns the deployments that are deployed on this infrastructure
+
+        :returns: a list of deployments
+        :rtype: list of :class:`dataikuapi.dss.apideployer.DSSAPIDeployerDeployment`
+        """
+        return [DSSAPIDeployerDeployment(self.client, deployment.id) for deployment in self.light_status["deployments"]]
+
+    def get_raw(self):
+        """
+        Gets the raw status information. This returns a dictionary with various information about the infrastructure
+        :rtype: dict
+        """
+        return self.light_status
+
+
 ###############################################
 # Deployments
 ###############################################

dataikuapi/dss/projectdeployer.py

@@ -177,7 +177,7 @@ def upload_bundle(self, fp, project_key=None):
 
 class DSSProjectDeployerInfra(object):
     """
-    A Deployment infrastructure on the Project Deployer
+    An Automation infrastructure on the Project Deployer
 
     Do not create this directly, use :meth:`~dataikuapi.dss.projectdeployer.DSSProjectDeployer.get_infra`
     """
@@ -188,6 +188,16 @@ def __init__(self, client, infra_id):
     def id(self):
         return self.infra_id
 
+    def get_status(self):
+        """
+        Returns status information about this infrastructure
+
+        :rtype: a :class:`dataikuapi.dss.projectdeployer.DSSProjectDeployerInfraStatus`
+        """
+        light = self.client._perform_json("GET", "/project-deployer/infras/%s" % (self.infra_id))
+
+        return DSSProjectDeployerInfraStatus(self.client, self.infra_id, light)
+
     def get_settings(self):
         """
         Gets the settings of this infra. If you want to modify the settings, you need to
@@ -211,7 +221,8 @@ def delete(self):
 
 
 class DSSProjectDeployerInfraSettings(object):
-    """The settings of a Project Deployer Infra.
+    """
+    The settings of an Automation infrastructure.
 
     Do not create this directly, use :meth:`~dataikuapi.dss.projectdeployer.DSSProjectDeployerInfra.get_settings`
     """
@@ -236,6 +247,33 @@ def save(self):
                 body = self.settings)
 
 
+class DSSProjectDeployerInfraStatus(object):
+    """
+    The status of an Automation infrastructure.
+
+    Do not create this directly, use :meth:`~dataikuapi.dss.projectdeployer.DSSProjectDeployerInfra.get_status`
+    """
+    def __init__(self, client, infra_id, light_status):
+        self.client = client
+        self.infra_id = infra_id
+        self.light_status = light_status
+
+    def list_deployments(self):
+        """
+        Returns the deployments that are deployed on this infrastructure
+
+        :returns: a list of deployments
+        :rtype: list of :class:`dataikuapi.dss.projectdeployer.DSSProjectDeployerDeployment`
+        """
+        return [DSSProjectDeployerDeployment(self.client, deployment.id) for deployment in self.light_status["deployments"]]
+
+    def get_raw(self):
+        """
+        Gets the raw status information. This returns a dictionary with various information about the infrastructure
+        :rtype: dict
+        """
+        return self.light_status
+
 ###############################################
 # Deployments
 ###############################################
@@ -444,6 +482,7 @@ def delete(self):
         return self.client._perform_empty(
             "DELETE", "/project-deployer/projects/%s" % (self.project_key))
 
+
 class DSSProjectDeployerProjectSettings(object):
     """The settings of a published project.
 
@@ -511,4 +550,4 @@ def get_raw(self):
         Gets the raw status information. This returns a dictionary with various information about the project
         :rtype: dict
         """
-        return self.light_status
+        return self.light_status