MGMT-18930: Consolidate static network configuration log messages (#7592)

This commit changes the logging behavior in the StaticNetworkConfigGenerator to reduce log verbosity by consolidating multiple individual "Adding NMConnection file" log messages into a single message. Instead of logging each NM connection file separately, the code now collects all file names and outputs them in a single log entry.

Author: yoavsc0302

pkg/staticnetworkconfig/generator.go

@@ -248,20 +248,31 @@ func (s *StaticNetworkConfigGenerator) createNMConnectionFiles(nmstateOutput, ho
 	if len(connectionsList) == 0 {
 		return nil, errors.Errorf("nmstate generated an empty NetworkManager config file content")
 	}
+
 	for _, connection := range connectionsList {
 		connectionElems := connection.([]interface{})
 		fileName := connectionElems[0].(string)
 		fileContents, err := s.formatNMConnection(connectionElems[1].(string))
 		if err != nil {
 			return nil, err
 		}
-		s.log.Infof("Adding NMConnection file <%s>", fileName)
+
 		newFile := StaticNetworkConfigData{
 			FilePath:     filepath.Join(hostDir, fileName),
 			FileContents: fileContents,
 		}
+
 		filesList = append(filesList, newFile)
 	}
+
+	if len(filesList) > 0 {
+		s.log.Infof("Adding NMConnection files: <%s>",
+			strings.Join(lo.Map(filesList, func(f StaticNetworkConfigData, _ int) string {
+				return filepath.Base(f.FilePath)
+			}), ">, <"),
+		)
+	}
+
 	return filesList, nil
 }
 

pkg/staticnetworkconfig/generator_test.go

@@ -1,6 +1,7 @@
 package staticnetworkconfig_test
 
 import (
+	"bytes"
 	"context"
 	"encoding/json"
 	"fmt"
@@ -489,6 +490,46 @@ var _ = Describe("StaticNetworkConfig", func() {
 		Expect(err).ToNot(HaveOccurred())
 		Expect(formattedOutput).To(Equal(""))
 	})
+
+	It("logs all NMConnection files in a consolidated format", func() {
+
+		var logBuffer bytes.Buffer
+		testLog := logrus.New()
+		testLog.SetOutput(&logBuffer)
+
+		testGenerator := snc.New(testLog, snc.Config{MinVersionForNmstateService: common.MinimalVersionForNmstatectl})
+
+		staticNetworkConfig := []*models.HostStaticNetworkConfig{
+			{
+				MacInterfaceMap: models.MacInterfaceMap{
+					{
+						LogicalNicName: "eth0",
+						MacAddress:     "f8:75:a4:a4:00:fe",
+					},
+					{
+						LogicalNicName: "eth1",
+						MacAddress:     "f8:75:a4:a4:00:ff",
+					},
+					{
+						LogicalNicName: "eth2",
+						MacAddress:     "f8:75:a4:a4:01:00",
+					},
+				},
+				NetworkYaml: multipleInterfacesYAML,
+			},
+		}
+
+		staticNetworkConfigBytes, err := json.Marshal(staticNetworkConfig)
+		Expect(err).NotTo(HaveOccurred())
+
+		_, err = testGenerator.GenerateStaticNetworkConfigData(context.Background(), string(staticNetworkConfigBytes))
+
+		if err == nil {
+			logOutput := logBuffer.String()
+
+			Expect(logOutput).To(ContainSubstring("Adding NMConnection files: <eth0.nmconnection>, <eth1.nmconnection>, <eth2.nmconnection>"))
+		}
+	})
 })
 
 var _ = Describe("StaticNetworkConfig.GenerateStaticNetworkConfigDataYAML - generate nmpolicy", func() {