Resolve "Implement client for Image endpoint"

Author: LKaemmerling

hcloud/hcloud.py

@@ -7,10 +7,10 @@
 from hcloud.servers.client import ServersClient
 from hcloud.server_types.client import ServerTypesClient
 from hcloud.volumes.client import VolumesClient
+from hcloud.images.client import ImagesClient
 from hcloud.locations.client import LocationsClient
 from hcloud.datacenters.client import DatacentersClient
 
-
 from .version import VERSION
 
 
@@ -34,6 +34,7 @@ def __init__(self, token):
         self.server_types = ServerTypesClient(self)
         self.volumes = VolumesClient(self)
         self.actions = ActionsClient(self)
+        self.images = ImagesClient(self)
 
     def _get_user_agent(self):
         return "hcloud-python/" + self.version
@@ -52,9 +53,10 @@ def request(self, method, url, **kwargs):
             headers=self._get_headers(),
             **kwargs
         )
-
+        result = response.content
         try:
-            result = response.json()
+            if len(response.content) > 0:
+                result = response.json()
         except (TypeError, ValueError):
             raise HcloudAPIException(
                 code=response.status_code,
@@ -65,11 +67,17 @@ def request(self, method, url, **kwargs):
             )
 
         if not response.ok:
-
-            raise HcloudAPIException(
-                code=result['error']['code'],
-                message=result['error']['message'],
-                details=result['error']['details']
-            )
+            if len(response.content) > 0:
+                raise HcloudAPIException(
+                    code=result['error']['code'],
+                    message=result['error']['message'],
+                    details=result['error']['details']
+                )
+            else:
+                raise HcloudAPIException(
+                    code="unknown_error",
+                    message="An unknown error occurred.",
+                    details=""
+                )
 
         return result

hcloud/images/client.py

@@ -1,8 +1,96 @@
 # -*- coding: utf-8 -*-
-from hcloud.core.client import BoundModelBase
+from hcloud.actions.client import BoundAction
+from hcloud.core.client import BoundModelBase, ClientEntityBase
 
 from hcloud.images.domain import Image
 
 
 class BoundImage(BoundModelBase):
     model = Image
+
+    def __init__(self, client, data):
+        from hcloud.servers.client import BoundServer
+        created_from = data.get("created_from")
+        if created_from is not None:
+            data['created_from'] = BoundServer(client._client.servers, created_from, complete=False)
+        bound_to = data.get("bound_to")
+        if bound_to is not None:
+            data['bound_to'] = BoundServer(client._client.servers, {"id": bound_to}, complete=False)
+
+        super(BoundImage, self).__init__(client, data)
+
+    def get_actions(self, sort=None):
+        # type: (Optional[List[str]]) -> List[BoundAction]
+        return self._client.get_actions(self, sort)
+
+    def update(self, description=None, type=None, labels=None):
+        # type: (Optional[str], Optional[Dict[str, str]]) -> BoundImage
+        return self._client.update(self, description, type, labels)
+
+    def delete(self):
+        # type: () -> bool
+        return self._client.delete(self)
+
+    def change_protection(self, delete=None):
+        # type: (Optional[bool]) -> BoundAction
+        return self._client.change_protection(self, delete)
+
+
+class ImagesClient(ClientEntityBase):
+
+    def get_actions(self, image, sort=None):
+        # type: (Image, Optional[List[str]]) -> List[BoundAction]
+        params = {}
+        if sort is not None:
+            params.update({"sort": sort})
+        response = self._client.request(url="/images/{image_id}/actions".format(image_id=image.id), method="GET", params=params)
+        return [BoundAction(self._client.actions, action_data) for action_data in response['actions']]
+
+    def get_by_id(self, id):
+        # type: (int) -> BoundImage
+        response = self._client.request(url="/images/{image_id}".format(image_id=id), method="GET")
+        return BoundImage(self, response['image'])
+
+    def get_all(self, name=None, label_selector=None, bound_to=None, type=None, sort=None):
+        # type: (Optional[str], Optional[str], Optional[List[str]], Optional[List[str]],Optional[List[str]]) -> List[BoundImage]
+        params = {}
+        if name:
+            params['name'] = name
+        if label_selector:
+            params['label_selector'] = label_selector
+        if bound_to:
+            params['bound_to'] = bound_to
+        if type:
+            params['type'] = type
+        if sort:
+            params['sort'] = sort
+
+        response = self._client.request(url="/images", method="GET", params=params)
+        return [BoundImage(self, image_data) for image_data in response['images']]
+
+    def update(self, image, description=None, type=None, labels=None):
+        # type:(Image,  Optional[str], Optional[str],  Optional[Dict[str, str]]) -> BoundImage
+        data = {}
+        if description is not None:
+            data.update({"description": description})
+        if type is not None:
+            data.update({"type": type})
+        if labels is not None:
+            data.update({"labels": labels})
+        response = self._client.request(url="/images/{image_id}".format(image_id=image.id), method="PUT", json=data)
+        return BoundImage(self, response['image'])
+
+    def delete(self, image):
+        # type: (Image) -> bool
+        self._client.request(url="/images/{image_id}".format(image_id=image.id), method="DELETE")
+        # Return allays true, because the API does not return an action for it. When an error occurs a HcloudAPIException will be raised
+        return True
+
+    def change_protection(self, image, delete=None):
+        # type: (Image, Optional[bool], Optional[bool]) -> BoundAction
+        data = {}
+        if delete is not None:
+            data.update({"delete": delete})
+
+        response = self._client.request(url="/images/{image_id}/actions/change_protection".format(image_id=image.id), method="POST", json=data)
+        return BoundAction(self._client.actions, response['action'])

hcloud/images/domain.py

