Merge pull request #116 from stfc/Cover_edge_case_no_image

Rabbit consumers: Cover edge case of no image

Author: khalford

.pre-commit-config.yaml

@@ -0,0 +1,5 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+      - id: black

openstack-rabbit-consumer/rabbit_consumer/openstack_api.py

@@ -92,8 +92,15 @@ def get_image(vm_data: VmData) -> Optional[Image]:
     Gets the image name from Openstack for the virtual machine.
     """
     server = get_server_details(vm_data)
-    uuid = server.image.id
+
+    try:
+        # This is caused by the user booking from a volume or snapshot
+        uuid = server.image.id
+    except AttributeError:
+        uuid = None
+
     if not uuid:
+        logger.warning("No image or ID found for server %s", server.name)
         return None
 
     with OpenstackConnection() as conn:

openstack-rabbit-consumer/tests/test_openstack_api.py

@@ -159,3 +159,35 @@ def test_get_image_no_image_id(server_details, vm_data):
 
     result = get_image(vm_data)
     assert not result
+
+
+@patch("rabbit_consumer.openstack_api.get_server_details")
+def test_get_image_no_image(server_details, vm_data):
+    """
+    Tests that get image handles a None type image, since this
+    is another edge-case we've seen when a volume was used
+    """
+    server_details.return_value = NonCallableMock()
+    server_details.return_value.image = None
+
+    result = get_image(vm_data)
+    assert not result
+
+
+@patch("rabbit_consumer.openstack_api.OpenstackConnection")
+@patch("rabbit_consumer.openstack_api.get_server_details")
+def test_get_image_valid_data(server_details, conn, vm_data):
+    """
+    Tests that get image handles a valid image
+    """
+    server_details.return_value = NonCallableMock()
+    server_details.return_value.image.id = "UUID-1234"
+
+    openstack_connection = conn.return_value.__enter__.return_value
+    find_image_result = NonCallableMock()
+    openstack_connection.compute.find_image.return_value = find_image_result
+
+    result = get_image(vm_data)
+
+    openstack_connection.compute.find_image.assert_called_once_with("UUID-1234")
+    assert result == find_image_result

openstack-rabbit-consumer/version.txt

@@ -1 +1 @@
-3.2.0
+3.2.1