Calculate checksums during file writes

Author: hiddeco

api/v1alpha1/gitrepository_types.go

@@ -122,62 +122,45 @@ const (
 	GitOperationFailedReason string = "GitOperationFailed"
 )
 
-// GitRepositoryReady sets the given artifact and url on the
-// GitRepository and resets the conditions to SourceCondition of
-// type Ready with status true and the given reason and message.
-// It returns the modified GitRepository.
-func GitRepositoryReady(repository GitRepository, artifact Artifact, url, reason, message string) GitRepository {
-	repository.Status.Conditions = []SourceCondition{
-		{
-			Type:               ReadyCondition,
-			Status:             corev1.ConditionTrue,
-			LastTransitionTime: metav1.Now(),
-			Reason:             reason,
-			Message:            message,
-		},
-	}
-	repository.Status.URL = url
-
-	if repository.Status.Artifact != nil {
-		if repository.Status.Artifact.Path != artifact.Path {
-			repository.Status.Artifact = &artifact
-		}
-	} else {
-		repository.Status.Artifact = &artifact
-	}
-
-	return repository
-}
-
 // GitRepositoryProgressing resets the conditions of the GitRepository
 // to SourceCondition of type Ready with status unknown and
 // progressing reason and message. It returns the modified GitRepository.
 func GitRepositoryProgressing(repository GitRepository) GitRepository {
-	repository.Status.Conditions = []SourceCondition{
-		{
-			Type:               ReadyCondition,
-			Status:             corev1.ConditionUnknown,
-			LastTransitionTime: metav1.Now(),
-			Reason:             ProgressingReason,
-			Message:            "reconciliation in progress",
-		},
-	}
+	repository.Status.URL = ""
+	repository.Status.Artifact = nil
+	repository.Status.Conditions = []SourceCondition{}
+	SetGitRepositoryCondition(&repository, ReadyCondition, corev1.ConditionUnknown, ProgressingReason, "reconciliation in progress")
 	return repository
 }
 
-// GitRepositoryNotReady resets the conditions of the GitRepository
-// to SourceCondition of type Ready with status false and the given
-// reason and message. It returns the modified GitRepository.
+// SetGitRepositoryCondition sets the given condition with the given status, reason and message
+// on the GitRepository.
+func SetGitRepositoryCondition(repository *GitRepository, condition string, status corev1.ConditionStatus, reason, message string) {
+	repository.Status.Conditions = filterOutSourceCondition(repository.Status.Conditions, condition)
+	repository.Status.Conditions = append(repository.Status.Conditions, SourceCondition{
+		Type:               condition,
+		Status:             status,
+		LastTransitionTime: metav1.Now(),
+		Reason:             reason,
+		Message:            message,
+	})
+}
+
+// GitRepositoryReady sets the given artifact and url on the GitRepository
+// and sets the ReadyCondition to True, with the given reason and
+// message. It returns the modified GitRepository.
+func GitRepositoryReady(repository GitRepository, artifact Artifact, url, reason, message string) GitRepository {
+	repository.Status.Artifact = &artifact
+	repository.Status.URL = url
+	SetGitRepositoryCondition(&repository, ReadyCondition, corev1.ConditionTrue, reason, message)
+	return repository
+}
+
+// GitRepositoryNotReady sets the ReadyCondition on the given GitRepository
+// to False, with the given reason and message. It returns the modified
+// GitRepository.
 func GitRepositoryNotReady(repository GitRepository, reason, message string) GitRepository {
-	repository.Status.Conditions = []SourceCondition{
-		{
-			Type:               ReadyCondition,
-			Status:             corev1.ConditionFalse,
-			LastTransitionTime: metav1.Now(),
-			Reason:             reason,
-			Message:            message,
-		},
-	}
+	SetGitRepositoryCondition(&repository, ReadyCondition, corev1.ConditionFalse, reason, message)
 	return repository
 }
 

api/v1alpha1/helmchart_types.go

@@ -92,7 +92,7 @@ const (
 	ChartPackageSucceededReason string = "ChartPackageSucceeded"
 )
 
