wip

Author: ezilber-akamai

linode_api4/groups/linode.py

@@ -140,6 +140,7 @@ def instance_create(
         region,
         image=None,
         authorized_keys=None,
+        root_pass=None,
         firewall: Optional[Union[Firewall, int]] = None,
         backup: Optional[Union[Backup, int]] = None,
         stackscript: Optional[Union[StackScript, int]] = None,
@@ -280,10 +281,18 @@ def instance_create(
         :type ltype: str or Type
         :param region: The Region in which we are creating the Instance
         :type region: str or Region
-        :param image: The Image to deploy to this Instance. If this is provided
-                      and no root_pass is given, a password will be generated
-                      and returned along with the new Instance.
+        :param image: The Image to deploy to this Instance.
         :type image: str or Image
+        :param authorized_keys: The ssh public keys to install in the linode's
+                                /root/.ssh/authorized_keys file.  Each entry may
+                                be a single key, or a path to a file containing
+                                the key.  At least one of authorized_keys or
+                                root_pass is required.
+        :type authorized_keys: list or str
+        :param root_pass: The root password for the new Instance.  At least one
+                          of root_pass or authorized_keys is required.  Both may
+                          be provided.
+        :type root_pass: str
         :param stackscript: The StackScript to deploy to the new Instance.  If
                             provided, "image" is required and must be compatible
                             with the chosen StackScript.
@@ -295,11 +304,6 @@ def instance_create(
         :param backup: The Backup to restore to the new Instance.  May not be
                        provided if "image" is given.
         :type backup: int of Backup
-        :param authorized_keys: The ssh public keys to install in the linode's
-                                /root/.ssh/authorized_keys file.  Each entry may
-                                be a single key, or a path to a file containing
-                                the key.
-        :type authorized_keys: list or str
         :param label: The display label for the new Instance
         :type label: str
         :param group: The display group for the new Instance
@@ -337,25 +341,27 @@ def instance_create(
                                       If not provided, the default policy (linode/migrate) will be applied.
         :type maintenance_policy: str
 
-        :returns: A new Instance object, or a tuple containing the new Instance and
-                  the generated password.
-        :rtype: Instance or tuple(Instance, str)
+        :returns: A new Instance object.
+        :rtype: Instance
+        :raises ValueError: If neither root_pass nor authorized_keys is provided.
         :raises ApiError: If contacting the API fails
         :raises UnexpectedResponseError: If the API response is somehow malformed.
                                          This usually indicates that you are using
                                          an outdated library.
         """
 
-        ret_pass = None
-        if image and not "root_pass" in kwargs:
-            ret_pass = Instance.generate_root_password()
-            kwargs["root_pass"] = ret_pass
+        # Validation: require at least one of root_pass or authorized_keys
+        if not root_pass and not authorized_keys:
+            raise ValueError(
+                "At least one of root_pass or authorized_keys is required."
+            )
 
         params = {
             "type": ltype,
             "region": region,
             "image": image,
             "authorized_keys": load_and_validate_keys(authorized_keys),
+            "root_pass": root_pass,
             # These will automatically be flattened below
             "firewall_id": firewall,
             "backup_id": backup,
@@ -388,9 +394,7 @@ def instance_create(
             )
 
         l = Instance(self.client, result["id"], result)
-        if not ret_pass:
-            return l
-        return l, ret_pass
+        return l
 
     @staticmethod
     def build_instance_metadata(user_data=None, encode_user_data=True):

test/unit/groups/linode_test.py

@@ -23,6 +23,7 @@ def test_instance_create_with_user_data(self):
             self.client.linode.instance_create(
                 "g6-nanode-1",
                 "us-southeast",
+                root_pass="test123ABC!",
                 metadata=self.client.linode.build_instance_metadata(
                     user_data="cool"
                 ),
@@ -33,6 +34,7 @@ def test_instance_create_with_user_data(self):
                 {
                     "region": "us-southeast",
                     "type": "g6-nanode-1",
+                    "root_pass": "test123ABC!",
                     "metadata": {"user_data": "Y29vbA=="},
                 },
             )
@@ -51,6 +53,7 @@ def test_instance_create_with_interfaces_legacy(self):
             self.client.linode.instance_create(
                 "us-southeast",
                 "g6-nanode-1",
+                root_pass="test123ABC!",
                 interface_generation=InterfaceGeneration.LEGACY_CONFIG,
                 interfaces=interfaces,
             )
@@ -92,6 +95,7 @@ def test_create_with_placement_group(self):
             self.client.linode.instance_create(
                 "g6-nanode-1",
                 "eu-west",
+                root_pass="test123ABC!",
                 placement_group=InstancePlacementGroupAssignment(
                     id=123,
                     compliant_only=True,
@@ -117,13 +121,15 @@ def test_instance_create_with_interfaces_linode(self):
             self.client.linode.instance_create(
                 "g6-nanode-1",
                 "us-mia",
+                root_pass="test123ABC!",
                 interface_generation=InterfaceGeneration.LINODE,
                 interfaces=interfaces,
             )
 
             assert m.call_data == {
                 "region": "us-mia",
                 "type": "g6-nanode-1",
+                "root_pass": "test123ABC!",
                 "interface_generation": "linode",
                 "interfaces": [iface._serialize() for iface in interfaces],
             }
@@ -137,6 +143,7 @@ def test_create_with_maintenance_policy(self):
             self.client.linode.instance_create(
                 "g6-nanode-1",
                 "eu-west",
+                root_pass="test123ABC!",
                 maintenance_policy="linode/migrate",
             )
 

test/unit/linode_client_test.py

@@ -672,7 +672,7 @@ def test_instance_create(self):
         """
         with self.mock_post("linode/instances/123") as m:
             l = self.client.linode.instance_create(
-                "g6-standard-1", "us-east-1a"
+                "g6-standard-1", "us-east-1a", root_pass="test123ABC!"
             )
 
             self.assertIsNotNone(l)
@@ -681,16 +681,24 @@ def test_instance_create(self):
             self.assertEqual(m.call_url, "/linode/instances")
 
             self.assertEqual(
-                m.call_data, {"region": "us-east-1a", "type": "g6-standard-1"}
+                m.call_data,
+                {
+                    "region": "us-east-1a",
+                    "type": "g6-standard-1",
+                    "root_pass": "test123ABC!",
+                },
             )
 
     def test_instance_create_with_image(self):
         """
-        Tests that a Linode Instance can be created with an image, and a password generated
+        Tests that a Linode Instance can be created with an image and root_pass
         """
         with self.mock_post("linode/instances/123") as m:
-            l, pw = self.client.linode.instance_create(
-                "g6-standard-1", "us-east-1a", image="linode/debian9"
+            l = self.client.linode.instance_create(
+                "g6-standard-1",
+                "us-east-1a",
+                image="linode/debian9",
+                root_pass="test123ABC!",
             )
 
             self.assertIsNotNone(l)
@@ -704,7 +712,7 @@ def test_instance_create_with_image(self):
                     "region": "us-east-1a",
                     "type": "g6-standard-1",
                     "image": "linode/debian9",
-                    "root_pass": pw,
+                    "root_pass": "test123ABC!",
                 },
             )