Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions pkg/controller/doriscluster_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -260,8 +260,8 @@ func (r *DorisClusterReconciler) resourceClean(ctx context.Context, dcr *dorisv1

func (r *DorisClusterReconciler) resourceBuilder(builder *ctrl.Builder) *ctrl.Builder {
return builder.For(&dorisv1.DorisCluster{}).
Owns(&appv1.StatefulSet{}).
Owns(&corev1.Service{})
Owns(&appv1.StatefulSet{}, controller_builder.MatchEveryOwner).
Owns(&corev1.Service{}, controller_builder.MatchEveryOwner)
}

func (r *DorisClusterReconciler) watchPodBuilder(builder *ctrl.Builder) *ctrl.Builder {
Expand Down
169 changes: 169 additions & 0 deletions pkg/controller/doriscluster_owner_watch_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you 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 controller

import (
"context"
"path/filepath"
"testing"
"time"

dorisv1 "github.com/apache/doris-operator/api/doris/v1"
"github.com/apache/doris-operator/pkg/common/utils/resource"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/utils/ptr"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/envtest"
metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
)

func TestDorisClusterWatchesExistingNonControllerOwnedResources(t *testing.T) {
environment := &envtest.Environment{CRDDirectoryPaths: []string{filepath.Join("..", "..", "config", "crd", "bases")}, ErrorIfCRDPathMissing: true}
config, err := environment.Start()
if err != nil {
t.Fatal(err)
}
t.Cleanup(func() {
if err := environment.Stop(); err != nil {
t.Error(err)
}
})
scheme := runtime.NewScheme()
for _, add := range []func(*runtime.Scheme) error{dorisv1.AddToScheme, appsv1.AddToScheme, corev1.AddToScheme} {
if err := add(scheme); err != nil {
t.Fatal(err)
}
}
direct, err := client.New(config, client.Options{Scheme: scheme})
if err != nil {
t.Fatal(err)
}
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
ns := &corev1.Namespace{ObjectMeta: metav1.ObjectMeta{Name: "native-owner-watch-test"}}
if err := direct.Create(ctx, ns); err != nil {
t.Fatal(err)
}
owner := &dorisv1.DorisCluster{TypeMeta: metav1.TypeMeta{APIVersion: dorisv1.GroupVersion.String(), Kind: "DorisCluster"}, ObjectMeta: metav1.ObjectMeta{Name: "doris", Namespace: ns.Name}, Spec: dorisv1.DorisClusterSpec{
FeSpec: &dorisv1.FeSpec{BaseSpec: dorisv1.BaseSpec{Replicas: ptr.To(int32(1)), Image: "doris:fe"}},
BeSpec: &dorisv1.BeSpec{BaseSpec: dorisv1.BaseSpec{Replicas: ptr.To(int32(1)), Image: "doris:be"}},
}}
if err := direct.Create(ctx, owner); err != nil {
t.Fatal(err)
}
owner.APIVersion = dorisv1.GroupVersion.String()
owner.Kind = "DorisCluster"
service := resource.BuildExternalService(owner, dorisv1.Component_FE, map[string]interface{}{})
statefulSet := resource.NewStatefulSet(owner, map[string]interface{}{}, dorisv1.Component_BE)
// Simulate upgrading an operator that already manages resources with legacy owners.
for _, object := range []client.Object{&service, &statefulSet} {
if metav1.GetControllerOf(object) != nil {
t.Fatal("fixture must retain its non-controller owner")
}
if err := direct.Create(ctx, object); err != nil {
t.Fatal(err)
}
}
manager, err := ctrl.NewManager(config, ctrl.Options{Scheme: scheme, Metrics: metricsserver.Options{BindAddress: "0"}, HealthProbeBindAddress: "0"})
if err != nil {
t.Fatal(err)
}
requests := make(chan reconcile.Request, 100)
builder := (&DorisClusterReconciler{}).resourceBuilder(ctrl.NewControllerManagedBy(manager).Named("native-resource-owner-test"))
if err := builder.Complete(reconcile.Func(func(ctx context.Context, request reconcile.Request) (ctrl.Result, error) {
requests <- request
return ctrl.Result{}, nil
})); err != nil {
t.Fatal(err)
}
stopped := make(chan error, 1)
go func() { stopped <- manager.Start(ctx) }()
t.Cleanup(func() {
cancel()
select {
case err := <-stopped:
if err != nil {
t.Error(err)
}
case <-time.After(10 * time.Second):
t.Error("manager did not stop")
}
})
syncCtx, syncCancel := context.WithTimeout(ctx, 10*time.Second)
defer syncCancel()
if !manager.GetCache().WaitForCacheSync(syncCtx) {
t.Fatal("cache did not synchronize")
}
drain := func() {
t.Helper()
for {
select {
case <-requests:
case <-time.After(300 * time.Millisecond):
return
}
}
}
expectRequest := func() {
t.Helper()
select {
case request := <-requests:
if request.Name != owner.Name || request.Namespace != owner.Namespace {
t.Fatalf("unexpected owner request: %v", request)
}
case <-time.After(10 * time.Second):
t.Fatal("resource event did not enqueue the existing DorisCluster")
}
}
drain()
if err := direct.Delete(ctx, &service); err != nil {
t.Fatal(err)
}
expectRequest()
drain()
current := &appsv1.StatefulSet{}
if err := direct.Get(ctx, client.ObjectKeyFromObject(&statefulSet), current); err != nil {
t.Fatal(err)
}
base := current.DeepCopy()
current.Spec.Replicas = ptr.To(int32(2))
if err := direct.Patch(ctx, current, client.MergeFrom(base)); err != nil {
t.Fatal(err)
}
expectRequest()
drain()
// Unrelated resources must not enqueue this CR merely because the type is watched.
unrelated := service.DeepCopy()
unrelated.ResourceVersion = ""
unrelated.UID = ""
unrelated.Name = "unrelated"
unrelated.OwnerReferences = nil
if err := direct.Create(ctx, unrelated); err != nil {
t.Fatal(err)
}
select {
case request := <-requests:
t.Fatalf("unowned resource enqueued a CR: %v", request)
case <-time.After(300 * time.Millisecond):
}
}
6 changes: 1 addition & 5 deletions pkg/controller/sub_controller/be/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,7 @@ func (be *Controller) Sync(ctx context.Context, dcr *v1.DorisCluster) error {
be.useNewDefaultValuesInStatefulset(st)
}

if err = k8s.ApplyStatefulSet(ctx, be.K8sclient, &st, func(new *appv1.StatefulSet, est *appv1.StatefulSet) bool {
// if have restart annotation, we should exclude the interference for comparison.
be.RestrictConditionsEqual(new, est)
return resource.StatefulSetDeepEqual(new, est, false)
}, ndf); err != nil {
if err = k8s.ApplyStatefulSet(ctx, be.K8sclient, &st, be.statefulSetsEqual, ndf); err != nil {
klog.Errorf("fe controller sync statefulset name=%s, namespace=%s, clusterName=%s failed. message=%s.",
st.Name, st.Namespace, dcr.Name, err.Error())
return err
Expand Down
9 changes: 9 additions & 0 deletions pkg/controller/sub_controller/be/statefulset.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (
v1 "github.com/apache/doris-operator/api/doris/v1"
"github.com/apache/doris-operator/pkg/common/utils/resource"
appv1 "k8s.io/api/apps/v1"
"k8s.io/utils/ptr"
)

func (be *Controller) buildBEStatefulSet(dcr *v1.DorisCluster, config map[string]interface{}) appv1.StatefulSet {
Expand All @@ -32,3 +33,11 @@ func (be *Controller) buildBEStatefulSet(dcr *v1.DorisCluster, config map[string
func (be *Controller) useNewDefaultValuesInStatefulset(st *appv1.StatefulSet) {
resource.UseNewDefaultInitContainerImage(&st.Spec.Template)
}

// statefulSetsEqual preserves the shared hash and legacy-env comparison, then
// verifies the replica count owned by the native BE controller.
func (be *Controller) statefulSetsEqual(new, old *appv1.StatefulSet) bool {
be.RestrictConditionsEqual(new, old)
equal := resource.StatefulSetDeepEqual(new, old, false)
return equal && ptr.Equal(new.Spec.Replicas, old.Spec.Replicas)
}
104 changes: 104 additions & 0 deletions pkg/controller/sub_controller/be/statefulset_reconcile_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you 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 be

import (
"context"
"testing"

dorisv1 "github.com/apache/doris-operator/api/doris/v1"
"github.com/apache/doris-operator/pkg/common/utils/k8s"
"github.com/apache/doris-operator/pkg/common/utils/resource"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/equality"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
"k8s.io/utils/ptr"
"sigs.k8s.io/controller-runtime/pkg/client/fake"
)

func newBEReplicaTestStatefulSet(n int32) *appsv1.StatefulSet {
bc := &Controller{}
dcr := &dorisv1.DorisCluster{ObjectMeta: metav1.ObjectMeta{Name: "doris", Namespace: "test"}, Spec: dorisv1.DorisClusterSpec{
FeSpec: &dorisv1.FeSpec{BaseSpec: dorisv1.BaseSpec{Replicas: ptr.To(int32(3)), Image: "doris:fe"}},
BeSpec: &dorisv1.BeSpec{BaseSpec: dorisv1.BaseSpec{Replicas: ptr.To(n), Image: "doris:be"}}}}
st := bc.buildBEStatefulSet(dcr, map[string]interface{}{})
return &st
}
func cacheBEStatefulSetHash(st *appsv1.StatefulSet) {
resource.StatefulsetDeepEqualWithKey(st, st.DeepCopy(), "", false)
}
func TestBEStatefulSetReconcilesReplicaDrift(t *testing.T) {
for _, tt := range []struct {
name string
desired, actual, cached int32
legacy bool
}{
{"manual_replica_drift", 20, 21, 20, false},
{"manual_replica_reduction", 20, 19, 20, false},
{"normal_CR_scale_up", 21, 20, 20, false},
{"normal_CR_scale_down", 20, 21, 21, false},
{"legacy_env_scale_up", 21, 20, 20, true},
} {
t.Run(tt.name, func(t *testing.T) {
actual := newBEReplicaTestStatefulSet(tt.cached)
if tt.legacy {
actual.Spec.Template.Spec.Containers[0].Env = append(actual.Spec.Template.Spec.Containers[0].Env, corev1.EnvVar{Name: "CONFIGMAP_MOUNT_PATH", Value: "/etc/doris"})
}
cacheBEStatefulSetHash(actual)
actual.Spec.Replicas = ptr.To(tt.actual)
originalTemplate := actual.Spec.Template.DeepCopy()
c := fake.NewClientBuilder().WithObjects(actual).Build()
bc := &Controller{}
desired := newBEReplicaTestStatefulSet(tt.desired)
if err := k8s.ApplyStatefulSet(context.Background(), c, desired, bc.statefulSetsEqual); err != nil {
t.Fatal(err)
}
got := &appsv1.StatefulSet{}
if err := c.Get(context.Background(), types.NamespacedName{Name: actual.Name, Namespace: actual.Namespace}, got); err != nil {
t.Fatal(err)
}
if *got.Spec.Replicas != tt.desired {
t.Fatalf("replicas=%d want=%d", *got.Spec.Replicas, tt.desired)
}
if !equality.Semantic.DeepEqual(originalTemplate, &got.Spec.Template) {
t.Fatal("replica-only update changed pod template")
}
t.Logf("replicas=%d pod template unchanged", *got.Spec.Replicas)
if !tt.legacy && !bc.statefulSetsEqual(newBEReplicaTestStatefulSet(tt.desired), got) {
t.Fatal("repeat comparison should be equal")
}
})
}
}
func TestBEStatefulSetCreatesMissingResource(t *testing.T) {
c := fake.NewClientBuilder().Build()
bc := &Controller{}
desired := newBEReplicaTestStatefulSet(20)
if err := k8s.ApplyStatefulSet(context.Background(), c, desired, bc.statefulSetsEqual); err != nil {
t.Fatal(err)
}
got := &appsv1.StatefulSet{}
if err := c.Get(context.Background(), types.NamespacedName{Name: desired.Name, Namespace: desired.Namespace}, got); err != nil {
t.Fatal(err)
}
if *got.Spec.Replicas != 20 {
t.Fatal("wrong replica count")
}
}
Loading