Support for Listeners in object/mapping format

Author: JohnPreston

docs/syntax/compose_x/elbv2.rst

@@ -135,6 +135,55 @@ Similar syntax as for ECS Services Ingress, allow you to define Ingress. See the
 Listeners
 =========
 
+.. hint::
+
+    Since version 1.1.8 you can define the listeners with a mapping, key being the port. For example
+
+    .. code-block::
+
+        x-elbv2:
+          lbA:
+            Properties:
+              Type: application
+              Scheme: internet-facing
+            DnsAliases:
+              - Route53Zone: x-route53::public-domain-01
+                Names:
+                  - test.bdd-testing.compose-x.io
+                  - someother.test.bdd-testing.compose-x.io
+            Settings:
+             S3Logs: bucket:/prefix
+             timeout_seconds: 60
+             desync_mitigation_mode: defensive
+             drop_invalid_header_fields: True
+             http2: False
+             cross_zone: True
+            Listeners:
+              80:
+                Protocol: HTTP
+                DefaultActions:
+                  - Redirect: HTTP_TO_HTTPS
+              443:
+                Protocol: HTTP
+                Certificates:
+                  - x-acm: public-acm-01
+                Targets:
+                  - name: bignicefamily:app01
+                    access: /somewhere
+              8080:
+                Protocol: HTTP
+                Certificates:
+                  - x-acm: public-acm-01
+                  - CertificateArn: arn:aws:acm:eu-west-1:012345678912:certificate/102402a1-d0d2-46ff-b26b-33008f072ee8
+                Targets:
+                  - name: bignicefamily:rproxy
+                    access: /
+                  - name: youtoo:rproxy
+                    access: /stupid
+                  - name: bignicefamily:app01
+                    access: thereisnospoon.ews-network.net:8080/abcd
+
+
 You can define in a very simple way your `Listener definition`_ and cross-reference other resources, here, the services
 and ACM certificates you might be creating.
 
@@ -149,6 +198,10 @@ The following properties are identical to the original CFN definition.
 
 `JSON Schema definition <https://github.com/compose-x/ecs_composex_specs/blob/main/ecs_composex_specs/x-elbv2.spec.json#L82>`__
 
+.. note::
+
+    When using the dict/object format for Listener ports, the ``Port`` property defined is ignored as to avoid having conflicting values.
+
 .. hint::
 
     For certificates, you can also use **x-acm** to refer to an ACM certificate you are creating with this stack.

ecs_composex/elbv2/elbv2_stack/elbv2.py

@@ -8,6 +8,7 @@
 import ecs_composex.common.troposphere_tools
 
 if TYPE_CHECKING:
+    from troposphere import Template
     from ecs_composex.mods_manager import XResourceModule
     from ecs_composex.common.settings import ComposeXSettings
 
@@ -133,34 +134,56 @@ def init_outputs(self):
         }
 
     def set_listeners_from_list(self, listeners: list[dict], template) -> None:
+        """Transforms the list of listeners into a dict format."""
         ports = [listener["Port"] for listener in listeners]
         validate_listeners_duplicates(self.name, ports)
-        for listener_def in listeners:
+        dict_definition: dict[int, dict] = {}
+        for _def in listeners:
+            _port = int(_def["Port"])
+            del _def["Port"]
+            dict_definition[_port] = _def
+
+        self.set_listeners_from_dict(dict_definition, template)
+
+    def _define_targets(self, targets: list[dict]) -> None:
+        """
+        Validates the targets definitions is correct
+
+        :raises: ValueError if the defined listener target does not comply to the LISTENER_TARGET_RE regex
+        """
+        for target in targets:
+            target_parts = LISTENER_TARGET_RE.match(target["name"])
+            if not target_parts:
+                raise ValueError(
+                    f"{self.module.res_key}.{self.name} - Listener {listener_def['Port']}"
+                    f" - Target {target['name']} is not a valid value. Must match",
+                    LISTENER_TARGET_RE.pattern,
+                )
+            simple_family: str = (
+                f"{target_parts.group('family')}:{target_parts.group('container')}"
+            )
+            family_id: str = (
+                simple_family + ":" + target_parts.group("port")
+                if target_parts.group("port")
+                else simple_family
+            )
+            if family_id not in self.services:
+                listener_def["Targets"].remove(target)
+
+    def set_listeners_from_dict(self, listeners: dict, template: Template) -> None:
+        """
+        Creates ComposeListener objects from the definition within x-elbv2.<LB>
+
+        """
+        for port, listener_def in listeners.items():
             targets: list[dict] = set_else_none("Targets", listener_def, [])
             if targets and self.services:
