Add placement group create request

Author: Adrian Huber

hcloud/placement_groups/client.py

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
+from hcloud.actions.client import BoundAction
 from hcloud.core.client import BoundModelBase, ClientEntityBase, GetEntityByNameMixin
 
-from hcloud.placement_groups.domain import PlacementGroup
+from hcloud.placement_groups.domain import PlacementGroup, CreatePlacementGroupResponse
 
 
 class BoundPlacementGroup(BoundModelBase):
@@ -108,6 +109,40 @@ def get_by_name(self, name):
         """
         return super(PlacementGroupsClient, self).get_by_name(name)
 
+    def create(self,
+               name,  # type: str
+               labels=None,  # type: Optional[Dict[str, str]]
+               type=PlacementGroup.TYPE_SPREAD  # type: Optional[str]
+               ):
+        # type: (...) -> CreatePlacementGroupResponse
+        """Creates a new Placement Group.
+
+        :param name: str
+               Placement Group Name
+        :param labels: Dict[str, str] (optional)
+               User-defined labels (key-value pairs)
+        :param type: str
+           Type of the Placement Group
+        :return: :class:`CreatePlacementGroupResponse <hcloud.placement_groups.domain.CreatePlacementGroupResponse>`
+        """
+        data = {
+            'name': name,
+            'type': type
+        }
+        if labels is not None:
+            data['labels'] = labels
+        response = self._client.request(url="/placement_groups", json=data, method="POST")
+
+        action = None
+        if response.get('action') is not None:
+            action = BoundAction(self._client.action, response['action'])
+
+        result = CreatePlacementGroupResponse(
+            placement_group=BoundPlacementGroup(self, response['placement_group']),
+            action=action
+        )
+        return result
+
     def update(self, placement_group, labels=None, name=None):
         # type: (PlacementGroup, Optional[Dict[str, str]], Optional[str]) -> BoundPlacementGroup
         """Updates the description or labels of a Placement Group.

hcloud/placement_groups/domain.py

@@ -50,3 +50,25 @@ def __init__(
         self.servers = servers
         self.type = type
         self.created = isoparse(created) if created else None
+
+
+class CreatePlacementGroupResponse(BaseDomain):
+    """Create Placement Group Response Domain
+
+    :param placement_group: :class:`BoundPlacementGroup <hcloud.placement_groups.client.BoundPlacementGroup>`
+           The Placement Group which was created
+    :param action: :class:`BoundAction <hcloud.actions.client.BoundAction>`
+           The Action which shows the progress of the Placement Group Creation
+    """
+    __slots__ = (
+        "placement_group",
+        "action"
+    )
+
+    def __init__(
+            self,
+            placement_group,  # type: BoundPlacementGroup
+            action,  # type: BoundAction
+    ):
+        self.placement_group = placement_group
+        self.action = action

tests/unit/placement_groups/conftest.py

@@ -1,6 +1,22 @@
 import pytest
 
 
+@pytest.fixture()
+def response_create_placement_group():
+    return {
+        "placement_group": {
+            "created": "2019-01-08T12:10:00+00:00",
+            "id": 897,
+            "labels": {
+                "key": "value"
+            },
+            "name": "my Placement Group",
+            "servers": [],
+            "type": "spread"
+        }
+    }
+
+
 @pytest.fixture()
 def one_placement_group_response():
     return {

tests/unit/placement_groups/test_client.py

@@ -120,3 +120,23 @@ def test_get_by_name(self, placement_groups_client, one_placement_group_response
         placement_groups_client._client.request.assert_called_with(url="/placement_groups", method="GET", params=params)
 
         check_variables(placement_group, one_placement_group_response['placement_groups'][0])
+
+    def test_create(self, placement_groups_client, response_create_placement_group):
+        placement_groups_client._client.request.return_value = response_create_placement_group
+        response = placement_groups_client.create(
+            response_create_placement_group['placement_group']['name'],
+            response_create_placement_group['placement_group']['labels'],
+            response_create_placement_group['placement_group']['type']
+        )
+
+        json = {
+            'name': response_create_placement_group['placement_group']['name'],
+            'labels': response_create_placement_group['placement_group']['labels'],
+            'type': response_create_placement_group['placement_group']['type']
+        }
+        placement_groups_client._client.request.assert_called_with(url="/placement_groups", method="POST", json=json)
+
+        bound_placement_group = response.placement_group
+
+        assert bound_placement_group._client is placement_groups_client
+        check_variables(bound_placement_group, response_create_placement_group['placement_group'])