Merge pull request #18 from DataCrunch-io/feature/CLOUD-141-update-the-python-sdk-to-the-n

Feature/cloud 141 update the python sdk to the new location code parameter

Author: tamirse

CHANGELOG.rst

@@ -1,6 +1,9 @@
 Changelog
 =========
 
+* Added location constants 
+* Refactored the code to send `location_code` instead of `location` when creating an instance or a volume
+
 v1.4.1 (2023-06-20)
 -------------------
 

datacrunch/constants.py

@@ -55,6 +55,14 @@ def __init__(self):
         return
 
 
+class Locations:
+    FIN_01 = "FIN-01"
+    ICE_01 = "ICE-01"
+
+    def __init__(self):
+        return
+
+
 class ErrorCodes:
     INVALID_REQUEST = "invalid_request"
     UNAUTHORIZED_REQUEST = "unauthorized_request"
@@ -85,6 +93,9 @@ def __init__(self, base_url, version):
         self.volume_types: VolumeTypes = VolumeTypes()
         """Available volume types"""
 
+        self.locations: Locations = Locations()
+        """Available locations"""
+
         self.error_codes: ErrorCodes = ErrorCodes()
         """Available error codes"""
 

datacrunch/instances/instances.py

@@ -1,5 +1,6 @@
 from typing import List, Union, Optional, Dict
 from datacrunch.helpers import stringify_class_object_properties
+from datacrunch.constants import Locations
 
 INSTANCES_ENDPOINT = '/instances'
 
@@ -24,7 +25,7 @@ def __init__(self,
                  storage: dict,
                  os_volume_id: str,
                  gpu_memory: dict,
-                 location: str = "FIN1",
+                 location: str = Locations.FIN_01,
                  startup_script_id: str = None,
                  is_spot: bool = False
                  ) -> None:
