initial changes to expose getnclist API in cns client

Author: smittal22

cns/NetworkContainerContract.go

@@ -40,6 +40,7 @@ const (
 	NumberOfCPUCores                         = NumberOfCPUCoresPath
 	NMAgentSupportedAPIs                     = NmAgentSupportedApisPath
 	EndpointAPI                              = EndpointPath
+	GetNCList                                = "/nclist"
 )
 
 // NetworkContainer Prefixes

cns/api.go

@@ -353,6 +353,11 @@ type NmAgentSupportedApisResponse struct {
 	SupportedApis []string
 }
 
+type NCListResponse struct {
+	Response Response `json:"response"`
+	NCList   []string `json:"ncList"`
+}
+
 type HomeAzResponse struct {
 	IsSupported          bool `json:"isSupported"`
 	HomeAz               uint `json:"homeAz"`

cns/restserver/api.go

@@ -1300,3 +1300,39 @@ func (service *HTTPRestService) getVMUniqueID(w http.ResponseWriter, r *http.Req
 		})
 	}
 }
+
+// This function is used to query all NCs on a node from NMAgent
+func (service *HTTPRestService) nmAgentNCListHandler(w http.ResponseWriter, r *http.Request) {
+	logger.Request(service.Name, "nmAgentNCListHandler", nil)
+	var (
+		returnCode           types.ResponseCode
+		returnMessage        string
+		networkContainerList []string
+	)
+
+	ctx := r.Context()
+	switch r.Method {
+	case http.MethodGet:
+		ncVersionList, ncVersionerr := service.nma.GetNCVersionList(ctx)
+		if ncVersionerr != nil {
+			returnCode = types.NmAgentNCVersionListError
+			returnMessage = fmt.Sprintf("[Azure-CNS] %s", ncVersionerr.Error())
+		}
+
+		for _, container := range ncVersionList.Containers {
+			networkContainerList = append(networkContainerList, container.NetworkContainerID)
+		}
+
+	default:
+		returnMessage = "[Azure-CNS] NmAgentNCList API expects a GET method."
+	}
+
+	resp := cns.Response{ReturnCode: returnCode, Message: returnMessage}
+	NCListResponse := &cns.NCListResponse{
+		Response: resp,
+		NCList:   networkContainerList,
+	}
+
+	serviceErr := common.Encode(w, &NCListResponse)
+	logger.Response(service.Name, NCListResponse, resp.ReturnCode, serviceErr)
+}

cns/restserver/restserver.go

@@ -292,6 +292,7 @@ func (service *HTTPRestService) Init(config *common.ServiceConfig) error {
 	listener.AddHandler(cns.NetworkContainersURLPath, service.getOrRefreshNetworkContainers)
 	listener.AddHandler(cns.GetHomeAz, service.getHomeAz)
 	listener.AddHandler(cns.EndpointPath, service.EndpointHandlerAPI)
+	listener.AddHandler(cns.GetNCList, service.nmAgentNCListHandler)
 	// This API is only needed for Direct channel mode with Swift v2.
 	if config.ChannelMode == cns.Direct {
 		listener.AddHandler(cns.GetVMUniqueID, service.getVMUniqueID)
@@ -318,6 +319,7 @@ func (service *HTTPRestService) Init(config *common.ServiceConfig) error {
 	listener.AddHandler(cns.V2Prefix+cns.NmAgentSupportedApisPath, service.nmAgentSupportedApisHandler)
 	listener.AddHandler(cns.V2Prefix+cns.GetHomeAz, service.getHomeAz)
 	listener.AddHandler(cns.V2Prefix+cns.EndpointPath, service.EndpointHandlerAPI)
+	listener.AddHandler(cns.V2Prefix+cns.GetNCList, service.nmAgentNCListHandler)
 	// This API is only needed for Direct channel mode with Swift v2.
 	if config.ChannelMode == cns.Direct {
 		listener.AddHandler(cns.V2Prefix+cns.GetVMUniqueID, service.getVMUniqueID)

cns/types/codes.go

@@ -46,6 +46,7 @@ const (
 	FailedToAllocateBackendConfig          ResponseCode = 44
 	ConnectionError                        ResponseCode = 45
 	UnexpectedError                        ResponseCode = 99
+	NmAgentNCVersionListError              ResponseCode = 100
 )
 
 // nolint:gocyclo

nmagent/responses.go

@@ -37,7 +37,7 @@ type NCVersion struct {
 	Version            string `json:"version"` // the current network container version
 }
 
-// NetworkContainerListResponse is a collection of network container IDs mapped
+// NCVersionList is a collection of network container IDs mapped
 // to their current versions.
 type NCVersionList struct {
 	Containers []NCVersion `json:"networkContainers"`