Skip to content
Open
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
26 changes: 14 additions & 12 deletions pkg/ddc/cache/engine/cm.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
package engine

import (
"context"
"encoding/json"

datav1alpha1 "github.com/fluid-cloudnative/fluid/api/v1alpha1"
"github.com/fluid-cloudnative/fluid/pkg/common"
"github.com/fluid-cloudnative/fluid/pkg/utils"
Expand All @@ -27,7 +29,7 @@ import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func (e *CacheEngine) createRuntimeConfigMaps(runtimeClass *datav1alpha1.CacheRuntimeClass) error {
func (e *CacheEngine) createRuntimeConfigMaps(ctx context.Context, runtimeClass *datav1alpha1.CacheRuntimeClass) error {
runtime, err := e.getRuntime()
if err != nil {
return err
Expand All @@ -46,29 +48,29 @@ func (e *CacheEngine) createRuntimeConfigMaps(runtimeClass *datav1alpha1.CacheRu
}

// create the config map defined in CacheRuntimeClass ExtraResources, runtimeClass PodTemplate can use these.
err = e.createConfigMapInRuntimeClass(&runtimeClass.ExtraResources, owner)
err = e.createConfigMapInRuntimeClass(ctx, &runtimeClass.ExtraResources, owner)
if err != nil {
return err
}

// create the config map generated by fluid, automatically mounted in component pods.
err = e.createRuntimeValueConfigMap(runtime, owner)
err = e.createRuntimeValueConfigMap(ctx, runtime, owner)
return err
}

// create if not exists
func (e *CacheEngine) createConfigMapInRuntimeClass(extraResources *datav1alpha1.RuntimeExtraResources, owner []metav1.OwnerReference) error {
func (e *CacheEngine) createConfigMapInRuntimeClass(ctx context.Context, extraResources *datav1alpha1.RuntimeExtraResources, owner []metav1.OwnerReference) error {
if extraResources.ConfigMaps == nil {
return nil
}

for _, configMap := range extraResources.ConfigMaps {
cm, err := kubeclient.GetConfigmapByName(e.Client, configMap.Name, e.namespace)
cm, err := kubeclient.GetConfigmapByNameWithContext(ctx, e.Client, configMap.Name, e.namespace)
if err != nil {
return err
}
if cm == nil {
err = kubeclient.CreateConfigMapWithOwner(e.Client, configMap.Name, e.namespace, configMap.Data, owner)
err = kubeclient.CreateConfigMapWithOwnerWithContext(ctx, e.Client, configMap.Name, e.namespace, configMap.Data, owner)
if err != nil {
return err
}
Expand All @@ -79,26 +81,26 @@ func (e *CacheEngine) createConfigMapInRuntimeClass(extraResources *datav1alpha1
}

// create if not exists
func (e *CacheEngine) createRuntimeValueConfigMap(runtime *datav1alpha1.CacheRuntime, owner []metav1.OwnerReference) error {
configMap, err := kubeclient.GetConfigmapByName(e.Client, e.getRuntimeConfigConfigMapName(), e.namespace)
func (e *CacheEngine) createRuntimeValueConfigMap(ctx context.Context, runtime *datav1alpha1.CacheRuntime, owner []metav1.OwnerReference) error {
configMap, err := kubeclient.GetConfigmapByNameWithContext(ctx, e.Client, e.getRuntimeConfigConfigMapName(), e.namespace)
if err != nil {
return err
}
// create if not exists
if configMap != nil {
return nil
}
data, err := e.generateRuntimeConfigData(runtime)
data, err := e.generateRuntimeConfigData(ctx, runtime)
if err != nil {
return errors.Wrap(err, "failed to generate runtime config")
}

return kubeclient.CreateConfigMapWithOwner(e.Client, e.getRuntimeConfigConfigMapName(), e.namespace, data, owner)
return kubeclient.CreateConfigMapWithOwnerWithContext(ctx, e.Client, e.getRuntimeConfigConfigMapName(), e.namespace, data, owner)
Comment thread
CAICAIIs marked this conversation as resolved.
}

// generateRuntimeConfigData generate the data in the config map for runtime config
func (e *CacheEngine) generateRuntimeConfigData(runtime *datav1alpha1.CacheRuntime) (map[string]string, error) {
dataset, err := utils.GetDataset(e.Client, e.name, e.namespace)
func (e *CacheEngine) generateRuntimeConfigData(ctx context.Context, runtime *datav1alpha1.CacheRuntime) (map[string]string, error) {
dataset, err := utils.GetDatasetWithContext(ctx, e.Client, e.name, e.namespace)
if err != nil {
return nil, err
}
Expand Down
230 changes: 230 additions & 0 deletions pkg/ddc/cache/engine/cm_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,230 @@
/*
Copyright 2026 The Fluid 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 engine

import (
"context"
"testing"

datav1alpha1 "github.com/fluid-cloudnative/fluid/api/v1alpha1"
"github.com/fluid-cloudnative/fluid/pkg/common"
cruntime "github.com/fluid-cloudnative/fluid/pkg/runtime"
"github.com/fluid-cloudnative/fluid/pkg/utils/fake"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/client"
)

type contextAwareCacheClient struct {
client.Client
updateCount int
}

func (c *contextAwareCacheClient) Get(ctx context.Context, key client.ObjectKey, obj client.Object, opts ...client.GetOption) error {
if err := ctx.Err(); err != nil {
return err
}
return c.Client.Get(ctx, key, obj, opts...)
}

func (c *contextAwareCacheClient) Create(ctx context.Context, obj client.Object, opts ...client.CreateOption) error {
if err := ctx.Err(); err != nil {
return err
}
return c.Client.Create(ctx, obj, opts...)
}

func (c *contextAwareCacheClient) Update(ctx context.Context, obj client.Object, opts ...client.UpdateOption) error {
if err := ctx.Err(); err != nil {
return err
}
c.updateCount++
return c.Client.Update(ctx, obj, opts...)
}

func TestCreateConfigMapInRuntimeClassWithCanceledContext(t *testing.T) {
scheme := newCacheEngineTestScheme(t)
baseClient := fake.NewFakeClientWithScheme(scheme)
testClient := &contextAwareCacheClient{Client: baseClient}
engine := &CacheEngine{Client: testClient, name: "demo", namespace: "default"}
resources := &datav1alpha1.RuntimeExtraResources{
ConfigMaps: []datav1alpha1.ConfigMapRuntimeExtraResource{{Name: "extra", Data: map[string]string{"key": "value"}}},
}
ctx, cancel := context.WithCancel(context.Background())
cancel()

if err := engine.createConfigMapInRuntimeClass(ctx, resources, nil); err != context.Canceled {
t.Fatalf("expected context.Canceled, got %v", err)
}
}

func TestCreateConfigMapInRuntimeClassCreatesMissingConfigMap(t *testing.T) {
scheme := newCacheEngineTestScheme(t)
baseClient := fake.NewFakeClientWithScheme(scheme)
engine := &CacheEngine{Client: baseClient, name: "demo", namespace: "default"}
resources := &datav1alpha1.RuntimeExtraResources{
ConfigMaps: []datav1alpha1.ConfigMapRuntimeExtraResource{{Name: "extra", Data: map[string]string{"key": "value"}}},
}

if err := engine.createConfigMapInRuntimeClass(context.Background(), resources, nil); err != nil {
t.Fatalf("expected no error, got %v", err)
}

created := &corev1.ConfigMap{}
if err := baseClient.Get(context.Background(), types.NamespacedName{Name: "extra", Namespace: "default"}, created); err != nil {
t.Fatalf("expected configmap to be created, got %v", err)
}
if got := created.Data["key"]; got != "value" {
t.Fatalf("expected copied data value, got %q", got)
}
}

func TestCreateRuntimeValueConfigMapCreatesMissingConfigMap(t *testing.T) {
scheme := newCacheEngineTestScheme(t)
runtimeObj := newCacheRuntimeForConfigMapTest()
runtimeClass := newCacheRuntimeClassForConfigMapTest()
dataset := newDatasetForConfigMapTest()
baseClient := fake.NewFakeClientWithScheme(scheme, runtimeObj, runtimeClass, dataset)
engine := &CacheEngine{Client: baseClient, name: "demo", namespace: "default"}

if err := engine.createRuntimeValueConfigMap(context.Background(), runtimeObj, nil); err != nil {
t.Fatalf("expected no error, got %v", err)
}

created := &corev1.ConfigMap{}
if err := baseClient.Get(context.Background(), types.NamespacedName{Name: engine.getRuntimeConfigConfigMapName(), Namespace: "default"}, created); err != nil {
t.Fatalf("expected runtime value configmap to be created, got %v", err)
}
if _, ok := created.Data[engine.getRuntimeConfigFileName()]; !ok {
t.Fatalf("expected runtime value config data key %q", engine.getRuntimeConfigFileName())
}
}

func TestGenerateRuntimeConfigDataWithCanceledContext(t *testing.T) {
scheme := newCacheEngineTestScheme(t)
runtimeObj := newCacheRuntimeForConfigMapTest()
runtimeClass := newCacheRuntimeClassForConfigMapTest()
dataset := newDatasetForConfigMapTest()
testClient := &contextAwareCacheClient{Client: fake.NewFakeClientWithScheme(scheme, runtimeObj, runtimeClass, dataset)}
engine := &CacheEngine{Client: testClient, name: "demo", namespace: "default"}
ctx, cancel := context.WithCancel(context.Background())
cancel()

if _, err := engine.generateRuntimeConfigData(ctx, runtimeObj); err != context.Canceled {
t.Fatalf("expected context.Canceled, got %v", err)
}
}

func TestSyncRuntimeValueConfigMapWithCanceledContext(t *testing.T) {
scheme := newCacheEngineTestScheme(t)
runtimeObj := newCacheRuntimeForConfigMapTest()
runtimeClass := newCacheRuntimeClassForConfigMapTest()
dataset := newDatasetForConfigMapTest()
testClient := &contextAwareCacheClient{Client: fake.NewFakeClientWithScheme(scheme, runtimeObj, runtimeClass, dataset)}
engine := &CacheEngine{Client: testClient, name: "demo", namespace: "default"}
canceledCtx, cancel := context.WithCancel(context.Background())
cancel()
ctx := cruntime.ReconcileRequestContext{Context: canceledCtx}

if err := engine.syncRuntimeValueConfigMap(ctx, runtimeObj); err != context.Canceled {
t.Fatalf("expected context.Canceled, got %v", err)
}
}

func TestSyncRuntimeValueConfigMapSkipsUnchangedData(t *testing.T) {
scheme := newCacheEngineTestScheme(t)
runtimeObj := newCacheRuntimeForConfigMapTest()
runtimeClass := newCacheRuntimeClassForConfigMapTest()
dataset := newDatasetForConfigMapTest()

baseEngine := &CacheEngine{Client: fake.NewFakeClientWithScheme(scheme, runtimeObj, runtimeClass, dataset), name: "demo", namespace: "default"}
data, err := baseEngine.generateRuntimeConfigData(context.Background(), runtimeObj)
if err != nil {
t.Fatalf("failed to generate runtime config data: %v", err)
}
configMap := &corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{Name: baseEngine.getRuntimeConfigConfigMapName(), Namespace: "default"},
Data: data,
}

testClient := &contextAwareCacheClient{Client: fake.NewFakeClientWithScheme(scheme, runtimeObj, runtimeClass, dataset, configMap)}
engine := &CacheEngine{Client: testClient, name: "demo", namespace: "default"}
ctx := cruntime.ReconcileRequestContext{Context: context.Background()}

if err := engine.syncRuntimeValueConfigMap(ctx, runtimeObj); err != nil {
t.Fatalf("expected no error, got %v", err)
}
if testClient.updateCount != 0 {
t.Fatalf("expected unchanged data to skip update, got %d updates", testClient.updateCount)
}
}

func newCacheEngineTestScheme(t *testing.T) *runtime.Scheme {
t.Helper()
scheme := runtime.NewScheme()
if err := corev1.AddToScheme(scheme); err != nil {
t.Fatal(err)
}
if err := datav1alpha1.AddToScheme(scheme); err != nil {
t.Fatal(err)
}
return scheme
}

func newCacheRuntimeForConfigMapTest() *datav1alpha1.CacheRuntime {
return &datav1alpha1.CacheRuntime{
TypeMeta: metav1.TypeMeta{APIVersion: "data.fluid.io/v1alpha1", Kind: datav1alpha1.CacheRuntimeKind},
ObjectMeta: metav1.ObjectMeta{
Name: "demo",
Namespace: "default",
UID: types.UID("demo-uid"),
},
Spec: datav1alpha1.CacheRuntimeSpec{
RuntimeClassName: "test-class",
Master: datav1alpha1.CacheRuntimeMasterSpec{RuntimeComponentCommonSpec: datav1alpha1.RuntimeComponentCommonSpec{Disabled: true}},
Worker: datav1alpha1.CacheRuntimeWorkerSpec{RuntimeComponentCommonSpec: datav1alpha1.RuntimeComponentCommonSpec{Disabled: true}},
Client: datav1alpha1.CacheRuntimeClientSpec{RuntimeComponentCommonSpec: datav1alpha1.RuntimeComponentCommonSpec{Disabled: true}},
},
}
}

func newCacheRuntimeClassForConfigMapTest() *datav1alpha1.CacheRuntimeClass {
return &datav1alpha1.CacheRuntimeClass{
ObjectMeta: metav1.ObjectMeta{Name: "test-class"},
}
}

func newDatasetForConfigMapTest() *datav1alpha1.Dataset {
return &datav1alpha1.Dataset{
ObjectMeta: metav1.ObjectMeta{Name: "demo", Namespace: "default"},
Spec: datav1alpha1.DatasetSpec{
AccessModes: []corev1.PersistentVolumeAccessMode{corev1.ReadOnlyMany},
Mounts: []datav1alpha1.Mount{
{
Name: "hbase",
MountPoint: "local:///data",
Path: "/data",
ReadOnly: true,
Shared: true,
},
},
},
Status: datav1alpha1.DatasetStatus{Runtimes: []datav1alpha1.Runtime{{Name: "demo", Type: common.CacheRuntime}}},
}
}
2 changes: 1 addition & 1 deletion pkg/ddc/cache/engine/setup.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ func (e *CacheEngine) Setup(ctx cruntime.ReconcileRequestContext) (ready bool, e
}

// create runtime value configmap for runtime mount
err = e.createRuntimeConfigMaps(runtimeClass)
err = e.createRuntimeConfigMaps(ctx, runtimeClass)
if err != nil {
return false, err
}
Expand Down
13 changes: 6 additions & 7 deletions pkg/ddc/cache/engine/sync.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
package engine

import (
"context"
datav1alpha1 "github.com/fluid-cloudnative/fluid/api/v1alpha1"
cruntime "github.com/fluid-cloudnative/fluid/pkg/runtime"
"github.com/fluid-cloudnative/fluid/pkg/utils/kubeclient"
Expand All @@ -34,7 +33,7 @@ func (e *CacheEngine) Sync(ctx cruntime.ReconcileRequestContext) (err error) {
return err
}

err = e.syncRuntimeValueConfigMap(runtime)
err = e.syncRuntimeValueConfigMap(ctx, runtime)
if err != nil {
return err
}
Expand All @@ -54,12 +53,12 @@ func (e *CacheEngine) Sync(ctx cruntime.ReconcileRequestContext) (err error) {
return nil
}

func (e *CacheEngine) syncRuntimeValueConfigMap(runtime *datav1alpha1.CacheRuntime) error {
configMap, err := kubeclient.GetConfigmapByName(e.Client, e.getRuntimeConfigConfigMapName(), e.namespace)
func (e *CacheEngine) syncRuntimeValueConfigMap(ctx cruntime.ReconcileRequestContext, runtime *datav1alpha1.CacheRuntime) error {
configMap, err := kubeclient.GetConfigmapByNameWithContext(ctx, e.Client, e.getRuntimeConfigConfigMapName(), e.namespace)
if err != nil {
return err
}
data, err := e.generateRuntimeConfigData(runtime)
data, err := e.generateRuntimeConfigData(ctx, runtime)
if err != nil {
return err
}
Expand All @@ -77,13 +76,13 @@ func (e *CacheEngine) syncRuntimeValueConfigMap(runtime *datav1alpha1.CacheRunti
}

if configMap == nil {
return kubeclient.CreateConfigMapWithOwner(e.Client, e.getRuntimeConfigConfigMapName(), e.namespace, data, owner)
return kubeclient.CreateConfigMapWithOwnerWithContext(ctx, e.Client, e.getRuntimeConfigConfigMapName(), e.namespace, data, owner)
}

configMapToUpdate := configMap.DeepCopy()
configMapToUpdate.Data = data
if !reflect.DeepEqual(configMapToUpdate, configMap) {
err = e.Client.Update(context.TODO(), configMapToUpdate)
err = kubeclient.UpdateConfigMapWithContext(ctx, e.Client, configMapToUpdate)
if err != nil {
return err
}
Expand Down
Loading
Loading