Adds to AMI Access Endpoint URL used for aws marketplace

docs/model/ami.rst

@@ -11,4 +11,7 @@ Push items: AMI
    :members:
 
 .. autoclass:: pushsource.AmiSecurityGroup()
+   :members:
+
+.. autoclass:: pushsource.AmiAccessEndpointUrl()
    :members:

src/pushsource/__init__.py

@@ -21,6 +21,7 @@
     VMIRelease,
     AmiPushItem,
     AmiRelease,
+    AmiAccessEndpointUrl,
     AmiBillingCodes,
     AmiSecurityGroup,
     VHDPushItem,

src/pushsource/_impl/backend/staged/staged_ami.py

@@ -77,6 +77,7 @@ def __push_item(self, leafdir, metadata, entry):
             "user_name",
             "version_title",
             "security_groups",
+            "access_endpoint_url",
         ]
 
         for key in image_attrs:

src/pushsource/_impl/model/__init__.py

@@ -22,6 +22,12 @@
 from .modulemd import ModuleMdPushItem, ModuleMdSourcePushItem
 from .comps import CompsXmlPushItem
 from .productid import ProductIdPushItem
-from .ami import AmiPushItem, AmiRelease, AmiBillingCodes, AmiSecurityGroup
+from .ami import (
+    AmiPushItem,
+    AmiRelease,
+    AmiAccessEndpointUrl,
+    AmiBillingCodes,
+    AmiSecurityGroup,
+)
 from .azure import VHDPushItem
 from .vms import BootMode, VMIPushItem, VMIRelease

src/pushsource/_impl/model/ami.py

@@ -92,6 +92,27 @@ def _from_data(cls, data):
         return cls(**kwargs)
 
 
