Merge pull request #88 from Ajpantuso/apantuso/refactor_controllers

refactor: independent controllers packages

Author: Ajpantuso

cmd/reference-addon-manager/main.go

@@ -13,7 +13,7 @@ import (
 
 	"github.com/go-logr/logr"
 	refapis "github.com/openshift/reference-addon/apis"
-	"github.com/openshift/reference-addon/internal/controllers"
+	ractrl "github.com/openshift/reference-addon/internal/controllers/referenceaddon"
 	"github.com/openshift/reference-addon/internal/metrics"
 	"github.com/openshift/reference-addon/internal/pprof"
 	opsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
@@ -109,18 +109,18 @@ func setupManager(log logr.Logger, opts options) (ctrl.Manager, error) {
 
 	client := mgr.GetClient()
 
-	r, err := controllers.NewReferenceAddonReconciler(
+	r, err := ractrl.NewReferenceAddonReconciler(
 		client,
-		controllers.NewSecretParameterGetter(
+		ractrl.NewSecretParameterGetter(
 			client,
-			controllers.WithNamespace(opts.Namespace),
-			controllers.WithName(opts.ParameterSecretname),
+			ractrl.WithNamespace(opts.Namespace),
+			ractrl.WithName(opts.ParameterSecretname),
 		),
-		controllers.WithLog{Log: ctrl.Log.WithName("controller").WithName("referenceaddon")},
-		controllers.WithAddonNamespace(opts.Namespace),
-		controllers.WithAddonParameterSecretName(opts.ParameterSecretname),
-		controllers.WithOperatorName(opts.OperatorName),
-		controllers.WithDeleteLabel(opts.DeleteLabel),
+		ractrl.WithLog{Log: ctrl.Log.WithName("controller").WithName("referenceaddon")},
+		ractrl.WithAddonNamespace(opts.Namespace),
+		ractrl.WithAddonParameterSecretName(opts.ParameterSecretname),
+		ractrl.WithOperatorName(opts.OperatorName),
+		ractrl.WithDeleteLabel(opts.DeleteLabel),
 	)
 	if err != nil {
 		return nil, fmt.Errorf("initializing reference addon controller: %w", err)

internal/controllers/helpers.go

@@ -3,11 +3,8 @@ package controllers
 import (
 	"context"
 	"errors"
-	"fmt"
 	"strings"
 
-	refv1alpha1 "github.com/openshift/reference-addon/apis/reference/v1alpha1"
-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/client-go/util/workqueue"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -19,37 +16,23 @@ import (
 
 var ErrEmptyOptionValue = errors.New("empty option value")
 
-func validateOptionValue(val string) error {
+func ValidateOptionValue(val string) error {
 	if val != "" {
 		return nil
 	}
 
 	return ErrEmptyOptionValue
 }
 
-func generateIngressPolicyName(prefix string) string {
-	return fmt.Sprintf("%s-ingress", prefix)
-}
-
-func boolPtr(b bool) *bool {
+func BoolPtr(b bool) *bool {
 	return &b
 }
 
-func stringPtr(s string) *string {
+func StringPtr(s string) *string {
 	return &s
 }
 
-func newAvailableCondition(reason refv1alpha1.ReferenceAddonAvailableReason, msg string) metav1.Condition {
-	return metav1.Condition{
-		Type:               refv1alpha1.ReferenceAddonConditionAvailable.String(),
-		Status:             reason.Status(),
-		Reason:             reason.String(),
-		Message:            msg,
-		LastTransitionTime: metav1.Now(),
-	}
-}
-
-func enqueueObject(obj types.NamespacedName) source.Func {
+func EnqueueObject(obj types.NamespacedName) source.Func {
 	return func(_ context.Context, _ handler.EventHandler, q workqueue.RateLimitingInterface, _ ...predicate.Predicate) error {
 		q.Add(reconcile.Request{
 			NamespacedName: obj,
@@ -59,15 +42,15 @@ func enqueueObject(obj types.NamespacedName) source.Func {
 	}
 }
 
-func hasNamePrefix(pfx string) predicate.Funcs {
+func HasNamePrefix(pfx string) predicate.Funcs {
 	return predicate.NewPredicateFuncs(
 		func(obj client.Object) bool {
 			return strings.HasPrefix(obj.GetName(), pfx)
 		},
 	)
 }
 
-func hasName(name string) predicate.Funcs {
+func HasName(name string) predicate.Funcs {
 	return predicate.NewPredicateFuncs(
 		func(obj client.Object) bool {
 			return obj.GetName() == name

internal/controllers/phase/phase.go

@@ -0,0 +1,22 @@
+package referenceaddon
+
+import (
+	"fmt"
+
+	refv1alpha1 "github.com/openshift/reference-addon/apis/reference/v1alpha1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+func generateIngressPolicyName(prefix string) string {
+	return fmt.Sprintf("%s-ingress", prefix)
+}
+
+func newAvailableCondition(reason refv1alpha1.ReferenceAddonAvailableReason, msg string) metav1.Condition {
+	return metav1.Condition{
+		Type:               refv1alpha1.ReferenceAddonConditionAvailable.String(),
+		Status:             reason.Status(),
+		Reason:             reason.String(),
+		Message:            msg,
+		LastTransitionTime: metav1.Now(),
+	}
+}

internal/controllers/referenceaddon/helpers.go

@@ -1,4 +1,4 @@
-package controllers
+package referenceaddon
 
 import (
 	"github.com/go-logr/logr"

internal/controllers/options.go …al/controllers/referenceaddon/options.gointernal/controllers/options.go renamed to internal/controllers/referenceaddon/options.go internal/controllers/options.go renamed to internal/controllers/referenceaddon/options.go

@@ -1,18 +1,17 @@
-package controllers
+package referenceaddon
 
 import (
 	"context"
 	"errors"
 	"fmt"
 	"strings"
 
-	"github.com/openshift/reference-addon/internal/controllers/phase"
 	corev1 "k8s.io/api/core/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
 type ParameterGetter interface {
-	GetParameters(ctx context.Context) (phase.RequestParameters, error)
+	GetParameters(ctx context.Context) (PhaseRequestParameters, error)
 }
 
 func NewSecretParameterGetter(client client.Client, opts ...SecretParameteterGetterOption) *SecretParameterGetter {
@@ -38,7 +37,7 @@ const (
 	sizeParameterID        = "size"
 )
 
-func (s *SecretParameterGetter) GetParameters(ctx context.Context) (phase.RequestParameters, error) {
+func (s *SecretParameterGetter) GetParameters(ctx context.Context) (PhaseRequestParameters, error) {
 	ctx, cancel := context.WithCancel(ctx)
 	defer cancel()
 
@@ -50,27 +49,27 @@ func (s *SecretParameterGetter) GetParameters(ctx context.Context) (phase.Reques
 	var secret corev1.Secret
 
 	if err := s.client.Get(ctx, key, &secret); err != nil {
-		return phase.NewRequestParameters(), fmt.Errorf("retrieving addon parameters secret: %w", err)
+		return NewPhaseRequestParameters(), fmt.Errorf("retrieving addon parameters secret: %w", err)
 	}
 
-	var opts []phase.RequestParametersOption
+	var opts []PhaseRequestParametersOption
 
 	if val, ok := secret.Data[applyNetworkPoliciesID]; ok {
 		b, err := parseBool(string(val))
 		if err != nil {
-			return phase.NewRequestParameters(), fmt.Errorf("parsing 'ApplyNetworkPolicies' value: %w", err)
+			return NewPhaseRequestParameters(), fmt.Errorf("parsing 'ApplyNetworkPolicies' value: %w", err)
 		}
 
-		opts = append(opts, phase.WithApplyNetworkPolicies{Value: &b})
+		opts = append(opts, WithApplyNetworkPolicies{Value: &b})
 	}
 
 	if val, ok := secret.Data[sizeParameterID]; ok {
 		s := string(val)
 
-		opts = append(opts, phase.WithSize{Value: &s})
+		opts = append(opts, WithSize{Value: &s})
 	}
 
-	return phase.NewRequestParameters(opts...), nil
+	return NewPhaseRequestParameters(opts...), nil
 }
 
 type SecretParameterGetterConfig struct {