Cumulus_NVUE: Add gateway support

* Anycast ipv4 (ipv6 also configured if provided, module officially only supports ipv4)
* VRRPv3 ipv4 and ipv6

* Comment out ipv6 addresses in VRRP test case (requires OSPFv3 which Cumulus NVUE does not support)
* Add VRRP ipv6 test case (issue with multiple ipv6 default routes popping up)

Author: jbemmel

docs/module/gateway.md

@@ -25,7 +25,8 @@ The module is supported on these platforms:
 | Cisco CSR 1000v       |  ❌  | ✅  | ✅  |
 | Cisco IOSv/IOSvL2     |  ❌  | ✅  | ✅  |
 | Cisco Nexus OS        |  ❌  | ✅  | ✅  |
-| Cumulus Linux         | ✅  | ✅  | ✅  |
+| Cumulus Linux 4.x     | ✅  | ✅  | ✅  |
+| Cumulus 5.x (NVUE)    | ✅ | ✅ |  ✅ |
 | Dell OS10             | ✅ [❗](caveats-os10) | ✅ [❗](caveats-os10) | ✅ [❗](caveats-os10)  |
 | FRRouting             | ✅  | ✅  | ✅  |
 | Nokia SR OS           | ✅  | ✅  | ✅  |

netsim/ansible/templates/gateway/cumulus_nvue.j2

@@ -0,0 +1,45 @@
+{% if gateway.anycast is defined %}
+- set:
+    router:
+      vrr:
+        enable: on
+{% endif %}
+{% if gateway.vrrp is defined %}
+- set:
+    router:
+      vrrp:
+        enable: on
+{% endif %}
+
+{% for intf in interfaces if intf.gateway is defined %}
+{%  if loop.first %}
+- set:
+    interface:
+{%  endif %}
+      {{ intf.ifname }}:
+        ip:
+{%   if intf.gateway.protocol=='anycast' %}
+          vrr:
+            address:
+{%     for af in 'ipv4','ipv6' if af in intf.gateway %}
+              {{ intf.gateway[af] }}: {}
+{%     endfor %}
+            enable: on
+            mac-address: {{ intf.gateway.anycast.mac|hwaddr('linux') }}
+            state:
+              up: {}
+{%   elif intf.gateway.protocol=='vrrp' %}
+          vrrp:
+            enable: on
+            virtual-router:
+              '{{ intf.gateway.vrrp.group }}':
+                address:
+{%     for af in 'ipv4','ipv6' if af in intf.gateway %}
+                  {{ intf.gateway[af]|ipaddr('address') }}: {}
+{%     endfor %}
+                preempt: {{ 'on' if intf.gateway.vrrp.preempt|default(True) else 'off' }}
+{%     if intf.gateway.vrrp.priority is defined %}
+                priority: {{ intf.gateway.vrrp.priority }}
+{%     endif %}
+{%   endif %}
+{% endfor %}

netsim/devices/cumulus_nvue.yml

@@ -32,6 +32,8 @@ features:
     local_as: True
     local_as_ibgp: True
     vrf_local_as: False
+  gateway:
+    protocol: [ anycast, vrrp ]
   lag:
     passive: False
     mlag:

tests/integration/gateway/01-anycast.yml

@@ -1,6 +1,6 @@
 ---
 message: |
-  This lab tests the anycast gateway functionality. It checks whether the
+  This lab tests the anycast gateway IPv4 functionality. It checks whether the
   anycast IP is active, whether it has the correct MAC address, and whether the
   first device in the forwarding path intercepts the packets with the shared MAC
   address.
@@ -43,13 +43,13 @@ links:
   r1:
   prefix:
     ipv4: 172.16.33.0/24
-    ipv6: 2001:db8:cafe:33::/64
+    # ipv6: 2001:db8:cafe:33::/64  # implies OSPFv3, which is not supported by some devices nor used in validation below
 
 - d2:
   r2:
   prefix:
     ipv4: 172.16.44.0/24