@@ -70,8 +70,8 @@ class CreateImageResponse(BaseDomain):
 
     def __init__(
             self,
-            action,  # type: Action
-            image    # type: Image
+            action,  # type: BoundAction
+            image    # type: BoundImage
     ):
         self.action = action
         self.image = image

hcloud/servers/client.py

@@ -4,7 +4,8 @@
 from hcloud.actions.client import BoundAction
 from hcloud.servers.domain import Server, CreateServerResponse, ResetPasswordResponse, EnableRescueResponse, RequestConsoleResponse
 from hcloud.volumes.client import BoundVolume
-from hcloud.images.domain import Image, CreateImageResponse
+from hcloud.images.domain import CreateImageResponse
+from hcloud.images.client import BoundImage
 from hcloud.iso.domain import Iso
 from hcloud.server_types.client import BoundServerType
 from hcloud.datacenters.client import BoundDatacenter
@@ -13,7 +14,7 @@
 class BoundServer(BoundModelBase):
     model = Server
 
-    def __init__(self, client, data):
+    def __init__(self, client, data, complete=False):
 
         datacenter = data.get('datacenter')
         if datacenter is not None:
@@ -26,8 +27,7 @@ def __init__(self, client, data):
 
         image = data.get("image", None)
         if image is not None:
-            # data['image'] = BoundImage(client._client.images, image, complete=True) # When Image Client is implemented
-            data['image'] = Image(**image)
+            data['image'] = BoundImage(client._client.images, image)
 
         iso = data.get("iso", None)
         if iso is not None:
@@ -38,10 +38,10 @@ def __init__(self, client, data):
         if server_type is not None:
             data['server_type'] = BoundServerType(client._client.server_types, server_type)
 
-        super(BoundServer, self).__init__(client, data)
+        super(BoundServer, self).__init__(client, data, complete)
 
     def get_actions(self, status=None, sort=None):
-        # type: # type: (Optional[List[str], Optional[List[str]]) -> List[BoundAction]
+        # type: (Optional[List[str]], Optional[List[str]]) -> List[BoundAction]
         return self._client.get_actions(self, status, sort)
 
     def update(self, name=None, labels=None):
@@ -301,7 +301,7 @@ def create_image(self, server, description=None, type=None, labels=None):
             data.update({"type": labels})
 
         response = self._client.request(url="/servers/{server_id}/actions/create_image".format(server_id=server.id), method="POST", json=data)
-        return CreateImageResponse(action=BoundAction(self._client.actions, response['action']), image=Image(**response['image']))
+        return CreateImageResponse(action=BoundAction(self._client.actions, response['action']), image=BoundImage(self._client.images, response['image']))
 
     def rebuild(self, server, image):
         # type: (servers.domain.Server, Image) -> actions.domainAction

tests/integration/images/test_images.py

@@ -1,7 +1,77 @@
-# import mock
-# import pytest
+import mock
+import pytest
 
-# from hcloud.images.client import ImagesClient
-# from hcloud.images.domain import Image
+from hcloud.images.client import BoundImage
+from hcloud.images.domain import Image
 
-# TODO
+
+class TestBoundImage(object):
+    @pytest.fixture()
+    def bound_image(self, hetzner_client):
+        return BoundImage(client=hetzner_client.images, data=dict(id=42))
+
+    def test_get_actions(self, bound_image):
+        actions = bound_image.get_actions()
+
+        assert len(actions) == 1
+        assert actions[0].id == 13
+        assert actions[0].command == "change_protection"
+
+    def test_update(self, bound_image):
+        image = bound_image.update(description="My new Image description", type="the new image type", labels={})
+
+        assert image.id == 4711
+        assert image.description == "My new Image description"
+
+    def test_delete(self, bound_image):
+        delete_success = bound_image.delete()
+
+        assert delete_success is True
+
+    def test_change_protection(self, bound_image):
+        action = bound_image.change_protection(True)
+
+        assert action.id == 13
+        assert action.command == "change_protection"
+
+
+class TestImagesClient(object):
+    def test_get_by_id(self, hetzner_client):
+        image = hetzner_client.images.get_by_id(1)
+        assert image.id == 4711
+        assert image.name == "ubuntu-16.04"
+        assert image.description == "Ubuntu 16.04 Standard 64 bit"
+
+    def test_get_all(self, hetzner_client):
+        images = hetzner_client.images.get_all()
+        assert images[0].id == 4711
+        assert images[0].name == "ubuntu-16.04"
+        assert images[0].description == "Ubuntu 16.04 Standard 64 bit"
+
+    @pytest.mark.parametrize("image", [Image(id=1), BoundImage(mock.MagicMock(), dict(id=1))])
+    def test_get_actions(self, hetzner_client, image):
+        actions = hetzner_client.images.get_actions(image)
+
+        assert len(actions) == 1
+        assert actions[0].id == 13
+        assert actions[0].command == "change_protection"
+
+    @pytest.mark.parametrize("image", [Image(id=1), BoundImage(mock.MagicMock(), dict(id=1))])
+    def test_update(self, hetzner_client, image):
+        image = hetzner_client.images.update(image, description="My new Image description", type="the new image type", labels={})
+
+        assert image.id == 4711
+        assert image.description == "My new Image description"
+
+    @pytest.mark.parametrize("image", [Image(id=1), BoundImage(mock.MagicMock(), dict(id=1))])
+    def test_delete(self, hetzner_client, image):
+        delete_success = hetzner_client.images.delete(image)
+
+        assert delete_success is True
+
+    @pytest.mark.parametrize("image", [Image(id=1), BoundImage(mock.MagicMock(), dict(id=1))])
+    def test_change_protection(self, hetzner_client, image):
+        action = hetzner_client.images.change_protection(image, delete=True)
+
+        assert action.id == 13
+        assert action.command == "change_protection"