Merge pull request #411 from fluxcd/gitrepository-reconciler

Rewrite `GitRepositoryReconciler` to new standards

api/go.mod

@@ -3,7 +3,11 @@ module github.com/fluxcd/source-controller/api
 go 1.16
 
 require (
-	github.com/fluxcd/pkg/apis/meta v0.10.0
-	k8s.io/apimachinery v0.21.1
-	sigs.k8s.io/controller-runtime v0.9.0
+	github.com/fluxcd/pkg/apis/meta v0.11.0-rc.1
+	// TODO(hidde): introduction of the runtime package is temporary, and the dependency should be removed as soon as
+	//  all APIs have been updated to the runtime standards (more specifically; have dropped their condition modifying
+	//  functions).
+	github.com/fluxcd/pkg/runtime v0.13.0-rc.2
+	k8s.io/apimachinery v0.21.3
+	sigs.k8s.io/controller-runtime v0.9.3
 )

api/v1beta1/bucket_types.go

@@ -17,7 +17,10 @@ limitations under the License.
 package v1beta1
 
 import (
+	"time"
+
 	"github.com/fluxcd/pkg/apis/meta"
+	"github.com/fluxcd/pkg/runtime/conditions"
 	apimeta "k8s.io/apimachinery/pkg/api/meta"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
@@ -119,7 +122,7 @@ func BucketProgressing(bucket Bucket) Bucket {
 	bucket.Status.ObservedGeneration = bucket.Generation
 	bucket.Status.URL = ""
 	bucket.Status.Conditions = []metav1.Condition{}
-	meta.SetResourceCondition(&bucket, meta.ReadyCondition, metav1.ConditionUnknown, meta.ProgressingReason, "reconciliation in progress")
+	conditions.MarkUnknown(&bucket, meta.ReadyCondition, meta.ProgressingReason, "reconciliation in progress")
 	return bucket
 }
 
@@ -129,14 +132,14 @@ func BucketProgressing(bucket Bucket) Bucket {
 func BucketReady(bucket Bucket, artifact Artifact, url, reason, message string) Bucket {
 	bucket.Status.Artifact = &artifact
 	bucket.Status.URL = url
-	meta.SetResourceCondition(&bucket, meta.ReadyCondition, metav1.ConditionTrue, reason, message)
+	conditions.MarkTrue(&bucket, meta.ReadyCondition, reason, message)
 	return bucket
 }
 
 // BucketNotReady sets the meta.ReadyCondition on the Bucket to 'False', with
 // the given reason and message. It returns the modified Bucket.
 func BucketNotReady(bucket Bucket, reason, message string) Bucket {
-	meta.SetResourceCondition(&bucket, meta.ReadyCondition, metav1.ConditionFalse, reason, message)
+	conditions.MarkFalse(&bucket, meta.ReadyCondition, reason, message)
 	return bucket
 }
 
@@ -151,22 +154,38 @@ func BucketReadyMessage(bucket Bucket) string {
 	return ""
 }
 
-// GetArtifact returns the latest artifact from the source if present in the
-// status sub-resource.
+// GetConditions returns the status conditions of the object.
+func (in Bucket) GetConditions() []metav1.Condition {
+	return in.Status.Conditions
+}
+
+// SetConditions sets the status conditions on the object.
+func (in *Bucket) SetConditions(conditions []metav1.Condition) {
+	in.Status.Conditions = conditions
+}
+
+// GetRequeueAfter returns the duration after which the source must be reconciled again.
+func (in Bucket) GetRequeueAfter() time.Duration {
+	return in.Spec.Interval.Duration
+}
+
+// GetInterval returns the interval at which the source is reconciled.
+// Deprecated: use GetRequeueAfter instead.
+func (in Bucket) GetInterval() metav1.Duration {
+	return in.Spec.Interval
+}
+
+// GetArtifact returns the latest artifact from the source if present in the status sub-resource.
 func (in *Bucket) GetArtifact() *Artifact {
 	return in.Status.Artifact
 }
 
-// GetStatusConditions returns a pointer to the Status.Conditions slice
+// GetStatusConditions returns a pointer to the Status.Conditions slice.
+// Deprecated: use GetConditions instead.
 func (in *Bucket) GetStatusConditions() *[]metav1.Condition {
 	return &in.Status.Conditions
 }
 
-// GetInterval returns the interval at which the source is updated.
-func (in *Bucket) GetInterval() metav1.Duration {
-	return in.Spec.Interval
-}
-
 // +genclient
 // +genclient:Namespaced
 // +kubebuilder:object:root=true

api/v1beta1/gitrepository_types.go

@@ -17,8 +17,9 @@ limitations under the License.
 package v1beta1
 
 import (
+	"time"
+
 	"github.com/fluxcd/pkg/apis/meta"
-	apimeta "k8s.io/apimachinery/pkg/api/meta"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -32,6 +33,30 @@ const (
 	LibGit2Implementation = "libgit2"
 )
 
+const (
+	// ArtifactUnavailableCondition indicates there is no Artifact available for the Source.
+	// This is a "negative polarity" or "abnormal-true" type, and is only present on the resource if it is True.
+	ArtifactUnavailableCondition string = "ArtifactUnavailable"
+
+	// CheckoutFailedCondition indicates a transient or persistent checkout failure. If True, observations on the
+	// upstream Source revision are not possible, and the Artifact available for the Source may be outdated.
+	// This is a "negative polarity" or "abnormal-true" type, and is only present on the resource if it is True.
+	CheckoutFailedCondition string = "CheckoutFailed"
+
+	// SourceVerifiedCondition indicates the integrity of the Source has been verified. If True, the integrity check
+	// succeeded. If False, it failed. The Condition is only present on the resource if the integrity has been verified.
+	SourceVerifiedCondition string = "SourceVerified"
+
+	// IncludeUnavailableCondition indicates one of the includes is not available. For example, because it does not
+	// exist, or does not have an Artifact.
+	// This is a "negative polarity" or "abnormal-true" type, and is only present on the resource if it is True.
+	IncludeUnavailableCondition string = "IncludeUnavailable"
+
+	// ArtifactOutdatedCondition indicates the current Artifact of the Source is outdated.
+	// This is a "negative polarity" or "abnormal-true" type, and is only present on the resource if it is True.
+	ArtifactOutdatedCondition string = "ArtifactOutdated"
+)
+
 // GitRepositorySpec defines the desired state of a Git repository.
 type GitRepositorySpec struct {
 	// The repository URL, can be a HTTP/S or SSH address.
@@ -40,10 +65,8 @@ type GitRepositorySpec struct {
 	URL string `json:"url"`
 
 	// The secret name containing the Git credentials.
-	// For HTTPS repositories the secret must contain username and password
-	// fields.
-	// For SSH repositories the secret must contain identity, identity.pub and
-	// known_hosts fields.
+	// For HTTPS repositories the secret must contain username and password fields.
+	// For SSH repositories the secret must contain 'identity', 'identity.pub' and 'known_hosts' fields.
 	// +optional
 	SecretRef *meta.LocalObjectReference `json:"secretRef,omitempty"`
 
@@ -61,16 +84,16 @@ type GitRepositorySpec struct {
 	// +optional
 	Reference *GitRepositoryRef `json:"ref,omitempty"`
 
-	// Verify OpenPGP signature for the Git commit HEAD points to.
+	// Verification defines the configuration to verify the OpenPGP signature for the Git commit HEAD points to.
 	// +optional
 	Verification *GitRepositoryVerification `json:"verify,omitempty"`
 
-	// Ignore overrides the set of excluded patterns in the .sourceignore format
-	// (which is the same as .gitignore). If not provided, a default will be used,
-	// consult the documentation for your version to find out what those are.
+	// Ignore overrides the set of excluded patterns in the .sourceignore format (which is the same as .gitignore).
+	// If not provided, a default will be used, consult the documentation for your version to find out what those are.
 	// +optional
 	Ignore *string `json:"ignore,omitempty"`
 
+	// Suspend tells the controller to suspend the reconciliation of this source.
 	// This flag tells the controller to suspend the reconciliation of this source.
 	// +optional
 	Suspend bool `json:"suspend,omitempty"`
@@ -82,13 +105,13 @@ type GitRepositorySpec struct {
 	// +optional
 	GitImplementation string `json:"gitImplementation,omitempty"`
 
-	// When enabled, after the clone is created, initializes all submodules within,
-	// using their default settings.
+	// When enabled, after the clone is created, initializes all submodules within, using their default settings.
 	// This option is available only when using the 'go-git' GitImplementation.
 	// +optional
 	RecurseSubmodules bool `json:"recurseSubmodules,omitempty"`
 
-	// Extra git repositories to map into the repository
+	// Include defines a list of GitRepository resources which artifacts should be included in the artifact produced for
+	// this resource.
 	Include []GitRepositoryInclude `json:"include,omitempty"`
 }
 
@@ -139,11 +162,11 @@ type GitRepositoryRef struct {
 
 // GitRepositoryVerification defines the OpenPGP signature verification process.
 type GitRepositoryVerification struct {
-	// Mode describes what git object should be verified, currently ('head').
+	// Mode describes what Git object should be verified, currently ('head').
 	// +kubebuilder:validation:Enum=head
 	Mode string `json:"mode"`
 
-	// The secret name containing the public keys of all trusted Git authors.
+	// SecretRef containing the public keys of all trusted Git authors.
 	SecretRef meta.LocalObjectReference `json:"secretRef,omitempty"`
 }
 
@@ -157,8 +180,7 @@ type GitRepositoryStatus struct {
 	// +optional
 	Conditions []metav1.Condition `json:"conditions,omitempty"`
 
-	// URL is the download link for the artifact output of the last repository
-	// sync.
+	// URL is the download link for the artifact output of the last repository sync.
 	// +optional
 	URL string `json:"url,omitempty"`
 
@@ -174,73 +196,45 @@ type GitRepositoryStatus struct {
 }
 
 const (
-	// GitOperationSucceedReason represents the fact that the git clone, pull
-	// and checkout operations succeeded.
+	// GitOperationSucceedReason represents the fact that the git clone, pull and checkout operations succeeded.
 	GitOperationSucceedReason string = "GitOperationSucceed"
 
-	// GitOperationFailedReason represents the fact that the git clone, pull or
-	// checkout operations failed.
+	// GitOperationFailedReason represents the fact that the git clone, pull or checkout operations failed.
 	GitOperationFailedReason string = "GitOperationFailed"
 )
 
-// GitRepositoryProgressing resets the conditions of the GitRepository to
-// metav1.Condition of type meta.ReadyCondition with status 'Unknown' and
-// meta.ProgressingReason reason and message. It returns the modified
-// GitRepository.
-func GitRepositoryProgressing(repository GitRepository) GitRepository {
-	repository.Status.ObservedGeneration = repository.Generation
-	repository.Status.URL = ""
-	repository.Status.Conditions = []metav1.Condition{}
-	meta.SetResourceCondition(&repository, meta.ReadyCondition, metav1.ConditionUnknown, meta.ProgressingReason, "reconciliation in progress")
-	return repository
+// GetConditions returns the status conditions of the object.
+func (in GitRepository) GetConditions() []metav1.Condition {
+	return in.Status.Conditions
 }
 
-// GitRepositoryReady sets the given Artifact and URL on the GitRepository and
-// sets the meta.ReadyCondition to 'True', with the given reason and message. It
-// returns the modified GitRepository.
-func GitRepositoryReady(repository GitRepository, artifact Artifact, includedArtifacts []*Artifact, url, reason, message string) GitRepository {
-	repository.Status.Artifact = &artifact
-	repository.Status.IncludedArtifacts = includedArtifacts
-	repository.Status.URL = url
-	meta.SetResourceCondition(&repository, meta.ReadyCondition, metav1.ConditionTrue, reason, message)
-	return repository
+// SetConditions sets the status conditions on the object.
+func (in *GitRepository) SetConditions(conditions []metav1.Condition) {
+	in.Status.Conditions = conditions
 }
 
-// GitRepositoryNotReady sets the meta.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 {
-	meta.SetResourceCondition(&repository, meta.ReadyCondition, metav1.ConditionFalse, reason, message)
-	return repository
+// GetRequeueAfter returns the duration after which the source must be reconciled again.
+func (in GitRepository) GetRequeueAfter() time.Duration {
+	return in.Spec.Interval.Duration
 }
 
-// GitRepositoryReadyMessage returns the message of the metav1.Condition of type
-// meta.ReadyCondition with status 'True' if present, or an empty string.
-func GitRepositoryReadyMessage(repository GitRepository) string {
-	if c := apimeta.FindStatusCondition(repository.Status.Conditions, meta.ReadyCondition); c != nil {
-		if c.Status == metav1.ConditionTrue {
-			return c.Message
-		}
-	}
-	return ""
+// GetInterval returns the interval at which the source is reconciled.
+// Deprecated: use GetRequeueAfter instead.
+func (in GitRepository) GetInterval() metav1.Duration {
+	return in.Spec.Interval
 }
 
-// GetArtifact returns the latest artifact from the source if present in the
-// status sub-resource.
+// GetArtifact returns the latest artifact from the source if present in the status sub-resource.
 func (in *GitRepository) GetArtifact() *Artifact {
 	return in.Status.Artifact
 }
 
-// GetStatusConditions returns a pointer to the Status.Conditions slice
+// GetStatusConditions returns a pointer to the Status.Conditions slice.
+// Deprecated: use GetConditions instead.
 func (in *GitRepository) GetStatusConditions() *[]metav1.Condition {
 	return &in.Status.Conditions
 }
 
-// GetInterval returns the interval at which the source is updated.
-func (in *GitRepository) GetInterval() metav1.Duration {
-	return in.Spec.Interval
-}
-
 // +genclient
 // +genclient:Namespaced
 // +kubebuilder:object:root=true