-    ipv6: 2001:db8:cafe:44::/64
+    # ipv6: 2001:db8:cafe:44::/64
 
 - r1-r2-h3
 

tests/integration/gateway/03-vrrp-ipv6.yml

@@ -0,0 +1,114 @@
+---
+message: |
+  This lab tests IPv6 VRRP configuration. It checks whether the
+  device-under-test (DUT) forwards traffic sent to the VRRP IP/MAC address,
+  whether it has correct VRRP priority, and whether the preemption mechanism
+  works.
+
+module: [ gateway ]
+
+groups:
+  probes:
+    device: eos
+    provider: clab
+    members: [ r2 ]
+  hosts:
+    device: linux
+    provider: clab
+    members: [ h1, h2 ]
+
+gateway.protocol: vrrp
+gateway.id: 42
+gateway.vrrp.group: 17
+
+nodes:
+  dut:
+  r2:
+  h1:
+  h2:
+
+links:
+- h1:
+  dut:
+    gateway.vrrp.priority: 30
+  r2:
+    gateway.vrrp.priority: 20
+  gateway: True
+  prefix.ipv6: 2001:db8:bad:cafe::/64
+- dut:
+  r2:
+  h2:
+  prefix.ipv6: 2002:db8:bad:cafe::/64
+
+validate:
+  r2_eth1_down:
+    description: Remove R2 from the VRRP LAN
+    nodes: [ r2 ]
+    config:
+      template: ifdown
+      variable.ifstate: 'down'
+    pass: R2 has been disconnected from the VRRP LAN
+    stop_on_error: True
+  ra:
+    description: Check RA-generated default route
+    wait: 30
+    wait_msg: Waiting for RA message to generate the default route
+    nodes: [ h1, h2 ]
+    plugin: default6()
+    stop_on_error: True
+  ping_vrrp:
+    description: Verify VRRP v6 is enabled on DUT
+    wait: 10
+    nodes: [ h1 ]
+    plugin: ping('h2',af='ipv6')
+  r2_eth1_up:
+    description: Add R2 to the VRRP LAN
+    nodes: [ r2 ]
+    config:
+      template: ifdown
+      variable.ifstate: 'up'
+    pass: R2 has been reconnected to the VRRP LAN
+    stop_on_error: True
+  r2_vrrp_backup:
+    description: Verify that R2 is in the backup state
+    wait: 10
+    nodes: [ r2 ]
+    show:
+      frr: vrrp interface {{ interfaces[0].ifname }} json
+      eos: vrrp | json
+    valid:
+      frr: result[0].v6.status == 'Backup'
+      eos: virtualRouters[0].state == 'backup'
+  r2_vrrp_prio:
+    nodes: [ r2 ]
+    pass: R2 VRRP priority has been increased to 80
+    config:
+      template: vrrp-priority
+      variable.vrrp_prio: 80
+  r2_vrrp_master:
+    description: Verify that R2 took over as master (VRRP priority on DUT is lower than 80)
+    wait: 10
+    nodes: [ r2 ]
+    show:
+      frr: vrrp interface {{ interfaces[0].ifname }} json
+      eos: vrrp | json
+    valid:
+      frr: result[0].v6.status == 'Master'
+      eos: virtualRouters[0].state == 'master'
+  r2_vrrp_prio_low:
+    nodes: [ r2 ]
+    pass: R2 VRRP priority has been lowered to 20
+    config:
+      template: vrrp-priority
+      variable.vrrp_prio: 20
+  dut_preempt:
+    description: Verify that DUT preempts R2 when its priority is lowered
+    wait: 10
+    nodes: [ r2 ]
+    show:
+      frr: vrrp interface {{ interfaces[0].ifname }} json
+      eos: vrrp | json
+    valid:
+      frr: result[0].v6.status == 'Backup'
+      eos: virtualRouters[0].state == 'backup'
+    level: warning