Document and demonstrate native and layered configuration loading

examples/consumers/layered.go

@@ -0,0 +1,95 @@
+package consumers
+
+import (
+	"embed"
+	"errors"
+	"io/fs"
+	"path"
+
+	configkit "gitea.maximumdirect.net/eric/ConfigKit"
+)
+
+//go:embed testdata/native-source testdata/layered-bundle
+var bundledFiles embed.FS
+
+// BundledConfig is a small configuration loaded directly from an embedded file.
+type BundledConfig struct {
+	Name    string `yaml:"name"`
+	Enabled bool   `yaml:"enabled"`
+}
+
+// LoadBundled demonstrates a native filesystem source without layered options.
+func LoadBundled() (*configkit.Result[BundledConfig], error) {
+	files, err := fs.Sub(bundledFiles, "testdata/native-source")
+	if err != nil {
+		return nil, err
+	}
+	return configkit.Load[BundledConfig](configkit.NewFilesystem("bundled", files).File("config.yml"))
+}
+
+// CatalogConfig keeps resource names and domain rules in the application.
+type CatalogConfig struct {
+	Mode      string            `yaml:"mode"`
+	Enabled   bool              `yaml:"enabled"`
+	Workers   int               `yaml:"workers"`
+	Templates map[string]string `yaml:"templates"`
+	Labels    map[string]string `yaml:"labels"`
+}
+
+// LoadCatalog combines two underlay tiers beneath an independently located
+// host main file. ConfigKit assembles and validates the complete result once.
+func LoadCatalog(mainPath string) (*configkit.Result[CatalogConfig], error) {
+	files, err := fs.Sub(bundledFiles, "testdata/layered-bundle")
+	if err != nil {
+		return nil, err
+	}
+	bundle := configkit.NewFilesystem("catalog bundle", files)
+	return configkit.LoadLayered(configkit.Input{Source: configkit.File(mainPath)},
+		configkit.LayeredOptions[CatalogConfig]{
+			Underlays: []configkit.Underlay{
+				{Inputs: []configkit.Input{{Source: bundle.File("defaults/config.yml"), Imports: true}}},
+				{Inputs: []configkit.Input{{Source: configkit.Mapping("local policy", map[string]any{
+					"workers": 2,
+					"labels":  map[string]any{"tenant": "example"},
+				})}}},
+			},
+			Definition: configkit.Definition[CatalogConfig]{
+				Defaults: func() CatalogConfig { return CatalogConfig{Mode: "demo"} },
+				Validate: validateCatalog,
+			},
+		})
+}
+
+func validateCatalog(configuration *CatalogConfig, validation *configkit.Validation) {
+	if configuration.Mode != "demo" && configuration.Mode != "production" {
+		validation.Error(configkit.Keys("mode"), "must be demo or production")
+	}
+	if configuration.Workers < 0 {
+		validation.Error(configkit.Keys("workers"), "must be nonnegative")
+	}
+	if name := configuration.Templates["welcome"]; name == "." || !fs.ValidPath(name) {
+		validation.Error(configkit.Keys("templates", "welcome"), "must be a relative resource name")
+	}
+}
+
+// ReadWelcome follows the effective template field's one declaring source to
+// its retained resource context. Opening and interpreting the resource remain
+// application work; this does not reopen configuration or change metadata.
+func ReadWelcome(result *configkit.Result[CatalogConfig]) (string, error) {
+	if result == nil {
+		return "", errors.New("catalog result is nil")
+	}
+	info, found := result.Metadata().Lookup(configkit.Keys("templates", "welcome"))
+	if !found || len(info.Origin.Locations) != 1 {
+		return "", errors.New("welcome template has no single declaring source")
+	}
+	context, found := result.SourceContext(info.Origin.Locations[0].SourceID)
+	if !found {
+		return "", errors.New("welcome template has no resource context")
+	}
+	data, err := fs.ReadFile(context.FS, path.Join(context.BaseDir, result.Config.Templates["welcome"]))
+	if err != nil {
+		return "", err
+	}
+	return string(data), nil
+}

