Merge pull request fluxcd#412 from fluxcd/bucket-reconciler

Author: hiddeco

api/v1beta1/bucket_types.go

@@ -20,8 +20,6 @@ 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"
 )
 
@@ -30,6 +28,11 @@ const (
 	BucketKind = "Bucket"
 )
 
+const (
+	GenericBucketProvider string = "generic"
+	AmazonBucketProvider  string = "aws"
+)
+
 // BucketSpec defines the desired state of an S3 compatible bucket
 type BucketSpec struct {
 	// The S3 compatible storage provider name, default ('generic').
@@ -79,11 +82,6 @@ type BucketSpec struct {
 	Suspend bool `json:"suspend,omitempty"`
 }
 
-const (
-	GenericBucketProvider string = "generic"
-	AmazonBucketProvider  string = "aws"
-)
-
 // BucketStatus defines the observed state of a bucket
 type BucketStatus struct {
 	// ObservedGeneration is the last observed generation.
@@ -115,45 +113,6 @@ const (
 	BucketOperationFailedReason string = "BucketOperationFailed"
 )
 
-// BucketProgressing resets the conditions of the Bucket to metav1.Condition of
-// type meta.ReadyCondition with status 'Unknown' and meta.ProgressingReason
-// reason and message. It returns the modified Bucket.
-func BucketProgressing(bucket Bucket) Bucket {
-	bucket.Status.ObservedGeneration = bucket.Generation
-	bucket.Status.URL = ""
-	bucket.Status.Conditions = []metav1.Condition{}
-	conditions.MarkUnknown(&bucket, meta.ReadyCondition, meta.ProgressingReason, "reconciliation in progress")
-	return bucket
-}
-
-// BucketReady sets the given Artifact and URL on the Bucket and sets the
-// meta.ReadyCondition to 'True', with the given reason and message. It returns
-// the modified Bucket.
-func BucketReady(bucket Bucket, artifact Artifact, url, reason, message string) Bucket {
-	bucket.Status.Artifact = &artifact
-	bucket.Status.URL = url
-	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 {
-	conditions.MarkFalse(&bucket, meta.ReadyCondition, reason, message)
-	return bucket
-}
-
-// BucketReadyMessage returns the message of the metav1.Condition of type
-// meta.ReadyCondition with status 'True' if present, or an empty string.
-func BucketReadyMessage(bucket Bucket) string {
-	if c := apimeta.FindStatusCondition(bucket.Status.Conditions, meta.ReadyCondition); c != nil {
-		if c.Status == metav1.ConditionTrue {
-			return c.Message
-		}
-	}
-	return ""
-}
-
 // GetConditions returns the status conditions of the object.
 func (in Bucket) GetConditions() []metav1.Condition {
 	return in.Status.Conditions

api/v1beta1/condition_types.go

@@ -18,6 +18,22 @@ package v1beta1
 
 const SourceFinalizer = "finalizers.fluxcd.io"
 
+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"
+
+	// 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"
+
+	// FetchFailedCondition indicates a transient or persistent fetch failure of an upstream Source.
+	// If True, observations on the upstream Source revision may be impossible, 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.
+	FetchFailedCondition string = "FetchFailed"
+)
+
 const (
 	// URLInvalidReason represents the fact that a given source has an invalid URL.
 	URLInvalidReason string = "URLInvalid"

api/v1beta1/gitrepository_types.go

@@ -34,15 +34,6 @@ const (
 )
 
 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"
@@ -51,10 +42,6 @@ const (
 	// 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.

controllers/artifact_matchers_test.go

@@ -0,0 +1,67 @@
+/*
+Copyright 2021 The Flux authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package controllers
+
+import (
+	"fmt"
+
+	sourcev1 "github.com/fluxcd/source-controller/api/v1beta1"
+	. "github.com/onsi/gomega"
+	"github.com/onsi/gomega/types"
+)
+
+// MatchArtifact returns a custom matcher to check equality of a v1beta1.Artifact, the timestamp and URL are ignored.
+func MatchArtifact(expected *sourcev1.Artifact) types.GomegaMatcher {
+	return &matchArtifact{
+		expected: expected,
+	}
+}
+
+type matchArtifact struct {
+	expected *sourcev1.Artifact
+}
+
+func (m matchArtifact) Match(actual interface{}) (success bool, err error) {
+	actualArtifact, ok := actual.(*sourcev1.Artifact)
+	if !ok {
+		return false, fmt.Errorf("actual should be a pointer to an Artifact")
+	}
+
+	if ok, _ := BeNil().Match(m.expected); ok {
+		return BeNil().Match(actual)
+	}
+
+	if ok, err = Equal(m.expected.Path).Match(actualArtifact.Path); !ok {
+		return ok, err
+	}
+	if ok, err = Equal(m.expected.Revision).Match(actualArtifact.Revision); !ok {
+		return ok, err
+	}
+	if ok, err = Equal(m.expected.Checksum).Match(actualArtifact.Checksum); !ok {
+		return ok, err
+	}
+
+	return ok, err
+}
+
+func (m matchArtifact) FailureMessage(actual interface{}) (message string) {
+	return fmt.Sprintf("expected\n\t%#v\nto match\n\t%#v\n", actual, m.expected)
+}
+
+func (m matchArtifact) NegatedFailureMessage(actual interface{}) (message string) {
+	return fmt.Sprintf("expected\n\t%#v\nto not match\n\t%#v\n", actual, m.expected)
+}