avoid_hosts and login_user block

Author: Elias Nygren

test/test_server_creation.py

@@ -6,7 +6,7 @@
 from future import standard_library
 standard_library.install_aliases()
 
-from upcloud_api import ZONE, Server, Storage
+from upcloud_api import ZONE, Server, Storage, login_user_block
 
 from conftest import Mock
 import json, pytest, responses
@@ -57,10 +57,16 @@ def test_server_init(self, manager):
 
 
   def test_server_prepare_post_body(self):
-    server = Server(core_number=2, memory_amount=1024, hostname='my.example.com',zone=ZONE.Chicago, storage_devices=[
-        Storage(os='Ubuntu 14.04', size=10),
-        Storage()
-      ])
+    server = Server(
+        core_number=2,
+        memory_amount=1024,
+        hostname='my.example.com',
+        zone=ZONE.Chicago,
+        storage_devices=[
+            Storage(os='Ubuntu 14.04', size=10),
+            Storage()
+        ]
+    )
     body = server.prepare_post_body()
 
     s1 = body['server']['storage_devices']['storage_device'][0]
@@ -82,10 +88,22 @@ def test_server_prepare_post_body(self):
     assert body['server']['zone'] == 'us-chi1'
 
   def test_server_prepare_post_body_optional_attributes(self):
-    server = Server(core_number=2, memory_amount=1024,
-            hostname='my.example.com',zone=ZONE.Chicago,
-            storage_devices=[ Storage(os='Ubuntu 14.04', size=10)],
-            vnc_password='my-passwd', password_delivery='email'   )
+    server = Server(
+        core_number=2,
+        memory_amount=1024,
+        hostname='my.example.com',
+        zone=ZONE.Chicago,
+        storage_devices=[
+            Storage(
+                os='Ubuntu 14.04',
+                size=10
+            )
+        ],
+        vnc_password='my-passwd',
+        password_delivery='email',
+        login_user=login_user_block('upclouduser', ['this-is-a-SSH-key']),
+        avoid_host='12345678'
+    )
 
     body = server.prepare_post_body()
     assert body['server']['title'] == 'my.example.com'
@@ -95,6 +113,14 @@ def test_server_prepare_post_body_optional_attributes(self):
     assert body['server']['zone'] == 'us-chi1'
     assert body['server']['vnc_password'] == 'my-passwd'
     assert body['server']['password_delivery'] == 'email'
+    assert body['server']['login_user'] == {
+        'username': 'upclouduser',
+        'create_password': 'yes',
+        'ssh_keys': {
+            'ssh_key': [ 'this-is-a-SSH-key' ]
+        }
+    }
+    assert body['server']['avoid_host'] == '12345678'
 
   @responses.activate
   def test_create_server(self, manager):
@@ -160,4 +186,3 @@ def test_create_server_with_dict(self, manager):
     assert server1.video_model ==  'cirrus'
     assert server1.vnc ==  'off'
     assert server1.vnc_password ==  'aabbccdd'
-

upcloud_api/__init__.py

@@ -17,7 +17,7 @@
 
 from upcloud_api.storage import Storage
 from upcloud_api.ip_address import IP_address
-from upcloud_api.server import Server
+from upcloud_api.server import Server, login_user_block
 from upcloud_api.firewall import FirewallRule
 from upcloud_api.tools import OperatingSystems, ZONE
 from upcloud_api.tag import Tag

upcloud_api/server.py

@@ -13,6 +13,20 @@
 from time import sleep
 
 
+def login_user_block(username, ssh_keys, create_password=True):
+    """
+    Helper function for creating Server.login_user blocks.
+    (see: https://www.upcloud.com/api/8-servers/#create-server)
+    """
+    return {
+        'username': username,
+        'create_password': 'yes' if create_password is True else 'no',
+        'ssh_keys': {
+            'ssh_key': ssh_keys
+        }
+    }
+
+
 class Server(BaseAPI):
   """
   Object representation of UpCloud Server instance.
@@ -26,8 +40,14 @@ class Server(BaseAPI):
   #
 
   updateable_fields = [
-    'boot_order', 'core_number', 'firewall', 'hostname', 'memory_amount', 'nic_model', 'title',
-    'timezone', 'video_model', 'vnc', 'vnc_password', 'plan'
+    'boot_order', 'core_number', 'firewall', 'hostname', 'memory_amount', 'nic_model',
+    'title', 'timezone', 'video_model', 'vnc', 'vnc_password', 'plan'
+  ]
+
+  optional_fields = [
+    'plan', 'core_number', 'memory_amount', 'boot_order', 'firewall', 'nic_model',
+    'timezone', 'video_model', 'vnc_password', 'password_delivery', 'avoid_host',
+    'login_user'
   ]
 
 
@@ -288,19 +308,21 @@ def prepare_post_body(self):
       'storage_devices': {}
     }
 
-    # optional
-    if hasattr(self, 'plan'):               body['server']['plan'] = self.plan
-    if hasattr(self, 'core_number'):        body['server']['core_number'] = self.core_number
-    if hasattr(self, 'memory_amount'):      body['server']['memory_amount'] = self.memory_amount
-    if hasattr(self, 'boot_order'):         body['server']['boot_order'] = self.boot_order
-    if hasattr(self, 'firewall'):           body['server']['firewall'] = self.firewall
-    if hasattr(self, 'nic_model'):          body['server']['nic_model'] = self.nic_model
-    if hasattr(self, 'timezone'):           body['server']['timezone'] = self.timezone
-    if hasattr(self, 'video_model'):        body['server']['video_model'] = self.video_model
-    if hasattr(self, 'vnc_password'):       body['server']['vnc_password'] = self.vnc_password
-    if hasattr(self, 'password_delivery'):  body['server']['password_delivery'] = self.password_delivery
-    else:                                   body['server']['password_delivery'] = 'none'
+    # optional fields
+
+    for optional_field in self.optional_fields:
+        if hasattr(self, optional_field):
+            body['server'][optional_field] = getattr(self, optional_field)
+
+
+    # set password_delivery default as 'none' to prevent API from sending
+    # emails (with credentials) about each created server
+    if not hasattr(self, 'password_delivery'):
+        body['server']['password_delivery'] = 'none'
+
 
+    # collect storage devices and create a unique title (see: Storage.title in API doc)
+    # for each of them
 
     body['server']['storage_devices'] = {
       'storage_device': []