pycloudlib 1!9.3.0__tar.gz → 1!9.3.2__tar.gz

{pycloudlib-1!9.3.0/pycloudlib.egg-info → pycloudlib-1!9.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pycloudlib
-Version: 1!9.3.0
+Version: 1!9.3.2
 Summary: Python library to launch, interact, and snapshot cloud instances
 Home-page: https://github.com/canonical/pycloudlib
 Author: pycloudlib-devs

pycloudlib-1!9.3.2/VERSION

@@ -0,0 +1 @@
+1!9.3.2

{pycloudlib-1!9.3.0 → pycloudlib-1!9.3.2}/pycloudlib/ibm/cloud.py

@@ -86,6 +86,8 @@ class IBM(BaseCloud):
             authenticator=authenticator
         )
 
+        self._floating_ip_substring = self.config.get("floating_ip_substring")
+
     @property
     def resource_group_id(self) -> str:
         """Resource Group ID used to create new things under."""
@@ -305,8 +307,8 @@ class IBM(BaseCloud):
         vpc = vpc or self.vpc
         name = name or f"{self.tag}-vm{next(self.instance_counter)}"
 
-        floating_ip_substring = floating_ip_substring or self.config.get(
-            "floating_ip_substring"
+        floating_ip_substring = (
+            floating_ip_substring or self._floating_ip_substring
         )
 
         raw_instance = IBMInstance.create_raw_instance(

{pycloudlib-1!9.3.0 → pycloudlib-1!9.3.2}/pycloudlib/ibm/instance.py

@@ -652,7 +652,7 @@ class IBMInstance(BaseInstance):
         Raises:
             IBMException: If failed to attach floating IP after 10 tries
         """
-        attached_floating_ip = None
+        floating_ip_is_attached = None
         self._log.info(
             "Will attempt to attach floating ip with name containing: %s"
             "until successful or all floating ips are in use.",
@@ -660,7 +660,7 @@ class IBMInstance(BaseInstance):
         )
 
         tries = 0
-        while attached_floating_ip is None:
+        while not floating_ip_is_attached:
             tries += 1
             target_floating_ip = self._choose_from_existing_floating_ips(
                 name_includes=floating_ip_substring,
@@ -669,8 +669,10 @@ class IBMInstance(BaseInstance):
                 "Attempting to attach floating ip: %s",
                 target_floating_ip["name"],
             )
-            attached_floating_ip = self._attach_floating_ip(target_floating_ip)
-            if not attached_floating_ip:
+            floating_ip_is_attached = self._attach_floating_ip(
+                floating_ip=target_floating_ip
+            )
+            if not floating_ip_is_attached:
                 self._log.info(
                     "Failed to attach floating ip: %s. Will try again.",
                     target_floating_ip["name"],
@@ -960,7 +962,7 @@ class IBMInstance(BaseInstance):
 
     def _wait_for_instance_start(self, **kwargs):
         """Wait for the cloud instance to be up."""
-        # if self.b
+        self._log.info("Waiting for instance to finish provisioning.")
         self._wait_for_status(
             _Status.RUNNING,
             sleep_seconds=900,

{pycloudlib-1!9.3.0 → pycloudlib-1!9.3.2}/pycloudlib/instance.py

@@ -454,7 +454,8 @@ class BaseInstance(ABC):
             SSHException,
             OSError,
         ) as e:
-            raise SSHException from e
+            error_msg = f"{type(e).__name__}: {str(e)}"
+            raise SSHException(error_msg) from e
         self._ssh_client = client
         return client
 

{pycloudlib-1!9.3.0 → pycloudlib-1!9.3.2/pycloudlib.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pycloudlib
-Version: 1!9.3.0
+Version: 1!9.3.2
 Summary: Python library to launch, interact, and snapshot cloud instances
 Home-page: https://github.com/canonical/pycloudlib
 Author: pycloudlib-devs

{pycloudlib-1!9.3.0 → pycloudlib-1!9.3.2}/pycloudlib.egg-info/SOURCES.txt

@@ -75,6 +75,8 @@ tests/integration_tests/test_public_api.py
 tests/integration_tests/test_qemu.py
 tests/integration_tests/gce/__init__.py
 tests/integration_tests/gce/test_launch.py
+tests/integration_tests/ibm/__init__.py
+tests/integration_tests/ibm/test_launch.py
 tests/unit_tests/__init__.py
 tests/unit_tests/test_cloud.py
 tests/unit_tests/test_config.py
@@ -89,6 +91,7 @@ tests/unit_tests/gce/__init__.py
 tests/unit_tests/gce/test_cloud.py
 tests/unit_tests/ibm/__init__.py
 tests/unit_tests/ibm/test_cloud.py
+tests/unit_tests/ibm/test_instance.py
 tests/unit_tests/ibm/test_util.py
 tests/unit_tests/ibm_classic/__init__.py
 tests/unit_tests/ibm_classic/test_cloud.py

pycloudlib-1!9.3.2/tests/integration_tests/ibm/test_launch.py

@@ -0,0 +1,70 @@
+import os
+import pytest
+from pycloudlib.ibm.cloud import IBM
+from pycloudlib.ibm.instance import IBMInstance
+from google.cloud import compute_v1
+import time
+
+
+@pytest.fixture
+def ibm_cloud():
+    with IBM(tag="integration-test-launch") as ibm:
+        yield ibm
+
+
+def manage_ssh_key(ibm: IBM, key_name):
+    """Manage ssh keys for ibm instances."""
+    if key_name in ibm.list_keys():
+        ibm.delete_key(key_name)
+
+    pub_key_path = "ibm-pubkey"
+    priv_key_path = "ibm-privkey"
+    pub_key, priv_key = ibm.create_key_pair()
+
+    with open(pub_key_path, "w", encoding="utf-8") as f:
+        f.write(pub_key)
+
+    with open(priv_key_path, "w", encoding="utf-8") as f:
+        f.write(priv_key)
+
+    os.chmod(pub_key_path, 0o600)
+    os.chmod(priv_key_path, 0o600)
+
+    ibm.use_key(
+        public_key_path=pub_key_path,
+        private_key_path=priv_key_path,
+        name=key_name,
+    )
+
+
+def test_ibm_launch(ibm_cloud: IBM):
+    """
+    Test launching an IBM instance.
+
+    This tests the following:
+    - The instance is launched successfully
+    - The instance is reachable via SSH
+    - The instance has a floating IP as expected
+    - The instance name was set correctly
+    """
+    time_id = time.time_ns()
+    image_id = ibm_cloud.released_image("noble")
+    floating_ip_substring = (
+        ibm_cloud._floating_ip_substring or "default-floating-ip"
+    )
+    unique_instance_name = f"integration-test-launch-instance-{time_id}"
+    # create ssh_keys for use
+    manage_ssh_key(ibm_cloud, f"integration-test-key-{time_id}")
+    with ibm_cloud.launch(
+        image_id=image_id,
+        floating_ip_substring=floating_ip_substring,
+        name=unique_instance_name,
+    ) as inst:
+        inst: IBMInstance  # type hint for IDE
+        # wait for instance to come online
+        inst.wait()
+        # assert hostname is the same as the instance name
+        assert inst.execute("hostname").strip() == unique_instance_name
+        # assert that the instance has a floating IP as expected
+        assert inst._floating_ip is not None
+        assert floating_ip_substring in inst._floating_ip["name"]

pycloudlib-1!9.3.2/tests/unit_tests/ibm/test_instance.py

@@ -0,0 +1,81 @@
+"""Module for IBM instance tests."""
+
+import pytest
+from unittest import mock
+
+from pycloudlib.ibm.instance import IBMInstance, _IBMInstanceType
+
+SAMPLE_RAW_INSTANCE = {
+    "id": "ibm1",
+    "primary_network_interface": {"id": "nic1"},
+    "profile": {"name": "metal"},
+    "zone": {"name": "zone1"},
+}
+M_PATH = "pycloudlib.ibm.instance."
+
+
+class TestIBMInstance:
+    @pytest.mark.parametrize(
+        "raw_instance,inst_id,zone_id,inst_type",
+        (
+            (
+                SAMPLE_RAW_INSTANCE,
+                "ibm1",
+                "zone1",
+                _IBMInstanceType.BARE_METAL_SERVER,
+            ),
+        ),
+    )
+    @mock.patch(M_PATH + "VpcV1", autospec=True)
+    def test_type_from_raw_instance(
+        self, client, raw_instance, inst_id, zone_id, inst_type
+    ):
+        """Factory function inits the appropriate IBMInstanceType."""
+        inst = IBMInstance.from_raw_instance(
+            key_pair=None,
+            client=client,
+            instance=raw_instance,
+        )
+        assert client == inst._client
+        assert inst_id == inst.id
+        assert zone_id == inst.zone
+        assert inst_type == inst._ibm_instance_type
+
+    @mock.patch(M_PATH + "VpcV1", autospec=True)
+    def test_attach_floating_ip(self, client, caplog):
+        """
+        retry attach_floating_ip until VpcV1 lists non-empty floating_ips."""
+
+        inst = IBMInstance.from_raw_instance(
+            key_pair=None,
+            client=client,
+            instance=SAMPLE_RAW_INSTANCE,
+        )
+        metal_floating_ips = mock.Mock(
+            get_result=mock.Mock(
+                side_effect=[
+                    {"floating_ips": []},
+                    {
+                        "floating_ips": [
+                            {"id": "floatingid1", "name": "floatingname"}
+                        ]
+                    },
+                ]
+            )
+        )
+        with mock.patch.object(
+            client,
+            "list_bare_metal_server_network_interface_floating_ips",
+            return_value=metal_floating_ips,
+        ), mock.patch.object(
+            inst,
+            "_choose_from_existing_floating_ips",
+            return_value={"name": "ci-ip-match-5", "id": "floatingid1"},
+        ):
+            inst.attach_floating_ip(floating_ip_substring="ci-ip-match")
+        for expected_log in [
+            "Failed to attach floating ip: ci-ip-match-5.",
+            "Successfully attached floating ip: floatingname",
+        ]:
+            assert expected_log in caplog.text
+        assert 2 == metal_floating_ips.get_result.call_count

pycloudlib-1!9.3.0/VERSION

@@ -1 +0,0 @@
-1!9.3.0