Server creation with placement group

Author: Adrian Huber

hcloud/servers/client.py

@@ -25,6 +25,7 @@
 from hcloud.datacenters.client import BoundDatacenter
 from hcloud.networks.client import BoundNetwork  # noqa
 from hcloud.networks.domain import Network  # noqa
+from hcloud.placement_groups.client import BoundPlacementGroup
 
 
 class BoundServer(BoundModelBase):
@@ -101,6 +102,11 @@ def __init__(self, client, data, complete=True):
             ]
             data["private_net"] = private_nets
 
+        placement_group = data.get("placement_group")
+        if placement_group:
+            placement_group = BoundPlacementGroup(client._client.placement_groups, placement_group)
+            data['placement_group'] = placement_group
+
         super(BoundServer, self).__init__(client, data, complete)
 
     def get_actions_list(self, status=None, sort=None, page=None, per_page=None):
@@ -456,22 +462,22 @@ def get_by_name(self, name):
         """
         return super(ServersClient, self).get_by_name(name)
 
-    def create(
-        self,
-        name,  # type: str
-        server_type,  # type: ServerType
-        image,  # type: Image
-        ssh_keys=None,  # type: Optional[List[SSHKey]]
-        volumes=None,  # type: Optional[List[Volume]]
-        firewalls=None,  # type: Optional[List[Firewall]]
-        networks=None,  # type: Optional[List[Network]]
-        user_data=None,  # type: Optional[str]
-        labels=None,  # type: Optional[Dict[str, str]]
-        location=None,  # type: Optional[Location]
-        datacenter=None,  # type: Optional[Datacenter]
-        start_after_create=True,  # type: Optional[bool]
-        automount=None,  # type: Optional[bool]
-    ):
+    def create(self,
+               name,  # type: str
+               server_type,  # type: ServerType
+               image,  # type: Image
+               ssh_keys=None,  # type: Optional[List[SSHKey]]
+               volumes=None,  # type: Optional[List[Volume]]
+               firewalls=None,  # type: Optional[List[Firewall]]
+               networks=None,  # type: Optional[List[Network]]
+               user_data=None,  # type: Optional[str]
+               labels=None,  # type: Optional[Dict[str, str]]
+               location=None,  # type: Optional[Location]
+               datacenter=None,  # type: Optional[Datacenter]
+               start_after_create=True,  # type: Optional[bool]
+               automount=None,  # type: Optional[bool]
+               placement_group=None  # type: Optional[PlacementGroup]
+               ):
         # type: (...) -> CreateServerResponse
         """Creates a new server. Returns preliminary information about the server as well as an action that covers progress of creation.
 
