added comments, misc

Author: M4KIF

internal/controller/postgrescluster_controller_test.go

@@ -35,7 +35,7 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
 	enterprisev4 "github.com/splunk/splunk-operator/api/v4"
-	"github.com/splunk/splunk-operator/pkg/postgresql/cluster/core"
+	"github.com/splunk/splunk-operator/pkg/postgresql/cluster/business/core"
 )
 
 /*

pkg/postgresql/cluster/business/core/cluster.go

@@ -502,6 +502,7 @@ func PostgresClusterService(ctx context.Context, rc *ReconcileContext, req ctrl.
 	return ctrl.Result{RequeueAfter: retryDelay}, nil
 }
 
+// Free to place in specific dir/place along with the p&a work.
 type StateInformationDto struct {
 	State     pgcConstants.State
 	Condition conditionTypes
@@ -511,6 +512,7 @@ type StateInformationDto struct {
 	Result    ctrl.Result
 }
 
+// a unit of work in a way, extractable.
 type clusterReadynessCheck interface {
 	Condition(ctx context.Context) (StateInformationDto, error)
 }
@@ -685,6 +687,7 @@ func (p *poolerHealthCheck) Condition(ctx context.Context) (StateInformationDto,
 		}, fmt.Errorf("pooler config missing")
 	}
 
+	// TODO: Port material.
 	rwExists, err := poolerExists(ctx, p.client, p.cluster, readWriteEndpoint)
 	if err != nil {
 		return StateInformationDto{

pkg/postgresql/cluster/business/core/cluster_unit_test.go

@@ -6,18 +6,31 @@ import (
 
 	cnpgv1 "github.com/cloudnative-pg/cloudnative-pg/api/v1"
 	enterprisev4 "github.com/splunk/splunk-operator/api/v4"
+	pgcConstants "github.com/splunk/splunk-operator/pkg/postgresql/cluster/business/core/types/constants"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	corev1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/utils/ptr"
 	client "sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 )
 
+type configMapNotFoundClient struct {
+	client.Client
+}
+
+func (c configMapNotFoundClient) Get(ctx context.Context, key client.ObjectKey, obj client.Object, opts ...client.GetOption) error {
+	if _, ok := obj.(*corev1.ConfigMap); ok {
+		return apierrors.NewNotFound(schema.GroupResource{Resource: "configmaps"}, key.Name)
+	}
+	return c.Client.Get(ctx, key, obj, opts...)
+}
+
 func TestPoolerResourceName(t *testing.T) {
 	tests := []struct {
 		name        string
@@ -1136,3 +1149,125 @@ func TestCreateOrUpdateConnectionPoolers(t *testing.T) {
 		assert.Equal(t, int32(1), *ro.Spec.Instances)
 	})
 }
+
+func TestComponentStateTriggerConditions(t *testing.T) {
+	t.Parallel()
+
+	ctx := t.Context()
+	scheme := runtime.NewScheme()
+	require.NoError(t, corev1.AddToScheme(scheme))
+
+	exampleCm := &corev1.ConfigMap{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "pg1-config",
+			Namespace: "default",
+		},
+		Data: map[string]string{
+			"CLUSTER_RW_ENDPOINT":   "pg1-rw.default",
+			"CLUSTER_RO_ENDPOINT":   "pg1-ro.default",
+			"DEFAULT_CLUSTER_PORT":  "5432",
+			"SUPER_USER_SECRET_REF": "pg1-secret",
+		},
+	}
+	examplePgCluster := &enterprisev4.PostgresCluster{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "pg1",
+			Namespace: "default",
+		},
+		Status: enterprisev4.PostgresClusterStatus{
+			Resources: &enterprisev4.PostgresClusterResources{
+				ConfigMapRef: &corev1.LocalObjectReference{Name: "pg1-config"},
+				SuperUserSecretRef: &corev1.SecretKeySelector{
+					LocalObjectReference: corev1.LocalObjectReference{Name: "pg1-secret"},
+					Key:                  "password",
+				},
+			},
+		},
+	}
+	exampleSecret := &corev1.Secret{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "pg1-secret",
+			Namespace: "default",
+		},
+		Data: map[string][]byte{
+			"password": []byte("s3cr3t"),
+		},
+	}
+
+	// TODO: as soon as coupling is addressed, remove this monster of a test.
+	combinations := []struct {
+		name            string
+		componentChecks []clusterReadynessCheck
+		requeue         []bool
+		expectedResult  bool
+		message         string
+	}{
+		{
+			name: "Provisioner ready, pooler pending, sync not successful",
+			componentChecks: []clusterReadynessCheck{
+				newProvisionerHealthCheck(examplePgCluster.DeepCopy(), &cnpgv1.Cluster{Status: cnpgv1.ClusterStatus{Phase: cnpgv1.PhaseHealthy}}),
+				newPoolerHealthCheck(nil, nil, true, false),
+			},
+			requeue:        []bool{false, false},
+			expectedResult: false,
+			message:        "Provisioner is ready but pooler is pending, don't fire",
+		},
+		{
+			name: "Provisioner ready, pooler ready, configMap failed, sync not successful",
+			componentChecks: []clusterReadynessCheck{
+				newProvisionerHealthCheck(examplePgCluster, &cnpgv1.Cluster{Status: cnpgv1.ClusterStatus{Phase: cnpgv1.PhaseHealthy}}),
+				newPoolerHealthCheck(nil, nil, false, false),
+				newConfigMapHealthCheck(
+					configMapNotFoundClient{
+						Client: fake.NewClientBuilder().
+							WithScheme(scheme).
+							Build(),
+					},
+					examplePgCluster.DeepCopy(),
+				),
+			},
+			requeue:        []bool{false, false, true},
+			expectedResult: false,
+			message:        "Provisioner and pooler ready are not enough when ConfigMap check returns NotFound/pending",
+		},
+		{
+			name: "Sync successful, all components ready.",
+			componentChecks: []clusterReadynessCheck{
+				newProvisionerHealthCheck(examplePgCluster, &cnpgv1.Cluster{Status: cnpgv1.ClusterStatus{Phase: cnpgv1.PhaseHealthy}}),
+				newPoolerHealthCheck(nil, nil, false, false),
+				newConfigMapHealthCheck(
+					fake.NewClientBuilder().
+						WithScheme(scheme).
+						WithObjects(exampleCm).
+						Build(),
+					examplePgCluster.DeepCopy(),
+				),
+				newSecretHealthCheck(
+					fake.NewClientBuilder().
+						WithScheme(scheme).
+						WithObjects(exampleSecret).
+						Build(),
+					examplePgCluster.DeepCopy(),
+				),
+			},
+			requeue:        []bool{false, false, false, false},
+			expectedResult: true,
+			message:        "",
+		},
+	}
+
+	for _, tt := range combinations {
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+
+			state := pgcConstants.EmptyState
+			for i, check := range tt.componentChecks {
+				info, _ := check.Condition(ctx)
+				state |= info.State
+				assert.Equal(t, tt.requeue[i], info.Result.RequeueAfter > 0)
+			}
+			assert.Equal(t, tt.expectedResult, state&pgcConstants.ComponentsReady == pgcConstants.ComponentsReady,
+				tt.message)
+		})
+	}
+}

pkg/postgresql/cluster/business/core/types/constants/state.go

@@ -3,36 +3,36 @@ package pgcConstants
 type State uint64
 
 const (
-	EmptyState         State = 0
-	PoolerReady        State = 1 << iota
-	PoolerPending      State = 1 << iota
-	PoolerProvisioning State = 1 << iota
-	PoolerConfiguring  State = 1 << iota
-	PoolerFailed       State = 1 << iota
+	EmptyState  State = 0
+	PoolerReady State = 1 << iota
+	PoolerPending
+	PoolerProvisioning
+	PoolerConfiguring
+	PoolerFailed
 
-	ProvisionerReady        State = 1 << iota
-	ProvisionerPending      State = 1 << iota
-	ProvisionerProvisioning State = 1 << iota
-	ProvisionerConfiguring  State = 1 << iota
-	ProvisionerFailed       State = 1 << iota
+	ProvisionerReady
+	ProvisionerPending
+	ProvisionerProvisioning
+	ProvisionerConfiguring
+	ProvisionerFailed
 
-	ConfigMapReady        State = 1 << iota
-	ConfigMapPending      State = 1 << iota
-	ConfigMapProvisioning State = 1 << iota
-	ConfigMapConfiguring  State = 1 << iota
-	ConfigMapFailed       State = 1 << iota
+	ConfigMapReady
+	ConfigMapPending
+	ConfigMapProvisioning
+	ConfigMapConfiguring
+	ConfigMapFailed
 
-	SecretReady        State = 1 << iota
-	SecretPending      State = 1 << iota
-	SecretProvisioning State = 1 << iota
-	SecretConfiguring  State = 1 << iota
-	SecretFailed       State = 1 << iota
+	SecretReady
+	SecretPending
+	SecretProvisioning
+	SecretConfiguring
+	SecretFailed
 
-	ClusterReady        State = 1 << iota
-	ClusterPending      State = 1 << iota
-	ClusterProvisioning State = 1 << iota
-	ClusterConfiguring  State = 1 << iota
-	ClusterFailed       State = 1 << iota
+	ClusterReady
+	ClusterPending
+	ClusterProvisioning
+	ClusterConfiguring
+	ClusterFailed
 )
 
 const (