Expose GET NC list API in CNS client

[smittal22]

Reason for Change:
Expose GET NC list API in CNS client. DNC will call this endpoint to fetch the list of NCs programmed on the node.
In the backend, CNS calls NMAgent's http://%s/machine/plugins/?comp=nmagent&type=NetworkManagement/interfaces/api-version/%s endpoint

Requirements:

• uses conventional commit messages
• includes documentation
• adds unit tests
• relevant PR labels added

[smittal22]

/azp run Azure Container Networking PR

[azure-pipelines]

Supported commands

• help:
• Get descriptions, examples and documentation about supported commands
• Example: help "command_name"
• list:
• List all pipelines for this repository using a comment.
• Example: "list"
• run:
• Run all pipelines or specific pipelines for this repository using a comment. Use this command by itself to trigger all related pipelines, or specify specific pipelines to run.
• Example: "run" or "run pipeline_name, pipeline_name, pipeline_name"
• where:
• Report back the Azure DevOps orgs that are related to this repository and org
• Example: "where"

See additional documentation.

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[Copilot]

Copilot reviewed 5 out of 7 changed files in this pull request and generated 1 comment.

Files not reviewed (2)

• cns/restserver/restserver.go: Evaluated as low risk
• nmagent/responses.go: Evaluated as low risk

Comments suppressed due to low confidence (2)

cns/restserver/api.go:1336

• Use respondJSON instead of common.Encode for consistency: respondJSON(w, http.StatusOK, NCListResponse)

serviceErr := common.Encode(w, &NCListResponse)

cns/restserver/api.go:1308

• Initialize returnCode with a default value, e.g., returnCode = types.Success

var returnCode types.ResponseCode

[Copilot]

Copilot reviewed 5 out of 7 changed files in this pull request and generated 2 comments.

Files not reviewed (2)

• cns/restserver/restserver.go: Evaluated as low risk
• nmagent/responses.go: Evaluated as low risk

Comments suppressed due to low confidence (2)

cns/restserver/api_test.go:1327

• [nitpick] The test case should assert based on the expected behavior of the API. If the list is expected to contain items, adjust the assertion accordingly.

require.Empty(t, nmAgentNCListResponse.NCList)

cns/api.go:31

• [nitpick] The constant name NMAgentGetNCListAPIPath should be renamed to GetNCListPath to match the existing naming convention.

NMAgentGetNCListAPIPath       = "/nclist"

[Copilot]

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

[smittal22]

/azp run Azure Container Networking PR

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[smittal22]

/azp run Azure Container Networking PR

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[smittal22]

CNS log when DNC calls this endpoint:

2025/02/26 20:08:26 [6596] [azure-cns] Received string nmAgentNCListHandler.
2025/02/26 20:08:26 [6596] [azure-cns] Sent *cns.NCListResponse &{Response:{ReturnCode:Success Message:Successfully fetched NC list from NMAgent} NCList:[86fd8b75-94b7-23d8-6ca4-6821b082111f]}.