examples/consumers/layered_test.go

@@ -0,0 +1,71 @@
+package consumers_test
+
+import (
+	"errors"
+	"fmt"
+	"strings"
+	"testing"
+
+	configkit "gitea.maximumdirect.net/eric/ConfigKit"
+	"gitea.maximumdirect.net/eric/ConfigKit/examples/consumers"
+)
+
+func Example_nativeFilesystem() {
+	result, err := consumers.LoadBundled()
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+	fmt.Println(result.Config.Name, result.Config.Enabled)
+	// Output: embedded false
+}
+
+func Example_layeredCatalog() {
+	result, err := consumers.LoadCatalog(fixture("layered-main", "config.yml"))
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+	welcome, err := consumers.ReadWelcome(result)
+	fmt.Println(result.Config.Mode, result.Config.Enabled, result.Config.Workers,
+		result.Config.Labels["origin"], result.Config.Labels["tenant"], strings.TrimSpace(welcome), err)
+	// Output: production false 0 bundle example Welcome from the bundle. <nil>
+}
+
+func TestCatalogRetainsPresenceAndSourceContext(t *testing.T) {
+	result, err := consumers.LoadCatalog(fixture("layered-main", "config.yml"))
+	if err != nil {
+		t.Fatal(err)
+	}
+	for _, key := range []string{"enabled", "workers"} {
+		info, found := result.Metadata().Lookup(configkit.Keys(key))
+		if !found || !info.Explicit || info.Origin.Layer != configkit.LayerBase {
+			t.Fatalf("%s presence = %#v, %v", key, info, found)
+		}
+	}
+	info, found := result.Metadata().Lookup(configkit.Keys("templates", "welcome"))
+	if !found || info.Origin.Layer != configkit.LayerUnderlay || len(info.Origin.Locations) != 1 {
+		t.Fatalf("welcome origin = %#v, %v", info, found)
+	}
+	context, found := result.SourceContext(info.Origin.Locations[0].SourceID)
+	if !found || context.BaseDir != "defaults" {
+		t.Fatalf("welcome context = %#v, %v", context, found)
+	}
+	welcome, err := consumers.ReadWelcome(result)
+	if err != nil || strings.TrimSpace(welcome) != "Welcome from the bundle." {
+		t.Fatalf("welcome = %q, %v", welcome, err)
+	}
+	if result.Config.Labels["tenant"] != "example" || result.Config.Labels["origin"] != "bundle" {
+		t.Fatalf("recursive underlay labels = %#v", result.Config.Labels)
+	}
+}
+
+func TestCatalogValidationRejectsInvalidMode(t *testing.T) {
+	_, err := consumers.LoadCatalog(fixture("layered-main", "invalid.yml"))
+	var loadError *configkit.LoadError
+	if !errors.As(err, &loadError) || len(loadError.Diagnostics()) == 0 ||
+		loadError.Diagnostics()[0].Code != configkit.CodeValidateError ||
+		loadError.Diagnostics()[0].Path.String() != "/mode" {
+		t.Fatalf("invalid mode error = %v", err)
+	}
+}

examples/consumers/testdata/layered-bundle/defaults/config.yml

@@ -0,0 +1,7 @@
+configkit:
+  imports:
+    - path: ../shared.yml
+enabled: true
+workers: 4
+templates:
+  welcome: messages/welcome.txt

examples/consumers/testdata/layered-bundle/defaults/messages/welcome.txt

@@ -0,0 +1 @@
+Welcome from the bundle.

examples/consumers/testdata/layered-bundle/shared.yml

@@ -0,0 +1,2 @@
+labels:
+  origin: bundle

examples/consumers/testdata/layered-main/config.yml

@@ -0,0 +1,3 @@
+mode: production
+enabled: false
+workers: 0

examples/consumers/testdata/layered-main/invalid.yml

@@ -0,0 +1 @@
+mode: unsupported

examples/consumers/testdata/native-source/config.yml

@@ -0,0 +1,2 @@
+name: embedded
+enabled: false