reafactor: replace individual err msg with const from common package

Signed-off-by: GitHub <[email protected]>

Author: isaac-dasan

cns/middlewares/k8sSwiftV2.go

@@ -9,6 +9,7 @@ import (
 	"github.com/Azure/azure-container-networking/cns/logger"
 	"github.com/Azure/azure-container-networking/cns/middlewares/utils"
 	"github.com/Azure/azure-container-networking/cns/types"
+	"github.com/Azure/azure-container-networking/common"
 	"github.com/Azure/azure-container-networking/crd/multitenancy/api/v1alpha1"
 	"github.com/pkg/errors"
 	v1 "k8s.io/api/core/v1"
@@ -17,10 +18,8 @@ import (
 )
 
 var (
-	// In AKS, for kubelet to retry faster it is particularly looking for "network is not ready" error string.
-	// https://github.com/kubernetes/kubernetes/blob/efd2a0d1f514be96a2f012fc3cb40f7c872b4e67/pkg/kubelet/pod_workers.go#L1495C2-L1501C3
-	errMTPNCNotReady            = errors.New("network is not ready - mtpnc is not ready")
-	errMTPNCNotFound            = errors.New("network is not ready - mtpnc not found")
+	errMTPNCNotReady            = errors.New(common.KubeletNetworkNotReadyMsg + " - mtpnc is not ready")
+	errMTPNCNotFound            = errors.New(common.KubeletNetworkNotReadyMsg + " - mtpnc not found")
 	errInvalidSWIFTv2NICType    = errors.New("invalid NIC type for SWIFT v2 scenario")
 	errInvalidMTPNCPrefixLength = errors.New("invalid prefix length for MTPNC primaryIP, must be 32")
 )

cns/middlewares/k8sSwiftV2_linux_test.go

@@ -12,6 +12,7 @@ import (
 	"github.com/Azure/azure-container-networking/cns/logger"
 	"github.com/Azure/azure-container-networking/cns/middlewares/mock"
 	"github.com/Azure/azure-container-networking/cns/types"
+	"github.com/Azure/azure-container-networking/common"
 	"github.com/Azure/azure-container-networking/crd/multitenancy/api/v1alpha1"
 	"github.com/google/go-cmp/cmp"
 	"gotest.tools/v3/assert"
@@ -41,8 +42,6 @@ var (
 
 	testPod9GUID = "2006cad4-e54d-472e-863d-c4bac66200a7"
 	testPod9Info = cns.NewPodInfo("2006cad4-eth0", testPod9GUID, "testpod9", "testpod9namespace")
-
-	kubeletExpectedString = "network is not ready"
 )
 
 func TestMain(m *testing.M) {
@@ -211,14 +210,14 @@ func TestValidateMultitenantIPConfigsRequestFailure(t *testing.T) {
 	failReq.OrchestratorContext = b
 	_, respCode, msg := middleware.GetPodInfoForIPConfigsRequest(context.TODO(), failReq)
 	assert.Equal(t, respCode, types.UnexpectedError)
-	assert.Assert(t, strings.Contains(msg, kubeletExpectedString), "expected error message to be '%s', got '%s'", kubeletExpectedString, msg)
+	assert.Assert(t, strings.Contains(msg, common.KubeletNetworkNotReadyMsg), "expected error message to contain '%s', got '%s'", common.KubeletNetworkNotReadyMsg, msg)
 
 	// MTPNC not ready
 	b, _ = testPod4Info.OrchestratorContext()
 	failReq.OrchestratorContext = b
 	_, respCode, msg = middleware.GetPodInfoForIPConfigsRequest(context.TODO(), failReq)
 	assert.Equal(t, respCode, types.UnexpectedError)
-	assert.Assert(t, strings.Contains(msg, kubeletExpectedString), "expected error message to be '%s', got '%s'", kubeletExpectedString, msg)
+	assert.Assert(t, strings.Contains(msg, common.KubeletNetworkNotReadyMsg), "expected error message to contain '%s', got '%s'", common.KubeletNetworkNotReadyMsg, msg)
 }
 
 func TestGetSWIFTv2IPConfigSuccess(t *testing.T) {
@@ -237,21 +236,18 @@ func TestGetSWIFTv2IPConfigSuccess(t *testing.T) {
 	assert.Equal(t, ipInfos[0].SkipDefaultRoutes, false)
 }
 
-// In AKS, for kubelet to retry faster it is particularly looking for "network is not ready" error string.
-// https://github.com/kubernetes/kubernetes/blob/efd2a0d1f514be96a2f012fc3cb40f7c872b4e67/pkg/kubelet/pod_workers.go#L1495C2-L1501C3
-// This test is to ensure that the error string contains "network is not ready"
 func TestGetSWIFTv2IPConfigFailure(t *testing.T) {
 	middleware := K8sSWIFTv2Middleware{Cli: mock.NewClient()}
 
 	// Pod's MTPNC doesn't exist in cache test
 	_, err := middleware.getIPConfig(context.TODO(), testPod3Info)
 	assert.Assert(t, errors.Is(err, errMTPNCNotFound), "expected error to wrap errMTPNCNotFound, got: %v", err)
-	assert.ErrorContains(t, err, kubeletExpectedString)
+	assert.ErrorContains(t, err, common.KubeletNetworkNotReadyMsg)
 
 	// Pod's MTPNC is not ready test
 	_, err = middleware.getIPConfig(context.TODO(), testPod4Info)
 	assert.Assert(t, errors.Is(err, errMTPNCNotReady), "expected error to wrap errMTPNCNotReady, got: %v", err)
-	assert.ErrorContains(t, err, kubeletExpectedString)
+	assert.ErrorContains(t, err, common.KubeletNetworkNotReadyMsg)
 }
 
 func TestSetRoutesSuccess(t *testing.T) {

common/utils.go

@@ -30,6 +30,9 @@ const (
 	FiveSeconds                     = 5 * time.Second
 	JsonContent                     = "application/json; charset=UTF-8"
 	ContentType                     = "Content-Type"
+	// In AKS, for kubelet to retry faster it is particularly looking for "network is not ready" error string.
+	// https://github.com/kubernetes/kubernetes/blob/efd2a0d1f514be96a2f012fc3cb40f7c872b4e67/pkg/kubelet/pod_workers.go#L1495C2-L1501C3
+	KubeletNetworkNotReadyMsg = "network is not ready"
 )
 
 // XmlDocument - Azure host agent XML document format.

network/secondary_endpoint_client_linux.go

@@ -6,6 +6,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/Azure/azure-container-networking/common"
 	"github.com/Azure/azure-container-networking/netio"
 	"github.com/Azure/azure-container-networking/netlink"
 	"github.com/Azure/azure-container-networking/netns"
@@ -141,7 +142,7 @@ func (client *SecondaryEndpointClient) ConfigureContainerInterfacesAndRoutes(epI
 	logger.Info("Sending DHCP packet", zap.Any("macAddress", epInfo.MacAddress), zap.String("ifName", epInfo.IfName))
 	err := client.dhcpClient.DiscoverRequest(ctx, epInfo.MacAddress, epInfo.IfName)
 	if err != nil {
-		return errors.Wrapf(err, "network is not ready - failed to issue dhcp discover packet to create mapping in host")
+		return errors.Wrapf(err, common.KubeletNetworkNotReadyMsg+" - failed to issue dhcp discover packet to create mapping in host")
 	}
 	logger.Info("Finished configuring container interfaces and routes for secondary endpoint client")
 

network/secondary_endpoint_linux_test.go

@@ -10,6 +10,7 @@ import (
 	"testing"
 
 	"github.com/Azure/azure-container-networking/cns"
+	"github.com/Azure/azure-container-networking/common"
 	"github.com/Azure/azure-container-networking/netio"
 	"github.com/Azure/azure-container-networking/netlink"
 	"github.com/Azure/azure-container-networking/network/networkutils"
@@ -399,7 +400,7 @@ func TestSecondaryConfigureContainerInterfacesAndRoutes(t *testing.T) {
 				},
 			},
 			wantErr:    true,
-			wantErrMsg: "network is not ready",
+			wantErrMsg: common.KubeletNetworkNotReadyMsg,
 		},
 	}