Merge pull request #6 from DataCrunch-io/feature/add_spot_instance_support

Feature/add spot instance support

Author: tamirse

README.md

@@ -134,6 +134,8 @@ We use pytest for testing.
 
 ### Local Manual Testing
 
+Create this file in the root directory of the project:
+
 ```python
 from datacrunch.datacrunch import DataCrunchClient
 

datacrunch/helpers.py

@@ -0,0 +1,13 @@
+from typing import Type
+import json
+
+def stringify_class_object_properties(class_object: Type) -> str:
+    """Generates a json string representation of a class object's properties and values
+
+    :param class_object: An instance of a class
+    :type class_object: Type
+    :return: _description_
+    :rtype: json string representation of a class object's properties and values
+    """
+    class_properties = {property: getattr(class_object, property, '') for property in class_object.__dir__() if property[:1] != '_' and type(getattr(class_object, property, '')).__name__ != 'method'}
+    return json.dumps(class_properties, indent=2)

datacrunch/images/images.py

@@ -1,4 +1,5 @@
 from typing import List
+from datacrunch.helpers import stringify_class_object_properties
 
 IMAGES_ENDPOINT = '/images'
 
@@ -59,6 +60,14 @@ def details(self) -> List[str]:
         """
         return self._details
 
+    def __str__(self) -> str:
+        """Returns a string of the json representation of the image
+
+        :return: json representation of the image
+        :rtype: str
+        """
+        return stringify_class_object_properties(self)
+
 
 class ImagesService:
     """A service for interacting with the images endpoint"""

datacrunch/instances/instances.py

@@ -1,4 +1,5 @@
 from typing import List, Union, Optional, Dict
+from datacrunch.helpers import stringify_class_object_properties
 
 INSTANCES_ENDPOINT = '/instances'
 
@@ -24,7 +25,8 @@ def __init__(self,
                  os_volume_id: str,
                  gpu_memory: dict,
                  location: str = "FIN1",
-                 startup_script_id: str = None
+                 startup_script_id: str = None,
+                 is_spot: bool = False
                  ) -> None:
         """Initialize the instance object
 
@@ -64,6 +66,8 @@ def __init__(self,
         :type location: str, optional
         :param startup_script_id: startup script id, defaults to None
         :type startup_script_id: str, optional
+        :param is_spot: is this a spot instance, defaults to None
+        :type is_spot: bool, optional
         """
         self._id = id
         self._instance_type = instance_type
@@ -83,6 +87,7 @@ def __init__(self,
         self._storage = storage
         self._os_volume_id = os_volume_id
         self._gpu_memory = gpu_memory
+        self._is_spot = is_spot
 
     @property
     def id(self) -> str:
@@ -246,6 +251,22 @@ def gpu_memory(self) -> dict:
         """
         return self._gpu_memory
 
+    @property
+    def is_spot(self) -> bool:
+        """Is this a spot instance
+
+        :return: is spot details
+        :rtype: bool
+        """
+        return self._is_spot
+
+    def __str__(self) -> str:
+        """Returns a string of the json representation of the instance
+
+        :return: json representation of the instance
+        :rtype: str
+        """
+        return stringify_class_object_properties(self)
 
 class InstancesService:
     """A service for interacting with the instances endpoint"""
@@ -281,7 +302,8 @@ def get(self, status: str = None) -> List[Instance]:
             memory=instance_dict['memory'],
             storage=instance_dict['storage'],
             os_volume_id=instance_dict['os_volume_id'] if 'os_volume_id' in instance_dict else None,
-            gpu_memory=instance_dict['gpu_memory'] if 'gpu_memory' in instance_dict else None
+            gpu_memory=instance_dict['gpu_memory'] if 'gpu_memory' in instance_dict else None,
+            is_spot=instance_dict['is_spot'] if 'is_spot' in instance_dict else False
         ), instances_dict))
         return instances
 
@@ -313,8 +335,8 @@ def get_by_id(self, id: str) -> Instance:
             memory=instance_dict['memory'],
             storage=instance_dict['storage'],
             os_volume_id=instance_dict['os_volume_id'] if 'os_volume_id' in instance_dict else None,
-            gpu_memory=instance_dict['gpu_memory'] if 'gpu_memory' in instance_dict else None
-
+            gpu_memory=instance_dict['gpu_memory'] if 'gpu_memory' in instance_dict else None,
+            is_spot=instance_dict['is_spot'] if 'is_spot' in instance_dict else False
         )
         return instance
 
@@ -327,7 +349,8 @@ def create(self,
                location: str = "FIN1",
                startup_script_id: str = None,
                volumes: List[Dict] = None,
-               os_volume: Dict = None) -> Instance:
+               os_volume: Dict = None,
+               is_spot: bool = False) -> Instance:
         """Creates (deploys) a new instance
 
         :param instance_type: instance type. e.g. '8V100.48M'
@@ -348,6 +371,8 @@ def create(self,
         :type volumes: List[Dict], optional
         :param os_volume: OS volume details, defaults to None
         :type os_volume: Dict, optional
+        :param is_spot: Is spot instance
+        :type is_spot: bool, optional
         :return: the new instance object
         :rtype: id
         """
@@ -360,7 +385,8 @@ def create(self,
             "description": description,
             "location": location,
             "os_volume": os_volume,
-            "volumes": volumes
+            "volumes": volumes,
+            "is_spot": is_spot
         }
         id = self._http_client.post(INSTANCES_ENDPOINT, json=payload).text
         instance = self.get_by_id(id)

datacrunch/volumes/volumes.py

@@ -1,5 +1,6 @@
 from typing import List, Union, Optional
 from datacrunch.constants import VolumeActions
+from datacrunch.helpers import stringify_class_object_properties
 
 VOLUMES_ENDPOINT = '/volumes'
 
@@ -157,6 +158,14 @@ def ssh_key_ids(self) -> List[str]:
         """
         return self._ssh_key_ids
 
+    def __str__(self) -> str:
+        """Returns a string of the json representation of the volume
+
+        :return: json representation of the volume
+        :rtype: str
+        """
+        return stringify_class_object_properties(self)
+
 class VolumesService:
     """A service for interacting with the volumes endpoint"""
 

tests/unit_tests/images/test_images.py

@@ -36,4 +36,6 @@ def test_images(http_client):
     assert images[0].image_type == 'ubuntu-20.04-cuda-11.0'
     assert type(images[0].details) == list
     assert images[0].details[0] == "Ubuntu 20.04"
-    assert images[0].details[1] == "CUDA 11.0"
+    assert images[0].details[1] == "CUDA 11.0"
+    assert type(images[0].__str__()) == str
+    

tests/unit_tests/instances/test_instances.py

@@ -60,6 +60,8 @@
     }
 ]
 
+PAYLOAD_SPOT = PAYLOAD
+PAYLOAD_SPOT[0]["is_spot"] = True
 
 class TestInstancesService:
     @pytest.fixture
@@ -260,6 +262,58 @@ def test_create_instance_successful(self, instances_service, endpoint):
         assert type(instance.storage) == dict
         assert responses.assert_call_count(endpoint, 1) is True
         assert responses.assert_call_count(url, 1) is True
+        assert type(instance.__str__()) == str
+
+    def test_create_spot_instance_successful(self, instances_service, endpoint):
+        # arrange - add response mock
+        # add response mock for the create instance endpoint
+        responses.add(
+            responses.POST,
+            endpoint,
+            body=INSTANCE_ID,
+            status=200
+        )
+        # add response mock for the get instance by id endpoint
+        url = endpoint + '/' + INSTANCE_ID
+        responses.add(
+            responses.GET,
+            url,
+            json=PAYLOAD_SPOT[0],
+            status=200
+        )
+
+        # act
+        instance = instances_service.create(
+            instance_type=INSTANCE_TYPE,
+            image=INSTANCE_IMAGE,
+            ssh_key_ids=[SSH_KEY_ID],
+            hostname=INSTANCE_HOSTNAME,
+            description=INSTANCE_DESCRIPTION,
+            os_volume=INSTANCE_OS_VOLUME
+        )
+
+        # assert
+        assert type(instance) == Instance
+        assert instance.id == INSTANCE_ID
+        assert instance.ssh_key_ids == [SSH_KEY_ID]
+        assert instance.status == INSTANCE_STATUS
+        assert instance.image == INSTANCE_IMAGE
+        assert instance.instance_type == INSTANCE_TYPE
+        assert instance.price_per_hour == INSTANCE_PRICE_PER_HOUR
+        assert instance.location == INSTANCE_LOCATION
+        assert instance.description == INSTANCE_DESCRIPTION
+        assert instance.hostname == INSTANCE_HOSTNAME
+        assert instance.ip == INSTANCE_IP
+        assert instance.created_at == INSTANCE_CREATED_AT
+        assert instance.os_volume_id == OS_VOLUME_ID
+        assert instance.is_spot == True
+        assert type(instance.cpu) == dict
+        assert type(instance.gpu) == dict
+        assert type(instance.memory) == dict
+        assert type(instance.gpu_memory) == dict
+        assert type(instance.storage) == dict
+        assert responses.assert_call_count(endpoint, 1) is True
+        assert responses.assert_call_count(url, 1) is True
 
     def test_create_instance_attached_os_volume_successful(self, instances_service, endpoint):
         # arrange - add response mock
@@ -368,7 +422,7 @@ def test_action_failed(self, instances_service, endpoint):
         assert excinfo.value.message == INVALID_REQUEST_MESSAGE
         assert responses.assert_call_count(url, 1) is True
 
-    def test_is_available_successful(self, instances_service, endpoint):
+    def test_is_available_successful(self, instances_service):
         # arrange - add response mock
         url = instances_service._http_client._base_url + '/instance-availability/' + INSTANCE_TYPE
         responses.add(
@@ -385,7 +439,7 @@ def test_is_available_successful(self, instances_service, endpoint):
         assert is_available is True
         assert responses.assert_call_count(url, 1) is True
 
-    def test_is_available_failed(self, instances_service, endpoint):
+    def test_is_available_failed(self, instances_service):
         # arrange - add response mock
         url = instances_service._http_client._base_url + '/instance-availability/x'
         responses.add(
@@ -402,4 +456,4 @@ def test_is_available_failed(self, instances_service, endpoint):
         # assert
         assert excinfo.value.code == INVALID_REQUEST
         assert excinfo.value.message == INVALID_REQUEST_MESSAGE
-        assert responses.assert_call_count(url, 1) is True
+        assert responses.assert_call_count(url, 1) is True

tests/unit_tests/volumes/test_volumes.py

@@ -223,6 +223,7 @@ def test_create_volume_successful(self, volumes_service, endpoint):
 
         # assert
         assert volume.id == NVME_VOL_ID
+        assert type(volume.__str__()) == str
 
     def test_create_volume_failed(self, volumes_service, endpoint):
         # arrange - add response mock