🐛 Fix reconcile where status was taken into account

pkg/controller/plugin/watcher.go

@@ -441,6 +441,20 @@ func (ow *objectWatcher) removeFilter(f *objectWatch) bool {
 	ow.logger.Info("removing filter")
 
 	delete(ow.filters, f)
+
+	// Flush delete events objects.
+	objects := ow.store.List()
+
+	for _, obj := range objects {
+		co, ok := obj.(client.Object)
+		if !ok {
+			ow.logger.Info("invalid object type")
+			continue
+		}
+
+		ow.handleForFilter(co, f, true)
+	}
+
 	return len(ow.filters) == 0
 }
 

pkg/pipeline/capsule_request.go

@@ -127,6 +127,7 @@ func newCapsuleRequest(
 
 	if capsule.Status != nil {
 		r.observedGeneration = capsule.Status.ObservedGeneration
+		r.lastErrors = capsule.Status.Errors
 	}
 
 	r.logger.Info("created capsule request",
@@ -266,6 +267,7 @@ func (r *capsuleRequest) UpdateStatusWithChanges(
 	}
 
 	r.observedGeneration = generation
+	r.lastErrors = status.Errors
 	r.capsule.Status = status
 	r.capsule.SetResourceVersion(capsuleCopy.GetResourceVersion())
 	r.logger.Info("updated status with changes", "resource_version", capsuleCopy.GetResourceVersion())
@@ -293,6 +295,7 @@ func (r *capsuleRequest) UpdateStatusWithError(ctx context.Context, err error) e
 		return err
 	}
 
+	r.lastErrors = status.Errors
 	r.capsule.Status = status
 	r.capsule.SetResourceVersion(capsuleCopy.GetResourceVersion())
 	r.logger.Info("updated status with error", "resource_version", capsuleCopy.GetResourceVersion())

pkg/pipeline/request.go

@@ -106,6 +106,7 @@ type RequestState struct {
 	existingObjects    map[ObjectKey]client.Object
 	newObjects         map[ObjectKey]*Object
 	observedGeneration int64
+	lastErrors         []string
 	dryRun             bool
 	force              bool
 }
@@ -421,7 +422,12 @@ func (r *RequestBase) Commit(ctx context.Context) (map[ObjectKey]*Change, error)
 			return nil, fmt.Errorf("could not render update to %s: %w", key, err)
 		}
 
-		if ObjectsEquals(cObj.Current, materializedObj) {
+		equal, err := ObjectsEquals(cObj.Current, materializedObj, r.scheme)
+		if err != nil {
+			return nil, err
+		}
+
+		if equal {
 			r.logger.Info("update object skipped, not changed", "object", key)
 			changes[key] = &Change{state: ResourceStateUnchanged}
 			continue
@@ -430,11 +436,12 @@ func (r *RequestBase) Commit(ctx context.Context) (map[ObjectKey]*Change, error)
 		cObj.Materialized = normalizeObject(key, materializedObj)
 
 		r.logger.Info("update object", "object", key)
+
 		changes[key] = &Change{state: ResourceStateUpdated}
 	}
 
 	// Skip update if no changes.
-	if r.observedGeneration == r.requestObject.GetGeneration() {
+	if r.observedGeneration == r.requestObject.GetGeneration() && len(r.lastErrors) == 0 {
 		r.logger.Info("already at generation", "generation", r.observedGeneration)
 		hasChanges := false
 		for _, change := range changes {

pkg/pipeline/types.go

@@ -1,36 +1,41 @@
 package pipeline
 
 import (
-	monitorv1 "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1"
+	"github.com/rigdev/rig/pkg/obj"
 	appsv1 "k8s.io/api/apps/v1"
-	"k8s.io/apimachinery/pkg/api/equality"
-	"k8s.io/apimachinery/pkg/runtime/schema"
+	"k8s.io/apimachinery/pkg/runtime"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
-var (
-	AppsDeploymentGVK           = appsv1.SchemeGroupVersion.WithKind("Deployment")
-	MonitoringServiceMonitorGVK = monitorv1.SchemeGroupVersion.WithKind(monitorv1.ServiceMonitorsKind)
-)
+var AppsDeploymentGVK = appsv1.SchemeGroupVersion.WithKind("Deployment")
 
-type ObjectsEqual func(o1, o2 client.Object) bool
+func ObjectsEquals(o1, o2 client.Object, scheme *runtime.Scheme) (bool, error) {
+	comp := obj.NewComparison(o1, o2, scheme)
 
-var _objectsEquals = map[schema.GroupVersionKind]ObjectsEqual{
-	MonitoringServiceMonitorGVK: func(o1, o2 client.Object) bool {
-		return equality.Semantic.DeepEqual(o1.(*monitorv1.ServiceMonitor).Spec, o2.(*monitorv1.ServiceMonitor).Spec)
-	},
-	AppsDeploymentGVK: func(o1, o2 client.Object) bool {
-		return equality.Semantic.DeepEqual(o1.(*appsv1.Deployment).Spec, o2.(*appsv1.Deployment).Spec)
-	},
-}
+	// Ignore deployment-revision. This is added in a post-step by the deployment step.
+	comp.AddFilter(obj.RemoveAnnotationsFilter(
+		"deployment.kubernetes.io/revision",
+	))
 
-func ObjectsEquals(o1, o2 client.Object) bool {
-	objectsEqual, ok := _objectsEquals[o1.GetObjectKind().GroupVersionKind()]
-	if !ok {
-		objectsEqual = func(o1, o2 client.Object) bool {
-			return equality.Semantic.DeepEqual(o1, o2)
-		}
+	// Always ignore `status` properties.
+	comp.AddRemoveDiffs("status")
+
+	diff, err := comp.ComputeDiff()
+	if err != nil {
+		return false, err
 	}
 
-	return objectsEqual(o1, o2)
+	// Out-comment this for pretty-printing the diff between the files.
+	/*
+		hr := &dyff.HumanReport{
+			Report:     *diff.Report,
+			OmitHeader: true,
+		}
+
+		if err := hr.WriteReport(os.Stderr); err != nil {
+			panic(err)
+		}
+		// */
+
+	return len(diff.Report.Diffs) == 0, nil
 }