fix: cleanup hooks not receiving error signal (#2475)

* fix: cleanup hooks not receiving error signal Closes #1041 Signed-off-by: yxxhero <11087727+yxxhero@users.noreply.github.com> Signed-off-by: yxxhero <aiopsclub@163.com> * Add tests for cleanup hooks error propagation Signed-off-by: yxxhero <aiopsclub@163.com> * fix tests Signed-off-by: yxxhero <aiopsclub@163.com> * fix tests Signed-off-by: yxxhero <aiopsclub@163.com> * fix tests Signed-off-by: yxxhero <aiopsclub@163.com> * fix tests Signed-off-by: yxxhero <aiopsclub@163.com> --------- Signed-off-by: yxxhero <11087727+yxxhero@users.noreply.github.com> Signed-off-by: yxxhero <aiopsclub@163.com>
2026-10-21 10:54:09 +02:00 · 2026-03-21 14:29:32 +08:00
parent 57c2b51eb0
commit 43b426892e
5 changed files with 300 additions and 27 deletions
@@ -1,8 +1,10 @@
 package event

 import (
+	"errors"
 	"fmt"
 	"io"
+	"strings"
 	"testing"

 	"go.uber.org/zap"
@@ -13,6 +15,11 @@ import (
 )

 type runner struct {
+	executeCalls []struct {
+		cmd  string
+		args []string
+		env  map[string]string
+	}
 }

 func (r *runner) ExecuteStdIn(cmd string, args []string, env map[string]string, stdin io.Reader) ([]byte, error) {
@@ -20,6 +27,11 @@ func (r *runner) ExecuteStdIn(cmd string, args []string, env map[string]string,
 }

 func (r *runner) Execute(cmd string, args []string, env map[string]string, enableLiveOutput bool) ([]byte, error) {
+	r.executeCalls = append(r.executeCalls, struct {
+		cmd  string
+		args []string
+		env  map[string]string
+	}{cmd: cmd, args: args, env: env})
 	if cmd == "ng" {
 		return nil, fmt.Errorf("cmd failed due to invalid cmd: %s", cmd)
 	}
@@ -188,3 +200,119 @@ func TestTrigger(t *testing.T) {
 		}
 	}
 }
+
+func TestTriggerCleanupEventWithError(t *testing.T) {
+	runner := &runner{}
+
+	core, _ := observer.New(zap.InfoLevel)
+	logger := zap.New(core).Sugar()
+
+	testError := errors.New("sync failed: release error")
+
+	hooks := []Hook{
+		{
+			Name:     "cleanup-with-error",
+			Events:   []string{"cleanup"},
+			Command:  "echo",
+			Args:     []string{"error is '{{ .Event.Error }}'"},
+			ShowLogs: true,
+		},
+	}
+
+	bus := &Bus{
+		Hooks:         hooks,
+		StateFilePath: "/path/to/helmfile.yaml",
+		BasePath:      ".",
+		Namespace:     "default",
+		Env:           environment.Environment{Name: "default"},
+		Logger:        logger,
+		Fs:            ffs.DefaultFileSystem(),
+		Runner:        runner,
+	}
+
+	data := map[string]any{
+		"HelmfileCommand": "sync",
+	}
+
+	executed, err := bus.Trigger("cleanup", testError, data)
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+
+	if !executed {
+		t.Fatal("expected cleanup hook to be executed")
+	}
+
+	if len(runner.executeCalls) != 1 {
+		t.Fatalf("expected 1 execute call, got %d", len(runner.executeCalls))
+	}
+
+	call := runner.executeCalls[0]
+	if call.cmd != "echo" {
+		t.Errorf("expected command 'echo', got %q", call.cmd)
+	}
+
+	if len(call.args) != 1 {
+		t.Fatalf("expected 1 arg, got %d", len(call.args))
+	}
+
+	expectedArg := "error is 'sync failed: release error'"
+	if !strings.Contains(call.args[0], "error is") {
+		t.Errorf("expected arg to contain 'error is', got %q", call.args[0])
+	}
+
+	if call.args[0] != expectedArg {
+		t.Errorf("expected arg %q, got %q", expectedArg, call.args[0])
+	}
+}
+
+func TestTriggerCleanupEventWithNilError(t *testing.T) {
+	runner := &runner{}
+
+	core, _ := observer.New(zap.InfoLevel)
+	logger := zap.New(core).Sugar()
+
+	hooks := []Hook{
+		{
+			Name:     "cleanup-nil-error",
+			Events:   []string{"cleanup"},
+			Command:  "echo",
+			Args:     []string{"error is '{{ .Event.Error }}'"},
+			ShowLogs: true,
+		},
+	}
+
+	bus := &Bus{
+		Hooks:         hooks,
+		StateFilePath: "/path/to/helmfile.yaml",
+		BasePath:      ".",
+		Namespace:     "default",
+		Env:           environment.Environment{Name: "default"},
+		Logger:        logger,
+		Fs:            ffs.DefaultFileSystem(),
+		Runner:        runner,
+	}
+
+	data := map[string]any{
+		"HelmfileCommand": "sync",
+	}
+
+	executed, err := bus.Trigger("cleanup", nil, data)
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+
+	if !executed {
+		t.Fatal("expected cleanup hook to be executed")
+	}
+
+	if len(runner.executeCalls) != 1 {
+		t.Fatalf("expected 1 execute call, got %d", len(runner.executeCalls))
+	}
+
+	call := runner.executeCalls[0]
+	expectedArg := "error is '<nil>'"
+	if call.args[0] != expectedArg {
+		t.Errorf("expected arg %q, got %q", expectedArg, call.args[0])
+	}
+}