Add support for overriding AqMetadata tags from VM meta

Adds support to the dataclass for overriding tags based on VM Metadata.
We also map a sandbox reference back to a domain instead

Author: DavidFair

OpenStack-Rabbit-Consumer/rabbit_consumer/aq_api.py

@@ -8,7 +8,7 @@
 from urllib3.util.retry import Retry
 
 from rabbit_consumer.consumer_config import ConsumerConfig
-from rabbit_consumer.build_metadata import AqMetadata
+from rabbit_consumer.aq_metadata import AqMetadata
 from rabbit_consumer.openstack_address import OpenstackAddress
 from rabbit_consumer.rabbit_message import RabbitMessage
 from rabbit_consumer.vm_data import VmData

OpenStack-Rabbit-Consumer/rabbit_consumer/aq_metadata.py

@@ -0,0 +1,45 @@
+import logging
+from dataclasses import dataclass
+from typing import Dict
+
+from mashumaro import DataClassDictMixin
+from mashumaro.config import BaseConfig
+
+logger = logging.getLogger(__name__)
+
+
+@dataclass
+class AqMetadata(DataClassDictMixin):
+    """
+    Deserialised metadata that is set either on an Openstack image
+    or a VM's metadata
+    """
+
+    aq_archetype: str
+    # Aq domain can hold either a domain or sandbox reference
+    aq_domain: str
+
+    aq_personality: str
+    aq_os_version: str
+    aq_os: str
+
+    class Config(BaseConfig):
+        aliases = {
+            "aq_archetype": "AQ_ARCHETYPE",
+            "aq_domain": "AQ_DOMAIN",
+            "aq_personality": "AQ_PERSONALITY",
+            "aq_os_version": "AQ_OSVERSION",
+            "aq_os": "AQ_OS",
+        }
+
+    def override_from_vm_meta(self, vm_meta: Dict[str, str]):
+        """
+        Overrides the values in the metadata with the values from the VM's
+        metadata
+        """
+        for attr, alias in self.Config.aliases.items():
+            if alias in vm_meta:
+                setattr(self, attr, vm_meta[alias])
+
+        if "AQ_SANDBOX" in vm_meta:
+            self.aq_domain = vm_meta["AQ_SANDBOX"]

OpenStack-Rabbit-Consumer/rabbit_consumer/build_metadata.py

@@ -9,7 +9,7 @@
 from rabbit_consumer import openstack_api
 from rabbit_consumer.aq_api import verify_kerberos_ticket
 from rabbit_consumer.consumer_config import ConsumerConfig
-from rabbit_consumer.build_metadata import AqMetadata
+from rabbit_consumer.aq_metadata import AqMetadata
 from rabbit_consumer.openstack_address import OpenstackAddress
 from rabbit_consumer.rabbit_message import RabbitMessage, MessageEventType
 from rabbit_consumer.vm_data import VmData

OpenStack-Rabbit-Consumer/rabbit_consumer/message_consumer.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from rabbit_consumer.build_metadata import AqMetadata
+from rabbit_consumer.aq_metadata import AqMetadata
 from rabbit_consumer.openstack_address import OpenstackAddress
 from rabbit_consumer.rabbit_message import RabbitMessage, RabbitMeta, RabbitPayload
 from rabbit_consumer.vm_data import VmData

OpenStack-Rabbit-Consumer/test/fixtures.py

@@ -0,0 +1,75 @@
+from typing import Dict
+
+import pytest
+
+from rabbit_consumer.aq_metadata import AqMetadata
+
+
+@pytest.fixture(name="image_metadata")
+def fixture_image_metadata() -> Dict[str, str]:
+    """
+    Creates a dictionary with mock data
+    which represents an example OpenStack image's metadata
+    """
+    return {
+        "AQ_ARCHETYPE": "archetype_mock",
+        "AQ_DOMAIN": "domain_mock",
+        "AQ_PERSONALITY": "personality_mock",
+        "AQ_OS": "os_mock",
+        "AQ_OSVERSION": "osversion_mock",
+    }
+
+
+def test_aq_metadata_from_initial_dict(image_metadata):
+    """
+    Tests creating an AQ metadata object from an initial dictionary
+    """
+    returned = AqMetadata.from_dict(image_metadata)
+
+    assert returned.aq_archetype == "archetype_mock"
+    assert returned.aq_domain == "domain_mock"
+    assert returned.aq_personality == "personality_mock"
+    assert returned.aq_os == "os_mock"
+    assert returned.aq_os_version == "osversion_mock"
+
+
+def test_aq_metadata_override_all(image_metadata):
+    """
+    Tests overriding all values in an AQ metadata object
+    """
+    returned = AqMetadata.from_dict(image_metadata)
+    returned.override_from_vm_meta(
+        {
+            "AQ_ARCHETYPE": "archetype_mock_override",
+            "AQ_DOMAIN": "domain_mock_override",
+            "AQ_PERSONALITY": "personality_mock_override",
+        }
+    )
+
+    assert returned.aq_archetype == "archetype_mock_override"
+    assert returned.aq_domain == "domain_mock_override"
+    assert returned.aq_personality == "personality_mock_override"
+
+    # Check the original values are still there
+    assert returned.aq_os == "os_mock"
+    assert returned.aq_os_version == "osversion_mock"
+
+
+def test_aq_metadata_override_sandbox(image_metadata):
+    """
+    Tests overriding the sandbox value in an AQ metadata object
+    maps correctly onto the domain value
+    """
+    returned = AqMetadata.from_dict(image_metadata)
+    returned.override_from_vm_meta(
+        {
+            "AQ_SANDBOX": "sandbox_mock",
+        }
+    )
+    # This should be the only value that has changed
+    assert returned.aq_domain == "sandbox_mock"
+
+    assert returned.aq_archetype == "archetype_mock"
+    assert returned.aq_personality == "personality_mock"
+    assert returned.aq_os == "os_mock"
+    assert returned.aq_os_version == "osversion_mock"