Feat(eos_designs): Add a future knob to raise when a L3 port-channel is configured without members (#6707)

Co-authored-by: Carl Baillargeon <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 3 people

ansible_collections/arista/avd/extensions/molecule/eos_designs_negative_unit_tests/inventory/host_vars/l3-port-channel-without-member-interfaces.yml

@@ -0,0 +1,19 @@
+---
+avd_design_future:
+  raise_for_port_channels_without_members: true
+
+type: l3leaf
+l3leaf:
+  nodes:
+    - bgp_as: 65000
+      name: l3-port-channel-without-member-interfaces
+      id: 1
+      loopback_ipv4_pool: 192.168.0.0/24
+      vtep_loopback_ipv4_pool: 192.168.1.0/24
+      l3_port_channels:
+        # No member interfaces
+        - name: Port-Channel5
+          ip_address: 172.16.0.2/30
+
+expected_error_message: >-
+  L3 Port-Channel 'Port-Channel5' must have at least one member interface defined.

ansible_collections/arista/avd/extensions/molecule/eos_designs_negative_unit_tests/inventory/host_vars/net-srv-l3-po-without-member-interfaces.yml

@@ -0,0 +1,25 @@
+---
+avd_design_future:
+  raise_for_port_channels_without_members: true
+
+type: l3leaf
+l3leaf:
+  nodes:
+    - bgp_as: 65000
+      name: net-srv-l3-po-without-member-interfaces
+      id: 1
+      loopback_ipv4_pool: 192.168.0.0/24
+      vtep_loopback_ipv4_pool: 192.168.1.0/24
+
+tenants:
+  - name: TENANT1
+    vrfs:
+      - name: VRF1
+        l3_port_channels:
+          # No member interfaces
+          - name: Port-Channel10
+            node: net-srv-l3-po-without-member-interfaces
+            ip_address: 10.0.0.1/30
+
+expected_error_message: >-
+  L3 Port-Channel 'Port-Channel10' must have at least one member interface defined.

ansible_collections/arista/avd/extensions/molecule/eos_designs_negative_unit_tests/inventory/hosts.yml

@@ -354,6 +354,7 @@ all:
             l3-port-channel-no-ip-address-subif:
             l3-port-channel-sub-interface-with-member-interfaces:
             l3-port-channel-sub-interface-with-mode:
+            l3-port-channel-without-member-interfaces:
             management-eapi-vrf-name-use-inband-mgmt-vrf:
             missing-application-classification-application-profile:
             missing-application-classification-category:
@@ -439,6 +440,7 @@ all:
             net-srv-l3-po-sub-interface-with-mtu:
             net-srv-l3-po-sub-interface-without-ip:
             net-srv-l3-po-sub-interface-without-main-po:
+            net-srv-l3-po-without-member-interfaces:
             network-services-l2vlan-pvlan-missing-primary:
             network-services-l2vlan-pvlan-platform-disabled:
             ntp-settings-server-vrf-missing-inband-mgmt-interface:

ansible_collections/arista/avd/roles/eos_designs/docs/tables/avd-design-future.md

@@ -16,3 +16,8 @@ keys:
         description: |-
           Deactivate the IPv4 unicast Address Family for BGP Peer Groups only when IPv4 is activated by default instead of always deactivating it.
         default: false
+      raise_for_port_channels_without_members:
+        type: bool
+        description: |-
+          Raise an error if an L3 Port-Channel is configured without any member interfaces.
+        default: false

python-avd/pyavd/_eos_designs/schema/__init__.py

@@ -55,10 +55,8 @@ def _set_l3_port_channels(
         """
         for vrf in tenant.vrfs:
             for l3_port_channel in vrf.l3_port_channels:
-                is_subinterface = "." in l3_port_channel.name
-
-                # Validation for l3_port_channel subinterface
-                if is_subinterface:
+                if is_subinterface := "." in l3_port_channel.name:
+                    # Validation for l3_port_channel subinterface
                     if l3_port_channel.member_interfaces:
                         msg = f"L3 Port-Channel sub-interface '{l3_port_channel.name}' has 'member_interfaces' set. This is not a valid setting."
                         raise AristaAvdInvalidInputsError(msg)
@@ -70,6 +68,10 @@ def _set_l3_port_channels(
                         # implies 'mtu' is set when not applicable for a sub-interface
                         msg = f"L3 Port-Channel sub-interface '{l3_port_channel.name}' has 'mtu' set. This is not a valid setting."
                         raise AristaAvdInvalidInputsError(msg)
+                elif self.inputs.avd_design_future.raise_for_port_channels_without_members and not l3_port_channel.member_interfaces:
+                    # Validation: Non-subinterface port-channels must have at least one member interface
+                    msg = f"L3 Port-Channel '{l3_port_channel.name}' must have at least one member interface defined."
+                    raise AristaAvdInvalidInputsError(msg)
 
                 if not (interface_description := l3_port_channel.description):
                     interface_description = "_".join(filter(None, [l3_port_channel.peer, l3_port_channel.peer_port_channel]))

python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml

@@ -124,15 +124,19 @@ def _set_l3_port_channel(
         self: AvdStructuredConfigUnderlayProtocol, l3_port_channel: EosDesigns._DynamicKeys.DynamicNodeTypesItem.NodeTypes.NodesItem.L3PortChannelsItem
     ) -> None:
         """Set structured_configuration for one L3 Port-Channel."""
-        # Validation for l3_port_channel subinterface
         if "." in l3_port_channel.name:
+            # Validation for l3_port_channel subinterface
             if l3_port_channel.member_interfaces:
                 msg = f"L3 Port-Channel sub-interface '{l3_port_channel.name}' has 'member_interfaces' set. This is not a valid setting."
                 raise AristaAvdInvalidInputsError(msg)
             if l3_port_channel._get("mode"):
                 # Implies 'mode' is set when not applicable for a sub-interface.
                 msg = f"L3 Port-Channel sub-interface '{l3_port_channel.name}' has 'mode' set. This is not a valid setting."
                 raise AristaAvdInvalidInputsError(msg)
+        # Validation: Non-subinterface port-channels must have at least one member interface
+        elif self.inputs.avd_design_future.raise_for_port_channels_without_members and not l3_port_channel.member_interfaces:
+            msg = f"L3 Port-Channel '{l3_port_channel.name}' must have at least one member interface defined."
+            raise AristaAvdInvalidInputsError(msg)
 
         # build common portion of the interface cfg
         interface = self._get_l3_common_interface_cfg(l3_port_channel)