Compare commits
115 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 1a885934c2 | |||
| 5917cebf50 | |||
| 8e91a2b16b | |||
| 08402d098b | |||
| 53b79528d9 | |||
| f849e06b77 | |||
| b37948cfea | |||
| 9323f89ad1 | |||
| 6c62226838 | |||
| 799ebab5a6 | |||
| c8546ae599 | |||
| d32c94eca3 | |||
| 344f4f73d7 | |||
| 5fedc11c8f | |||
| 5b8b7a2415 | |||
| e591e97f22 | |||
| 71e142afb4 | |||
| ca1ba04676 | |||
| 528495c75a | |||
| aa3b4a5881 | |||
| db2d8ed217 | |||
| d34a98d34b | |||
| 9ac65ccc08 | |||
| edc6660654 | |||
| a2084df11a | |||
| b59f002314 | |||
| 52793301ba | |||
| 0c77deed05 | |||
| 48619de024 | |||
| c546124029 | |||
| 673faea097 | |||
| 91ae4fa7ef | |||
| f1722274c0 | |||
| d53021ea2c | |||
| a22aaa5dfa | |||
| b1ecd9a078 | |||
| 84b59c690d | |||
| ac90b9835b | |||
| f887fac809 | |||
| c03457c814 | |||
| e9b6b63e5e | |||
| 1dc50d8cdf | |||
| 0e92085002 | |||
| f96f2b8295 | |||
| 1917dcf921 | |||
| 0ac4731903 | |||
| c42930c6d5 | |||
| 2d3ea588f1 | |||
| 5aafd943b4 | |||
| c0605fab44 | |||
| dc09959cca | |||
| 83c59ea7d3 | |||
| b45f7a0410 | |||
| 2ca1f80094 | |||
| df9a02539c | |||
| 501d59f21b | |||
| f916e7d1f9 | |||
| 462e57df3e | |||
| 4207110e2f | |||
| fdbc306cfb | |||
| 78d4b59bbe | |||
| f564fef84c | |||
| 01e38b5840 | |||
| ac1eec2e30 | |||
| 0a4b774bfe | |||
| b604aa167b | |||
| 15f5083282 | |||
| cbf031aedc | |||
| 34e18c84c1 | |||
| 36362ee6af | |||
| 5a77728a81 | |||
| 1cdf90d831 | |||
| 90c6e8ed7e | |||
| 1ff3c812a7 | |||
| 6111cb23a1 | |||
| de28718941 | |||
| 8d9a3a8dfa | |||
| 27df838513 | |||
| 36172ed20e | |||
| e1ce24aabb | |||
| e4bbedc695 | |||
| 798091b276 | |||
| 5c1aa1814c | |||
| ec26591b27 | |||
| 99338baabb | |||
| 67c0369018 | |||
| a36ed3deba | |||
| d750e7325c | |||
| 3d0093e1fd | |||
| 299ebc21a9 | |||
| ad2f07db5f | |||
| d6fe498652 | |||
| faf5ff8fa1 | |||
| 897203dd8f | |||
| b5a919b8c5 | |||
| 5f4a8f1919 | |||
| 12a03dbb9a | |||
| 6f372e0dfe | |||
| 0adb94f59e | |||
| ee2bcbeed5 | |||
| 3883a5042d | |||
| c034b7e709 | |||
| a803799502 | |||
| 01b437e6ed | |||
| e6ced0d3d1 | |||
| 73ce6e9e31 | |||
| ae91f57bbe | |||
| 66e080ed34 | |||
| d8d9dbfe7f | |||
| aead20fae4 | |||
| c5a2ddee7a | |||
| 418fefdeef | |||
| 21ae2159f7 | |||
| b9425c9ae2 | |||
| fbe7b61c79 |
3
.codebase-memory/.gitattributes
vendored
3
.codebase-memory/.gitattributes
vendored
@@ -1,3 +0,0 @@
|
|||||||
# Auto-generated by codebase-memory-mcp
|
|
||||||
# Prevent merge conflicts on compressed artifact
|
|
||||||
graph.db.zst merge=ours binary
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
{
|
|
||||||
"schema_version": 2,
|
|
||||||
"commit": "88e86de03ebd87038b0c98b164865f2c3b82a94c",
|
|
||||||
"indexed_at": "2026-09-12T18:30:58Z",
|
|
||||||
"project": "home-eric-Workspace-ConfigKit",
|
|
||||||
"nodes": 1641,
|
|
||||||
"edges": 7961,
|
|
||||||
"original_size": 8126464,
|
|
||||||
"compressed_size": 1350795,
|
|
||||||
"compression_level": 3
|
|
||||||
}
|
|
||||||
Binary file not shown.
4
.gitignore
vendored
4
.gitignore
vendored
@@ -25,6 +25,9 @@ go.work.sum
|
|||||||
# env file
|
# env file
|
||||||
.env
|
.env
|
||||||
|
|
||||||
|
# Local codebase-memory tooling artifacts
|
||||||
|
/.codebase-memory/
|
||||||
|
|
||||||
# ---> Linux
|
# ---> Linux
|
||||||
*~
|
*~
|
||||||
|
|
||||||
@@ -81,4 +84,3 @@ Temporary Items
|
|||||||
.history/
|
.history/
|
||||||
|
|
||||||
# Built Visual Studio Code Extensions
|
# Built Visual Studio Code Extensions
|
||||||
*.vsix
|
|
||||||
|
|||||||
50
AGENTS.md
50
AGENTS.md
@@ -1,35 +1,25 @@
|
|||||||
Please review `docs/development.md` for initial orientation in this repository
|
<!-- codebase-memory-mcp:start -->
|
||||||
and follow its task-specific reading guide.
|
# Codebase Knowledge Graph (codebase-memory-mcp)
|
||||||
|
|
||||||
## Implementation Discipline
|
This project uses codebase-memory-mcp to maintain a knowledge graph of the codebase.
|
||||||
|
ALWAYS prefer MCP graph tools over grep/glob/file-search for code discovery.
|
||||||
|
|
||||||
Simplify the mechanism, not the user's choices.
|
## Priority Order
|
||||||
|
1. `search_graph` — find functions, classes, routes, variables by pattern
|
||||||
|
2. `trace_path` — trace who calls a function or what it calls
|
||||||
|
3. `get_code_snippet` — read specific function/class source code
|
||||||
|
4. `query_graph` — run Cypher queries for complex patterns
|
||||||
|
5. `get_architecture` — high-level project summary
|
||||||
|
|
||||||
**Keep implementation machinery proportionate.** Use straightforward,
|
## When to fall back to grep/glob
|
||||||
idiomatic code and introduce only the machinery needed to support the requested
|
- Searching for string literals, error messages, config values
|
||||||
behavior and flexibility. Optimize for conceptual simplicity and
|
- Searching non-code files (Dockerfiles, shell scripts, configs)
|
||||||
maintainability, not for the fewest lines, fewest options, or narrowest product
|
- When MCP tools return insufficient results
|
||||||
surface.
|
<!-- codebase-memory-mcp:end -->
|
||||||
|
|
||||||
**Do not invent restrictions.** Do not reject, prohibit, constrain, cap,
|
Start with `docs/development.md` for orientation and use its policy reading guide
|
||||||
harden, or otherwise narrow behavior unless required by the user, an explicit
|
to select the policies applicable to the task. Do not read the entire suite by
|
||||||
repository contract, or an unavoidable correctness constraint. Preserve
|
default.
|
||||||
operator and caller choice where policy has not been established. If an
|
|
||||||
additional restriction appears advisable, present it as a decision rather than
|
|
||||||
silently implementing it.
|
|
||||||
|
|
||||||
A correctness constraint must follow from the requested behavior or an
|
Read and follow `docs/policy/agents.md` before recommending, planning, or
|
||||||
established invariant, not from the convenience of the chosen implementation.
|
implementing repository changes.
|
||||||
Explain the specific failure it prevents and why a less restrictive
|
|
||||||
implementation cannot satisfy the contract.
|
|
||||||
|
|
||||||
**An implementation detail is not repository policy.** Tests and documentation
|
|
||||||
must not elevate incidental behavior into a durable guarantee or restriction
|
|
||||||
unless that behavior was expressly selected as part of the contract. Existing
|
|
||||||
explicit contracts remain authoritative; changing or weakening one requires a
|
|
||||||
deliberate decision rather than being inferred from this principle.
|
|
||||||
|
|
||||||
Agent-authored plans, tests, documentation, and prior implementations are not
|
|
||||||
evidence that an additional restriction was deliberately approved. Identify the
|
|
||||||
authorizing requirement or decision; when that authority is unclear, surface
|
|
||||||
the ambiguity rather than treating repetition as approval.
|
|
||||||
|
|||||||
25
COPYRIGHT
Normal file
25
COPYRIGHT
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
ConfigKit
|
||||||
|
|
||||||
|
Copyright (C) 2026 Eric Rakestraw
|
||||||
|
|
||||||
|
SPDX-License-Identifier: LGPL-3.0-or-later
|
||||||
|
|
||||||
|
This library is free software: you can redistribute it and/or modify it
|
||||||
|
under the terms of the GNU Lesser General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
The GNU Lesser General Public License version 3 and its incorporated
|
||||||
|
GNU General Public License version 3 text are provided in LICENSE.
|
||||||
|
|
||||||
|
This library is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Lesser General Public License for more details.
|
||||||
|
|
||||||
|
Third-party code and assets are subject to their respective license terms.
|
||||||
|
|
||||||
|
Policy documents adapted from Standard Repository Policies, the root AGENTS.md
|
||||||
|
orientation, and the Policy Reading Guide in docs/development.md remain licensed
|
||||||
|
under CC-BY-SA-4.0. See docs/oss/attribution.md for the affected material,
|
||||||
|
upstream credit, and license links.
|
||||||
56
README.md
56
README.md
@@ -5,18 +5,22 @@ An opinionated Go library for applications that use YAML configuration files.
|
|||||||
Linux is release-validated; macOS support is best-effort. See the
|
Linux is release-validated; macOS support is best-effort. See the
|
||||||
[platform support policy](docs/policy/release.md#platform-support) for details.
|
[platform support policy](docs/policy/release.md#platform-support) for details.
|
||||||
|
|
||||||
ConfigKit's initial loader accepts one strict YAML
|
ConfigKit's simple `Load` accepts one strict YAML source (or explicit
|
||||||
source (or explicit defaults-only input), optionally traverses explicit path and glob
|
defaults-only input). `LoadLayered` additionally combines explicit lower-priority
|
||||||
imports, strictly composes their disjoint definitions, applies typed defaults, and
|
source groups with an independently selected main input. Sources can be host
|
||||||
can overlay one selected fixed profile and check an application schema version. It
|
files, native `fs.FS` files, labeled bytes or readers, or snapshotted mappings.
|
||||||
returns detached metadata and safe diagnostics.
|
Enabled path and glob imports compose strictly within their group; precedence
|
||||||
|
between groups combines mappings recursively. Both entry points return a complete,
|
||||||
|
validated configuration with detached metadata and safe diagnostics.
|
||||||
Applications may perform audited defaulting and normalization through a resolver,
|
Applications may perform audited defaulting and normalization through a resolver,
|
||||||
then report domain errors and warnings through read-only semantic validation. Secret
|
then report domain errors and warnings through read-only semantic validation. Secret
|
||||||
tags and a path predicate drive deterministic redacted effective YAML. Typed secret
|
tags and a path predicate drive deterministic redacted effective YAML. Typed secret
|
||||||
references resolve environment names before validation, and explicit
|
references resolve environment names before validation, and explicit
|
||||||
secrets-directory bootstrap is available as a separate startup operation. Explicit
|
secrets-directory bootstrap is available as a separate startup operation. Explicit
|
||||||
CLI override records apply above profiles. Value explanation is available through
|
CLI override records apply above overlays. Value explanation is available through
|
||||||
detached structured records and deterministic redacted output.
|
detached structured records and deterministic redacted output. Built-in
|
||||||
|
`extends` relationships let a mapping inherit from a named sibling during the
|
||||||
|
same load, retaining explicit presence and source/derivation history.
|
||||||
|
|
||||||
```go
|
```go
|
||||||
type Config struct {
|
type Config struct {
|
||||||
@@ -33,10 +37,40 @@ func ReadConfig(path string) (Config, error) {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Design philosophy
|
||||||
|
|
||||||
|
ConfigKit favors one coherent, predictable configuration model over flexibility
|
||||||
|
for reproducing each consumer's conventions. Its goal is to let applications
|
||||||
|
load once, inspect where final values came from, and distinguish explicit values
|
||||||
|
from omissions with minimal configuration bookkeeping. Applications retain their
|
||||||
|
domain rules and execution responsibilities.
|
||||||
|
|
||||||
|
Loading is synchronous and complete on return. Applications normally load once
|
||||||
|
near startup and then use the final configuration and metadata; ConfigKit stays
|
||||||
|
inactive until explicitly called again. Applications may initiate additional
|
||||||
|
loads as needed. See the [loading lifecycle](docs/config.md#completion-and-resource-lifetime)
|
||||||
|
for completion and ownership details.
|
||||||
|
|
||||||
|
Within a configuration tier, independent contributions compose strictly: shared
|
||||||
|
mappings combine, while overlapping non-mapping definitions are errors. Between
|
||||||
|
precedence tiers, mappings combine recursively, retaining omitted lower-priority
|
||||||
|
children; other values replace lower-priority values. The main document and its
|
||||||
|
imports form one strictly composed tier. Explicit underlay groups sit below it
|
||||||
|
and above typed defaults; a selected overlay and explicit CLI overrides sit
|
||||||
|
above it. The [configuration contract](docs/config.md#strict-document-composition)
|
||||||
|
owns the detailed combination rules and input-specific constraints.
|
||||||
|
|
||||||
|
The [architecture goals](docs/policy/architecture.md#success-criteria) explain
|
||||||
|
these priorities and how genuine new needs can justify extending the shared
|
||||||
|
model. The [deferred scope](docs/roadmap/deferred.md) records deliberate exclusions.
|
||||||
|
|
||||||
The [configuration contract](docs/config.md) describes implemented behavior. The
|
The [configuration contract](docs/config.md) describes implemented behavior. The
|
||||||
[consumer adoption guide](docs/consumers/README.md) provides maintained Narratio-,
|
[consumer adoption guide](docs/consumers/README.md) provides maintained simple
|
||||||
Notarius-, WeatherReporter-, and Seriatim-shaped examples and migration guidance.
|
native-filesystem, layered, and sibling-inheritance examples alongside the migration shapes.
|
||||||
The [deferred scope](docs/roadmap/deferred.md) records deliberate exclusions. See the
|
See the [development guide](docs/development.md) for repository orientation and the
|
||||||
[development guide](docs/development.md) for repository orientation and the
|
|
||||||
[release procedure](docs/release.md) for maintainer-only candidate and publication
|
[release procedure](docs/release.md) for maintainer-only candidate and publication
|
||||||
steps.
|
steps.
|
||||||
|
|
||||||
|
ConfigKit code is licensed under the [LGPL v3.0 or later](COPYRIGHT).
|
||||||
|
|
||||||
|
[Open Source attribution notices](docs/oss/attribution.md) are available.
|
||||||
|
|||||||
@@ -43,16 +43,36 @@ func toEngineLocations(values []Location) []engine.Location {
|
|||||||
return result
|
return result
|
||||||
}
|
}
|
||||||
func fromEngineSourceInfo(value engine.SourceInfo) SourceInfo {
|
func fromEngineSourceInfo(value engine.SourceInfo) SourceInfo {
|
||||||
return SourceInfo{ID: value.ID, Label: value.Label, Path: value.Path, Layer: Layer(value.Layer), ImportedFrom: fromEngineLocationPointer(value.ImportedFrom)}
|
return SourceInfo{ID: value.ID, Label: value.Label, Path: value.Path, Layer: Layer(value.Layer), Kind: SourceKind(value.Kind), UnderlayIndex: value.UnderlayIndex, ImportedFrom: fromEngineLocationPointer(value.ImportedFrom)}
|
||||||
}
|
}
|
||||||
func toEngineSourceInfo(value SourceInfo) engine.SourceInfo {
|
func toEngineSourceInfo(value SourceInfo) engine.SourceInfo {
|
||||||
return engine.SourceInfo{ID: value.ID, Label: value.Label, Path: value.Path, Layer: engine.Layer(value.Layer), ImportedFrom: toEngineLocationPointer(value.ImportedFrom)}
|
return engine.SourceInfo{ID: value.ID, Label: value.Label, Path: value.Path, Layer: engine.Layer(value.Layer), Kind: engine.SourceKind(value.Kind), UnderlayIndex: value.UnderlayIndex, ImportedFrom: toEngineLocationPointer(value.ImportedFrom)}
|
||||||
}
|
}
|
||||||
func fromEngineOrigin(value engine.Origin) Origin {
|
func fromEngineOrigin(value engine.Origin) Origin {
|
||||||
return Origin{Layer: Layer(value.Layer), Locations: fromEngineLocations(value.Locations), Operation: ChangeKind(value.Operation)}
|
result := Origin{Layer: Layer(value.Layer), Locations: fromEngineLocations(value.Locations), Operation: ChangeKind(value.Operation)}
|
||||||
|
if value.Inheritance != nil {
|
||||||
|
result.Inheritance = make([]InheritanceStep, len(value.Inheritance))
|
||||||
|
for index, step := range value.Inheritance {
|
||||||
|
result.Inheritance[index] = InheritanceStep{
|
||||||
|
From: fromEnginePath(step.From), To: fromEnginePath(step.To), Reference: fromEnginePath(step.Reference),
|
||||||
|
Locations: fromEngineLocations(step.Locations),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result
|
||||||
}
|
}
|
||||||
func toEngineOrigin(value Origin) engine.Origin {
|
func toEngineOrigin(value Origin) engine.Origin {
|
||||||
return engine.Origin{Layer: engine.Layer(value.Layer), Locations: toEngineLocations(value.Locations), Operation: engine.ChangeKind(value.Operation)}
|
result := engine.Origin{Layer: engine.Layer(value.Layer), Locations: toEngineLocations(value.Locations), Operation: engine.ChangeKind(value.Operation)}
|
||||||
|
if value.Inheritance != nil {
|
||||||
|
result.Inheritance = make([]engine.InheritanceStep, len(value.Inheritance))
|
||||||
|
for index, step := range value.Inheritance {
|
||||||
|
result.Inheritance[index] = engine.InheritanceStep{
|
||||||
|
From: toEnginePath(step.From), To: toEnginePath(step.To), Reference: toEnginePath(step.Reference),
|
||||||
|
Locations: toEngineLocations(step.Locations),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result
|
||||||
}
|
}
|
||||||
func fromEngineDiagnostic(value engine.Diagnostic) Diagnostic {
|
func fromEngineDiagnostic(value engine.Diagnostic) Diagnostic {
|
||||||
return Diagnostic{Code: Code(value.Code), Severity: Severity(value.Severity), Path: fromEnginePath(value.Path), Message: value.Message, Primary: fromEngineLocationPointer(value.Primary), Related: fromEngineLocations(value.Related)}
|
return Diagnostic{Code: Code(value.Code), Severity: Severity(value.Severity), Path: fromEnginePath(value.Path), Message: value.Message, Primary: fromEngineLocationPointer(value.Primary), Related: fromEngineLocations(value.Related)}
|
||||||
|
|||||||
@@ -9,8 +9,8 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestCheckScriptsHandleFilenamesAndStopOnFailure(t *testing.T) {
|
func TestDevelopmentCheckHandlesFilenamesAndStopsOnFailure(t *testing.T) {
|
||||||
for _, scriptName := range []string{"release-check.sh", "check.sh"} {
|
for _, scriptName := range []string{"check.sh"} {
|
||||||
t.Run(scriptName, func(t *testing.T) {
|
t.Run(scriptName, func(t *testing.T) {
|
||||||
script, err := os.ReadFile("scripts/" + scriptName)
|
script, err := os.ReadFile("scripts/" + scriptName)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -66,7 +66,7 @@ func TestCheckScriptsHandleFilenamesAndStopOnFailure(t *testing.T) {
|
|||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
cmd := exec.Command("/bin/bash", filepath.Join(root, "scripts", scriptName))
|
cmd := exec.Command("/bin/bash", filepath.Join(root, "scripts", scriptName))
|
||||||
cmd.Env = append(os.Environ(), "PATH="+bin+string(os.PathListSeparator)+os.Getenv("PATH"), "CONFIGKIT_BASELINE_TOOLCHAIN=test-baseline", "CONFIGKIT_NEWER_TOOLCHAIN=test-newer", "CONFIGKIT_TEST_FMT_LOG="+log, "CONFIGKIT_TEST_GO_LOG="+calls)
|
cmd.Env = append(os.Environ(), "PATH="+bin+string(os.PathListSeparator)+os.Getenv("PATH"), "CONFIGKIT_TEST_FMT_LOG="+log, "CONFIGKIT_TEST_GO_LOG="+calls)
|
||||||
// Log only targets selected by the script, not inherited host settings.
|
// Log only targets selected by the script, not inherited host settings.
|
||||||
cmd.Env = append(cmd.Env, "GOOS=", "GOARCH=")
|
cmd.Env = append(cmd.Env, "GOOS=", "GOARCH=")
|
||||||
if name == "failed-go-check" {
|
if name == "failed-go-check" {
|
||||||
@@ -103,17 +103,6 @@ func TestCheckScriptsHandleFilenamesAndStopOnFailure(t *testing.T) {
|
|||||||
if fail && strings.Contains(string(invoked), "vet ./...") {
|
if fail && strings.Contains(string(invoked), "vet ./...") {
|
||||||
t.Fatal("checker continued after failed test")
|
t.Fatal("checker continued after failed test")
|
||||||
}
|
}
|
||||||
if scriptName == "release-check.sh" && !fail {
|
|
||||||
// These are selected release gates, not incidental loop details.
|
|
||||||
for _, target := range []string{"linux/amd64", "linux/arm64"} {
|
|
||||||
if !strings.Contains(string(invoked), target+" build ./...") {
|
|
||||||
t.Errorf("checker omitted required target %s", target)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if strings.Contains(string(invoked), "darwin/") {
|
|
||||||
t.Fatal("checker requires best-effort macOS validation")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
2
doc.go
2
doc.go
@@ -2,7 +2,7 @@
|
|||||||
// loading for Go programs.
|
// loading for Go programs.
|
||||||
//
|
//
|
||||||
// Load supports file, byte, reader, and explicit no-input sources with strict YAML,
|
// Load supports file, byte, reader, and explicit no-input sources with strict YAML,
|
||||||
// typed defaults, imports, profiles, CLI overrides, schema-version checks, detached
|
// typed defaults, imports, overlays, CLI overrides, schema-version checks, detached
|
||||||
// metadata, recorded application resolution, typed secret references, safe effective
|
// metadata, recorded application resolution, typed secret references, safe effective
|
||||||
// rendering, read-only semantic validation, and structured load errors. The
|
// rendering, read-only semantic validation, and structured load errors. The
|
||||||
// configuration contract is documented in docs/config.md.
|
// configuration contract is documented in docs/config.md.
|
||||||
|
|||||||
118
docs/adr/0007-source-backed-underlays.md
Normal file
118
docs/adr/0007-source-backed-underlays.md
Normal file
@@ -0,0 +1,118 @@
|
|||||||
|
# ADR 0007: Add Source-Backed Underlays with Consistent Recursive Precedence
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Proposed draft for review. Completed planning and remediation records are
|
||||||
|
preserved in Git history at `b604aa1` under `docs/roadmap/`; the
|
||||||
|
[configuration contract](../config.md#layered-loading) owns current behavior.
|
||||||
|
|
||||||
|
This extends [ADR 0001](0001-separate-composition-and-overlay.md) and preserves
|
||||||
|
its distinction between strict composition and intentional overlay.
|
||||||
|
|
||||||
|
## Date
|
||||||
|
|
||||||
|
2026-09-29
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Configuration-backed defaults provide lower-priority settings that applications
|
||||||
|
can override. These sources carry imports, locations, and relative-resource
|
||||||
|
contexts. Integrating them into ConfigKit's loading lifecycle gives their values
|
||||||
|
the same presence tracking and inspectable provenance as other configuration
|
||||||
|
inputs.
|
||||||
|
|
||||||
|
The [architecture goals](../policy/architecture.md#success-criteria) prioritize
|
||||||
|
one coherent, predictable configuration model with consistent rules across
|
||||||
|
source representations and loading interfaces. Consumers should load once,
|
||||||
|
receive a complete validated configuration, and inspect its final values' origins.
|
||||||
|
Reducing integration code is important subject to those principles.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
### Add underlays to the existing precedence model
|
||||||
|
|
||||||
|
Introduce explicitly supplied source-backed underlays between typed defaults
|
||||||
|
and main configuration. The proposed precedence, from lowest to highest, is:
|
||||||
|
|
||||||
|
**Typed application defaults < source underlays < strictly composed main
|
||||||
|
configuration < selected overlay < explicit CLI overrides.**
|
||||||
|
|
||||||
|
Typed defaults remain the Go-value baseline. Underlays supply lower-priority
|
||||||
|
configuration with source provenance and, where applicable, imports and resource
|
||||||
|
context. This ordering describes value precedence; typed defaults fill fields
|
||||||
|
absent from the assembled input under the existing defaulting rules.
|
||||||
|
|
||||||
|
Preserve strict composition of the main document and its imports before applying
|
||||||
|
the resulting configuration over underlays. Independent contributions within an
|
||||||
|
underlay tier also compose strictly. Explicitly ordered tiers express intentional
|
||||||
|
precedence. Strict composition reports conflicting contributions within each tier.
|
||||||
|
|
||||||
|
Across precedence tiers, reuse the existing recursive mapping-overlay semantics.
|
||||||
|
Omitted children retain lower-priority input; existing scalar, sequence, null,
|
||||||
|
and cross-kind replacement semantics remain unchanged. Reusing these operations
|
||||||
|
keeps the combination rules consistent across the loading model.
|
||||||
|
|
||||||
|
### Keep source representation separate from composition semantics
|
||||||
|
|
||||||
|
Native `fs.FS` and programmatic inputs join the shared loading model.
|
||||||
|
Equivalent inputs using the same
|
||||||
|
operation have the same presence and precedence semantics regardless of medium.
|
||||||
|
Programmatic values enter directly as labeled configuration sources.
|
||||||
|
|
||||||
|
Retain the contributing source's identity and resource context through layering.
|
||||||
|
A retained underlay value keeps its originating source's resource context.
|
||||||
|
Consumers remain responsible for opening and interpreting their domain resources
|
||||||
|
under the supplied filesystem's lifetime and access semantics. Exact
|
||||||
|
context-access and input APIs remain roadmap decisions.
|
||||||
|
|
||||||
|
### Deliver one final configuration and its inspection metadata
|
||||||
|
|
||||||
|
Assemble effective input, then run the typed loading lifecycle once for the load.
|
||||||
|
Preserve explicit zero,
|
||||||
|
false, empty, and null input versus omission through configuration and metadata
|
||||||
|
together.
|
||||||
|
|
||||||
|
Extend existing provenance and history through underlays, defaults, and recorded
|
||||||
|
application resolution. The returned result includes the completed combination,
|
||||||
|
defaulting, and provenance work. Domain resolution and validation
|
||||||
|
remain application-owned within the recorded lifecycle, consistent with
|
||||||
|
[ADR 0003](0003-preserve-presence-and-resolution-history.md).
|
||||||
|
|
||||||
|
Preserve the existing opt-in schema-version ownership, path protections, and
|
||||||
|
check timing before precedence
|
||||||
|
assembly and typed decoding. The roadmap owns how layered input identifies that
|
||||||
|
owner when version checking is configured.
|
||||||
|
|
||||||
|
Favor near-linear processing in input, retained history, and output size through
|
||||||
|
incremental assembly of load-owned state. This is an engineering objective
|
||||||
|
subordinate to clarity and semantic consistency. Preserve the root-owned facade and
|
||||||
|
private implementation boundary established by [ADR 0006](0006-public-facade.md).
|
||||||
|
|
||||||
|
## Alternatives considered
|
||||||
|
|
||||||
|
- **Leave bundled defaults to consumers.** Avoids extending loading, but makes
|
||||||
|
consumers reproduce merging, presence tracking, and provenance reconciliation.
|
||||||
|
It does not meet the goal of obtaining a complete configuration in one load.
|
||||||
|
- **Offer recursive or atomic combination per layer.** Makes both behaviors
|
||||||
|
explicit and could serve more consumers, but expands the semantic surface and
|
||||||
|
its interactions with presence and provenance without a demonstrated need that
|
||||||
|
outweighs a single consistent rule. A future concrete requirement may justify
|
||||||
|
reconsideration; this feature does not add the option.
|
||||||
|
- **Flatten all documents into last-wins layers.** Simplifies ordering but turns
|
||||||
|
accidental main/import conflicts into overrides, weakening the intentional
|
||||||
|
distinction established by ADR 0001.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
Consumers gain source-backed defaults within the shared loading lifecycle.
|
||||||
|
Strict contributions and intentional precedence remain distinct, with consistent
|
||||||
|
combination rules across source media. Presence and provenance remain
|
||||||
|
part of the same loading lifecycle as the final values.
|
||||||
|
|
||||||
|
Higher-priority mappings retain omitted lower-priority children, so application
|
||||||
|
validation assesses the final combined configuration.
|
||||||
|
|
||||||
|
Implementation must integrate source context and underlay history into the shared
|
||||||
|
engine with attention to assembly and history-retention costs. Current behavior
|
||||||
|
documentation will change when the feature lands. The roadmap retains ownership
|
||||||
|
of the remaining API decisions.
|
||||||
82
docs/adr/0008-complete-on-return-loading.md
Normal file
82
docs/adr/0008-complete-on-return-loading.md
Normal file
@@ -0,0 +1,82 @@
|
|||||||
|
# ADR 0008: Synchronous, Complete-on-Return Configuration Loading
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Proposed draft for review. The
|
||||||
|
[configuration contract](../config.md#completion-and-resource-lifetime) describes
|
||||||
|
the implemented loading lifecycle and
|
||||||
|
[source resource contexts](../config.md#source-resource-contexts).
|
||||||
|
|
||||||
|
## Date
|
||||||
|
|
||||||
|
2026-09-29
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Applications need a clear point at which configuration is ready for use.
|
||||||
|
Completing configuration processing and inspection metadata together gives
|
||||||
|
applications a coherent result whose values and origins agree. A bounded loading
|
||||||
|
lifecycle also makes resource ownership and startup failures straightforward to
|
||||||
|
reason about.
|
||||||
|
|
||||||
|
ConfigKit's [architecture goals](../policy/architecture.md#success-criteria)
|
||||||
|
emphasize complete configuration, inspectable provenance, predictable behavior,
|
||||||
|
and minimal consumer bookkeeping. Applications own their execution lifecycle and
|
||||||
|
the timing of configuration acquisition.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Make loading a synchronous, complete-on-return operation. Within each load,
|
||||||
|
ConfigKit completes input assembly, defaulting, typed decoding, configured
|
||||||
|
application resolution, secret lookup, validation, and snapshotting before
|
||||||
|
returning the final configuration and metadata. Reported failures return
|
||||||
|
diagnostics and a nil result.
|
||||||
|
|
||||||
|
Release all library-owned loading handles before returning on success or failure.
|
||||||
|
The resulting configuration and metadata are independently usable, caller-owned
|
||||||
|
data with a retained inspection snapshot. Caller-supplied readers and filesystems
|
||||||
|
remain under caller ownership and lifetime control.
|
||||||
|
|
||||||
|
After the call completes, ConfigKit remains inactive until explicitly invoked
|
||||||
|
again. Applications normally load once at or near startup and may initiate
|
||||||
|
additional loads when needed. Each load follows the same lifecycle and source
|
||||||
|
reuse contracts. Inspection, rendering, and separately requested operations run
|
||||||
|
in response to explicit application calls.
|
||||||
|
|
||||||
|
For the planned resource-context capability, retain source context as passive
|
||||||
|
information or a borrowed caller-supplied filesystem. Subsequent resource access
|
||||||
|
acquires its own handles with explicit ownership. This preserves a clear boundary
|
||||||
|
between configuration completion and application resource use.
|
||||||
|
|
||||||
|
These choices give consumers one completion boundary for configuration and
|
||||||
|
provenance, predictable resource lifetimes, and control over when ConfigKit runs.
|
||||||
|
Application callbacks remain responsible for their own effects and resources.
|
||||||
|
|
||||||
|
## Alternatives considered
|
||||||
|
|
||||||
|
- **Background watching or refresh.** Can automate responses to source changes,
|
||||||
|
but adds scheduling, shutdown, publication, and resource-lifetime concerns to
|
||||||
|
the library. Explicit calls keep those responsibilities with the application.
|
||||||
|
- **Lazy completion after return.** Can defer work until particular values are
|
||||||
|
used, but moves configuration failures into application execution and makes
|
||||||
|
the readiness of values and metadata harder to establish.
|
||||||
|
- **Transactional atomic loading.** Could imply simultaneous observation of all
|
||||||
|
external inputs and rollback of callback effects. Filesystems, environment
|
||||||
|
variables, and application callbacks do not share a transaction mechanism.
|
||||||
|
Synchronous completion provides the required usable-result boundary without
|
||||||
|
promising those external guarantees.
|
||||||
|
- **Retain loading handles in results.** Can preserve open filesystem access,
|
||||||
|
but gives configuration results an ongoing resource lifecycle and cleanup
|
||||||
|
obligation. Passive source context supports later explicit resource access
|
||||||
|
while keeping loading resources scoped to the load call.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
Applications can treat successful return as the point at which the final
|
||||||
|
configuration and its metadata are ready for use. Startup loading remains simple,
|
||||||
|
and additional loads have an explicit application-owned trigger.
|
||||||
|
|
||||||
|
Configuration inspection operates on retained data. Resource access observes the
|
||||||
|
backing resource when explicitly requested and has its own failure and ownership
|
||||||
|
boundary. Implementations of new source kinds and layering features preserve the
|
||||||
|
same completion boundary, including cleanup on reported load failures.
|
||||||
76
docs/adr/0009-sibling-inheritance.md
Normal file
76
docs/adr/0009-sibling-inheritance.md
Normal file
@@ -0,0 +1,76 @@
|
|||||||
|
# ADR 0009: Resolve Sibling Inheritance After Source Assembly
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Accepted and implemented. The [configuration contract](../config.md#sibling-inheritance)
|
||||||
|
owns current behavior. The completed implementation plan is preserved in Git
|
||||||
|
history at `83c59ea`.
|
||||||
|
|
||||||
|
## Date
|
||||||
|
|
||||||
|
2026-09-29
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Named configuration mappings often share settings while retaining individual
|
||||||
|
overrides. ConfigKit already distinguishes strict composition of independent
|
||||||
|
source contributions from recursive overlay between explicit precedence tiers.
|
||||||
|
Doing another untracked merge in applications would lose omission, source
|
||||||
|
context, and historical explanation information. A shared structural operation
|
||||||
|
must preserve the same presence and provenance model as the rest of loading.
|
||||||
|
|
||||||
|
Inheritance also interacts with source precedence, nested namespaces, version
|
||||||
|
ownership, and secrets. Resolving it before source assembly would validate
|
||||||
|
superseded references and copy values that a later tier should replace. Fully
|
||||||
|
resolving nested relationships inside a reusable parent would bind them to the
|
||||||
|
wrong sibling scope when copied into a child.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Reserve `extends` as a built-in input key on mappings. A string names one exact
|
||||||
|
sibling mapping; null cancels the relationship. Complete source acquisition,
|
||||||
|
strict composition, selected overlay, and CLI precedence first. Then resolve
|
||||||
|
each effective relationship in the parser-independent document tree, before
|
||||||
|
typed defaults and decoding. A child recursively overlays its own payload on
|
||||||
|
its resolved parent using the existing mapping-combination rules. This creates
|
||||||
|
neither a source tier nor a configurable merge strategy.
|
||||||
|
|
||||||
|
Resolve enclosing sibling chains before nested relationships. Reuse memoized
|
||||||
|
parent templates with unresolved nested instructions; evaluate those instructions
|
||||||
|
at each destination. Preserve original source applications separately from
|
||||||
|
structural transfer/control evidence. Effective origins carry concrete
|
||||||
|
source-to-destination derivation, and inspection projects relevant inheritance
|
||||||
|
events between source replay and typed reconciliation. Inherited input counts as
|
||||||
|
explicit presence, while direct replacement retains its own effective origin.
|
||||||
|
|
||||||
|
The existing main-input version check remains at its original point. Reject
|
||||||
|
structural contributions or directive consumption affecting its protected path.
|
||||||
|
Classify sensitivity at corresponding source and destination paths and retain
|
||||||
|
historical redaction. Secret references remain unresolved input until the
|
||||||
|
existing lookup point. Keep all machinery behind the root-owned public facade.
|
||||||
|
|
||||||
|
## Alternatives considered
|
||||||
|
|
||||||
|
- **Application-owned inheritance after `Load`.** Leaves every consumer to
|
||||||
|
recreate ordering, presence, provenance, error reporting, and redaction after
|
||||||
|
ConfigKit has already declared a result complete.
|
||||||
|
- **Resolve each source before precedence assembly.** Makes superseded
|
||||||
|
references active and can copy a parent definition before higher-priority
|
||||||
|
input finishes changing it.
|
||||||
|
- **Resolve nested relationships in a cached parent subtree.** Shares more
|
||||||
|
ready-made output but binds nested sibling lookups to the parent's scope,
|
||||||
|
giving incorrect values at a child destination.
|
||||||
|
- **Registered collections, configurable keywords, or multiple-parent merge
|
||||||
|
modes.** Increase public setup and semantic branches without a requirement
|
||||||
|
that warrants diverging from one structural rule.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
Consumers can load a configuration once and inspect direct, inherited,
|
||||||
|
defaulted, and application-derived values through the existing result surfaces.
|
||||||
|
`extends` is no longer an ordinary application field, so existing configurations
|
||||||
|
using that key as data must migrate. Expanding many children can materialize
|
||||||
|
substantially more output than the input contains; projection and retained-history
|
||||||
|
budgets bound that work without charging copies as newly acquired sources.
|
||||||
|
Applications still own domain validation, entry selection, and runtime resource
|
||||||
|
use.
|
||||||
301
docs/config.md
301
docs/config.md
@@ -12,20 +12,30 @@ ConfigKit exposes opaque sources through these constructors:
|
|||||||
| Constructor | Current contract |
|
| Constructor | Current contract |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `File(path)` | Requires a nonempty path, opens a regular file for each consumption, and closes only the library-owned file handle. Missing, inaccessible, unreadable, directory, and other nonregular inputs fail. |
|
| `File(path)` | Requires a nonempty path, opens a regular file for each consumption, and closes only the library-owned file handle. Missing, inaccessible, unreadable, directory, and other nonregular inputs fail. |
|
||||||
|
| `NewFilesystem(label, filesystem).File(name)` | Borrows a caller-owned `fs.FS` under a safe nonempty display label. `name` must be a non-root slash-relative `fs.ValidPath`. Each load reopens the selected regular file; copies of the `Filesystem` preserve namespace identity. Separate constructors create separate namespaces even for the same label or filesystem. |
|
||||||
| `Bytes(label, data)` | Requires a nonempty, non-secret diagnostic label and snapshots bytes during construction. Later caller mutation cannot affect the source. |
|
| `Bytes(label, data)` | Requires a nonempty, non-secret diagnostic label and snapshots bytes during construction. Later caller mutation cannot affect the source. |
|
||||||
| `Reader(label, input)` | Requires a nonempty, non-secret label and non-nil reader. The reader is claimed once across all copies of the source, consumed but never closed, and cannot be reused. |
|
| `Reader(label, input)` | Requires a nonempty, non-secret label and non-nil reader. The reader is claimed once across all copies of the source, consumed but never closed, and cannot be reused. |
|
||||||
|
| `Mapping(label, values)` | Requires a safe nonempty label and a non-nil root `map[string]any`. Snapshots supported built-in values into an owned mapping document at construction; `{}` is valid. Constructor conversion failures become safe deferred diagnostics. |
|
||||||
| `NoSource()` | Selects defaults-only loading, creates no source record, and marks no paths explicit. |
|
| `NoSource()` | Selects defaults-only loading, creates no source record, and marks no paths explicit. |
|
||||||
|
|
||||||
The zero `Source` is invalid. Constructor argument failures are retained inside the
|
The zero `Source` is invalid. Constructor argument failures are retained inside the
|
||||||
opaque source and become safe structured diagnostics when the source is consumed.
|
opaque source and become safe structured diagnostics when the source is consumed.
|
||||||
File sources can observe file changes between consumptions; byte sources cannot.
|
File and filesystem sources can observe changes between consumptions; byte and
|
||||||
|
mapping sources cannot. Mapping accepts nil, built-in string, boolean, signed or
|
||||||
|
unsigned integer, finite float, `[]any`, and `map[string]any` values recursively.
|
||||||
|
Typed nil maps and slices represent explicit null; empty collections remain empty.
|
||||||
|
Keys are sorted for stable provenance, integer decimal spelling stays exact, and
|
||||||
|
cycles or unsupported types are rejected without exposing values. Mapping input
|
||||||
|
uses the same directive and version rules as YAML, not CLI override restrictions.
|
||||||
|
|
||||||
Each source is limited to 8 MiB. A load using imports or an active profile is limited
|
Each source is limited to 8 MiB. A load using imports or an active overlay is limited
|
||||||
to 64 MiB across all accepted sources, 1,024 accepted sources, 64 active import
|
to 64 MiB across all accepted sources, 1,024 accepted sources, 64 active import
|
||||||
edges, and 1,000,000 input nodes in aggregate. Glob expansion separately permits
|
edges, and 1,000,000 input nodes in aggregate. Glob expansion separately permits
|
||||||
1,000,000 visited directory entries, including nonmatches. Reads request at most the
|
1,000,000 visited directory entries, including nonmatches. Reads request at most the
|
||||||
remaining allowance plus one byte so excess data is rejected rather than silently
|
remaining allowance plus one byte so excess data is rejected rather than silently
|
||||||
truncated. Data returned together with a read error is not accepted as partial input.
|
truncated. Data returned together with a read error is not accepted as partial input.
|
||||||
|
For mapping sources, key and string bytes use the same accounting as programmatic
|
||||||
|
overrides, and the converted tree uses the same node and depth bounds.
|
||||||
|
|
||||||
## Single-source loading
|
## Single-source loading
|
||||||
|
|
||||||
@@ -33,7 +43,7 @@ truncated. Data returned together with a read error is not accepted as partial i
|
|||||||
root `T` must satisfy the application schema contract below. With no options it
|
root `T` must satisfy the application schema contract below. With no options it
|
||||||
starts from the Go zero value. A `Definition[T].Defaults` factory, when supplied,
|
starts from the Go zero value. A `Definition[T].Defaults` factory, when supplied,
|
||||||
runs exactly once after successful source parsing, schema construction, optional
|
runs exactly once after successful source parsing, schema construction, optional
|
||||||
schema-version checking, and selected-profile loading. Its result is detached before
|
schema-version checking, and selected-overlay loading. Its result is detached before
|
||||||
input is applied. Resolver-provided mutable values are detached before secret lookup
|
input is applied. Resolver-provided mutable values are detached before secret lookup
|
||||||
and validation, and a final detached copy prevents equal-valued aliases introduced
|
and validation, and a final detached copy prevents equal-valued aliases introduced
|
||||||
by validators from escaping into the returned configuration. The publication copy
|
by validators from escaping into the returned configuration. The publication copy
|
||||||
@@ -43,34 +53,190 @@ The current lifecycle is:
|
|||||||
|
|
||||||
```text
|
```text
|
||||||
validate options → parse the selected source → traverse/compose enabled imports
|
validate options → parse the selected source → traverse/compose enabled imports
|
||||||
→ build schema → check the optional application version → apply a selected profile
|
→ build schema → check the optional application version → apply a selected overlay
|
||||||
→ apply explicit CLI overrides → create and clone defaults → strictly decode
|
→ apply explicit CLI overrides → expand sibling inheritance
|
||||||
|
→ create and clone defaults → strictly decode
|
||||||
→ recorded application resolution
|
→ recorded application resolution
|
||||||
→ resolve typed secret references → semantic validation → classify secrets
|
→ resolve typed secret references → semantic validation → classify secrets
|
||||||
→ snapshot configuration and metadata
|
→ snapshot configuration and metadata
|
||||||
```
|
```
|
||||||
|
|
||||||
`File`, `Bytes`, and `Reader` each contribute the first base source with deterministic
|
`File`, `Filesystem.File`, `Bytes`, `Reader`, and `Mapping` each contribute the first base source with deterministic
|
||||||
ID `source-1`; enabled imports continue in depth-first order as `source-2` onward.
|
ID `source-1`; enabled imports continue in depth-first order as `source-2` onward.
|
||||||
`NoSource` skips parsing, supplies an absent version to a configured version checker,
|
`NoSource` skips parsing, supplies an absent version to a configured version checker,
|
||||||
contributes no source, and continues through defaults, decode, and projection. A
|
contributes no source, and continues through defaults, decode, and projection. A
|
||||||
missing file remains an error; it is never interpreted as no input.
|
missing file remains an error; it is never interpreted as no input.
|
||||||
|
|
||||||
The current `Options` boundary accepts a defaults factory, `VersionRule`, resolver,
|
The current `Options` boundary accepts a defaults factory, `VersionRule`, resolver,
|
||||||
semantic validator, explicit path and glob imports, one selected profile, and
|
semantic validator, explicit path and glob imports, one selected overlay, and
|
||||||
filesystem context. It also accepts explicit CLI override records, static secret
|
filesystem context. It also accepts explicit CLI override records, static secret
|
||||||
tags, and a dynamic path predicate. `NoSource` rejects imports, active profiles,
|
tags, and a dynamic path predicate. `NoSource` rejects imports, active overlays,
|
||||||
and filesystem context as invalid combinations but accepts overrides. Input
|
and filesystem context as invalid combinations but accepts overrides. Input
|
||||||
containing a reserved `configkit` mapping key is rejected while imports are
|
containing a reserved `configkit` mapping key is rejected while imports are
|
||||||
disabled.
|
disabled.
|
||||||
|
|
||||||
Every source, options, schema, version, defaults, decode, resolution, or validation
|
Every source, options, schema, version, defaults, decode, resolution, or validation
|
||||||
failure returns a nil result and a `*LoadError`. Successful results contain caller-owned `Config`, detached
|
failure returns a nil result and a `*LoadError`. Successful results contain caller-owned `Config`, detached
|
||||||
`Metadata`, a defensive source list, and defensive nonfatal diagnostics. Mutating
|
`Metadata`, a defensive source list, and defensive nonfatal diagnostics. Each source
|
||||||
|
record's `Kind` identifies file, filesystem, bytes, reader, mapping, or CLI acquisition
|
||||||
|
independently of its precedence `Layer`. Host file paths remain canonical;
|
||||||
|
filesystem paths are slash-relative within their namespace; synthetic inputs have
|
||||||
|
no path. Mutating
|
||||||
the returned configuration or inspection records cannot alter ConfigKit's private
|
the returned configuration or inspection records cannot alter ConfigKit's private
|
||||||
snapshot. ConfigKit performs no logging. `Result.WriteEffective` exposes only the
|
snapshot. ConfigKit performs no logging. `Result.WriteEffective` exposes only the
|
||||||
frozen redacted projection.
|
frozen redacted projection.
|
||||||
|
|
||||||
|
### Completion and resource lifetime
|
||||||
|
|
||||||
|
`Load` is synchronous and complete on return. Success means input assembly,
|
||||||
|
defaulting, typed decoding, configured application resolution, secret lookup,
|
||||||
|
validation, and configuration/metadata snapshotting have completed. A reported
|
||||||
|
load failure returns diagnostics and a nil result, as described above.
|
||||||
|
|
||||||
|
Before returning on success or failure, ConfigKit closes the filesystem handles
|
||||||
|
it opened for loading, including files and directory/root handles. Caller-owned
|
||||||
|
filesystems are borrowed, never closed. The returned
|
||||||
|
configuration and inspection metadata require no close operation and remain
|
||||||
|
usable independently of the source files. A supplied `Reader` remains
|
||||||
|
caller-owned and is never closed by ConfigKit.
|
||||||
|
|
||||||
|
ConfigKit performs no background work after returning: it does not watch inputs,
|
||||||
|
refresh secrets, or mutate published results. Inspection and rendering run only
|
||||||
|
when explicitly called and use the retained snapshot. Applications normally load
|
||||||
|
once near startup, but may explicitly load again using sources that satisfy their
|
||||||
|
documented reuse rules. Additional loads produce independently owned results.
|
||||||
|
|
||||||
|
Completion is not a transaction over external state. Files and environment
|
||||||
|
variables are observed during processing rather than as one simultaneous external
|
||||||
|
snapshot. ConfigKit does not roll back application callback effects or manage work
|
||||||
|
or resources created by application callbacks. The explicit secrets-directory
|
||||||
|
bootstrap remains a separate operation invoked by the application.
|
||||||
|
|
||||||
|
## Layered loading
|
||||||
|
|
||||||
|
`LoadLayered[T](main, options...)` accepts zero or one `LayeredOptions[T]` value.
|
||||||
|
Its `main` is an `Input` containing a source, import opt-in, and optional
|
||||||
|
filesystem context. A zero source is invalid; `Input{Source: NoSource()}` omits
|
||||||
|
the main document. Each `Underlay` contains inputs that compose strictly as
|
||||||
|
one tier, including each input's enabled imports. Empty groups contribute
|
||||||
|
nothing. Underlay groups are listed from lowest to highest priority. Repeating
|
||||||
|
a file within one group remains an import/repetition error; the same reusable
|
||||||
|
source may be selected again in another tier.
|
||||||
|
|
||||||
|
ConfigKit acquires and composes the main input first, constructs the schema,
|
||||||
|
and checks the optional application version from the main tier only. Underlay
|
||||||
|
roots cannot claim that version path (`underlay.version`); imported fragments
|
||||||
|
retain `import.version` protection. It then acquires and composes underlay
|
||||||
|
groups in order, recursively combines the groups, and applies the main tier,
|
||||||
|
one selected overlay, and explicit CLI overrides. Scalar, sequence, and null
|
||||||
|
definitions replace lower values between tiers; mappings combine recursively.
|
||||||
|
Syntax and strict-composition errors inside a tier cannot be masked by a
|
||||||
|
higher-priority tier. Defaults, typed decoding, resolution, secret lookup,
|
||||||
|
validation, and publication run once on the final assembled input.
|
||||||
|
|
||||||
|
An active layered overlay requires `LayeredOptions.OverlayFilesystem` explicitly,
|
||||||
|
independent of the main source's namespace. Its name and root-relative lookup
|
||||||
|
follow the selected-overlay rules below; inactive overlays ignore the context.
|
||||||
|
The same path in a different filesystem namespace is not a repeated file.
|
||||||
|
Ordinary `Load` continues to infer its selected-overlay context from its source.
|
||||||
|
|
||||||
|
Source IDs follow acquisition order—main and its depth-first imports, then each
|
||||||
|
underlay tier's inputs and depth-first imports, then overlay and CLI—even though
|
||||||
|
history follows precedence order. Source `Layer` describes precedence while
|
||||||
|
`Kind` describes acquisition. Underlay records use `LayerUnderlay` and a
|
||||||
|
one-based `UnderlayIndex` giving their original tier position; all other records
|
||||||
|
have index zero. Explicit empty groups and `NoSource` consume no source ID.
|
||||||
|
Byte, source, node, and glob-entry budgets are shared across the load, while
|
||||||
|
the existing per-source and import-depth bounds still apply.
|
||||||
|
|
||||||
|
The maintained [layered consumer example](consumers/README.md#native-filesystem-and-layered-input)
|
||||||
|
shows a main host file, two underlay tiers, embedded defaults, a mapping source,
|
||||||
|
and explicit resource access without a second configuration pass.
|
||||||
|
|
||||||
|
### Sibling inheritance
|
||||||
|
|
||||||
|
Any input mapping may declare `extends: name` to inherit from the mapping named
|
||||||
|
`name` among its immediate siblings. Names are exact keys, including the empty
|
||||||
|
string; lookup does not search ancestor or unrelated scopes. The document root
|
||||||
|
and a sequence-element mapping have no sibling namespace for their own string
|
||||||
|
relationship, though mappings nested inside them can have one. An `extends`
|
||||||
|
value of null cancels a relationship without looking up a parent. Other value
|
||||||
|
types, missing or non-mapping parents, and cycles fail the load with value-free
|
||||||
|
diagnostics.
|
||||||
|
|
||||||
|
`extends` is reserved structural input across ordinary and layered loads, every
|
||||||
|
source kind, imports, selected overlays, and explicit CLI overrides. It is
|
||||||
|
consumed before typed decoding and need not appear in the application's Go
|
||||||
|
types. Applications previously using `extends` as an ordinary YAML field must
|
||||||
|
rename that key and its field. No collection registration or keyword setup is
|
||||||
|
required.
|
||||||
|
|
||||||
|
ConfigKit completes strict composition within tiers and precedence assembly
|
||||||
|
between tiers before resolving relationships. An omitted `extends` retains a
|
||||||
|
lower-priority relationship; `extends: null` cancels it while preserving the
|
||||||
|
child's own settings. Superseded references are historical evidence, not active
|
||||||
|
relationships to validate. Each child recursively overlays its own settings
|
||||||
|
over its resolved parent: explicit zero, false, empty string, sequence, and
|
||||||
|
null values replace inherited values, while mappings combine recursively.
|
||||||
|
The child retains its key. All effective relationships resolve, including
|
||||||
|
entries the application may never select for execution. Partial parent
|
||||||
|
definitions undergo normal typed decoding and application-owned validation,
|
||||||
|
not a special structural exemption.
|
||||||
|
|
||||||
|
Enclosing relationships resolve first. Nested instructions carried by a parent
|
||||||
|
are then resolved separately at each destination, so a child's nested sibling
|
||||||
|
override can change an inherited nested relationship. Typed defaults and
|
||||||
|
application-derived values do not start another inheritance pass. Inherited
|
||||||
|
input counts as explicit presence for `Metadata.IsExplicit`,
|
||||||
|
`Resolution.IsExplicit`, and absence-based resolver defaults, even for false,
|
||||||
|
zero, empty, or null input. `Origin.Inheritance` distinguishes it from a direct
|
||||||
|
declaration with concrete source, destination, and controlling directive paths.
|
||||||
|
A direct child replacement has its own effective origin; displaced ancestry
|
||||||
|
remains inspectable in history. An inherited relative resource keeps the
|
||||||
|
declaring source's passive `SourceContext`, not the child's directory.
|
||||||
|
|
||||||
|
The optional schema-version checker still runs once against the main input at
|
||||||
|
its original point. Inheritance cannot add, replace, or consume the protected
|
||||||
|
version path; an unrelated relationship inside an enclosing mapping does not
|
||||||
|
invalidate an unchanged version. Expansion uses the decoded projection
|
||||||
|
node/depth limits without charging copied values as acquired sources;
|
||||||
|
retained evidence uses the existing history-node limit. See the
|
||||||
|
[consumer example](consumers/README.md#named-sibling-inheritance) for one-load
|
||||||
|
usage.
|
||||||
|
|
||||||
|
### Source resource contexts
|
||||||
|
|
||||||
|
`Result.SourceContext(id)` and callback-scoped `Resolution.SourceContext(id)`
|
||||||
|
return a passive `ResourceContext` for a source with filesystem context, or
|
||||||
|
false for unknown and contextless IDs. The result query is nil-safe; the
|
||||||
|
resolution query follows the callback's lifetime guard. Queries perform no
|
||||||
|
filesystem access. Obtain IDs from exact origin locations rather than guessing
|
||||||
|
one context for a composite origin or an application-derived value.
|
||||||
|
|
||||||
|
`ResourceContext.FS` is rooted at the source's configured root, and `BaseDir`
|
||||||
|
is its slash-relative directory inside that root. This includes imported
|
||||||
|
sources, selected overlays, host files even without enabled imports, native
|
||||||
|
files, and byte, reader, or mapping inputs with an explicit context. CLI and
|
||||||
|
contextless synthetic inputs have no resource context. To open a relative
|
||||||
|
resource, join `BaseDir` with the application resource name using slash-path
|
||||||
|
operations and open that path through `FS`.
|
||||||
|
|
||||||
|
For a resource-valued field, query `result.Metadata().Lookup(fieldPath)`, inspect
|
||||||
|
its origin locations, choose a source ID only when the application's policy can
|
||||||
|
identify the intended contributor, then call `result.SourceContext(id)`. The
|
||||||
|
context belongs to that source even when the field survived from a lower-priority
|
||||||
|
underlay. A composite origin has no automatically selected resource base.
|
||||||
|
|
||||||
|
Native contexts borrow the caller's filesystem within the configured root.
|
||||||
|
Host contexts retain a canonical root path, not an open root handle; each
|
||||||
|
resource `Open` checks containment and opens a fresh handle that the returned
|
||||||
|
file's `Close` releases. Applications own and close the files they open.
|
||||||
|
Resources are application data, not configuration input, and do not consume
|
||||||
|
configuration byte or node budgets. The loaded configuration and metadata stay
|
||||||
|
usable if source files later change or disappear. Later resource operations
|
||||||
|
observe the backing filesystem then and may fail if files move, disappear, or
|
||||||
|
a caller-owned filesystem closes. This is not a snapshot or universal sandbox.
|
||||||
|
|
||||||
### Application schema versions
|
### Application schema versions
|
||||||
|
|
||||||
`VersionRule` declares a semantic path and non-nil checker. Before defaults or typed
|
`VersionRule` declares a semantic path and non-nil checker. Before defaults or typed
|
||||||
@@ -93,7 +259,7 @@ This is a load-local exception: siblings and unrelated fields, dynamic values,
|
|||||||
integer and float destinations, durations, `Secret`, and text codecs retain ordinary
|
integer and float destinations, durations, `Secret`, and text codecs retain ordinary
|
||||||
strict decoding. The retained source and history stay numeric while typed projection
|
strict decoding. The retained source and history stay numeric while typed projection
|
||||||
and effective YAML contain the resulting string; explanation records this through
|
and effective YAML contain the resulting string; explanation records this through
|
||||||
the normal decoding reconciliation event. Fragment, profile, and CLI ownership
|
the normal decoding reconciliation event. Fragment, overlay, and CLI ownership
|
||||||
protections apply before this conversion.
|
protections apply before this conversion.
|
||||||
|
|
||||||
The checker reports safe, value-free errors and warnings through `Validation.Error`
|
The checker reports safe, value-free errors and warnings through `Validation.Error`
|
||||||
@@ -108,12 +274,13 @@ successful result. Callback panics remain programming failures.
|
|||||||
`Result.Metadata` describes every final canonical path. Queries retain explicit
|
`Result.Metadata` describes every final canonical path. Queries retain explicit
|
||||||
key/index distinctions using actual effective and historical container shapes;
|
key/index distinctions using actual effective and historical container shapes;
|
||||||
only parsed numeric tokens are resolved contextually. A descendant that never
|
only parsed numeric tokens are resolved contextually. A descendant that never
|
||||||
existed is not historical merely because an atomic ancestor was replaced. Exact surviving input paths
|
existed is not historical merely because an atomic ancestor was replaced. Exact
|
||||||
are explicit and have a base or profile origin; omitted paths have a default origin.
|
surviving direct or inherited input paths are explicit and retain their source
|
||||||
|
layer and derivation; omitted paths have a default origin.
|
||||||
An explicit parent mapping does not make omitted children explicit. Null state and
|
An explicit parent mapping does not make omitted children explicit. Null state and
|
||||||
available source coordinates are retained. `History` records the Go-zero or application
|
available source coordinates are retained. `History` records the Go-zero or application
|
||||||
default baseline followed by exact base or profile definitions, including
|
default baseline followed by exact base or overlay definitions, including
|
||||||
equal-valued input. Profile replacement removes displaced descendants from effective
|
equal-valued input. Overlay replacement removes displaced descendants from effective
|
||||||
metadata while retaining their base definition and the parent replacement operation
|
metadata while retaining their base definition and the parent replacement operation
|
||||||
in history. All metadata queries and returned nested records are detached.
|
in history. All metadata queries and returned nested records are detached.
|
||||||
|
|
||||||
@@ -124,22 +291,32 @@ domain ownership rules remain application responsibilities. The method's Go
|
|||||||
documentation in [metadata.go](../metadata.go) defines enumeration and path-ordering
|
documentation in [metadata.go](../metadata.go) defines enumeration and path-ordering
|
||||||
details.
|
details.
|
||||||
|
|
||||||
History is chronological: a path can have a synthetic default record, its exact base
|
History is chronological: a path can have a synthetic default record, its exact
|
||||||
definition, a profile replacement, and a recorded resolution operation. A descendant
|
base definition, an overlay replacement, structural inheritance, and a recorded
|
||||||
|
resolution operation. A descendant
|
||||||
query uses the ancestor's path for a whole-container or whole-sequence replacement;
|
query uses the ancestor's path for a whole-container or whole-sequence replacement;
|
||||||
the descendant can therefore retain history after `Lookup` stops reporting it as
|
the descendant can therefore retain history after `Lookup` stops reporting it as
|
||||||
effective. Equal-valued input is still an explicit base definition, while a derived
|
effective. Equal-valued input is still an explicit base definition, while a derived
|
||||||
value for absent input remains non-explicit.
|
value for absent input remains non-explicit.
|
||||||
|
|
||||||
A mapping assembled from the selected file and imports has one composite base origin
|
A mapping assembled from the selected file and imports has one composite base origin
|
||||||
whose locations retain source traversal order. A mapping also visited by a profile
|
whose locations retain source traversal order. A mapping also visited by an overlay
|
||||||
has a profile-layer composite origin with the lower contributing locations followed
|
has an overlay-layer composite origin with the lower contributing locations followed
|
||||||
by the profile location; an empty mapping is still an explicit container even though
|
by the overlay location; an empty mapping is still an explicit container even though
|
||||||
it contributes no children. Resolution origins are synthetic: they have layer
|
it contributes no children. Resolution origins are synthetic: they have layer
|
||||||
`resolution`, no fabricated file location, and a `derived_default` or `normalization`
|
`resolution`, no fabricated file location, and a `derived_default` or `normalization`
|
||||||
operation. Reasons and dependency paths retain first occurrence order with duplicates
|
operation. Reasons and dependency paths retain first occurrence order with duplicates
|
||||||
removed. Source records remain ordered as selected source, depth-first imports, the
|
removed. Source records remain ordered as selected source, depth-first imports, the
|
||||||
selected profile, then synthetic CLI records in supplied order.
|
selected overlay, then synthetic CLI records in supplied order.
|
||||||
|
|
||||||
|
Inheritance adds no acquired source or precedence layer. `Origin.Inheritance`
|
||||||
|
lists concrete transfers from contributor paths through destinations, with
|
||||||
|
each step's controlling `extends` path and location. `History` retains source
|
||||||
|
applications at their original paths and projects parent contributions, child
|
||||||
|
replacements, and consumed controls at destination paths after source assembly
|
||||||
|
and before typed decoding. `HistoricalPaths` includes consumed directives and
|
||||||
|
displaced inherited descendants. A control can have history even when `Lookup`
|
||||||
|
reports it absent. Queries return detached records.
|
||||||
|
|
||||||
### Secret classification and effective rendering
|
### Secret classification and effective rendering
|
||||||
|
|
||||||
@@ -156,6 +333,11 @@ Propagation reaches a fixed point, so record/map iteration order does not affect
|
|||||||
result and dependency cycles terminate. A dependency on a classified descendant or
|
result and dependency cycles terminate. A dependency on a classified descendant or
|
||||||
on a container that contains one is treated conservatively as sensitive. Applications
|
on a container that contains one is treated conservatively as sensitive. Applications
|
||||||
must classify secret-producing transformations whose dependencies are not recorded.
|
must classify secret-producing transformations whose dependencies are not recorded.
|
||||||
|
Inherited value and control paths link source and destination classifications
|
||||||
|
through chains and nested copies; unrelated sibling fields are not classified
|
||||||
|
merely because another field is secret. Displaced historical evidence remains
|
||||||
|
redacted. Secret references are copied only as unresolved names; credential
|
||||||
|
lookup stays after decoding and application resolution.
|
||||||
|
|
||||||
`Result.WriteEffective` writes the frozen resolved snapshot as deterministic redacted
|
`Result.WriteEffective` writes the frozen resolved snapshot as deterministic redacted
|
||||||
YAML. Mappings sort by decoded key string, sequences retain order, indentation is two
|
YAML. Mappings sort by decoded key string, sequences retain order, indentation is two
|
||||||
@@ -189,8 +371,11 @@ historical path. Its effective value and each chronological before/after value a
|
|||||||
parser values. `Present=false` with empty YAML means absence or deletion; explicit
|
parser values. `Present=false` with empty YAML means absence or deletion; explicit
|
||||||
null is present and renders as `null`. The history starts with the canonical typed
|
null is present and renders as `null`. The history starts with the canonical typed
|
||||||
application-default or Go-zero baseline, then includes only relevant base sources in
|
application-default or Go-zero baseline, then includes only relevant base sources in
|
||||||
traversal order, the selected profile, supplied CLI records, and audited net
|
traversal order, the selected overlay, supplied CLI records, and audited net
|
||||||
resolution operations. Overlapping parent/child resolution records are rendered
|
resolution operations. Structural inheritance events appear after source replay
|
||||||
|
and before typed reconciliation, including consumed or canceled `extends` input
|
||||||
|
and equal-valued child replacements. Overlapping parent/child resolution records
|
||||||
|
are rendered
|
||||||
as one net subtree event with combined reasons and dependencies, rather than
|
as one net subtree event with combined reasons and dependencies, rather than
|
||||||
pretending that the recorded assignments ran in lexical order. Explicit equal
|
pretending that the recorded assignments ran in lexical order. Explicit equal
|
||||||
writes remain visible. When input replay
|
writes remain visible. When input replay
|
||||||
@@ -199,7 +384,7 @@ before domain resolution. Its origin retains the decoded path's source/default
|
|||||||
attribution; its reason identifies static-default retention and canonical decoding.
|
attribution; its reason identifies static-default retention and canonical decoding.
|
||||||
This built-in inspection operation is not accepted by `Resolution.Record`.
|
This built-in inspection operation is not accepted by `Resolution.Record`.
|
||||||
|
|
||||||
Base, profile, and CLI history preserves the policy-validated input representation,
|
Base, overlay, and CLI history preserves the policy-validated input representation,
|
||||||
including a superseded value that could not have decoded into the final Go field.
|
including a superseded value that could not have decoded into the final Go field.
|
||||||
Baseline, effective, and resolution values use canonical typed projection. A
|
Baseline, effective, and resolution values use canonical typed projection. A
|
||||||
decoding event bridges replayed input and canonical typed values, so intermediate
|
decoding event bridges replayed input and canonical typed values, so intermediate
|
||||||
@@ -293,10 +478,13 @@ operation once before starting concurrent work. The selected path may itself be
|
|||||||
symlink; ConfigKit resolves it to an existing canonical directory before examining
|
symlink; ConfigKit resolves it to an existing canonical directory before examining
|
||||||
its immediate entries.
|
its immediate entries.
|
||||||
|
|
||||||
The bootstrap enumerates at most 1,024 entries and sorts them by filename. Every
|
The bootstrap enumerates at most 1,024 entries, including dot-prefixed entries.
|
||||||
entry must have an ASCII environment-variable name and be a regular, nonsymlink
|
Entries whose names begin with `.` (files, directories, or symlinks, such as `.git`
|
||||||
file. Metadata for all entries is validated before file content is read or process
|
and `.gitignore`) are ignored before name or metadata validation, are never opened,
|
||||||
state is changed. Existing environment variables win, including variables whose
|
and are omitted from the report. Remaining entries are sorted by filename; each
|
||||||
|
must have an ASCII environment-variable name and be a regular, nonsymlink
|
||||||
|
file. Metadata for all remaining entries is validated before file content is read
|
||||||
|
or process state is changed. Existing environment variables win, including variables whose
|
||||||
value is empty; their files are not opened. Each eligible file is limited to 1 MiB,
|
value is empty; their files are not opened. Each eligible file is limited to 1 MiB,
|
||||||
and eligible content is limited to 8 MiB in total. ConfigKit removes exactly one
|
and eligible content is limited to 8 MiB in total. ConfigKit removes exactly one
|
||||||
terminal LF or CRLF, preserves all other whitespace, accepts an empty value, and
|
terminal LF or CRLF, preserves all other whitespace, accepts an empty value, and
|
||||||
@@ -335,7 +523,7 @@ found entry path. Resolution changes, additions, removals, and moves do not alte
|
|||||||
this entry view.
|
this entry view.
|
||||||
|
|
||||||
`Resolution.Source(id)` returns a detached record for an already acquired source in
|
`Resolution.Source(id)` returns a detached record for an already acquired source in
|
||||||
the same load: the main source, imports, selected profile, and supplied CLI records
|
the same load: the main source, imports, selected overlay, and supplied CLI records
|
||||||
where applicable. Empty and unknown IDs return false. It never reloads input, reads
|
where applicable. Empty and unknown IDs return false. It never reloads input, reads
|
||||||
the filesystem, resolves symlinks, or looks up credentials. A source path exists
|
the filesystem, resolves symlinks, or looks up credentials. A source path exists
|
||||||
only when the acquired source has one; defaults and byte, reader, and CLI sources do
|
only when the acquired source has one; defaults and byte, reader, and CLI sources do
|
||||||
@@ -433,41 +621,41 @@ traversal order. Traversal order never authorizes replacement. Composition clone
|
|||||||
the resulting tree and its ordered claim records rather than mutating or aliasing an
|
the resulting tree and its ordered claim records rather than mutating or aliasing an
|
||||||
input document.
|
input document.
|
||||||
|
|
||||||
## Selected profiles
|
## Selected overlays
|
||||||
|
|
||||||
`Options.Profile` selects at most one overlay by name. Names must match
|
`Options.Overlay` selects at most one overlay by name. Names must match
|
||||||
`[a-zA-Z0-9_-]+`; they are not paths. The empty name and exact lowercase name
|
`[a-zA-Z0-9_-]+`; they are not paths. The empty name and exact lowercase name
|
||||||
`default` select no profile, and `profiles/default.yml` is never loaded implicitly.
|
`default` select no overlay, and `overlays/default.yml` is never loaded implicitly.
|
||||||
Every other name resolves only to `<configuration-root>/profiles/<name>.yml`, with
|
Every other name resolves only to `<configuration-root>/overlays/<name>.yml`, with
|
||||||
no extension fallback, case normalization, inheritance, or profile stack. A selected
|
no extension fallback, case normalization, inheritance between overlay files,
|
||||||
missing profile is an error.
|
or overlay stack. A selected missing overlay is an error.
|
||||||
|
|
||||||
The profile is a separately policy-validated YAML mapping. It is loaded after the
|
The overlay is a separately policy-validated YAML mapping. It is loaded after the
|
||||||
base import graph is composed and its schema version is checked, but before defaults
|
base import graph is composed and its schema version is checked, but before defaults
|
||||||
and typed decoding. Profile bytes, nodes, and source records count toward the same
|
and typed decoding. Overlay bytes, nodes, and source records count toward the same
|
||||||
aggregate limits as base inputs. Its canonical path must remain within the configured
|
aggregate limits as base inputs. Its canonical path must remain within the configured
|
||||||
root and must not duplicate a file already present in the base graph.
|
root and must not duplicate a file already present in the base graph.
|
||||||
|
|
||||||
Overlay is intentionally distinct from strict composition:
|
Overlay is intentionally distinct from strict composition:
|
||||||
|
|
||||||
| Existing lower node | Incoming profile node | Result |
|
| Existing lower node | Incoming overlay node | Result |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| Absent | Value | Retain the profile value |
|
| Absent | Value | Retain the overlay value |
|
||||||
| Value | Absent | Retain the lower value |
|
| Value | Absent | Retain the lower value |
|
||||||
| Mapping | Mapping | Recurse by mapping key |
|
| Mapping | Mapping | Recurse by mapping key |
|
||||||
| Any other pair of present nodes | Any other pair of present nodes | Replace the entire lower node |
|
| Any other pair of present nodes | Any other pair of present nodes | Replace the entire lower node |
|
||||||
|
|
||||||
Scalars, sequences, and null are atomic. Thus a profile sequence replaces rather
|
Scalars, sequences, and null are atomic. Thus an overlay sequence replaces rather
|
||||||
than extends a base sequence, `[]` clears it, null is an explicit replacement, and
|
than extends a base sequence, `[]` clears it, null is an explicit replacement, and
|
||||||
cross-kind replacement is allowed when the final application schema accepts it.
|
cross-kind replacement is allowed when the final application schema accepts it.
|
||||||
Replacing a subtree removes all displaced descendants from effective presence and
|
Replacing a subtree removes all displaced descendants from effective presence and
|
||||||
origin data; history retains the displaced definitions and identifies the parent
|
origin data; history retains the displaced definitions and identifies the parent
|
||||||
replacement. Surviving profile paths have profile origins, while recursively shared
|
replacement. Surviving overlay paths have overlay origins, while recursively shared
|
||||||
mapping containers retain their contributing locations.
|
mapping containers retain their contributing locations.
|
||||||
|
|
||||||
A profile may not contain `configkit` anywhere, contribute the configured schema
|
An overlay may not contain `configkit` anywhere, contribute the configured schema
|
||||||
version, or replace an ancestor of that version with a scalar or null. These rules
|
version, or replace an ancestor of that version with a scalar or null. These rules
|
||||||
apply even if the supplied version text would be unchanged. Profiles cannot mask a
|
apply even if the supplied version text would be unchanged. Overlays cannot mask a
|
||||||
base parse, composition, or version failure because those checks run first.
|
base parse, composition, or version failure because those checks run first.
|
||||||
|
|
||||||
## Explicit CLI overrides
|
## Explicit CLI overrides
|
||||||
@@ -480,8 +668,8 @@ must never contain the raw argument or configured value. General environment
|
|||||||
variable overlays are an explicit non-goal: environment access is reserved for
|
variable overlays are an explicit non-goal: environment access is reserved for
|
||||||
typed secret references.
|
typed secret references.
|
||||||
|
|
||||||
Overrides apply after the selected profile and before typed defaults/decoding, so
|
Overrides apply after the selected overlay and before typed defaults/decoding, so
|
||||||
the input precedence is application defaults < composed base < selected profile <
|
the input precedence is application defaults < composed base < selected overlay <
|
||||||
CLI. Recorded resolution, typed secret lookup, and semantic validation follow the
|
CLI. Recorded resolution, typed secret lookup, and semantic validation follow the
|
||||||
effective override tree. Overrides also work with `NoSource`.
|
effective override tree. Overrides also work with `NoSource`.
|
||||||
|
|
||||||
@@ -503,7 +691,7 @@ configured schema-version path. Unknown fields and effective type mismatches rem
|
|||||||
ordinary strict-decoder errors.
|
ordinary strict-decoder errors.
|
||||||
|
|
||||||
At most 1,024 records are accepted, and each record creates one synthetic CLI
|
At most 1,024 records are accepted, and each record creates one synthetic CLI
|
||||||
source after file/profile sources in supplied order. Override sources share the
|
source after file/overlay sources in supplied order. Override sources share the
|
||||||
1,024-source ceiling. A record has an 8 MiB string-byte limit; override strings and
|
1,024-source ceiling. A record has an 8 MiB string-byte limit; override strings and
|
||||||
source bytes share the 64 MiB aggregate limit. Synthetic mapping keys and values
|
source bytes share the 64 MiB aggregate limit. Synthetic mapping keys and values
|
||||||
count toward the existing 1,000,000-node and depth-256 ceilings. Cycles, named or
|
count toward the existing 1,000,000-node and depth-256 ceilings. Cycles, named or
|
||||||
@@ -511,7 +699,7 @@ unsupported types, nonfinite floats, and limit excesses fail with safe `override
|
|||||||
diagnostics. Diagnostics and provenance identify the safe `Flag` source, never raw
|
diagnostics. Diagnostics and provenance identify the safe `Flag` source, never raw
|
||||||
arguments or values.
|
arguments or values.
|
||||||
|
|
||||||
Override origins are explicit CLI origins. History retains replaced base/profile
|
Override origins are explicit CLI origins. History retains replaced base/overlay
|
||||||
definitions and records equal-value replacements as well as structural changes.
|
definitions and records equal-value replacements as well as structural changes.
|
||||||
Caller-owned maps and slices are snapshotted during loading and must not be mutated
|
Caller-owned maps and slices are snapshotted during loading and must not be mutated
|
||||||
concurrently with the call. The executable `ExampleOverride` shows translating a
|
concurrently with the call. The executable `ExampleOverride` shows translating a
|
||||||
@@ -554,18 +742,25 @@ walk failures, matched directories, invalid documents, escapes, and repeated tar
|
|||||||
remain errors. Final candidates are bounded by the remaining source limit before
|
remain errors. Final candidates are bounded by the remaining source limit before
|
||||||
their contents are accumulated.
|
their contents are accumulated.
|
||||||
|
|
||||||
The configuration root defaults to a selected file's canonical directory. A file
|
For host files, the configuration root defaults to the selected file's canonical
|
||||||
source may supply `FilesystemContext.Root` to widen that root but may not supply
|
directory. A host file may supply `FilesystemContext.Root` to widen that root but
|
||||||
`BaseDir`. Whenever byte and reader sources supply filesystem context, they must
|
may not supply `BaseDir` or a native `FS`. Byte, reader, and mapping inputs with host context
|
||||||
provide both `BaseDir` and `Root` as absolute existing directories; their diagnostic
|
must provide both `BaseDir` and `Root` as absolute existing directories.
|
||||||
labels, including URI-looking labels, never imply filesystem paths. The base and
|
For `Filesystem.File`, the default root is `.` in its namespace and the base is
|
||||||
selected file must be inside the canonical root. Nonregular targets are rejected before opening to avoid blocking on FIFOs;
|
the selected file's directory. An explicit context must use the same `Filesystem`
|
||||||
|
namespace and may set `Root` to contain the file and its base; it may not supply
|
||||||
|
`BaseDir`. Byte, reader, and mapping inputs with native context provide both `BaseDir` and
|
||||||
|
`Root` as slash-relative `fs.ValidPath` directories in `FS` (`.` means its root),
|
||||||
|
with the base inside the root. Context paths are checked even when imports and
|
||||||
|
overlays are inactive. Diagnostic labels, including URI-looking labels, never
|
||||||
|
imply filesystem paths. Nonregular targets are rejected before opening to avoid blocking on FIFOs;
|
||||||
post-open regular-file checks remain in place under the stable-input assumption.
|
post-open regular-file checks remain in place under the stable-input assumption.
|
||||||
ConfigKit canonicalizes symlinks,
|
ConfigKit canonicalizes symlinks,
|
||||||
checks containment with relative paths, and opens the canonical root-relative target
|
checks containment with relative paths, and opens the canonical root-relative target
|
||||||
through a library-owned root handle. Contained relative or absolute symlink targets
|
through a library-owned root handle. Contained relative or absolute symlink targets
|
||||||
are accepted; escapes are rejected. Canonical paths define identity, so hard links at
|
are accepted; escapes are rejected. Canonical paths define identity, so hard links at
|
||||||
distinct paths remain distinct sources.
|
distinct paths remain distinct sources. Native filesystems use slash-path operations
|
||||||
|
and their own symlink behavior; imports stay in their selected namespace and root.
|
||||||
|
|
||||||
An active-stack repeat is `import.cycle` and reports the complete cycle's import
|
An active-stack repeat is `import.cycle` and reports the complete cycle's import
|
||||||
sites. A previously visited canonical path is `import.repeated` and reports both
|
sites. A previously visited canonical path is `import.repeated` and reports both
|
||||||
|
|||||||
@@ -1,13 +1,13 @@
|
|||||||
# Consumer Adoption Guide
|
# Consumer Adoption Guide
|
||||||
|
|
||||||
ConfigKit removes parser setup, strict decoding, presence bookkeeping, import and
|
ConfigKit removes parser setup, strict decoding, presence bookkeeping, import and
|
||||||
profile traversal, precedence, provenance, secret lookup, and safe inspection from
|
selected-overlay traversal, precedence, provenance, secret lookup, and safe inspection from
|
||||||
applications. Consumers still own their configuration structs, defaults, semantic
|
applications. Consumers still own their configuration structs, defaults, semantic
|
||||||
validation, schema-version policy, CLI parsing, runtime matching and conversion,
|
validation, schema-version policy, CLI parsing, runtime matching and conversion,
|
||||||
resource checks, remote acquisition, and service initialization.
|
resource checks, remote acquisition, and service initialization.
|
||||||
|
|
||||||
The maintained [`examples/consumers`](../../examples/consumers) package demonstrates
|
The maintained [`examples/consumers`](../../examples/consumers) package demonstrates
|
||||||
four sanitized shapes using only ConfigKit and the Go standard library:
|
sanitized shapes using only ConfigKit and the Go standard library:
|
||||||
|
|
||||||
| Shape | Demonstrated fit | Application code deliberately retained |
|
| Shape | Demonstrated fit | Application code deliberately retained |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
@@ -15,6 +15,9 @@ four sanitized shapes using only ConfigKit and the Go standard library:
|
|||||||
| Notarius-like | Canonical object bindings, a string-backed schema version accepting string or integer YAML, strict dynamic options, and `int64` dynamic integers | Catalog selection, allowed option keys, range-checked conversion to runtime `int` |
|
| Notarius-like | Canonical object bindings, a string-backed schema version accepting string or integer YAML, strict dynamic options, and `int64` dynamic integers | Catalog selection, allowed option keys, range-checked conversion to runtime `int` |
|
||||||
| WeatherReporter-like | Defaults-only loading, report maps, canonical module objects, typed option unions, explicit CLI records, and typed secret startup | Report/module compatibility, rejection of explicitly empty domain lists, CLI parsing, and startup ordering |
|
| WeatherReporter-like | Defaults-only loading, report maps, canonical module objects, typed option unions, explicit CLI records, and typed secret startup | Report/module compatibility, rejection of explicitly empty domain lists, CLI parsing, and startup ordering |
|
||||||
| Seriatim-like | Independent strict ordered speaker and autocorrect rule files | First-match and ordered replacement algorithms; no central application configuration file |
|
| Seriatim-like | Independent strict ordered speaker and autocorrect rule files | First-match and ordered replacement algorithms; no central application configuration file |
|
||||||
|
| Bundled file | Simple native `fs.FS` source through ordinary `Load` | Selection and lifetime of the application-owned embedded filesystem |
|
||||||
|
| Layered catalog | Embedded defaults with an import, a mapping underlay, an independent host main file, explicit false/zero input, and source-relative resource access | Domain validation and opening/interpreting the template resource |
|
||||||
|
| Named presets | One-load sibling inheritance, explicit false, nested destination resolution, and source/derivation inspection | Choosing and executing a preset |
|
||||||
|
|
||||||
The YAML under [`testdata`](../../examples/consumers/testdata) is loaded by the
|
The YAML under [`testdata`](../../examples/consumers/testdata) is loaded by the
|
||||||
executable examples and ordinary tests. It contains no private application data,
|
executable examples and ordinary tests. It contains no private application data,
|
||||||
@@ -34,7 +37,7 @@ features appear only when the application needs them:
|
|||||||
result, err := configkit.Load[Config](configkit.File(path), configkit.Options[Config]{
|
result, err := configkit.Load[Config](configkit.File(path), configkit.Options[Config]{
|
||||||
Definition: rules,
|
Definition: rules,
|
||||||
Imports: useDeclaredImports,
|
Imports: useDeclaredImports,
|
||||||
Profile: selectedConfigProfile,
|
Overlay: selectedConfigOverlay,
|
||||||
Overrides: explicitlySetFlags,
|
Overrides: explicitlySetFlags,
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -43,11 +46,48 @@ if err != nil {
|
|||||||
return start(result.Config)
|
return start(result.Config)
|
||||||
```
|
```
|
||||||
|
|
||||||
Simple consumers use neither imports nor profiles. A complex consumer can opt into
|
Simple consumers use neither imports nor selected overlays. A complex consumer can opt into
|
||||||
both without redefining their syntax. ConfigKit profiles are configuration overlays;
|
both without redefining their syntax. ConfigKit overlays are configuration overlays;
|
||||||
they do not select or replace an application's LLM, model, pipeline, report, or
|
they do not select or replace an application's LLM, model, pipeline, report, or
|
||||||
execution profile concepts.
|
execution profile concepts.
|
||||||
|
|
||||||
|
## Named sibling inheritance
|
||||||
|
|
||||||
|
[`LoadPresets`](../../examples/consumers/inheritance.go) loads the maintained
|
||||||
|
[`presets.yml`](../../examples/consumers/testdata/inheritance/presets.yml) in one
|
||||||
|
call. `custom` inherits `enabled: false` from `base`, while its nested
|
||||||
|
`settings.primary` changes the inherited `settings.secondary` result at the
|
||||||
|
custom destination. The application struct has no `extends` field; ConfigKit
|
||||||
|
consumes the relationship before strict typed decoding.
|
||||||
|
|
||||||
|
The [executable example](../../examples/consumers/consumers_test.go) reads
|
||||||
|
`Metadata.IsExplicit` for the inherited false value, then follows
|
||||||
|
`Origin.Inheritance` back to the parent path while `Origin.Locations` identifies
|
||||||
|
the declaring source. Applications still choose which preset to execute and
|
||||||
|
validate domain meaning. The [configuration contract](../config.md#sibling-inheritance)
|
||||||
|
owns exact lookup, precedence, cancellation, and migration rules.
|
||||||
|
|
||||||
|
## Native filesystem and layered input
|
||||||
|
|
||||||
|
[`LoadBundled`](../../examples/consumers/layered.go) keeps the simple `Load` shape:
|
||||||
|
it selects a file in an application-owned embedded filesystem and needs no
|
||||||
|
underlay setup. [`LoadCatalog`](../../examples/consumers/layered.go) uses
|
||||||
|
`LoadLayered` with an imported embedded-defaults group, a separate
|
||||||
|
`Mapping` group, and a host main file supplied by its caller. The groups
|
||||||
|
compose strictly within themselves and recursively across precedence boundaries;
|
||||||
|
the main file's explicit `false` and `0` replace lower values without being
|
||||||
|
mistaken for omissions. Its validator owns allowed modes and resource-name policy.
|
||||||
|
|
||||||
|
[`ReadWelcome`](../../examples/consumers/layered.go) follows the effective field's
|
||||||
|
origin location to a source ID, queries `Result.SourceContext`, and opens the
|
||||||
|
resource relative to that context's `BaseDir`. It does not assume the main file
|
||||||
|
owns a retained underlay value. A composite origin needs an application choice;
|
||||||
|
ConfigKit does not guess a directory. The context query is passive, while later
|
||||||
|
resource reads observe the caller-owned filesystem or a freshly opened host root
|
||||||
|
and may fail independently of the completed configuration load. The
|
||||||
|
[configuration contract](../config.md#source-resource-contexts) owns exact
|
||||||
|
lifetime and precedence rules.
|
||||||
|
|
||||||
Known module catalogs should use canonical object entries with a module identifier
|
Known module catalogs should use canonical object entries with a module identifier
|
||||||
and typed options. A small union struct is sufficient when the available option
|
and typed options. A small union struct is sufficient when the available option
|
||||||
fields are known; validation selects which fields apply to each module. Runtime-
|
fields are known; validation selects which fields apply to each module. Runtime-
|
||||||
@@ -100,6 +140,16 @@ The examples preserve domain meaning while adopting one configuration convention
|
|||||||
blocked empty variables remain blocked, and ordinary `Load` never changes the
|
blocked empty variables remain blocked, and ordinary `Load` never changes the
|
||||||
process environment.
|
process environment.
|
||||||
|
|
||||||
|
### Selected-overlay migration
|
||||||
|
|
||||||
|
To adopt the current selected-overlay API, rename `Options.Profile`,
|
||||||
|
`LayerProfile`, and `CodeProfile*` references to their `Overlay` equivalents; move
|
||||||
|
selected files from `profiles/<name>.yml` to `overlays/<name>.yml`; update any
|
||||||
|
handling of the `overlay` layer and `overlay.*` diagnostic strings; then rebuild.
|
||||||
|
The [configuration contract](../config.md#selected-overlays) is the canonical
|
||||||
|
behavioral reference. Application-owned profile concepts, such as `model_profile`,
|
||||||
|
are unchanged, and any CLI flag rename remains the application's decision.
|
||||||
|
|
||||||
These examples are migration evidence, not completed changes to Narratio, Notarius,
|
These examples are migration evidence, not completed changes to Narratio, Notarius,
|
||||||
WeatherReporter, or Seriatim. Updating those repositories, their deployed YAML, CLI
|
WeatherReporter, or Seriatim. Updating those repositories, their deployed YAML, CLI
|
||||||
wiring, runtime catalogs, and operational documentation remains separate downstream
|
wiring, runtime catalogs, and operational documentation remains separate downstream
|
||||||
@@ -113,9 +163,11 @@ focused behavioral owner:
|
|||||||
| Roadmap surface | Maintained owner |
|
| Roadmap surface | Maintained owner |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Load`, `NoSource`, validation, versions, resolution, `SecretEnv`, overrides, and explanation | Executable examples in [`example_test.go`](../../example_test.go) |
|
| `Load`, `NoSource`, validation, versions, resolution, `SecretEnv`, overrides, and explanation | Executable examples in [`example_test.go`](../../example_test.go) |
|
||||||
| Source/import/profile pipeline rules and artifact defaults | Narratio-shaped executable example and fixture |
|
| Source/import/selected-overlay pipeline rules and artifact defaults | Narratio-shaped executable example and fixture |
|
||||||
| Canonical module objects and dynamic option handling | WeatherReporter- and Notarius-shaped examples and migration tests |
|
| Canonical module objects and dynamic option handling | WeatherReporter- and Notarius-shaped examples and migration tests |
|
||||||
| `LoadSecretsDir`, bootstrap reporting, typed lookup, CLI explanation | `Example_weatherStartup` |
|
| `LoadSecretsDir`, bootstrap reporting, typed lookup, CLI explanation | `Example_weatherStartup` |
|
||||||
|
| Native filesystem, grouped underlays, programmatic mapping, retained resource context | `Example_nativeFilesystem`, `Example_layeredCatalog`, and their focused consumer tests |
|
||||||
|
| Named sibling inheritance, presence, and derivation | `Example_inheritedPresets` and `TestPresetCatalogOneLoadAndDerivation` |
|
||||||
| Results, metadata, diagnostics, effective output, and writer failures | Focused root-package load, provenance, rendering, and explanation tests |
|
| Results, metadata, diagnostics, effective output, and writer failures | Focused root-package load, provenance, rendering, and explanation tests |
|
||||||
|
|
||||||
The package-level import-boundary test covers the consumer examples too: supported
|
The package-level import-boundary test covers the consumer examples too: supported
|
||||||
|
|||||||
@@ -8,20 +8,43 @@ public behavior.
|
|||||||
## Initial orientation
|
## Initial orientation
|
||||||
|
|
||||||
1. Inspect the working tree and preserve unrelated changes.
|
1. Inspect the working tree and preserve unrelated changes.
|
||||||
2. Read the architecture policy for code or design work.
|
2. Use the Policy Reading Guide below to select applicable policies.
|
||||||
3. Read the policy, contract, and internal documents applicable to the task.
|
3. Read the contract and internal documents applicable to the task.
|
||||||
4. Inspect the relevant implementation and behavioral tests before changing them.
|
4. Inspect the relevant implementation and behavioral tests before changing them.
|
||||||
|
|
||||||
|
## Policy Reading Guide
|
||||||
|
|
||||||
|
| Policy | Read before… |
|
||||||
|
| --- | --- |
|
||||||
|
| [Policy set provenance](policy/meta.md) | Adopting policies, checking upstream revisions, or updating the adopted policy set. |
|
||||||
|
| [Agents](policy/agents.md) | Recommending, planning, or implementing repository changes. |
|
||||||
|
| [Architecture](policy/architecture.md) | Planning or changing Go library code or its structure. |
|
||||||
|
| [Testing](policy/testing.md) | Selecting validation for code changes, or adding, changing, removing, or evaluating tests. |
|
||||||
|
| [Documentation](policy/documentation.md) | Writing, revising, or reorganizing documentation. |
|
||||||
|
| [OSS](policy/oss.md) | Adding or updating dependencies or incorporated third-party material, or changing licensing or attribution. |
|
||||||
|
| [Release](policy/release.md) | Preparing or publishing a release, changing release procedures, or making versioning and compatibility decisions. |
|
||||||
|
|
||||||
|
- Read applicable policies before making decisions they govern; multiple policies
|
||||||
|
may apply.
|
||||||
|
- Select policies using the task triggers above. Follow cross-references to
|
||||||
|
relevant sections when needed to resolve a concrete question.
|
||||||
|
- Reuse policies already available in context; reread when changed or no longer
|
||||||
|
available.
|
||||||
|
- Expand reading when the task's scope expands.
|
||||||
|
- When revising a policy itself, read that policy and any provisions elsewhere
|
||||||
|
affected by the revision.
|
||||||
|
|
||||||
## Task-specific reading guide
|
## Task-specific reading guide
|
||||||
|
|
||||||
| Task | Read |
|
| Task | Read |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| Repository orientation or component responsibility | [Architecture policy](policy/architecture.md) and [component overview](internal/overview.md) |
|
| Repository orientation or component responsibility | [Component overview](internal/overview.md) |
|
||||||
| Documentation changes | [Documentation policy](policy/documentation.md) and the owning document |
|
| Documentation changes | The owning document |
|
||||||
| Architecture decisions or future work | [Documentation policy](policy/documentation.md), [deferred scope](roadmap/deferred.md), and relevant ADRs listed below |
|
| Licensing, dependencies, attribution, or release-document changes | [Project grant](../COPYRIGHT) and [attribution](oss/attribution.md); release changes also follow the release procedure |
|
||||||
| Code and test changes | [Architecture policy](policy/architecture.md), [testing policy](policy/testing.md), and the owning contract and tests from the map below |
|
| Architecture decisions or future work | [Deferred scope](roadmap/deferred.md) and relevant ADRs listed below |
|
||||||
|
| Code and test changes | The owning contract and tests from the map below |
|
||||||
| Examples or copyable assets | The owning implemented contract and [consumer adoption guide](consumers/README.md) |
|
| Examples or copyable assets | The owning implemented contract and [consumer adoption guide](consumers/README.md) |
|
||||||
| Release preparation | [Release policy](policy/release.md) and [release procedure](release.md) |
|
| Release preparation | [Release procedure](release.md) |
|
||||||
|
|
||||||
Accepted decisions:
|
Accepted decisions:
|
||||||
|
|
||||||
@@ -41,7 +64,9 @@ git show cb5b435:docs/roadmap/remediation.md
|
|||||||
```
|
```
|
||||||
|
|
||||||
Release-candidate, publication, and verification work follows the operational
|
Release-candidate, publication, and verification work follows the operational
|
||||||
[release procedure](release.md).
|
[release procedure](release.md). Its module-selected ReleaseKit `publish`
|
||||||
|
invocation validates the committed candidate and publishes only the intended
|
||||||
|
tag; those release checks remain distinct from the everyday development check.
|
||||||
|
|
||||||
The completed string-and-integer schema-version implementation and remediation
|
The completed string-and-integer schema-version implementation and remediation
|
||||||
records are preserved in Git history at `244104f`. The
|
records are preserved in Git history at `244104f`. The
|
||||||
@@ -56,9 +81,33 @@ and current facade ownership belongs to the [component overview](internal/overvi
|
|||||||
|
|
||||||
## Baseline validation
|
## Baseline validation
|
||||||
|
|
||||||
Install Go 1.25.0 or a supported patched/newer Go toolchain. Acquire declared
|
The completed filesystem-source and underlay roadmap, original feature request,
|
||||||
dependencies explicitly before entering an offline development or validation
|
implementation plan, and resolved remediation record are preserved in Git history
|
||||||
environment:
|
at `b604aa1` under `docs/roadmap/`. Current behavior belongs to the
|
||||||
|
[configuration contract](config.md#layered-loading). Built-in sibling
|
||||||
|
inheritance is now part of the [configuration contract](config.md#sibling-inheritance).
|
||||||
|
The completed request, roadmap, plan, and resolved review findings are preserved
|
||||||
|
in Git history at `83c59ea` under `docs/roadmap/`.
|
||||||
|
|
||||||
|
The completed overlay rename plan and release-workflow simplification record are
|
||||||
|
preserved in Git history at `73ce6e9` under `docs/roadmap/`. Current overlay
|
||||||
|
behavior belongs to the [configuration contract](config.md#selected-overlays),
|
||||||
|
and release operations belong to the [release procedure](release.md).
|
||||||
|
|
||||||
|
The completed ReleaseKit adoption, startup performance request and experiments,
|
||||||
|
benchmark evidence, performance audit, implementation plan, and remediation
|
||||||
|
record are preserved in Git history at `8e91a2b` under `docs/roadmap/`. For example:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git show 8e91a2b:docs/roadmap/startup-benchmark.md
|
||||||
|
```
|
||||||
|
|
||||||
|
Remaining optimization candidates belong to
|
||||||
|
[deferred scope](roadmap/deferred.md#deferred-performance-experiments).
|
||||||
|
|
||||||
|
Install the Go version required by `go.mod` or a compatible newer toolchain.
|
||||||
|
Acquire declared dependencies explicitly before entering an offline
|
||||||
|
development or validation environment:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
go mod download
|
go mod download
|
||||||
@@ -88,8 +137,10 @@ Use focused checks while iterating, with validation proportionate to the change
|
|||||||
under the testing policy. Documentation-only work normally needs the local-link
|
under the testing policy. Documentation-only work normally needs the local-link
|
||||||
check below and whitespace review; behavior-bearing examples and commands also
|
check below and whitespace review; behavior-bearing examples and commands also
|
||||||
need execution. Use `go test -race ./...` for ownership or concurrency changes.
|
need execution. Use `go test -race ./...` for ownership or concurrency changes.
|
||||||
The separate [release checker](release.md#4-validate-the-source-candidate) adds
|
The [release procedure](release.md#4-publish-the-committed-candidate) performs
|
||||||
two-toolchain, module-hygiene, race, and cross-build gates.
|
its selected validation through one `publish` invocation. The everyday checker
|
||||||
|
remains a development gate and is not a separate release prerequisite. CI never
|
||||||
|
gates a release.
|
||||||
|
|
||||||
## Task-to-test map
|
## Task-to-test map
|
||||||
|
|
||||||
@@ -101,14 +152,21 @@ code changes. Use the component overview to find the corresponding implementatio
|
|||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| YAML syntax, diagnostics, parser limits | [Adapter tests](../internal/yaml/parse_test.go), [source translation](../internal/engine/parse_test.go) | `go test ./internal/yaml` and `go test ./internal/engine -run '^TestParseSource'` |
|
| YAML syntax, diagnostics, parser limits | [Adapter tests](../internal/yaml/parse_test.go), [source translation](../internal/engine/parse_test.go) | `go test ./internal/yaml` and `go test ./internal/engine -run '^TestParseSource'` |
|
||||||
| File/reader access, imports, globs, containment | [Sources](../internal/engine/source_test.go), [FIFO](../internal/engine/source_fifo_test.go), [imports](../internal/engine/imports_test.go), [globs](../internal/engine/glob_test.go) | `go test ./internal/engine -run 'Source\|Import\|Glob\|Filesystem\|Nonregular\|RegularFile'` |
|
| File/reader access, imports, globs, containment | [Sources](../internal/engine/source_test.go), [FIFO](../internal/engine/source_fifo_test.go), [imports](../internal/engine/imports_test.go), [globs](../internal/engine/glob_test.go) | `go test ./internal/engine -run 'Source\|Import\|Glob\|Filesystem\|Nonregular\|RegularFile'` |
|
||||||
| Composition, profiles, CLI precedence | [Composition](../internal/engine/compose_test.go), [overlay](../internal/engine/overlay_test.go), [profiles](../internal/engine/profile_test.go), [overrides](../internal/engine/override_test.go) | `go test ./internal/engine -run 'Compose\|Overlay\|Profile\|Override'` |
|
| Native filesystem and mapping sources | [Native acquisition](../internal/engine/native_filesystem_test.go), [filesystem facade](../facade_filesystem_test.go), [mapping facade](../facade_mapping_test.go) | `go test ./internal/engine -run 'NativeFilesystem'` and `go test . -run 'TestFacade'` |
|
||||||
|
| Composition, selected overlays, CLI precedence | [Composition](../internal/engine/compose_test.go), [overlay](../internal/engine/overlay_test.go), [selected overlays](../internal/engine/selected_overlay_test.go), [overrides](../internal/engine/override_test.go) | `go test ./internal/engine -run 'Compose\|Overlay\|Override'` |
|
||||||
|
| Sibling inheritance, provenance, history, sensitivity | [Expansion](../internal/engine/inheritance_test.go), [destination scopes](../internal/engine/inheritance_walk_test.go), [origins](../internal/engine/inheritance_origin_test.go), [history](../internal/engine/inheritance_history_test.go), [secrets](../internal/engine/inheritance_secret_test.go), [public loading](../facade_inheritance_test.go) | `go test ./internal/engine -run 'Inheritance\|Inherited'` and `go test . -run '^TestFacadeInheritance\|^TestFacadeInheritedSecrets'` |
|
||||||
|
| Layered loading and source equivalence | [Grouped lifecycle](../internal/engine/load_request_test.go), [layered facade](../facade_layered_test.go), [equivalence](../facade_equivalence_test.go) | `go test ./internal/engine -run '^TestGrouped'`, `go test . -run '^TestFacadeLayered'`, and `go test . -run '^TestEquivalentSourceForms'` |
|
||||||
| Schema, defaults, projection, cloning | [Schema](../internal/engine/schema_test.go), [decoding](../internal/engine/decode_test.go), [projection](../internal/engine/projection_test.go) | `go test ./internal/engine -run 'Schema\|Decode\|Projection\|Clone\|Inline\|CompareDocument'` |
|
| Schema, defaults, projection, cloning | [Schema](../internal/engine/schema_test.go), [decoding](../internal/engine/decode_test.go), [projection](../internal/engine/projection_test.go) | `go test ./internal/engine -run 'Schema\|Decode\|Projection\|Clone\|Inline\|CompareDocument'` |
|
||||||
| Lifecycle, resolution, validation, callback ownership | [Loading](../internal/engine/load_test.go), [resolution](../internal/engine/resolution_test.go), [validation](../internal/engine/validation_test.go), [ownership](../internal/engine/callback_ownership_test.go), [independence](../internal/engine/independence_test.go) | `go test ./internal/engine -run 'Load\|Resolution\|Validation\|Validator\|Hook\|Callback\|Parallel'` |
|
| Lifecycle, resolution, validation, callback ownership | [Loading](../internal/engine/load_test.go), [resolution](../internal/engine/resolution_test.go), [validation](../internal/engine/validation_test.go), [ownership](../internal/engine/callback_ownership_test.go), [independence](../internal/engine/independence_test.go) | `go test ./internal/engine -run 'Load\|Resolution\|Validation\|Validator\|Hook\|Callback\|Parallel'` |
|
||||||
| Paths, metadata, provenance | [Paths](../internal/engine/path_test.go), [metadata](../internal/engine/metadata_test.go), [provenance](../internal/engine/provenance_test.go) | `go test ./internal/engine -run 'Path\|Metadata\|Provenance\|Queries'` |
|
| Paths, metadata, provenance | [Paths](../internal/engine/path_test.go), [metadata](../internal/engine/metadata_test.go), [provenance](../internal/engine/provenance_test.go) | `go test ./internal/engine -run 'Path\|Metadata\|Provenance\|Queries'` |
|
||||||
|
| Passive resource contexts | [Engine contexts](../internal/engine/resource_context_test.go), [public contexts](../facade_resource_context_test.go) | `go test ./internal/engine -run 'Resource'` and `go test . -run 'SourceContext'` |
|
||||||
| Secrets, bootstrap, redaction, explanation | [References](../internal/engine/secret_reference_test.go), [bootstrap](../internal/engine/secrets_test.go), [rendering](../internal/engine/render_test.go), [explanation](../internal/engine/explain_test.go) | `go test ./internal/engine -run 'Secret\|Bootstrap\|Effective\|Explain\|Explanation\|History\|Sensitivity'` |
|
| Secrets, bootstrap, redaction, explanation | [References](../internal/engine/secret_reference_test.go), [bootstrap](../internal/engine/secrets_test.go), [rendering](../internal/engine/render_test.go), [explanation](../internal/engine/explain_test.go) | `go test ./internal/engine -run 'Secret\|Bootstrap\|Effective\|Explain\|Explanation\|History\|Sensitivity'` |
|
||||||
| Consumer examples and migration fixtures | [Consumer tests](../examples/consumers/consumers_test.go), [API examples](../example_test.go) | `go test ./examples/consumers` and `go test . -run '^Example'` |
|
| Consumer examples and migration fixtures | [Consumer tests](../examples/consumers/consumers_test.go), [native and layered examples](../examples/consumers/layered_test.go), [API examples](../example_test.go) | `go test ./examples/consumers` and `go test . -run '^Example'` |
|
||||||
|
| Assembly and layered scaling evidence | [Assembly benchmarks](../internal/engine/assembly_bench_test.go), [layered benchmarks](../internal/engine/underlay_bench_test.go) | `go test ./internal/engine -run '^$' -bench '^BenchmarkUnderlay' -benchmem`; repeat with `^BenchmarkCompose` and `^BenchmarkOverlay` |
|
||||||
|
| Inheritance scaling evidence | [Expansion benchmarks](../internal/engine/inheritance_bench_test.go) | `go test ./internal/engine -run '^$' -bench '^BenchmarkInheritance' -benchmem` |
|
||||||
| Documentation links and dependency isolation | [Link checks](../documentation_test.go), [import boundary](../import_boundary_test.go), [public boundary](../public_boundary_test.go) | `go test . -run 'TestLocalDocumentationLinks\|TestDependencyImportBoundary\|TestPublicFacadeBoundary'` |
|
| Documentation links and dependency isolation | [Link checks](../documentation_test.go), [import boundary](../import_boundary_test.go), [public boundary](../public_boundary_test.go) | `go test . -run 'TestLocalDocumentationLinks\|TestDependencyImportBoundary\|TestPublicFacadeBoundary'` |
|
||||||
| Check-command behavior | [Shell regression](../release_check_test.go) | `go test . -run '^TestCheckScripts'` |
|
| Development check behavior | [Development checker test](../development_check_test.go) | `go test . -run '^TestDevelopmentCheckHandlesFilenamesAndStopsOnFailure$'` |
|
||||||
|
| Release profile wiring | [Release profile test](../releasekit_profile_test.go) | `go test . -run '^TestReleaseKitProfile$'` |
|
||||||
|
|
||||||
## Fuzz validation
|
## Fuzz validation
|
||||||
|
|
||||||
|
|||||||
@@ -137,9 +137,11 @@ permission failures, explicit `conf.d` use, and entry/candidate budgets. This wo
|
|||||||
has no Narratio production equivalent; it uses the selected standard-library
|
has no Narratio production equivalent; it uses the selected standard-library
|
||||||
`path.Match` and bounded `File.ReadDir` adaptation rather than its flat loader.
|
`path.Match` and bounded `File.ReadDir` adaptation rather than its flat loader.
|
||||||
|
|
||||||
### Profiles and overlay
|
### Upstream profiles and ConfigKit selected overlays
|
||||||
|
|
||||||
Assigned to selected-profile overlay:
|
The following upstream symbols and case names retain their original profile
|
||||||
|
terminology. ConfigKit adapts their selected-overlay behavior without renaming the
|
||||||
|
upstream evidence:
|
||||||
|
|
||||||
- Production: `mergeOverlayComposition`, `mergeOverlayNodes`,
|
- Production: `mergeOverlayComposition`, `mergeOverlayNodes`,
|
||||||
`selectPipelineProfile`, `loadPipelineProfileOverlays`, and
|
`selectPipelineProfile`, `loadPipelineProfileOverlays`, and
|
||||||
@@ -153,19 +155,21 @@ Assigned to selected-profile overlay:
|
|||||||
`TestLoadPipelineProfilePairResolvesIndependentEffectivePipelines`.
|
`TestLoadPipelineProfilePairResolvesIndependentEffectivePipelines`.
|
||||||
- Preserve: recursive mapping overlay, atomic scalar/sequence replacement,
|
- Preserve: recursive mapping overlay, atomic scalar/sequence replacement,
|
||||||
deterministic selection failures, source ownership, and independent results.
|
deterministic selection failures, source ownership, and independent results.
|
||||||
- Adapt: load only the selected fixed profile path; lowercase `default` means no
|
- Adapt: load only the selected fixed overlay path; lowercase `default` means no
|
||||||
overlay. ConfigKit permits null and cross-kind replacement and does not support
|
selection. ConfigKit permits null and cross-kind replacement and does not support
|
||||||
declared defaults, inheritance, arbitrary profile paths, or validating every
|
declared defaults, inheritance, arbitrary overlay paths, or validating every
|
||||||
unselected overlay.
|
unselected overlay.
|
||||||
|
|
||||||
Implementation record (2026-09-06): `overlayDocuments`, `mergeOverlayMappings`,
|
Implementation record (2026-09-06, updated 2026-09-23): `overlayDocuments`,
|
||||||
`loadProfileDocument`, and `profileDirectiveDiagnostics` adapt the assigned merge,
|
`mergeOverlayMappings`, `loadSelectedOverlayDocument`, and
|
||||||
selection, loading, and ownership mechanics. `TestOverlayDocumentsRecursesMappingsAndReplacesAtomicSubtrees`,
|
`overlayDirectiveDiagnostics` adapt the assigned merge, selection, loading, and
|
||||||
`TestLoadAppliesSelectedProfileAfterBaseAndBeforeDefaults`, profile selection/error,
|
ownership mechanics. `TestOverlayDocumentsRecursesMappingsAndReplacesAtomicSubtrees`,
|
||||||
directive/version, containment, and budget cases adapt the assigned tests. ConfigKit
|
`TestLoadAppliesSelectedOverlayAfterBaseAndBeforeDefaults`, selected-overlay
|
||||||
|
selection/error, directive/version, containment, and budget cases adapt the assigned
|
||||||
|
tests. ConfigKit
|
||||||
uses exactly one fixed selected `.yml` source, permits null and cross-kind replacement,
|
uses exactly one fixed selected `.yml` source, permits null and cross-kind replacement,
|
||||||
retains displaced descendant history, rejects any profile directive or version-path
|
retains displaced descendant history, rejects any overlay directive or version-path
|
||||||
contribution, and counts the profile in aggregate budgets. Narratio's declared
|
contribution, and counts the overlay in aggregate budgets. Narratio's declared
|
||||||
default, multi-overlay validation, inheritance-like application conventions, and
|
default, multi-overlay validation, inheritance-like application conventions, and
|
||||||
null/kind restrictions were not retained.
|
null/kind restrictions were not retained.
|
||||||
|
|
||||||
@@ -196,7 +200,7 @@ previously extracted source claims, overlay displacement records, typed baseline
|
|||||||
and audited resolution snapshots in `load_metadata.go`. The representative
|
and audited resolution snapshots in `load_metadata.go`. The representative
|
||||||
`TestLayeredProvenanceAgreesWithResolvedSnapshot` adapts Narratio's stable ownership,
|
`TestLayeredProvenanceAgreesWithResolvedSnapshot` adapts Narratio's stable ownership,
|
||||||
profile ownership, deterministic effective projection, and side-effect-free
|
profile ownership, deterministic effective projection, and side-effect-free
|
||||||
inspection cases across one default/import/profile/resolution workflow. ConfigKit
|
inspection cases across one default/import/overlay/resolution workflow. ConfigKit
|
||||||
adds chronological descendant history for parent and whole-sequence operations,
|
adds chronological descendant history for parent and whole-sequence operations,
|
||||||
composite empty-mapping origins, canonical resolution reasons/dependencies, private
|
composite empty-mapping origins, canonical resolution reasons/dependencies, private
|
||||||
snapshot agreement, defensive nested copies, and concurrent load isolation. Value
|
snapshot agreement, defensive nested copies, and concurrent load isolation. Value
|
||||||
|
|||||||
@@ -7,23 +7,28 @@ private state; public signatures and fields do not expose engine types.
|
|||||||
|
|
||||||
Implemented component owners:
|
Implemented component owners:
|
||||||
|
|
||||||
- `internal/engine` owns source acquisition, composition, schema inspection,
|
- `internal/engine` owns host and native-filesystem source acquisition,
|
||||||
decoding, lifecycle coordination, callback auditing, provenance/history,
|
grouped strict composition, recursive precedence assembly, and destination-local
|
||||||
secret resolution and bootstrap, and safe inspection rendering. It never
|
sibling inheritance before typed decoding. It also owns schema
|
||||||
imports the root package.
|
inspection, lifecycle coordination, callback auditing,
|
||||||
- Root `Source`, `Path`, `Secret`, records, lifecycle callbacks, results, and
|
provenance/history, passive source-context retention, secret resolution and
|
||||||
bootstrap reports are root-defined wrappers or records. Callback wrappers pass
|
bootstrap, and safe inspection rendering. It never imports the root package.
|
||||||
only live engine context during a callback; `Result.Config` is detached and its
|
- Root `Source`, `Filesystem`, `Input`, `Underlay`, `Path`, `Secret`, records,
|
||||||
private inspection remains frozen independently.
|
lifecycle callbacks, results, and bootstrap reports are root-defined wrappers
|
||||||
|
or records. Callback wrappers pass only live engine context during a callback;
|
||||||
|
`Result.Config` is detached and its private inspection remains frozen
|
||||||
|
independently.
|
||||||
- Root conversion files explicitly cross the path, record, callback, secret, and
|
- Root conversion files explicitly cross the path, record, callback, secret, and
|
||||||
error boundaries. There are no public aliases, anonymous engine embeddings, or
|
error boundaries. There are no public aliases, anonymous engine embeddings, or
|
||||||
public engine bridge methods.
|
public engine bridge methods.
|
||||||
- `internal/document` owns the parser-independent ordered tree and cloning.
|
- `internal/document` owns the parser-independent ordered tree and cloning.
|
||||||
`internal/yaml` is the sole upstream YAML adapter and parser/dumper boundary.
|
`internal/yaml` is the sole upstream YAML adapter and parser/dumper boundary.
|
||||||
- Engine mechanism tests own source, composition, decoding, callback, provenance,
|
- Engine mechanism tests own source, composition, inheritance, decoding,
|
||||||
secret, history, rendering, and bootstrap behavior. Root tests own public API
|
callback, provenance,
|
||||||
compatibility, facade integration, documentation links, and dependency/public
|
source-context, secret, history, rendering, and bootstrap behavior. Root tests
|
||||||
boundary checks. Consumer examples remain under `examples/consumers`.
|
own public API compatibility, facade integration, documentation links, and
|
||||||
|
dependency/public boundary checks. Consumer examples remain under
|
||||||
|
`examples/consumers`.
|
||||||
|
|
||||||
Dependency direction is root to engine to document/YAML support. The root may
|
Dependency direction is root to engine to document/YAML support. The root may
|
||||||
import only `internal/engine` among project internal production packages; engine
|
import only `internal/engine` among project internal production packages; engine
|
||||||
@@ -36,4 +41,6 @@ semantics. The [consumer adoption guide](../consumers/README.md) owns applicatio
|
|||||||
guidance. The [architecture policy](../policy/architecture.md) owns contributor
|
guidance. The [architecture policy](../policy/architecture.md) owns contributor
|
||||||
boundaries, and [ADR 0006](../adr/0006-public-facade.md) records the facade
|
boundaries, and [ADR 0006](../adr/0006-public-facade.md) records the facade
|
||||||
decision. See the [development guide](../development.md) for validation commands
|
decision. See the [development guide](../development.md) for validation commands
|
||||||
and [release procedure](../release.md) for source-candidate gates.
|
and [release procedure](../release.md) for source-candidate gates. [ADR
|
||||||
|
0009](../adr/0009-sibling-inheritance.md) records why inheritance is a built-in
|
||||||
|
post-assembly structural operation.
|
||||||
|
|||||||
43
docs/oss/attribution.md
Normal file
43
docs/oss/attribution.md
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
# Open Source Attribution Notices
|
||||||
|
|
||||||
|
## Standard Repository Policies
|
||||||
|
|
||||||
|
Material: `docs/policy/release.md`, adapted from
|
||||||
|
`e833faddf120c789a9b45348edaf75720de16348`; `docs/policy/meta.md`, `docs/policy/oss.md`,
|
||||||
|
`docs/policy/documentation.md`, `docs/policy/agents.md`,
|
||||||
|
`docs/policy/architecture.md`, `docs/policy/testing.md`; root `AGENTS.md`; and the
|
||||||
|
Policy Reading Guide in `docs/development.md`, adapted from
|
||||||
|
`d84a38ebab26f048cafbe59a2246700c35d29843` for this repository.
|
||||||
|
|
||||||
|
Copyright (C) 2026 Eric Rakestraw
|
||||||
|
|
||||||
|
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||||
|
|
||||||
|
License and notices: [CC BY-SA 4.0](licenses/CC-BY-SA-4.0.txt) |
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/COPYRIGHT) |
|
||||||
|
[LICENSE](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/LICENSE) |
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/policy/src/commit/e833faddf120c789a9b45348edaf75720de16348/COPYRIGHT) |
|
||||||
|
[LICENSE](https://gitea.maximumdirect.net/eric/policy/src/commit/e833faddf120c789a9b45348edaf75720de16348/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843).
|
||||||
|
|
||||||
|
[Source](https://gitea.maximumdirect.net/eric/policy/src/commit/e833faddf120c789a9b45348edaf75720de16348).
|
||||||
|
|
||||||
|
## go-yaml v4
|
||||||
|
|
||||||
|
Selected module: `go.yaml.in/yaml/v4` at `v4.0.0-rc.6`.
|
||||||
|
|
||||||
|
Copyright 2011-2019 Canonical Ltd
|
||||||
|
|
||||||
|
Copyright 2025 The go-yaml Project Contributors
|
||||||
|
|
||||||
|
Copyright 2006-2010 Kirill Simonov
|
||||||
|
|
||||||
|
SPDX-License-Identifier: Apache-2.0 AND MIT
|
||||||
|
|
||||||
|
License and notices: [Apache 2.0](licenses/Apache-2.0.txt) |
|
||||||
|
[MIT](licenses/MIT.txt) |
|
||||||
|
[NOTICE](https://github.com/yaml/go-yaml/blob/1c17b9cee72bf81ae73a8be50fbd7dd3a9985125/NOTICE) |
|
||||||
|
[LICENSE](https://github.com/yaml/go-yaml/blob/1c17b9cee72bf81ae73a8be50fbd7dd3a9985125/LICENSE).
|
||||||
|
|
||||||
|
[Source](https://github.com/yaml/go-yaml/tree/1c17b9cee72bf81ae73a8be50fbd7dd3a9985125).
|
||||||
202
docs/oss/licenses/Apache-2.0.txt
Normal file
202
docs/oss/licenses/Apache-2.0.txt
Normal file
@@ -0,0 +1,202 @@
|
|||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
170
docs/oss/licenses/CC-BY-SA-4.0.txt
Normal file
170
docs/oss/licenses/CC-BY-SA-4.0.txt
Normal file
@@ -0,0 +1,170 @@
|
|||||||
|
Creative Commons Attribution-ShareAlike 4.0 International
|
||||||
|
|
||||||
|
Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
|
||||||
|
|
||||||
|
Using Creative Commons Public Licenses
|
||||||
|
|
||||||
|
Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
|
||||||
|
|
||||||
|
Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors.
|
||||||
|
|
||||||
|
Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described.
|
||||||
|
|
||||||
|
Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public.
|
||||||
|
|
||||||
|
Creative Commons Attribution-ShareAlike 4.0 International Public License
|
||||||
|
|
||||||
|
By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
|
||||||
|
|
||||||
|
Section 1 – Definitions.
|
||||||
|
|
||||||
|
a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
|
||||||
|
|
||||||
|
b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
c. BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License.
|
||||||
|
|
||||||
|
d. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
|
||||||
|
|
||||||
|
e. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
|
||||||
|
|
||||||
|
f. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
|
||||||
|
|
||||||
|
g. License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike.
|
||||||
|
|
||||||
|
h. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
|
||||||
|
|
||||||
|
i. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
|
||||||
|
|
||||||
|
j. Licensor means the individual(s) or entity(ies) granting rights under this Public License.
|
||||||
|
|
||||||
|
k. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
|
||||||
|
|
||||||
|
l. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
|
||||||
|
|
||||||
|
m. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
|
||||||
|
|
||||||
|
Section 2 – Scope.
|
||||||
|
|
||||||
|
a. License grant.
|
||||||
|
|
||||||
|
1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
|
||||||
|
|
||||||
|
A. reproduce and Share the Licensed Material, in whole or in part; and
|
||||||
|
|
||||||
|
B. produce, reproduce, and Share Adapted Material.
|
||||||
|
|
||||||
|
2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
|
||||||
|
|
||||||
|
3. Term. The term of this Public License is specified in Section 6(a).
|
||||||
|
|
||||||
|
4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
|
||||||
|
|
||||||
|
5. Downstream recipients.
|
||||||
|
|
||||||
|
A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
B. Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply.
|
||||||
|
|
||||||
|
C. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
|
||||||
|
|
||||||
|
6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
|
||||||
|
|
||||||
|
b. Other rights.
|
||||||
|
|
||||||
|
1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
|
||||||
|
|
||||||
|
2. Patent and trademark rights are not licensed under this Public License.
|
||||||
|
|
||||||
|
3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
|
||||||
|
|
||||||
|
Section 3 – License Conditions.
|
||||||
|
|
||||||
|
Your exercise of the Licensed Rights is expressly made subject to the following conditions.
|
||||||
|
|
||||||
|
a. Attribution.
|
||||||
|
|
||||||
|
1. If You Share the Licensed Material (including in modified form), You must:
|
||||||
|
|
||||||
|
A. retain the following if it is supplied by the Licensor with the Licensed Material:
|
||||||
|
|
||||||
|
i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
|
||||||
|
|
||||||
|
ii. a copyright notice;
|
||||||
|
|
||||||
|
iii. a notice that refers to this Public License;
|
||||||
|
|
||||||
|
iv. a notice that refers to the disclaimer of warranties;
|
||||||
|
|
||||||
|
v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
|
||||||
|
|
||||||
|
B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
|
||||||
|
|
||||||
|
C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
|
||||||
|
|
||||||
|
2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
|
||||||
|
|
||||||
|
3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
|
||||||
|
|
||||||
|
b. ShareAlike.In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply.
|
||||||
|
|
||||||
|
1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License.
|
||||||
|
|
||||||
|
2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.
|
||||||
|
|
||||||
|
3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply.
|
||||||
|
|
||||||
|
Section 4 – Sui Generis Database Rights.
|
||||||
|
|
||||||
|
Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
|
||||||
|
|
||||||
|
a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
|
||||||
|
|
||||||
|
b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and
|
||||||
|
|
||||||
|
c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
|
||||||
|
For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
|
||||||
|
|
||||||
|
Section 5 – Disclaimer of Warranties and Limitation of Liability.
|
||||||
|
|
||||||
|
a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
|
||||||
|
|
||||||
|
b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
|
||||||
|
|
||||||
|
c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
|
||||||
|
|
||||||
|
Section 6 – Term and Termination.
|
||||||
|
|
||||||
|
a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
|
||||||
|
|
||||||
|
b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
|
||||||
|
|
||||||
|
1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
|
||||||
|
|
||||||
|
2. upon express reinstatement by the Licensor.
|
||||||
|
|
||||||
|
c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
|
||||||
|
|
||||||
|
d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
|
||||||
|
|
||||||
|
e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
|
||||||
|
|
||||||
|
Section 7 – Other Terms and Conditions.
|
||||||
|
|
||||||
|
a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
|
||||||
|
|
||||||
|
b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
Section 8 – Interpretation.
|
||||||
|
|
||||||
|
a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
|
||||||
|
|
||||||
|
b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
|
||||||
|
|
||||||
|
c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
|
||||||
|
|
||||||
|
d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
|
||||||
|
|
||||||
|
Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.
|
||||||
|
|
||||||
|
Creative Commons may be contacted at creativecommons.org.
|
||||||
18
docs/oss/licenses/MIT.txt
Normal file
18
docs/oss/licenses/MIT.txt
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) <year> <copyright holders>
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
|
||||||
|
associated documentation files (the "Software"), to deal in the Software without restriction, including
|
||||||
|
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
|
||||||
|
following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all copies or substantial
|
||||||
|
portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
|
||||||
|
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
|
||||||
|
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||||
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
|
||||||
|
USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
91
docs/policy/agents.md
Normal file
91
docs/policy/agents.md
Normal file
@@ -0,0 +1,91 @@
|
|||||||
|
# Agent Policy
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.3
|
||||||
|
|
||||||
|
**Last Updated**: 2026-09-28
|
||||||
|
|
||||||
|
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/agents.md)
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Agents must read and follow these rules.
|
||||||
|
|
||||||
|
## Implementation Discipline
|
||||||
|
|
||||||
|
**KEY PRINCIPLES:** Write the simplest idiomatic code that satisfies the user's
|
||||||
|
request. Do not implicitly strengthen requirements, restrictions, or guarantees
|
||||||
|
beyond what the user actually requested.
|
||||||
|
|
||||||
|
**Keep implementation machinery proportionate.** Use straightforward,
|
||||||
|
idiomatic code and introduce only the machinery needed to support the requested
|
||||||
|
behavior and flexibility. Optimize for conceptual simplicity and
|
||||||
|
maintainability, not for the fewest lines, fewest options, or narrowest product
|
||||||
|
surface.
|
||||||
|
|
||||||
|
**Do not invent restrictions.** Do not reject, prohibit, constrain, cap,
|
||||||
|
harden, or otherwise narrow behavior unless required by the user, an explicit
|
||||||
|
repository contract, or an unavoidable correctness constraint. Preserve
|
||||||
|
operator and caller choice where policy has not been established. If an
|
||||||
|
additional restriction appears advisable, present it as a decision rather than
|
||||||
|
silently implementing it.
|
||||||
|
|
||||||
|
A correctness constraint must follow from the requested behavior or an
|
||||||
|
established invariant, not from the convenience of the chosen implementation.
|
||||||
|
Explain the specific failure it prevents and why a less restrictive
|
||||||
|
implementation cannot satisfy the contract.
|
||||||
|
|
||||||
|
**Do not invent guarantees.** Do not strengthen public contracts, guarantees,
|
||||||
|
or invariants beyond those expressly requested by the user.
|
||||||
|
|
||||||
|
**Use the standard library.** For example: in almost every case, the best
|
||||||
|
approach to copying files is to use the standard library. Writing custom code to
|
||||||
|
implement power-loss protection at the application level, or to guard against
|
||||||
|
bad actors with privileged and concurrent access to the host's filesystem,
|
||||||
|
is wasteful, unnecessary, and not idiomatic. Stick to the simple, standard, and
|
||||||
|
idiomatic approach unless another path is expressly requested by the user.
|
||||||
|
|
||||||
|
**An implementation detail is not repository policy.** Tests and documentation
|
||||||
|
must not elevate incidental behavior into a durable guarantee or restriction
|
||||||
|
unless that behavior was expressly selected as part of the contract. Existing
|
||||||
|
explicit contracts remain authoritative; changing or weakening one requires a
|
||||||
|
deliberate decision rather than being inferred from this principle.
|
||||||
|
|
||||||
|
Agent-authored plans, tests, documentation, and prior implementations are not
|
||||||
|
evidence that an additional restriction was deliberately approved. Identify the
|
||||||
|
authorizing requirement or decision; when that authority is unclear, surface
|
||||||
|
the ambiguity rather than treating repetition as approval.
|
||||||
|
|
||||||
|
## Git Commit Policy
|
||||||
|
|
||||||
|
By default, commit each completed, nonempty unit of work using a
|
||||||
|
concise, plain-English message describing what changed. This policy is standing
|
||||||
|
authorization to create those local commits; a separate user request is not
|
||||||
|
required. An explicit user instruction to leave work uncommitted takes precedence.
|
||||||
|
|
||||||
|
A unit of work is a focused, reviewable outcome, including its relevant tests and
|
||||||
|
documentation.
|
||||||
|
Complete the appropriate validation before committing. If work is incomplete or
|
||||||
|
validation is blocked, report that state accurately.
|
||||||
|
|
||||||
|
Before committing:
|
||||||
|
|
||||||
|
1. Run `git status --short` and review the relevant diff, including any staged
|
||||||
|
changes. Identify changes that predate the current unit of work.
|
||||||
|
2. Exclude secrets, local environment files, generated junk, and unrelated changes.
|
||||||
|
3. Stage only the files or hunks belonging to the completed unit. Use `git add .`
|
||||||
|
only when every included change belongs to that unit. Preserve unrelated
|
||||||
|
staged and unstaged work.
|
||||||
|
4. Review `git diff --staged` and run appropriate checks for the change. Reuse
|
||||||
|
successful checks for unchanged content.
|
||||||
|
5. Review `git log --oneline -n 10` and use
|
||||||
|
`git commit -m "<concise plain-English commit message>"`.
|
||||||
|
6. Report the commit identifier and any remaining uncommitted work.
|
||||||
|
|
||||||
|
If the unit cannot be safely separated from pre-existing work, leave it uncommitted
|
||||||
|
and explain the overlap rather than silently including that work. If a commit
|
||||||
|
fails, preserve the changes and report the failure; do not bypass hooks.
|
||||||
|
|
||||||
|
Default commit authorization does not authorize pushing, publishing, amending,
|
||||||
|
resetting, reverting, or rewriting history. Those actions require a separate user
|
||||||
|
instruction. Do not use `git commit -a` or `git commit --no-verify` to bypass the
|
||||||
|
staging and validation discipline above.
|
||||||
@@ -1,18 +1,55 @@
|
|||||||
# Architecture Policy
|
# Architecture Policy
|
||||||
|
|
||||||
**Base Policy Version:** 1.0
|
**Base Policy Version:** 1.3
|
||||||
|
|
||||||
**Last Updated:** 2026-09-06
|
**Last Updated**: 2026-09-29
|
||||||
|
|
||||||
## Purpose and applicability
|
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/architecture.md)
|
||||||
|
|
||||||
|
## Purpose And Ownership
|
||||||
|
|
||||||
|
The adopted policy defines the application's purpose and the architectural
|
||||||
|
constraints contributors must follow. It owns system boundaries, responsibility
|
||||||
|
and dependency rules, established invariants, and explicit non-goals.
|
||||||
|
|
||||||
|
Describe the concrete package inventory and implementation mechanics in internal
|
||||||
|
documentation. Link to canonical public contracts for their exact behavior and
|
||||||
|
to ADRs for decision rationale.
|
||||||
|
|
||||||
ConfigKit is an opinionated Go library for consistent YAML configuration loading
|
ConfigKit is an opinionated Go library for consistent YAML configuration loading
|
||||||
and resolution across consuming applications. This policy governs contributions.
|
and resolution across consuming applications. The [component overview](../internal/overview.md)
|
||||||
The [component overview](../internal/overview.md) owns implementation inventory, the
|
owns implementation inventory, the [configuration contract](../config.md) owns
|
||||||
[configuration contract](../config.md) owns implemented behavior, and the
|
implemented behavior, and the [deferred scope](../roadmap/deferred.md) preserves
|
||||||
[deferred scope](../roadmap/deferred.md) preserves deferred scope.
|
deferred scope.
|
||||||
|
|
||||||
## Success criteria
|
## Adopted Constraints And Implemented Structure
|
||||||
|
|
||||||
|
Architectural constraints govern current and future development. Record
|
||||||
|
implemented structure accurately, proposals and implementation status in the
|
||||||
|
roadmap, and significant decisions and rationale in ADRs. Describe a target
|
||||||
|
structure as implemented when its changes land.
|
||||||
|
|
||||||
|
Constraints must reflect deliberately selected requirements and decisions.
|
||||||
|
Do not promote incidental implementation choices into architectural invariants.
|
||||||
|
|
||||||
|
## Success Criteria
|
||||||
|
|
||||||
|
ConfigKit prioritizes a coherent configuration model: consistency and
|
||||||
|
predictability take precedence over flexibility for accommodating individual
|
||||||
|
downstream conventions. Consumers should learn one set of rules, not different
|
||||||
|
combination or presence semantics depending on the source format or consuming
|
||||||
|
application. Distinct operations such as strict composition and intentional
|
||||||
|
overlay express distinct purposes within that model.
|
||||||
|
|
||||||
|
Consumers should be able to load once and receive a complete, validated
|
||||||
|
configuration with inspectable provenance for its final values, including
|
||||||
|
defaults and recorded application-derived values. Configuration and metadata
|
||||||
|
together must distinguish explicit zero, false, empty, and null input from
|
||||||
|
omission; ordinary Go values alone need not encode those distinctions.
|
||||||
|
Application-owned resolution belongs within the recorded loading lifecycle, so
|
||||||
|
consumers need no subsequent generic merging, defaulting, or provenance
|
||||||
|
reconstruction. This does not transfer domain execution or runtime resource
|
||||||
|
management into ConfigKit.
|
||||||
|
|
||||||
1. **Reduce application infrastructure:** Can applications delete substantial
|
1. **Reduce application infrastructure:** Can applications delete substantial
|
||||||
configuration infrastructure while retaining clear ownership of their domain
|
configuration infrastructure while retaining clear ownership of their domain
|
||||||
@@ -21,8 +58,11 @@ The [component overview](../internal/overview.md) owns implementation inventory,
|
|||||||
configuration model, with only the flexibility needed to express genuine
|
configuration model, with only the flexibility needed to express genuine
|
||||||
application requirements?
|
application requirements?
|
||||||
|
|
||||||
Both criteria must hold. ConfigKit should not preserve divergent consumer
|
Both criteria must hold. Minimize consumer loading and processing code subject
|
||||||
conventions merely for compatibility, nor impose restrictions that prevent useful
|
to the consistency, presence, and provenance principles above, rather than
|
||||||
|
trading those principles for consumer-specific shortcuts. ConfigKit should not
|
||||||
|
preserve divergent consumer conventions merely for compatibility, nor impose
|
||||||
|
restrictions that prevent useful
|
||||||
domain information from being expressed. Prefer a canonical representation using
|
domain information from being expressed. Prefer a canonical representation using
|
||||||
existing primitives before adding another mechanism. Extend the model when a
|
existing primitives before adding another mechanism. Extend the model when a
|
||||||
concrete requirement cannot be accommodated cleanly, not simply because a
|
concrete requirement cannot be accommodated cleanly, not simply because a
|
||||||
@@ -51,7 +91,7 @@ boundaries, and keep simple consumers independent of optional composition
|
|||||||
features. The [consumer adoption guide](../consumers/README.md) demonstrates the
|
features. The [consumer adoption guide](../consumers/README.md) demonstrates the
|
||||||
implemented surface against representative simple and complex shapes.
|
implemented surface against representative simple and complex shapes.
|
||||||
|
|
||||||
## Responsibility boundaries
|
## Responsibility Boundaries
|
||||||
|
|
||||||
ConfigKit owns configuration input processing and the coordination of decoding,
|
ConfigKit owns configuration input processing and the coordination of decoding,
|
||||||
resolution, validation, and inspection. Applications own their configuration
|
resolution, validation, and inspection. Applications own their configuration
|
||||||
@@ -68,10 +108,26 @@ must never run implicitly as part of configuration loading.
|
|||||||
Remote data can enter through application-supplied input without introducing a
|
Remote data can enter through application-supplied input without introducing a
|
||||||
network provider into the library.
|
network provider into the library.
|
||||||
|
|
||||||
## Public API and dependency direction
|
## Loading Lifecycle
|
||||||
|
|
||||||
|
Configuration loading is a synchronous, complete-on-return operation. A successful
|
||||||
|
load provides the final configuration and inspection metadata after the configured
|
||||||
|
processing and validation phases complete. A failed load reports diagnostics and
|
||||||
|
returns no usable partial result. The normal application pattern is one load near
|
||||||
|
startup; applications may explicitly initiate additional loads.
|
||||||
|
|
||||||
|
ConfigKit releases its library-owned loading handles before returning and remains
|
||||||
|
inactive until the application explicitly invokes it again. It performs no
|
||||||
|
background watching, refresh, or mutation of published results. Caller-owned
|
||||||
|
resources and application callback effects remain the caller's responsibility.
|
||||||
|
The [configuration contract](../config.md#completion-and-resource-lifetime) owns
|
||||||
|
the precise completion and ownership behavior. The proposed decision record is
|
||||||
|
[ADR 0008](../adr/0008-complete-on-return-loading.md).
|
||||||
|
|
||||||
|
## Public API And Dependency Direction
|
||||||
|
|
||||||
Keep one small, coherent public surface for the supported lifecycle. Simple
|
Keep one small, coherent public surface for the supported lifecycle. Simple
|
||||||
single-document consumers must not need import, profile, or provider machinery.
|
single-document consumers must not need import, overlay, or provider machinery.
|
||||||
Do not expose parser-specific nodes, errors, or extension hooks through the
|
Do not expose parser-specific nodes, errors, or extension hooks through the
|
||||||
public API. Parser integration belongs behind a private boundary, as recorded
|
public API. Parser integration belongs behind a private boundary, as recorded
|
||||||
in [ADR 0002](../adr/0002-own-yaml-semantics.md).
|
in [ADR 0002](../adr/0002-own-yaml-semantics.md).
|
||||||
@@ -94,20 +150,43 @@ Dependencies must preserve those boundaries; package splits and abstractions
|
|||||||
must earn their complexity. Do not impose a full application or hexagonal
|
must earn their complexity. Do not impose a full application or hexagonal
|
||||||
framework on this library.
|
framework on this library.
|
||||||
|
|
||||||
## Configuration integrity
|
## Configuration Integrity
|
||||||
|
|
||||||
Composition and intentional overlay are distinct operations. Composition must
|
Within a configuration tier, independent contributions use strict composition:
|
||||||
not silently become last-wins override through file ordering. The decision and
|
shared mappings combine recursively, while overlapping non-mapping definitions
|
||||||
alternatives are recorded in [ADR 0001](../adr/0001-separate-composition-and-overlay.md).
|
are conflicts, including equal values. Between precedence tiers, intentional
|
||||||
|
overlay combines mappings recursively, retains omitted lower-priority children,
|
||||||
|
and replaces other present values according to the existing overlay rules.
|
||||||
|
Tier precedence is explicit; traversal order within a tier establishes stable
|
||||||
|
reporting, not permission to override. The distinction and its rationale are
|
||||||
|
recorded in [ADR 0001](../adr/0001-separate-composition-and-overlay.md).
|
||||||
|
|
||||||
|
The main document and its imports form a strictly composed tier. Explicit
|
||||||
|
underlay groups compose strictly within each group, then combine recursively
|
||||||
|
from lowest to highest beneath the main tier. Source acquisition kind does not
|
||||||
|
determine its precedence role. Input-specific constraints, including CLI path
|
||||||
|
rules and opt-in version ownership, remain part of the configuration contract. Consistent combination
|
||||||
|
semantics do not require identical acquisition or lifetime behavior from every
|
||||||
|
source kind.
|
||||||
|
|
||||||
|
After source precedence is complete, built-in sibling `extends` relationships
|
||||||
|
resolve structurally in the same parser-independent representation, using the
|
||||||
|
existing recursive overlay rules. This adds neither an acquired source nor a
|
||||||
|
consumer registration mechanism. Enclosing relationships precede nested
|
||||||
|
destination-local resolution; typed defaults, application resolution, and
|
||||||
|
secret lookup retain their existing lifecycle roles. The [configuration
|
||||||
|
contract](../config.md#sibling-inheritance) owns the exact syntax and presence
|
||||||
|
rules, and [ADR 0009](../adr/0009-sibling-inheritance.md) records the rationale.
|
||||||
|
|
||||||
ConfigKit must define supported YAML semantics explicitly rather than inherit
|
ConfigKit must define supported YAML semantics explicitly rather than inherit
|
||||||
parser defaults. Processing order and diagnostics must be deterministic for the
|
parser defaults. Processing order and diagnostics must be deterministic for the
|
||||||
same inputs and options. Invalid input must not produce a successful usable
|
same inputs and options. Invalid input must not produce a successful usable
|
||||||
configuration. Do not run application hooks on invalid typed configuration.
|
configuration. Do not run application hooks on invalid typed configuration.
|
||||||
|
|
||||||
User-controlled precedence is application defaults, composed base, selected
|
User-controlled precedence is application defaults, ordered underlays, composed
|
||||||
profile, then explicitly supplied CLI overrides. Applications own flag parsing;
|
main input, selected overlay, then explicitly supplied CLI overrides.
|
||||||
ConfigKit owns overlay semantics and provenance. Domain resolution follows these
|
Applications own flag parsing; ConfigKit owns overlay semantics and provenance.
|
||||||
|
Domain resolution follows these
|
||||||
inputs and must remain recorded, not become a hidden override channel.
|
inputs and must remain recorded, not become a hidden override channel.
|
||||||
|
|
||||||
Preserve node-based composition until the effective input is ready for typed
|
Preserve node-based composition until the effective input is ready for typed
|
||||||
@@ -122,7 +201,7 @@ See [ADR 0005](../adr/0005-explicit-overrides-and-safe-explanation.md).
|
|||||||
Detailed syntax and operation tables belong to the
|
Detailed syntax and operation tables belong to the
|
||||||
[current configuration contract](../config.md).
|
[current configuration contract](../config.md).
|
||||||
|
|
||||||
## Ownership and confidentiality
|
## Ownership And Confidentiality
|
||||||
|
|
||||||
Returned configuration and metadata must not share mutable state across loads.
|
Returned configuration and metadata must not share mutable state across loads.
|
||||||
ConfigKit must not mutate a result after returning it. Ordinary exported Go
|
ConfigKit must not mutate a result after returning it. Ordinary exported Go
|
||||||
@@ -143,7 +222,7 @@ forwarded blindly when they can include raw input. Do not log configuration
|
|||||||
implicitly. Applications remain responsible for classifying their secrets and
|
implicitly. Applications remain responsible for classifying their secrets and
|
||||||
for safe messages supplied by their hooks.
|
for safe messages supplied by their hooks.
|
||||||
|
|
||||||
## Scope boundaries
|
## Scope Boundaries
|
||||||
|
|
||||||
Do not introduce automatic directory discovery, network providers, arbitrary
|
Do not introduce automatic directory discovery, network providers, arbitrary
|
||||||
merge strategies, additional configuration languages, or application runtime
|
merge strategies, additional configuration languages, or application runtime
|
||||||
|
|||||||
@@ -1,125 +1,176 @@
|
|||||||
# Documentation Policy
|
# Documentation Policy
|
||||||
|
|
||||||
**Base Policy Version:** 1.0
|
**Base Policy Version:** 1.11
|
||||||
|
|
||||||
**Last Updated:** 2026-09-06
|
**Last Updated**: 2026-09-28
|
||||||
|
|
||||||
|
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/documentation.md)
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
Assign each documentation topic one canonical owner so ConfigKit's documentation
|
This policy assigns each documentation topic to one canonical owner. Its goal is
|
||||||
remains accurate and useful to consumers, maintainers, and implementation agents.
|
to keep ConfigKit's documentation accurate, concise, discoverable, and resistant
|
||||||
|
to drift for consumers, maintainers, developers, and coding agents.
|
||||||
|
|
||||||
## Core rules
|
## Core Rules
|
||||||
|
|
||||||
### One canonical owner
|
### One Canonical Owner
|
||||||
|
|
||||||
Each authoritative fact belongs in one owning document or Go declaration's
|
Each authoritative fact belongs in one document. A non-owning document may give
|
||||||
reference documentation. Other documents may summarize and link to that owner;
|
a short, stable summary for orientation, but it must link to the canonical owner
|
||||||
they must not maintain competing definitions of commands, API contracts, YAML
|
for volatile details.
|
||||||
semantics, defaults, paths, diagnostics, or compatibility guarantees.
|
|
||||||
|
|
||||||
### Policies, current behavior, and future work
|
Volatile details include commands, flags, configuration fields and defaults,
|
||||||
|
module keys, schemas, file names, paths, status codes, retry behavior, and
|
||||||
|
runtime guarantees. If readers could reasonably treat a statement as a
|
||||||
|
contract, maintain it only in the owning document.
|
||||||
|
|
||||||
- Policies state currently binding contributor rules, including constraints on
|
### Current And Future Behavior
|
||||||
future implementation. They do not imply that features already exist.
|
|
||||||
- Current API/configuration contracts, consumer guidance, and component
|
|
||||||
documentation describe implemented behavior only, including partial boundaries.
|
|
||||||
- ADRs record accepted decisions and rationale. Acceptance is not evidence of
|
|
||||||
implementation; execution status belongs in roadmaps.
|
|
||||||
- Roadmaps own unimplemented targets, deferred work, and execution status.
|
|
||||||
|
|
||||||
Future implementation plans own their task order, acceptance gates, and progress;
|
Outside `docs/roadmap/`, documentation describes implemented behavior only.
|
||||||
`docs/roadmap/deferred.md` owns deliberate exclusions, not execution instructions.
|
Partial features may be described only to their implemented boundary.
|
||||||
As behavior lands, move its normative definition into the current contract and
|
|
||||||
replace the roadmap definition with a link. Retire completed roadmap material
|
|
||||||
as part of release preparation; ADRs preserve significant decision history.
|
|
||||||
|
|
||||||
### Audience and examples
|
Architectural constraints may govern future changes. Describe current structure
|
||||||
|
from implemented behavior.
|
||||||
|
|
||||||
Consumer documentation explains how to use the library and what consumers own.
|
ADRs may record an accepted architectural decision before implementation. The
|
||||||
Internal documents explain mechanisms and dependencies. Keep implementation
|
roadmap owns implementation status and sequencing until the decision is
|
||||||
mechanics out of consumer guidance unless they affect a meaningful choice.
|
implemented. Current architecture, user, operator, integration, and internal
|
||||||
|
documentation are updated when the behavior lands.
|
||||||
|
|
||||||
Complete copyable artifacts belong in `examples/`; Go API examples may live in
|
`docs/roadmap/deferred.md` owns deliberate exclusions; task-specific plans
|
||||||
executable Go example tests beside the relevant package. Prose should use the
|
own execution order and progress. Completed plans retire during release
|
||||||
smallest useful excerpt and link to the maintained artifact. Examples must be
|
preparation.
|
||||||
secret-free and checked against implemented behavior. Clearly label illustrative
|
|
||||||
future syntax in roadmaps; do not present it as a runnable current example.
|
|
||||||
|
|
||||||
### Security and privacy
|
### Audience And Detail
|
||||||
|
|
||||||
Do not include real credentials, private keys, environment dumps, sensitive input,
|
Write for the document's stated audience and include only the detail needed for
|
||||||
or private infrastructure details unless intentionally public. Document secret
|
its owned topic. Keep user and operator docs focused on using and operating the
|
||||||
handling, not secret values.
|
application. Developer docs should link to user-facing and external contracts
|
||||||
|
for their definitions.
|
||||||
|
|
||||||
## Canonical ownership
|
### Examples
|
||||||
|
|
||||||
| Topic | Owner | Boundary |
|
Complete copyable files belong in `examples/`. Documentation may use the
|
||||||
| --- | --- | --- |
|
smallest illustrative snippet needed to explain its owned topic, but should link
|
||||||
| Product orientation | `README.md` | Current status, purpose, navigation, and a minimal working example |
|
to maintained examples for complete copyable files.
|
||||||
| Contributor entry point | `docs/development.md` | Reading guide and actual baseline validation commands |
|
|
||||||
| Architecture rules | `docs/policy/architecture.md` | Responsibilities, dependency constraints, invariants, and scope boundaries |
|
|
||||||
| Documentation rules | `docs/policy/documentation.md` | Ownership and document lifecycle |
|
|
||||||
| Testing rules | `docs/policy/testing.md` | Risk-based sufficiency, test boundaries, and maintenance principles |
|
|
||||||
| Release rules | `docs/policy/release.md` | Compatibility, integrity, gates, immutability, and exceptions |
|
|
||||||
| Release procedure | `docs/release.md` | Exact maintainer commands, prerequisites, supported targets, and verification |
|
|
||||||
| Exported Go API | Go documentation beside declarations | Symbol contracts, errors, ownership, and lifecycle API behavior |
|
|
||||||
| YAML and resolution semantics | `docs/config.md` | Syntax, composition, precedence, conversion, secret references/bootstrap, and explanation semantics; Go reference docs link here for shared rules |
|
|
||||||
| Consumer walkthroughs | `docs/consumers/`, when useful | Task-oriented usage and consumer responsibilities, not duplicate API reference |
|
|
||||||
| Component inventory | `docs/internal/overview.md` | Implemented components and links to their owners |
|
|
||||||
| Component mechanics | Other `docs/internal/` files, when needed | Detailed implementation behavior and change recipes |
|
|
||||||
| Architectural decisions | `docs/adr/` | Context, decisions, alternatives, consequences, and supersession history |
|
|
||||||
| Deferred scope | `docs/roadmap/deferred.md` | Deliberate exclusions and the conditions for reconsidering them |
|
|
||||||
| Future implementation plans | Task-specific files under `docs/roadmap/` | Unfinished work, task order, acceptance gates, and progress; completed plans retire to Git history |
|
|
||||||
| Historical release notes | `docs/releases/` | Version-specific historical summaries required by release policy |
|
|
||||||
| Complete examples | `examples/` and executable Go examples | Maintained artifacts; prose links instead of duplicating full examples |
|
|
||||||
|
|
||||||
A listed owner is not a requirement to create an empty file before it has useful
|
Executable Go API examples may live beside the relevant package.
|
||||||
content. Create API, consumer, example, and component documents when the corresponding behavior
|
|
||||||
exists and there is useful content to own. Link only to existing files; use plain
|
|
||||||
code paths for planned files. Unvalidated candidate and publication work has the
|
|
||||||
explicit temporary exception recorded in the release policy.
|
|
||||||
|
|
||||||
ConfigKit has no owned HTTP service, application CLI, or runtime operations
|
Examples must be valid, secret-free, and tested where practical. Commands and
|
||||||
interface. Do not create those reference documents for consuming applications.
|
configuration used in documentation should match the application.
|
||||||
|
|
||||||
## Boundary rules
|
### Security And Privacy
|
||||||
|
|
||||||
Architecture owns governing constraints; ADRs explain why; contracts describe
|
Documentation and examples must not contain real credentials, private keys,
|
||||||
implemented semantics; internal documentation explains how. A roadmap may link
|
private environment dumps, sensitive source material, or private infrastructure
|
||||||
to all of them but must not become a second current reference.
|
details unless intentionally public. Document secret-handling mechanisms, not
|
||||||
|
secret values.
|
||||||
|
|
||||||
Release policy owns guarantees; the release procedure owns commands. A release
|
## Canonical Ownership
|
||||||
note cannot redefine a compatibility contract or replace a current-documentation
|
|
||||||
update. The note at an immutable tag is that release's historical record.
|
|
||||||
|
|
||||||
This policy owns what documentation may disclose. Architecture owns security
|
| Topic | Canonical owner | Owned content | Content owned elsewhere |
|
||||||
invariants. Current configuration and Go API contracts own secret-classification
|
| --- | --- | --- | --- |
|
||||||
and rendering behavior when implemented; internal docs own their mechanisms.
|
| Product orientation and minimal example | `README.md` | Purpose, current status, shortest useful Go example, and navigation, including licensing and attribution. | Full Go API and configuration contracts, release procedure, and implementation detail. |
|
||||||
|
| Contributor entry point | `docs/development.md` | Task-oriented reading guide, contributor orientation, baseline validation commands, and canonical links. | Package inventory, architecture rules, subsystem behavior, detailed change recipes. |
|
||||||
|
| Application architecture policy | `docs/policy/architecture.md` | System shape, normative ownership, dependency direction, boundaries, invariants, safety properties, and non-goals. | Concrete package inventory, implementation mechanics, contributor procedures, decision history, future work. |
|
||||||
|
| Policy-set provenance and upstream navigation | `docs/policy/meta.md` | Policy-set origin, local authority, adoption baselines, and upstream adoption and update links. | Task-specific reading triggers, detailed adoption procedures, and formal attribution notices. |
|
||||||
|
| Agent policy | `docs/policy/agents.md` | Proportionate, idiomatic implementation; rules against inventing requirements, restrictions, guarantees, or policy. | Application contracts, architecture, testing policy, and contributor procedures. |
|
||||||
|
| Documentation policy | `docs/policy/documentation.md` | Documentation ownership, audience boundaries, maintenance rules, and ADR/document lifecycle. | Application architecture or product behavior. |
|
||||||
|
| Testing policy | `docs/policy/testing.md` | Test philosophy, risk sufficiency, boundaries, doubles, coverage, regressions, and test maintenance. | Subsystem behavior, application contracts, subsystem-specific test inventories, and implementation plans. |
|
||||||
|
| Release policy | `docs/policy/release.md` | Versioning, compatibility, release integrity and immutability, release documentation, proportionate gates, publication controls, completion, and required versus optional checks. | Repository-specific commands, product installation guidance, CLI version semantics, historical release summaries, and CI implementation detail. |
|
||||||
|
| Open source licensing and attribution policy | `docs/policy/oss.md` | License defaults and author choices, COPYRIGHT and attribution formats, license/notice links, discoverability, maintenance, and concrete exceptions. | Component entries, license texts, release commands, and dependency security review. |
|
||||||
|
| Project copyright and license grant | `COPYRIGHT` | Project identity, copyright holders and years, SPDX expression, code grant, separately licensed document scope, warranty disclaimer, and third-party statement. | Complete license texts and upstream component attribution. |
|
||||||
|
| Project license texts | `LICENSE` | Complete project and incorporated companion license texts, with required project-specific fields. | General licensing policy and upstream component attribution. |
|
||||||
|
| Upstream component attribution | `docs/oss/attribution.md` | House Format entries for dependencies and adapted documents: identity, material scope, copyright, license, notices, and source links. | General policy, exception reasoning, and complete standard license texts. |
|
||||||
|
| Standard license texts | `docs/oss/licenses/` | Complete, verbatim standard license texts shared by applicable entries, including copied documentation. | Project-specific upstream notices, attribution prose, and policy interpretation. |
|
||||||
|
| Repository-specific release procedure | `docs/release.md` | Maintainer prerequisites, candidate preparation, validation and publication commands and automated guards, asynchronous deliverables, delivery status, optional consumer verification, and recovery. | General release requirements, product installation guidance, historical release summaries, and current compatibility contracts. |
|
||||||
|
| Exported Go API | Go documentation beside declarations | Symbol contracts, errors, ownership, and lifecycle behavior. | Shared YAML semantics and complete examples. |
|
||||||
|
| Configuration contract | `docs/config.md` | YAML syntax, composition, precedence, schema, defaults, resolution, validation, secrets, and explanation semantics. | Go symbol contracts, complete examples, and implementation detail. |
|
||||||
|
| Consumer guidance for the public Go API | `docs/consumers/` | Task-oriented public Go API usage, minimal examples, and consumer responsibilities. | Go symbol contracts, configuration semantics, and internal implementation detail. |
|
||||||
|
| Inventory of implemented internal packages | `docs/internal/overview.md` | Implemented packages and components, responsibilities, and links to focused internal docs. | Normative architecture, contributor reading policy, external contracts. |
|
||||||
|
| Behavior and architecture of internal packages | Other files under `docs/internal/` | Implementation flow, collaborators, state transitions, package-local guarantees and failures, and relevant tests. | Global architecture invariants, configuration definitions and defaults, external schemas, operator procedures. |
|
||||||
|
| Architectural decision records | `docs/adr/` | Significant decisions, context, alternatives, rationale, consequences, and supersession history. | Current behavior reference, implementation status, task sequencing. |
|
||||||
|
| Deferred scope | `docs/roadmap/deferred.md` | Deliberate exclusions and conditions for reconsideration. | Task execution and current behavior. |
|
||||||
|
| Future implementation plans | Task-specific files under `docs/roadmap/` | Unfinished work, sequencing, acceptance, and progress; completed plans retire during release preparation. | Implemented behavior and ADR rationale. |
|
||||||
|
| Release-note history | `docs/releases/` | One checked-in summary per source release under the procedure; the note at its immutable tag is the release record. | Current commands, behavior, contracts, and compatibility definitions. |
|
||||||
|
| Complete examples | `examples/` and executable Go examples | Maintained copyable artifacts and Go API examples. | Configuration reference, symbol contracts, and prose explanation. |
|
||||||
|
|
||||||
## Architectural decision records
|
Create supporting documents for existing interfaces and responsibilities when
|
||||||
|
substantive content is available.
|
||||||
|
|
||||||
Use sequential filenames, such as `0001-separate-composition-and-overlay.md`,
|
Do not create empty owners.
|
||||||
and the lightweight Nygard structure: title, status, date, context, decision,
|
|
||||||
alternatives considered, and consequences.
|
|
||||||
|
|
||||||
Accepted decision content is immutable. A changed decision requires a new ADR
|
## Boundary Rules
|
||||||
and a superseded status/link in the old one. Navigation links may be repaired
|
|
||||||
when specification ownership moves without rewriting historical rationale.
|
|
||||||
Rejected architectural alternatives belong in ADRs; deferred or rejected product
|
|
||||||
features belong in roadmaps. Do not create an ADR for every routine choice.
|
|
||||||
|
|
||||||
## Maintenance and verification
|
### Orientation
|
||||||
|
|
||||||
Update the owning current documentation in the same change that implements or
|
Link among orientation, architecture, and internal documents; maintain each
|
||||||
changes behavior. When ownership moves, remove the old definition and preserve
|
package or behavior description in its canonical owner.
|
||||||
useful navigation links.
|
|
||||||
|
### Go API And Configuration
|
||||||
|
|
||||||
|
Go declaration documentation owns exported symbol behavior. The configuration
|
||||||
|
contract owns shared YAML and resolution semantics. Consumer guidance explains
|
||||||
|
tasks and links to those contracts.
|
||||||
|
|
||||||
|
### Releases
|
||||||
|
|
||||||
|
The release policy defines requirements and invariants that every release must
|
||||||
|
satisfy. The repository-specific release procedure defines the commands and
|
||||||
|
workflow maintainers use to satisfy that policy. Release notes record history
|
||||||
|
at immutable tags. Maintain current behavior in its canonical documentation,
|
||||||
|
update it with the corresponding behavior changes, and keep release procedures
|
||||||
|
consistent with adopted policy.
|
||||||
|
|
||||||
|
### Project Licensing And Upstream Attribution
|
||||||
|
|
||||||
|
README and release documents link to the canonical licensing and attribution
|
||||||
|
materials under the [OSS policy](oss.md). The release procedure owns URL
|
||||||
|
construction and publication mechanics.
|
||||||
|
|
||||||
|
### Contracts And Implementation
|
||||||
|
|
||||||
|
Go API and configuration documents define externally observable behavior.
|
||||||
|
Internal documents explain implementation and link to the owning contract.
|
||||||
|
|
||||||
|
### Security Topics
|
||||||
|
|
||||||
|
This policy owns what documentation and examples may contain. Architecture owns
|
||||||
|
application security invariants. The configuration and public API contracts own
|
||||||
|
secret-classification, bootstrap, and rendering behavior. Internal docs own
|
||||||
|
implementation mechanisms only.
|
||||||
|
|
||||||
|
## Architecture Decision Records
|
||||||
|
|
||||||
|
Use sequentially numbered ADR filenames such as
|
||||||
|
`0001-record-architecture-decisions.md`. Follow the lightweight Nygard format:
|
||||||
|
|
||||||
|
1. title;
|
||||||
|
2. status;
|
||||||
|
3. date;
|
||||||
|
4. context;
|
||||||
|
5. decision;
|
||||||
|
6. alternatives considered;
|
||||||
|
7. consequences.
|
||||||
|
|
||||||
|
Treat the decision content of an accepted ADR as immutable. When a decision
|
||||||
|
changes, create a new ADR and update the earlier ADR's status to superseded.
|
||||||
|
Rejected architectural alternatives belong in the ADR; rejected product ideas
|
||||||
|
belong in the roadmap. Routine choices need no ADR.
|
||||||
|
|
||||||
|
## Maintenance
|
||||||
|
|
||||||
|
When behavior changes, update its canonical owner in the same change. If
|
||||||
|
ownership moves, remove the old definition and replace it with a link where
|
||||||
|
navigation remains useful.
|
||||||
|
|
||||||
Before completing documentation work:
|
Before completing documentation work:
|
||||||
|
|
||||||
- verify claims against the implementation or clearly identify future design;
|
- verify affected behavior and examples;
|
||||||
- check changed local links, paths, fragments, examples, and commands;
|
- check commands, flags, fields, defaults, schemas, and paths against their
|
||||||
- preserve the distinction between policy, decisions, target behavior, and status;
|
implementation;
|
||||||
- check canonical ownership and remove stale or duplicate definitions;
|
- keep unimplemented behavior in the roadmap, subject to the ADR exception;
|
||||||
- inspect formatting and whitespace;
|
- remove stale references and validate links;
|
||||||
- ensure no sensitive data was introduced.
|
- confirm that non-owning documents summarize and link rather than redefine;
|
||||||
|
- confirm that no secrets or sensitive private data were added.
|
||||||
|
|||||||
27
docs/policy/meta.md
Normal file
27
docs/policy/meta.md
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
# Policy Set Provenance
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.0
|
||||||
|
|
||||||
|
**Last Updated**: 2026-09-28
|
||||||
|
|
||||||
|
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/meta.md)
|
||||||
|
|
||||||
|
## Origin And Local Authority
|
||||||
|
|
||||||
|
This repository's policy set is adapted from
|
||||||
|
[Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy).
|
||||||
|
The adopted local policies govern work in this repository. Upstream revisions
|
||||||
|
become local policy through deliberate adoption, preserving local decisions.
|
||||||
|
Each policy's `Upstream Source` identifies its adopted baseline.
|
||||||
|
|
||||||
|
## Adoption And Updates
|
||||||
|
|
||||||
|
For policy adoption, upstream revision reviews, and updates, consult the
|
||||||
|
[upstream adoption and update guide](https://gitea.maximumdirect.net/eric/policy/src/branch/main/docs/adoption.md).
|
||||||
|
That guide and the reference example collection are maintained upstream and
|
||||||
|
accessed through links. Keep discovery links pointed at the current upstream
|
||||||
|
project and guide; keep adopted-source and example links pinned to commits.
|
||||||
|
|
||||||
|
The local [developer guide](../development.md) routes tasks to applicable
|
||||||
|
policies. Formal credit and licensing notices for the copied policy material
|
||||||
|
belong in the local [attribution document](../oss/attribution.md).
|
||||||
217
docs/policy/oss.md
Normal file
217
docs/policy/oss.md
Normal file
@@ -0,0 +1,217 @@
|
|||||||
|
# Open Source Licensing And Attribution Policy
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.8
|
||||||
|
|
||||||
|
**Last Updated**: 2026-09-28
|
||||||
|
|
||||||
|
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/oss.md)
|
||||||
|
|
||||||
|
## ConfigKit Applicability
|
||||||
|
|
||||||
|
ConfigKit's selected grant is LGPL-3.0-or-later, recorded in
|
||||||
|
[COPYRIGHT](../../COPYRIGHT), with the complete LGPLv3 and incorporated GPLv3
|
||||||
|
texts in [LICENSE](../../LICENSE). The [release procedure](../release.md)
|
||||||
|
owns source-only Go module publication through Gitea. No separate hosted release
|
||||||
|
object or license asset is required for this channel.
|
||||||
|
|
||||||
|
## Purpose And Scope
|
||||||
|
|
||||||
|
This policy defines project licensing conventions and a repeatable House Format
|
||||||
|
for upstream attribution and license notices. It covers the project's own code
|
||||||
|
and upstream components incorporated into or distributed with the application
|
||||||
|
or library, including relevant transitive dependencies and copied code,
|
||||||
|
documentation, or assets.
|
||||||
|
Determine treatment from the component's terms and actual use.
|
||||||
|
|
||||||
|
Consulting development guidance or using tooling alone does not require an
|
||||||
|
attribution entry. Copying or adapting documentation for inclusion in the
|
||||||
|
repository is different: preserve its applicable attribution and license terms.
|
||||||
|
A material's role as development guidance does not exempt copied documents.
|
||||||
|
Apply any express permissions for attribution-free reuse of example formatting.
|
||||||
|
|
||||||
|
The baseline is a publicly available source repository with releases published
|
||||||
|
alongside it. The format is independent of language, forge, and build system.
|
||||||
|
It does not require attribution for every development tool, establish license
|
||||||
|
compatibility, or resolve every obligation arising from use or distribution.
|
||||||
|
|
||||||
|
## Canonical Locations
|
||||||
|
|
||||||
|
The [documentation policy](documentation.md) assigns ownership:
|
||||||
|
|
||||||
|
- `COPYRIGHT`: project name, copyright statements, SPDX expression, grant,
|
||||||
|
warranty disclaimer, and third-party statement.
|
||||||
|
- `LICENSE` contains the complete, unmodified project license text, including
|
||||||
|
incorporated companion text. Dependency attribution does not relicense the project.
|
||||||
|
- `docs/oss/attribution.md`: canonical component entries.
|
||||||
|
- `docs/oss/licenses/`: complete, verbatim standard and applicable companion texts.
|
||||||
|
|
||||||
|
Use recognizable license filenames, such as `Apache-2.0.txt` or `LGPL-3.0.txt`.
|
||||||
|
A shared standard text may serve multiple entries. Keep explanations outside
|
||||||
|
license texts and preserve distinct versions and exceptions.
|
||||||
|
|
||||||
|
## Upstream Reference Examples
|
||||||
|
|
||||||
|
Use the commit-pinned upstream examples to create actual project notices.
|
||||||
|
Retain their links and keep the example collection upstream; keep applicable
|
||||||
|
license texts locally as specified above. The
|
||||||
|
[standard license-text collection](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/oss/licenses/README.md)
|
||||||
|
identifies the available reference texts.
|
||||||
|
|
||||||
|
## Project Licensing
|
||||||
|
|
||||||
|
Unless the author specifies otherwise, use **GPL version 3 or later**
|
||||||
|
(`GPL-3.0-or-later`) for applications and **LGPL version 3 or later**
|
||||||
|
(`LGPL-3.0-or-later`) for libraries. An author's explicit choice takes precedence:
|
||||||
|
for example, a one-off script may use MIT. Such a choice requires no exception
|
||||||
|
rationale, additional approval, or compensating controls under this policy.
|
||||||
|
|
||||||
|
These defaults guide new license selection. Adopting this policy does not
|
||||||
|
relicense existing code or override third-party terms. Preserve an existing
|
||||||
|
license unless the author deliberately changes it. For mixed-purpose projects,
|
||||||
|
follow the author's selected scope rather than inferring different licenses for
|
||||||
|
individual packages.
|
||||||
|
|
||||||
|
Use the upstream [application COPYRIGHT example](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/examples/licensing/application/COPYRIGHT)
|
||||||
|
or [library COPYRIGHT example](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/examples/licensing/library/COPYRIGHT)
|
||||||
|
to create the project’s root `COPYRIGHT` file.
|
||||||
|
Use verified project names, contribution years, and copyright holders.
|
||||||
|
For another selected license, adapt the grant, SPDX expression, disclaimer, and
|
||||||
|
text references together to reflect the author's selected grant.
|
||||||
|
|
||||||
|
For GPLv3 projects, copy the complete GPLv3 text into `LICENSE`. For LGPLv3
|
||||||
|
projects, place the complete LGPLv3 text followed by the complete GPLv3 text in
|
||||||
|
`LICENSE`; the LGPL incorporates the GPL terms. Keep the texts unmodified and
|
||||||
|
place project-specific statements in `COPYRIGHT`. For the default grants, the
|
||||||
|
grant and SPDX expression in `COPYRIGHT` must expressly identify `or-later`;
|
||||||
|
follow the author’s choice if a different grant is selected.
|
||||||
|
|
||||||
|
For other licenses, provide their complete text and any required project-specific
|
||||||
|
fields; the standard reference collection remains unchanged. Keep `COPYRIGHT`,
|
||||||
|
`LICENSE`, SPDX expressions, and README descriptions consistent with the actual
|
||||||
|
grant. This convention introduces no blanket requirement for per-file headers;
|
||||||
|
preserve notices or add them where the applicable terms require them.
|
||||||
|
|
||||||
|
Identify separately licensed documentation or assets in the project grant, with
|
||||||
|
links to their attribution and license information. An application's default
|
||||||
|
code license does not override the terms of incorporated documentation.
|
||||||
|
|
||||||
|
## Upstream Attribution House Format
|
||||||
|
|
||||||
|
Begin `docs/oss/attribution.md` with `# Open Source Attribution Notices`,
|
||||||
|
followed directly by component entries. These comprise the complete document.
|
||||||
|
|
||||||
|
Each entry presents these five fields in order, with blank lines between them:
|
||||||
|
|
||||||
|
1. **Project name** as a level-two heading. An optional identification paragraph
|
||||||
|
may follow, such as `Selected module: MODULE at VERSION.` with the module and
|
||||||
|
version in backticks. For copied documentation, a concise `Material:` sentence
|
||||||
|
may identify the affected files and whether they were adapted or copied
|
||||||
|
without modification. A factual qualifier such as `(transitive dependency)`
|
||||||
|
is permitted. Limit optional identification prose to factual component and
|
||||||
|
material scope.
|
||||||
|
2. **Upstream copyright statement or statements**, preserving their wording.
|
||||||
|
Put multiple statements in separate paragraphs. Include this field when the
|
||||||
|
selected upstream source supplies an applicable statement; otherwise, omit it.
|
||||||
|
3. **SPDX license identifier or expression**, when applicable, using
|
||||||
|
`SPDX-License-Identifier: EXPRESSION`.
|
||||||
|
4. **License and notice links**, beginning `License and notices:`, separated
|
||||||
|
by ` | `, and ending with a period. Label local standard texts by license
|
||||||
|
name, such as `MIT` or `Apache 2.0`. Label upstream files by their actual
|
||||||
|
filenames, such as `COPYRIGHT`, `LICENSE`, `NOTICE`, or `PATENTS`.
|
||||||
|
5. **Source repository link**, rendered exactly as `[Source](COMMIT_URL).`.
|
||||||
|
|
||||||
|
Use the upstream [attribution example](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/examples/licensing/attribution.md)
|
||||||
|
to create the project’s `docs/oss/attribution.md`.
|
||||||
|
The example illustrates omitted fields and multiple copyrights and licenses.
|
||||||
|
Replace the uppercase placeholders and illustrative URLs with actual component
|
||||||
|
information. Local license links are relative to the destination
|
||||||
|
`docs/oss/attribution.md`; copy the applicable texts into its `licenses/`
|
||||||
|
directory. Do not copy example entries for components the project does not use.
|
||||||
|
|
||||||
|
These are five fields, not a line limit. Omit the SPDX field when no applicable
|
||||||
|
identifier exists; identify nonstandard terms through the linked text. Preserve
|
||||||
|
licensing alternatives and exceptions, and record a selected option when
|
||||||
|
relevant through the factual license identification. Do not invent an identifier
|
||||||
|
or silently resolve an unsettled licensing choice.
|
||||||
|
|
||||||
|
Keep entries factual. Do not add agent-authored explanations of license
|
||||||
|
expressions, file-level license scope, research performed, retained source
|
||||||
|
notices, or compliance conclusions. Avoid filler such as "none is invented
|
||||||
|
here" and embellished link labels such as "upstream LICENSE", "additional
|
||||||
|
patent grant", or "at the imported commit". Preserve actual required upstream
|
||||||
|
content; this rule excludes editorial additions, not required notices. Policy
|
||||||
|
interpretation and exception reasoning belong in the adopted OSS policy or an
|
||||||
|
appropriate decision record, not the attribution document.
|
||||||
|
|
||||||
|
## License Texts And Upstream Links
|
||||||
|
|
||||||
|
Link standard license texts to their local copies. Link project-specific
|
||||||
|
notices to their upstream copies. Every upstream repository or notice link must
|
||||||
|
identify the exact commit corresponding to the
|
||||||
|
imported version, including the selected source revision for copied material.
|
||||||
|
|
||||||
|
Classify material according to its contents. An upstream `LICENSE`,
|
||||||
|
`COPYING`, or similar file may contain project-specific notices or exceptions
|
||||||
|
in addition to standard wording. Link both the local standard text and the
|
||||||
|
commit-specific upstream file when needed. Make companion license texts directly
|
||||||
|
reachable from the entry.
|
||||||
|
|
||||||
|
For project-specific license and attribution material, this policy accepts
|
||||||
|
direct links to the applicable upstream texts as satisfying reproduction,
|
||||||
|
inclusion, or copy requirements. This is the adopted house interpretation.
|
||||||
|
Agents must apply it without adding local-copy requirements or seeking repeated
|
||||||
|
approval solely because a license uses those terms.
|
||||||
|
|
||||||
|
This interpretation concerns notice reproduction. Concrete obligations such as
|
||||||
|
marking modified files or supplying corresponding source receive their own
|
||||||
|
applicable treatment. Preserve required notices already present in incorporated
|
||||||
|
source files; the central attribution entry does not authorize stripping them.
|
||||||
|
|
||||||
|
## Discoverability
|
||||||
|
|
||||||
|
End the project's README with two friendly statements linking to its actual
|
||||||
|
grant in `COPYRIGHT` and the attribution document. ConfigKit's
|
||||||
|
[README](../../README.md) contains the two required statements: one linking to
|
||||||
|
the project grant and one linking to attribution.
|
||||||
|
|
||||||
|
Each new checked-in release document and its hosted download page must end
|
||||||
|
with links whose visible text is `COPYRIGHT | LICENSE | ATTRIBUTION`. Use absolute
|
||||||
|
URLs to those files at the release's immutable tag or corresponding immutable source
|
||||||
|
revision so the links work in both locations. This release navigation is distinct
|
||||||
|
from upstream component links, which must use the imported commit.
|
||||||
|
|
||||||
|
Reuse the checked-in release document as the hosted release body where supported.
|
||||||
|
The release procedure owns concrete URLs and publication mechanics for delivering
|
||||||
|
the links through the selected channel. Do not maintain duplicate notice lists.
|
||||||
|
These conventions do not by themselves require separate downloadable license
|
||||||
|
assets, source bundles, or a different binary package format.
|
||||||
|
|
||||||
|
## Maintenance And Exceptions
|
||||||
|
|
||||||
|
Update project licensing statements together when the author changes the grant
|
||||||
|
or its scope. Update upstream notices in the change that adds, removes, upgrades,
|
||||||
|
copies, or changes the distribution of a relevant component. Check the selected source's license
|
||||||
|
and notices rather than assuming they are unchanged. Update affected entries,
|
||||||
|
commit links, and texts; retain historical versions through Git.
|
||||||
|
|
||||||
|
Check affected statements, faithful standard-text copies, and link destinations
|
||||||
|
as part of ordinary change review. For a future release tag, check intended file
|
||||||
|
paths against the candidate source; the tag need not resolve remotely before
|
||||||
|
publication. Do not add publication-time network checks, CI polling, recurring
|
||||||
|
legal sign-offs, mandatory scanners, or a full software bill of materials merely
|
||||||
|
to implement this policy.
|
||||||
|
|
||||||
|
Use the House Format routinely. Raise an exception only for a concrete obligation
|
||||||
|
or unresolved rights question it does not address, including any arising from a
|
||||||
|
particular distribution channel. Record the issue and selected treatment in the
|
||||||
|
adopted OSS policy or an appropriate decision record. Attribution entries
|
||||||
|
contain the resulting factual identification and required material, without
|
||||||
|
repeating that reasoning. Resolve the issue before the affected use or
|
||||||
|
distribution without reopening settled choices.
|
||||||
|
Common ownership of projects is neither required nor a blanket exception.
|
||||||
|
|
||||||
|
Apply the formatting convention prospectively. Do not rewrite published tags,
|
||||||
|
notes, binaries, or checksums to retrofit it. Address actual omissions deliberately
|
||||||
|
under the applicable terms and the [release correction policy](release.md#immutability-and-correction).
|
||||||
|
Ordinary attribution maintenance and release links are preparation work, not new
|
||||||
|
release approval gates.
|
||||||
@@ -1,41 +1,39 @@
|
|||||||
# Release Policy
|
# Release Policy
|
||||||
|
|
||||||
**Base Policy Version:** 0.1.0
|
**Base Policy Version:** 1.6
|
||||||
|
|
||||||
**Last Updated:** 2026-09-12
|
**Last Updated**: 2026-10-09
|
||||||
|
|
||||||
|
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/e833faddf120c789a9b45348edaf75720de16348/docs/policy/release.md)
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
This policy defines the minimum requirements for selecting, validating,
|
This policy defines a proportionate workflow for validating and publishing an
|
||||||
publishing, verifying, and correcting releases. Its goal is to make every
|
intended source revision under a fresh version. Releases should require little
|
||||||
release intentional, reproducible from an exact source revision, documented
|
routine intervention, avoid repeated work, and preserve published contents.
|
||||||
for consumers, and safe from retrospective replacement.
|
|
||||||
|
|
||||||
The repository-specific commands that implement these requirements belong in
|
Adopt stronger verification or reproducibility requirements through an explicit
|
||||||
`docs/release.md`. Historical release summaries belong in `docs/releases/`.
|
project-specific decision justified by the intended audience and support needs.
|
||||||
Neither document may weaken this policy.
|
|
||||||
|
|
||||||
## ConfigKit applicability
|
The repository-specific commands belong in `docs/release.md`. Historical release
|
||||||
|
summaries belong in `docs/releases/`. The procedure must agree with the adopted
|
||||||
|
policy and link to it rather than introduce additional release requirements.
|
||||||
|
|
||||||
ConfigKit adopts a source-only Go module release model. The source tag and
|
## ConfigKit Applicability
|
||||||
version-matched release note are the declared deliverables. Standalone binaries,
|
|
||||||
container images, and separate binary/package-registry publication are not
|
|
||||||
required. This does not waive source compilation, module hygiene, testing, or
|
|
||||||
consumer-facing module retrieval and build verification.
|
|
||||||
|
|
||||||
The release procedure must define the module path, authoritative remote,
|
ConfigKit publishes a source-only Go module. Its declared deliverables are the
|
||||||
supported Go versions and operating-system/architecture targets, prerequisite
|
immutable annotated source tag and version-matched checked-in release note.
|
||||||
dependency acquisition, and the exact verification commands once established.
|
Standalone binaries, container images, hosted release objects, and separate
|
||||||
The default tests themselves remain deterministic and offline. Additional
|
registry publication are not required. Additional channels require a deliberate
|
||||||
publication channels require documented deliverables and verification before use.
|
update to the policy and procedure.
|
||||||
|
|
||||||
The Go API, documented YAML/resolution semantics, and structured diagnostic
|
The Go API, documented YAML and resolution semantics, and structured diagnostic
|
||||||
contracts all participate in compatibility review. A signature-preserving change
|
contracts participate in compatibility review. A signature-preserving change
|
||||||
can still break consumers. Human diagnostic wording is stable only where a
|
can still break consumers. Human diagnostic wording is stable only where a
|
||||||
contract expressly promises it. Minimum Go version and platform support changes
|
contract expressly promises it. Minimum Go version and platform support
|
||||||
also require an explicit compatibility assessment.
|
changes also require an explicit compatibility assessment.
|
||||||
|
|
||||||
### Platform support
|
### Platform Support
|
||||||
|
|
||||||
Linux is the release-validated platform. macOS has best-effort support: keeping
|
Linux is the release-validated platform. macOS has best-effort support: keeping
|
||||||
it working remains desirable, but neither native macOS validation nor Darwin
|
it working remains desirable, but neither native macOS validation nor Darwin
|
||||||
@@ -44,49 +42,67 @@ does not by itself block a release. Voluntary checks and fixes are welcome; ther
|
|||||||
is no guarantee that each release has been validated on macOS.
|
is no guarantee that each release has been validated on macOS.
|
||||||
|
|
||||||
The [release procedure](../release.md#release-identity-and-support) owns target
|
The [release procedure](../release.md#release-identity-and-support) owns target
|
||||||
architectures and required Linux checks. This support change applies to upcoming
|
architectures and required Linux checks. Historical release notes and their
|
||||||
releases; historical release notes and their validation records remain unchanged.
|
validation records remain unchanged.
|
||||||
The v0.3.0 release note must explain the change in Compatibility, with version
|
|
||||||
selection following this policy's existing compatibility rules.
|
|
||||||
|
|
||||||
## Release Model
|
## Release Model And Completion
|
||||||
|
|
||||||
A release consists of:
|
A source release identifies one exact committed source revision through an
|
||||||
|
immutable version tag and a version-matched, checked-in release note. The
|
||||||
|
primary release branch is `main` unless the adopted policy specifies otherwise.
|
||||||
|
The procedure must name the authoritative publication remote.
|
||||||
|
|
||||||
- one exact source commit reachable from the repository's primary branch;
|
A successful push of the intended tag, with its source commit available on the
|
||||||
- one immutable version tag identifying that commit;
|
authoritative primary branch, completes the release. The source commit may be
|
||||||
- one version-matched, checked-in release note; and
|
pushed before the tag or published together with it through an atomic push.
|
||||||
- every artifact, image, package, registry entry, or other deliverable the
|
The procedure must choose and document the supported approach.
|
||||||
repository declares for that release.
|
|
||||||
|
|
||||||
The repository's primary branch is `main` unless an adopted policy documents
|
ConfigKit uses sequential publication: first push the committed candidate to
|
||||||
an exception. A release candidate must be committed and pushed to that branch
|
authoritative `main`, then invoke ReleaseKit once to validate that candidate and
|
||||||
before its release tag is published.
|
publish its annotated tag. The [release procedure](../release.md) names
|
||||||
|
`origin`; ReleaseKit checks its exact effective push URL before validation and
|
||||||
|
tag publication.
|
||||||
|
|
||||||
The source tag is the authoritative release identity. Published deliverables
|
Release commands must finish at successful publication. They must not wait for
|
||||||
must be traceable to the tagged source and must agree with its version. A
|
or poll CI, require successful CI status, inspect downloadable artifacts, or
|
||||||
repository may publish source only. When it publishes additional deliverables,
|
check consumer installation or Go module availability as completion gates.
|
||||||
its release procedure must enumerate them and define how each is built,
|
A failed or ambiguous push requires resolving the authoritative remote state
|
||||||
identified, published, and verified.
|
before declaring success or retrying; successful pushes do not require a
|
||||||
|
separate remote read-back gate.
|
||||||
|
|
||||||
Release automation may validate or publish a release only when its exact
|
Remote tag read-back and fresh consumer retrieval are optional and non-gating
|
||||||
responsibility is documented. Automation must not silently change the source
|
after successful publication. A failed push receives one bounded check of the
|
||||||
candidate, move a published tag, replace a published deliverable, or repair a
|
authoritative ref; do not poll or blindly retry.
|
||||||
release in place.
|
|
||||||
|
Repositories may publish source only. Additional binaries, images, packages,
|
||||||
|
checksums, or other declared deliverables may be published asynchronously from
|
||||||
|
the tagged source. The procedure must identify those deliverables and the
|
||||||
|
responsibility of their automation. Published deliverables must be traceable
|
||||||
|
to that source and identify the same version.
|
||||||
|
|
||||||
|
ConfigKit currently declares no additional deliverables. Confirmed publication
|
||||||
|
of the intended source tag is the completion point. CI, macOS validation,
|
||||||
|
hosted delivery, and consumer retrieval are outside the release gates.
|
||||||
|
|
||||||
## Versioning And Compatibility
|
## Versioning And Compatibility
|
||||||
|
|
||||||
Stable releases use Semantic Versioning in the form `vMAJOR.MINOR.PATCH`, with
|
Stable releases use Semantic Versioning in the form `vMAJOR.MINOR.PATCH`, with
|
||||||
no leading zeroes. Each version must be unused locally and in every configured
|
no leading zeroes. Prereleases require an explicit adopted policy defining
|
||||||
remote or publication channel before publication begins.
|
their format and use.
|
||||||
|
|
||||||
Unless an adopted policy explicitly supports and defines prereleases,
|
ConfigKit does not support prereleases.
|
||||||
prerelease versions are not permitted.
|
|
||||||
|
The selected version must be unused locally and on the authoritative remote.
|
||||||
|
Do not require queries to every configured remote or publication service.
|
||||||
|
A version known to have already been published must not be reused, even if the
|
||||||
|
normal guards do not inspect that channel. Adding a distribution channel
|
||||||
|
requires a deliberate update to the policy and procedure where needed.
|
||||||
|
|
||||||
For releases at or after `v1.0.0`:
|
For releases at or after `v1.0.0`:
|
||||||
|
|
||||||
- a major release may make intentional incompatible changes;
|
- a major release may make intentional incompatible changes;
|
||||||
- a minor release may add backward-compatible behavior; and
|
- a minor release may add backward-compatible behavior or raise the Go consumer
|
||||||
|
minimum as described below; and
|
||||||
- a patch release may make backward-compatible fixes.
|
- a patch release may make backward-compatible fixes.
|
||||||
|
|
||||||
Before `v1.0.0`, a minor release may change a documented public, operational,
|
Before `v1.0.0`, a minor release may change a documented public, operational,
|
||||||
@@ -94,146 +110,211 @@ configuration, data, integration, or compatibility contract when the release
|
|||||||
note explains the impact and required consumer action. A patch release must
|
note explains the impact and required consumer action. A patch release must
|
||||||
not intentionally break those contracts within its minor line.
|
not intentionally break those contracts within its minor line.
|
||||||
|
|
||||||
A repository with additional compatibility promises must define them in its
|
Additional compatibility promises and deliberate exceptions belong in the
|
||||||
adopted policy or canonical contract documentation. A release note may explain
|
adopted policy or canonical contract documentation. Release notes explain
|
||||||
a compatibility change, but it must not redefine the current compatibility
|
changes; they do not redefine current compatibility contracts.
|
||||||
contract.
|
|
||||||
|
|
||||||
## Release Documentation
|
## Consumer Minimum And Release Toolchain
|
||||||
|
|
||||||
Every release made under this policy must include
|
Distinguish the minimum toolchain supported for consumers from the toolchain
|
||||||
`docs/releases/<version>.md` in the tagged source tree. The filename must use
|
maintainers use to build and validate a release. Record the consumer minimum in
|
||||||
the complete version tag, and the document must begin with a title containing
|
the language's standard metadata and explain its support meaning in canonical
|
||||||
the product name and that exact version.
|
documentation. Define the selected release toolchain and its setup commands in
|
||||||
|
`docs/release.md`. Toolchain selection and upgrade cadence are repository-specific
|
||||||
|
choices.
|
||||||
|
|
||||||
Every new release note must contain these sections:
|
For Go repositories, normally declare the initial stable release of the selected
|
||||||
|
series as the consumer minimum, such as `go 1.26.0`. Use a higher patch minimum
|
||||||
|
when a dependency or an identified correctness fix requires it, and document
|
||||||
|
the reason.
|
||||||
|
|
||||||
```markdown
|
For release-policy purposes, successful build and release validation on the
|
||||||
# <Product> vMAJOR.MINOR.PATCH
|
selected Go patch release are sufficient to presume support across that Go
|
||||||
|
series, subject to the declared consumer minimum and concrete evidence of
|
||||||
|
incompatibility. Investigate specific compatibility concerns as they arise.
|
||||||
|
|
||||||
This release ...
|
Use the selected release toolchain for candidate validation and release builds,
|
||||||
|
including CI jobs performing those tasks. A newer validation patch version alone
|
||||||
|
leaves the consumer minimum unchanged.
|
||||||
|
|
||||||
## Summary
|
A minor release may raise the Go consumer minimum, including from one Go series
|
||||||
|
to the next, both before and after `v1.0.0`. This is an explicit exception to the
|
||||||
|
backward-compatibility requirement for minor releases. Patch releases preserve
|
||||||
|
the consumer minimum. Explain an increase's impact and required consumer action
|
||||||
|
in the release note. Other incompatible changes remain subject to the versioning
|
||||||
|
rules above.
|
||||||
|
|
||||||
## Compatibility
|
### ConfigKit Toolchain Selection
|
||||||
|
|
||||||
## Upgrade
|
For minor and major releases, select the newest stable Go series available in
|
||||||
|
the development environment. For patch releases, retain the series recorded in
|
||||||
|
`go.mod` and its consumer minimum. Use the latest locally available compatible
|
||||||
|
patch in the selected series, with `GOTOOLCHAIN=local`, to build the
|
||||||
|
module-selected ReleaseKit CLI and validate the candidate. The same Go
|
||||||
|
executable builds the tool and runs its validation commands.
|
||||||
|
|
||||||
## Changes
|
## Release Documentation And Preparation
|
||||||
```
|
|
||||||
|
|
||||||
Use an explicit statement such as "No action required" when a section has no
|
Every new release must include `docs/releases/<version>.md` in the tagged
|
||||||
substantive content.
|
source tree. Use the complete version tag as the filename and begin with a
|
||||||
|
title containing the product name and that exact version.
|
||||||
|
|
||||||
Release notes are immutable historical summaries. They should link to current
|
ConfigKit requires the first line `# ConfigKit <version>`. ReleaseKit's
|
||||||
canonical documentation for exact behavior. Every affected canonical document
|
publication guard checks the release-note H1 for the product and version.
|
||||||
must be updated in the same candidate; a release note must not substitute for
|
|
||||||
current documentation or defer required documentation changes.
|
|
||||||
|
|
||||||
## Candidate Preparation And Validation
|
Include a short summary and any relevant compatibility impact or upgrade
|
||||||
|
instructions. Choose sections suited to the release and keep the note
|
||||||
|
proportionate to the change.
|
||||||
|
|
||||||
Each repository must provide one documented release-check command or script
|
Keep exact current contracts in their canonical documents and update affected
|
||||||
that exercises the complete set of automated source-candidate gates. The
|
documentation with the behavior change. Link to those documents from the note
|
||||||
repository-specific procedure must state all additional manual gates.
|
where useful. If annotated tags are used, derive their summary from the
|
||||||
|
checked-in note.
|
||||||
|
|
||||||
The required gates are:
|
ConfigKit uses the complete checked-in note as the annotated tag message.
|
||||||
|
|
||||||
- dependency or module hygiene appropriate to the language and ecosystem;
|
Include the release footer defined by the [OSS policy](oss.md#discoverability)
|
||||||
- the complete deterministic, offline default test suite;
|
in each new release document. The release procedure defines the concrete URLs
|
||||||
- race, concurrency, or equivalent safety checks where the implementation can
|
and publication mechanics. Prepare these links with the release note; they do
|
||||||
be meaningfully checked for those risks;
|
not add a network check or approval gate. If a hosted download page is used in
|
||||||
- static analysis and linting used by the repository;
|
a future channel, preserve the footer there.
|
||||||
- production builds for every supported target that can be built in the
|
|
||||||
release environment;
|
|
||||||
- formatting and whitespace checks;
|
|
||||||
- validation of maintained examples, configuration, schemas, generated
|
|
||||||
sources, and documentation commands where applicable;
|
|
||||||
- review of changed local documentation links;
|
|
||||||
- removal of obsolete roadmap documents under `docs/roadmap/` that describe
|
|
||||||
completed work included in the release;
|
|
||||||
- review for unintended files, generated output, credentials, private data,
|
|
||||||
and unrelated changes; and
|
|
||||||
- any additional security, compatibility, migration, packaging, or platform
|
|
||||||
checks required by the product.
|
|
||||||
|
|
||||||
Unavailable tooling or an inapplicable check must be addressed explicitly in
|
Handle version selection, release-note content, and retirement of completed
|
||||||
the adopted policy or release procedure; it must not disappear silently from
|
roadmaps during preparation. Preserve planned and deferred work and repair
|
||||||
the candidate gates.
|
affected links when retiring roadmaps. Reuse ordinary change review for
|
||||||
|
unintended files, credentials, and private data. Scope release-content review
|
||||||
|
to the tagged source.
|
||||||
|
|
||||||
Run the complete checker while preparing the candidate. Commit the release
|
## Candidate Validation
|
||||||
note and all associated code, tests, documentation, and configuration, then
|
|
||||||
run the complete checker again against the exact commit intended for release.
|
Provide one publication command that validates the final committed candidate,
|
||||||
Do not publish a release from uncommitted or unvalidated content.
|
checks publication state, and publishes the intended refs. A validation-only
|
||||||
|
mode or command may be provided for diagnosis, but must not be a required step
|
||||||
|
before publication repeats the same checks.
|
||||||
|
|
||||||
|
ConfigKit uses the module-selected ReleaseKit CLI's `publish
|
||||||
|
vMAJOR.MINOR.PATCH` command. Its `check` command is optional for diagnosis; it
|
||||||
|
is not a required preliminary pass to publication.
|
||||||
|
|
||||||
|
Run the complete deterministic, offline default test suite once for the final
|
||||||
|
candidate, following the [testing policy](testing.md). For repositories that
|
||||||
|
publish builds, verify the required build targets. Select those targets for
|
||||||
|
the application's actual support commitments; native testing on each platform
|
||||||
|
and access to particular hardware are not default release prerequisites.
|
||||||
|
|
||||||
|
Prepare dependencies and build the tool before offline validation; the
|
||||||
|
publication command is the required validation run, with no separate successful
|
||||||
|
test or CI run required before it.
|
||||||
|
|
||||||
|
The selected profile runs the complete deterministic, offline default suite
|
||||||
|
once with the race detector and test-time vet disabled. The suite already
|
||||||
|
includes examples, consumer fixtures, documentation links, and package
|
||||||
|
boundaries. One full vet pass adds static checks beyond the test-time subset.
|
||||||
|
CGO-disabled Linux amd64 and arm64 package compilation covers supported
|
||||||
|
configurations distinct from native race compilation. macOS and newer-toolchain
|
||||||
|
checks are optional.
|
||||||
|
|
||||||
|
Additional gates must address a concrete risk that the existing checks do not
|
||||||
|
adequately cover. Do not automatically require linting, race testing, module
|
||||||
|
hygiene audits, documentation audits, credential scans, example validation, or
|
||||||
|
expanded platform matrices solely because they are possible. Retain such
|
||||||
|
checks when their distinct protection justifies their cost. A one-time migration
|
||||||
|
check must not silently become a permanent release requirement.
|
||||||
|
|
||||||
|
ReleaseKit runs its selected Go commands with readonly module mode and
|
||||||
|
`GOPROXY=off`; acquire dependencies and build the tool before candidate
|
||||||
|
validation. Formatting and whitespace remain ordinary development checks in
|
||||||
|
`scripts/check.sh`.
|
||||||
|
Review module tidiness when dependencies change, not as a release gate.
|
||||||
|
|
||||||
|
Release tests must not require real credentials, mutable application services,
|
||||||
|
paid APIs, provider probes, or inference calls. The procedure may describe dependency
|
||||||
|
preparation separately from offline validation.
|
||||||
|
|
||||||
|
Avoid duplicate validation across release phases. Successful checks for the
|
||||||
|
same final candidate need not be repeated solely to satisfy another phase;
|
||||||
|
any reuse must clearly apply to that exact candidate. Persistent validation
|
||||||
|
caches are not required. If the candidate changes, validate the new candidate.
|
||||||
|
Cheap publication-state checks may be repeated immediately before pushing
|
||||||
|
because local or remote state may have changed during validation.
|
||||||
|
|
||||||
|
Automate mechanical guards. Human review gates are strongly disfavored: add one
|
||||||
|
only through an explicit project-specific policy decision explaining the
|
||||||
|
concrete risk and why ordinary change review or automation is insufficient.
|
||||||
|
Do not add routine confirmations for checks the command can perform itself.
|
||||||
|
|
||||||
|
Compatibility review, release-note accuracy, completed-roadmap retirement, and
|
||||||
|
review for unintended files or credentials remain ordinary preparation. The
|
||||||
|
executing agent may perform them without routine human approval or separate
|
||||||
|
manual evidence records. Publication itself requires authorization.
|
||||||
|
|
||||||
## Publication Guards
|
## Publication Guards
|
||||||
|
|
||||||
Immediately before publication, the maintainer or release automation must
|
Automate the checks needed to publish the intended source under a fresh version:
|
||||||
fetch the current primary branch and tags from the authoritative remote and
|
|
||||||
verify all of the following:
|
|
||||||
|
|
||||||
- the version has the required format and is not already published;
|
- the version has the adopted format and is unused locally and on the
|
||||||
- the current branch is the primary release branch;
|
authoritative remote;
|
||||||
- the worktree and index are clean;
|
- the worktree and index are clean on the primary release branch;
|
||||||
- the current commit is the recorded, validated candidate;
|
- the source being published is the exact candidate that passed validation,
|
||||||
- the authoritative remote branch points to that same commit;
|
including its matching release note H1;
|
||||||
- the matching release note exists in that commit and has the required title
|
- the remote primary branch can be advanced to that candidate without
|
||||||
and sections;
|
discarding remote history, and is published before the tag; and
|
||||||
- all required approvals and automated gates succeeded for that commit; and
|
- the tag identifies the validated candidate and only the intended refs are
|
||||||
- no local or remote tag already uses the selected version.
|
published.
|
||||||
|
|
||||||
Create the version tag against the guarded commit and verify its target before
|
ReleaseKit checks that `origin`'s effective push URL exactly matches the
|
||||||
publishing it. Publish only the exact intended ref and deliverables. Broad
|
authoritative URL before candidate validation. This does not assert the
|
||||||
operations such as `git push --tags` are discouraged because they can publish
|
configured fetch URL or require the release-note H1 to be the first line; the
|
||||||
unreviewed refs unrelated to the release.
|
required `# ConfigKit <version>` first-line format remains a content rule. The
|
||||||
|
command checks the candidate and unused version again after validation, and
|
||||||
|
checks local state before creating the tag. Ignored local files do not block
|
||||||
|
publication.
|
||||||
|
|
||||||
The repository-specific procedure must make these guards executable or give
|
Fetch the authoritative branch and tag state as needed for these checks.
|
||||||
copyable commands for performing them.
|
Do not force branch or tag updates to bypass a failed guard. Publish explicit
|
||||||
|
refs rather than all local tags. Do not require CI success, publication-service
|
||||||
|
availability checks, or a separate manual confirmation for each guard.
|
||||||
|
|
||||||
## Immutability And Correction
|
## Immutability And Correction
|
||||||
|
|
||||||
Published version tags and published deliverables are immutable. Do not move,
|
Published version tags and published contents are immutable. Do not move,
|
||||||
overwrite, recreate, or delete a published tag. Do not replace an artifact,
|
overwrite, recreate, or delete a published tag, or replace a published artifact,
|
||||||
image, package, checksum, signature, provenance statement, or release note
|
checksum, signature, provenance statement, or release note under that version.
|
||||||
under an already published version.
|
The checked-in note at the immutable tag is that release's historical record.
|
||||||
|
|
||||||
If validation fails before publication, correct the candidate, rerun the
|
If validation fails before publication, correct and commit the candidate and
|
||||||
complete gates, and repeat the publication guards. An unpublished local tag
|
rerun the publication command. If a push fails or its outcome is ambiguous,
|
||||||
may be removed after confirming that it was never published or used by a
|
inspect the authoritative remote before retrying. Remove an unpublished local
|
||||||
release channel.
|
tag only after confirming it was never published or used by a release channel.
|
||||||
|
An unavailable remote leaves publication status unknown; do not overwrite a tag
|
||||||
|
to resolve uncertainty.
|
||||||
|
|
||||||
If publication or post-publication verification reveals a defect, leave the
|
Transient network, authentication, CI, or consumer-availability failures do not
|
||||||
published release intact. Correct the defect on the primary branch, choose a
|
by themselves require a new version.
|
||||||
new patch version or other semantically appropriate new version, write a new
|
|
||||||
matching release note, and perform the complete release procedure again.
|
|
||||||
|
|
||||||
A distribution channel's supported yank, deprecation, or advisory mechanism
|
A defect requiring changes to published source or contents requires a corrected
|
||||||
may warn consumers away from a defective release, but it must not replace that
|
commit, a new semantically appropriate version, a matching release note, and
|
||||||
release's contents or reuse its version.
|
the release procedure again. Leave the original release intact. A channel's
|
||||||
|
yank, deprecation, or advisory mechanism may warn consumers away from a defective
|
||||||
|
release without replacing its contents or reusing its version.
|
||||||
|
|
||||||
## Repository Release Procedure
|
## Repository Release Procedure
|
||||||
|
|
||||||
Every adopting repository must maintain `docs/release.md` as the canonical
|
Maintain `docs/release.md` as a short, executable maintainer runbook. It must
|
||||||
maintainer runbook for implementing this policy. It must define, in execution
|
identify prerequisites, the selected release toolchain, the primary branch and
|
||||||
order:
|
authoritative remote, version and note preparation, one publication command with
|
||||||
|
local checks and guards, source-only deliverables, the successful-tag-push
|
||||||
|
completion point, and partial or unknown-state recovery.
|
||||||
|
|
||||||
1. maintainer prerequisites and required access;
|
Use copyable commands where practical. Keep optional diagnostics and consumer
|
||||||
2. version selection and compatibility review;
|
verification clearly optional. The procedure must not turn preparation work,
|
||||||
3. release-note creation;
|
ordinary change review, or post-publication investigation into additional
|
||||||
4. candidate preparation and the complete validation command;
|
release gates.
|
||||||
5. candidate commit, push, and exact commit recording;
|
|
||||||
6. publication guards;
|
|
||||||
7. exact tag and deliverable publication commands;
|
|
||||||
8. authoritative remote and consumer-facing verification; and
|
|
||||||
9. failure handling and correction.
|
|
||||||
|
|
||||||
The procedure should use copyable, fail-fast commands where practical. It must
|
|
||||||
name the primary branch, authoritative remote, tag form, published
|
|
||||||
deliverables, supported build targets, release automation responsibilities,
|
|
||||||
and consumer verification path. It must link to this policy instead of
|
|
||||||
restating or redefining its requirements.
|
|
||||||
|
|
||||||
## Policy Exceptions
|
## Policy Exceptions
|
||||||
|
|
||||||
|
The following historical exceptions do not change the current release workflow.
|
||||||
|
|
||||||
For v0.1.1 only, the maintainer approved renaming the reserved `_configkit` key to
|
For v0.1.1 only, the maintainer approved renaming the reserved `_configkit` key to
|
||||||
`configkit` as an error-correcting point release because there are no current
|
`configkit` as an error-correcting point release because there are no current
|
||||||
consumers. This intentionally changes the v0.1.0 configuration contract without a
|
consumers. This intentionally changes the v0.1.0 configuration contract without a
|
||||||
@@ -246,6 +327,3 @@ For v0.2.0 only, the maintainer accepted the successful native macOS check at
|
|||||||
only. The final candidate still requires the complete Linux release checker.
|
only. The final candidate still requires the complete Linux release checker.
|
||||||
This exception waives only repeating the macOS check after those documentation
|
This exception waives only repeating the macOS check after those documentation
|
||||||
changes; it does not waive other publication or verification gates.
|
changes; it does not waive other publication or verification gates.
|
||||||
|
|
||||||
Candidate selection, publication, and post-publication verification remain
|
|
||||||
mandatory steps in the [release procedure](../release.md).
|
|
||||||
|
|||||||
@@ -1,14 +1,16 @@
|
|||||||
# Testing Policy
|
# Testing Policy
|
||||||
|
|
||||||
**Base Policy Version:** 1.0
|
**Base Policy Version:** 1.3
|
||||||
|
|
||||||
**Last Updated:** 2026-09-06
|
**Last Updated**: 2026-09-28
|
||||||
|
|
||||||
|
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/testing.md)
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
Our tests exist to make **incorrect changes expensive and correct changes cheap**.
|
Our tests exist to make **incorrect changes expensive and correct changes cheap**.
|
||||||
|
|
||||||
We do not optimize for test count, line coverage, exhaustive isolation, or the fewest possible tests. We optimize for sufficient confidence in important behavior while imposing as little unnecessary friction as possible on future development.
|
We optimize for sufficient confidence in important behavior while minimizing friction on future development.
|
||||||
|
|
||||||
## ConfigKit-specific priorities
|
## ConfigKit-specific priorities
|
||||||
|
|
||||||
@@ -44,32 +46,19 @@ policy does not imply that those tools or tests already exist.
|
|||||||
|
|
||||||
## Every test has a cost
|
## Every test has a cost
|
||||||
|
|
||||||
Testing is not an unqualified good. Every test imposes both an immediate cost and a continuing lifetime cost.
|
Every test has an immediate and continuing cost: writing, review, execution,
|
||||||
|
diagnosis, fixture maintenance, and updates when legitimate behavior changes.
|
||||||
A test must be:
|
Tests can also constrain refactoring, duplicate policy, and add failure noise.
|
||||||
|
|
||||||
- written and reviewed;
|
|
||||||
- understood by future maintainers and coding agents;
|
|
||||||
- executed in local and CI workflows;
|
|
||||||
- diagnosed when it fails;
|
|
||||||
- updated when legitimate behavior changes;
|
|
||||||
- maintained as fixtures, APIs, and dependencies evolve; and
|
|
||||||
- removed or rewritten when it becomes redundant, brittle, misleading, or obsolete.
|
|
||||||
|
|
||||||
Tests also create cognitive and architectural friction. They can constrain refactoring, duplicate policy, slow feedback loops, add noise to failures, and cause harmless implementation changes to require unrelated edits across the suite.
|
|
||||||
|
|
||||||
A test is warranted only when the confidence it provides justifies these costs.
|
A test is warranted only when the confidence it provides justifies these costs.
|
||||||
|
Evaluate that tradeoff at two levels:
|
||||||
Apply this cost-benefit analysis at two levels:
|
|
||||||
|
|
||||||
1. **Per test:** What realistic defect does this test detect, how consequential would that defect be, and is that protection worth the test's lifetime cost?
|
1. **Per test:** What realistic defect does this test detect, how consequential would that defect be, and is that protection worth the test's lifetime cost?
|
||||||
2. **Across the suite:** Does this collection provide materially more confidence than a smaller, simpler suite would?
|
2. **Across the suite:** Does this collection provide materially more confidence than a smaller, simpler suite would?
|
||||||
|
|
||||||
The preferred test suite is a **lean suite that provides sufficient confidence in the risks that matter, without redundant or low-value tests**. We seek sufficient confidence with the least unnecessary testing friction, not the fewest possible tests.
|
Some friction is intentional. Tests should make dangerous changes—such as breaking compatibility, corrupting data, violating security boundaries, or reintroducing subtle bugs—require deliberate review. Keep ordinary internal changes inexpensive.
|
||||||
|
|
||||||
Some friction is intentional. Tests should make dangerous changes—such as breaking compatibility, corrupting data, violating security boundaries, or reintroducing subtle bugs—require deliberate review. They should not make ordinary internal changes needlessly expensive.
|
Evaluate maintenance cost against the specific failure being protected. When omitting a plausible test, be able to state why the protected failure is low-risk, already covered, obvious, reversible, or cheaper to detect elsewhere. For consequential, subtle, or difficult-to-observe behavior, the presumption should favor testing.
|
||||||
|
|
||||||
The cost of a test is not a reason to omit testing by default. Do not cite maintenance cost abstractly. When omitting a plausible test, be able to state why the protected failure is low-risk, already covered, obvious, reversible, or cheaper to detect elsewhere. For consequential, subtle, or difficult-to-observe behavior, the presumption should favor testing.
|
|
||||||
|
|
||||||
## Default testing style
|
## Default testing style
|
||||||
|
|
||||||
@@ -81,6 +70,8 @@ Use a **classical/Detroit-style** approach:
|
|||||||
- Prefer package-level behavioral tests over tests coupled to private helpers or internal call sequences.
|
- Prefer package-level behavioral tests over tests coupled to private helpers or internal call sequences.
|
||||||
- Treat exact collaborator interactions as testable behavior only when the interaction itself is a requirement.
|
- Treat exact collaborator interactions as testable behavior only when the interaction itself is a requirement.
|
||||||
|
|
||||||
|
Examples of appropriate seams include clocks, randomness, subprocesses, remote APIs, object storage, email, and paid LLM calls.
|
||||||
|
|
||||||
For ConfigKit, controlled input readers and filesystem failures are useful seams.
|
For ConfigKit, controlled input readers and filesystem failures are useful seams.
|
||||||
Prefer actual parsing, composition, and decoding over mocks of their call order.
|
Prefer actual parsing, composition, and decoding over mocks of their call order.
|
||||||
|
|
||||||
@@ -92,7 +83,7 @@ Control clocks, randomness, environment variables, and other process-global or m
|
|||||||
|
|
||||||
## What deserves tests
|
## What deserves tests
|
||||||
|
|
||||||
Prioritize tests for:
|
To the extent the following features are present in the application, prioritize tests for:
|
||||||
|
|
||||||
1. Public and package-level contracts.
|
1. Public and package-level contracts.
|
||||||
2. Domain rules and important invariants.
|
2. Domain rules and important invariants.
|
||||||
@@ -102,15 +93,27 @@ Prioritize tests for:
|
|||||||
6. Previously observed or plausible regressions.
|
6. Previously observed or plausible regressions.
|
||||||
7. Representative integration and end-to-end workflows.
|
7. Representative integration and end-to-end workflows.
|
||||||
|
|
||||||
A package-level contract is behavior relied upon by another package or major collaborator, not every observable detail of a package implementation.
|
A package-level contract comprises behavior relied upon by another package or major collaborator.
|
||||||
|
|
||||||
For behavior involving **data integrity, destructive operations, compatibility, security, concurrency, idempotency, or recovery**, presume that durable tests are required unless the behavior is already credibly protected at another layer.
|
Choose tests for requested behavior and established contracts. Tests must not
|
||||||
|
introduce new restrictions, guarantees, or threat scenarios merely because they
|
||||||
|
could be asserted. Follow the [agent policy](agents.md) when deciding whether a
|
||||||
|
behavior belongs to the contract; current implementation behavior alone is not
|
||||||
|
sufficient authority.
|
||||||
|
|
||||||
|
For established behavior involving **data integrity, destructive operations,
|
||||||
|
compatibility, security, concurrency, idempotency, or recovery**, favor durable
|
||||||
|
tests for realistic failures whose consequences warrant protection. Identify
|
||||||
|
the failure and the existing contract it would violate. These categories call
|
||||||
|
for attention, not an automatic test inventory or permission to strengthen the
|
||||||
|
application's guarantees. Account for protection already provided at other layers.
|
||||||
|
|
||||||
Do not add tests merely because a function, branch, or line exists. Do not add a test when the same meaningful risk is already adequately protected elsewhere.
|
Do not add tests merely because a function, branch, or line exists. Do not add a test when the same meaningful risk is already adequately protected elsewhere.
|
||||||
|
|
||||||
## Choose the right test boundary
|
## Choose the right test boundary
|
||||||
|
|
||||||
Test through the narrowest stable boundary that expresses the behavior clearly.
|
Choose the narrowest stable boundary that expresses the behavior clearly and
|
||||||
|
provides durable confidence with minimal incidental coupling.
|
||||||
|
|
||||||
This is often the package API, but it may instead be:
|
This is often the package API, but it may instead be:
|
||||||
|
|
||||||
@@ -118,28 +121,15 @@ This is often the package API, but it may instead be:
|
|||||||
- a package-level operation when several internal collaborators jointly produce the behavior; or
|
- a package-level operation when several internal collaborators jointly produce the behavior; or
|
||||||
- a larger integration boundary when correctness emerges from interaction with a real dependency.
|
- a larger integration boundary when correctness emerges from interaction with a real dependency.
|
||||||
|
|
||||||
Do not force all behavior through oversized end-to-end tests. Do not test every private helper merely because it exists. Choose the boundary that gives durable confidence with the least incidental coupling.
|
|
||||||
|
|
||||||
## Test behavior, not implementation
|
## Test behavior, not implementation
|
||||||
|
|
||||||
A test should protect a decision, contract, or invariant—not memorialize the current implementation.
|
A test should protect a selected decision, contract, or invariant.
|
||||||
|
|
||||||
Before adding or retaining a test, ask:
|
A test is suspect when it primarily detects changes to private constants or
|
||||||
|
helpers, equivalent operation ordering, incidental formatting, equivalent
|
||||||
|
algorithms, or internal structure that preserves behavior.
|
||||||
|
|
||||||
> What realistic defect would this test catch?
|
Behavioral tests should normally remain stable through internal refactoring that preserves the contract.
|
||||||
|
|
||||||
A test is suspect when its main purpose is to detect that someone:
|
|
||||||
|
|
||||||
- changed an internal constant;
|
|
||||||
- renamed or split a private helper;
|
|
||||||
- reordered equivalent internal operations;
|
|
||||||
- changed incidental formatting;
|
|
||||||
- replaced one correct algorithm with another; or
|
|
||||||
- refactored internal object structure without changing behavior.
|
|
||||||
|
|
||||||
Refactoring should normally require no test edits unless the refactored structure is itself part of the contract.
|
|
||||||
|
|
||||||
A test can be factually correct and still have negative value. Accurately describing current behavior is not enough; the protected behavior must be important enough to justify the future friction.
|
|
||||||
|
|
||||||
## Expected effects of different changes
|
## Expected effects of different changes
|
||||||
|
|
||||||
@@ -156,12 +146,13 @@ A test failing is not the same as a test needing to be edited. Many tests may co
|
|||||||
|
|
||||||
## Separate mechanism from policy
|
## Separate mechanism from policy
|
||||||
|
|
||||||
Configurable thresholds and defaults must not be duplicated throughout the test suite.
|
Derive expectations from test-controlled configuration and relationships.
|
||||||
|
|
||||||
For example, do not encode an internal concurrency limit indirectly:
|
For this example, assume the selected contract rejects a request to start more
|
||||||
|
processes than a configured limit. Do not encode its production default indirectly:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
// Production policy:
|
// Production default:
|
||||||
const maxConcurrency = 4
|
const maxConcurrency = 4
|
||||||
|
|
||||||
// Brittle test:
|
// Brittle test:
|
||||||
@@ -179,25 +170,30 @@ require.NoError(t, runner.Start(limit))
|
|||||||
require.ErrorIs(t, runner.Start(limit+1), ErrTooMuchConcurrency)
|
require.ErrorIs(t, runner.Start(limit+1), ErrTooMuchConcurrency)
|
||||||
```
|
```
|
||||||
|
|
||||||
The test should prove:
|
For this selected contract, the test should prove:
|
||||||
|
|
||||||
- the configured limit is accepted; and
|
- the configured limit is accepted; and
|
||||||
- one beyond the configured limit is rejected.
|
- one beyond the configured limit is rejected.
|
||||||
|
|
||||||
|
Rejection is not a general requirement for concurrency control. If the selected
|
||||||
|
contract queues excess work or limits active workers while accepting larger
|
||||||
|
batches, test that behavior instead. Do not add rejection or a configurable
|
||||||
|
limit solely to reproduce this example.
|
||||||
|
|
||||||
The production default should be tested exactly only when its literal value is itself a public, operational, safety, protocol, or compatibility requirement.
|
The production default should be tested exactly only when its literal value is itself a public, operational, safety, protocol, or compatibility requirement.
|
||||||
|
|
||||||
Apply the same rule to limits, timeouts, capacities, retry counts, and ranges: test relationships and behavior, not duplicated literals.
|
Apply the same rule to limits, timeouts, capacities, retry counts, and ranges: test relationships and behavior.
|
||||||
|
|
||||||
For concurrency limits, test both kinds of behavior when relevant:
|
For established concurrency limits, distinguish these behaviors where the contract requires them:
|
||||||
|
|
||||||
1. **Configuration enforcement:** invalid or excessive requested values are handled correctly.
|
1. **Configuration handling:** values are accepted or rejected according to the selected contract.
|
||||||
2. **Runtime enforcement:** observed peak concurrency never exceeds the configured limit.
|
2. **Runtime enforcement:** observed peak concurrency never exceeds the configured limit.
|
||||||
|
|
||||||
Use a test-controlled limit and measure the behavior relative to that limit. Do not merely assert today's default value.
|
Use a test-controlled limit and measure the behavior relative to that limit.
|
||||||
|
|
||||||
## Avoid semantic duplication across layers
|
## Assign each behavior a test owner
|
||||||
|
|
||||||
Each behavior should have a clear test owner.
|
For ConfigKit, assign ownership as follows:
|
||||||
|
|
||||||
- YAML boundary tests own syntax and policy enforcement.
|
- YAML boundary tests own syntax and policy enforcement.
|
||||||
- Composition and overlay tests own their operation semantics.
|
- Composition and overlay tests own their operation semantics.
|
||||||
@@ -209,9 +205,7 @@ Each behavior should have a clear test owner.
|
|||||||
|
|
||||||
These are responsibility boundaries, not a required package layout.
|
These are responsibility boundaries, not a required package layout.
|
||||||
|
|
||||||
Higher-level tests should not repeat every lower-level case. A single intentional policy change should not require unrelated edits across many test files.
|
Give each layer its distinct responsibility and keep expectation updates localized to the contract being changed.
|
||||||
|
|
||||||
Tests that are individually reasonable may still be collectively redundant. Evaluate the marginal value of each additional test in light of the protection already provided by the rest of the suite.
|
|
||||||
|
|
||||||
## Use test doubles deliberately
|
## Use test doubles deliberately
|
||||||
|
|
||||||
@@ -232,104 +226,77 @@ Mocks are appropriate when the contract includes facts such as:
|
|||||||
- an expensive API is called no more than once; or
|
- an expensive API is called no more than once; or
|
||||||
- a security audit event is emitted.
|
- a security audit event is emitted.
|
||||||
|
|
||||||
Do not use mocks merely to isolate every object or reproduce the implementation's call graph.
|
|
||||||
|
|
||||||
## Go-specific guidance
|
## Go-specific guidance
|
||||||
|
|
||||||
Use:
|
Select techniques by behavior and risk:
|
||||||
|
|
||||||
- table-driven tests for meaningful behavioral categories and boundaries;
|
- table-driven tests for meaningful behavioral categories and boundaries;
|
||||||
- `t.TempDir()` for real filesystem behavior;
|
- `t.TempDir()` for real filesystem behavior;
|
||||||
- fuzz tests for parsers, normalization, path handling, and broad input spaces;
|
- `httptest.Server` for realistic HTTP interactions;
|
||||||
|
- fuzz tests when exploring broad input spaces, such as parsers or path handling, adds useful protection beyond representative cases;
|
||||||
- golden files only when the complete output is intentionally stable;
|
- golden files only when the complete output is intentionally stable;
|
||||||
- integration tests where correctness depends on component interaction; and
|
- integration tests where correctness depends on component interaction; and
|
||||||
- a small number of representative end-to-end tests.
|
- a small number of representative end-to-end tests when assembled workflows expose meaningful risks not adequately covered at narrower boundaries.
|
||||||
|
|
||||||
Avoid exact error-string assertions unless the wording is itself contractual. Prefer `errors.Is`, `errors.As`, typed errors, or structured error fields.
|
Prefer `errors.Is`, `errors.As`, typed errors, or structured error fields. Use exact error-wording assertions only when the wording is contractual.
|
||||||
|
|
||||||
At the public library boundary, prefer diagnostic codes, paths, and source
|
At the public library boundary, prefer diagnostic codes, paths, and source
|
||||||
locations over complete message snapshots. Assert wording only when contractual.
|
locations over complete message snapshots. Assert wording only when contractual.
|
||||||
|
|
||||||
Golden-file updates must require an explicit local flag. CI must not update golden files automatically, and reviewers must inspect the semantic diff before accepting an update.
|
Golden-file updates must require an explicit local flag. CI must not update golden files automatically, and reviewers must inspect the semantic diff before accepting an update.
|
||||||
|
|
||||||
Keep tests readable and direct. Test helpers and fixture frameworks must earn their own maintenance cost; do not build elaborate test infrastructure for small or isolated needs.
|
Keep tests readable and direct. Size test helpers and fixture frameworks to the maintenance benefit they provide.
|
||||||
|
|
||||||
## Coverage
|
## Coverage
|
||||||
|
|
||||||
Coverage is a diagnostic, not a target.
|
Use coverage to locate untested critical branches and unexpectedly weak packages. Evaluate test quality through meaningful behavioral protection and choose coverage according to risk.
|
||||||
|
|
||||||
Use it to find untested critical branches and unexpectedly weak packages. Do not write low-value tests solely to increase a percentage, and do not infer test quality from coverage alone.
|
Pure domain logic will often warrant higher coverage than CLI wiring or external adapters. Uneven coverage is acceptable when it reflects risk.
|
||||||
|
|
||||||
Dense configuration semantics will often warrant higher coverage than simple input wiring. Uneven coverage is acceptable when it reflects risk.
|
|
||||||
|
|
||||||
Increasing coverage is valuable only when the newly covered behavior protects a meaningful risk at an acceptable cost.
|
|
||||||
|
|
||||||
## Regression tests
|
## Regression tests
|
||||||
|
|
||||||
A bug fix should normally include a regression test that fails before the fix and passes afterward.
|
A bug fix should normally include a regression test that fails before the fix and passes afterward.
|
||||||
|
|
||||||
Retain the test when the defect could realistically recur and its consequences justify the ongoing cost. Prefer the narrowest durable test of the violated contract or invariant; do not preserve accidental implementation details from the original bug.
|
Retain the test when the defect could realistically recur and its consequences justify the ongoing cost. Prefer the narrowest durable test of the violated contract or invariant.
|
||||||
|
|
||||||
Not every historical bug requires a permanent test. If the underlying design has made recurrence impossible, the test has become redundant, or a stronger invariant test now subsumes it, remove or consolidate it.
|
Remove or consolidate a test when the underlying design has made recurrence impossible, its protection is redundant, or a stronger invariant test subsumes it.
|
||||||
|
|
||||||
## Deleting or rewriting tests
|
## Deleting or rewriting tests
|
||||||
|
|
||||||
Tests are maintained code, not permanent historical artifacts.
|
Delete or rewrite tests when maintenance cost exceeds their continuing
|
||||||
|
protective value.
|
||||||
Delete or rewrite a test when its maintenance cost exceeds the confidence it provides.
|
|
||||||
|
|
||||||
Strong candidates include tests that:
|
Strong candidates include tests that:
|
||||||
|
|
||||||
- require updates after harmless internal changes;
|
- require updates after harmless internal changes;
|
||||||
- directly assert private constants without protecting a real contract;
|
- assert incidental private constants or snapshot large amounts of incidental output;
|
||||||
- duplicate the same policy across several layers;
|
|
||||||
- verify mock choreography rather than outcomes;
|
- verify mock choreography rather than outcomes;
|
||||||
- snapshot large amounts of incidental output;
|
- duplicate policy across layers, retest trivial helpers covered by package
|
||||||
- test trivial private helpers already exercised through stable package behavior;
|
behavior, or protect risks covered more effectively elsewhere;
|
||||||
- protect risks already covered more effectively elsewhere;
|
|
||||||
- are flaky, misleading, obsolete, or disproportionately expensive to diagnose; or
|
- are flaky, misleading, obsolete, or disproportionately expensive to diagnose; or
|
||||||
- no longer correspond to a plausible failure mode.
|
- no longer correspond to a plausible failure mode.
|
||||||
|
|
||||||
Several brittle tests may encode one genuine requirement. Replace them with one durable behavior-level or invariant test rather than preserving all of them.
|
Several brittle tests may encode one genuine requirement. Consolidate them into one durable behavior-level or invariant test.
|
||||||
|
|
||||||
Deleting a low-value test can improve the quality of the suite by reducing noise, maintenance burden, and friction around legitimate change.
|
|
||||||
|
|
||||||
## Reviewing a proposed test
|
## Reviewing a proposed test
|
||||||
|
|
||||||
Use the following questions when the value, boundary, or durability of a proposed test is not self-evident. Significant test additions should be reviewable against them, but written answers are not required for every routine test.
|
Use the following questions when a proposed test needs closer evaluation. Significant test additions should be reviewable against them; written answers are optional for routine tests.
|
||||||
|
|
||||||
1. What realistic defect would it catch?
|
1. Which requested behavior or established contract does it protect, and what realistic defect would violate it?
|
||||||
2. How likely is that defect?
|
2. How likely and consequential is that defect, and is it already protected elsewhere?
|
||||||
3. How consequential would it be?
|
3. What is the narrowest stable boundary that can test it clearly?
|
||||||
4. Is the behavior already protected elsewhere?
|
4. Would a correct internal refactor or a change to an incidental default require test edits?
|
||||||
5. At which layer should this behavior be owned?
|
5. Does its confidence justify its maintenance, execution, and diagnostic cost, or would a smaller test suffice?
|
||||||
6. Does the test assert a durable contract or an incidental implementation detail?
|
|
||||||
7. Could the implementation be refactored without changing the behavior and without editing this test?
|
|
||||||
8. What should cause this test to fail?
|
|
||||||
9. What legitimate changes should not cause this test to fail?
|
|
||||||
10. What ongoing maintenance, execution, and diagnostic cost will the test impose?
|
|
||||||
11. Is there a smaller or more direct test that protects the same risk?
|
|
||||||
|
|
||||||
Do not add the test when its expected lifetime cost exceeds its expected protective value.
|
|
||||||
|
|
||||||
When deciding not to test plausible behavior, record or be able to explain why the risk is low, already protected, obvious, reversible, or cheaper to detect elsewhere.
|
|
||||||
|
|
||||||
## Definition of sufficient
|
## Definition of sufficient
|
||||||
|
|
||||||
A test suite is sufficient when:
|
A test suite is sufficient when:
|
||||||
|
|
||||||
- important contracts and invariants are protected;
|
- important requested behavior and established contracts are protected against realistic, consequential failures;
|
||||||
- meaningful boundaries and failure modes are exercised;
|
- boundaries and component interactions have coverage where they introduce meaningful risks not protected elsewhere;
|
||||||
- realistic and consequential regressions are credibly protected against silent recurrence;
|
- failures provide useful, distinct signals;
|
||||||
- behavior involving data integrity, destructive operations, compatibility, security, concurrency, idempotency, and recovery is credibly protected;
|
- tests usually remain stable through legitimate internal changes; and
|
||||||
- important external boundaries have realistic integration coverage;
|
|
||||||
- representative complete workflows are tested;
|
|
||||||
- failures provide useful signal rather than redundant noise;
|
|
||||||
- legitimate internal changes usually do not require test edits; and
|
|
||||||
- additional tests would mostly repeat existing protection or preserve inconsequential implementation details.
|
- additional tests would mostly repeat existing protection or preserve inconsequential implementation details.
|
||||||
|
|
||||||
Sufficiency is a risk judgment, not a coverage percentage or test count. Reassess it as the library, its consumers, and the consequences of failure evolve.
|
Reassess sufficiency as the application, its users, and the consequences of
|
||||||
|
failure evolve.
|
||||||
The governing rule is:
|
|
||||||
|
|
||||||
> Test heavily where failure is consequential, subtle, or difficult to detect after the fact. Test lightly where failure is obvious, reversible, and inexpensive—and retain no test whose lifetime cost exceeds the confidence it provides.
|
|
||||||
|
|||||||
355
docs/release.md
355
docs/release.md
@@ -1,244 +1,237 @@
|
|||||||
# ConfigKit Release Procedure
|
# ConfigKit Release Procedure
|
||||||
|
|
||||||
This is the maintainer runbook for ConfigKit's [release policy](policy/release.md).
|
This is the maintainer runbook for ConfigKit's [release policy](policy/release.md).
|
||||||
ConfigKit publishes one source-only Go module: the immutable source tag and the
|
ConfigKit publishes a source-only Go module. The immutable annotated tag and
|
||||||
matching checked-in release note are the deliverables. There is no application
|
matching checked-in release note are the deliverables; there is no binary,
|
||||||
binary, container image, generated package, or separate registry publication.
|
container image, generated package, or separate registry publication.
|
||||||
|
|
||||||
## Release identity and support
|
## Release identity and support
|
||||||
|
|
||||||
- Module: `gitea.maximumdirect.net/eric/ConfigKit`
|
- Module: `gitea.maximumdirect.net/eric/ConfigKit`
|
||||||
- Primary branch: `main`
|
- Primary branch: `main`
|
||||||
- Authoritative remote: `origin`, expected to fetch from
|
- Authoritative remote: `origin`
|
||||||
`https://gitea.maximumdirect.net/eric/ConfigKit.git`
|
- Authoritative push URL: `https://gitea.maximumdirect.net/eric/ConfigKit.git`
|
||||||
- Tags: stable Semantic Versions such as `v0.1.0`; prerelease tags are not supported
|
- Tags: stable Semantic Versions such as `v0.5.0`; no prereleases
|
||||||
- Minimum Go language/toolchain line: Go 1.25, tested with a supported patched
|
- Minimum Go version: the first stable patch of the selected Go series, or a
|
||||||
Go 1.25 toolchain and one newer supported toolchain
|
higher patch when required by a dependency or specific correctness fix, as
|
||||||
- Release-gated build targets: Linux on amd64 and arm64
|
recorded in `go.mod`; see the
|
||||||
- Best-effort targets: macOS on amd64 and arm64, under the
|
[consumer minimum policy](policy/release.md#consumer-minimum-and-release-toolchain)
|
||||||
|
- Release-gated targets: Linux amd64 and arm64
|
||||||
|
- Best-effort targets: macOS amd64 and arm64, under the
|
||||||
[platform support policy](policy/release.md#platform-support)
|
[platform support policy](policy/release.md#platform-support)
|
||||||
|
|
||||||
The automated checker cross-builds the Linux targets. Before release, the maintainer
|
Release validation runs one offline race-enabled Go suite, one full vet pass,
|
||||||
must also obtain native test, race, symlink, and permission-fixture evidence on Linux;
|
and CGO-disabled package compilation for both Linux targets. macOS and CI are
|
||||||
cross-compilation is not native execution evidence. Native macOS checks and Darwin
|
not release gates; do not wait for or poll CI.
|
||||||
cross-builds are optional and do not gate publication.
|
|
||||||
|
|
||||||
## 1. Prepare access and tools
|
## 1. Select Go and prepare the tool
|
||||||
|
|
||||||
The release maintainer owns this procedure. Work in a dedicated clone with Git, Bash 3.2 or newer,
|
Use a clean checkout with Git, Bash 3.2 or newer, and a native compiler for race
|
||||||
and two supported Go toolchains available. The checker supports the stock macOS
|
tests. Choose the release type before selecting Go. For a minor or major release,
|
||||||
Bash; its filename enumeration is null-delimited, including names with whitespace. Configure private-host Git and Go module
|
select the newest stable Go series available in the development environment.
|
||||||
access through the normal credential manager before starting. Keep tokens, passwords,
|
For a patch release, retain the series recorded in `go.mod` and leave its consumer
|
||||||
SSH material, and environment dumps outside the repository and command transcript.
|
minimum unchanged. Follow the
|
||||||
Verify access without displaying credentials:
|
[toolchain selection policy](policy/release.md#configkit-toolchain-selection).
|
||||||
|
|
||||||
|
Put the selected series' latest locally available compatible patch first on
|
||||||
|
`PATH`, ensuring it meets `go.mod`'s minimum. The same `go` executable must build
|
||||||
|
ReleaseKit and run its child validation commands. Set local toolchain selection
|
||||||
|
and verify it:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git remote get-url origin
|
export GOTOOLCHAIN=local
|
||||||
git ls-remote origin HEAD
|
go version
|
||||||
|
go env GOVERSION
|
||||||
|
command -v go
|
||||||
```
|
```
|
||||||
|
|
||||||
The remote URL must equal the authoritative URL above. Select the latest supported
|
Only when a minor or major release advances the consumer minimum to a newer Go
|
||||||
patch in the Go 1.25 line and a newer supported toolchain. The values below are the
|
series, derive that series' initial stable release from the selected executable:
|
||||||
toolchains used while this runbook was introduced; update them to supported patch
|
|
||||||
releases during candidate preparation and record the actual versions in the release
|
|
||||||
note or validation record.
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
export CONFIGKIT_BASELINE_TOOLCHAIN=go1.25.5
|
selected_go=$(GOTOOLCHAIN=local go env GOVERSION)
|
||||||
export CONFIGKIT_NEWER_TOOLCHAIN=go1.26.7
|
selected_series=${selected_go#go}
|
||||||
GOTOOLCHAIN="$CONFIGKIT_BASELINE_TOOLCHAIN" go version
|
selected_series=${selected_series%.*}
|
||||||
GOTOOLCHAIN="$CONFIGKIT_NEWER_TOOLCHAIN" go version
|
release_minimum="$selected_series.0"
|
||||||
GOTOOLCHAIN="$CONFIGKIT_BASELINE_TOOLCHAIN" go mod download
|
go mod edit -go="$release_minimum"
|
||||||
GOTOOLCHAIN="$CONFIGKIT_NEWER_TOOLCHAIN" go mod download
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Those commands explicitly acquire toolchains and dependencies. The checker itself
|
If a dependency or identified correctness fix requires a higher patch minimum,
|
||||||
sets `GOPROXY=off` and fails if its required cache is incomplete.
|
use that required version instead and document the reason. When the series is
|
||||||
|
unchanged, leave the minimum unchanged unless a minor or major release
|
||||||
|
deliberately changes it under the
|
||||||
|
[consumer minimum policy](policy/release.md#consumer-minimum-and-release-toolchain).
|
||||||
|
For example, validating with Go 1.26.8 leaves `go 1.26.0` unchanged. There is no
|
||||||
|
separate requirement to validate with Go 1.26.0.
|
||||||
|
|
||||||
## 2. Select the version and review compatibility
|
Prepare dependencies whether or not the minimum changes:
|
||||||
|
|
||||||
Choose an unused stable version and compare the candidate with the previous tag.
|
|
||||||
For the first release, review the whole public surface and current contracts.
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
release_version=v0.1.0
|
go mod download
|
||||||
printf '%s\n' "$release_version" | grep -Eq '^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$'
|
|
||||||
git show-ref --verify --quiet "refs/tags/$release_version" && exit 1 || :
|
|
||||||
if git ls-remote --exit-code --tags origin "refs/tags/$release_version" >/dev/null; then
|
|
||||||
printf 'remote tag already exists: %s\n' "$release_version" >&2
|
|
||||||
exit 1
|
|
||||||
else
|
|
||||||
test $? -eq 2
|
|
||||||
fi
|
|
||||||
git log --oneline --decorate --no-merges
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Review exported Go signatures and ownership, YAML and scalar behavior, precedence,
|
Build the tool selected by `go.mod` into temporary storage outside the checkout.
|
||||||
diagnostic codes, minimum Go version, and platform support. Before `v1.0.0`, any
|
Ensure `$TMPDIR` names a system temporary location, not the repository. These
|
||||||
intentional incompatible minor-release change must be explained with consumer action;
|
commands never install another ReleaseKit version:
|
||||||
patch releases must remain compatible within their minor line. Review the maintained
|
|
||||||
consumer examples and the migration guide even when signatures did not change.
|
|
||||||
|
|
||||||
Reassess `go.yaml.in/yaml/v4` rather than using `@latest` implicitly:
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
go list -m -versions go.yaml.in/yaml/v4
|
releasekit_tmp=$(mktemp -d "${TMPDIR:-/tmp}/configkit-releasekit.XXXXXX")
|
||||||
go list -m -json go.yaml.in/yaml/v4@latest
|
releasekit_bin="$releasekit_tmp/releasekit"
|
||||||
|
go build -o "$releasekit_bin" gitea.maximumdirect.net/eric/ReleaseKit/cmd/releasekit
|
||||||
|
go list -m gitea.maximumdirect.net/eric/ReleaseKit
|
||||||
|
"$releasekit_bin" version
|
||||||
```
|
```
|
||||||
|
|
||||||
If changing the explicit pin, make that a reviewed dependency change and rerun the
|
The module-selected executable is ReleaseKit v0.3.0. Use the built executable
|
||||||
complete checker, especially parser policy, limits, diagnostics, and rendering tests.
|
for publication to preserve its exit status and publication-state diagnostics.
|
||||||
If retaining a prerelease pin, record that decision in Compatibility.
|
`go run` maps a nonzero child exit status to 1. ReleaseKit's child Go commands
|
||||||
|
use the `go` found on `PATH` with `GOTOOLCHAIN=local`; keep the selected
|
||||||
|
executable first on `PATH` through the publication command.
|
||||||
|
|
||||||
## 3. Write the release note
|
Verify access to the authoritative remote without displaying credentials:
|
||||||
|
|
||||||
Create `docs/releases/$release_version.md` before selecting the candidate. It must
|
|
||||||
begin with `# ConfigKit $release_version` and contain `Summary`, `Compatibility`,
|
|
||||||
`Upgrade`, and `Changes` sections. Use “No action required” where appropriate. Link
|
|
||||||
to current canonical contracts instead of copying their definitions. Do not create a
|
|
||||||
release note until there is a real candidate and reviewed content.
|
|
||||||
|
|
||||||
## 4. Validate the source candidate
|
|
||||||
|
|
||||||
Run the complete checker on Linux from the repository root after dependencies have been
|
|
||||||
acquired. It validates module manifests in a disposable copy, both supported Go
|
|
||||||
toolchains, offline default tests, the native race detector, vet, native builds,
|
|
||||||
CGO-disabled Linux cross-builds, formatting and whitespace (including untracked files),
|
|
||||||
examples, package isolation, and local documentation links.
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
./scripts/release-check.sh
|
git ls-remote https://gitea.maximumdirect.net/eric/ConfigKit.git HEAD refs/heads/main
|
||||||
```
|
```
|
||||||
|
|
||||||
`go vet` is the repository's static-analysis baseline. No additional linter is
|
Publication requires explicit authorization. Local implementation commits do
|
||||||
claimed. Links to current ConfigKit files and headings are strict. Recorded links to
|
not authorize a push or release.
|
||||||
sibling consumer source are checked when those checkouts exist and are otherwise
|
|
||||||
inapplicable in an isolated clone; their immutable revisions remain recorded in the
|
|
||||||
extraction inventory.
|
|
||||||
|
|
||||||
Complete these manual gates and record their evidence with the candidate:
|
## 2. Prepare and commit the candidate
|
||||||
|
|
||||||
- The maintainer reviews compatibility and downstream migration impact against
|
Choose an unused stable version locally and on the authoritative remote. Compare
|
||||||
`docs/config.md`, Go API comments, and the consumer guide.
|
the candidate with the previous tag and review exported Go signatures and
|
||||||
- The maintainer inspects `git status --short`, `git diff`, and the candidate file
|
ownership, YAML and resolution semantics, diagnostic contracts, minimum Go
|
||||||
list for credentials, private data, generated output, unintended files, and
|
version, and platform support. Review maintained consumer examples and the
|
||||||
unrelated changes.
|
migration guidance. Explain any consumer-minimum increase and required consumer
|
||||||
- The maintainer records a successful native checker run on Linux, including
|
action under the
|
||||||
filesystem capability tests. Missing required Linux evidence blocks release;
|
[consumer minimum policy](policy/release.md#consumer-minimum-and-release-toolchain).
|
||||||
no macOS run, sign-off, or cross-build result is required.
|
|
||||||
- The maintainer removes completed, obsolete documents under `docs/roadmap/`, repairs
|
|
||||||
inbound links, and reruns the checker. ADR rationale remains historical.
|
|
||||||
- The maintainer reviews the exact version-matched release note for accuracy and
|
|
||||||
confirms it describes only deliverables that will actually be published.
|
|
||||||
|
|
||||||
## 5. Commit, push, and record the candidate
|
Create `docs/releases/<version>.md`. Its first line must be exactly
|
||||||
|
`# ConfigKit <version>`, and it must end with the license and attribution footer:
|
||||||
|
|
||||||
Commit all candidate source, contract, example, roadmap-retirement, and release-note
|
```markdown
|
||||||
changes, rerun the checker against that clean commit, then push only `main` and record
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/VERSION/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/VERSION/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/VERSION/docs/oss/attribution.md)
|
||||||
the exact commit in Git metadata local to the clone:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
git add .
|
|
||||||
git commit --message "Prepare ConfigKit $release_version"
|
|
||||||
./scripts/release-check.sh
|
|
||||||
test -z "$(git status --porcelain=v1 --untracked-files=all)"
|
|
||||||
git push origin HEAD:refs/heads/main
|
|
||||||
git rev-parse HEAD | tee .git/configkit-release-candidate
|
|
||||||
candidate_commit=$(cat .git/configkit-release-candidate)
|
|
||||||
```
|
```
|
||||||
|
|
||||||
If review changes the source after this point, create and validate a new candidate;
|
Replace `VERSION` with the full tag and confirm the three target files exist in
|
||||||
do not reuse the recorded commit.
|
the candidate. Retire completed roadmaps, preserve unfinished and deferred
|
||||||
|
work, and repair affected links. Review the complete candidate for unintended
|
||||||
|
files and credentials, then commit it on `main`. These are ordinary preparation
|
||||||
|
tasks, not separate approval gates. Any `go.mod` change belongs in this
|
||||||
|
candidate.
|
||||||
|
|
||||||
## 6. Run publication guards
|
## 3. Push the candidate to `main`
|
||||||
|
|
||||||
Immediately before tagging, fetch the authoritative branch and tags, restore the
|
Push only that committed candidate to the literal authoritative URL. This does
|
||||||
recorded variables if this is a new shell, and execute every guard:
|
not follow local tags:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
release_version=v0.1.0
|
git push --no-follow-tags https://gitea.maximumdirect.net/eric/ConfigKit.git HEAD:refs/heads/main
|
||||||
candidate_commit=$(cat .git/configkit-release-candidate)
|
|
||||||
git fetch --prune origin main
|
|
||||||
git fetch --tags origin
|
|
||||||
test "$(git branch --show-current)" = main
|
|
||||||
test -z "$(git status --porcelain=v1 --untracked-files=all)"
|
|
||||||
test "$(git rev-parse HEAD)" = "$candidate_commit"
|
|
||||||
test "$(git rev-parse refs/remotes/origin/main)" = "$candidate_commit"
|
|
||||||
test "$(git remote get-url origin)" = 'https://gitea.maximumdirect.net/eric/ConfigKit.git'
|
|
||||||
printf '%s\n' "$release_version" | grep -Eq '^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$'
|
|
||||||
test -f "docs/releases/$release_version.md"
|
|
||||||
test "$(sed -n '1p' "docs/releases/$release_version.md")" = "# ConfigKit $release_version"
|
|
||||||
for heading in Summary Compatibility Upgrade Changes; do
|
|
||||||
grep -Fxq "## $heading" "docs/releases/$release_version.md"
|
|
||||||
done
|
|
||||||
git show-ref --verify --quiet "refs/tags/$release_version" && exit 1 || :
|
|
||||||
if git ls-remote --exit-code --tags origin "refs/tags/$release_version" >/dev/null; then
|
|
||||||
printf 'remote tag already exists: %s\n' "$release_version" >&2
|
|
||||||
exit 1
|
|
||||||
else
|
|
||||||
test $? -eq 2
|
|
||||||
fi
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Confirm the recorded automated and manual approvals apply to exactly
|
ReleaseKit requires authoritative `main` to equal this candidate before it
|
||||||
`$candidate_commit`. A successful older run is not evidence for a changed commit.
|
validates. A failure before this push means ReleaseKit publication has not
|
||||||
|
started. If the push result is uncertain, inspect authoritative `main` and
|
||||||
|
continue only when it is confirmed at the candidate. If validation later fails,
|
||||||
|
no release tag is published; correct the issue in a new commit, push the new
|
||||||
|
candidate to `main`, and invoke validation again.
|
||||||
|
|
||||||
## 7. Tag and publish the exact ref
|
## 4. Publish the committed candidate
|
||||||
|
|
||||||
Create one annotated tag at the guarded commit, verify its peeled target, and push
|
With the authorized candidate already on authoritative `main`, invoke the
|
||||||
only that ref. Do not use `git push --tags`.
|
module-selected native executable exactly once:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git tag --annotate "$release_version" --message "ConfigKit $release_version" "$candidate_commit"
|
"$releasekit_bin" publish vMAJOR.MINOR.PATCH
|
||||||
test "$(git rev-list -n 1 "$release_version")" = "$candidate_commit"
|
|
||||||
git push origin "refs/tags/$release_version:refs/tags/$release_version"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
The pushed tag completes the declared source-only publication. No Gitea release
|
Replace the placeholder with the selected version. ReleaseKit checks the
|
||||||
object or binary upload is required.
|
effective push URL against `expected_push_url`, verifies the candidate on
|
||||||
|
`main`, and checks the release-note H1 for the product and version. It then
|
||||||
## 8. Verify publication and clean consumer retrieval
|
runs the selected race-enabled standard suite once with test-time vet disabled,
|
||||||
|
one full vet pass, and CGO-disabled package compilation for Linux amd64 and
|
||||||
Verify the authoritative tag and then retrieve that exact version into a new module
|
arm64. It publishes only the annotated tag for that candidate. Confirmed
|
||||||
without a local `replace` directive. Private-host credentials must already be
|
publication of the intended tag completes the release. The tag points to the
|
||||||
configured. Use direct origin retrieval unless an explicitly approved internal Go
|
captured commit and uses the complete checked-in note as its annotation message.
|
||||||
proxy is the publication channel.
|
The optional `check`
|
||||||
|
command is available for diagnosis but is not a separate required pass:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
remote_tag_commit=$(git ls-remote origin "refs/tags/$release_version^{}" | awk '{print $1}')
|
"$releasekit_bin" check vMAJOR.MINOR.PATCH
|
||||||
test "$remote_tag_commit" = "$candidate_commit"
|
```
|
||||||
|
|
||||||
|
Status 0 confirms publication, status 1 reports a known publication failure or
|
||||||
|
conflict, status 2 reports usage, profile, or version errors, and status 3 means
|
||||||
|
the push outcome remains unknown. Preserve both the native exit status and its
|
||||||
|
diagnostics.
|
||||||
|
|
||||||
|
The command does not push or repair `main`, wait for CI, or publish binaries or
|
||||||
|
a hosted release page. A successful intended-tag publication does not require
|
||||||
|
remote read-back or consumer retrieval; those checks remain optional.
|
||||||
|
|
||||||
|
## 5. Recover from a failed or uncertain tag push
|
||||||
|
|
||||||
|
The executable reports the publication state, phase, version, candidate commit,
|
||||||
|
tag-object ID, effective endpoint, and error on standard error. It performs one
|
||||||
|
bounded authoritative reconciliation after a failed tag push. Exit status 3
|
||||||
|
means the tag outcome remains unknown; do not blindly retry or move a tag.
|
||||||
|
|
||||||
|
For an uncertain result, use the exact endpoint, candidate commit, version, and
|
||||||
|
tag-object ID from the report. Copy the captured endpoint into the variable
|
||||||
|
below using normal shell quoting. Check that Git still resolves it to itself,
|
||||||
|
then query the authoritative refs once:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
authoritative='COPY_CAPTURED_ENDPOINT'
|
||||||
|
release_version='vMAJOR.MINOR.PATCH'
|
||||||
|
test "$(git ls-remote --get-url -- "$authoritative")" = "$authoritative" &&
|
||||||
|
git ls-remote --refs -- "$authoritative" refs/heads/main "refs/tags/$release_version"
|
||||||
|
```
|
||||||
|
|
||||||
|
A failed URL-equality check or remote query leaves the outcome unresolved.
|
||||||
|
Correct transport configuration before continuing; a rewritten destination
|
||||||
|
cannot establish absence at the captured endpoint.
|
||||||
|
|
||||||
|
Compare the `main` object ID with the reported candidate commit and the tag
|
||||||
|
object ID with the reported tag-object ID. `--refs` returns the annotated tag
|
||||||
|
object itself, not merely its peeled commit. If the tag object matches, the
|
||||||
|
release is published. If the query fails, the result is conflicting, or the
|
||||||
|
endpoint or candidate differs, stop and resolve the state before retrying. If
|
||||||
|
the endpoint is reachable, the tag is confirmed absent, and `main` still equals
|
||||||
|
the reported candidate, remove a retained local tag only after confirming it
|
||||||
|
was not published or used by another channel; then rerun `publish`, which
|
||||||
|
revalidates the candidate:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git tag -d "$release_version"
|
||||||
|
"$releasekit_bin" publish "$release_version"
|
||||||
|
```
|
||||||
|
|
||||||
|
A validation failure after the candidate reached `main` leaves an untagged
|
||||||
|
candidate there. Correct it with a new commit rather than rewriting or rolling
|
||||||
|
back `main`. A conflicting published tag must never be moved or reused. A
|
||||||
|
defect in published source requires a corrected commit, a new semantically
|
||||||
|
appropriate version, and a matching release note.
|
||||||
|
|
||||||
|
## 6. Optional consumer verification
|
||||||
|
|
||||||
|
When useful or requested, read back the remote tag or retrieve the exact
|
||||||
|
version into a new module without a local `replace` directive. These checks are
|
||||||
|
optional and non-gating. Do not poll CI or wait for module propagation. For
|
||||||
|
direct-origin verification, use the exact published version in a temporary
|
||||||
|
consumer module:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
release_version=vMAJOR.MINOR.PATCH
|
||||||
consumer_dir=$(mktemp -d)
|
consumer_dir=$(mktemp -d)
|
||||||
(
|
(
|
||||||
cd "$consumer_dir"
|
cd "$consumer_dir"
|
||||||
go mod init example.invalid/configkit-release-check
|
go mod init example.invalid/configkit-release-check
|
||||||
GOPRIVATE=gitea.maximumdirect.net GOPROXY=direct go get "gitea.maximumdirect.net/eric/ConfigKit@$release_version"
|
GOPRIVATE=gitea.maximumdirect.net GOPROXY=direct go get "gitea.maximumdirect.net/eric/ConfigKit@$release_version"
|
||||||
cat > main.go <<'EOF'
|
|
||||||
package main
|
|
||||||
|
|
||||||
import configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
_ = configkit.NoSource()
|
|
||||||
}
|
|
||||||
EOF
|
|
||||||
gofmt -w main.go
|
|
||||||
go test ./...
|
|
||||||
go build ./...
|
|
||||||
go list -m -f '{{.Path}} {{.Version}}' gitea.maximumdirect.net/eric/ConfigKit
|
go list -m -f '{{.Path}} {{.Version}}' gitea.maximumdirect.net/eric/ConfigKit
|
||||||
)
|
)
|
||||||
rm -rf -- "$consumer_dir"
|
|
||||||
```
|
```
|
||||||
|
|
||||||
The final `go list` output must show the exact module path and `$release_version`.
|
The output should show the exact module path and selected version. Report this
|
||||||
Record the result with the release evidence.
|
optional check separately from publication success.
|
||||||
|
|
||||||
## 9. Handle failures without replacement
|
|
||||||
|
|
||||||
Before publication, fix the candidate, rerun every gate, commit, push, and record a
|
|
||||||
new exact candidate. An unpublished local tag may be deleted only after verifying it
|
|
||||||
was never pushed or used by another release channel.
|
|
||||||
|
|
||||||
After publication, never move, delete, or recreate the tag and never replace its
|
|
||||||
release note. Correct the defect on `main`, choose a new semantically appropriate
|
|
||||||
version, and repeat this procedure. A supported advisory or deprecation mechanism
|
|
||||||
may warn consumers about the old version but cannot change its contents.
|
|
||||||
|
|||||||
43
docs/releases/v0.3.1.md
Normal file
43
docs/releases/v0.3.1.md
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
# ConfigKit v0.3.1
|
||||||
|
|
||||||
|
This release fixes secrets-directory bootstrap when the directory contains Git
|
||||||
|
metadata or other dot-prefixed entries.
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
`LoadSecretsDir` now ignores dot-prefixed files, directories, and symlinks,
|
||||||
|
including `.git`, `.gitignore`, and `.DS_Store`. These entries no longer prevent
|
||||||
|
otherwise valid secrets from loading and are omitted from the bootstrap report.
|
||||||
|
See the [bootstrap contract](../config.md#explicit-secrets-directory-bootstrap).
|
||||||
|
|
||||||
|
## Compatibility
|
||||||
|
|
||||||
|
This is a backward-compatible bug fix for previously rejected directory contents.
|
||||||
|
There are no Go API signature changes or migrations for previously accepted
|
||||||
|
inputs. Validation of non-hidden entries, existing-environment precedence, and
|
||||||
|
the existing enumeration and content limits remain unchanged. Hidden entries
|
||||||
|
still count toward the directory enumeration limit.
|
||||||
|
|
||||||
|
The minimum Go version remains 1.25. Linux remains release-validated and macOS
|
||||||
|
remains best-effort. The explicitly pinned YAML dependency remains
|
||||||
|
`go.yaml.in/yaml/v4 v4.0.0-rc.6`; reassessment found no newer published version.
|
||||||
|
Retaining this prerelease pin avoids unrelated parser changes in this patch.
|
||||||
|
|
||||||
|
## Upgrade
|
||||||
|
|
||||||
|
Update the module dependency and rebuild the consuming application:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go get gitea.maximumdirect.net/eric/ConfigKit@v0.3.1
|
||||||
|
```
|
||||||
|
|
||||||
|
No configuration migration is required. A secrets directory can retain its
|
||||||
|
dot-prefixed metadata without treating those entries as secret candidates.
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
- Filter hidden entries before filename and metadata validation and reporting.
|
||||||
|
- Cover hidden-only and mixed directories, including Git metadata and a dangling
|
||||||
|
hidden symlink, with regression tests.
|
||||||
|
- Update public API comments and the canonical bootstrap contract.
|
||||||
|
- Stop tracking local codebase-memory tooling artifacts and ignore their directory.
|
||||||
56
docs/releases/v0.4.0.md
Normal file
56
docs/releases/v0.4.0.md
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
# ConfigKit v0.4.0
|
||||||
|
|
||||||
|
This release renames selected configuration profiles to overlays, intentionally
|
||||||
|
breaking the previous naming contract without compatibility aliases or fallback.
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Selected configuration now uses `Options.Overlay` and `overlays/<name>.yml`.
|
||||||
|
Selection, merge rules, input precedence, and lifecycle behavior are unchanged.
|
||||||
|
See the [selected-overlay contract](../config.md#selected-overlays).
|
||||||
|
|
||||||
|
## Compatibility
|
||||||
|
|
||||||
|
This is a breaking minor release before v1.0.0. Four surfaces change:
|
||||||
|
|
||||||
|
- Go API: `Options.Profile` becomes `Options.Overlay`, `LayerProfile` becomes
|
||||||
|
`LayerOverlay`, and all seven `CodeProfile*` constants become `CodeOverlay*`.
|
||||||
|
- Selected files: `profiles/<name>.yml` becomes `overlays/<name>.yml`; there is
|
||||||
|
no legacy-directory fallback.
|
||||||
|
- Provenance: the layer string changes from `profile` to `overlay`.
|
||||||
|
- Structured diagnostics: the `profile.*` code prefix becomes `overlay.*`.
|
||||||
|
|
||||||
|
The old Go identifiers are removed. Application-owned concepts such as
|
||||||
|
`ModelProfile` and `model_profile` are unchanged. Ordinary explicit imports from
|
||||||
|
a directory named `profiles` remain valid base inputs.
|
||||||
|
|
||||||
|
The minimum Go version remains 1.25. Linux remains release-validated and macOS
|
||||||
|
remains best-effort. The YAML dependency remains pinned to
|
||||||
|
`go.yaml.in/yaml/v4 v4.0.0-rc.6`; this release does not change parser dependencies.
|
||||||
|
|
||||||
|
## Upgrade
|
||||||
|
|
||||||
|
Update the dependency:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go get gitea.maximumdirect.net/eric/ConfigKit@v0.4.0
|
||||||
|
```
|
||||||
|
|
||||||
|
Rename the affected Go identifiers, move selected files into `overlays/`, update
|
||||||
|
any handling of provenance-layer and diagnostic-code strings, and rebuild.
|
||||||
|
The maintained example helper is now `LoadNarratioOverlay` rather than
|
||||||
|
`LoadNarratioProfile`. Application CLI flag names remain application-owned;
|
||||||
|
ConfigKit does not require renaming domain-specific profile concepts.
|
||||||
|
See the [migration guide](../consumers/README.md#selected-overlay-migration).
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
- Rename the selected feature consistently across the public facade, internal
|
||||||
|
engine, diagnostics, source labels, examples, and current documentation.
|
||||||
|
- Add regression coverage for the new directory, absence of legacy fallback,
|
||||||
|
public values, explanations, and preservation of application profile fields.
|
||||||
|
- Align contributor policies with the current shared standard.
|
||||||
|
- Simplify release validation to one local minimum-toolchain check. CI is not a
|
||||||
|
release gate; successful publication of the intended tag completes the
|
||||||
|
source-only release. See the [release procedure](../release.md).
|
||||||
|
- Retire completed overlay and release-workflow planning documents to Git history.
|
||||||
42
docs/releases/v0.4.1.md
Normal file
42
docs/releases/v0.4.1.md
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
# ConfigKit v0.4.1
|
||||||
|
|
||||||
|
This release formalizes ConfigKit's licensing and upstream attribution
|
||||||
|
documentation without changing library behavior.
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
ConfigKit now includes an explicit LGPL-3.0-or-later grant in COPYRIGHT,
|
||||||
|
complete LGPLv3 and incorporated GPLv3 license texts, and centralized upstream
|
||||||
|
attribution. README and release guidance provide navigation to those materials.
|
||||||
|
|
||||||
|
## Compatibility
|
||||||
|
|
||||||
|
No Go code, public API, configuration semantics, diagnostic behavior, or
|
||||||
|
dependencies changed from v0.4.0. The minimum Go version remains 1.25, Linux
|
||||||
|
remains release-validated, and macOS remains best-effort. The YAML dependency
|
||||||
|
remains `go.yaml.in/yaml/v4 v4.0.0-rc.6`.
|
||||||
|
|
||||||
|
The project grant is explicitly LGPL-3.0-or-later. Third-party material remains
|
||||||
|
subject to its respective terms, recorded in the attribution document below.
|
||||||
|
Published earlier releases are unchanged.
|
||||||
|
|
||||||
|
## Upgrade
|
||||||
|
|
||||||
|
Update the module dependency and rebuild to select this release:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go get gitea.maximumdirect.net/eric/ConfigKit@v0.4.1
|
||||||
|
```
|
||||||
|
|
||||||
|
No application-code or configuration migration is required from v0.4.0.
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
- Add the project COPYRIGHT statement and complete standard project license texts.
|
||||||
|
- Document go-yaml attribution with exact upstream revision links and local
|
||||||
|
Apache-2.0 and MIT license texts.
|
||||||
|
- Adopt the house OSS policy and connect licensing ownership and contributor guidance.
|
||||||
|
- Add license and attribution navigation to README and future release documents,
|
||||||
|
without adding release gates or changing publication mechanics.
|
||||||
|
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.4.1/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.4.1/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.4.1/docs/oss/attribution.md)
|
||||||
45
docs/releases/v0.4.2.md
Normal file
45
docs/releases/v0.4.2.md
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
# ConfigKit v0.4.2
|
||||||
|
|
||||||
|
This patch release simplifies and safeguards source publication and aligns
|
||||||
|
maintainer policy and licensing guidance. Library behavior is unchanged.
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Maintainers can now publish a prepared release with one guarded command. It
|
||||||
|
validates the exact committed candidate, checks the authoritative destination,
|
||||||
|
and pushes only the candidate on `main` and its annotated version tag. The
|
||||||
|
[release procedure](../release.md) explains preparation and partial-publication
|
||||||
|
recovery; successful tag publication completes the source-only release without
|
||||||
|
waiting for CI or consumer retrieval.
|
||||||
|
|
||||||
|
## Compatibility
|
||||||
|
|
||||||
|
No Go code, public API, configuration semantics, diagnostic behavior, or
|
||||||
|
dependencies changed from v0.4.1. The minimum Go version remains 1.25. Linux
|
||||||
|
amd64 and arm64 remain release-validated; macOS remains best-effort. The YAML
|
||||||
|
dependency remains `go.yaml.in/yaml/v4 v4.0.0-rc.6`.
|
||||||
|
|
||||||
|
## Upgrade
|
||||||
|
|
||||||
|
Select this version and rebuild:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go get gitea.maximumdirect.net/eric/ConfigKit@v0.4.2
|
||||||
|
```
|
||||||
|
|
||||||
|
No application-code or configuration migration is required from v0.4.1.
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
- Add guarded single-command publication with exact candidate, version, and
|
||||||
|
remote checks; note-derived annotated tags; and bounded failed-push recovery.
|
||||||
|
- Keep one offline race suite, one full vet pass, and Linux amd64/arm64 builds
|
||||||
|
as release gates. Formatting and whitespace remain development checks;
|
||||||
|
dependency tidiness is reviewed when dependencies change.
|
||||||
|
- Align adopted policies and contributor guidance with their pinned upstream
|
||||||
|
revision, and include the CC BY-SA 4.0 license text and attribution for
|
||||||
|
adapted policy material. The project grant remains LGPL-3.0-or-later.
|
||||||
|
- Retire completed release-workflow and policy-alignment planning records while
|
||||||
|
preserving their history in Git. Deferred scope remains documented.
|
||||||
|
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.4.2/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.4.2/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.4.2/docs/oss/attribution.md)
|
||||||
53
docs/releases/v0.5.0.md
Normal file
53
docs/releases/v0.5.0.md
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
# ConfigKit v0.5.0
|
||||||
|
|
||||||
|
This minor release adds source-backed layered configuration and built-in sibling
|
||||||
|
inheritance, so applications can load one complete configuration while retaining
|
||||||
|
presence, source context, and explainable derivation.
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
- `LoadLayered` combines ordered underlay groups beneath the main input, selected
|
||||||
|
overlay, and explicit CLI overrides. Inputs within a group still compose
|
||||||
|
strictly; precedence tiers combine mappings recursively. The main input
|
||||||
|
remains the owner of the optional schema-version check.
|
||||||
|
- `NewFilesystem(...).File(...)` accepts caller-owned `fs.FS` sources, and
|
||||||
|
`Mapping(...)` snapshots supported built-in values as a labeled source.
|
||||||
|
`Result.SourceContext` and `Resolution.SourceContext` expose passive resource
|
||||||
|
contexts for values from file-backed sources.
|
||||||
|
- `extends` now resolves a mapping against one named sibling after source
|
||||||
|
precedence and before typed decoding. Inherited values count as explicit
|
||||||
|
input. Origins, history, explanations, and redacted rendering retain the
|
||||||
|
source and the structural path by which a value reached its destination.
|
||||||
|
Review corrections preserve immutable nested-history evidence and bounded
|
||||||
|
expansion work.
|
||||||
|
|
||||||
|
See the [configuration contract](../config.md#layered-loading),
|
||||||
|
[inheritance rules](../config.md#sibling-inheritance), and
|
||||||
|
[consumer examples](../consumers/README.md) for current behavior.
|
||||||
|
|
||||||
|
## Compatibility and upgrade
|
||||||
|
|
||||||
|
This is an intentional pre-v1 incompatible minor release for configurations
|
||||||
|
that use `extends` as ordinary data. That key is now reserved wherever an input
|
||||||
|
mapping occurs; it is consumed before decoding. Rename any such YAML key and
|
||||||
|
corresponding Go field, then rebuild. No collection registration or opt-in flag
|
||||||
|
is available. Configurations without `extends` retain their existing meaning.
|
||||||
|
|
||||||
|
Applications adopting the new features may move source-backed defaults into
|
||||||
|
explicit `Underlay` groups, use `SourceContext` for relative resources, or
|
||||||
|
replace application-owned sibling merging with one `extends` relationship per
|
||||||
|
mapping. Adoption is optional. The maintained
|
||||||
|
[named-preset example](../consumers/README.md#named-sibling-inheritance)
|
||||||
|
shows inherited `false` and destination-local nested resolution.
|
||||||
|
|
||||||
|
Select the new module version:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go get gitea.maximumdirect.net/eric/ConfigKit@v0.5.0
|
||||||
|
```
|
||||||
|
|
||||||
|
The minimum Go line remains 1.25. Linux amd64 and arm64 remain the
|
||||||
|
release-validated targets; macOS remains best-effort. The YAML dependency is
|
||||||
|
unchanged at `go.yaml.in/yaml/v4 v4.0.0-rc.6`.
|
||||||
|
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.5.0/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.5.0/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.5.0/docs/oss/attribution.md)
|
||||||
63
docs/releases/v0.6.0.md
Normal file
63
docs/releases/v0.6.0.md
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
# ConfigKit v0.6.0
|
||||||
|
|
||||||
|
This minor release reduces avoidable configuration-loading and inspection work,
|
||||||
|
adopts ReleaseKit for source publication, and raises the consumer Go minimum to
|
||||||
|
1.26.0. The public configuration model remains unchanged from v0.5.0.
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
- Reduce temporary path allocations by sizing pointer-formatting buffers,
|
||||||
|
combining final metadata traversal, reusing parsed sensitivity paths, and
|
||||||
|
avoiding path construction when detecting inheritance. Effective and
|
||||||
|
historical metadata indexes retain independently owned paths.
|
||||||
|
- Replace repeated resolution-coverage, metadata-update, CLI-overlap, and
|
||||||
|
sensitivity-propagation scans with private indexes and incremental processing.
|
||||||
|
Preserve diagnostic ordering, history, contextual path shapes, and redaction.
|
||||||
|
- Make presence-only metadata queries avoid materializing provenance. Prepare
|
||||||
|
resolution replay descriptors and immutable mapping and inheritance-history
|
||||||
|
lookups for inspection, and use ordered membership indexes for provenance
|
||||||
|
collections. Returned records remain detached; explanations still replay
|
||||||
|
complete trees and render on demand.
|
||||||
|
- Add a maintained public-API startup construction benchmark. The initial path
|
||||||
|
formatting and metadata traversal experiments reproduced allocation reductions
|
||||||
|
across local and downstream workloads. Later algorithmic improvements were
|
||||||
|
validated behaviorally without a new benchmark campaign. Busy-host timings
|
||||||
|
were inconclusive; no fixed speedup or allocation threshold is promised.
|
||||||
|
- Replace ConfigKit-owned release scripts with a small profile and the
|
||||||
|
module-selected ReleaseKit v0.3.0 tool. The
|
||||||
|
[release procedure](../release.md) documents candidate preparation, tag-only
|
||||||
|
publication, and failed-push recovery. Existing release checks and the
|
||||||
|
successful-tag-push completion point remain unchanged; CI is not a gate.
|
||||||
|
- Adopt release policy 1.6, distinguishing the consumer Go minimum from the
|
||||||
|
validation toolchain. Retire completed planning and measurement records into
|
||||||
|
Git history while preserving [deferred work](../roadmap/deferred.md).
|
||||||
|
|
||||||
|
## Compatibility and upgrade
|
||||||
|
|
||||||
|
The consumer minimum increases from Go 1.25.0 to **Go 1.26.0**. Install Go 1.26.0
|
||||||
|
or newer before upgrading, and update application build and CI environments that
|
||||||
|
still use Go 1.25. The `go.mod` directive records the consumer minimum; using a
|
||||||
|
newer validation patch does not itself raise that minimum. See the
|
||||||
|
[consumer minimum policy](../policy/release.md#consumer-minimum-and-release-toolchain).
|
||||||
|
|
||||||
|
Select this version and rebuild:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go get gitea.maximumdirect.net/eric/ConfigKit@v0.6.0
|
||||||
|
```
|
||||||
|
|
||||||
|
No application-code or configuration migration is required from v0.5.0. Public
|
||||||
|
Go signatures, strict within-tier composition, recursive tier precedence,
|
||||||
|
sibling inheritance, presence/null distinctions, provenance, secret handling,
|
||||||
|
and synchronous completion retain their existing contracts. See the
|
||||||
|
[configuration contract](../config.md) and
|
||||||
|
[consumer guide](../consumers/README.md).
|
||||||
|
|
||||||
|
The YAML dependency remains `go.yaml.in/yaml/v4 v4.0.0-rc.6`. ReleaseKit is a
|
||||||
|
declared Go tool dependency for maintainer commands, not a library runtime
|
||||||
|
import; its requirements participate in ConfigKit's module graph. Linux amd64
|
||||||
|
and arm64 remain release-validated targets, and macOS remains best-effort.
|
||||||
|
Maintainers should use the current release procedure instead of the retired
|
||||||
|
`scripts/release.sh` and `scripts/release-check.sh` commands.
|
||||||
|
|
||||||
|
[COPYRIGHT](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.6.0/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.6.0/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/ConfigKit/src/tag/v0.6.0/docs/oss/attribution.md)
|
||||||
@@ -11,11 +11,13 @@ General environment-variable configuration overlays are not supported. Typed sec
|
|||||||
references and explicit directory bootstrap are the environment convention. Literal
|
references and explicit directory bootstrap are the environment convention. Literal
|
||||||
credential configuration and implicit secret-directory discovery are unsupported.
|
credential configuration and implicit secret-directory discovery are unsupported.
|
||||||
|
|
||||||
The initial release deliberately excludes:
|
The following remain deliberately excluded:
|
||||||
|
|
||||||
- automatic `conf.d` discovery;
|
- automatic `conf.d` discovery;
|
||||||
- remote imports, arbitrary providers, and additional configuration formats;
|
- remote imports, arbitrary providers, and additional configuration formats;
|
||||||
- custom merge strategies, sequence merging, reset operators, and profile inheritance;
|
- custom merge strategies, sequence merging, reset operators, multiple-parent
|
||||||
|
inheritance, and cross-scope references;
|
||||||
|
- named overlay inheritance;
|
||||||
- parser-specific or custom structural-decoding extension APIs;
|
- parser-specific or custom structural-decoding extension APIs;
|
||||||
- generic dynamic-subtree conversion and module-registry APIs;
|
- generic dynamic-subtree conversion and module-registry APIs;
|
||||||
- automatic schema migrations;
|
- automatic schema migrations;
|
||||||
@@ -26,3 +28,24 @@ The initial release deliberately excludes:
|
|||||||
Applications may build their own validate, effective-value, source, bootstrap, and
|
Applications may build their own validate, effective-value, source, bootstrap, and
|
||||||
explanation commands around the library. Broadening these boundaries requires
|
explanation commands around the library. Broadening these boundaries requires
|
||||||
concrete consumer evidence, compatibility review, and an explicit design change.
|
concrete consumer evidence, compatibility review, and an explicit design change.
|
||||||
|
|
||||||
|
Built-in sibling inheritance using `extends` is implemented as described in the
|
||||||
|
[configuration contract](../config.md#sibling-inheritance). It is distinct from
|
||||||
|
inheritance between selected overlay files, which remains excluded above.
|
||||||
|
|
||||||
|
## Deferred performance experiments
|
||||||
|
|
||||||
|
The completed performance audit left these internal optimization candidates for
|
||||||
|
separate investigation:
|
||||||
|
|
||||||
|
- branch-local explanation replay instead of the current whole-tree replay;
|
||||||
|
- redesigning the private metadata-copy handoff while preserving detached public
|
||||||
|
records;
|
||||||
|
- caching schema descriptors across loads; and
|
||||||
|
- indexing complex contributor-trace membership while preserving its equality
|
||||||
|
rules and compact linked traces.
|
||||||
|
|
||||||
|
These are not committed implementation work. Reconsider them with evidence that
|
||||||
|
the benefit justifies the ownership, retained-memory, or equivalence risks. The
|
||||||
|
completed audit and implementation evidence are preserved in Git history at
|
||||||
|
`8e91a2b` under `docs/roadmap/`.
|
||||||
|
|||||||
@@ -29,14 +29,14 @@ type NarratioConfig struct {
|
|||||||
|
|
||||||
// LoadNarratio loads the maintained import fixture with Narratio-shaped rules.
|
// LoadNarratio loads the maintained import fixture with Narratio-shaped rules.
|
||||||
func LoadNarratio(path string) (*configkit.Result[NarratioConfig], error) {
|
func LoadNarratio(path string) (*configkit.Result[NarratioConfig], error) {
|
||||||
return LoadNarratioProfile(path, "")
|
return LoadNarratioOverlay(path, "")
|
||||||
}
|
}
|
||||||
|
|
||||||
// LoadNarratioProfile selects a ConfigKit configuration overlay independently
|
// LoadNarratioOverlay selects a ConfigKit configuration overlay independently
|
||||||
// from the application's ModelProfile field.
|
// from the application's ModelProfile field.
|
||||||
func LoadNarratioProfile(path, profile string) (*configkit.Result[NarratioConfig], error) {
|
func LoadNarratioOverlay(path, overlay string) (*configkit.Result[NarratioConfig], error) {
|
||||||
return configkit.Load(configkit.File(path), configkit.Options[NarratioConfig]{
|
return configkit.Load(configkit.File(path), configkit.Options[NarratioConfig]{
|
||||||
Imports: true, Profile: profile,
|
Imports: true, Overlay: overlay,
|
||||||
Definition: configkit.Definition[NarratioConfig]{
|
Definition: configkit.Definition[NarratioConfig]{
|
||||||
Defaults: func() NarratioConfig { return NarratioConfig{PollInterval: time.Minute} },
|
Defaults: func() NarratioConfig { return NarratioConfig{PollInterval: time.Minute} },
|
||||||
Resolve: resolveNarratio,
|
Resolve: resolveNarratio,
|
||||||
|
|||||||
@@ -52,6 +52,22 @@ func Example_seriatim() {
|
|||||||
// Output: visitor true the event occurred <nil> <nil>
|
// Output: visitor true the event occurred <nil> <nil>
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func Example_inheritedPresets() {
|
||||||
|
result, err := consumers.LoadPresets(configkit.File(fixture("inheritance", "presets.yml")))
|
||||||
|
if err != nil {
|
||||||
|
fmt.Println(err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
path := configkit.Keys("presets", "custom", "enabled")
|
||||||
|
info, _ := result.Metadata().Lookup(path)
|
||||||
|
custom := result.Config.Presets["custom"]
|
||||||
|
fmt.Println(custom.Enabled, result.Metadata().IsExplicit(path), custom.Settings["secondary"]["width"])
|
||||||
|
fmt.Println(info.Origin.Locations[0].SourceID, info.Origin.Inheritance[0].From)
|
||||||
|
// Output:
|
||||||
|
// false true 20
|
||||||
|
// source-1 /presets/base/enabled
|
||||||
|
}
|
||||||
|
|
||||||
func Example_weatherStartup() {
|
func Example_weatherStartup() {
|
||||||
const blockedName = "CONFIGKIT_WEATHER_EXAMPLE_BLOCKED"
|
const blockedName = "CONFIGKIT_WEATHER_EXAMPLE_BLOCKED"
|
||||||
const tokenName = "CONFIGKIT_WEATHER_EXAMPLE_TOKEN"
|
const tokenName = "CONFIGKIT_WEATHER_EXAMPLE_TOKEN"
|
||||||
@@ -92,10 +108,13 @@ func TestMaintainedConsumerFixturesPreserveDomainOutcomes(t *testing.T) {
|
|||||||
if origin, ok := narratio.Metadata().Lookup(configkit.Keys("artifacts", "transcript", "output")); !ok || origin.Origin.Layer != configkit.LayerResolution {
|
if origin, ok := narratio.Metadata().Lookup(configkit.Keys("artifacts", "transcript", "output")); !ok || origin.Origin.Layer != configkit.LayerResolution {
|
||||||
t.Fatalf("artifact origin = %#v, %v", origin, ok)
|
t.Fatalf("artifact origin = %#v, %v", origin, ok)
|
||||||
}
|
}
|
||||||
profiled, err := consumers.LoadNarratioProfile(fixture("narratio", "pipeline.yml"), "testing")
|
overlaid, err := consumers.LoadNarratioOverlay(fixture("narratio", "pipeline.yml"), "testing")
|
||||||
if err != nil || profiled.Config.PollInterval.String() != "2m0s" ||
|
if err != nil || overlaid.Config.PollInterval.String() != "2m0s" ||
|
||||||
profiled.Config.ModelProfile != "concise" || len(profiled.Sources()) != 3 {
|
overlaid.Config.ModelProfile != "concise" || len(overlaid.Sources()) != 3 {
|
||||||
t.Fatalf("configuration/application profiles = %#v, %v", profiled, err)
|
t.Fatalf("configuration overlay and application model profile = %#v, %v", overlaid, err)
|
||||||
|
}
|
||||||
|
if source := overlaid.Sources()[2]; source.Label != "overlays/testing.yml" || source.Layer != configkit.LayerOverlay {
|
||||||
|
t.Fatalf("Narratio overlay source = %#v", source)
|
||||||
}
|
}
|
||||||
|
|
||||||
notarius, err := consumers.LoadNotarius(fixture("notarius", "config.yml"))
|
notarius, err := consumers.LoadNotarius(fixture("notarius", "config.yml"))
|
||||||
@@ -200,7 +219,7 @@ func TestMigrationFixturesFailWithStableCodesAndPaths(t *testing.T) {
|
|||||||
if len(diagnostics) == 0 || diagnostics[0].Code != test.code || diagnostics[0].Path.String() != test.path {
|
if len(diagnostics) == 0 || diagnostics[0].Code != test.code || diagnostics[0].Path.String() != test.path {
|
||||||
t.Fatalf("diagnostics = %#v", diagnostics)
|
t.Fatalf("diagnostics = %#v", diagnostics)
|
||||||
}
|
}
|
||||||
if strings.Contains(diagnostics[0].Message, "wrong-before-profile") {
|
if strings.Contains(diagnostics[0].Message, "wrong-before-overlay") {
|
||||||
t.Fatalf("diagnostic exposed raw parser input: %#v", diagnostics[0])
|
t.Fatalf("diagnostic exposed raw parser input: %#v", diagnostics[0])
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|||||||
20
examples/consumers/inheritance.go
Normal file
20
examples/consumers/inheritance.go
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
package consumers
|
||||||
|
|
||||||
|
import configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
|
||||||
|
// PresetCatalog is ordinary application data; no inheritance fields or
|
||||||
|
// registration hooks are required in the typed configuration.
|
||||||
|
type PresetCatalog struct {
|
||||||
|
Presets map[string]Preset `yaml:"presets"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Preset struct {
|
||||||
|
Enabled bool `yaml:"enabled"`
|
||||||
|
Settings map[string]map[string]int `yaml:"settings"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadPresets performs one load; callers may inspect inherited presence and
|
||||||
|
// source origins on the returned result before choosing a preset to execute.
|
||||||
|
func LoadPresets(source configkit.Source) (*configkit.Result[PresetCatalog], error) {
|
||||||
|
return configkit.Load[PresetCatalog](source)
|
||||||
|
}
|
||||||
35
examples/consumers/inheritance_test.go
Normal file
35
examples/consumers/inheritance_test.go
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
package consumers_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
"gitea.maximumdirect.net/eric/ConfigKit/examples/consumers"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestPresetCatalogOneLoadAndDerivation(t *testing.T) {
|
||||||
|
result, err := consumers.LoadPresets(configkit.File(fixture("inheritance", "presets.yml")))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if result.Config.Presets["base"].Settings["secondary"]["width"] != 10 ||
|
||||||
|
result.Config.Presets["custom"].Settings["secondary"]["width"] != 20 ||
|
||||||
|
result.Config.Presets["custom"].Enabled {
|
||||||
|
t.Fatalf("expanded presets = %#v", result.Config.Presets)
|
||||||
|
}
|
||||||
|
enabled := configkit.Keys("presets", "custom", "enabled")
|
||||||
|
if !result.Metadata().IsExplicit(enabled) {
|
||||||
|
t.Fatal("inherited false lost explicit presence")
|
||||||
|
}
|
||||||
|
info, found := result.Metadata().Lookup(enabled)
|
||||||
|
if !found || info.Origin.Locations[0].SourceID != "source-1" ||
|
||||||
|
len(info.Origin.Inheritance) != 1 || info.Origin.Inheritance[0].From.String() != "/presets/base/enabled" {
|
||||||
|
t.Fatalf("origin and derivation = %#v, %v", info, found)
|
||||||
|
}
|
||||||
|
nested := configkit.Keys("presets", "custom", "settings", "secondary", "width")
|
||||||
|
info, found = result.Metadata().Lookup(nested)
|
||||||
|
if !found || len(info.Origin.Inheritance) != 1 ||
|
||||||
|
info.Origin.Inheritance[0].From.String() != "/presets/custom/settings/primary/width" {
|
||||||
|
t.Fatalf("destination-local derivation = %#v, %v", info, found)
|
||||||
|
}
|
||||||
|
}
|
||||||
95
examples/consumers/layered.go
Normal file
95
examples/consumers/layered.go
Normal file
@@ -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
|
||||||
|
}
|
||||||
71
examples/consumers/layered_test.go
Normal file
71
examples/consumers/layered_test.go
Normal file
@@ -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)
|
||||||
|
}
|
||||||
|
}
|
||||||
10
examples/consumers/testdata/inheritance/presets.yml
vendored
Normal file
10
examples/consumers/testdata/inheritance/presets.yml
vendored
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
presets:
|
||||||
|
base:
|
||||||
|
enabled: false
|
||||||
|
settings:
|
||||||
|
primary: {width: 10}
|
||||||
|
secondary: {extends: primary}
|
||||||
|
custom:
|
||||||
|
extends: base
|
||||||
|
settings:
|
||||||
|
primary: {width: 20}
|
||||||
7
examples/consumers/testdata/layered-bundle/defaults/config.yml
vendored
Normal file
7
examples/consumers/testdata/layered-bundle/defaults/config.yml
vendored
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
configkit:
|
||||||
|
imports:
|
||||||
|
- path: ../shared.yml
|
||||||
|
enabled: true
|
||||||
|
workers: 4
|
||||||
|
templates:
|
||||||
|
welcome: messages/welcome.txt
|
||||||
1
examples/consumers/testdata/layered-bundle/defaults/messages/welcome.txt
vendored
Normal file
1
examples/consumers/testdata/layered-bundle/defaults/messages/welcome.txt
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
Welcome from the bundle.
|
||||||
2
examples/consumers/testdata/layered-bundle/shared.yml
vendored
Normal file
2
examples/consumers/testdata/layered-bundle/shared.yml
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
labels:
|
||||||
|
origin: bundle
|
||||||
3
examples/consumers/testdata/layered-main/config.yml
vendored
Normal file
3
examples/consumers/testdata/layered-main/config.yml
vendored
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
mode: production
|
||||||
|
enabled: false
|
||||||
|
workers: 0
|
||||||
1
examples/consumers/testdata/layered-main/invalid.yml
vendored
Normal file
1
examples/consumers/testdata/layered-main/invalid.yml
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
mode: unsupported
|
||||||
2
examples/consumers/testdata/native-source/config.yml
vendored
Normal file
2
examples/consumers/testdata/native-source/config.yml
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
name: embedded
|
||||||
|
enabled: false
|
||||||
@@ -31,6 +31,9 @@ func TestFacadeValuesRemainRootOwned(t *testing.T) {
|
|||||||
reflect.TypeFor[configkit.Resolution](), reflect.TypeFor[configkit.Validation](),
|
reflect.TypeFor[configkit.Resolution](), reflect.TypeFor[configkit.Validation](),
|
||||||
reflect.TypeFor[configkit.Version](), reflect.TypeFor[configkit.VersionRule](),
|
reflect.TypeFor[configkit.Version](), reflect.TypeFor[configkit.VersionRule](),
|
||||||
reflect.TypeFor[configkit.FilesystemContext](), reflect.TypeFor[configkit.Override](),
|
reflect.TypeFor[configkit.FilesystemContext](), reflect.TypeFor[configkit.Override](),
|
||||||
|
reflect.TypeFor[configkit.Filesystem](), reflect.TypeFor[configkit.ResourceContext](),
|
||||||
|
reflect.TypeFor[configkit.Input](), reflect.TypeFor[configkit.Underlay](),
|
||||||
|
reflect.TypeFor[configkit.LayeredOptions[struct{}]](),
|
||||||
reflect.TypeFor[configkit.Definition[struct{}]](), reflect.TypeFor[configkit.Options[struct{}]](),
|
reflect.TypeFor[configkit.Definition[struct{}]](), reflect.TypeFor[configkit.Options[struct{}]](),
|
||||||
reflect.TypeFor[configkit.Result[struct{}]](),
|
reflect.TypeFor[configkit.Result[struct{}]](),
|
||||||
reflect.TypeFor[configkit.ValueSnapshot](), reflect.TypeFor[configkit.ValueChange](),
|
reflect.TypeFor[configkit.ValueSnapshot](), reflect.TypeFor[configkit.ValueChange](),
|
||||||
|
|||||||
@@ -26,6 +26,7 @@ func TestFacadeInactiveContextsPreserveClosedFailure(t *testing.T) {
|
|||||||
{"IsExplicit", func() { state.resolution.IsExplicit(path) }},
|
{"IsExplicit", func() { state.resolution.IsExplicit(path) }},
|
||||||
{"InputInfo", func() { state.resolution.InputInfo(path) }},
|
{"InputInfo", func() { state.resolution.InputInfo(path) }},
|
||||||
{"Source", func() { state.resolution.Source("source") }},
|
{"Source", func() { state.resolution.Source("source") }},
|
||||||
|
{"SourceContext", func() { state.resolution.SourceContext("source") }},
|
||||||
{"Record", func() { state.resolution.Record(path, configkit.ChangeNormalization, "reason") }},
|
{"Record", func() { state.resolution.Record(path, configkit.ChangeNormalization, "reason") }},
|
||||||
{"Resolution.Error", func() { state.resolution.Error(path, "message") }},
|
{"Resolution.Error", func() { state.resolution.Error(path, "message") }},
|
||||||
{"Resolution.Warning", func() { state.resolution.Warning(path, "message") }},
|
{"Resolution.Warning", func() { state.resolution.Warning(path, "message") }},
|
||||||
|
|||||||
164
facade_equivalence_test.go
Normal file
164
facade_equivalence_test.go
Normal file
@@ -0,0 +1,164 @@
|
|||||||
|
package configkit_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"testing/fstest"
|
||||||
|
|
||||||
|
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
)
|
||||||
|
|
||||||
|
type equivalentConfig struct {
|
||||||
|
Version uint64 `yaml:"version"`
|
||||||
|
Name string `yaml:"name"`
|
||||||
|
Enabled bool `yaml:"enabled"`
|
||||||
|
Count int `yaml:"count"`
|
||||||
|
Items []string `yaml:"items"`
|
||||||
|
Optional *string `yaml:"optional"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEquivalentSourceFormsPreserveInputSemantics(t *testing.T) {
|
||||||
|
const yaml = "version: 1\nname: retained\nenabled: false\ncount: 0\nitems: []\noptional: null\n"
|
||||||
|
hostPath := filepath.Join(t.TempDir(), "main.yml")
|
||||||
|
if err := os.WriteFile(hostPath, []byte(yaml), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
namespace := configkit.NewFilesystem("bundle", fstest.MapFS{"main.yml": &fstest.MapFile{Data: []byte(yaml)}})
|
||||||
|
context := &configkit.FilesystemContext{Root: ".", BaseDir: ".", FS: &namespace}
|
||||||
|
for _, test := range []struct {
|
||||||
|
name string
|
||||||
|
source configkit.Source
|
||||||
|
context *configkit.FilesystemContext
|
||||||
|
kind configkit.SourceKind
|
||||||
|
}{
|
||||||
|
{"host", configkit.File(hostPath), nil, configkit.SourceKindFile},
|
||||||
|
{"native", namespace.File("main.yml"), nil, configkit.SourceKindFilesystem},
|
||||||
|
{"bytes", configkit.Bytes("memory", []byte(yaml)), context, configkit.SourceKindBytes},
|
||||||
|
{"reader", configkit.Reader("stream", strings.NewReader(yaml)), context, configkit.SourceKindReader},
|
||||||
|
{"mapping", configkit.Mapping("programmatic", map[string]any{
|
||||||
|
"version": uint64(1), "name": "retained", "enabled": false, "count": 0,
|
||||||
|
"items": []any{}, "optional": nil,
|
||||||
|
}), context, configkit.SourceKindMapping},
|
||||||
|
} {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
checks := 0
|
||||||
|
result, err := configkit.LoadLayered(configkit.Input{Source: test.source, Filesystem: test.context}, configkit.LayeredOptions[equivalentConfig]{
|
||||||
|
Definition: configkit.Definition[equivalentConfig]{Version: &configkit.VersionRule{
|
||||||
|
Path: configkit.Keys("version"), Check: func(version configkit.Version, validation *configkit.Validation) error {
|
||||||
|
checks++
|
||||||
|
if !version.Present || version.Text != "1" {
|
||||||
|
t.Errorf("version = %#v", version)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
}},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
want := equivalentConfig{Version: 1, Name: "retained", Items: []string{}}
|
||||||
|
if !reflect.DeepEqual(result.Config, want) || checks != 1 {
|
||||||
|
t.Fatalf("config = %#v, checks %d", result.Config, checks)
|
||||||
|
}
|
||||||
|
for _, field := range []string{"version", "name", "enabled", "count", "items", "optional"} {
|
||||||
|
info, ok := result.Metadata().Lookup(configkit.Keys(field))
|
||||||
|
if !ok || !info.Explicit || info.Origin.Layer != configkit.LayerBase || info.Null != (field == "optional") {
|
||||||
|
t.Errorf("%s input info = %#v, %v", field, info, ok)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sources := result.Sources()
|
||||||
|
if len(sources) != 1 || sources[0].Kind != test.kind || sources[0].ID != "source-1" || sources[0].UnderlayIndex != 0 {
|
||||||
|
t.Fatalf("sources = %#v", sources)
|
||||||
|
}
|
||||||
|
resource, ok := result.SourceContext("source-1")
|
||||||
|
if !ok || resource.BaseDir != "." || resource.FS == nil {
|
||||||
|
t.Fatalf("source context = %#v, %v", resource, ok)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRepeatedImportsAcrossTiersAndReaderConsumption(t *testing.T) {
|
||||||
|
namespace := configkit.NewFilesystem("bundle", fstest.MapFS{
|
||||||
|
"left.yml": &fstest.MapFile{Data: []byte("configkit: {imports: [{path: shared.yml}]}\n")},
|
||||||
|
"right.yml": &fstest.MapFile{Data: []byte("configkit: {imports: [{path: shared.yml}]}\n")},
|
||||||
|
"shared.yml": &fstest.MapFile{Data: []byte("name: retained\n")},
|
||||||
|
})
|
||||||
|
type config struct {
|
||||||
|
Name string `yaml:"name"`
|
||||||
|
}
|
||||||
|
left := configkit.Input{Source: namespace.File("left.yml"), Imports: true}
|
||||||
|
right := configkit.Input{Source: namespace.File("right.yml"), Imports: true}
|
||||||
|
_, err := configkit.LoadLayered(configkit.Input{Source: configkit.NoSource()}, configkit.LayeredOptions[config]{
|
||||||
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{left, right}}},
|
||||||
|
})
|
||||||
|
if got := layeredErrorCode(t, err); got != configkit.CodeImportRepeated {
|
||||||
|
t.Fatalf("same-tier repeated import = %s", got)
|
||||||
|
}
|
||||||
|
result, err := configkit.LoadLayered(configkit.Input{Source: configkit.NoSource()}, configkit.LayeredOptions[config]{
|
||||||
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{left}}, {Inputs: []configkit.Input{right}}},
|
||||||
|
})
|
||||||
|
if err != nil || result.Config.Name != "retained" || len(result.Sources()) != 4 {
|
||||||
|
t.Fatalf("cross-tier repeated import = %#v, %v", result, err)
|
||||||
|
}
|
||||||
|
reader := configkit.Reader("single-use", strings.NewReader("name: retained\n"))
|
||||||
|
_, err = configkit.LoadLayered(configkit.Input{Source: configkit.NoSource()}, configkit.LayeredOptions[config]{
|
||||||
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{{Source: reader}}}, {Inputs: []configkit.Input{{Source: reader}}}},
|
||||||
|
})
|
||||||
|
if got := layeredErrorCode(t, err); got != configkit.CodeSourceReaderUsed {
|
||||||
|
t.Fatalf("reader re-consumption = %s", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReplacedSecretRemainsAbsentFromSafeOutput(t *testing.T) {
|
||||||
|
type config struct {
|
||||||
|
Secret string `yaml:"secret"`
|
||||||
|
}
|
||||||
|
result, err := configkit.LoadLayered(configkit.Input{Source: configkit.Bytes("main", []byte("secret: new-secret-canary\n"))}, configkit.LayeredOptions[config]{
|
||||||
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{{Source: configkit.Mapping("lower", map[string]any{"secret": "old-secret-canary"})}}}},
|
||||||
|
Definition: configkit.Definition[config]{Secret: func(path configkit.Path) bool { return path.String() == "/secret" }},
|
||||||
|
})
|
||||||
|
if err != nil || result.Config.Secret != "new-secret-canary" {
|
||||||
|
t.Fatalf("secret load = %#v, %v", result, err)
|
||||||
|
}
|
||||||
|
var effective, history bytes.Buffer
|
||||||
|
if err := result.WriteEffective(&effective); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := result.WriteExplanation(&history, configkit.Keys("secret")); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if strings.Contains(effective.String()+history.String(), "old-secret-canary") || strings.Contains(effective.String()+history.String(), "new-secret-canary") {
|
||||||
|
t.Fatalf("secret output leaked: %q %q", effective.String(), history.String())
|
||||||
|
}
|
||||||
|
_, err = configkit.LoadLayered(configkit.Input{Source: configkit.Bytes("main", []byte("secret: new-secret-canary\n"))}, configkit.LayeredOptions[config]{
|
||||||
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{{Source: configkit.Mapping("lower", map[string]any{"secret": "old-secret-canary"})}}}},
|
||||||
|
Definition: configkit.Definition[config]{Validate: func(config *config, validation *configkit.Validation) {
|
||||||
|
validation.Error(configkit.Keys("secret"), "invalid secret")
|
||||||
|
}},
|
||||||
|
})
|
||||||
|
loadError, ok := err.(*configkit.LoadError)
|
||||||
|
if !ok {
|
||||||
|
t.Fatalf("validation error = %#v", err)
|
||||||
|
}
|
||||||
|
var diagnostics bytes.Buffer
|
||||||
|
if err := configkit.WriteDiagnostics(&diagnostics, loadError.Diagnostics()); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if strings.Contains(diagnostics.String(), "secret-canary") {
|
||||||
|
t.Fatalf("diagnostic leaked secret: %q", diagnostics.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func layeredErrorCode(t *testing.T, err error) configkit.Code {
|
||||||
|
t.Helper()
|
||||||
|
loadError, ok := err.(*configkit.LoadError)
|
||||||
|
if !ok || len(loadError.Diagnostics()) == 0 {
|
||||||
|
t.Fatalf("load error = %#v", err)
|
||||||
|
}
|
||||||
|
return loadError.Diagnostics()[0].Code
|
||||||
|
}
|
||||||
142
facade_filesystem_test.go
Normal file
142
facade_filesystem_test.go
Normal file
@@ -0,0 +1,142 @@
|
|||||||
|
package configkit_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"embed"
|
||||||
|
"io/fs"
|
||||||
|
"reflect"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"testing/fstest"
|
||||||
|
|
||||||
|
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
)
|
||||||
|
|
||||||
|
//go:embed testdata/filesystem
|
||||||
|
var filesystemFixtures embed.FS
|
||||||
|
|
||||||
|
type filesystemFacadeConfig struct {
|
||||||
|
Items map[string]string `yaml:"items"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeFilesystemSourceImportsOverlayAndReuse(t *testing.T) {
|
||||||
|
fixture, err := fs.Sub(filesystemFixtures, "testdata/filesystem")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
namespace := configkit.NewFilesystem("embedded", fixture)
|
||||||
|
copyOfNamespace := namespace
|
||||||
|
source := namespace.File("config/main.yml")
|
||||||
|
for range 2 {
|
||||||
|
result, err := configkit.Load(source, configkit.Options[filesystemFacadeConfig]{
|
||||||
|
Imports: true, Overlay: "testing", Filesystem: &configkit.FilesystemContext{FS: ©OfNamespace},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if want := (map[string]string{"main": "selected", "shared": "default"}); !reflect.DeepEqual(result.Config.Items, want) {
|
||||||
|
t.Fatalf("items = %#v, want %#v", result.Config.Items, want)
|
||||||
|
}
|
||||||
|
sources := result.Sources()
|
||||||
|
if len(sources) != 3 {
|
||||||
|
t.Fatalf("sources = %#v", sources)
|
||||||
|
}
|
||||||
|
for index, want := range []string{"config/main.yml", "shared.yml", "overlays/testing.yml"} {
|
||||||
|
if sources[index].ID != "source-"+strconv.Itoa(index+1) || sources[index].Path != want || sources[index].Kind != configkit.SourceKindFilesystem {
|
||||||
|
t.Errorf("source %d = %#v", index, sources[index])
|
||||||
|
}
|
||||||
|
if sources[index].Label != "embedded/"+want {
|
||||||
|
t.Errorf("source label = %q", sources[index].Label)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if sources[1].ImportedFrom == nil || sources[1].ImportedFrom.SourceID != sources[0].ID || sources[1].ImportedFrom.Line == 0 {
|
||||||
|
t.Fatalf("import location = %#v", sources[1].ImportedFrom)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeFilesystemContextsAndIdentity(t *testing.T) {
|
||||||
|
first := configkit.NewFilesystem("same", fstest.MapFS{
|
||||||
|
"root/config/main.yml": &fstest.MapFile{Data: []byte("configkit: {imports: [{path: ../shared.yml}]}\n")},
|
||||||
|
"root/shared.yml": &fstest.MapFile{Data: []byte("items: {value: first}\n")},
|
||||||
|
"root/overlays/testing.yml": &fstest.MapFile{Data: []byte("items: {overlay: first}\n")},
|
||||||
|
})
|
||||||
|
second := configkit.NewFilesystem("same", fstest.MapFS{
|
||||||
|
"root/config/main.yml": &fstest.MapFile{Data: []byte("items: {value: second}\n")},
|
||||||
|
})
|
||||||
|
context := &configkit.FilesystemContext{Root: "root", FS: &first}
|
||||||
|
result, err := configkit.Load(first.File("root/config/main.yml"), configkit.Options[filesystemFacadeConfig]{Imports: true, Overlay: "testing", Filesystem: context})
|
||||||
|
if err != nil || result.Config.Items["value"] != "first" || result.Config.Items["overlay"] != "first" {
|
||||||
|
t.Fatalf("contained load = %#v, %v", result, err)
|
||||||
|
}
|
||||||
|
result, err = configkit.Load[filesystemFacadeConfig](second.File("root/config/main.yml"))
|
||||||
|
if err != nil || result.Config.Items["value"] != "second" {
|
||||||
|
t.Fatalf("same-label independent namespace = %#v, %v", result, err)
|
||||||
|
}
|
||||||
|
checkCode(t, second.File("root/config/main.yml"), configkit.Options[filesystemFacadeConfig]{Filesystem: context}, configkit.CodeOptionsInvalid)
|
||||||
|
checkCode(t, first.File("root/config/main.yml"), configkit.Options[filesystemFacadeConfig]{Filesystem: &configkit.FilesystemContext{Root: "root/config", FS: &first}, Imports: true}, configkit.CodeImportOutsideRoot)
|
||||||
|
checkCode(t, configkit.File("testdata/filesystem/config/main.yml"), configkit.Options[filesystemFacadeConfig]{Filesystem: context}, configkit.CodeOptionsInvalid)
|
||||||
|
|
||||||
|
for _, input := range []struct {
|
||||||
|
name string
|
||||||
|
source configkit.Source
|
||||||
|
kind configkit.SourceKind
|
||||||
|
}{
|
||||||
|
{"bytes", configkit.Bytes("memory", []byte("configkit: {imports: [{path: shared.yml}]}\n")), configkit.SourceKindBytes},
|
||||||
|
{"reader", configkit.Reader("stream", strings.NewReader("configkit: {imports: [{path: shared.yml}]}\n")), configkit.SourceKindReader},
|
||||||
|
} {
|
||||||
|
t.Run(input.name, func(t *testing.T) {
|
||||||
|
result, err := configkit.Load(input.source, configkit.Options[filesystemFacadeConfig]{Imports: true, Filesystem: &configkit.FilesystemContext{Root: "root", BaseDir: "root", FS: &first}})
|
||||||
|
if err != nil || result.Config.Items["value"] != "first" {
|
||||||
|
t.Fatalf("synthetic import = %#v, %v", result, err)
|
||||||
|
}
|
||||||
|
if got := result.Sources(); len(got) != 2 || got[0].Kind != input.kind || got[0].Path != "" || got[1].Kind != configkit.SourceKindFilesystem {
|
||||||
|
t.Fatalf("sources = %#v", got)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
checkCode(t, configkit.Bytes("memory", []byte("items: {}\n")), configkit.Options[filesystemFacadeConfig]{Filesystem: &configkit.FilesystemContext{Root: "root", BaseDir: ".", FS: &first}}, configkit.CodeImportOutsideRoot)
|
||||||
|
result, err = configkit.Load(configkit.Bytes("memory", []byte("items: {value: main}\n")), configkit.Options[filesystemFacadeConfig]{
|
||||||
|
Overlay: "testing", Filesystem: &configkit.FilesystemContext{Root: "root", BaseDir: "root", FS: &first},
|
||||||
|
})
|
||||||
|
if err != nil || result.Config.Items["value"] != "main" || result.Config.Items["overlay"] != "first" {
|
||||||
|
t.Fatalf("synthetic selected overlay = %#v, %v", result, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeSourceKindsIncludeHostAndCLI(t *testing.T) {
|
||||||
|
result, err := configkit.Load(configkit.File("testdata/filesystem/shared.yml"), configkit.Options[filesystemFacadeConfig]{
|
||||||
|
Overrides: []configkit.Override{{Path: configkit.Keys("items", "shared"), Value: "changed", Flag: "--shared"}},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
sources := result.Sources()
|
||||||
|
if len(sources) != 2 || sources[0].Kind != configkit.SourceKindFile || sources[0].Path == "" || sources[1].Kind != configkit.SourceKindCLI || sources[1].Path != "" {
|
||||||
|
t.Fatalf("host and CLI sources = %#v", sources)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeFilesystemConstructorDiagnostics(t *testing.T) {
|
||||||
|
var nilFilesystem fs.FS
|
||||||
|
var zero configkit.Filesystem
|
||||||
|
for _, source := range []configkit.Source{
|
||||||
|
zero.File("main.yml"),
|
||||||
|
configkit.NewFilesystem("", fstest.MapFS{}).File("main.yml"),
|
||||||
|
configkit.NewFilesystem("bad\nlabel", fstest.MapFS{}).File("main.yml"),
|
||||||
|
configkit.NewFilesystem("good", nilFilesystem).File("main.yml"),
|
||||||
|
configkit.NewFilesystem("good", fstest.MapFS{}).File("."),
|
||||||
|
configkit.NewFilesystem("good", fstest.MapFS{}).File("../outside.yml"),
|
||||||
|
} {
|
||||||
|
checkCode(t, source, configkit.Options[filesystemFacadeConfig]{}, configkit.CodeSourceInvalid)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func checkCode(t *testing.T, source configkit.Source, options configkit.Options[filesystemFacadeConfig], want configkit.Code) {
|
||||||
|
t.Helper()
|
||||||
|
_, err := configkit.Load(source, options)
|
||||||
|
loadError, ok := err.(*configkit.LoadError)
|
||||||
|
if !ok || len(loadError.Diagnostics()) == 0 || loadError.Diagnostics()[0].Code != want {
|
||||||
|
t.Fatalf("error = %#v, want %s", err, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
284
facade_inheritance_test.go
Normal file
284
facade_inheritance_test.go
Normal file
@@ -0,0 +1,284 @@
|
|||||||
|
package configkit_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"io/fs"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"testing/fstest"
|
||||||
|
|
||||||
|
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
)
|
||||||
|
|
||||||
|
type inheritedEntry struct {
|
||||||
|
Enabled bool `yaml:"enabled"`
|
||||||
|
Count int `yaml:"count"`
|
||||||
|
Resource string `yaml:"resource"`
|
||||||
|
Settings map[string]map[string]string `yaml:"settings"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type inheritedConfiguration struct {
|
||||||
|
Version string `yaml:"version"`
|
||||||
|
Entries map[string]inheritedEntry `yaml:"entries"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeInheritancePreservesPresenceOriginsAndHistory(t *testing.T) {
|
||||||
|
input := []byte(`entries:
|
||||||
|
parent:
|
||||||
|
enabled: false
|
||||||
|
count: 0
|
||||||
|
settings:
|
||||||
|
primary: {value: original}
|
||||||
|
secondary: {extends: primary}
|
||||||
|
child:
|
||||||
|
extends: parent
|
||||||
|
settings:
|
||||||
|
primary: {value: custom}
|
||||||
|
`)
|
||||||
|
defaultRan := false
|
||||||
|
result, err := configkit.Load(configkit.Bytes("config.yml", input), configkit.Options[inheritedConfiguration]{Definition: configkit.Definition[inheritedConfiguration]{
|
||||||
|
Resolve: func(config *inheritedConfiguration, resolution *configkit.Resolution) error {
|
||||||
|
if !resolution.IsExplicit(configkit.Keys("entries", "child", "enabled")) {
|
||||||
|
t.Error("inherited false is not explicit")
|
||||||
|
}
|
||||||
|
info, found := resolution.InputInfo(configkit.Keys("entries", "child", "enabled"))
|
||||||
|
if !found || len(info.Origin.Inheritance) != 1 {
|
||||||
|
t.Errorf("resolver inherited origin = %#v, %v", info, found)
|
||||||
|
}
|
||||||
|
child := config.Entries["child"]
|
||||||
|
configkit.Default(resolution, configkit.Keys("entries", "child", "enabled"), &child.Enabled, true, "use fallback")
|
||||||
|
defaultRan = child.Enabled
|
||||||
|
config.Entries["child"] = child
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
}})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
child := result.Config.Entries["child"]
|
||||||
|
if defaultRan || child.Enabled || child.Count != 0 || child.Settings["secondary"]["value"] != "custom" {
|
||||||
|
t.Fatalf("inherited values = %#v, default ran %v", child, defaultRan)
|
||||||
|
}
|
||||||
|
path := configkit.Keys("entries", "child", "settings", "secondary", "value")
|
||||||
|
info, found := result.Metadata().Lookup(path)
|
||||||
|
if !found || !info.Explicit || len(info.Origin.Inheritance) != 1 ||
|
||||||
|
info.Origin.Inheritance[0].From.String() != "/entries/child/settings/primary/value" ||
|
||||||
|
info.Origin.Inheritance[0].To.String() != path.String() {
|
||||||
|
t.Fatalf("nested destination origin = %#v, %v", info, found)
|
||||||
|
}
|
||||||
|
info.Origin.Inheritance[0].Locations[0].SourceID = "mutated"
|
||||||
|
info, _ = result.Metadata().Lookup(path)
|
||||||
|
if info.Origin.Inheritance[0].Locations[0].SourceID == "mutated" {
|
||||||
|
t.Fatal("public inheritance record aliases inspection state")
|
||||||
|
}
|
||||||
|
if _, found := result.Metadata().Lookup(configkit.Keys("entries", "child", "extends")); found {
|
||||||
|
t.Fatal("consumed directive remained effective")
|
||||||
|
}
|
||||||
|
control, found := result.Explain(configkit.Keys("entries", "child", "extends"))
|
||||||
|
if !found || control.Effective.Present || len(control.History) < 2 ||
|
||||||
|
control.History[len(control.History)-1].Origin.Operation != configkit.ChangeInheritance {
|
||||||
|
t.Fatalf("consumed directive = %#v, %v", control, found)
|
||||||
|
}
|
||||||
|
explanation, found := result.Explain(path)
|
||||||
|
if !found || explanation.Effective.YAML != "custom\n" {
|
||||||
|
t.Fatalf("nested explanation = %#v, %v", explanation, found)
|
||||||
|
}
|
||||||
|
for _, change := range explanation.History {
|
||||||
|
if change.Origin.Operation == configkit.ChangeDecoding {
|
||||||
|
t.Fatalf("inherited value attributed to decoding: %#v", explanation.History)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeInheritanceLayeredPrecedenceAndSourceContext(t *testing.T) {
|
||||||
|
filesystem := configkit.NewFilesystem("bundle", fstest.MapFS{
|
||||||
|
"config/main.yml": &fstest.MapFile{Data: []byte("entries: {child: {extends: parent}}\n")},
|
||||||
|
"shared/parent.yml": &fstest.MapFile{Data: []byte("entries: {parent: {resource: icon.txt, count: 1}}\n")},
|
||||||
|
"shared/flags.yml": &fstest.MapFile{Data: []byte("entries: {parent: {enabled: false}}\n")},
|
||||||
|
"shared/icon.txt": &fstest.MapFile{Data: []byte("parent-resource")},
|
||||||
|
"config/overlays/test.yml": &fstest.MapFile{Data: []byte("entries: {parent: {count: 2}}\n")},
|
||||||
|
})
|
||||||
|
result, err := configkit.LoadLayered(configkit.Input{Source: filesystem.File("config/main.yml")}, configkit.LayeredOptions[inheritedConfiguration]{
|
||||||
|
Underlays: []configkit.Underlay{
|
||||||
|
{Inputs: []configkit.Input{{Source: filesystem.File("shared/parent.yml")}}},
|
||||||
|
{Inputs: []configkit.Input{{Source: filesystem.File("shared/flags.yml")}}},
|
||||||
|
},
|
||||||
|
Overlay: "test", OverlayFilesystem: &configkit.FilesystemContext{Root: "config", BaseDir: "config", FS: &filesystem},
|
||||||
|
Overrides: []configkit.Override{{Path: configkit.Keys("entries", "child", "count"), Value: 3, Flag: "--count"}},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
child := result.Config.Entries["child"]
|
||||||
|
if child.Count != 3 || child.Resource != "icon.txt" {
|
||||||
|
t.Fatalf("layered inheritance = %#v", child)
|
||||||
|
}
|
||||||
|
info, found := result.Metadata().Lookup(configkit.Keys("entries", "child", "resource"))
|
||||||
|
if !found || len(info.Origin.Inheritance) != 1 || len(info.Origin.Locations) != 1 {
|
||||||
|
t.Fatalf("resource origin = %#v, %v", info, found)
|
||||||
|
}
|
||||||
|
context, found := result.SourceContext(info.Origin.Locations[0].SourceID)
|
||||||
|
if !found || context.BaseDir != "shared" || context.FS == nil {
|
||||||
|
t.Fatalf("source context = %#v, %v", context, found)
|
||||||
|
}
|
||||||
|
data, err := fs.ReadFile(context.FS, context.BaseDir+"/"+child.Resource)
|
||||||
|
if err != nil || string(data) != "parent-resource" {
|
||||||
|
t.Fatalf("source-relative resource = %q, %v", data, err)
|
||||||
|
}
|
||||||
|
count, found := result.Metadata().Lookup(configkit.Keys("entries", "child", "count"))
|
||||||
|
if !found || count.Origin.Layer != configkit.LayerCLI || len(count.Origin.Inheritance) != 0 {
|
||||||
|
t.Fatalf("CLI replacement origin = %#v, %v", count, found)
|
||||||
|
}
|
||||||
|
var rendered bytes.Buffer
|
||||||
|
if err := result.WriteEffective(&rendered); err != nil || strings.Contains(rendered.String(), "extends:") {
|
||||||
|
t.Fatalf("effective rendering = %q, %v", rendered.String(), err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeInheritanceMappingMatchesBytes(t *testing.T) {
|
||||||
|
values := map[string]any{"entries": map[string]any{
|
||||||
|
"parent": map[string]any{"enabled": false, "count": 0},
|
||||||
|
"child": map[string]any{"extends": "parent"},
|
||||||
|
}}
|
||||||
|
mapped, err := configkit.Load[inheritedConfiguration](configkit.Mapping("mapping", values))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
fromYAML, err := configkit.Load[inheritedConfiguration](configkit.Bytes("config.yml", []byte("entries: {parent: {enabled: false, count: 0}, child: {extends: parent}}\n")))
|
||||||
|
if err != nil || !reflect.DeepEqual(mapped.Config, fromYAML.Config) {
|
||||||
|
t.Fatalf("mapping and bytes differ: %#v, %#v, %v", mapped, fromYAML, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeInheritanceProtectsVersionOwnership(t *testing.T) {
|
||||||
|
for _, test := range []struct {
|
||||||
|
name, input string
|
||||||
|
path configkit.Path
|
||||||
|
wantFailure bool
|
||||||
|
}{
|
||||||
|
{"inherited version", "entries: {parent: {count: 1}, child: {extends: parent}}\n", configkit.Keys("entries", "child", "count"), true},
|
||||||
|
{"overridden version", "entries: {parent: {count: 1}, child: {extends: parent, count: 1}}\n", configkit.Keys("entries", "child", "count"), true},
|
||||||
|
{"direct unchanged version", "entries: {parent: {enabled: false}, child: {extends: parent, count: 1}}\n", configkit.Keys("entries", "child", "count"), false},
|
||||||
|
{"consumed checked directive", "entries: {parent: {count: 1}, child: {extends: parent}}\n", configkit.Keys("entries", "child", "extends"), true},
|
||||||
|
{"independent top-level version", "version: v1\nentries: {parent: {count: 1}, child: {extends: parent}}\n", configkit.Keys("version"), false},
|
||||||
|
} {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
checks := struct{ version, defaults, resolution, validation int }{}
|
||||||
|
result, err := configkit.Load(configkit.Bytes("version.yml", []byte(test.input)), configkit.Options[inheritedConfiguration]{Definition: configkit.Definition[inheritedConfiguration]{
|
||||||
|
Version: &configkit.VersionRule{Path: test.path, Check: func(configkit.Version, *configkit.Validation) error {
|
||||||
|
checks.version++
|
||||||
|
return nil
|
||||||
|
}},
|
||||||
|
Defaults: func() inheritedConfiguration { checks.defaults++; return inheritedConfiguration{} },
|
||||||
|
Resolve: func(*inheritedConfiguration, *configkit.Resolution) error { checks.resolution++; return nil },
|
||||||
|
Validate: func(*inheritedConfiguration, *configkit.Validation) { checks.validation++ },
|
||||||
|
}})
|
||||||
|
if test.wantFailure {
|
||||||
|
if result != nil || err == nil {
|
||||||
|
t.Fatalf("protected version = %#v, %v", result, err)
|
||||||
|
}
|
||||||
|
loadError, ok := err.(*configkit.LoadError)
|
||||||
|
if !ok || len(loadError.Diagnostics()) == 0 || loadError.Diagnostics()[0].Code != configkit.CodeInheritanceVersion ||
|
||||||
|
checks != (struct{ version, defaults, resolution, validation int }{version: 1}) {
|
||||||
|
t.Fatalf("version failure = %v, callbacks %#v", err, checks)
|
||||||
|
}
|
||||||
|
} else if err != nil || result == nil || checks != (struct{ version, defaults, resolution, validation int }{1, 1, 1, 1}) {
|
||||||
|
t.Fatalf("unchanged version = %#v, %v, callbacks %#v", result, err, checks)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeInheritanceFailureStopsLaterCallbacks(t *testing.T) {
|
||||||
|
checks := struct{ defaults, resolution, validation int }{}
|
||||||
|
result, err := configkit.Load(configkit.Bytes("invalid.yml", []byte("entries: {child: {extends: PRIVATE-REFERENCE-CANARY}}\n")), configkit.Options[inheritedConfiguration]{Definition: configkit.Definition[inheritedConfiguration]{
|
||||||
|
Defaults: func() inheritedConfiguration { checks.defaults++; return inheritedConfiguration{} },
|
||||||
|
Resolve: func(*inheritedConfiguration, *configkit.Resolution) error { checks.resolution++; return nil },
|
||||||
|
Validate: func(*inheritedConfiguration, *configkit.Validation) { checks.validation++ },
|
||||||
|
}})
|
||||||
|
if result != nil || err == nil || checks != (struct{ defaults, resolution, validation int }{}) || strings.Contains(err.Error(), "PRIVATE-REFERENCE-CANARY") {
|
||||||
|
t.Fatalf("invalid inheritance = %#v, %v, callbacks %#v", result, err, checks)
|
||||||
|
}
|
||||||
|
loadError, ok := err.(*configkit.LoadError)
|
||||||
|
if !ok || len(loadError.Diagnostics()) == 0 || loadError.Diagnostics()[0].Code != configkit.CodeInheritanceMissing {
|
||||||
|
t.Fatalf("missing reference diagnostics = %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeInheritanceResolvesAfterImportsAndCLIReferenceChange(t *testing.T) {
|
||||||
|
filesystem := configkit.NewFilesystem("bundle", fstest.MapFS{
|
||||||
|
"main.yml": &fstest.MapFile{Data: []byte("configkit: {imports: [{path: parent.yml}]}\nentries: {child: {extends: first}}\n")},
|
||||||
|
"parent.yml": &fstest.MapFile{Data: []byte("entries: {first: {count: 1}, second: {count: 2}}\n")},
|
||||||
|
})
|
||||||
|
result, err := configkit.Load(filesystem.File("main.yml"), configkit.Options[inheritedConfiguration]{
|
||||||
|
Imports: true, Overrides: []configkit.Override{{Path: configkit.Keys("entries", "child", "extends"), Value: "second", Flag: "--extends"}},
|
||||||
|
})
|
||||||
|
if err != nil || result.Config.Entries["child"].Count != 2 {
|
||||||
|
t.Fatalf("import and CLI reference = %#v, %v", result, err)
|
||||||
|
}
|
||||||
|
history := result.Metadata().History(configkit.Keys("entries", "child", "extends"))
|
||||||
|
if len(history) < 3 || history[len(history)-1].Origin.Operation != configkit.ChangeInheritance {
|
||||||
|
t.Fatalf("superseded reference history = %#v", history)
|
||||||
|
}
|
||||||
|
conflicting := configkit.NewFilesystem("bundle", fstest.MapFS{
|
||||||
|
"main.yml": &fstest.MapFile{Data: []byte("configkit: {imports: [{path: parent.yml}]}\nentries: {child: {extends: first}, first: {count: 3}}\n")},
|
||||||
|
"parent.yml": &fstest.MapFile{Data: []byte("entries: {first: {count: 1}}\n")},
|
||||||
|
})
|
||||||
|
_, err = configkit.Load[inheritedConfiguration](conflicting.File("main.yml"), configkit.Options[inheritedConfiguration]{Imports: true})
|
||||||
|
loadError, ok := err.(*configkit.LoadError)
|
||||||
|
if !ok || len(loadError.Diagnostics()) == 0 || loadError.Diagnostics()[0].Code != configkit.CodeComposeConflict {
|
||||||
|
t.Fatalf("strict conflict before expansion = %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeInheritanceSelectedOverlayCancelsRelationship(t *testing.T) {
|
||||||
|
filesystem := configkit.NewFilesystem("bundle", fstest.MapFS{
|
||||||
|
"main.yml": &fstest.MapFile{Data: []byte("entries: {parent: {count: 7}, child: {extends: parent, enabled: false}}\n")},
|
||||||
|
"overlays/test.yml": &fstest.MapFile{Data: []byte("entries: {child: {extends: null}}\n")},
|
||||||
|
})
|
||||||
|
result, err := configkit.Load(filesystem.File("main.yml"), configkit.Options[inheritedConfiguration]{
|
||||||
|
Overlay: "test", Filesystem: &configkit.FilesystemContext{Root: ".", FS: &filesystem},
|
||||||
|
})
|
||||||
|
if err != nil || result.Config.Entries["child"].Count != 0 || result.Config.Entries["child"].Enabled {
|
||||||
|
if loadError, ok := err.(*configkit.LoadError); ok {
|
||||||
|
t.Fatalf("cancelled relationship = %#v, %v, diagnostics %#v", result, err, loadError.Diagnostics())
|
||||||
|
}
|
||||||
|
t.Fatalf("cancelled relationship = %#v, %v", result, err)
|
||||||
|
}
|
||||||
|
history := result.Metadata().History(configkit.Keys("entries", "child", "extends"))
|
||||||
|
if len(history) < 3 || history[len(history)-1].Origin.Operation != configkit.ChangeInheritance {
|
||||||
|
t.Fatalf("cancellation history = %#v", history)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeInheritedSecretsStayRedactedAfterLookup(t *testing.T) {
|
||||||
|
const canary = "INHERITED-RELEASE-TEST-CREDENTIAL"
|
||||||
|
t.Setenv("CONFIGKIT_INHERITED_TEST_SECRET", canary)
|
||||||
|
type entry struct {
|
||||||
|
Credential configkit.Secret `yaml:"credential"`
|
||||||
|
Plain string `yaml:"plain"`
|
||||||
|
}
|
||||||
|
type configuration struct {
|
||||||
|
Entries map[string]entry `yaml:"entries"`
|
||||||
|
}
|
||||||
|
result, err := configkit.Load[configuration](configkit.Bytes("secret.yml", []byte("entries: {parent: {credential: CONFIGKIT_INHERITED_TEST_SECRET, plain: visible}, child: {extends: parent}}\n")), configkit.Options[configuration]{Definition: configkit.Definition[configuration]{
|
||||||
|
Secret: func(path configkit.Path) bool { return path.String() == "/entries/parent/credential" },
|
||||||
|
}})
|
||||||
|
if err != nil || result.Config.Entries["child"].Credential.Value() != canary {
|
||||||
|
t.Fatalf("inherited credential = %#v, %v", result, err)
|
||||||
|
}
|
||||||
|
path := configkit.Keys("entries", "child", "credential")
|
||||||
|
explanation, found := result.Explain(path)
|
||||||
|
if !found || !explanation.Effective.Redacted || strings.Contains(explanation.Effective.YAML, canary) {
|
||||||
|
t.Fatalf("credential explanation = %#v, %v", explanation, found)
|
||||||
|
}
|
||||||
|
var rendered bytes.Buffer
|
||||||
|
if err := result.WriteEffective(&rendered); err != nil || strings.Contains(rendered.String(), canary) || !strings.Contains(rendered.String(), "visible") {
|
||||||
|
t.Fatalf("effective secret rendering = %q, %v", rendered.String(), err)
|
||||||
|
}
|
||||||
|
rendered.Reset()
|
||||||
|
if err := result.WriteExplanation(&rendered, path); err != nil || strings.Contains(rendered.String(), canary) {
|
||||||
|
t.Fatalf("historical secret rendering = %q, %v", rendered.String(), err)
|
||||||
|
}
|
||||||
|
}
|
||||||
243
facade_layered_test.go
Normal file
243
facade_layered_test.go
Normal file
@@ -0,0 +1,243 @@
|
|||||||
|
package configkit_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"reflect"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"testing/fstest"
|
||||||
|
|
||||||
|
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
)
|
||||||
|
|
||||||
|
type layeredFacadeConfig struct {
|
||||||
|
Settings map[string]string `yaml:"settings"`
|
||||||
|
Count int `yaml:"count"`
|
||||||
|
Enabled bool `yaml:"enabled"`
|
||||||
|
List []string `yaml:"list"`
|
||||||
|
Optional *string `yaml:"optional"`
|
||||||
|
Derived string `yaml:"derived"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeLayeredMixedSourcesAndInspection(t *testing.T) {
|
||||||
|
mainPath := filepath.Join(t.TempDir(), "main.yml")
|
||||||
|
if err := os.WriteFile(mainPath, []byte("settings: {shared: main, secret: new-canary}\ncount: 0\nenabled: false\nlist: []\noptional: null\n"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
lower := configkit.NewFilesystem("bundle", fstest.MapFS{
|
||||||
|
"main.yml": &fstest.MapFile{Data: []byte("configkit: {imports: [{path: defaults.yml}]}\nsettings: {shared: lower, native: retained, secret: old-canary}\nlist: [lower]\n")},
|
||||||
|
"defaults.yml": &fstest.MapFile{Data: []byte("settings: {imported: retained}\n")},
|
||||||
|
"overlays/testing.yml": &fstest.MapFile{Data: []byte("settings: {from_lower_namespace: retained}\n")},
|
||||||
|
})
|
||||||
|
selected := configkit.NewFilesystem("bundle", fstest.MapFS{
|
||||||
|
"overlays/testing.yml": &fstest.MapFile{Data: []byte("settings: {shared: overlay}\n")},
|
||||||
|
})
|
||||||
|
checks := struct{ defaults, resolution, validation int }{}
|
||||||
|
result, err := configkit.LoadLayered(configkit.Input{Source: configkit.File(mainPath)}, configkit.LayeredOptions[layeredFacadeConfig]{
|
||||||
|
Underlays: []configkit.Underlay{
|
||||||
|
{Inputs: []configkit.Input{
|
||||||
|
{Source: lower.File("main.yml"), Imports: true},
|
||||||
|
{Source: configkit.Mapping("programmatic-low", map[string]any{"settings": map[string]any{"mapping": "retained"}, "count": 7, "enabled": true})},
|
||||||
|
{Source: lower.File("overlays/testing.yml")},
|
||||||
|
}},
|
||||||
|
{Inputs: []configkit.Input{{Source: configkit.Mapping("programmatic-high", map[string]any{
|
||||||
|
"settings": map[string]any{"shared": "middle", "second": "retained"}, "list": []any{"middle"},
|
||||||
|
})}}},
|
||||||
|
},
|
||||||
|
Overlay: "testing", OverlayFilesystem: &configkit.FilesystemContext{Root: ".", BaseDir: ".", FS: &selected},
|
||||||
|
Overrides: []configkit.Override{{Path: configkit.Keys("settings", "shared"), Value: "cli", Flag: "--shared"}},
|
||||||
|
Definition: configkit.Definition[layeredFacadeConfig]{
|
||||||
|
Defaults: func() layeredFacadeConfig { checks.defaults++; return layeredFacadeConfig{} },
|
||||||
|
Resolve: func(config *layeredFacadeConfig, resolution *configkit.Resolution) error {
|
||||||
|
checks.resolution++
|
||||||
|
if source, ok := resolution.Source("source-2"); !ok || source.Layer != configkit.LayerUnderlay || source.UnderlayIndex != 1 || source.Kind != configkit.SourceKindFilesystem {
|
||||||
|
t.Errorf("resolver source = %#v, %v", source, ok)
|
||||||
|
}
|
||||||
|
configkit.Default(resolution, configkit.Keys("derived"), &config.Derived, config.Settings["native"], "derive from native", configkit.Keys("settings", "native"))
|
||||||
|
return nil
|
||||||
|
},
|
||||||
|
Validate: func(config *layeredFacadeConfig, validation *configkit.Validation) { checks.validation++ },
|
||||||
|
Secret: func(path configkit.Path) bool { return path.String() == "/settings/secret" },
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("layered load: %v, diagnostics %#v", err, err.(*configkit.LoadError).Diagnostics())
|
||||||
|
}
|
||||||
|
wantSettings := map[string]string{
|
||||||
|
"shared": "cli", "secret": "new-canary", "native": "retained", "imported": "retained",
|
||||||
|
"mapping": "retained", "from_lower_namespace": "retained", "second": "retained",
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(result.Config.Settings, wantSettings) || result.Config.Count != 0 || result.Config.Enabled || result.Config.List == nil || len(result.Config.List) != 0 || result.Config.Optional != nil || result.Config.Derived != "retained" {
|
||||||
|
t.Fatalf("configuration = %#v", result.Config)
|
||||||
|
}
|
||||||
|
if checks != (struct{ defaults, resolution, validation int }{1, 1, 1}) {
|
||||||
|
t.Fatalf("lifecycle calls = %#v", checks)
|
||||||
|
}
|
||||||
|
sources := result.Sources()
|
||||||
|
if len(sources) != 8 {
|
||||||
|
t.Fatalf("sources = %#v", sources)
|
||||||
|
}
|
||||||
|
wantLayers := []configkit.Layer{configkit.LayerBase, configkit.LayerUnderlay, configkit.LayerUnderlay, configkit.LayerUnderlay, configkit.LayerUnderlay, configkit.LayerUnderlay, configkit.LayerOverlay, configkit.LayerCLI}
|
||||||
|
wantIndexes := []int{0, 1, 1, 1, 1, 2, 0, 0}
|
||||||
|
wantKinds := []configkit.SourceKind{configkit.SourceKindFile, configkit.SourceKindFilesystem, configkit.SourceKindFilesystem, configkit.SourceKindMapping, configkit.SourceKindFilesystem, configkit.SourceKindMapping, configkit.SourceKindFilesystem, configkit.SourceKindCLI}
|
||||||
|
for index, source := range sources {
|
||||||
|
if source.ID != "source-"+strconv.Itoa(index+1) || source.Layer != wantLayers[index] || source.UnderlayIndex != wantIndexes[index] || source.Kind != wantKinds[index] {
|
||||||
|
t.Errorf("source %d = %#v", index, source)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if sources[4].Path != sources[6].Path || sources[4].Label != sources[6].Label {
|
||||||
|
t.Fatalf("namespace-collision fixture changed: %#v, %#v", sources[4], sources[6])
|
||||||
|
}
|
||||||
|
sources[1].Label = "changed"
|
||||||
|
if result.Sources()[1].Label != "bundle/main.yml" {
|
||||||
|
t.Fatal("source records alias retained metadata")
|
||||||
|
}
|
||||||
|
for _, test := range []struct {
|
||||||
|
path string
|
||||||
|
want configkit.Layer
|
||||||
|
}{
|
||||||
|
{"/settings/native", configkit.LayerUnderlay},
|
||||||
|
{"/settings/shared", configkit.LayerCLI},
|
||||||
|
{"/derived", configkit.LayerResolution},
|
||||||
|
} {
|
||||||
|
path, err := configkit.ParsePath(test.path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
info, ok := result.Metadata().Lookup(path)
|
||||||
|
if !ok || info.Origin.Layer != test.want {
|
||||||
|
t.Errorf("%s metadata = %#v, %v", test.path, info, ok)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
container, ok := result.Metadata().Lookup(configkit.Keys("settings"))
|
||||||
|
if !ok || len(container.Origin.Locations) < 4 {
|
||||||
|
t.Fatalf("composite mapping origin = %#v, %v", container, ok)
|
||||||
|
}
|
||||||
|
explanation, ok := result.Explain(configkit.Keys("settings", "shared"))
|
||||||
|
if !ok || len(explanation.History) < 5 || explanation.Origin.Layer != configkit.LayerCLI {
|
||||||
|
t.Fatalf("shared history = %#v, %v", explanation, ok)
|
||||||
|
}
|
||||||
|
var effective, rendered bytes.Buffer
|
||||||
|
if err := result.WriteEffective(&effective); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := result.WriteExplanation(&rendered, configkit.Keys("settings", "secret")); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if strings.Contains(effective.String()+rendered.String(), "old-canary") || strings.Contains(effective.String()+rendered.String(), "new-canary") || !strings.Contains(rendered.String(), "redacted") {
|
||||||
|
t.Fatalf("secret rendering leaked: effective %q, explanation %q", effective.String(), rendered.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeLayeredDisplacedDescendantRemainsInspectable(t *testing.T) {
|
||||||
|
type config struct {
|
||||||
|
Choice string `yaml:"choice"`
|
||||||
|
}
|
||||||
|
result, err := configkit.LoadLayered(configkit.Input{Source: configkit.Mapping("main", map[string]any{"choice": "flat"})}, configkit.LayeredOptions[config]{
|
||||||
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{{Source: configkit.Mapping("lower", map[string]any{
|
||||||
|
"choice": map[string]any{"nested": "historical"},
|
||||||
|
})}}}},
|
||||||
|
})
|
||||||
|
if err != nil || result.Config.Choice != "flat" {
|
||||||
|
t.Fatalf("replacement load = %#v, %v", result, err)
|
||||||
|
}
|
||||||
|
path := configkit.Keys("choice", "nested")
|
||||||
|
explanation, ok := result.Explain(path)
|
||||||
|
if !ok || explanation.Effective.Present || len(explanation.History) == 0 || explanation.History[0].Origin.Layer != configkit.LayerUnderlay {
|
||||||
|
t.Fatalf("deleted descendant = %#v, %v", explanation, ok)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeLayeredZeroUnderlaysMatchesOrdinaryLoad(t *testing.T) {
|
||||||
|
filesystem := configkit.NewFilesystem("bundle", fstest.MapFS{
|
||||||
|
"overlays/testing.yml": &fstest.MapFile{Data: []byte("value: selected\n")},
|
||||||
|
})
|
||||||
|
context := &configkit.FilesystemContext{Root: ".", BaseDir: ".", FS: &filesystem}
|
||||||
|
source := configkit.Bytes("main", []byte("value: base\n"))
|
||||||
|
type config struct {
|
||||||
|
Value string `yaml:"value"`
|
||||||
|
}
|
||||||
|
ordinary, err := configkit.Load(source, configkit.Options[config]{Overlay: "testing", Filesystem: context})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
layered, err := configkit.LoadLayered(configkit.Input{Source: source}, configkit.LayeredOptions[config]{Overlay: "testing", OverlayFilesystem: context})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if ordinary.Config != layered.Config || !reflect.DeepEqual(ordinary.Sources(), layered.Sources()) {
|
||||||
|
t.Fatalf("ordinary = %#v, %#v; layered = %#v, %#v", ordinary.Config, ordinary.Sources(), layered.Config, layered.Sources())
|
||||||
|
}
|
||||||
|
var first, second bytes.Buffer
|
||||||
|
if err := ordinary.WriteEffective(&first); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := layered.WriteEffective(&second); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if first.String() != second.String() {
|
||||||
|
t.Fatalf("effective ordinary %q, layered %q", first.String(), second.String())
|
||||||
|
}
|
||||||
|
if ordinaryExplanation, ok := ordinary.Explain(configkit.Keys("value")); !ok {
|
||||||
|
t.Fatal("ordinary explanation missing")
|
||||||
|
} else if layeredExplanation, ok := layered.Explain(configkit.Keys("value")); !ok || !reflect.DeepEqual(ordinaryExplanation, layeredExplanation) {
|
||||||
|
t.Fatalf("explanations differ: %#v, %#v", ordinaryExplanation, layeredExplanation)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeLayeredOptionAndVersionFailures(t *testing.T) {
|
||||||
|
type config struct {
|
||||||
|
Version string `yaml:"version"`
|
||||||
|
}
|
||||||
|
namespace := configkit.NewFilesystem("bundle", fstest.MapFS{
|
||||||
|
"overlays/testing.yml": &fstest.MapFile{Data: []byte("{}\n")},
|
||||||
|
})
|
||||||
|
for _, test := range []struct {
|
||||||
|
name string
|
||||||
|
main configkit.Input
|
||||||
|
options []configkit.LayeredOptions[config]
|
||||||
|
want configkit.Code
|
||||||
|
}{
|
||||||
|
{"zero source", configkit.Input{}, nil, configkit.CodeSourceInvalid},
|
||||||
|
{"multiple options", configkit.Input{Source: configkit.NoSource()}, []configkit.LayeredOptions[config]{{}, {}}, configkit.CodeOptionsInvalid},
|
||||||
|
{"missing overlay context", configkit.Input{Source: configkit.NoSource()}, []configkit.LayeredOptions[config]{{Overlay: "testing"}}, configkit.CodeOptionsInvalid},
|
||||||
|
{"selected file already acquired", configkit.Input{Source: configkit.NoSource()}, []configkit.LayeredOptions[config]{{
|
||||||
|
Overlay: "testing", OverlayFilesystem: &configkit.FilesystemContext{Root: ".", BaseDir: ".", FS: &namespace},
|
||||||
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{{Source: namespace.File("overlays/testing.yml")}}}},
|
||||||
|
}}, configkit.CodeOverlayRepeated},
|
||||||
|
{"underlay version", configkit.Input{Source: configkit.NoSource()}, []configkit.LayeredOptions[config]{{
|
||||||
|
Definition: configkit.Definition[config]{Version: &configkit.VersionRule{Path: configkit.Keys("version"), Check: func(configkit.Version, *configkit.Validation) error { return nil }}},
|
||||||
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{{Source: configkit.Mapping("lower", map[string]any{"version": "forbidden"})}}}},
|
||||||
|
}}, configkit.CodeUnderlayVersion},
|
||||||
|
} {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
_, err := configkit.LoadLayered(test.main, test.options...)
|
||||||
|
loadError, ok := err.(*configkit.LoadError)
|
||||||
|
if !ok || len(loadError.Diagnostics()) == 0 || loadError.Diagnostics()[0].Code != test.want {
|
||||||
|
t.Fatalf("error = %#v, want %s", err, test.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeLayeredExplicitHostOverlayWithoutMain(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
if err := os.Mkdir(filepath.Join(root, "overlays"), 0o700); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(root, "overlays", "testing.yml"), []byte("value: selected\n"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
type config struct {
|
||||||
|
Value string `yaml:"value"`
|
||||||
|
}
|
||||||
|
result, err := configkit.LoadLayered(configkit.Input{Source: configkit.NoSource()}, configkit.LayeredOptions[config]{
|
||||||
|
Overlay: "testing", OverlayFilesystem: &configkit.FilesystemContext{Root: root, BaseDir: root},
|
||||||
|
})
|
||||||
|
if err != nil || result.Config.Value != "selected" || len(result.Sources()) != 1 || result.Sources()[0].Kind != configkit.SourceKindFile {
|
||||||
|
t.Fatalf("explicit host overlay = %#v, %v", result, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
133
facade_mapping_test.go
Normal file
133
facade_mapping_test.go
Normal file
@@ -0,0 +1,133 @@
|
|||||||
|
package configkit_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"math"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"testing/fstest"
|
||||||
|
|
||||||
|
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
)
|
||||||
|
|
||||||
|
type mappingFacadeConfig struct {
|
||||||
|
Enabled bool `yaml:"enabled"`
|
||||||
|
Count uint64 `yaml:"count"`
|
||||||
|
Optional *string `yaml:"optional"`
|
||||||
|
Items []string `yaml:"items"`
|
||||||
|
Name string `yaml:"name"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeMappingSnapshotsAndMatchesYAML(t *testing.T) {
|
||||||
|
items := []any{"one", "two"}
|
||||||
|
values := map[string]any{
|
||||||
|
"name": "original", "enabled": false, "count": ^uint64(0),
|
||||||
|
"optional": nil, "items": items,
|
||||||
|
}
|
||||||
|
source := configkit.Mapping("programmatic", values)
|
||||||
|
values["name"] = "mutated"
|
||||||
|
items[0] = "mutated"
|
||||||
|
for range 2 {
|
||||||
|
result, err := configkit.Load[mappingFacadeConfig](source)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
want := mappingFacadeConfig{Count: ^uint64(0), Items: []string{"one", "two"}, Name: "original"}
|
||||||
|
if !reflect.DeepEqual(result.Config, want) {
|
||||||
|
t.Fatalf("mapping config = %#v, want %#v", result.Config, want)
|
||||||
|
}
|
||||||
|
if sources := result.Sources(); len(sources) != 1 || sources[0].ID != "source-1" || sources[0].Kind != configkit.SourceKindMapping || sources[0].Layer != configkit.LayerBase || sources[0].Path != "" {
|
||||||
|
t.Fatalf("mapping sources = %#v", sources)
|
||||||
|
}
|
||||||
|
info, ok := result.Metadata().Lookup(configkit.Keys("name"))
|
||||||
|
if !ok || len(info.Origin.Locations) != 1 || info.Origin.Locations[0].SourceID != "source-1" || info.Origin.Locations[0].Line != 0 {
|
||||||
|
t.Fatalf("mapping name origin = %#v, %v", info, ok)
|
||||||
|
}
|
||||||
|
fromYAML, err := configkit.Load[mappingFacadeConfig](configkit.Bytes("equivalent", []byte("enabled: false\ncount: 18446744073709551615\noptional: null\nitems: [one, two]\nname: original\n")))
|
||||||
|
if err != nil || !reflect.DeepEqual(result.Config, fromYAML.Config) {
|
||||||
|
t.Fatalf("equivalent YAML = %#v, %v", fromYAML, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeMappingNullEmptyAndVersion(t *testing.T) {
|
||||||
|
result, err := configkit.Load[mappingFacadeConfig](configkit.Mapping("empty", map[string]any{}))
|
||||||
|
if err != nil || len(result.Sources()) != 1 {
|
||||||
|
t.Fatalf("empty mapping = %#v, %v", result, err)
|
||||||
|
}
|
||||||
|
var nilSequence []any
|
||||||
|
var nilMap map[string]any
|
||||||
|
var checked string
|
||||||
|
result, err = configkit.Load(configkit.Mapping("nullable", map[string]any{
|
||||||
|
"items": nilSequence, "optional": nilMap, "enabled": false, "count": uint64(0),
|
||||||
|
}), configkit.Options[mappingFacadeConfig]{Definition: configkit.Definition[mappingFacadeConfig]{
|
||||||
|
Version: &configkit.VersionRule{Path: configkit.Keys("count"), Check: func(version configkit.Version, validation *configkit.Validation) error {
|
||||||
|
checked = version.Text
|
||||||
|
return nil
|
||||||
|
}},
|
||||||
|
}})
|
||||||
|
if err != nil || checked != "0" || result.Config.Items != nil || result.Config.Optional != nil {
|
||||||
|
t.Fatalf("null and zero mapping = %#v, checked %q, %v", result, checked, err)
|
||||||
|
}
|
||||||
|
info, ok := result.Metadata().Lookup(configkit.Keys("items"))
|
||||||
|
if !ok || !info.Null || !info.Explicit {
|
||||||
|
t.Fatalf("null metadata = %#v, %v", info, ok)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeMappingImportsUseExplicitContext(t *testing.T) {
|
||||||
|
namespace := configkit.NewFilesystem("bundle", fstest.MapFS{
|
||||||
|
"root/shared.yml": &fstest.MapFile{Data: []byte("name: imported\n")},
|
||||||
|
})
|
||||||
|
source := configkit.Mapping("programmatic", map[string]any{
|
||||||
|
"configkit": map[string]any{"imports": []any{map[string]any{"path": "shared.yml"}}},
|
||||||
|
"enabled": true,
|
||||||
|
})
|
||||||
|
result, err := configkit.Load(source, configkit.Options[mappingFacadeConfig]{
|
||||||
|
Imports: true, Filesystem: &configkit.FilesystemContext{Root: "root", BaseDir: "root", FS: &namespace},
|
||||||
|
})
|
||||||
|
if err != nil || result.Config.Name != "imported" || !result.Config.Enabled {
|
||||||
|
t.Fatalf("mapping import = %#v, %v", result, err)
|
||||||
|
}
|
||||||
|
if sources := result.Sources(); len(sources) != 2 || sources[0].Kind != configkit.SourceKindMapping || sources[1].Kind != configkit.SourceKindFilesystem || sources[1].Layer != configkit.LayerBase {
|
||||||
|
t.Fatalf("mapping import sources = %#v", sources)
|
||||||
|
}
|
||||||
|
checkMappingCode(t, source, configkit.Options[mappingFacadeConfig]{Imports: true}, configkit.CodeOptionsInvalid)
|
||||||
|
checkMappingCode(t, source, configkit.Options[mappingFacadeConfig]{}, configkit.CodeImportDisabled)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeMappingDeferredValueDiagnostics(t *testing.T) {
|
||||||
|
cycle := map[string]any{}
|
||||||
|
cycle["secret"] = cycle
|
||||||
|
for _, test := range []struct {
|
||||||
|
name string
|
||||||
|
source configkit.Source
|
||||||
|
want configkit.Code
|
||||||
|
path string
|
||||||
|
}{
|
||||||
|
{"nil root", configkit.Mapping("nil", nil), configkit.CodeSourceInvalid, ""},
|
||||||
|
{"bad label", configkit.Mapping("bad\nlabel", map[string]any{}), configkit.CodeSourceInvalid, ""},
|
||||||
|
{"unsupported", configkit.Mapping("bad", map[string]any{"secret": struct{ Value string }{"canary-value"}}), configkit.CodeSourceInvalid, "/secret"},
|
||||||
|
{"nonfinite", configkit.Mapping("bad", map[string]any{"count": math.NaN()}), configkit.CodeSourceInvalid, "/count"},
|
||||||
|
{"cycle", configkit.Mapping("bad", cycle), configkit.CodeSourceInvalid, "/secret"},
|
||||||
|
{"too many bytes", configkit.Mapping("bad", map[string]any{"name": strings.Repeat("x", 8<<20+1)}), configkit.CodeSourceLimitExceeded, "/name"},
|
||||||
|
} {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
loadError := checkMappingCode(t, test.source, configkit.Options[mappingFacadeConfig]{}, test.want)
|
||||||
|
diagnostic := loadError.Diagnostics()[0]
|
||||||
|
if diagnostic.Path.String() != test.path || diagnostic.Primary == nil || diagnostic.Primary.SourceID != "source-1" || strings.Contains(diagnostic.Message, "canary-value") {
|
||||||
|
t.Fatalf("diagnostic = %#v", diagnostic)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func checkMappingCode(t *testing.T, source configkit.Source, options configkit.Options[mappingFacadeConfig], want configkit.Code) *configkit.LoadError {
|
||||||
|
t.Helper()
|
||||||
|
_, err := configkit.Load(source, options)
|
||||||
|
loadError, ok := err.(*configkit.LoadError)
|
||||||
|
if !ok || len(loadError.Diagnostics()) == 0 || loadError.Diagnostics()[0].Code != want {
|
||||||
|
t.Fatalf("error = %#v, want %s", err, want)
|
||||||
|
}
|
||||||
|
return loadError
|
||||||
|
}
|
||||||
221
facade_resource_context_test.go
Normal file
221
facade_resource_context_test.go
Normal file
@@ -0,0 +1,221 @@
|
|||||||
|
package configkit_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"io/fs"
|
||||||
|
"os"
|
||||||
|
"path"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"testing/fstest"
|
||||||
|
|
||||||
|
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
)
|
||||||
|
|
||||||
|
type observedResourceFS struct {
|
||||||
|
files fstest.MapFS
|
||||||
|
opens int
|
||||||
|
closed bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *observedResourceFS) Open(name string) (fs.File, error) {
|
||||||
|
f.opens++
|
||||||
|
if f.closed {
|
||||||
|
return nil, fs.ErrClosed
|
||||||
|
}
|
||||||
|
return f.files.Open(name)
|
||||||
|
}
|
||||||
|
|
||||||
|
type resourceFacadeConfig struct {
|
||||||
|
Native string `yaml:"native"`
|
||||||
|
Shared string `yaml:"shared"`
|
||||||
|
Host string `yaml:"host"`
|
||||||
|
Selected string `yaml:"selected"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeSourceContextsFollowOriginsWithoutQueryIO(t *testing.T) {
|
||||||
|
host := t.TempDir()
|
||||||
|
if err := os.WriteFile(filepath.Join(host, "main.yml"), []byte("host: host.txt\n"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(host, "host.txt"), []byte("host-v1"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
borrowed := &observedResourceFS{files: fstest.MapFS{
|
||||||
|
"bundle/config/defaults.yml": &fstest.MapFile{Data: []byte("configkit: {imports: [{path: ../shared.yml}]}\nnative: icon.txt\n")},
|
||||||
|
"bundle/shared.yml": &fstest.MapFile{Data: []byte("shared: shared.txt\n")},
|
||||||
|
"bundle/overlays/test.yml": &fstest.MapFile{Data: []byte("selected: overlay.txt\n")},
|
||||||
|
"bundle/config/icon.txt": &fstest.MapFile{Data: []byte("icon-v1")},
|
||||||
|
"bundle/shared.txt": &fstest.MapFile{Data: []byte("shared-v1")},
|
||||||
|
"bundle/overlays/overlay.txt": &fstest.MapFile{Data: []byte("overlay-v1")},
|
||||||
|
}}
|
||||||
|
namespace := configkit.NewFilesystem("bundle", borrowed)
|
||||||
|
var resolverContext configkit.ResourceContext
|
||||||
|
result, err := configkit.LoadLayered(configkit.Input{Source: configkit.File(filepath.Join(host, "main.yml"))}, configkit.LayeredOptions[resourceFacadeConfig]{
|
||||||
|
Underlays: []configkit.Underlay{{Inputs: []configkit.Input{{
|
||||||
|
Source: namespace.File("bundle/config/defaults.yml"), Imports: true,
|
||||||
|
Filesystem: &configkit.FilesystemContext{Root: "bundle", FS: &namespace},
|
||||||
|
}}}},
|
||||||
|
Overlay: "test", OverlayFilesystem: &configkit.FilesystemContext{Root: "bundle", BaseDir: "bundle", FS: &namespace},
|
||||||
|
Definition: configkit.Definition[resourceFacadeConfig]{Resolve: func(config *resourceFacadeConfig, resolution *configkit.Resolution) error {
|
||||||
|
before := borrowed.opens
|
||||||
|
var ok bool
|
||||||
|
resolverContext, ok = resolution.SourceContext("source-2")
|
||||||
|
if !ok || resolverContext.BaseDir != "config" || resolverContext.FS == nil {
|
||||||
|
t.Errorf("resolver context = %#v, %v", resolverContext, ok)
|
||||||
|
}
|
||||||
|
if _, ok := resolution.SourceContext("missing"); ok || borrowed.opens != before {
|
||||||
|
t.Error("resolution context query performed I/O or guessed an unknown source")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("load: %v, diagnostics %#v", err, err.(*configkit.LoadError).Diagnostics())
|
||||||
|
}
|
||||||
|
queriesBefore := borrowed.opens
|
||||||
|
for _, test := range []struct {
|
||||||
|
field, wantBase, wantData string
|
||||||
|
}{
|
||||||
|
{"native", "config", "icon-v1"},
|
||||||
|
{"shared", ".", "shared-v1"},
|
||||||
|
{"selected", "overlays", "overlay-v1"},
|
||||||
|
{"host", ".", "host-v1"},
|
||||||
|
} {
|
||||||
|
origin, ok := result.Metadata().Lookup(configkit.Keys(test.field))
|
||||||
|
if !ok || len(origin.Origin.Locations) != 1 {
|
||||||
|
t.Fatalf("%s origin = %#v, %v", test.field, origin, ok)
|
||||||
|
}
|
||||||
|
context, ok := result.SourceContext(origin.Origin.Locations[0].SourceID)
|
||||||
|
if !ok || context.FS == nil || context.BaseDir != test.wantBase {
|
||||||
|
t.Fatalf("%s context = %#v, %v", test.field, context, ok)
|
||||||
|
}
|
||||||
|
if borrowed.opens != queriesBefore {
|
||||||
|
t.Fatal("result SourceContext query performed filesystem I/O")
|
||||||
|
}
|
||||||
|
resourceName := path.Join(context.BaseDir, map[string]string{
|
||||||
|
"native": result.Config.Native, "shared": result.Config.Shared,
|
||||||
|
"selected": result.Config.Selected, "host": result.Config.Host,
|
||||||
|
}[test.field])
|
||||||
|
data, err := fs.ReadFile(context.FS, resourceName)
|
||||||
|
if err != nil || string(data) != test.wantData {
|
||||||
|
t.Fatalf("%s resource = %q, %v", test.field, data, err)
|
||||||
|
}
|
||||||
|
queriesBefore = borrowed.opens
|
||||||
|
}
|
||||||
|
if _, ok := result.SourceContext(""); ok {
|
||||||
|
t.Fatal("empty source ID returned a context")
|
||||||
|
}
|
||||||
|
var nilResult *configkit.Result[resourceFacadeConfig]
|
||||||
|
if _, ok := nilResult.SourceContext("source-2"); ok {
|
||||||
|
t.Fatal("nil result returned a context")
|
||||||
|
}
|
||||||
|
if _, err := fs.ReadFile(resolverContext.FS, "../shared.txt"); !errors.Is(err, fs.ErrInvalid) {
|
||||||
|
t.Fatalf("native root escape = %v", err)
|
||||||
|
}
|
||||||
|
borrowed.files["bundle/config/icon.txt"].Data = []byte("icon-v2")
|
||||||
|
data, err := fs.ReadFile(resolverContext.FS, "config/icon.txt")
|
||||||
|
if err != nil || string(data) != "icon-v2" {
|
||||||
|
t.Fatalf("updated native resource = %q, %v", data, err)
|
||||||
|
}
|
||||||
|
borrowed.closed = true
|
||||||
|
if result.Config.Native != "icon.txt" {
|
||||||
|
t.Fatal("closing caller filesystem altered loaded configuration")
|
||||||
|
}
|
||||||
|
if _, err := fs.ReadFile(resolverContext.FS, "config/icon.txt"); !errors.Is(err, fs.ErrClosed) {
|
||||||
|
t.Fatalf("closed caller filesystem error = %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeHostContextSurvivesConfigurationDeletion(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
main := filepath.Join(root, "main.yml")
|
||||||
|
resource := filepath.Join(root, "asset.txt")
|
||||||
|
if err := os.WriteFile(main, []byte("native: asset.txt\n"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(resource, []byte("first"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
result, err := configkit.Load[resourceFacadeConfig](configkit.File(main))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
context, ok := result.SourceContext("source-1")
|
||||||
|
if !ok || context.BaseDir != "." {
|
||||||
|
t.Fatalf("host context = %#v, %v", context, ok)
|
||||||
|
}
|
||||||
|
if err := os.Remove(main); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(resource, []byte("second"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
data, err := fs.ReadFile(context.FS, path.Join(context.BaseDir, result.Config.Native))
|
||||||
|
if err != nil || string(data) != "second" || result.Config.Native != "asset.txt" {
|
||||||
|
t.Fatalf("resource after source deletion = %q, %v", data, err)
|
||||||
|
}
|
||||||
|
if _, err := fs.ReadFile(context.FS, "../asset.txt"); !errors.Is(err, fs.ErrInvalid) {
|
||||||
|
t.Fatalf("invalid host path = %v", err)
|
||||||
|
}
|
||||||
|
if err := os.Remove(resource); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := fs.ReadFile(context.FS, "asset.txt"); !errors.Is(err, fs.ErrNotExist) {
|
||||||
|
t.Fatalf("missing later resource = %v", err)
|
||||||
|
}
|
||||||
|
outside := filepath.Join(t.TempDir(), "outside.txt")
|
||||||
|
if err := os.WriteFile(outside, []byte("outside"), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.Symlink(outside, filepath.Join(root, "escape")); err == nil {
|
||||||
|
if _, err := fs.ReadFile(context.FS, "escape"); !errors.Is(err, fs.ErrPermission) {
|
||||||
|
t.Fatalf("host symlink escape = %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFacadeSyntheticSourceContextsAndContextlessSources(t *testing.T) {
|
||||||
|
namespace := configkit.NewFilesystem("bundle", fstest.MapFS{
|
||||||
|
"bundle/config/icon.txt": &fstest.MapFile{Data: []byte("icon")},
|
||||||
|
})
|
||||||
|
context := &configkit.FilesystemContext{Root: "bundle", BaseDir: "bundle/config", FS: &namespace}
|
||||||
|
for _, test := range []struct {
|
||||||
|
name string
|
||||||
|
source configkit.Source
|
||||||
|
}{
|
||||||
|
{"bytes", configkit.Bytes("memory", []byte("native: icon.txt\n"))},
|
||||||
|
{"reader", configkit.Reader("stream", strings.NewReader("native: icon.txt\n"))},
|
||||||
|
{"mapping", configkit.Mapping("values", map[string]any{"native": "icon.txt"})},
|
||||||
|
} {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
result, err := configkit.Load(test.source, configkit.Options[resourceFacadeConfig]{Filesystem: context})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
resource, ok := result.SourceContext("source-1")
|
||||||
|
if !ok || resource.BaseDir != "config" {
|
||||||
|
t.Fatalf("synthetic context = %#v, %v", resource, ok)
|
||||||
|
}
|
||||||
|
data, err := fs.ReadFile(resource.FS, path.Join(resource.BaseDir, result.Config.Native))
|
||||||
|
if err != nil || string(data) != "icon" {
|
||||||
|
t.Fatalf("synthetic resource = %q, %v", data, err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
result, err := configkit.Load[resourceFacadeConfig](configkit.Bytes("plain", []byte("native: none\n")))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, ok := result.SourceContext("source-1"); ok {
|
||||||
|
t.Fatal("contextless byte source returned a context")
|
||||||
|
}
|
||||||
|
result, err = configkit.Load(configkit.NoSource(), configkit.Options[resourceFacadeConfig]{Overrides: []configkit.Override{{Path: configkit.Keys("native"), Value: "from-cli", Flag: "--native"}}})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, ok := result.SourceContext("source-1"); ok {
|
||||||
|
t.Fatal("CLI source returned a context")
|
||||||
|
}
|
||||||
|
}
|
||||||
107
facade_underlay_origins_test.go
Normal file
107
facade_underlay_origins_test.go
Normal file
@@ -0,0 +1,107 @@
|
|||||||
|
package configkit_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"reflect"
|
||||||
|
"testing"
|
||||||
|
"testing/fstest"
|
||||||
|
|
||||||
|
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestUnderlaySequenceDescendantOrigins(t *testing.T) {
|
||||||
|
for _, later := range []bool{false, true} {
|
||||||
|
name := "first tier"
|
||||||
|
if later {
|
||||||
|
name = "later tier"
|
||||||
|
}
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
bundle := configkit.NewFilesystem("bundle", fstest.MapFS{
|
||||||
|
"main.yml": &fstest.MapFile{Data: []byte("configkit: {imports: [{path: items.yml}]}\n")},
|
||||||
|
"items.yml": &fstest.MapFile{Data: []byte("items: [{name: first, nested: [false]}]\n")},
|
||||||
|
})
|
||||||
|
tiers := []configkit.Underlay{}
|
||||||
|
if later {
|
||||||
|
tiers = append(tiers, configkit.Underlay{Inputs: []configkit.Input{{Source: configkit.Mapping("lower", map[string]any{"other": true})}}})
|
||||||
|
}
|
||||||
|
tiers = append(tiers, configkit.Underlay{Inputs: []configkit.Input{{Source: bundle.File("main.yml"), Imports: true}}})
|
||||||
|
paths := []string{"/items", "/items/0", "/items/0/name", "/items/0/nested", "/items/0/nested/0"}
|
||||||
|
entry := map[string]configkit.Origin{}
|
||||||
|
result, err := configkit.LoadLayered[map[string]any](configkit.Input{Source: configkit.Mapping("main", map[string]any{"main": true})}, configkit.LayeredOptions[map[string]any]{
|
||||||
|
Underlays: tiers,
|
||||||
|
Definition: configkit.Definition[map[string]any]{Resolve: func(_ *map[string]any, resolution *configkit.Resolution) error {
|
||||||
|
for _, pointer := range paths {
|
||||||
|
path, _ := configkit.ParsePath(pointer)
|
||||||
|
info, ok := resolution.InputInfo(path)
|
||||||
|
if !ok {
|
||||||
|
t.Errorf("missing resolver input %s", pointer)
|
||||||
|
}
|
||||||
|
entry[pointer] = info.Origin
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
var sourceID string
|
||||||
|
for _, source := range result.Sources() {
|
||||||
|
if source.Path == "items.yml" {
|
||||||
|
sourceID = source.ID
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if sourceID == "" {
|
||||||
|
t.Fatal("missing imported source")
|
||||||
|
}
|
||||||
|
for _, pointer := range paths {
|
||||||
|
path, _ := configkit.ParsePath(pointer)
|
||||||
|
info, ok := result.Metadata().Lookup(path)
|
||||||
|
if !ok || info.Origin.Layer != configkit.LayerUnderlay || len(info.Origin.Locations) != 1 || info.Origin.Locations[0].SourceID != sourceID {
|
||||||
|
t.Errorf("%s origin = %+v", pointer, info.Origin)
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(entry[pointer], info.Origin) {
|
||||||
|
t.Errorf("%s resolver origin differs", pointer)
|
||||||
|
}
|
||||||
|
explanation, ok := result.Explain(path)
|
||||||
|
if !ok || !reflect.DeepEqual(explanation.Origin, info.Origin) {
|
||||||
|
t.Errorf("%s explanation origin differs", pointer)
|
||||||
|
}
|
||||||
|
history := result.Metadata().History(path)
|
||||||
|
if len(history) == 0 || !reflect.DeepEqual(history[len(history)-1].Origin, info.Origin) {
|
||||||
|
t.Errorf("%s history = %+v", pointer, history)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnderlayHistoryRetainsLaterMappingContributors(t *testing.T) {
|
||||||
|
result, err := configkit.LoadLayered[map[string]any](configkit.Input{Source: configkit.NoSource()}, configkit.LayeredOptions[map[string]any]{Underlays: []configkit.Underlay{
|
||||||
|
{Inputs: []configkit.Input{{Source: configkit.Mapping("one", map[string]any{"x": 1})}}},
|
||||||
|
{Inputs: []configkit.Input{{Source: configkit.Mapping("two", map[string]any{"x": map[string]any{}})}}},
|
||||||
|
{Inputs: []configkit.Input{{Source: configkit.Mapping("three", map[string]any{"x": map[string]any{"y": 2}})}}},
|
||||||
|
}})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
path := configkit.Keys("x")
|
||||||
|
info, _ := result.Metadata().Lookup(path)
|
||||||
|
wantOrigin := configkit.Origin{Layer: configkit.LayerUnderlay, Locations: []configkit.Location{{SourceID: "source-2"}, {SourceID: "source-3"}}}
|
||||||
|
if !reflect.DeepEqual(info.Origin, wantOrigin) {
|
||||||
|
t.Fatalf("effective origin = %+v, want %+v", info.Origin, wantOrigin)
|
||||||
|
}
|
||||||
|
history := result.Metadata().History(path)
|
||||||
|
if len(history) != 3 || !reflect.DeepEqual(history[len(history)-1].Origin, info.Origin) {
|
||||||
|
t.Fatalf("history = %+v, effective origin = %+v", history, info.Origin)
|
||||||
|
}
|
||||||
|
explanation, ok := result.Explain(path)
|
||||||
|
if !ok || !reflect.DeepEqual(explanation.Origin, info.Origin) {
|
||||||
|
t.Fatal("explanation and metadata disagree")
|
||||||
|
}
|
||||||
|
if len(explanation.History) != 3 {
|
||||||
|
t.Fatalf("explanation history = %+v", explanation.History)
|
||||||
|
}
|
||||||
|
last := explanation.History[len(explanation.History)-1].Origin
|
||||||
|
if last.Layer != configkit.LayerUnderlay || len(last.Locations) != 1 || last.Locations[0].SourceID != "source-3" {
|
||||||
|
t.Fatalf("last explanation origin = %+v", last)
|
||||||
|
}
|
||||||
|
}
|
||||||
10
go.mod
10
go.mod
@@ -1,5 +1,13 @@
|
|||||||
module gitea.maximumdirect.net/eric/ConfigKit
|
module gitea.maximumdirect.net/eric/ConfigKit
|
||||||
|
|
||||||
go 1.25.0
|
go 1.26.0
|
||||||
|
|
||||||
require go.yaml.in/yaml/v4 v4.0.0-rc.6
|
require go.yaml.in/yaml/v4 v4.0.0-rc.6
|
||||||
|
|
||||||
|
require (
|
||||||
|
gitea.maximumdirect.net/eric/ReleaseKit v0.3.0 // indirect
|
||||||
|
github.com/yuin/goldmark/v2 v2.1.6 // indirect
|
||||||
|
golang.org/x/mod v0.40.0 // indirect
|
||||||
|
)
|
||||||
|
|
||||||
|
tool gitea.maximumdirect.net/eric/ReleaseKit/cmd/releasekit
|
||||||
|
|||||||
6
go.sum
6
go.sum
@@ -1,2 +1,8 @@
|
|||||||
|
gitea.maximumdirect.net/eric/ReleaseKit v0.3.0 h1:aTMn+50MEpHpHI2RoCCmJYsy7Ohrpa+RSva63Kq0/tU=
|
||||||
|
gitea.maximumdirect.net/eric/ReleaseKit v0.3.0/go.mod h1:LVodqNQ3OIKv9NBq+fFeyMByd1lHY25YOmmpah/NaNI=
|
||||||
|
github.com/yuin/goldmark/v2 v2.1.6 h1:igy0q9JcqovoFXFx/XjtU8sHVhcUHavPj2sA3EoKJUE=
|
||||||
|
github.com/yuin/goldmark/v2 v2.1.6/go.mod h1:G6M4/qOFtfn01/o14BU1UR2Lo5N3S9Qo7xCuz/sHjGQ=
|
||||||
go.yaml.in/yaml/v4 v4.0.0-rc.6 h1:1h7H1ohdUh93/FyE4YaDa1Zh64K6VVbjF4K6WUxMtH4=
|
go.yaml.in/yaml/v4 v4.0.0-rc.6 h1:1h7H1ohdUh93/FyE4YaDa1Zh64K6VVbjF4K6WUxMtH4=
|
||||||
go.yaml.in/yaml/v4 v4.0.0-rc.6/go.mod h1:aZqd9kCMsGL7AuUv/m/PvWLdg5sjJsZ4oHDEnfPPfY0=
|
go.yaml.in/yaml/v4 v4.0.0-rc.6/go.mod h1:aZqd9kCMsGL7AuUv/m/PvWLdg5sjJsZ4oHDEnfPPfY0=
|
||||||
|
golang.org/x/mod v0.40.0 h1:hUv+3cXcdRHz08UmSiOob7sadHig73uo5bkXxQ/tvUs=
|
||||||
|
golang.org/x/mod v0.40.0/go.mod h1:0/weTWkPWGBikyTWAX3dkjVztMmBA5hM0DH6BElSupE=
|
||||||
|
|||||||
@@ -39,7 +39,8 @@ type Explanation struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Explain returns safe effective and chronological values for a known final or
|
// Explain returns safe effective and chronological values for a known final or
|
||||||
// historical path. Unknown and malformed paths return false.
|
// historical path. Structural inheritance appears between source applications
|
||||||
|
// and typed reconciliation. Unknown and malformed paths return false.
|
||||||
func (r *Result[T]) Explain(path Path) (Explanation, bool) {
|
func (r *Result[T]) Explain(path Path) (Explanation, bool) {
|
||||||
if r == nil {
|
if r == nil {
|
||||||
return Explanation{}, false
|
return Explanation{}, false
|
||||||
|
|||||||
119
internal/engine/assembly_bench_test.go
Normal file
119
internal/engine/assembly_bench_test.go
Normal file
@@ -0,0 +1,119 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strconv"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
||||||
|
)
|
||||||
|
|
||||||
|
func BenchmarkComposeWideMappings(b *testing.B) {
|
||||||
|
for _, width := range []int{128, 256, 512} {
|
||||||
|
b.Run(strconv.Itoa(width), func(b *testing.B) {
|
||||||
|
left := benchmarkCatalog("source-1", 0, width)
|
||||||
|
right := benchmarkCatalog("source-2", width, width)
|
||||||
|
b.ReportAllocs()
|
||||||
|
b.ResetTimer()
|
||||||
|
for range b.N {
|
||||||
|
if _, diagnostics := composeDocuments(left, right); len(diagnostics) != 0 {
|
||||||
|
b.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func BenchmarkOverlayRecursiveMappings(b *testing.B) {
|
||||||
|
for _, width := range []int{128, 256, 512} {
|
||||||
|
b.Run(strconv.Itoa(width), func(b *testing.B) {
|
||||||
|
base, diagnostics := composeDocuments(benchmarkCatalog("source-1", 0, width))
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
b.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
overlay := benchmarkCatalog("source-2", width/2, width)
|
||||||
|
b.ReportAllocs()
|
||||||
|
b.ResetTimer()
|
||||||
|
for range b.N {
|
||||||
|
if _, diagnostics := overlayDocuments(base, overlay); len(diagnostics) != 0 {
|
||||||
|
b.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func BenchmarkOverlayManyApplications(b *testing.B) {
|
||||||
|
for _, count := range []int{32, 64, 128} {
|
||||||
|
inputs := make([]*document.Node, count)
|
||||||
|
for index := range inputs {
|
||||||
|
inputs[index] = benchmarkCatalog("source-2", index, 1)
|
||||||
|
}
|
||||||
|
benchmarkOverlayApplications(b, count, inputs)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func BenchmarkOverlayRepeatedReplacement(b *testing.B) {
|
||||||
|
for _, count := range []int{32, 64, 128} {
|
||||||
|
inputs := make([]*document.Node, count)
|
||||||
|
for index := range inputs {
|
||||||
|
location := document.Location{SourceID: "source-2"}
|
||||||
|
value := &document.Node{Kind: document.String, Text: "replacement", Location: location}
|
||||||
|
if index%2 == 0 {
|
||||||
|
value = &document.Node{Kind: document.Mapping, Location: location, Mapping: []document.Entry{{
|
||||||
|
Key: "enabled", Value: &document.Node{Kind: document.Boolean, Text: "false", Location: location},
|
||||||
|
}}}
|
||||||
|
}
|
||||||
|
inputs[index] = &document.Node{Kind: document.Mapping, Location: location, Mapping: []document.Entry{{
|
||||||
|
Key: "catalog", Value: &document.Node{Kind: document.Mapping, Location: location, Mapping: []document.Entry{{
|
||||||
|
Key: "item-0", Value: value,
|
||||||
|
}}},
|
||||||
|
}}}
|
||||||
|
}
|
||||||
|
benchmarkOverlayApplications(b, count, inputs)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func benchmarkOverlayApplications(b *testing.B, count int, inputs []*document.Node) {
|
||||||
|
base, diagnostics := composeDocuments(benchmarkCatalog("source-1", 0, 1))
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
b.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
for _, mode := range []string{"owned", "copy-preserving"} {
|
||||||
|
b.Run(mode+"/"+strconv.Itoa(count), func(b *testing.B) {
|
||||||
|
b.ReportAllocs()
|
||||||
|
b.ResetTimer()
|
||||||
|
for range b.N {
|
||||||
|
if mode == "owned" {
|
||||||
|
assembly := newAssemblyAccumulator(cloneComposedDocument(base))
|
||||||
|
for _, input := range inputs {
|
||||||
|
if diagnostics := assembly.applyOverlay(input, nil, nil, LayerOverlay); len(diagnostics) != 0 {
|
||||||
|
b.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
current := base
|
||||||
|
for _, input := range inputs {
|
||||||
|
current, diagnostics = overlayDocuments(current, input)
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
b.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func benchmarkCatalog(source string, first, width int) *document.Node {
|
||||||
|
location := document.Location{SourceID: source}
|
||||||
|
entries := make([]document.Entry, width)
|
||||||
|
for index := range entries {
|
||||||
|
entries[index] = document.Entry{
|
||||||
|
Key: "item-" + strconv.Itoa(first+index),
|
||||||
|
Value: &document.Node{Kind: document.Mapping, Location: location, Mapping: []document.Entry{{Key: "enabled", Value: &document.Node{Kind: document.Boolean, Text: "true", Location: location}}}},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return &document.Node{Kind: document.Mapping, Location: location, Mapping: []document.Entry{{
|
||||||
|
Key: "catalog", Value: &document.Node{Kind: document.Mapping, Location: location, Mapping: entries},
|
||||||
|
}}}
|
||||||
|
}
|
||||||
@@ -15,6 +15,17 @@ type composedDocument struct {
|
|||||||
inputNodes int
|
inputNodes int
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// assemblyAccumulator owns one mutable working document. Acquired trees held by
|
||||||
|
// history applications are separate from its root and remain unchanged.
|
||||||
|
type assemblyAccumulator struct {
|
||||||
|
current *composedDocument
|
||||||
|
index mappingIndex
|
||||||
|
}
|
||||||
|
|
||||||
|
func newAssemblyAccumulator(owned *composedDocument) *assemblyAccumulator {
|
||||||
|
return &assemblyAccumulator{current: owned}
|
||||||
|
}
|
||||||
|
|
||||||
// cloneComposedDocument detaches mutable composition and provenance state;
|
// cloneComposedDocument detaches mutable composition and provenance state;
|
||||||
// history application trees are immutable and retain their existing sharing.
|
// history application trees are immutable and retain their existing sharing.
|
||||||
func cloneComposedDocument(base *composedDocument) *composedDocument {
|
func cloneComposedDocument(base *composedDocument) *composedDocument {
|
||||||
@@ -58,8 +69,14 @@ func composeDocuments(inputs ...*document.Node) (*composedDocument, []Diagnostic
|
|||||||
collected.append(input, Path{})
|
collected.append(input, Path{})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
checked := make(map[string]struct{}, len(collected.byPath))
|
||||||
for _, claim := range collected.ordered {
|
for _, claim := range collected.ordered {
|
||||||
claims := collected.byPath[claim.path.String()]
|
pointer := claim.path.String()
|
||||||
|
if _, seen := checked[pointer]; seen {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
checked[pointer] = struct{}{}
|
||||||
|
claims := collected.byPath[pointer]
|
||||||
if len(claims) < 2 || allMappingClaims(claims) {
|
if len(claims) < 2 || allMappingClaims(claims) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
@@ -67,21 +84,43 @@ func composeDocuments(inputs ...*document.Node) (*composedDocument, []Diagnostic
|
|||||||
}
|
}
|
||||||
|
|
||||||
root := document.Clone(inputs[0])
|
root := document.Clone(inputs[0])
|
||||||
|
index := new(mappingIndex)
|
||||||
for _, input := range inputs[1:] {
|
for _, input := range inputs[1:] {
|
||||||
mergeDisjointMappings(root, input)
|
mergeDisjointMappings(root, input, index)
|
||||||
}
|
}
|
||||||
applications := make([]historyApplication, 0, len(inputs))
|
applications := make([]historyApplication, 0, len(inputs))
|
||||||
for _, input := range inputs {
|
for _, input := range inputs {
|
||||||
applications = append(applications, historyApplication{layer: LayerBase, value: input})
|
applications = append(applications, historyApplication{layer: LayerBase, value: input})
|
||||||
}
|
}
|
||||||
|
origins := compositionOrigins(collected.ordered)
|
||||||
|
completeCompositionOrigins(root, Path{}, origins)
|
||||||
return &composedDocument{
|
return &composedDocument{
|
||||||
root: root,
|
root: root,
|
||||||
claims: cloneCompositionClaims(collected.ordered),
|
claims: cloneCompositionClaims(collected.ordered),
|
||||||
origins: compositionOrigins(collected.ordered),
|
origins: origins,
|
||||||
applications: applications,
|
applications: applications,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Conflict claims treat sequences atomically, but inspection needs origins for
|
||||||
|
// every descendant. Preserve composite mapping claims while filling those gaps.
|
||||||
|
func completeCompositionOrigins(node *document.Node, path Path, origins map[string]Origin) {
|
||||||
|
pointer := path.String()
|
||||||
|
if _, present := origins[pointer]; !present {
|
||||||
|
origins[pointer] = Origin{Layer: LayerBase, Locations: []Location{publicLocation(node.Location)}}
|
||||||
|
}
|
||||||
|
switch node.Kind {
|
||||||
|
case document.Mapping:
|
||||||
|
for _, entry := range node.Mapping {
|
||||||
|
completeCompositionOrigins(entry.Value, path.Key(entry.Key), origins)
|
||||||
|
}
|
||||||
|
case document.Sequence:
|
||||||
|
for index, child := range node.Sequence {
|
||||||
|
completeCompositionOrigins(child, path.Index(index), origins)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func (c *compositionClaims) append(node *document.Node, path Path) {
|
func (c *compositionClaims) append(node *document.Node, path Path) {
|
||||||
claim := compositionClaim{
|
claim := compositionClaim{
|
||||||
path: path.clone(),
|
path: path.clone(),
|
||||||
@@ -109,18 +148,18 @@ func allMappingClaims(claims []compositionClaim) bool {
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
func mergeDisjointMappings(target, incoming *document.Node) {
|
func mergeDisjointMappings(target, incoming *document.Node, index *mappingIndex) {
|
||||||
for _, incomingEntry := range incoming.Mapping {
|
for _, incomingEntry := range incoming.Mapping {
|
||||||
index := documentEntryIndex(target.Mapping, incomingEntry.Key)
|
position := index.find(target, incomingEntry.Key)
|
||||||
if index < 0 {
|
if position < 0 {
|
||||||
cloned := incomingEntry
|
cloned := incomingEntry
|
||||||
cloned.Value = document.Clone(incomingEntry.Value)
|
cloned.Value = document.Clone(incomingEntry.Value)
|
||||||
target.Mapping = append(target.Mapping, cloned)
|
index.append(target, cloned)
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
// Claim validation guarantees that the only remaining overlap is a
|
// Claim validation guarantees that the only remaining overlap is a
|
||||||
// mapping pair. Empty mappings naturally contribute no child entries.
|
// mapping pair. Empty mappings naturally contribute no child entries.
|
||||||
mergeDisjointMappings(target.Mapping[index].Value, incomingEntry.Value)
|
mergeDisjointMappings(target.Mapping[position].Value, incomingEntry.Value, index)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -116,6 +116,31 @@ func TestComposeDocumentsReportsAllClaimantsAtExactLocations(t *testing.T) {
|
|||||||
assertCompositionConflict(t, diagnostics, "/group", []string{"source-1", "source-2", "source-3"})
|
assertCompositionConflict(t, diagnostics, "/group", []string{"source-1", "source-2", "source-3"})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestComposeDocumentsKeepsFirstConflictAndAppendedEntryOrder(t *testing.T) {
|
||||||
|
first := parseCompositionDocument(t, "source-1", "catalog:\n first: 1\n shared: one\n later: one\n")
|
||||||
|
second := parseCompositionDocument(t, "source-2", "catalog:\n second: 2\n shared: two\n later: two\n")
|
||||||
|
third := parseCompositionDocument(t, "source-3", "catalog:\n third: 3\n shared: three\n")
|
||||||
|
_, diagnostics := composeDocuments(first, second, third)
|
||||||
|
assertCompositionConflict(t, diagnostics, "/catalog/shared", []string{"source-1", "source-2", "source-3"})
|
||||||
|
|
||||||
|
composed, diagnostics := composeDocuments(
|
||||||
|
parseCompositionDocument(t, "source-1", "catalog:\n first: 1\n"),
|
||||||
|
parseCompositionDocument(t, "source-2", "catalog:\n second: 2\n"),
|
||||||
|
parseCompositionDocument(t, "source-3", "catalog:\n third: 3\n"),
|
||||||
|
)
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatalf("composeDocuments() diagnostics = %#v", diagnostics)
|
||||||
|
}
|
||||||
|
entries := composed.root.Mapping[0].Value.Mapping
|
||||||
|
got := make([]string, len(entries))
|
||||||
|
for index, entry := range entries {
|
||||||
|
got[index] = entry.Key
|
||||||
|
}
|
||||||
|
if want := []string{"first", "second", "third"}; !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("catalog keys = %#v, want %#v", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestComposeDocumentsTreatsEmptyMappingsAsChildlessContributions(t *testing.T) {
|
func TestComposeDocumentsTreatsEmptyMappingsAsChildlessContributions(t *testing.T) {
|
||||||
empty, diagnostics := composeDocuments(
|
empty, diagnostics := composeDocuments(
|
||||||
parseCompositionDocument(t, "source-1", "{}\n"),
|
parseCompositionDocument(t, "source-1", "{}\n"),
|
||||||
|
|||||||
@@ -85,15 +85,28 @@ func canonicalDiagnostics(diagnostics []Diagnostic) []Diagnostic {
|
|||||||
for i := range canonical {
|
for i := range canonical {
|
||||||
slices.SortFunc(canonical[i].Related, compareLocation)
|
slices.SortFunc(canonical[i].Related, compareLocation)
|
||||||
}
|
}
|
||||||
slices.SortFunc(canonical, compareDiagnostic)
|
type orderedDiagnostic struct {
|
||||||
|
diagnostic Diagnostic
|
||||||
|
pointer string
|
||||||
|
}
|
||||||
|
ordered := make([]orderedDiagnostic, len(canonical))
|
||||||
|
for i, diagnostic := range canonical {
|
||||||
|
ordered[i] = orderedDiagnostic{diagnostic: diagnostic, pointer: diagnostic.Path.String()}
|
||||||
|
}
|
||||||
|
slices.SortFunc(ordered, func(left, right orderedDiagnostic) int {
|
||||||
|
return compareDiagnosticWithPaths(left.diagnostic, right.diagnostic, left.pointer, right.pointer)
|
||||||
|
})
|
||||||
|
for i, item := range ordered {
|
||||||
|
canonical[i] = item.diagnostic
|
||||||
|
}
|
||||||
return canonical
|
return canonical
|
||||||
}
|
}
|
||||||
|
|
||||||
func compareDiagnostic(left, right Diagnostic) int {
|
func compareDiagnosticWithPaths(left, right Diagnostic, leftPath, rightPath string) int {
|
||||||
if order := compareOptionalLocation(left.Primary, right.Primary); order != 0 {
|
if order := compareOptionalLocation(left.Primary, right.Primary); order != 0 {
|
||||||
return order
|
return order
|
||||||
}
|
}
|
||||||
if order := cmp.Compare(left.Path.String(), right.Path.String()); order != 0 {
|
if order := cmp.Compare(leftPath, rightPath); order != 0 {
|
||||||
return order
|
return order
|
||||||
}
|
}
|
||||||
if order := cmp.Compare(left.Code, right.Code); order != 0 {
|
if order := cmp.Compare(left.Code, right.Code); order != 0 {
|
||||||
|
|||||||
@@ -90,6 +90,26 @@ func TestDiagnosticsAreCanonicalAndDetached(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestCanonicalDiagnosticsSortEscapedPaths(t *testing.T) {
|
||||||
|
primary := &Location{SourceID: "source-1", Line: 1, Column: 1}
|
||||||
|
diagnostics := []Diagnostic{
|
||||||
|
{Code: "same", Severity: SeverityError, Path: Keys("a/b"), Message: "same", Primary: primary},
|
||||||
|
{Code: "same", Severity: SeverityError, Path: Keys("a~b"), Message: "same", Primary: primary},
|
||||||
|
{Code: "z", Severity: SeverityError, Path: Keys("same"), Message: "same", Primary: primary},
|
||||||
|
{Code: "a", Severity: SeverityError, Path: Keys("same"), Message: "same", Primary: primary},
|
||||||
|
}
|
||||||
|
canonical := canonicalDiagnostics(diagnostics)
|
||||||
|
want := []string{"/a~0b", "/a~1b", "/same", "/same"}
|
||||||
|
for i, diagnostic := range canonical {
|
||||||
|
if got := diagnostic.Path.String(); got != want[i] {
|
||||||
|
t.Fatalf("diagnostic[%d] path = %q, want %q", i, got, want[i])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if canonical[2].Code != "a" || canonical[3].Code != "z" {
|
||||||
|
t.Fatalf("same-path code order = %q, %q", canonical[2].Code, canonical[3].Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestWriteDiagnosticsEscapesControls(t *testing.T) {
|
func TestWriteDiagnosticsEscapesControls(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
|
|||||||
@@ -181,24 +181,24 @@ func nodeImportDiagnostic(code Code, path Path, message string, node *document.N
|
|||||||
return Diagnostic{Code: code, Severity: SeverityError, Path: path, Message: message, Primary: &location}
|
return Diagnostic{Code: code, Severity: SeverityError, Path: path, Message: message, Primary: &location}
|
||||||
}
|
}
|
||||||
|
|
||||||
func profileDirectiveDiagnostics(node *document.Node, current Path) []Diagnostic {
|
func overlayDirectiveDiagnostics(node *document.Node, current Path) []Diagnostic {
|
||||||
if node.Kind == document.Mapping {
|
if node.Kind == document.Mapping {
|
||||||
for _, entry := range node.Mapping {
|
for _, entry := range node.Mapping {
|
||||||
childPath := current.Key(entry.Key)
|
childPath := current.Key(entry.Key)
|
||||||
if entry.Key == directiveKey {
|
if entry.Key == directiveKey {
|
||||||
location := publicLocation(entry.KeyLocation)
|
location := publicLocation(entry.KeyLocation)
|
||||||
return []Diagnostic{{
|
return []Diagnostic{{
|
||||||
Code: CodeProfileDirective, Severity: SeverityError, Path: childPath,
|
Code: CodeOverlayDirective, Severity: SeverityError, Path: childPath,
|
||||||
Message: "profiles cannot contain configuration directives", Primary: &location,
|
Message: "overlays cannot contain configuration directives", Primary: &location,
|
||||||
}}
|
}}
|
||||||
}
|
}
|
||||||
if diagnostics := profileDirectiveDiagnostics(entry.Value, childPath); len(diagnostics) != 0 {
|
if diagnostics := overlayDirectiveDiagnostics(entry.Value, childPath); len(diagnostics) != 0 {
|
||||||
return diagnostics
|
return diagnostics
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} else if node.Kind == document.Sequence {
|
} else if node.Kind == document.Sequence {
|
||||||
for index, child := range node.Sequence {
|
for index, child := range node.Sequence {
|
||||||
if diagnostics := profileDirectiveDiagnostics(child, current.Index(index)); len(diagnostics) != 0 {
|
if diagnostics := overlayDirectiveDiagnostics(child, current.Index(index)); len(diagnostics) != 0 {
|
||||||
return diagnostics
|
return diagnostics
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -24,12 +24,23 @@ type documentDelta struct {
|
|||||||
func compareConfigurationValues(before, after *document.Node) []documentDelta {
|
func compareConfigurationValues(before, after *document.Node) []documentDelta {
|
||||||
var deltas []documentDelta
|
var deltas []documentDelta
|
||||||
compareConfigurationValue(before, after, Path{}, &deltas)
|
compareConfigurationValue(before, after, Path{}, &deltas)
|
||||||
slices.SortFunc(deltas, func(left, right documentDelta) int {
|
type orderedDelta struct {
|
||||||
if order := cmp.Compare(left.path.String(), right.path.String()); order != 0 {
|
delta documentDelta
|
||||||
|
pointer string
|
||||||
|
}
|
||||||
|
ordered := make([]orderedDelta, len(deltas))
|
||||||
|
for i, delta := range deltas {
|
||||||
|
ordered[i] = orderedDelta{delta: delta, pointer: delta.path.String()}
|
||||||
|
}
|
||||||
|
slices.SortFunc(ordered, func(left, right orderedDelta) int {
|
||||||
|
if order := cmp.Compare(left.pointer, right.pointer); order != 0 {
|
||||||
return order
|
return order
|
||||||
}
|
}
|
||||||
return int(left.kind) - int(right.kind)
|
return int(left.delta.kind) - int(right.delta.kind)
|
||||||
})
|
})
|
||||||
|
for i, item := range ordered {
|
||||||
|
deltas[i] = item.delta
|
||||||
|
}
|
||||||
return deltas
|
return deltas
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
54
internal/engine/document_lookup.go
Normal file
54
internal/engine/document_lookup.go
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import "gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
||||||
|
|
||||||
|
// documentLookup contains read-only mapping positions for a completed document.
|
||||||
|
type documentLookup struct {
|
||||||
|
byNode map[*document.Node]map[string]int
|
||||||
|
}
|
||||||
|
|
||||||
|
func buildDocumentLookup(roots ...*document.Node) *documentLookup {
|
||||||
|
lookup := &documentLookup{byNode: make(map[*document.Node]map[string]int)}
|
||||||
|
visited := make(map[*document.Node]struct{})
|
||||||
|
var visit func(*document.Node)
|
||||||
|
visit = func(node *document.Node) {
|
||||||
|
if node == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if _, ok := visited[node]; ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
visited[node] = struct{}{}
|
||||||
|
switch node.Kind {
|
||||||
|
case document.Mapping:
|
||||||
|
entries := make(map[string]int, len(node.Mapping))
|
||||||
|
for index, entry := range node.Mapping {
|
||||||
|
if _, exists := entries[entry.Key]; !exists {
|
||||||
|
entries[entry.Key] = index
|
||||||
|
}
|
||||||
|
visit(entry.Value)
|
||||||
|
}
|
||||||
|
lookup.byNode[node] = entries
|
||||||
|
case document.Sequence:
|
||||||
|
for _, child := range node.Sequence {
|
||||||
|
visit(child)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, root := range roots {
|
||||||
|
visit(root)
|
||||||
|
}
|
||||||
|
return lookup
|
||||||
|
}
|
||||||
|
|
||||||
|
func (lookup *documentLookup) find(node *document.Node, key string) int {
|
||||||
|
if lookup == nil {
|
||||||
|
return -1
|
||||||
|
}
|
||||||
|
if entries := lookup.byNode[node]; entries != nil {
|
||||||
|
if index, ok := entries[key]; ok {
|
||||||
|
return index
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return -1
|
||||||
|
}
|
||||||
@@ -31,6 +31,10 @@ func indexDocument(node *document.Node, path Path, index map[string]*document.No
|
|||||||
}
|
}
|
||||||
|
|
||||||
func documentAtPath(root *document.Node, path Path) (*document.Node, bool) {
|
func documentAtPath(root *document.Node, path Path) (*document.Node, bool) {
|
||||||
|
return documentAtPathWithLookup(root, path, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
func documentAtPathWithLookup(root *document.Node, path Path, lookup *documentLookup) (*document.Node, bool) {
|
||||||
if root == nil || !path.valid() {
|
if root == nil || !path.valid() {
|
||||||
return nil, false
|
return nil, false
|
||||||
}
|
}
|
||||||
@@ -41,17 +45,21 @@ func documentAtPath(root *document.Node, path Path) (*document.Node, bool) {
|
|||||||
if segment.kind == pathSegmentIndex {
|
if segment.kind == pathSegmentIndex {
|
||||||
return nil, false
|
return nil, false
|
||||||
}
|
}
|
||||||
found := false
|
entryIndex := -1
|
||||||
for _, entry := range current.Mapping {
|
if lookup != nil {
|
||||||
if entry.Key == segment.key {
|
entryIndex = lookup.find(current, segment.key)
|
||||||
current = entry.Value
|
} else {
|
||||||
found = true
|
for index, entry := range current.Mapping {
|
||||||
break
|
if entry.Key == segment.key {
|
||||||
|
entryIndex = index
|
||||||
|
break
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if !found {
|
if entryIndex < 0 || entryIndex >= len(current.Mapping) {
|
||||||
return nil, false
|
return nil, false
|
||||||
}
|
}
|
||||||
|
current = current.Mapping[entryIndex].Value
|
||||||
case document.Sequence:
|
case document.Sequence:
|
||||||
index, ok := schemaIndex(segment)
|
index, ok := schemaIndex(segment)
|
||||||
if !ok || index >= len(current.Sequence) {
|
if !ok || index >= len(current.Sequence) {
|
||||||
|
|||||||
@@ -40,7 +40,7 @@ func (r *Inspection) Explain(path Path) (Explanation, bool) {
|
|||||||
if r == nil || r.final == nil || r.baseline == nil || !r.metadata.hasHistoricalPath(path) {
|
if r == nil || r.final == nil || r.baseline == nil || !r.metadata.hasHistoricalPath(path) {
|
||||||
return Explanation{}, false
|
return Explanation{}, false
|
||||||
}
|
}
|
||||||
explanation := Explanation{Path: path.clone(), Effective: valueSnapshot(r.final, path, r.secrets)}
|
explanation := Explanation{Path: path.clone(), Effective: valueSnapshotWithLookup(r.final, path, r.secrets, r.immutableLookup)}
|
||||||
if info, ok := r.metadata.Lookup(path); ok {
|
if info, ok := r.metadata.Lookup(path); ok {
|
||||||
explanation.Origin = cloneOrigin(info.Origin)
|
explanation.Origin = cloneOrigin(info.Origin)
|
||||||
}
|
}
|
||||||
@@ -51,13 +51,14 @@ func (r *Inspection) Explain(path Path) (Explanation, bool) {
|
|||||||
After: valueSnapshot(working, path, r.secrets), Origin: Origin{Layer: LayerDefault},
|
After: valueSnapshot(working, path, r.secrets), Origin: Origin{Layer: LayerDefault},
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
replayIndex := new(mappingIndex)
|
||||||
for _, application := range r.applications {
|
for _, application := range r.applications {
|
||||||
operationPath, relevant := applicationOperationPath(application, path)
|
operationPath, relevant := applicationOperationPath(application, path, r.immutableLookup)
|
||||||
var before ValueSnapshot
|
var before ValueSnapshot
|
||||||
if relevant {
|
if relevant {
|
||||||
before = valueSnapshot(working, path, r.secrets)
|
before = valueSnapshot(working, path, r.secrets)
|
||||||
}
|
}
|
||||||
applyHistoryApplication(&working, application)
|
applyHistoryApplication(&working, application, replayIndex)
|
||||||
if !relevant {
|
if !relevant {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
@@ -68,28 +69,29 @@ func (r *Inspection) Explain(path Path) (Explanation, bool) {
|
|||||||
explanation.History = append(explanation.History, ValueChange{
|
explanation.History = append(explanation.History, ValueChange{
|
||||||
Before: before,
|
Before: before,
|
||||||
After: after,
|
After: after,
|
||||||
Origin: historyApplicationOrigin(application, operationPath),
|
Origin: historyApplicationOrigin(application, operationPath, r.immutableLookup),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
appendInheritanceExplanation(&explanation, &working, path, r.inheritance, r.secrets)
|
||||||
|
|
||||||
// Intermediate input replacements do not permanently suppress defaults:
|
// Intermediate input replacements do not permanently suppress defaults:
|
||||||
// decoding applies them to the final input tree. Show that reconciliation
|
// decoding applies them to the final input tree. Show that reconciliation
|
||||||
// explicitly, including canonical scalar conversions, before domain changes.
|
// explicitly, including canonical scalar conversions, before domain changes.
|
||||||
replayed, _ := documentAtPath(working, path)
|
replayed, _ := documentAtPath(working, path)
|
||||||
decoded, _ := documentAtPath(r.input, path)
|
decoded, _ := documentAtPathWithLookup(r.input, path, r.immutableLookup)
|
||||||
if !configurationValuesEqual(replayed, decoded) {
|
if !configurationValuesEqual(replayed, decoded) {
|
||||||
origin := cloneOrigin(r.inputOrigins[path.String()])
|
origin := cloneOrigin(r.inputOrigins[path.String()])
|
||||||
origin.Operation = ChangeDecoding
|
origin.Operation = ChangeDecoding
|
||||||
explanation.History = append(explanation.History, ValueChange{
|
explanation.History = append(explanation.History, ValueChange{
|
||||||
Before: valueSnapshot(working, path, r.secrets),
|
Before: valueSnapshot(working, path, r.secrets),
|
||||||
After: valueSnapshot(r.input, path, r.secrets),
|
After: valueSnapshotWithLookup(r.input, path, r.secrets, r.immutableLookup),
|
||||||
Origin: origin,
|
Origin: origin,
|
||||||
Reasons: []string{"applied retained defaults and canonical typed decoding"},
|
Reasons: []string{"applied retained defaults and canonical typed decoding"},
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
working = document.Clone(r.input)
|
working = document.Clone(r.input)
|
||||||
for _, snapshot := range coalescedResolutionSnapshots(r.resolution) {
|
for _, snapshot := range r.resolutionReplay {
|
||||||
relevant := pathsIntersect(snapshot.change.Path, path)
|
relevant := pathsIntersect(snapshot.change.Path, path)
|
||||||
var before ValueSnapshot
|
var before ValueSnapshot
|
||||||
if relevant {
|
if relevant {
|
||||||
|
|||||||
@@ -23,10 +23,14 @@ func (r *Inspection) WriteExplanation(output io.Writer, path Path) error {
|
|||||||
return errExplanationUnknownPath
|
return errExplanationUnknownPath
|
||||||
}
|
}
|
||||||
var rendered strings.Builder
|
var rendered strings.Builder
|
||||||
|
labels := make(map[string]string, len(r.sources))
|
||||||
|
for _, source := range r.sources {
|
||||||
|
labels[source.ID] = source.Label
|
||||||
|
}
|
||||||
rendered.WriteString("path: ")
|
rendered.WriteString("path: ")
|
||||||
rendered.WriteString(strconv.Quote(explanation.Path.String()))
|
rendered.WriteString(strconv.Quote(explanation.Path.String()))
|
||||||
rendered.WriteByte('\n')
|
rendered.WriteByte('\n')
|
||||||
writeExplanationOrigin(&rendered, "effective source", explanation.Origin, r.sources)
|
writeExplanationOrigin(&rendered, "effective source", explanation.Origin, labels)
|
||||||
writeExplanationSnapshot(&rendered, "effective (canonical typed)", explanation.Effective, 0)
|
writeExplanationSnapshot(&rendered, "effective (canonical typed)", explanation.Effective, 0)
|
||||||
if explanation.SecretReference != nil {
|
if explanation.SecretReference != nil {
|
||||||
rendered.WriteString("secret reference: ")
|
rendered.WriteString("secret reference: ")
|
||||||
@@ -38,12 +42,14 @@ func (r *Inspection) WriteExplanation(output io.Writer, path Path) error {
|
|||||||
rendered.WriteString(" - representation: ")
|
rendered.WriteString(" - representation: ")
|
||||||
if change.Origin.Operation == ChangeDecoding {
|
if change.Origin.Operation == ChangeDecoding {
|
||||||
rendered.WriteString("input to canonical typed\n")
|
rendered.WriteString("input to canonical typed\n")
|
||||||
} else if change.Origin.Layer == LayerBase || change.Origin.Layer == LayerProfile || change.Origin.Layer == LayerCLI {
|
} else if change.Origin.Operation == ChangeInheritance {
|
||||||
|
rendered.WriteString("structural inheritance\n")
|
||||||
|
} else if change.Origin.Layer == LayerBase || change.Origin.Layer == LayerUnderlay || change.Origin.Layer == LayerOverlay || change.Origin.Layer == LayerCLI {
|
||||||
rendered.WriteString("policy-validated input\n")
|
rendered.WriteString("policy-validated input\n")
|
||||||
} else {
|
} else {
|
||||||
rendered.WriteString("canonical typed\n")
|
rendered.WriteString("canonical typed\n")
|
||||||
}
|
}
|
||||||
writeExplanationOrigin(&rendered, " source", change.Origin, r.sources)
|
writeExplanationOrigin(&rendered, " source", change.Origin, labels)
|
||||||
writeExplanationSnapshot(&rendered, " before", change.Before, 4)
|
writeExplanationSnapshot(&rendered, " before", change.Before, 4)
|
||||||
writeExplanationSnapshot(&rendered, " after", change.After, 4)
|
writeExplanationSnapshot(&rendered, " after", change.After, 4)
|
||||||
for _, reason := range change.Reasons {
|
for _, reason := range change.Reasons {
|
||||||
@@ -65,7 +71,7 @@ func (r *Inspection) WriteExplanation(output io.Writer, path Path) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
func writeExplanationOrigin(output *strings.Builder, label string, origin Origin, sources []SourceInfo) {
|
func writeExplanationOrigin(output *strings.Builder, label string, origin Origin, labels map[string]string) {
|
||||||
output.WriteString(label)
|
output.WriteString(label)
|
||||||
output.WriteString(": layer=")
|
output.WriteString(": layer=")
|
||||||
output.WriteString(strconv.Quote(string(origin.Layer)))
|
output.WriteString(strconv.Quote(string(origin.Layer)))
|
||||||
@@ -77,7 +83,7 @@ func writeExplanationOrigin(output *strings.Builder, label string, origin Origin
|
|||||||
for _, location := range origin.Locations {
|
for _, location := range origin.Locations {
|
||||||
output.WriteString(" location: source=")
|
output.WriteString(" location: source=")
|
||||||
output.WriteString(strconv.Quote(location.SourceID))
|
output.WriteString(strconv.Quote(location.SourceID))
|
||||||
if label := sourceLabel(sources, location.SourceID); label != "" {
|
if label := labels[location.SourceID]; label != "" {
|
||||||
output.WriteString(" label=")
|
output.WriteString(" label=")
|
||||||
output.WriteString(strconv.Quote(label))
|
output.WriteString(strconv.Quote(label))
|
||||||
}
|
}
|
||||||
@@ -87,15 +93,15 @@ func writeExplanationOrigin(output *strings.Builder, label string, origin Origin
|
|||||||
output.WriteString(strconv.Itoa(location.Column))
|
output.WriteString(strconv.Itoa(location.Column))
|
||||||
output.WriteByte('\n')
|
output.WriteByte('\n')
|
||||||
}
|
}
|
||||||
}
|
for _, step := range origin.Inheritance {
|
||||||
|
output.WriteString(" inherited: from=")
|
||||||
func sourceLabel(sources []SourceInfo, sourceID string) string {
|
output.WriteString(strconv.Quote(step.From.String()))
|
||||||
for _, source := range sources {
|
output.WriteString(" to=")
|
||||||
if source.ID == sourceID {
|
output.WriteString(strconv.Quote(step.To.String()))
|
||||||
return source.Label
|
output.WriteString(" reference=")
|
||||||
}
|
output.WriteString(strconv.Quote(step.Reference.String()))
|
||||||
|
output.WriteByte('\n')
|
||||||
}
|
}
|
||||||
return ""
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func writeExplanationSnapshot(output *strings.Builder, label string, snapshot ValueSnapshot, indent int) {
|
func writeExplanationSnapshot(output *strings.Builder, label string, snapshot ValueSnapshot, indent int) {
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ import (
|
|||||||
"path/filepath"
|
"path/filepath"
|
||||||
"reflect"
|
"reflect"
|
||||||
"strings"
|
"strings"
|
||||||
|
"sync"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
"gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
||||||
@@ -21,13 +22,13 @@ type explanationConcurrency struct {
|
|||||||
} `yaml:"transcription"`
|
} `yaml:"transcription"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestExplainShowsDefaultBaseAndEffectiveProfileValue(t *testing.T) {
|
func TestExplainShowsDefaultBaseAndEffectiveOverlayValue(t *testing.T) {
|
||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
mainPath := writeImportFile(t, directory, "config.yml", "configkit:\n imports: [{path: transcription.yml}]\n")
|
mainPath := writeImportFile(t, directory, "config.yml", "configkit:\n imports: [{path: transcription.yml}]\n")
|
||||||
writeImportFile(t, directory, "transcription.yml", "transcription:\n concurrency: 8\n")
|
writeImportFile(t, directory, "transcription.yml", "transcription:\n concurrency: 8\n")
|
||||||
writeImportFile(t, directory, filepath.Join("profiles", "testing.yml"), "transcription:\n concurrency: 1\n")
|
writeImportFile(t, directory, filepath.Join("overlays", "testing.yml"), "transcription:\n concurrency: 1\n")
|
||||||
result, err := testLoad[explanationConcurrency](File(mainPath), Options[explanationConcurrency]{
|
result, err := testLoad[explanationConcurrency](File(mainPath), Options[explanationConcurrency]{
|
||||||
Imports: true, Profile: "testing",
|
Imports: true, Overlay: "testing",
|
||||||
Definition: Definition[explanationConcurrency]{Defaults: func() explanationConcurrency {
|
Definition: Definition[explanationConcurrency]{Defaults: func() explanationConcurrency {
|
||||||
value := explanationConcurrency{}
|
value := explanationConcurrency{}
|
||||||
value.Transcription.Concurrency = 4
|
value.Transcription.Concurrency = 4
|
||||||
@@ -44,11 +45,17 @@ func TestExplainShowsDefaultBaseAndEffectiveProfileValue(t *testing.T) {
|
|||||||
if got := explanationValues(explanation); !reflect.DeepEqual(got, []string{"4\n", "8\n", "1\n"}) {
|
if got := explanationValues(explanation); !reflect.DeepEqual(got, []string{"4\n", "8\n", "1\n"}) {
|
||||||
t.Fatalf("history values = %#v", got)
|
t.Fatalf("history values = %#v", got)
|
||||||
}
|
}
|
||||||
if explanation.Effective.YAML != "1\n" || explanation.Origin.Layer != LayerProfile ||
|
if explanation.Effective.YAML != "1\n" || explanation.Origin.Layer != LayerOverlay ||
|
||||||
len(explanation.Origin.Locations) != 1 || explanation.Origin.Locations[0].SourceID != "source-3" ||
|
len(explanation.Origin.Locations) != 1 || explanation.Origin.Locations[0].SourceID != "source-3" ||
|
||||||
explanation.Origin.Locations[0].Line != 2 {
|
explanation.Origin.Locations[0].Line != 2 {
|
||||||
t.Fatalf("effective explanation = %#v", explanation)
|
t.Fatalf("effective explanation = %#v", explanation)
|
||||||
}
|
}
|
||||||
|
var rendered bytes.Buffer
|
||||||
|
if err := result.WriteExplanation(&rendered, Keys("transcription", "concurrency")); err != nil ||
|
||||||
|
!strings.Contains(rendered.String(), `layer="overlay"`) ||
|
||||||
|
!strings.Contains(rendered.String(), `label="overlays/testing.yml"`) {
|
||||||
|
t.Fatalf("rendered explanation = %v\n%s", err, rendered.String())
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
type explanationConfig struct {
|
type explanationConfig struct {
|
||||||
@@ -70,18 +77,18 @@ func TestExplainReplaysCLIResolutionContainersAndSafeHistoricalValues(t *testing
|
|||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
mainPath := writeImportFile(t, directory, "config.yml", `concurrency: 8
|
mainPath := writeImportFile(t, directory, "config.yml", `concurrency: 8
|
||||||
equal: same
|
equal: same
|
||||||
limit: wrong-before-profile
|
limit: wrong-before-overlay
|
||||||
items: [base, removed]
|
items: [base, removed]
|
||||||
labels: {base: retained}
|
labels: {base: retained}
|
||||||
dynamic: {retired: HISTORICAL_EXPLAIN_CANARY, public: visible}
|
dynamic: {retired: HISTORICAL_EXPLAIN_CANARY, public: visible}
|
||||||
credential: APP_SECRET
|
credential: APP_SECRET
|
||||||
classified: APP_SECRET
|
classified: APP_SECRET
|
||||||
`)
|
`)
|
||||||
writeImportFile(t, directory, filepath.Join("profiles", "testing.yml"), `concurrency: 1
|
writeImportFile(t, directory, filepath.Join("overlays", "testing.yml"), `concurrency: 1
|
||||||
equal: same
|
equal: same
|
||||||
limit: 7
|
limit: 7
|
||||||
items: [profile]
|
items: [overlay]
|
||||||
labels: {profile: retained}
|
labels: {overlay: retained}
|
||||||
dynamic: selected
|
dynamic: selected
|
||||||
`)
|
`)
|
||||||
result, err := testLoadWithSecretLookup(File(mainPath), func(name string) (string, bool) {
|
result, err := testLoadWithSecretLookup(File(mainPath), func(name string) (string, bool) {
|
||||||
@@ -90,7 +97,7 @@ dynamic: selected
|
|||||||
}
|
}
|
||||||
return "RESOLVED_EXPLAIN_CANARY", true
|
return "RESOLVED_EXPLAIN_CANARY", true
|
||||||
}, Options[explanationConfig]{
|
}, Options[explanationConfig]{
|
||||||
Profile: "testing",
|
Overlay: "testing",
|
||||||
Overrides: []Override{
|
Overrides: []Override{
|
||||||
{Path: Keys("concurrency"), Value: 2, Flag: "--concurrency"},
|
{Path: Keys("concurrency"), Value: 2, Flag: "--concurrency"},
|
||||||
{Path: Keys("equal"), Value: "same", Flag: "--equal"},
|
{Path: Keys("equal"), Value: "same", Flag: "--equal"},
|
||||||
@@ -130,7 +137,7 @@ dynamic: selected
|
|||||||
if got := explanationValues(concurrency); !reflect.DeepEqual(got, []string{"4\n", "8\n", "1\n", "2\n", "3\n"}) {
|
if got := explanationValues(concurrency); !reflect.DeepEqual(got, []string{"4\n", "8\n", "1\n", "2\n", "3\n"}) {
|
||||||
t.Fatalf("concurrency history = %#v", got)
|
t.Fatalf("concurrency history = %#v", got)
|
||||||
}
|
}
|
||||||
if got := historyValueLayers(concurrency); !reflect.DeepEqual(got, []Layer{LayerDefault, LayerBase, LayerProfile, LayerCLI, LayerResolution}) {
|
if got := historyValueLayers(concurrency); !reflect.DeepEqual(got, []Layer{LayerDefault, LayerBase, LayerOverlay, LayerCLI, LayerResolution}) {
|
||||||
t.Fatalf("concurrency layers = %#v", got)
|
t.Fatalf("concurrency layers = %#v", got)
|
||||||
}
|
}
|
||||||
if concurrency.History[4].Before.YAML != "2\n" || concurrency.History[4].Reasons[0] != "normalized\nconcurrency" ||
|
if concurrency.History[4].Before.YAML != "2\n" || concurrency.History[4].Reasons[0] != "normalized\nconcurrency" ||
|
||||||
@@ -149,7 +156,7 @@ dynamic: selected
|
|||||||
}
|
}
|
||||||
|
|
||||||
limit, _ := result.Explain(Keys("limit"))
|
limit, _ := result.Explain(Keys("limit"))
|
||||||
if got := explanationValues(limit); !reflect.DeepEqual(got, []string{"0\n", "wrong-before-profile\n", "7\n"}) {
|
if got := explanationValues(limit); !reflect.DeepEqual(got, []string{"0\n", "wrong-before-overlay\n", "7\n"}) {
|
||||||
t.Fatalf("overridden invalid input was not retained: %#v", got)
|
t.Fatalf("overridden invalid input was not retained: %#v", got)
|
||||||
}
|
}
|
||||||
removed, ok := result.Explain(Keys("dynamic", "retired"))
|
removed, ok := result.Explain(Keys("dynamic", "retired"))
|
||||||
@@ -182,7 +189,7 @@ dynamic: selected
|
|||||||
}
|
}
|
||||||
labels, _ := result.Explain(Keys("labels"))
|
labels, _ := result.Explain(Keys("labels"))
|
||||||
if len(labels.History) != 4 || !strings.Contains(labels.Effective.YAML, "default: retained") ||
|
if len(labels.History) != 4 || !strings.Contains(labels.Effective.YAML, "default: retained") ||
|
||||||
!strings.Contains(labels.Effective.YAML, "profile: retained") || !strings.Contains(labels.Effective.YAML, "cli: retained") {
|
!strings.Contains(labels.Effective.YAML, "overlay: retained") || !strings.Contains(labels.Effective.YAML, "cli: retained") {
|
||||||
t.Fatalf("composite mapping history = %#v", labels)
|
t.Fatalf("composite mapping history = %#v", labels)
|
||||||
}
|
}
|
||||||
if labels.Origin.Layer != LayerCLI || len(labels.Origin.Locations) != 3 {
|
if labels.Origin.Layer != LayerCLI || len(labels.Origin.Locations) != 3 {
|
||||||
@@ -258,7 +265,7 @@ dynamic: selected
|
|||||||
var invalidInput bytes.Buffer
|
var invalidInput bytes.Buffer
|
||||||
if err := result.WriteExplanation(&invalidInput, Keys("limit")); err != nil ||
|
if err := result.WriteExplanation(&invalidInput, Keys("limit")); err != nil ||
|
||||||
!strings.Contains(invalidInput.String(), "policy-validated input") ||
|
!strings.Contains(invalidInput.String(), "policy-validated input") ||
|
||||||
strings.Contains(invalidInput.String(), "wrong-before-profile\n source: layer=\"base\"\n before (canonical typed)") {
|
strings.Contains(invalidInput.String(), "wrong-before-overlay\n source: layer=\"base\"\n before (canonical typed)") {
|
||||||
t.Fatalf("historical representation rendering = %v\n%s", err, invalidInput.String())
|
t.Fatalf("historical representation rendering = %v\n%s", err, invalidInput.String())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -340,8 +347,8 @@ func TestExplanationReconcilesDefaultsAfterInputReplacement(t *testing.T) {
|
|||||||
if cli {
|
if cli {
|
||||||
opts.Overrides = []Override{{Path: Keys("m"), Value: map[string]any{"b": 2}, Flag: "--m"}}
|
opts.Overrides = []Override{{Path: Keys("m"), Value: map[string]any{"b": 2}, Flag: "--m"}}
|
||||||
} else {
|
} else {
|
||||||
writeImportFile(t, root, "profiles/p.yml", "m: {b: 2}\n")
|
writeImportFile(t, root, "overlays/p.yml", "m: {b: 2}\n")
|
||||||
opts.Profile = "p"
|
opts.Overlay = "p"
|
||||||
}
|
}
|
||||||
result, err := testLoad(File(main), opts)
|
result, err := testLoad(File(main), opts)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -514,3 +521,95 @@ func TestExplanationReplaysResolutionAdditionsAndOverlappingIntent(t *testing.T)
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestExplanationReplayDescriptorsRemainDetachedAcrossQueries(t *testing.T) {
|
||||||
|
type config struct {
|
||||||
|
Count int `yaml:"count"`
|
||||||
|
}
|
||||||
|
result, err := testLoad(Bytes("resolution-explanation.yml", []byte("count: 1\n")), Options[config]{
|
||||||
|
Definition: Definition[config]{Resolve: func(value *config, resolution *Resolution) error {
|
||||||
|
value.Count = 2
|
||||||
|
resolution.Record(Keys("count"), ChangeNormalization, "normalized", Keys("count"))
|
||||||
|
return nil
|
||||||
|
}},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
first, ok := result.Explain(Keys("count"))
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("missing explanation")
|
||||||
|
}
|
||||||
|
var firstResolution *ValueChange
|
||||||
|
for index := range first.History {
|
||||||
|
if first.History[index].Origin.Layer == LayerResolution {
|
||||||
|
firstResolution = &first.History[index]
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if firstResolution == nil || len(firstResolution.Reasons) != 1 || len(firstResolution.Dependencies) != 1 {
|
||||||
|
t.Fatalf("resolution history = %#v", first.History)
|
||||||
|
}
|
||||||
|
firstResolution.Reasons[0] = "mutated"
|
||||||
|
firstResolution.Dependencies[0].segments[0].key = "mutated"
|
||||||
|
|
||||||
|
second, ok := result.Explain(Keys("count"))
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("missing repeated explanation")
|
||||||
|
}
|
||||||
|
for _, change := range second.History {
|
||||||
|
if change.Origin.Layer == LayerResolution {
|
||||||
|
if !reflect.DeepEqual(change.Reasons, []string{"normalized"}) || len(change.Dependencies) != 1 || change.Dependencies[0].String() != "/count" {
|
||||||
|
t.Fatalf("repeated explanation observed caller mutation: %#v", change)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
t.Fatalf("resolution change missing from repeated explanation: %#v", second.History)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConcurrentReadOnlyInspectionQueries(t *testing.T) {
|
||||||
|
type config struct {
|
||||||
|
Group struct {
|
||||||
|
Value string `yaml:"value"`
|
||||||
|
} `yaml:"group"`
|
||||||
|
}
|
||||||
|
result, err := testLoad(Bytes("concurrent-inspection.yml", []byte("group: {value: input}\n")), Options[config]{
|
||||||
|
Definition: Definition[config]{Resolve: func(value *config, resolution *Resolution) error {
|
||||||
|
value.Group.Value = "resolved"
|
||||||
|
resolution.Record(Keys("group", "value"), ChangeNormalization, "normalized", Keys("group", "value"))
|
||||||
|
return nil
|
||||||
|
}},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
paths := []Path{Keys("group"), Keys("group", "value")}
|
||||||
|
var wait sync.WaitGroup
|
||||||
|
errors := make(chan string, 8)
|
||||||
|
for worker := 0; worker < cap(errors); worker++ {
|
||||||
|
wait.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer wait.Done()
|
||||||
|
for iteration := 0; iteration < 8; iteration++ {
|
||||||
|
for _, path := range paths {
|
||||||
|
explanation, found := result.Explain(path)
|
||||||
|
if !found || !explanation.Effective.Present {
|
||||||
|
errors <- "missing effective explanation for " + path.String()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
metadata := result.Metadata()
|
||||||
|
if _, found := metadata.Lookup(path); !found || len(metadata.History(path)) == 0 {
|
||||||
|
errors <- "missing metadata for " + path.String()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
wait.Wait()
|
||||||
|
close(errors)
|
||||||
|
for message := range errors {
|
||||||
|
t.Error(message)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,12 +1,21 @@
|
|||||||
package engine
|
package engine
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"io/fs"
|
||||||
"os"
|
"os"
|
||||||
|
"path"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
func validateFilesystemContext(source Source, context *FilesystemContext, main parsedSource) *Diagnostic {
|
func validateFilesystemContext(source Source, context *FilesystemContext, main parsedSource) *Diagnostic {
|
||||||
|
if nativeContext(source, context) {
|
||||||
|
access, basePath, mainPath, diagnostic := nativeFilesystemAccess(source, context)
|
||||||
|
if diagnostic != nil {
|
||||||
|
return diagnostic
|
||||||
|
}
|
||||||
|
return validateNativeDirectories(access, basePath, mainPath)
|
||||||
|
}
|
||||||
rootPath, _, _, diagnostic := importFilesystem(source, context, main)
|
rootPath, _, _, diagnostic := importFilesystem(source, context, main)
|
||||||
if diagnostic != nil {
|
if diagnostic != nil {
|
||||||
return diagnostic
|
return diagnostic
|
||||||
@@ -29,20 +38,87 @@ func filesystemOptionDiagnostics(source Source, context *FilesystemContext) []Di
|
|||||||
case sourceNone:
|
case sourceNone:
|
||||||
return []Diagnostic{optionDiagnostic(CodeOptionsInvalid, "NoSource cannot use filesystem context")}
|
return []Diagnostic{optionDiagnostic(CodeOptionsInvalid, "NoSource cannot use filesystem context")}
|
||||||
case sourceFile:
|
case sourceFile:
|
||||||
|
if context.FS != nil {
|
||||||
|
return []Diagnostic{optionDiagnostic(CodeOptionsInvalid, "host file sources cannot use a native filesystem context")}
|
||||||
|
}
|
||||||
if context.BaseDir != "" {
|
if context.BaseDir != "" {
|
||||||
return []Diagnostic{optionDiagnostic(CodeOptionsInvalid, "file sources determine their own import base directory")}
|
return []Diagnostic{optionDiagnostic(CodeOptionsInvalid, "file sources determine their own import base directory")}
|
||||||
}
|
}
|
||||||
case sourceBytes, sourceReader:
|
case sourceFilesystem:
|
||||||
|
if context.FS == nil || context.FS.namespace == nil || source.namespace == nil || context.FS.namespace.token != source.namespace.token {
|
||||||
|
return []Diagnostic{optionDiagnostic(CodeOptionsInvalid, "filesystem file context must use the source namespace")}
|
||||||
|
}
|
||||||
|
if context.BaseDir != "" {
|
||||||
|
return []Diagnostic{optionDiagnostic(CodeOptionsInvalid, "file sources determine their own import base directory")}
|
||||||
|
}
|
||||||
|
if context.Root != "" && !fs.ValidPath(context.Root) {
|
||||||
|
return []Diagnostic{optionDiagnostic(CodeOptionsInvalid, "filesystem root must be a slash-relative valid path")}
|
||||||
|
}
|
||||||
|
case sourceBytes, sourceReader, sourceMapping:
|
||||||
if context.BaseDir == "" || context.Root == "" {
|
if context.BaseDir == "" || context.Root == "" {
|
||||||
return []Diagnostic{optionDiagnostic(CodeOptionsInvalid, "byte and reader filesystem context requires base and root directories")}
|
return []Diagnostic{optionDiagnostic(CodeOptionsInvalid, "byte and reader filesystem context requires base and root directories")}
|
||||||
}
|
}
|
||||||
if !filepath.IsAbs(context.BaseDir) || !filepath.IsAbs(context.Root) {
|
if context.FS != nil {
|
||||||
|
if context.FS.namespace == nil || !fs.ValidPath(context.BaseDir) || !fs.ValidPath(context.Root) {
|
||||||
|
return []Diagnostic{optionDiagnostic(CodeOptionsInvalid, "filesystem base and root must be slash-relative valid paths")}
|
||||||
|
}
|
||||||
|
} else if !filepath.IsAbs(context.BaseDir) || !filepath.IsAbs(context.Root) {
|
||||||
return []Diagnostic{optionDiagnostic(CodeOptionsInvalid, "byte and reader filesystem base and root directories must be absolute")}
|
return []Diagnostic{optionDiagnostic(CodeOptionsInvalid, "byte and reader filesystem base and root directories must be absolute")}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func nativeContext(source Source, context *FilesystemContext) bool {
|
||||||
|
return source.kind == sourceFilesystem || context != nil && context.FS != nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// nativeFilesystemAccess resolves namespace context without opening caller
|
||||||
|
// resources. File inputs always derive their base from the selected file.
|
||||||
|
func nativeFilesystemAccess(source Source, context *FilesystemContext) (*filesystemAccess, string, string, *Diagnostic) {
|
||||||
|
var namespace *nativeNamespace
|
||||||
|
rootPath := "."
|
||||||
|
basePath := "."
|
||||||
|
mainPath := ""
|
||||||
|
if source.kind == sourceFilesystem {
|
||||||
|
namespace = source.namespace
|
||||||
|
mainPath = source.path
|
||||||
|
basePath = path.Dir(source.path)
|
||||||
|
if context != nil && context.Root != "" {
|
||||||
|
rootPath = context.Root
|
||||||
|
}
|
||||||
|
} else if context != nil && context.FS != nil {
|
||||||
|
namespace = context.FS.namespace
|
||||||
|
rootPath, basePath = context.Root, context.BaseDir
|
||||||
|
}
|
||||||
|
if namespace == nil || nilFilesystem(namespace.filesystem) || !fs.ValidPath(rootPath) || !fs.ValidPath(basePath) {
|
||||||
|
value := optionDiagnostic(CodeOptionsInvalid, "filesystem context is invalid")
|
||||||
|
return nil, "", "", &value
|
||||||
|
}
|
||||||
|
access := newNativeAccess(namespace.filesystem, rootPath, namespace.token)
|
||||||
|
access.label = namespace.label
|
||||||
|
if !access.contains(basePath) || mainPath != "" && !access.contains(mainPath) {
|
||||||
|
value := importDiagnostic(CodeImportOutsideRoot, "selected source and import base must stay inside the configuration root", nil)
|
||||||
|
return nil, "", "", &value
|
||||||
|
}
|
||||||
|
return access, basePath, mainPath, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateNativeDirectories(access *filesystemAccess, basePath, mainPath string) *Diagnostic {
|
||||||
|
if !access.contains(basePath) || mainPath != "" && !access.contains(mainPath) {
|
||||||
|
value := importDiagnostic(CodeImportOutsideRoot, "selected source and import base must stay inside the configuration root", nil)
|
||||||
|
return &value
|
||||||
|
}
|
||||||
|
for _, directory := range []string{access.rootPath, basePath} {
|
||||||
|
info, err := access.stat(directory)
|
||||||
|
if err != nil || !info.IsDir() {
|
||||||
|
value := importDiagnostic(CodeImportInvalid, "configuration root and import base must be directories", nil)
|
||||||
|
return &value
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
func importFilesystem(source Source, context *FilesystemContext, main parsedSource) (rootPath, basePath, mainPath string, diagnostic *Diagnostic) {
|
func importFilesystem(source Source, context *FilesystemContext, main parsedSource) (rootPath, basePath, mainPath string, diagnostic *Diagnostic) {
|
||||||
if main.source == nil || main.document == nil {
|
if main.source == nil || main.document == nil {
|
||||||
value := importDiagnostic(CodeImportInvalid, "imports require a selected configuration source", nil)
|
value := importDiagnostic(CodeImportInvalid, "imports require a selected configuration source", nil)
|
||||||
|
|||||||
185
internal/engine/filesystem_access.go
Normal file
185
internal/engine/filesystem_access.go
Normal file
@@ -0,0 +1,185 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"io/fs"
|
||||||
|
"os"
|
||||||
|
"path"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// namespaceToken identifies one caller-selected filesystem without comparing
|
||||||
|
// arbitrary fs.FS values. A token can be shared by copies of a source wrapper.
|
||||||
|
type namespaceToken struct{ marker byte }
|
||||||
|
|
||||||
|
type nativeNamespace struct {
|
||||||
|
filesystem fs.FS
|
||||||
|
label string
|
||||||
|
token *namespaceToken
|
||||||
|
}
|
||||||
|
|
||||||
|
func newNativeNamespace(label string, filesystem fs.FS) *nativeNamespace {
|
||||||
|
return &nativeNamespace{filesystem: filesystem, label: label, token: &namespaceToken{}}
|
||||||
|
}
|
||||||
|
|
||||||
|
type resourceIdentity struct {
|
||||||
|
namespace *namespaceToken
|
||||||
|
path string
|
||||||
|
occurrence *namespaceToken
|
||||||
|
}
|
||||||
|
|
||||||
|
// filesystemAccess is a load-scoped view of either a contained host root or a
|
||||||
|
// borrowed native filesystem. Names are canonical host paths or fs.FS paths.
|
||||||
|
type filesystemAccess struct {
|
||||||
|
rootPath string
|
||||||
|
root *os.Root
|
||||||
|
native fs.FS
|
||||||
|
token *namespaceToken
|
||||||
|
label string
|
||||||
|
}
|
||||||
|
|
||||||
|
func openHostAccess(rootPath string) (*filesystemAccess, error) {
|
||||||
|
root, err := os.OpenRoot(rootPath)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return &filesystemAccess{rootPath: rootPath, root: root, token: &namespaceToken{}}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func newNativeAccess(filesystem fs.FS, root string, token *namespaceToken) *filesystemAccess {
|
||||||
|
return &filesystemAccess{rootPath: root, native: filesystem, token: token}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *filesystemAccess) close() error {
|
||||||
|
if a.root != nil {
|
||||||
|
return a.root.Close()
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *filesystemAccess) identity(name string) resourceIdentity {
|
||||||
|
return resourceIdentity{namespace: a.token, path: name}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *filesystemAccess) syntheticIdentity() resourceIdentity {
|
||||||
|
return resourceIdentity{namespace: a.token, occurrence: &namespaceToken{}}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *filesystemAccess) join(base, name string) string {
|
||||||
|
if a.native != nil {
|
||||||
|
return path.Join(base, name)
|
||||||
|
}
|
||||||
|
return filepath.Join(base, filepath.FromSlash(path.Clean(name)))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *filesystemAccess) dir(name string) string {
|
||||||
|
if a.native != nil {
|
||||||
|
return path.Dir(name)
|
||||||
|
}
|
||||||
|
return filepath.Dir(name)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *filesystemAccess) contains(name string) bool {
|
||||||
|
if a.native == nil {
|
||||||
|
return containedPath(a.rootPath, filepath.Clean(name))
|
||||||
|
}
|
||||||
|
if !fs.ValidPath(name) || !fs.ValidPath(a.rootPath) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return a.rootPath == "." || name == a.rootPath || strings.HasPrefix(name, a.rootPath+"/")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *filesystemAccess) canonical(name string) (string, error) {
|
||||||
|
if a.native == nil {
|
||||||
|
return canonicalExistingPath(name)
|
||||||
|
}
|
||||||
|
if !fs.ValidPath(name) {
|
||||||
|
return "", fs.ErrInvalid
|
||||||
|
}
|
||||||
|
_, err := fs.Stat(a.native, name)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return name, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *filesystemAccess) relative(name string) (string, error) {
|
||||||
|
if a.native != nil {
|
||||||
|
if !a.contains(name) {
|
||||||
|
return "", fs.ErrInvalid
|
||||||
|
}
|
||||||
|
return name, nil
|
||||||
|
}
|
||||||
|
relative, err := filepath.Rel(a.rootPath, name)
|
||||||
|
if err != nil || filepath.IsAbs(relative) || relative == ".." || strings.HasPrefix(relative, ".."+string(filepath.Separator)) {
|
||||||
|
return "", fs.ErrInvalid
|
||||||
|
}
|
||||||
|
return relative, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *filesystemAccess) stat(name string) (fs.FileInfo, error) {
|
||||||
|
if a.native != nil {
|
||||||
|
return fs.Stat(a.native, name)
|
||||||
|
}
|
||||||
|
relative, err := a.relative(name)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return a.root.Stat(relative)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *filesystemAccess) open(name string) (fs.File, error) {
|
||||||
|
if a.native != nil {
|
||||||
|
return a.native.Open(name)
|
||||||
|
}
|
||||||
|
relative, err := a.relative(name)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return a.root.Open(relative)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *filesystemAccess) readDirectory(name string, visit func(fs.DirEntry) bool) error {
|
||||||
|
file, err := a.open(name)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if reader, ok := file.(fs.ReadDirFile); ok {
|
||||||
|
for {
|
||||||
|
entries, readErr := reader.ReadDir(globReadBatch)
|
||||||
|
for _, entry := range entries {
|
||||||
|
if !visit(entry) {
|
||||||
|
return file.Close()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if errors.Is(readErr, io.EOF) {
|
||||||
|
return file.Close()
|
||||||
|
}
|
||||||
|
if readErr != nil {
|
||||||
|
_ = file.Close()
|
||||||
|
return readErr
|
||||||
|
}
|
||||||
|
if len(entries) == 0 {
|
||||||
|
_ = file.Close()
|
||||||
|
return io.ErrNoProgress
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := file.Close(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
// fs.ReadDir provides the standard fallback for implementations whose opened
|
||||||
|
// files do not implement fs.ReadDirFile. It may allocate all entries itself.
|
||||||
|
entries, err := fs.ReadDir(a.native, name)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
for _, entry := range entries {
|
||||||
|
if !visit(entry) {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -2,11 +2,8 @@ package engine
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
"errors"
|
||||||
"io"
|
|
||||||
"io/fs"
|
"io/fs"
|
||||||
"os"
|
|
||||||
"path"
|
"path"
|
||||||
"path/filepath"
|
|
||||||
"slices"
|
"slices"
|
||||||
"strings"
|
"strings"
|
||||||
)
|
)
|
||||||
@@ -42,29 +39,29 @@ func (s *importTraversal) expandImportGlob(basePath string, declaration importDe
|
|||||||
names = []string{literal}
|
names = []string{literal}
|
||||||
}
|
}
|
||||||
for _, name := range names {
|
for _, name := range names {
|
||||||
absolute := filepath.Join(candidate.absolute, filepath.FromSlash(name))
|
absolute := s.access.join(candidate.absolute, name)
|
||||||
relative := path.Join(candidate.relative, name)
|
relative := path.Join(candidate.relative, name)
|
||||||
if !containedPath(s.rootPath, filepath.Clean(absolute)) {
|
if !s.access.contains(absolute) {
|
||||||
return nil, []Diagnostic{importDiagnostic(CodeImportOutsideRoot, "glob traversal is outside the configuration root", &location)}
|
return nil, []Diagnostic{importDiagnostic(CodeImportOutsideRoot, "glob traversal is outside the configuration root", &location)}
|
||||||
}
|
}
|
||||||
canonical, err := canonicalExistingPath(absolute)
|
canonical, err := s.access.canonical(absolute)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if errors.Is(err, fs.ErrNotExist) && !patterned {
|
if errors.Is(err, fs.ErrNotExist) && !patterned {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
return nil, []Diagnostic{globFilesystemDiagnostic(err, "glob match could not be canonicalized", location)}
|
return nil, []Diagnostic{globFilesystemDiagnostic(err, "glob match could not be canonicalized", location)}
|
||||||
}
|
}
|
||||||
if !containedPath(s.rootPath, canonical) {
|
if !s.access.contains(canonical) {
|
||||||
return nil, []Diagnostic{importDiagnostic(CodeImportOutsideRoot, "glob traversal resolves outside the configuration root", &location)}
|
return nil, []Diagnostic{importDiagnostic(CodeImportOutsideRoot, "glob traversal resolves outside the configuration root", &location)}
|
||||||
}
|
}
|
||||||
if last {
|
if last {
|
||||||
next = append(next, globCandidate{absolute: canonical, relative: relative})
|
next = append(next, globCandidate{absolute: canonical, relative: relative})
|
||||||
if len(s.sources)+len(next) > s.limits.sources {
|
if s.accounting.sources+len(next) > s.limits.sources {
|
||||||
return nil, []Diagnostic{importDiagnostic(CodeImportLimitExceeded, "glob matches exceed the remaining source-count limit", &location)}
|
return nil, []Diagnostic{importDiagnostic(CodeImportLimitExceeded, "glob matches exceed the remaining source-count limit", &location)}
|
||||||
}
|
}
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
info, err := os.Stat(canonical)
|
info, err := s.access.stat(canonical)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, []Diagnostic{globFilesystemDiagnostic(err, "glob traversal target could not be inspected", location)}
|
return nil, []Diagnostic{globFilesystemDiagnostic(err, "glob traversal target could not be inspected", location)}
|
||||||
}
|
}
|
||||||
@@ -88,56 +85,47 @@ func (s *importTraversal) expandImportGlob(basePath string, declaration importDe
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (s *importTraversal) readGlobMatches(directory, pattern string, location Location) ([]string, []Diagnostic) {
|
func (s *importTraversal) readGlobMatches(directory, pattern string, location Location) ([]string, []Diagnostic) {
|
||||||
canonical, err := canonicalExistingPath(directory)
|
canonical, err := s.access.canonical(directory)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if errors.Is(err, fs.ErrNotExist) {
|
if errors.Is(err, fs.ErrNotExist) {
|
||||||
return nil, nil
|
return nil, nil
|
||||||
}
|
}
|
||||||
return nil, []Diagnostic{globFilesystemDiagnostic(err, "glob directory could not be canonicalized", location)}
|
return nil, []Diagnostic{globFilesystemDiagnostic(err, "glob directory could not be canonicalized", location)}
|
||||||
}
|
}
|
||||||
if !containedPath(s.rootPath, canonical) {
|
if !s.access.contains(canonical) {
|
||||||
return nil, []Diagnostic{importDiagnostic(CodeImportOutsideRoot, "glob directory resolves outside the configuration root", &location)}
|
return nil, []Diagnostic{importDiagnostic(CodeImportOutsideRoot, "glob directory resolves outside the configuration root", &location)}
|
||||||
}
|
}
|
||||||
relative, err := filepath.Rel(s.rootPath, canonical)
|
if _, err := s.access.relative(canonical); err != nil {
|
||||||
if err != nil || filepath.IsAbs(relative) || relative == ".." || strings.HasPrefix(relative, ".."+string(filepath.Separator)) {
|
|
||||||
return nil, []Diagnostic{importDiagnostic(CodeImportOutsideRoot, "glob directory could not be addressed inside the configuration root", &location)}
|
return nil, []Diagnostic{importDiagnostic(CodeImportOutsideRoot, "glob directory could not be addressed inside the configuration root", &location)}
|
||||||
}
|
}
|
||||||
directoryFile, err := s.root.Open(relative)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, fs.ErrNotExist) {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
return nil, []Diagnostic{globFilesystemDiagnostic(err, "glob directory could not be opened", location)}
|
|
||||||
}
|
|
||||||
|
|
||||||
var matches []string
|
var matches []string
|
||||||
for {
|
var problem *Diagnostic
|
||||||
entries, readErr := directoryFile.ReadDir(globReadBatch)
|
err = s.access.readDirectory(canonical, func(entry fs.DirEntry) bool {
|
||||||
for _, entry := range entries {
|
s.accounting.entries++
|
||||||
s.usedEntries++
|
if s.accounting.entries > s.limits.entries {
|
||||||
if s.usedEntries > s.limits.entries {
|
value := importDiagnostic(CodeImportLimitExceeded, "glob traversal exceeds the directory-entry visit limit", &location)
|
||||||
_ = directoryFile.Close()
|
problem = &value
|
||||||
return nil, []Diagnostic{importDiagnostic(CodeImportLimitExceeded, "glob traversal exceeds the directory-entry visit limit", &location)}
|
return false
|
||||||
}
|
|
||||||
matched, matchErr := path.Match(pattern, entry.Name())
|
|
||||||
if matchErr != nil {
|
|
||||||
_ = directoryFile.Close()
|
|
||||||
return nil, []Diagnostic{importDiagnostic(CodeImportInvalid, "import glob pattern is invalid", &location)}
|
|
||||||
}
|
|
||||||
if matched {
|
|
||||||
matches = append(matches, entry.Name())
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
if errors.Is(readErr, io.EOF) {
|
matched, matchErr := path.Match(pattern, entry.Name())
|
||||||
break
|
if matchErr != nil {
|
||||||
|
value := importDiagnostic(CodeImportInvalid, "import glob pattern is invalid", &location)
|
||||||
|
problem = &value
|
||||||
|
return false
|
||||||
}
|
}
|
||||||
if readErr != nil {
|
if matched {
|
||||||
_ = directoryFile.Close()
|
matches = append(matches, entry.Name())
|
||||||
return nil, []Diagnostic{globFilesystemDiagnostic(readErr, "glob directory could not be read", location)}
|
|
||||||
}
|
}
|
||||||
|
return true
|
||||||
|
})
|
||||||
|
if problem != nil {
|
||||||
|
return nil, []Diagnostic{*problem}
|
||||||
}
|
}
|
||||||
if err := directoryFile.Close(); err != nil {
|
if errors.Is(err, fs.ErrNotExist) {
|
||||||
return nil, []Diagnostic{globFilesystemDiagnostic(err, "glob directory could not be closed", location)}
|
return nil, nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, []Diagnostic{globFilesystemDiagnostic(err, "glob directory could not be traversed", location)}
|
||||||
}
|
}
|
||||||
slices.Sort(matches)
|
slices.Sort(matches)
|
||||||
return matches, nil
|
return matches, nil
|
||||||
|
|||||||
@@ -229,11 +229,11 @@ func TestGlobTraversalBoundsNonmatchesAndAcceptedCandidates(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFilesystemContextIsValidatedWithoutImportsOrActiveProfile(t *testing.T) {
|
func TestFilesystemContextIsValidatedWithoutImportsOrActiveOverlay(t *testing.T) {
|
||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
mainPath := writeImportFile(t, directory, "main.yml", "items: {root: root}\n")
|
mainPath := writeImportFile(t, directory, "main.yml", "items: {root: root}\n")
|
||||||
result, err := testLoad[importTestConfig](File(mainPath), Options[importTestConfig]{
|
result, err := testLoad[importTestConfig](File(mainPath), Options[importTestConfig]{
|
||||||
Profile: "default", Filesystem: &FilesystemContext{Root: directory},
|
Overlay: "default", Filesystem: &FilesystemContext{Root: directory},
|
||||||
})
|
})
|
||||||
if err != nil || result.Config.Items["root"] != "root" {
|
if err != nil || result.Config.Items["root"] != "root" {
|
||||||
t.Fatalf("file filesystem context = %#v, %v", result, err)
|
t.Fatalf("file filesystem context = %#v, %v", result, err)
|
||||||
@@ -247,9 +247,9 @@ func TestFilesystemContextIsValidatedWithoutImportsOrActiveProfile(t *testing.T)
|
|||||||
t.Fatalf("byte filesystem context = %#v, %v", result, err)
|
t.Fatalf("byte filesystem context = %#v, %v", result, err)
|
||||||
}
|
}
|
||||||
requireLoadCode(t, Bytes("memory.yml", []byte("{}\n")), Options[importTestConfig]{Filesystem: &FilesystemContext{BaseDir: directory}}, CodeOptionsInvalid)
|
requireLoadCode(t, Bytes("memory.yml", []byte("{}\n")), Options[importTestConfig]{Filesystem: &FilesystemContext{BaseDir: directory}}, CodeOptionsInvalid)
|
||||||
defaultsOnly, err := testLoad[importTestConfig](NoSource(), Options[importTestConfig]{Profile: "default"})
|
defaultsOnly, err := testLoad[importTestConfig](NoSource(), Options[importTestConfig]{Overlay: "default"})
|
||||||
if err != nil || defaultsOnly == nil {
|
if err != nil || defaultsOnly == nil {
|
||||||
t.Fatalf("default profile with NoSource = %#v, %v", defaultsOnly, err)
|
t.Fatalf("default overlay with NoSource = %#v, %v", defaultsOnly, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if runtime.GOOS == "linux" || runtime.GOOS == "darwin" {
|
if runtime.GOOS == "linux" || runtime.GOOS == "darwin" {
|
||||||
|
|||||||
@@ -6,6 +6,40 @@ import (
|
|||||||
|
|
||||||
const historyNodeLimit = 4_000_000
|
const historyNodeLimit = 4_000_000
|
||||||
|
|
||||||
|
type retainedNodeCounter struct {
|
||||||
|
seen map[*document.Node]bool
|
||||||
|
count int
|
||||||
|
limit int
|
||||||
|
}
|
||||||
|
|
||||||
|
func newRetainedNodeCounter(limit int) *retainedNodeCounter {
|
||||||
|
return &retainedNodeCounter{seen: make(map[*document.Node]bool), limit: limit}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *retainedNodeCounter) add(root *document.Node) bool {
|
||||||
|
if c == nil {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
stack := []*document.Node{root}
|
||||||
|
for len(stack) != 0 {
|
||||||
|
node := stack[len(stack)-1]
|
||||||
|
stack = stack[:len(stack)-1]
|
||||||
|
if node == nil || c.seen[node] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
c.seen[node] = true
|
||||||
|
c.count++
|
||||||
|
if c.limit >= 0 && c.count > c.limit {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
for _, entry := range node.Mapping {
|
||||||
|
stack = append(stack, entry.Value)
|
||||||
|
}
|
||||||
|
stack = append(stack, node.Sequence...)
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
// History applications borrow immutable policy-validated input trees. Metadata
|
// History applications borrow immutable policy-validated input trees. Metadata
|
||||||
// records answer presence and origin queries; replay reconstructs value changes.
|
// records answer presence and origin queries; replay reconstructs value changes.
|
||||||
// Replay reconciles with canonical decoding before domain resolution so both
|
// Replay reconciles with canonical decoding before domain resolution so both
|
||||||
@@ -31,7 +65,7 @@ func cloneHistoryApplications(values []historyApplication) []historyApplication
|
|||||||
return cloned
|
return cloned
|
||||||
}
|
}
|
||||||
|
|
||||||
func applicationOperationPath(application historyApplication, query Path) (Path, bool) {
|
func applicationOperationPath(application historyApplication, query Path, lookup *documentLookup) (Path, bool) {
|
||||||
if !application.path.valid() || application.value == nil {
|
if !application.path.valid() || application.value == nil {
|
||||||
return Path{}, false
|
return Path{}, false
|
||||||
}
|
}
|
||||||
@@ -46,7 +80,7 @@ func applicationOperationPath(application historyApplication, query Path) (Path,
|
|||||||
}
|
}
|
||||||
for length := 1; length <= len(query.segments); length++ {
|
for length := 1; length <= len(query.segments); length++ {
|
||||||
prefix := Path{segments: clonePathSegments(query.segments[:length], 0)}
|
prefix := Path{segments: clonePathSegments(query.segments[:length], 0)}
|
||||||
node, present := documentAtPath(application.value, prefix)
|
node, present := documentAtPathWithLookup(application.value, prefix, lookup)
|
||||||
if !present {
|
if !present {
|
||||||
return Path{}, false
|
return Path{}, false
|
||||||
}
|
}
|
||||||
@@ -57,7 +91,7 @@ func applicationOperationPath(application historyApplication, query Path) (Path,
|
|||||||
return Path{}, false
|
return Path{}, false
|
||||||
}
|
}
|
||||||
|
|
||||||
func historyApplicationOrigin(application historyApplication, operationPath Path) Origin {
|
func historyApplicationOrigin(application historyApplication, operationPath Path, lookup *documentLookup) Origin {
|
||||||
if application.origin.Layer != "" {
|
if application.origin.Layer != "" {
|
||||||
return cloneOrigin(application.origin)
|
return cloneOrigin(application.origin)
|
||||||
}
|
}
|
||||||
@@ -66,7 +100,7 @@ func historyApplicationOrigin(application historyApplication, operationPath Path
|
|||||||
if !ok {
|
if !ok {
|
||||||
return origin
|
return origin
|
||||||
}
|
}
|
||||||
if node, present := documentAtPath(application.value, relative); present {
|
if node, present := documentAtPathWithLookup(application.value, relative, lookup); present {
|
||||||
origin.Locations = []Location{publicLocation(node.Location)}
|
origin.Locations = []Location{publicLocation(node.Location)}
|
||||||
}
|
}
|
||||||
return origin
|
return origin
|
||||||
@@ -83,15 +117,15 @@ func pathsIntersect(left, right Path) bool {
|
|||||||
return pathContains(left, right) || pathContains(right, left)
|
return pathContains(left, right) || pathContains(right, left)
|
||||||
}
|
}
|
||||||
|
|
||||||
func applyHistoryApplication(root **document.Node, application historyApplication) {
|
func applyHistoryApplication(root **document.Node, application historyApplication, index *mappingIndex) {
|
||||||
if application.path.String() == "" {
|
if application.path.String() == "" {
|
||||||
mergeHistoryDocument(root, application.value)
|
mergeHistoryDocument(root, application.value, index)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
mergeHistoryAtPath(root, application.path, application.value)
|
mergeHistoryAtPath(root, application.path, application.value, index)
|
||||||
}
|
}
|
||||||
|
|
||||||
func mergeHistoryDocument(target **document.Node, incoming *document.Node) {
|
func mergeHistoryDocument(target **document.Node, incoming *document.Node, index *mappingIndex) {
|
||||||
if incoming == nil {
|
if incoming == nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -100,39 +134,39 @@ func mergeHistoryDocument(target **document.Node, incoming *document.Node) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
for _, entry := range incoming.Mapping {
|
for _, entry := range incoming.Mapping {
|
||||||
position := documentEntryIndex((*target).Mapping, entry.Key)
|
position := index.find(*target, entry.Key)
|
||||||
if position < 0 {
|
if position < 0 {
|
||||||
cloned := entry
|
cloned := entry
|
||||||
cloned.Value = document.Clone(entry.Value)
|
cloned.Value = document.Clone(entry.Value)
|
||||||
(*target).Mapping = append((*target).Mapping, cloned)
|
index.append(*target, cloned)
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
mergeHistoryDocument(&(*target).Mapping[position].Value, entry.Value)
|
mergeHistoryDocument(&(*target).Mapping[position].Value, entry.Value, index)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func mergeHistoryAtPath(root **document.Node, path Path, incoming *document.Node) {
|
func mergeHistoryAtPath(root **document.Node, path Path, incoming *document.Node, index *mappingIndex) {
|
||||||
if root == nil || *root == nil || len(path.segments) == 0 {
|
if root == nil || *root == nil || len(path.segments) == 0 {
|
||||||
mergeHistoryDocument(root, incoming)
|
mergeHistoryDocument(root, incoming, index)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
current := *root
|
current := *root
|
||||||
for index, segment := range path.segments {
|
for segmentIndex, segment := range path.segments {
|
||||||
if current.Kind != document.Mapping || segment.kind == pathSegmentIndex {
|
if current.Kind != document.Mapping || segment.kind == pathSegmentIndex {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
position := documentEntryIndex(current.Mapping, segment.key)
|
position := index.find(current, segment.key)
|
||||||
if index == len(path.segments)-1 {
|
if segmentIndex == len(path.segments)-1 {
|
||||||
if position < 0 {
|
if position < 0 {
|
||||||
current.Mapping = append(current.Mapping, document.Entry{Key: segment.key, Value: document.Clone(incoming)})
|
index.append(current, document.Entry{Key: segment.key, Value: document.Clone(incoming)})
|
||||||
} else {
|
} else {
|
||||||
mergeHistoryDocument(¤t.Mapping[position].Value, incoming)
|
mergeHistoryDocument(¤t.Mapping[position].Value, incoming, index)
|
||||||
}
|
}
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if position < 0 {
|
if position < 0 {
|
||||||
child := &document.Node{Kind: document.Mapping}
|
child := &document.Node{Kind: document.Mapping}
|
||||||
current.Mapping = append(current.Mapping, document.Entry{Key: segment.key, Value: child})
|
index.append(current, document.Entry{Key: segment.key, Value: child})
|
||||||
current = child
|
current = child
|
||||||
} else {
|
} else {
|
||||||
current = current.Mapping[position].Value
|
current = current.Mapping[position].Value
|
||||||
@@ -145,28 +179,50 @@ func mergeHistoryAtPath(root **document.Node, path Path, incoming *document.Node
|
|||||||
// intent into that event rather than replay a child assignment a second time.
|
// intent into that event rather than replay a child assignment a second time.
|
||||||
func coalescedResolutionSnapshots(snapshots []resolutionSnapshot) []resolutionSnapshot {
|
func coalescedResolutionSnapshots(snapshots []resolutionSnapshot) []resolutionSnapshot {
|
||||||
groups := make([]resolutionSnapshot, 0, len(snapshots))
|
groups := make([]resolutionSnapshot, 0, len(snapshots))
|
||||||
|
reasons := make([]map[string]struct{}, 0, len(snapshots))
|
||||||
|
dependencies := make([]map[string]struct{}, 0, len(snapshots))
|
||||||
|
var coverage pathPrefixIndex
|
||||||
for _, snapshot := range snapshots {
|
for _, snapshot := range snapshots {
|
||||||
merged := false
|
pointer := snapshot.change.Path.String()
|
||||||
for i := range groups {
|
groupIndex := -1
|
||||||
if !pathContains(groups[i].change.Path, snapshot.change.Path) {
|
coverage.visitAncestors(pointer, func(id int) {
|
||||||
continue
|
if groupIndex < 0 || id < groupIndex {
|
||||||
|
groupIndex = id
|
||||||
}
|
}
|
||||||
|
})
|
||||||
|
if groupIndex >= 0 {
|
||||||
|
group := &groups[groupIndex]
|
||||||
for _, reason := range snapshot.change.Reasons {
|
for _, reason := range snapshot.change.Reasons {
|
||||||
groups[i].change.Reasons = appendUniqueString(groups[i].change.Reasons, reason)
|
if _, found := reasons[groupIndex][reason]; !found {
|
||||||
|
reasons[groupIndex][reason] = struct{}{}
|
||||||
|
group.change.Reasons = append(group.change.Reasons, reason)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
for _, dependency := range snapshot.change.Dependencies {
|
for _, dependency := range snapshot.change.Dependencies {
|
||||||
groups[i].change.Dependencies = appendUniquePath(groups[i].change.Dependencies, dependency)
|
dependencyPointer := dependency.String()
|
||||||
|
if _, found := dependencies[groupIndex][dependencyPointer]; !found {
|
||||||
|
dependencies[groupIndex][dependencyPointer] = struct{}{}
|
||||||
|
group.change.Dependencies = append(group.change.Dependencies, dependency.clone())
|
||||||
|
}
|
||||||
}
|
}
|
||||||
if snapshot.change.Origin.Operation == ChangeNormalization {
|
if snapshot.change.Origin.Operation == ChangeNormalization {
|
||||||
groups[i].change.Origin.Operation = ChangeNormalization
|
group.change.Origin.Operation = ChangeNormalization
|
||||||
}
|
}
|
||||||
merged = true
|
continue
|
||||||
break
|
|
||||||
}
|
}
|
||||||
if !merged {
|
snapshot.change = cloneChange(snapshot.change)
|
||||||
snapshot.change = cloneChange(snapshot.change)
|
groups = append(groups, snapshot)
|
||||||
groups = append(groups, snapshot)
|
reasonSet := make(map[string]struct{}, len(snapshot.change.Reasons))
|
||||||
|
for _, reason := range snapshot.change.Reasons {
|
||||||
|
reasonSet[reason] = struct{}{}
|
||||||
}
|
}
|
||||||
|
reasons = append(reasons, reasonSet)
|
||||||
|
dependencySet := make(map[string]struct{}, len(snapshot.change.Dependencies))
|
||||||
|
for _, dependency := range snapshot.change.Dependencies {
|
||||||
|
dependencySet[dependency.String()] = struct{}{}
|
||||||
|
}
|
||||||
|
dependencies = append(dependencies, dependencySet)
|
||||||
|
coverage.insert(pointer, len(groups)-1)
|
||||||
}
|
}
|
||||||
return groups
|
return groups
|
||||||
}
|
}
|
||||||
@@ -230,11 +286,11 @@ func replaceHistoryPath(root **document.Node, path Path, replacement *document.N
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func historyNodesWithinLimit(baseline, input, final *document.Node, applications []historyApplication, resolutions []resolutionSnapshot) bool {
|
func historyNodesWithinLimit(baseline, input, final *document.Node, applications []historyApplication, resolutions []resolutionSnapshot, inherited ...*inheritanceScope) bool {
|
||||||
return historyNodesWithin(historyNodeLimit, baseline, input, final, applications, resolutions)
|
return historyNodesWithin(historyNodeLimit, baseline, input, final, applications, resolutions, inherited...)
|
||||||
}
|
}
|
||||||
|
|
||||||
func historyNodesWithin(limit int, baseline, input, final *document.Node, applications []historyApplication, resolutions []resolutionSnapshot) bool {
|
func historyNodesWithin(limit int, baseline, input, final *document.Node, applications []historyApplication, resolutions []resolutionSnapshot, inherited ...*inheritanceScope) bool {
|
||||||
seen := make(map[*document.Node]bool)
|
seen := make(map[*document.Node]bool)
|
||||||
count := 0
|
count := 0
|
||||||
var visit func(*document.Node) bool
|
var visit func(*document.Node) bool
|
||||||
@@ -272,5 +328,23 @@ func historyNodesWithin(limit int, baseline, input, final *document.Node, applic
|
|||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
for _, expansion := range inherited {
|
||||||
|
if expansion == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if !visit(expansion.root) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
for _, operation := range expansion.operations {
|
||||||
|
if !visit(operation.parent) || !visit(operation.effective) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, replacement := range expansion.replacements {
|
||||||
|
if !visit(replacement.before) || !visit(replacement.after) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,9 +4,6 @@ import (
|
|||||||
"bytes"
|
"bytes"
|
||||||
"errors"
|
"errors"
|
||||||
"io/fs"
|
"io/fs"
|
||||||
"os"
|
|
||||||
"path"
|
|
||||||
"path/filepath"
|
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
@@ -40,47 +37,96 @@ type importRoute struct {
|
|||||||
locations []Location
|
locations []Location
|
||||||
}
|
}
|
||||||
|
|
||||||
type importTraversal struct {
|
type importAccounting struct {
|
||||||
rootPath string
|
sources int
|
||||||
root *os.Root
|
bytes int64
|
||||||
limits importLimits
|
nodes int
|
||||||
rule *VersionRule
|
entries int
|
||||||
|
}
|
||||||
|
|
||||||
documents []*document.Node
|
type importTraversal struct {
|
||||||
sources []SourceInfo
|
access *filesystemAccess
|
||||||
active map[string]int
|
accounting *importAccounting
|
||||||
visited map[string]importRoute
|
limits importLimits
|
||||||
stack []importRoute
|
rule *VersionRule
|
||||||
usedBytes int64
|
|
||||||
usedNodes int
|
documents []*document.Node
|
||||||
usedEntries int
|
sources []SourceInfo
|
||||||
|
active map[resourceIdentity]int
|
||||||
|
visited map[resourceIdentity]importRoute
|
||||||
|
stack []importRoute
|
||||||
}
|
}
|
||||||
|
|
||||||
func loadImportedDocuments(source Source, context *FilesystemContext, main parsedSource, rule *VersionRule, limits importLimits) (*composedDocument, []SourceInfo, []Diagnostic) {
|
func loadImportedDocuments(source Source, context *FilesystemContext, main parsedSource, rule *VersionRule, limits importLimits) (*composedDocument, []SourceInfo, []Diagnostic) {
|
||||||
|
return loadImportedDocumentsTracked(source, context, main, rule, limits, &importAccounting{}, nil, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
func loadImportedDocumentsTracked(source Source, context *FilesystemContext, main parsedSource, rule *VersionRule, limits importLimits, accounting *importAccounting, visited map[resourceIdentity]importRoute, hostToken *namespaceToken) (*composedDocument, []SourceInfo, []Diagnostic) {
|
||||||
|
if nativeContext(source, context) {
|
||||||
|
access, basePath, mainPath, diagnostic := nativeFilesystemAccess(source, context)
|
||||||
|
if diagnostic != nil {
|
||||||
|
return nil, sourceInfos(main.source), []Diagnostic{*diagnostic}
|
||||||
|
}
|
||||||
|
return loadImportedWithAccessTracked(access, basePath, mainPath, main, rule, limits, accounting, visited)
|
||||||
|
}
|
||||||
rootPath, basePath, mainPath, diagnostic := importFilesystem(source, context, main)
|
rootPath, basePath, mainPath, diagnostic := importFilesystem(source, context, main)
|
||||||
if diagnostic != nil {
|
if diagnostic != nil {
|
||||||
return nil, sourceInfos(main.source), []Diagnostic{*diagnostic}
|
return nil, sourceInfos(main.source), []Diagnostic{*diagnostic}
|
||||||
}
|
}
|
||||||
root, err := os.OpenRoot(rootPath)
|
access, err := openHostAccess(rootPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
diagnostic := globFilesystemDiagnostic(err, "configuration root could not be opened", Location{})
|
diagnostic := globFilesystemDiagnostic(err, "configuration root could not be opened", Location{})
|
||||||
diagnostic.Primary = nil
|
diagnostic.Primary = nil
|
||||||
return nil, sourceInfos(main.source), []Diagnostic{diagnostic}
|
return nil, sourceInfos(main.source), []Diagnostic{diagnostic}
|
||||||
}
|
}
|
||||||
|
if hostToken != nil {
|
||||||
|
access.token = hostToken
|
||||||
|
}
|
||||||
|
return loadImportedWithAccessTracked(access, basePath, mainPath, main, rule, limits, accounting, visited)
|
||||||
|
}
|
||||||
|
|
||||||
|
func loadImportedWithAccess(access *filesystemAccess, basePath, mainPath string, main parsedSource, rule *VersionRule, limits importLimits, accounting *importAccounting) (*composedDocument, []SourceInfo, []Diagnostic) {
|
||||||
|
return loadImportedWithAccessTracked(access, basePath, mainPath, main, rule, limits, accounting, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
func loadImportedWithAccessTracked(access *filesystemAccess, basePath, mainPath string, main parsedSource, rule *VersionRule, limits importLimits, accounting *importAccounting, visited map[resourceIdentity]importRoute) (*composedDocument, []SourceInfo, []Diagnostic) {
|
||||||
|
if !access.contains(basePath) || (mainPath != "" && !access.contains(mainPath)) {
|
||||||
|
_ = access.close()
|
||||||
|
return nil, sourceInfos(main.source), []Diagnostic{importDiagnostic(CodeImportOutsideRoot, "selected source and import base must stay inside the configuration root", nil)}
|
||||||
|
}
|
||||||
|
for _, directory := range []string{access.rootPath, basePath} {
|
||||||
|
info, err := access.stat(directory)
|
||||||
|
if err != nil || !info.IsDir() {
|
||||||
|
_ = access.close()
|
||||||
|
return nil, sourceInfos(main.source), []Diagnostic{importDiagnostic(CodeImportInvalid, "configuration root and import base must be directories", nil)}
|
||||||
|
}
|
||||||
|
}
|
||||||
mainInfo := cloneSourceInfo(*main.source)
|
mainInfo := cloneSourceInfo(*main.source)
|
||||||
if mainPath != "" {
|
if mainPath != "" {
|
||||||
mainInfo.Path = mainPath
|
mainInfo.Path = mainPath
|
||||||
}
|
}
|
||||||
|
mainKey := access.identity(mainPath)
|
||||||
|
if mainPath == "" {
|
||||||
|
mainKey = access.syntheticIdentity()
|
||||||
|
}
|
||||||
|
if previous, repeated := visited[mainKey]; repeated {
|
||||||
|
_ = access.close()
|
||||||
|
return nil, sourceInfos(main.source), []Diagnostic{importRepeatedDiagnostic(Location{SourceID: main.source.ID}, previous, importRoute{})}
|
||||||
|
}
|
||||||
|
accounting.sources++
|
||||||
|
accounting.bytes += main.bytes
|
||||||
|
accounting.nodes += countInputNodes(main.document)
|
||||||
state := importTraversal{
|
state := importTraversal{
|
||||||
rootPath: rootPath, root: root, limits: limits, rule: rule,
|
access: access, accounting: accounting, limits: limits, rule: rule,
|
||||||
documents: make([]*document.Node, 0, 1),
|
documents: make([]*document.Node, 0, 1),
|
||||||
sources: []SourceInfo{mainInfo},
|
sources: []SourceInfo{mainInfo},
|
||||||
active: make(map[string]int), visited: make(map[string]importRoute),
|
active: make(map[resourceIdentity]int), visited: visited,
|
||||||
usedBytes: main.bytes, usedNodes: countInputNodes(main.document),
|
}
|
||||||
|
if state.visited == nil {
|
||||||
|
state.visited = make(map[resourceIdentity]importRoute)
|
||||||
}
|
}
|
||||||
if diagnostic := state.checkInitialLimits(); diagnostic != nil {
|
if diagnostic := state.checkInitialLimits(); diagnostic != nil {
|
||||||
_ = root.Close()
|
_ = access.close()
|
||||||
return nil, cloneSourceInfos(state.sources), []Diagnostic{*diagnostic}
|
return nil, cloneSourceInfos(state.sources), []Diagnostic{*diagnostic}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -89,8 +135,8 @@ func loadImportedDocuments(source Source, context *FilesystemContext, main parse
|
|||||||
mainIdentity = "<selected-source>"
|
mainIdentity = "<selected-source>"
|
||||||
}
|
}
|
||||||
mainRoute := importRoute{canonical: mainIdentity}
|
mainRoute := importRoute{canonical: mainIdentity}
|
||||||
state.active[mainIdentity] = 0
|
state.active[mainKey] = 0
|
||||||
state.visited[mainIdentity] = mainRoute
|
state.visited[mainKey] = mainRoute
|
||||||
state.stack = append(state.stack, mainRoute)
|
state.stack = append(state.stack, mainRoute)
|
||||||
body, declarations, diagnostics := splitImportDirectives(main.document)
|
body, declarations, diagnostics := splitImportDirectives(main.document)
|
||||||
if len(diagnostics) == 0 {
|
if len(diagnostics) == 0 {
|
||||||
@@ -98,7 +144,7 @@ func loadImportedDocuments(source Source, context *FilesystemContext, main parse
|
|||||||
diagnostics = state.walkDeclarations(basePath, declarations, 0)
|
diagnostics = state.walkDeclarations(basePath, declarations, 0)
|
||||||
}
|
}
|
||||||
|
|
||||||
closeErr := root.Close()
|
closeErr := access.close()
|
||||||
if len(diagnostics) != 0 {
|
if len(diagnostics) != 0 {
|
||||||
return nil, cloneSourceInfos(state.sources), diagnostics
|
return nil, cloneSourceInfos(state.sources), diagnostics
|
||||||
}
|
}
|
||||||
@@ -107,22 +153,22 @@ func loadImportedDocuments(source Source, context *FilesystemContext, main parse
|
|||||||
}
|
}
|
||||||
composed, diagnostics := composeDocuments(state.documents...)
|
composed, diagnostics := composeDocuments(state.documents...)
|
||||||
if composed != nil {
|
if composed != nil {
|
||||||
composed.inputBytes = state.usedBytes
|
composed.inputBytes = accounting.bytes
|
||||||
composed.inputNodes = state.usedNodes
|
composed.inputNodes = accounting.nodes
|
||||||
}
|
}
|
||||||
return composed, cloneSourceInfos(state.sources), diagnostics
|
return composed, cloneSourceInfos(state.sources), diagnostics
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *importTraversal) checkInitialLimits() *Diagnostic {
|
func (s *importTraversal) checkInitialLimits() *Diagnostic {
|
||||||
if s.limits.sources < 1 {
|
if s.accounting.sources > s.limits.sources {
|
||||||
value := importDiagnostic(CodeImportLimitExceeded, "configuration exceeds the source-count limit", nil)
|
value := importDiagnostic(CodeImportLimitExceeded, "configuration exceeds the source-count limit", nil)
|
||||||
return &value
|
return &value
|
||||||
}
|
}
|
||||||
if s.usedBytes > s.limits.bytes {
|
if s.accounting.bytes > s.limits.bytes {
|
||||||
value := importDiagnostic(CodeImportLimitExceeded, "configuration exceeds the aggregate byte limit", nil)
|
value := importDiagnostic(CodeImportLimitExceeded, "configuration exceeds the aggregate byte limit", nil)
|
||||||
return &value
|
return &value
|
||||||
}
|
}
|
||||||
if s.usedNodes > s.limits.nodes {
|
if s.accounting.nodes > s.limits.nodes {
|
||||||
value := importDiagnostic(CodeImportLimitExceeded, "configuration exceeds the aggregate node limit", nil)
|
value := importDiagnostic(CodeImportLimitExceeded, "configuration exceeds the aggregate node limit", nil)
|
||||||
return &value
|
return &value
|
||||||
}
|
}
|
||||||
@@ -169,11 +215,11 @@ func (s *importTraversal) visitPath(basePath string, declaration importDeclarati
|
|||||||
return []Diagnostic{importDiagnostic(CodeImportInvalid, "import path must be a nonempty slash-relative path without a network scheme", &location)}
|
return []Diagnostic{importDiagnostic(CodeImportInvalid, "import path must be a nonempty slash-relative path without a network scheme", &location)}
|
||||||
}
|
}
|
||||||
|
|
||||||
candidate := filepath.Join(basePath, filepath.FromSlash(path.Clean(declaration.path)))
|
candidate := s.access.join(basePath, declaration.path)
|
||||||
if !containedPath(s.rootPath, filepath.Clean(candidate)) {
|
if !s.access.contains(candidate) {
|
||||||
return []Diagnostic{importDiagnostic(CodeImportOutsideRoot, "import target is outside the configuration root", &location)}
|
return []Diagnostic{importDiagnostic(CodeImportOutsideRoot, "import target is outside the configuration root", &location)}
|
||||||
}
|
}
|
||||||
canonical, err := canonicalExistingPath(candidate)
|
canonical, err := s.access.canonical(candidate)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if declaration.optional && errors.Is(err, fs.ErrNotExist) {
|
if declaration.optional && errors.Is(err, fs.ErrNotExist) {
|
||||||
return nil
|
return nil
|
||||||
@@ -187,30 +233,39 @@ func (s *importTraversal) visitPath(basePath string, declaration importDeclarati
|
|||||||
}
|
}
|
||||||
return []Diagnostic{importDiagnostic(code, message, &location)}
|
return []Diagnostic{importDiagnostic(code, message, &location)}
|
||||||
}
|
}
|
||||||
if !containedPath(s.rootPath, canonical) {
|
if !s.access.contains(canonical) {
|
||||||
return []Diagnostic{importDiagnostic(CodeImportOutsideRoot, "import target resolves outside the configuration root", &location)}
|
return []Diagnostic{importDiagnostic(CodeImportOutsideRoot, "import target resolves outside the configuration root", &location)}
|
||||||
}
|
}
|
||||||
|
|
||||||
currentRoute := s.currentRoute(location)
|
currentRoute := s.currentRoute(location)
|
||||||
if activeIndex, ok := s.active[canonical]; ok {
|
identity := s.access.identity(canonical)
|
||||||
|
if activeIndex, ok := s.active[identity]; ok {
|
||||||
cycle := append([]importRoute(nil), s.stack[activeIndex:]...)
|
cycle := append([]importRoute(nil), s.stack[activeIndex:]...)
|
||||||
return []Diagnostic{importCycleDiagnostic(canonical, location, cycle)}
|
return []Diagnostic{importCycleDiagnostic(canonical, location, cycle)}
|
||||||
}
|
}
|
||||||
if previous, ok := s.visited[canonical]; ok {
|
if previous, ok := s.visited[identity]; ok {
|
||||||
return []Diagnostic{importRepeatedDiagnostic(location, previous, currentRoute)}
|
return []Diagnostic{importRepeatedDiagnostic(location, previous, currentRoute)}
|
||||||
}
|
}
|
||||||
if len(s.sources)+1 > s.limits.sources {
|
if s.accounting.sources+1 > s.limits.sources {
|
||||||
return []Diagnostic{importDiagnostic(CodeImportLimitExceeded, "configuration exceeds the source-count limit", &location)}
|
return []Diagnostic{importDiagnostic(CodeImportLimitExceeded, "configuration exceeds the source-count limit", &location)}
|
||||||
}
|
}
|
||||||
|
|
||||||
relative, err := filepath.Rel(s.rootPath, canonical)
|
if _, err := s.access.relative(canonical); err != nil {
|
||||||
if err != nil || filepath.IsAbs(relative) || relative == ".." || strings.HasPrefix(relative, ".."+string(filepath.Separator)) {
|
|
||||||
return []Diagnostic{importDiagnostic(CodeImportOutsideRoot, "import target could not be addressed inside the configuration root", &location)}
|
return []Diagnostic{importDiagnostic(CodeImportOutsideRoot, "import target could not be addressed inside the configuration root", &location)}
|
||||||
}
|
}
|
||||||
sourceID := "source-" + strconv.Itoa(len(s.sources)+1)
|
sourceID := "source-" + strconv.Itoa(s.accounting.sources+1)
|
||||||
info := SourceInfo{ID: sourceID, Label: declaration.path, Path: canonical, Layer: LayerBase, ImportedFrom: &location}
|
kind := SourceKindFile
|
||||||
|
label := declaration.path
|
||||||
|
if s.access.native != nil {
|
||||||
|
kind = SourceKindFilesystem
|
||||||
|
label = s.access.label + "/" + canonical
|
||||||
|
}
|
||||||
|
info := SourceInfo{ID: sourceID, Label: label, Path: canonical, Layer: LayerBase, Kind: kind, ImportedFrom: &location}
|
||||||
|
if kind == SourceKindFilesystem {
|
||||||
|
info.namespace = s.access.token
|
||||||
|
}
|
||||||
s.sources = append(s.sources, info)
|
s.sources = append(s.sources, info)
|
||||||
data, skipped, diagnostic := s.readImport(relative, sourceID, declaration.optional)
|
data, skipped, diagnostic := s.readImport(canonical, sourceID, declaration.optional)
|
||||||
if diagnostic != nil {
|
if diagnostic != nil {
|
||||||
return []Diagnostic{*diagnostic}
|
return []Diagnostic{*diagnostic}
|
||||||
}
|
}
|
||||||
@@ -218,6 +273,7 @@ func (s *importTraversal) visitPath(basePath string, declaration importDeclarati
|
|||||||
s.sources = s.sources[:len(s.sources)-1]
|
s.sources = s.sources[:len(s.sources)-1]
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
s.accounting.sources++
|
||||||
|
|
||||||
root, issues := yamladapter.Parse(bytes.NewReader(data), sourceID, yamladapter.Limits{
|
root, issues := yamladapter.Parse(bytes.NewReader(data), sourceID, yamladapter.Limits{
|
||||||
Depth: maxDocumentDepth, Nodes: maxDocumentNodes,
|
Depth: maxDocumentDepth, Nodes: maxDocumentNodes,
|
||||||
@@ -226,10 +282,10 @@ func (s *importTraversal) visitPath(basePath string, declaration importDeclarati
|
|||||||
return parserDiagnostics(sourceID, issues)
|
return parserDiagnostics(sourceID, issues)
|
||||||
}
|
}
|
||||||
nodeCount := countInputNodes(root)
|
nodeCount := countInputNodes(root)
|
||||||
if s.usedNodes+nodeCount > s.limits.nodes {
|
if s.accounting.nodes+nodeCount > s.limits.nodes {
|
||||||
return []Diagnostic{importDiagnostic(CodeImportLimitExceeded, "configuration exceeds the aggregate node limit", &location)}
|
return []Diagnostic{importDiagnostic(CodeImportLimitExceeded, "configuration exceeds the aggregate node limit", &location)}
|
||||||
}
|
}
|
||||||
s.usedNodes += nodeCount
|
s.accounting.nodes += nodeCount
|
||||||
|
|
||||||
body, declarations, diagnostics := splitImportDirectives(root)
|
body, declarations, diagnostics := splitImportDirectives(root)
|
||||||
if len(diagnostics) != 0 {
|
if len(diagnostics) != 0 {
|
||||||
@@ -245,22 +301,22 @@ func (s *importTraversal) visitPath(basePath string, declaration importDeclarati
|
|||||||
|
|
||||||
route := importRoute{canonical: canonical, locations: currentRoute.locations}
|
route := importRoute{canonical: canonical, locations: currentRoute.locations}
|
||||||
s.documents = append(s.documents, body)
|
s.documents = append(s.documents, body)
|
||||||
s.active[canonical] = len(s.stack)
|
s.active[identity] = len(s.stack)
|
||||||
s.visited[canonical] = route
|
s.visited[identity] = route
|
||||||
s.stack = append(s.stack, route)
|
s.stack = append(s.stack, route)
|
||||||
diagnostics = s.walkDeclarations(filepath.Dir(canonical), declarations, depth)
|
diagnostics = s.walkDeclarations(s.access.dir(canonical), declarations, depth)
|
||||||
delete(s.active, canonical)
|
delete(s.active, identity)
|
||||||
s.stack = s.stack[:len(s.stack)-1]
|
s.stack = s.stack[:len(s.stack)-1]
|
||||||
return diagnostics
|
return diagnostics
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *importTraversal) readImport(relative, sourceID string, optional bool) ([]byte, bool, *Diagnostic) {
|
func (s *importTraversal) readImport(name, sourceID string, optional bool) ([]byte, bool, *Diagnostic) {
|
||||||
remaining := s.limits.bytes - s.usedBytes
|
remaining := s.limits.bytes - s.accounting.bytes
|
||||||
limit := min(int64(maxSourceBytes), remaining)
|
limit := min(int64(maxSourceBytes), remaining)
|
||||||
if limit < 0 {
|
if limit < 0 {
|
||||||
limit = 0
|
limit = 0
|
||||||
}
|
}
|
||||||
data, failure := readRegularFile(relative, s.root.Stat, s.root.Open, limit)
|
data, failure := readRegularFile(name, s.access.stat, s.access.open, limit)
|
||||||
if failure != nil {
|
if failure != nil {
|
||||||
if optional && failure.missingTarget {
|
if optional && failure.missingTarget {
|
||||||
return nil, true, nil
|
return nil, true, nil
|
||||||
@@ -268,7 +324,7 @@ func (s *importTraversal) readImport(relative, sourceID string, optional bool) (
|
|||||||
value := sourceReadDiagnostic(failure, sourceID, CodeImportLimitExceeded, "configuration exceeds a source or aggregate byte limit")
|
value := sourceReadDiagnostic(failure, sourceID, CodeImportLimitExceeded, "configuration exceeds a source or aggregate byte limit")
|
||||||
return nil, false, &value
|
return nil, false, &value
|
||||||
}
|
}
|
||||||
s.usedBytes += int64(len(data))
|
s.accounting.bytes += int64(len(data))
|
||||||
return data, false, nil
|
return data, false, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -89,6 +89,18 @@ settings:
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestLoadImportsFromProfilesDirectoryAsBaseInput(t *testing.T) {
|
||||||
|
directory := t.TempDir()
|
||||||
|
mainPath := writeImportFile(t, directory, "main.yml", "configkit: {imports: [{path: profiles/shared.yml}]}\n")
|
||||||
|
writeImportFile(t, directory, "profiles/shared.yml", "settings: {root: imported}\n")
|
||||||
|
|
||||||
|
result, err := testLoad[importTestConfig](File(mainPath), Options[importTestConfig]{Imports: true})
|
||||||
|
if err != nil || result.Config.Settings.Root != "imported" || len(result.Sources()) != 2 ||
|
||||||
|
result.Sources()[1].Layer != LayerBase {
|
||||||
|
t.Fatalf("profiles import = %#v, %v", result, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestLoadRejectsImportConflictsAndFragmentVersions(t *testing.T) {
|
func TestLoadRejectsImportConflictsAndFragmentVersions(t *testing.T) {
|
||||||
t.Run("all duplicate claimants", func(t *testing.T) {
|
t.Run("all duplicate claimants", func(t *testing.T) {
|
||||||
directory := t.TempDir()
|
directory := t.TempDir()
|
||||||
|
|||||||
313
internal/engine/inheritance.go
Normal file
313
internal/engine/inheritance.go
Normal file
@@ -0,0 +1,313 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"slices"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
||||||
|
)
|
||||||
|
|
||||||
|
const inheritanceKey = "extends"
|
||||||
|
|
||||||
|
// These private records keep structural evidence separate from acquired source
|
||||||
|
// records. Later inspection can project a transfer onto individual descendants.
|
||||||
|
type inheritanceTransfer struct {
|
||||||
|
from Path
|
||||||
|
to Path
|
||||||
|
reference Path
|
||||||
|
locations []Location
|
||||||
|
}
|
||||||
|
|
||||||
|
type inheritanceControl struct {
|
||||||
|
path Path
|
||||||
|
locations []Location
|
||||||
|
cancelled bool
|
||||||
|
}
|
||||||
|
|
||||||
|
type inheritanceScope struct {
|
||||||
|
root *document.Node
|
||||||
|
origins map[string]Origin
|
||||||
|
transfers []inheritanceTransfer
|
||||||
|
controls []inheritanceControl
|
||||||
|
replacements []inheritanceReplacement
|
||||||
|
operations []inheritanceOperation
|
||||||
|
}
|
||||||
|
|
||||||
|
type inheritanceOperation struct {
|
||||||
|
control *inheritanceControl
|
||||||
|
transfer *inheritanceTransfer
|
||||||
|
controlOrigin Origin
|
||||||
|
parent *document.Node
|
||||||
|
effective *document.Node
|
||||||
|
parentOrigins map[string]Origin
|
||||||
|
effectiveOrigins map[string]Origin
|
||||||
|
}
|
||||||
|
|
||||||
|
// A replacement retains the displaced source/derivation record while the
|
||||||
|
// effective origin belongs to the child. Value trees are borrowed immutable
|
||||||
|
// inputs or detached templates and are budgeted with retained history later.
|
||||||
|
type inheritanceReplacement struct {
|
||||||
|
path Path
|
||||||
|
before *document.Node
|
||||||
|
after *document.Node
|
||||||
|
previous []displacedDefinition
|
||||||
|
effective Origin
|
||||||
|
}
|
||||||
|
|
||||||
|
// A link represents one shared relationship edge. Each contributor retains
|
||||||
|
// its original semantic path independently of source line/column coordinates.
|
||||||
|
type inheritanceTrace struct {
|
||||||
|
previous *inheritanceTrace
|
||||||
|
transfer *inheritanceTransfer
|
||||||
|
}
|
||||||
|
|
||||||
|
type inheritanceContributor struct {
|
||||||
|
source Path
|
||||||
|
location Location
|
||||||
|
trace *inheritanceTrace
|
||||||
|
}
|
||||||
|
|
||||||
|
type siblingFrame struct {
|
||||||
|
name string
|
||||||
|
parent string
|
||||||
|
hasParent bool
|
||||||
|
entered bool
|
||||||
|
}
|
||||||
|
|
||||||
|
// expandSiblingDefinitions resolves only the mappings directly in scope.
|
||||||
|
// Nested instructions remain in the returned templates for destination-local
|
||||||
|
// resolution. This private entry point does not participate in public loading.
|
||||||
|
func expandSiblingDefinitions(scope *document.Node, scopePath Path) (*inheritanceScope, []Diagnostic) {
|
||||||
|
return expandSiblingDefinitionsWithLimits(scope, scopePath, defaultProjectionLimits())
|
||||||
|
}
|
||||||
|
|
||||||
|
func expandSiblingDefinitionsWithLimits(scope *document.Node, scopePath Path, limits projectionLimits) (*inheritanceScope, []Diagnostic) {
|
||||||
|
return expandSiblingDefinitionsWithOrigins(scope, scopePath, limits, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
func expandSiblingDefinitionsWithOrigins(scope *document.Node, scopePath Path, limits projectionLimits, inputOrigins map[string]Origin, budget ...*retainedNodeCounter) (*inheritanceScope, []Diagnostic) {
|
||||||
|
if scope == nil || scope.Kind != document.Mapping {
|
||||||
|
return nil, []Diagnostic{{
|
||||||
|
Code: CodeInheritanceInvalid, Severity: SeverityError, Path: scopePath,
|
||||||
|
Message: "inheritance scope must be a mapping",
|
||||||
|
}}
|
||||||
|
}
|
||||||
|
|
||||||
|
byName := make(map[string]document.Entry, len(scope.Mapping))
|
||||||
|
names := make([]string, 0, len(scope.Mapping))
|
||||||
|
for _, entry := range scope.Mapping {
|
||||||
|
byName[entry.Key] = entry
|
||||||
|
names = append(names, entry.Key)
|
||||||
|
}
|
||||||
|
slices.Sort(names)
|
||||||
|
|
||||||
|
resolved := make(map[string]*document.Node, len(byName))
|
||||||
|
resolvedOrigins := make(map[string]map[string]Origin, len(byName))
|
||||||
|
state := make(map[string]uint8, len(byName))
|
||||||
|
result := &inheritanceScope{}
|
||||||
|
counter := newRetainedNodeCounter(historyNodeLimit)
|
||||||
|
if len(budget) != 0 {
|
||||||
|
counter = budget[0]
|
||||||
|
}
|
||||||
|
retained := 1 // scope mapping node
|
||||||
|
for _, entry := range scope.Mapping {
|
||||||
|
if entry.Value.Kind == document.Mapping {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
remaining := limits.nodes - retained - 1
|
||||||
|
if limits.nodes >= 0 && remaining < 0 {
|
||||||
|
return nil, []Diagnostic{inheritanceBudgetDiagnostic(scopePath.Key(entry.Key), entry.Value.Location)}
|
||||||
|
}
|
||||||
|
count, within := inheritanceLowerBoundCount(entry.Value, remaining)
|
||||||
|
if !within {
|
||||||
|
return nil, []Diagnostic{inheritanceBudgetDiagnostic(scopePath.Key(entry.Key), entry.Value.Location)}
|
||||||
|
}
|
||||||
|
retained += 1 + count // key and value subtree
|
||||||
|
}
|
||||||
|
for _, name := range names {
|
||||||
|
if byName[name].Value.Kind != document.Mapping || state[name] == 2 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
stack := []siblingFrame{{name: name}}
|
||||||
|
for len(stack) != 0 {
|
||||||
|
frame := &stack[len(stack)-1]
|
||||||
|
entry := byName[frame.name]
|
||||||
|
path := scopePath.Key(frame.name)
|
||||||
|
if !frame.entered {
|
||||||
|
state[frame.name] = 1
|
||||||
|
frame.entered = true
|
||||||
|
reference, found := inheritanceDirective(entry.Value)
|
||||||
|
if found {
|
||||||
|
referencePath := path.Key(inheritanceKey)
|
||||||
|
location := publicLocation(reference.Value.Location)
|
||||||
|
result.controls = append(result.controls, inheritanceControl{
|
||||||
|
path: referencePath, locations: []Location{location},
|
||||||
|
cancelled: reference.Value.Kind == document.Null,
|
||||||
|
})
|
||||||
|
switch reference.Value.Kind {
|
||||||
|
case document.Null:
|
||||||
|
case document.String:
|
||||||
|
frame.parent, frame.hasParent = reference.Value.Text, true
|
||||||
|
parent, exists := byName[frame.parent]
|
||||||
|
if !exists {
|
||||||
|
return nil, []Diagnostic{inheritanceDiagnostic(CodeInheritanceMissing, referencePath, location, nil,
|
||||||
|
"referenced sibling does not exist")}
|
||||||
|
}
|
||||||
|
if parent.Value.Kind != document.Mapping {
|
||||||
|
related := []Location{publicLocation(parent.Value.Location)}
|
||||||
|
return nil, []Diagnostic{inheritanceDiagnostic(CodeInheritanceInvalid, referencePath, location, related,
|
||||||
|
"referenced sibling is not a mapping")}
|
||||||
|
}
|
||||||
|
if state[frame.parent] == 1 {
|
||||||
|
related := []Location{publicLocation(parent.Value.Location)}
|
||||||
|
return nil, []Diagnostic{inheritanceDiagnostic(CodeInheritanceCycle, referencePath, location, related,
|
||||||
|
"sibling inheritance contains a cycle")}
|
||||||
|
}
|
||||||
|
if state[frame.parent] == 0 {
|
||||||
|
stack = append(stack, siblingFrame{name: frame.parent})
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return nil, []Diagnostic{inheritanceDiagnostic(CodeInheritanceInvalid, referencePath, location, nil,
|
||||||
|
"inheritance reference must be a sibling name or null")}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
payload := withoutInheritanceDirective(entry.Value)
|
||||||
|
operationStart, replacementStart := len(result.operations), len(result.replacements)
|
||||||
|
childOrigins := directInheritanceOrigins(payload, path, inputOrigins)
|
||||||
|
if reference, found := inheritanceDirective(entry.Value); found {
|
||||||
|
control := inheritanceControl{
|
||||||
|
path: path.Key(inheritanceKey),
|
||||||
|
locations: []Location{publicLocation(reference.Value.Location)},
|
||||||
|
cancelled: reference.Value.Kind == document.Null,
|
||||||
|
}
|
||||||
|
controlOrigins := directInheritanceOrigins(reference.Value, control.path, inputOrigins)
|
||||||
|
result.operations = append(result.operations, inheritanceOperation{
|
||||||
|
control: &control, controlOrigin: controlOrigins[control.path.String()],
|
||||||
|
})
|
||||||
|
}
|
||||||
|
if limits.nodes >= 0 {
|
||||||
|
remaining := limits.nodes - retained - 1 // the sibling key
|
||||||
|
within := false
|
||||||
|
if frame.hasParent {
|
||||||
|
within = inheritanceOverlayLowerBoundWithin(resolved[frame.parent], payload, remaining)
|
||||||
|
} else {
|
||||||
|
within = inheritanceLowerBoundWithin(payload, remaining)
|
||||||
|
}
|
||||||
|
if !within {
|
||||||
|
return nil, []Diagnostic{inheritanceBudgetDiagnostic(path, entry.Value.Location)}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if frame.hasParent {
|
||||||
|
parent := resolved[frame.parent]
|
||||||
|
merged := document.Clone(parent)
|
||||||
|
control := inheritanceDirectiveLocation(entry.Value)
|
||||||
|
transfer := inheritanceTransfer{
|
||||||
|
from: scopePath.Key(frame.parent), to: path,
|
||||||
|
reference: path.Key(inheritanceKey), locations: []Location{control},
|
||||||
|
}
|
||||||
|
mergedOrigins := transferredInheritanceOrigins(resolvedOrigins[frame.parent], transfer.from, path, transfer)
|
||||||
|
mergeInheritanceOrigin(mergedOrigins, path, childOrigins[path.String()])
|
||||||
|
mergeRecursiveMappings(merged, payload, path, new(mappingIndex), recursiveMergeHooks{
|
||||||
|
added: func(childPath Path, incoming *document.Node) {
|
||||||
|
copyInheritanceSubtree(mergedOrigins, childOrigins, incoming, childPath)
|
||||||
|
},
|
||||||
|
combined: func(childPath Path, _ *document.Node) {
|
||||||
|
mergeInheritanceOrigin(mergedOrigins, childPath, childOrigins[childPath.String()])
|
||||||
|
},
|
||||||
|
replaced: func(childPath Path, existing, incoming *document.Node) {
|
||||||
|
previous := displacedOrigins(existing, mergedOrigins, childPath)
|
||||||
|
result.replacements = append(result.replacements, inheritanceReplacement{
|
||||||
|
path: childPath.clone(), before: existing, after: incoming,
|
||||||
|
previous: previous, effective: cloneOrigin(childOrigins[childPath.String()]),
|
||||||
|
})
|
||||||
|
deleteOriginSubtree(mergedOrigins, childPath, existing)
|
||||||
|
copyInheritanceSubtree(mergedOrigins, childOrigins, incoming, childPath)
|
||||||
|
},
|
||||||
|
})
|
||||||
|
merged.Location = entry.Value.Location
|
||||||
|
resolved[frame.name] = merged
|
||||||
|
resolvedOrigins[frame.name] = mergedOrigins
|
||||||
|
result.transfers = append(result.transfers, transfer)
|
||||||
|
result.operations = append(result.operations, inheritanceOperation{
|
||||||
|
transfer: &transfer, parent: parent, effective: merged,
|
||||||
|
parentOrigins: resolvedOrigins[frame.parent], effectiveOrigins: mergedOrigins,
|
||||||
|
})
|
||||||
|
} else {
|
||||||
|
resolved[frame.name] = document.Clone(payload)
|
||||||
|
resolvedOrigins[frame.name] = childOrigins
|
||||||
|
}
|
||||||
|
count, _ := inheritanceLowerBoundCount(resolved[frame.name], limits.nodes)
|
||||||
|
retained += 1 + count
|
||||||
|
for _, operation := range result.operations[operationStart:] {
|
||||||
|
if !counter.add(operation.parent) || !counter.add(operation.effective) {
|
||||||
|
return nil, []Diagnostic{inheritanceHistoryBudgetDiagnostic(path, entry.Value.Location)}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, replacement := range result.replacements[replacementStart:] {
|
||||||
|
if !counter.add(replacement.before) || !counter.add(replacement.after) {
|
||||||
|
return nil, []Diagnostic{inheritanceHistoryBudgetDiagnostic(path, entry.Value.Location)}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
state[frame.name] = 2
|
||||||
|
stack = stack[:len(stack)-1]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
root := *scope
|
||||||
|
root.Mapping = make([]document.Entry, len(scope.Mapping))
|
||||||
|
rootOrigin := directInheritanceOrigins(&document.Node{Kind: document.Mapping, Location: scope.Location}, scopePath, inputOrigins)
|
||||||
|
result.origins = rootOrigin
|
||||||
|
for index, entry := range scope.Mapping {
|
||||||
|
root.Mapping[index] = entry
|
||||||
|
if resolved[entry.Key] != nil {
|
||||||
|
root.Mapping[index].Value = resolved[entry.Key]
|
||||||
|
for pointer, origin := range resolvedOrigins[entry.Key] {
|
||||||
|
result.origins[pointer] = origin
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
root.Mapping[index].Value = document.Clone(entry.Value)
|
||||||
|
for pointer, origin := range directInheritanceOrigins(entry.Value, scopePath.Key(entry.Key), inputOrigins) {
|
||||||
|
result.origins[pointer] = origin
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
result.root = &root
|
||||||
|
if !inheritanceLowerBoundWithin(result.root, limits.nodes) {
|
||||||
|
return nil, []Diagnostic{inheritanceBudgetDiagnostic(scopePath, scope.Location)}
|
||||||
|
}
|
||||||
|
return result, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func inheritanceDirective(node *document.Node) (document.Entry, bool) {
|
||||||
|
for _, entry := range node.Mapping {
|
||||||
|
if entry.Key == inheritanceKey {
|
||||||
|
return entry, true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return document.Entry{}, false
|
||||||
|
}
|
||||||
|
|
||||||
|
func inheritanceDirectiveLocation(node *document.Node) Location {
|
||||||
|
entry, _ := inheritanceDirective(node)
|
||||||
|
return publicLocation(entry.Value.Location)
|
||||||
|
}
|
||||||
|
|
||||||
|
func withoutInheritanceDirective(node *document.Node) *document.Node {
|
||||||
|
payload := *node
|
||||||
|
payload.Mapping = make([]document.Entry, 0, len(node.Mapping))
|
||||||
|
for _, entry := range node.Mapping {
|
||||||
|
if entry.Key != inheritanceKey {
|
||||||
|
payload.Mapping = append(payload.Mapping, entry)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return &payload
|
||||||
|
}
|
||||||
|
|
||||||
|
func inheritanceDiagnostic(code Code, path Path, primary Location, related []Location, message string) Diagnostic {
|
||||||
|
return Diagnostic{
|
||||||
|
Code: code, Severity: SeverityError, Path: path, Message: message,
|
||||||
|
Primary: &primary, Related: related,
|
||||||
|
}
|
||||||
|
}
|
||||||
110
internal/engine/inheritance_bench_test.go
Normal file
110
internal/engine/inheritance_bench_test.go
Normal file
@@ -0,0 +1,110 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
||||||
|
)
|
||||||
|
|
||||||
|
func BenchmarkInheritanceExpansion(b *testing.B) {
|
||||||
|
for _, shape := range []string{"chain", "wide", "nested", "replacement"} {
|
||||||
|
for _, size := range []int{16, 32, 64} {
|
||||||
|
b.Run(shape+"/"+strconv.Itoa(size), func(b *testing.B) {
|
||||||
|
input := inheritanceBenchmarkInput(shape, size)
|
||||||
|
b.ReportAllocs()
|
||||||
|
b.ResetTimer()
|
||||||
|
for range b.N {
|
||||||
|
if _, diagnostics := expandInheritanceWithOrigins(input, nil, defaultProjectionLimits()); len(diagnostics) != 0 {
|
||||||
|
b.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func BenchmarkInheritanceInspectedLoad(b *testing.B) {
|
||||||
|
type entry struct {
|
||||||
|
Value string `yaml:"value"`
|
||||||
|
}
|
||||||
|
type configuration struct {
|
||||||
|
Entries map[string]entry `yaml:"entries"`
|
||||||
|
}
|
||||||
|
for _, size := range []int{16, 32, 64} {
|
||||||
|
b.Run(strconv.Itoa(size), func(b *testing.B) {
|
||||||
|
var input strings.Builder
|
||||||
|
input.WriteString("entries:\n item-0: {value: base}\n")
|
||||||
|
for index := 1; index <= size; index++ {
|
||||||
|
input.WriteString(" item-")
|
||||||
|
input.WriteString(strconv.Itoa(index))
|
||||||
|
input.WriteString(": {extends: item-0}\n")
|
||||||
|
}
|
||||||
|
source := Bytes("inheritance-benchmark", []byte(input.String()))
|
||||||
|
query := Keys("entries", "item-"+strconv.Itoa(size), "value")
|
||||||
|
b.ReportAllocs()
|
||||||
|
b.ResetTimer()
|
||||||
|
for range b.N {
|
||||||
|
loaded, err := Load[configuration](source, testSecretBinding())
|
||||||
|
if err != nil {
|
||||||
|
b.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, found := loaded.Inspection.Explain(query); !found {
|
||||||
|
b.Fatal("inherited value is not explainable")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Each scope has constant-sized output and evidence. This distinguishes budget
|
||||||
|
// accounting overhead from legitimate growth in expanded parent payloads.
|
||||||
|
func BenchmarkInheritanceIndependentScopes(b *testing.B) {
|
||||||
|
for _, size := range []int{256, 512, 1024} {
|
||||||
|
b.Run(strconv.Itoa(size), func(b *testing.B) {
|
||||||
|
input := &document.Node{Kind: document.Mapping}
|
||||||
|
for index := 0; index < size; index++ {
|
||||||
|
input.Mapping = append(input.Mapping, document.Entry{
|
||||||
|
Key: strconv.Itoa(index), Value: inheritanceBenchmarkInput("wide", 1),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
b.ReportAllocs()
|
||||||
|
b.ResetTimer()
|
||||||
|
for range b.N {
|
||||||
|
if _, diagnostics := expandInheritanceTree(input, defaultProjectionLimits()); len(diagnostics) != 0 {
|
||||||
|
b.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func inheritanceBenchmarkInput(shape string, size int) *document.Node {
|
||||||
|
value := func(text string) *document.Node { return &document.Node{Kind: document.String, Text: text} }
|
||||||
|
mapping := func(entries ...document.Entry) *document.Node {
|
||||||
|
return &document.Node{Kind: document.Mapping, Mapping: entries}
|
||||||
|
}
|
||||||
|
entry := func(key string, node *document.Node) document.Entry { return document.Entry{Key: key, Value: node} }
|
||||||
|
base := mapping(entry("value", value("base")), entry("settings", mapping(entry("enabled", &document.Node{Kind: document.Boolean, Text: "false"}))))
|
||||||
|
if shape == "nested" {
|
||||||
|
base = mapping(entry("settings", mapping(entry("first", mapping(entry("value", value("base")))), entry("second", mapping(entry("extends", value("first")))))))
|
||||||
|
}
|
||||||
|
definitions := make([]document.Entry, 0, size+1)
|
||||||
|
definitions = append(definitions, entry("item-0", base))
|
||||||
|
for index := 1; index <= size; index++ {
|
||||||
|
parent := "item-0"
|
||||||
|
if shape == "chain" {
|
||||||
|
parent = "item-" + strconv.Itoa(index-1)
|
||||||
|
}
|
||||||
|
payload := []document.Entry{entry("extends", value(parent))}
|
||||||
|
if shape == "nested" {
|
||||||
|
payload = append(payload, entry("settings", mapping(entry("first", mapping(entry("value", value("custom")))))))
|
||||||
|
}
|
||||||
|
if shape == "replacement" {
|
||||||
|
payload = append(payload, entry("value", value("replacement")))
|
||||||
|
}
|
||||||
|
definitions = append(definitions, entry("item-"+strconv.Itoa(index), mapping(payload...)))
|
||||||
|
}
|
||||||
|
return mapping(entry("entries", mapping(definitions...)))
|
||||||
|
}
|
||||||
60
internal/engine/inheritance_explain.go
Normal file
60
internal/engine/inheritance_explain.go
Normal file
@@ -0,0 +1,60 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import "gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
||||||
|
|
||||||
|
func appendInheritanceExplanation(explanation *Explanation, working **document.Node, query Path, operations []inheritanceOperation, secrets map[string]bool) {
|
||||||
|
for _, operation := range operations {
|
||||||
|
changes := projectedInheritanceChanges(query, operation)
|
||||||
|
if operation.control != nil {
|
||||||
|
if !pathsIntersect(operation.control.path, query) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
before := valueSnapshot(*working, query, secrets)
|
||||||
|
replaceHistoryPath(working, operation.control.path, nil)
|
||||||
|
after := valueSnapshot(*working, query, secrets)
|
||||||
|
if len(changes) != 0 {
|
||||||
|
explanation.History = append(explanation.History, ValueChange{
|
||||||
|
Before: before, After: after, Origin: cloneOrigin(changes[0].Origin),
|
||||||
|
Dependencies: clonePaths(changes[0].Dependencies),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if operation.transfer == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
before := valueSnapshot(*working, query, secrets)
|
||||||
|
replaceHistoryPath(working, operation.transfer.to, operation.parent)
|
||||||
|
afterParent := valueSnapshot(*working, query, secrets)
|
||||||
|
parent, parentPresent := transferredOperationOrigin(operation, operationPathForQuery(operation.transfer.to, query))
|
||||||
|
if pathsIntersect(operation.transfer.to, query) && parentPresent {
|
||||||
|
parent.Operation = ChangeInheritance
|
||||||
|
parent.Inheritance = projectInheritanceSteps(parent)
|
||||||
|
explanation.History = append(explanation.History, ValueChange{
|
||||||
|
Before: before, After: afterParent, Origin: parent,
|
||||||
|
Dependencies: []Path{operation.transfer.from.clone(), operation.transfer.reference.clone()},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
replaceHistoryPath(working, operation.transfer.to, operation.effective)
|
||||||
|
if !pathsIntersect(operation.transfer.to, query) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
afterChild := valueSnapshot(*working, query, secrets)
|
||||||
|
if len(changes) != 0 {
|
||||||
|
last := changes[len(changes)-1]
|
||||||
|
if !parentPresent || len(changes) > 1 {
|
||||||
|
explanation.History = append(explanation.History, ValueChange{
|
||||||
|
Before: afterParent, After: afterChild, Origin: cloneOrigin(last.Origin),
|
||||||
|
Dependencies: clonePaths(last.Dependencies),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func operationPathForQuery(root, query Path) Path {
|
||||||
|
if pathContains(query, root) {
|
||||||
|
return root
|
||||||
|
}
|
||||||
|
return query
|
||||||
|
}
|
||||||
170
internal/engine/inheritance_history.go
Normal file
170
internal/engine/inheritance_history.go
Normal file
@@ -0,0 +1,170 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"sort"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
||||||
|
)
|
||||||
|
|
||||||
|
type inheritanceHistoryIndex struct {
|
||||||
|
paths pathPrefixIndex
|
||||||
|
}
|
||||||
|
|
||||||
|
func newInheritanceHistoryIndex(operations []inheritanceOperation) *inheritanceHistoryIndex {
|
||||||
|
if len(operations) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
index := &inheritanceHistoryIndex{}
|
||||||
|
for operationID, operation := range operations {
|
||||||
|
if operation.control != nil {
|
||||||
|
index.paths.insert(operation.control.path.String(), operationID)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if operation.transfer != nil {
|
||||||
|
index.paths.insert(operation.transfer.to.String(), operationID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return index
|
||||||
|
}
|
||||||
|
|
||||||
|
func (index *inheritanceHistoryIndex) matchingOperations(path Path, operations []inheritanceOperation) []inheritanceOperation {
|
||||||
|
if index == nil {
|
||||||
|
return operations
|
||||||
|
}
|
||||||
|
var ids []int
|
||||||
|
seen := make(map[int]struct{})
|
||||||
|
collect := func(id int) {
|
||||||
|
if _, found := seen[id]; found {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
seen[id] = struct{}{}
|
||||||
|
ids = append(ids, id)
|
||||||
|
}
|
||||||
|
pointer := path.String()
|
||||||
|
index.paths.visitAncestors(pointer, collect)
|
||||||
|
index.paths.visitDescendants(pointer, collect)
|
||||||
|
sort.Ints(ids)
|
||||||
|
matching := make([]inheritanceOperation, 0, len(ids))
|
||||||
|
for _, id := range ids {
|
||||||
|
if id >= 0 && id < len(operations) {
|
||||||
|
matching = append(matching, operations[id])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return matching
|
||||||
|
}
|
||||||
|
|
||||||
|
// Retain source history at original paths. Structural operations are held once
|
||||||
|
// per relationship and projected onto a requested destination path only when
|
||||||
|
// History or Explain is queried.
|
||||||
|
func applyInheritanceMetadata(metadata *Metadata, raw *document.Node, rawOrigins map[string]Origin, overlays []overlayRecord, expansion *inheritanceScope) {
|
||||||
|
if metadata == nil || expansion == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
sourceView := Metadata{
|
||||||
|
fields: make(map[string]FieldInfo),
|
||||||
|
history: metadata.history,
|
||||||
|
}
|
||||||
|
walkDocument(raw, Path{}, func(path Path, node *document.Node) {
|
||||||
|
origin, found := rawOrigins[path.String()]
|
||||||
|
if !found {
|
||||||
|
origin = Origin{Layer: LayerBase, Locations: []Location{publicLocation(node.Location)}}
|
||||||
|
}
|
||||||
|
sourceView.fields[path.String()] = FieldInfo{Explicit: true, Null: node.Kind == document.Null, Origin: cloneOrigin(origin)}
|
||||||
|
})
|
||||||
|
applyOverlayMetadata(&sourceView, overlays)
|
||||||
|
metadata.history = sourceView.history
|
||||||
|
metadata.inheritance = append([]inheritanceOperation(nil), expansion.operations...)
|
||||||
|
}
|
||||||
|
|
||||||
|
func historyWithInheritance(path Path, stored []Change, operations []inheritanceOperation) []Change {
|
||||||
|
split := len(stored)
|
||||||
|
for index, change := range stored {
|
||||||
|
if change.Origin.Layer == LayerResolution {
|
||||||
|
split = index
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
history := cloneChanges(stored[:split])
|
||||||
|
for _, operation := range operations {
|
||||||
|
for _, change := range projectedInheritanceChanges(path, operation) {
|
||||||
|
if len(history) != 0 {
|
||||||
|
change.Previous = []Origin{cloneOrigin(history[len(history)-1].Origin)}
|
||||||
|
}
|
||||||
|
history = append(history, change)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, change := range stored[split:] {
|
||||||
|
cloned := cloneChange(change)
|
||||||
|
if len(history) != 0 {
|
||||||
|
cloned.Previous = []Origin{cloneOrigin(history[len(history)-1].Origin)}
|
||||||
|
}
|
||||||
|
history = append(history, cloned)
|
||||||
|
}
|
||||||
|
return history
|
||||||
|
}
|
||||||
|
|
||||||
|
func projectedInheritanceChanges(query Path, operation inheritanceOperation) []Change {
|
||||||
|
if operation.control != nil {
|
||||||
|
if !pathsIntersect(operation.control.path, query) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
origin := cloneOrigin(operation.controlOrigin)
|
||||||
|
origin.Operation = ChangeInheritance
|
||||||
|
origin.Inheritance = projectInheritanceSteps(origin)
|
||||||
|
return []Change{{Path: operation.control.path.clone(), Origin: origin,
|
||||||
|
Dependencies: []Path{operation.control.path.clone()}}}
|
||||||
|
}
|
||||||
|
if operation.transfer == nil || !pathsIntersect(operation.transfer.to, query) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
path := query
|
||||||
|
if pathContains(query, operation.transfer.to) {
|
||||||
|
path = operation.transfer.to
|
||||||
|
}
|
||||||
|
var changes []Change
|
||||||
|
parent, parentFound := transferredOperationOrigin(operation, path)
|
||||||
|
if parentFound {
|
||||||
|
parent.Operation = ChangeInheritance
|
||||||
|
parent.Inheritance = projectInheritanceSteps(parent)
|
||||||
|
changes = append(changes, Change{
|
||||||
|
Path: path.clone(), Origin: parent,
|
||||||
|
Dependencies: []Path{operation.transfer.from.clone(), operation.transfer.reference.clone()},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
effective, effectiveFound := operation.effectiveOrigins[path.String()]
|
||||||
|
if effectiveFound {
|
||||||
|
effective = cloneOrigin(effective)
|
||||||
|
effective.Operation = ChangeInheritance
|
||||||
|
}
|
||||||
|
if effectiveFound && (!parentFound || !originContainedBy(effective, parent)) {
|
||||||
|
effective.Inheritance = projectInheritanceSteps(effective)
|
||||||
|
changes = append(changes, Change{
|
||||||
|
Path: path.clone(), Origin: effective,
|
||||||
|
Dependencies: []Path{operation.transfer.reference.clone()},
|
||||||
|
})
|
||||||
|
} else if parentFound && !effectiveFound {
|
||||||
|
removed := cloneOrigin(operation.effectiveOrigins[operation.transfer.to.String()])
|
||||||
|
removed.Operation = ChangeInheritance
|
||||||
|
removed.Inheritance = projectInheritanceSteps(removed)
|
||||||
|
changes = append(changes, Change{
|
||||||
|
Path: operation.transfer.to.clone(), Origin: removed,
|
||||||
|
Dependencies: []Path{operation.transfer.reference.clone()},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
return changes
|
||||||
|
}
|
||||||
|
|
||||||
|
func transferredOperationOrigin(operation inheritanceOperation, destination Path) (Origin, bool) {
|
||||||
|
relative, ok := relativeHistoryPath(operation.transfer.to, destination)
|
||||||
|
if !ok {
|
||||||
|
return Origin{}, false
|
||||||
|
}
|
||||||
|
source := appendInheritancePath(operation.transfer.from, relative)
|
||||||
|
origin, found := operation.parentOrigins[source.String()]
|
||||||
|
if !found {
|
||||||
|
return Origin{}, false
|
||||||
|
}
|
||||||
|
transferred := transferredInheritanceOrigins(map[string]Origin{source.String(): origin},
|
||||||
|
operation.transfer.from, operation.transfer.to, *operation.transfer)
|
||||||
|
return transferred[destination.String()], true
|
||||||
|
}
|
||||||
410
internal/engine/inheritance_history_test.go
Normal file
410
internal/engine/inheritance_history_test.go
Normal file
@@ -0,0 +1,410 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestNestedInheritanceHistoryRetainsUnresolvedTemplates(t *testing.T) {
|
||||||
|
input := `presets:
|
||||||
|
base:
|
||||||
|
settings:
|
||||||
|
primary: {width: 10}
|
||||||
|
secondary: {extends: primary}
|
||||||
|
custom:
|
||||||
|
extends: base
|
||||||
|
settings:
|
||||||
|
primary: {width: 20}
|
||||||
|
grandchild:
|
||||||
|
extends: custom
|
||||||
|
settings:
|
||||||
|
primary: {width: 30}
|
||||||
|
`
|
||||||
|
loaded, err := Load[map[string]any](Bytes("nested", []byte(input)), testSecretBinding())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for name, width := range map[string]string{"custom": "20", "grandchild": "30"} {
|
||||||
|
t.Run(name, func(t *testing.T) {
|
||||||
|
root := Keys("presets", name)
|
||||||
|
value, _ := loaded.Inspection.Explain(root.Key("settings").Key("secondary").Key("width"))
|
||||||
|
introduced := false
|
||||||
|
for _, change := range value.History {
|
||||||
|
if change.Origin.Operation == ChangeInheritance && !change.Before.Present && change.After.YAML == width+"\n" {
|
||||||
|
introduced = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !introduced || value.Effective.YAML != width+"\n" {
|
||||||
|
t.Fatalf("missing nested introduction: %#v", value)
|
||||||
|
}
|
||||||
|
controlPath := root.Key("settings").Key("secondary").Key("extends")
|
||||||
|
control, _ := loaded.Inspection.Explain(controlPath)
|
||||||
|
arrived, consumed := false, false
|
||||||
|
for _, change := range control.History {
|
||||||
|
arrived = arrived || change.After.YAML == "primary\n"
|
||||||
|
consumed = consumed || (change.Before.YAML == "primary\n" && !change.After.Present)
|
||||||
|
}
|
||||||
|
if !arrived || !consumed || control.Effective.Present {
|
||||||
|
t.Fatalf("missing control history: %#v", control)
|
||||||
|
}
|
||||||
|
container, _ := loaded.Inspection.Explain(root)
|
||||||
|
unresolved := false
|
||||||
|
for _, change := range container.History {
|
||||||
|
if change.Origin.Operation == ChangeInheritance && strings.Contains(change.After.YAML, "extends: primary") {
|
||||||
|
unresolved = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !unresolved || strings.Contains(container.Effective.YAML, "extends:") {
|
||||||
|
t.Fatalf("invalid enclosing snapshot: %#v", container)
|
||||||
|
}
|
||||||
|
if _, present := loaded.Inspection.Metadata().Lookup(controlPath); present {
|
||||||
|
t.Fatal("control is effective")
|
||||||
|
}
|
||||||
|
if len(loaded.Inspection.Metadata().History(controlPath)) != len(control.History) {
|
||||||
|
t.Fatal("metadata and explanation disagree")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNestedInheritanceHistoryInsideSequence(t *testing.T) {
|
||||||
|
input := `base:
|
||||||
|
items:
|
||||||
|
- first: {value: inherited}
|
||||||
|
second: {extends: first}
|
||||||
|
child: {extends: base}
|
||||||
|
`
|
||||||
|
loaded, err := Load[map[string]any](Bytes("sequence", []byte(input)), testSecretBinding())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
path := Keys("child", "items").Index(0).Key("second")
|
||||||
|
control, _ := loaded.Inspection.Explain(path.Key("extends"))
|
||||||
|
consumed := false
|
||||||
|
for _, change := range control.History {
|
||||||
|
consumed = consumed || (change.Before.YAML == "first\n" && !change.After.Present)
|
||||||
|
}
|
||||||
|
if !consumed || control.Effective.Present {
|
||||||
|
t.Fatalf("sequence control history = %#v", control)
|
||||||
|
}
|
||||||
|
value, _ := loaded.Inspection.Explain(path.Key("value"))
|
||||||
|
introduced := false
|
||||||
|
for _, change := range value.History {
|
||||||
|
introduced = introduced || (!change.Before.Present && change.After.YAML == "inherited\n")
|
||||||
|
}
|
||||||
|
if !introduced || value.Effective.YAML != "inherited\n" {
|
||||||
|
t.Fatalf("sequence value history = %#v", value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func inheritanceInspectionForTest(t *testing.T, sources ...*document.Node) (*Inspection, *inheritanceScope) {
|
||||||
|
t.Helper()
|
||||||
|
composed, diagnostics := composeDocuments(sources...)
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
return inheritanceInspectionFromComposition(t, composed)
|
||||||
|
}
|
||||||
|
|
||||||
|
func inheritanceInspectionFromComposition(t *testing.T, composed *composedDocument) (*Inspection, *inheritanceScope) {
|
||||||
|
t.Helper()
|
||||||
|
expanded, diagnostics := expandInheritanceWithOrigins(composed.root, composed.origins, defaultProjectionLimits())
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
baseline := &document.Node{Kind: document.Mapping}
|
||||||
|
presence := make(map[string]inputPresence)
|
||||||
|
collectPresence(expanded.root, Path{}, presence)
|
||||||
|
decoded := decodedConfiguration{
|
||||||
|
baseline: baseline, final: expanded.root, presence: presence, origins: expanded.origins,
|
||||||
|
}
|
||||||
|
metadata := metadataFromDecoded(decoded)
|
||||||
|
applyInheritanceMetadata(&metadata, composed.root, composed.origins, composed.overlays, expanded)
|
||||||
|
finalizeMetadataPaths(&metadata, expanded.root, composed.applications, baseline, composed.root)
|
||||||
|
return &Inspection{
|
||||||
|
metadata: metadata, baseline: baseline, input: expanded.root,
|
||||||
|
inputOrigins: expanded.origins, final: expanded.root,
|
||||||
|
applications: composed.applications, inheritance: expanded.operations,
|
||||||
|
}, expanded
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInheritanceHistoryFollowsFinalParentAfterSourceOverlay(t *testing.T) {
|
||||||
|
base, diagnostics := composeDocuments(parseCompositionDocument(t, "source-1", "parent: {value: original}\nchild: {extends: parent}\n"))
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
assembly := newAssemblyAccumulator(base)
|
||||||
|
if diagnostics := assembly.applyOverlay(parseCompositionDocument(t, "source-2", "parent: {value: latest}\n"), nil, nil, LayerOverlay); len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
inspection, _ := inheritanceInspectionFromComposition(t, assembly.current)
|
||||||
|
path := Keys("child", "value")
|
||||||
|
explanation, found := inspection.Explain(path)
|
||||||
|
if !found || explanation.Effective.YAML != "latest\n" ||
|
||||||
|
len(explanation.History) == 0 || explanation.History[len(explanation.History)-1].Origin.Locations[0].SourceID != "source-2" {
|
||||||
|
t.Fatalf("overlaid parent contribution = %#v, %v", explanation, found)
|
||||||
|
}
|
||||||
|
parentHistory := inspection.Metadata().History(Keys("parent", "value"))
|
||||||
|
if len(parentHistory) < 2 || parentHistory[0].Origin.Layer != LayerBase ||
|
||||||
|
parentHistory[len(parentHistory)-1].Origin.Layer != LayerOverlay {
|
||||||
|
t.Fatalf("parent source history = %#v", parentHistory)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInheritanceHistoryPreservesCancellationAndSupersededDirective(t *testing.T) {
|
||||||
|
base, diagnostics := composeDocuments(parseCompositionDocument(t, "source-1", "parent: {value: one}\nchild: {extends: missing, value: own}\n"))
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
assembly := newAssemblyAccumulator(base)
|
||||||
|
if diagnostics := assembly.applyOverlay(parseCompositionDocument(t, "source-2", "child: {extends: null}\n"), nil, nil, LayerOverlay); len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
inspection, _ := inheritanceInspectionFromComposition(t, assembly.current)
|
||||||
|
control := Keys("child", inheritanceKey)
|
||||||
|
history := inspection.Metadata().History(control)
|
||||||
|
if len(history) < 3 || history[0].Origin.Locations[0].SourceID != "source-1" ||
|
||||||
|
history[1].Origin.Locations[0].SourceID != "source-2" ||
|
||||||
|
history[len(history)-1].Origin.Operation != ChangeInheritance {
|
||||||
|
t.Fatalf("superseded and cancelled directive history = %#v", history)
|
||||||
|
}
|
||||||
|
explanation, found := inspection.Explain(control)
|
||||||
|
if !found || explanation.Effective.Present || len(explanation.History) < 3 ||
|
||||||
|
explanation.History[len(explanation.History)-1].After.Present {
|
||||||
|
t.Fatalf("cancelled directive explanation = %#v, %v", explanation, found)
|
||||||
|
}
|
||||||
|
value, found := inspection.Explain(Keys("child", "value"))
|
||||||
|
if !found || value.Effective.YAML != "own\n" {
|
||||||
|
t.Fatalf("cancelled relationship changed own value = %#v, %v", value, found)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInheritanceHistoryProjectsNestedDestinationValues(t *testing.T) {
|
||||||
|
inspection, _ := inheritanceInspectionForTest(t, parseCompositionDocument(t, "source-1", `base:
|
||||||
|
settings:
|
||||||
|
primary: {value: old}
|
||||||
|
secondary: {extends: primary}
|
||||||
|
custom:
|
||||||
|
extends: base
|
||||||
|
settings:
|
||||||
|
primary: {value: new}
|
||||||
|
`))
|
||||||
|
path := Keys("custom", "settings", "secondary", "value")
|
||||||
|
history := inspection.Metadata().History(path)
|
||||||
|
structural := 0
|
||||||
|
for _, change := range history {
|
||||||
|
if change.Origin.Operation == ChangeInheritance {
|
||||||
|
structural++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if structural == 0 {
|
||||||
|
t.Fatalf("nested destination history = %#v", history)
|
||||||
|
}
|
||||||
|
explanation, found := inspection.Explain(path)
|
||||||
|
if !found || explanation.Effective.YAML != "new\n" ||
|
||||||
|
len(explanation.Origin.Inheritance) == 0 ||
|
||||||
|
explanation.Origin.Inheritance[len(explanation.Origin.Inheritance)-1].To.String() != path.String() {
|
||||||
|
t.Fatalf("nested destination explanation = %#v, %v", explanation, found)
|
||||||
|
}
|
||||||
|
for _, change := range explanation.History {
|
||||||
|
if change.Origin.Operation == ChangeDecoding {
|
||||||
|
t.Fatalf("nested inheritance was attributed to decoding: %#v", explanation.History)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInheritanceHistoryShowsParentAndEqualChildContribution(t *testing.T) {
|
||||||
|
inspection, _ := inheritanceInspectionForTest(t,
|
||||||
|
parseCompositionDocument(t, "source-1", "parent: {value: same}\n"),
|
||||||
|
parseCompositionDocument(t, "source-2", "child: {extends: parent, value: same}\n"))
|
||||||
|
path := Keys("child", "value")
|
||||||
|
history := inspection.Metadata().History(path)
|
||||||
|
var structural []Change
|
||||||
|
for _, change := range history {
|
||||||
|
if change.Origin.Operation == ChangeInheritance {
|
||||||
|
structural = append(structural, change)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(structural) != 2 || structural[0].Origin.Locations[0].SourceID != "source-1" ||
|
||||||
|
structural[1].Origin.Locations[0].SourceID != "source-2" ||
|
||||||
|
len(structural[0].Dependencies) != 2 || structural[0].Dependencies[0].String() != "/parent" ||
|
||||||
|
len(structural[0].Origin.Inheritance) != 1 {
|
||||||
|
t.Fatalf("equal-valued structural history = %#v", history)
|
||||||
|
}
|
||||||
|
explanation, found := inspection.Explain(path)
|
||||||
|
if !found || explanation.Effective.YAML != "same\n" {
|
||||||
|
t.Fatalf("explanation = %#v, %v", explanation, found)
|
||||||
|
}
|
||||||
|
var equalEvents int
|
||||||
|
for _, change := range explanation.History {
|
||||||
|
if change.Origin.Operation == ChangeDecoding {
|
||||||
|
t.Fatalf("inheritance was attributed to decoding: %#v", explanation.History)
|
||||||
|
}
|
||||||
|
if change.Origin.Operation == ChangeInheritance && change.Before.YAML == change.After.YAML {
|
||||||
|
equalEvents++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if equalEvents != 2 {
|
||||||
|
t.Fatalf("equal parent and child operations = %#v", explanation.History)
|
||||||
|
}
|
||||||
|
parentHistory := inspection.Metadata().History(Keys("parent", "value"))
|
||||||
|
for _, change := range parentHistory {
|
||||||
|
if change.Origin.Operation == ChangeInheritance {
|
||||||
|
t.Fatalf("source definition acquired a destination operation: %#v", parentHistory)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInheritanceHistoryRetainsControlsAndDisplacedPaths(t *testing.T) {
|
||||||
|
inspection, _ := inheritanceInspectionForTest(t,
|
||||||
|
parseCompositionDocument(t, "source-1", "parent: {branch: {detail: inherited}}\n"),
|
||||||
|
parseCompositionDocument(t, "source-2", "child: {extends: parent, branch: replaced}\n"))
|
||||||
|
control := Keys("child", inheritanceKey)
|
||||||
|
controlHistory := inspection.Metadata().History(control)
|
||||||
|
if len(controlHistory) < 2 || controlHistory[len(controlHistory)-1].Origin.Operation != ChangeInheritance {
|
||||||
|
t.Fatalf("control history = %#v", controlHistory)
|
||||||
|
}
|
||||||
|
controlExplanation, found := inspection.Explain(control)
|
||||||
|
if !found || controlExplanation.Effective.Present ||
|
||||||
|
controlExplanation.History[len(controlExplanation.History)-1].After.Present {
|
||||||
|
t.Fatalf("consumed control = %#v, %v", controlExplanation, found)
|
||||||
|
}
|
||||||
|
path := Keys("child", "branch", "detail")
|
||||||
|
if _, found := inspection.Metadata().Lookup(path); found {
|
||||||
|
t.Fatal("displaced descendant remained effective")
|
||||||
|
}
|
||||||
|
listed := false
|
||||||
|
for _, historical := range inspection.Metadata().HistoricalPaths() {
|
||||||
|
if historical.String() == path.String() {
|
||||||
|
listed = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !listed {
|
||||||
|
t.Fatal("displaced inherited descendant was not enumerable")
|
||||||
|
}
|
||||||
|
history := inspection.Metadata().History(path)
|
||||||
|
if len(history) < 2 || history[len(history)-1].Origin.Operation != ChangeInheritance {
|
||||||
|
t.Fatalf("displaced descendant history = %#v", history)
|
||||||
|
}
|
||||||
|
explanation, found := inspection.Explain(path)
|
||||||
|
if !found || explanation.Effective.Present {
|
||||||
|
t.Fatalf("displaced descendant explanation = %#v, %v", explanation, found)
|
||||||
|
}
|
||||||
|
var sawInherited, sawRemoval bool
|
||||||
|
for _, change := range explanation.History {
|
||||||
|
if change.Origin.Operation != ChangeInheritance {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
sawInherited = sawInherited || change.After.Present
|
||||||
|
sawRemoval = sawRemoval || (change.Before.Present && !change.After.Present)
|
||||||
|
}
|
||||||
|
if !sawInherited || !sawRemoval {
|
||||||
|
t.Fatalf("displaced value sequence = %#v", explanation.History)
|
||||||
|
}
|
||||||
|
var rendered bytes.Buffer
|
||||||
|
if err := inspection.WriteExplanation(&rendered, path); err != nil ||
|
||||||
|
!strings.Contains(rendered.String(), "structural inheritance") {
|
||||||
|
t.Fatalf("rendered structural explanation = %q, %v", rendered.String(), err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIndexedInheritanceHistoryMatchesOperationScan(t *testing.T) {
|
||||||
|
inspection, _ := inheritanceInspectionForTest(t,
|
||||||
|
parseCompositionDocument(t, "source-1", "parent: {branch: {detail: inherited, retained: present}}\n"),
|
||||||
|
parseCompositionDocument(t, "source-2", "child: {extends: parent, branch: replaced}\n"),
|
||||||
|
parseCompositionDocument(t, "source-3", "sibling: {extends: parent}\n"))
|
||||||
|
metadata := inspection.Metadata()
|
||||||
|
if len(metadata.inheritance) < 4 {
|
||||||
|
t.Fatalf("inheritance operations = %d, want multiple control and transfer scopes", len(metadata.inheritance))
|
||||||
|
}
|
||||||
|
queries := []Path{
|
||||||
|
Keys("child"),
|
||||||
|
Keys("child", inheritanceKey),
|
||||||
|
Keys("child", "branch", "detail"),
|
||||||
|
Keys("child", "branch"),
|
||||||
|
Keys("sibling", "branch", "detail"),
|
||||||
|
Path{},
|
||||||
|
}
|
||||||
|
for _, path := range queries {
|
||||||
|
if !metadata.hasHistoricalPath(path) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
stored := metadata.history[path.String()]
|
||||||
|
want := historyWithInheritance(path, stored, metadata.inheritance)
|
||||||
|
if got := metadata.History(path); !reflect.DeepEqual(got, want) {
|
||||||
|
t.Errorf("indexed history for %s differs from operation scan:\n got: %#v\nwant: %#v", path, got, want)
|
||||||
|
}
|
||||||
|
unprepared := Metadata{history: metadata.history, historicalPaths: metadata.historicalPaths, inheritance: metadata.inheritance}
|
||||||
|
if got := unprepared.History(path); !reflect.DeepEqual(got, want) {
|
||||||
|
t.Errorf("unprepared history for %s differs from operation scan:\n got: %#v\nwant: %#v", path, got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
removed := Keys("child", "branch", "detail")
|
||||||
|
first := metadata.History(removed)
|
||||||
|
if len(first) == 0 || len(first[0].Path.segments) == 0 {
|
||||||
|
t.Fatalf("removed-path history = %#v", first)
|
||||||
|
}
|
||||||
|
first[0].Path.segments[0].key = "mutated"
|
||||||
|
second := cloneMetadata(metadata).History(removed)
|
||||||
|
want := historyWithInheritance(removed, metadata.history[removed.String()], metadata.inheritance)
|
||||||
|
if !reflect.DeepEqual(second, want) {
|
||||||
|
t.Fatalf("returned history mutation affected a repeated or cloned query:\n got: %#v\nwant: %#v", second, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInheritanceHistoryPrecedesApplicationResolution(t *testing.T) {
|
||||||
|
inspection, _ := inheritanceInspectionForTest(t,
|
||||||
|
parseCompositionDocument(t, "source-1", "parent: {value: original}\nchild: {extends: parent}\n"))
|
||||||
|
path := Keys("child", "value")
|
||||||
|
replacement := &document.Node{Kind: document.String, Text: "derived"}
|
||||||
|
snapshot := resolutionSnapshot{
|
||||||
|
change: Change{Path: path, Origin: Origin{Layer: LayerResolution, Operation: ChangeNormalization}},
|
||||||
|
after: replacement,
|
||||||
|
}
|
||||||
|
final := document.Clone(inspection.final)
|
||||||
|
replaceHistoryPath(&final, path, replacement)
|
||||||
|
inspection.final = final
|
||||||
|
inspection.resolution = []resolutionSnapshot{snapshot}
|
||||||
|
inspection.resolutionReplay = coalescedResolutionSnapshots(inspection.resolution)
|
||||||
|
inspection.metadata.history[path.String()] = append(inspection.metadata.history[path.String()], snapshot.change)
|
||||||
|
inspection.metadata.fields[path.String()] = FieldInfo{Explicit: true, Origin: snapshot.change.Origin}
|
||||||
|
history := inspection.Metadata().History(path)
|
||||||
|
if len(history) < 2 || history[len(history)-2].Origin.Operation != ChangeInheritance ||
|
||||||
|
history[len(history)-1].Origin.Operation != ChangeNormalization {
|
||||||
|
t.Fatalf("resolution order = %#v", history)
|
||||||
|
}
|
||||||
|
explanation, found := inspection.Explain(path)
|
||||||
|
if !found || explanation.Effective.YAML != "derived\n" ||
|
||||||
|
explanation.History[len(explanation.History)-1].Origin.Operation != ChangeNormalization {
|
||||||
|
t.Fatalf("resolved explanation = %#v, %v", explanation, found)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHistoryNodeBudgetCountsSharedInheritanceEvidenceOnce(t *testing.T) {
|
||||||
|
shared := &document.Node{Kind: document.String, Text: "shared"}
|
||||||
|
extra := &document.Node{Kind: document.String, Text: "extra"}
|
||||||
|
expansion := &inheritanceScope{
|
||||||
|
root: shared,
|
||||||
|
operations: []inheritanceOperation{{parent: shared, effective: shared}},
|
||||||
|
replacements: []inheritanceReplacement{{before: shared, after: extra}},
|
||||||
|
}
|
||||||
|
if !historyNodesWithin(2, nil, nil, nil, nil, nil, expansion) ||
|
||||||
|
historyNodesWithin(1, nil, nil, nil, nil, nil, expansion) {
|
||||||
|
t.Fatal("shared evidence node accounting is incorrect")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInheritanceExpansionEnforcesRetainedHistoryBudget(t *testing.T) {
|
||||||
|
input := parseCompositionDocument(t, "source-1", "parent: {value: original}\nchild: {extends: parent, value: replacement}\n")
|
||||||
|
if _, diagnostics := expandInheritanceWithBudgets(input, nil, defaultProjectionLimits(), 2); len(diagnostics) != 1 || diagnostics[0].Code != CodeExplainLimitExceeded {
|
||||||
|
t.Fatalf("retained history limit = %#v", diagnostics)
|
||||||
|
}
|
||||||
|
if _, diagnostics := expandInheritanceWithBudgets(input, nil, defaultProjectionLimits(), 100); len(diagnostics) != 0 {
|
||||||
|
t.Fatalf("sufficient retained history budget = %#v", diagnostics)
|
||||||
|
}
|
||||||
|
}
|
||||||
67
internal/engine/inheritance_load.go
Normal file
67
internal/engine/inheritance_load.go
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import "gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
||||||
|
|
||||||
|
func containsInheritanceDirective(root *document.Node) bool {
|
||||||
|
var visit func(*document.Node) bool
|
||||||
|
visit = func(node *document.Node) bool {
|
||||||
|
if node == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
switch node.Kind {
|
||||||
|
case document.Mapping:
|
||||||
|
for _, entry := range node.Mapping {
|
||||||
|
if entry.Key == inheritanceKey || visit(entry.Value) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case document.Sequence:
|
||||||
|
for _, child := range node.Sequence {
|
||||||
|
if visit(child) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return visit(root)
|
||||||
|
}
|
||||||
|
|
||||||
|
func inheritanceVersionDiagnostic(rule *VersionRule, expanded *inheritanceScope) *Diagnostic {
|
||||||
|
if rule == nil || expanded == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
for _, operation := range expanded.operations {
|
||||||
|
var location Location
|
||||||
|
var affected bool
|
||||||
|
if operation.control != nil {
|
||||||
|
affected = pathsIntersect(operation.control.path, rule.Path)
|
||||||
|
if len(operation.control.locations) != 0 {
|
||||||
|
location = operation.control.locations[0]
|
||||||
|
}
|
||||||
|
} else if operation.transfer != nil {
|
||||||
|
if relative, within := relativeHistoryPath(operation.transfer.to, rule.Path); within {
|
||||||
|
_, affected = documentAtPath(operation.parent, relative)
|
||||||
|
} else if pathContains(rule.Path, operation.transfer.to) {
|
||||||
|
affected = true
|
||||||
|
}
|
||||||
|
if len(operation.transfer.locations) != 0 {
|
||||||
|
location = operation.transfer.locations[0]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if affected {
|
||||||
|
return &Diagnostic{
|
||||||
|
Code: CodeInheritanceVersion, Severity: SeverityError, Path: rule.Path.clone(),
|
||||||
|
Message: "inheritance cannot change the schema-version path", Primary: &location,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func inheritanceOperations(expanded *inheritanceScope) []inheritanceOperation {
|
||||||
|
if expanded == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return expanded.operations
|
||||||
|
}
|
||||||
158
internal/engine/inheritance_origin.go
Normal file
158
internal/engine/inheritance_origin.go
Normal file
@@ -0,0 +1,158 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"slices"
|
||||||
|
"strconv"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
||||||
|
)
|
||||||
|
|
||||||
|
func directInheritanceOrigins(node *document.Node, root Path, input map[string]Origin) map[string]Origin {
|
||||||
|
result := make(map[string]Origin)
|
||||||
|
walkDocument(node, root, func(path Path, value *document.Node) {
|
||||||
|
origin, found := input[path.String()]
|
||||||
|
if !found {
|
||||||
|
origin = Origin{Layer: LayerBase, Locations: []Location{publicLocation(value.Location)}}
|
||||||
|
}
|
||||||
|
origin = cloneOrigin(origin)
|
||||||
|
if len(origin.contributors) == 0 {
|
||||||
|
origin.contributors = make([]inheritanceContributor, len(origin.Locations))
|
||||||
|
for index, location := range origin.Locations {
|
||||||
|
origin.contributors[index] = inheritanceContributor{
|
||||||
|
source: path.clone(), location: location,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
result[path.String()] = origin
|
||||||
|
})
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
func transferredInheritanceOrigins(parent map[string]Origin, from, to Path, control inheritanceTransfer) map[string]Origin {
|
||||||
|
result := make(map[string]Origin, len(parent))
|
||||||
|
transfer := control // one immutable edge shared by every matching contributor
|
||||||
|
links := make(map[*inheritanceTrace]*inheritanceTrace)
|
||||||
|
for pointer, origin := range parent {
|
||||||
|
path, err := ParsePath(pointer)
|
||||||
|
if err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
relative, ok := relativeHistoryPath(from, path)
|
||||||
|
if !ok {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
destination := appendInheritancePath(to, relative)
|
||||||
|
origin = cloneOrigin(origin)
|
||||||
|
for index, contributor := range origin.contributors {
|
||||||
|
link, found := links[contributor.trace]
|
||||||
|
if !found {
|
||||||
|
link = &inheritanceTrace{previous: contributor.trace, transfer: &transfer}
|
||||||
|
links[contributor.trace] = link
|
||||||
|
}
|
||||||
|
origin.contributors[index].trace = link
|
||||||
|
}
|
||||||
|
result[destination.String()] = origin
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
func appendInheritancePath(root, relative Path) Path {
|
||||||
|
return Path{segments: append(clonePathSegments(root.segments, len(relative.segments)), relative.segments...)}
|
||||||
|
}
|
||||||
|
|
||||||
|
func mergeInheritanceOrigin(origins map[string]Origin, path Path, incoming Origin) {
|
||||||
|
pointer := path.String()
|
||||||
|
current := origins[pointer]
|
||||||
|
current.Layer = incoming.Layer
|
||||||
|
current.Locations = append(current.Locations, incoming.Locations...)
|
||||||
|
current.contributors = append(current.contributors, incoming.contributors...)
|
||||||
|
origins[pointer] = current
|
||||||
|
}
|
||||||
|
|
||||||
|
func copyInheritanceSubtree(target, incoming map[string]Origin, node *document.Node, root Path) {
|
||||||
|
walkDocument(node, root, func(path Path, _ *document.Node) {
|
||||||
|
target[path.String()] = cloneOrigin(incoming[path.String()])
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
type inheritanceStepKey struct {
|
||||||
|
from string
|
||||||
|
to string
|
||||||
|
reference string
|
||||||
|
locations string
|
||||||
|
}
|
||||||
|
|
||||||
|
func inheritanceStepKeyForPaths(from, to, reference Path, locations []Location) inheritanceStepKey {
|
||||||
|
return inheritanceStepKey{
|
||||||
|
from: from.String(), to: to.String(), reference: reference.String(),
|
||||||
|
locations: inheritanceLocationsKey(locations),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func inheritanceLocationsKey(locations []Location) string {
|
||||||
|
encoded := strconv.AppendInt(nil, int64(len(locations)), 10)
|
||||||
|
encoded = append(encoded, ';')
|
||||||
|
for _, location := range locations {
|
||||||
|
encoded = strconv.AppendInt(encoded, int64(len(location.SourceID)), 10)
|
||||||
|
encoded = append(encoded, ':')
|
||||||
|
encoded = append(encoded, location.SourceID...)
|
||||||
|
encoded = append(encoded, ';')
|
||||||
|
encoded = strconv.AppendInt(encoded, int64(location.Line), 10)
|
||||||
|
encoded = append(encoded, ';')
|
||||||
|
encoded = strconv.AppendInt(encoded, int64(location.Column), 10)
|
||||||
|
encoded = append(encoded, ';')
|
||||||
|
}
|
||||||
|
return string(encoded)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Materialize concrete steps only for an inspection record. The linked private
|
||||||
|
// traces remain compact when one parent supplies many descendant values.
|
||||||
|
func projectInheritanceSteps(origin Origin) []InheritanceStep {
|
||||||
|
steps := cloneInheritanceSteps(origin.Inheritance)
|
||||||
|
seen := make(map[inheritanceStepKey]struct{}, len(steps))
|
||||||
|
for _, step := range steps {
|
||||||
|
seen[inheritanceStepKeyForPaths(step.From, step.To, step.Reference, step.Locations)] = struct{}{}
|
||||||
|
}
|
||||||
|
for _, contributor := range origin.contributors {
|
||||||
|
var reverse []*inheritanceTrace
|
||||||
|
for link := contributor.trace; link != nil; link = link.previous {
|
||||||
|
reverse = append(reverse, link)
|
||||||
|
}
|
||||||
|
current := contributor.source
|
||||||
|
for index := len(reverse) - 1; index >= 0; index-- {
|
||||||
|
transfer := reverse[index].transfer
|
||||||
|
relative, ok := relativeHistoryPath(transfer.from, current)
|
||||||
|
if !ok {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
next := appendInheritancePath(transfer.to, relative)
|
||||||
|
key := inheritanceStepKeyForPaths(current, next, transfer.reference, transfer.locations)
|
||||||
|
if _, found := seen[key]; !found {
|
||||||
|
seen[key] = struct{}{}
|
||||||
|
steps = append(steps, InheritanceStep{
|
||||||
|
From: current.clone(), To: next.clone(), Reference: transfer.reference.clone(),
|
||||||
|
Locations: cloneLocations(transfer.locations),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
current = next
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return steps
|
||||||
|
}
|
||||||
|
|
||||||
|
func sameInheritanceTrace(left, right *inheritanceTrace) bool {
|
||||||
|
for left != nil && right != nil {
|
||||||
|
if left == right {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
l, r := left.transfer, right.transfer
|
||||||
|
if !slices.Equal(l.from.segments, r.from.segments) ||
|
||||||
|
!slices.Equal(l.to.segments, r.to.segments) ||
|
||||||
|
!slices.Equal(l.reference.segments, r.reference.segments) ||
|
||||||
|
!slices.Equal(l.locations, r.locations) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
left, right = left.previous, right.previous
|
||||||
|
}
|
||||||
|
return left == nil && right == nil
|
||||||
|
}
|
||||||
302
internal/engine/inheritance_origin_test.go
Normal file
302
internal/engine/inheritance_origin_test.go
Normal file
@@ -0,0 +1,302 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io/fs"
|
||||||
|
"reflect"
|
||||||
|
"slices"
|
||||||
|
"testing"
|
||||||
|
"testing/fstest"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestInheritedOriginsKeepSourcePathsPresenceAndIndependentReplacement(t *testing.T) {
|
||||||
|
parent := parseCompositionDocument(t, "source-1", `parent:
|
||||||
|
enabled: false
|
||||||
|
count: 0
|
||||||
|
optional: null
|
||||||
|
items: [{file: message.txt}]
|
||||||
|
settings: {shared: parent}
|
||||||
|
`)
|
||||||
|
child := parseCompositionDocument(t, "source-2", `child:
|
||||||
|
extends: parent
|
||||||
|
count: 3
|
||||||
|
settings: {own: child}
|
||||||
|
`)
|
||||||
|
composed, diagnostics := composeDocuments(parent, child)
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
result, diagnostics := expandInheritanceWithOrigins(composed.root, composed.origins, defaultProjectionLimits())
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
for _, key := range []string{"enabled", "optional"} {
|
||||||
|
path := Keys("child", key)
|
||||||
|
value, found := documentAtPath(result.root, path)
|
||||||
|
origin, hasOrigin := result.origins[path.String()]
|
||||||
|
if !found || !hasOrigin || value == nil || len(origin.Locations) != 1 || origin.Locations[0].SourceID != "source-1" ||
|
||||||
|
len(projectInheritanceSteps(origin)) != 1 {
|
||||||
|
t.Fatalf("inherited %s = %#v, %#v", key, value, origin)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
count := result.origins["/child/count"]
|
||||||
|
if len(count.Locations) != 1 || count.Locations[0].SourceID != "source-2" || len(projectInheritanceSteps(count)) != 0 {
|
||||||
|
t.Fatalf("direct replacement origin = %#v", count)
|
||||||
|
}
|
||||||
|
if len(result.replacements) != 1 || result.replacements[0].path.String() != "/child/count" ||
|
||||||
|
result.replacements[0].before.Text != "0" || result.replacements[0].after.Text != "3" ||
|
||||||
|
len(result.replacements[0].previous) != 1 ||
|
||||||
|
len(projectInheritanceSteps(result.replacements[0].previous[0].origin)) != 1 {
|
||||||
|
t.Fatalf("displaced inheritance = %#v", result.replacements)
|
||||||
|
}
|
||||||
|
settings := result.origins["/child/settings"]
|
||||||
|
if len(settings.Locations) != 2 || settings.Locations[0].SourceID != "source-1" ||
|
||||||
|
settings.Locations[1].SourceID != "source-2" || len(projectInheritanceSteps(settings)) != 1 {
|
||||||
|
t.Fatalf("composite mapping origin = %#v", settings)
|
||||||
|
}
|
||||||
|
if originContainedBy(result.origins["/child/enabled"], result.origins["/parent/enabled"]) ||
|
||||||
|
originContainedBy(result.origins["/parent/enabled"], result.origins["/child/enabled"]) {
|
||||||
|
t.Fatal("direct and inherited evidence collapsed despite matching source coordinates")
|
||||||
|
}
|
||||||
|
original := result.origins["/child/enabled"]
|
||||||
|
detached := cloneOrigin(original)
|
||||||
|
detached.Locations[0].SourceID = "changed"
|
||||||
|
detached.contributors[0].source.segments[0].key = "changed"
|
||||||
|
stepsCopy := projectInheritanceSteps(original)
|
||||||
|
stepsCopy[0].Locations[0].SourceID = "changed"
|
||||||
|
if original.Locations[0].SourceID != "source-1" ||
|
||||||
|
original.contributors[0].source.String() != "/parent/enabled" ||
|
||||||
|
projectInheritanceSteps(original)[0].Locations[0].SourceID != "source-2" {
|
||||||
|
t.Fatal("cloned origin or projected steps changed retained evidence")
|
||||||
|
}
|
||||||
|
resource := result.origins["/child/items/0/file"]
|
||||||
|
steps := projectInheritanceSteps(resource)
|
||||||
|
if len(steps) != 1 || steps[0].From.String() != "/parent/items/0/file" ||
|
||||||
|
steps[0].To.String() != "/child/items/0/file" || steps[0].Reference.String() != "/child/extends" ||
|
||||||
|
len(resource.Locations) != 1 || resource.Locations[0].SourceID != "source-1" {
|
||||||
|
t.Fatalf("sequence resource origin = %#v, steps = %#v", resource, steps)
|
||||||
|
}
|
||||||
|
contexts := map[string]fs.FS{
|
||||||
|
"source-1": fstest.MapFS{"message.txt": &fstest.MapFile{Data: []byte("from parent")}},
|
||||||
|
"source-2": fstest.MapFS{"message.txt": &fstest.MapFile{Data: []byte("from child")}},
|
||||||
|
}
|
||||||
|
data, err := fs.ReadFile(contexts[resource.Locations[0].SourceID], "message.txt")
|
||||||
|
if err != nil || string(data) != "from parent" {
|
||||||
|
t.Fatalf("inherited resource = %q, %v", data, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestOriginMembershipPreservesLocationAndSourceCoverageRules(t *testing.T) {
|
||||||
|
location := Location{SourceID: "source", Line: 4, Column: 2}
|
||||||
|
otherCoordinates := location
|
||||||
|
otherCoordinates.Line++
|
||||||
|
|
||||||
|
container := Origin{
|
||||||
|
Layer: LayerOverlay,
|
||||||
|
Operation: ChangeNormalization,
|
||||||
|
Locations: []Location{location},
|
||||||
|
}
|
||||||
|
if !originContainedBy(container, container) {
|
||||||
|
t.Fatal("identical location evidence was not contained")
|
||||||
|
}
|
||||||
|
coordinateDifference := container
|
||||||
|
coordinateDifference.Locations = []Location{otherCoordinates}
|
||||||
|
if originContainedBy(coordinateDifference, container) {
|
||||||
|
t.Fatal("location containment ignored differing coordinates")
|
||||||
|
}
|
||||||
|
|
||||||
|
parent := Keys("parent")
|
||||||
|
child := parent.Key("child")
|
||||||
|
change := Change{Path: parent, Origin: container}
|
||||||
|
descendantOrigin := Origin{
|
||||||
|
Layer: container.Layer,
|
||||||
|
Operation: container.Operation,
|
||||||
|
Locations: []Location{otherCoordinates},
|
||||||
|
}
|
||||||
|
if !originRepresentedByChange(child, descendantOrigin, change) {
|
||||||
|
t.Fatal("descendant source coverage rejected matching SourceID with different coordinates")
|
||||||
|
}
|
||||||
|
descendantOrigin.Locations[0].SourceID = "another-source"
|
||||||
|
if originRepresentedByChange(child, descendantOrigin, change) {
|
||||||
|
t.Fatal("descendant source coverage accepted an unrecorded SourceID")
|
||||||
|
}
|
||||||
|
|
||||||
|
withContributor := container
|
||||||
|
withContributor.contributors = []inheritanceContributor{{source: parent, location: location}}
|
||||||
|
if originContainedBy(withContributor, container) {
|
||||||
|
t.Fatal("exact location containment ignored the contributor-empty mismatch")
|
||||||
|
}
|
||||||
|
if !originRepresentedByChange(child, withContributor, change) {
|
||||||
|
t.Fatal("descendant source coverage was conflated with contributor containment")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProjectedInheritanceStepsMatchScanAndRetainOwnership(t *testing.T) {
|
||||||
|
sourcePath := Keys("source", "a/b", "01")
|
||||||
|
firstLocations := []Location{{SourceID: "first;:source", Line: -1, Column: 2}}
|
||||||
|
secondLocations := []Location{
|
||||||
|
{SourceID: "second:;source", Line: 3, Column: -4},
|
||||||
|
{SourceID: "", Line: -5, Column: 6},
|
||||||
|
}
|
||||||
|
firstTransfer := inheritanceTransfer{
|
||||||
|
from: Keys("source"), to: Keys("middle"), reference: Keys("middle", "extends"), locations: firstLocations,
|
||||||
|
}
|
||||||
|
secondTransfer := inheritanceTransfer{
|
||||||
|
from: Keys("middle"), to: Keys("target"), reference: Keys("target", "extends"), locations: secondLocations,
|
||||||
|
}
|
||||||
|
firstTrace := &inheritanceTrace{transfer: &firstTransfer}
|
||||||
|
chain := &inheritanceTrace{previous: firstTrace, transfer: &secondTransfer}
|
||||||
|
firstStep := InheritanceStep{
|
||||||
|
From: sourcePath, To: Keys("middle", "a/b", "01"), Reference: firstTransfer.reference, Locations: firstLocations,
|
||||||
|
}
|
||||||
|
|
||||||
|
duplicateFirstTransfer := firstTransfer
|
||||||
|
duplicateSecondTransfer := secondTransfer
|
||||||
|
duplicateChain := &inheritanceTrace{
|
||||||
|
previous: &inheritanceTrace{transfer: &duplicateFirstTransfer},
|
||||||
|
transfer: &duplicateSecondTransfer,
|
||||||
|
}
|
||||||
|
reversedLocations := []Location{secondLocations[1], secondLocations[0]}
|
||||||
|
reorderedSecondTransfer := secondTransfer
|
||||||
|
reorderedSecondTransfer.locations = reversedLocations
|
||||||
|
reorderedChain := &inheritanceTrace{
|
||||||
|
previous: &inheritanceTrace{transfer: &duplicateFirstTransfer},
|
||||||
|
transfer: &reorderedSecondTransfer,
|
||||||
|
}
|
||||||
|
origin := Origin{
|
||||||
|
Inheritance: []InheritanceStep{firstStep, firstStep},
|
||||||
|
contributors: []inheritanceContributor{
|
||||||
|
{source: sourcePath, trace: chain},
|
||||||
|
{source: sourcePath, trace: duplicateChain},
|
||||||
|
{source: sourcePath, trace: reorderedChain},
|
||||||
|
{source: sourcePath, trace: chain},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
want := projectInheritanceStepsByScan(origin)
|
||||||
|
got := projectInheritanceSteps(origin)
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Fatalf("projected steps differ from ordered scan:\n got: %#v\nwant: %#v", got, want)
|
||||||
|
}
|
||||||
|
if len(got) != 4 || got[0].From.String() != "/source/a~1b/01" || got[0].To.String() != "/middle/a~1b/01" ||
|
||||||
|
!reflect.DeepEqual(got[0], got[1]) || got[2].To.String() != "/target/a~1b/01" ||
|
||||||
|
!reflect.DeepEqual(got[2].Locations, secondLocations) || !reflect.DeepEqual(got[3].Locations, reversedLocations) {
|
||||||
|
t.Fatalf("unexpected duplicate/order/escape projection: %#v", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
got[0].From.segments[0].key = "mutated"
|
||||||
|
got[2].Locations[0].SourceID = "mutated"
|
||||||
|
if repeated := projectInheritanceSteps(origin); !reflect.DeepEqual(repeated, want) {
|
||||||
|
t.Fatalf("returned steps mutated retained evidence:\n got: %#v\nwant: %#v", repeated, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInheritanceLocationsKeyEncodesOrderedLengthPrefixedValues(t *testing.T) {
|
||||||
|
if inheritanceLocationsKey(nil) != inheritanceLocationsKey([]Location{}) {
|
||||||
|
t.Fatal("nil and empty location lists should encode equally")
|
||||||
|
}
|
||||||
|
values := [][]Location{
|
||||||
|
{{SourceID: "a;1;-2;", Line: -3, Column: 4}},
|
||||||
|
{{SourceID: "a", Line: 1, Column: -2}, {SourceID: ";1;-2;", Line: -3, Column: 4}},
|
||||||
|
{{SourceID: ";1;-2;", Line: -3, Column: 4}, {SourceID: "a", Line: 1, Column: -2}},
|
||||||
|
{{SourceID: "é", Line: -3, Column: 4}},
|
||||||
|
{{SourceID: "e", Line: -3, Column: 4}},
|
||||||
|
}
|
||||||
|
keys := make(map[string]int, len(values))
|
||||||
|
for index, locations := range values {
|
||||||
|
key := inheritanceLocationsKey(locations)
|
||||||
|
if previous, found := keys[key]; found {
|
||||||
|
t.Fatalf("location lists %d and %d encoded identically", previous, index)
|
||||||
|
}
|
||||||
|
keys[key] = index
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func projectInheritanceStepsByScan(origin Origin) []InheritanceStep {
|
||||||
|
steps := cloneInheritanceSteps(origin.Inheritance)
|
||||||
|
for _, contributor := range origin.contributors {
|
||||||
|
var reverse []*inheritanceTrace
|
||||||
|
for link := contributor.trace; link != nil; link = link.previous {
|
||||||
|
reverse = append(reverse, link)
|
||||||
|
}
|
||||||
|
current := contributor.source
|
||||||
|
for index := len(reverse) - 1; index >= 0; index-- {
|
||||||
|
transfer := reverse[index].transfer
|
||||||
|
relative, ok := relativeHistoryPath(transfer.from, current)
|
||||||
|
if !ok {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
next := appendInheritancePath(transfer.to, relative)
|
||||||
|
step := InheritanceStep{
|
||||||
|
From: current.clone(), To: next.clone(), Reference: transfer.reference.clone(),
|
||||||
|
Locations: cloneLocations(transfer.locations),
|
||||||
|
}
|
||||||
|
if !slices.ContainsFunc(steps, func(existing InheritanceStep) bool {
|
||||||
|
return existing.From.String() == step.From.String() &&
|
||||||
|
existing.To.String() == step.To.String() &&
|
||||||
|
existing.Reference.String() == step.Reference.String() &&
|
||||||
|
slices.Equal(existing.Locations, step.Locations)
|
||||||
|
}) {
|
||||||
|
steps = append(steps, step)
|
||||||
|
}
|
||||||
|
current = next
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return steps
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInheritedOriginsRetainChainsAndNestedDestinations(t *testing.T) {
|
||||||
|
first := parseCompositionDocument(t, "source-1", `first:
|
||||||
|
enabled: false
|
||||||
|
settings:
|
||||||
|
primary: {value: original}
|
||||||
|
secondary: {extends: primary}
|
||||||
|
`)
|
||||||
|
second := parseCompositionDocument(t, "source-2", `first: {other: present}
|
||||||
|
middle: {extends: first}
|
||||||
|
last:
|
||||||
|
extends: middle
|
||||||
|
settings:
|
||||||
|
primary: {value: replaced}
|
||||||
|
`)
|
||||||
|
composed, diagnostics := composeDocuments(first, second)
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
result, diagnostics := expandInheritanceWithOrigins(composed.root, composed.origins, defaultProjectionLimits())
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
chain := projectInheritanceSteps(result.origins["/last/enabled"])
|
||||||
|
if len(chain) != 2 || chain[0].From.String() != "/first/enabled" ||
|
||||||
|
chain[0].To.String() != "/middle/enabled" || chain[1].From.String() != "/middle/enabled" ||
|
||||||
|
chain[1].To.String() != "/last/enabled" {
|
||||||
|
t.Fatalf("chain = %#v", chain)
|
||||||
|
}
|
||||||
|
composite := result.origins["/last"]
|
||||||
|
if len(composite.Locations) < 2 || len(composite.contributors) != len(composite.Locations) {
|
||||||
|
t.Fatalf("composite contributors = %#v", composite)
|
||||||
|
}
|
||||||
|
seenSources := make(map[string]bool)
|
||||||
|
for _, contributor := range composite.contributors {
|
||||||
|
seenSources[contributor.location.SourceID] = true
|
||||||
|
}
|
||||||
|
if !seenSources["source-1"] || !seenSources["source-2"] {
|
||||||
|
t.Fatalf("same-layer source contributors = %#v", composite.contributors)
|
||||||
|
}
|
||||||
|
nested := projectInheritanceSteps(result.origins["/last/settings/secondary/value"])
|
||||||
|
if len(nested) != 1 || nested[0].From.String() != "/last/settings/primary/value" ||
|
||||||
|
nested[0].To.String() != "/last/settings/secondary/value" {
|
||||||
|
t.Fatalf("destination-specific nested transfer = %#v", nested)
|
||||||
|
}
|
||||||
|
if got := result.origins["/last/settings/secondary/value"].Locations[0].SourceID; got != "source-2" {
|
||||||
|
t.Fatalf("nested replacement source = %q", got)
|
||||||
|
}
|
||||||
|
if original, found := documentAtPath(first, Keys("first", "settings", "primary", "value")); !found || original.Text != "original" {
|
||||||
|
t.Fatal("expansion changed its input")
|
||||||
|
}
|
||||||
|
if inherited, found := documentAtPath(result.root, Keys("last", "settings", "secondary", "value")); !found || inherited.Kind != document.String || inherited.Text != "replaced" {
|
||||||
|
t.Fatalf("nested inherited value = %#v, %v", inherited, found)
|
||||||
|
}
|
||||||
|
}
|
||||||
136
internal/engine/inheritance_secret_test.go
Normal file
136
internal/engine/inheritance_secret_test.go
Normal file
@@ -0,0 +1,136 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestInheritanceSensitivityFollowsCopiesWithoutMaskingNeighbors(t *testing.T) {
|
||||||
|
const canary = "INHERITED-CANARY-CREDENTIAL"
|
||||||
|
input := parseCompositionDocument(t, "source-1", "parent: {token: "+canary+", plain: visible}\nchild: {extends: parent}\nnext: {extends: child}\nother: {extends: parent}\n")
|
||||||
|
for _, classified := range []Path{Keys("parent", "token"), Keys("next", "token")} {
|
||||||
|
t.Run(classified.String(), func(t *testing.T) {
|
||||||
|
inspection, _ := inheritanceInspectionForTest(t, input)
|
||||||
|
inspection.secrets = classifySecretPaths(nil, func(path Path) bool {
|
||||||
|
return path.String() == classified.String()
|
||||||
|
}, inspection.metadata, inspection.final, inspection.applications, inspection.input)
|
||||||
|
for _, path := range []Path{Keys("parent", "token"), Keys("child", "token"), Keys("next", "token"), Keys("other", "token")} {
|
||||||
|
explanation, found := inspection.Explain(path)
|
||||||
|
if !found || !explanation.Effective.Redacted || strings.Contains(explanation.Effective.YAML, canary) {
|
||||||
|
t.Fatalf("sensitive copy %s = %#v, %v", path, explanation, found)
|
||||||
|
}
|
||||||
|
for _, change := range explanation.History {
|
||||||
|
if strings.Contains(change.Before.YAML, canary) || strings.Contains(change.After.YAML, canary) {
|
||||||
|
t.Fatalf("historical canary at %s: %#v", path, change)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
plain, found := inspection.Explain(Keys("other", "plain"))
|
||||||
|
if !found || plain.Effective.Redacted || plain.Effective.YAML != "visible\n" {
|
||||||
|
t.Fatalf("unrelated field = %#v, %v", plain, found)
|
||||||
|
}
|
||||||
|
var output bytes.Buffer
|
||||||
|
if err := inspection.WriteEffective(&output); err != nil || strings.Contains(output.String(), canary) || !strings.Contains(output.String(), "visible") {
|
||||||
|
t.Fatalf("effective rendering = %q, %v", output.String(), err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInheritanceSensitivityPreservesDisplacedHistoryAndControl(t *testing.T) {
|
||||||
|
const canary = "DISPLACED-CANARY-CREDENTIAL"
|
||||||
|
inspection, _ := inheritanceInspectionForTest(t, parseCompositionDocument(t, "source-1", "parent: {branch: {token: "+canary+"}}\nchild: {extends: parent, branch: public}\n"))
|
||||||
|
inspection.secrets = classifySecretPaths(nil, func(path Path) bool {
|
||||||
|
return path.String() == Keys("parent", "branch", "token").String() || path.String() == Keys("child", inheritanceKey).String()
|
||||||
|
}, inspection.metadata, inspection.final, inspection.applications, inspection.input)
|
||||||
|
path := Keys("child", "branch", "token")
|
||||||
|
explanation, found := inspection.Explain(path)
|
||||||
|
if !found || explanation.Effective.Present {
|
||||||
|
t.Fatalf("displaced sensitive path = %#v, %v", explanation, found)
|
||||||
|
}
|
||||||
|
for _, change := range explanation.History {
|
||||||
|
if strings.Contains(change.Before.YAML, canary) || strings.Contains(change.After.YAML, canary) ||
|
||||||
|
(change.After.Present && !change.After.Redacted) {
|
||||||
|
t.Fatalf("displaced secret leaked: %#v", explanation.History)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var rendered bytes.Buffer
|
||||||
|
if err := inspection.WriteExplanation(&rendered, path); err != nil || strings.Contains(rendered.String(), canary) {
|
||||||
|
t.Fatalf("displaced explanation rendering = %q, %v", rendered.String(), err)
|
||||||
|
}
|
||||||
|
control, found := inspection.Explain(Keys("child", inheritanceKey))
|
||||||
|
if !found || control.Effective.Present || len(control.History) == 0 || !control.History[0].After.Redacted {
|
||||||
|
t.Fatalf("sensitive control history = %#v, %v", control, found)
|
||||||
|
}
|
||||||
|
info, found := inspection.Metadata().Lookup(Keys("child", "branch"))
|
||||||
|
if !found || len(info.Origin.Inheritance) != 0 {
|
||||||
|
t.Fatalf("independent replacement provenance = %#v, %v", info, found)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInheritanceSensitivityIncludesSchemaTaggedSource(t *testing.T) {
|
||||||
|
type entry struct {
|
||||||
|
Token string `yaml:"token"`
|
||||||
|
}
|
||||||
|
type configuration struct {
|
||||||
|
Parent struct {
|
||||||
|
Token string `yaml:"token" configkit:"secret"`
|
||||||
|
} `yaml:"parent"`
|
||||||
|
Child entry `yaml:"child"`
|
||||||
|
}
|
||||||
|
schema, issue := buildSchema(reflect.TypeFor[configuration](), testSecretBinding())
|
||||||
|
if issue != nil {
|
||||||
|
t.Fatal(issue)
|
||||||
|
}
|
||||||
|
inspection, _ := inheritanceInspectionForTest(t, parseCompositionDocument(t, "source-1", "parent: {token: TAGGED-CANARY}\nchild: {extends: parent}\n"))
|
||||||
|
inspection.secrets = classifySecretPaths(schema, nil, inspection.metadata, inspection.final, inspection.applications, inspection.input)
|
||||||
|
child, found := inspection.Explain(Keys("child", "token"))
|
||||||
|
if !found || !child.Effective.Redacted || strings.Contains(child.Effective.YAML, "TAGGED-CANARY") {
|
||||||
|
t.Fatalf("tagged source copy = %#v, %v", child, found)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInheritedSecretReferencesResolveOnlyAfterExpansion(t *testing.T) {
|
||||||
|
type entry struct {
|
||||||
|
Credential Secret `yaml:"credential"`
|
||||||
|
}
|
||||||
|
type configuration struct {
|
||||||
|
Entries map[string]entry `yaml:"entries"`
|
||||||
|
}
|
||||||
|
schema, issue := buildSchema(reflect.TypeFor[configuration](), testSecretBinding())
|
||||||
|
if issue != nil {
|
||||||
|
t.Fatal(issue)
|
||||||
|
}
|
||||||
|
composed, diagnostics := composeDocuments(parseCompositionDocument(t, "source-1", "entries:\n parent: {credential: INHERITED_SECRET_NAME}\n child: {extends: parent}\n"))
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
expanded, diagnostics := expandInheritanceWithOrigins(composed.root, composed.origins, defaultProjectionLimits())
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
lookupCount := 0
|
||||||
|
decoded, issues := decodeConfiguration(schema, reflect.Zero(reflect.TypeFor[configuration]()), expanded.root)
|
||||||
|
if len(issues) != 0 || lookupCount != 0 {
|
||||||
|
t.Fatalf("decoding and lookup order = %#v, %d", issues, lookupCount)
|
||||||
|
}
|
||||||
|
resolved := resolveSecretReferences(decoded.value, schema, expanded.root, func(name string) (string, bool) {
|
||||||
|
lookupCount++
|
||||||
|
if name != "INHERITED_SECRET_NAME" {
|
||||||
|
t.Fatalf("inherited reference name = %q", name)
|
||||||
|
}
|
||||||
|
return "RESOLVED-CREDENTIAL-CANARY", true
|
||||||
|
})
|
||||||
|
if len(resolved.diagnostics) != 0 || lookupCount != 1 ||
|
||||||
|
decoded.value.Interface().(configuration).Entries["child"].Credential.Value() != "RESOLVED-CREDENTIAL-CANARY" {
|
||||||
|
t.Fatalf("inherited reference resolution = %#v, %d", resolved.diagnostics, lookupCount)
|
||||||
|
}
|
||||||
|
inspection, _ := inheritanceInspectionFromComposition(t, composed)
|
||||||
|
inspection.secrets = classifySecretPaths(schema, nil, inspection.metadata, inspection.final, inspection.applications, inspection.input)
|
||||||
|
var rendered bytes.Buffer
|
||||||
|
if err := inspection.WriteEffective(&rendered); err != nil || strings.Contains(rendered.String(), "RESOLVED-CREDENTIAL-CANARY") {
|
||||||
|
t.Fatalf("reference rendering = %q, %v", rendered.String(), err)
|
||||||
|
}
|
||||||
|
}
|
||||||
159
internal/engine/inheritance_test.go
Normal file
159
internal/engine/inheritance_test.go
Normal file
@@ -0,0 +1,159 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"reflect"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestSiblingInheritanceResolvesReferencesAndKeepsInputs(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name, input string
|
||||||
|
path Path
|
||||||
|
text string
|
||||||
|
transfers int
|
||||||
|
controls int
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "forward reference", input: "child: {extends: parent, value: own}\nparent: {value: parent, kept: preserved}\n",
|
||||||
|
path: Keys("child", "kept"), text: "preserved", transfers: 1, controls: 1,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "backward reference", input: "parent: {value: parent, kept: preserved}\nchild: {extends: parent, value: own}\n",
|
||||||
|
path: Keys("child", "value"), text: "own", transfers: 1, controls: 1,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "chain and shared parent", input: "last: {extends: middle, enabled: false}\nfirst: {value: original}\nmiddle: {extends: first, extra: middle}\nother: {extends: first}\n",
|
||||||
|
path: Keys("last", "value"), text: "original", transfers: 3, controls: 3,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "exact empty sibling name", input: "child: {extends: \"\"}\n\"\": {value: empty}\n",
|
||||||
|
path: Keys("child", "value"), text: "empty", transfers: 1, controls: 1,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "exact unusual sibling name", input: "child: {extends: \"a/b~c\"}\n\"a/b~c\": {value: unusual}\n",
|
||||||
|
path: Keys("child", "value"), text: "unusual", transfers: 1, controls: 1,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "null cancellation", input: "child: {extends: null, value: own}\nparent: {value: parent}\n",
|
||||||
|
path: Keys("child", "value"), text: "own", controls: 1,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for _, test := range tests {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
input := parseCompositionDocument(t, "source-1", test.input)
|
||||||
|
before := document.Clone(input)
|
||||||
|
result, diagnostics := expandSiblingDefinitions(input, Path{})
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatalf("diagnostics = %#v", diagnostics)
|
||||||
|
}
|
||||||
|
if len(result.transfers) != test.transfers || len(result.controls) != test.controls {
|
||||||
|
t.Fatalf("evidence = %#v, %#v", result.transfers, result.controls)
|
||||||
|
}
|
||||||
|
node, found := documentAtPath(result.root, test.path)
|
||||||
|
if !found || node.Text != test.text {
|
||||||
|
t.Fatalf("%s = %#v, %v", test.path.String(), node, found)
|
||||||
|
}
|
||||||
|
if _, found := documentAtPath(result.root, Keys("child", inheritanceKey)); found {
|
||||||
|
t.Fatal("child directive remained in expanded payload")
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(input, before) {
|
||||||
|
t.Fatal("resolver changed input")
|
||||||
|
}
|
||||||
|
node.Text = "changed"
|
||||||
|
if !reflect.DeepEqual(input, before) {
|
||||||
|
t.Fatal("expanded payload aliases input")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSiblingInheritanceTracksTransferAndIndependentChildren(t *testing.T) {
|
||||||
|
input := parseCompositionDocument(t, "source-1", "first: {value: parent}\nsecond: {extends: first}\nthird: {extends: first}\n")
|
||||||
|
result, diagnostics := expandSiblingDefinitions(input, Keys("catalog"))
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
if len(result.transfers) != 2 || result.transfers[0].from.String() != "/catalog/first" ||
|
||||||
|
result.transfers[0].to.String() != "/catalog/second" ||
|
||||||
|
result.transfers[0].reference.String() != "/catalog/second/extends" ||
|
||||||
|
len(result.transfers[0].locations) != 1 || result.transfers[0].locations[0].SourceID != "source-1" {
|
||||||
|
t.Fatalf("transfers = %#v", result.transfers)
|
||||||
|
}
|
||||||
|
second, _ := documentAtPath(result.root, Keys("second", "value"))
|
||||||
|
third, _ := documentAtPath(result.root, Keys("third", "value"))
|
||||||
|
second.Text = "changed"
|
||||||
|
if third.Text != "parent" {
|
||||||
|
t.Fatal("siblings share mutable expanded values")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSiblingInheritanceRejectsInvalidRelationships(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name, input, path string
|
||||||
|
code Code
|
||||||
|
related bool
|
||||||
|
}{
|
||||||
|
{"missing", "child: {extends: private-reference-canary}\n", "/child/extends", CodeInheritanceMissing, false},
|
||||||
|
{"nonmapping parent", "child: {extends: parent}\nparent: null\n", "/child/extends", CodeInheritanceInvalid, true},
|
||||||
|
{"boolean reference", "child: {extends: true}\n", "/child/extends", CodeInheritanceInvalid, false},
|
||||||
|
{"sequence reference", "child: {extends: [parent]}\n", "/child/extends", CodeInheritanceInvalid, false},
|
||||||
|
{"self reference", "child: {extends: child}\n", "/child/extends", CodeInheritanceCycle, true},
|
||||||
|
{"longer cycle", "a: {extends: b}\nb: {extends: c}\nc: {extends: a}\n", "/c/extends", CodeInheritanceCycle, true},
|
||||||
|
}
|
||||||
|
for _, test := range tests {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
input := parseCompositionDocument(t, "source-1", test.input)
|
||||||
|
result, diagnostics := expandSiblingDefinitions(input, Path{})
|
||||||
|
if result != nil || len(diagnostics) != 1 {
|
||||||
|
t.Fatalf("result and diagnostics = %#v, %#v", result, diagnostics)
|
||||||
|
}
|
||||||
|
problem := diagnostics[0]
|
||||||
|
if problem.Code != test.code || problem.Path.String() != test.path || problem.Primary == nil ||
|
||||||
|
problem.Primary.SourceID != "source-1" || problem.Primary.Line < 1 ||
|
||||||
|
(len(problem.Related) != 0) != test.related || strings.Contains(problem.Message, "private-reference-canary") {
|
||||||
|
t.Fatalf("diagnostic = %#v", problem)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadDetectsInvalidInheritanceInsideSequence(t *testing.T) {
|
||||||
|
input := []byte(`items:
|
||||||
|
- child: {extends: true}
|
||||||
|
`)
|
||||||
|
result, err := testLoad[map[string]any](Bytes("nested-inheritance.yml", input), Options[map[string]any]{})
|
||||||
|
if result != nil || err == nil {
|
||||||
|
t.Fatalf("result, err = %#v, %v; want invalid nested inheritance", result, err)
|
||||||
|
}
|
||||||
|
loadError, ok := err.(*LoadError)
|
||||||
|
if !ok {
|
||||||
|
t.Fatalf("error type = %T, want *LoadError", err)
|
||||||
|
}
|
||||||
|
diagnostics := loadError.Diagnostics()
|
||||||
|
if len(diagnostics) != 1 || diagnostics[0].Code != CodeInheritanceInvalid || diagnostics[0].Path.String() != "/items/0/child/extends" {
|
||||||
|
t.Fatalf("diagnostics = %#v", diagnostics)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSiblingInheritanceDetectsDeepCycleWithoutRecursiveDependencyWalk(t *testing.T) {
|
||||||
|
const count = 2048
|
||||||
|
entries := make([]document.Entry, count)
|
||||||
|
for index := range entries {
|
||||||
|
location := document.Location{SourceID: "source-1", Line: index + 1, Column: 1}
|
||||||
|
parent := strconv.Itoa((index + 1) % count)
|
||||||
|
entries[index] = document.Entry{
|
||||||
|
Key: strconv.Itoa(index), Value: &document.Node{Kind: document.Mapping, Location: location,
|
||||||
|
Mapping: []document.Entry{{Key: inheritanceKey, Value: &document.Node{
|
||||||
|
Kind: document.String, Text: parent, Location: location,
|
||||||
|
}}}},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
result, diagnostics := expandSiblingDefinitions(&document.Node{Kind: document.Mapping, Mapping: entries}, Path{})
|
||||||
|
if result != nil || len(diagnostics) != 1 || diagnostics[0].Code != CodeInheritanceCycle {
|
||||||
|
t.Fatalf("deep cycle result = %#v, diagnostics = %#v", result, diagnostics)
|
||||||
|
}
|
||||||
|
}
|
||||||
309
internal/engine/inheritance_walk.go
Normal file
309
internal/engine/inheritance_walk.go
Normal file
@@ -0,0 +1,309 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"cmp"
|
||||||
|
"slices"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
||||||
|
)
|
||||||
|
|
||||||
|
type inheritanceWalker struct {
|
||||||
|
nodes int // logical non-directive nodes in the entire working tree
|
||||||
|
origins map[string]Origin
|
||||||
|
limits projectionLimits
|
||||||
|
retained *retainedNodeCounter
|
||||||
|
transfers []inheritanceTransfer
|
||||||
|
controls []inheritanceControl
|
||||||
|
replacements []inheritanceReplacement
|
||||||
|
operations []inheritanceOperation
|
||||||
|
}
|
||||||
|
|
||||||
|
// expandInheritanceTree resolves each destination scope after its enclosing
|
||||||
|
// relationships. The loading lifecycle uses the origin-aware entry point.
|
||||||
|
func expandInheritanceTree(input *document.Node, limits projectionLimits) (*inheritanceScope, []Diagnostic) {
|
||||||
|
return expandInheritanceWithOrigins(input, nil, limits)
|
||||||
|
}
|
||||||
|
|
||||||
|
func expandInheritanceWithOrigins(input *document.Node, inputOrigins map[string]Origin, limits projectionLimits) (*inheritanceScope, []Diagnostic) {
|
||||||
|
return expandInheritanceWithBudgets(input, inputOrigins, limits, historyNodeLimit)
|
||||||
|
}
|
||||||
|
|
||||||
|
func expandInheritanceWithBudgets(input *document.Node, inputOrigins map[string]Origin, limits projectionLimits, historyLimit int) (*inheritanceScope, []Diagnostic) {
|
||||||
|
if input == nil || input.Kind != document.Mapping {
|
||||||
|
return nil, []Diagnostic{{Code: CodeInheritanceInvalid, Severity: SeverityError,
|
||||||
|
Message: "inheritance requires a mapping document root"}}
|
||||||
|
}
|
||||||
|
root := document.Clone(input)
|
||||||
|
origins := cloneOriginIndex(inputOrigins)
|
||||||
|
if inputOrigins == nil {
|
||||||
|
origins = directInheritanceOrigins(input, Path{}, nil)
|
||||||
|
}
|
||||||
|
nodes, within := inheritanceLowerBoundCount(root, limits.nodes)
|
||||||
|
if !within {
|
||||||
|
return nil, []Diagnostic{inheritanceBudgetDiagnostic(Path{}, root.Location)}
|
||||||
|
}
|
||||||
|
walker := inheritanceWalker{
|
||||||
|
nodes: nodes, limits: limits, origins: origins,
|
||||||
|
retained: newRetainedNodeCounter(historyLimit),
|
||||||
|
}
|
||||||
|
if problem := walker.visit(&root, Path{}, true); problem != nil {
|
||||||
|
return nil, []Diagnostic{*problem}
|
||||||
|
}
|
||||||
|
if problem := inheritanceFinalBudget(root, limits); problem != nil {
|
||||||
|
return nil, []Diagnostic{*problem}
|
||||||
|
}
|
||||||
|
return &inheritanceScope{
|
||||||
|
root: root, origins: walker.origins, transfers: walker.transfers,
|
||||||
|
controls: walker.controls, replacements: walker.replacements, operations: walker.operations,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *inheritanceWalker) visit(node **document.Node, path Path, unscoped bool) *Diagnostic {
|
||||||
|
switch (*node).Kind {
|
||||||
|
case document.Mapping:
|
||||||
|
original := *node
|
||||||
|
if unscoped {
|
||||||
|
reference, found := inheritanceDirective(*node)
|
||||||
|
if found {
|
||||||
|
referencePath := path.Key(inheritanceKey)
|
||||||
|
location := publicLocation(reference.Value.Location)
|
||||||
|
if reference.Value.Kind != document.Null {
|
||||||
|
problem := inheritanceDiagnostic(CodeInheritanceInvalid, referencePath, location, nil,
|
||||||
|
"inheritance reference has no enclosing sibling scope")
|
||||||
|
return &problem
|
||||||
|
}
|
||||||
|
w.controls = append(w.controls, inheritanceControl{
|
||||||
|
path: referencePath, locations: []Location{location}, cancelled: true,
|
||||||
|
})
|
||||||
|
origin := directInheritanceOrigins(reference.Value, referencePath, w.origins)[referencePath.String()]
|
||||||
|
control := inheritanceControl{path: referencePath, locations: []Location{location}, cancelled: true}
|
||||||
|
w.operations = append(w.operations, inheritanceOperation{control: &control, controlOrigin: origin})
|
||||||
|
deleteOriginSubtree(w.origins, referencePath, reference.Value)
|
||||||
|
*node = withoutInheritanceDirective(*node)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if scopeHasInheritanceDefinitions(*node) {
|
||||||
|
// Only this scope can change the logical total. Reserve the nodes
|
||||||
|
// outside it so expansion checks the remaining budget before cloning.
|
||||||
|
before, _ := inheritanceLowerBoundCount(*node, -1)
|
||||||
|
limits := w.limits
|
||||||
|
if limits.nodes >= 0 {
|
||||||
|
limits.nodes -= w.nodes - before
|
||||||
|
}
|
||||||
|
resolved, diagnostics := expandSiblingDefinitionsWithOrigins(*node, path, limits, w.origins, w.retained)
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
return &diagnostics[0]
|
||||||
|
}
|
||||||
|
*node = resolved.root
|
||||||
|
deleteOriginSubtree(w.origins, path, original)
|
||||||
|
for pointer, origin := range resolved.origins {
|
||||||
|
w.origins[pointer] = origin
|
||||||
|
}
|
||||||
|
w.transfers = append(w.transfers, resolved.transfers...)
|
||||||
|
w.controls = append(w.controls, resolved.controls...)
|
||||||
|
w.replacements = append(w.replacements, resolved.replacements...)
|
||||||
|
w.operations = append(w.operations, resolved.operations...)
|
||||||
|
after, _ := inheritanceLowerBoundCount(*node, -1)
|
||||||
|
w.nodes += after - before
|
||||||
|
}
|
||||||
|
// Operations retain immutable enclosing templates. Detach just this
|
||||||
|
// container before replacing descendants during destination resolution;
|
||||||
|
// untouched subtrees remain shared with the retained evidence.
|
||||||
|
working := **node
|
||||||
|
working.Mapping = slices.Clone(working.Mapping)
|
||||||
|
*node = &working
|
||||||
|
indices := make([]int, len((*node).Mapping))
|
||||||
|
for index := range indices {
|
||||||
|
indices[index] = index
|
||||||
|
}
|
||||||
|
slices.SortFunc(indices, func(left, right int) int {
|
||||||
|
return cmp.Compare((*node).Mapping[left].Key, (*node).Mapping[right].Key)
|
||||||
|
})
|
||||||
|
for _, index := range indices {
|
||||||
|
entry := &(*node).Mapping[index]
|
||||||
|
if problem := w.visit(&entry.Value, path.Key(entry.Key), false); problem != nil {
|
||||||
|
return problem
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case document.Sequence:
|
||||||
|
working := **node
|
||||||
|
working.Sequence = slices.Clone(working.Sequence)
|
||||||
|
*node = &working
|
||||||
|
for index := range (*node).Sequence {
|
||||||
|
child := &(*node).Sequence[index]
|
||||||
|
if problem := w.visit(child, path.Index(index), (*child).Kind == document.Mapping); problem != nil {
|
||||||
|
return problem
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func scopeHasInheritanceDefinitions(scope *document.Node) bool {
|
||||||
|
for _, entry := range scope.Mapping {
|
||||||
|
if entry.Value.Kind != document.Mapping {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if _, found := inheritanceDirective(entry.Value); found {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// A directive may disappear during later destination resolution, so only
|
||||||
|
// non-directive nodes form a safe early lower bound on final output size.
|
||||||
|
func inheritanceLowerBoundWithin(root *document.Node, limit int) bool {
|
||||||
|
_, within := inheritanceLowerBoundCount(root, limit)
|
||||||
|
return within
|
||||||
|
}
|
||||||
|
|
||||||
|
func inheritanceLowerBoundCount(root *document.Node, limit int) (int, bool) {
|
||||||
|
if limit < 0 {
|
||||||
|
limit = int(^uint(0) >> 1)
|
||||||
|
}
|
||||||
|
stack := []*document.Node{root}
|
||||||
|
count := 0
|
||||||
|
for len(stack) != 0 {
|
||||||
|
node := stack[len(stack)-1]
|
||||||
|
stack = stack[:len(stack)-1]
|
||||||
|
if node == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
count++
|
||||||
|
if count > limit {
|
||||||
|
return count, false
|
||||||
|
}
|
||||||
|
switch node.Kind {
|
||||||
|
case document.Mapping:
|
||||||
|
for _, entry := range node.Mapping {
|
||||||
|
if entry.Key == inheritanceKey {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
count++ // mapping key
|
||||||
|
stack = append(stack, entry.Value)
|
||||||
|
}
|
||||||
|
case document.Sequence:
|
||||||
|
stack = append(stack, node.Sequence...)
|
||||||
|
}
|
||||||
|
if count > limit {
|
||||||
|
return count, false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return count, true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Count the materialized mapping shape before cloning a memoized parent.
|
||||||
|
// Relationship fields are excluded because later destination resolution
|
||||||
|
// consumes them; their omission makes this a safe lower bound.
|
||||||
|
func inheritanceOverlayLowerBoundWithin(lower, upper *document.Node, limit int) bool {
|
||||||
|
if limit < 0 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
index := new(mappingIndex)
|
||||||
|
count := 0
|
||||||
|
var visit func(*document.Node, *document.Node) bool
|
||||||
|
visit = func(base, incoming *document.Node) bool {
|
||||||
|
if base.Kind != document.Mapping || incoming.Kind != document.Mapping {
|
||||||
|
added, within := inheritanceLowerBoundCount(incoming, limit-count)
|
||||||
|
count += added
|
||||||
|
return within
|
||||||
|
}
|
||||||
|
count++ // mapping node
|
||||||
|
if count > limit {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
for _, entry := range base.Mapping {
|
||||||
|
if entry.Key == inheritanceKey {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
count++ // mapping key
|
||||||
|
if count > limit {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
position := index.find(incoming, entry.Key)
|
||||||
|
if position >= 0 {
|
||||||
|
if !visit(entry.Value, incoming.Mapping[position].Value) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
added, within := inheritanceLowerBoundCount(entry.Value, limit-count)
|
||||||
|
count += added
|
||||||
|
if !within {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, entry := range incoming.Mapping {
|
||||||
|
if entry.Key == inheritanceKey || index.find(base, entry.Key) >= 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
count++ // mapping key
|
||||||
|
if count > limit {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
added, within := inheritanceLowerBoundCount(entry.Value, limit-count)
|
||||||
|
count += added
|
||||||
|
if !within || count > limit {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return visit(lower, upper)
|
||||||
|
}
|
||||||
|
|
||||||
|
func inheritanceFinalBudget(root *document.Node, limits projectionLimits) *Diagnostic {
|
||||||
|
type pending struct {
|
||||||
|
node *document.Node
|
||||||
|
path Path
|
||||||
|
}
|
||||||
|
stack := []pending{{node: root}}
|
||||||
|
count := 0
|
||||||
|
for len(stack) != 0 {
|
||||||
|
item := stack[len(stack)-1]
|
||||||
|
stack = stack[:len(stack)-1]
|
||||||
|
if len(item.path.segments) > limits.depth {
|
||||||
|
problem := inheritanceBudgetDiagnostic(item.path, item.node.Location)
|
||||||
|
return &problem
|
||||||
|
}
|
||||||
|
count++
|
||||||
|
if limits.nodes >= 0 && count > limits.nodes {
|
||||||
|
problem := inheritanceBudgetDiagnostic(item.path, item.node.Location)
|
||||||
|
return &problem
|
||||||
|
}
|
||||||
|
switch item.node.Kind {
|
||||||
|
case document.Mapping:
|
||||||
|
count += len(item.node.Mapping) // mapping keys
|
||||||
|
for index := len(item.node.Mapping) - 1; index >= 0; index-- {
|
||||||
|
entry := item.node.Mapping[index]
|
||||||
|
stack = append(stack, pending{node: entry.Value, path: item.path.Key(entry.Key)})
|
||||||
|
}
|
||||||
|
case document.Sequence:
|
||||||
|
for index := len(item.node.Sequence) - 1; index >= 0; index-- {
|
||||||
|
stack = append(stack, pending{node: item.node.Sequence[index], path: item.path.Index(index)})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if limits.nodes >= 0 && count > limits.nodes {
|
||||||
|
problem := inheritanceBudgetDiagnostic(item.path, item.node.Location)
|
||||||
|
return &problem
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func inheritanceBudgetDiagnostic(path Path, location document.Location) Diagnostic {
|
||||||
|
primary := publicLocation(location)
|
||||||
|
return Diagnostic{
|
||||||
|
Code: CodeSchemaProjectionLimit, Severity: SeverityError, Path: path,
|
||||||
|
Message: "expanded configuration exceeds the projection limit", Primary: &primary,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func inheritanceHistoryBudgetDiagnostic(path Path, location document.Location) Diagnostic {
|
||||||
|
primary := publicLocation(location)
|
||||||
|
return Diagnostic{
|
||||||
|
Code: CodeExplainLimitExceeded, Severity: SeverityError, Path: path,
|
||||||
|
Message: "retained inheritance history exceeds the node limit", Primary: &primary,
|
||||||
|
}
|
||||||
|
}
|
||||||
219
internal/engine/inheritance_walk_test.go
Normal file
219
internal/engine/inheritance_walk_test.go
Normal file
@@ -0,0 +1,219 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"reflect"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestNestedInheritanceUsesEachDestinationScope(t *testing.T) {
|
||||||
|
input := parseCompositionDocument(t, "source-1", `presets:
|
||||||
|
base:
|
||||||
|
settings:
|
||||||
|
primary: {width: 10}
|
||||||
|
secondary: {extends: primary}
|
||||||
|
custom:
|
||||||
|
extends: base
|
||||||
|
settings:
|
||||||
|
primary: {width: 20}
|
||||||
|
`)
|
||||||
|
before := document.Clone(input)
|
||||||
|
result, diagnostics := expandInheritanceTree(input, defaultProjectionLimits())
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
for path, want := range map[string]string{
|
||||||
|
"/presets/base/settings/secondary/width": "10",
|
||||||
|
"/presets/custom/settings/secondary/width": "20",
|
||||||
|
} {
|
||||||
|
parsed, _ := ParsePath(path)
|
||||||
|
node, found := documentAtPath(result.root, parsed)
|
||||||
|
if !found || node.Text != want {
|
||||||
|
t.Errorf("%s = %#v, found %v", path, node, found)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(result.transfers) != 3 || !reflect.DeepEqual(input, before) {
|
||||||
|
t.Fatalf("transfers = %#v; input changed = %v", result.transfers, !reflect.DeepEqual(input, before))
|
||||||
|
}
|
||||||
|
if node, found := documentAtPath(result.root, Keys("presets", "custom", "settings", "secondary", inheritanceKey)); found {
|
||||||
|
t.Fatalf("nested directive survived: %#v", node)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNestedInheritanceSupportsChainsCancellationAndContainerReplacement(t *testing.T) {
|
||||||
|
input := parseCompositionDocument(t, "source-1", `catalog:
|
||||||
|
alpha:
|
||||||
|
settings:
|
||||||
|
first: {value: one}
|
||||||
|
second: {extends: first}
|
||||||
|
beta:
|
||||||
|
extends: alpha
|
||||||
|
settings:
|
||||||
|
first: {value: two}
|
||||||
|
gamma:
|
||||||
|
extends: beta
|
||||||
|
settings:
|
||||||
|
first: {value: three}
|
||||||
|
cancelled:
|
||||||
|
extends: alpha
|
||||||
|
settings:
|
||||||
|
second: {extends: null, value: own}
|
||||||
|
replaced:
|
||||||
|
extends: alpha
|
||||||
|
settings: none
|
||||||
|
`)
|
||||||
|
result, diagnostics := expandInheritanceTree(input, defaultProjectionLimits())
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
checks := map[string]string{
|
||||||
|
"/catalog/alpha/settings/second/value": "one",
|
||||||
|
"/catalog/beta/settings/second/value": "two",
|
||||||
|
"/catalog/gamma/settings/second/value": "three",
|
||||||
|
"/catalog/cancelled/settings/second/value": "own",
|
||||||
|
"/catalog/replaced/settings": "none",
|
||||||
|
}
|
||||||
|
for pointer, want := range checks {
|
||||||
|
path, _ := ParsePath(pointer)
|
||||||
|
node, found := documentAtPath(result.root, path)
|
||||||
|
if !found || node.Text != want {
|
||||||
|
t.Errorf("%s = %#v, found %v", pointer, node, found)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, found := documentAtPath(result.root, Keys("catalog", "replaced", "settings", "second")); found {
|
||||||
|
t.Fatal("replaced container retained an active child")
|
||||||
|
}
|
||||||
|
if _, found := documentAtPath(result.root, Keys("catalog", "cancelled", "settings", "second", inheritanceKey)); found {
|
||||||
|
t.Fatal("cancelled nested directive survived")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNestedInheritanceCanReplaceAnInheritedRelationship(t *testing.T) {
|
||||||
|
input := parseCompositionDocument(t, "source-1", `base:
|
||||||
|
settings:
|
||||||
|
first: {value: old}
|
||||||
|
other: {value: new}
|
||||||
|
selected: {extends: first}
|
||||||
|
custom:
|
||||||
|
extends: base
|
||||||
|
settings:
|
||||||
|
selected: {extends: other}
|
||||||
|
`)
|
||||||
|
result, diagnostics := expandInheritanceTree(input, defaultProjectionLimits())
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
base, found := documentAtPath(result.root, Keys("base", "settings", "selected", "value"))
|
||||||
|
if !found || base.Text != "old" {
|
||||||
|
t.Fatalf("base relationship = %#v, %v", base, found)
|
||||||
|
}
|
||||||
|
custom, found := documentAtPath(result.root, Keys("custom", "settings", "selected", "value"))
|
||||||
|
if !found || custom.Text != "new" {
|
||||||
|
t.Fatalf("replaced relationship = %#v, %v", custom, found)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNestedInheritanceRejectsDestinationCycleAndInvalidPositions(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name, input, path string
|
||||||
|
code Code
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "destination-only cycle", input: `base:
|
||||||
|
settings:
|
||||||
|
a: {value: one}
|
||||||
|
b: {extends: a}
|
||||||
|
custom:
|
||||||
|
extends: base
|
||||||
|
settings:
|
||||||
|
a: {extends: b}
|
||||||
|
`, path: "/custom/settings/b/extends", code: CodeInheritanceCycle,
|
||||||
|
},
|
||||||
|
{"root reference", "extends: anything\nentry: {value: one}\n", "/extends", CodeInheritanceInvalid},
|
||||||
|
{"list element reference", "items: [{extends: anything, value: one}]\n", "/items/0/extends", CodeInheritanceInvalid},
|
||||||
|
}
|
||||||
|
for _, test := range tests {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
input := parseCompositionDocument(t, "source-1", test.input)
|
||||||
|
result, diagnostics := expandInheritanceTree(input, defaultProjectionLimits())
|
||||||
|
if result != nil || len(diagnostics) != 1 || diagnostics[0].Code != test.code ||
|
||||||
|
diagnostics[0].Path.String() != test.path || diagnostics[0].Primary == nil {
|
||||||
|
t.Fatalf("result = %#v, diagnostics = %#v", result, diagnostics)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNestedInheritanceResolvesScopesInsideSequences(t *testing.T) {
|
||||||
|
input := parseCompositionDocument(t, "source-1", `items:
|
||||||
|
- primary: {value: first}
|
||||||
|
secondary: {extends: primary}
|
||||||
|
- extends: null
|
||||||
|
zeta: {extends: alpha}
|
||||||
|
alpha: {value: second}
|
||||||
|
`)
|
||||||
|
result, diagnostics := expandInheritanceTree(input, defaultProjectionLimits())
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
t.Fatal(diagnostics)
|
||||||
|
}
|
||||||
|
first, found := documentAtPath(result.root, Keys("items").Index(0).Key("secondary").Key("value"))
|
||||||
|
if !found || first.Text != "first" {
|
||||||
|
t.Fatalf("first sequence scope = %#v, %v", first, found)
|
||||||
|
}
|
||||||
|
second, found := documentAtPath(result.root, Keys("items").Index(1).Key("zeta").Key("value"))
|
||||||
|
if !found || second.Text != "second" {
|
||||||
|
t.Fatalf("second sequence scope = %#v, %v", second, found)
|
||||||
|
}
|
||||||
|
if _, found := documentAtPath(result.root, Keys("items").Index(1).Key(inheritanceKey)); found {
|
||||||
|
t.Fatal("sequence-element cancellation survived")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInheritanceExpansionHonorsOutputNodeAndDepthBudgets(t *testing.T) {
|
||||||
|
input := parseCompositionDocument(t, "source-1", "base: {value: one}\nchild: {extends: base}\n")
|
||||||
|
for _, test := range []struct {
|
||||||
|
name string
|
||||||
|
limits projectionLimits
|
||||||
|
valid bool
|
||||||
|
}{
|
||||||
|
{name: "at node boundary", limits: projectionLimits{nodes: 9, depth: 2}, valid: true},
|
||||||
|
{name: "beyond node boundary", limits: projectionLimits{nodes: 8, depth: 2}},
|
||||||
|
{name: "at depth boundary", limits: projectionLimits{nodes: 20, depth: 2}, valid: true},
|
||||||
|
{name: "beyond depth boundary", limits: projectionLimits{nodes: 20, depth: 1}},
|
||||||
|
} {
|
||||||
|
t.Run(test.name, func(t *testing.T) {
|
||||||
|
result, diagnostics := expandInheritanceTree(input, test.limits)
|
||||||
|
if test.valid {
|
||||||
|
if result == nil || len(diagnostics) != 0 {
|
||||||
|
t.Fatalf("result = %#v, diagnostics = %#v", result, diagnostics)
|
||||||
|
}
|
||||||
|
} else if result != nil || len(diagnostics) != 1 || diagnostics[0].Code != CodeSchemaProjectionLimit {
|
||||||
|
t.Fatalf("result = %#v, diagnostics = %#v", result, diagnostics)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInheritanceBudgetIncludesOtherScopesAndSequenceItems(t *testing.T) {
|
||||||
|
input := parseCompositionDocument(t, "source-1", `extends: null
|
||||||
|
groups:
|
||||||
|
- a: {x: one}
|
||||||
|
b: {extends: a}
|
||||||
|
- a: {x: two}
|
||||||
|
b: {extends: a}
|
||||||
|
unchanged: {x: three}
|
||||||
|
`)
|
||||||
|
// Root (1), groups key/list (2), two expanded scopes (18), and
|
||||||
|
// unchanged key/mapping/key/value (4). Consumed controls cost nothing.
|
||||||
|
for _, limit := range []int{24, 25, 26} {
|
||||||
|
result, diagnostics := expandInheritanceTree(input, projectionLimits{nodes: limit, depth: 5})
|
||||||
|
if limit < 25 {
|
||||||
|
if result != nil || len(diagnostics) != 1 || diagnostics[0].Code != CodeSchemaProjectionLimit {
|
||||||
|
t.Fatalf("limit %d accepted or wrong error: %#v", limit, diagnostics)
|
||||||
|
}
|
||||||
|
} else if result == nil || len(diagnostics) != 0 {
|
||||||
|
t.Fatalf("limit %d rejected: %#v", limit, diagnostics)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
50
internal/engine/layered.go
Normal file
50
internal/engine/layered.go
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import "os"
|
||||||
|
|
||||||
|
// Input selects one source and its independent import policy.
|
||||||
|
type Input struct {
|
||||||
|
Source Source
|
||||||
|
Imports bool
|
||||||
|
Filesystem *FilesystemContext
|
||||||
|
}
|
||||||
|
|
||||||
|
// Underlay contains strictly composed contributions at one precedence tier.
|
||||||
|
type Underlay struct{ Inputs []Input }
|
||||||
|
|
||||||
|
// LayeredOptions selects lower-priority tiers and final application rules.
|
||||||
|
type LayeredOptions[T any] struct {
|
||||||
|
Definition Definition[T]
|
||||||
|
Underlays []Underlay
|
||||||
|
Overlay string
|
||||||
|
OverlayFilesystem *FilesystemContext
|
||||||
|
Overrides []Override
|
||||||
|
}
|
||||||
|
|
||||||
|
// LoadLayered loads a main input and lower-priority grouped inputs through one
|
||||||
|
// final decode, resolution, and validation lifecycle.
|
||||||
|
func LoadLayered[T any](main Input, secrets SecretBinding, supplied ...LayeredOptions[T]) (*Loaded[T], error) {
|
||||||
|
if len(supplied) > 1 {
|
||||||
|
return nil, (&diagnosticAccumulator{diagnostics: []Diagnostic{optionDiagnostic(CodeOptionsInvalid, "LoadLayered accepts at most one options value")}}).loadError()
|
||||||
|
}
|
||||||
|
var options LayeredOptions[T]
|
||||||
|
if len(supplied) != 0 {
|
||||||
|
options = supplied[0]
|
||||||
|
}
|
||||||
|
request := loadRequest[T]{
|
||||||
|
main: loadInput{source: main.Source, imports: main.Imports, filesystem: main.Filesystem},
|
||||||
|
definition: options.Definition, overlay: options.Overlay,
|
||||||
|
overlayFilesystem: options.OverlayFilesystem,
|
||||||
|
overrides: append([]Override(nil), options.Overrides...),
|
||||||
|
underlays: make([]loadGroup, len(options.Underlays)),
|
||||||
|
}
|
||||||
|
for index, underlay := range options.Underlays {
|
||||||
|
request.underlays[index].inputs = make([]loadInput, len(underlay.Inputs))
|
||||||
|
for inputIndex, input := range underlay.Inputs {
|
||||||
|
request.underlays[index].inputs[inputIndex] = loadInput{
|
||||||
|
source: input.Source, imports: input.Imports, filesystem: input.Filesystem,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return loadGroupedWithSecretLookup(request, secrets, os.LookupEnv)
|
||||||
|
}
|
||||||
@@ -19,20 +19,21 @@ type Definition[T any] struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Options contains the application definition and per-load input selections.
|
// Options contains the application definition and per-load input selections.
|
||||||
// Imports enables explicit path and glob imports; Profile selects one fixed profile
|
// Imports enables explicit path and glob imports; Overlay selects one fixed overlay;
|
||||||
// overlay; Overrides contains only values explicitly supplied by an application CLI.
|
// Overrides contains only values explicitly supplied by an application CLI.
|
||||||
type Options[T any] struct {
|
type Options[T any] struct {
|
||||||
Definition Definition[T]
|
Definition Definition[T]
|
||||||
Imports bool
|
Imports bool
|
||||||
Profile string
|
Overlay string
|
||||||
Filesystem *FilesystemContext
|
Filesystem *FilesystemContext
|
||||||
Overrides []Override
|
Overrides []Override
|
||||||
}
|
}
|
||||||
|
|
||||||
// FilesystemContext supplies filesystem roots for imports and profiles.
|
// FilesystemContext supplies filesystem roots for imports and overlays.
|
||||||
type FilesystemContext struct {
|
type FilesystemContext struct {
|
||||||
BaseDir string
|
BaseDir string
|
||||||
Root string
|
Root string
|
||||||
|
FS *Filesystem
|
||||||
}
|
}
|
||||||
|
|
||||||
// Override describes one explicitly supplied application override. Value uses
|
// Override describes one explicitly supplied application override. Value uses
|
||||||
@@ -77,13 +78,17 @@ type Loaded[T any] struct {
|
|||||||
type Inspection struct {
|
type Inspection struct {
|
||||||
metadata Metadata
|
metadata Metadata
|
||||||
sources []SourceInfo
|
sources []SourceInfo
|
||||||
|
contexts map[string]ResourceContext
|
||||||
diagnostics []Diagnostic
|
diagnostics []Diagnostic
|
||||||
baseline *document.Node
|
baseline *document.Node
|
||||||
input *document.Node
|
input *document.Node
|
||||||
inputOrigins map[string]Origin
|
inputOrigins map[string]Origin
|
||||||
final *document.Node
|
final *document.Node
|
||||||
|
immutableLookup *documentLookup
|
||||||
resolution []resolutionSnapshot
|
resolution []resolutionSnapshot
|
||||||
|
resolutionReplay []resolutionSnapshot
|
||||||
applications []historyApplication
|
applications []historyApplication
|
||||||
|
inheritance []inheritanceOperation
|
||||||
secrets map[string]bool
|
secrets map[string]bool
|
||||||
secretReferences map[string]string
|
secretReferences map[string]string
|
||||||
}
|
}
|
||||||
@@ -104,6 +109,16 @@ func (r *Inspection) Sources() []SourceInfo {
|
|||||||
return cloneSourceInfos(r.sources)
|
return cloneSourceInfos(r.sources)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// SourceContext returns a passive filesystem view for an acquired source.
|
||||||
|
// Unknown IDs and sources without a filesystem context return false.
|
||||||
|
func (r *Inspection) SourceContext(id string) (ResourceContext, bool) {
|
||||||
|
if r == nil {
|
||||||
|
return ResourceContext{}, false
|
||||||
|
}
|
||||||
|
context, ok := r.contexts[id]
|
||||||
|
return context, ok
|
||||||
|
}
|
||||||
|
|
||||||
// Diagnostics returns detached nonfatal diagnostics from the load.
|
// Diagnostics returns detached nonfatal diagnostics from the load.
|
||||||
func (r *Inspection) Diagnostics() []Diagnostic {
|
func (r *Inspection) Diagnostics() []Diagnostic {
|
||||||
if r == nil {
|
if r == nil {
|
||||||
@@ -113,21 +128,34 @@ func (r *Inspection) Diagnostics() []Diagnostic {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Load parses and strictly decodes zero or one selected source, explicitly enabled
|
// Load parses and strictly decodes zero or one selected source, explicitly enabled
|
||||||
// imports, and one selected profile. It accepts at most one Options value and
|
// imports, and one selected overlay. It accepts at most one Options value and
|
||||||
// returns no result when any error is reported.
|
// returns no result when any error is reported.
|
||||||
func Load[T any](source Source, secrets SecretBinding, supplied ...Options[T]) (*Loaded[T], error) {
|
func Load[T any](source Source, secrets SecretBinding, supplied ...Options[T]) (*Loaded[T], error) {
|
||||||
return loadWithSecretLookup(source, secrets, os.LookupEnv, supplied...)
|
return loadWithSecretLookup(source, secrets, os.LookupEnv, supplied...)
|
||||||
}
|
}
|
||||||
|
|
||||||
func loadWithSecretLookup[T any](source Source, secrets SecretBinding, lookup secretLookup, supplied ...Options[T]) (*Loaded[T], error) {
|
func loadWithSecretLookup[T any](source Source, secrets SecretBinding, lookup secretLookup, supplied ...Options[T]) (*Loaded[T], error) {
|
||||||
accumulator := diagnosticAccumulator{}
|
|
||||||
options, diagnostics := selectOptions(source, supplied)
|
options, diagnostics := selectOptions(source, supplied)
|
||||||
accumulator.add(diagnostics...)
|
|
||||||
if len(diagnostics) != 0 {
|
if len(diagnostics) != 0 {
|
||||||
return nil, accumulator.loadError()
|
return nil, (&diagnosticAccumulator{diagnostics: diagnostics}).loadError()
|
||||||
|
}
|
||||||
|
request := loadRequest[T]{
|
||||||
|
main: loadInput{source: source, imports: options.Imports, filesystem: options.Filesystem},
|
||||||
|
definition: options.Definition, overlay: options.Overlay,
|
||||||
|
overrides: options.Overrides, ordinary: true,
|
||||||
|
}
|
||||||
|
return executeLoadRequest(request, secrets, lookup)
|
||||||
|
}
|
||||||
|
|
||||||
|
func executeLoadRequest[T any](request loadRequest[T], secrets SecretBinding, lookup secretLookup) (*Loaded[T], error) {
|
||||||
|
accumulator := diagnosticAccumulator{}
|
||||||
|
accounting := &importAccounting{}
|
||||||
|
mainOptions := Options[T]{Definition: request.definition, Imports: request.main.imports, Filesystem: request.main.filesystem}
|
||||||
|
if request.ordinary {
|
||||||
|
mainOptions.Overlay = request.overlay
|
||||||
}
|
}
|
||||||
|
|
||||||
input, diagnostics := assembleBaseInput(source, options)
|
input, diagnostics := assembleBaseInputTracked(request.main.source, mainOptions, accounting, nil, nil)
|
||||||
accumulator.sources = input.sources
|
accumulator.sources = input.sources
|
||||||
accumulator.add(diagnostics...)
|
accumulator.add(diagnostics...)
|
||||||
if len(diagnostics) != 0 {
|
if len(diagnostics) != 0 {
|
||||||
@@ -138,29 +166,68 @@ func loadWithSecretLookup[T any](source Source, secrets SecretBinding, lookup se
|
|||||||
accumulator.add(diagnosticFromSchemaIssue(schemaIssue))
|
accumulator.add(diagnosticFromSchemaIssue(schemaIssue))
|
||||||
return nil, accumulator.loadError()
|
return nil, accumulator.loadError()
|
||||||
}
|
}
|
||||||
versionDiagnostics := checkVersion(options.Definition.Version, input.document)
|
versionDiagnostics := checkVersion(request.definition.Version, input.document)
|
||||||
accumulator.add(versionDiagnostics...)
|
accumulator.add(versionDiagnostics...)
|
||||||
if hasErrors(versionDiagnostics) {
|
if hasErrors(versionDiagnostics) {
|
||||||
return nil, accumulator.loadError()
|
return nil, accumulator.loadError()
|
||||||
}
|
}
|
||||||
input, diagnostics = applyInputLayers(source, options, input)
|
if request.ordinary {
|
||||||
|
input, diagnostics = applyInputLayers(request.main.source, Options[T]{Definition: request.definition, Overlay: request.overlay, Filesystem: request.main.filesystem, Overrides: request.overrides}, input)
|
||||||
|
} else {
|
||||||
|
input, diagnostics = assembleLayeredInput(request, input, accounting)
|
||||||
|
}
|
||||||
accumulator.sources = input.sources
|
accumulator.sources = input.sources
|
||||||
accumulator.add(diagnostics...)
|
accumulator.add(diagnostics...)
|
||||||
if len(diagnostics) != 0 {
|
if len(diagnostics) != 0 {
|
||||||
return nil, accumulator.loadError()
|
return nil, accumulator.loadError()
|
||||||
}
|
}
|
||||||
|
if request.ordinary && input.parsed.source != nil {
|
||||||
|
baseSources := make([]SourceInfo, 0, len(input.sources))
|
||||||
|
for _, source := range input.sources {
|
||||||
|
if source.Layer == LayerBase {
|
||||||
|
baseSources = append(baseSources, source)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(baseSources) != 0 && input.contexts[baseSources[0].ID].FS == nil {
|
||||||
|
contexts, diagnostic := contextsForAcquiredSources(request.main.source, request.main.filesystem, input.parsed.source, baseSources)
|
||||||
|
if diagnostic != nil {
|
||||||
|
accumulator.add(*diagnostic)
|
||||||
|
return nil, accumulator.loadError()
|
||||||
|
}
|
||||||
|
mergeResourceContexts(&input.contexts, contexts)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if input.document != nil && containsInheritanceDirective(input.document) {
|
||||||
|
composition, problems := compositionForInput(input)
|
||||||
|
if len(problems) != 0 {
|
||||||
|
accumulator.add(problems...)
|
||||||
|
return nil, accumulator.loadError()
|
||||||
|
}
|
||||||
|
expanded, problems := expandInheritanceWithOrigins(composition.root, composition.origins, defaultProjectionLimits())
|
||||||
|
if len(problems) != 0 {
|
||||||
|
accumulator.add(problems...)
|
||||||
|
return nil, accumulator.loadError()
|
||||||
|
}
|
||||||
|
if problem := inheritanceVersionDiagnostic(request.definition.Version, expanded); problem != nil {
|
||||||
|
accumulator.add(*problem)
|
||||||
|
return nil, accumulator.loadError()
|
||||||
|
}
|
||||||
|
input.composition = composition
|
||||||
|
input.inheritance = expanded
|
||||||
|
input.document = expanded.root
|
||||||
|
}
|
||||||
|
|
||||||
decoded, diagnostics := decodeLoadInput(schema, options.Definition, input)
|
decoded, diagnostics := decodeLoadInput(schema, request.definition, input)
|
||||||
accumulator.add(diagnostics...)
|
accumulator.add(diagnostics...)
|
||||||
if len(diagnostics) != 0 {
|
if len(diagnostics) != 0 {
|
||||||
return nil, accumulator.loadError()
|
return nil, accumulator.loadError()
|
||||||
}
|
}
|
||||||
resolved, diagnostics := resolveLoadInput(schema, options.Definition, input, decoded)
|
resolved, diagnostics := resolveLoadInput(schema, request.definition, input, decoded)
|
||||||
accumulator.add(diagnostics...)
|
accumulator.add(diagnostics...)
|
||||||
if hasErrors(diagnostics) {
|
if hasErrors(diagnostics) {
|
||||||
return nil, accumulator.loadError()
|
return nil, accumulator.loadError()
|
||||||
}
|
}
|
||||||
if !historyNodesWithinLimit(decoded.baseline, decoded.final, resolved.final, resolved.applications, resolved.snapshots) {
|
if !historyNodesWithinLimit(decoded.baseline, decoded.final, resolved.final, resolved.applications, resolved.snapshots, input.inheritance) {
|
||||||
accumulator.add(Diagnostic{Code: CodeExplainLimitExceeded, Severity: SeverityError, Message: "retained configuration history exceeds the node limit"})
|
accumulator.add(Diagnostic{Code: CodeExplainLimitExceeded, Severity: SeverityError, Message: "retained configuration history exceeds the node limit"})
|
||||||
return nil, accumulator.loadError()
|
return nil, accumulator.loadError()
|
||||||
}
|
}
|
||||||
@@ -176,8 +243,8 @@ func loadWithSecretLookup[T any](source Source, secrets SecretBinding, lookup se
|
|||||||
if hasErrors(secretResolution.diagnostics) {
|
if hasErrors(secretResolution.diagnostics) {
|
||||||
return nil, accumulator.loadError()
|
return nil, accumulator.loadError()
|
||||||
}
|
}
|
||||||
if options.Definition.Validate != nil {
|
if request.definition.Validate != nil {
|
||||||
diagnostics = runValidation(&configuration, options.Definition.Validate, schema, resolved.final, input.document, secretResolution.lookups)
|
diagnostics = runValidation(&configuration, request.definition.Validate, schema, resolved.final, input.document, secretResolution.lookups)
|
||||||
accumulator.add(diagnostics...)
|
accumulator.add(diagnostics...)
|
||||||
if hasErrors(diagnostics) {
|
if hasErrors(diagnostics) {
|
||||||
return nil, accumulator.loadError()
|
return nil, accumulator.loadError()
|
||||||
@@ -186,5 +253,5 @@ func loadWithSecretLookup[T any](source Source, secrets SecretBinding, lookup se
|
|||||||
resolved.configuration = configuration
|
resolved.configuration = configuration
|
||||||
// Publication detaches equal-valued validator replacements, preserving the
|
// Publication detaches equal-valued validator replacements, preserving the
|
||||||
// validated secret state, then finalizes metadata and sensitivity.
|
// validated secret state, then finalizes metadata and sensitivity.
|
||||||
return publishLoadResult(schema, options.Definition, resolved, secretResolution.references, &accumulator)
|
return publishLoadResult(schema, request.definition, resolved, secretResolution.references, &accumulator)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,31 +1,44 @@
|
|||||||
package engine
|
package engine
|
||||||
|
|
||||||
import "gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
import (
|
||||||
|
"strconv"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
||||||
|
)
|
||||||
|
|
||||||
// assembledInput is the source/document handoff across schema and version checks.
|
// assembledInput is the source/document handoff across schema and version checks.
|
||||||
type assembledInput struct {
|
type assembledInput struct {
|
||||||
parsed parsedSource
|
parsed parsedSource
|
||||||
document *document.Node
|
document *document.Node
|
||||||
composition *composedDocument
|
composition *composedDocument
|
||||||
|
inheritance *inheritanceScope
|
||||||
sources []SourceInfo
|
sources []SourceInfo
|
||||||
|
contexts map[string]ResourceContext
|
||||||
}
|
}
|
||||||
|
|
||||||
func assembleBaseInput[T any](source Source, options Options[T]) (assembledInput, []Diagnostic) {
|
func assembleBaseInput[T any](source Source, options Options[T]) (assembledInput, []Diagnostic) {
|
||||||
parsed, diagnostics := parseSource(source, "source-1", defaultParseLimits())
|
return assembleBaseInputTracked(source, options, &importAccounting{}, nil, nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
func assembleBaseInputTracked[T any](source Source, options Options[T], accounting *importAccounting, visited map[resourceIdentity]importRoute, hostToken *namespaceToken) (assembledInput, []Diagnostic) {
|
||||||
|
limits := defaultImportLimits()
|
||||||
|
parseLimits := defaultParseLimits()
|
||||||
|
parseLimits.source.remaining = limits.bytes - accounting.bytes
|
||||||
|
parsed, diagnostics := parseSource(source, "source-"+strconv.Itoa(accounting.sources+1), parseLimits)
|
||||||
input := assembledInput{parsed: parsed, document: parsed.document}
|
input := assembledInput{parsed: parsed, document: parsed.document}
|
||||||
if len(diagnostics) != 0 {
|
if len(diagnostics) != 0 {
|
||||||
input.sources = sourceInfos(parsed.source)
|
input.sources = sourceInfos(parsed.source)
|
||||||
return input, diagnostics
|
return input, diagnostics
|
||||||
}
|
}
|
||||||
if options.Imports {
|
if options.Imports {
|
||||||
input.composition, input.sources, diagnostics = loadImportedDocuments(source, options.Filesystem, parsed, options.Definition.Version, defaultImportLimits())
|
input.composition, input.sources, diagnostics = loadImportedDocumentsTracked(source, options.Filesystem, parsed, options.Definition.Version, limits, accounting, visited, hostToken)
|
||||||
if len(diagnostics) != 0 {
|
if len(diagnostics) != 0 {
|
||||||
return input, diagnostics
|
return input, diagnostics
|
||||||
}
|
}
|
||||||
input.document = input.composition.root
|
input.document = input.composition.root
|
||||||
} else {
|
} else {
|
||||||
input.sources = sourceInfos(parsed.source)
|
input.sources = sourceInfos(parsed.source)
|
||||||
if options.Filesystem != nil && !activeProfile(options.Profile) {
|
if options.Filesystem != nil && !activeOverlay(options.Overlay) {
|
||||||
if diagnostic := validateFilesystemContext(source, options.Filesystem, parsed); diagnostic != nil {
|
if diagnostic := validateFilesystemContext(source, options.Filesystem, parsed); diagnostic != nil {
|
||||||
return input, []Diagnostic{*diagnostic}
|
return input, []Diagnostic{*diagnostic}
|
||||||
}
|
}
|
||||||
@@ -35,41 +48,81 @@ func assembleBaseInput[T any](source Source, options Options[T]) (assembledInput
|
|||||||
if diagnostics := disabledDirectiveDiagnostics(input.document, Path{}); len(diagnostics) != 0 {
|
if diagnostics := disabledDirectiveDiagnostics(input.document, Path{}); len(diagnostics) != 0 {
|
||||||
return input, diagnostics
|
return input, diagnostics
|
||||||
}
|
}
|
||||||
|
if accounting.sources+1 > limits.sources || accounting.bytes+parsed.bytes > limits.bytes || accounting.nodes+countInputNodes(input.document) > limits.nodes {
|
||||||
|
return input, []Diagnostic{sourceDiagnostic(CodeSourceLimitExceeded, parsed.source.ID, "configuration exceeds the aggregate input limit")}
|
||||||
|
}
|
||||||
|
if diagnostic := registerAcquiredSource(source, options.Filesystem, parsed.source, visited, hostToken); diagnostic != nil {
|
||||||
|
return input, []Diagnostic{*diagnostic}
|
||||||
|
}
|
||||||
|
accounting.sources++
|
||||||
|
accounting.bytes += parsed.bytes
|
||||||
|
accounting.nodes += countInputNodes(input.document)
|
||||||
|
}
|
||||||
|
if !activeOverlay(options.Overlay) || options.Imports {
|
||||||
|
contexts, diagnostic := contextsForAcquiredSources(source, options.Filesystem, parsed.source, input.sources)
|
||||||
|
if diagnostic != nil {
|
||||||
|
return input, []Diagnostic{*diagnostic}
|
||||||
|
}
|
||||||
|
input.contexts = contexts
|
||||||
}
|
}
|
||||||
return input, nil
|
return input, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func registerAcquiredSource(source Source, context *FilesystemContext, info *SourceInfo, visited map[resourceIdentity]importRoute, hostToken *namespaceToken) *Diagnostic {
|
||||||
|
if visited == nil || info == nil || info.Path == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
identity := resourceIdentity{namespace: hostToken, path: info.Path}
|
||||||
|
if source.kind == sourceFilesystem {
|
||||||
|
identity.namespace = source.namespace.token
|
||||||
|
} else if context != nil && context.FS != nil {
|
||||||
|
identity.namespace = context.FS.namespace.token
|
||||||
|
}
|
||||||
|
if previous, repeated := visited[identity]; repeated {
|
||||||
|
value := importRepeatedDiagnostic(Location{SourceID: info.ID}, previous, importRoute{})
|
||||||
|
return &value
|
||||||
|
}
|
||||||
|
visited[identity] = importRoute{canonical: info.Path}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
func applyInputLayers[T any](source Source, options Options[T], input assembledInput) (assembledInput, []Diagnostic) {
|
func applyInputLayers[T any](source Source, options Options[T], input assembledInput) (assembledInput, []Diagnostic) {
|
||||||
if !activeProfile(options.Profile) && len(options.Overrides) == 0 {
|
if !activeOverlay(options.Overlay) && len(options.Overrides) == 0 {
|
||||||
return input, nil
|
return input, nil
|
||||||
}
|
}
|
||||||
composition, diagnostics := compositionForInput(input)
|
composition, diagnostics := compositionForInput(input)
|
||||||
if len(diagnostics) != 0 {
|
if len(diagnostics) != 0 {
|
||||||
return input, diagnostics
|
return input, diagnostics
|
||||||
}
|
}
|
||||||
if activeProfile(options.Profile) {
|
assembly := newAssemblyAccumulator(composition)
|
||||||
composition, input.sources, diagnostics = loadProfileDocument(
|
if activeOverlay(options.Overlay) {
|
||||||
source, options.Filesystem, input.parsed, composition, input.sources,
|
input.sources, diagnostics = loadSelectedOverlayInto(
|
||||||
options.Profile, options.Definition.Version, defaultImportLimits(),
|
source, options.Filesystem, input.parsed, assembly, input.sources,
|
||||||
|
options.Overlay, options.Definition.Version, defaultImportLimits(),
|
||||||
)
|
)
|
||||||
if len(diagnostics) != 0 {
|
if len(diagnostics) != 0 {
|
||||||
return input, diagnostics
|
return input, diagnostics
|
||||||
}
|
}
|
||||||
|
contexts, diagnostic := contextsForAcquiredSources(source, options.Filesystem, input.parsed.source, input.sources[len(input.sources)-1:])
|
||||||
|
if diagnostic != nil {
|
||||||
|
return input, []Diagnostic{*diagnostic}
|
||||||
|
}
|
||||||
|
mergeResourceContexts(&input.contexts, contexts)
|
||||||
}
|
}
|
||||||
if len(options.Overrides) != 0 {
|
if len(options.Overrides) != 0 {
|
||||||
composition, input.sources, diagnostics = applyOverrides(
|
input.sources, diagnostics = assembly.applyOverrides(
|
||||||
composition, input.sources, options.Overrides, options.Definition.Version, defaultImportLimits(),
|
input.sources, options.Overrides, options.Definition.Version, defaultImportLimits(),
|
||||||
)
|
)
|
||||||
if len(diagnostics) != 0 {
|
if len(diagnostics) != 0 {
|
||||||
return input, diagnostics
|
return input, diagnostics
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
input.composition = composition
|
input.composition = assembly.current
|
||||||
input.document = composition.root
|
input.document = assembly.current.root
|
||||||
return input, nil
|
return input, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// compositionForInput initializes one handoff for profiles and CLI, including
|
// compositionForInput initializes one handoff for overlays and CLI, including
|
||||||
// defaults-only CLI input. Raw source bytes and mapping keys retain their budgets.
|
// defaults-only CLI input. Raw source bytes and mapping keys retain their budgets.
|
||||||
func compositionForInput(input assembledInput) (*composedDocument, []Diagnostic) {
|
func compositionForInput(input assembledInput) (*composedDocument, []Diagnostic) {
|
||||||
if input.composition != nil {
|
if input.composition != nil {
|
||||||
|
|||||||
@@ -12,9 +12,10 @@ import (
|
|||||||
type resolutionInput struct {
|
type resolutionInput struct {
|
||||||
metadata Metadata
|
metadata Metadata
|
||||||
sources map[string]SourceInfo
|
sources map[string]SourceInfo
|
||||||
|
contexts map[string]ResourceContext
|
||||||
}
|
}
|
||||||
|
|
||||||
func newResolutionInput(metadata Metadata, final *document.Node, sources []SourceInfo) resolutionInput {
|
func newResolutionInput(metadata Metadata, final *document.Node, sources []SourceInfo, contexts ...map[string]ResourceContext) resolutionInput {
|
||||||
frozen := Metadata{
|
frozen := Metadata{
|
||||||
fields: make(map[string]FieldInfo, len(metadata.fields)),
|
fields: make(map[string]FieldInfo, len(metadata.fields)),
|
||||||
effectivePaths: effectivePathIndex(final),
|
effectivePaths: effectivePathIndex(final),
|
||||||
@@ -32,7 +33,11 @@ func newResolutionInput(metadata Metadata, final *document.Node, sources []Sourc
|
|||||||
}
|
}
|
||||||
indexed[source.ID] = cloneSourceInfo(source)
|
indexed[source.ID] = cloneSourceInfo(source)
|
||||||
}
|
}
|
||||||
return resolutionInput{metadata: frozen, sources: indexed}
|
result := resolutionInput{metadata: frozen, sources: indexed}
|
||||||
|
if len(contexts) != 0 {
|
||||||
|
result.contexts = cloneResourceContexts(contexts[0])
|
||||||
|
}
|
||||||
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
func (input resolutionInput) lookup(path Path) (FieldInfo, bool) {
|
func (input resolutionInput) lookup(path Path) (FieldInfo, bool) {
|
||||||
@@ -47,6 +52,11 @@ func (input resolutionInput) source(id string) (SourceInfo, bool) {
|
|||||||
return cloneSourceInfo(source), true
|
return cloneSourceInfo(source), true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (input resolutionInput) sourceContext(id string) (ResourceContext, bool) {
|
||||||
|
context, ok := input.contexts[id]
|
||||||
|
return context, ok
|
||||||
|
}
|
||||||
|
|
||||||
func metadataFromDecoded(decoded decodedConfiguration) Metadata {
|
func metadataFromDecoded(decoded decodedConfiguration) Metadata {
|
||||||
metadata := Metadata{
|
metadata := Metadata{
|
||||||
fields: make(map[string]FieldInfo),
|
fields: make(map[string]FieldInfo),
|
||||||
@@ -115,9 +125,6 @@ func applyOverlayMetadata(metadata *Metadata, records []overlayRecord) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
if history := events[pointer]; len(history) != 0 && history[len(history)-1].Origin.Layer == info.Origin.Layer && history[len(history)-1].Origin.Operation == info.Origin.Operation {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
appendInputOriginEvent(events, baseline, pointer, path, info.Origin)
|
appendInputOriginEvent(events, baseline, pointer, path, info.Origin)
|
||||||
}
|
}
|
||||||
metadata.history = make(map[string][]Change, len(baseline)+len(events))
|
metadata.history = make(map[string][]Change, len(baseline)+len(events))
|
||||||
@@ -134,12 +141,34 @@ func appendInputOriginEvent(events map[string][]Change, baseline map[string][]Ch
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
history := events[pointer]
|
history := events[pointer]
|
||||||
if len(history) != 0 && originContainedBy(history[len(history)-1].Origin, origin) {
|
if len(history) != 0 && originRepresentedByChange(path, origin, history[len(history)-1]) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
appendInputChangeEvent(events, baseline, pointer, Change{Path: path.clone(), Origin: cloneOrigin(origin)})
|
appendInputChangeEvent(events, baseline, pointer, Change{Path: path.clone(), Origin: cloneOrigin(origin)})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func originRepresentedByChange(path Path, origin Origin, change Change) bool {
|
||||||
|
if change.Path.String() == path.String() {
|
||||||
|
return originContainedBy(origin, change.Origin)
|
||||||
|
}
|
||||||
|
if !pathContains(change.Path, path) || origin.Layer != change.Origin.Layer || origin.Operation != change.Origin.Operation {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
// A subtree replacement already records its descendants' contributions.
|
||||||
|
// Their coordinates differ from the container's, but their sources must be
|
||||||
|
// covered by the operation; matching only the precedence role is insufficient.
|
||||||
|
recordedSources := make(map[string]struct{}, len(change.Origin.Locations))
|
||||||
|
for _, recorded := range change.Origin.Locations {
|
||||||
|
recordedSources[recorded.SourceID] = struct{}{}
|
||||||
|
}
|
||||||
|
for _, location := range origin.Locations {
|
||||||
|
if _, found := recordedSources[location.SourceID]; !found {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
func appendInputChangeEvent(events map[string][]Change, baseline map[string][]Change, pointer string, value Change) {
|
func appendInputChangeEvent(events map[string][]Change, baseline map[string][]Change, pointer string, value Change) {
|
||||||
change := cloneChange(value)
|
change := cloneChange(value)
|
||||||
history := events[pointer]
|
history := events[pointer]
|
||||||
@@ -157,10 +186,24 @@ func originContainedBy(candidate, container Origin) bool {
|
|||||||
if candidate.Layer != container.Layer || candidate.Operation != container.Operation {
|
if candidate.Layer != container.Layer || candidate.Operation != container.Operation {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
availableLocations := make(map[Location]struct{}, len(container.Locations))
|
||||||
|
for _, location := range container.Locations {
|
||||||
|
availableLocations[location] = struct{}{}
|
||||||
|
}
|
||||||
for _, location := range candidate.Locations {
|
for _, location := range candidate.Locations {
|
||||||
|
if _, found := availableLocations[location]; !found {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (len(candidate.contributors) == 0) != (len(container.contributors) == 0) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
for _, contributor := range candidate.contributors {
|
||||||
found := false
|
found := false
|
||||||
for _, available := range container.Locations {
|
for _, available := range container.contributors {
|
||||||
if location == available {
|
if contributor.location == available.location &&
|
||||||
|
slices.Equal(contributor.source.segments, available.source.segments) &&
|
||||||
|
sameInheritanceTrace(contributor.trace, available.trace) {
|
||||||
found = true
|
found = true
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
@@ -205,8 +248,10 @@ func cloneMetadata(metadata Metadata) Metadata {
|
|||||||
return Metadata{}
|
return Metadata{}
|
||||||
}
|
}
|
||||||
cloned := Metadata{
|
cloned := Metadata{
|
||||||
fields: make(map[string]FieldInfo, len(metadata.fields)),
|
fields: make(map[string]FieldInfo, len(metadata.fields)),
|
||||||
history: make(map[string][]Change, len(metadata.history)),
|
history: make(map[string][]Change, len(metadata.history)),
|
||||||
|
inheritance: append([]inheritanceOperation(nil), metadata.inheritance...),
|
||||||
|
inheritanceIndex: metadata.inheritanceIndex,
|
||||||
}
|
}
|
||||||
cloned.effectivePaths = make(map[string]Path, len(metadata.effectivePaths))
|
cloned.effectivePaths = make(map[string]Path, len(metadata.effectivePaths))
|
||||||
for pointer, path := range metadata.effectivePaths {
|
for pointer, path := range metadata.effectivePaths {
|
||||||
@@ -230,8 +275,23 @@ func cloneMetadata(metadata Metadata) Metadata {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func applyResolutionMetadata(metadata *Metadata, resolved resolutionResult) {
|
func applyResolutionMetadata(metadata *Metadata, resolved resolutionResult) {
|
||||||
for _, snapshot := range resolved.snapshots {
|
finalPaths := make(map[string]*document.Node)
|
||||||
pointer := snapshot.change.Path.String()
|
indexDocument(resolved.final, Path{}, finalPaths)
|
||||||
|
snapshotCoverage, snapshotPointers := newResolutionCoverageIndexFromSnapshots(resolved.snapshots)
|
||||||
|
var deltaCoverage pathPrefixIndex
|
||||||
|
snapshotIDs := make([]int, len(resolved.deltas))
|
||||||
|
for id, delta := range resolved.deltas {
|
||||||
|
if delta.path.valid() {
|
||||||
|
deltaCoverage.insert(delta.path.String(), id)
|
||||||
|
}
|
||||||
|
snapshotIDs[id] = -1
|
||||||
|
if snapshotID, ok := snapshotCoverage.deepestCoveringID(delta.path); ok {
|
||||||
|
snapshotIDs[id] = snapshotID
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for snapshotID, snapshot := range resolved.snapshots {
|
||||||
|
pointer := snapshotPointers[snapshotID]
|
||||||
change := cloneChange(snapshot.change)
|
change := cloneChange(snapshot.change)
|
||||||
if info, ok := metadata.fields[pointer]; ok {
|
if info, ok := metadata.fields[pointer]; ok {
|
||||||
change.Previous = []Origin{cloneOrigin(info.Origin)}
|
change.Previous = []Origin{cloneOrigin(info.Origin)}
|
||||||
@@ -240,52 +300,40 @@ func applyResolutionMetadata(metadata *Metadata, resolved resolutionResult) {
|
|||||||
}
|
}
|
||||||
metadata.history[pointer] = append(metadata.history[pointer], change)
|
metadata.history[pointer] = append(metadata.history[pointer], change)
|
||||||
}
|
}
|
||||||
appendResolutionDescendantHistory(metadata, resolved)
|
|
||||||
for _, delta := range resolved.deltas {
|
appendResolutionDescendantHistory(metadata, resolved.snapshots, snapshotPointers, finalPaths, &deltaCoverage, snapshotIDs)
|
||||||
record := coveringResolutionSnapshot(resolved.snapshots, delta.path)
|
applyResolutionFieldOrigins(metadata.fields, resolved.snapshots, &deltaCoverage, snapshotIDs)
|
||||||
if record == nil {
|
refreshResolutionFields(metadata.fields, finalPaths, resolved.snapshots, snapshotCoverage)
|
||||||
continue
|
|
||||||
}
|
|
||||||
for pointer, info := range metadata.fields {
|
|
||||||
path, err := ParsePath(pointer)
|
|
||||||
if err != nil || !pathContains(delta.path, path) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
info.Origin = cloneOrigin(record.change.Origin)
|
|
||||||
metadata.fields[pointer] = info
|
|
||||||
}
|
|
||||||
}
|
|
||||||
refreshResolutionFields(metadata.fields, resolved.final, resolved.snapshots)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func appendResolutionDescendantHistory(metadata *Metadata, resolved resolutionResult) {
|
func appendResolutionDescendantHistory(metadata *Metadata, snapshots []resolutionSnapshot, snapshotPointers []string, finalPaths map[string]*document.Node, deltaIndex *pathPrefixIndex, snapshotIDs []int) {
|
||||||
finalPaths := make(map[string]*document.Node)
|
allPointers := make(map[string]struct{}, len(metadata.history)+len(finalPaths))
|
||||||
indexDocument(resolved.final, Path{}, finalPaths)
|
for pointer := range metadata.history {
|
||||||
for _, delta := range resolved.deltas {
|
if _, err := ParsePath(pointer); err == nil {
|
||||||
record := coveringResolutionSnapshot(resolved.snapshots, delta.path)
|
allPointers[pointer] = struct{}{}
|
||||||
if record == nil {
|
}
|
||||||
|
}
|
||||||
|
for pointer := range finalPaths {
|
||||||
|
allPointers[pointer] = struct{}{}
|
||||||
|
}
|
||||||
|
buckets := make([][]string, len(snapshotIDs))
|
||||||
|
for pointer := range allPointers {
|
||||||
|
deltaIndex.visitAncestors(pointer, func(deltaID int) {
|
||||||
|
snapshotID := snapshotIDs[deltaID]
|
||||||
|
if snapshotID < 0 || pointer == snapshotPointers[snapshotID] {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
buckets[deltaID] = append(buckets[deltaID], pointer)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
for deltaID, pointers := range buckets {
|
||||||
|
snapshotID := snapshotIDs[deltaID]
|
||||||
|
if snapshotID < 0 {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
affected := make(map[string]bool)
|
|
||||||
for pointer := range metadata.history {
|
|
||||||
if path, err := ParsePath(pointer); err == nil && pathContains(delta.path, path) {
|
|
||||||
affected[pointer] = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
for pointer := range finalPaths {
|
|
||||||
if path, err := ParsePath(pointer); err == nil && pathContains(delta.path, path) {
|
|
||||||
affected[pointer] = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
pointers := make([]string, 0, len(affected))
|
|
||||||
for pointer := range affected {
|
|
||||||
if pointer != record.change.Path.String() {
|
|
||||||
pointers = append(pointers, pointer)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
slices.Sort(pointers)
|
slices.Sort(pointers)
|
||||||
for _, pointer := range pointers {
|
for _, pointer := range pointers {
|
||||||
change := cloneChange(record.change)
|
change := cloneChange(snapshots[snapshotID].change)
|
||||||
if info, ok := metadata.fields[pointer]; ok {
|
if info, ok := metadata.fields[pointer]; ok {
|
||||||
change.Previous = []Origin{cloneOrigin(info.Origin)}
|
change.Previous = []Origin{cloneOrigin(info.Origin)}
|
||||||
}
|
}
|
||||||
@@ -294,20 +342,33 @@ func appendResolutionDescendantHistory(metadata *Metadata, resolved resolutionRe
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func coveringResolutionSnapshot(snapshots []resolutionSnapshot, path Path) *resolutionSnapshot {
|
func applyResolutionFieldOrigins(fields map[string]FieldInfo, snapshots []resolutionSnapshot, deltaIndex *pathPrefixIndex, snapshotIDs []int) {
|
||||||
var covering *resolutionSnapshot
|
buckets := make([][]string, len(snapshotIDs))
|
||||||
for index := range snapshots {
|
for pointer := range fields {
|
||||||
snapshot := &snapshots[index]
|
if _, err := ParsePath(pointer); err != nil {
|
||||||
if pathContains(snapshot.change.Path, path) && (covering == nil || len(snapshot.change.Path.segments) > len(covering.change.Path.segments)) {
|
continue
|
||||||
covering = snapshot
|
}
|
||||||
|
deltaIndex.visitAncestors(pointer, func(deltaID int) {
|
||||||
|
if snapshotIDs[deltaID] >= 0 {
|
||||||
|
buckets[deltaID] = append(buckets[deltaID], pointer)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
for deltaID, pointers := range buckets {
|
||||||
|
snapshotID := snapshotIDs[deltaID]
|
||||||
|
if snapshotID < 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
origin := snapshots[snapshotID].change.Origin
|
||||||
|
for _, pointer := range pointers {
|
||||||
|
info := fields[pointer]
|
||||||
|
info.Origin = cloneOrigin(origin)
|
||||||
|
fields[pointer] = info
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return covering
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func refreshResolutionFields(fields map[string]FieldInfo, final *document.Node, snapshots []resolutionSnapshot) {
|
func refreshResolutionFields(fields map[string]FieldInfo, finalPaths map[string]*document.Node, snapshots []resolutionSnapshot, snapshotCoverage *resolutionCoverageIndex) {
|
||||||
finalPaths := make(map[string]*document.Node)
|
|
||||||
indexDocument(final, Path{}, finalPaths)
|
|
||||||
for pointer := range fields {
|
for pointer := range fields {
|
||||||
if _, ok := finalPaths[pointer]; !ok {
|
if _, ok := finalPaths[pointer]; !ok {
|
||||||
delete(fields, pointer)
|
delete(fields, pointer)
|
||||||
@@ -320,10 +381,8 @@ func refreshResolutionFields(fields map[string]FieldInfo, final *document.Node,
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
origin := Origin{Layer: LayerResolution}
|
origin := Origin{Layer: LayerResolution}
|
||||||
if path, err := ParsePath(pointer); err == nil {
|
if snapshotID, ok := snapshotCoverage.deepestCoveringPointerID(pointer); ok {
|
||||||
if covering := coveringResolutionSnapshot(snapshots, path); covering != nil {
|
origin = cloneOrigin(snapshots[snapshotID].change.Origin)
|
||||||
origin = cloneOrigin(covering.change.Origin)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
fields[pointer] = FieldInfo{Null: node.Kind == document.Null, Origin: origin}
|
fields[pointer] = FieldInfo{Null: node.Kind == document.Null, Origin: origin}
|
||||||
}
|
}
|
||||||
|
|||||||
182
internal/engine/load_request.go
Normal file
182
internal/engine/load_request.go
Normal file
@@ -0,0 +1,182 @@
|
|||||||
|
package engine
|
||||||
|
|
||||||
|
import (
|
||||||
|
"gitea.maximumdirect.net/eric/ConfigKit/internal/document"
|
||||||
|
)
|
||||||
|
|
||||||
|
// loadRequest keeps source acquisition separate from precedence assembly.
|
||||||
|
// The ordinary entry point and grouped entry point share the final lifecycle.
|
||||||
|
type loadRequest[T any] struct {
|
||||||
|
main loadInput
|
||||||
|
underlays []loadGroup
|
||||||
|
definition Definition[T]
|
||||||
|
overlay string
|
||||||
|
overlayFilesystem *FilesystemContext
|
||||||
|
overrides []Override
|
||||||
|
ordinary bool
|
||||||
|
}
|
||||||
|
|
||||||
|
type loadInput struct {
|
||||||
|
source Source
|
||||||
|
imports bool
|
||||||
|
filesystem *FilesystemContext
|
||||||
|
}
|
||||||
|
|
||||||
|
type loadGroup struct{ inputs []loadInput }
|
||||||
|
|
||||||
|
func loadGroupedWithSecretLookup[T any](request loadRequest[T], secrets SecretBinding, lookup secretLookup) (*Loaded[T], error) {
|
||||||
|
request.ordinary = false
|
||||||
|
var diagnostics []Diagnostic
|
||||||
|
_, mainDiagnostics := selectOptions(request.main.source, []Options[T]{{
|
||||||
|
Definition: request.definition, Imports: request.main.imports, Filesystem: request.main.filesystem,
|
||||||
|
}})
|
||||||
|
diagnostics = append(diagnostics, mainDiagnostics...)
|
||||||
|
for _, group := range request.underlays {
|
||||||
|
for _, input := range group.inputs {
|
||||||
|
_, inputDiagnostics := selectOptions(input.source, []Options[T]{{Imports: input.imports, Filesystem: input.filesystem}})
|
||||||
|
diagnostics = append(diagnostics, inputDiagnostics...)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !validOverlayName(request.overlay) {
|
||||||
|
diagnostics = append(diagnostics, optionDiagnostic(CodeOptionsInvalid, "overlay name must contain only ASCII letters, digits, underscore, or hyphen"))
|
||||||
|
}
|
||||||
|
if activeOverlay(request.overlay) {
|
||||||
|
if request.overlayFilesystem == nil {
|
||||||
|
diagnostics = append(diagnostics, optionDiagnostic(CodeOptionsInvalid, "selected overlay requires explicit filesystem context"))
|
||||||
|
} else {
|
||||||
|
diagnostics = append(diagnostics, filesystemOptionDiagnostics(Source{kind: sourceBytes}, request.overlayFilesystem)...)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
return nil, (&diagnosticAccumulator{diagnostics: canonicalDiagnostics(diagnostics)}).loadError()
|
||||||
|
}
|
||||||
|
return executeLoadRequest(request, secrets, lookup)
|
||||||
|
}
|
||||||
|
|
||||||
|
func assembleLayeredInput[T any](request loadRequest[T], input assembledInput, accounting *importAccounting) (assembledInput, []Diagnostic) {
|
||||||
|
groups := make([]*composedDocument, 0, len(request.underlays))
|
||||||
|
for index, group := range request.underlays {
|
||||||
|
composition, sources, contexts, diagnostics := acquireUnderlayGroup(group, index+1, request.definition.Version, accounting)
|
||||||
|
input.sources = append(input.sources, sources...)
|
||||||
|
mergeResourceContexts(&input.contexts, contexts)
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
return input, diagnostics
|
||||||
|
}
|
||||||
|
if composition != nil {
|
||||||
|
groups = append(groups, composition)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var assembly *assemblyAccumulator
|
||||||
|
for _, group := range groups {
|
||||||
|
if assembly == nil {
|
||||||
|
assembly = newAssemblyAccumulator(group)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if diagnostics := assembly.applyOverlay(group.root, group.origins, group.applications, LayerUnderlay); len(diagnostics) != 0 {
|
||||||
|
return input, diagnostics
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if input.document != nil {
|
||||||
|
mainComposition, diagnostics := compositionForInput(input)
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
return input, diagnostics
|
||||||
|
}
|
||||||
|
if assembly == nil {
|
||||||
|
assembly = newAssemblyAccumulator(mainComposition)
|
||||||
|
} else if diagnostics := assembly.applyOverlay(mainComposition.root, mainComposition.origins, mainComposition.applications, LayerBase); len(diagnostics) != 0 {
|
||||||
|
return input, diagnostics
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if assembly == nil && (activeOverlay(request.overlay) || len(request.overrides) != 0) {
|
||||||
|
composition, _ := compositionForInput(assembledInput{})
|
||||||
|
assembly = newAssemblyAccumulator(composition)
|
||||||
|
}
|
||||||
|
if assembly == nil {
|
||||||
|
return input, nil
|
||||||
|
}
|
||||||
|
assembly.current.inputBytes = accounting.bytes
|
||||||
|
assembly.current.inputNodes = accounting.nodes
|
||||||
|
if activeOverlay(request.overlay) {
|
||||||
|
// The selected overlay context is independent of the main input. This
|
||||||
|
// synthetic descriptor creates no source record or input contribution.
|
||||||
|
selection := Source{kind: sourceBytes}
|
||||||
|
selected := parsedSource{document: &document.Node{Kind: document.Mapping}, source: &SourceInfo{}}
|
||||||
|
var diagnostics []Diagnostic
|
||||||
|
input.sources, diagnostics = loadSelectedOverlayInto(selection, request.overlayFilesystem, selected, assembly, input.sources, request.overlay, request.definition.Version, defaultImportLimits())
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
return input, diagnostics
|
||||||
|
}
|
||||||
|
contexts, diagnostic := contextsForAcquiredSources(selection, request.overlayFilesystem, selected.source, input.sources[len(input.sources)-1:])
|
||||||
|
if diagnostic != nil {
|
||||||
|
return input, []Diagnostic{*diagnostic}
|
||||||
|
}
|
||||||
|
mergeResourceContexts(&input.contexts, contexts)
|
||||||
|
}
|
||||||
|
if len(request.overrides) != 0 {
|
||||||
|
var diagnostics []Diagnostic
|
||||||
|
input.sources, diagnostics = assembly.applyOverrides(input.sources, request.overrides, request.definition.Version, defaultImportLimits())
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
return input, diagnostics
|
||||||
|
}
|
||||||
|
}
|
||||||
|
input.composition = assembly.current
|
||||||
|
input.document = assembly.current.root
|
||||||
|
return input, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func acquireUnderlayGroup(group loadGroup, index int, rule *VersionRule, accounting *importAccounting) (*composedDocument, []SourceInfo, map[string]ResourceContext, []Diagnostic) {
|
||||||
|
initialBytes, initialNodes := accounting.bytes, accounting.nodes
|
||||||
|
visited := make(map[resourceIdentity]importRoute)
|
||||||
|
hostToken := &namespaceToken{}
|
||||||
|
var documents []*document.Node
|
||||||
|
var sources []SourceInfo
|
||||||
|
var contexts map[string]ResourceContext
|
||||||
|
for _, contribution := range group.inputs {
|
||||||
|
options := Options[struct{}]{Imports: contribution.imports, Filesystem: contribution.filesystem, Definition: Definition[struct{}]{Version: rule}}
|
||||||
|
acquired, diagnostics := assembleBaseInputTracked(contribution.source, options, accounting, visited, hostToken)
|
||||||
|
for _, source := range acquired.sources {
|
||||||
|
source.Layer = LayerUnderlay
|
||||||
|
source.UnderlayIndex = index
|
||||||
|
sources = append(sources, source)
|
||||||
|
}
|
||||||
|
mergeResourceContexts(&contexts, acquired.contexts)
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
return nil, sources, contexts, diagnostics
|
||||||
|
}
|
||||||
|
if acquired.document == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if node := fragmentVersionClaim(acquired.document, rule); node != nil {
|
||||||
|
location := publicLocation(node.Location)
|
||||||
|
return nil, sources, contexts, []Diagnostic{{
|
||||||
|
Code: CodeUnderlayVersion, Severity: SeverityError, Path: rule.Path.clone(),
|
||||||
|
Message: "underlay inputs cannot contribute to the schema-version path", Primary: &location,
|
||||||
|
}}
|
||||||
|
}
|
||||||
|
if acquired.composition != nil {
|
||||||
|
for _, application := range acquired.composition.applications {
|
||||||
|
documents = append(documents, application.value)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
documents = append(documents, acquired.document)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(documents) == 0 {
|
||||||
|
return nil, sources, contexts, nil
|
||||||
|
}
|
||||||
|
composition, diagnostics := composeDocuments(documents...)
|
||||||
|
if len(diagnostics) != 0 {
|
||||||
|
return nil, sources, contexts, diagnostics
|
||||||
|
}
|
||||||
|
composition.inputBytes = accounting.bytes - initialBytes
|
||||||
|
composition.inputNodes = accounting.nodes - initialNodes
|
||||||
|
for pointer, origin := range composition.origins {
|
||||||
|
origin.Layer = LayerUnderlay
|
||||||
|
composition.origins[pointer] = origin
|
||||||
|
}
|
||||||
|
for index := range composition.applications {
|
||||||
|
composition.applications[index].layer = LayerUnderlay
|
||||||
|
}
|
||||||
|
return composition, sources, contexts, nil
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user