Introduce Bucket provider constants with the common part as a prefix

Signed-off-by: Matheus Pimenta <[email protected]>
fluxcd · Aug 22, 2024 · d181710 · d181710
1 parent b2f08f5
commit d181710
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 7 deletions.
diff --git a/api/v1beta2/bucket_types.go b/api/v1beta2/bucket_types.go
@@ -33,17 +33,34 @@ const (
 )
 
 const (
+	// BucketProviderGeneric for any S3 API compatible storage Bucket.
+	BucketProviderGeneric string = "generic"
+	// BucketProviderAmazon for an AWS S3 object storage Bucket.
+	// Provides support for retrieving credentials from the AWS EC2 service.
+	BucketProviderAmazon string = "aws"
+	// BucketProviderGoogle for a Google Cloud Storage Bucket.
+	// Provides support for authentication using a workload identity.
+	BucketProviderGoogle string = "gcp"
+	// BucketProviderAzure for an Azure Blob Storage Bucket.
+	// Provides support for authentication using a Service Principal,
+	// Managed Identity or Shared Key.
+	BucketProviderAzure string = "azure"
+
 	// GenericBucketProvider for any S3 API compatible storage Bucket.
+	// Deprecated: use BucketProviderGeneric.
 	GenericBucketProvider string = "generic"
 	// AmazonBucketProvider for an AWS S3 object storage Bucket.
 	// Provides support for retrieving credentials from the AWS EC2 service.
+	// Deprecated: use BucketProviderAmazon.
 	AmazonBucketProvider string = "aws"
 	// GoogleBucketProvider for a Google Cloud Storage Bucket.
 	// Provides support for authentication using a workload identity.
+	// Deprecated: use BucketProviderGoogle.
 	GoogleBucketProvider string = "gcp"
 	// AzureBucketProvider for an Azure Blob Storage Bucket.
 	// Provides support for authentication using a Service Principal,
 	// Managed Identity or Shared Key.
+	// Deprecated: use BucketProviderAzure.
 	AzureBucketProvider string = "azure"
 )
 

diff --git a/internal/controller/bucket_controller.go b/internal/controller/bucket_controller.go
@@ -441,7 +441,7 @@ func (r *BucketReconciler) reconcileSource(ctx context.Context, sp *patch.Serial
 	// Construct provider client
 	var provider BucketProvider
 	switch obj.Spec.Provider {
-	case bucketv1.GoogleBucketProvider:
+	case bucketv1.BucketProviderGoogle:
 		if err = gcp.ValidateSecret(secret); err != nil {
 			e := serror.NewGeneric(err, sourcev1.AuthenticationFailedReason)
 			conditions.MarkTrue(obj, sourcev1.FetchFailedCondition, e.Reason, "%s", e)
@@ -459,7 +459,7 @@ func (r *BucketReconciler) reconcileSource(ctx context.Context, sp *patch.Serial
 			conditions.MarkTrue(obj, sourcev1.FetchFailedCondition, e.Reason, "%s", e)
 			return sreconcile.ResultEmpty, e
 		}
-	case bucketv1.AzureBucketProvider:
+	case bucketv1.BucketProviderAzure:
 		if err = azure.ValidateSecret(secret); err != nil {
 			e := serror.NewGeneric(err, sourcev1.AuthenticationFailedReason)
 			conditions.MarkTrue(obj, sourcev1.FetchFailedCondition, e.Reason, "%s", e)

diff --git a/internal/controller/bucket_controller_test.go b/internal/controller/bucket_controller_test.go
@@ -1314,7 +1314,7 @@ func TestBucketReconciler_reconcileSource_gcs(t *testing.T) {
 				Spec: bucketv1.BucketSpec{
 					BucketName: tt.bucketName,
 					Timeout:    &metav1.Duration{Duration: timeout},
-					Provider:   bucketv1.GoogleBucketProvider,
+					Provider:   bucketv1.BucketProviderGoogle,
 				},
 			}
 

diff --git a/pkg/minio/minio.go b/pkg/minio/minio.go
@@ -104,9 +104,9 @@ func NewClient(bucket *sourcev1.Bucket, opts ...Option) (*MinioClient, error) {
 	switch bucketProvider := bucket.Spec.Provider; {
 	case o.secret != nil:
 		minioOpts.Creds = newCredsFromSecret(o.secret)
-	case bucketProvider == sourcev1.AmazonBucketProvider:
+	case bucketProvider == sourcev1.BucketProviderAmazon:
 		minioOpts.Creds = newAWSCreds(bucket, o.proxyURL)
-	case bucketProvider == sourcev1.GenericBucketProvider:
+	case bucketProvider == sourcev1.BucketProviderGeneric:
 		minioOpts.Creds = newGenericCreds(bucket, &o)
 	}
 
@@ -241,7 +241,7 @@ func ValidateSTSProvider(bucketProvider string, sts *sourcev1.BucketSTSSpec) err
 		sts.Provider)
 
 	switch bucketProvider {
-	case sourcev1.AmazonBucketProvider:
+	case sourcev1.BucketProviderAmazon:
 		switch sts.Provider {
 		case sourcev1.STSProviderAmazon:
 			if sts.SecretRef != nil {
@@ -254,7 +254,7 @@ func ValidateSTSProvider(bucketProvider string, sts *sourcev1.BucketSTSSpec) err
 		default:
 			return errProviderIncompatbility
 		}
-	case sourcev1.GenericBucketProvider:
+	case sourcev1.BucketProviderGeneric:
 		switch sts.Provider {
 		case sourcev1.STSProviderLDAP:
 			return nil