-// HelmReleaseProgressing resets any failures and registers progress toward reconciling the given HelmRelease
+// HelmChartProgressing resets any failures and registers progress toward reconciling the given HelmChart
 // by setting the ReadyCondition to ConditionUnknown for ProgressingReason.
 func HelmChartProgressing(chart HelmChart) HelmChart {
 	chart.Status.URL = ""

api/v1alpha1/helmrepository_types.go

@@ -76,62 +76,45 @@ const (
 	IndexationSucceededReason string = "IndexationSucceed"
 )
 
-// HelmRepositoryReady sets the given artifact and url on the
-// HelmRepository and resets the conditions to SourceCondition of
-// type Ready with status true and the given reason and message.
-// It returns the modified HelmRepository.
-func HelmRepositoryReady(repository HelmRepository, artifact Artifact, url, reason, message string) HelmRepository {
-	repository.Status.Conditions = []SourceCondition{
-		{
-			Type:               ReadyCondition,
-			Status:             corev1.ConditionTrue,
-			LastTransitionTime: metav1.Now(),
-			Reason:             reason,
-			Message:            message,
-		},
-	}
-	repository.Status.URL = url
-
-	if repository.Status.Artifact != nil {
-		if repository.Status.Artifact.Path != artifact.Path {
-			repository.Status.Artifact = &artifact
-		}
-	} else {
-		repository.Status.Artifact = &artifact
-	}
-
-	return repository
-}
-
 // HelmRepositoryProgressing resets the conditions of the HelmRepository
 // to SourceCondition of type Ready with status unknown and
 // progressing reason and message. It returns the modified HelmRepository.
 func HelmRepositoryProgressing(repository HelmRepository) HelmRepository {
-	repository.Status.Conditions = []SourceCondition{
-		{
-			Type:               ReadyCondition,
-			Status:             corev1.ConditionUnknown,
-			LastTransitionTime: metav1.Now(),
-			Reason:             ProgressingReason,
-			Message:            "reconciliation in progress",
-		},
-	}
+	repository.Status.URL = ""
+	repository.Status.Artifact = nil
+	repository.Status.Conditions = []SourceCondition{}
+	SetHelmRepositoryCondition(&repository, ReadyCondition, corev1.ConditionUnknown, ProgressingReason, "reconciliation in progress")
 	return repository
 }
 
-// HelmRepositoryNotReady resets the conditions of the HelmRepository
-// to SourceCondition of type Ready with status false and the given
-// reason and message. It returns the modified HelmRepository.
+// SetHelmRepositoryCondition sets the given condition with the given status,
+// reason and message on the HelmRepository.
+func SetHelmRepositoryCondition(repository *HelmRepository, condition string, status corev1.ConditionStatus, reason, message string) {
+	repository.Status.Conditions = filterOutSourceCondition(repository.Status.Conditions, condition)
+	repository.Status.Conditions = append(repository.Status.Conditions, SourceCondition{
+		Type:               condition,
+		Status:             status,
+		LastTransitionTime: metav1.Now(),
+		Reason:             reason,
+		Message:            message,
+	})
+}
+
+// HelmRepositoryReady sets the given artifact and url on the HelmRepository
+// and sets the ReadyCondition to True, with the given reason and
+// message. It returns the modified HelmRepository.
+func HelmRepositoryReady(repository HelmRepository, artifact Artifact, url, reason, message string) HelmRepository {
+	repository.Status.Artifact = &artifact
+	repository.Status.URL = url
+	SetHelmRepositoryCondition(&repository, ReadyCondition, corev1.ConditionTrue, reason, message)
+	return repository
+}
+
+// HelmRepositoryNotReady sets the ReadyCondition on the given HelmRepository
+// to False, with the given reason and message. It returns the modified
+// HelmRepository.
 func HelmRepositoryNotReady(repository HelmRepository, reason, message string) HelmRepository {
-	repository.Status.Conditions = []SourceCondition{
-		{
-			Type:               ReadyCondition,
-			Status:             corev1.ConditionFalse,
-			LastTransitionTime: metav1.Now(),
-			Reason:             reason,
-			Message:            message,
-		},
-	}
+	SetHelmRepositoryCondition(&repository, ReadyCondition, corev1.ConditionFalse, reason, message)
 	return repository
 }
 

controllers/gitrepository_controller.go

@@ -28,7 +28,6 @@ import (
 	"github.com/go-git/go-git/v5/plumbing/transport"
 	"github.com/go-logr/logr"
 	corev1 "k8s.io/api/core/v1"
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/types"
 	kuberecorder "k8s.io/client-go/tools/record"
@@ -100,13 +99,7 @@ func (r *GitRepositoryReconciler) Reconcile(req ctrl.Request) (ctrl.Result, erro
 	}
 
 	// set initial status
-	if reset, status := r.shouldResetStatus(repository); reset {
-		repository.Status = status
-		if err := r.Status().Update(ctx, &repository); err != nil {
-			log.Error(err, "unable to update status")
-			return ctrl.Result{Requeue: true}, err
-		}
-	} else {
+	if repository.Generation == 0 || repository.GetArtifact() != nil && !r.Storage.ArtifactExist(*repository.GetArtifact()) {
 		repository = sourcev1.GitRepositoryProgressing(repository)
 		if err := r.Status().Update(ctx, &repository); err != nil {
 			log.Error(err, "unable to update status")
@@ -202,6 +195,12 @@ func (r *GitRepositoryReconciler) reconcile(ctx context.Context, repository sour
 		return sourcev1.GitRepositoryNotReady(repository, sourcev1.GitOperationFailedReason, err.Error()), err
 	}
 
+	// return early on unchanged revision
+	artifact := r.Storage.NewArtifactFor(repository.Kind, repository.GetObjectMeta(), revision, fmt.Sprintf("%s.tar.gz", commit.Hash.String()))
+	if repository.GetArtifact() != nil && repository.GetArtifact().Revision == revision {
+		return repository, nil
+	}
+
 	// verify PGP signature
 	if repository.Spec.Verification != nil {
 		err := r.verify(ctx, types.NamespacedName{
@@ -213,11 +212,6 @@ func (r *GitRepositoryReconciler) reconcile(ctx context.Context, repository sour
 		}
 	}
 
-	// TODO(hidde): implement checksum when https://github.com/fluxcd/source-controller/pull/133
-	//   has been merged.
-	artifact := r.Storage.ArtifactFor(repository.Kind, repository.ObjectMeta.GetObjectMeta(),
-		fmt.Sprintf("%s.tar.gz", commit.Hash.String()), revision, "")
-
 	// create artifact dir
 	err = r.Storage.MkdirAll(artifact)
 	if err != nil {
@@ -234,7 +228,7 @@ func (r *GitRepositoryReconciler) reconcile(ctx context.Context, repository sour
 	defer unlock()
 
 	// archive artifact and check integrity
-	if err := r.Storage.Archive(artifact, tmpGit, repository.Spec); err != nil {
+	if err := r.Storage.Archive(&artifact, tmpGit, repository.Spec); err != nil {
 		err = fmt.Errorf("storage archive error: %w", err)
 		return sourcev1.GitRepositoryNotReady(repository, sourcev1.StorageOperationFailedReason, err.Error()), err
 	}
@@ -250,32 +244,6 @@ func (r *GitRepositoryReconciler) reconcile(ctx context.Context, repository sour
 	return sourcev1.GitRepositoryReady(repository, artifact, url, sourcev1.GitOperationSucceedReason, message), nil
 }
 
-// shouldResetStatus returns a boolean indicating if the status of the
-// given repository should be reset.
-func (r *GitRepositoryReconciler) shouldResetStatus(repository sourcev1.GitRepository) (bool, sourcev1.GitRepositoryStatus) {
-	resetStatus := false
-	if repository.Status.Artifact != nil {
-		if !r.Storage.ArtifactExist(*repository.Status.Artifact) {
-			resetStatus = true
-		}
-	}
-
-	if len(repository.Status.Conditions) == 0 || resetStatus {
-		resetStatus = true
-	}
-
-	return resetStatus, sourcev1.GitRepositoryStatus{
-		Conditions: []sourcev1.SourceCondition{
-			{
-				Type:               sourcev1.ReadyCondition,
-				Status:             corev1.ConditionUnknown,
-				Reason:             sourcev1.InitializingReason,
-				LastTransitionTime: metav1.Now(),
-			},
-		},
-	}
-}
-
 // verify returns an error if the PGP signature can't be verified
 func (r *GitRepositoryReconciler) verify(ctx context.Context, publicKeySecret types.NamespacedName, commit *object.Commit) error {
 	if commit.PGPSignature == "" {
@@ -304,10 +272,10 @@ func (r *GitRepositoryReconciler) verify(ctx context.Context, publicKeySecret ty
 // the given repository.
 func (r *GitRepositoryReconciler) gc(repository sourcev1.GitRepository, all bool) error {
 	if all {
-		return r.Storage.RemoveAll(r.Storage.ArtifactFor(repository.Kind, repository.GetObjectMeta(), "", "", ""))
+		return r.Storage.RemoveAll(r.Storage.NewArtifactFor(repository.Kind, repository.GetObjectMeta(), "", ""))
 	}
-	if repository.Status.Artifact != nil {
-		return r.Storage.RemoveAllButCurrent(*repository.Status.Artifact)
+	if repository.GetArtifact() != nil {
+		return r.Storage.RemoveAllButCurrent(*repository.GetArtifact())
 	}
 	return nil
 }