Implement GetComponents method for ConfigurableInterpreter

Signed-off-by: wei-chenglai <[email protected]>

Author: seanlaii

pkg/resourceinterpreter/customized/declarative/configmanager/accessor.go

@@ -31,6 +31,7 @@ type LuaScriptAccessor interface {
 
 	GetRetentionLuaScript() string
 	GetReplicaResourceLuaScript() string
+	GetComponentResourceLuaScript() string
 	GetReplicaRevisionLuaScript() string
 	GetStatusReflectionLuaScript() string
 	GetStatusAggregationLuaScript() string
@@ -46,6 +47,7 @@ type CustomAccessor interface {
 type resourceCustomAccessor struct {
 	retention                 *configv1alpha1.LocalValueRetention
 	replicaResource           *configv1alpha1.ReplicaResourceRequirement
+	componentResource         *configv1alpha1.ComponentResourceRequirement
 	replicaRevision           *configv1alpha1.ReplicaRevision
 	statusReflection          *configv1alpha1.StatusReflection
 	statusAggregation         *configv1alpha1.StatusAggregation
@@ -66,6 +68,9 @@ func (a *resourceCustomAccessor) Merge(rules configv1alpha1.CustomizationRules)
 	if rules.ReplicaResource != nil {
 		a.setReplicaResource(rules.ReplicaResource)
 	}
+	if rules.ComponentResource != nil {
+		a.setComponentResource(rules.ComponentResource)
+	}
 	if rules.ReplicaRevision != nil {
 		a.setReplicaRevision(rules.ReplicaRevision)
 	}
@@ -97,6 +102,13 @@ func (a *resourceCustomAccessor) GetReplicaResourceLuaScript() string {
 	return a.replicaResource.LuaScript
 }
 
+func (a *resourceCustomAccessor) GetComponentResourceLuaScript() string {
+	if a.componentResource == nil {
+		return ""
+	}
+	return a.componentResource.LuaScript
+}
+
 func (a *resourceCustomAccessor) GetReplicaRevisionLuaScript() string {
 	if a.replicaRevision == nil {
 		return ""
@@ -161,6 +173,17 @@ func (a *resourceCustomAccessor) setReplicaResource(replicaResource *configv1alp
 	}
 }
 
+func (a *resourceCustomAccessor) setComponentResource(componentResource *configv1alpha1.ComponentResourceRequirement) {
+	if a.componentResource == nil {
+		a.componentResource = componentResource
+		return
+	}
+
+	if componentResource.LuaScript != "" && a.componentResource.LuaScript == "" {
+		a.componentResource.LuaScript = componentResource.LuaScript
+	}
+}
+
 func (a *resourceCustomAccessor) setReplicaRevision(replicaRevision *configv1alpha1.ReplicaRevision) {
 	if a.replicaRevision == nil {
 		a.replicaRevision = replicaRevision

pkg/resourceinterpreter/customized/declarative/configmanager/accessor_test.go

@@ -85,6 +85,34 @@ func TestGetReplicaResourceLuaScript(t *testing.T) {
 	}
 }
 
+func TestGetComponentResourceLuaScript(t *testing.T) {
+	tests := []struct {
+		name     string
+		accessor *resourceCustomAccessor
+		want     string
+	}{
+		{
+			name:     "nil component resource",
+			accessor: &resourceCustomAccessor{},
+			want:     "",
+		},
+		{
+			name: "with script",
+			accessor: &resourceCustomAccessor{
+				componentResource: &configv1alpha1.ComponentResourceRequirement{LuaScript: "test-script"},
+			},
+			want: "test-script",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got := tt.accessor.GetComponentResourceLuaScript()
+			assert.Equal(t, tt.want, got)
+		})
+	}
+}
+
 func TestGetReplicaRevisionLuaScript(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -465,6 +493,45 @@ func TestSetReplicaResource(t *testing.T) {
 	}
 }
 
+func TestSetComponentResource(t *testing.T) {
+	tests := []struct {
+		name    string
+		initial *resourceCustomAccessor
+		input   *configv1alpha1.ComponentResourceRequirement
+		want    string
+	}{
+		{
+			name:    "set on nil field",
+			initial: &resourceCustomAccessor{},
+			input:   &configv1alpha1.ComponentResourceRequirement{LuaScript: "script1"},
+			want:    "script1",
+		},
+		{
+			name: "set on empty script",
+			initial: &resourceCustomAccessor{
+				componentResource: &configv1alpha1.ComponentResourceRequirement{LuaScript: ""},
+			},
+			input: &configv1alpha1.ComponentResourceRequirement{LuaScript: "script1"},
+			want:  "script1",
+		},
+		{
+			name: "set on non-empty script",
+			initial: &resourceCustomAccessor{
+				componentResource: &configv1alpha1.ComponentResourceRequirement{LuaScript: "existing"},
+			},
+			input: &configv1alpha1.ComponentResourceRequirement{LuaScript: "script1"},
+			want:  "existing",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			tt.initial.setComponentResource(tt.input)
+			assert.Equal(t, tt.want, tt.initial.GetComponentResourceLuaScript())
+		})
+	}
+}
+
 func TestSetReplicaRevision(t *testing.T) {
 	tests := []struct {
 		name    string

pkg/resourceinterpreter/customized/declarative/configurable.go

@@ -70,6 +70,8 @@ func (c *ConfigurableInterpreter) HookEnabled(kind schema.GroupVersionKind, oper
 		script = accessor.GetHealthInterpretationLuaScript()
 	case configv1alpha1.InterpreterOperationInterpretReplica:
 		script = accessor.GetReplicaResourceLuaScript()
+	case configv1alpha1.InterpreterOperationInterpretComponent:
+		script = accessor.GetComponentResourceLuaScript()
 	case configv1alpha1.InterpreterOperationInterpretStatus:
 		script = accessor.GetStatusReflectionLuaScript()
 	case configv1alpha1.InterpreterOperationRetain:
@@ -99,6 +101,25 @@ func (c *ConfigurableInterpreter) GetReplicas(object *unstructured.Unstructured)
 	return
 }
 
+// GetComponents returns the desired components of the object.
+func (c *ConfigurableInterpreter) GetComponents(object *unstructured.Unstructured) (components []workv1alpha2.ComponentRequirements, enabled bool, err error) {
+	klog.V(4).Infof("Get components for object: %v %s/%s with configurable interpreter.", object.GroupVersionKind(), object.GetNamespace(), object.GetName())
+
+	accessor, enabled := c.getCustomAccessor(object.GroupVersionKind())
+	if !enabled {
+		return
+	}
+
+	script := accessor.GetComponentResourceLuaScript()
+	if len(script) == 0 {
+		enabled = false
+		return
+	}
+
+	components, err = c.luaVM.GetComponents(object, script)
+	return
+}
+
 // ReviseReplica revises the replica of the given object.
 func (c *ConfigurableInterpreter) ReviseReplica(object *unstructured.Unstructured, replica int64) (revised *unstructured.Unstructured, enabled bool, err error) {
 	klog.V(4).Infof("Revise replicas for object: %v %s/%s with configurable interpreter.", object.GroupVersionKind(), object.GetNamespace(), object.GetName())

pkg/resourceinterpreter/customized/declarative/luavm/lua.go

@@ -154,6 +154,33 @@ func (vm *VM) GetReplicas(obj *unstructured.Unstructured, script string) (replic
 	return
 }
 
+// GetComponents returns the desired components of the object by executing a Lua script.
+func (vm *VM) GetComponents(obj *unstructured.Unstructured, script string) ([]workv1alpha2.ComponentRequirements, error) {
+	results, err := vm.RunScript(script, "GetComponents", 1, obj)
+	if err != nil {
+		return nil, fmt.Errorf("failed to run 'GetComponents' script: %w", err)
+	}
+
+	componentsResult := results[0]
+	var components []workv1alpha2.ComponentRequirements
+
+	switch componentsResult.Type() {
+	case lua.LTTable:
+		if err := ConvertLuaResultInto(componentsResult.(*lua.LTable), &components); err != nil {
+			klog.Errorf("Failed to convert Lua result for GetComponents: %v", err)
+			return nil, fmt.Errorf("failed to convert lua table for components: %w", err)
+		}
+	case lua.LTNil:
+		// This is a valid case where the script returns no components.
+		// The 'components' slice is already nil, so we do nothing.
+	default:
+		// Handle unexpected return types.
+		return nil, fmt.Errorf("expected result type 'table' or 'nil' from GetComponents, but got '%s'", componentsResult.Type())
+	}
+
+	return components, nil
+}
+
 // ReviseReplica revises the replica of the given object by lua.
 func (vm *VM) ReviseReplica(object *unstructured.Unstructured, replica int64, script string) (*unstructured.Unstructured, error) {
 	results, err := vm.RunScript(script, "ReviseReplica", 1, object, replica)