[module-sdk] expose readonly Settings on ApplicationHookInput

Author: Fkuloff

examples/single-file-app-example/hooks/main.go

@@ -36,6 +36,12 @@ var config = &pkg.ApplicationHookConfig{
 }
 
 func Handle(_ context.Context, input *pkg.ApplicationHookInput) error {
+	enabled, ok := input.Settings.GetOk("apiServersDiscovery.enabled")
+	if !ok || !enabled.Bool() {
+		input.Logger.Info("apiServersDiscovery.enabled is not set — skipping")
+		return nil
+	}
+
 	podNames, err := objectpatch.UnmarshalToStruct[string](input.Snapshots, SnapshotKey)
 	if err != nil {
 		return err

examples/single-file-app-example/hooks/main_test.go

@@ -5,6 +5,7 @@ import (
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+	"github.com/tidwall/gjson"
 
 	"github.com/deckhouse/deckhouse/pkg/log"
 
@@ -20,35 +21,57 @@ const (
 )
 
 var _ = Describe("handle hook single file example", func() {
-	snapshots := mock.NewSnapshotsMock(GinkgoT())
-	snapshots.GetMock.When(singlefileappexample.SnapshotKey).Then(
-		[]pkg.Snapshot{
-			mock.NewSnapshotMock(GinkgoT()).UnmarshalToMock.Set(func(v any) error {
-				str := v.(*string)
-				*str = firstSnapshot
-
-				return nil
-			}),
-			mock.NewSnapshotMock(GinkgoT()).UnmarshalToMock.Set(func(v any) error {
-				str := v.(*string)
-				*str = secondSnapshot
-
-				return nil
-			}),
-		},
-	)
-
-	values := mock.NewOutputPatchableValuesCollectorMock(GinkgoT())
-	values.SetMock.When("test.internal.apiServers", []string{firstSnapshot, secondSnapshot})
-
-	var input = &pkg.ApplicationHookInput{
-		Snapshots: snapshots,
-		Values:    values,
-		Logger:    log.NewNop(),
-	}
-
-	Context("reconcile func", func() {
-		It("reconcile func executed correctly", func() {
+	Context("settings gate closed", func() {
+		settings := mock.NewOutputPatchableValuesCollectorMock(GinkgoT())
+		settings.GetOkMock.When("apiServersDiscovery.enabled").Then(gjson.Result{}, false)
+
+		values := mock.NewOutputPatchableValuesCollectorMock(GinkgoT())
+
+		var input = &pkg.ApplicationHookInput{
+			Values:   values,
+			Settings: settings,
+			Logger:   log.NewNop(),
+		}
+
+		It("does not touch values when the gate is closed", func() {
+			err := singlefileappexample.Handle(context.Background(), input)
+			Expect(err).ShouldNot(HaveOccurred())
+		})
+	})
+
+	Context("settings gate open", func() {
+		snapshots := mock.NewSnapshotsMock(GinkgoT())
+		snapshots.GetMock.When(singlefileappexample.SnapshotKey).Then(
+			[]pkg.Snapshot{
+				mock.NewSnapshotMock(GinkgoT()).UnmarshalToMock.Set(func(v any) error {
+					str := v.(*string)
+					*str = firstSnapshot
+
+					return nil
+				}),
+				mock.NewSnapshotMock(GinkgoT()).UnmarshalToMock.Set(func(v any) error {
+					str := v.(*string)
+					*str = secondSnapshot
+
+					return nil
+				}),
+			},
+		)
+
+		settings := mock.NewOutputPatchableValuesCollectorMock(GinkgoT())
+		settings.GetOkMock.When("apiServersDiscovery.enabled").Then(gjson.Result{Type: gjson.True}, true)
+
+		values := mock.NewOutputPatchableValuesCollectorMock(GinkgoT())
+		values.SetMock.When("test.internal.apiServers", []string{firstSnapshot, secondSnapshot})
+
+		var input = &pkg.ApplicationHookInput{
+			Snapshots: snapshots,
+			Values:    values,
+			Settings:  settings,
+			Logger:    log.NewNop(),
+		}
+
+		It("writes discovered pods into values when the gate is open", func() {
 			err := singlefileappexample.Handle(context.Background(), input)
 			Expect(err).ShouldNot(HaveOccurred())
 		})

internal/controller/config.go

@@ -14,6 +14,7 @@ type HookConfig struct {
 	BindingContextPath string
 	ValuesPath         string
 	ConfigValuesPath   string
+	SettingsPath       string
 
 	// send to addon operator when config requested
 	HookConfigPath string
@@ -47,6 +48,7 @@ func (cfg *Config) GetFileConfig() *file.Config {
 		BindingContextPath: cfg.HookConfig.BindingContextPath,
 		ValuesPath:         cfg.HookConfig.ValuesPath,
 		ConfigValuesPath:   cfg.HookConfig.ConfigValuesPath,
+		SettingsPath:       cfg.HookConfig.SettingsPath,
 
 		HookConfigPath: cfg.HookConfig.HookConfigPath,
 

internal/executor/application.go

@@ -46,6 +46,18 @@ func (e *applicationExecutor) Execute(ctx context.Context, req Request) (Result,
 		return nil, fmt.Errorf("get patchable values: %w", err)
 	}
 
+	rawSettings, err := req.GetSettings()
+	if err != nil {
+		e.logger.Error("get settings", slog.String("error", err.Error()))
+		return nil, fmt.Errorf("get settings: %w", err)
+	}
+
+	patchableSettings, err := patchablevalues.NewPatchableValues(rawSettings)
+	if err != nil {
+		e.logger.Error("new patchable settings", slog.String("error", err.Error()))
+		return nil, fmt.Errorf("get patchable settings: %w", err)
+	}
+
 	bContext, err := req.GetBindingContexts()
 	if err != nil {
 		e.logger.Warn("get binding context", slog.String("error", err.Error()))
@@ -85,6 +97,7 @@ func (e *applicationExecutor) Execute(ctx context.Context, req Request) (Result,
 		Snapshots:        formattedSnapshots,
 		Instance:         inst,
 		Values:           patchableValues,
+		Settings:         patchableSettings,
 		PatchCollector:   namespacedPatchCollector,
 		MetricsCollector: metricsCollector,
 		DC:               dc,

internal/executor/executor.go

@@ -24,6 +24,8 @@ type Request interface {
 	GetValues() (map[string]any, error)
 	// GetConfigValues returns the module's ConfigMap values.
 	GetConfigValues() (map[string]any, error)
+	// GetSettings returns the application's readonly Settings (may be nil).
+	GetSettings() (map[string]any, error)
 	// GetBindingContexts returns Kubernetes binding contexts with snapshots.
 	GetBindingContexts() ([]bctx.BindingContext, error)
 	// GetDependencyContainer returns the container with external dependencies.