+@attr.s()
+class AmiAccessEndpointUrl(object):
+    """Access Endpoint URL to be associated with a Marketplace VM."""
+
+    port = attr.ib(type=int, validator=instance_of(int))
+    """Port to access the endpoint URL."""
+
+    protocol = attr.ib(type=str, validator=instance_of_str)
+    """Protocol to access the endpoint URL (http, https)."""
+
+    @classmethod
+    def _from_data(cls, data):
+        """Instantiate AccessEndpointUrl from raw dict"""
+
+        kwargs = {
+            "port": data["port"],
+            "protocol": data["protocol"],
+        }
+        return cls(**kwargs)
+
+
 @attr.s()
 class AmiPushItem(VMIPushItem):
     """A :class:`~pushsource.PushItem` representing an Amazon Machine Image (or "AMI").
@@ -180,6 +201,13 @@ class AmiPushItem(VMIPushItem):
     )
     """Automatically created security groups for the product. """
 
+    access_endpoint_url = attr.ib(
+        type=AmiAccessEndpointUrl,
+        default=None,
+        validator=optional(instance_of(AmiAccessEndpointUrl)),
+    )
+    """Access endpoint url associated with this image."""
+
     @classmethod
     def _from_data(cls, data):
         """Instantiate AmiPushItem from raw list or dict"""
@@ -224,6 +252,11 @@ def _from_data(cls, data):
                 AmiSecurityGroup._from_data(security_group)
                 for security_group in (data.get("security_groups") or [])
             ],
+            "access_endpoint_url": (
+                AmiAccessEndpointUrl._from_data(data.get("access_endpoint_url"))
+                if data.get("access_endpoint_url")
+                else None
+            ),
         }
 
         return cls(**kwargs)

src/pushsource/_impl/schema/staged-schema.yaml

@@ -173,6 +173,18 @@ definitions:
                                 minimum: 0
                                 maximum: 65536
 
+            access_endpoint_url:
+                type:
+                - object
+                - "null"
+                properties:
+                    port:
+                        type: number
+                        minimum: 0
+                        maximum: 65536
+                    protocol:
+                        enum: ["http", "https"]
+
         required:
         - release
         - region

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

@@ -9,6 +9,7 @@ url: "staged:{{ src_dir }}/tests/staged/data/simple_ami_with_bc"
 # Push items generated from above.
 items:
 - AmiPushItem:
+    access_endpoint_url: null
     billing_codes:
       codes:
       - bp-1234

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

@@ -9,6 +9,7 @@ url: "staged:{{ src_dir }}/tests/staged/data/simple_ami_with_bootmode"
 # Push items generated from above.
 items:
 - AmiPushItem:
+    access_endpoint_url: null
     billing_codes: null
     boot_mode: uefi
     build: null

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

@@ -9,6 +9,7 @@ url: "staged:{{ src_dir }}/tests/staged/data/simple_ami_with_uefi"
 # Push items generated from above.
 items:
 - AmiPushItem:
+    access_endpoint_url: null
     billing_codes: null
     boot_mode: null
     build: null

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

@@ -9,6 +9,7 @@ url: "staged:{{ src_dir }}/tests/staged/data/simple_ami"
 # Push items generated from above.
 items:
 - AmiPushItem:
+    access_endpoint_url: null
     billing_codes: null
     boot_mode: null
     build: null

tests/pub/data/123456/images.json

@@ -43,7 +43,11 @@
       "security_groups": [
         {"from_port":10, "ip_protocol": "udp", "ip_ranges":["8.1.8.8"], "to_port":90},
         {"from_port":11, "ip_protocol": "tcp", "ip_ranges":["8.2.8.8"], "to_port":91}
-      ]
+      ],
+      "access_endpoint_url": {
+        "port": 10,
+        "protocol": "http"
+      }
 
     }
 ]

tests/pub/data/200/images.json

@@ -33,7 +33,11 @@
     "type": "hourly", 
     "virtualization": "hvm", 
     "volume": "gp2",
-    "security_groups": [{"from_port":-1, "ip_protocol": "icmpv6", "ip_ranges":["255.255.255.255"], "to_port":255}]
+    "security_groups": [{"from_port":-1, "ip_protocol": "icmpv6", "ip_ranges":["255.255.255.255"], "to_port":255}],
+    "access_endpoint_url": {
+      "port": 10,
+      "protocol": "https"
+    }
 
   }, 
   {
@@ -70,7 +74,11 @@
     "type": "hourly", 
     "virtualization": "hvm", 
     "volume": "gp2",
-    "security_groups": [{"from_port":1, "ip_protocol": "icmp", "ip_ranges":["1.1.1.1"], "to_port":10}]
+    "security_groups": [{"from_port":1, "ip_protocol": "icmp", "ip_ranges":["1.1.1.1"], "to_port":10}],
+    "access_endpoint_url": {
+      "port": 10,
+      "protocol": "http"
+    }
 
   }
 ]

tests/pub/test_pub_amis.py

@@ -6,6 +6,7 @@
 import requests
 
 from pushsource import (
+    AmiAccessEndpointUrl,
     AmiBillingCodes,
     AmiPushItem,
     AmiRelease,
@@ -90,6 +91,7 @@ def test_get_ami_push_items_single_task(requests_mock):
                     from_port=11, ip_protocol="tcp", ip_ranges=["8.2.8.8"], to_port=91
                 ),
             ],
+            access_endpoint_url=AmiAccessEndpointUrl(port=10, protocol="http"),
         )
     ]
 
@@ -148,6 +150,7 @@ def test_get_ami_push_items_multiple_tasks(requests_mock):
             ena_support=True,
             billing_codes=AmiBillingCodes(name="Hourly2", codes=["bp-fake"]),
             image_id="ami-fake-100",
+            access_endpoint_url=None,
         ),
         AmiPushItem(
             name="RHEL-SAP-8.4.0_HVM-20230109-x86_64-0-Hourly2-GP2",
@@ -196,6 +199,7 @@ def test_get_ami_push_items_multiple_tasks(requests_mock):
                     from_port=11, ip_protocol="tcp", ip_ranges=["8.2.8.8"], to_port=91
                 ),
             ],
+            access_endpoint_url=AmiAccessEndpointUrl(port=10, protocol="http"),
         ),
         AmiPushItem(
             name="RHEL-SAP-8.4.0_HVM-20230109-x86_64-0-Hourly2-GP2",
@@ -237,6 +241,7 @@ def test_get_ami_push_items_multiple_tasks(requests_mock):
                     to_port=255,
                 )
             ],
+            access_endpoint_url=AmiAccessEndpointUrl(port=10, protocol="https"),
         ),
         AmiPushItem(
             name="RHEL-SAP-8.4.0_HVM-20230109-x86_64-0-Hourly2-GP2",
@@ -275,6 +280,7 @@ def test_get_ami_push_items_multiple_tasks(requests_mock):
                     from_port=1, ip_protocol="icmp", ip_ranges=["1.1.1.1"], to_port=10
                 )
             ],
+            access_endpoint_url=AmiAccessEndpointUrl(port=10, protocol="http"),
         ),
     ]