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.

Sign up for GitHub

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

Jump to bottom

[chore] Fix featuregate usage in controller tests #3490

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+55 −27
Open

[chore] Fix featuregate usage in controller tests #3490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 41 additions & 27 deletions controllers/builder_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
package controllers

import (
"strings"
"testing"

cmv1 "github.com/cert-manager/cert-manager/pkg/apis/certmanager/v1"
Expand Down Expand Up @@ -1245,7 +1244,7 @@ service:
name string
args args
want []client.Object
featuregates []string
featuregates []*colfeaturegate.Gate
wantErr bool
opts []config.Option
}{
Expand Down Expand Up @@ -2188,8 +2187,7 @@ prometheus_cr:
},
},
},
wantErr: false,
featuregates: []string{},
wantErr: false,
},
{
name: "target allocator mtls enabled",
Expand Down Expand Up @@ -2827,7 +2825,7 @@ prometheus_cr:
opts: []config.Option{
config.WithCertManagerAvailability(certmanager.Available),
},
featuregates: []string{"operator.targetallocator.mtls"},
featuregates: []*colfeaturegate.Gate{featuregate.EnableTargetAllocatorMTLS},
},
}
for _, tt := range tests {
Expand All @@ -2848,13 +2846,18 @@ prometheus_cr:
targetAllocator, err := collector.TargetAllocator(params)
require.NoError(t, err)
params.TargetAllocator = targetAllocator
if len(tt.featuregates) > 0 {
fg := strings.Join(tt.featuregates, ",")
flagset := featuregate.Flags(colfeaturegate.GlobalRegistry())
if err = flagset.Set(featuregate.FeatureGatesFlag, fg); err != nil {
t.Errorf("featuregate setting error = %v", err)
registry := colfeaturegate.GlobalRegistry()
for _, gate := range tt.featuregates {
current := gate.IsEnabled()
require.False(t, current, "only enable gates which are disabled by default")
if setErr := registry.Set(gate.ID(), true); setErr != nil {
require.NoError(t, setErr)
return
}
t.Cleanup(func() {
setErr := registry.Set(gate.ID(), current)
require.NoError(t, setErr)
})
}
got, err := BuildCollector(params)
if (err != nil) != tt.wantErr {
Expand Down Expand Up @@ -2909,7 +2912,7 @@ service:
name string
args args
want []client.Object
featuregates []string
featuregates []*colfeaturegate.Gate
wantErr bool
opts []config.Option
}{
Expand Down Expand Up @@ -3396,7 +3399,7 @@ service:
},
},
wantErr: false,
featuregates: []string{},
featuregates: []*colfeaturegate.Gate{},
},
}
for _, tt := range tests {
Expand All @@ -3417,13 +3420,20 @@ service:
targetAllocator, err := collector.TargetAllocator(params)
require.NoError(t, err)
params.TargetAllocator = targetAllocator
featuregates := []string{"operator.collector.targetallocatorcr"}
featuregates := []*colfeaturegate.Gate{featuregate.CollectorUsesTargetAllocatorCR}
featuregates = append(featuregates, tt.featuregates...)
fg := strings.Join(featuregates, ",")
flagset := featuregate.Flags(colfeaturegate.GlobalRegistry())
if err = flagset.Set(featuregate.FeatureGatesFlag, fg); err != nil {
t.Errorf("featuregate setting error = %v", err)
return
registry := colfeaturegate.GlobalRegistry()
for _, gate := range featuregates {
current := gate.IsEnabled()
require.False(t, current, "only enable gates which are disabled by default")
if setErr := registry.Set(gate.ID(), true); setErr != nil {
require.NoError(t, setErr)
return
}
t.Cleanup(func() {
setErr := registry.Set(gate.ID(), current)
require.NoError(t, setErr)
})
}
got, err := BuildCollector(params)
if (err != nil) != tt.wantErr {
Expand All @@ -3445,7 +3455,7 @@ func TestBuildTargetAllocator(t *testing.T) {
name string
args args
want []client.Object
featuregates []string
featuregates []*colfeaturegate.Gate
wantErr bool
opts []config.Option
}{
Expand Down Expand Up @@ -4019,8 +4029,7 @@ prometheus_cr:
},
},
},
wantErr: false,
featuregates: []string{},
wantErr: false,
},
{
name: "collector present",
Expand Down Expand Up @@ -4776,7 +4785,7 @@ prometheus_cr:
opts: []config.Option{
config.WithCertManagerAvailability(certmanager.Available),
},
featuregates: []string{"operator.targetallocator.mtls"},
featuregates: []*colfeaturegate.Gate{featuregate.EnableTargetAllocatorMTLS},
},
}
for _, tt := range tests {
Expand All @@ -4795,13 +4804,18 @@ prometheus_cr:
TargetAllocator: tt.args.instance,
Collector: tt.args.collector,
}
if len(tt.featuregates) > 0 {
fg := strings.Join(tt.featuregates, ",")
flagset := featuregate.Flags(colfeaturegate.GlobalRegistry())
if err := flagset.Set(featuregate.FeatureGatesFlag, fg); err != nil {
t.Errorf("featuregate setting error = %v", err)
registry := colfeaturegate.GlobalRegistry()
for _, gate := range tt.featuregates {
current := gate.IsEnabled()
require.False(t, current, "only enable gates which are disabled by default")
if err := registry.Set(gate.ID(), true); err != nil {
require.NoError(t, err)
return
}
t.Cleanup(func() {
err := registry.Set(gate.ID(), current)
require.NoError(t, err)
})
}
got, err := BuildTargetAllocator(params)
if (err != nil) != tt.wantErr {
Expand Down
14 changes: 14 additions & 0 deletions controllers/reconcile_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
routev1 "github.com/openshift/api/route/v1"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
colfeaturegate "go.opentelemetry.io/collector/featuregate"
appsv1 "k8s.io/api/apps/v1"
autoscalingv2 "k8s.io/api/autoscaling/v2"
v1 "k8s.io/api/core/v1"
Expand All @@ -48,6 +49,7 @@ import (
"github.com/open-telemetry/opentelemetry-operator/internal/config"
"github.com/open-telemetry/opentelemetry-operator/internal/manifests"
"github.com/open-telemetry/opentelemetry-operator/internal/naming"
"github.com/open-telemetry/opentelemetry-operator/pkg/featuregate"
)

const (
Expand All @@ -74,6 +76,18 @@ var (
type check[T any] func(t *testing.T, params T)

func TestOpenTelemetryCollectorReconciler_Reconcile(t *testing.T) {
// enable the collector CR feature flag, as these tests assume it
// TODO: drop this after the flag is enabled by default
registry := colfeaturegate.GlobalRegistry()
current := featuregate.CollectorUsesTargetAllocatorCR.IsEnabled()
require.False(t, current, "don't set gates which are enabled by default")
err := registry.Set(featuregate.CollectorUsesTargetAllocatorCR.ID(), true)
require.NoError(t, err)
t.Cleanup(func() {
err := registry.Set(featuregate.CollectorUsesTargetAllocatorCR.ID(), current)
require.NoError(t, err)
})

addedMetadataDeployment := testCollectorWithMode("test-deployment", v1alpha1.ModeDeployment)
addedMetadataDeployment.Labels = map[string]string{
labelName: labelVal,
Expand Down
Loading