-                for target in targets:
-                    target_parts = LISTENER_TARGET_RE.match(target["name"])
-                    if not target_parts:
-                        raise ValueError(
-                            f"{self.module.res_key}.{self.name} - Listener {listener_def['Port']}"
-                            f" - Target {target['name']} is not a valid value. Must match",
-                            LISTENER_TARGET_RE.pattern,
-                        )
-                    simple_family: str = (
-                        f"{target_parts.group('family')}:{target_parts.group('container')}"
-                    )
-                    family_id: str = (
-                        simple_family + ":" + target_parts.group("port")
-                        if target_parts.group("port")
-                        else simple_family
-                    )
-                    if family_id not in self.services:
-                        listener_def["Targets"].remove(target)
+                self._define_targets(targets)
             if keyisset("Targets", listener_def) or keyisset(
                 "DefaultActions", listener_def
             ):
                 new_listener = template.add_resource(
-                    ComposeListener(self, listener_def)
+                    ComposeListener(self, int(port), listener_def)
                 )
                 self.new_listeners.append(new_listener)
             else:
@@ -184,8 +207,12 @@ def set_listeners(self, template):
             )
         if isinstance(listeners, list):
             self.set_listeners_from_list(listeners, template)
+        elif isinstance(listeners, dict):
+            self.set_listeners_from_dict(listeners, template)
         else:
-            raise TypeError("Listeners not yet supported as a mapping.")
+            raise TypeError(
+                "Listeners must be one of [list, dict]. Got", type(listeners)
+            )
 
     def find_lookup_listeners(self):
         """

ecs_composex/elbv2/elbv2_stack/elbv2_listener/__init__.py

@@ -49,22 +49,24 @@ class ComposeListener(Listener):
 
     targets_keys = "Targets"
 
-    def __init__(self, lb: Elbv2, definition):
+    def __init__(self, lb: Elbv2, port: int, definition: dict):
         """
         Method to init listener.
 
         :param ecs_composex.elbv2.elbv2_stack.elbv2.Elbv2 lb:
         :param dict definition:
         """
         self._lb = lb
+        self._port: int = port
         self.definition = deepcopy(definition)
-        straight_import_keys = ["Port", "Protocol", "SslPolicy", "AlpnPolicy"]
+        straight_import_keys = ["Protocol", "SslPolicy", "AlpnPolicy"]
         listener_kwargs = {
             x: self.definition[x] for x in straight_import_keys if x in self.definition
         }
         listener_kwargs.update(
             {x: self.definition[x] for x in self.attributes if x in self.definition}
         )
+        listener_kwargs.update({"Port": port})
         self.services = (
             self.definition[self.targets_keys]
             if keyisset(self.targets_keys, self.definition)
@@ -103,7 +105,7 @@ def __init__(self, lb: Elbv2, definition):
 
     @property
     def def_port(self) -> int:
-        return int(self.definition["Port"])
+        return self._port
 
     @property
     def lb(self) -> Elbv2:

ecs_composex/elbv2/x-elbv2.spec.json

@@ -92,8 +92,8 @@
         {
           "type": "object",
           "patternProperties": {
-            "x-": {},
-            "[0-9]{1,6}": {
+            "^x-": {},
+            "[0-9]{1,7}": {
               "$ref": "#/definitions/ListenerV2"
             }
           }
@@ -517,6 +517,9 @@
     },
     "ListenerV2": {
       "type": "object",
+      "patternProperties": {
+        "^x-": {}
+      },
       "oneOf": [
         {
           "required": [

use-cases/elbv2/create_acm_parameters.yml

@@ -33,18 +33,18 @@ x-elbv2:
      http2: False
      cross_zone: True
     Listeners:
-      - Port: 80
+      80:
         Protocol: HTTP
         DefaultActions:
           - Redirect: HTTP_TO_HTTPS
-      - Port: 443
+      443:
         Protocol: HTTP
         Certificates:
           - x-acm: public-acm-01
         Targets:
           - name: bignicefamily:app01
             access: /somewhere
-      - Port: 8080
+      8080:
         Protocol: HTTP
         Certificates:
           - x-acm: public-acm-01