Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Part 1]Add unit tests for reconcile methods #250

Merged
merged 10 commits into from
May 4, 2021
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ bin
# Release artifacts
dist
bundle.tar.gz
vendor

# editor and IDE paraphernalia
.idea
Expand Down
2 changes: 1 addition & 1 deletion pkg/collector/reconcile/configmap.go
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ func expectedConfigMaps(ctx context.Context, params Params, expected []corev1.Co
updated.ObjectMeta.Labels[k] = v
}

patch := client.MergeFrom(&params.Instance)
patch := client.MergeFrom(existing)
jpkrohling marked this conversation as resolved.
Show resolved Hide resolved

if err := params.Client.Patch(ctx, updated, patch); err != nil {
return fmt.Errorf("failed to apply changes: %w", err)
Expand Down
141 changes: 141 additions & 0 deletions pkg/collector/reconcile/configmap_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
// 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 reconcile

import (
"context"
"testing"

"github.com/stretchr/testify/assert"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/tools/record"

"github.com/open-telemetry/opentelemetry-operator/api/v1alpha1"
"github.com/open-telemetry/opentelemetry-operator/internal/config"
)

func TestDesiredConfigMap(t *testing.T) {
t.Run("should return expected config map", func(t *testing.T) {
expectedLables := map[string]string{
"app.kubernetes.io/managed-by": "opentelemetry-operator",
"app.kubernetes.io/instance": "default.test",
"app.kubernetes.io/part-of": "opentelemetry",
"app.kubernetes.io/component": "opentelemetry-collector",
"app.kubernetes.io/name": "test-collector",
}

expectedData := map[string]string{
"collector.yaml": `
receivers:
jaeger:
protocols:
grpc:
processors:

exporters:
logging:

service:
pipelines:
traces:
receivers: [jaeger]
processors: []
exporters: [logging]

`,
}

actual := desiredConfigMap(context.Background(), params())

assert.Equal(t, "test-collector", actual.Name)
assert.Equal(t, expectedLables, actual.Labels)
assert.Equal(t, expectedData, actual.Data)

})

}

func TestExpectedConfigMap(t *testing.T) {
t.Run("should create config map", func(t *testing.T) {
err := expectedConfigMaps(context.Background(), params(), []v1.ConfigMap{desiredConfigMap(context.Background(), params())}, true)
assert.NoError(t, err)

exists, err := populateObjectIfExists(t, &v1.ConfigMap{}, types.NamespacedName{Namespace: "default", Name: "test-collector"})

assert.NoError(t, err)
assert.True(t, exists)
})

t.Run("should update config map", func(t *testing.T) {

param := Params{
Config: config.New(),
Client: k8sClient,
Instance: v1alpha1.OpenTelemetryCollector{
TypeMeta: metav1.TypeMeta{
Kind: "opentelemetry.io",
APIVersion: "v1",
},
ObjectMeta: metav1.ObjectMeta{
Name: "test",
Namespace: "default",
UID: instanceUID,
},
},
Scheme: testScheme,
Log: logger,
Recorder: record.NewFakeRecorder(10),
}
cm := desiredConfigMap(context.Background(), param)
createObjectIfNotExists(t, "test-collector", &cm)

err := expectedConfigMaps(context.Background(), params(), []v1.ConfigMap{desiredConfigMap(context.Background(), params())}, true)
assert.NoError(t, err)

actual := v1.ConfigMap{}
exists, err := populateObjectIfExists(t, &actual, types.NamespacedName{Namespace: "default", Name: "test-collector"})

assert.NoError(t, err)
assert.True(t, exists)
assert.Equal(t, instanceUID, actual.OwnerReferences[0].UID)
assert.Equal(t, params().Instance.Spec.Config, actual.Data["collector.yaml"])
})

t.Run("should delete config map", func(t *testing.T) {

deletecm := v1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: "test-delete-collector",
Namespace: "default",
Labels: map[string]string{
"app.kubernetes.io/instance": "default.test",
"app.kubernetes.io/managed-by": "opentelemetry-operator",
},
},
}
createObjectIfNotExists(t, "test-delete-collector", &deletecm)

exists, _ := populateObjectIfExists(t, &v1.ConfigMap{}, types.NamespacedName{Namespace: "default", Name: "test-delete-collector"})
assert.True(t, exists)

err := deleteConfigMaps(context.Background(), params(), []v1.ConfigMap{desiredConfigMap(context.Background(), params())})
assert.NoError(t, err)

exists, _ = populateObjectIfExists(t, &v1.ConfigMap{}, types.NamespacedName{Namespace: "default", Name: "test-delete-collector"})
assert.False(t, exists)
})
}
2 changes: 1 addition & 1 deletion pkg/collector/reconcile/daemonset.go
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ func expectedDaemonSets(ctx context.Context, params Params, expected []appsv1.Da
updated.ObjectMeta.Labels[k] = v
}

