rename to aggregator, add testing

Author: piceri

cmd/deployment-tracker/main.go

@@ -122,8 +122,8 @@ func main() {
 		os.Exit(1)
 	}
 
-	// Create MetadataService
-	metadataService := metadata.NewMetadataService(metadataClient)
+	// Create metadata aggregator
+	metadataAggregator := metadata.NewAggregator(metadataClient)
 
 	// Start the metrics server
 	var promSrv = &http.Server{
@@ -164,7 +164,7 @@ func main() {
 		cancel()
 	}()
 
-	cntrl, err := controller.New(clientset, metadataService, namespace, excludeNamespaces, &cntrlCfg)
+	cntrl, err := controller.New(clientset, metadataAggregator, namespace, excludeNamespaces, &cntrlCfg)
 	if err != nil {
 		slog.Error("Failed to create controller",
 			"error", err)

internal/controller/controller.go

@@ -39,6 +39,10 @@ type ttlCache interface {
 	Delete(k any)
 }
 
+type podMetadataAggregator interface {
+	AggregatePodMetadata(ctx context.Context, obj *metav1.PartialObjectMetadata) *metadata.AggregatePodMetadata
+}
+
 // PodEvent represents a pod event to be processed.
 type PodEvent struct {
 	Key        string
@@ -48,20 +52,20 @@ type PodEvent struct {
 
 // Controller is the Kubernetes controller for tracking deployments.
 type Controller struct {
-	clientset       kubernetes.Interface
-	metadataService *metadata.MetadataService
-	podInformer     cache.SharedIndexInformer
-	workqueue       workqueue.TypedRateLimitingInterface[PodEvent]
-	apiClient       *deploymentrecord.Client
-	cfg             *Config
+	clientset          kubernetes.Interface
+	metadataAggregator podMetadataAggregator
+	podInformer        cache.SharedIndexInformer
+	workqueue          workqueue.TypedRateLimitingInterface[PodEvent]
+	apiClient          *deploymentrecord.Client
+	cfg                *Config
 	// best effort cache to avoid redundant posts
 	// post requests are idempotent, so if this cache fails due to
 	// restarts or other events, nothing will break.
 	observedDeployments ttlCache
 }
 
 // New creates a new deployment tracker controller.
-func New(clientset kubernetes.Interface, metadataService *metadata.MetadataService, namespace string, excludeNamespaces string, cfg *Config) (*Controller, error) {
+func New(clientset kubernetes.Interface, metadataAggregator podMetadataAggregator, namespace string, excludeNamespaces string, cfg *Config) (*Controller, error) {
 	// Create informer factory
 	factory := createInformerFactory(clientset, namespace, excludeNamespaces)
 
@@ -94,7 +98,7 @@ func New(clientset kubernetes.Interface, metadataService *metadata.MetadataServi
 
 	cntrl := &Controller{
 		clientset:           clientset,
-		metadataService:     metadataService,
+		metadataAggregator:  metadataAggregator,
 		podInformer:         podInformer,
 		workqueue:           queue,
 		apiClient:           apiClient,
@@ -348,7 +352,7 @@ func (c *Controller) processEvent(ctx context.Context, event PodEvent) error {
 	// Gather aggregate metadata for adds/updates
 	var aggPodMetadata *metadata.AggregatePodMetadata
 	if status != deploymentrecord.StatusDecommissioned {
-		aggPodMetadata = c.metadataService.AggregatePodMetadata(ctx, podToPartialMetadata(pod))
+		aggPodMetadata = c.metadataAggregator.AggregatePodMetadata(ctx, podToPartialMetadata(pod))
 	}
 
 	// Record info for each container in the pod

internal/metadata/metadata.go

@@ -26,7 +26,8 @@ const (
 	MaxCustomTagLength = 100
 )
 
-type MetadataService struct {
+// Aggregator uses the Kubernetes metadata client to aggregate metadata for a pod and its ownership hierarchy.
+type Aggregator struct {
 	metadataClient k8smetadata.Interface
 }
 
@@ -36,13 +37,15 @@ type AggregatePodMetadata struct {
 	Tags         map[string]string
 }
 
-func NewMetadataService(metadataClient k8smetadata.Interface) *MetadataService {
-	return &MetadataService{
+// NewAggregator creates a new Aggregator with a Kubernetes metadata client.
+func NewAggregator(metadataClient k8smetadata.Interface) *Aggregator {
+	return &Aggregator{
 		metadataClient: metadataClient,
 	}
 }
 
-func (ms *MetadataService) AggregatePodMetadata(ctx context.Context, obj *metav1.PartialObjectMetadata) *AggregatePodMetadata {
+// AggregatePodMetadata takes a pod's partial object metadata and traverses its ownership hierarchy to return AggregatePodMetadata.
+func (m *Aggregator) AggregatePodMetadata(ctx context.Context, obj *metav1.PartialObjectMetadata) *AggregatePodMetadata {
 	aggMetadata := &AggregatePodMetadata{
 		RuntimeRisks: make(map[deploymentrecord.RuntimeRisk]bool),
 		Tags:         make(map[string]string),
@@ -64,19 +67,19 @@ func (ms *MetadataService) AggregatePodMetadata(ctx context.Context, obj *metav1
 		visited[current.GetUID()] = true
 
 		extractMetadataFromObject(current, aggMetadata)
-		ms.addOwnersToQueue(ctx, current, &queue)
+		m.addOwnersToQueue(ctx, current, &queue)
 	}
 
 	return aggMetadata
 }
 
 // addOwnersToQueue takes a current object and looks up its owners, adding them to the queue for processing
 // to collect their metadata.
-func (ms *MetadataService) addOwnersToQueue(ctx context.Context, current *metav1.PartialObjectMetadata, queue *[]*metav1.PartialObjectMetadata) {
+func (m *Aggregator) addOwnersToQueue(ctx context.Context, current *metav1.PartialObjectMetadata, queue *[]*metav1.PartialObjectMetadata) {
 	ownerRefs := current.GetOwnerReferences()
 
 	for _, owner := range ownerRefs {
-		ownerObj, err := ms.getOwnerMetadata(ctx, current.GetNamespace(), owner)
+		ownerObj, err := m.getOwnerMetadata(ctx, current.GetNamespace(), owner)
 		if err != nil {
 			slog.Warn("Failed to get owner object for metadata collection",
 				"namespace", current.GetNamespace(),
@@ -96,7 +99,7 @@ func (ms *MetadataService) addOwnersToQueue(ctx context.Context, current *metav1
 }
 
 // getOwnerMetadata retrieves partial object metadata for an owner ref.
-func (ms *MetadataService) getOwnerMetadata(ctx context.Context, namespace string, owner metav1.OwnerReference) (*metav1.PartialObjectMetadata, error) {
+func (m *Aggregator) getOwnerMetadata(ctx context.Context, namespace string, owner metav1.OwnerReference) (*metav1.PartialObjectMetadata, error) {
 	gvr := schema.GroupVersionResource{
 		Group:   "apps",
 		Version: "v1",
@@ -115,7 +118,7 @@ func (ms *MetadataService) getOwnerMetadata(ctx context.Context, namespace strin
 		return nil, nil
 	}
 
-	obj, err := ms.metadataClient.Resource(gvr).Namespace(namespace).Get(ctx, owner.Name, metav1.GetOptions{})
+	obj, err := m.metadataClient.Resource(gvr).Namespace(namespace).Get(ctx, owner.Name, metav1.GetOptions{})
 	if err != nil {
 		if k8serrors.IsNotFound(err) {
 			slog.Debug("Owner object not found for metadata collection",