Update artifact tarball when spec.ignore changes

This commit adds a new field `status.ignoreChecksum` which is used to detect changes on `spec.ignore`, that controls the exclusions for the object's `status.artifact`

Signed-off-by: Tiago Angelo <[email protected]>

Author: angelokurtis

api/v1beta2/bucket_types.go

@@ -17,6 +17,8 @@ limitations under the License.
 package v1beta2
 
 import (
+	"crypto/sha256"
+	"fmt"
 	"time"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -124,6 +126,11 @@ type BucketStatus struct {
 	// +optional
 	Artifact *Artifact `json:"artifact,omitempty"`
 
+	// IgnoreChecksum is a SHA256 checksum of the excluded patterns applied
+	// in the last reconciliation.
+	// +optional
+	IgnoreChecksum string `json:"ignoreChecksum,omitempty"`
+
 	meta.ReconcileRequestStatus `json:",inline"`
 }
 
@@ -157,6 +164,27 @@ func (in *Bucket) GetArtifact() *Artifact {
 	return in.Status.Artifact
 }
 
+// UpdateIgnoreChecksum updates the checksum of excluded patterns in the status sub-resource.
+func (in *Bucket) UpdateIgnoreChecksum() {
+	var checksum string
+	if in.Spec.Ignore != nil {
+		ignore := []byte(*in.Spec.Ignore)
+		checksum = fmt.Sprintf("%x", sha256.Sum256(ignore))
+	}
+	in.Status.IgnoreChecksum = checksum
+}
+
+// IgnoreHasChanged compares the checksum of excluded patterns applied in the last reconciliation
+// with the current spec and returns true if values are different.
+func (in *Bucket) IgnoreHasChanged() bool {
+	var checksum string
+	if in.Spec.Ignore != nil {
+		ignore := []byte(*in.Spec.Ignore)
+		checksum = fmt.Sprintf("%x", sha256.Sum256(ignore))
+	}
+	return in.Status.IgnoreChecksum != checksum
+}
+
 // +genclient
 // +genclient:Namespaced
 // +kubebuilder:storageversion

api/v1beta2/gitrepository_types.go

@@ -17,6 +17,8 @@ limitations under the License.
 package v1beta2
 
 import (
+	"crypto/sha256"
+	"fmt"
 	"time"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -211,6 +213,11 @@ type GitRepositoryStatus struct {
 	// +optional
 	IncludedArtifacts []*Artifact `json:"includedArtifacts,omitempty"`
 
+	// IgnoreChecksum is a SHA256 checksum of the excluded patterns applied
+	// in the last reconciliation.
+	// +optional
+	IgnoreChecksum string `json:"ignoreChecksum,omitempty"`
+
 	meta.ReconcileRequestStatus `json:",inline"`
 }
 
@@ -246,6 +253,27 @@ func (in *GitRepository) GetArtifact() *Artifact {
 	return in.Status.Artifact
 }
 
+// UpdateIgnoreChecksum updates the checksum of excluded patterns in the status sub-resource.
+func (in *GitRepository) UpdateIgnoreChecksum() {
+	var checksum string
+	if in.Spec.Ignore != nil {
+		ignore := []byte(*in.Spec.Ignore)
+		checksum = fmt.Sprintf("%x", sha256.Sum256(ignore))
+	}
+	in.Status.IgnoreChecksum = checksum
+}
+
+// IgnoreHasChanged compares the checksum of excluded patterns applied in the last reconciliation
+// with the current spec and returns true if values are different.
+func (in *GitRepository) IgnoreHasChanged() bool {
+	var checksum string
+	if in.Spec.Ignore != nil {
+		ignore := []byte(*in.Spec.Ignore)
+		checksum = fmt.Sprintf("%x", sha256.Sum256(ignore))
+	}
+	return in.Status.IgnoreChecksum != checksum
+}
+
 // +genclient
 // +genclient:Namespaced
 // +kubebuilder:storageversion

config/crd/bases/source.toolkit.fluxcd.io_buckets.yaml

@@ -478,6 +478,10 @@ spec:
                   - type
                   type: object
                 type: array
+              ignoreChecksum:
+                description: IgnoreChecksum is a SHA256 checksum of the excluded patterns
+                  applied in the last reconciliation.
+                type: string
               lastHandledReconcileAt:
                 description: LastHandledReconcileAt holds the value of the most recent
                   reconcile request value, so a change of the annotation value can

config/crd/bases/source.toolkit.fluxcd.io_gitrepositories.yaml

@@ -653,6 +653,10 @@ spec:
                   - type
                   type: object
                 type: array
+              ignoreChecksum:
+                description: IgnoreChecksum is a SHA256 checksum of the excluded patterns
+                  applied in the last reconciliation.
+                type: string
               includedArtifacts:
                 description: IncludedArtifacts contains a list of the last successfully
                   included Artifacts as instructed by GitRepositorySpec.Include.

controllers/bucket_controller.go

@@ -28,7 +28,6 @@ import (
 	"sync"
 	"time"
 
-	"github.com/fluxcd/source-controller/pkg/azure"
 	"golang.org/x/sync/errgroup"
 	"golang.org/x/sync/semaphore"
 	corev1 "k8s.io/api/core/v1"
@@ -42,6 +41,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/predicate"
 	"sigs.k8s.io/controller-runtime/pkg/ratelimiter"
 
+	"github.com/fluxcd/source-controller/pkg/azure"
+
 	"github.com/fluxcd/pkg/apis/meta"
 	"github.com/fluxcd/pkg/runtime/conditions"
 	helper "github.com/fluxcd/pkg/runtime/controller"
@@ -564,19 +565,22 @@ func (r *BucketReconciler) reconcileArtifact(ctx context.Context, obj *sourcev1.
 
 	// Set the ArtifactInStorageCondition if there's no drift.
 	defer func() {
-		if obj.GetArtifact().HasRevision(artifact.Revision) {
+		if obj.GetArtifact().HasRevision(artifact.Revision) && !obj.IgnoreHasChanged() {
 			conditions.Delete(obj, sourcev1.ArtifactOutdatedCondition)
 			conditions.MarkTrue(obj, sourcev1.ArtifactInStorageCondition, meta.SucceededReason,
 				"stored artifact for revision '%s'", artifact.Revision)
 		}
 	}()
 
 	// The artifact is up-to-date
-	if obj.GetArtifact().HasRevision(artifact.Revision) {
+	if obj.GetArtifact().HasRevision(artifact.Revision) && !obj.IgnoreHasChanged() {
 		r.eventLogf(ctx, obj, events.EventTypeTrace, sourcev1.ArtifactUpToDateReason, "artifact up-to-date with remote revision: '%s'", artifact.Revision)
 		return sreconcile.ResultSuccess, nil
 	}
 
+	// If needed, updates ignore checksum
+	obj.UpdateIgnoreChecksum()
+
 	// Ensure target path exists and is a directory
 	if f, err := os.Stat(dir); err != nil {
 		e := &serror.Event{

controllers/gitrepository_controller.go

@@ -500,19 +500,22 @@ func (r *GitRepositoryReconciler) reconcileArtifact(ctx context.Context,
 
 	// Set the ArtifactInStorageCondition if there's no drift.
 	defer func() {
-		if obj.GetArtifact().HasRevision(artifact.Revision) && !includes.Diff(obj.Status.IncludedArtifacts) {
+		if obj.GetArtifact().HasRevision(artifact.Revision) && !includes.Diff(obj.Status.IncludedArtifacts) && !obj.IgnoreHasChanged() {
 			conditions.Delete(obj, sourcev1.ArtifactOutdatedCondition)
 			conditions.MarkTrue(obj, sourcev1.ArtifactInStorageCondition, meta.SucceededReason,
 				"stored artifact for revision '%s'", artifact.Revision)
 		}
 	}()
 
 	// The artifact is up-to-date
-	if obj.GetArtifact().HasRevision(artifact.Revision) && !includes.Diff(obj.Status.IncludedArtifacts) {
+	if obj.GetArtifact().HasRevision(artifact.Revision) && !includes.Diff(obj.Status.IncludedArtifacts) && !obj.IgnoreHasChanged() {
 		r.eventLogf(ctx, obj, events.EventTypeTrace, sourcev1.ArtifactUpToDateReason, "artifact up-to-date with remote revision: '%s'", artifact.Revision)
 		return sreconcile.ResultSuccess, nil
 	}
 
+	// If needed, updates ignore checksum
+	obj.UpdateIgnoreChecksum()
+
 	// Ensure target path exists and is a directory
 	if f, err := os.Stat(dir); err != nil {
 		e := &serror.Event{