@@ -62,7 +63,7 @@ def __init__(self,
         :type id: str
         :param memory: gpu memory details
         :type memory: dict
-        :param location: datacenter location, defaults to "FIN1"
+        :param location: datacenter location, defaults to "FIN-01"
         :type location: str, optional
         :param startup_script_id: startup script id, defaults to None
         :type startup_script_id: str, optional
@@ -268,6 +269,7 @@ def __str__(self) -> str:
         """
         return stringify_class_object_properties(self)
 
+
 class InstancesService:
     """A service for interacting with the instances endpoint"""
 
@@ -295,7 +297,8 @@ def get(self, status: str = None) -> List[Instance]:
             ip=instance_dict['ip'],
             status=instance_dict['status'],
             created_at=instance_dict['created_at'],
-            ssh_key_ids=instance_dict['ssh_key_ids'] if 'ssh_key_ids' in instance_dict else [],
+            ssh_key_ids=instance_dict['ssh_key_ids'] if 'ssh_key_ids' in instance_dict else [
+            ],
             startup_script_id=instance_dict['startup_script_id'] if 'startup_script_id' in instance_dict else None,
             cpu=instance_dict['cpu'],
             gpu=instance_dict['gpu'],
@@ -328,7 +331,8 @@ def get_by_id(self, id: str) -> Instance:
             ip=instance_dict['ip'],
             status=instance_dict['status'],
             created_at=instance_dict['created_at'],
-            ssh_key_ids=instance_dict['ssh_key_ids'] if 'ssh_key_ids' in instance_dict else [],
+            ssh_key_ids=instance_dict['ssh_key_ids'] if 'ssh_key_ids' in instance_dict else [
+            ],
             startup_script_id=instance_dict['startup_script_id'] if 'startup_script_id' in instance_dict else None,
             cpu=instance_dict['cpu'],
             gpu=instance_dict['gpu'],
@@ -346,7 +350,7 @@ def create(self,
                hostname: str,
                description: str,
                ssh_key_ids: list = [],
-               location: str = "FIN1",
+               location: str = Locations.FIN_01,
                startup_script_id: str = None,
                volumes: List[Dict] = None,
                existing_volumes: List[str] = None,
@@ -365,7 +369,7 @@ def create(self,
         :type hostname: str
         :param description: instance description
         :type description: str
-        :param location: datacenter location, defaults to "FIN1"
+        :param location: datacenter location, defaults to "FIN-01"
         :type location: str, optional
         :param startup_script_id: startup script id, defaults to None
         :type startup_script_id: str, optional
@@ -389,7 +393,7 @@ def create(self,
             "startup_script_id": startup_script_id,
             "hostname": hostname,
             "description": description,
-            "location": location,
+            "location_code": location,
             "os_volume": os_volume,
             "volumes": volumes,
             "existing_volumes": existing_volumes,

datacrunch/volumes/volumes.py

@@ -1,5 +1,5 @@
 from typing import List, Union, Optional
-from datacrunch.constants import VolumeActions
+from datacrunch.constants import VolumeActions, Locations
 from datacrunch.helpers import stringify_class_object_properties
 
 VOLUMES_ENDPOINT = '/volumes'
@@ -17,7 +17,7 @@ def __init__(self,
                  is_os_volume: bool,
                  created_at: str,
                  target: str = None,
-                 location: str = "FIN1",
+                 location: str = Locations.FIN_01,
                  instance_id: str = None,
                  ssh_key_ids: List[str] = [],
                  deleted_at: str = None,
@@ -40,7 +40,7 @@ def __init__(self,
         :type created_at: str
         :param target: target device e.g. vda
         :type target: str, optional
-        :param location: datacenter location, defaults to "FIN1"
+        :param location: datacenter location, defaults to "FIN-01"
         :type location: str, optional
         :param instance_id: the instance id the volume is attached to, None if detached
         :type instance_id: str
@@ -238,7 +238,7 @@ def create(self,
                name: str,
                size: int,
                instance_id: str = None,
-               location: str = "FIN1",
+               location: str = Locations.FIN_01,
                ) -> Volume:
         """Create new volume
 
@@ -250,7 +250,7 @@ def create(self,
         :type size: int
         :param instance_id: Instance id to be attached to, defaults to None
         :type instance_id: str, optional
-        :param location: datacenter location, defaults to "FIN1"
+        :param location: datacenter location, defaults to "FIN-01"
         :type location: str, optional
         :return: the new volume object
         :rtype: Volume
@@ -260,7 +260,7 @@ def create(self,
             "name": name,
             "size": size,
             "instance_id": instance_id,
-            "location": location
+            "location_code": location
         }
         id = self._http_client.post(VOLUMES_ENDPOINT, json=payload).text
         volume = self.get_by_id(id)

tests/integration_tests/test_instances.py

@@ -0,0 +1,36 @@
+import os
+import pytest
+from datacrunch.datacrunch import DataCrunchClient
+from datacrunch.constants import Locations
+
+IN_GITHUB_ACTIONS = os.getenv("GITHUB_ACTIONS") == "true"
+
+
+@pytest.mark.skipif(IN_GITHUB_ACTIONS, reason="Test doesn't work in Github Actions.")
+@pytest.mark.withoutresponses
+class TestInstances():
+
+    def test_create_instance(self, datacrunch_client: DataCrunchClient):
+        # get ssh key
+        ssh_key = datacrunch_client.ssh_keys.get()[0]
+
+        # create instance
+        instance = datacrunch_client.instances.create(
+            hostname="test-instance",
+            location=Locations.FIN_01,
+            instance_type='CPU.4V',
+            description="test instance",
+            image="ubuntu-18.04",
+            ssh_key_ids=[ssh_key.id])
+
+        # assert instance is created
+        assert instance.id is not None
+        assert instance.status == datacrunch_client.constants.instance_status.PROVISIONING
+
+        # delete instance
+        datacrunch_client.instances.action(instance.id, "delete")
+
+        # permanently delete all volumes in trash
+        trash = datacrunch_client.volumes.get_in_trash()
+        for volume in trash:
+            datacrunch_client.volumes.delete(volume.id, is_permanent=True)

tests/integration_tests/test_volumes.py

@@ -1,18 +1,22 @@
 import os
 import pytest
 from datacrunch.datacrunch import DataCrunchClient
+from datacrunch.constants import Locations, VolumeTypes, VolumeStatus
 
 IN_GITHUB_ACTIONS = os.getenv("GITHUB_ACTIONS") == "true"
 
 
+NVMe = VolumeTypes.NVMe
+
+
 @pytest.mark.skipif(IN_GITHUB_ACTIONS, reason="Test doesn't work in Github Actions.")
 @pytest.mark.withoutresponses
 class TestVolumes():
 
     def test_get_volumes_from_trash(self, datacrunch_client: DataCrunchClient):
         # create new volume
         volume = datacrunch_client.volumes.create(
-            type=datacrunch_client.constants.volume_types.NVMe, name="test_volume", size=100)
+            type=NVMe, name="test_volume", size=100)
 
         # delete volume
         datacrunch_client.volumes.delete(volume.id)
@@ -29,7 +33,7 @@ def test_get_volumes_from_trash(self, datacrunch_client: DataCrunchClient):
     def test_permanently_delete_detached_volumes(seld, datacrunch_client):
         # create new volume
         volume = datacrunch_client.volumes.create(
-            type=datacrunch_client.constants.volume_types.NVMe, name="test_volume", size=100)
+            type=NVMe, name="test_volume", size=100)
 
         # permanently delete the detached volume
         datacrunch_client.volumes.delete(volume.id, is_permanent=True)
