fix: address comments

Author: santhoshmprabhu

cns/restserver/helper_for_nodesubnet_test.go

@@ -14,6 +14,7 @@ import (
 	"github.com/Azure/azure-container-networking/store"
 )
 
+// GetRestServiceObjectForNodeSubnetTest creates a new HTTPRestService object for use in nodesubnet unit tests.
 func GetRestServiceObjectForNodeSubnetTest(t *testing.T, generator CNIConflistGenerator) *HTTPRestService {
 	config := &common.ServiceConfig{
 		Name:        "test",

cns/restserver/nodesubnet.go

@@ -56,6 +56,8 @@ func (service *HTTPRestService) InitializeNodeSubnet(ctx context.Context, podInf
 	return nil
 }
 
+// StartNodeSubnet starts the IP fetcher for NodeSubnet. This will cause secondary IPs to be fetched periodically.
+// After the first successful fetch, conflist will be generated to indicate CNS is ready.
 func (service *HTTPRestService) StartNodeSubnet(ctx context.Context) {
 	service.nodesubnetIPFetcher.Start(ctx)
 }

cns/restserver/nodesubnet_test.go

@@ -12,6 +12,7 @@ import (
 	"github.com/Azure/azure-container-networking/store"
 )
 
+// getMockStore creates a mock KeyValueStore with some endpoint state
 func getMockStore() store.KeyValueStore {
 	mockStore := store.NewMockStore("")
 	endpointState := map[string]*restserver.EndpointInfo{
@@ -67,13 +68,15 @@ func (m *MockCNIConflistGenerator) Close() error {
 	return nil
 }
 
+// TestNodeSubnet tests initialization of NodeSubnet with endpoint info, and verfies that
+// the conflist is generated after fetching secondary IPs
 func TestNodeSubnet(t *testing.T) {
 	podInfoByIPProvider, err := cnireconciler.NewCNSPodInfoProvider(getMockStore())
 	if err != nil {
 		t.Fatalf("NewCNSPodInfoProvider returned an error: %v", err)
 	}
 
-	// Create a real HTTPRestService object
+	// create a real HTTPRestService object
 	mockCNIConflistGenerator := &MockCNIConflistGenerator{
 		GenerateCalled: make(chan struct{}),
 	}
@@ -111,6 +114,7 @@ func TestNodeSubnet(t *testing.T) {
 	checkIPassignment(t, service, expectedIPs)
 }
 
+// checkIPassignment checks whether the IP assignment state in the HTTPRestService object matches expectation
 func checkIPassignment(t *testing.T, service *restserver.HTTPRestService, expectedIPs map[string]types.IPState) {
 	if len(service.PodIPConfigState) != len(expectedIPs) {
 		t.Fatalf("expected 2 entries in PodIPConfigState, got %d", len(service.PodIPConfigState))