Implement interpretComponent for karmadactl interpret

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

Author: seanlaii

api/openapi-spec/swagger.json

@@ -18477,7 +18477,7 @@
       ],
       "properties": {
         "luaScript": {
-          "description": "LuaScript holds the Lua script that is used to extract the desired replica count and resource requirements for each component of the resource.\n\nThe script should implement a function as follows:\n\n```\n  luaScript: \u003e\n      function GetComponents(desiredObj)\n          local components = {}\n\n          local jobManagerComponent = {\n              name = \"jobmanager\"\n              replicas = desiredObj.spec.jobManager.replicas\n          }\n          table.insert(components, jobManagerComponent)\n\n          local taskManagerComponent = {\n              name = \"taskmanager\"\n              replicas = desiredObj.spec.taskManager.replicas\n          }\n          table.insert(components, taskManagerComponent)\n\n          return components\n      end\n```\n\nThe content of the LuaScript needs to be a whole function including both declaration and implementation.\n\nThe parameters will be supplied by the system:\n  - desiredObj: the object represents the configuration to be applied\n      to the member cluster.\n\nThe function expects one return value:\n  - components: the resource requirements for each component.\nThe returned value will be set into a ResourceBinding or ClusterResourceBinding.",
+          "description": "LuaScript holds the Lua script that is used to extract the desired replica count and resource requirements for each component of the resource.\n\nThe script should implement a function as follows:\n\n```\n  luaScript: \u003e\n      function GetComponents(desiredObj)\n          local components = {}\n\n          local jobManagerComponent = {\n              name = \"jobmanager\",\n              replicas = desiredObj.spec.jobManager.replicas\n          }\n          table.insert(components, jobManagerComponent)\n\n          local taskManagerComponent = {\n              name = \"taskmanager\",\n              replicas = desiredObj.spec.taskManager.replicas\n          }\n          table.insert(components, taskManagerComponent)\n\n          return components\n      end\n```\n\nThe content of the LuaScript needs to be a whole function including both declaration and implementation.\n\nThe parameters will be supplied by the system:\n  - desiredObj: the object represents the configuration to be applied\n      to the member cluster.\n\nThe function expects one return value:\n  - components: the resource requirements for each component.\nThe returned value will be set into a ResourceBinding or ClusterResourceBinding.",
           "type": "string",
           "default": ""
         }

charts/karmada/_crds/bases/config/config.karmada.io_resourceinterpretercustomizations.yaml

@@ -84,13 +84,13 @@ spec:
                                     local components = {}
 
                                     local jobManagerComponent = {
-                                        name = "jobmanager"
+                                        name = "jobmanager",
                                         replicas = desiredObj.spec.jobManager.replicas
                                     }
                                     table.insert(components, jobManagerComponent)
 
                                     local taskManagerComponent = {
-                                        name = "taskmanager"
+                                        name = "taskmanager",
                                         replicas = desiredObj.spec.taskManager.replicas
                                     }
                                     table.insert(components, taskManagerComponent)

pkg/apis/config/v1alpha1/resourceinterpretercustomization_types.go

@@ -230,13 +230,13 @@ type ComponentResourceRequirement struct {
 	//           local components = {}
 	//
 	//           local jobManagerComponent = {
-	//               name = "jobmanager"
+	//               name = "jobmanager",
 	//               replicas = desiredObj.spec.jobManager.replicas
 	//           }
 	//           table.insert(components, jobManagerComponent)
 	//
 	//           local taskManagerComponent = {
-	//               name = "taskmanager"
+	//               name = "taskmanager",
 	//               replicas = desiredObj.spec.taskManager.replicas
 	//           }
 	//           table.insert(components, taskManagerComponent)

pkg/generated/openapi/zz_generated.openapi.go

@@ -66,6 +66,7 @@ TARGET: apps/v1 Deployment
 RULERS:
     Retain:                  PASS
     InterpretReplica:        ERROR: <string> line:1(column:10) near 'format':   parse error   
+    InterpretComponent:      UNSET
     ReviseReplica:           UNSET
     InterpretStatus:         UNSET
     AggregateStatus:         UNSET
@@ -87,6 +88,7 @@ TARGET: apps/v1 Deployment
 RULERS:
     Retain:                  PASS
     InterpretReplica:        PASS
+    InterpretComponent:      PASS
     ReviseReplica:           PASS
     InterpretStatus:         PASS
     AggregateStatus:         PASS

pkg/karmadactl/interpret/check_test.go

@@ -81,6 +81,23 @@ status: {}
 # [2/2] requires:
 resourceRequest:
     cpu: 100m
+`,
+		},
+		{
+			name: "execute interpretComponent",
+			options: &Options{
+				FilenameOptions: resource.FilenameOptions{Filenames: []string{"./testdata/customization.yml"}},
+				Operation:       "interpretComponent",
+				ObservedFile:    "./testdata/observed.yml",
+				Rules:           interpreter.AllResourceInterpreterCustomizationRules,
+			},
+			want: `---
+# [1/1] components:
+- name: master
+  replicaRequirements:
+    resourceRequest:
+        cpu: 100m
+  replicas: 3
 `,
 		},
 		{

pkg/karmadactl/interpret/execute_test.go

@@ -63,6 +63,9 @@ var (
 		# Execute the replicaResource rule
         %[1]s interpret -f customization.yml --operation interpretReplica --observed-file observed.yml
 
+		# Execute the componentResource rule
+        %[1]s interpret -f customization.yml --operation interpretComponent --observed-file observed.yml
+
 		# Execute the replicaRevision rule
         %[1]s interpret -f customization.yml --operation reviseReplica --observed-file observed.yml --desired-replica 2
 

pkg/karmadactl/interpret/interpret.go

@@ -26,6 +26,25 @@ spec:
           }
           return replica, requirement
         end
+    componentResource:
+      luaScript: >
+        function GetComponents(obj)
+          local components = {}
+          local replica = obj.spec.replicas
+          local requirement = {
+            resourceRequest = obj.spec.template.spec.containers[1].resources.limits,
+            nodeClaim = {
+              nodeSelector = obj.spec.template.spec.nodeSelector,
+              tolerations = obj.spec.template.spec.tolerations
+            }
+          }
+          table.insert(components, {
+            name = "master",
+            replicas = replica,
+            replicaRequirements = requirement
+          })
+          return components
+        end
     replicaRevision:
       luaScript: >
         function ReviseReplica(obj, desiredReplica)

pkg/karmadactl/interpret/testdata/customization.yml

@@ -31,6 +31,7 @@ import (
 var AllResourceInterpreterCustomizationRules = []Rule{
 	&retentionRule{},
 	&replicaResourceRule{},
+	&componentResourceRule{},
 	&replicaRevisionRule{},
 	&statusReflectionRule{},
 	&statusAggregationRule{},
@@ -102,12 +103,13 @@ func (r *replicaResourceRule) Document() string {
 	return `This rule is used to discover the resource's replica as well as resource requirements.
 The script should implement a function as follows:
 function GetReplicas(desiredObj)
-  replica = desiredObj.spec.replicas
-  nodeClaim = {}
-  nodeClaim.hardNodeAffinity = {}
-  nodeClaim.nodeSelector = {}
-  nodeClaim.tolerations = {}
-  return replica, nodeClaim
+  local replica = desiredObj.spec.replicas
+  local requirement = {}
+  requirement.nodeClaim = {}
+  requirement.nodeClaim.nodeSelector = desiredObj.spec.template.spec.nodeSelector
+  requirement.nodeClaim.tolerations = desiredObj.spec.template.spec.tolerations
+  requirement.resourceRequest = desiredObj.spec.template.spec.containers[1].resources.limits
+  return replica, requirement
 end`
 }
 
@@ -145,6 +147,66 @@ func (r *replicaResourceRule) Run(interpreter *declarative.ConfigurableInterpret
 	return newRuleResult().add("replica", replica).add("requires", requires)
 }
 
+type componentResourceRule struct {
+}
+
+func (r *componentResourceRule) Name() string {
+	return string(configv1alpha1.InterpreterOperationInterpretComponent)
+}
+
+func (r *componentResourceRule) Document() string {
+	return `This rule is used to discover the resource's components.
+The script should implement a function as follows:
+function GetComponents(desiredObj)
+  local components = {}
+  local jobManagerComponent = {
+	name = "jobmanager",
+	replicas = desiredObj.spec.jobManager.replicas
+  }
+  table.insert(components, jobManagerComponent)
+  local taskManagerComponent = {
+	name = "taskmanager",
+	replicas = desiredObj.spec.taskManager.replicas
+  }
+  table.insert(components, taskManagerComponent)
+  return components
+end`
+}
+
+func (r *componentResourceRule) GetScript(c *configv1alpha1.ResourceInterpreterCustomization) string {
+	if c.Spec.Customizations.ComponentResource != nil {
+		return c.Spec.Customizations.ComponentResource.LuaScript
+	}
+	return ""
+}
+
+func (r *componentResourceRule) SetScript(c *configv1alpha1.ResourceInterpreterCustomization, script string) {
+	if script == "" {
+		c.Spec.Customizations.ComponentResource = nil
+		return
+	}
+
+	if c.Spec.Customizations.ComponentResource == nil {
+		c.Spec.Customizations.ComponentResource = &configv1alpha1.ComponentResourceRequirement{}
+	}
+	c.Spec.Customizations.ComponentResource.LuaScript = script
+}
+
+func (r *componentResourceRule) Run(interpreter *declarative.ConfigurableInterpreter, args RuleArgs) *RuleResult {
+	obj, err := args.getObjectOrError()
+	if err != nil {
+		return newRuleResultWithError(err)
+	}
+	components, enabled, err := interpreter.GetComponents(obj)
+	if err != nil {
+		return newRuleResultWithError(err)
+	}
+	if !enabled {
+		return newRuleResultWithError(fmt.Errorf("rule is not enabled"))
+	}
+	return newRuleResult().add("components", components)
+}
+
 type replicaRevisionRule struct {
 }
 

pkg/util/interpreter/rule.go

@@ -152,12 +152,13 @@ func TestReplicaResourceRule_Document(t *testing.T) {
 	expected := `This rule is used to discover the resource's replica as well as resource requirements.
 The script should implement a function as follows:
 function GetReplicas(desiredObj)
-  replica = desiredObj.spec.replicas
-  nodeClaim = {}
-  nodeClaim.hardNodeAffinity = {}
-  nodeClaim.nodeSelector = {}
-  nodeClaim.tolerations = {}
-  return replica, nodeClaim
+  local replica = desiredObj.spec.replicas
+  local requirement = {}
+  requirement.nodeClaim = {}
+  requirement.nodeClaim.nodeSelector = desiredObj.spec.template.spec.nodeSelector
+  requirement.nodeClaim.tolerations = desiredObj.spec.template.spec.tolerations
+  requirement.resourceRequest = desiredObj.spec.template.spec.containers[1].resources.limits
+  return replica, requirement
 end`
 	assert.Equal(t, expected, rule.Document())
 }
@@ -200,24 +201,28 @@ func TestReplicaResourceRule_GetScript(t *testing.T) {
 }
 
 func TestReplicaResourceRule_SetScript(t *testing.T) {
-	c := &configv1alpha1.ResourceInterpreterCustomization{
-		Spec: configv1alpha1.ResourceInterpreterCustomizationSpec{
-			Customizations: configv1alpha1.CustomizationRules{
-				ReplicaResource: &configv1alpha1.ReplicaResourceRequirement{},
-			},
-		},
-	}
 	r := &replicaResourceRule{}
 
 	t.Run("Empty Script", func(t *testing.T) {
+		c := &configv1alpha1.ResourceInterpreterCustomization{
+			Spec: configv1alpha1.ResourceInterpreterCustomizationSpec{
+				Customizations: configv1alpha1.CustomizationRules{
+					ReplicaResource: &configv1alpha1.ReplicaResourceRequirement{},
+				},
+			},
+		}
 		r.SetScript(c, "")
 		if c.Spec.Customizations.ReplicaResource != nil {
 			t.Errorf("Expected ReplicaResource to be nil, but got %v", c.Spec.Customizations.ReplicaResource)
 		}
 	})
 
 	t.Run("Non-Empty Script", func(t *testing.T) {
-		c.Spec.Customizations.ReplicaResource = nil
+		c := &configv1alpha1.ResourceInterpreterCustomization{
+			Spec: configv1alpha1.ResourceInterpreterCustomizationSpec{
+				Customizations: configv1alpha1.CustomizationRules{},
+			},
+		}
 		script := "test script"
 		r.SetScript(c, script)
 		if c.Spec.Customizations.ReplicaResource == nil {
@@ -229,6 +234,105 @@ func TestReplicaResourceRule_SetScript(t *testing.T) {
 	})
 }
 
+func TestComponentResourceRule_Name(t *testing.T) {
+	r := &componentResourceRule{}
+	expected := string(configv1alpha1.InterpreterOperationInterpretComponent)
+	actual := r.Name()
+	assert.Equal(t, expected, actual, "Name should return %v", expected)
+}
+
+func TestComponentResourceRule_Document(t *testing.T) {
+	rule := &componentResourceRule{}
+	expected := `This rule is used to discover the resource's components.
+The script should implement a function as follows:
+function GetComponents(desiredObj)
+  local components = {}
+  local jobManagerComponent = {
+	name = "jobmanager",
+	replicas = desiredObj.spec.jobManager.replicas
+  }
+  table.insert(components, jobManagerComponent)
+  local taskManagerComponent = {
+	name = "taskmanager",
+	replicas = desiredObj.spec.taskManager.replicas
+  }
+  table.insert(components, taskManagerComponent)
+  return components
+end`
+	assert.Equal(t, expected, rule.Document())
+}
+
+func TestComponentResourceRule_GetScript(t *testing.T) {
+	t.Run("WithScript", func(t *testing.T) {
+		c := &configv1alpha1.ResourceInterpreterCustomization{
+			Spec: configv1alpha1.ResourceInterpreterCustomizationSpec{
+				Customizations: configv1alpha1.CustomizationRules{
+					ComponentResource: &configv1alpha1.ComponentResourceRequirement{
+						LuaScript: "return 'test script'",
+					},
+				},
+			},
+		}
+		r := &componentResourceRule{}
+		script := r.GetScript(c)
+		expectedScript := c.Spec.Customizations.ComponentResource.LuaScript
+		if script != expectedScript {
+			t.Errorf("GetScript() returned %q, expected %q", script, expectedScript)
+		}
+	})
+
+	t.Run("WithoutScript", func(t *testing.T) {
+		c := &configv1alpha1.ResourceInterpreterCustomization{
+			Spec: configv1alpha1.ResourceInterpreterCustomizationSpec{
+				Customizations: configv1alpha1.CustomizationRules{
+					ComponentResource: nil,
+				},
+			},
+		}
+
+		rule := &componentResourceRule{}
+		script := rule.GetScript(c)
+
+		if script != "" {
+			t.Errorf("GetScript() returned %q, expected an empty string", script)
+		}
+	})
+}
+
+func TestComponentResourceRule_SetScript(t *testing.T) {
+	r := &componentResourceRule{}
+
+	t.Run("Empty Script", func(t *testing.T) {
+		c := &configv1alpha1.ResourceInterpreterCustomization{
+			Spec: configv1alpha1.ResourceInterpreterCustomizationSpec{
+				Customizations: configv1alpha1.CustomizationRules{
+					ComponentResource: &configv1alpha1.ComponentResourceRequirement{},
+				},
+			},
+		}
+		r.SetScript(c, "")
+		if c.Spec.Customizations.ComponentResource != nil {
+			t.Errorf("Expected ComponentResource to be nil, but got %v", c.Spec.Customizations.ComponentResource)
+		}
+	})
+
+	t.Run("Non-Empty Script", func(t *testing.T) {
+		c := &configv1alpha1.ResourceInterpreterCustomization{
+			Spec: configv1alpha1.ResourceInterpreterCustomizationSpec{
+				Customizations: configv1alpha1.CustomizationRules{},
+			},
+		}
+		script := "test script"
+		r.SetScript(c, script)
+		if c.Spec.Customizations.ComponentResource == nil {
+			t.Errorf("Expected ComponentResource to be non-nil, but got nil")
+		}
+		if c.Spec.Customizations.ComponentResource.LuaScript != "test script" {
+			t.Errorf("Expected ComponentResource.LuaScript to be %s, but got %s", script, c.Spec.Customizations.ComponentResource.LuaScript)
+		}
+	})
+}
+
 func TestReplicaRevisionRule_Name(t *testing.T) {
 	r := &replicaRevisionRule{}
 	expected := string(configv1alpha1.InterpreterOperationReviseReplica)