Update stringifying configs

Author: catherinetcai

pkg/bgp/peer_config.go

@@ -15,21 +15,19 @@ import (
 type PeerConfig struct {
 	LocalIP   *string             `yaml:"localip"`
 	Password  *utils.Base64String `yaml:"password"`
-	Port      *uint32             `yaml:"port"`
+	Port      uint32              `yaml:"port"`
 	RemoteASN *uint32             `yaml:"remoteasn"`
 	RemoteIP  *net.IP             `yaml:"remoteip"`
 }
 
 // Custom Stringer to prevent leaking passwords when printed
 func (p PeerConfig) String() string {
 	var fields []string
+	fields = append(fields, fmt.Sprintf("Port: %d", p.Port))
 
 	if p.LocalIP != nil {
 		fields = append(fields, fmt.Sprintf("LocalIP: %s", *p.LocalIP))
 	}
-	if p.Port != nil {
-		fields = append(fields, fmt.Sprintf("Port: %d", *p.Port))
-	}
 	if p.RemoteASN != nil {
 		fields = append(fields, fmt.Sprintf("RemoteASN: %d", *p.RemoteASN))
 	}
@@ -43,7 +41,7 @@ func (p *PeerConfig) UnmarshalYAML(raw []byte) error {
 	tmp := struct {
 		LocalIP   *string             `yaml:"localip"`
 		Password  *utils.Base64String `yaml:"password"`
-		Port      *uint32             `yaml:"port"`
+		Port      uint32              `yaml:"port"`
 		RemoteASN *uint32             `yaml:"remoteasn"`
 		RemoteIP  string              `yaml:"remoteip"`
 	}{}
@@ -93,9 +91,7 @@ func (p PeerConfigs) Passwords() []string {
 func (p PeerConfigs) Ports() []uint32 {
 	ports := make([]uint32, 0)
 	for _, cfg := range p {
-		if cfg.Port != nil {
-			ports = append(ports, *cfg.Port)
-		}
+		ports = append(ports, cfg.Port)
 	}
 	return ports
 }
@@ -176,7 +172,7 @@ func NewPeerConfigs(
 		peerCfgs[i].RemoteASN = &remoteASNs[i]
 
 		if len(ports) != 0 {
-			peerCfgs[i].Port = &ports[i]
+			peerCfgs[i].Port = ports[i]
 		}
 
 		if len(b64EncodedPasswords) != 0 {

pkg/bgp/peer_config_test.go

@@ -18,19 +18,19 @@ func TestPeerConfig_String(t *testing.T) {
 		{
 			name:     "empty PeerConfig",
 			config:   PeerConfig{},
-			expected: "PeerConfig{}",
+			expected: "PeerConfig{Port: 0}",
 		},
 		{
 			name: "LocalIP",
 			config: PeerConfig{
 				LocalIP: testutils.ValToPtr("192.168.1.1"),
 			},
-			expected: "PeerConfig{LocalIP: 192.168.1.1}",
+			expected: "PeerConfig{Port: 0, LocalIP: 192.168.1.1}",
 		},
 		{
 			name: "Port",
 			config: PeerConfig{
-				Port: testutils.ValToPtr(uint32(179)),
+				Port: 179,
 			},
 			expected: "PeerConfig{Port: 179}",
 		},
@@ -39,39 +39,39 @@ func TestPeerConfig_String(t *testing.T) {
 			config: PeerConfig{
 				RemoteASN: testutils.ValToPtr(uint32(65000)),
 			},
-			expected: "PeerConfig{RemoteASN: 65000}",
+			expected: "PeerConfig{Port: 0, RemoteASN: 65000}",
 		},
 		{
 			name: "RemoteIP",
 			config: PeerConfig{
 				RemoteIP: testutils.ValToPtr(net.ParseIP("10.0.0.1")),
 			},
-			expected: "PeerConfig{RemoteIP: 10.0.0.1}",
+			expected: "PeerConfig{Port: 0, RemoteIP: 10.0.0.1}",
 		},
 		{
 			name: "RemoteIP with IPv6",
 			config: PeerConfig{
 				RemoteIP: testutils.ValToPtr(net.ParseIP("2001:db8::1")),
 			},
-			expected: "PeerConfig{RemoteIP: 2001:db8::1}",
+			expected: "PeerConfig{Port: 0, RemoteIP: 2001:db8::1}",
 		},
 		{
 			name: "Password - should not be printed",
 			config: PeerConfig{
 				Password: testutils.ValToPtr(utils.Base64String("password")),
 			},
-			expected: "PeerConfig{}",
+			expected: "PeerConfig{Port: 0}",
 		},
 		{
 			name: "all fields - Password should not be printed",
 			config: PeerConfig{
 				LocalIP:   testutils.ValToPtr("192.168.1.1"),
 				Password:  testutils.ValToPtr(utils.Base64String("password")),
-				Port:      testutils.ValToPtr(uint32(179)),
+				Port:      179,
 				RemoteASN: testutils.ValToPtr(uint32(65000)),
 				RemoteIP:  testutils.ValToPtr(net.ParseIP("10.0.0.1")),
 			},
-			expected: "PeerConfig{LocalIP: 192.168.1.1, Port: 179, RemoteASN: 65000, RemoteIP: 10.0.0.1}",
+			expected: "PeerConfig{Port: 179, LocalIP: 192.168.1.1, RemoteASN: 65000, RemoteIP: 10.0.0.1}",
 		},
 	}
 
@@ -100,12 +100,12 @@ func TestPeerConfigs_String(t *testing.T) {
 				{
 					LocalIP:   testutils.ValToPtr("192.168.1.1"),
 					Password:  testutils.ValToPtr(utils.Base64String("secret")),
-					Port:      testutils.ValToPtr(uint32(179)),
+					Port:      179,
 					RemoteASN: testutils.ValToPtr(uint32(65000)),
 					RemoteIP:  testutils.ValToPtr(net.ParseIP("10.0.0.1")),
 				},
 			},
-			expected: "PeerConfigs[PeerConfig{LocalIP: 192.168.1.1, Port: 179, RemoteASN: 65000, RemoteIP: 10.0.0.1}]",
+			expected: "PeerConfigs[PeerConfig{Port: 179, LocalIP: 192.168.1.1, RemoteASN: 65000, RemoteIP: 10.0.0.1}]",
 		},
 		{
 			name: "multiple PeerConfigs - passwords should not be printed",
@@ -117,15 +117,15 @@ func TestPeerConfigs_String(t *testing.T) {
 					RemoteIP:  testutils.ValToPtr(net.ParseIP("10.0.0.1")),
 				},
 				{
-					Port:      testutils.ValToPtr(uint32(1790)),
+					Port:      179,
 					RemoteASN: testutils.ValToPtr(uint32(65001)),
 					RemoteIP:  testutils.ValToPtr(net.ParseIP("10.0.0.2")),
 				},
 				{
 					RemoteIP: testutils.ValToPtr(net.ParseIP("10.0.0.3")),
 				},
 			},
-			expected: "PeerConfigs[PeerConfig{LocalIP: 192.168.1.1, RemoteASN: 65000, RemoteIP: 10.0.0.1},PeerConfig{Port: 1790, RemoteASN: 65001, RemoteIP: 10.0.0.2},PeerConfig{RemoteIP: 10.0.0.3}]",
+			expected: "PeerConfigs[PeerConfig{Port: 0, LocalIP: 192.168.1.1, RemoteASN: 65000, RemoteIP: 10.0.0.1},PeerConfig{Port: 179, RemoteASN: 65001, RemoteIP: 10.0.0.2},PeerConfig{Port: 0, RemoteIP: 10.0.0.3}]",
 		},
 	}
 

pkg/controllers/routing/network_routes_controller.go

@@ -1469,7 +1469,6 @@ func bgpPeerConfigsFromIndividualAnnotations(nodeAnnotations map[string]string,
 	// Get Global Peer Router ASN configs
 	var ports []uint32
 	nodeBgpPeerPortsAnnotation, ok := nodeAnnotations[peerPortAnnotation]
-	// Default to default BGP port if port annotation is not found
 	if ok {
 		portStrings := stringToSlice(nodeBgpPeerPortsAnnotation, ",")
 		ports, err = stringSliceToUInt32(portStrings)