patch := client.MergeFrom(&params.Instance)
patch := client.MergeFrom(existing)
if err := params.Client.Patch(ctx, updated, patch); err != nil {
return fmt.Errorf("failed to apply changes: %w", err)
}
Expand Down
133 changes: 133 additions & 0 deletions pkg/collector/reconcile/daemonset_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
// 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 reconcile

import (
"context"
"testing"

"github.com/stretchr/testify/assert"
v1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"

"github.com/open-telemetry/opentelemetry-operator/pkg/collector"
)

func TestExpectedDaemonsets(t *testing.T) {
param := params()
expectedDs := collector.DaemonSet(param.Config, logger, param.Instance)

t.Run("should create Daemonset", func(t *testing.T) {
err := expectedDaemonSets(context.Background(), param, []v1.DaemonSet{expectedDs})
assert.NoError(t, err)

exists, err := populateObjectIfExists(t, &v1.DaemonSet{}, types.NamespacedName{Namespace: "default", Name: "test-collector"})

assert.NoError(t, err)
assert.True(t, exists)

})
t.Run("should update Daemonset", func(t *testing.T) {
createObjectIfNotExists(t, "test-collector", &expectedDs)
err := expectedDaemonSets(context.Background(), param, []v1.DaemonSet{expectedDs})
assert.NoError(t, err)

actual := v1.DaemonSet{}
exists, err := populateObjectIfExists(t, &actual, types.NamespacedName{Namespace: "default", Name: "test-collector"})

assert.NoError(t, err)
assert.True(t, exists)
assert.Equal(t, instanceUID, actual.OwnerReferences[0].UID)
})

t.Run("should delete daemonset", func(t *testing.T) {

labels := map[string]string{
"app.kubernetes.io/instance": "default.test",
"app.kubernetes.io/managed-by": "opentelemetry-operator",
}
ds := v1.DaemonSet{}
ds.Name = "dummy"
ds.Namespace = "default"
ds.Labels = labels
ds.Spec = v1.DaemonSetSpec{
Selector: &metav1.LabelSelector{
MatchLabels: labels,
},
Template: corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Labels: labels,
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{{
Name: "dummy",
Image: "busybox",
}},
},
},
}

createObjectIfNotExists(t, "dummy", &ds)

err := deleteDaemonSets(context.Background(), param, []v1.DaemonSet{expectedDs})
assert.NoError(t, err)

actual := v1.DaemonSet{}
exists, _ := populateObjectIfExists(t, &actual, types.NamespacedName{Namespace: "default", Name: "dummy"})

assert.False(t, exists)

})

t.Run("should not delete daemonset", func(t *testing.T) {

labels := map[string]string{
"app.kubernetes.io/managed-by": "helm-opentelemetry-operator",
}
ds := v1.DaemonSet{}
ds.Name = "dummy"
ds.Namespace = "default"
ds.Labels = labels
ds.Spec = v1.DaemonSetSpec{
Selector: &metav1.LabelSelector{
MatchLabels: labels,
},
Template: corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Labels: labels,
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{{
Name: "dummy",
Image: "busybox",
}},
},
},
}

createObjectIfNotExists(t, "dummy", &ds)

err := deleteDaemonSets(context.Background(), param, []v1.DaemonSet{expectedDs})
assert.NoError(t, err)

actual := v1.DaemonSet{}
exists, _ := populateObjectIfExists(t, &actual, types.NamespacedName{Namespace: "default", Name: "dummy"})

assert.True(t, exists)

})
}
2 changes: 1 addition & 1 deletion pkg/collector/reconcile/deployment.go
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ func expectedDeployments(ctx context.Context, params Params, expected []appsv1.D
updated.ObjectMeta.Labels[k] = v
}

patch := client.MergeFrom(&params.Instance)
patch := client.MergeFrom(existing)

if err := params.Client.Patch(ctx, updated, patch); err != nil {
return fmt.Errorf("failed to apply changes: %w", err)
Expand Down
Loading