server: fix volume_size unused

Author: resmo

cloudscale/lib/server.py

@@ -1,3 +1,5 @@
+import warnings
+
 from .base import CloudscaleMutable
 
 
@@ -10,7 +12,7 @@ def create(
         flavor: str,
         image: str,
         zone: str | None = None,
-        volume_size: int | None = None,
+        volume_size_gb: int | None = None,
         volumes: list | None = None,
         interfaces: list | None = None,
         ssh_keys: list | None = None,
@@ -21,6 +23,7 @@ def create(
         server_groups: list | None = None,
         user_data: str | None = None,
         tags: dict | None = None,
+        volume_size: int | None = None,
     ) -> dict:
         """Creates a server.
 
@@ -29,7 +32,7 @@ def create(
             flavor (str): The flavor of the server.
             image (str): The image of the server.
             zone (str, optional): The zone the server is created in. Defaults to None.
-            volume_size (int, optional): The volume size of the server. Defaults to None.
+            volume_size_gb (int, optional): The size of the root volume in GiB (1024^3). Defaults to None.
             volumes (list, optional): A list of volumes to be created and attached to the server. Defaults to None.
             interfaces (list, optional): A list of interfacs to be attached to the server. Defaults to None.
             ssh_keys (list, optional): A list of SSH public keys to be placed on the server. Defaults to None.
@@ -40,15 +43,26 @@ def create(
             server_groups (list, optional): A list of server groups UUIDs the server should be placed in. Defaults to None.
             user_data (str, optional): The user data startup config. Defaults to None.
             tags (dict, optional): The tags assigned to the server. Defaults to None.
+            volume_size (int, optional): Deprecated alias of volume_size_gb. Defaults to None.
 
         Returns:
             dict: API data response.
         """
+        if volume_size is not None:
+            warnings.warn(
+                "volume_size is deprecated, use volume_size_gb instead",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            if volume_size_gb is None:
+                volume_size_gb = volume_size
+
         payload = {
             "name": name,
             "flavor": flavor,
             "image": image,
             "zone": zone,
+            "volume_size_gb": volume_size_gb,
             "volumes": volumes,
             "interfaces": interfaces,
             "ssh_keys": ssh_keys,

tests/test_server.py

@@ -112,6 +112,7 @@ def test_server_create_with_all_options(responses, cloudscale):
                     "flavor": "flex-4",
                     "image": "debian-9",
                     "zone": "lpg1",
+                    "volume_size_gb": 50,
                     "volumes": [{"size_gb": 100}],
                     "interfaces": [{"network": "public"}],
                     "ssh_keys": ["ssh-rsa AAAA"],
@@ -132,7 +133,7 @@ def test_server_create_with_all_options(responses, cloudscale):
         flavor="flex-4",
         image="debian-9",
         zone="lpg1",
-        volume_size=50,
+        volume_size_gb=50,
         volumes=[{"size_gb": 100}],
         interfaces=[{"network": "public"}],
         ssh_keys=["ssh-rsa AAAA"],
@@ -155,6 +156,94 @@ def test_server_create_error(responses, cloudscale):
     assert exc_info.value.status_code == 500
 
 
+def test_server_create_with_volume_size_gb(responses, cloudscale):
+    responses.post(
+        f"{API_URL}/servers",
+        json=SERVER_RESP,
+        status=201,
+        match=[
+            responses_module.matchers.json_params_matcher(
+                {
+                    "name": "db-master",
+                    "flavor": "flex-4",
+                    "image": "debian-9",
+                    "volume_size_gb": 100,
+                }
+            )
+        ],
+    )
+
+    cloudscale.server.create(
+        name="db-master", flavor="flex-4", image="debian-9", volume_size_gb=100
+    )
+
+
+def test_server_create_with_deprecated_volume_size(responses, cloudscale):
+    """The legacy name still works, but is sent as volume_size_gb."""
+    responses.post(
+        f"{API_URL}/servers",
+        json=SERVER_RESP,
+        status=201,
+        match=[
+            responses_module.matchers.json_params_matcher(
+                {
+                    "name": "db-master",
+                    "flavor": "flex-4",
+                    "image": "debian-9",
+                    "volume_size_gb": 100,
+                }
+            )
+        ],
+    )
+
+    with pytest.warns(DeprecationWarning, match="use volume_size_gb instead"):
+        cloudscale.server.create(
+            name="db-master", flavor="flex-4", image="debian-9", volume_size=100
+        )
+
+
+def test_server_create_volume_size_gb_wins_over_the_alias(responses, cloudscale):
+    responses.post(
+        f"{API_URL}/servers",
+        json=SERVER_RESP,
+        status=201,
+        match=[
+            responses_module.matchers.json_params_matcher(
+                {
+                    "name": "db-master",
+                    "flavor": "flex-4",
+                    "image": "debian-9",
+                    "volume_size_gb": 100,
+                }
+            )
+        ],
+    )
+
+    with pytest.warns(DeprecationWarning):
+        cloudscale.server.create(
+            name="db-master",
+            flavor="flex-4",
+            image="debian-9",
+            volume_size_gb=100,
+            volume_size=50,
+        )
+
+
+def test_server_create_without_volume_size_omits_it(responses, cloudscale):
+    responses.post(
+        f"{API_URL}/servers",
+        json=SERVER_RESP,
+        status=201,
+        match=[
+            responses_module.matchers.json_params_matcher(
+                {"name": "db-master", "flavor": "flex-4", "image": "debian-9"}
+            )
+        ],
+    )
+
+    cloudscale.server.create(name="db-master", flavor="flex-4", image="debian-9")
+
+
 def test_server_update(responses, cloudscale):
     responses.patch(
         f"{API_URL}/servers/{UUID}",