Add optional property "cloud_info" for VMIs (#637)

This commit introduces a new optional property for all VMIPushItems
named `VMICloudInformation` which stores the cloud's provider name and
account alias into it.

The goal of this change is to be able to parse the patched `clouds.json`
with this new property, which was introduced in
release-engineering/pubtools-marketplacesvm#71 ,
allowing the DeleteTask to have a more reliable way to retrieve the
provider/account information.

Refers to SPSTRAT-363

---------

Co-authored-by: Rohan McGovern <[email protected]>

Author: JAVGan

docs/model/vmi.rst

@@ -7,5 +7,8 @@ Push items: VMI
 .. autoclass:: pushsource.VMIRelease()
    :members:
 
+.. autoclass:: pushsource.VMICloudInfo()
+   :members:
+
 .. autoclass:: pushsource.BootMode()
    :members:

src/pushsource/__init__.py

@@ -26,6 +26,7 @@
     AmiBillingCodes,
     AmiSecurityGroup,
     VHDPushItem,
+    VMICloudInfo,
     BootMode,
     ErratumPushItem,
     ErratumReference,

src/pushsource/_impl/model/__init__.py

@@ -30,4 +30,4 @@
     AmiSecurityGroup,
 )
 from .azure import VHDPushItem
-from .vms import BootMode, VMIPushItem, VMIRelease
+from .vms import BootMode, VMICloudInfo, VMIPushItem, VMIRelease

src/pushsource/_impl/model/ami.py

@@ -2,7 +2,7 @@
 
 from .. import compat_attr as attr
 from .conv import instance_of_str, instance_of, optional_str, optional
-from .vms import VMIRelease, VMIPushItem, BootMode
+from .vms import VMICloudInfo, VMIRelease, VMIPushItem, BootMode
 
 
 class AmiRelease(VMIRelease):
@@ -219,6 +219,11 @@ def _from_data(cls, data):
             # base push item fields
             "name": data["name"],
             "build": data.get("build") or None,
+            "cloud_info": (
+                VMICloudInfo(**data.get("cloud_info"))
+                if data.get("cloud_info")
+                else None
+            ),
             "state": "PENDING",
             "src": data.get("src") or None,
             "dest": data.get("dest") or [],

src/pushsource/_impl/model/vms.py

@@ -24,6 +24,26 @@ def __repr__(self):
         return f"{cls_name}.{self.name}"
 
 
+@attr.s()
+class VMICloudInfo(object):
+    """Information on the cloud provider associated with a given push item.
+
+    Cloud provider information is only available for VMIs which have previously
+    been published to a cloud. It may be used to locate an existing VMI for
+    manipulation, such as metadata updates or deletion.
+
+    This library doesn't define any specific cloud provider names or aliases.
+    Generally, a user of this library is expected to use the information here
+    to look up cloud access details from a configuration file or other source.
+    """
+
+    provider = attr.ib(type=str, validator=instance_of_str)
+    """The cloud provider's name, e.g.: "aws"."""
+
+    account = attr.ib(type=str, validator=instance_of_str)
+    """The cloud provider's account alias, e.g.: "aws-na"."""
+
+
 @attr.s()
 class VMIRelease(object):
     """Release metadata associated with a VM image."""
@@ -79,6 +99,13 @@ class VMIPushItem(PushItem):
     boot_mode = attr.ib(type=BootMode, default=None, validator=optional(in_(BootMode)))
     """Boot mode supported by the image (if known): uefi, legacy, or hybrid (uefi + legacy)."""
 
+    cloud_info = attr.ib(
+        type=VMICloudInfo,
+        default=None,
+        validator=optional((instance_of(VMICloudInfo))),
+    )
+    """Cloud provider information, such as the provider's short name and account alias."""
+
     marketplace_title_template = attr.ib(type=str, default=None, validator=optional_str)
     """The template is of the form used by ``str.format``, with available keywords being all of
     the documented fields on ``VMIRelease`` and ``AMIRelease`` classes.

tests/baseline/cases/staged-simple-ami-bc.yml

@@ -18,6 +18,7 @@ items:
     boot_mode: null
     build: null
     build_info: null
+    cloud_info: null
     description: A sample image for testing
     dest:
     - dest1

tests/baseline/cases/staged-simple-ami-bootmode.yml

@@ -14,6 +14,7 @@ items:
     boot_mode: uefi
     build: null
     build_info: null
+    cloud_info: null
     description: A sample image for testing
     dest:
     - dest1

tests/baseline/cases/staged-simple-ami-uefi.yml

@@ -14,6 +14,7 @@ items:
     boot_mode: null
     build: null
     build_info: null
+    cloud_info: null
     description: A sample image for testing
     dest:
     - dest1

tests/baseline/cases/staged-simple-ami.yml

@@ -14,6 +14,7 @@ items:
     boot_mode: null
     build: null
     build_info: null
+    cloud_info: null
     description: A sample image for testing
     dest:
     - dest1

tests/baseline/cases/staged-simple-cloud.yml

@@ -18,6 +18,7 @@ items:
       name: rhel
       release: '1'
       version: '9.4'
+    cloud_info: null
     description: build2 sample
     dest:
     - starmap
@@ -68,6 +69,7 @@ items:
       name: rhel
       release: '1'
       version: '9.4'
+    cloud_info: null
     description: build2 sample
     dest:
     - starmap
@@ -118,6 +120,7 @@ items:
       name: rhel-ec2
       release: '1'
       version: '9.4'
+    cloud_info: null
     description: build3 sample
     dest:
     - starmap
@@ -166,6 +169,7 @@ items:
       name: rhel-ec2
       release: '1'
       version: '9.4'
+    cloud_info: null
     description: build1 sample
     dest:
     - starmap
@@ -203,6 +207,7 @@ items:
       name: rhel-ec2
       release: '1'
       version: '9.4'
+    cloud_info: null
     description: build1 sample
     dest:
     - starmap