nit(external-plugins): rename/clarify state plugin is for HealthState (#699)

Signed-off-by: Gyuho Lee <[email protected]>

Signed-off-by: Gyuho Lee <[email protected]>

Author: gyuho

client/v1/v1_test.go

@@ -535,7 +535,7 @@ func TestGetCustomPlugins(t *testing.T) {
 		"test": {
 			PluginName: "test",
 			Type:       pkgcustomplugins.SpecTypeComponent,
-			StatePlugin: &pkgcustomplugins.Plugin{
+			HealthStatePlugin: &pkgcustomplugins.Plugin{
 				Steps: []pkgcustomplugins.Step{
 					{
 						Name: "test-step",
@@ -646,7 +646,7 @@ func TestReadCustomPluginSpecs(t *testing.T) {
 		"test": {
 			PluginName: "test",
 			Type:       pkgcustomplugins.SpecTypeComponent,
-			StatePlugin: &pkgcustomplugins.Plugin{
+			HealthStatePlugin: &pkgcustomplugins.Plugin{
 				Steps: []pkgcustomplugins.Step{
 					{
 						Name: "test-step",
@@ -729,7 +729,7 @@ func createValidPluginSpec() pkgcustomplugins.Spec {
 	return pkgcustomplugins.Spec{
 		PluginName: "test-plugin",
 		Type:       pkgcustomplugins.SpecTypeComponent,
-		StatePlugin: &pkgcustomplugins.Plugin{
+		HealthStatePlugin: &pkgcustomplugins.Plugin{
 			Steps: []pkgcustomplugins.Step{
 				{
 					RunBashScript: &pkgcustomplugins.RunBashScript{

e2e/e2e_test.go

@@ -90,7 +90,7 @@ var _ = Describe("[GPUD E2E]", Ordered, func() {
 			{
 				PluginName: "init-plugin",
 				Type:       pkgcustomplugins.SpecTypeInit,
-				StatePlugin: &pkgcustomplugins.Plugin{
+				HealthStatePlugin: &pkgcustomplugins.Plugin{
 					Steps: []pkgcustomplugins.Step{
 						{
 							Name: "first-step",
@@ -435,7 +435,7 @@ var _ = Describe("[GPUD E2E]", Ordered, func() {
 			PluginName: pluginName,
 			Type:       pkgcustomplugins.SpecTypeComponent,
 			DryRun:     true,
-			StatePlugin: &pkgcustomplugins.Plugin{
+			HealthStatePlugin: &pkgcustomplugins.Plugin{
 				Steps: []pkgcustomplugins.Step{
 					{
 						Name: "first-step",
@@ -489,21 +489,21 @@ var _ = Describe("[GPUD E2E]", Ordered, func() {
 
 		testPluginSpec.Interval = metav1.Duration{Duration: time.Minute}
 		testPluginSpec.DryRun = false
-		testPluginSpec.StatePlugin.Steps = append(testPluginSpec.StatePlugin.Steps, pkgcustomplugins.Step{
+		testPluginSpec.HealthStatePlugin.Steps = append(testPluginSpec.HealthStatePlugin.Steps, pkgcustomplugins.Step{
 			Name: "third-step",
 			RunBashScript: &pkgcustomplugins.RunBashScript{
 				Script:      "echo 111 > " + fileToWrite,
 				ContentType: "plaintext",
 			},
 		})
-		testPluginSpec.StatePlugin.Steps = append(testPluginSpec.StatePlugin.Steps, pkgcustomplugins.Step{
+		testPluginSpec.HealthStatePlugin.Steps = append(testPluginSpec.HealthStatePlugin.Steps, pkgcustomplugins.Step{
 			Name: "fourth-step",
 			RunBashScript: &pkgcustomplugins.RunBashScript{
 				Script:      "echo '" + pkgcustomplugins.HealthStateOutputPrefixType + ` Degraded'`,
 				ContentType: "plaintext",
 			},
 		})
-		testPluginSpec.StatePlugin.Steps = append(testPluginSpec.StatePlugin.Steps, pkgcustomplugins.Step{
+		testPluginSpec.HealthStatePlugin.Steps = append(testPluginSpec.HealthStatePlugin.Steps, pkgcustomplugins.Step{
 			Name: "fifth-step",
 			RunBashScript: &pkgcustomplugins.RunBashScript{
 				Script:      "echo '" + pkgcustomplugins.HealthStateOutputPrefixReason + ` test'`,

pkg/custom-plugins/component.go

@@ -102,7 +102,7 @@ func (c *component) Check() components.CheckResult {
 		c.lastMu.Unlock()
 	}()
 
-	if c.spec.StatePlugin == nil {
+	if c.spec.HealthStatePlugin == nil {
 		cr.health = apiv1.HealthStateTypeHealthy
 		cr.reason = "no state plugin defined"
 		return cr
@@ -111,7 +111,7 @@ func (c *component) Check() components.CheckResult {
 	cctx, ccancel := context.WithTimeout(c.ctx, c.spec.Timeout.Duration)
 	defer ccancel()
 
-	cr.out, cr.exitCode, cr.err = c.spec.StatePlugin.executeAllSteps(cctx)
+	cr.out, cr.exitCode, cr.err = c.spec.HealthStatePlugin.executeAllSteps(cctx)
 	cr.output = string(cr.out)
 
 	if cr.err != nil {

pkg/custom-plugins/component_test.go

@@ -280,7 +280,7 @@ func TestComponent_Check_WithStatePlugin(t *testing.T) {
 		Timeout: metav1.Duration{
 			Duration: time.Second * 10,
 		},
-		StatePlugin: statePlugin,
+		HealthStatePlugin: statePlugin,
 	}
 
 	c := &component{
@@ -334,7 +334,7 @@ func TestComponent_Check_WithFailingStatePlugin(t *testing.T) {
 		Timeout: metav1.Duration{
 			Duration: time.Second * 10,
 		},
-		StatePlugin: statePlugin,
+		HealthStatePlugin: statePlugin,
 	}
 
 	c := &component{
@@ -386,7 +386,7 @@ func TestComponent_Check_WithTimeoutContext(t *testing.T) {
 		Timeout: metav1.Duration{
 			Duration: time.Second * 10, // This will be overridden by the context timeout
 		},
-		StatePlugin: statePlugin,
+		HealthStatePlugin: statePlugin,
 	}
 
 	c := &component{
@@ -678,8 +678,8 @@ func TestComponent_CheckWithOutput(t *testing.T) {
 	}
 
 	spec := &Spec{
-		PluginName:  "test-plugin",
-		StatePlugin: statePlugin,
+		PluginName:        "test-plugin",
+		HealthStatePlugin: statePlugin,
 		Timeout: metav1.Duration{
 			Duration: time.Second * 10,
 		},
@@ -775,7 +775,7 @@ func TestComponent_Check_SuccessfulPlugin(t *testing.T) {
 		Timeout: metav1.Duration{
 			Duration: time.Second * 10,
 		},
-		StatePlugin: statePlugin,
+		HealthStatePlugin: statePlugin,
 	}
 
 	c := &component{

pkg/custom-plugins/testdata/plugins.base64.yaml

@@ -1,7 +1,7 @@
 - plugin_name: "nvidia-smi"
   type: component
 
-  state_plugin:
+  health_state_plugin:
     steps:
       - name: "Run nvidia-smi"
         run_bash_script:

pkg/custom-plugins/testdata/plugins.plaintext.0.yaml

@@ -1,7 +1,7 @@
 - plugin_name: test plugin 1
   type: component
 
-  state_plugin:
+  health_state_plugin:
     steps:
       - name: "Install Python"
         run_bash_script:
@@ -23,7 +23,7 @@
 - plugin_name: test plugin 2
   type: component
 
-  state_plugin:
+  health_state_plugin:
     steps:
       - name: "Install Python"
         run_bash_script:

pkg/custom-plugins/testdata/plugins.plaintext.1.yaml

@@ -3,7 +3,7 @@
 - plugin_name: nv-plugin-install-python
   type: init
 
-  state_plugin:
+  health_state_plugin:
     steps:
       - name: Install Python
         run_bash_script:
@@ -42,7 +42,7 @@
 - plugin_name: nv-plugin-fail-me
   type: component
 
-  state_plugin:
+  health_state_plugin:
     steps:
       - name: Exit 1
         run_bash_script:
@@ -66,7 +66,7 @@
 - plugin_name: nv-plugin-simple-script-gpu-throttle
   type: component
 
-  state_plugin:
+  health_state_plugin:
     steps:
       - name: Run health check
         run_bash_script:
@@ -139,7 +139,7 @@
 - plugin_name: nv-plugin-simple-script-gpu-power-state
   type: component
 
-  state_plugin:
+  health_state_plugin:
     steps:
       - name: Run health check
         run_bash_script:

pkg/custom-plugins/type_plugin_test.go

@@ -14,7 +14,7 @@ func TestPluginValidate(t *testing.T) {
 	plugin := Spec{
 		PluginName: "test",
 		Type:       SpecTypeComponent,
-		StatePlugin: &Plugin{
+		HealthStatePlugin: &Plugin{
 			Steps: []Step{
 				{
 					Name: "test",

pkg/custom-plugins/type_run_bash_script_test.go

@@ -76,7 +76,7 @@ func TestDecodeWithInvalidBase64(t *testing.T) {
 	// Create a plugin with invalid base64 encoded scripts
 	plugin := Spec{
 		Type: SpecTypeComponent,
-		StatePlugin: &Plugin{
+		HealthStatePlugin: &Plugin{
 			Steps: []Step{
 				{
 					Name: "test-plugin",
@@ -93,7 +93,7 @@ func TestDecodeWithInvalidBase64(t *testing.T) {
 	err := plugin.Validate()
 	assert.Error(t, err)
 
-	_, err = plugin.StatePlugin.Steps[0].RunBashScript.decode()
+	_, err = plugin.HealthStatePlugin.Steps[0].RunBashScript.decode()
 	assert.Error(t, err)
 }
 
@@ -102,7 +102,7 @@ func TestDecodeWithPlaintext(t *testing.T) {
 	plugin := Spec{
 		PluginName: "test-plaintext",
 		Type:       SpecTypeComponent,
-		StatePlugin: &Plugin{
+		HealthStatePlugin: &Plugin{
 			Steps: []Step{
 				{
 					Name: "test-plaintext",
@@ -121,7 +121,7 @@ func TestDecodeWithPlaintext(t *testing.T) {
 	assert.NoError(t, err)
 
 	// Test decoding the plaintext scripts
-	stateScript, err := plugin.StatePlugin.Steps[0].RunBashScript.decode()
+	stateScript, err := plugin.HealthStatePlugin.Steps[0].RunBashScript.decode()
 	assert.NoError(t, err)
 	assert.Equal(t, "echo 'Hello, World!'", stateScript)
 }

pkg/custom-plugins/type_spec.go

@@ -78,10 +78,10 @@ func (spec *Spec) Validate() error {
 		return ErrComponentNameRequired
 	}
 
-	if spec.StatePlugin == nil {
+	if spec.HealthStatePlugin == nil {
 		return ErrMissingStatePlugin
 	}
-	if err := spec.StatePlugin.Validate(); err != nil {
+	if err := spec.HealthStatePlugin.Validate(); err != nil {
 		return err
 	}
 
@@ -103,10 +103,10 @@ func (spec *Spec) ComponentName() string {
 
 // RunStatePlugin runs the state plugin and returns the output and its exit code.
 func (spec *Spec) RunStatePlugin(ctx context.Context) ([]byte, int32, error) {
-	if spec.StatePlugin == nil {
+	if spec.HealthStatePlugin == nil {
 		return nil, 0, ErrMissingStatePlugin
 	}
-	if err := spec.StatePlugin.Validate(); err != nil {
+	if err := spec.HealthStatePlugin.Validate(); err != nil {
 		return nil, 0, err
 	}
 	if spec.DryRun {
@@ -115,5 +115,5 @@ func (spec *Spec) RunStatePlugin(ctx context.Context) ([]byte, int32, error) {
 
 	cctx, cancel := context.WithTimeout(ctx, spec.Timeout.Duration)
 	defer cancel()
-	return spec.StatePlugin.executeAllSteps(cctx)
+	return spec.HealthStatePlugin.executeAllSteps(cctx)
 }