added __str__ for Instance, Volumes, Images, added spot test

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'
 
@@ -259,6 +260,14 @@ def is_spot(self) -> 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"""
 

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/instances/test_instances.py

@@ -60,6 +60,8 @@
     }
 ]
 
+PAYLOAD_SPOT = PAYLOAD
+PAYLOAD_SPOT[0]["is_spot"] = True
 
 class TestInstancesService:
     @pytest.fixture
@@ -261,6 +263,57 @@ def test_create_instance_successful(self, instances_service, endpoint):
         assert responses.assert_call_count(endpoint, 1) is True
         assert responses.assert_call_count(url, 1) is True
 
+    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
         # create instance