Refactor Reconciliation Flow

.chloggen/reconcile-change.yaml

@@ -0,0 +1,16 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. operator, target allocator, github action)
+component: operator
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Introduces a new method of reconciliation to reduce duplication and complexity
+
+# One or more tracking issues related to the change
+issues: [1959]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:

controllers/builder_test.go

@@ -0,0 +1,317 @@
+// Copyright The OpenTelemetry 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 (
+	"testing"
+
+	"github.com/go-logr/logr"
+	"github.com/stretchr/testify/require"
+	appsv1 "k8s.io/api/apps/v1"
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	"github.com/open-telemetry/opentelemetry-operator/apis/v1alpha1"
+	"github.com/open-telemetry/opentelemetry-operator/internal/config"
+)
+
+var (
+	selectorLabels = map[string]string{
+		"app.kubernetes.io/managed-by": "opentelemetry-operator",
+		"app.kubernetes.io/part-of":    "opentelemetry",
+		"app.kubernetes.io/component":  "opentelemetry-collector",
+		"app.kubernetes.io/instance":   "test.test",
+	}
+	basePolicy = corev1.ServiceInternalTrafficPolicyCluster
+)
+
+func TestBuildAll(t *testing.T) {
+	var goodConfig = `receivers:
+  examplereceiver:
+    endpoint: "0.0.0.0:12345"
+service:
+  pipelines:
+    metrics:
+      receivers: [examplereceiver]
+      exporters: [logging]
+`
+	one := int32(1)
+	type args struct {
+		instance v1alpha1.OpenTelemetryCollector
+	}
+	tests := []struct {
+		name    string
+		args    args
+		want    []client.Object
+		wantErr bool
+	}{
+		{
+			name: "base case",
+			args: args{
+				instance: v1alpha1.OpenTelemetryCollector{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "test",
+						Namespace: "test",
+					},
+					Spec: v1alpha1.OpenTelemetryCollectorSpec{
+						Replicas: &one,
+						Mode:     "deployment",
+						Image:    "test",
+						Config:   goodConfig,
+					},
+				},
+			},
+			want: []client.Object{
+				&appsv1.Deployment{
+					TypeMeta: metav1.TypeMeta{},
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "test-collector",
+						Namespace: "test",
+						Labels: map[string]string{
+							"app.kubernetes.io/component":  "opentelemetry-collector",
+							"app.kubernetes.io/instance":   "test.test",
+							"app.kubernetes.io/managed-by": "opentelemetry-operator",
+							"app.kubernetes.io/name":       "test-collector",
+							"app.kubernetes.io/part-of":    "opentelemetry",
+							"app.kubernetes.io/version":    "latest",
+						},
+						Annotations: map[string]string{
+							"opentelemetry-operator-config/sha256": "baf97852b8beb44fb46a120f8c31873ded3129088e50cd6c69f3208ba60bd661",
+							"prometheus.io/path":                   "/metrics",
+							"prometheus.io/port":                   "8888",
+							"prometheus.io/scrape":                 "true",
+						},
+					},
+					Spec: appsv1.DeploymentSpec{
+						Replicas: &one,
+						Selector: &metav1.LabelSelector{
+							MatchLabels: selectorLabels,
+						},
+						Template: corev1.PodTemplateSpec{
+							ObjectMeta: metav1.ObjectMeta{
+								Labels: map[string]string{
+									"app.kubernetes.io/component":  "opentelemetry-collector",
+									"app.kubernetes.io/instance":   "test.test",
+									"app.kubernetes.io/managed-by": "opentelemetry-operator",
+									"app.kubernetes.io/name":       "test-collector",
+									"app.kubernetes.io/part-of":    "opentelemetry",
+									"app.kubernetes.io/version":    "latest",
+								},
+								Annotations: map[string]string{
+									"opentelemetry-operator-config/sha256": "baf97852b8beb44fb46a120f8c31873ded3129088e50cd6c69f3208ba60bd661",
+									"prometheus.io/path":                   "/metrics",
+									"prometheus.io/port":                   "8888",
+									"prometheus.io/scrape":                 "true",
+								},
+							},
+							Spec: corev1.PodSpec{
+								Volumes: []corev1.Volume{
+									{
+										Name: "otc-internal",
+										VolumeSource: corev1.VolumeSource{
+											ConfigMap: &corev1.ConfigMapVolumeSource{
+												LocalObjectReference: corev1.LocalObjectReference{
+													Name: "test-collector",
+												},
+												Items: []corev1.KeyToPath{
+													{
+														Key:  "collector.yaml",
+														Path: "collector.yaml",
+													},
+												},
+											},
+										},
+									},
+								},
+								Containers: []corev1.Container{
+									{
+										Name:  "otc-container",
+										Image: "test",
+										Args: []string{
+											"--config=/conf/collector.yaml",
+										},
+										Ports: []corev1.ContainerPort{
+											{
+												Name:          "examplereceiver",
+												HostPort:      0,
+												ContainerPort: 12345,
+											},
+											{
+												Name:          "metrics",
+												HostPort:      0,
+												ContainerPort: 8888,
+												Protocol:      "TCP",
+											},
+										},
+										Env: []corev1.EnvVar{
+											{
+												Name: "POD_NAME",
+												ValueFrom: &corev1.EnvVarSource{
+													FieldRef: &corev1.ObjectFieldSelector{
+														FieldPath: "metadata.name",
+													},
+												},
+											},
+										},
+										VolumeMounts: []corev1.VolumeMount{
+											{
+												Name:      "otc-internal",
+												MountPath: "/conf",
+											},
+										},
+									},
+								},
+								DNSPolicy:          "ClusterFirst",
+								ServiceAccountName: "test-collector",
+							},
+						},
+					},
+				},
+				&corev1.ConfigMap{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "test-collector",
+						Namespace: "test",
+						Labels: map[string]string{
+							"app.kubernetes.io/component":  "opentelemetry-collector",
+							"app.kubernetes.io/instance":   "test.test",
+							"app.kubernetes.io/managed-by": "opentelemetry-operator",
+							"app.kubernetes.io/name":       "test-collector",
+							"app.kubernetes.io/part-of":    "opentelemetry",
+							"app.kubernetes.io/version":    "latest",
+						},
+						Annotations: nil,
+					},
+					Data: map[string]string{
+						"collector.yaml": "receivers:\n  examplereceiver:\n    endpoint: \"0.0.0.0:12345\"\nservice:\n  pipelines:\n    metrics:\n      receivers: [examplereceiver]\n      exporters: [logging]\n",
+					},
+				},
+				&corev1.ServiceAccount{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "test-collector",
+						Namespace: "test",
+						Labels: map[string]string{
+							"app.kubernetes.io/component":  "opentelemetry-collector",
+							"app.kubernetes.io/instance":   "test.test",
+							"app.kubernetes.io/managed-by": "opentelemetry-operator",
+							"app.kubernetes.io/name":       "test-collector",
+							"app.kubernetes.io/part-of":    "opentelemetry",
+							"app.kubernetes.io/version":    "latest",
+						},
+						Annotations: nil,
+					},
+				},
+				&corev1.Service{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "test-collector",
+						Namespace: "test",
+						Labels: map[string]string{
+							"app.kubernetes.io/component":  "opentelemetry-collector",
+							"app.kubernetes.io/instance":   "test.test",
+							"app.kubernetes.io/managed-by": "opentelemetry-operator",
+							"app.kubernetes.io/name":       "test-collector",
+							"app.kubernetes.io/part-of":    "opentelemetry",
+							"app.kubernetes.io/version":    "latest",
+						},
+						Annotations: nil,
+					},
+					Spec: corev1.ServiceSpec{
+						Ports: []corev1.ServicePort{
+							{
+								Name: "examplereceiver",
+								Port: 12345,
+							},
+						},
+						Selector:              selectorLabels,
+						InternalTrafficPolicy: &basePolicy,
+					},
+				},
+				&corev1.Service{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "test-collector-headless",
+						Namespace: "test",
+						Labels: map[string]string{
+							"app.kubernetes.io/component":                          "opentelemetry-collector",
+							"app.kubernetes.io/instance":                           "test.test",
+							"app.kubernetes.io/managed-by":                         "opentelemetry-operator",
+							"app.kubernetes.io/name":                               "test-collector",
+							"app.kubernetes.io/part-of":                            "opentelemetry",
+							"app.kubernetes.io/version":                            "latest",
+							"operator.opentelemetry.io/collector-headless-service": "Exists",
+						},
+						Annotations: map[string]string{
+							"service.beta.openshift.io/serving-cert-secret-name": "test-collector-headless-tls",
+						},
+					},
+					Spec: corev1.ServiceSpec{
+						Ports: []corev1.ServicePort{
+							{
+								Name: "examplereceiver",
+								Port: 12345,
+							},
+						},
+						Selector:              selectorLabels,
+						InternalTrafficPolicy: &basePolicy,
+						ClusterIP:             "None",
+					},
+				},
+				&corev1.Service{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      "test-collector-monitoring",
+						Namespace: "test",
+						Labels: map[string]string{
+							"app.kubernetes.io/component":  "opentelemetry-collector",
+							"app.kubernetes.io/instance":   "test.test",
+							"app.kubernetes.io/managed-by": "opentelemetry-operator",
+							"app.kubernetes.io/name":       "test-collector-monitoring",
+							"app.kubernetes.io/part-of":    "opentelemetry",
+							"app.kubernetes.io/version":    "latest",
+						},
+						Annotations: nil,
+					},
+					Spec: corev1.ServiceSpec{
+						Ports: []corev1.ServicePort{
+							{
+								Name: "monitoring",
+								Port: 8888,
+							},
+						},
+						Selector: selectorLabels,
+					},
+				},
+			},
+			wantErr: false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			cfg := config.New(
+				config.WithCollectorImage("default-collector"),
+				config.WithTargetAllocatorImage("default-ta-allocator"),
+			)
+			reconciler := NewReconciler(Params{
+				Log:    logr.Discard(),
+				Config: cfg,
+			})
+			params := reconciler.GetParams(tt.args.instance)
+			got, err := reconciler.BuildAll(params)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("BuildAll() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			require.Equal(t, tt.want, got)
+		})
+	}
+}