@@ -497,6 +503,8 @@ def create(
                Start Server right after creation. Defaults to True.
         :param automount: boolean (optional)
                Auto mount volumes after attach.
+        :param placement_group: :class:`BoundPlacementGroup <hcloud.placement_groups.client.BoundPlacementGroup>` or :class:`Location <hcloud.placement_groups.domain.PlacementGroup>`
+               Placement Group where server should be added during creation
         :return: :class:`CreateServerResponse <hcloud.servers.domain.CreateServerResponse>`
         """
         data = {
@@ -524,6 +532,8 @@ def create(
             data["labels"] = labels
         if automount is not None:
             data["automount"] = automount
+        if placement_group is not None:
+            data['placement_group'] = placement_group.id
 
         response = self._client.request(url="/servers", method="POST", json=data)
 

hcloud/servers/domain.py

@@ -84,30 +84,32 @@ class Server(BaseDomain):
         "private_net",
         "created",
         "primary_disk_size",
+        "placement_group"
     )
 
     def __init__(
-        self,
-        id,
-        name=None,
-        status=None,
-        created=None,
-        public_net=None,
-        server_type=None,
-        datacenter=None,
-        image=None,
-        iso=None,
-        rescue_enabled=None,
-        locked=None,
-        backup_window=None,
-        outgoing_traffic=None,
-        ingoing_traffic=None,
-        included_traffic=None,
-        protection=None,
-        labels=None,
-        volumes=None,
-        private_net=None,
-        primary_disk_size=None,
+            self,
+            id,
+            name=None,
+            status=None,
+            created=None,
+            public_net=None,
+            server_type=None,
+            datacenter=None,
+            image=None,
+            iso=None,
+            rescue_enabled=None,
+            locked=None,
+            backup_window=None,
+            outgoing_traffic=None,
+            ingoing_traffic=None,
+            included_traffic=None,
+            protection=None,
+            labels=None,
+            volumes=None,
+            private_net=None,
+            primary_disk_size=None,
+            placement_group=None,
     ):
         self.id = id
         self.name = name
@@ -129,6 +131,7 @@ def __init__(
         self.volumes = volumes
         self.private_net = private_net
         self.primary_disk_size = primary_disk_size
+        self.placement_group = placement_group
 
 
 class CreateServerResponse(BaseDomain):

tests/unit/servers/conftest.py

@@ -627,6 +627,19 @@ def response_full_server():
                 "type": "public",
                 "deprecated": "2018-02-28T00:00:00+00:00",
             },
+            "placement_group": {
+                "created": "2019-01-08T12:10:00+00:00",
+                "id": 897,
+                "labels": {
+                    "key": "value"
+                },
+                "name": "my Placement Group",
+                "servers": [
+                    4711,
+                    4712
+                ],
+                "type": "spread"
+            },
             "rescue_enabled": False,
             "locked": False,
             "backup_window": "22-02",

tests/unit/servers/test_client.py

@@ -117,6 +117,12 @@ def test_bound_server_init(self, response_full_server):
         assert len(bound_server.private_net[0].alias_ips) == 1
         assert bound_server.private_net[0].alias_ips[0] == "10.1.1.8"
 
+        assert isinstance(bound_server.placement_group, BoundPlacementGroup)
+        assert bound_server.placement_group._client == bound_server._client._client.placement_groups
+        assert bound_server.placement_group.id == 897
+        assert bound_server.placement_group.name == "my Placement Group"
+        assert bound_server.placement_group.complete is True
+
     @pytest.mark.parametrize(
         "params",
         [
@@ -741,9 +747,48 @@ def test_create_with_firewalls(self, servers_client, response_create_simple_serv
 
         assert next_actions[0].id == 13
 
-    @pytest.mark.parametrize(
-        "server", [Server(id=1), BoundServer(mock.MagicMock(), dict(id=1))]
-    )
+    def test_create_with_placement_group(self, servers_client, response_create_simple_server):
+        servers_client._client.request.return_value = response_create_simple_server
+        placement_group = PlacementGroup(id=1)
+        response = servers_client.create(
+            "my-server",
+            server_type=ServerType(name="cx11"),
+            image=Image(id=4711),
+            start_after_create=False,
+            placement_group=placement_group
+        )
+
+        servers_client._client.request.assert_called_with(
+            url="/servers",
+            method="POST",
+            json={
+                'name': "my-server",
+                'server_type': "cx11",
+                'image': 4711,
+                'placement_group': 1,
+                "start_after_create": False
+            }
+        )
+
+        bound_server = response.server
+        bound_action = response.action
+        next_actions = response.next_actions
+        root_password = response.root_password
+
+        assert root_password == "YItygq1v3GYjjMomLaKc"
+
+        assert bound_server._client is servers_client
+        assert bound_server.id == 1
+        assert bound_server.name == "my-server"
+
+        assert isinstance(bound_action, BoundAction)
+        assert bound_action._client == servers_client._client.actions
+        assert bound_action.id == 1
+        assert bound_action.command == "create_server"
+
+        assert next_actions[0].id == 13
+
+    @pytest.mark.parametrize("server", [Server(id=1), BoundServer(mock.MagicMock(), dict(id=1))])
     def test_get_actions_list(self, servers_client, server, response_get_actions):
         servers_client._client.request.return_value = response_get_actions
         result = servers_client.get_actions_list(server)