test: add UT for error message check

Author: isaac-dasan

cns/middlewares/k8sSwiftV2.go

@@ -20,10 +20,18 @@ 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 is not found")
 	errInvalidSWIFTv2NICType    = errors.New("invalid NIC type for SWIFT v2 scenario")
 	errInvalidMTPNCPrefixLength = errors.New("invalid prefix length for MTPNC primaryIP, must be 32")
 )
 
+// 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
+
+var getMTPNCNotFoundErr = func(err error) error {
+	return fmt.Errorf("%w: %v", errMTPNCNotFound, err)
+}
+
 const (
 	prefixLength     = 32
 	overlayGatewayv4 = "169.254.1.1"
@@ -74,7 +82,7 @@ func (k *K8sSWIFTv2Middleware) getIPConfig(ctx context.Context, podInfo cns.PodI
 	mtpnc := v1alpha1.MultitenantPodNetworkConfig{}
 	mtpncNamespacedName := k8stypes.NamespacedName{Namespace: podInfo.Namespace(), Name: podInfo.Name()}
 	if err := k.Cli.Get(ctx, mtpncNamespacedName, &mtpnc); err != nil {
-		return nil, errors.Wrapf(err, "failed to get pod's mtpnc from cache")
+		return nil, getMTPNCNotFoundErr(err)
 	}
 
 	// Check if the MTPNC CRD is ready. If one of the fields is empty, return error
@@ -192,7 +200,7 @@ func (k *K8sSWIFTv2Middleware) getMTPNC(ctx context.Context, podInfo cns.PodInfo
 	mtpnc := v1alpha1.MultitenantPodNetworkConfig{}
 	mtpncNamespacedName := k8stypes.NamespacedName{Namespace: podInfo.Namespace(), Name: podInfo.Name()}
 	if err := k.Cli.Get(ctx, mtpncNamespacedName, &mtpnc); err != nil {
-		return v1alpha1.MultitenantPodNetworkConfig{}, types.UnexpectedError, fmt.Errorf("failed to get pod's mtpnc from cache : %w", err).Error()
+		return v1alpha1.MultitenantPodNetworkConfig{}, types.UnexpectedError, getMTPNCNotFoundErr(err).Error()
 	}
 	// Check if the MTPNC CRD is ready. If one of the fields is empty, return error
 	if !mtpnc.IsReady() {

cns/middlewares/k8sSwiftV2_linux_test.go

@@ -2,6 +2,7 @@ package middlewares
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"strings"
 	"testing"
@@ -203,17 +204,20 @@ func TestValidateMultitenantIPConfigsRequestFailure(t *testing.T) {
 	_, respCode, _ = middleware.GetPodInfoForIPConfigsRequest(context.TODO(), failReq)
 	assert.Equal(t, respCode, types.UnexpectedError)
 
+	kubeletExpectedString := "network is not ready"
 	// Failed to get MTPNC
 	b, _ = testPod3Info.OrchestratorContext()
 	failReq.OrchestratorContext = b
-	_, respCode, _ = middleware.GetPodInfoForIPConfigsRequest(context.TODO(), failReq)
+	_, 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)
 
 	// MTPNC not ready
 	b, _ = testPod4Info.OrchestratorContext()
 	failReq.OrchestratorContext = b
-	_, respCode, _ = middleware.GetPodInfoForIPConfigsRequest(context.TODO(), failReq)
+	_, 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)
 }
 
 func TestGetSWIFTv2IPConfigSuccess(t *testing.T) {
@@ -232,27 +236,21 @@ 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.ErrorContains(t, err, mock.ErrMTPNCNotFound.Error())
+	assert.Assert(t, errors.Is(err, errMTPNCNotFound), "expected error to wrap errMTPNCNotFound, got: %v", err)
+	assert.ErrorContains(t, err, "network is not ready")
 
 	// Pod's MTPNC is not ready test
 	_, err = middleware.getIPConfig(context.TODO(), testPod4Info)
 	assert.Error(t, err, errMTPNCNotReady.Error())
-}
-
-// 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 errMTPNCNotReady contains "network is not ready"
-func TestMTPNCNotReadyErrorMessage(t *testing.T) {
-	middleware := K8sSWIFTv2Middleware{Cli: mock.NewClient()}
-	// Pod's MTPNC is not ready test
-	_, err := middleware.getIPConfig(context.TODO(), testPod4Info)
-
-	assert.Equal(t, strings.Contains(err.Error(), "network is not ready"), true)
+	assert.ErrorContains(t, err, "network is not ready")
 }
 
 func TestSetRoutesSuccess(t *testing.T) {