jschoubben
2c5f818d15
mesh/delivery-group group feat/774-bus-want rejected: composed together: the checker's verdict at the members' heads (a0ab6ce2e316): novox
mesh/delivery closed: the pull request closed unmerged
mesh/check failed: novox: not composed on novox: nats has not been built for this mesh: server is its "server" artifact… | 2c5f818d1522 on 798d73eb11e9
371 lines
17 KiB
Go
371 lines
17 KiB
Go
package apply
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"os"
|
|
"path/filepath"
|
|
"slices"
|
|
"strings"
|
|
"testing"
|
|
|
|
"git.novox.be/novox/mesh-sdk/go/declaration"
|
|
"github.com/novox/mesh-host/internal/store"
|
|
)
|
|
|
|
// R6-A AC3: given two modules declaring one path, when one module's want changes, the shared path is neither removed
|
|
// nor taken from the other module (novox/hq ADR 0539 §9).
|
|
func TestASharedPathIsNeitherRemovedNorTakenFromTheOtherModule(t *testing.T) {
|
|
dir := t.TempDir()
|
|
shared := filepath.Join(dir, "shared.conf")
|
|
own := filepath.Join(dir, "a-own.conf")
|
|
a := declare(t, `{"id":"a.shared","type":"file","path":"`+shared+`","content":"x\n","module":"a"},
|
|
{"id":"a.own","type":"file","path":"`+own+`","content":"a\n","module":"a"}`)
|
|
b := declare(t, `{"id":"b.shared","type":"file","path":"`+shared+`","content":"x\n","module":"b"}`)
|
|
|
|
state := store.State{}
|
|
var err error
|
|
_, state, err = ApplyModule(context.Background(), archHost(t), a, Scope{Module: "a", Others: b.Resources},
|
|
state, store.OriginDeclared, noServices, nil, nil, nil, nil)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
_, state, err = ApplyModule(context.Background(), archHost(t), b, Scope{Module: "b", Others: a.Resources},
|
|
state, store.OriginDeclared, noServices, nil, nil, nil, nil)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
// A's want changes: it no longer declares the shared path, and b still does.
|
|
a2 := declare(t, `{"id":"a.own","type":"file","path":"`+own+`","content":"a\n","module":"a"}`)
|
|
report, state, err := ApplyModule(context.Background(), archHost(t), a2, Scope{Module: "a", Others: b.Resources},
|
|
state, store.OriginDeclared, noServices, nil, nil, nil, nil)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if !exists(shared) {
|
|
t.Fatal("the path another module still declares was removed")
|
|
}
|
|
if _, still := state.Find("b.shared"); !still {
|
|
t.Fatal("the other module's record was taken away")
|
|
}
|
|
if _, still := state.Find("a.shared"); still {
|
|
t.Fatal("the module's own record of the shared path was kept")
|
|
}
|
|
if o := outcomeOf(report, "a.shared"); o.Action != "forgotten" {
|
|
t.Fatalf("the shared path: %+v", o)
|
|
}
|
|
}
|
|
|
|
// R6-A AC4: given modules A and B on a node, when A's want is removed, only A's resources are removed and B is
|
|
// untouched.
|
|
func TestARemovedModuleTakesOnlyItsOwnResources(t *testing.T) {
|
|
dir := t.TempDir()
|
|
fa, fb := filepath.Join(dir, "a.conf"), filepath.Join(dir, "b.conf")
|
|
d := declare(t, `{"id":"a.conf","type":"file","path":"`+fa+`","content":"a\n","module":"a"},
|
|
{"id":"b.conf","type":"file","path":"`+fb+`","content":"b\n","module":"b"}`)
|
|
_, state, err := Apply(context.Background(), archHost(t), d, store.State{}, store.OriginDeclared, noServices, nil, nil)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if rec, _ := state.Find("a.conf"); rec.Module != "a" {
|
|
t.Fatalf("the owner was not recorded: %+v", rec)
|
|
}
|
|
|
|
gone := &declaration.Declaration{}
|
|
b := declare(t, `{"id":"b.conf","type":"file","path":"`+fb+`","content":"b\n","module":"b"}`)
|
|
report, state, err := ApplyModule(context.Background(), archHost(t), gone, Scope{Module: "a", Others: b.Resources},
|
|
state, store.OriginDeclared, noServices, nil, nil, nil, nil)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if exists(fa) || !exists(fb) {
|
|
t.Fatalf("a's file exists %v, b's file exists %v", exists(fa), exists(fb))
|
|
}
|
|
if o := outcomeOf(report, "a.conf"); o.Action != "removed" {
|
|
t.Fatalf("a's file: %+v", o)
|
|
}
|
|
if _, still := state.Find("b.conf"); !still {
|
|
t.Fatal("b's record was removed")
|
|
}
|
|
if _, still := state.Find("a.conf"); still {
|
|
t.Fatal("a's record is still there")
|
|
}
|
|
}
|
|
|
|
// A record from before the owner was kept is read by its id, so the first removal after the switch is the module's too.
|
|
func TestARecordWithoutAnOwnerBelongsToTheModuleItsIdNames(t *testing.T) {
|
|
dir := t.TempDir()
|
|
fa, fb := filepath.Join(dir, "a.conf"), filepath.Join(dir, "b.conf")
|
|
d := declare(t, `{"id":"a.conf","type":"file","path":"`+fa+`","content":"a\n"},
|
|
{"id":"b.conf","type":"file","path":"`+fb+`","content":"b\n"}`)
|
|
_, state, err := Apply(context.Background(), archHost(t), d, store.State{}, store.OriginDeclared, noServices, nil, nil)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
for i := range state.Resources {
|
|
state.Resources[i].Module = ""
|
|
}
|
|
_, state, err = ApplyModule(context.Background(), archHost(t), &declaration.Declaration{}, Scope{Module: "a"},
|
|
state, store.OriginDeclared, noServices, nil, nil, nil, nil)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if exists(fa) || !exists(fb) {
|
|
t.Fatalf("a's file exists %v, b's file exists %v", exists(fa), exists(fb))
|
|
}
|
|
}
|
|
|
|
// A resource that leaves the node's own composition for its module's own is that module's now: the node's own apply
|
|
// leaves it as it is, whatever its type, until the module's own apply takes it (issue 1945, live on 2026-10-25 at 02:32:
|
|
// shanks and g14 lost systemd-resolved's guard, its resolver files and sudo's operator file, ace qbittorrent's server,
|
|
// because the node's own apply removed every record no longer in it, the others holding the very same resources or not).
|
|
//
|
|
// And a resource the node's own composition carried for a module a want still places here (a folded module of the old
|
|
// form, held) is never removed by the node's own apply when a composition leaves it out: the apply is refused whole and
|
|
// says why (issue 774, live on 2026-10-29 at 07:54 UTC on the bus node: the node's own composition, composed without what
|
|
// it ran once the kept declaration was read no more, removed the bus server, the proxy and three held modules). Only its
|
|
// want's removal lets it go.
|
|
func TestAResourceThatMovedToItsModulesCompositionIsLeftByTheNodesOwnApply(t *testing.T) {
|
|
for _, tc := range []struct {
|
|
name string
|
|
id string // the resource the node's own composition carried, and no longer does
|
|
moved bool // its module's own composition now declares it (Others)
|
|
// dropped: its module has a composition of its own here that no longer declares it (Others holds another of its
|
|
// resources); the node's own apply leaves it, and the module's own apply removes it.
|
|
dropped bool
|
|
placed bool // a want still places its module here
|
|
refused bool // the node's own apply is refused whole
|
|
stays bool // the resource is still on the machine and recorded
|
|
// wants names the modules whose want says removed (Scope.RemovedByWant); nil leaves the guard to Placed alone.
|
|
wants []string
|
|
}{
|
|
{name: "moved to its module's own composition", id: "systemd-resolved.fact-suffix", moved: true, placed: true, stays: true},
|
|
{name: "a held folded module, in no composition", id: "nats.server-conf", placed: true, refused: true, stays: true},
|
|
{name: "its module's want removed", id: "nats.server-conf"},
|
|
// Issue 774, review of the re-land, round 1: a module folded in the node's own has no want, so Placed does not name
|
|
// it; in the node's own apply only a module a want removed loses its resources.
|
|
{name: "a folded module with no want", id: "nats.server-conf", wants: []string{}, refused: true, stays: true},
|
|
{name: "a folded module a want removed", id: "nats.server-conf", wants: []string{"nats", "old"}},
|
|
// 2026-10-30 19:42 on the bus node: restic's manifest replaced its process measure by awake. Its record was the
|
|
// node's, carried when restic was folded, so restic's own apply never saw it and the node's own was refused
|
|
// whole every two minutes, applying nothing of the node's own.
|
|
{name: "its module's own composition dropped it", id: "restic.measure", dropped: true, placed: true,
|
|
wants: []string{"old"}, stays: true},
|
|
} {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
dir := t.TempDir()
|
|
fact := filepath.Join(dir, "carried")
|
|
gone := filepath.Join(dir, "gone.conf")
|
|
own := declare(t, `{"id":"`+tc.id+`","type":"file","path":"`+fact+`","content":"mesh\n"},
|
|
{"id":"old.gone","type":"file","path":"`+gone+`","content":"g\n"}`)
|
|
_, state, err := ApplyModule(context.Background(), archHost(t), own, Scope{Module: store.NodeModule},
|
|
state0(), store.OriginDeclared, noServices, nil, nil, nil, nil)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
module, _ := declaration.ModuleGuess(tc.id)
|
|
scope := Scope{Module: store.NodeModule}
|
|
if tc.moved {
|
|
moved := declare(t, `{"id":"`+tc.id+`","type":"file","path":"`+fact+`","content":"mesh\n","module":"`+module+`"}`)
|
|
scope.Others = moved.Resources
|
|
}
|
|
if tc.dropped {
|
|
later := declare(t, `{"id":"`+module+`.awake","type":"file","path":"`+filepath.Join(dir, "awake")+
|
|
`","content":"a\n","module":"`+module+`"}`)
|
|
scope.Others = later.Resources
|
|
}
|
|
if tc.placed {
|
|
scope.Placed = map[string]bool{module: true}
|
|
}
|
|
if tc.wants != nil {
|
|
scope.RemovedByWant = map[string]bool{}
|
|
for _, m := range tc.wants {
|
|
scope.RemovedByWant[m] = true
|
|
}
|
|
}
|
|
report, after, err := ApplyModule(context.Background(), archHost(t), &declaration.Declaration{}, scope, state,
|
|
store.OriginDeclared, noServices, nil, nil, nil, nil)
|
|
if tc.refused != (err != nil) {
|
|
t.Fatalf("refused %v, want %v: %v", err != nil, tc.refused, err)
|
|
}
|
|
if tc.refused {
|
|
if !strings.Contains(err.Error(), tc.id+" of "+module) {
|
|
t.Fatalf("the refusal does not name what it kept: %v", err)
|
|
}
|
|
after = state
|
|
}
|
|
if exists(fact) != tc.stays {
|
|
t.Fatalf("the carried resource exists %v, want %v: %+v", exists(fact), tc.stays, outcomeOf(report, tc.id))
|
|
}
|
|
if _, still := after.Find(tc.id); still != tc.stays {
|
|
t.Fatalf("the carried resource's record kept %v, want %v", still, tc.stays)
|
|
}
|
|
if exists(gone) == !tc.refused {
|
|
t.Fatalf("a resource no composition holds any more exists %v, with the apply refused %v", exists(gone), tc.refused)
|
|
}
|
|
if tc.dropped {
|
|
if o := outcomeOf(report, tc.id); o.Action != "kept" {
|
|
t.Fatalf("the node's own apply did not say it left it: %+v", o)
|
|
}
|
|
later := declare(t, `{"id":"`+module+`.awake","type":"file","path":"`+filepath.Join(dir, "awake")+
|
|
`","content":"a\n","module":"`+module+`"}`)
|
|
_, last, err := ApplyModule(context.Background(), archHost(t), later, Scope{Module: module}, after,
|
|
store.OriginDeclared, noServices, nil, nil, nil, nil)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if _, still := last.Find(tc.id); still || exists(fact) {
|
|
t.Fatalf("the module's own apply left what it no longer declares: recorded %v, on the machine %v",
|
|
still, exists(fact))
|
|
}
|
|
}
|
|
})
|
|
}
|
|
// Issue 774, ADR 0594 §2: the bus module's first own apply takes over the server the node's own composition made
|
|
// while the bus was folded. Kept (a want without the warrant's mark), the server's container and its program archive
|
|
// are left as they run, whatever the build changed in them, and become nats's; its files and the tools' account file
|
|
// are written. Not kept, the same apply replaces the container.
|
|
// Review of 774, round 1: the keep is decided once before anything moves, by the runtime's answer for the server. A
|
|
// server not there is made and its archives applied with it, none said kept; a runtime that does not answer fails the
|
|
// apply, nothing written and nothing replaced; a removal of the bus removes the rest and leaves the server.
|
|
for _, tc := range []struct {
|
|
name string
|
|
keep bool
|
|
gone bool // the server is not on the machine
|
|
mute bool // the runtime does not answer the server's inspect
|
|
remove bool // the bus module's want is removed
|
|
}{
|
|
{name: "kept", keep: true},
|
|
{name: "not kept"},
|
|
{name: "kept, the server not there", keep: true, gone: true},
|
|
{name: "kept, the runtime does not answer", keep: true, mute: true},
|
|
{name: "kept, the bus removed", keep: true, remove: true},
|
|
} {
|
|
t.Run("the bus server "+tc.name, func(t *testing.T) {
|
|
keep := tc.keep && !tc.gone
|
|
dir := t.TempDir()
|
|
conf, account, program := filepath.Join(dir, "nats.conf"), filepath.Join(dir, "tools", "account"), filepath.Join(dir, "program")
|
|
bus := func(env, confBody, programBody, module string) *declaration.Declaration {
|
|
archive, _ := archiveDecl(t, "nats.program-snapshot", program, map[string]string{"snapshot": programBody}, "")
|
|
if module != "" {
|
|
archive = strings.Replace(archive, `"id":"nats.program-snapshot"`, `"id":"nats.program-snapshot","module":"nats"`, 1)
|
|
module = `,"module":"nats"`
|
|
}
|
|
return declare(t, archive+`,
|
|
{"id":"nats.server-conf","type":"file","path":"`+conf+`","content":"`+confBody+`"`+module+`},
|
|
{"id":"nats.server","type":"container","name":"mesh-broker-nats","image":"`+pinned+`","env":{"V":"`+env+
|
|
`"},"restart-on":["nats.program-snapshot","nats.server-conf"]`+module+`}`)
|
|
}
|
|
m := &machine{containers: map[string]*fakeContainer{}}
|
|
_, state, err := ApplyModule(context.Background(), archHost(t), bus("1", "a", "one", ""), Scope{Module: store.NodeModule},
|
|
state0(), store.OriginDeclared, m.run, nil, nil, nil, nil)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
made := m.containers["mesh-broker-nats"]
|
|
if made == nil {
|
|
t.Fatalf("the node's own made no server: %v", m.asked)
|
|
}
|
|
if tc.gone {
|
|
delete(m.containers, "mesh-broker-nats")
|
|
}
|
|
m.asked = nil
|
|
run := m.run
|
|
if tc.mute {
|
|
run = func(ctx context.Context, name string, args ...string) (string, error) {
|
|
if name == "docker" && len(args) > 1 && args[0] == "container" && args[1] == "inspect" {
|
|
m.asked = append(m.asked, "docker "+strings.Join(args, " "))
|
|
return "", errors.New("Cannot connect to the Docker daemon at unix:///var/run/docker.sock")
|
|
}
|
|
return m.run(ctx, name, args...)
|
|
}
|
|
}
|
|
next := bus("2", "b", "two", "nats")
|
|
next.Resources = append(next.Resources, declare(t, `{"id":"nats.tools-account","type":"file","path":"`+account+
|
|
`","content":"tools","module":"nats"}`).Resources...)
|
|
scope := Scope{Module: "nats", Placed: map[string]bool{"nats": true}}
|
|
if tc.keep {
|
|
scope.Keep = map[string]bool{"nats.server": true, "nats.program-snapshot": true}
|
|
}
|
|
moved := func() []string {
|
|
var out []string
|
|
for _, a := range m.asked {
|
|
for _, verb := range []string{"docker rm", "docker run", "docker create", "docker stop", "docker restart", "docker rename"} {
|
|
if strings.HasPrefix(a, verb+" ") {
|
|
out = append(out, a)
|
|
}
|
|
}
|
|
}
|
|
return out
|
|
}
|
|
report, after, err := ApplyModule(context.Background(), archHost(t), next, scope, state,
|
|
store.OriginDeclared, run, nil, nil, nil, nil)
|
|
if tc.mute {
|
|
if err == nil || !strings.Contains(err.Error(), "did not say whether the bus server") {
|
|
t.Fatalf("an unanswered inspect did not fail the apply: %v", err)
|
|
}
|
|
if got, _ := os.ReadFile(conf); string(got) != "a" || len(moved()) > 0 {
|
|
t.Errorf("an apply that could not tell whether the server runs wrote %q and moved %v", got, moved())
|
|
}
|
|
return
|
|
}
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if keep == (len(moved()) > 0) {
|
|
t.Fatalf("kept %v, and the server was moved by %v", keep, moved())
|
|
}
|
|
if got, _ := os.ReadFile(conf); string(got) != "b" {
|
|
t.Errorf("the server's file holds %q", got)
|
|
}
|
|
if got, _ := os.ReadFile(account); string(got) != "tools" {
|
|
t.Errorf("the tools' account file holds %q", got)
|
|
}
|
|
if got, _ := os.ReadFile(filepath.Join(program, "snapshot")); keep != (string(got) == "one") {
|
|
t.Errorf("kept %v, and the server's program is %q", keep, got)
|
|
}
|
|
var kept []string
|
|
for _, id := range []string{"nats.program-snapshot", "nats.server"} {
|
|
rec, ok := after.Find(id)
|
|
if !ok || rec.Module != "nats" {
|
|
t.Errorf("%s is recorded %+v, not as nats's", id, rec)
|
|
}
|
|
if o := outcomeOf(report, id); keep != (o.Action == keptAsItRuns) {
|
|
t.Errorf("kept %v, and %s was %s: %s", keep, id, o.Action, o.Detail)
|
|
}
|
|
if keep {
|
|
kept = append(kept, id)
|
|
}
|
|
}
|
|
if !slices.Equal(report.Kept, kept) && !(len(kept) == 0 && len(report.Kept) == 0) {
|
|
t.Errorf("the report says it kept %v, want %v", report.Kept, kept)
|
|
}
|
|
if tc.keep && report.Changed() == false {
|
|
t.Error("an apply that wrote the server's files says nothing changed")
|
|
}
|
|
if !tc.remove {
|
|
return
|
|
}
|
|
m.asked = nil
|
|
gone, last, err := ApplyModule(context.Background(), archHost(t), &declaration.Declaration{}, scope, after,
|
|
store.OriginDeclared, run, nil, nil, nil, nil)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if len(moved()) > 0 || m.containers["mesh-broker-nats"] == nil || !exists(filepath.Join(program, "snapshot")) {
|
|
t.Errorf("the bus's removal removed its server: %v", moved())
|
|
}
|
|
if exists(conf) || exists(account) {
|
|
t.Errorf("the bus's removal left the rest of it: conf %v, account %v", exists(conf), exists(account))
|
|
}
|
|
if _, ok := last.Find("nats.server"); !ok || !slices.Equal(gone.Kept, []string{"nats.program-snapshot", "nats.server"}) &&
|
|
!slices.Equal(gone.Kept, []string{"nats.server", "nats.program-snapshot"}) {
|
|
t.Errorf("the removal kept %v, the server recorded %v", gone.Kept, ok)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func state0() store.State { return store.State{} }
|