Add more stringers to print data structures. Also print raw json from l2discovery. (#8)

Author: edcdavid

.golangci.yml

@@ -51,7 +51,6 @@ linters:
     - dogsled
     - errcheck
     - exhaustive
-    - exportloopref
     - funlen
     - goconst
     - gocritic

Makefile

@@ -1,6 +1,9 @@
 GOLANGCI_VERSION=v1.53.2
 
-.PHONY: all clean test build
+.PHONY: all clean test build lint install-lint vet fmt
+
+fmt:
+	go fmt ./...
 
 lint:
 	golangci-lint run

go.mod

@@ -4,7 +4,7 @@ go 1.22
 
 require (
 	github.com/pkg/errors v0.9.1
-	github.com/redhat-cne/l2discovery-exports v0.0.4
+	github.com/redhat-cne/l2discovery-exports v0.0.6
 	github.com/redhat-cne/privileged-daemonset v1.0.34
 	github.com/sirupsen/logrus v1.9.3
 	github.com/yourbasic/graph v0.0.0-20210606180040-8ecfec1c2869

go.sum

@@ -62,8 +62,8 @@ github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/redhat-cne/l2discovery-exports v0.0.4 h1:oYZlk0lXEnLTO8nxnL1G54L+KdQ1WyA5zZFJln9/8uA=
-github.com/redhat-cne/l2discovery-exports v0.0.4/go.mod h1:hYvCYXSfngU/j+auFobgvKcwiu5DurO2BnUBoSmg/NA=
+github.com/redhat-cne/l2discovery-exports v0.0.6 h1:CP6A+O2ITI21nnMZGAYeQgWaflHr0Z1bkn3Q9HED6uQ=
+github.com/redhat-cne/l2discovery-exports v0.0.6/go.mod h1:hYvCYXSfngU/j+auFobgvKcwiu5DurO2BnUBoSmg/NA=
 github.com/redhat-cne/privileged-daemonset v1.0.34 h1:wcffXvaz5PwvAZfq62WiMXi0N+gXFlEFXkK4CcdjshU=
 github.com/redhat-cne/privileged-daemonset v1.0.34/go.mod h1:poRO1Giq9rH4JD8/KLxRJobOARGxmPr8xAIwhSrZGRQ=
 github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ=

l2lib.go

@@ -55,6 +55,8 @@ const (
 	L2ContainerCPUReq              = "100m"
 	L2ContainerMemLim              = "100M"
 	L2ContainerMemReq              = "100M"
+	// ptpIfIndent defines the indentation level for PtpIf detailed output
+	ptpIfIndent = 6
 )
 
 type L2DaemonsetMode int64
@@ -121,6 +123,80 @@ type L2DiscoveryConfig struct {
 	refresh bool
 }
 
+func (config L2DiscoveryConfig) String() string { //nolint:funlen
+	var result strings.Builder
+
+	result.WriteString("L2DiscoveryConfig:\n")
+	result.WriteString(fmt.Sprintf("  MaxL2GraphSize: %d\n", config.MaxL2GraphSize))
+	result.WriteString(fmt.Sprintf("  L2DsMode: %s\n", config.L2DsMode))
+	result.WriteString(fmt.Sprintf("  refresh: %t\n", config.refresh))
+
+	// PtpIfList
+	result.WriteString("  PtpIfList: \n")
+	for i, ptpIf := range config.PtpIfList {
+		result.WriteString(fmt.Sprintf("    %d:\n%s\n", i, ptpIf.StringFull(ptpIfIndent)))
+	}
+
+	// PtpIfListUnfiltered
+	result.WriteString("  PtpIfListUnfiltered: \n")
+	for key, ptpIf := range config.PtpIfListUnfiltered {
+		result.WriteString(fmt.Sprintf("    %s:\n%s\n", key, ptpIf.StringFull(ptpIfIndent)))
+	}
+
+	// L2DiscoveryPods
+	result.WriteString("  L2DiscoveryPods: \n")
+	for key, pod := range config.L2DiscoveryPods {
+		result.WriteString(fmt.Sprintf("    [%s]: %s\n", key, pod.Name))
+	}
+
+	// ClusterMacs
+	result.WriteString("  ClusterMacs:\n")
+	for key, mac := range config.ClusterMacs {
+		result.WriteString(fmt.Sprintf("    [%s]: %s\n", key, mac))
+	}
+
+	// ClusterIndexToInt
+	result.WriteString("  ClusterIndexToInt:\n")
+	for key, value := range config.ClusterIndexToInt {
+		result.WriteString(fmt.Sprintf("    [%s]: %d\n", key, value))
+	}
+
+	// ClusterMacToInt
+	result.WriteString("  ClusterMacToInt:\n")
+	for key, value := range config.ClusterMacToInt {
+		result.WriteString(fmt.Sprintf("    [%s]: %d\n", key, value))
+	}
+
+	// ClusterIndexes
+	result.WriteString("  ClusterIndexes:\n")
+	for key, value := range config.ClusterIndexes {
+		result.WriteString(fmt.Sprintf("    [%s]: %s\n", key, value))
+	}
+
+	// LANs
+	result.WriteString("  LANs: \n")
+	if config.LANs != nil {
+		for i, lan := range *config.LANs {
+			result.WriteString(fmt.Sprintf("    [%d]: %v\n", i, lan))
+		}
+	} else {
+		result.WriteString("nil\n")
+	}
+
+	// PortsGettingPTP
+	result.WriteString("  PortsGettingPTP:\n")
+	for i, ptpIf := range config.PortsGettingPTP {
+		result.WriteString(fmt.Sprintf("    [%d]: %s\n", i, ptpIf))
+	}
+
+	// SkippedInterfaces
+	result.WriteString("  SkippedInterfaces:\n")
+	for i, iface := range config.SkippedInterfaces {
+		result.WriteString(fmt.Sprintf("    [%d]: %s\n", i, iface))
+	}
+	return result.String()
+}
+
 var GlobalL2DiscoveryConfig L2DiscoveryConfig
 
 func (config *L2DiscoveryConfig) GetPtpIfList() []*l2.PtpIf {
@@ -248,7 +324,12 @@ func (config *L2DiscoveryConfig) getL2Disc(ptpInterfacesOnly bool) error {
 		if err := json.Unmarshal([]byte(report), &discDataPerNode); err != nil {
 			return err
 		}
-
+		jsonData, err := json.MarshalIndent(discDataPerNode, "", "  ")
+		if err != nil {
+			return err
+		}
+		// print the formatted json data
+		logrus.Tracef("key= %s discDataPerNode: %s", k, string(jsonData))
 		if _, ok := config.DiscoveryMap[config.L2DiscoveryPods[k].Spec.NodeName]; !ok {
 			config.DiscoveryMap[config.L2DiscoveryPods[k].Spec.NodeName] = make(map[string]map[string]*l2.Neighbors)
 		}