update for new home az contract

Author: ZetaoZhuang

cns/api.go

@@ -356,6 +356,7 @@ type NmAgentSupportedApisResponse struct {
 type HomeAzResponse struct {
 	IsSupported bool `json:"isSupported"`
 	HomeAz      uint `json:"homeAz"`
+	APIVersion  uint `json:"apiVersion"`
 }
 
 type GetHomeAzResponse struct {

cns/restserver/homeazmonitor.go

@@ -154,7 +154,15 @@ func (h *HomeAzMonitor) Populate(ctx context.Context) {
 		h.update(returnCode, returnMessage, cns.HomeAzResponse{IsSupported: true})
 		return
 	}
-	h.update(types.Success, "Get Home Az succeeded", cns.HomeAzResponse{IsSupported: true, HomeAz: azResponse.HomeAz})
+	// validate APIVersion, APIVersion is a uint, so its value >=0
+	// 0 should be valid when NMA version is old and does not have the apiVersion value in home az response
+	if azResponse.APIVersion > 0 && azResponse.APIVersion != 2 {
+		returnMessage := fmt.Sprintf("[HomeAzMonitor] invalid APIVersion value from nmagent: %d", azResponse.APIVersion)
+		returnCode := types.UnexpectedError
+		h.update(returnCode, returnMessage, cns.HomeAzResponse{IsSupported: true})
+		return
+	}
+	h.update(types.Success, "Get Home Az succeeded", cns.HomeAzResponse{IsSupported: true, HomeAz: azResponse.HomeAz, APIVersion: azResponse.APIVersion})
 }
 
 // update constructs a GetHomeAzResponse entity and update its cache

cns/restserver/homeazmonitor_test.go

@@ -28,10 +28,10 @@ func TestHomeAzMonitor(t *testing.T) {
 					return []string{"GetHomeAz"}, nil
 				},
 				GetHomeAzF: func(ctx context.Context) (nmagent.AzResponse, error) {
-					return nmagent.AzResponse{HomeAz: uint(1)}, nil
+					return nmagent.AzResponse{HomeAz: uint(1), APIVersion: uint(2)}, nil
 				},
 			},
-			cns.HomeAzResponse{IsSupported: true, HomeAz: uint(1)},
+			cns.HomeAzResponse{IsSupported: true, HomeAz: uint(1), APIVersion: uint(2)},
 			false,
 		},
 		{
@@ -60,6 +60,19 @@ func TestHomeAzMonitor(t *testing.T) {
 			cns.HomeAzResponse{IsSupported: true},
 			true,
 		},
+		{
+			"api supported but apiVersion value is not valid",
+			&fakes.NMAgentClientFake{
+				SupportedAPIsF: func(ctx context.Context) ([]string, error) {
+					return []string{GetHomeAzAPIName}, nil
+				},
+				GetHomeAzF: func(ctx context.Context) (nmagent.AzResponse, error) {
+					return nmagent.AzResponse{HomeAz: uint(1), APIVersion: uint(3)}, nil
+				},
+			},
+			cns.HomeAzResponse{IsSupported: true},
+			true,
+		},
 		{
 			"api supported but got unexpected errors",
 			&fakes.NMAgentClientFake{

nmagent/client_test.go

@@ -756,6 +756,18 @@ func TestGetHomeAz(t *testing.T) {
 			map[string]interface{}{
 				"httpStatusCode": "200",
 				"HomeAz":         1,
+				"APIVersion":     0,
+			},
+			false,
+		},
+		{
+			"happy path with new version",
+			nmagent.AzResponse{HomeAz: uint(1), APIVersion: uint(2)},
+			"/machine/plugins?comp=nmagent&type=GetHomeAz%2Fapi-version%2F1",
+			map[string]interface{}{
+				"httpStatusCode": "200",
+				"HomeAz":         1,
+				"APIVersion":     2,
 			},
 			false,
 		},

nmagent/responses.go

@@ -38,7 +38,8 @@ type NCVersionList struct {
 }
 
 type AzResponse struct {
-	HomeAz uint `json:"homeAz"`
+	HomeAz     uint `json:"homeAz"`
+	APIVersion uint `json:"apiVersion"`
 }
 
 type NodeIP struct {