Archived
Compare commits
16
Commits
main
...
dc36536e19
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
dc36536e19 | ||
|
|
71362c196d | ||
|
|
617881c309 | ||
|
|
661918f4e4 | ||
|
|
def3ccefe3 | ||
|
|
912d76df25 | ||
|
|
3048dccd0e | ||
|
|
f0af09cfc7 | ||
|
|
85b85a3fa9 | ||
|
|
02b542a059 | ||
|
|
7530c2aeac | ||
|
|
f45e0a1de5 | ||
|
|
276f6755ab | ||
|
|
1ce4ab8c2a | ||
|
|
d43fbc202c | ||
|
|
bfc79c64d9 |
@@ -0,0 +1,6 @@
|
|||||||
|
# Release 57: config and provisioning
|
||||||
|
|
||||||
|
This branch carries the work of hq design 57 (ADR 0348, ADR 0349) in this repository. Each package
|
||||||
|
merges here through its own reviewed pull request; the branch reaches main as one pull request, in one
|
||||||
|
delivery group with the branch of the same name in mesh-controller, mesh-host, mesh-sdk, mesh-catalog
|
||||||
|
and hq, after a rehearsal in the lab. This file is deleted by the last commit before that pull request.
|
||||||
@@ -424,8 +424,9 @@ func comparisonOf(module string, c comparison, opts takeOptions) (preview string
|
|||||||
}
|
}
|
||||||
// And its settings on this machine, composed against its definition (rule 1, rule 6).
|
// And its settings on this machine, composed against its definition (rule 1, rule 6).
|
||||||
for _, layer := range c.layers {
|
for _, layer := range c.layers {
|
||||||
keys := make([]string, 0, len(layer.Values))
|
said := layer.Whole()
|
||||||
for k := range layer.Values {
|
keys := make([]string, 0, len(said))
|
||||||
|
for k := range said {
|
||||||
keys = append(keys, k)
|
keys = append(keys, k)
|
||||||
}
|
}
|
||||||
sort.Strings(keys)
|
sort.Strings(keys)
|
||||||
|
|||||||
@@ -55,6 +55,11 @@ func moduleCheckFor(paths []string, longestMachine int, out io.Writer) error {
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
m, err := catalogue.ParseManifest(raw)
|
m, err := catalogue.ParseManifest(raw)
|
||||||
|
if err == nil {
|
||||||
|
// Each template's text read from the tree beside the manifest, and judged as inline content is
|
||||||
|
// (novox/hq ADR 0349 §2): a missing template is refused by name.
|
||||||
|
m, err = catalogue.WithTemplatesFrom(m, filepath.Dir(path))
|
||||||
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fmt.Fprintf(out, "%s: %v\n", path, err)
|
fmt.Fprintf(out, "%s: %v\n", path, err)
|
||||||
failed++
|
failed++
|
||||||
|
|||||||
@@ -348,11 +348,11 @@ func gatherFacts(ctx context.Context, open *stores, busVersion string) (snapshot
|
|||||||
if layer.From == catalogue.MeshWideLayer {
|
if layer.From == catalogue.MeshWideLayer {
|
||||||
if !meshWide[module] {
|
if !meshWide[module] {
|
||||||
meshWide[module] = true
|
meshWide[module] = true
|
||||||
f.Settings = append(f.Settings, snapshot.Settings{Module: module, Values: scrub.Values(layer.Values)})
|
f.Settings = append(f.Settings, snapshot.Settings{Module: module, Values: scrub.Values(layer.Whole())})
|
||||||
}
|
}
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
m.Settings = append(m.Settings, snapshot.Settings{Module: module, Values: scrub.Values(layer.Values)})
|
m.Settings = append(m.Settings, snapshot.Settings{Module: module, Values: scrub.Values(layer.Whole())})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
m.Declaration = declarationFacts(ctx, open, n.Name, gens, gensErr, scrub)
|
m.Declaration = declarationFacts(ctx, open, n.Name, gens, gensErr, scrub)
|
||||||
|
|||||||
@@ -576,6 +576,11 @@ func shelfWithChange(base map[string]catalogue.Manifest, sources map[string]inve
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
m, err := catalogue.ParseManifest(raw)
|
m, err := catalogue.ParseManifest(raw)
|
||||||
|
if err == nil {
|
||||||
|
// Each template's text from the tree beside the manifest, as the build reads it back from the archive it
|
||||||
|
// packs (novox/hq ADR 0349 §2): so a change to a template alone is a change to its module.
|
||||||
|
m, err = catalogue.WithTemplatesFrom(m, filepath.Dir(path))
|
||||||
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
if inScope(dir) {
|
if inScope(dir) {
|
||||||
failures = append(failures, fmt.Sprintf("%s: the controller judging this (%s) refuses it — %s",
|
failures = append(failures, fmt.Sprintf("%s: the controller judging this (%s) refuses it — %s",
|
||||||
|
|||||||
@@ -33,7 +33,21 @@ import (
|
|||||||
func aMesh(t *testing.T) *stores {
|
func aMesh(t *testing.T) *stores {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
inventory.ForTest(t) // raises the store, migrates it, and points the environment at it
|
inventory.ForTest(t) // raises the store, migrates it, and points the environment at it
|
||||||
licences.ForTest(t) // planning reaches this one too, by name and never by connection
|
return aMeshOnTheStore(t)
|
||||||
|
}
|
||||||
|
|
||||||
|
// aMeshBefore is aMesh on a store migrated only below migration `number`, with the function that runs the
|
||||||
|
// rest: for a test of what a migration that moves data does to what the mesh composes (novox/hq issue 651).
|
||||||
|
func aMeshBefore(t *testing.T, number int) (*stores, func()) {
|
||||||
|
t.Helper()
|
||||||
|
_, migrate := inventory.ForTestBefore(t, number)
|
||||||
|
return aMeshOnTheStore(t), migrate
|
||||||
|
}
|
||||||
|
|
||||||
|
// aMeshOnTheStore is the mesh aMesh makes, on the store the environment points at.
|
||||||
|
func aMeshOnTheStore(t *testing.T) *stores {
|
||||||
|
t.Helper()
|
||||||
|
licences.ForTest(t) // planning reaches this one too, by name and never by connection
|
||||||
|
|
||||||
open, err := openStores(t.Context())
|
open, err := openStores(t.Context())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"net"
|
"net"
|
||||||
"os"
|
"os"
|
||||||
|
"path/filepath"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
@@ -127,6 +128,10 @@ func moduleCommand(ctx context.Context, args []string) error {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
// A manifest handed over by hand takes each template's text from the tree beside it (novox/hq ADR 0349 §2).
|
||||||
|
if m, err = catalogue.WithTemplatesFrom(m, filepath.Dir(positionals[0])); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
from, err := whereItComesFrom(*repo, *ref, *commit, *path, *self)
|
from, err := whereItComesFrom(*repo, *ref, *commit, *path, *self)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -537,6 +542,10 @@ func settingsCommand(ctx context.Context, args []string) error {
|
|||||||
if p.SetBy != "" {
|
if p.SetBy != "" {
|
||||||
by = "; " + p.SetBy
|
by = "; " + p.SetBy
|
||||||
}
|
}
|
||||||
|
if p.Why != "" {
|
||||||
|
// A layer whose placement moved out of it (migration 0097): still the layer, as it stands.
|
||||||
|
by += "; " + p.Why
|
||||||
|
}
|
||||||
fmt.Printf("%s on %s, until %s (%s%s):\n %s\n", positionals[0], where,
|
fmt.Printf("%s on %s, until %s (%s%s):\n %s\n", positionals[0], where,
|
||||||
p.ReplacedAt.Local().Format("2006-01-02 15:04:05"), p.ReplacedBy, by, shown)
|
p.ReplacedAt.Local().Format("2006-01-02 15:04:05"), p.ReplacedBy, by, shown)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,113 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/novox/mesh-controller/internal/catalogue"
|
||||||
|
)
|
||||||
|
|
||||||
|
// **Placement leaves the settings layers and no machine is told anything new** (novox/hq ADR 0348 clause
|
||||||
|
// 11, issue 651). A mesh is seeded as the store holds it before migration 0097 — `places`, `accesses` and a
|
||||||
|
// kept network among the settings, at the mesh's level and a machine's, one layer of placement only — then
|
||||||
|
// migrated, and every machine's declaration is composed. What each machine is told of the seeded modules is
|
||||||
|
// byte for byte what the controller before this change composed from the same seed: the golden files were
|
||||||
|
// written by the integration branch's controller at bfc79c6 running this same test (MESH_WRITE_GOLDEN=1),
|
||||||
|
// where there was no migration 0097 to run.
|
||||||
|
func TestADeclarationIsTheSameAfterPlacementMoves(t *testing.T) {
|
||||||
|
open, migrate := aMeshBefore(t, 97)
|
||||||
|
ctx := t.Context()
|
||||||
|
inv := open.inventory
|
||||||
|
image := "registry.invalid:5000/library@sha256:" + strings.Repeat("a", 64)
|
||||||
|
register(t, open, catalogue.Manifest{Module: "library", Version: "1",
|
||||||
|
Accesses: []catalogue.Access{{ID: "series"}, {ID: "downloads", Mode: catalogue.AccessRead}},
|
||||||
|
Resources: []map[string]any{
|
||||||
|
{"id": "config", "type": "directory", "mode": "0750"},
|
||||||
|
{"id": "server", "type": "container", "image": image,
|
||||||
|
"volumes": []any{"${dir:config}:/config", "${access:series}:/series", "${access:downloads}:/downloads:ro"}},
|
||||||
|
// Today's form: a mergeable file naming no keys takes every key of the layer (ADR 0326 §3).
|
||||||
|
{"id": "runtime-config", "type": "file", "path": "${dir:config}/runtime.json", "mode": "0640",
|
||||||
|
"content": `{"log":"info"}`, "merge": "json"},
|
||||||
|
}})
|
||||||
|
register(t, open, catalogue.Manifest{Module: "found", Version: "1",
|
||||||
|
Resources: []map[string]any{{"id": "server", "type": "container", "image": image}}})
|
||||||
|
if err := inv.SetAdopted(ctx, "anchor", true); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for _, l := range []struct{ node, module, values string }{
|
||||||
|
{"", "library", `{"accesses": {"downloads": "/storage/downloads"}, "log": "warn"}`},
|
||||||
|
{"anchor", "library", `{"places": {"config": {"path": "/var/lib/library/config", "owner": "1001:2000"}},
|
||||||
|
"accesses": {"series": "/storage/media/series"}, "workers": 4}`},
|
||||||
|
{"laptop", "library", `{"accesses": {"series": "/home/media/series"}}`},
|
||||||
|
{"anchor", "found", `{"networks": {"server": ["predecessor_default"]}}`},
|
||||||
|
} {
|
||||||
|
if l.node == "" {
|
||||||
|
inv.ExecForTest(t, `insert into settings (node, module, values) values (null, $1, $2)`, l.module, l.values)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
inv.ExecForTest(t, `insert into settings (node, module, values) select id, $2, $3 from node where name = $1`,
|
||||||
|
l.node, l.module, l.values)
|
||||||
|
}
|
||||||
|
|
||||||
|
migrate()
|
||||||
|
// Assigned once the store is migrated: an assignment reads the layers, as this controller holds them.
|
||||||
|
for _, a := range [][]string{{"anchor", "library", "found"}, {"laptop", "library"}} {
|
||||||
|
if _, err := assign(ctx, open, a[0], a[1:]...); err != nil {
|
||||||
|
t.Fatalf("assign %v: %v", a, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
gens, err := generators(ctx, open)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for _, node := range []string{"anchor", "laptop"} {
|
||||||
|
plan, settings, err := planFor(ctx, open, node)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
with, _, err := renderingFor(ctx, open, node, plan, settings, gens, Allocating)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
composed, err := plan.Compose(with)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if len(composed.LeftOut) > 0 {
|
||||||
|
t.Fatalf("%s leaves out %v", node, composed.LeftOut)
|
||||||
|
}
|
||||||
|
var told []map[string]any
|
||||||
|
for _, r := range composed.Resources {
|
||||||
|
if owner := composed.Owner[r["id"].(string)]; owner == "library" || owner == "found" {
|
||||||
|
told = append(told, r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Slice(told, func(i, j int) bool { return told[i]["id"].(string) < told[j]["id"].(string) })
|
||||||
|
got, err := json.MarshalIndent(told, "", " ")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
golden := filepath.Join("testdata", "placement-moved", node+".json")
|
||||||
|
if os.Getenv("MESH_WRITE_GOLDEN") != "" {
|
||||||
|
if err := os.MkdirAll(filepath.Dir(golden), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(golden, append(got, '\n'), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
want, err := os.ReadFile(golden)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if string(want) != string(got)+"\n" {
|
||||||
|
t.Errorf("%s is told something else after placement moved:\n%s\nwas:\n%s", node, got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,204 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/novox/mesh-controller/internal/catalogue"
|
||||||
|
snapshot "github.com/novox/mesh-controller/internal/facts"
|
||||||
|
"github.com/novox/mesh-controller/internal/inventory"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A file's text kept as a template file in its module's repository (novox/hq ADR 0349 §2, design 57 package T1,
|
||||||
|
// issue 654): `module check` and the merge gate read it from the tree beside the manifest, so a change to a
|
||||||
|
// template alone is judged as a change to its module.
|
||||||
|
|
||||||
|
const templatedNotifier = `{"module":"notifier","version":"1",
|
||||||
|
"build":{"artifacts":[{"name":"files","kind":"archive","from":"files"}]},
|
||||||
|
"resources":[{"id":"conf","type":"file","path":"/etc/notifier/notifier.conf","mode":"0644","template":"files/notifier.conf"}]}`
|
||||||
|
|
||||||
|
// inlineNotifier is the same module as the mesh holds it: built, its text inline.
|
||||||
|
const inlineNotifier = `{"module":"notifier","version":"1",
|
||||||
|
"resources":[{"id":"conf","type":"file","path":"/etc/notifier/notifier.conf","mode":"0644","content":"volume = 3\n"}]}`
|
||||||
|
|
||||||
|
// aTemplatedModule writes a module's directory: its manifest and its files/.
|
||||||
|
func aTemplatedModule(t *testing.T, dir, manifest string, files map[string]string) string {
|
||||||
|
t.Helper()
|
||||||
|
if err := os.MkdirAll(dir, 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
path := filepath.Join(dir, "module.json")
|
||||||
|
if err := os.WriteFile(path, []byte(manifest), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for name, text := range files {
|
||||||
|
full := filepath.Join(dir, filepath.FromSlash(name))
|
||||||
|
if err := os.MkdirAll(filepath.Dir(full), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(full, []byte(text), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return path
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestModuleCheckReadsTemplatesFromTheTreeBesideTheManifest(t *testing.T) {
|
||||||
|
good := aTemplatedModule(t, t.TempDir(), templatedNotifier, map[string]string{"files/notifier.conf": "volume = 3\n"})
|
||||||
|
var out bytes.Buffer
|
||||||
|
if err := moduleCheck([]string{good}, &out); err != nil || !strings.Contains(out.String(), "notifier: ok") {
|
||||||
|
t.Fatalf("a module with its text in files/ was refused: %v\n%s", err, out.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
// A change to the template alone, to text the controller refuses inline, is refused the same.
|
||||||
|
bad := aTemplatedModule(t, t.TempDir(), templatedNotifier,
|
||||||
|
map[string]string{"files/notifier.conf": "volume = 3\nstore = ${dir:nowhere}\n"})
|
||||||
|
out.Reset()
|
||||||
|
if err := moduleCheck([]string{bad}, &out); err == nil || !strings.Contains(out.String(), "nowhere") {
|
||||||
|
t.Fatalf("a template whose text is refused inline passed:\n%s", out.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
// A symlink under files/ that no template names: the build's packing refuses it, so the check does too.
|
||||||
|
linked := t.TempDir()
|
||||||
|
aTemplatedModule(t, linked, templatedNotifier, map[string]string{"files/notifier.conf": "volume = 3\n"})
|
||||||
|
if err := os.Symlink("/etc/hostname", filepath.Join(linked, "files", "elsewhere")); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
out.Reset()
|
||||||
|
if err := moduleCheck([]string{filepath.Join(linked, "module.json")}, &out); err == nil ||
|
||||||
|
!strings.Contains(out.String(), "files/elsewhere is a symlink") {
|
||||||
|
t.Fatalf("a symlink under files/ passed the check:\n%s", out.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
// And a template the tree lacks, by name.
|
||||||
|
missing := aTemplatedModule(t, t.TempDir(), templatedNotifier, nil)
|
||||||
|
out.Reset()
|
||||||
|
if err := moduleCheck([]string{missing}, &out); err == nil || !strings.Contains(out.String(), "files/notifier.conf") {
|
||||||
|
t.Fatalf("a missing template was not refused by name:\n%s", out.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// templatedMesh is catalogueMesh with the notifier on the laptop, registered as built: its text inline.
|
||||||
|
func templatedMesh(t *testing.T) (snapshot.Facts, map[string]string) {
|
||||||
|
t.Helper()
|
||||||
|
open := aMesh(t)
|
||||||
|
ctx := t.Context()
|
||||||
|
manifests := map[string]string{
|
||||||
|
"lemurs": `{"module":"lemurs","version":"1","capabilities":["systemd"],
|
||||||
|
"resources":[{"id":"service","type":"service","unit":"lemurs.service","state":"running","boot":"enabled"}]}`,
|
||||||
|
"notifier": inlineNotifier,
|
||||||
|
}
|
||||||
|
for name, raw := range manifests {
|
||||||
|
m, err := catalogue.ParseManifest([]byte(raw))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("%s: %v", name, err)
|
||||||
|
}
|
||||||
|
if err := open.inventory.RegisterModule(ctx, m, inventory.Source{Repository: "novox/mesh-catalog",
|
||||||
|
Path: "modules/" + name, BuiltFrom: "c0ffee"}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := assign(ctx, open, "laptop", name); err != nil {
|
||||||
|
t.Fatalf("assign %s: %v", name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
f, err := gatherFacts(ctx, open, "2.11.17")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return f, manifests
|
||||||
|
}
|
||||||
|
|
||||||
|
// aTemplatedTree is the catalogue's checkout with the notifier's text in files/.
|
||||||
|
func aTemplatedTree(t *testing.T, manifests map[string]string, text string, has bool) string {
|
||||||
|
t.Helper()
|
||||||
|
tree := aTree(t, withEdit(manifests, "notifier", ""))
|
||||||
|
files := map[string]string{}
|
||||||
|
if has {
|
||||||
|
files["files/notifier.conf"] = text
|
||||||
|
}
|
||||||
|
aTemplatedModule(t, filepath.Join(tree, "modules", "notifier"), templatedNotifier, files)
|
||||||
|
return tree
|
||||||
|
}
|
||||||
|
|
||||||
|
const notifierTemplate = "modules/notifier/files/notifier.conf"
|
||||||
|
|
||||||
|
func TestTheMergeGateJudgesAChangeToATemplateAlone(t *testing.T) {
|
||||||
|
f, manifests := templatedMesh(t)
|
||||||
|
|
||||||
|
// The module moved to its template, the same text: nothing changes on any machine.
|
||||||
|
v := gateJudged(t, f, aTemplatedTree(t, manifests, "volume = 3\n", true), "modules/notifier/module.json",
|
||||||
|
notifierTemplate)
|
||||||
|
if v.Verdict == "fail" || v.Modules["notifier"] != "" {
|
||||||
|
t.Fatalf("the module moved to its template with the same text reads as a change (%v):\n%s", v.Modules, v.Report())
|
||||||
|
}
|
||||||
|
|
||||||
|
// The template alone changed: its module changed, and composes.
|
||||||
|
v = gateJudged(t, f, aTemplatedTree(t, manifests, "volume = 4\n", true), notifierTemplate)
|
||||||
|
if v.Verdict == "fail" || v.Modules["notifier"] != "changed" {
|
||||||
|
t.Fatalf("a change to the template alone is not a change to its module (%v):\n%s", v.Modules, v.Report())
|
||||||
|
}
|
||||||
|
if v.Width == nil || strings.Join(v.Width.Modules, ",") != "notifier" {
|
||||||
|
t.Fatalf("a change to the template rebuilds %+v, not its module", v.Width)
|
||||||
|
}
|
||||||
|
|
||||||
|
// The template alone changed to text the controller refuses: the pull request fails, naming the module.
|
||||||
|
v = gateJudged(t, f, aTemplatedTree(t, manifests, "store = ${dir:nowhere}\n", true), notifierTemplate)
|
||||||
|
if v.Verdict != "fail" || !strings.Contains(v.Report(), "notifier") {
|
||||||
|
t.Fatalf("a template the controller refuses passed the gate:\n%s", v.Report())
|
||||||
|
}
|
||||||
|
|
||||||
|
// A symlinked files/ fails: nothing is read from outside the tree.
|
||||||
|
tree := aTree(t, withEdit(manifests, "notifier", ""))
|
||||||
|
elsewhere := t.TempDir()
|
||||||
|
if err := os.WriteFile(filepath.Join(elsewhere, "notifier.conf"), []byte("volume = 3\n"), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
aTemplatedModule(t, filepath.Join(tree, "modules", "notifier"), templatedNotifier, nil)
|
||||||
|
if err := os.Symlink(elsewhere, filepath.Join(tree, "modules", "notifier", "files")); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
v = gateJudged(t, f, tree, notifierTemplate)
|
||||||
|
if v.Verdict != "fail" || !strings.Contains(v.Report(), "files/ is a symlink") {
|
||||||
|
t.Fatalf("a symlinked files/ passed the gate:\n%s", v.Report())
|
||||||
|
}
|
||||||
|
|
||||||
|
// And the template removed from the tree fails, naming it.
|
||||||
|
v = gateJudged(t, f, aTemplatedTree(t, manifests, "", false), notifierTemplate)
|
||||||
|
if v.Verdict != "fail" || !strings.Contains(v.Report(), "files/notifier.conf") {
|
||||||
|
t.Fatalf("a missing template passed the gate:\n%s", v.Report())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// What the gate composes for the module in its template form is what the mesh composes for it inline.
|
||||||
|
func TestTheMergeGateResolvesATemplatedModuleToItsInlineTwin(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := aTemplatedModule(t, dir, templatedNotifier, map[string]string{"files/notifier.conf": "volume = 3\n"})
|
||||||
|
raw, err := os.ReadFile(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
m, err := catalogue.ParseManifest(raw)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
m, err = catalogue.WithTemplatesFrom(m, dir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
resolved, err := standInBuild(m)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
inline, err := catalogue.ParseManifest([]byte(inlineNotifier))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if builtAlike(resolved) != builtAlike(inline) {
|
||||||
|
got, _ := json.Marshal(resolved)
|
||||||
|
t.Fatalf("the templated module resolves to %s, not its inline twin", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
[
|
||||||
|
{
|
||||||
|
"id": "found.server",
|
||||||
|
"image": "registry.invalid:5000/library@sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
|
||||||
|
"networks": [
|
||||||
|
"predecessor_default"
|
||||||
|
],
|
||||||
|
"type": "container"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "library.access-storage/downloads",
|
||||||
|
"mode": "read",
|
||||||
|
"path": "/storage/downloads",
|
||||||
|
"type": "access"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "library.access-storage/media/series",
|
||||||
|
"mode": "read",
|
||||||
|
"path": "/storage/media/series",
|
||||||
|
"type": "access"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "library.config",
|
||||||
|
"mode": "0750",
|
||||||
|
"owner": "1001:2000",
|
||||||
|
"path": "/var/lib/library/config",
|
||||||
|
"type": "directory"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"content": "{\n \"accesses\": {\n \"downloads\": \"/storage/downloads\",\n \"series\": \"/storage/media/series\"\n },\n \"log\": \"warn\",\n \"places\": {\n \"config\": {\n \"owner\": \"1001:2000\",\n \"path\": \"/var/lib/library/config\"\n }\n },\n \"workers\": 4\n}\n",
|
||||||
|
"id": "library.runtime-config",
|
||||||
|
"mode": "0640",
|
||||||
|
"path": "/var/lib/library/config/runtime.json",
|
||||||
|
"type": "file"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "library.server",
|
||||||
|
"image": "registry.invalid:5000/library@sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
|
||||||
|
"type": "container",
|
||||||
|
"volumes": [
|
||||||
|
"/var/lib/library/config:/config",
|
||||||
|
"/storage/media/series:/series",
|
||||||
|
"/storage/downloads:/downloads:ro"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
[
|
||||||
|
{
|
||||||
|
"id": "library.access-home/media/series",
|
||||||
|
"mode": "read",
|
||||||
|
"path": "/home/media/series",
|
||||||
|
"type": "access"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "library.access-storage/downloads",
|
||||||
|
"mode": "read",
|
||||||
|
"path": "/storage/downloads",
|
||||||
|
"type": "access"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "library.config",
|
||||||
|
"mode": "0750",
|
||||||
|
"path": "/var/lib/library/config",
|
||||||
|
"type": "directory"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"content": "{\n \"accesses\": {\n \"downloads\": \"/storage/downloads\",\n \"series\": \"/home/media/series\"\n },\n \"log\": \"warn\"\n}\n",
|
||||||
|
"id": "library.runtime-config",
|
||||||
|
"mode": "0640",
|
||||||
|
"path": "/var/lib/library/config/runtime.json",
|
||||||
|
"type": "file"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "library.server",
|
||||||
|
"image": "registry.invalid:5000/library@sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
|
||||||
|
"type": "container",
|
||||||
|
"volumes": [
|
||||||
|
"/var/lib/library/config:/config",
|
||||||
|
"/home/media/series:/series",
|
||||||
|
"/storage/downloads:/downloads:ro"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
@@ -268,7 +268,14 @@ func build(ctx context.Context, run Runner, publish Publisher,
|
|||||||
}
|
}
|
||||||
// What is judged only where a definition is written (novox/hq ADR 0326 §3, issue 574): a build is
|
// What is judged only where a definition is written (novox/hq ADR 0326 §3, issue 574): a build is
|
||||||
// where a changed definition is first read, so it is refused here before anything is made of it.
|
// where a changed definition is first read, so it is refused here before anything is made of it.
|
||||||
if problems := catalogue.WrittenSettingsProblems(manifest); len(problems) > 0 {
|
// Judged with each template's text in its file, as written in the tree (novox/hq ADR 0349 §2): a template the
|
||||||
|
// module's directory lacks is refused here, before anything is built.
|
||||||
|
judged, err := catalogue.WithTemplatesFrom(manifest, within)
|
||||||
|
if err != nil {
|
||||||
|
say("manifest", "INVALID: %v", err)
|
||||||
|
return Result{}, err
|
||||||
|
}
|
||||||
|
if problems := catalogue.WrittenSettingsProblems(judged); len(problems) > 0 {
|
||||||
err := fmt.Errorf("%s", strings.Join(problems, "; "))
|
err := fmt.Errorf("%s", strings.Join(problems, "; "))
|
||||||
say("manifest", "INVALID: %v", err)
|
say("manifest", "INVALID: %v", err)
|
||||||
return Result{}, err
|
return Result{}, err
|
||||||
@@ -410,6 +417,11 @@ func build(ctx context.Context, run Runner, publish Publisher,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Each template's text, read back from the archive the build made or took (novox/hq ADR 0349 §2).
|
||||||
|
if built, err = withTemplateTexts(manifest, within, built); err != nil {
|
||||||
|
say("templates", "FAILED: %v", err)
|
||||||
|
return Result{}, err
|
||||||
|
}
|
||||||
resolved, err := manifest.Resolve(built)
|
resolved, err := manifest.Resolve(built)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
say("resolve", "FAILED: %v", err)
|
say("resolve", "FAILED: %v", err)
|
||||||
|
|||||||
@@ -73,8 +73,14 @@ const reusedModule = `{"module":"meshboard","version":"1",
|
|||||||
// aModuleAt is a repository holding the module under mod/, whose directory git names as tree, on its trunk.
|
// aModuleAt is a repository holding the module under mod/, whose directory git names as tree, on its trunk.
|
||||||
func aModuleAt(t *testing.T, tree string) (*recorded, Runner, string) {
|
func aModuleAt(t *testing.T, tree string) (*recorded, Runner, string) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
r := &recorded{tree: tree, contents: map[string]string{"mod/" + ManifestName: reusedModule,
|
return aModuleWith(t, tree, map[string]string{"mod/" + ManifestName: reusedModule,
|
||||||
"mod/Dockerfile": "FROM scratch", "mod/files/theme.conf": "dark"}}
|
"mod/Dockerfile": "FROM scratch", "mod/files/theme.conf": "dark"})
|
||||||
|
}
|
||||||
|
|
||||||
|
// aModuleWith is aModuleAt with the repository's files given.
|
||||||
|
func aModuleWith(t *testing.T, tree string, contents map[string]string) (*recorded, Runner, string) {
|
||||||
|
t.Helper()
|
||||||
|
r := &recorded{tree: tree, contents: contents}
|
||||||
run := func(ctx context.Context, dir, name string, args ...string) (string, error) {
|
run := func(ctx context.Context, dir, name string, args ...string) (string, error) {
|
||||||
if name == "git" && len(args) > 0 && args[0] == "symbolic-ref" {
|
if name == "git" && len(args) > 0 && args[0] == "symbolic-ref" {
|
||||||
r.ran = append(r.ran, name+" "+strings.Join(args, " "))
|
r.ran = append(r.ran, name+" "+strings.Join(args, " "))
|
||||||
@@ -100,6 +106,12 @@ var aPull = PullRef{Owner: "novox", Repo: "meshboard", Number: 7}
|
|||||||
func aCheckBuilt(t *testing.T, scratch *aScratch, tree string) CheckBuilt {
|
func aCheckBuilt(t *testing.T, scratch *aScratch, tree string) CheckBuilt {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
r, run, workspace := aModuleAt(t, tree)
|
r, run, workspace := aModuleAt(t, tree)
|
||||||
|
return aCheckBuiltBy(t, scratch, r, run, workspace)
|
||||||
|
}
|
||||||
|
|
||||||
|
// aCheckBuiltBy is aCheckBuilt of the repository given.
|
||||||
|
func aCheckBuiltBy(t *testing.T, scratch *aScratch, r *recorded, run Runner, workspace string) CheckBuilt {
|
||||||
|
t.Helper()
|
||||||
spec := CheckSpec{ID: "build-1", Owner: aPull.Owner, Repo: aPull.Repo, Number: aPull.Number,
|
spec := CheckSpec{ID: "build-1", Owner: aPull.Owner, Repo: aPull.Repo, Number: aPull.Number,
|
||||||
Builds: []CheckBuildSpec{{Module: "meshboard", Repository: "https://forge.invalid/meshboard.git", Path: "mod",
|
Builds: []CheckBuildSpec{{Module: "meshboard", Repository: "https://forge.invalid/meshboard.git", Path: "mod",
|
||||||
Ref: "main"}}}
|
Ref: "main"}}}
|
||||||
|
|||||||
@@ -0,0 +1,94 @@
|
|||||||
|
package builder
|
||||||
|
|
||||||
|
import (
|
||||||
|
"archive/tar"
|
||||||
|
"bytes"
|
||||||
|
"compress/gzip"
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/hex"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"path/filepath"
|
||||||
|
|
||||||
|
"github.com/novox/mesh-controller/internal/catalogue"
|
||||||
|
)
|
||||||
|
|
||||||
|
// withTemplateTexts is what was built with each template's text, for a module whose files name templates
|
||||||
|
// (novox/hq ADR 0349 §2): its templates archive gains the text of every file in it, read back from the packed
|
||||||
|
// bytes, by its path inside the archive. Resolve reads them into the files' content.
|
||||||
|
//
|
||||||
|
// **Read from the archive, proven by its digest.** The module's files/ is packed again, as the build packs it,
|
||||||
|
// and the bytes are read only when they hash to the digest the build made or took: a fresh build's own archive,
|
||||||
|
// or a check's build a walk copied by digest without building (novox/hq ADR 0350 §2). Packing is deterministic,
|
||||||
|
// so one source packs to one digest; a tree that packs to another is not the archive, and its text is refused.
|
||||||
|
func withTemplateTexts(manifest catalogue.Manifest, within string, built []catalogue.Built) ([]catalogue.Built, error) {
|
||||||
|
if !manifest.Templated() {
|
||||||
|
return built, nil
|
||||||
|
}
|
||||||
|
name := catalogue.TemplatesArtifact(manifest)
|
||||||
|
at := -1
|
||||||
|
for i, b := range built {
|
||||||
|
if b.Name == name {
|
||||||
|
at = i
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if name == "" || at < 0 {
|
||||||
|
return nil, fmt.Errorf("%s names templates and built no archive of %s/ to read them from",
|
||||||
|
manifest.Module, catalogue.TemplatesDir)
|
||||||
|
}
|
||||||
|
body, err := pack(filepath.Join(within, catalogue.TemplatesDir))
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("%s: packing %s/ to read its templates back failed: %w", manifest.Module,
|
||||||
|
catalogue.TemplatesDir, err)
|
||||||
|
}
|
||||||
|
sum := sha256.Sum256(body)
|
||||||
|
digest := "sha256:" + hex.EncodeToString(sum[:])
|
||||||
|
if built[at].Digest != digest {
|
||||||
|
return nil, fmt.Errorf("%s: %s/ packs to the digest %s, and the archive %q built or taken is %s: the "+
|
||||||
|
"templates are read only from the archive the mesh records", manifest.Module, catalogue.TemplatesDir,
|
||||||
|
digest, name, orNone(built[at].Digest))
|
||||||
|
}
|
||||||
|
texts, err := unpackTexts(body)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("%s: reading the archive %q back failed: %w", manifest.Module, name, err)
|
||||||
|
}
|
||||||
|
out := append([]catalogue.Built(nil), built...)
|
||||||
|
out[at].Texts = texts
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// unpackTexts is every file of a packed archive (pack), by its path inside it.
|
||||||
|
func unpackTexts(body []byte) (map[string]string, error) {
|
||||||
|
zipped, err := gzip.NewReader(bytes.NewReader(body))
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer zipped.Close()
|
||||||
|
reader := tar.NewReader(zipped)
|
||||||
|
texts := map[string]string{}
|
||||||
|
for {
|
||||||
|
header, err := reader.Next()
|
||||||
|
if errors.Is(err, io.EOF) {
|
||||||
|
return texts, nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if header.Typeflag != tar.TypeReg {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
text, err := io.ReadAll(reader)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
texts[header.Name] = string(text)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func orNone(digest string) string {
|
||||||
|
if digest == "" {
|
||||||
|
return "no digest"
|
||||||
|
}
|
||||||
|
return digest
|
||||||
|
}
|
||||||
@@ -0,0 +1,136 @@
|
|||||||
|
package builder
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/novox/mesh-controller/internal/catalogue"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A module's files kept as template files in its repository (novox/hq ADR 0349 §2, design 57 package T1, issue
|
||||||
|
// 654): the build packs files/ into the module's templates archive and reads each template's text back from the
|
||||||
|
// packed bytes into the file's content, so the manifest the mesh holds is the one it would hold for the text inline.
|
||||||
|
|
||||||
|
const templatedModule = `{"module":"meshboard","version":"1",
|
||||||
|
"build":{"artifacts":[
|
||||||
|
{"name":"server","kind":"image","from":"Dockerfile"},
|
||||||
|
{"name":"files","kind":"archive","from":"files"}]},
|
||||||
|
"resources":[
|
||||||
|
{"id":"svc","type":"container","name":"meshboard","artifact":"server"},
|
||||||
|
{"id":"conf","type":"file","path":"/etc/meshboard/meshboard.conf","template":"files/meshboard.conf"},
|
||||||
|
{"id":"deeper","type":"file","path":"/etc/meshboard/deeper.conf","template":"files/a/deeper.conf"}]}`
|
||||||
|
|
||||||
|
var templatedFiles = map[string]string{
|
||||||
|
"Dockerfile": "FROM scratch", "files/meshboard.conf": "listen = 8080\n\"quoted\" é\n",
|
||||||
|
"files/a/deeper.conf": "deeper\n", "files/unused.conf": "packed, named by nothing",
|
||||||
|
}
|
||||||
|
|
||||||
|
func contentOf(t *testing.T, m catalogue.Manifest, id string) string {
|
||||||
|
t.Helper()
|
||||||
|
for _, r := range m.Resources {
|
||||||
|
if r["id"] == id {
|
||||||
|
if _, has := r[catalogue.TemplateField]; has {
|
||||||
|
t.Fatalf("%s still names its template in the built manifest: %v", id, r)
|
||||||
|
}
|
||||||
|
text, ok := r["content"].(string)
|
||||||
|
if !ok {
|
||||||
|
t.Fatalf("%s carries no content: %v", id, r)
|
||||||
|
}
|
||||||
|
return text
|
||||||
|
}
|
||||||
|
}
|
||||||
|
t.Fatalf("no resource %s in %v", id, m.Resources)
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestABuildReadsEachTemplateBackFromItsArchive(t *testing.T) {
|
||||||
|
r, workspace := aRepository(t, templatedModule, templatedFiles)
|
||||||
|
got, err := Build(context.Background(), r.run, r, "https://forge.invalid/meshboard.git", "", "", workspace, nil,
|
||||||
|
Npmrc{}, GitCredential{}, nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if text := contentOf(t, got.Manifest, "conf"); text != templatedFiles["files/meshboard.conf"] {
|
||||||
|
t.Fatalf("the template's text is %q, not the file's", text)
|
||||||
|
}
|
||||||
|
if text := contentOf(t, got.Manifest, "deeper"); text != templatedFiles["files/a/deeper.conf"] {
|
||||||
|
t.Fatalf("the template's text is %q, not the file's", text)
|
||||||
|
}
|
||||||
|
if r.archives["meshboard/files"] == "" {
|
||||||
|
t.Fatalf("the templates archive was not published: %v", r.archives)
|
||||||
|
}
|
||||||
|
if problem := catalogue.HeldTemplateProblem(got.Manifest); problem != "" {
|
||||||
|
t.Fatal(problem)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestABuildWhoseTemplateIsMissingFailsNamingIt(t *testing.T) {
|
||||||
|
files := map[string]string{}
|
||||||
|
for k, v := range templatedFiles {
|
||||||
|
files[k] = v
|
||||||
|
}
|
||||||
|
delete(files, "files/a/deeper.conf")
|
||||||
|
r, workspace := aRepository(t, templatedModule, files)
|
||||||
|
_, err := Build(context.Background(), r.run, r, "https://forge.invalid/meshboard.git", "", "", workspace, nil,
|
||||||
|
Npmrc{}, GitCredential{}, nil)
|
||||||
|
if err == nil || !strings.Contains(err.Error(), "files/a/deeper.conf") {
|
||||||
|
t.Fatalf("a build whose template is missing did not fail naming it: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A walk that takes its check's build copies the archive by digest and builds nothing: the templates are read back
|
||||||
|
// from the tree packed again, which is the archive only when it packs to the digest taken.
|
||||||
|
func TestAWalkTakingAChecksBuildReadsTheTemplatesBackToo(t *testing.T) {
|
||||||
|
withVersion(t, "builder-1")
|
||||||
|
contents := map[string]string{"mod/" + ManifestName: templatedModule}
|
||||||
|
for k, v := range templatedFiles {
|
||||||
|
contents["mod/"+k] = v
|
||||||
|
}
|
||||||
|
scratch := newScratch()
|
||||||
|
r, run, workspace := aModuleWith(t, "tree-one", contents)
|
||||||
|
checked := aCheckBuiltBy(t, scratch, r, run, workspace)
|
||||||
|
|
||||||
|
r, run, workspace = aModuleWith(t, "tree-one", contents)
|
||||||
|
got, err := BuildReusing(t.Context(), run, r, Reuse{Scratch: scratch, Pulls: []PullRef{aPull}, Named: named(checked)},
|
||||||
|
"https://forge.invalid/meshboard.git", "mod", "main", workspace, nil, Npmrc{}, GitCredential{}, nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got.Reused == nil || len(r.archives) > 0 {
|
||||||
|
t.Fatalf("the walk built again: reused %+v, why %q, published %v", got.Reused, got.Why, r.archives)
|
||||||
|
}
|
||||||
|
if text := contentOf(t, got.Manifest, "conf"); text != templatedFiles["files/meshboard.conf"] {
|
||||||
|
t.Fatalf("the template's text is %q, not the file's", text)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The tree packed again must be the archive taken; text read from anything else is not the archive's.
|
||||||
|
func TestTemplateTextsAreRefusedWhenTheTreeDoesNotPackToTheDigestTaken(t *testing.T) {
|
||||||
|
m, err := catalogue.ParseManifest([]byte(templatedModule))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
within := writeTree(t, t.TempDir(), templatedFiles)
|
||||||
|
built := []catalogue.Built{{Name: "files", Kind: catalogue.ArtifactArchive, Digest: "sha256:" + strings.Repeat("0", 64)}}
|
||||||
|
if _, err := withTemplateTexts(m, within, built); err == nil || !strings.Contains(err.Error(), "digest") {
|
||||||
|
t.Fatalf("text was read from a tree that does not pack to the archive taken: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// writeTree writes files under dir and answers dir.
|
||||||
|
func writeTree(t *testing.T, dir string, files map[string]string) string {
|
||||||
|
t.Helper()
|
||||||
|
for name, body := range files {
|
||||||
|
full := filepath.Join(dir, filepath.FromSlash(name))
|
||||||
|
if err := os.MkdirAll(filepath.Dir(full), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(full, []byte(body), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return dir
|
||||||
|
}
|
||||||
@@ -35,6 +35,10 @@ type Built struct {
|
|||||||
// Launchers are, for a bundle in an interpreted language, the executable the build wrote beside
|
// Launchers are, for a bundle in an interpreted language, the executable the build wrote beside
|
||||||
// each entrypoint, by entrypoint (novox/hq ADR 0193): what the node's runtime starts to serve it.
|
// each entrypoint, by entrypoint (novox/hq ADR 0193): what the node's runtime starts to serve it.
|
||||||
Launchers map[string]string
|
Launchers map[string]string
|
||||||
|
// Texts are, for the archive a module packs its templates into (TemplatesArtifact), each file's text as the
|
||||||
|
// build read it back from the packed archive, by its path inside it (novox/hq ADR 0349 §2). Never carried on
|
||||||
|
// the wire or kept: Resolve reads them into the files' content, which is what the mesh holds.
|
||||||
|
Texts map[string]string `json:"-"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Resolve fills a manifest's resources in from what was built.
|
// Resolve fills a manifest's resources in from what was built.
|
||||||
@@ -71,6 +75,26 @@ func (m Manifest) Resolve(built []Built) (Manifest, error) {
|
|||||||
m.Module, strings.Join(missing, " and "), oneOrOther(len(missing)))
|
m.Module, strings.Join(missing, " and "), oneOrOther(len(missing)))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// **Each template's text, as the build read it back from its templates archive** (novox/hq ADR 0349 §2): into
|
||||||
|
// the file's content, so what the mesh holds and composes is what the same text inline would be.
|
||||||
|
if m.Templated() {
|
||||||
|
name := TemplatesArtifact(m)
|
||||||
|
texts := by[name].Texts
|
||||||
|
if name == "" || texts == nil {
|
||||||
|
return Manifest{}, fmt.Errorf("%s names templates, and the build carried no text read back from the "+
|
||||||
|
"archive it packs %s/ into (%q): the builder that built it does not read templates",
|
||||||
|
m.Module, TemplatesDir, name)
|
||||||
|
}
|
||||||
|
filled, err := fillTemplates(m.Module, m.Resources, func(template string) (string, bool) {
|
||||||
|
t, ok := texts[strings.TrimPrefix(template, TemplatesDir+"/")]
|
||||||
|
return t, ok
|
||||||
|
}, fmt.Sprintf("the archive %q", name))
|
||||||
|
if err != nil {
|
||||||
|
return Manifest{}, err
|
||||||
|
}
|
||||||
|
m.Resources = filled
|
||||||
|
}
|
||||||
|
|
||||||
out := m
|
out := m
|
||||||
out.Build = nil
|
out.Build = nil
|
||||||
out.Resources = nil
|
out.Resources = nil
|
||||||
|
|||||||
@@ -173,7 +173,7 @@ func TestTheBackupHoldersLinesAreDerivedFromTheData(t *testing.T) {
|
|||||||
{"id":"meta","path":"${dir:meta}","class":"rebuildable"}]},
|
{"id":"meta","path":"${dir:meta}","class":"rebuildable"}]},
|
||||||
"resources":[{"id":"meta","type":"directory","mode":"0700"}]}`)
|
"resources":[{"id":"meta","type":"directory","mode":"0700"}]}`)
|
||||||
facts := map[string]string{"account-home": "/home/op"}
|
facts := map[string]string{"account-home": "/home/op"}
|
||||||
with := Rendering{Settings: SettingsBy{"media": {{From: "node", Values: map[string]any{AccessesSetting: map[string]any{"films": "/tank/films"}}}}}}
|
with := Rendering{Settings: SettingsBy{"media": {LayerOf("node", map[string]any{AccessesSetting: map[string]any{"films": "/tank/films"}})}}}
|
||||||
backup, _, err := seatContributions([]Manifest{pg, agent, media}, Manifest{}, BackupSeat+":"+BackupKindBackup, with, facts, nil)
|
backup, _, err := seatContributions([]Manifest{pg, agent, media}, Manifest{}, BackupSeat+":"+BackupKindBackup, with, facts, nil)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
|
|||||||
@@ -1853,6 +1853,9 @@ func ParseManifest(raw []byte) (Manifest, error) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
problems = append(problems, m.Build.problems(m.Module)...)
|
problems = append(problems, m.Build.problems(m.Module)...)
|
||||||
|
// A file's text in a template file of the module's repository (novox/hq ADR 0349 §2): only a file, never beside
|
||||||
|
// content, only under files/, and packed by the module's build.
|
||||||
|
problems = append(problems, templateProblems(m)...)
|
||||||
problems = append(problems, undeliveredBundles(m)...)
|
problems = append(problems, undeliveredBundles(m)...)
|
||||||
// **What provides the artifact store cannot be delivered through it** (novox/hq 04-ISSUES/029).
|
// **What provides the artifact store cannot be delivered through it** (novox/hq 04-ISSUES/029).
|
||||||
//
|
//
|
||||||
|
|||||||
@@ -34,6 +34,69 @@ const PlacesSetting = "places"
|
|||||||
// AccessesSetting is the settings key that says where a module's accesses are on this node, by id.
|
// AccessesSetting is the settings key that says where a module's accesses are on this node, by id.
|
||||||
const AccessesSetting = "accesses"
|
const AccessesSetting = "accesses"
|
||||||
|
|
||||||
|
// **Placement is not config** (novox/hq ADR 0348 clause 11, issue 651). `places`, `accesses` and
|
||||||
|
// `networks` are facts of an assignment the controller decides, held beside the assignment and apart
|
||||||
|
// from its settings: a Layer carries them in Placement, never in Values, and only Places, AccessPlaces
|
||||||
|
// and KeptNetworks read them. A person still says them as keys of a layer through `settings`; LayerOf
|
||||||
|
// splits such a layer, so what they type is routed to the placement and nothing they do changes.
|
||||||
|
|
||||||
|
// placementKeys are the keys of a layer that are placement, not config.
|
||||||
|
var placementKeys = map[string]bool{PlacesSetting: true, AccessesSetting: true, NetworksSetting: true}
|
||||||
|
|
||||||
|
// SplitPlacement divides a layer as a person says it into its config values and its placement. Each is
|
||||||
|
// nil when it holds nothing; the values themselves are not copied.
|
||||||
|
func SplitPlacement(values map[string]any) (config, placement map[string]any) {
|
||||||
|
for key, value := range values {
|
||||||
|
if placementKeys[key] {
|
||||||
|
if placement == nil {
|
||||||
|
placement = map[string]any{}
|
||||||
|
}
|
||||||
|
placement[key] = value
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if config == nil {
|
||||||
|
config = map[string]any{}
|
||||||
|
}
|
||||||
|
config[key] = value
|
||||||
|
}
|
||||||
|
return config, placement
|
||||||
|
}
|
||||||
|
|
||||||
|
// LayerOf is a layer as a person says it — config values and placement in one map — split into the two.
|
||||||
|
func LayerOf(from string, values map[string]any) Layer {
|
||||||
|
config, placement := SplitPlacement(values)
|
||||||
|
if config == nil {
|
||||||
|
config = map[string]any{}
|
||||||
|
}
|
||||||
|
return Layer{From: from, Values: config, Placement: placement}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Whole is the layer as a person says it: its values and its placement in one map, a new map.
|
||||||
|
func (l Layer) Whole() map[string]any {
|
||||||
|
out := make(map[string]any, len(l.Values)+len(l.Placement))
|
||||||
|
for k, v := range l.Values {
|
||||||
|
out[k] = v
|
||||||
|
}
|
||||||
|
for k, v := range l.Placement {
|
||||||
|
out[k] = v
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// asSaid is the layers with placement folded back into the values, for what reads a layer whole as it
|
||||||
|
// did while placement was kept in it: today's mergeable file, which takes every key (ADR 0326 §3), and
|
||||||
|
// the judgement that no value holds a line end.
|
||||||
|
func asSaid(layers []Layer) []Layer {
|
||||||
|
out := make([]Layer, len(layers))
|
||||||
|
for i, l := range layers {
|
||||||
|
out[i] = l
|
||||||
|
if len(l.Placement) > 0 {
|
||||||
|
out[i] = Layer{From: l.From, Values: l.Whole(), Default: l.Default}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
// Placement is what an assignment says about one of a module's directories.
|
// Placement is what an assignment says about one of a module's directories.
|
||||||
type Placement struct {
|
type Placement struct {
|
||||||
// Path is where the directory is on this machine. Absolute.
|
// Path is where the directory is on this machine. Absolute.
|
||||||
@@ -208,7 +271,7 @@ func Places(m Manifest, layers []Layer) (map[string]Placement, error) {
|
|||||||
}
|
}
|
||||||
out := map[string]Placement{}
|
out := map[string]Placement{}
|
||||||
for _, layer := range layers {
|
for _, layer := range layers {
|
||||||
raw, ok := layer.Values[PlacesSetting]
|
raw, ok := layer.Placement[PlacesSetting]
|
||||||
if !ok {
|
if !ok {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
@@ -278,7 +341,7 @@ func AccessPlaces(m Manifest, layers []Layer) (map[string]string, error) {
|
|||||||
}
|
}
|
||||||
out := map[string]string{}
|
out := map[string]string{}
|
||||||
for _, layer := range layers {
|
for _, layer := range layers {
|
||||||
raw, ok := layer.Values[AccessesSetting]
|
raw, ok := layer.Placement[AccessesSetting]
|
||||||
if !ok {
|
if !ok {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ func placeable() Manifest {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func placedBy(values map[string]any) Rendering {
|
func placedBy(values map[string]any) Rendering {
|
||||||
return Rendering{Settings: SettingsBy{"arr": {{From: "node anchor", Values: values}}}}
|
return Rendering{Settings: SettingsBy{"arr": {LayerOf("node anchor", values)}}}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestAnAssignmentPlacesDirectoriesAndAccesses(t *testing.T) {
|
func TestAnAssignmentPlacesDirectoriesAndAccesses(t *testing.T) {
|
||||||
@@ -179,3 +179,43 @@ func TestAnUnknownAccessReferenceIsRefusedAtParse(t *testing.T) {
|
|||||||
t.Fatalf("an access with no id and no path was accepted: %v", err)
|
t.Fatalf("an access with no id and no path was accepted: %v", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// **Placement is read from the placement, never from a layer's values** (novox/hq ADR 0348 clause 11, issue
|
||||||
|
// 651). A `places` or `accesses` among the config values places nothing; the same in Placement does. A
|
||||||
|
// mergeable file of today's form still takes every key of the layer as it is said, placement too, so it
|
||||||
|
// composes as it did while placement was kept in the layer.
|
||||||
|
func TestPlacementIsReadFromThePlacementOnly(t *testing.T) {
|
||||||
|
m := placeable()
|
||||||
|
said := map[string]any{
|
||||||
|
PlacesSetting: map[string]any{"config": "/services/arr/config"},
|
||||||
|
AccessesSetting: map[string]any{"series": "/storage/media/series", "spool": "/storage/downloads"},
|
||||||
|
"log": "warn",
|
||||||
|
}
|
||||||
|
among := []Layer{{From: "anchor", Values: said}}
|
||||||
|
if placed, err := Places(m, among); err != nil || placed != nil {
|
||||||
|
t.Fatalf("a place among the config values placed %v (%v)", placed, err)
|
||||||
|
}
|
||||||
|
if _, _, err := accessesFor(m, among); err == nil {
|
||||||
|
t.Fatal("an access among the config values placed it")
|
||||||
|
}
|
||||||
|
beside := []Layer{LayerOf("anchor", said)}
|
||||||
|
if beside[0].Values["log"] != "warn" || beside[0].Values[PlacesSetting] != nil || beside[0].Placement[PlacesSetting] == nil {
|
||||||
|
t.Fatalf("LayerOf split %+v", beside[0])
|
||||||
|
}
|
||||||
|
if placed, err := Places(m, beside); err != nil || placed["config"].Path != "/services/arr/config" {
|
||||||
|
t.Fatalf("the placement did not place: %v (%v)", placed, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
file := map[string]any{"id": "runtime", "type": "file", "path": "/x", "content": `{"a":1}`, "merge": "json"}
|
||||||
|
whole, err := ApplySettings(file, among)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
split, err := ApplySettings(file, beside)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if whole["content"] != split["content"] || !strings.Contains(split["content"].(string), `"places"`) {
|
||||||
|
t.Fatalf("today's mergeable file composes %q, was %q", split["content"], whole["content"])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -128,7 +128,19 @@ var defaultSeats = append([]Seat{
|
|||||||
// The vault: the controller seals every minted credential with what it provides, which is the
|
// The vault: the controller seals every minted credential with what it provides, which is the
|
||||||
// test for a seat of the mesh's own (novox/hq ADR 0161) — a second provider of `secret` is a
|
// test for a seat of the mesh's own (novox/hq ADR 0161) — a second provider of `secret` is a
|
||||||
// second claimant, refused by name, rather than a candidate for a pin.
|
// second claimant, refused by name, rather than a candidate for a pin.
|
||||||
{Name: "mesh-vault", Scope: ScopeMesh, Delivers: "secret", Decision: "novox/hq ADR 0161"},
|
//
|
||||||
|
// Its one verb, `get`, hands a secret on request and reply, sealed to the key the asker sends and only
|
||||||
|
// to an asker the vault allows (novox/hq ADR 0349 §11, issue 674). Optional until the vault that runs
|
||||||
|
// serves it (design 33 §7).
|
||||||
|
{Name: "mesh-vault", Scope: ScopeMesh, Delivers: "secret", Decision: "novox/hq ADR 0161",
|
||||||
|
Serves: []Verb{
|
||||||
|
{Name: "get", Optional: true, Description: "One secret, sealed to the public key the asker sends (the " +
|
||||||
|
"sealed box of ADR 0206), with its generation; answered only to an asker the vault allows, as the " +
|
||||||
|
"bus proved it. Never the value in the clear, and never to a private key.",
|
||||||
|
Input: schema(map[string]string{"name": "the secret's name",
|
||||||
|
"public_key": "the asker's X25519 public key as SPKI PEM — never a private key"},
|
||||||
|
[]string{"name", "public_key"})},
|
||||||
|
}},
|
||||||
// Named for its scope since 2026-09-30 (novox/hq ADR 0156); `the-artifact-store` resolves to it as
|
// Named for its scope since 2026-09-30 (novox/hq ADR 0156); `the-artifact-store` resolves to it as
|
||||||
// an alias on a mesh that predates the rename. It serves artifacts of every kind a build makes —
|
// an alias on a mesh that predates the rename. It serves artifacts of every kind a build makes —
|
||||||
// images and archives, by digest — which is why the provision is the artifact store and not an
|
// images and archives, by digest — which is why the provision is the artifact store and not an
|
||||||
|
|||||||
@@ -207,7 +207,8 @@ func Effective(m Manifest, layers []Layer) []SettingSource {
|
|||||||
Default: d.Default, HasDefault: true}
|
Default: d.Default, HasDefault: true}
|
||||||
}
|
}
|
||||||
for _, layer := range layers {
|
for _, layer := range layers {
|
||||||
for key, v := range layer.Values {
|
// As the layer is said, placement too: `settings` answers it as a person set it.
|
||||||
|
for key, v := range layer.Whole() {
|
||||||
s, ok := byKey[key]
|
s, ok := byKey[key]
|
||||||
if !ok {
|
if !ok {
|
||||||
s = &SettingSource{Key: key}
|
s = &SettingSource{Key: key}
|
||||||
|
|||||||
@@ -427,7 +427,7 @@ func TestALeftOutModulesUnplaceableBackupLineCostsOnlyThatLine(t *testing.T) {
|
|||||||
r := anAdoptedAnchor()
|
r := anAdoptedAnchor()
|
||||||
r.Modules = append(r.Modules, holder, media, placedBadly)
|
r.Modules = append(r.Modules, holder, media, placedBadly)
|
||||||
with := anchorRendering(false)
|
with := anchorRendering(false)
|
||||||
with.Settings["notes"] = []Layer{{From: "anchor", Values: map[string]any{PlacesSetting: "not a map"}}}
|
with.Settings["notes"] = []Layer{LayerOf("anchor", map[string]any{PlacesSetting: "not a map"})}
|
||||||
composed, err := r.Compose(with)
|
composed, err := r.Compose(with)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("an unplaceable line of a left-out module failed the machine: %v", err)
|
t.Fatalf("an unplaceable line of a left-out module failed the machine: %v", err)
|
||||||
|
|||||||
@@ -37,6 +37,11 @@ type Layer struct {
|
|||||||
// Default marks the layer a module's own defaults make (novox/hq ADR 0262). Marked rather than
|
// Default marks the layer a module's own defaults make (novox/hq ADR 0262). Marked rather than
|
||||||
// recognised by From, which is a node's name for a node's layer, and a node may be called anything.
|
// recognised by From, which is a node's name for a node's layer, and a node may be called anything.
|
||||||
Default bool
|
Default bool
|
||||||
|
// Placement is the assignment's placement at this layer's scope — `places`, `accesses`, `networks`
|
||||||
|
// — which the controller holds apart from settings (novox/hq ADR 0348 clause 11, issue 651): read
|
||||||
|
// by Places, AccessPlaces and KeptNetworks, and never from Values. LayerOf splits a layer as a person
|
||||||
|
// says it into the two.
|
||||||
|
Placement map[string]any
|
||||||
}
|
}
|
||||||
|
|
||||||
// ApplySettings produces a resource's final content from the module's own and the layers over it.
|
// ApplySettings produces a resource's final content from the module's own and the layers over it.
|
||||||
@@ -45,6 +50,10 @@ type Layer struct {
|
|||||||
// module first, then this node's. A node that differs from the rest is expressed by differing,
|
// module first, then this node's. A node that differs from the rest is expressed by differing,
|
||||||
// rather than by repeating everything the rest already say.
|
// rather than by repeating everything the rest already say.
|
||||||
func ApplySettings(resource map[string]any, layers []Layer) (map[string]any, error) {
|
func ApplySettings(resource map[string]any, layers []Layer) (map[string]any, error) {
|
||||||
|
// Today's form reaches a mergeable file with every key of the layer as it was said, placement too
|
||||||
|
// (novox/hq ADR 0326 §3, ADR 0348 clause 11: a module not yet moved keeps it), so a file composes
|
||||||
|
// byte for byte as it did while placement was kept in the layer.
|
||||||
|
layers = asSaid(layers)
|
||||||
how, _ := resource["merge"].(string)
|
how, _ := resource["merge"].(string)
|
||||||
taken, names := takenKeys(resource)
|
taken, names := takenKeys(resource)
|
||||||
if how == "" {
|
if how == "" {
|
||||||
@@ -395,7 +404,7 @@ func UnusedSettings(m Manifest, layers []Layer) []string {
|
|||||||
}
|
}
|
||||||
var unused []string
|
var unused []string
|
||||||
for _, layer := range layers {
|
for _, layer := range layers {
|
||||||
for key := range layer.Values {
|
for key := range layer.Whole() {
|
||||||
if lands[key] {
|
if lands[key] {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
@@ -483,7 +492,7 @@ func KeptNetworks(m Manifest, layers []Layer, adopted bool) (map[string][]string
|
|||||||
}
|
}
|
||||||
out := map[string][]string{}
|
out := map[string][]string{}
|
||||||
for _, layer := range layers {
|
for _, layer := range layers {
|
||||||
raw, ok := layer.Values[NetworksSetting]
|
raw, ok := layer.Placement[NetworksSetting]
|
||||||
if !ok {
|
if !ok {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
@@ -543,7 +552,8 @@ var networkName = regexp.MustCompile(`^[A-Za-z0-9][A-Za-z0-9_.-]*$`)
|
|||||||
// refused where it is stored (SetSettings, with UnusedSettings) and said where a plan is read,
|
// refused where it is stored (SetSettings, with UnusedSettings) and said where a plan is read,
|
||||||
// and never costs a module its place.
|
// and never costs a module its place.
|
||||||
func JudgeSettings(m Manifest, layers []Layer, adopted bool) error {
|
func JudgeSettings(m Manifest, layers []Layer, adopted bool) error {
|
||||||
if err := settingsHoldOneLine(m.Module, layers); err != nil {
|
// Placement is judged for line ends as it always was: a path is written into files as well.
|
||||||
|
if err := settingsHoldOneLine(m.Module, asSaid(layers)); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
// Which keys each mergeable file takes is the definition's to say right (novox/hq ADR 0326);
|
// Which keys each mergeable file takes is the definition's to say right (novox/hq ADR 0326);
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ func TestASettingThatCannotComposeIsRefusedByNameAndLeavesOnlyItsModuleOut(t *te
|
|||||||
if c.name == "a mesh-wide port" {
|
if c.name == "a mesh-wide port" {
|
||||||
from = MeshWideLayer
|
from = MeshWideLayer
|
||||||
}
|
}
|
||||||
err := JudgeSettings(web, []Layer{{From: from, Values: c.layer}}, true)
|
err := JudgeSettings(web, []Layer{LayerOf(from, c.layer)}, true)
|
||||||
if err == nil || !strings.Contains(err.Error(), c.refuse) {
|
if err == nil || !strings.Contains(err.Error(), c.refuse) {
|
||||||
t.Errorf("%s: judged %v, want %q", c.name, err, c.refuse)
|
t.Errorf("%s: judged %v, want %q", c.name, err, c.refuse)
|
||||||
}
|
}
|
||||||
@@ -69,8 +69,8 @@ func TestASettingThatCannotComposeIsRefusedByNameAndLeavesOnlyItsModuleOut(t *te
|
|||||||
// declaration as the networks it also joins.
|
// declaration as the networks it also joins.
|
||||||
func TestAKeptNetworkReachesTheContainerOnAnAdoptedMachineOnly(t *testing.T) {
|
func TestAKeptNetworkReachesTheContainerOnAnAdoptedMachineOnly(t *testing.T) {
|
||||||
r := anAdoptedAnchor()
|
r := anAdoptedAnchor()
|
||||||
keep := SettingsBy{"hello-web": {{From: "anchor",
|
keep := SettingsBy{"hello-web": {LayerOf("anchor",
|
||||||
Values: map[string]any{NetworksSetting: map[string]any{"server": []any{"predecessor_default"}}}}}}
|
map[string]any{NetworksSetting: map[string]any{"server": []any{"predecessor_default"}}})}}
|
||||||
|
|
||||||
with := anchorRendering(true)
|
with := anchorRendering(true)
|
||||||
with.Settings = keep
|
with.Settings = keep
|
||||||
@@ -107,13 +107,13 @@ func TestAKeptNetworkReachesTheContainerOnAnAdoptedMachineOnly(t *testing.T) {
|
|||||||
layer Layer
|
layer Layer
|
||||||
want string
|
want string
|
||||||
}{
|
}{
|
||||||
{"mesh-wide", Layer{From: MeshWideLayer, Values: map[string]any{NetworksSetting: map[string]any{"server": []any{"x"}}}},
|
{"mesh-wide", LayerOf(MeshWideLayer, map[string]any{NetworksSetting: map[string]any{"server": []any{"x"}}}),
|
||||||
"a found network is a fact about one machine"},
|
"a found network is a fact about one machine"},
|
||||||
{"an unknown container", Layer{From: "anchor", Values: map[string]any{NetworksSetting: map[string]any{"db": []any{"x"}}}},
|
{"an unknown container", LayerOf("anchor", map[string]any{NetworksSetting: map[string]any{"db": []any{"x"}}}),
|
||||||
`names the container "db", which it does not declare`},
|
`names the container "db", which it does not declare`},
|
||||||
{"not a list", Layer{From: "anchor", Values: map[string]any{NetworksSetting: map[string]any{"server": "x"}}},
|
{"not a list", LayerOf("anchor", map[string]any{NetworksSetting: map[string]any{"server": "x"}}),
|
||||||
"is a list of network names"},
|
"is a list of network names"},
|
||||||
{"not a network name", Layer{From: "anchor", Values: map[string]any{NetworksSetting: map[string]any{"server": []any{"a/b"}}}},
|
{"not a network name", LayerOf("anchor", map[string]any{NetworksSetting: map[string]any{"server": []any{"a/b"}}}),
|
||||||
"which is not a network name"},
|
"which is not a network name"},
|
||||||
} {
|
} {
|
||||||
_, err := KeptNetworks(web, []Layer{c.layer}, true)
|
_, err := KeptNetworks(web, []Layer{c.layer}, true)
|
||||||
|
|||||||
@@ -0,0 +1,334 @@
|
|||||||
|
package catalogue
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io/fs"
|
||||||
|
"os"
|
||||||
|
"path"
|
||||||
|
"path/filepath"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
"unicode/utf8"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A file's text kept as a template file in its module's repository (novox/hq ADR 0349 §2, design 57 package T1,
|
||||||
|
// issue 654).
|
||||||
|
//
|
||||||
|
// **Two forms, one composition.** A file resource says its text inline (`content`) or names a template file
|
||||||
|
// beside its manifest (`"template": "files/<name>"`), never both. The module's build packs `files/` into an
|
||||||
|
// archive artifact of its own — an `archive` artifact built `from: "files"` — and resolving the build reads each
|
||||||
|
// template's text back from that packed archive into `content` and drops `template`. So the manifest the mesh
|
||||||
|
// holds, composition and the node-engine are exactly as they were: a module with its text in `files/` composes
|
||||||
|
// byte-identically to the same module with it inline. Where there is no build — `module check`, the merge gate,
|
||||||
|
// `module add` — the text is read from the repository tree beside the manifest (WithTemplatesFrom).
|
||||||
|
//
|
||||||
|
// **Read back by the builder, carried in the resolved manifest.** The builder reads each template from the very
|
||||||
|
// bytes it hashed into the archive's digest, so the text the mesh holds is the archive's. The controller
|
||||||
|
// registers the resolved manifest as the build result carries it and fetches nothing from the artifact store; a
|
||||||
|
// manifest that still names a template when it would be held — built by a builder that predates templates — is
|
||||||
|
// refused at registration (HeldTemplateProblem).
|
||||||
|
|
||||||
|
// TemplateField is the key a file resource names its template file by.
|
||||||
|
const TemplateField = "template"
|
||||||
|
|
||||||
|
// TemplatesDir is the module's directory its template files are kept in, and the directory its templates archive
|
||||||
|
// is built from.
|
||||||
|
const TemplatesDir = "files"
|
||||||
|
|
||||||
|
// Templated is whether any of the manifest's resources names a template.
|
||||||
|
func (m Manifest) Templated() bool {
|
||||||
|
for _, r := range m.Resources {
|
||||||
|
if _, has := r[TemplateField]; has {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// TemplatesArtifact is the name of the archive artifact the module packs its templates into — the one built from
|
||||||
|
// files/ — or "" when it declares none, or more than one (both refused by templateProblems for a module naming a
|
||||||
|
// template).
|
||||||
|
func TemplatesArtifact(m Manifest) string {
|
||||||
|
found := templatesArtifacts(m)
|
||||||
|
if len(found) != 1 {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return found[0]
|
||||||
|
}
|
||||||
|
|
||||||
|
func templatesArtifacts(m Manifest) []string {
|
||||||
|
if m.Build == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
var found []string
|
||||||
|
for _, a := range m.Build.Artifacts {
|
||||||
|
if a.Kind == ArtifactArchive && a.URL == "" && cleanFrom(a.From) == TemplatesDir {
|
||||||
|
found = append(found, a.Name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return found
|
||||||
|
}
|
||||||
|
|
||||||
|
// cleanFrom is an artifact's directory as one relative path: "./files/" is "files".
|
||||||
|
func cleanFrom(from string) string {
|
||||||
|
c := path.Clean(strings.TrimSpace(from))
|
||||||
|
return strings.TrimPrefix(c, "./")
|
||||||
|
}
|
||||||
|
|
||||||
|
// templateOf is the template a resource names, whether it names one, and what is wrong with it ("" when nothing).
|
||||||
|
func templateOf(module string, r map[string]any) (string, bool, string) {
|
||||||
|
raw, has := r[TemplateField]
|
||||||
|
if !has {
|
||||||
|
return "", false, ""
|
||||||
|
}
|
||||||
|
id := fmt.Sprint(r["id"])
|
||||||
|
if t := fmt.Sprint(r["type"]); t != "file" {
|
||||||
|
return "", true, fmt.Sprintf("%s: %s is a %s and names a template; only a file takes its text from one "+
|
||||||
|
"(novox/hq ADR 0349 §2)", module, id, t)
|
||||||
|
}
|
||||||
|
name, ok := raw.(string)
|
||||||
|
if !ok || strings.TrimSpace(name) == "" {
|
||||||
|
return "", true, fmt.Sprintf("%s: %s names a template that is not a path: %v; a template is %q",
|
||||||
|
module, id, raw, TemplatesDir+"/<name>")
|
||||||
|
}
|
||||||
|
if _, both := r["content"]; both {
|
||||||
|
return name, true, fmt.Sprintf("%s: %s names the template %q and says its content too; a file's text is "+
|
||||||
|
"in one place, the template or the content, never both (novox/hq ADR 0349 §2)", module, id, name)
|
||||||
|
}
|
||||||
|
if strings.HasPrefix(name, "/") || path.Clean(name) != name || !strings.HasPrefix(name, TemplatesDir+"/") ||
|
||||||
|
strings.Contains(name, "\\") {
|
||||||
|
return name, true, fmt.Sprintf("%s: %s names the template %q, which is not a file under %s/ of its own "+
|
||||||
|
"repository: a template is %q, a plain relative path, and the build packs only %s/",
|
||||||
|
module, id, name, TemplatesDir, TemplatesDir+"/<name>", TemplatesDir)
|
||||||
|
}
|
||||||
|
return name, true, ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// templateProblems is what is wrong with the manifest's templates, as written: a template on something not a file,
|
||||||
|
// beside content, outside files/, or a module naming templates whose build packs no archive from files/. Whether
|
||||||
|
// each template exists is judged where a tree is (ReadTemplates) or the archive's text is (Resolve).
|
||||||
|
func templateProblems(m Manifest) []string {
|
||||||
|
var problems []string
|
||||||
|
templated := false
|
||||||
|
for _, r := range m.Resources {
|
||||||
|
_, has, wrong := templateOf(m.Module, r)
|
||||||
|
templated = templated || has
|
||||||
|
if wrong != "" {
|
||||||
|
problems = append(problems, wrong)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !templated {
|
||||||
|
return problems
|
||||||
|
}
|
||||||
|
switch found := templatesArtifacts(m); len(found) {
|
||||||
|
case 0:
|
||||||
|
problems = append(problems, fmt.Sprintf("%s names templates and its build packs no archive from %s/: "+
|
||||||
|
"declare an artifact {\"name\": \"files\", \"kind\": \"archive\", \"from\": %q} (novox/hq ADR 0349 §2)",
|
||||||
|
m.Module, TemplatesDir, TemplatesDir))
|
||||||
|
case 1:
|
||||||
|
default:
|
||||||
|
sort.Strings(found)
|
||||||
|
problems = append(problems, fmt.Sprintf("%s packs %s/ into %s; its templates are read from one archive",
|
||||||
|
m.Module, TemplatesDir, strings.Join(found, " and ")))
|
||||||
|
}
|
||||||
|
return problems
|
||||||
|
}
|
||||||
|
|
||||||
|
// fillTemplates is resources with each template's text as its content and the template key dropped: text says the
|
||||||
|
// text of a template by its path ("files/<name>"), and whether it has one. A template it has no text for, or text
|
||||||
|
// that is not UTF-8, is refused by name. Every resource is copied; the manifest's own are left as they were.
|
||||||
|
func fillTemplates(module string, resources []map[string]any, text func(string) (string, bool),
|
||||||
|
where string) ([]map[string]any, error) {
|
||||||
|
out := make([]map[string]any, 0, len(resources))
|
||||||
|
var problems []string
|
||||||
|
for _, r := range resources {
|
||||||
|
name, has, wrong := templateOf(module, r)
|
||||||
|
if !has {
|
||||||
|
out = append(out, r)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if wrong != "" {
|
||||||
|
problems = append(problems, wrong)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
body, ok := text(name)
|
||||||
|
if !ok {
|
||||||
|
problems = append(problems, fmt.Sprintf("%s: %v names the template %q, and %s holds no such file",
|
||||||
|
module, r["id"], name, where))
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if !utf8.ValidString(body) {
|
||||||
|
// A manifest is JSON: text that is not UTF-8 would be changed on the way, silently.
|
||||||
|
problems = append(problems, fmt.Sprintf("%s: %v names the template %q, which is not UTF-8 text; a "+
|
||||||
|
"file's text is carried as JSON and would not reach the machine as written", module, r["id"], name))
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
filled := make(map[string]any, len(r))
|
||||||
|
for k, v := range r {
|
||||||
|
filled[k] = v
|
||||||
|
}
|
||||||
|
delete(filled, TemplateField)
|
||||||
|
filled["content"] = body
|
||||||
|
out = append(out, filled)
|
||||||
|
}
|
||||||
|
if len(problems) > 0 {
|
||||||
|
return nil, errors.New(strings.Join(problems, "; "))
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReadTemplates is the text of each template the manifest names, read from the module's directory in a repository
|
||||||
|
// tree, by template path. Refused by name: a template the directory lacks, and anything under files/ the build's
|
||||||
|
// packing refuses — files/ itself, or any directory or file under it, that is a symlink or not a plain file — so
|
||||||
|
// nothing judged here can be read from outside the tree, and no tree passes here that the build would refuse. Each
|
||||||
|
// template is read through an os.Root of the module's directory besides, which no path element can leave.
|
||||||
|
func ReadTemplates(m Manifest, dir string) (map[string]string, error) {
|
||||||
|
problems := templatesTreeProblems(m.Module, dir)
|
||||||
|
root, err := os.OpenRoot(dir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("%s: the module's directory cannot be opened to read its templates: %w", m.Module, err)
|
||||||
|
}
|
||||||
|
defer root.Close()
|
||||||
|
texts := map[string]string{}
|
||||||
|
for _, r := range m.Resources {
|
||||||
|
name, has, wrong := templateOf(m.Module, r)
|
||||||
|
if !has {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if wrong != "" {
|
||||||
|
problems = append(problems, wrong)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if _, read := texts[name]; read {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
info, err := root.Lstat(name)
|
||||||
|
switch {
|
||||||
|
case errors.Is(err, fs.ErrNotExist):
|
||||||
|
problems = append(problems, fmt.Sprintf("%s: %v names the template %q, and the module's directory "+
|
||||||
|
"has no such file", m.Module, r["id"], name))
|
||||||
|
continue
|
||||||
|
case err != nil:
|
||||||
|
problems = append(problems, fmt.Sprintf("%s: %v names the template %q, which cannot be read: %v",
|
||||||
|
m.Module, r["id"], name, err))
|
||||||
|
continue
|
||||||
|
case !info.Mode().IsRegular():
|
||||||
|
problems = append(problems, fmt.Sprintf("%s: %v names the template %q, which is not a plain file; "+
|
||||||
|
"the build packs only files", m.Module, r["id"], name))
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
body, err := root.ReadFile(name)
|
||||||
|
if err != nil {
|
||||||
|
problems = append(problems, fmt.Sprintf("%s: %v names the template %q, which cannot be read: %v",
|
||||||
|
m.Module, r["id"], name, err))
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
texts[name] = string(body)
|
||||||
|
}
|
||||||
|
if len(problems) > 0 {
|
||||||
|
return nil, errors.New(strings.Join(problems, "; "))
|
||||||
|
}
|
||||||
|
return texts, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// templatesTreeProblems is everything under the module's files/ that the build's packing refuses: files/ itself not
|
||||||
|
// a plain directory, and any entry under it that is neither a directory nor a plain file — a symlink, to a file or a
|
||||||
|
// directory, a device, a pipe. Each said by its path. A files/ that does not exist is no problem here: each template
|
||||||
|
// it would have held is refused as missing.
|
||||||
|
func templatesTreeProblems(module, dir string) []string {
|
||||||
|
top := filepath.Join(dir, TemplatesDir)
|
||||||
|
info, err := os.Lstat(top)
|
||||||
|
if errors.Is(err, fs.ErrNotExist) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return []string{fmt.Sprintf("%s: %s/ cannot be read: %v", module, TemplatesDir, err)}
|
||||||
|
}
|
||||||
|
if !info.IsDir() {
|
||||||
|
return []string{fmt.Sprintf("%s: %s/ is %s, not a directory of the module's own; its templates are read "+
|
||||||
|
"only from inside the repository, and the build packs only directories and files", module, TemplatesDir,
|
||||||
|
kindOf(info.Mode()))}
|
||||||
|
}
|
||||||
|
var problems []string
|
||||||
|
err = filepath.WalkDir(top, func(at string, d fs.DirEntry, err error) error {
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if d.IsDir() || d.Type().IsRegular() {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
rel, _ := filepath.Rel(dir, at)
|
||||||
|
problems = append(problems, fmt.Sprintf("%s: %s is %s; the build packs only directories and files, so "+
|
||||||
|
"%s/ holds nothing else", module, filepath.ToSlash(rel), kindOf(d.Type()), TemplatesDir))
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
problems = append(problems, fmt.Sprintf("%s: %s/ cannot be read: %v", module, TemplatesDir, err))
|
||||||
|
}
|
||||||
|
return problems
|
||||||
|
}
|
||||||
|
|
||||||
|
// kindOf says what a file that is not a plain file is.
|
||||||
|
func kindOf(mode fs.FileMode) string {
|
||||||
|
switch {
|
||||||
|
case mode&fs.ModeSymlink != 0:
|
||||||
|
return "a symlink"
|
||||||
|
case mode&fs.ModeDevice != 0:
|
||||||
|
return "a device"
|
||||||
|
case mode&fs.ModeNamedPipe != 0:
|
||||||
|
return "a named pipe"
|
||||||
|
case mode&fs.ModeSocket != 0:
|
||||||
|
return "a socket"
|
||||||
|
case mode.IsDir():
|
||||||
|
return "a directory"
|
||||||
|
}
|
||||||
|
return "not a plain file"
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithTemplatesFrom is the manifest with each template's text read from the module's directory in a repository
|
||||||
|
// tree as its content: what `module check`, the merge gate and `module add` judge, where nothing was built. Read
|
||||||
|
// again strictly afterwards, so every rule about a file's text judges the template's text exactly as it judges
|
||||||
|
// inline content. A manifest naming no template is returned as it is.
|
||||||
|
func WithTemplatesFrom(m Manifest, dir string) (Manifest, error) {
|
||||||
|
if !m.Templated() {
|
||||||
|
return m, nil
|
||||||
|
}
|
||||||
|
texts, err := ReadTemplates(m, dir)
|
||||||
|
if err != nil {
|
||||||
|
return Manifest{}, err
|
||||||
|
}
|
||||||
|
filled, err := fillTemplates(m.Module, m.Resources, func(name string) (string, bool) {
|
||||||
|
t, ok := texts[name]
|
||||||
|
return t, ok
|
||||||
|
}, "the module's directory")
|
||||||
|
if err != nil {
|
||||||
|
return Manifest{}, err
|
||||||
|
}
|
||||||
|
out := m
|
||||||
|
out.Resources = filled
|
||||||
|
raw, err := json.Marshal(out)
|
||||||
|
if err != nil {
|
||||||
|
return Manifest{}, err
|
||||||
|
}
|
||||||
|
return ParseManifest(raw)
|
||||||
|
}
|
||||||
|
|
||||||
|
// HeldTemplateProblem is why a manifest cannot be held by the mesh because it still names a template, or "": the
|
||||||
|
// manifest the mesh holds carries every file's text, which a build reads back from its templates archive. One
|
||||||
|
// naming a template was resolved by a builder that does not read templates, and would compose files with no text.
|
||||||
|
func HeldTemplateProblem(m Manifest) string {
|
||||||
|
var named []string
|
||||||
|
for _, r := range m.Resources {
|
||||||
|
if t, has := r[TemplateField]; has {
|
||||||
|
named = append(named, fmt.Sprintf("%v (%v)", r["id"], t))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(named) == 0 {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return fmt.Sprintf("%s still names the template(s) of %s: the manifest the mesh holds carries each file's "+
|
||||||
|
"text, read back from the build's templates archive — this one was resolved by a builder that does not "+
|
||||||
|
"read templates, or not built at all (novox/hq ADR 0349 §2)", m.Module, strings.Join(named, ", "))
|
||||||
|
}
|
||||||
@@ -0,0 +1,323 @@
|
|||||||
|
package catalogue
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A file resource may name a template file in its module's repository (novox/hq ADR 0349 §2, design 57 package
|
||||||
|
// T1, issue 654): the build packs files/ into an archive, and resolving the build reads each template's text back
|
||||||
|
// into content, so the mesh holds, composes and sends exactly what it would for the same text inline.
|
||||||
|
|
||||||
|
// The two forms of one module: its text inline, and its text in files/.
|
||||||
|
const (
|
||||||
|
inlineTwin = `{"module":"tidy","version":"1",
|
||||||
|
"build":{"artifacts":[{"name":"files","kind":"archive","from":"files"}]},
|
||||||
|
"resources":[
|
||||||
|
{"id":"conf","type":"directory","path":"${dir:conf}"},
|
||||||
|
{"id":"main","type":"file","path":"${dir:conf}/tidy.conf","mode":"0644","content":"` + mainText + `"},
|
||||||
|
{"id":"extra","type":"file","path":"${dir:conf}/extra.conf","content":"` + extraText + `"}]}`
|
||||||
|
templatedTwin = `{"module":"tidy","version":"1",
|
||||||
|
"build":{"artifacts":[{"name":"files","kind":"archive","from":"files"}]},
|
||||||
|
"resources":[
|
||||||
|
{"id":"conf","type":"directory","path":"${dir:conf}"},
|
||||||
|
{"id":"main","type":"file","path":"${dir:conf}/tidy.conf","mode":"0644","template":"files/tidy.conf"},
|
||||||
|
{"id":"extra","type":"file","path":"${dir:conf}/extra.conf","template":"files/deeper/extra.conf"}]}`
|
||||||
|
mainText = `# tidy\nroot = ${dir:conf}\nquoted = \"yes\" é\n`
|
||||||
|
extraText = `one\ntwo\n`
|
||||||
|
)
|
||||||
|
|
||||||
|
// templateTexts is what a build reads back from the packed files/ archive: by path inside it.
|
||||||
|
func templateTexts(t *testing.T) map[string]string {
|
||||||
|
t.Helper()
|
||||||
|
var m struct{ Main, Extra string }
|
||||||
|
if err := json.Unmarshal([]byte(`{"Main":"`+mainText+`","Extra":"`+extraText+`"}`), &m); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return map[string]string{"tidy.conf": m.Main, "deeper/extra.conf": m.Extra, "unused.conf": "not named"}
|
||||||
|
}
|
||||||
|
|
||||||
|
func builtFiles(texts map[string]string) []Built {
|
||||||
|
return []Built{{Name: "files", Kind: ArtifactArchive,
|
||||||
|
Reference: ArtifactStoreScheme + "tidy/files/blobs/sha256:" + strings.Repeat("c", 64),
|
||||||
|
Digest: "sha256:" + strings.Repeat("c", 64), Texts: texts}}
|
||||||
|
}
|
||||||
|
|
||||||
|
// held is a manifest as registration holds it: resolved with what was built, then read again strictly.
|
||||||
|
func held(t *testing.T, raw string, built []Built) Manifest {
|
||||||
|
t.Helper()
|
||||||
|
m, err := ParseManifest([]byte(raw))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
resolved, err := m.Resolve(built)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
again, err := json.Marshal(resolved)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
out, err := ParseManifest(again)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if problem := HeldTemplateProblem(out); problem != "" {
|
||||||
|
t.Fatal(problem)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func composed(t *testing.T, m Manifest) string {
|
||||||
|
t.Helper()
|
||||||
|
got, err := Resolve(shelf(m), []string{m.Module}, workstation(), World{})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
out, err := json.Marshal(mustDeclare(t, got))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return string(out)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestATemplatedModuleComposesByteIdenticallyToItsInlineTwin(t *testing.T) {
|
||||||
|
inline := composed(t, held(t, inlineTwin, builtFiles(nil)))
|
||||||
|
templated := composed(t, held(t, templatedTwin, builtFiles(templateTexts(t))))
|
||||||
|
if inline != templated {
|
||||||
|
t.Fatalf("the two forms compose differently:\ninline: %s\ntemplated: %s", inline, templated)
|
||||||
|
}
|
||||||
|
if !strings.Contains(templated, "quoted = \\\"yes\\\"") || strings.Contains(templated, `"template"`) {
|
||||||
|
t.Fatalf("the composition does not carry the template's text as content: %s", templated)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// What `module check`, the merge gate and `module add` judge: the text read from the tree beside the manifest.
|
||||||
|
func TestATemplatedModuleReadFromItsTreeComposesByteIdenticallyToItsInlineTwin(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
for name, text := range templateTexts(t) {
|
||||||
|
full := filepath.Join(dir, "files", filepath.FromSlash(name))
|
||||||
|
if err := os.MkdirAll(filepath.Dir(full), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(full, []byte(text), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
m, err := ParseManifest([]byte(templatedTwin))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
filled, err := WithTemplatesFrom(m, dir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if filled.Templated() {
|
||||||
|
t.Fatal("a manifest read from its tree still names a template")
|
||||||
|
}
|
||||||
|
resolved, err := filled.Resolve(builtFiles(nil))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got, want := composed(t, resolved), composed(t, held(t, inlineTwin, builtFiles(nil))); got != want {
|
||||||
|
t.Fatalf("read from the tree, the module composes differently:\ninline: %s\ntemplated: %s", want, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAFileNamingBothATemplateAndContentIsRefused(t *testing.T) {
|
||||||
|
raw := strings.Replace(templatedTwin, `"template":"files/tidy.conf"`,
|
||||||
|
`"template":"files/tidy.conf","content":"x"`, 1)
|
||||||
|
_, err := ParseManifest([]byte(raw))
|
||||||
|
if err == nil || !strings.Contains(err.Error(), "main") || !strings.Contains(err.Error(), "never both") {
|
||||||
|
t.Fatalf("a file with both a template and content was not refused by name: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestATemplateOutsideFilesIsRefusedByName(t *testing.T) {
|
||||||
|
for _, bad := range []string{"../tidy.conf", "/etc/tidy.conf", "files", "files/", "files/../tidy.conf",
|
||||||
|
"files/./tidy.conf", "other/tidy.conf", "tidy.conf", "files//tidy.conf", `files\\tidy.conf`} {
|
||||||
|
raw := strings.Replace(templatedTwin, `"files/tidy.conf"`, `"`+bad+`"`, 1)
|
||||||
|
_, err := ParseManifest([]byte(raw))
|
||||||
|
if err == nil || !strings.Contains(err.Error(), "main") || !strings.Contains(err.Error(), "not a file under files/") {
|
||||||
|
t.Errorf("the template %q was not refused by name: %v", bad, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestATemplateOnAResourceThatIsNotAFileIsRefused(t *testing.T) {
|
||||||
|
raw := strings.Replace(templatedTwin, `{"id":"conf","type":"directory","path":"${dir:conf}"}`,
|
||||||
|
`{"id":"conf","type":"directory","path":"${dir:conf}","template":"files/tidy.conf"}`, 1)
|
||||||
|
_, err := ParseManifest([]byte(raw))
|
||||||
|
if err == nil || !strings.Contains(err.Error(), "conf is a directory and names a template") {
|
||||||
|
t.Fatalf("a directory naming a template was not refused: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestATemplatedModuleWhoseBuildPacksNoFilesIsRefused(t *testing.T) {
|
||||||
|
for _, build := range []string{
|
||||||
|
``,
|
||||||
|
`"build":{"artifacts":[{"name":"look","kind":"archive","from":"theme"}]},`,
|
||||||
|
`"build":{"artifacts":[{"name":"a","kind":"archive","from":"files"},{"name":"b","kind":"archive","from":"./files/"}]},`,
|
||||||
|
} {
|
||||||
|
raw := strings.Replace(templatedTwin,
|
||||||
|
`"build":{"artifacts":[{"name":"files","kind":"archive","from":"files"}]},`, build, 1)
|
||||||
|
_, err := ParseManifest([]byte(raw))
|
||||||
|
if err == nil || !strings.Contains(err.Error(), "files/") {
|
||||||
|
t.Errorf("a templated module with the build %q was not refused: %v", build, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAMissingTemplateIsRefusedByName(t *testing.T) {
|
||||||
|
m, err := ParseManifest([]byte(templatedTwin))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
// In the tree beside the manifest.
|
||||||
|
dir := t.TempDir()
|
||||||
|
if err := os.MkdirAll(filepath.Join(dir, "files"), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(dir, "files", "tidy.conf"), []byte("x"), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
_, err = WithTemplatesFrom(m, dir)
|
||||||
|
if err == nil || !strings.Contains(err.Error(), "extra") || !strings.Contains(err.Error(), "files/deeper/extra.conf") {
|
||||||
|
t.Fatalf("a template missing from the tree was not refused by name: %v", err)
|
||||||
|
}
|
||||||
|
// And in what the build read back from its archive.
|
||||||
|
texts := templateTexts(t)
|
||||||
|
delete(texts, "deeper/extra.conf")
|
||||||
|
_, err = m.Resolve(builtFiles(texts))
|
||||||
|
if err == nil || !strings.Contains(err.Error(), "extra") || !strings.Contains(err.Error(), "files/deeper/extra.conf") {
|
||||||
|
t.Fatalf("a template missing from the archive was not refused by name: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestATemplateThatIsASymlinkIsRefused(t *testing.T) {
|
||||||
|
m, err := ParseManifest([]byte(templatedTwin))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
dir := t.TempDir()
|
||||||
|
if err := os.MkdirAll(filepath.Join(dir, "files", "deeper"), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(dir, "elsewhere"), []byte("x"), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(dir, "files", "tidy.conf"), []byte("x"), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.Symlink(filepath.Join(dir, "elsewhere"), filepath.Join(dir, "files", "deeper", "extra.conf")); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := WithTemplatesFrom(m, dir); err == nil || !strings.Contains(err.Error(), "not a plain file") {
|
||||||
|
t.Fatalf("a template that is a symlink was not refused: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAResolveWithoutTheArchivesTextIsRefused(t *testing.T) {
|
||||||
|
m, err := ParseManifest([]byte(templatedTwin))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := m.Resolve(builtFiles(nil)); err == nil || !strings.Contains(err.Error(), "files") {
|
||||||
|
t.Fatalf("a templated module resolved with no text read back from its archive: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestATemplateThatIsNotUTF8IsRefused(t *testing.T) {
|
||||||
|
m, err := ParseManifest([]byte(templatedTwin))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
texts := templateTexts(t)
|
||||||
|
texts["tidy.conf"] = "\xff\xfe"
|
||||||
|
if _, err := m.Resolve(builtFiles(texts)); err == nil || !strings.Contains(err.Error(), "UTF-8") {
|
||||||
|
t.Fatalf("a template that is not UTF-8 was resolved: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// What registration refuses: a manifest to be held that still names a template — one resolved by a builder that
|
||||||
|
// predates templates would otherwise compose files with no text.
|
||||||
|
func TestAManifestStillNamingATemplateIsNotHeld(t *testing.T) {
|
||||||
|
m, err := ParseManifest([]byte(templatedTwin))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if problem := HeldTemplateProblem(m); !strings.Contains(problem, "main") || !strings.Contains(problem, "files/tidy.conf") {
|
||||||
|
t.Fatalf("a manifest naming a template would be held: %q", problem)
|
||||||
|
}
|
||||||
|
if problem := HeldTemplateProblem(held(t, inlineTwin, builtFiles(nil))); problem != "" {
|
||||||
|
t.Fatalf("an inline manifest is refused: %s", problem)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A symlinked files/, or a symlinked directory under it, would read a file outside the tree: refused by name,
|
||||||
|
// as is any symlink or special file under files/ that no template names, which the build's packing refuses.
|
||||||
|
func TestASymlinkAnywhereUnderFilesIsRefusedByName(t *testing.T) {
|
||||||
|
m, err := ParseManifest([]byte(templatedTwin))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
outside := t.TempDir()
|
||||||
|
if err := os.MkdirAll(filepath.Join(outside, "deeper"), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for _, name := range []string{"tidy.conf", "deeper/extra.conf", "secret"} {
|
||||||
|
if err := os.WriteFile(filepath.Join(outside, filepath.FromSlash(name)), []byte("outside"), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
write := func(t *testing.T, dir, name string) {
|
||||||
|
t.Helper()
|
||||||
|
full := filepath.Join(dir, filepath.FromSlash(name))
|
||||||
|
if err := os.MkdirAll(filepath.Dir(full), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(full, []byte("inside"), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
link := func(t *testing.T, target, at string) {
|
||||||
|
t.Helper()
|
||||||
|
if err := os.MkdirAll(filepath.Dir(at), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.Symlink(target, at); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, c := range []struct {
|
||||||
|
name string
|
||||||
|
make func(t *testing.T, dir string)
|
||||||
|
names string
|
||||||
|
}{
|
||||||
|
{"files/ itself", func(t *testing.T, dir string) {
|
||||||
|
link(t, outside, filepath.Join(dir, "files"))
|
||||||
|
}, "files/ is a symlink"},
|
||||||
|
{"a directory under files/", func(t *testing.T, dir string) {
|
||||||
|
write(t, dir, "files/tidy.conf")
|
||||||
|
link(t, filepath.Join(outside, "deeper"), filepath.Join(dir, "files", "deeper"))
|
||||||
|
}, "files/deeper is a symlink"},
|
||||||
|
{"a file no template names", func(t *testing.T, dir string) {
|
||||||
|
write(t, dir, "files/tidy.conf")
|
||||||
|
write(t, dir, "files/deeper/extra.conf")
|
||||||
|
link(t, filepath.Join(outside, "secret"), filepath.Join(dir, "files", "unnamed"))
|
||||||
|
}, "files/unnamed is a symlink"},
|
||||||
|
} {
|
||||||
|
dir := t.TempDir()
|
||||||
|
c.make(t, dir)
|
||||||
|
_, err := WithTemplatesFrom(m, dir)
|
||||||
|
if err == nil || !strings.Contains(err.Error(), c.names) {
|
||||||
|
t.Errorf("a symlinked %s was not refused by name: %v", c.name, err)
|
||||||
|
}
|
||||||
|
if err != nil && strings.Contains(err.Error(), "outside") {
|
||||||
|
t.Errorf("a symlinked %s was read: %v", c.name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -13,22 +13,22 @@ func TestAPlacementOrAnAccessAtTheMachinesOwnIsRefused(t *testing.T) {
|
|||||||
for _, path := range []string{"/", "/etc", "/etc/", "/etc/sudoers.d", "/usr/bin", "/root", "/var", "/var/lib",
|
for _, path := range []string{"/", "/etc", "/etc/", "/etc/sudoers.d", "/usr/bin", "/root", "/var", "/var/lib",
|
||||||
"/home", "/home/", "/run", "/run/user/1000", "/var/lib/mesh/x", "/var/lib/mesh-host", "/var/lib/mesh-host/identity",
|
"/home", "/home/", "/run", "/run/user/1000", "/var/lib/mesh/x", "/var/lib/mesh-host", "/var/lib/mesh-host/identity",
|
||||||
"/srv/../etc", "//etc", "/proc/1", "/sys", "/dev", "/boot/efi", "/bin", "/sbin", "/lib", "/lib64"} {
|
"/srv/../etc", "//etc", "/proc/1", "/sys", "/dev", "/boot/efi", "/bin", "/sbin", "/lib", "/lib64"} {
|
||||||
layers := []Layer{{From: "laptop", Values: map[string]any{PlacesSetting: map[string]any{"data": path}}}}
|
layers := []Layer{LayerOf("laptop", map[string]any{PlacesSetting: map[string]any{"data": path}})}
|
||||||
if _, err := Places(m, layers); err == nil || !strings.Contains(err.Error(), "issue 339") {
|
if _, err := Places(m, layers); err == nil || !strings.Contains(err.Error(), "issue 339") {
|
||||||
t.Errorf("a place at %s: %v", path, err)
|
t.Errorf("a place at %s: %v", path, err)
|
||||||
}
|
}
|
||||||
layers = []Layer{{From: "laptop", Values: map[string]any{AccessesSetting: map[string]any{"media": path}}}}
|
layers = []Layer{LayerOf("laptop", map[string]any{AccessesSetting: map[string]any{"media": path}})}
|
||||||
if _, err := AccessPlaces(m, layers); err == nil || !strings.Contains(err.Error(), "issue 339") {
|
if _, err := AccessPlaces(m, layers); err == nil || !strings.Contains(err.Error(), "issue 339") {
|
||||||
t.Errorf("an access at %s: %v", path, err)
|
t.Errorf("an access at %s: %v", path, err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
for _, path := range []string{"/srv/notes", "/mnt/plex/data", "/storage/media", "/services/media/movies",
|
for _, path := range []string{"/srv/notes", "/mnt/plex/data", "/storage/media", "/services/media/movies",
|
||||||
"/var/lib/notes/data", "/home/restic/repo", "/var/lib/mesh-store"} {
|
"/var/lib/notes/data", "/home/restic/repo", "/var/lib/mesh-store"} {
|
||||||
layers := []Layer{{From: "laptop", Values: map[string]any{PlacesSetting: map[string]any{"data": path}}}}
|
layers := []Layer{LayerOf("laptop", map[string]any{PlacesSetting: map[string]any{"data": path}})}
|
||||||
if got, err := Places(m, layers); err != nil || got["data"].Path != path {
|
if got, err := Places(m, layers); err != nil || got["data"].Path != path {
|
||||||
t.Errorf("a place at %s: %v %v", path, got, err)
|
t.Errorf("a place at %s: %v %v", path, got, err)
|
||||||
}
|
}
|
||||||
layers = []Layer{{From: "laptop", Values: map[string]any{AccessesSetting: map[string]any{"media": path}}}}
|
layers = []Layer{LayerOf("laptop", map[string]any{AccessesSetting: map[string]any{"media": path}})}
|
||||||
if got, err := AccessPlaces(m, layers); err != nil || got["media"] != path {
|
if got, err := AccessPlaces(m, layers); err != nil || got["media"] != path {
|
||||||
t.Errorf("an access at %s: %v %v", path, got, err)
|
t.Errorf("an access at %s: %v %v", path, got, err)
|
||||||
}
|
}
|
||||||
@@ -111,17 +111,17 @@ func TestTheRuntimesDataAndAnyHomesSSHAreTheMachinesOwn(t *testing.T) {
|
|||||||
for _, path := range []string{"/var/spool", "/var/spool/cron", "/var/lib/docker", "/var/lib/docker/volumes",
|
for _, path := range []string{"/var/spool", "/var/spool/cron", "/var/lib/docker", "/var/lib/docker/volumes",
|
||||||
"/var/lib/containers/storage", "/var/lib/containerd", "/var/lib/containerd/io.containerd.snapshotter.v1", "/opt", "/opt/app", "/home/alice/.ssh", "/home/alice/.ssh/keys",
|
"/var/lib/containers/storage", "/var/lib/containerd", "/var/lib/containerd/io.containerd.snapshotter.v1", "/opt", "/opt/app", "/home/alice/.ssh", "/home/alice/.ssh/keys",
|
||||||
"/srv/backup/.ssh", "/root/.ssh"} {
|
"/srv/backup/.ssh", "/root/.ssh"} {
|
||||||
layers := []Layer{{From: "laptop", Values: map[string]any{PlacesSetting: map[string]any{"data": path}}}}
|
layers := []Layer{LayerOf("laptop", map[string]any{PlacesSetting: map[string]any{"data": path}})}
|
||||||
if _, err := Places(m, layers); err == nil || !strings.Contains(err.Error(), "issue 339") {
|
if _, err := Places(m, layers); err == nil || !strings.Contains(err.Error(), "issue 339") {
|
||||||
t.Errorf("a place at %s: %v", path, err)
|
t.Errorf("a place at %s: %v", path, err)
|
||||||
}
|
}
|
||||||
layers = []Layer{{From: "laptop", Values: map[string]any{AccessesSetting: map[string]any{"media": path}}}}
|
layers = []Layer{LayerOf("laptop", map[string]any{AccessesSetting: map[string]any{"media": path}})}
|
||||||
if _, err := AccessPlaces(m, layers); err == nil || !strings.Contains(err.Error(), "issue 339") {
|
if _, err := AccessPlaces(m, layers); err == nil || !strings.Contains(err.Error(), "issue 339") {
|
||||||
t.Errorf("an access at %s: %v", path, err)
|
t.Errorf("an access at %s: %v", path, err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
for _, path := range []string{"/var/lib/dockerish", "/home/alice/ssh", "/home/alice/.sshd-notes", "/storage/media"} {
|
for _, path := range []string{"/var/lib/dockerish", "/home/alice/ssh", "/home/alice/.sshd-notes", "/storage/media"} {
|
||||||
layers := []Layer{{From: "laptop", Values: map[string]any{PlacesSetting: map[string]any{"data": path}}}}
|
layers := []Layer{LayerOf("laptop", map[string]any{PlacesSetting: map[string]any{"data": path}})}
|
||||||
if _, err := Places(m, layers); err != nil {
|
if _, err := Places(m, layers); err != nil {
|
||||||
t.Errorf("a place at %s: %v", path, err)
|
t.Errorf("a place at %s: %v", path, err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -23,3 +23,34 @@ func TestTheVaultsSeatDeliversSecret(t *testing.T) {
|
|||||||
t.Fatal("a provider of secret that does not claim the seat was allowed to hold it")
|
t.Fatal("a provider of secret that does not claim the seat was allowed to hold it")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The vault answers `get` on request and reply (novox/hq ADR 0349 §11, issue 674): the seat promises the
|
||||||
|
// verb, so a holder serving it is accepted — and, optional while the vault that runs is the TypeScript one,
|
||||||
|
// so is a holder that does not yet.
|
||||||
|
func TestTheVaultsSeatPromisesGet(t *testing.T) {
|
||||||
|
seat, _ := SeatNamed("mesh-vault")
|
||||||
|
var get *Verb
|
||||||
|
for i := range seat.Serves {
|
||||||
|
if seat.Serves[i].Name == "get" {
|
||||||
|
get = &seat.Serves[i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if get == nil {
|
||||||
|
t.Fatal("the vault's seat does not promise get")
|
||||||
|
}
|
||||||
|
for _, arg := range []string{"name", "public_key"} {
|
||||||
|
if props, _ := get.Input["properties"].(map[string]any); props[arg] == nil {
|
||||||
|
t.Errorf("get takes no %s", arg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
serving := Manifest{Module: "mesh-vault", Provides: []Offer{{Name: "secret", Scope: ScopeMesh}},
|
||||||
|
Claims: []Claim{{Name: "mesh-vault", Scope: ScopeMesh, Serves: []string{"get"}}}}
|
||||||
|
if err := CanHold(serving, seat); err != nil {
|
||||||
|
t.Fatalf("the vault serving get was refused: %v", err)
|
||||||
|
}
|
||||||
|
notYet := Manifest{Module: "mesh-vault", Provides: []Offer{{Name: "secret", Scope: ScopeMesh}},
|
||||||
|
Claims: []Claim{{Name: "mesh-vault", Scope: ScopeMesh}}}
|
||||||
|
if err := CanHold(notYet, seat); err != nil {
|
||||||
|
t.Fatalf("the vault that does not serve get yet was refused: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -117,6 +117,11 @@ func (i *Inventory) RegisterModule(ctx context.Context, m catalogue.Manifest, fr
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
// **The manifest the mesh holds carries each file's text** (novox/hq ADR 0349 §2): one still naming a template
|
||||||
|
// would compose a file with no text, so it is refused by name — a build by a builder that predates templates.
|
||||||
|
if why := catalogue.HeldTemplateProblem(m); why != "" {
|
||||||
|
return fmt.Errorf("%s is not registered: %s", m.Module, why)
|
||||||
|
}
|
||||||
raw, err := json.Marshal(m)
|
raw, err := json.Marshal(m)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -839,7 +844,18 @@ func (i *Inventory) KeepSettings(ctx context.Context, nodeName, module string, v
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (i *Inventory) setSettings(ctx context.Context, nodeName, module string, values map[string]any, judge bool, setBy string) error {
|
func (i *Inventory) setSettings(ctx context.Context, nodeName, module string, values map[string]any, judge bool, setBy string) error {
|
||||||
raw, err := json.Marshal(values)
|
// **Placement is not config** (novox/hq ADR 0348 clause 11, issue 651): the layer is said whole, as
|
||||||
|
// it always was, and its placement keys are kept beside the assignment, never in the settings row.
|
||||||
|
// Both are written in one transaction, and the layer a set replaces is the whole of both.
|
||||||
|
config, placement := catalogue.SplitPlacement(values)
|
||||||
|
if config == nil {
|
||||||
|
config = map[string]any{}
|
||||||
|
}
|
||||||
|
raw, err := json.Marshal(config)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
placed, err := placementJSON(placement)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -881,6 +897,9 @@ func (i *Inventory) setSettings(ctx context.Context, nodeName, module string, va
|
|||||||
do update set values = excluded.values, set_at = now(), set_by = excluded.set_by`, module, raw, nullable(setBy)); err != nil {
|
do update set values = excluded.values, set_at = now(), set_by = excluded.set_by`, module, raw, nullable(setBy)); err != nil {
|
||||||
return wrapModule(err, module)
|
return wrapModule(err, module)
|
||||||
}
|
}
|
||||||
|
if err := keepPlacement(ctx, tx, nil, module, placed, setBy); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
return tx.Commit(ctx)
|
return tx.Commit(ctx)
|
||||||
}
|
}
|
||||||
node, err := i.NodeByName(ctx, nodeName)
|
node, err := i.NodeByName(ctx, nodeName)
|
||||||
@@ -912,6 +931,9 @@ func (i *Inventory) setSettings(ctx context.Context, nodeName, module string, va
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return wrapModule(err, module)
|
return wrapModule(err, module)
|
||||||
}
|
}
|
||||||
|
if err := keepPlacement(ctx, tx, &node.ID, module, placed, setBy); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
// A given port replaces what the mesh assigned for that port: the assignment is given back,
|
// A given port replaces what the mesh assigned for that port: the assignment is given back,
|
||||||
// so the number is free for the next module rather than held for ever in the name of a port
|
// so the number is free for the next module rather than held for ever in the name of a port
|
||||||
// that now lives elsewhere.
|
// that now lives elsewhere.
|
||||||
@@ -942,21 +964,15 @@ func (i *Inventory) judgeSettings(ctx context.Context, nodeName, module string,
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
where, from, adopted = nodeName, nodeName, node.Adopted
|
where, from, adopted = nodeName, nodeName, node.Adopted
|
||||||
var meshWide []byte
|
under, has, err := i.Layer(ctx, "", module)
|
||||||
err = i.store.Pool().QueryRow(ctx,
|
if err != nil {
|
||||||
`select values from settings where module = $1 and node is null`, module).Scan(&meshWide)
|
|
||||||
if err != nil && !errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if len(meshWide) > 0 {
|
if has {
|
||||||
var under map[string]any
|
layers = append(layers, catalogue.LayerOf(catalogue.MeshWideLayer, under))
|
||||||
if err := json.Unmarshal(meshWide, &under); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
layers = append(layers, catalogue.Layer{From: catalogue.MeshWideLayer, Values: under})
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
layers = append(layers, catalogue.Layer{From: from, Values: values})
|
layers = append(layers, catalogue.LayerOf(from, values))
|
||||||
if err := catalogue.JudgeSettings(m, layers, adopted); err != nil {
|
if err := catalogue.JudgeSettings(m, layers, adopted); err != nil {
|
||||||
return fmt.Errorf("refused: %s on %s cannot compose with the layer %q — %w", module, where, from, err)
|
return fmt.Errorf("refused: %s on %s cannot compose with the layer %q — %w", module, where, from, err)
|
||||||
}
|
}
|
||||||
@@ -1089,7 +1105,8 @@ func refuseGivenCollisions(ctx context.Context, tx pgx.Tx, nodeID any, node, mod
|
|||||||
}
|
}
|
||||||
|
|
||||||
func wrapModule(err error, module string) error {
|
func wrapModule(err error, module string) error {
|
||||||
if err != nil && strings.Contains(err.Error(), "settings_module_fkey") {
|
if err != nil && (strings.Contains(err.Error(), "settings_module_fkey") ||
|
||||||
|
strings.Contains(err.Error(), "placement_module_fkey")) {
|
||||||
return fmt.Errorf("%w: %s", ErrNoSuchModule, module)
|
return fmt.Errorf("%w: %s", ErrNoSuchModule, module)
|
||||||
}
|
}
|
||||||
return err
|
return err
|
||||||
@@ -1130,6 +1147,11 @@ func (i *Inventory) ClearSettingsBy(ctx context.Context, nodeName, module, clear
|
|||||||
`delete from settings where module = $1 and node is not distinct from $2::uuid`, module, nodeID); err != nil {
|
`delete from settings where module = $1 and node is not distinct from $2::uuid`, module, nodeID); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
// And its placement, which is the same layer as a person says it (novox/hq ADR 0348 clause 11).
|
||||||
|
if _, err := tx.Exec(ctx,
|
||||||
|
`delete from placement where module = $1 and node is not distinct from $2::uuid`, module, nodeID); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
return tx.Commit(ctx)
|
return tx.Commit(ctx)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1142,10 +1164,13 @@ func (i *Inventory) SettingsFor(ctx context.Context, nodeName, module string) ([
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
// Each layer's placement beside it, from the placement the controller holds (novox/hq ADR 0348
|
||||||
|
// clause 11): a layer's Values hold its config values only, its Placement where things are.
|
||||||
rows, err := i.store.Pool().Query(ctx,
|
rows, err := i.store.Pool().Query(ctx,
|
||||||
`select node is null, values from settings
|
`select s.node is null, s.values, p.values from settings s
|
||||||
where module = $1 and (node is null or node = $2)
|
left join placement p on p.module = s.module and p.node is not distinct from s.node
|
||||||
order by node is null desc`, module, node.ID)
|
where s.module = $1 and (s.node is null or s.node = $2)
|
||||||
|
order by s.node is null desc`, module, node.ID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -1154,23 +1179,62 @@ func (i *Inventory) SettingsFor(ctx context.Context, nodeName, module string) ([
|
|||||||
var layers []catalogue.Layer
|
var layers []catalogue.Layer
|
||||||
for rows.Next() {
|
for rows.Next() {
|
||||||
var meshWide bool
|
var meshWide bool
|
||||||
var raw []byte
|
var raw, placed []byte
|
||||||
if err := rows.Scan(&meshWide, &raw); err != nil {
|
if err := rows.Scan(&meshWide, &raw, &placed); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
values := map[string]any{}
|
values := map[string]any{}
|
||||||
if err := json.Unmarshal(raw, &values); err != nil {
|
if err := json.Unmarshal(raw, &values); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
var placement map[string]any
|
||||||
|
if len(placed) > 0 {
|
||||||
|
if err := json.Unmarshal(placed, &placement); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
from := nodeName
|
from := nodeName
|
||||||
if meshWide {
|
if meshWide {
|
||||||
from = catalogue.MeshWideLayer
|
from = catalogue.MeshWideLayer
|
||||||
}
|
}
|
||||||
layers = append(layers, catalogue.Layer{From: from, Values: values})
|
layers = append(layers, catalogue.Layer{From: from, Values: values, Placement: placement})
|
||||||
}
|
}
|
||||||
return layers, rows.Err()
|
return layers, rows.Err()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// placementJSON is a layer's placement as the placement table keeps it, or nil when it has none.
|
||||||
|
func placementJSON(placement map[string]any) ([]byte, error) {
|
||||||
|
if len(placement) == 0 {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
return json.Marshal(placement)
|
||||||
|
}
|
||||||
|
|
||||||
|
// keepPlacement writes one layer's placement beside its settings row, in the write's transaction: the
|
||||||
|
// placement the layer says, or none when it says none — a set replaces the layer whole, placement too.
|
||||||
|
func keepPlacement(ctx context.Context, tx pgx.Tx, nodeID *string, module string, placed []byte, setBy string) error {
|
||||||
|
if placed == nil {
|
||||||
|
_, err := tx.Exec(ctx,
|
||||||
|
`delete from placement where module = $1 and node is not distinct from $2::uuid`, module, nodeID)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var err error
|
||||||
|
if nodeID == nil {
|
||||||
|
_, err = tx.Exec(ctx,
|
||||||
|
`insert into placement (node, module, values, set_by) values (null, $1, $2, $3)
|
||||||
|
on conflict (module) where node is null
|
||||||
|
do update set values = excluded.values, set_at = now(), set_by = excluded.set_by`,
|
||||||
|
module, placed, nullable(setBy))
|
||||||
|
} else {
|
||||||
|
_, err = tx.Exec(ctx,
|
||||||
|
`insert into placement (node, module, values, set_by) values ($1, $2, $3, $4)
|
||||||
|
on conflict (node, module) where node is not null
|
||||||
|
do update set values = excluded.values, set_at = now(), set_by = excluded.set_by`,
|
||||||
|
*nodeID, module, placed, nullable(setBy))
|
||||||
|
}
|
||||||
|
return wrapModule(err, module)
|
||||||
|
}
|
||||||
|
|
||||||
// PinProvision records which provider a machine gets a provision from: a module, and the node it
|
// PinProvision records which provider a machine gets a provision from: a module, and the node it
|
||||||
// runs on — both, always (novox/hq #258). A provision comes from a module, and the same module on
|
// runs on — both, always (novox/hq #258). A provision comes from a module, and the same module on
|
||||||
// two machines is two answers, so neither half alone says which.
|
// two machines is two answers, so neither half alone says which.
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ package inventory
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -75,3 +76,94 @@ func (i *Inventory) RemoveNodeForTest(ctx context.Context, name string) (bool, e
|
|||||||
}
|
}
|
||||||
return tag.RowsAffected() == 1, nil
|
return tag.RowsAffected() == 1, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ForTestBefore is ForTest with the store migrated only below migration `number`, and a function that runs the
|
||||||
|
// rest: for a test of a migration that moves data, which seeds the store as the mesh holds it before the
|
||||||
|
// migration, migrates, and reads what the migration made of it (novox/hq issue 651).
|
||||||
|
func ForTestBefore(t *testing.T, number int) (*Inventory, func()) {
|
||||||
|
t.Helper()
|
||||||
|
admin := os.Getenv("MESH_TEST_POSTGRES")
|
||||||
|
if admin == "" {
|
||||||
|
t.Skip("no MESH_TEST_POSTGRES; run `make check` to raise one")
|
||||||
|
}
|
||||||
|
name := fmt.Sprintf("invb_%d_%s", time.Now().UnixNano()%1_000_000,
|
||||||
|
strings.ToLower(strings.NewReplacer("/", "", "-", "").Replace(t.Name())))
|
||||||
|
if len(name) > 60 {
|
||||||
|
name = name[:60]
|
||||||
|
}
|
||||||
|
all, err := Migrations()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
var before []store.Migration
|
||||||
|
for _, m := range all {
|
||||||
|
if m.Number < number {
|
||||||
|
before = append(before, m)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
store.CreateMigratedForTest(t, admin, name, before)
|
||||||
|
busPasswordCostForTest.Store(int32(bcrypt.MinCost))
|
||||||
|
cut := strings.LastIndex(admin, "/")
|
||||||
|
t.Setenv(store.Variable(Name), admin[:cut]+"/"+name+"?sslmode=disable")
|
||||||
|
inv, err := Open(t.Context())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
t.Cleanup(func() {
|
||||||
|
inv.Close()
|
||||||
|
c, err := pgx.Connect(context.Background(), admin)
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
defer c.Close(context.Background())
|
||||||
|
_, _ = c.Exec(context.Background(), "drop database if exists "+name+" with (force)")
|
||||||
|
})
|
||||||
|
if err := inv.Ready(t.Context(), 20*time.Second); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return inv, func() {
|
||||||
|
t.Helper()
|
||||||
|
if _, err := inv.store.Migrate(t.Context(), all); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ExecForTest runs one statement against a test's store, for a fixture no verb of the mesh writes: a row as an
|
||||||
|
// older migration left it.
|
||||||
|
func (i *Inventory) ExecForTest(t *testing.T, sql string, args ...any) {
|
||||||
|
t.Helper()
|
||||||
|
if _, err := i.store.Pool().Exec(t.Context(), sql, args...); err != nil {
|
||||||
|
t.Fatalf("%s: %v", sql, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// QueryForTest reads rows of a test's store, each row's columns as JSON text, for a test that checks what a
|
||||||
|
// migration left.
|
||||||
|
func (i *Inventory) QueryForTest(t *testing.T, sql string, args ...any) [][]string {
|
||||||
|
t.Helper()
|
||||||
|
rows, err := i.store.Pool().Query(t.Context(), sql, args...)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("%s: %v", sql, err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
var out [][]string
|
||||||
|
for rows.Next() {
|
||||||
|
values, err := rows.Values()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
row := make([]string, len(values))
|
||||||
|
for k, v := range values {
|
||||||
|
row[k] = fmt.Sprint(v)
|
||||||
|
if b, err := json.Marshal(v); err == nil {
|
||||||
|
row[k] = string(b)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out = append(out, row)
|
||||||
|
}
|
||||||
|
if err := rows.Err(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,46 @@
|
|||||||
|
-- Placement is not config (novox/hq ADR 0348 clause 11, issue 651).
|
||||||
|
--
|
||||||
|
-- Where a module's directories are on a machine (`places`), where the operator's data it reads is
|
||||||
|
-- (`accesses`) and which found networks a taken container keeps (`networks`) were kept as keys of a
|
||||||
|
-- settings layer. They are facts of an assignment that the controller decides, never config values, and
|
||||||
|
-- the config values are leaving for the mesh-config module (ADR 0348 clause 9) while placement stays with
|
||||||
|
-- the controller. So they get a table of their own beside the assignment, and every settings layer's
|
||||||
|
-- placement keys move into it, unchanged.
|
||||||
|
--
|
||||||
|
-- Scoped exactly as the layer they came from: one machine's, or the whole mesh's (node null) for a
|
||||||
|
-- module's every assignment, which is how a mesh-wide `places` or `accesses` layer composes today. The
|
||||||
|
-- composer reads placement from here only; the `settings` verb still takes the three keys and routes
|
||||||
|
-- them here, so nothing a person types changes.
|
||||||
|
create table placement (
|
||||||
|
node uuid references node(id) on delete cascade,
|
||||||
|
module text not null references module(name) on delete cascade,
|
||||||
|
-- Only `places`, `accesses` and `networks`, as the settings layer held them.
|
||||||
|
values jsonb not null,
|
||||||
|
set_at timestamptz not null default now(),
|
||||||
|
set_by text
|
||||||
|
);
|
||||||
|
create unique index placement_for_the_mesh on placement (module) where node is null;
|
||||||
|
create unique index placement_for_a_node on placement (node, module) where node is not null;
|
||||||
|
|
||||||
|
-- Why a layer went into the history, beside how (`replaced_by`): said for a layer this migration moved.
|
||||||
|
alter table settings_history add column why text;
|
||||||
|
|
||||||
|
-- Each layer that held a placement key is kept whole in the history first, as a `settings history` reads it.
|
||||||
|
insert into settings_history (node, module, values, set_at, replaced_by, set_by, why)
|
||||||
|
select node, module, values, set_at, 'moved', set_by, 'moved to placement, ADR 0348 clause 11'
|
||||||
|
from settings
|
||||||
|
where values ?| array['places', 'accesses', 'networks'];
|
||||||
|
|
||||||
|
insert into placement (node, module, values, set_at, set_by)
|
||||||
|
select node, module,
|
||||||
|
(select jsonb_object_agg(e.key, e.value) from jsonb_each(values) as e
|
||||||
|
where e.key in ('places', 'accesses', 'networks')),
|
||||||
|
set_at, set_by
|
||||||
|
from settings
|
||||||
|
where values ?| array['places', 'accesses', 'networks'];
|
||||||
|
|
||||||
|
-- The layer keeps its other keys, when it was set and who set it; a layer that held only placement stays,
|
||||||
|
-- empty, so a layer that existed still exists.
|
||||||
|
update settings
|
||||||
|
set values = values - 'places' - 'accesses' - 'networks'
|
||||||
|
where values ?| array['places', 'accesses', 'networks'];
|
||||||
@@ -0,0 +1,222 @@
|
|||||||
|
package inventory
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/novox/mesh-controller/internal/catalogue"
|
||||||
|
)
|
||||||
|
|
||||||
|
// placedLibrary is a module with each kind of placement: a directory to place, two accesses, a container that
|
||||||
|
// may keep a found network.
|
||||||
|
func placedLibrary() catalogue.Manifest {
|
||||||
|
return catalogue.Manifest{Module: "library", Version: "1",
|
||||||
|
Accesses: []catalogue.Access{{ID: "series"}, {ID: "downloads"}},
|
||||||
|
Resources: []map[string]any{
|
||||||
|
{"id": "config", "type": "directory", "mode": "0750"},
|
||||||
|
{"id": "server", "type": "container",
|
||||||
|
"image": "registry.invalid:5000/library@sha256:" + strings.Repeat("a", 64),
|
||||||
|
"volumes": []any{"${dir:config}:/config", "${access:series}:/series", "${access:downloads}:/downloads"}},
|
||||||
|
{"id": "runtime-config", "type": "file", "path": "${dir:config}/runtime.json", "mode": "0640",
|
||||||
|
"content": `{"log":"info"}`, "merge": "json"},
|
||||||
|
}}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The layers of the issue (651): a mesh-wide layer with an access and a config value, a node's layer with a
|
||||||
|
// place, an access and a kept network beside a config value, a node's layer of placement only, and one with
|
||||||
|
// none.
|
||||||
|
var placementLayers = []struct {
|
||||||
|
node string
|
||||||
|
values string
|
||||||
|
}{
|
||||||
|
{"", `{"accesses": {"downloads": "/storage/downloads"}, "log": "warn"}`},
|
||||||
|
{"anchor", `{"places": {"config": {"path": "/var/lib/library/config", "owner": "1001:2000"}},
|
||||||
|
"accesses": {"series": "/storage/media/series"}, "networks": {"server": ["predecessor_default"]}, "workers": 4}`},
|
||||||
|
{"laptop", `{"accesses": {"series": "/home/media/series"}}`},
|
||||||
|
{"spare", `{"log": "debug"}`},
|
||||||
|
}
|
||||||
|
|
||||||
|
// **Placement moves out of the settings layers, and every layer reads as it did** (novox/hq ADR 0348 clause
|
||||||
|
// 11, issue 651). Migration 0097 moves each layer's places, accesses and kept networks beside it: no settings
|
||||||
|
// row holds a placement key after, every layer the settings verb and composition read is what it was, each
|
||||||
|
// moved layer is kept whole in the history with why, and a layer without placement is not touched.
|
||||||
|
func TestPlacementMovesOutOfTheSettingsLayers(t *testing.T) {
|
||||||
|
inv, migrate := ForTestBefore(t, 97)
|
||||||
|
ctx := t.Context()
|
||||||
|
if err := inv.RegisterModule(ctx, placedLibrary(), Source{}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for _, n := range []string{"anchor", "laptop", "spare"} {
|
||||||
|
if _, err := inv.AddNode(ctx, n); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := inv.SetAdopted(ctx, "anchor", true); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
// As the mesh holds them before the migration: placement among the settings.
|
||||||
|
for _, l := range placementLayers {
|
||||||
|
if l.node == "" {
|
||||||
|
inv.ExecForTest(t, `insert into settings (node, module, values, set_by) values (null, 'library', $1, 'the operator')`, l.values)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
inv.ExecForTest(t, `insert into settings (node, module, values) select id, 'library', $2 from node where name = $1`,
|
||||||
|
l.node, l.values)
|
||||||
|
}
|
||||||
|
setAt := inv.QueryForTest(t, `select coalesce(n.name, ''), s.set_at from settings s left join node n on n.id = s.node order by 1`)
|
||||||
|
|
||||||
|
migrate()
|
||||||
|
|
||||||
|
if held := inv.QueryForTest(t, `select module from settings where values ?| array['places', 'accesses', 'networks']`); len(held) != 0 {
|
||||||
|
t.Fatalf("a settings layer still holds a placement key: %v", held)
|
||||||
|
}
|
||||||
|
if after := inv.QueryForTest(t, `select coalesce(n.name, ''), s.set_at from settings s left join node n on n.id = s.node order by 1`); !reflect.DeepEqual(after, setAt) {
|
||||||
|
t.Fatalf("the layers or when they were set changed: %v, was %v", after, setAt)
|
||||||
|
}
|
||||||
|
for _, l := range placementLayers {
|
||||||
|
var want map[string]any
|
||||||
|
if err := json.Unmarshal([]byte(l.values), &want); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
got, has, err := inv.Layer(ctx, l.node, "library")
|
||||||
|
if err != nil || !has || !reflect.DeepEqual(roundTrip(t, got), want) {
|
||||||
|
t.Errorf("the layer on %q reads %v (%v, %v), was %v", l.node, got, has, err, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Composition's view: the config values in Values, the placement in Placement, together the layer.
|
||||||
|
layers, err := inv.SettingsFor(ctx, "anchor", "library")
|
||||||
|
if err != nil || len(layers) != 2 {
|
||||||
|
t.Fatalf("anchor's layers: %v, %v", layers, err)
|
||||||
|
}
|
||||||
|
if layers[1].Values["workers"] == nil || layers[1].Values["places"] != nil || layers[1].Placement["places"] == nil ||
|
||||||
|
layers[1].Placement["networks"] == nil || layers[0].Placement["accesses"] == nil || layers[0].Values["log"] != "warn" {
|
||||||
|
t.Fatalf("anchor's layers split wrong: %+v", layers)
|
||||||
|
}
|
||||||
|
for i, l := range layers {
|
||||||
|
var want map[string]any
|
||||||
|
_ = json.Unmarshal([]byte(placementLayers[i].values), &want)
|
||||||
|
if !reflect.DeepEqual(roundTrip(t, l.Whole()), want) {
|
||||||
|
t.Errorf("anchor's layer %s is %v whole, was %v", l.From, l.Whole(), want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Judged as composition judges them, as before: anchor is adopted, so its kept network composes.
|
||||||
|
if err := catalogue.JudgeSettings(placedLibrary(), layers, true); err != nil {
|
||||||
|
t.Fatalf("the moved layers no longer compose: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
moved := inv.QueryForTest(t, `select coalesce(n.name, ''), h.replaced_by, h.why, h.set_by from settings_history h
|
||||||
|
left join node n on n.id = h.node order by 1`)
|
||||||
|
want := [][]string{
|
||||||
|
{`""`, `"moved"`, `"moved to placement, ADR 0348 clause 11"`, `"the operator"`},
|
||||||
|
{`"anchor"`, `"moved"`, `"moved to placement, ADR 0348 clause 11"`, `null`},
|
||||||
|
{`"laptop"`, `"moved"`, `"moved to placement, ADR 0348 clause 11"`, `null`},
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(moved, want) {
|
||||||
|
t.Fatalf("the history of what moved: %v, want %v", moved, want)
|
||||||
|
}
|
||||||
|
past, err := inv.SettingsHistory(ctx, "anchor", "library")
|
||||||
|
if err != nil || len(past) != 1 || past[0].Why != "moved to placement, ADR 0348 clause 11" || past[0].Values["places"] == nil {
|
||||||
|
t.Fatalf("settings history on anchor: %+v, %v", past, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// **The settings verb's path still takes a placement key, and routes it** (issue 651): a set keeps the
|
||||||
|
// placement beside the layer and the rest in it, reads back whole, is refused as before when the placement
|
||||||
|
// cannot compose (nothing written), and a set or a clear replaces the placement with the layer.
|
||||||
|
func TestASettingRoutesPlacementBesideTheLayer(t *testing.T) {
|
||||||
|
inv := ForTest(t)
|
||||||
|
ctx := t.Context()
|
||||||
|
if err := inv.RegisterModule(ctx, placedLibrary(), Source{}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := inv.AddNode(ctx, "anchor"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
// Placement alone is a layer as well: the whole mesh's says where both accesses are.
|
||||||
|
meshWide := map[string]any{"accesses": map[string]any{
|
||||||
|
"downloads": "/storage/downloads", "series": "/storage/series"}}
|
||||||
|
if err := inv.SetSettings(ctx, "", "library", meshWide); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got, has, _ := inv.Layer(ctx, "", "library"); !has || !reflect.DeepEqual(roundTrip(t, got), roundTrip(t, meshWide)) {
|
||||||
|
t.Fatalf("the mesh-wide layer of placement only reads %v (%v)", got, has)
|
||||||
|
}
|
||||||
|
set := map[string]any{"log": "warn",
|
||||||
|
"places": map[string]any{"config": map[string]any{"path": "/var/lib/library/config"}},
|
||||||
|
"accesses": map[string]any{"series": "/storage/media/series"}}
|
||||||
|
if err := inv.SetSettings(ctx, "anchor", "library", set); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
stored := inv.QueryForTest(t, `select s.values, p.values from settings s join placement p using (module, node)
|
||||||
|
where s.node is not null`)
|
||||||
|
if len(stored) != 1 || stored[0][0] != `{"log":"warn"}` ||
|
||||||
|
!strings.Contains(stored[0][1], `"places"`) || !strings.Contains(stored[0][1], `"accesses"`) {
|
||||||
|
t.Fatalf("the layer and its placement are kept as %v", stored)
|
||||||
|
}
|
||||||
|
if got, _, _ := inv.Layer(ctx, "anchor", "library"); !reflect.DeepEqual(roundTrip(t, got), roundTrip(t, set)) {
|
||||||
|
t.Fatalf("the layer reads %v, was set %v", got, set)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Refused as before, by the same judgement, and nothing changes.
|
||||||
|
for name, bad := range map[string]map[string]any{
|
||||||
|
"an undeclared directory": {"places": map[string]any{"cache": "/var/lib/library/cache"}},
|
||||||
|
"the machine's own": {"accesses": map[string]any{"series": "/etc"}},
|
||||||
|
"a kept network on a converged machine": {
|
||||||
|
"networks": map[string]any{"server": []any{"predecessor_default"}}},
|
||||||
|
} {
|
||||||
|
if err := inv.SetSettings(ctx, "anchor", "library", bad); err == nil {
|
||||||
|
t.Errorf("%s was kept", name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := inv.SetSettings(ctx, "", "library", map[string]any{"accesses": meshWide["accesses"],
|
||||||
|
"networks": map[string]any{"server": []any{"x"}}}); err == nil || !strings.Contains(err.Error(), "per node") {
|
||||||
|
t.Errorf("a mesh-wide kept network: %v", err)
|
||||||
|
}
|
||||||
|
if got, _, _ := inv.Layer(ctx, "anchor", "library"); !reflect.DeepEqual(roundTrip(t, got), roundTrip(t, set)) {
|
||||||
|
t.Fatalf("a refused set changed the layer to %v", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
// A set without placement replaces it too, and the history keeps the layer whole.
|
||||||
|
if err := inv.SetSettings(ctx, "anchor", "library", map[string]any{"log": "debug"}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if rows := inv.QueryForTest(t, `select module from placement where node is not null`); len(rows) != 0 {
|
||||||
|
t.Fatalf("a set without placement left it: %v", rows)
|
||||||
|
}
|
||||||
|
past, err := inv.SettingsHistory(ctx, "anchor", "library")
|
||||||
|
if err != nil || len(past) != 1 || past[0].Values["places"] == nil || past[0].Values["log"] != "warn" {
|
||||||
|
t.Fatalf("the replaced layer is not kept whole: %+v, %v", past, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// The merge gate's way in keeps a layer as the facts carry it, whole: split the same way.
|
||||||
|
if err := inv.KeepSettings(ctx, "anchor", "library", map[string]any{"log": "info",
|
||||||
|
"places": map[string]any{"config": "/var/lib/library/config"}}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if rows := inv.QueryForTest(t, `select values from settings where values ? 'places'`); len(rows) != 0 {
|
||||||
|
t.Fatalf("a kept layer put placement among the settings: %v", rows)
|
||||||
|
}
|
||||||
|
for _, node := range []string{"", "anchor"} {
|
||||||
|
if err := inv.ClearSettings(ctx, node, "library"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if rows := inv.QueryForTest(t, `select module from placement`); len(rows) != 0 {
|
||||||
|
t.Fatalf("a clear left the placement: %v", rows)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func roundTrip(t *testing.T, v map[string]any) map[string]any {
|
||||||
|
t.Helper()
|
||||||
|
b, err := json.Marshal(v)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
out := map[string]any{}
|
||||||
|
if err := json.Unmarshal(b, &out); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
package inventory
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/novox/mesh-controller/internal/catalogue"
|
||||||
|
)
|
||||||
|
|
||||||
|
// The manifest the mesh holds carries each file's text (novox/hq ADR 0349 §2): one still naming a template — a
|
||||||
|
// build by a builder that predates templates, or a manifest handed over unbuilt — would compose a file with no
|
||||||
|
// text, and is refused by name.
|
||||||
|
func TestAManifestStillNamingATemplateIsNotRegistered(t *testing.T) {
|
||||||
|
inv := ForTest(t)
|
||||||
|
m := catalogue.Manifest{Module: "notifier", Version: "1", Resources: []map[string]any{
|
||||||
|
{"id": "conf", "type": "file", "path": "/etc/notifier.conf", "template": "files/notifier.conf"}}}
|
||||||
|
err := inv.RegisterModule(t.Context(), m, Source{})
|
||||||
|
if err == nil || !strings.Contains(err.Error(), "files/notifier.conf") {
|
||||||
|
t.Fatalf("a manifest naming a template was registered: %v", err)
|
||||||
|
}
|
||||||
|
m.Resources[0] = map[string]any{"id": "conf", "type": "file", "path": "/etc/notifier.conf", "content": "x"}
|
||||||
|
if err := inv.RegisterModule(t.Context(), m, Source{}); err != nil {
|
||||||
|
t.Fatalf("the same manifest with its text was refused: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -20,9 +20,11 @@ func (i *Inventory) Layer(ctx context.Context, nodeName, module string) (map[str
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, false, err
|
return nil, false, err
|
||||||
}
|
}
|
||||||
|
// Said whole, as it was set: its config values and the placement kept beside them (novox/hq ADR 0348
|
||||||
|
// clause 11), so a person reading it before setting it sees every key they may keep or remove.
|
||||||
var raw []byte
|
var raw []byte
|
||||||
err = i.store.Pool().QueryRow(ctx,
|
err = i.store.Pool().QueryRow(ctx, `select `+layerWhole+` from settings s
|
||||||
`select values from settings where module = $1 and node is not distinct from $2::uuid`,
|
where s.module = $1 and s.node is not distinct from $2::uuid`,
|
||||||
module, nodeID).Scan(&raw)
|
module, nodeID).Scan(&raw)
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
if errors.Is(err, pgx.ErrNoRows) {
|
||||||
return nil, false, nil
|
return nil, false, nil
|
||||||
@@ -46,6 +48,9 @@ type PastLayer struct {
|
|||||||
ReplacedBy string
|
ReplacedBy string
|
||||||
// SetBy is who had set the layer, when it was kept (novox/hq ADR 0277); empty for one set before that was kept.
|
// SetBy is who had set the layer, when it was kept (novox/hq ADR 0277); empty for one set before that was kept.
|
||||||
SetBy string
|
SetBy string
|
||||||
|
// Why is why it went, where that was said: "moved to placement, ADR 0348 clause 11" for a layer whose
|
||||||
|
// placement keys migration 0097 moved out of it (ReplacedBy "moved").
|
||||||
|
Why string
|
||||||
}
|
}
|
||||||
|
|
||||||
// LayerOrigin is who set a layer and when (novox/hq ADR 0277): empty words for a layer set before who set it was
|
// LayerOrigin is who set a layer and when (novox/hq ADR 0277): empty words for a layer set before who set it was
|
||||||
@@ -79,7 +84,7 @@ func (i *Inventory) SettingsHistory(ctx context.Context, nodeName, module string
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
rows, err := i.store.Pool().Query(ctx,
|
rows, err := i.store.Pool().Query(ctx,
|
||||||
`select values, set_at, replaced_at, replaced_by, set_by from settings_history
|
`select values, set_at, replaced_at, replaced_by, set_by, why from settings_history
|
||||||
where module = $1 and node is not distinct from $2::uuid order by replaced_at desc`,
|
where module = $1 and node is not distinct from $2::uuid order by replaced_at desc`,
|
||||||
module, nodeID)
|
module, nodeID)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -90,13 +95,16 @@ func (i *Inventory) SettingsHistory(ctx context.Context, nodeName, module string
|
|||||||
for rows.Next() {
|
for rows.Next() {
|
||||||
var raw []byte
|
var raw []byte
|
||||||
var p PastLayer
|
var p PastLayer
|
||||||
var by *string
|
var by, why *string
|
||||||
if err := rows.Scan(&raw, &p.SetAt, &p.ReplacedAt, &p.ReplacedBy, &by); err != nil {
|
if err := rows.Scan(&raw, &p.SetAt, &p.ReplacedAt, &p.ReplacedBy, &by, &why); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
if by != nil {
|
if by != nil {
|
||||||
p.SetBy = *by
|
p.SetBy = *by
|
||||||
}
|
}
|
||||||
|
if why != nil {
|
||||||
|
p.Why = *why
|
||||||
|
}
|
||||||
if err := json.Unmarshal(raw, &p.Values); err != nil {
|
if err := json.Unmarshal(raw, &p.Values); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -107,9 +115,15 @@ func (i *Inventory) SettingsHistory(ctx context.Context, nodeName, module string
|
|||||||
|
|
||||||
// keepReplacedSQL copies a layer into the history before it is replaced or cleared; run in the same
|
// keepReplacedSQL copies a layer into the history before it is replaced or cleared; run in the same
|
||||||
// transaction as the write where there is one, so a write that fails leaves no history of it.
|
// transaction as the write where there is one, so a write that fails leaves no history of it.
|
||||||
|
//
|
||||||
|
// The layer is kept whole, as it was set: its config values and its placement (novox/hq ADR 0348 clause 11).
|
||||||
const keepReplacedSQL = `insert into settings_history (node, module, values, set_at, replaced_by, set_by)
|
const keepReplacedSQL = `insert into settings_history (node, module, values, set_at, replaced_by, set_by)
|
||||||
select node, module, values, set_at, $3, set_by from settings
|
select s.node, s.module, ` + layerWhole + `, s.set_at, $3, s.set_by from settings s
|
||||||
where module = $1 and node is not distinct from $2::uuid`
|
where s.module = $1 and s.node is not distinct from $2::uuid`
|
||||||
|
|
||||||
|
// layerWhole is a settings row `s` with the placement kept beside it folded back in: the layer as it was set.
|
||||||
|
const layerWhole = `s.values || coalesce((select p.values from placement p
|
||||||
|
where p.module = s.module and p.node is not distinct from s.node), '{}'::jsonb)`
|
||||||
|
|
||||||
// layerNode is the node id of a layer, nil for the whole mesh's.
|
// layerNode is the node id of a layer, nil for the whole mesh's.
|
||||||
func (i *Inventory) layerNode(ctx context.Context, nodeName string) (*string, error) {
|
func (i *Inventory) layerNode(ctx context.Context, nodeName string) (*string, error) {
|
||||||
|
|||||||
Vendored
+3
@@ -61,3 +61,6 @@
|
|||||||
./cmd/mesh-controller TestAProviderElsewhereServesItsOwnComposedName
|
./cmd/mesh-controller TestAProviderElsewhereServesItsOwnComposedName
|
||||||
./cmd/mesh-controller TestAReusedCheckBuildIsRegisteredByItsDigestAndGatedAsABuiltOne
|
./cmd/mesh-controller TestAReusedCheckBuildIsRegisteredByItsDigestAndGatedAsABuiltOne
|
||||||
./internal/inventory TestAReportOfABusyContainerIsKeptAndReadBack
|
./internal/inventory TestAReportOfABusyContainerIsKeptAndReadBack
|
||||||
|
./internal/inventory TestPlacementMovesOutOfTheSettingsLayers
|
||||||
|
./internal/inventory TestASettingRoutesPlacementBesideTheLayer
|
||||||
|
./cmd/mesh-controller TestADeclarationIsTheSameAfterPlacementMoves
|
||||||
|
|||||||
Reference in New Issue
Block a user