carve out dependent object reconciler (#87)

Author: cbarbian-sap

internal/cluster/types.go

@@ -11,7 +11,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
-// TODO: the Client interface should be public, because it is returned by component.GetClientFromContext()
 // TODO: should we add a Config() method, i.e. expose the rest.Config used by the client?
 
 // The Client interface extends the controller-runtime client by discovery and event recording capabilities.

pkg/cluster/doc.go

@@ -0,0 +1,9 @@
+/*
+SPDX-FileCopyrightText: 2023 SAP SE or an SAP affiliate company and component-operator-runtime contributors
+SPDX-License-Identifier: Apache-2.0
+*/
+
+/*
+Package cluster contains client logic to interact with Kubernetes clusters.
+*/
+package cluster

pkg/cluster/types.go

@@ -0,0 +1,10 @@
+/*
+SPDX-FileCopyrightText: 2023 SAP SE or an SAP affiliate company and component-operator-runtime contributors
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package cluster
+
+import "github.com/sap/component-operator-runtime/internal/cluster"
+
+type Client cluster.Client

pkg/component/component.go

@@ -12,10 +12,8 @@ import (
 	"time"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/apimachinery/pkg/runtime/schema"
 
 	"github.com/sap/component-operator-runtime/internal/walk"
-	"github.com/sap/component-operator-runtime/pkg/types"
 )
 
 // Instantiate given Component type T; panics unless T is a pointer type.
@@ -225,39 +223,3 @@ func (s *Status) SetState(state State, reason string, message string) {
 	cond.Message = message
 	s.State = state
 }
-
-// Get inventory item's ObjectKind accessor.
-func (i *InventoryItem) GetObjectKind() schema.ObjectKind {
-	return i
-}
-
-// Get inventory item's GroupVersionKind.
-func (i InventoryItem) GroupVersionKind() schema.GroupVersionKind {
-	return schema.GroupVersionKind(i.TypeInfo)
-}
-
-// Set inventory item's GroupVersionKind.
-func (i *InventoryItem) SetGroupVersionKind(gvk schema.GroupVersionKind) {
-	i.TypeInfo = TypeInfo(gvk)
-}
-
-// Get inventory item's namespace.
-func (i InventoryItem) GetNamespace() string {
-	return i.Namespace
-}
-
-// Get inventory item's name.
-func (i InventoryItem) GetName() string {
-	return i.Name
-}
-
-// Check whether inventory item matches given ObjectKey, in the sense that Group, Kind, Namespace and Name are the same.
-// Note that this does not compare the group's Version.
-func (i InventoryItem) Matches(key types.ObjectKey) bool {
-	return i.GroupVersionKind().GroupKind() == key.GetObjectKind().GroupVersionKind().GroupKind() && i.Namespace == key.GetNamespace() && i.Name == key.GetName()
-}
-
-// Return a string representation of the inventory item; makes InventoryItem implement the Stringer interface.
-func (i InventoryItem) String() string {
-	return types.ObjectKeyToString(&i)
-}

pkg/component/context.go

@@ -9,7 +9,7 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/sap/component-operator-runtime/internal/cluster"
+	"github.com/sap/component-operator-runtime/pkg/cluster"
 )
 
 type reconcilerNameContextKey struct{}

pkg/component/reconcile.go pkg/component/reconciler.gopkg/component/reconcile.go renamed to pkg/component/reconciler.go

@@ -32,8 +32,9 @@ import (
 
 	"github.com/sap/component-operator-runtime/internal/backoff"
 	"github.com/sap/component-operator-runtime/internal/cluster"
-	"github.com/sap/component-operator-runtime/internal/kstatus"
 	"github.com/sap/component-operator-runtime/pkg/manifests"
+	"github.com/sap/component-operator-runtime/pkg/reconciler"
+	"github.com/sap/component-operator-runtime/pkg/status"
 	"github.com/sap/component-operator-runtime/pkg/types"
 )
 
@@ -77,11 +78,11 @@ type ReconcilerOptions struct {
 	// How to react if a dependent object exists but has no or a different owner.
 	// If unspecified, AdoptionPolicyIfUnowned is assumed.
 	// Can be overridden by annotation on object level.
-	AdoptionPolicy *AdoptionPolicy
+	AdoptionPolicy *reconciler.AdoptionPolicy
 	// How to perform updates to dependent objects.
 	// If unspecified, UpdatePolicyReplace is assumed.
 	// Can be overridden by annotation on object level.
-	UpdatePolicy *UpdatePolicy
+	UpdatePolicy *reconciler.UpdatePolicy
 	// Schemebuilder allows to define additional schemes to be made available in the
 	// target client.
 	SchemeBuilder types.SchemeBuilder
@@ -93,7 +94,7 @@ type Reconciler[T Component] struct {
 	id                 string
 	client             cluster.Client
 	resourceGenerator  manifests.Generator
-	statusAnalyzer     kstatus.StatusAnalyzer
+	statusAnalyzer     status.StatusAnalyzer
 	options            ReconcilerOptions
 	clients            *cluster.ClientFactory
 	backoff            *backoff.Backoff
@@ -115,19 +116,21 @@ func NewReconciler[T Component](name string, resourceGenerator manifests.Generat
 		options.CreateMissingNamespaces = ref(true)
 	}
 	if options.AdoptionPolicy == nil {
-		options.AdoptionPolicy = ref(AdoptionPolicyIfUnowned)
+		options.AdoptionPolicy = ref(reconciler.AdoptionPolicyIfUnowned)
 	}
 	if options.UpdatePolicy == nil {
-		options.UpdatePolicy = ref(UpdatePolicyReplace)
+		options.UpdatePolicy = ref(reconciler.UpdatePolicyReplace)
 	}
 
 	return &Reconciler[T]{
 		name:              name,
 		resourceGenerator: resourceGenerator,
-		statusAnalyzer:    kstatus.NewStatusAnalyzer(name),
-		options:           options,
-		backoff:           backoff.NewBackoff(10 * time.Second),
-		postReadHooks:     []HookFunc[T]{resolveReferences[T]},
+		// TODO: make statusAnalyzer specifiable via options?
+		statusAnalyzer: status.NewStatusAnalyzer(name),
+		options:        options,
+		// TODO: make backoff configurable via options?
+		backoff:       backoff.NewBackoff(10 * time.Second),
+		postReadHooks: []HookFunc[T]{resolveReferences[T]},
 	}
 }
 
@@ -248,7 +251,12 @@ func (r *Reconciler[T]) Reconcile(ctx context.Context, req ctrl.Request) (result
 	if err != nil {
 		return ctrl.Result{}, errors.Wrap(err, "error getting client for component")
 	}
-	target := newReconcileTarget[T](r.name, r.id, targetClient, r.resourceGenerator, r.statusAnalyzer, *r.options.CreateMissingNamespaces, *r.options.AdoptionPolicy, *r.options.UpdatePolicy)
+	target := newReconcileTarget[T](r.name, r.id, targetClient, r.resourceGenerator, reconciler.ReconcilerOptions{
+		CreateMissingNamespaces: r.options.CreateMissingNamespaces,
+		AdoptionPolicy:          r.options.AdoptionPolicy,
+		UpdatePolicy:            r.options.UpdatePolicy,
+		StatusAnalyzer:          r.statusAnalyzer,
+	})
 	hookCtx := newContext(ctx).WithClient(targetClient)
 
 	// do the reconciliation
@@ -271,7 +279,7 @@ func (r *Reconciler[T]) Reconcile(ctx context.Context, req ctrl.Request) (result
 				return ctrl.Result{}, errors.Wrapf(err, "error running pre-reconcile hook (%d)", hookOrder)
 			}
 		}
-		ok, err := target.Reconcile(ctx, component)
+		ok, err := target.Apply(ctx, component)
 		if err != nil {
 			log.V(1).Info("error while reconciling dependent resources")
 			return ctrl.Result{}, errors.Wrap(err, "error reconciling dependent resources")