Merge pull request vmware-tanzu#1040 from zhengxiexie/topic/zhengxie/main/refactor_inventory

Refactor inventory utils

Author: zhengxiexie

pkg/controllers/inventory/pod_handler.go

@@ -48,7 +48,7 @@ func (c *InventoryController) handlePod(obj interface{}) {
 	case cache.DeletedFinalStateUnknown:
 		pod, ok = obj1.Obj.(*v1.Pod)
 		if !ok {
-			err := fmt.Errorf("Obj is not valid *v1.Pod")
+			err := fmt.Errorf("obj is not valid *v1.Pod")
 			log.Error(err, "DeletedFinalStateUnknown Obj is not *v1.Pod")
 			return
 		}

pkg/nsx/services/inventory/build.go

@@ -18,7 +18,7 @@ func (s *InventoryService) BuildPod(pod *corev1.Pod) (retry bool) {
 	log.Info("Add Pod ", "Pod", pod.Name, "Namespace", pod.Namespace)
 	retry = false
 	// Calculate the services related to this Pod from pendingAdd or inventory store.
-	containerApplicationIds := []string{}
+	var containerApplicationIds []string
 	if s.pendingAdd[string(pod.UID)] != nil {
 		containerApplicationInstance := s.pendingAdd[string(pod.UID)].(*containerinventory.ContainerApplicationInstance)
 		containerApplicationIds = containerApplicationInstance.ContainerApplicationIds
@@ -35,7 +35,7 @@ func (s *InventoryService) BuildPod(pod *corev1.Pod) (retry bool) {
 	err := s.Client.Get(context.TODO(), types.NamespacedName{Name: namespaceName}, namespace)
 	if err != nil {
 		retry = true
-		log.Error(errors.New("Not find namespace for Pod"), "Failed to build Pod", "Pod", pod)
+		log.Error(errors.New("not find namespace for Pod"), "Failed to build Pod", "Pod", pod)
 		return
 	}
 
@@ -105,7 +105,7 @@ func (s *InventoryService) BuildInventoryCluster() containerinventory.ContainerC
 
 	clusterType := InventoryClusterTypeWCP
 	clusterName := s.NSXConfig.Cluster
-	networkErrors := []common.NetworkError{}
+	var networkErrors []common.NetworkError
 	infra := &containerinventory.ContainerInfrastructureInfo{}
 	infra.InfraType = InventoryInfraTypeVsphere
 	newContainerCluster := containerinventory.ContainerCluster{

pkg/nsx/services/inventory/inventory.go

@@ -14,53 +14,6 @@ import (
 	"k8s.io/client-go/tools/cache"
 )
 
-type InventoryType string
-
-const (
-	// Inventory object types
-	ContainerCluster             InventoryType = "ContainerCluster"
-	ContainerClusterNode         InventoryType = "ContainerClusterNode"
-	ContainerProject             InventoryType = "ContainerProject"
-	ContainerApplication         InventoryType = "ContainerApplication"
-	ContainerApplicationInstance InventoryType = "ContainerApplicationInstance"
-	ContainerNetworkPolicy       InventoryType = "ContainerNetworkPolicy"
-	ContainerIngressPolicy       InventoryType = "ContainerIngressPolicy"
-
-	// Inventory cluster type
-	InventoryClusterTypeWCP = "WCP"
-
-	InventoryClusterCNIType = "NSX-Operator"
-
-	// Inventory network status
-	NetworkStatusHealthy   = "HEALTHY"
-	NetworkStatusUnhealthy = "UNHEALTHY"
-
-	// Inventory infra
-	InventoryInfraTypeVsphere = "vSphere"
-
-	InventoryMaxDisTags = 20
-	InventoryK8sPrefix  = "dis:k8s:"
-	MaxTagLen           = 256
-	MaxResourceTypeLen  = 128
-)
-
-type InventoryKey struct {
-	InventoryType InventoryType
-	ExternalId    string
-	Key           string
-}
-
-const (
-	operationCreate = "CREATE"
-	operationUpdate = "UPDATE"
-	operationDelete = "DELETE"
-	operationNone   = "NONE"
-
-	InventoryStatusUp      = "UP"
-	InventoryStatusDown    = "DOWN"
-	InventoryStatusUnknown = "UNKNOWN"
-)
-
 var (
 	log         = &logger.Log
 	emptyKeySet = sets.New[InventoryKey]()
@@ -223,34 +176,34 @@ func (s *InventoryService) SyncInventoryObject(bufferedKeys sets.Set[InventoryKe
 	return retryKeys, err
 }
 
+func (s *InventoryService) prepareDelete(resourceType InventoryType, externalId string, inventoryObject interface{}) {
+	deletedInfo := map[string]interface{}{
+		"resource_type": resourceType,
+		"external_id":   externalId,
+	}
+	s.requestBuffer = append(s.requestBuffer, containerinventory.ContainerInventoryObject{
+		ContainerObject:  deletedInfo,
+		ObjectUpdateType: operationDelete,
+	})
+	switch resourceType {
+	case ContainerApplicationInstance:
+		s.pendingDelete[externalId] = inventoryObject.(*containerinventory.ContainerApplicationInstance)
+	}
+}
+
 func (s *InventoryService) DeleteResource(externalId string, resourceType InventoryType) error {
 	log.V(1).Info("Delete inventory resource", "resource_type", resourceType, "external_id", externalId)
-	var inventoryObject interface{}
-	exists := false
 	switch resourceType {
-
 	case ContainerApplicationInstance:
-		inventoryObject = s.ApplicationInstanceStore.GetByKey(externalId)
-		if inventoryObject != nil {
-			exists = true
+		inventoryObject := s.ApplicationInstanceStore.GetByKey(externalId)
+		if inventoryObject == nil {
+			return nil
 		}
+		s.prepareDelete(resourceType, externalId, inventoryObject)
+		return s.DeleteContainerApplicationInstance(externalId, inventoryObject.(*containerinventory.ContainerApplicationInstance))
 	default:
 		return fmt.Errorf("unknown resource_type : %v for external_id %s", resourceType, externalId)
 	}
-
-	if exists {
-		deletedInfo := make(map[string]interface{})
-		deletedInfo["resource_type"] = resourceType
-		deletedInfo["external_id"] = externalId
-		s.requestBuffer = append(s.requestBuffer, containerinventory.ContainerInventoryObject{ContainerObject: deletedInfo,
-			ObjectUpdateType: operationDelete})
-		s.pendingDelete[externalId] = inventoryObject.(*containerinventory.ContainerApplicationInstance)
-
-		if resourceType == ContainerApplicationInstance {
-			return s.DeleteContainerApplicationInstance(externalId, inventoryObject.(*containerinventory.ContainerApplicationInstance))
-		}
-	}
-	return nil
 }
 
 func (s *InventoryService) sendNSXRequestAndUpdateInventoryStore() error {
@@ -262,7 +215,9 @@ func (s *InventoryService) sendNSXRequestAndUpdateInventoryStore() error {
 			containerinventory.ContainerInventoryData{ContainerInventoryObjects: s.requestBuffer})
 
 		// Update NSX Inventory store when the request succeeds.
-		log.V(1).Info("NSX request response", "response status code", resp.StatusCode)
+		if resp != nil {
+			log.V(1).Info("NSX request response", "response status code", resp.StatusCode)
+		}
 		if err == nil {
 			err = s.updateInventoryStore()
 		}

pkg/nsx/services/inventory/types.go

@@ -0,0 +1,56 @@
+package inventory
+
+type InventoryType string
+
+const (
+	// ContainerCluster represents the inventory type for a container cluster,
+	// which is a collection of container nodes managed as a single entity.
+	ContainerCluster InventoryType = "ContainerCluster"
+	// ContainerClusterNode represents the inventory type for a node within a container cluster.
+	// Each node is an individual unit of compute resources.
+	ContainerClusterNode InventoryType = "ContainerClusterNode"
+	// ContainerProject represents the inventory type for a containerized project,
+	// typically mapping to a Kubernetes namespace or similar concept.
+	ContainerProject InventoryType = "ContainerProject"
+	// ContainerApplication represents the inventory type for an application
+	// typically mapping to cluster services.
+	ContainerApplication InventoryType = "ContainerApplication"
+	// ContainerApplicationInstance represents the inventory type for a specific instance
+	// typically mapping to pods.
+	ContainerApplicationInstance InventoryType = "ContainerApplicationInstance"
+	// ContainerNetworkPolicy represents the inventory type for network policies
+	// typically mapping to Kubernetes network policies.
+	ContainerNetworkPolicy InventoryType = "ContainerNetworkPolicy"
+	ContainerIngressPolicy InventoryType = "ContainerIngressPolicy"
+
+	// InventoryClusterTypeWCP Inventory cluster type
+	InventoryClusterTypeWCP = "WCP"
+	InventoryClusterCNIType = "NSX-Operator"
+
+	// NetworkStatusHealthy Inventory network status
+	NetworkStatusHealthy   = "HEALTHY"
+	NetworkStatusUnhealthy = "UNHEALTHY"
+
+	// InventoryInfraTypeVsphere Inventory infra
+	InventoryInfraTypeVsphere = "vSphere"
+
+	InventoryMaxDisTags = 20
+	InventoryK8sPrefix  = "dis:k8s:"
+	MaxTagLen           = 256
+	MaxResourceTypeLen  = 128
+
+	operationCreate = "CREATE"
+	operationUpdate = "UPDATE"
+	operationDelete = "DELETE"
+	operationNone   = "NONE"
+
+	InventoryStatusUp      = "UP"
+	InventoryStatusDown    = "DOWN"
+	InventoryStatusUnknown = "UNKNOWN"
+)
+
+type InventoryKey struct {
+	InventoryType InventoryType
+	ExternalId    string
+	Key           string
+}