@@ -49,7 +53,7 @@ def test_permanently_delete_detached_volumes(seld, datacrunch_client):
     def test_permanently_delete_a_deleted_volume_from_trash(self, datacrunch_client):
         # create new volume
         volume = datacrunch_client.volumes.create(
-            type=datacrunch_client.constants.volume_types.NVMe, name="test_volume", size=100)
+            type=NVMe, name="test_volume", size=100)
 
         # delete volume
         datacrunch_client.volumes.delete(volume.id)
@@ -68,3 +72,16 @@ def test_permanently_delete_a_deleted_volume_from_trash(self, datacrunch_client)
 
         # assert volume is not in trash
         assert volume.id not in [v.id for v in volumes]
+
+    def test_create_volume(self, datacrunch_client):
+        # create new volume
+        volume = datacrunch_client.volumes.create(
+            type=NVMe, name="test_volume", size=100, location=Locations.FIN_01)
+
+        # assert volume is created
+        assert volume.id is not None
+        assert volume.location == Locations.FIN_01
+        assert volume.status == VolumeStatus.ORDERED or volume.status == VolumeStatus.DETACHED
+
+        # cleaning: delete volume
+        datacrunch_client.volumes.delete(volume.id, is_permanent=True)

tests/unit_tests/instances/test_instances.py

@@ -3,7 +3,7 @@
 
 from datacrunch.exceptions import APIException
 from datacrunch.instances.instances import InstancesService, Instance
-from datacrunch.constants import Actions, ErrorCodes
+from datacrunch.constants import Actions, ErrorCodes, Locations
 
 INVALID_REQUEST = ErrorCodes.INVALID_REQUEST
 INVALID_REQUEST_MESSAGE = 'Your existence is invalid'
@@ -18,7 +18,7 @@
 INSTANCE_DESCRIPTION = "hope you enjoy your GPU"
 INSTANCE_STATUS = 'running'
 INSTANCE_PRICE_PER_HOUR = 0.60
-INSTANCE_LOCATION = 'FIN1'
+INSTANCE_LOCATION = Locations.FIN_01
 INSTANCE_IP = '1.2.3.4'
 INSTANCE_CREATED_AT = "whatchalookingatboy?"
 INSTANCE_OS_VOLUME = {"name": "os volume", "size": 50}
@@ -63,6 +63,7 @@
 PAYLOAD_SPOT = PAYLOAD
 PAYLOAD_SPOT[0]["is_spot"] = True
 
+
 class TestInstancesService:
     @pytest.fixture
     def instances_service(self, http_client):
@@ -397,7 +398,8 @@ def test_action_successful(self, instances_service, endpoint):
         )
 
         # act
-        result = instances_service.action(id_list=[INSTANCE_ID], action=Actions.SHUTDOWN)
+        result = instances_service.action(
+            id_list=[INSTANCE_ID], action=Actions.SHUTDOWN)
 
         # assert
         assert result is None
@@ -415,7 +417,8 @@ def test_action_failed(self, instances_service, endpoint):
 
         # act
         with pytest.raises(APIException) as excinfo:
-            instances_service.action(id_list=[INSTANCE_ID], action="fluxturcate")
+            instances_service.action(
+                id_list=[INSTANCE_ID], action="fluxturcate")
 
         # assert
         assert excinfo.value.code == INVALID_REQUEST
@@ -424,7 +427,8 @@ def test_action_failed(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
+        url = instances_service._http_client._base_url + \
+            '/instance-availability/' + INSTANCE_TYPE
         responses.add(
             responses.GET,
             url,
@@ -441,7 +445,8 @@ def test_is_available_successful(self, instances_service):
 
     def test_is_spot_available_successful(self, instances_service):
         # arrange - add response mock
-        url = instances_service._http_client._base_url + '/instance-availability/' + INSTANCE_TYPE + '?isSpot=true'
+        url = instances_service._http_client._base_url + \
+            '/instance-availability/' + INSTANCE_TYPE + '?isSpot=true'
         responses.add(
             responses.GET,
             url,
@@ -450,7 +455,8 @@ def test_is_spot_available_successful(self, instances_service):
         )
 
         # act
-        is_available = instances_service.is_available(INSTANCE_TYPE, is_spot=True)
+        is_available = instances_service.is_available(
+            INSTANCE_TYPE, is_spot=True)
 
         # assert
         assert is_available is True
@@ -473,4 +479,4 @@ def test_is_available_failed(self, instances_service):
         # 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