From a266b5a9487fcadee04ec462feaf9b54a6aea4d9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Harald=20Jens=C3=A5s?= <hjensas@redhat.com>
Date: Thu, 28 Oct 2021 22:52:45 +0200
Subject: [PATCH] Add ping test for all networks gateway IPs

Add ping test for gateway IPs on all networks, to ensure
all gateways are reachable.

The releated Bugzilla reports an issue where some network
fabrics fail when using the current node ping test, which
pings the first node in each role. The fabric simply does
not forward traffic before the gateway has been pinged.

One can argue that the fabric in question is broken. However,
with the current implementation the first node in each role
actually ping tests only against it's own address? So adding
the test to ping the gateway addresses improves the validation
in general.

Make PingTestGatewayIPsMap a map of flatten lists

PingTestGatewayIPsMap elements may contain list of lists, causing failures
on roles that iterate over them. See [1] and #1950528 for more info.

[1] https://review.opendev.org/c/openstack/tripleo-ansible/+/817500

Related RHBZ#1875962
Closes-bug: #1950528
Depends-On: I93cded61ffb862e99fd8043dbf0def3d16079692

Change-Id: I3309f2a0e39ad115930ecd5c0e895816565819e9
(cherry picked from commit 5d830980ec842c6093a8fd44ef922014bcadf693)
(cherry picked from commit efc328c66898bfc09c5dcb00fe5f584a45b899ff)
---
 common/deploy-steps.j2 |  6 ++++++
 overcloud.j2.yaml      | 18 ++++++++++++++++++
 2 files changed, 24 insertions(+)

diff --git a/common/deploy-steps.j2 b/common/deploy-steps.j2
index 2a09bf792f..fb5b299b83 100644
--- a/common/deploy-steps.j2
+++ b/common/deploy-steps.j2
@@ -131,6 +131,10 @@ parameters:
     default: false
     description: Optional validation to ensure FQDN as set by Nova matches the name set in /etc/hosts.
     type: boolean
+  PingTestGatewayIPsMap:
+    default: {}
+    description: A map of role name to list of gateway IP addresses for each network, used to ping test each gateway.
+    type: json
   PingTestIpsMap:
     default: ''
     description: A map of role name to a space separated list of IP addresses used to ping test each available network interface.
@@ -384,6 +388,7 @@ outputs:
         validate_controllers_icmp: {get_param: ValidateControllersIcmp}
         validate_gateways_icmp: {get_param: ValidateGatewaysIcmp}
         validate_fqdn: {get_param: ValidateFqdn}
+        ping_test_gateway_ips: {get_param: PingTestGatewayIPsMap}
         ping_test_ips: {get_param: PingTestIpsMap}
         stack_action: {get_param: StackAction}
         network_safe_defaults: {get_param: NetworkSafeDefaults}
@@ -641,6 +646,7 @@ outputs:
                     tripleo_nodes_validation_validate_gateway_icmp: "{{ validate_gateways_icmp }}"
                     tripleo_nodes_validation_validate_fqdn: "{{ validate_fqdn }}"
                     tripleo_nodes_validation_ping_test_ips: "{{ ping_test_ips.get(tripleo_role_name).split(' ') | list | unique }}"
+                    tripleo_nodes_validation_ping_test_gateway_ips: "{{ ping_test_gateway_ips.get(tripleo_role_name) }}"
               tags:
                 - overcloud
                 - pre_deploy_steps
diff --git a/overcloud.j2.yaml b/overcloud.j2.yaml
index 7b3dcc92df..caf4e44836 100644
--- a/overcloud.j2.yaml
+++ b/overcloud.j2.yaml
@@ -1186,6 +1186,24 @@ resources:
       {{role.name}}Count: {get_param: {{role.name}}Count}
 {%- endfor %}
       ServiceNetMapLower: {get_attr: [ServiceNetMap, service_net_map_lower]}
+      PingTestGatewayIPsMap:
+{%- for role in roles %}
+        {{role.name}}:
+          yaql:
+            expression: list($.data.where($ != null)).flatten()
+            data:
+              - {get_attr: [Networks, net_attributes_map, ctlplane, subnets, {get_param: {{role.name}}ControlPlaneSubnet}, gateway_ip]}
+    {%- for network in networks %}
+      {%- if network.enabled|default(true) and network.name in role.networks|default([]) %}
+        {%- if role.networks is mapping %}
+          {%- set _role_net_subnet = role.networks[network.name]['subnet'] %}
+        {%- else %}
+          {%- set _role_net_subnet = network.name_lower + '_subnet' %}
+        {%- endif %}
+              - {get_attr: [Networks, net_attributes_map, {{network.name_lower}}, subnets, {{ _role_net_subnet }}, gateway_ip]}
+      {%- endif %}
+    {%- endfor %}
+{%- endfor %}
       PingTestIpsMap:
 {%- for role in roles %}
         {{role.name}}: