From e9995d6d6cd563170495adad08d9fc36cac42708 Mon Sep 17 00:00:00 2001
From: Ricardo Maraschini <ricardo.maraschini@gmail.com>
Date: Thu, 21 Nov 2024 14:10:36 +0100
Subject: [PATCH] feat: rename templating variables

when templating the output of the namespace connectivity check we were
referring to the 'fromCIDR' as 'fromNamespace'. it makes way more sense
to refer to it as 'fromCIDR' as this is how it is provided in the input
for the collector.

as this is a brand new feature it is very unlikely that anyone is using
this feature (except for the embedded cluster that still needs to be
patched accodringly).

this is how the analyser were defined before:

```yaml
apiVersion: troubleshoot.sh/v1beta2
kind: HostPreflight
metadata:
    name: ec-cluster-preflight
spec:
    analyzers:
        - networkNamespaceConnectivity:
            collectorName: check-network-connectivity
            outcomes:
            - pass:
                message: "Communication between {{ .FromNamespace }} and {{ .ToNamespace }} is working"
            - fail:
                message: "{{ .ErrorMessage }}"
```

and this is how it is now:

```yaml
apiVersion: troubleshoot.sh/v1beta2
kind: HostPreflight
metadata:
    name: ec-cluster-preflight
spec:
    analyzers:
        - networkNamespaceConnectivity:
            collectorName: check-network-connectivity
            outcomes:
            - pass:
                message: "Communication between {{ .FromCIDR }} and {{ .ToCIDR }} is working"
            - fail:
                message: "{{ .ErrorMessage }}"

```
---
 .../host_network_namespace_connectivity.go    | 38 +++++++++----------
 1 file changed, 19 insertions(+), 19 deletions(-)

diff --git a/pkg/collect/host_network_namespace_connectivity.go b/pkg/collect/host_network_namespace_connectivity.go
index 354267c18..71890919d 100644
--- a/pkg/collect/host_network_namespace_connectivity.go
+++ b/pkg/collect/host_network_namespace_connectivity.go
@@ -18,11 +18,11 @@ import (
 // have the logs, the information from the source and destination namespaces,
 // errors and a success flag.
 type NetworkNamespaceConnectivityInfo struct {
-	FromNamespace string                             `json:"from_namespace"`
-	ToNamespace   string                             `json:"to_namespace"`
-	Errors        NetworkNamespaceConnectivityErrors `json:"errors"`
-	Output        NetworkNamespaceConnectivityOutput `json:"output"`
-	Success       bool                               `json:"success"`
+	FromCIDR string                             `json:"from_cidr"`
+	ToCIDR   string                             `json:"to_cidr"`
+	Errors   NetworkNamespaceConnectivityErrors `json:"errors"`
+	Output   NetworkNamespaceConnectivityOutput `json:"output"`
+	Success  bool                               `json:"success"`
 }
 
 // ErrorMessage returns the error message from the errors field.
@@ -33,26 +33,26 @@ func (n *NetworkNamespaceConnectivityInfo) ErrorMessage() string {
 // NetworkNamespaceConnectivityErrors is a struct that contains the errors that
 // occurred during the network namespace connectivity test
 type NetworkNamespaceConnectivityErrors struct {
-	FromNamespaceCreation string `json:"from_namespace_creation"`
-	ToNamespaceCreation   string `json:"to_namespace_creation"`
-	UDPClient             string `json:"udp_client"`
-	UDPServer             string `json:"udp_server"`
-	TCPClient             string `json:"tcp_client"`
-	TCPServer             string `json:"tcp_server"`
+	FromCIDRCreation string `json:"from_cidr_creation"`
+	ToCIDRCreation   string `json:"to_cidr_creation"`
+	UDPClient        string `json:"udp_client"`
+	UDPServer        string `json:"udp_server"`
+	TCPClient        string `json:"tcp_client"`
+	TCPServer        string `json:"tcp_server"`
 }
 
 // Errors returns a string representation of the errors found during the
 // network namespace connectivity test.
 func (e NetworkNamespaceConnectivityErrors) Errors() string {
 	var sb strings.Builder
-	if e.FromNamespaceCreation != "" {
+	if e.FromCIDRCreation != "" {
 		sb.WriteString("Failed to create 'from' namespace: ")
-		sb.WriteString(e.FromNamespaceCreation + "\n")
+		sb.WriteString(e.FromCIDRCreation + "\n")
 	}
 
-	if e.ToNamespaceCreation != "" {
+	if e.ToCIDRCreation != "" {
 		sb.WriteString("Failed to create 'to' namespace: ")
-		sb.WriteString(e.ToNamespaceCreation + "\n")
+		sb.WriteString(e.ToCIDRCreation + "\n")
 	}
 
 	if e.UDPClient != "" {
@@ -165,8 +165,8 @@ func (c *CollectHostNetworkNamespaceConnectivity) Collect(progressChan chan<- in
 	}
 
 	result := &NetworkNamespaceConnectivityInfo{
-		FromNamespace: c.hostCollector.FromCIDR,
-		ToNamespace:   c.hostCollector.ToCIDR,
+		FromCIDR: c.hostCollector.FromCIDR,
+		ToCIDR:   c.hostCollector.ToCIDR,
 	}
 
 	opts := []namespaces.Option{namespaces.WithLogf(result.Output.Printf)}
@@ -188,14 +188,14 @@ func (c *CollectHostNetworkNamespaceConnectivity) Collect(progressChan chan<- in
 
 	fromNS, err := namespaces.NewNamespacePinger("from", c.hostCollector.FromCIDR, opts...)
 	if err != nil {
-		result.Errors.ToNamespaceCreation = err.Error()
+		result.Errors.ToCIDRCreation = err.Error()
 		return c.marshal(result)
 	}
 	defer fromNS.Close()
 
 	toNS, err := namespaces.NewNamespacePinger("to", c.hostCollector.ToCIDR, opts...)
 	if err != nil {
-		result.Errors.FromNamespaceCreation = err.Error()
+		result.Errors.FromCIDRCreation = err.Error()
 		return c.marshal(result)
 	}
 	defer toNS.Close()