Compare commits
87
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e0d1de0475 | ||
|
|
db26f7e8b6 | ||
|
|
d4ae4b6790 | ||
|
|
2f6741b7f8 | ||
|
|
20a6dc4920 | ||
|
|
c4f37c279a | ||
|
|
7f89cb51de | ||
|
|
518dae5ec9 | ||
|
|
e8f8ef63fa | ||
|
|
4f4d5ca9c9 | ||
|
|
a8fbabbfc3 | ||
|
|
b9911dc1c1 | ||
|
|
e6b2df6506 | ||
|
|
f9d11acf23 | ||
|
|
10b6e20232 | ||
|
|
da7f045575 | ||
|
|
748c564cdf | ||
|
|
312878befb | ||
|
|
d7a9b9688b | ||
|
|
7f9cc0e55c | ||
|
|
e45bdc0891 | ||
|
|
a523a8cbb0 | ||
|
|
5da87a0dda | ||
|
|
e64486b0e6 | ||
|
|
64a502d16a | ||
|
|
de5b33843f | ||
|
|
d8da8f1d36 | ||
|
|
d506f2196a | ||
|
|
d6cef5829b | ||
|
|
826fd73cf2 | ||
|
|
aee971c198 | ||
|
|
bfc3883af9 | ||
|
|
19c1d35939 | ||
|
|
bc0c25e510 | ||
|
|
8c6e18e822 | ||
|
|
d9fa5536a8 | ||
|
|
dd0d156b9e | ||
|
|
51bc6a65b6 | ||
|
|
66bf26c0d7 | ||
|
|
34f210e5eb | ||
|
|
4e0036cc95 | ||
|
|
4784762a70 | ||
|
|
668fc2a722 | ||
|
|
20d18eb4f5 | ||
|
|
e1f393bbb1 | ||
|
|
35e86b00d3 | ||
|
|
53a1de2aaa | ||
|
|
403a5d72ab | ||
|
|
1ff6d33978 | ||
|
|
a2c813a6b4 | ||
|
|
a9560890ee | ||
|
|
bec9585d50 | ||
|
|
fc4f57c4b3 | ||
|
|
88fa74ce5e | ||
|
|
9205222a98 | ||
|
|
285566eed1 | ||
|
|
51756ee9a4 | ||
|
|
d7375c9811 | ||
|
|
232ded26ea | ||
|
|
691c97ec31 | ||
|
|
ba092d543f | ||
|
|
c3915ffb11 | ||
|
|
34338df950 | ||
|
|
07462c4caa | ||
|
|
6003da0a58 | ||
|
|
3e5d4c30ff | ||
|
|
1672f40233 | ||
|
|
e1dca0a39f | ||
|
|
4b503f8d0d | ||
|
|
8cd22892a3 | ||
|
|
1f6fc027c0 | ||
|
|
f625d98713 | ||
|
|
c2967432e6 | ||
|
|
69041c5302 | ||
|
|
792fb2ccfd | ||
|
|
89aa6fc17c | ||
|
|
a1d73bdcf0 | ||
|
|
d9384bcb23 | ||
|
|
b9b9c5120c | ||
|
|
37eff6fe5c | ||
|
|
687d715e99 | ||
|
|
ec2bd3b990 | ||
|
|
2248b985bf | ||
|
|
780be2fae5 | ||
|
|
5ab7ccf47e | ||
|
|
6147a20454 | ||
|
|
7aacbc1620 |
@@ -0,0 +1,401 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"path"
|
||||||
|
"slices"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
// **One ask, one whole job** (novox/hq ADR 0525 §3). A build module runs a pulled ask with its own step tools' bodies,
|
||||||
|
// the same ones its request and reply tools run (ADR 0525 §8), in the order the job names: a build ask fetches, then
|
||||||
|
// builds or copies each artifact; a check ask fetches, digests the level, takes the kept verdicts and tests the rest,
|
||||||
|
// the packages whose tests the change touches first. The answers are the tools' own, whole, so the asker judges them as
|
||||||
|
// it judged the tools' answers.
|
||||||
|
|
||||||
|
// StepFunc is one step tool's body: its arguments in, its answer out.
|
||||||
|
type StepFunc func(ctx context.Context, args map[string]any) (any, error)
|
||||||
|
|
||||||
|
// AskSteps are the step tools a build module runs an ask with. Copy is the image module's alone; Digest the Go module's.
|
||||||
|
type AskSteps struct {
|
||||||
|
Fetch, Build, Copy, Digest, Test StepFunc
|
||||||
|
// Toolchain is the toolchain the module builds with now; a build ask naming another is refused. Nil checks nothing
|
||||||
|
// (an image or an archive names none).
|
||||||
|
Toolchain func(ctx context.Context) (delivery.ToolchainUsed, error)
|
||||||
|
// Kept looks up a kept verdict by level and digest (the checker's kept bucket, delivery.KeptKey): whether one is
|
||||||
|
// kept and how many tests it counted. Nil takes none.
|
||||||
|
Kept func(ctx context.Context, level, digest string) (tests int, found bool, err error)
|
||||||
|
// Release removes a workspace once the ask's steps on it ended (the module's release tool's body); nil leaves it to
|
||||||
|
// the module's sweep.
|
||||||
|
Release func(workspace string) error
|
||||||
|
Logf func(format string, args ...any)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RunAsk runs ask's job with steps and answers a delivery.BuildAnswer or a delivery.CheckAnswer.
|
||||||
|
func RunAsk(ctx context.Context, steps AskSteps, ask delivery.StepAsk) (any, error) {
|
||||||
|
if ask.Build != nil {
|
||||||
|
return steps.build(ctx, *ask.Build)
|
||||||
|
}
|
||||||
|
if ask.Check != nil {
|
||||||
|
return steps.check(ctx, *ask.Check)
|
||||||
|
}
|
||||||
|
return nil, Refuse("the ask %s holds no job", ask.ID)
|
||||||
|
}
|
||||||
|
|
||||||
|
func raw(v any) (json.RawMessage, error) {
|
||||||
|
if r, ok := v.(json.RawMessage); ok {
|
||||||
|
return r, nil
|
||||||
|
}
|
||||||
|
return json.Marshal(v)
|
||||||
|
}
|
||||||
|
|
||||||
|
// fetched is what an ask reads of a fetch's answer.
|
||||||
|
type fetched struct {
|
||||||
|
Workspace string `json:"workspace"`
|
||||||
|
Merge string `json:"merge"`
|
||||||
|
Conflicts []string `json:"conflicts"`
|
||||||
|
Changed []string `json:"changed"`
|
||||||
|
Modules []string `json:"modules"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s AskSteps) fetch(ctx context.Context, args map[string]any) (json.RawMessage, fetched, error) {
|
||||||
|
if s.Fetch == nil {
|
||||||
|
return nil, fetched{}, Refuse("this build module fetches nothing")
|
||||||
|
}
|
||||||
|
out, err := s.Fetch(ctx, args)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fetched{}, err
|
||||||
|
}
|
||||||
|
r, err := raw(out)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fetched{}, err
|
||||||
|
}
|
||||||
|
var f fetched
|
||||||
|
if err := json.Unmarshal(r, &f); err != nil || f.Workspace == "" {
|
||||||
|
return r, f, fmt.Errorf("the fetch answered no workspace: %s", r)
|
||||||
|
}
|
||||||
|
return r, f, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s AskSteps) build(ctx context.Context, job delivery.BuildJob) (any, error) {
|
||||||
|
answer := delivery.BuildAnswer{}
|
||||||
|
if job.Toolchain != nil && s.Toolchain != nil {
|
||||||
|
tc, err := s.Toolchain(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if tc.Version != job.Toolchain.Version || tc.Recipe != job.Toolchain.Recipe {
|
||||||
|
return nil, Refuse("the ask is for %s (recipe %s) and this node builds with %s (recipe %s)",
|
||||||
|
job.Toolchain.Version, job.Toolchain.Recipe, tc.Version, tc.Recipe)
|
||||||
|
}
|
||||||
|
answer.Toolchain = &tc
|
||||||
|
}
|
||||||
|
var f fetched
|
||||||
|
defer func() { s.release(f.Workspace) }()
|
||||||
|
for _, a := range job.Artifacts {
|
||||||
|
if a.From == "" && f.Workspace == "" {
|
||||||
|
r, got, err := s.fetch(ctx, job.Fetch)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if _, candidate := job.Fetch["base"]; candidate {
|
||||||
|
// A candidate is built from its head merged onto the trunk; a head that does not merge leaves the tree at the
|
||||||
|
// trunk, and building that would store the trunk's build under the candidate's fingerprint.
|
||||||
|
if len(got.Conflicts) > 0 {
|
||||||
|
return nil, fmt.Errorf("the head does not merge into the trunk: files in conflict: %s", strings.Join(got.Conflicts, ", "))
|
||||||
|
}
|
||||||
|
if got.Merge == "" {
|
||||||
|
return nil, fmt.Errorf("the fetch with a base answered no merge: %s", r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
f = got
|
||||||
|
}
|
||||||
|
var (
|
||||||
|
out any
|
||||||
|
err error
|
||||||
|
)
|
||||||
|
if a.From != "" {
|
||||||
|
if s.Copy == nil {
|
||||||
|
return nil, Refuse("this build module copies no artifact (%s)", a.Artifact)
|
||||||
|
}
|
||||||
|
out, err = s.Copy(ctx, map[string]any{"module": job.Module, "artifact": a.Artifact, "from": a.From})
|
||||||
|
} else {
|
||||||
|
if s.Build == nil {
|
||||||
|
return nil, Refuse("this build module builds no artifact (%s)", a.Artifact)
|
||||||
|
}
|
||||||
|
args := map[string]any{"workspace": f.Workspace, "module": job.Path, "artifact": a.Artifact}
|
||||||
|
if job.Publish {
|
||||||
|
args["publish"] = true
|
||||||
|
}
|
||||||
|
out, err = s.Build(ctx, args)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("%s: %w", a.Artifact, err)
|
||||||
|
}
|
||||||
|
r, err := raw(out)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
var built struct {
|
||||||
|
Digest string `json:"digest"`
|
||||||
|
Reference string `json:"reference"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(r, &built); err != nil || built.Digest == "" {
|
||||||
|
return nil, fmt.Errorf("the build of %s answered no digest: %s", a.Artifact, r)
|
||||||
|
}
|
||||||
|
answer.Artifacts = append(answer.Artifacts, delivery.AskBuilt{Artifact: a.Artifact, Digest: built.Digest, Reference: built.Reference})
|
||||||
|
}
|
||||||
|
return answer, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s AskSteps) check(ctx context.Context, job delivery.CheckJob) (any, error) {
|
||||||
|
r, f, err := s.fetch(ctx, job.Fetch)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
defer s.release(f.Workspace)
|
||||||
|
answer := delivery.CheckAnswer{Fetch: r}
|
||||||
|
if len(f.Conflicts) > 0 {
|
||||||
|
return answer, nil // the asker reads the conflict from the fetch's answer: a verdict, not an error
|
||||||
|
}
|
||||||
|
if s.Test == nil {
|
||||||
|
return nil, Refuse("this build module tests nothing")
|
||||||
|
}
|
||||||
|
runner := ""
|
||||||
|
if job.Runner != "" && (job.RunnerWhen == "" || changesUnder(f.Changed, job.RunnerWhen)) {
|
||||||
|
runner = job.Runner
|
||||||
|
}
|
||||||
|
for _, level := range job.Levels {
|
||||||
|
la := delivery.LevelAnswer{Level: level}
|
||||||
|
passed, err := s.level(ctx, job, level, f, runner, &la)
|
||||||
|
answer.Levels = append(answer.Levels, la)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if !passed {
|
||||||
|
return answer, nil // the first level that did not pass ends the check (ADR 0484 clause 13)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return answer, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// level runs one level of a check ask and says whether it passed.
|
||||||
|
func (s AskSteps) level(ctx context.Context, job delivery.CheckJob, level string, f fetched, runner string, la *delivery.LevelAnswer) (bool, error) {
|
||||||
|
withRunner := func(args map[string]any) map[string]any {
|
||||||
|
if runner != "" {
|
||||||
|
args["runner"] = runner
|
||||||
|
}
|
||||||
|
return args
|
||||||
|
}
|
||||||
|
test := func(args map[string]any) (bool, error) {
|
||||||
|
out, err := s.Test(ctx, args)
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
r, err := raw(out)
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
la.Tests = append(la.Tests, r)
|
||||||
|
var t struct {
|
||||||
|
Passed bool `json:"passed"`
|
||||||
|
}
|
||||||
|
_ = json.Unmarshal(r, &t)
|
||||||
|
return t.Passed, nil
|
||||||
|
}
|
||||||
|
if s.Digest == nil {
|
||||||
|
// A module with no digest (Node) tests each module directory of the tree, those whose tests changed first.
|
||||||
|
for _, priority := range []bool{true, false} {
|
||||||
|
for _, dir := range f.Modules {
|
||||||
|
if changesTestIn(f.Changed, dir) != priority {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
passed, err := test(withRunner(map[string]any{"workspace": f.Workspace, "module": dir, "level": level}))
|
||||||
|
if err != nil {
|
||||||
|
return false, fmt.Errorf("the %s level of %s: %w", level, dir, err)
|
||||||
|
}
|
||||||
|
if !passed {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true, nil
|
||||||
|
}
|
||||||
|
todo, all, keepRunner := s.plan(ctx, job, level, f, runner, withRunner, la)
|
||||||
|
if !keepRunner {
|
||||||
|
runner = "" // an installed module that ignores the runner judges the level as it judges any other (ADR 0535 §2)
|
||||||
|
}
|
||||||
|
for _, priority := range []bool{true, false} {
|
||||||
|
args := withRunner(map[string]any{"workspace": f.Workspace, "level": level})
|
||||||
|
if job.Run != "" {
|
||||||
|
args["run"] = job.Run
|
||||||
|
}
|
||||||
|
if all {
|
||||||
|
if priority {
|
||||||
|
continue // nothing to put first: the level runs whole after
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
var run []string
|
||||||
|
for _, p := range todo {
|
||||||
|
if changesTestOf(f.Changed, p) == priority {
|
||||||
|
run = append(run, p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(run) == 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
args["packages"] = run
|
||||||
|
}
|
||||||
|
passed, err := test(args)
|
||||||
|
if err != nil {
|
||||||
|
return false, fmt.Errorf("the %s level: %w", level, err)
|
||||||
|
}
|
||||||
|
if !passed {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// release removes an ask's workspace, saying a failure: the module's sweep removes it later.
|
||||||
|
func (s AskSteps) release(workspace string) {
|
||||||
|
if workspace == "" || s.Release == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err := s.Release(workspace); err != nil && s.Logf != nil {
|
||||||
|
s.Logf("the workspace %s is left to the sweep: %v", workspace, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// plan digests the level and takes the kept verdicts: the packages left to test, or all when the level runs whole, and
|
||||||
|
// whether the runner stays. A try of some tests runs whole, digesting nothing (a partial run proves no package). Under the
|
||||||
|
// candidate's runner the digest is asked as the candidate: when the candidate answers it, every package runs and nothing
|
||||||
|
// is digested for keeping (ADR 0535 §4); when the installed module answers it (it does not take the runner), the level is
|
||||||
|
// planned as any other and the runner is dropped. The level runs whole and takes nothing when the digest names no package
|
||||||
|
// or does not cover the siblings the fetch placed (ADR 0444, L5).
|
||||||
|
func (s AskSteps) plan(ctx context.Context, job delivery.CheckJob, level string, f fetched, runner string, withRunner func(map[string]any) map[string]any, la *delivery.LevelAnswer) ([]string, bool, bool) {
|
||||||
|
if job.Run != "" {
|
||||||
|
return nil, true, true
|
||||||
|
}
|
||||||
|
out, err := s.Digest(ctx, withRunner(map[string]any{"workspace": f.Workspace, "level": level}))
|
||||||
|
if err != nil {
|
||||||
|
if s.Logf != nil {
|
||||||
|
s.Logf("no digest of the %s level, so it runs whole: %v", level, err)
|
||||||
|
}
|
||||||
|
return nil, true, true
|
||||||
|
}
|
||||||
|
r, err := raw(out)
|
||||||
|
if err != nil {
|
||||||
|
return nil, true, true
|
||||||
|
}
|
||||||
|
var d delivery.LevelDigest // packages kept as a sorted list, never keyed by a package path (issue 1930)
|
||||||
|
if err := json.Unmarshal(r, &d); err != nil {
|
||||||
|
return nil, true, true
|
||||||
|
}
|
||||||
|
if runner != "" {
|
||||||
|
if strings.HasPrefix(d.JudgedBy, "candidate ") {
|
||||||
|
la.Judged = d.JudgedBy
|
||||||
|
return nil, true, true // the candidate decides which verdicts would be taken: all run, nothing kept
|
||||||
|
}
|
||||||
|
runner = ""
|
||||||
|
}
|
||||||
|
if len(d.Packages) == 0 || !slices.Equal(d.Beside, besideOf(job.Fetch)) {
|
||||||
|
return nil, true, runner != "" // a digest that names nothing or not the siblings keys no verdict: the level runs whole
|
||||||
|
}
|
||||||
|
la.Digest = &d
|
||||||
|
var todo []string
|
||||||
|
for _, pd := range d.Packages {
|
||||||
|
p := pd.Package
|
||||||
|
if job.Kept && s.Kept != nil {
|
||||||
|
tests, found, err := s.Kept(ctx, level, pd.Digest)
|
||||||
|
if err != nil && s.Logf != nil {
|
||||||
|
s.Logf("the kept verdict of %s at %s cannot be read, so it runs: %v", p, level, err)
|
||||||
|
}
|
||||||
|
if err == nil && found {
|
||||||
|
la.Kept = append(la.Kept, delivery.KeptTaken{Package: p, Digest: pd.Digest, Tests: tests})
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
}
|
||||||
|
todo = append(todo, p)
|
||||||
|
}
|
||||||
|
return todo, false, false
|
||||||
|
}
|
||||||
|
|
||||||
|
// besideOf are the siblings a fetch's arguments place, as a digest echoes them: `<owner/repo> <commit>`, sorted.
|
||||||
|
func besideOf(fetch map[string]any) []string {
|
||||||
|
raw, err := json.Marshal(fetch["beside"])
|
||||||
|
if err != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
var refs []struct {
|
||||||
|
Repository string `json:"repository"`
|
||||||
|
Commit string `json:"commit"`
|
||||||
|
}
|
||||||
|
_ = json.Unmarshal(raw, &refs)
|
||||||
|
var out []string
|
||||||
|
for _, r := range refs {
|
||||||
|
out = append(out, r.Repository+" "+r.Commit)
|
||||||
|
}
|
||||||
|
sort.Strings(out)
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// changesUnder says whether a path the merge changes is under prefix.
|
||||||
|
func changesUnder(changed []string, prefix string) bool {
|
||||||
|
for _, p := range changed {
|
||||||
|
if strings.HasPrefix(p, prefix) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// isTestFile says whether a repository-relative path is a test file: Go's _test.go, and a TypeScript module's .test.
|
||||||
|
// and .spec. files and test directories.
|
||||||
|
func isTestFile(p string) bool {
|
||||||
|
switch {
|
||||||
|
case strings.HasSuffix(p, "_test.go"):
|
||||||
|
return true
|
||||||
|
case strings.Contains(p, ".test.") || strings.Contains(p, ".spec."):
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
for _, seg := range strings.Split(path.Dir(p), "/") {
|
||||||
|
if seg == "__tests__" || seg == "test" || seg == "tests" {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// changesTestOf says whether the merge changes a test file of the Go package with the import path pkg: the file's
|
||||||
|
// directory and the import path agree on their last segments.
|
||||||
|
func changesTestOf(changed []string, pkg string) bool {
|
||||||
|
for _, f := range changed {
|
||||||
|
if !strings.HasSuffix(f, "_test.go") {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
dir := path.Dir(f)
|
||||||
|
if dir == pkg || strings.HasSuffix(pkg, "/"+dir) || strings.HasSuffix(dir, "/"+pkg) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// changesTestIn says whether the merge changes a test file inside the directory of a Node module.
|
||||||
|
func changesTestIn(changed []string, dir string) bool {
|
||||||
|
for _, f := range changed {
|
||||||
|
if !isTestFile(f) || strings.HasSuffix(f, "_test.go") {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if dir == "." || dir == "" || strings.HasPrefix(f, strings.TrimSuffix(dir, "/")+"/") {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
@@ -0,0 +1,205 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
const runCommit = "0123456789abcdef0123456789abcdef01234567"
|
||||||
|
|
||||||
|
// recorder is a build module's step tools that record each call.
|
||||||
|
type recorder struct {
|
||||||
|
calls []string
|
||||||
|
fetch map[string]any
|
||||||
|
tests map[string]bool // package or module directory -> passed
|
||||||
|
digests map[string]string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *recorder) steps() AskSteps {
|
||||||
|
call := func(name string, answer func(args map[string]any) any) StepFunc {
|
||||||
|
return func(ctx context.Context, args map[string]any) (any, error) {
|
||||||
|
b, _ := json.Marshal(args)
|
||||||
|
r.calls = append(r.calls, name+" "+string(b))
|
||||||
|
return answer(args), nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return AskSteps{
|
||||||
|
Fetch: call("fetch", func(map[string]any) any { return r.fetch }),
|
||||||
|
Build: call("build", func(args map[string]any) any {
|
||||||
|
return map[string]any{"digest": "sha256:" + args["artifact"].(string), "reference": "artifact-store://" + args["artifact"].(string)}
|
||||||
|
}),
|
||||||
|
Copy: call("copy", func(args map[string]any) any { return map[string]any{"digest": "sha256:copied"} }),
|
||||||
|
Digest: call("digest", func(map[string]any) any { return map[string]any{"level": "unit", "packages": r.digests} }),
|
||||||
|
Test: call("test", func(args map[string]any) any {
|
||||||
|
passed := true
|
||||||
|
if pkgs, ok := args["packages"].([]string); ok {
|
||||||
|
for _, p := range pkgs {
|
||||||
|
passed = passed && r.tests[p]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if dir, ok := args["module"].(string); ok {
|
||||||
|
passed = r.tests[dir]
|
||||||
|
}
|
||||||
|
return map[string]any{"passed": passed, "tests": 1}
|
||||||
|
}),
|
||||||
|
Kept: func(ctx context.Context, level, digest string) (int, bool, error) { return 7, digest == "d-kept", nil },
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func ask(job any) delivery.StepAsk {
|
||||||
|
a := delivery.StepAsk{ID: NewID(), Kind: delivery.AskCheck, Language: delivery.AskGo, Asker: "t", At: time.Now()}
|
||||||
|
switch j := job.(type) {
|
||||||
|
case delivery.BuildJob:
|
||||||
|
a.Build = &j
|
||||||
|
case delivery.CheckJob:
|
||||||
|
a.Check = &j
|
||||||
|
}
|
||||||
|
return a
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1887/A3: a build ask fetches once, builds each artifact from the workspace with publish, copies a pinned one without a
|
||||||
|
// fetch, and answers each artifact's digest and reference.
|
||||||
|
func TestRunAskBuilds(t *testing.T) {
|
||||||
|
r := &recorder{fetch: map[string]any{"workspace": "/w/1"}}
|
||||||
|
steps := r.steps()
|
||||||
|
var released []string
|
||||||
|
steps.Release = func(ws string) error { released = append(released, ws); return nil }
|
||||||
|
out, err := RunAsk(context.Background(), steps, ask(delivery.BuildJob{Module: "m", Path: "modules/m", Publish: true,
|
||||||
|
Fetch: map[string]any{"repository": "novox/x", "commit": runCommit},
|
||||||
|
Artifacts: []delivery.AskArtifact{{Artifact: "base", From: "registry/b@sha256:00"}, {Artifact: "bundle"}, {Artifact: "lib"}}}))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
got := strings.Join(r.calls, "\n")
|
||||||
|
want := `copy {"artifact":"base","from":"registry/b@sha256:00","module":"m"}
|
||||||
|
fetch {"commit":"` + runCommit + `","repository":"novox/x"}
|
||||||
|
build {"artifact":"bundle","module":"modules/m","publish":true,"workspace":"/w/1"}
|
||||||
|
build {"artifact":"lib","module":"modules/m","publish":true,"workspace":"/w/1"}`
|
||||||
|
if got != want {
|
||||||
|
t.Fatalf("calls:\n%s\nwant:\n%s", got, want)
|
||||||
|
}
|
||||||
|
if len(released) != 1 || released[0] != "/w/1" {
|
||||||
|
t.Errorf("released %v, want the one workspace", released)
|
||||||
|
}
|
||||||
|
a := out.(delivery.BuildAnswer)
|
||||||
|
if len(a.Artifacts) != 3 || a.Artifacts[1].Reference != "artifact-store://bundle" {
|
||||||
|
t.Fatalf("answer %+v", a)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A build ask for another toolchain is refused, so its step ends refused and the asker reads why.
|
||||||
|
func TestRunAskRefusesAnotherToolchain(t *testing.T) {
|
||||||
|
r := &recorder{fetch: map[string]any{"workspace": "/w"}}
|
||||||
|
s := r.steps()
|
||||||
|
s.Toolchain = func(context.Context) (delivery.ToolchainUsed, error) {
|
||||||
|
return delivery.ToolchainUsed{Version: "go1.27", Recipe: "3"}, nil
|
||||||
|
}
|
||||||
|
_, err := RunAsk(context.Background(), s, ask(delivery.BuildJob{Module: "m", Path: ".", Fetch: map[string]any{"repository": "novox/x", "commit": runCommit},
|
||||||
|
Artifacts: []delivery.AskArtifact{{Artifact: "bundle"}}, Toolchain: &delivery.ToolchainUsed{Version: "go1.26", Recipe: "3"}}))
|
||||||
|
var ref *Refusal
|
||||||
|
if !errors.As(err, &ref) || len(r.calls) != 0 {
|
||||||
|
t.Fatalf("err %v, calls %v", err, r.calls)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1887/A3, A5a, issue 1887 design limit 1: a check ask runs the levels of one check after one fetch: it digests the unit
|
||||||
|
// level, takes the kept verdicts, tests the packages whose tests changed first, and stops at the first failure, running
|
||||||
|
// no later level.
|
||||||
|
func TestRunAskChecksTheLevelsOfOneCheck(t *testing.T) {
|
||||||
|
r := &recorder{
|
||||||
|
fetch: map[string]any{"workspace": "/w", "changed": []string{"pkg/b/b_test.go"}},
|
||||||
|
digests: map[string]string{"x/pkg/a": "d-a", "x/pkg/b": "d-b", "x/pkg/k": "d-kept"},
|
||||||
|
tests: map[string]bool{"x/pkg/a": true, "x/pkg/b": false},
|
||||||
|
}
|
||||||
|
out, err := RunAsk(context.Background(), r.steps(), ask(delivery.CheckJob{Levels: []string{delivery.LevelUnit, delivery.LevelIntegration}, Kept: true,
|
||||||
|
Runner: "workspace", RunnerWhen: "modules/mesh-build-go/", Fetch: map[string]any{"repository": "novox/x", "commit": runCommit, "base": runCommit}}))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
got := strings.Join(r.calls, "\n")
|
||||||
|
want := `fetch {"base":"` + runCommit + `","commit":"` + runCommit + `","repository":"novox/x"}
|
||||||
|
digest {"level":"unit","workspace":"/w"}
|
||||||
|
test {"level":"unit","packages":["x/pkg/b"],"workspace":"/w"}`
|
||||||
|
if got != want {
|
||||||
|
t.Fatalf("calls:\n%s\nwant:\n%s", got, want)
|
||||||
|
}
|
||||||
|
a := out.(delivery.CheckAnswer)
|
||||||
|
if len(a.Levels) != 1 {
|
||||||
|
t.Fatalf("levels %+v, want the unit level alone", a.Levels)
|
||||||
|
}
|
||||||
|
u := a.Levels[0]
|
||||||
|
if u.Level != delivery.LevelUnit || len(u.Kept) != 1 || u.Kept[0].Package != "x/pkg/k" || u.Kept[0].Tests != 7 || len(u.Tests) != 1 || u.Digest == nil {
|
||||||
|
t.Fatalf("the unit level %+v", u)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ADR 0535 §2, §4: a merge that changes the build module's own code is judged by the candidate's runner: its digest says
|
||||||
|
// the candidate ran, and every package runs with nothing kept; an installed module that ignores the runner is planned as
|
||||||
|
// any other, the runner dropped. A digest that does not cover the fetch's siblings runs the level whole too.
|
||||||
|
func TestRunAskRunsWholeUnderTheRunnerOrWithoutTheSiblings(t *testing.T) {
|
||||||
|
for _, tc := range []struct{ judged, want string }{
|
||||||
|
{"candidate 999", `digest {"level":"unit","runner":"workspace","workspace":"/w"}
|
||||||
|
test {"level":"unit","runner":"workspace","workspace":"/w"}`},
|
||||||
|
{"installed", `digest {"level":"unit","runner":"workspace","workspace":"/w"}`},
|
||||||
|
} {
|
||||||
|
r := &recorder{fetch: map[string]any{"workspace": "/w", "changed": []string{"modules/mesh-build-go/x.go"}},
|
||||||
|
digests: map[string]string{"x/pkg/a": "d-kept"}, tests: map[string]bool{}}
|
||||||
|
steps := r.steps()
|
||||||
|
digest := steps.Digest
|
||||||
|
steps.Digest = func(ctx context.Context, args map[string]any) (any, error) {
|
||||||
|
_, _ = digest(ctx, args)
|
||||||
|
return map[string]any{"level": "unit", "packages": r.digests, "judged_by": tc.judged}, nil
|
||||||
|
}
|
||||||
|
out, err := RunAsk(context.Background(), steps, ask(delivery.CheckJob{Levels: []string{delivery.LevelUnit}, Kept: true,
|
||||||
|
Runner: "workspace", RunnerWhen: "modules/mesh-build-go/", Fetch: map[string]any{"repository": "novox/x", "commit": runCommit}}))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got := strings.Join(r.calls[1:], "\n"); got != tc.want {
|
||||||
|
t.Errorf("judged by %s: calls\n%s\nwant\n%s", tc.judged, got, tc.want)
|
||||||
|
}
|
||||||
|
l := out.(delivery.CheckAnswer).Levels[0]
|
||||||
|
if tc.judged == "installed" && (len(l.Kept) != 1 || l.Judged != "") {
|
||||||
|
t.Errorf("an installed module's level %+v, want the kept verdict taken", l)
|
||||||
|
}
|
||||||
|
if tc.judged != "installed" && (len(l.Kept) != 0 || l.Digest != nil || l.Judged != tc.judged) {
|
||||||
|
t.Errorf("the candidate's level %+v, want nothing kept and the program named", l)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
r := &recorder{fetch: map[string]any{"workspace": "/w"}, digests: map[string]string{"x/pkg/a": "d-kept"}, tests: map[string]bool{}}
|
||||||
|
out, err := RunAsk(context.Background(), r.steps(), ask(delivery.CheckJob{Levels: []string{delivery.LevelUnit}, Kept: true,
|
||||||
|
Fetch: map[string]any{"repository": "novox/x", "commit": runCommit, "beside": []any{map[string]any{"repository": "novox/mesh-sdk", "commit": runCommit}}}}))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if l := out.(delivery.CheckAnswer).Levels[0]; len(l.Kept) != 0 || l.Digest != nil {
|
||||||
|
t.Fatalf("a digest without the siblings kept %+v", l)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A Node check tests each module directory, the one whose tests changed first; a conflict ends the ask with the fetch
|
||||||
|
// alone, a verdict for the asker.
|
||||||
|
func TestRunAskChecksNodeModulesAndConflicts(t *testing.T) {
|
||||||
|
r := &recorder{fetch: map[string]any{"workspace": "/w", "modules": []string{"a", "b"}, "changed": []string{"b/test/x.test.ts"}},
|
||||||
|
tests: map[string]bool{"a": true, "b": true}}
|
||||||
|
s := r.steps()
|
||||||
|
s.Digest = nil
|
||||||
|
if _, err := RunAsk(context.Background(), s, ask(delivery.CheckJob{Levels: []string{delivery.LevelUnit}, Fetch: map[string]any{"repository": "novox/x", "commit": runCommit}})); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if fmt.Sprint(r.calls[1:]) != `[test {"level":"unit","module":"b","workspace":"/w"} test {"level":"unit","module":"a","workspace":"/w"}]` {
|
||||||
|
t.Fatalf("calls %v", r.calls)
|
||||||
|
}
|
||||||
|
r = &recorder{fetch: map[string]any{"workspace": "/w", "conflicts": []string{"go.mod"}}}
|
||||||
|
out, err := RunAsk(context.Background(), r.steps(), ask(delivery.CheckJob{Levels: []string{delivery.LevelUnit}, Fetch: map[string]any{"repository": "novox/x", "commit": runCommit}}))
|
||||||
|
if err != nil || len(r.calls) != 1 || len(out.(delivery.CheckAnswer).Levels) != 0 {
|
||||||
|
t.Fatalf("a conflict: %v %v", err, r.calls)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,61 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery/buildrun"
|
||||||
|
)
|
||||||
|
|
||||||
|
// CapacitySetting is the build modules' setting of each node's build capacity (novox/hq ADR 0525 §5): `<node>=<asks at
|
||||||
|
// once>` pairs separated by commas, as the builder's was (ADR 0485 §1). Each build module declares it with
|
||||||
|
// DefaultCapacities as its default, and the controller lays it into the module's settings file.
|
||||||
|
const CapacitySetting = "capacity"
|
||||||
|
|
||||||
|
// DefaultCapacities is the setting's default, the builder's before R4g: the control-node (novox) and the laptop (g14)
|
||||||
|
// build nothing.
|
||||||
|
const DefaultCapacities = "shanks=3,ace=2,g14=0,novox=0"
|
||||||
|
|
||||||
|
// NodeCapacity is node's build capacity, read from the module's settings file at path at every call, so a change takes
|
||||||
|
// effect at the next pull; with no path it reads fallback. A node the setting does not name runs one ask at a time (as
|
||||||
|
// the builder's did). A file or a setting that cannot be read gives 0 and says why: pulling on a setting nobody can read
|
||||||
|
// could build on a node that must not.
|
||||||
|
func NodeCapacity(path, fallback, node string, logf func(string, ...any)) func() int {
|
||||||
|
say := func(format string, args ...any) {
|
||||||
|
if logf != nil {
|
||||||
|
logf(format, args...)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return func() int {
|
||||||
|
setting := fallback
|
||||||
|
if path != "" {
|
||||||
|
raw, err := os.ReadFile(path)
|
||||||
|
if err != nil {
|
||||||
|
say("the build capacity cannot be read, so %s pulls nothing: %v", node, err)
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
var s map[string]any
|
||||||
|
if err := json.Unmarshal(raw, &s); err != nil {
|
||||||
|
say("the settings file %s is not JSON, so %s pulls nothing: %v", path, node, err)
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
setting, _ = s[CapacitySetting].(string)
|
||||||
|
}
|
||||||
|
n, err := capacityOf(setting, node)
|
||||||
|
if err != nil {
|
||||||
|
say("%v, so %s pulls nothing", err, node)
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
return n
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// capacityOf is node's capacity in a setting's `<node>=<asks>` pairs: DefaultCapacity for a node it does not name.
|
||||||
|
func capacityOf(setting, node string) (int, error) {
|
||||||
|
caps, err := buildrun.ParseCapacity(setting)
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("the build capacity: %w", err)
|
||||||
|
}
|
||||||
|
return (&buildrun.Places{Capacity: caps}).CapacityOf(node), nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// 1887/A7: the node's build capacity is the build module's setting, read at every pull: the control-node at 0 pulls
|
||||||
|
// nothing, a change takes effect at the next read, and a setting that cannot be read pulls nothing.
|
||||||
|
func TestNodeCapacity(t *testing.T) {
|
||||||
|
if got := NodeCapacity("", DefaultCapacities, "novox", nil)(); got != 0 {
|
||||||
|
t.Errorf("novox = %d by default, want 0", got)
|
||||||
|
}
|
||||||
|
if got := NodeCapacity("", DefaultCapacities, "shanks", nil)(); got != 3 {
|
||||||
|
t.Errorf("shanks = %d by default, want 3", got)
|
||||||
|
}
|
||||||
|
file := filepath.Join(t.TempDir(), "settings.json")
|
||||||
|
os.WriteFile(file, []byte(`{"capacity":"shanks=1,ace=2"}`), 0o600)
|
||||||
|
capacity := NodeCapacity(file, DefaultCapacities, "shanks", nil)
|
||||||
|
if got := capacity(); got != 1 {
|
||||||
|
t.Errorf("shanks = %d from the file, want 1", got)
|
||||||
|
}
|
||||||
|
os.WriteFile(file, []byte(`{"capacity":"shanks=4"}`), 0o600)
|
||||||
|
if got := capacity(); got != 4 {
|
||||||
|
t.Errorf("shanks = %d after the change, want 4", got)
|
||||||
|
}
|
||||||
|
if got := NodeCapacity(file, "", "pi", nil)(); got != 1 {
|
||||||
|
t.Errorf("a node not named = %d, want 1", got)
|
||||||
|
}
|
||||||
|
os.WriteFile(file, []byte(`{"capacity":"shanks=lots"}`), 0o600)
|
||||||
|
if got := capacity(); got != 0 {
|
||||||
|
t.Errorf("an unreadable setting = %d, want 0", got)
|
||||||
|
}
|
||||||
|
if got := NodeCapacity(filepath.Join(t.TempDir(), "none"), DefaultCapacities, "shanks", nil)(); got != 0 {
|
||||||
|
t.Errorf("a missing file = %d, want 0", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,234 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
// credentialField is the node runtime's rule for a state value (mesh-tools node-tools/internal/bus/state.go, novox/hq
|
||||||
|
// ADR 0201), copied whole: the first field anywhere in the value whose name, lower-cased and without - _ and spaces, ends
|
||||||
|
// in a credential word, or "". A step's end is refused when it answers a field.
|
||||||
|
func credentialField(value json.RawMessage) string {
|
||||||
|
endings := []string{"password", "passwd", "secret", "token", "credential", "credentials",
|
||||||
|
"authorization", "apikey", "privatekey", "accesskey", "cookie"}
|
||||||
|
var v any
|
||||||
|
if json.Unmarshal(value, &v) != nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
var walk func(any) string
|
||||||
|
walk = func(v any) string {
|
||||||
|
switch t := v.(type) {
|
||||||
|
case map[string]any:
|
||||||
|
keys := make([]string, 0, len(t))
|
||||||
|
for k := range t {
|
||||||
|
keys = append(keys, k)
|
||||||
|
}
|
||||||
|
sort.Strings(keys)
|
||||||
|
for _, k := range keys {
|
||||||
|
norm := strings.NewReplacer("-", "", "_", "", " ", "").Replace(strings.ToLower(k))
|
||||||
|
for _, end := range endings {
|
||||||
|
if strings.HasSuffix(norm, end) {
|
||||||
|
return k
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if found := walk(t[k]); found != "" {
|
||||||
|
return found
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case []any:
|
||||||
|
for _, x := range t {
|
||||||
|
if found := walk(x); found != "" {
|
||||||
|
return found
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return walk(v)
|
||||||
|
}
|
||||||
|
|
||||||
|
// runtimeState is a steps state that refuses a value as the node runtime does, and keeps every value it took.
|
||||||
|
type runtimeState struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
took map[string][]delivery.Step
|
||||||
|
refused int
|
||||||
|
}
|
||||||
|
|
||||||
|
func newRuntimeState() *runtimeState { return &runtimeState{took: map[string][]delivery.Step{}} }
|
||||||
|
|
||||||
|
func (s *runtimeState) put(key string, value any) (uint64, error) {
|
||||||
|
raw, _ := value.(json.RawMessage)
|
||||||
|
if f := credentialField(raw); f != "" {
|
||||||
|
s.mu.Lock()
|
||||||
|
s.refused++
|
||||||
|
s.mu.Unlock()
|
||||||
|
return 0, fmt.Errorf("steps.%s carries a field %q, which names a credential", key, f)
|
||||||
|
}
|
||||||
|
st, err := delivery.DecodeStep(raw)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
s.took[key] = append(s.took[key], st)
|
||||||
|
return uint64(len(s.took[key])), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *runtimeState) last(key string) (delivery.Step, bool) {
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
t := s.took[key]
|
||||||
|
if len(t) == 0 {
|
||||||
|
return delivery.Step{}, false
|
||||||
|
}
|
||||||
|
return t[len(t)-1], true
|
||||||
|
}
|
||||||
|
|
||||||
|
func fastEnds(t *testing.T) {
|
||||||
|
attempts, retry := EndAttempts, EndRetry
|
||||||
|
EndAttempts, EndRetry = 2, time.Millisecond
|
||||||
|
t.Cleanup(func() { EndAttempts, EndRetry = attempts, retry })
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1930/AC1: given a check of a repository with the package .../internal/token, when its ask's answer is stored as the
|
||||||
|
// step's end, then no field is keyed by a package path: the runtime's credential rule takes the value, and the package
|
||||||
|
// and its digest read back from the stored end.
|
||||||
|
func TestADigestOfAPackageNamedTokenIsStoredAsAList(t *testing.T) {
|
||||||
|
fastEnds(t)
|
||||||
|
r := &recorder{
|
||||||
|
fetch: map[string]any{"workspace": "/w"},
|
||||||
|
digests: map[string]string{"x/internal/token": "d-token", "x/pkg/a": "d-a"},
|
||||||
|
tests: map[string]bool{"x/internal/token": true, "x/pkg/a": true},
|
||||||
|
}
|
||||||
|
out, err := RunAsk(context.Background(), r.steps(), ask(delivery.CheckJob{Levels: []string{delivery.LevelUnit},
|
||||||
|
Fetch: map[string]any{"repository": "novox/x", "commit": runCommit}}))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
old, _ := json.Marshal(map[string]any{"levels": []any{map[string]any{"level": "unit", "digest": map[string]any{"packages": r.digests}}}})
|
||||||
|
if credentialField(old) != "x/internal/token" {
|
||||||
|
t.Fatalf("the rule does not refuse the form before issue 1930 (%s): the test proves nothing", old)
|
||||||
|
}
|
||||||
|
st := newRuntimeState()
|
||||||
|
if err := finish(st.put, "shanks.a1", delivery.Step{ID: "a1", Tool: "check ask", Node: "shanks", State: delivery.StepRunning, Started: time.Now()}, out, nil, t.Logf); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
s, ok := st.last("shanks.a1")
|
||||||
|
if !ok || s.State != delivery.StepPassed || st.refused != 0 {
|
||||||
|
t.Fatalf("the end %+v (written %v, refused %d), want it passed and taken at once", s, ok, st.refused)
|
||||||
|
}
|
||||||
|
var a delivery.CheckAnswer
|
||||||
|
if err := json.Unmarshal(s.Result, &a); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if len(a.Levels) != 1 || a.Levels[0].Digest == nil {
|
||||||
|
t.Fatalf("levels %+v, want the unit level with its digest", a.Levels)
|
||||||
|
}
|
||||||
|
want := []delivery.PackageDigest{{Package: "x/internal/token", Digest: "d-token"}, {Package: "x/pkg/a", Digest: "d-a"}}
|
||||||
|
if got := a.Levels[0].Digest.Packages; fmt.Sprint(got) != fmt.Sprint(want) {
|
||||||
|
t.Errorf("packages %v, want %v", got, want)
|
||||||
|
}
|
||||||
|
if !strings.Contains(string(s.Result), `"package":"x/internal/token"`) {
|
||||||
|
t.Errorf("the stored end does not name the package as a value: %s", s.Result)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1930/AC2: given an end the state refuses every time, when finish writes it, then it logs the refusal and writes a small
|
||||||
|
// failed end without the result that names the write's error; and when no end can be written at all it answers an error.
|
||||||
|
func TestARefusedEndIsSaidAndEndsTheStepFailed(t *testing.T) {
|
||||||
|
fastEnds(t)
|
||||||
|
big := errors.New("the value carries a field \"x/internal/token\", which names a credential")
|
||||||
|
var refused int
|
||||||
|
var stored []delivery.Step
|
||||||
|
put := func(key string, value any) (uint64, error) {
|
||||||
|
st, _ := delivery.DecodeStep(value.(json.RawMessage))
|
||||||
|
if len(st.Result) > 0 {
|
||||||
|
refused++
|
||||||
|
return 0, big
|
||||||
|
}
|
||||||
|
stored = append(stored, st)
|
||||||
|
return 1, nil
|
||||||
|
}
|
||||||
|
var logged []string
|
||||||
|
logf := func(format string, args ...any) { logged = append(logged, fmt.Sprintf(format, args...)) }
|
||||||
|
err := finish(put, "shanks.a2", delivery.Step{ID: "a2", Tool: "check ask", Node: "shanks", State: delivery.StepRunning, Started: time.Now()}, map[string]any{"levels": 1}, nil, logf)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("finish answered %v, want the small end written", err)
|
||||||
|
}
|
||||||
|
if refused != EndAttempts || len(stored) != 1 {
|
||||||
|
t.Fatalf("refused %d, stored %d, want %d refusals and one small end", refused, len(stored), EndAttempts)
|
||||||
|
}
|
||||||
|
s := stored[0]
|
||||||
|
if s.State != delivery.StepFailed || len(s.Result) != 0 || !strings.Contains(s.Reason, "could not be written") ||
|
||||||
|
!strings.Contains(s.Reason, big.Error()) || !strings.Contains(s.Reason, "passed") {
|
||||||
|
t.Errorf("the small end %+v, want failed, no result, naming the write's error and that it passed", s)
|
||||||
|
}
|
||||||
|
if len(logged) == 0 || !strings.Contains(logged[0], big.Error()) {
|
||||||
|
t.Errorf("logged %q, want the refusal said", logged)
|
||||||
|
}
|
||||||
|
none := func(string, any) (uint64, error) { return 0, errors.New("the bus is gone") }
|
||||||
|
if err := finish(none, "shanks.a3", delivery.Step{ID: "a3", Tool: "check ask", Node: "shanks", Started: time.Now()}, nil, nil, logf); err == nil || !strings.Contains(err.Error(), "the bus is gone") {
|
||||||
|
t.Errorf("finish with no write possible answered %v, want the error", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1930/AC2: given an ask whose end the state refuses, when it runs, then the ask is acknowledged only once its small
|
||||||
|
// failed end is written; when no end can be written at all, it is given back, never acknowledged as done.
|
||||||
|
func TestAnAskWhoseEndCannotBeWrittenIsNotAcked(t *testing.T) {
|
||||||
|
fastEnds(t)
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
|
smallOK bool
|
||||||
|
wantAcked bool
|
||||||
|
}{{"the small end written", true, true}, {"no end written", false, false}} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
src := NewFakeAsks()
|
||||||
|
a := testAsk(delivery.AskCheck)
|
||||||
|
_ = src.PublishAsk(a)
|
||||||
|
var mu sync.Mutex
|
||||||
|
var ends []delivery.Step
|
||||||
|
put := func(key string, value any) (uint64, error) {
|
||||||
|
st, err := delivery.DecodeStep(value.(json.RawMessage))
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
if st.State != delivery.StepRunning && (len(st.Result) > 0 || !tc.smallOK) {
|
||||||
|
return 0, errors.New("refused")
|
||||||
|
}
|
||||||
|
mu.Lock()
|
||||||
|
ends = append(ends, st)
|
||||||
|
mu.Unlock()
|
||||||
|
return 1, nil
|
||||||
|
}
|
||||||
|
p := &Puller{Source: src, Language: delivery.AskGo, Node: "shanks", Put: put, Capacity: func() int { return 1 },
|
||||||
|
PullWait: 10 * time.Millisecond, Logf: t.Logf,
|
||||||
|
Run: func(ctx context.Context, a delivery.StepAsk) (any, error) { return map[string]any{"ran": true}, nil }}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go p.Pull(ctx)
|
||||||
|
waitFor(t, "the ask's fate", func() bool { ac, tm, nk := src.Fates(); return len(ac)+len(tm)+len(nk) > 0 })
|
||||||
|
cancel()
|
||||||
|
acked, termed, naked := src.Fates()
|
||||||
|
if tc.wantAcked && (len(acked) != 1 || len(naked) != 0) || !tc.wantAcked && (len(acked) != 0 || len(naked) == 0) || len(termed) != 0 {
|
||||||
|
t.Fatalf("acked %v naked %v termed %v", acked, naked, termed)
|
||||||
|
}
|
||||||
|
mu.Lock()
|
||||||
|
defer mu.Unlock()
|
||||||
|
if tc.smallOK {
|
||||||
|
last := ends[len(ends)-1]
|
||||||
|
if last.State != delivery.StepFailed || !strings.Contains(last.Reason, "refused") {
|
||||||
|
t.Errorf("the end %+v, want the small failed end", last)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
+88
-1
@@ -4,6 +4,8 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net/url"
|
"net/url"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
"regexp"
|
"regexp"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
@@ -13,12 +15,37 @@ import (
|
|||||||
// Option changes FetchCommit.
|
// Option changes FetchCommit.
|
||||||
type Option func(*fetchOptions)
|
type Option func(*fetchOptions)
|
||||||
|
|
||||||
type fetchOptions struct{ allowFile bool }
|
type fetchOptions struct {
|
||||||
|
allowFile bool
|
||||||
|
mirror string
|
||||||
|
}
|
||||||
|
|
||||||
// AllowFileRemote lets FetchCommit take a file:// remote. It is for a test's local repository; production
|
// AllowFileRemote lets FetchCommit take a file:// remote. It is for a test's local repository; production
|
||||||
// code does not pass it, and FetchCommit then refuses anything but ssh://.
|
// code does not pass it, and FetchCommit then refuses anything but ssh://.
|
||||||
func AllowFileRemote() Option { return func(o *fetchOptions) { o.allowFile = true } }
|
func AllowFileRemote() Option { return func(o *fetchOptions) { o.allowFile = true } }
|
||||||
|
|
||||||
|
// WithMirror makes FetchCommit (and MergeInto) borrow objects from mirror, a bare repository that UpdateMirror keeps
|
||||||
|
// in the build module's own cache (novox/hq ADR 0536 §2; issue 890): the workspace's .git/objects/info/alternates
|
||||||
|
// names the mirror's objects directory, so git transfers only the objects the mirror lacks. It is a plain file, never
|
||||||
|
// a symlink. mirror must be an absolute path of an existing directory; the workspace never writes to it.
|
||||||
|
func WithMirror(mirror string) Option { return func(o *fetchOptions) { o.mirror = mirror } }
|
||||||
|
|
||||||
|
// useMirror writes the alternates file of the repository in dir, when a mirror is set.
|
||||||
|
func useMirror(o fetchOptions, dir string) error {
|
||||||
|
if o.mirror == "" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
info := filepath.Join(dir, ".git", "objects", "info")
|
||||||
|
if err := os.MkdirAll(info, 0o755); err != nil {
|
||||||
|
return fmt.Errorf("buildstep: the mirror cannot be used: %w", err)
|
||||||
|
}
|
||||||
|
line := filepath.Join(o.mirror, "objects") + "\n"
|
||||||
|
if err := os.WriteFile(filepath.Join(info, "alternates"), []byte(line), 0o644); err != nil {
|
||||||
|
return fmt.Errorf("buildstep: the mirror cannot be used: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
var (
|
var (
|
||||||
commitOK = regexp.MustCompile(`^[0-9a-f]{40}$`)
|
commitOK = regexp.MustCompile(`^[0-9a-f]{40}$`)
|
||||||
refOK = regexp.MustCompile(`^refs/[A-Za-z0-9._/-]+$`)
|
refOK = regexp.MustCompile(`^refs/[A-Za-z0-9._/-]+$`)
|
||||||
@@ -51,6 +78,9 @@ func FetchCommit(ctx context.Context, run forgekey.Runner, dir, remote, commit,
|
|||||||
if _, err := git("init", "-q"); err != nil {
|
if _, err := git("init", "-q"); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
if err := useMirror(o, dir); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
if _, err := git("remote", "add", "origin", remote); err != nil {
|
if _, err := git("remote", "add", "origin", remote); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -78,10 +108,67 @@ func FetchCommit(ctx context.Context, run forgekey.Runner, dir, remote, commit,
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// UpdateMirror brings the bare repository mirror to commit: it makes the mirror when it is absent (git init --bare,
|
||||||
|
// origin set to remote), then fetches the commit, or the ref when only the ref holds it, with the same rules as
|
||||||
|
// FetchCommit (no prompt, no credential helper, ssh:// or an allowed file:// remote, a 40-hex commit). The mirror
|
||||||
|
// keeps every commit it was brought to, so later fetches through WithMirror transfer only what is new. Callers
|
||||||
|
// serialise updates of one mirror.
|
||||||
|
func UpdateMirror(ctx context.Context, run forgekey.Runner, mirror, remote, commit, ref string, opts ...Option) error {
|
||||||
|
var o fetchOptions
|
||||||
|
for _, opt := range opts {
|
||||||
|
opt(&o)
|
||||||
|
}
|
||||||
|
if !filepath.IsAbs(mirror) {
|
||||||
|
return fmt.Errorf("buildstep: the mirror %q is not an absolute path", mirror)
|
||||||
|
}
|
||||||
|
if err := checkFetch(o, mirror, remote, commit, ref); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
env := []string{"GIT_TERMINAL_PROMPT=0"}
|
||||||
|
git := func(args ...string) error {
|
||||||
|
r := run(ctx, env, "git", append([]string{"-c", "credential.helper="}, args...)...)
|
||||||
|
if r.Status != 0 || r.Err != "" {
|
||||||
|
return fmt.Errorf("git %s: %s", args[0], firstLine(r.Err+" "+r.Stderr))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
in := func(args ...string) error { return git(append([]string{"-C", mirror}, args...)...) }
|
||||||
|
if _, err := os.Stat(filepath.Join(mirror, "HEAD")); err != nil {
|
||||||
|
if err := git("init", "-q", "--bare", mirror); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := in("remote", "add", "origin", remote); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
} else if err := in("remote", "set-url", "origin", remote); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := in("fetch", "--no-tags", "origin", commit); err != nil {
|
||||||
|
if ref == "" {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if rerr := in("fetch", "--no-tags", "origin", ref); rerr != nil {
|
||||||
|
return fmt.Errorf("%v; then the ref %s: %w", err, ref, rerr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := in("cat-file", "-e", commit+"^{commit}"); err != nil {
|
||||||
|
return fmt.Errorf("the commit %s is not in the mirror: %w", commit, err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
func checkFetch(o fetchOptions, dir, remote, commit, ref string) error {
|
func checkFetch(o fetchOptions, dir, remote, commit, ref string) error {
|
||||||
if dir == "" {
|
if dir == "" {
|
||||||
return fmt.Errorf("buildstep: no workspace directory")
|
return fmt.Errorf("buildstep: no workspace directory")
|
||||||
}
|
}
|
||||||
|
if o.mirror != "" {
|
||||||
|
if !filepath.IsAbs(o.mirror) {
|
||||||
|
return fmt.Errorf("buildstep: the mirror %q is not an absolute path", o.mirror)
|
||||||
|
}
|
||||||
|
if fi, err := os.Stat(o.mirror); err != nil || !fi.IsDir() {
|
||||||
|
return fmt.Errorf("buildstep: the mirror %q is not an existing directory", o.mirror)
|
||||||
|
}
|
||||||
|
}
|
||||||
if !commitOK.MatchString(commit) {
|
if !commitOK.MatchString(commit) {
|
||||||
return fmt.Errorf("buildstep: %q is not a full commit (40 hex digits)", commit)
|
return fmt.Errorf("buildstep: %q is not a full commit (40 hex digits)", commit)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -44,6 +44,9 @@ func MergeInto(ctx context.Context, run forgekey.Runner, dir, remote, base, comm
|
|||||||
if err := checkFetch(o, dir, remote, commit, ""); err != nil {
|
if err := checkFetch(o, dir, remote, commit, ""); err != nil {
|
||||||
return res, err
|
return res, err
|
||||||
}
|
}
|
||||||
|
if err := useMirror(o, dir); err != nil {
|
||||||
|
return res, err
|
||||||
|
}
|
||||||
env := []string{"GIT_TERMINAL_PROMPT=0"}
|
env := []string{"GIT_TERMINAL_PROMPT=0"}
|
||||||
git := func(args ...string) (string, error) {
|
git := func(args ...string) (string, error) {
|
||||||
full := append([]string{"-c", "credential.helper=", "-C", dir}, args...)
|
full := append([]string{"-c", "credential.helper=", "-C", dir}, args...)
|
||||||
|
|||||||
@@ -0,0 +1,65 @@
|
|||||||
|
//go:build integration
|
||||||
|
|
||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/forgekey"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Issue 890 C1 (AC3): a mirror brought to two commits in turn; a fetch through it checks out each commit, the
|
||||||
|
// alternates name the mirror, and no symlink is in the workspace.
|
||||||
|
func TestMirrorServesTwoCommitsWithoutSymlinks(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
src := filepath.Join(root, "src.git")
|
||||||
|
work := filepath.Join(root, "work")
|
||||||
|
for _, d := range []string{src, work} {
|
||||||
|
if err := os.MkdirAll(d, 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
gitIn(t, src, "init", "-q", "--bare")
|
||||||
|
gitIn(t, work, "init", "-q")
|
||||||
|
var commits []string
|
||||||
|
for _, c := range []string{"one", "two"} {
|
||||||
|
if err := os.WriteFile(filepath.Join(work, "f"), []byte(c), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
gitIn(t, work, "add", "f")
|
||||||
|
gitIn(t, work, "commit", "-q", "-m", c)
|
||||||
|
commits = append(commits, gitIn(t, work, "rev-parse", "HEAD"))
|
||||||
|
gitIn(t, work, "push", "-q", src, "HEAD:refs/heads/main")
|
||||||
|
}
|
||||||
|
remote := "file://" + src
|
||||||
|
mirror := filepath.Join(root, "mirror.git")
|
||||||
|
for i, commit := range commits {
|
||||||
|
if err := UpdateMirror(context.Background(), forgekey.ExecRunner, mirror, remote, commit, "", AllowFileRemote()); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
ws := filepath.Join(root, "ws"+string(rune('0'+i)))
|
||||||
|
if err := os.MkdirAll(ws, 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := FetchCommit(context.Background(), forgekey.ExecRunner, ws, remote, commit, "", AllowFileRemote(), WithMirror(mirror)); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if head := gitIn(t, ws, "rev-parse", "HEAD"); head != commit {
|
||||||
|
t.Errorf("HEAD = %s, want %s", head, commit)
|
||||||
|
}
|
||||||
|
b, _ := os.ReadFile(filepath.Join(ws, ".git", "objects", "info", "alternates"))
|
||||||
|
if !strings.Contains(string(b), filepath.Join(mirror, "objects")) {
|
||||||
|
t.Errorf("alternates %q", b)
|
||||||
|
}
|
||||||
|
_ = filepath.Walk(ws, func(p string, fi os.FileInfo, err error) error {
|
||||||
|
if err == nil && fi.Mode()&os.ModeSymlink != 0 {
|
||||||
|
t.Errorf("symlink %s", p)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,106 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/forgekey"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Issue 890 C1 (ADR 0536 §2): a fetch through a bare mirror names the mirror in .git/objects/info/alternates, a
|
||||||
|
// plain file, and never links it.
|
||||||
|
func TestFetchCommitWithMirrorWritesAlternates(t *testing.T) {
|
||||||
|
mirror := t.TempDir()
|
||||||
|
ws := t.TempDir()
|
||||||
|
f := &fakeGit{}
|
||||||
|
// the fake's init does not create .git; make the objects directory as git init would.
|
||||||
|
if err := os.MkdirAll(filepath.Join(ws, ".git", "objects", "info"), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
err := FetchCommit(context.Background(), f.run, ws, "ssh://mesh-forge/novox/mesh-sdk.git", sha, "", WithMirror(mirror))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
p := filepath.Join(ws, ".git", "objects", "info", "alternates")
|
||||||
|
b, err := os.ReadFile(p)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got, want := strings.TrimSpace(string(b)), filepath.Join(mirror, "objects"); got != want {
|
||||||
|
t.Errorf("alternates %q, want %q", got, want)
|
||||||
|
}
|
||||||
|
if fi, err := os.Lstat(p); err != nil || !fi.Mode().IsRegular() {
|
||||||
|
t.Errorf("alternates is not a plain file: %v %v", fi, err)
|
||||||
|
}
|
||||||
|
// the alternates exist before the fetch runs
|
||||||
|
if len(f.calls) < 3 || !strings.Contains(f.calls[2], "fetch") {
|
||||||
|
t.Errorf("calls %v", f.calls)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWithMirrorRefusesARelativeOrMissingMirror(t *testing.T) {
|
||||||
|
for _, m := range []string{"rel/mirror", filepath.Join(t.TempDir(), "absent")} {
|
||||||
|
f := &fakeGit{}
|
||||||
|
err := FetchCommit(context.Background(), f.run, t.TempDir(), "ssh://mesh-forge/novox/x.git", sha, "", WithMirror(m))
|
||||||
|
if err == nil || len(f.calls) != 0 {
|
||||||
|
t.Errorf("mirror %q: err %v, calls %v", m, err, f.calls)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUpdateMirrorInitsBareThenFetches(t *testing.T) {
|
||||||
|
mirror := filepath.Join(t.TempDir(), "mirror.git")
|
||||||
|
f := &fakeGit{}
|
||||||
|
if err := UpdateMirror(context.Background(), f.run, mirror, "ssh://mesh-forge/novox/x.git", sha, ""); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
pm := "git -c credential.helper= -C " + mirror + " "
|
||||||
|
want := []string{
|
||||||
|
"git -c credential.helper= init -q --bare " + mirror,
|
||||||
|
pm + "remote add origin ssh://mesh-forge/novox/x.git",
|
||||||
|
pm + "fetch --no-tags origin " + sha,
|
||||||
|
pm + "cat-file -e " + sha + "^{commit}",
|
||||||
|
}
|
||||||
|
if strings.Join(f.calls, "\n") != strings.Join(want, "\n") {
|
||||||
|
t.Errorf("commands:\n%s\nwant:\n%s", strings.Join(f.calls, "\n"), strings.Join(want, "\n"))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUpdateMirrorKeepsAnExistingMirrorAndFallsBackToTheRef(t *testing.T) {
|
||||||
|
mirror := t.TempDir() // exists: no init
|
||||||
|
if err := os.WriteFile(filepath.Join(mirror, "HEAD"), []byte("ref: refs/heads/main\n"), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
f := &fakeGit{}
|
||||||
|
f.rule = func(args string) (r forgekey.Ran) {
|
||||||
|
if strings.HasSuffix(args, "origin "+sha) {
|
||||||
|
r.Status = 1
|
||||||
|
r.Stderr = "not our ref"
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if err := UpdateMirror(context.Background(), f.run, mirror, "ssh://mesh-forge/novox/x.git", sha, "refs/pull/3/head"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
all := strings.Join(f.calls, "\n")
|
||||||
|
if strings.Contains(all, "init") || strings.Contains(all, "remote add") || !strings.Contains(all, "fetch --no-tags origin refs/pull/3/head") {
|
||||||
|
t.Errorf("commands:\n%s", all)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUpdateMirrorRefusesBeforeRunning(t *testing.T) {
|
||||||
|
f := &fakeGit{}
|
||||||
|
for _, c := range []struct{ remote, commit string }{
|
||||||
|
{"https://x/y.git", sha}, {"ssh://u@h/o/r.git", sha}, {"ssh://h/o/r.git", "abc"},
|
||||||
|
} {
|
||||||
|
if err := UpdateMirror(context.Background(), f.run, t.TempDir(), c.remote, c.commit, ""); err == nil {
|
||||||
|
t.Errorf("%v accepted", c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(f.calls) != 0 {
|
||||||
|
t.Errorf("ran %v", f.calls)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,445 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"sort"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
stdio "git.novox.be/novox/mesh-sdk/go"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
// **The pull loop the build modules share** (novox/hq ADR 0525 §4-§6, ADR 0536 §4; issue 1887). A build module on a node
|
||||||
|
// whose build capacity is above zero pulls the asks of its language's seat: from the delivery worker first, then check,
|
||||||
|
// then recheck, holding at most its capacity at once. Each ask runs as a step under the ask's own id, so its end is the
|
||||||
|
// key <node>.<ask id> in the module's steps state, which the asker watches; the ask is acknowledged when that end is
|
||||||
|
// written, kept alive while it runs by an in-progress signal, and redelivered by the stream to another node if this one
|
||||||
|
// stops. No part keeps a timer for an ask: the pull's own wait and the stream's acknowledgement wait are the bus's.
|
||||||
|
|
||||||
|
// Pulled is one ask a source handed over, with what decides its fate on the bus.
|
||||||
|
type Pulled struct {
|
||||||
|
// Kind is the worker it came from, filled by the puller.
|
||||||
|
Kind string
|
||||||
|
Data []byte
|
||||||
|
// Delivered is how many times the bus has handed it over, this time included.
|
||||||
|
Delivered uint64
|
||||||
|
// Ack ends it: it is never delivered again. InProgress tells the bus it is still being worked, restarting its
|
||||||
|
// acknowledgement wait. Nak hands it back to be delivered again at once (to this node or another). Term drops it.
|
||||||
|
Ack, InProgress, Nak, Term func() error
|
||||||
|
}
|
||||||
|
|
||||||
|
// AskSource is where a puller takes asks from: the seat's workers on the bus (JetStreamAsks) or a test double
|
||||||
|
// (FakeAsks).
|
||||||
|
type AskSource interface {
|
||||||
|
// Next takes one ask of kind: with wait 0 only one already waiting, else waiting for one at most wait. It answers
|
||||||
|
// nil and no error when none came.
|
||||||
|
Next(ctx context.Context, kind string, wait time.Duration) (*Pulled, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Defaults of a Puller.
|
||||||
|
var (
|
||||||
|
// DefaultPullWait is how long one pull of the delivery worker waits for an ask while every worker is empty: the
|
||||||
|
// pull's own wait (as process.Consume's), after which the check and recheck workers are looked at again.
|
||||||
|
DefaultPullWait = 5 * time.Second
|
||||||
|
// DefaultHeartbeat is how often a running ask tells the bus it is still being worked; under the seat worker's
|
||||||
|
// acknowledgement wait of 60 s (mesh-controller internal/broker HolderConsumerFor).
|
||||||
|
DefaultHeartbeat = 20 * time.Second
|
||||||
|
)
|
||||||
|
|
||||||
|
// Puller pulls a build seat's asks and runs them.
|
||||||
|
type Puller struct {
|
||||||
|
Source AskSource
|
||||||
|
Language string // the seat's language: delivery.AskGo, AskNode or AskImage
|
||||||
|
Node string // the node this holder runs on, the first part of its step keys
|
||||||
|
Put Put // writes the module's steps state
|
||||||
|
// Capacity is how many asks the node runs at once; read before every pull, so a change takes effect at the next
|
||||||
|
// one. 0 pulls nothing.
|
||||||
|
Capacity func() int
|
||||||
|
// Run runs one ask's job; a *Refusal ends its step refused. Its result is the step's result.
|
||||||
|
Run func(ctx context.Context, ask delivery.StepAsk) (any, error)
|
||||||
|
// PullWait and Heartbeat default to DefaultPullWait and DefaultHeartbeat.
|
||||||
|
PullWait time.Duration
|
||||||
|
Heartbeat time.Duration
|
||||||
|
Logf func(format string, args ...any)
|
||||||
|
// Load reads one key of the state the node's pause is kept in (nil and no error when it is absent). When set, Pull
|
||||||
|
// reads the node's pause key (delivery.PauseKey) before it pulls, and Pause and Resume write it with PausePut, so a
|
||||||
|
// pause outlives a restart.
|
||||||
|
Load func(key string) ([]byte, error)
|
||||||
|
// PausePut writes the node's pause key: the module's pauses state (delivery.PausesState), which has no age, so a
|
||||||
|
// pause never ends by itself while the steps state drops its old keys. Put when nil.
|
||||||
|
PausePut Put
|
||||||
|
// WatchConfig, when set, follows the module's config value `capacity` (CapacitySetting) as mesh-config resolves it
|
||||||
|
// for this node, and wakes the puller on each change (watchCapacity): WatchConfigServed in a module, a test's own
|
||||||
|
// double. Until it hands a value the puller judges by Capacity.
|
||||||
|
WatchConfig func(key string, handle func(stdio.ProvisionChange) error) error
|
||||||
|
|
||||||
|
mu sync.Mutex
|
||||||
|
inHand int
|
||||||
|
running map[string]RunningAsk
|
||||||
|
paused bool
|
||||||
|
wake chan struct{}
|
||||||
|
once sync.Once
|
||||||
|
// watched is the capacity the config watch handed last, used in place of Capacity once hasWatched.
|
||||||
|
watched int
|
||||||
|
hasWatched bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Puller) init() {
|
||||||
|
p.once.Do(func() { p.wake = make(chan struct{}, 1) })
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Puller) logf(format string, args ...any) {
|
||||||
|
if p.Logf != nil {
|
||||||
|
p.Logf(format, args...)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wake makes a waiting puller look again: after a capacity change, a resume, or a step's end.
|
||||||
|
func (p *Puller) Wake() {
|
||||||
|
p.init()
|
||||||
|
select {
|
||||||
|
case p.wake <- struct{}{}:
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Pause stops the puller taking asks; the asks it holds run to their end. by names who paused it. With Load set the
|
||||||
|
// pause is written on the node's pause key first, and an error there leaves the puller as it was.
|
||||||
|
func (p *Puller) Pause(by string) error { return p.setPaused(true, by) }
|
||||||
|
|
||||||
|
// Resume lets the puller take asks again, written as Pause's is.
|
||||||
|
func (p *Puller) Resume(by string) error { return p.setPaused(false, by) }
|
||||||
|
|
||||||
|
func (p *Puller) setPaused(paused bool, by string) error {
|
||||||
|
if p.Load != nil {
|
||||||
|
key, err := delivery.PauseKey(p.Node)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
raw, err := delivery.EncodePause(delivery.Pause{Paused: paused, By: by, At: now()})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
put := p.PausePut
|
||||||
|
if put == nil {
|
||||||
|
put = p.Put
|
||||||
|
}
|
||||||
|
if _, err := put(key, json.RawMessage(raw)); err != nil {
|
||||||
|
return fmt.Errorf("buildstep: writing the pause of %s: %w", p.Node, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
p.mu.Lock()
|
||||||
|
p.paused = paused
|
||||||
|
p.mu.Unlock()
|
||||||
|
p.Wake()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// restore reads the node's pause key, when Load is set.
|
||||||
|
func (p *Puller) restore() error {
|
||||||
|
if p.Load == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
key, err := delivery.PauseKey(p.Node)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
raw, err := p.Load(key)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("buildstep: reading the pause of %s: %w", p.Node, err)
|
||||||
|
}
|
||||||
|
if raw == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
v, err := delivery.DecodePause(raw)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("buildstep: the pause of %s: %w", p.Node, err)
|
||||||
|
}
|
||||||
|
p.mu.Lock()
|
||||||
|
p.paused = v.Paused
|
||||||
|
p.mu.Unlock()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Paused says whether the puller takes no asks.
|
||||||
|
func (p *Puller) Paused() bool {
|
||||||
|
p.mu.Lock()
|
||||||
|
defer p.mu.Unlock()
|
||||||
|
return p.paused
|
||||||
|
}
|
||||||
|
|
||||||
|
// InHand is how many asks run now.
|
||||||
|
func (p *Puller) InHand() int {
|
||||||
|
p.mu.Lock()
|
||||||
|
defer p.mu.Unlock()
|
||||||
|
return p.inHand
|
||||||
|
}
|
||||||
|
|
||||||
|
// RunningAsk is an ask a puller runs now, as its seat's current verb says it.
|
||||||
|
type RunningAsk struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Kind string `json:"kind"`
|
||||||
|
Module string `json:"module,omitempty"`
|
||||||
|
Started time.Time `json:"started"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Running are the asks the puller runs now, oldest first.
|
||||||
|
func (p *Puller) Running() []RunningAsk {
|
||||||
|
p.mu.Lock()
|
||||||
|
defer p.mu.Unlock()
|
||||||
|
out := make([]RunningAsk, 0, len(p.running))
|
||||||
|
for _, r := range p.running {
|
||||||
|
out = append(out, r)
|
||||||
|
}
|
||||||
|
sort.Slice(out, func(i, j int) bool { return out[i].Started.Before(out[j].Started) })
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// room says whether the puller may take one more ask now.
|
||||||
|
func (p *Puller) room() bool {
|
||||||
|
ok, _, _ := p.roomNow()
|
||||||
|
return ok
|
||||||
|
}
|
||||||
|
|
||||||
|
// roomNow is room, with the capacity and the asks in hand it was judged on.
|
||||||
|
func (p *Puller) roomNow() (ok bool, capacity, inHand int) {
|
||||||
|
p.mu.Lock()
|
||||||
|
watched, has := p.watched, p.hasWatched
|
||||||
|
p.mu.Unlock()
|
||||||
|
if has {
|
||||||
|
capacity = watched
|
||||||
|
} else if p.Capacity != nil {
|
||||||
|
capacity = p.Capacity()
|
||||||
|
}
|
||||||
|
p.mu.Lock()
|
||||||
|
defer p.mu.Unlock()
|
||||||
|
return !p.paused && p.inHand < capacity, capacity, p.inHand
|
||||||
|
}
|
||||||
|
|
||||||
|
// CapacityNow is the capacity the puller judges by: the config watch's last value, else Capacity.
|
||||||
|
func (p *Puller) CapacityNow() int {
|
||||||
|
_, capacity, _ := p.roomNow()
|
||||||
|
return capacity
|
||||||
|
}
|
||||||
|
|
||||||
|
// Pull takes and runs asks until ctx ends. An ask still running then is neither ended nor acknowledged: the stream
|
||||||
|
// delivers it again, to another node or to this one restarted.
|
||||||
|
func (p *Puller) Pull(ctx context.Context) error {
|
||||||
|
p.init()
|
||||||
|
if p.Source == nil || p.Put == nil || p.Run == nil {
|
||||||
|
return errors.New("buildstep: a puller needs its source, its steps' put and its run")
|
||||||
|
}
|
||||||
|
if err := p.restore(); err != nil {
|
||||||
|
// An unreadable pause degrades to not paused, said once: a puller that stops silently is the worse failure, and a
|
||||||
|
// node kept from building is held by its capacity (0), not by a pause.
|
||||||
|
p.logf("the pause of %s cannot be read: %v; pulling as not paused", p.Node, err)
|
||||||
|
}
|
||||||
|
go p.watchCapacity() // WatchConfigServed waits for Serve, which a module starts after its pull
|
||||||
|
wait := p.PullWait
|
||||||
|
if wait <= 0 {
|
||||||
|
wait = DefaultPullWait
|
||||||
|
}
|
||||||
|
for {
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if ok, capacity, inHand := p.roomNow(); !ok {
|
||||||
|
// Parked until something wakes it: a capacity change (the config watch), a resume, or a step's end. Every
|
||||||
|
// park logs once, so a puller that sits idle says why (issue 1887).
|
||||||
|
p.logf("the %s puller on %s parks: %d of capacity %d in hand, paused %v", p.Language, p.Node, inHand, capacity, p.Paused())
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return ctx.Err()
|
||||||
|
case <-p.wake:
|
||||||
|
}
|
||||||
|
_, capacity, inHand = p.roomNow()
|
||||||
|
p.logf("the %s puller on %s wakes: %d of capacity %d in hand, paused %v", p.Language, p.Node, inHand, capacity, p.Paused())
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
msg, err := p.next(ctx, wait)
|
||||||
|
if err != nil {
|
||||||
|
if ctx.Err() != nil {
|
||||||
|
return ctx.Err()
|
||||||
|
}
|
||||||
|
p.logf("the %s asks cannot be pulled: %v", p.Language, err)
|
||||||
|
select { // the pull's own wait before the next try, as an empty pull's
|
||||||
|
case <-ctx.Done():
|
||||||
|
return ctx.Err()
|
||||||
|
case <-p.wake:
|
||||||
|
case <-time.After(wait):
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if msg == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
p.take(ctx, msg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// next is one ask from the workers in their order: one already waiting on delivery, check or recheck, and when none
|
||||||
|
// waits, a pull of the delivery worker that waits for one.
|
||||||
|
func (p *Puller) next(ctx context.Context, wait time.Duration) (*Pulled, error) {
|
||||||
|
for _, kind := range delivery.AskKinds {
|
||||||
|
msg, err := p.Source.Next(ctx, kind, 0)
|
||||||
|
if err != nil || msg != nil {
|
||||||
|
return withKind(msg, kind), err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
msg, err := p.Source.Next(ctx, delivery.AskDelivery, wait)
|
||||||
|
return withKind(msg, delivery.AskDelivery), err
|
||||||
|
}
|
||||||
|
|
||||||
|
func withKind(msg *Pulled, kind string) *Pulled {
|
||||||
|
if msg != nil {
|
||||||
|
msg.Kind = kind
|
||||||
|
}
|
||||||
|
return msg
|
||||||
|
}
|
||||||
|
|
||||||
|
// take starts one ask: it decodes it, refuses one that is not of this seat, and runs it as a step under its own id.
|
||||||
|
func (p *Puller) take(ctx context.Context, msg *Pulled) {
|
||||||
|
kind := msg.Kind
|
||||||
|
ask, err := delivery.DecodeStepAsk(msg.Data)
|
||||||
|
if err == nil && (ask.Language != p.Language || (kind != "" && ask.Kind != kind)) {
|
||||||
|
err = fmt.Errorf("the ask %s is a %s ask of %s, pulled from the %s %s worker", ask.ID, ask.Kind, ask.Language, p.Language, kind)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
// An ask that is not one runs nowhere: delivering it again would only fail again.
|
||||||
|
p.logf("an ask dropped: %v", err)
|
||||||
|
_ = msg.Term()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
step, key, err := begin(p.Put, p.Node, ask.Kind+" ask", ask.ID)
|
||||||
|
if err != nil {
|
||||||
|
p.logf("the ask %s cannot start on %s: %v", ask.ID, p.Node, err)
|
||||||
|
_ = msg.Nak()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if msg.Delivered > delivery.AskRuns {
|
||||||
|
// Run AskRuns times and never ended: each run took its node down or died with it. It is run no more, and said
|
||||||
|
// (issue 1907): the asker's key fails with why.
|
||||||
|
why := fmt.Errorf("the ask was taken %d times and no run of it ended: each took its build node down or died with it, so it is run no more (poison)", msg.Delivered-1)
|
||||||
|
p.logf("the ask %s is ended on %s: %v", ask.ID, p.Node, why)
|
||||||
|
_ = finish(p.Put, key, step, nil, why, p.Logf) // run no more either way: the asker's bound says it then
|
||||||
|
_ = msg.Term()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
module := ""
|
||||||
|
if ask.Build != nil {
|
||||||
|
module = ask.Build.Module
|
||||||
|
}
|
||||||
|
p.mu.Lock()
|
||||||
|
p.inHand++
|
||||||
|
if p.running == nil {
|
||||||
|
p.running = map[string]RunningAsk{}
|
||||||
|
}
|
||||||
|
p.running[ask.ID] = RunningAsk{ID: ask.ID, Kind: ask.Kind, Module: module, Started: step.Started}
|
||||||
|
p.mu.Unlock()
|
||||||
|
go p.run(ctx, msg, ask, key, step)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Puller) run(ctx context.Context, msg *Pulled, ask delivery.StepAsk, key string, step delivery.Step) {
|
||||||
|
defer func() {
|
||||||
|
p.mu.Lock()
|
||||||
|
p.inHand--
|
||||||
|
delete(p.running, ask.ID)
|
||||||
|
p.mu.Unlock()
|
||||||
|
p.Wake()
|
||||||
|
}()
|
||||||
|
beat := p.Heartbeat
|
||||||
|
if beat <= 0 {
|
||||||
|
beat = DefaultHeartbeat
|
||||||
|
}
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
t := time.NewTicker(beat)
|
||||||
|
defer t.Stop()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
return
|
||||||
|
case <-t.C:
|
||||||
|
if msg.InProgress != nil {
|
||||||
|
_ = msg.InProgress()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
result, err := protect(ctx, func(ctx context.Context) (any, error) { return p.Run(ctx, ask) })
|
||||||
|
close(done)
|
||||||
|
if ctx.Err() != nil {
|
||||||
|
// The process stops: the ask is neither ended nor acknowledged here, so the stream gives it to a node that runs.
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if ferr := finish(p.Put, key, step, result, err, p.Logf); ferr != nil {
|
||||||
|
// No end was written: the ask is not acknowledged as done, so the stream gives it again and a run that can
|
||||||
|
// write its end (or the poison rule, issue 1907) ends it where its asker sees it (issue 1930).
|
||||||
|
p.logf("the ask %s ran on %s and no end of it could be written, so it is given back: %v", ask.ID, p.Node, ferr)
|
||||||
|
_ = msg.Nak()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if aerr := msg.Ack(); aerr != nil {
|
||||||
|
p.logf("the ask %s ended on %s and its acknowledgement failed: %v", ask.ID, p.Node, aerr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// watchCapacity follows the module's config value `capacity` when WatchConfig is set (issue 1887, 2026-10-25: g14's
|
||||||
|
// puller started at capacity 0 sat parked with capacity 2 set, because nothing woke it to read its settings file
|
||||||
|
// again). The value comes as mesh-config resolved it for this node, the event of the change itself: the runtime hands
|
||||||
|
// the value now and then each change its machine's provisioner client says moved, so nothing polls, and the puller does
|
||||||
|
// not wait for the node-engine to fill its settings file again. Each value handed is kept, used in place of Capacity,
|
||||||
|
// and wakes the puller. A watch that cannot start leaves the puller on Capacity, said once.
|
||||||
|
func (p *Puller) watchCapacity() {
|
||||||
|
if p.WatchConfig == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
err := p.WatchConfig(CapacitySetting, func(c stdio.ProvisionChange) error {
|
||||||
|
n, why := p.capacityFrom(c)
|
||||||
|
p.mu.Lock()
|
||||||
|
before, had := p.watched, p.hasWatched
|
||||||
|
p.watched, p.hasWatched = n, true
|
||||||
|
p.mu.Unlock()
|
||||||
|
switch {
|
||||||
|
case why != "":
|
||||||
|
p.logf("the %s puller on %s pulls nothing: %s", p.Language, p.Node, why)
|
||||||
|
case !had || before != n:
|
||||||
|
p.logf("the %s build capacity of %s is %d, as mesh-config resolved it", p.Language, p.Node, n)
|
||||||
|
}
|
||||||
|
p.Wake()
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
p.logf("the %s build capacity of %s cannot be followed on the bus, so it is read from the settings file when the "+
|
||||||
|
"puller wakes: %v", p.Language, p.Node, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WatchConfigServed is stdio.WatchConfig once Serve has the runtime's channel (stdio.Served): a build module starts its
|
||||||
|
// pull before it serves, and a watch asked before that would be refused.
|
||||||
|
func WatchConfigServed(key string, handle func(stdio.ProvisionChange) error) error {
|
||||||
|
<-stdio.Served()
|
||||||
|
return stdio.WatchConfig(key, handle)
|
||||||
|
}
|
||||||
|
|
||||||
|
// capacityFrom is the node's capacity in one value the watch handed, and why it is 0 when it cannot be read.
|
||||||
|
func (p *Puller) capacityFrom(c stdio.ProvisionChange) (int, string) {
|
||||||
|
if c.Refused != "" {
|
||||||
|
return 0, "its capacity is no longer answered: " + c.Refused
|
||||||
|
}
|
||||||
|
setting := ""
|
||||||
|
if len(c.Value) > 0 && string(c.Value) != "null" {
|
||||||
|
if err := json.Unmarshal(c.Value, &setting); err != nil {
|
||||||
|
return 0, fmt.Sprintf("its capacity %s is not a string", c.Value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
n, err := capacityOf(setting, p.Node)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err.Error()
|
||||||
|
}
|
||||||
|
return n, ""
|
||||||
|
}
|
||||||
@@ -0,0 +1,102 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/nats-io/nats.go/jetstream"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
// JetStreamAsks is a build seat's workers on the bus: the shared pull consumer of each kind on the seat's stream
|
||||||
|
// (delivery.AskStream, AskWorker), which the broker makes when the seat is declared; a holder only binds them.
|
||||||
|
type JetStreamAsks struct {
|
||||||
|
JS jetstream.JetStream
|
||||||
|
Language string
|
||||||
|
|
||||||
|
mu sync.Mutex
|
||||||
|
cons map[string]jetstream.Consumer
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *JetStreamAsks) consumer(ctx context.Context, kind string) (jetstream.Consumer, error) {
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
if c, ok := s.cons[kind]; ok {
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
stream, err := delivery.AskStream(s.Language)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
worker, err := delivery.AskWorker(s.Language, kind)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
c, err := s.JS.Consumer(ctx, stream, worker)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("binding the %s worker %s on %s: %w", kind, worker, stream, err)
|
||||||
|
}
|
||||||
|
if s.cons == nil {
|
||||||
|
s.cons = map[string]jetstream.Consumer{}
|
||||||
|
}
|
||||||
|
s.cons[kind] = c
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Next is AskSource's: a fetch of one with no wait when wait is 0, else one that waits at most wait.
|
||||||
|
func (s *JetStreamAsks) Next(ctx context.Context, kind string, wait time.Duration) (*Pulled, error) {
|
||||||
|
c, err := s.consumer(ctx, kind)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
var batch jetstream.MessageBatch
|
||||||
|
if wait <= 0 {
|
||||||
|
batch, err = c.FetchNoWait(1)
|
||||||
|
} else {
|
||||||
|
batch, err = c.Fetch(1, jetstream.FetchMaxWait(wait))
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case msg, ok := <-batch.Messages():
|
||||||
|
if !ok {
|
||||||
|
return nil, batch.Error()
|
||||||
|
}
|
||||||
|
var delivered uint64 = 1
|
||||||
|
if meta, err := msg.Metadata(); err == nil && meta != nil {
|
||||||
|
delivered = meta.NumDelivered
|
||||||
|
}
|
||||||
|
return &Pulled{Data: append([]byte(nil), msg.Data()...), Delivered: delivered,
|
||||||
|
Ack: msg.Ack, InProgress: msg.InProgress, Nak: msg.Nak, Term: msg.Term}, nil
|
||||||
|
case <-ctx.Done():
|
||||||
|
return nil, ctx.Err()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeclareAskWorkers makes language's seat stream and its three workers on a bus with no broker: a test's (the build
|
||||||
|
// modules' integration tests start one). On the mesh the broker declares them from the seat, as it declares every
|
||||||
|
// seat's stream (mesh-controller internal/broker SeatStreams); a holder never does.
|
||||||
|
func DeclareAskWorkers(ctx context.Context, js jetstream.JetStream, language string, ackWait time.Duration) error {
|
||||||
|
stream, err := delivery.AskStream(language)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
seat, _ := delivery.BuildSeat(language)
|
||||||
|
if _, err := js.CreateOrUpdateStream(ctx, jetstream.StreamConfig{Name: stream, Subjects: []string{"mesh.seat." + seat + ".accept.>"},
|
||||||
|
Retention: jetstream.WorkQueuePolicy}); err != nil {
|
||||||
|
return fmt.Errorf("the stream %s: %w", stream, err)
|
||||||
|
}
|
||||||
|
for _, kind := range delivery.AskKinds {
|
||||||
|
worker, _ := delivery.AskWorker(language, kind)
|
||||||
|
subject, _ := delivery.AskSubject(language, kind)
|
||||||
|
if _, err := js.CreateOrUpdateConsumer(ctx, stream, jetstream.ConsumerConfig{Durable: worker, FilterSubject: subject,
|
||||||
|
AckPolicy: jetstream.AckExplicitPolicy, AckWait: ackWait, MaxDeliver: 5}); err != nil {
|
||||||
|
return fmt.Errorf("the worker %s: %w", worker, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
stdio "git.novox.be/novox/mesh-sdk/go"
|
||||||
|
)
|
||||||
|
|
||||||
|
// configWatch is a double of stdio.WatchConfig: it hands the value now at the start, as the runtime does, and a test
|
||||||
|
// hands each change after with set.
|
||||||
|
type configWatch struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
value string
|
||||||
|
handle func(stdio.ProvisionChange) error
|
||||||
|
asked string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *configWatch) watch(key string, handle func(stdio.ProvisionChange) error) error {
|
||||||
|
w.mu.Lock()
|
||||||
|
w.asked, w.handle = key, handle
|
||||||
|
value := w.value
|
||||||
|
w.mu.Unlock()
|
||||||
|
return handle(stdio.ProvisionChange{Kind: "config", Key: key, Value: json.RawMessage(`"` + value + `"`)})
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *configWatch) set(t *testing.T, value string) {
|
||||||
|
t.Helper()
|
||||||
|
w.mu.Lock()
|
||||||
|
handle, key := w.handle, w.asked
|
||||||
|
w.mu.Unlock()
|
||||||
|
if handle == nil {
|
||||||
|
t.Fatal("the puller watches no config value")
|
||||||
|
}
|
||||||
|
if err := handle(stdio.ProvisionChange{Kind: "config", Key: key, Value: json.RawMessage(`"` + value + `"`)}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,113 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
// FakeAsks is a test double of a seat's workers for the build modules' unit tests: Publish puts an ask on a kind's
|
||||||
|
// worker, Next hands them out in their order, and the fates the puller gives them are counted. Safe for concurrent use.
|
||||||
|
type FakeAsks struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
waiting map[string][][]byte
|
||||||
|
added chan struct{}
|
||||||
|
// Acked, Termed and Naked are the asks' ids or data by fate, InProgress how many heartbeats were given.
|
||||||
|
Acked, Termed, Naked []string
|
||||||
|
InProgress int
|
||||||
|
// Delivered, when set, is the delivery count every ask handed over says (1 when 0): a test of a poisoned ask sets it.
|
||||||
|
Delivered uint64
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewFakeAsks is an empty double.
|
||||||
|
func NewFakeAsks() *FakeAsks {
|
||||||
|
return &FakeAsks{waiting: map[string][][]byte{}, added: make(chan struct{}, 1)}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Publish puts an encoded ask on kind's worker.
|
||||||
|
func (f *FakeAsks) Publish(kind string, data []byte) {
|
||||||
|
f.mu.Lock()
|
||||||
|
f.waiting[kind] = append(f.waiting[kind], data)
|
||||||
|
f.mu.Unlock()
|
||||||
|
select {
|
||||||
|
case f.added <- struct{}{}:
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// PublishAsk encodes a and puts it on its kind's worker.
|
||||||
|
func (f *FakeAsks) PublishAsk(a delivery.StepAsk) error {
|
||||||
|
raw, err := delivery.EncodeStepAsk(a)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
f.Publish(a.Kind, raw)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Waiting is how many asks wait on kind's worker.
|
||||||
|
func (f *FakeAsks) Waiting(kind string) int {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
return len(f.waiting[kind])
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fates is a copy of the acked, termed and naked lists.
|
||||||
|
func (f *FakeAsks) Fates() (acked, termed, naked []string) {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
return append([]string(nil), f.Acked...), append([]string(nil), f.Termed...), append([]string(nil), f.Naked...)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Next is AskSource's.
|
||||||
|
func (f *FakeAsks) Next(ctx context.Context, kind string, wait time.Duration) (*Pulled, error) {
|
||||||
|
var deadline <-chan time.Time
|
||||||
|
if wait > 0 {
|
||||||
|
t := time.NewTimer(wait)
|
||||||
|
defer t.Stop()
|
||||||
|
deadline = t.C
|
||||||
|
}
|
||||||
|
for {
|
||||||
|
f.mu.Lock()
|
||||||
|
if q := f.waiting[kind]; len(q) > 0 {
|
||||||
|
data := q[0]
|
||||||
|
f.waiting[kind] = q[1:]
|
||||||
|
f.mu.Unlock()
|
||||||
|
return f.pulled(data), nil
|
||||||
|
}
|
||||||
|
f.mu.Unlock()
|
||||||
|
if wait <= 0 {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return nil, ctx.Err()
|
||||||
|
case <-deadline:
|
||||||
|
return nil, nil
|
||||||
|
case <-f.added:
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *FakeAsks) pulled(data []byte) *Pulled {
|
||||||
|
id := string(data)
|
||||||
|
if a, err := delivery.DecodeStepAsk(data); err == nil {
|
||||||
|
id = a.ID
|
||||||
|
}
|
||||||
|
fate := func(list *[]string) func() error {
|
||||||
|
return func() error {
|
||||||
|
f.mu.Lock()
|
||||||
|
*list = append(*list, id)
|
||||||
|
f.mu.Unlock()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
delivered := f.Delivered
|
||||||
|
if delivered == 0 {
|
||||||
|
delivered = 1
|
||||||
|
}
|
||||||
|
return &Pulled{Data: data, Delivered: delivered, Ack: fate(&f.Acked), Nak: fate(&f.Naked), Term: fate(&f.Termed),
|
||||||
|
InProgress: func() error { f.mu.Lock(); f.InProgress++; f.mu.Unlock(); return nil }}
|
||||||
|
}
|
||||||
@@ -0,0 +1,144 @@
|
|||||||
|
//go:build integration
|
||||||
|
|
||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/nats-io/nats.go"
|
||||||
|
"github.com/nats-io/nats.go/jetstream"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/testbus"
|
||||||
|
)
|
||||||
|
|
||||||
|
func askBus(t *testing.T, ackWait time.Duration) jetstream.JetStream {
|
||||||
|
t.Helper()
|
||||||
|
nc, err := nats.Connect(testbus.URL(t))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
t.Cleanup(nc.Close)
|
||||||
|
js, err := jetstream.New(nc)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := DeclareAskWorkers(context.Background(), js, delivery.AskGo, ackWait); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return js
|
||||||
|
}
|
||||||
|
|
||||||
|
func publishAsk(t *testing.T, js jetstream.JetStream, a delivery.StepAsk) {
|
||||||
|
t.Helper()
|
||||||
|
raw, err := delivery.EncodeStepAsk(a)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
subject, _ := delivery.AskSubject(a.Language, a.Kind)
|
||||||
|
if _, err := js.Publish(context.Background(), subject, raw); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1887/A2a, 1887/AC-order, 1887/AC-pull on the real server: a check ask published before a delivery ask runs after it;
|
||||||
|
// with capacity 2 and three asks two run, the third waits in the stream and starts when one ends.
|
||||||
|
func TestPullOrderAndCapacityOnTheBus(t *testing.T) {
|
||||||
|
js := askBus(t, 30*time.Second)
|
||||||
|
check, first, second := testAsk(delivery.AskCheck), testAsk(delivery.AskDelivery), testAsk(delivery.AskDelivery)
|
||||||
|
publishAsk(t, js, check)
|
||||||
|
publishAsk(t, js, first)
|
||||||
|
publishAsk(t, js, second)
|
||||||
|
release := make(chan struct{})
|
||||||
|
var mu sync.Mutex
|
||||||
|
var order []string
|
||||||
|
st := newSteps()
|
||||||
|
p := &Puller{Source: &JetStreamAsks{JS: js, Language: delivery.AskGo}, Language: delivery.AskGo, Node: "shanks", Put: st.put,
|
||||||
|
Capacity: func() int { return 2 }, PullWait: 200 * time.Millisecond,
|
||||||
|
Run: func(ctx context.Context, a delivery.StepAsk) (any, error) {
|
||||||
|
mu.Lock()
|
||||||
|
order = append(order, a.ID)
|
||||||
|
mu.Unlock()
|
||||||
|
<-release
|
||||||
|
return nil, nil
|
||||||
|
}}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go p.Pull(ctx)
|
||||||
|
waitFor(t, "two in hand", func() bool { return p.InHand() == 2 })
|
||||||
|
time.Sleep(500 * time.Millisecond)
|
||||||
|
mu.Lock()
|
||||||
|
if len(order) != 2 || order[0] != first.ID || order[1] != second.ID {
|
||||||
|
t.Fatalf("ran %v, want the two delivery asks %s %s first", order, first.ID, second.ID)
|
||||||
|
}
|
||||||
|
mu.Unlock()
|
||||||
|
release <- struct{}{}
|
||||||
|
waitFor(t, "the check taken", func() bool { mu.Lock(); defer mu.Unlock(); return len(order) == 3 })
|
||||||
|
close(release)
|
||||||
|
waitFor(t, "every step ended", func() bool {
|
||||||
|
for _, a := range []delivery.StepAsk{check, first, second} {
|
||||||
|
key, _ := delivery.AskStepKey("shanks", a.ID)
|
||||||
|
if s, ok := st.get(key); !ok || s.State != delivery.StepPassed {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
})
|
||||||
|
info, err := js.Stream(ctx, "SEAT_NODE_BUILD_GO")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
waitFor(t, "the stream empty (every ask acknowledged)", func() bool {
|
||||||
|
si, err := info.Info(ctx)
|
||||||
|
return err == nil && si.State.Msgs == 0
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1887/A2c, ADR 0525 §6: a killed puller's ask is redelivered by the stream's acknowledgement wait to the other node,
|
||||||
|
// whose step key names the reference.
|
||||||
|
func TestPullRedeliversAKilledPullersAsk(t *testing.T) {
|
||||||
|
js := askBus(t, 2*time.Second)
|
||||||
|
a := testAsk(delivery.AskDelivery)
|
||||||
|
publishAsk(t, js, a)
|
||||||
|
st := newSteps()
|
||||||
|
taken := make(chan struct{})
|
||||||
|
dying := &Puller{Source: &JetStreamAsks{JS: js, Language: delivery.AskGo}, Language: delivery.AskGo, Node: "ace", Put: st.put,
|
||||||
|
Capacity: func() int { return 1 }, PullWait: 200 * time.Millisecond, Heartbeat: time.Hour,
|
||||||
|
Run: func(ctx context.Context, a delivery.StepAsk) (any, error) {
|
||||||
|
close(taken)
|
||||||
|
<-ctx.Done()
|
||||||
|
return nil, ctx.Err()
|
||||||
|
}}
|
||||||
|
kill, killed := context.WithCancel(context.Background())
|
||||||
|
go dying.Pull(kill)
|
||||||
|
<-taken
|
||||||
|
killed()
|
||||||
|
other := &Puller{Source: &JetStreamAsks{JS: js, Language: delivery.AskGo}, Language: delivery.AskGo, Node: "shanks", Put: st.put,
|
||||||
|
Capacity: func() int { return 1 }, PullWait: 200 * time.Millisecond,
|
||||||
|
Run: func(ctx context.Context, a delivery.StepAsk) (any, error) {
|
||||||
|
return delivery.BuildAnswer{Artifacts: []delivery.AskBuilt{{Artifact: "bundle", Digest: "sha256:00", Reference: "artifact-store://x"}}}, nil
|
||||||
|
}}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go other.Pull(ctx)
|
||||||
|
key, _ := delivery.AskStepKey("shanks", a.ID)
|
||||||
|
deadline := time.Now().Add(10 * time.Second)
|
||||||
|
for {
|
||||||
|
if s, ok := st.get(key); ok && s.State == delivery.StepPassed {
|
||||||
|
if want := `artifact-store://x`; !contains(string(s.Result), want) {
|
||||||
|
t.Fatalf("the step's result %s names no %s", s.Result, want)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if time.Now().After(deadline) {
|
||||||
|
t.Fatalf("the killed puller's ask was not taken by shanks within 10 s")
|
||||||
|
}
|
||||||
|
time.Sleep(20 * time.Millisecond)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func contains(s, sub string) bool { return strings.Contains(s, sub) }
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
stdio "git.novox.be/novox/mesh-sdk/go"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
// SeatAsks is a build seat's workers as a tools bundle reaches them: through its runtime's seat pull and settle
|
||||||
|
// (stdio.SeatPull, SeatSettle; issue 1887 A11), one message per pull, only from the workers the module's membership
|
||||||
|
// lists.
|
||||||
|
type SeatAsks struct {
|
||||||
|
Language string
|
||||||
|
// Pull and Settle are stdio.SeatPull and stdio.SeatSettle when nil; a test gives its own.
|
||||||
|
Pull func(worker string, wait time.Duration) (*stdio.Pulled, error)
|
||||||
|
Settle func(id, fate string) error
|
||||||
|
}
|
||||||
|
|
||||||
|
// Next is AskSource's.
|
||||||
|
func (s SeatAsks) Next(ctx context.Context, kind string, wait time.Duration) (*Pulled, error) {
|
||||||
|
pull, settle := s.Pull, s.Settle
|
||||||
|
if pull == nil {
|
||||||
|
pull = stdio.SeatPull
|
||||||
|
}
|
||||||
|
if settle == nil {
|
||||||
|
settle = stdio.SeatSettle
|
||||||
|
}
|
||||||
|
worker, err := delivery.AskWorker(s.Language, kind)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
p, err := pull(worker, wait)
|
||||||
|
if err != nil || p == nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
fate := func(f string) func() error { return func() error { return settle(p.ID, f) } }
|
||||||
|
return &Pulled{Data: p.Body, Delivered: p.Delivered, Ack: fate(stdio.SettleAck), InProgress: fate(stdio.SettleProgress),
|
||||||
|
Nak: fate(stdio.SettleNak), Term: fate(stdio.SettleTerm)}, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
stdio "git.novox.be/novox/mesh-sdk/go"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
// 1887/A11: a bundle's source pulls the kind's worker by its seat's name and settles each ask by the runtime's id.
|
||||||
|
func TestSeatAsksPullsTheKindsWorkerAndSettlesByID(t *testing.T) {
|
||||||
|
var pulled []string
|
||||||
|
var settled []string
|
||||||
|
src := SeatAsks{Language: delivery.AskGo,
|
||||||
|
Pull: func(worker string, wait time.Duration) (*stdio.Pulled, error) {
|
||||||
|
pulled = append(pulled, worker)
|
||||||
|
if worker != "SEAT_NODE_BUILD_GO_CHECK_worker" {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
return &stdio.Pulled{ID: "p9", Worker: worker, Body: []byte(`{"v":1}`), Delivered: 2}, nil
|
||||||
|
},
|
||||||
|
Settle: func(id, fate string) error { settled = append(settled, id+" "+fate); return nil }}
|
||||||
|
if p, err := src.Next(context.Background(), delivery.AskDelivery, 0); err != nil || p != nil {
|
||||||
|
t.Fatalf("delivery = %+v, %v", p, err)
|
||||||
|
}
|
||||||
|
p, err := src.Next(context.Background(), delivery.AskCheck, time.Second)
|
||||||
|
if err != nil || p == nil || string(p.Data) != `{"v":1}` || p.Delivered != 2 {
|
||||||
|
t.Fatalf("check = %+v, %v", p, err)
|
||||||
|
}
|
||||||
|
_ = p.InProgress()
|
||||||
|
_ = p.Ack()
|
||||||
|
if len(pulled) != 2 || pulled[0] != "SEAT_NODE_BUILD_GO_DELIVERY_worker" {
|
||||||
|
t.Errorf("pulled %v", pulled)
|
||||||
|
}
|
||||||
|
if len(settled) != 2 || settled[0] != "p9 progress" || settled[1] != "p9 ack" {
|
||||||
|
t.Errorf("settled %v", settled)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,364 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
stdio "git.novox.be/novox/mesh-sdk/go"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
// steps records a steps state's puts: the last value of each key.
|
||||||
|
type steps struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
keys map[string]delivery.Step
|
||||||
|
}
|
||||||
|
|
||||||
|
func newSteps() *steps { return &steps{keys: map[string]delivery.Step{}} }
|
||||||
|
|
||||||
|
func (s *steps) put(key string, value any) (uint64, error) {
|
||||||
|
raw, _ := value.(json.RawMessage)
|
||||||
|
st, err := delivery.DecodeStep(raw)
|
||||||
|
if err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
s.mu.Lock()
|
||||||
|
s.keys[key] = st
|
||||||
|
s.mu.Unlock()
|
||||||
|
return 1, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *steps) get(key string) (delivery.Step, bool) {
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
st, ok := s.keys[key]
|
||||||
|
return st, ok
|
||||||
|
}
|
||||||
|
|
||||||
|
func testAsk(kind string) delivery.StepAsk {
|
||||||
|
id := NewID()
|
||||||
|
a := delivery.StepAsk{ID: id, Kind: kind, Language: delivery.AskGo, Asker: "mesh-delivery-builder", At: time.Now()}
|
||||||
|
fetch := map[string]any{"repository": "novox/x", "commit": "0123456789abcdef0123456789abcdef01234567"}
|
||||||
|
if kind == delivery.AskDelivery {
|
||||||
|
b := buildJobFixture
|
||||||
|
b.Fetch = fetch
|
||||||
|
a.Build = &b
|
||||||
|
} else {
|
||||||
|
a.Check = &delivery.CheckJob{Fetch: fetch, Levels: []string{delivery.LevelUnit}}
|
||||||
|
}
|
||||||
|
return a
|
||||||
|
}
|
||||||
|
|
||||||
|
var buildJobFixture = delivery.BuildJob{Module: "m", Path: ".", Artifacts: []delivery.AskArtifact{{Artifact: "bundle"}}}
|
||||||
|
|
||||||
|
func waitFor(t *testing.T, what string, cond func() bool) {
|
||||||
|
t.Helper()
|
||||||
|
deadline := time.Now().Add(2 * time.Second)
|
||||||
|
for !cond() {
|
||||||
|
if time.Now().After(deadline) {
|
||||||
|
t.Fatalf("waited 2 s for %s", what)
|
||||||
|
}
|
||||||
|
time.Sleep(time.Millisecond)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1887/A2a: given a check ask published before a delivery ask and one slot, the delivery ask runs first.
|
||||||
|
func TestPullTakesDeliveryBeforeCheck(t *testing.T) {
|
||||||
|
src, st := NewFakeAsks(), newSteps()
|
||||||
|
check, recheck, deliver := testAsk(delivery.AskCheck), testAsk(delivery.AskRecheck), testAsk(delivery.AskDelivery)
|
||||||
|
for _, a := range []delivery.StepAsk{recheck, check, deliver} {
|
||||||
|
if err := src.PublishAsk(a); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var mu sync.Mutex
|
||||||
|
var order []string
|
||||||
|
p := &Puller{Source: src, Language: delivery.AskGo, Node: "shanks", Put: st.put, Capacity: func() int { return 1 },
|
||||||
|
PullWait: 10 * time.Millisecond, Run: func(ctx context.Context, a delivery.StepAsk) (any, error) {
|
||||||
|
mu.Lock()
|
||||||
|
order = append(order, a.Kind)
|
||||||
|
mu.Unlock()
|
||||||
|
return map[string]string{"ran": a.ID}, nil
|
||||||
|
}}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go p.Pull(ctx)
|
||||||
|
waitFor(t, "three asks acked", func() bool { a, _, _ := src.Fates(); return len(a) == 3 })
|
||||||
|
mu.Lock()
|
||||||
|
defer mu.Unlock()
|
||||||
|
if want := []string{delivery.AskDelivery, delivery.AskCheck, delivery.AskRecheck}; len(order) != 3 || order[0] != want[0] || order[1] != want[1] || order[2] != want[2] {
|
||||||
|
t.Fatalf("order = %v, want %v", order, want)
|
||||||
|
}
|
||||||
|
key, _ := delivery.AskStepKey("shanks", deliver.ID)
|
||||||
|
s, ok := st.get(key)
|
||||||
|
if !ok || s.State != delivery.StepPassed || string(s.Result) != `{"ran":"`+deliver.ID+`"}` {
|
||||||
|
t.Fatalf("the step %s = %+v (%v)", key, s, ok)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1887/A2a, 1887/AC-pull: given capacity 2 and three asks waiting, two run and the third waits, and it starts when
|
||||||
|
// one ends, with no timer.
|
||||||
|
func TestPullHoldsAtMostItsCapacity(t *testing.T) {
|
||||||
|
src, st := NewFakeAsks(), newSteps()
|
||||||
|
for i := 0; i < 3; i++ {
|
||||||
|
_ = src.PublishAsk(testAsk(delivery.AskDelivery))
|
||||||
|
}
|
||||||
|
release := make(chan struct{})
|
||||||
|
var mu sync.Mutex
|
||||||
|
started := 0
|
||||||
|
p := &Puller{Source: src, Language: delivery.AskGo, Node: "shanks", Put: st.put, Capacity: func() int { return 2 },
|
||||||
|
PullWait: 10 * time.Millisecond, Run: func(ctx context.Context, a delivery.StepAsk) (any, error) {
|
||||||
|
mu.Lock()
|
||||||
|
started++
|
||||||
|
mu.Unlock()
|
||||||
|
<-release
|
||||||
|
return nil, nil
|
||||||
|
}}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go p.Pull(ctx)
|
||||||
|
waitFor(t, "two in hand", func() bool { return p.InHand() == 2 })
|
||||||
|
time.Sleep(30 * time.Millisecond) // three pull waits: the third must still wait
|
||||||
|
if p.InHand() != 2 || src.Waiting(delivery.AskDelivery) != 1 {
|
||||||
|
t.Fatalf("in hand %d, waiting %d; want 2 and 1", p.InHand(), src.Waiting(delivery.AskDelivery))
|
||||||
|
}
|
||||||
|
release <- struct{}{}
|
||||||
|
waitFor(t, "the third taken", func() bool { return src.Waiting(delivery.AskDelivery) == 0 })
|
||||||
|
// Taken from the source comes a moment before its run starts: wait for the start, not only the take.
|
||||||
|
waitFor(t, "the third started", func() bool { mu.Lock(); defer mu.Unlock(); return started == 3 })
|
||||||
|
close(release)
|
||||||
|
waitFor(t, "all acked", func() bool { a, _, _ := src.Fates(); return len(a) == 3 })
|
||||||
|
}
|
||||||
|
|
||||||
|
// An ask that is not one, or not this seat's, is dropped and runs nowhere.
|
||||||
|
func TestPullDropsWhatIsNoAsk(t *testing.T) {
|
||||||
|
src, st := NewFakeAsks(), newSteps()
|
||||||
|
src.Publish(delivery.AskDelivery, []byte(`{"v":1}`))
|
||||||
|
other := testAsk(delivery.AskDelivery)
|
||||||
|
other.Language = delivery.AskNode
|
||||||
|
_ = src.PublishAsk(other)
|
||||||
|
ran := false
|
||||||
|
p := &Puller{Source: src, Language: delivery.AskGo, Node: "shanks", Put: st.put, Capacity: func() int { return 1 },
|
||||||
|
PullWait: 10 * time.Millisecond, Run: func(ctx context.Context, a delivery.StepAsk) (any, error) { ran = true; return nil, nil }}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go p.Pull(ctx)
|
||||||
|
waitFor(t, "two termed", func() bool { _, tm, _ := src.Fates(); return len(tm) == 2 })
|
||||||
|
if ran {
|
||||||
|
t.Fatal("a wrong ask ran")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// load reads the recorded steps state's raw values: the pause key is not a step, so it is kept apart.
|
||||||
|
type kv struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
vals map[string][]byte
|
||||||
|
}
|
||||||
|
|
||||||
|
func (k *kv) put(key string, value any) (uint64, error) {
|
||||||
|
raw, _ := value.(json.RawMessage)
|
||||||
|
k.mu.Lock()
|
||||||
|
defer k.mu.Unlock()
|
||||||
|
if k.vals == nil {
|
||||||
|
k.vals = map[string][]byte{}
|
||||||
|
}
|
||||||
|
k.vals[key] = append([]byte(nil), raw...)
|
||||||
|
return 1, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (k *kv) load(key string) ([]byte, error) {
|
||||||
|
k.mu.Lock()
|
||||||
|
defer k.mu.Unlock()
|
||||||
|
return k.vals[key], nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1887/A2b, 1887/AC-zero, 1887/AC-wake: at capacity 0 the puller takes nothing; a capacity raised takes effect at the
|
||||||
|
// next pull, or, with the config watch (g14 idle at capacity 2, 2026-10-25), at once when the value moves, with no
|
||||||
|
// pause, resume or step end to wake it; a refused value pulls nothing, and a watch that cannot start leaves the
|
||||||
|
// settings file's capacity.
|
||||||
|
func TestPullAtCapacityZeroTakesNothing(t *testing.T) {
|
||||||
|
t.Run("settings file", func(t *testing.T) {
|
||||||
|
src, st := NewFakeAsks(), &kv{}
|
||||||
|
_ = src.PublishAsk(testAsk(delivery.AskDelivery))
|
||||||
|
var mu sync.Mutex
|
||||||
|
capacity := 0
|
||||||
|
p := &Puller{Source: src, Language: delivery.AskGo, Node: "novox", Put: st.put, PullWait: 10 * time.Millisecond,
|
||||||
|
Capacity: func() int { mu.Lock(); defer mu.Unlock(); return capacity },
|
||||||
|
Run: func(ctx context.Context, a delivery.StepAsk) (any, error) { return nil, nil }}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go p.Pull(ctx)
|
||||||
|
time.Sleep(50 * time.Millisecond)
|
||||||
|
if src.Waiting(delivery.AskDelivery) != 1 {
|
||||||
|
t.Fatal("a node at capacity 0 took an ask")
|
||||||
|
}
|
||||||
|
mu.Lock()
|
||||||
|
capacity = 1
|
||||||
|
mu.Unlock()
|
||||||
|
p.Wake()
|
||||||
|
waitFor(t, "the ask taken at capacity 1", func() bool { a, _, _ := src.Fates(); return len(a) == 1 })
|
||||||
|
})
|
||||||
|
t.Run("config watch wakes", func(t *testing.T) {
|
||||||
|
src, st := NewFakeAsks(), newSteps()
|
||||||
|
_ = src.PublishAsk(testAsk(delivery.AskDelivery))
|
||||||
|
w := &configWatch{value: "shanks=3,g14=0"}
|
||||||
|
p := &Puller{Source: src, Language: delivery.AskGo, Node: "g14", Put: st.put, PullWait: 10 * time.Millisecond,
|
||||||
|
Capacity: func() int { return 0 }, // the settings file, not refilled yet
|
||||||
|
WatchConfig: w.watch,
|
||||||
|
Run: func(ctx context.Context, a delivery.StepAsk) (any, error) { return nil, nil }}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go p.Pull(ctx)
|
||||||
|
waitFor(t, "the watch of the capacity", func() bool { w.mu.Lock(); defer w.mu.Unlock(); return w.handle != nil })
|
||||||
|
time.Sleep(30 * time.Millisecond)
|
||||||
|
if src.Waiting(delivery.AskDelivery) != 1 {
|
||||||
|
t.Fatal("a node at capacity 0 took an ask")
|
||||||
|
}
|
||||||
|
if w.asked != CapacitySetting {
|
||||||
|
t.Fatalf("the puller watches %q, want %q", w.asked, CapacitySetting)
|
||||||
|
}
|
||||||
|
w.set(t, "shanks=3,g14=2")
|
||||||
|
waitFor(t, "the ask taken once the capacity moved to 2", func() bool { a, _, _ := src.Fates(); return len(a) == 1 })
|
||||||
|
})
|
||||||
|
for _, c := range []struct {
|
||||||
|
name string
|
||||||
|
watch func(string, func(stdio.ProvisionChange) error) error
|
||||||
|
room bool
|
||||||
|
}{
|
||||||
|
{"refused value leaves no room", func(key string, handle func(stdio.ProvisionChange) error) error {
|
||||||
|
return handle(stdio.ProvisionChange{Kind: "config", Key: key, Refused: "the module is no longer on g14"})
|
||||||
|
}, false},
|
||||||
|
{"watch that cannot start keeps the settings file", func(string, func(stdio.ProvisionChange) error) error {
|
||||||
|
return errors.New("no runtime")
|
||||||
|
}, true},
|
||||||
|
} {
|
||||||
|
t.Run(c.name, func(t *testing.T) {
|
||||||
|
p := &Puller{Source: NewFakeAsks(), Language: delivery.AskGo, Node: "g14", Put: newSteps().put,
|
||||||
|
Capacity: func() int { return 1 }, WatchConfig: c.watch,
|
||||||
|
Run: func(ctx context.Context, a delivery.StepAsk) (any, error) { return nil, nil }}
|
||||||
|
p.watchCapacity()
|
||||||
|
if p.room() != c.room {
|
||||||
|
t.Fatalf("room = %v, want %v", p.room(), c.room)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1887/A2b: a paused puller takes nothing, its pause is kept on the pause key, and a puller started again on that state
|
||||||
|
// stays paused until resumed.
|
||||||
|
func TestPullPauseOutlivesARestart(t *testing.T) {
|
||||||
|
src, st, steps := NewFakeAsks(), &kv{}, &kv{}
|
||||||
|
run := func(ctx context.Context, a delivery.StepAsk) (any, error) { return nil, nil }
|
||||||
|
p := &Puller{Source: src, Language: delivery.AskGo, Node: "shanks", Put: steps.put, PausePut: st.put, Load: st.load,
|
||||||
|
PullWait: 10 * time.Millisecond, Capacity: func() int { return 2 }, Run: run}
|
||||||
|
if err := p.Pause("the operator"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
key, _ := delivery.PauseKey("shanks")
|
||||||
|
raw, _ := st.load(key)
|
||||||
|
if v, err := delivery.DecodePause(raw); err != nil || !v.Paused || v.By != "the operator" {
|
||||||
|
t.Fatalf("the pause key holds %s (%v)", raw, err)
|
||||||
|
}
|
||||||
|
if raw, _ := steps.load(key); raw != nil {
|
||||||
|
t.Fatalf("the pause was written in the steps state, whose keys age out: %s", raw)
|
||||||
|
}
|
||||||
|
// The restart: a new puller on the same state.
|
||||||
|
again := &Puller{Source: src, Language: delivery.AskGo, Node: "shanks", Put: steps.put, PausePut: st.put, Load: st.load,
|
||||||
|
PullWait: 10 * time.Millisecond, Capacity: func() int { return 2 }, Run: run}
|
||||||
|
_ = src.PublishAsk(testAsk(delivery.AskDelivery))
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go again.Pull(ctx)
|
||||||
|
time.Sleep(50 * time.Millisecond)
|
||||||
|
if !again.Paused() || src.Waiting(delivery.AskDelivery) != 1 {
|
||||||
|
t.Fatalf("restarted: paused %v, waiting %d; want paused and 1", again.Paused(), src.Waiting(delivery.AskDelivery))
|
||||||
|
}
|
||||||
|
if err := again.Resume("the operator"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
waitFor(t, "the ask taken after the resume", func() bool { a, _, _ := src.Fates(); return len(a) == 1 })
|
||||||
|
|
||||||
|
t.Run("a pause that cannot be read is said and pulled as not paused", func(t *testing.T) {
|
||||||
|
src := NewFakeAsks()
|
||||||
|
var said atomic.Value
|
||||||
|
p := &Puller{Source: src, Language: delivery.AskGo, Node: "shanks", Put: steps.put, PausePut: st.put,
|
||||||
|
Load: func(string) ([]byte, error) { return nil, errors.New("no runtime yet") },
|
||||||
|
PullWait: 10 * time.Millisecond, Capacity: func() int { return 2 }, Run: run,
|
||||||
|
Logf: func(f string, a ...any) {
|
||||||
|
if m := fmt.Sprintf(f, a...); strings.Contains(m, "cannot be read") {
|
||||||
|
said.Store(m)
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
_ = src.PublishAsk(testAsk(delivery.AskDelivery))
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go p.Pull(ctx)
|
||||||
|
waitFor(t, "the ask taken", func() bool { a, _, _ := src.Fates(); return len(a) == 1 })
|
||||||
|
if m, _ := said.Load().(string); !strings.Contains(m, "pulling as not paused") {
|
||||||
|
t.Fatalf("the unreadable pause was not said: %q", m)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1887/A2c: a long step tells the bus it is still being worked; a holder that stops mid-step neither ends nor
|
||||||
|
// acknowledges its ask, so the stream gives it to another node.
|
||||||
|
func TestPullHeartbeatAndStop(t *testing.T) {
|
||||||
|
src, st := NewFakeAsks(), newSteps()
|
||||||
|
a := testAsk(delivery.AskDelivery)
|
||||||
|
_ = src.PublishAsk(a)
|
||||||
|
running := make(chan struct{})
|
||||||
|
p := &Puller{Source: src, Language: delivery.AskGo, Node: "shanks", Put: st.put, Capacity: func() int { return 1 },
|
||||||
|
PullWait: 10 * time.Millisecond, Heartbeat: 5 * time.Millisecond,
|
||||||
|
Run: func(ctx context.Context, a delivery.StepAsk) (any, error) {
|
||||||
|
close(running)
|
||||||
|
<-ctx.Done()
|
||||||
|
return nil, ctx.Err()
|
||||||
|
}}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
stopped := make(chan struct{})
|
||||||
|
go func() { p.Pull(ctx); close(stopped) }()
|
||||||
|
<-running
|
||||||
|
waitFor(t, "two heartbeats", func() bool { src.mu.Lock(); defer src.mu.Unlock(); return src.InProgress >= 2 })
|
||||||
|
cancel()
|
||||||
|
<-stopped
|
||||||
|
waitFor(t, "the step's goroutine gone", func() bool { return p.InHand() == 0 })
|
||||||
|
acked, termed, naked := src.Fates()
|
||||||
|
if len(acked)+len(termed)+len(naked) != 0 {
|
||||||
|
t.Fatalf("a stopped holder gave its ask a fate: acked %v termed %v naked %v", acked, termed, naked)
|
||||||
|
}
|
||||||
|
key, _ := delivery.AskStepKey("shanks", a.ID)
|
||||||
|
if s, ok := st.get(key); !ok || s.State != delivery.StepRunning {
|
||||||
|
t.Fatalf("the step %s = %+v, want left running", key, s)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1907: an ask taken past AskRuns (each run took its node down) is run no more: its step ends failed saying why, so the
|
||||||
|
// asker's key fails, and it is ended on the stream, not offered to another node.
|
||||||
|
func TestAPoisonedAskIsSaidAndRunNoMore(t *testing.T) {
|
||||||
|
src, st := NewFakeAsks(), newSteps()
|
||||||
|
src.Delivered = delivery.AskRuns + 1
|
||||||
|
a := testAsk(delivery.AskDelivery)
|
||||||
|
_ = src.PublishAsk(a)
|
||||||
|
ran := false
|
||||||
|
p := &Puller{Source: src, Language: delivery.AskGo, Node: "shanks", Put: st.put, Capacity: func() int { return 1 },
|
||||||
|
PullWait: 10 * time.Millisecond, Run: func(ctx context.Context, a delivery.StepAsk) (any, error) { ran = true; return nil, nil }}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go p.Pull(ctx)
|
||||||
|
waitFor(t, "the ask termed", func() bool { _, tm, _ := src.Fates(); return len(tm) == 1 })
|
||||||
|
key, _ := delivery.AskStepKey("shanks", a.ID)
|
||||||
|
s, ok := st.get(key)
|
||||||
|
if ran || !ok || s.State != delivery.StepFailed || !strings.Contains(s.Reason, "taken 3 times") || !strings.Contains(s.Reason, "poison") {
|
||||||
|
t.Fatalf("ran %v, step %+v", ran, s)
|
||||||
|
}
|
||||||
|
if acked, _, naked := src.Fates(); len(acked)+len(naked) != 0 {
|
||||||
|
t.Errorf("acked %v naked %v, want it termed alone", acked, naked)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,5 +1,7 @@
|
|||||||
package buildstep
|
package buildstep
|
||||||
|
|
||||||
|
import "fmt"
|
||||||
|
|
||||||
// Refusal is a step that is not run on purpose, as against one that failed: the toolchain installed is not the
|
// Refusal is a step that is not run on purpose, as against one that failed: the toolchain installed is not the
|
||||||
// recipe's, the integration level's postgres major is not the one it is built for (novox/hq ADR 0469 §1, ADR 0470
|
// recipe's, the integration level's postgres major is not the one it is built for (novox/hq ADR 0469 §1, ADR 0470
|
||||||
// §4; issue 1473). A step's run returns one and the runner ends the step refused with its text.
|
// §4; issue 1473). A step's run returns one and the runner ends the step refused with its text.
|
||||||
@@ -11,3 +13,6 @@ type Refusal struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (r *Refusal) Error() string { return r.Text }
|
func (r *Refusal) Error() string { return r.Text }
|
||||||
|
|
||||||
|
// Refuse is a Refusal with its text formatted.
|
||||||
|
func Refuse(format string, args ...any) *Refusal { return &Refusal{Text: fmt.Sprintf(format, args...)} }
|
||||||
|
|||||||
@@ -0,0 +1,36 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
stdio "git.novox.be/novox/mesh-sdk/go"
|
||||||
|
)
|
||||||
|
|
||||||
|
// SeatTools are a build seat's verbs on one node, as its holder serves them (novox/hq ADR 0525 §10; mesh-sdk catalogue
|
||||||
|
// buildSeatVerbs): `<seat>.current` (what the node runs, its capacity, whether it is paused), `<seat>.pause` and
|
||||||
|
// `<seat>.resume`, the pause kept on the node's pause key by the puller. what names the asks in the descriptions ("Go").
|
||||||
|
func SeatTools(seat, what string, p *Puller) []stdio.Tool {
|
||||||
|
verb := func(name, description string, run func() (any, error)) stdio.Tool {
|
||||||
|
return stdio.Tool{Name: seat + "." + name, Description: description,
|
||||||
|
Input: map[string]any{"type": "object", "properties": map[string]any{}},
|
||||||
|
Run: func(map[string]any) (any, error) { return run() }}
|
||||||
|
}
|
||||||
|
current := func() (any, error) {
|
||||||
|
return map[string]any{"node": p.Node, "capacity": p.CapacityNow(), "running": p.Running(), "paused": p.Paused()}, nil
|
||||||
|
}
|
||||||
|
return []stdio.Tool{
|
||||||
|
verb("current", "The "+what+" asks this node runs now (each one's id, kind and when it started), its build capacity, "+
|
||||||
|
"and whether it is paused.", current),
|
||||||
|
verb("pause", "Take no new "+what+" ask on this node until resumed; an ask running here ends in its place. Kept "+
|
||||||
|
"across a restart (the node's pause key).", func() (any, error) {
|
||||||
|
if err := p.Pause("the seat's pause verb"); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return current()
|
||||||
|
}),
|
||||||
|
verb("resume", "Take "+what+" asks again on this node.", func() (any, error) {
|
||||||
|
if err := p.Resume("the seat's resume verb"); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return current()
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
// 1887/A9a, ADR 0525 §10: a build seat's verbs are <seat>.current, .pause and .resume; current names the ask running,
|
||||||
|
// pause stops the puller taking asks, resume lets it take them again.
|
||||||
|
func TestSeatToolsCurrentPauseResume(t *testing.T) {
|
||||||
|
src, st := NewFakeAsks(), newSteps()
|
||||||
|
release := make(chan struct{})
|
||||||
|
p := &Puller{Source: src, Language: delivery.AskGo, Node: "shanks", Put: st.put, Capacity: func() int { return 1 },
|
||||||
|
PullWait: 10 * time.Millisecond, Run: func(ctx context.Context, a delivery.StepAsk) (any, error) { <-release; return nil, nil }}
|
||||||
|
tools := map[string]func(map[string]any) (any, error){}
|
||||||
|
for _, tool := range SeatTools("node-build-go", "Go", p) {
|
||||||
|
tools[tool.Name] = tool.Run
|
||||||
|
}
|
||||||
|
for _, name := range []string{"node-build-go.current", "node-build-go.pause", "node-build-go.resume"} {
|
||||||
|
if tools[name] == nil {
|
||||||
|
t.Fatalf("no %s", name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
a := testAsk(delivery.AskDelivery)
|
||||||
|
_ = src.PublishAsk(a)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
go p.Pull(ctx)
|
||||||
|
waitFor(t, "the ask running", func() bool { return p.InHand() == 1 })
|
||||||
|
out, _ := tools["node-build-go.current"](nil)
|
||||||
|
cur := out.(map[string]any)
|
||||||
|
running := cur["running"].([]RunningAsk)
|
||||||
|
if len(running) != 1 || running[0].ID != a.ID || running[0].Module != "m" || cur["capacity"] != 1 || cur["paused"] != false {
|
||||||
|
t.Fatalf("current = %+v", cur)
|
||||||
|
}
|
||||||
|
if out, err := tools["node-build-go.pause"](nil); err != nil || out.(map[string]any)["paused"] != true {
|
||||||
|
t.Fatalf("pause = %v, %v", out, err)
|
||||||
|
}
|
||||||
|
close(release)
|
||||||
|
_ = src.PublishAsk(testAsk(delivery.AskDelivery))
|
||||||
|
time.Sleep(50 * time.Millisecond)
|
||||||
|
if src.Waiting(delivery.AskDelivery) != 1 {
|
||||||
|
t.Fatal("a paused node took an ask")
|
||||||
|
}
|
||||||
|
if _, err := tools["node-build-go.resume"](nil); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
waitFor(t, "the ask taken after the resume", func() bool { return src.Waiting(delivery.AskDelivery) == 0 })
|
||||||
|
}
|
||||||
+78
-31
@@ -10,6 +10,7 @@ import (
|
|||||||
"encoding/json"
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"log"
|
||||||
"strconv"
|
"strconv"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -42,43 +43,89 @@ func NewID() string {
|
|||||||
// the error's text, or refused when the error is a *Refusal; a panic in run ends the step failed, naming it, and
|
// the error's text, or refused when the error is a *Refusal; a panic in run ends the step failed, naming it, and
|
||||||
// the process goes on. If the running write fails, nothing was started and Start answers the error.
|
// the process goes on. If the running write fails, nothing was started and Start answers the error.
|
||||||
func Start(ctx context.Context, put Put, node, tool string, run func(ctx context.Context) (result any, err error)) (string, error) {
|
func Start(ctx context.Context, put Put, node, tool string, run func(ctx context.Context) (result any, err error)) (string, error) {
|
||||||
step := delivery.Step{ID: NewID(), Tool: tool, Node: node, State: delivery.StepRunning, Started: now().UTC()}
|
step, key, err := begin(put, node, tool, NewID())
|
||||||
key, err := delivery.StepKey(node, step.ID)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
if err := write(put, key, step); err != nil {
|
go end(ctx, put, key, step, run)
|
||||||
return "", fmt.Errorf("buildstep: writing the running step %s: %w", key, err)
|
|
||||||
}
|
|
||||||
go func() {
|
|
||||||
result, err := protect(ctx, run)
|
|
||||||
step.Ended = now().UTC()
|
|
||||||
switch ref := (*Refusal)(nil); {
|
|
||||||
case err == nil:
|
|
||||||
step.State = delivery.StepPassed
|
|
||||||
if result != nil {
|
|
||||||
raw, merr := json.Marshal(result)
|
|
||||||
if merr != nil {
|
|
||||||
step.State, step.Reason = delivery.StepFailed, "the result is not JSON: "+merr.Error()
|
|
||||||
} else {
|
|
||||||
step.Result = raw
|
|
||||||
}
|
|
||||||
}
|
|
||||||
case errors.As(err, &ref):
|
|
||||||
step.State, step.Reason = delivery.StepRefused, err.Error()
|
|
||||||
default:
|
|
||||||
step.State, step.Reason = delivery.StepFailed, err.Error()
|
|
||||||
}
|
|
||||||
for attempt := 1; ; attempt++ {
|
|
||||||
if werr := write(put, key, step); werr == nil || attempt >= EndAttempts {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
time.Sleep(EndRetry)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
return step.ID, nil
|
return step.ID, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// begin writes the step running under id.
|
||||||
|
func begin(put Put, node, tool, id string) (delivery.Step, string, error) {
|
||||||
|
step := delivery.Step{ID: id, Tool: tool, Node: node, State: delivery.StepRunning, Started: now().UTC()}
|
||||||
|
key, err := delivery.StepKey(node, step.ID)
|
||||||
|
if err != nil {
|
||||||
|
return delivery.Step{}, "", err
|
||||||
|
}
|
||||||
|
if err := write(put, key, step); err != nil {
|
||||||
|
return delivery.Step{}, "", fmt.Errorf("buildstep: writing the running step %s: %w", key, err)
|
||||||
|
}
|
||||||
|
return step, key, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// end runs run and writes the step's end.
|
||||||
|
func end(ctx context.Context, put Put, key string, step delivery.Step, run func(ctx context.Context) (any, error)) {
|
||||||
|
result, err := protect(ctx, run)
|
||||||
|
_ = finish(put, key, step, result, err, log.Printf) // finish says a refused end itself
|
||||||
|
}
|
||||||
|
|
||||||
|
// finish writes the step's end from run's result or error: passed, failed or refused (a *Refusal). A write that fails is
|
||||||
|
// tried EndAttempts times. When the whole end is refused every time (a result the state will not take: issue 1930), the
|
||||||
|
// refusal is logged and a small failed end without the result is written instead, naming the write's error, so the
|
||||||
|
// step's reader learns it is over and why. finish answers an error only when no end could be written at all, and then
|
||||||
|
// the step's ask is not acknowledged as done.
|
||||||
|
func finish(put Put, key string, step delivery.Step, result any, err error, logf func(format string, args ...any)) error {
|
||||||
|
step.Ended = now().UTC()
|
||||||
|
switch ref := (*Refusal)(nil); {
|
||||||
|
case err == nil:
|
||||||
|
step.State = delivery.StepPassed
|
||||||
|
if result != nil {
|
||||||
|
raw, merr := json.Marshal(result)
|
||||||
|
if merr != nil {
|
||||||
|
step.State, step.Reason = delivery.StepFailed, "the result is not JSON: "+merr.Error()
|
||||||
|
} else {
|
||||||
|
step.Result = raw
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case errors.As(err, &ref):
|
||||||
|
step.State, step.Reason = delivery.StepRefused, err.Error()
|
||||||
|
default:
|
||||||
|
step.State, step.Reason = delivery.StepFailed, err.Error()
|
||||||
|
}
|
||||||
|
werr := writeEnd(put, key, step)
|
||||||
|
if werr == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if logf != nil {
|
||||||
|
logf("the end of the step %s (%s) could not be written in %d tries: %v", key, step.State, EndAttempts, werr)
|
||||||
|
}
|
||||||
|
ended := step.State
|
||||||
|
why := fmt.Sprintf("the step ended %s, and its end could not be written: %v", ended, werr)
|
||||||
|
if step.Reason != "" {
|
||||||
|
why = fmt.Sprintf("the step ended %s (%s), and its end could not be written: %v", ended, step.Reason, werr)
|
||||||
|
}
|
||||||
|
step.State, step.Reason, step.Result = delivery.StepFailed, why, nil
|
||||||
|
if ferr := writeEnd(put, key, step); ferr != nil {
|
||||||
|
if logf != nil {
|
||||||
|
logf("the failed end of the step %s could not be written either: %v", key, ferr)
|
||||||
|
}
|
||||||
|
return fmt.Errorf("buildstep: no end of the step %s could be written: %w", key, ferr)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// writeEnd writes the step's end, trying EndAttempts times.
|
||||||
|
func writeEnd(put Put, key string, step delivery.Step) error {
|
||||||
|
for attempt := 1; ; attempt++ {
|
||||||
|
werr := write(put, key, step)
|
||||||
|
if werr == nil || attempt >= EndAttempts {
|
||||||
|
return werr
|
||||||
|
}
|
||||||
|
time.Sleep(EndRetry)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// protect is run with a panic turned into the error that ends the step.
|
// protect is run with a panic turned into the error that ends the step.
|
||||||
func protect(ctx context.Context, run func(ctx context.Context) (any, error)) (result any, err error) {
|
func protect(ctx context.Context, run func(ctx context.Context) (any, error)) (result any, err error) {
|
||||||
defer func() {
|
defer func() {
|
||||||
|
|||||||
@@ -0,0 +1,160 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
// A build module's room to work and its workspaces (novox/hq issue 1839, ADR 0509): a step is refused while the
|
||||||
|
// filesystem it writes to has less free than the floor, and a workspace is removed when its caller releases it, or,
|
||||||
|
// unheld, once its last use is past a bound (a lost caller's), never while a running step holds it.
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"regexp"
|
||||||
|
"sort"
|
||||||
|
"sync"
|
||||||
|
"syscall"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// FreeSpaceFloor is the free space a build module needs on its work and cache filesystems to take a step: the floor
|
||||||
|
// build-agent keeps (mesh-controller internal/builder/floor.go, issue 1834).
|
||||||
|
const FreeSpaceFloor uint64 = 20 << 30
|
||||||
|
|
||||||
|
// UnheldBound is how long a workspace no step holds is kept after its last use, when its caller never released it
|
||||||
|
// (ADR 0509: a lost caller's workspace goes after two hours).
|
||||||
|
const UnheldBound = 2 * time.Hour
|
||||||
|
|
||||||
|
// FreeBytes reads the bytes an unprivileged writer can still use on the filesystem holding path.
|
||||||
|
func FreeBytes(path string) (uint64, error) {
|
||||||
|
var s syscall.Statfs_t
|
||||||
|
if err := syscall.Statfs(path, &s); err != nil {
|
||||||
|
return 0, err
|
||||||
|
}
|
||||||
|
return s.Bavail * uint64(s.Bsize), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Floor refuses a step while a filesystem it writes to has less free than Bytes. A zero Bytes checks nothing.
|
||||||
|
type Floor struct {
|
||||||
|
// Node is named in the refusal.
|
||||||
|
Node string
|
||||||
|
Bytes uint64
|
||||||
|
// Free reads a path's free bytes; FreeBytes when nil. A test answers for a disk it does not have.
|
||||||
|
Free func(path string) (uint64, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check answers a *Refusal, "refused: <node> has N GiB free under the floor of F GiB (on <path>)", when any path's
|
||||||
|
// filesystem has less free than the floor, or its free space cannot be read; nil otherwise. A path not made yet is
|
||||||
|
// read at its nearest folder that is; an empty path is skipped.
|
||||||
|
func (f Floor) Check(paths ...string) error {
|
||||||
|
if f.Bytes == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
free := f.Free
|
||||||
|
if free == nil {
|
||||||
|
free = FreeBytes
|
||||||
|
}
|
||||||
|
for _, p := range paths {
|
||||||
|
if p == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
at := p
|
||||||
|
for {
|
||||||
|
if _, err := os.Stat(at); err == nil || filepath.Dir(at) == at {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
at = filepath.Dir(at)
|
||||||
|
}
|
||||||
|
n, err := free(at)
|
||||||
|
if err != nil {
|
||||||
|
return &Refusal{Text: fmt.Sprintf("refused: the free space of %s on %s cannot be read: %v", p, f.Node, err)}
|
||||||
|
}
|
||||||
|
if n < f.Bytes {
|
||||||
|
return &Refusal{Text: fmt.Sprintf("refused: %s has %d GiB free under the floor of %d GiB (on %s)", f.Node, n>>30, f.Bytes>>30, p),
|
||||||
|
Want: fmt.Sprintf("%d GiB", f.Bytes>>30), Have: fmt.Sprintf("%d GiB", n>>30)}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var workspaceID = regexp.MustCompile(`^[a-z0-9]+$`)
|
||||||
|
|
||||||
|
// Workspaces are a build module's workspaces, each <Dir>/<id>, and which of them running steps hold.
|
||||||
|
type Workspaces struct {
|
||||||
|
Dir string
|
||||||
|
|
||||||
|
mu sync.Mutex
|
||||||
|
held map[string]int
|
||||||
|
}
|
||||||
|
|
||||||
|
// Hold marks the workspace held by a running step until the answered func is called; both mark it used now, so the
|
||||||
|
// sweep counts its bound from the step's end. An id that is not a workspace's holds nothing.
|
||||||
|
func (w *Workspaces) Hold(id string) func() {
|
||||||
|
if !workspaceID.MatchString(id) {
|
||||||
|
return func() {}
|
||||||
|
}
|
||||||
|
w.mu.Lock()
|
||||||
|
if w.held == nil {
|
||||||
|
w.held = map[string]int{}
|
||||||
|
}
|
||||||
|
w.held[id]++
|
||||||
|
w.mu.Unlock()
|
||||||
|
w.touch(id)
|
||||||
|
var once sync.Once
|
||||||
|
return func() {
|
||||||
|
once.Do(func() {
|
||||||
|
w.touch(id)
|
||||||
|
w.mu.Lock()
|
||||||
|
if w.held[id]--; w.held[id] <= 0 {
|
||||||
|
delete(w.held, id)
|
||||||
|
}
|
||||||
|
w.mu.Unlock()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *Workspaces) touch(id string) {
|
||||||
|
now := time.Now()
|
||||||
|
_ = os.Chtimes(filepath.Join(w.Dir, id), now, now) // a workspace not made yet has nothing to mark
|
||||||
|
}
|
||||||
|
|
||||||
|
// Release removes the workspace at once: its caller's chain of steps has ended. One already gone is no error; one a
|
||||||
|
// running step holds is refused and kept; an id that is not a workspace's is refused.
|
||||||
|
func (w *Workspaces) Release(id string) error {
|
||||||
|
if !workspaceID.MatchString(id) {
|
||||||
|
return fmt.Errorf("%q is not a workspace id", id)
|
||||||
|
}
|
||||||
|
w.mu.Lock()
|
||||||
|
defer w.mu.Unlock()
|
||||||
|
if w.held[id] > 0 {
|
||||||
|
return fmt.Errorf("the workspace %s is held by a running step", id)
|
||||||
|
}
|
||||||
|
if err := os.RemoveAll(filepath.Join(w.Dir, id)); err != nil {
|
||||||
|
return fmt.Errorf("the workspace %s could not be removed: %w", id, err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sweep removes every workspace no step holds whose last use is older than bound, and answers the ids it removed,
|
||||||
|
// sorted. It is the safety net for a caller that never released its workspace.
|
||||||
|
func (w *Workspaces) Sweep(now time.Time, bound time.Duration) []string {
|
||||||
|
entries, err := os.ReadDir(w.Dir)
|
||||||
|
if err != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
removed := []string{}
|
||||||
|
w.mu.Lock()
|
||||||
|
defer w.mu.Unlock()
|
||||||
|
for _, e := range entries {
|
||||||
|
if !e.IsDir() || !workspaceID.MatchString(e.Name()) || w.held[e.Name()] > 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
info, err := e.Info()
|
||||||
|
if err != nil || now.Sub(info.ModTime()) < bound {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if os.RemoveAll(filepath.Join(w.Dir, e.Name())) == nil {
|
||||||
|
removed = append(removed, e.Name())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Strings(removed)
|
||||||
|
return removed
|
||||||
|
}
|
||||||
@@ -0,0 +1,113 @@
|
|||||||
|
package buildstep
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// 1839/AC1: a filesystem under the floor refuses the step, naming the node, what is free and the floor.
|
||||||
|
func TestAFilesystemUnderTheFloorRefusesNamingNodeFreeAndFloor(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
f := Floor{Node: "ace", Bytes: 20 << 30, Free: func(string) (uint64, error) { return 4<<30 + 5, nil }}
|
||||||
|
err := f.Check(dir)
|
||||||
|
var ref *Refusal
|
||||||
|
if !errors.As(err, &ref) {
|
||||||
|
t.Fatalf("Check = %v, want a *Refusal", err)
|
||||||
|
}
|
||||||
|
if want := "refused: ace has 4 GiB free under the floor of 20 GiB (on " + dir + ")"; err.Error() != want {
|
||||||
|
t.Errorf("Check = %q, want %q", err, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1839/AC1: at or above the floor, and with no floor set, nothing is refused.
|
||||||
|
func TestAtTheFloorOrWithNoFloorNothingIsRefused(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
if err := (Floor{Node: "ace", Bytes: 20 << 30, Free: func(string) (uint64, error) { return 20 << 30, nil }}).Check(dir); err != nil {
|
||||||
|
t.Errorf("at the floor: %v", err)
|
||||||
|
}
|
||||||
|
if err := (Floor{Node: "ace", Free: func(string) (uint64, error) { return 0, nil }}).Check(dir); err != nil {
|
||||||
|
t.Errorf("no floor: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1839/AC1: a path not made yet is read at its nearest folder that is; a free space that cannot be read is a refusal.
|
||||||
|
func TestAPathNotMadeIsReadAtItsParentAndAnUnreadableOneRefuses(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
var read string
|
||||||
|
f := Floor{Node: "ace", Bytes: 1, Free: func(p string) (uint64, error) { read = p; return 2, nil }}
|
||||||
|
if err := f.Check(filepath.Join(dir, "not", "made")); err != nil || read != dir {
|
||||||
|
t.Errorf("Check = %v, read %q, want nil and %q", err, read, dir)
|
||||||
|
}
|
||||||
|
f.Free = func(string) (uint64, error) { return 0, errors.New("statfs: boom") }
|
||||||
|
var ref *Refusal
|
||||||
|
if err := f.Check(dir); !errors.As(err, &ref) {
|
||||||
|
t.Errorf("Check = %v, want a refusal", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func makeWorkspace(t *testing.T, w *Workspaces, id string, age time.Duration) string {
|
||||||
|
t.Helper()
|
||||||
|
p := filepath.Join(w.Dir, id)
|
||||||
|
if err := os.MkdirAll(filepath.Join(p, "tree"), 0o700); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
at := time.Now().Add(-age)
|
||||||
|
if err := os.Chtimes(p, at, at); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
func gone(p string) bool { _, err := os.Stat(p); return os.IsNotExist(err) }
|
||||||
|
|
||||||
|
// 1839/AC2: a released workspace is gone at once; one already gone is no error; one a running step holds is refused
|
||||||
|
// and kept; an id that is not a workspace's is refused.
|
||||||
|
func TestReleaseRemovesAWorkspaceAtOnce(t *testing.T) {
|
||||||
|
w := &Workspaces{Dir: t.TempDir()}
|
||||||
|
p := makeWorkspace(t, w, "abc1", 0)
|
||||||
|
if err := w.Release("abc1"); err != nil || !gone(p) {
|
||||||
|
t.Fatalf("Release = %v, gone %v", err, gone(p))
|
||||||
|
}
|
||||||
|
if err := w.Release("abc1"); err != nil {
|
||||||
|
t.Errorf("a second release = %v, want nil", err)
|
||||||
|
}
|
||||||
|
held := makeWorkspace(t, w, "abc2", 0)
|
||||||
|
done := w.Hold("abc2")
|
||||||
|
if err := w.Release("abc2"); err == nil || gone(held) {
|
||||||
|
t.Errorf("Release of a held workspace = %v, gone %v; want refused and kept", err, gone(held))
|
||||||
|
}
|
||||||
|
done()
|
||||||
|
if err := w.Release("abc2"); err != nil || !gone(held) {
|
||||||
|
t.Errorf("Release after the hold ended = %v, gone %v", err, gone(held))
|
||||||
|
}
|
||||||
|
if err := w.Release("../etc"); err == nil {
|
||||||
|
t.Errorf("Release of ../etc answered nil")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1839/AC3: the sweep removes a workspace no step holds whose last use is past the bound, and keeps a held one and a
|
||||||
|
// recent one; a hold ending counts as a use.
|
||||||
|
func TestSweepRemovesUnheldWorkspacesPastTheBound(t *testing.T) {
|
||||||
|
w := &Workspaces{Dir: t.TempDir()}
|
||||||
|
old := makeWorkspace(t, w, "old1", 3*time.Hour)
|
||||||
|
heldOld := makeWorkspace(t, w, "held1", 3*time.Hour)
|
||||||
|
recent := makeWorkspace(t, w, "new1", time.Minute)
|
||||||
|
if err := os.WriteFile(filepath.Join(w.Dir, "not-a-workspace.txt"), nil, 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
done := w.Hold("held1")
|
||||||
|
removed := w.Sweep(time.Now(), 2*time.Hour)
|
||||||
|
if !gone(old) || gone(heldOld) || gone(recent) {
|
||||||
|
t.Errorf("after the sweep: old gone %v, held kept %v, recent kept %v", gone(old), !gone(heldOld), !gone(recent))
|
||||||
|
}
|
||||||
|
if len(removed) != 1 || removed[0] != "old1" {
|
||||||
|
t.Errorf("Sweep answered %v, want [old1]", removed)
|
||||||
|
}
|
||||||
|
done()
|
||||||
|
if w.Sweep(time.Now(), 2*time.Hour); gone(heldOld) {
|
||||||
|
t.Errorf("a workspace whose hold just ended was swept: its end is a use")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -9,7 +9,26 @@ package catalogue
|
|||||||
// DeliverySeat is the seat mesh-delivery holds.
|
// DeliverySeat is the seat mesh-delivery holds.
|
||||||
const DeliverySeat = "mesh-delivery"
|
const DeliverySeat = "mesh-delivery"
|
||||||
|
|
||||||
// deliveryVerbs are the delivery seat's tools: six that read, and the acts of a person, a reviewer and healer H2.
|
// RemovedDeliveryVerbs are the delivery seat's verbs release 6 removed (novox/hq ADR 0539 clause 17): with no plan the
|
||||||
|
// gate keeps the merge's states and derives nothing after the merge. Each stays in deliveryVerbs as an optional row
|
||||||
|
// with no input, so the holder of before and the holder of release 6 both hold the seat and a caller is answered by
|
||||||
|
// name with its replacement, given here.
|
||||||
|
var RemovedDeliveryVerbs = map[string]string{
|
||||||
|
"times": "the delivery view (nox-delivery): each machine's want and have, and since when",
|
||||||
|
"what-if": "the merge check's composition, which composes every machine a change touches",
|
||||||
|
"release": "the assigner's asks (hold, restore, backup, record), answered on the phone or in the delivery view",
|
||||||
|
"stop": "a bad fingerprint is held and its canary set back by the assigner (ADR 0429 §6, ADR 0539 clause 18)",
|
||||||
|
"retire-history": "nothing to retire: the gate keeps no delivery after its merge",
|
||||||
|
}
|
||||||
|
|
||||||
|
// deliveryRemovedInR6 is the row of a verb release 6 removed from the delivery seat.
|
||||||
|
func deliveryRemovedInR6(name string) Verb {
|
||||||
|
return Verb{Name: name, Description: "Removed in R6 (ADR 0539): refused by name, naming its replacement: " +
|
||||||
|
RemovedDeliveryVerbs[name], Input: schema(nil, nil), Optional: true}
|
||||||
|
}
|
||||||
|
|
||||||
|
// deliveryVerbs are the delivery seat's tools: what reads the merges and checks, and the acts of a person and healer H2
|
||||||
|
// on a merge (ADR 0539 clause 17).
|
||||||
func deliveryVerbs() []Verb {
|
func deliveryVerbs() []Verb {
|
||||||
return []Verb{
|
return []Verb{
|
||||||
{Name: "deliveries", Description: "Every delivery not final, and those that ended in the last day, one line " +
|
{Name: "deliveries", Description: "Every delivery not final, and those that ended in the last day, one line " +
|
||||||
@@ -18,15 +37,7 @@ func deliveryVerbs() []Verb {
|
|||||||
Input: schema(map[string]string{"state": "one state, e.g. delivering or held",
|
Input: schema(map[string]string{"state": "one state, e.g. delivering or held",
|
||||||
"repository": "owner/repository", "group": "a group's id (its branch name)",
|
"repository": "owner/repository", "group": "a group's id (its branch name)",
|
||||||
"all": "\"true\": the final ones of the last thirty days too"}, nil, "all")},
|
"all": "\"true\": the final ones of the last thirty days too"}, nil, "all")},
|
||||||
// Delivery time against the delivery budgets (novox/hq ADR 0282): what probe D16 reads, optional until its
|
deliveryRemovedInR6("times"),
|
||||||
// holder serves it.
|
|
||||||
{Name: "times", Description: "Delivery time: from a merge to every machine of its walk running the build. " +
|
|
||||||
"Each class's delivery budget (a leaf module three minutes, a core module ten), the last days' median and " +
|
|
||||||
"worst, how many within and over, the newest delivery of each class, every delivery over its budget with its " +
|
|
||||||
"longest phase, and the delivered ones whose time is not known. Given a delivery's id, its time phase by phase.",
|
|
||||||
Input: schema(map[string]string{"days": "how many days back (default 7)", "id": "one delivery's id: its phases"}, nil),
|
|
||||||
// Optional until mesh-delivery serves it: its holder lives in the catalogue (design 33 §7).
|
|
||||||
Optional: true},
|
|
||||||
{Name: "show", Description: "One delivery or group whole: its delivery plan (what it builds, what each " +
|
{Name: "show", Description: "One delivery or group whole: its delivery plan (what it builds, what each " +
|
||||||
"machine receives, what is not an ordinary send), every transition with when and why, the machine " +
|
"machine receives, what is not an ordinary send), every transition with when and why, the machine " +
|
||||||
"steps of its walk, its group and its order.",
|
"steps of its walk, its group and its order.",
|
||||||
@@ -35,12 +46,7 @@ func deliveryVerbs() []Verb {
|
|||||||
"(declared, built by, version skew, engine before controller, by name), its composed check and its " +
|
"(declared, built by, version skew, engine before controller, by name), its composed check and its " +
|
||||||
"state, derived from its members.",
|
"state, derived from its members.",
|
||||||
Input: schema(map[string]string{"all": "\"true\": the groups that ended too"}, nil, "all")},
|
Input: schema(map[string]string{"all": "\"true\": the groups that ended too"}, nil, "all")},
|
||||||
{Name: "what-if", Description: "The delivery plan a change would have, asked of the controller's planner " +
|
deliveryRemovedInR6("what-if"),
|
||||||
"and kept nowhere: the modules it moves and their dependents in tiers, what each machine would receive, " +
|
|
||||||
"the steps that are not an ordinary send.",
|
|
||||||
Input: schema(map[string]string{"repository": "owner/repository",
|
|
||||||
"paths": "the files it changes, comma-separated, from the repository's root",
|
|
||||||
"base": "the branch it merges into (default main)"}, []string{"repository", "paths"})},
|
|
||||||
{Name: "checks", Description: "What the mesh's checks said of a pull request's head or of one commit: each " +
|
{Name: "checks", Description: "What the mesh's checks said of a pull request's head or of one commit: each " +
|
||||||
"of the commit's mesh statuses (mesh/check, the one a main requires from R4e, hq's mesh/repo-check, " +
|
"of the commit's mesh statuses (mesh/check, the one a main requires from R4e, hq's mesh/repo-check, " +
|
||||||
"mesh/delivery, …) with its state, " +
|
"mesh/delivery, …) with its state, " +
|
||||||
@@ -62,40 +68,13 @@ func deliveryVerbs() []Verb {
|
|||||||
"controller is asked for its check. With why.",
|
"controller is asked for its check. With why.",
|
||||||
Input: schema(map[string]string{"id": "the delivery's id", "why": "why, kept with the transition"},
|
Input: schema(map[string]string{"id": "the delivery's id", "why": "why, kept with the transition"},
|
||||||
[]string{"id", "why"})},
|
[]string{"id", "why"})},
|
||||||
{Name: "release", Description: "A person's word that a held delivery goes on: it starts delivering. With why.",
|
deliveryRemovedInR6("release"),
|
||||||
Input: schema(map[string]string{"id": "the delivery's id", "why": "why, kept with the transition"},
|
deliveryRemovedInR6("stop"),
|
||||||
[]string{"id", "why"})},
|
|
||||||
{Name: "stop", Description: "Stop a delivery that is not final, with why; its walk is ended through the " +
|
|
||||||
"controller, and in a group every member after it is stopped too, naming it.",
|
|
||||||
Input: schema(map[string]string{"id": "the delivery's id", "why": "why, kept with the transition"},
|
|
||||||
[]string{"id", "why"})},
|
|
||||||
{Name: "close", Description: "Healer H2's verb: take the one transition the table names for a delivery held " +
|
{Name: "close", Description: "Healer H2's verb: take the one transition the table names for a delivery held " +
|
||||||
"past its bound. Refused for any other.",
|
"past its bound. Refused for any other.",
|
||||||
Input: schema(map[string]string{"id": "the delivery's id", "why": "the condition it answers"},
|
Input: schema(map[string]string{"id": "the delivery's id", "why": "the condition it answers"},
|
||||||
[]string{"id", "why"})},
|
[]string{"id", "why"})},
|
||||||
{Name: "retire-history", Description: "Retire held deliveries that are history, on a person's word, with " +
|
deliveryRemovedInR6("retire-history"),
|
||||||
"why: each made from the forge's word for a merge on the trunk heard long after it happened — replayed " +
|
|
||||||
"when the holder first held the seat — with no walk of it open. Never released, delivered or put back: " +
|
|
||||||
"retired, final. One by id, refused when the rule does not take it; or every held one, of one " +
|
|
||||||
"repository when named, answering how many it retired and naming those it left held. dry \"true\" " +
|
|
||||||
"answers what it would do and changes nothing.",
|
|
||||||
Input: schema(map[string]string{"why": "why, kept with every transition",
|
|
||||||
"id": "one delivery's id; every held one when empty",
|
|
||||||
"repository": "owner/repository: only its held deliveries",
|
|
||||||
"dry": "\"true\": what it would retire, changing nothing"}, []string{"why"}, "dry"),
|
|
||||||
// Added after the seat's holder shipped (novox/hq issue 313): optional until mesh-delivery serves it.
|
|
||||||
Optional: true},
|
|
||||||
{Name: "mark-ready", Description: "A reviewer's word that a delivery's head is approved: the holder puts the " +
|
|
||||||
"label mesh/ready on its pull request and then writes \"ready at <head>\", the order the forge counts, " +
|
|
||||||
"as the mesh's own forge account, naming who reviewed it and why. Refused when the delivery's commit is " +
|
|
||||||
"no longer its pull request's head. mesh-delivery then merges it once its checks pass (novox/hq ADR 0364).",
|
|
||||||
Input: schema(map[string]string{"id": "the delivery's id (owner/repository@commit): the head reviewed",
|
|
||||||
"reviewed-by": "who reviewed it, as who@node", "why": "the review's verdict in a line"},
|
|
||||||
[]string{"id", "reviewed-by", "why"}),
|
|
||||||
// Kept one more release, optional (novox/hq issue 1022): mesh-delivery no longer serves it, but the manifest
|
|
||||||
// it still has on the mesh does until its catalogue member merges, and a seat refuses a holder that serves
|
|
||||||
// a verb it does not promise. The next release removes this entry.
|
|
||||||
Optional: true},
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -58,107 +58,3 @@ func TestTheDeliverySeatPromisesChecks(t *testing.T) {
|
|||||||
t.Fatalf("a holder without %s: %v", before[0], err)
|
t.Fatalf("a holder without %s: %v", before[0], err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// The seat retires history on a person's word (novox/hq issue 313): `retire-history`, with why, one delivery by
|
|
||||||
// id or every held one, dry to see first. Added after the holder shipped, it is optional, so the holder that
|
|
||||||
// does not serve it yet still holds the seat, and one that does is not refused for a verb the seat lacks.
|
|
||||||
func TestTheDeliverySeatPromisesRetireHistoryOptionally(t *testing.T) {
|
|
||||||
seat, _ := SeatNamed(DeliverySeat)
|
|
||||||
var retire *Verb
|
|
||||||
for i := range seat.Serves {
|
|
||||||
if seat.Serves[i].Name == "retire-history" {
|
|
||||||
retire = &seat.Serves[i]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if retire == nil || !retire.Optional {
|
|
||||||
t.Fatalf("the delivery seat promises %v, retire-history optionally", VerbNames(seat.Serves))
|
|
||||||
}
|
|
||||||
props, _ := retire.Input["properties"].(map[string]any)
|
|
||||||
for _, arg := range []string{"why", "id", "repository", "dry"} {
|
|
||||||
if _, has := props[arg]; !has {
|
|
||||||
t.Errorf("retire-history takes no %q", arg)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if req, _ := retire.Input["required"].([]string); !reflect.DeepEqual(req, []string{"why"}) {
|
|
||||||
t.Errorf("retire-history requires %v, wanted only why", req)
|
|
||||||
}
|
|
||||||
var without []string
|
|
||||||
for _, v := range VerbNames(seat.Serves) {
|
|
||||||
if v != "retire-history" {
|
|
||||||
without = append(without, v)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
m := Manifest{Module: "mesh-delivery", Claims: []Claim{{Name: DeliverySeat, Scope: ScopeMesh, Serves: without}}}
|
|
||||||
if err := CanHold(m, seat); err != nil {
|
|
||||||
t.Fatalf("a holder without retire-history yet: %v", err)
|
|
||||||
}
|
|
||||||
m.Claims[0].Serves = VerbNames(seat.Serves)
|
|
||||||
if err := CanHold(m, seat); err != nil {
|
|
||||||
t.Fatalf("a holder serving retire-history: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// The seat says delivery times (novox/hq ADR 0282, issue 382): `times`, over some days or for one delivery. Added
|
|
||||||
// after the holder shipped, it is optional, so the holder that does not serve it yet still holds the seat, and one
|
|
||||||
// that does is not refused for a verb the seat lacks.
|
|
||||||
func TestTheDeliverySeatPromisesTimesOptionally(t *testing.T) {
|
|
||||||
seat, _ := SeatNamed(DeliverySeat)
|
|
||||||
var times *Verb
|
|
||||||
for i := range seat.Serves {
|
|
||||||
if seat.Serves[i].Name == "times" {
|
|
||||||
times = &seat.Serves[i]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if times == nil || !times.Optional {
|
|
||||||
t.Fatalf("the delivery seat promises %v, times optionally", VerbNames(seat.Serves))
|
|
||||||
}
|
|
||||||
props, _ := times.Input["properties"].(map[string]any)
|
|
||||||
for _, arg := range []string{"days", "id"} {
|
|
||||||
if _, has := props[arg]; !has {
|
|
||||||
t.Errorf("times takes no %q", arg)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
var without []string
|
|
||||||
for _, v := range VerbNames(seat.Serves) {
|
|
||||||
if v != "times" {
|
|
||||||
without = append(without, v)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
m := Manifest{Module: "mesh-delivery", Claims: []Claim{{Name: DeliverySeat, Scope: ScopeMesh, Serves: without}}}
|
|
||||||
if err := CanHold(m, seat); err != nil {
|
|
||||||
t.Fatalf("a holder without times yet: %v", err)
|
|
||||||
}
|
|
||||||
m.Claims[0].Serves = VerbNames(seat.Serves)
|
|
||||||
if err := CanHold(m, seat); err != nil {
|
|
||||||
t.Fatalf("a holder serving times: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// The seat still promises `mark-ready`, optionally, for one more release (issue 1022); it was added by novox/hq issue 913: `mark-ready`, with the delivery's id, who reviewed it
|
|
||||||
// and why, so a reviewer marks a pull request through one audited verb, label and comment in the order the forge
|
|
||||||
// counts, instead of two raw forge calls. Added after the holder shipped, it is optional.
|
|
||||||
func TestTheDeliverySeatPromisesMarkReadyOptionally(t *testing.T) {
|
|
||||||
seat, _ := SeatNamed(DeliverySeat)
|
|
||||||
var mark *Verb
|
|
||||||
for i := range seat.Serves {
|
|
||||||
if seat.Serves[i].Name == "mark-ready" {
|
|
||||||
mark = &seat.Serves[i]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if mark == nil || !mark.Optional {
|
|
||||||
t.Fatalf("the delivery seat promises %v, mark-ready optionally", VerbNames(seat.Serves))
|
|
||||||
}
|
|
||||||
if req, _ := mark.Input["required"].([]string); !reflect.DeepEqual(req, []string{"id", "reviewed-by", "why"}) {
|
|
||||||
t.Errorf("mark-ready requires %v, wanted id, reviewed-by and why", req)
|
|
||||||
}
|
|
||||||
var without []string
|
|
||||||
for _, v := range VerbNames(seat.Serves) {
|
|
||||||
if v != "mark-ready" {
|
|
||||||
without = append(without, v)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
m := Manifest{Module: "mesh-delivery", Claims: []Claim{{Name: DeliverySeat, Scope: ScopeMesh, Serves: without}}}
|
|
||||||
if err := CanHold(m, seat); err != nil {
|
|
||||||
t.Fatalf("a holder without mark-ready yet: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -170,10 +170,10 @@ func TestAMembershipForTheNewBusIsComposedAsASealedFile(t *testing.T) {
|
|||||||
func TestAStoreRowWithoutAProtocolKeepsTheCompiledOne(t *testing.T) {
|
func TestAStoreRowWithoutAProtocolKeepsTheCompiledOne(t *testing.T) {
|
||||||
was := Seats()
|
was := Seats()
|
||||||
t.Cleanup(func() { UseSeats(was) })
|
t.Cleanup(func() { UseSeats(was) })
|
||||||
UseSeats([]Seat{{Name: "mesh-build-machine", Scope: ScopeMesh, Decision: "row"}})
|
UseSeats([]Seat{{Name: "node-build-go", Scope: ScopeNode, Decision: "row"}})
|
||||||
got, ok := SeatNamed("mesh-build-machine")
|
got, ok := SeatNamed("node-build-go")
|
||||||
if !ok || len(got.Accepts) == 0 {
|
if !ok || len(got.Accepts) == 0 || !got.PulledByKind {
|
||||||
t.Fatalf("the build machine's seat lost what it accepts when loaded from the store: %+v", got)
|
t.Fatalf("the Go build seat lost what it accepts when loaded from the store: %+v", got)
|
||||||
}
|
}
|
||||||
if got.Decision != "row" {
|
if got.Decision != "row" {
|
||||||
t.Fatalf("the store's own columns were not kept: %+v", got)
|
t.Fatalf("the store's own columns were not kept: %+v", got)
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
These tests read files outside this directory (the repository's root files or other directories): mesh-build-go never keeps this package's verdict (issue 1935).
|
||||||
+50
-41
@@ -45,6 +45,10 @@ type Seat struct {
|
|||||||
// today — which the bus refuses, because a namespace belongs to who it is named for.
|
// today — which the bus refuses, because a namespace belongs to who it is named for.
|
||||||
Accepts []string
|
Accepts []string
|
||||||
Emits []string
|
Emits []string
|
||||||
|
// PulledByKind says each accepted kind is a worker of its own on the seat's stream, which its holders pull in the
|
||||||
|
// order Accepts lists them (novox/hq ADR 0525 §2, ADR 0536 §4): the build seats'. Compiled, never stored, like
|
||||||
|
// Receives.
|
||||||
|
PulledByKind bool
|
||||||
// Serves carries each verb in full — name, description, schema — because a role's tools are the
|
// Serves carries each verb in full — name, description, schema — because a role's tools are the
|
||||||
// mesh's to define and an agent's to call (novox/hq ADR 0132, design 33 §2).
|
// mesh's to define and an agent's to call (novox/hq ADR 0132, design 33 §2).
|
||||||
Serves []Verb
|
Serves []Verb
|
||||||
@@ -106,12 +110,18 @@ var defaultSeats = append([]Seat{
|
|||||||
"rolled-back",
|
"rolled-back",
|
||||||
// A pull request's merge check, judged (novox/hq to-be 45 §9).
|
// A pull request's merge check, judged (novox/hq to-be 45 §9).
|
||||||
"checked",
|
"checked",
|
||||||
// A walk kept in a new state, for the delivery it walks (novox/hq ADR 0239).
|
// A walk kept in a new state, and a tier sent to a machine: kept until the catalogue's main consumes them no
|
||||||
|
// more; nothing emits them (ADR 0539).
|
||||||
"plan-moved",
|
"plan-moved",
|
||||||
// A tier sent to a machine, once the send is kept (novox/hq ADR 0406 §5, issue 974).
|
|
||||||
"sent",
|
"sent",
|
||||||
// A key of a record mirror written or removed (novox/hq ADR 0289, design 54 §3; design 57 F3).
|
// A key of a record mirror written or removed (novox/hq ADR 0289, design 54 §3; design 57 F3).
|
||||||
"assignment-changed", "declared-config-changed", "predefined-changed"},
|
"assignment-changed", "declared-config-changed", "predefined-changed",
|
||||||
|
// A builder's key not taken in because the artifact store does not hold an artifact it names (novox/hq
|
||||||
|
// issue 1937): the builder builds it again.
|
||||||
|
"artifacts-gone",
|
||||||
|
// A bucket of a state this release deleted, deleted at the controller's first start (novox/hq ADR 0539
|
||||||
|
// clause 13): the merge window's, the silent sends' and the building plans' hold, each said once.
|
||||||
|
"bucket-deleted"},
|
||||||
Serves: ControllerVerbs},
|
Serves: ControllerVerbs},
|
||||||
// The store's first verbs (novox/hq ADR 0159): the smallest set that makes the store askable,
|
// The store's first verbs (novox/hq ADR 0159): the smallest set that makes the store askable,
|
||||||
// served by whichever module holds the seat with tools of these names.
|
// served by whichever module holds the seat with tools of these names.
|
||||||
@@ -238,31 +248,19 @@ var defaultSeats = append([]Seat{
|
|||||||
// They keep their names until that migration is done deliberately, apart from the node-* pass.
|
// They keep their names until that migration is done deliberately, apart from the node-* pass.
|
||||||
{Name: "npm-package-registry", Scope: ScopeMesh, Delivers: "npm-package-registry", Decision: "novox/hq ADR 0109"},
|
{Name: "npm-package-registry", Scope: ScopeMesh, Delivers: "npm-package-registry", Decision: "novox/hq ADR 0109"},
|
||||||
{Name: "git", Scope: ScopeMesh, Delivers: "git", Decision: "novox/hq ADR 0111"},
|
{Name: "git", Scope: ScopeMesh, Delivers: "git", Decision: "novox/hq ADR 0111"},
|
||||||
// A build is work submitted to this role and its outcome is the role's own event (ADR 0129).
|
// **A build node's work, one seat per build language** (novox/hq ADR 0525 §2, §10; ADR 0536 §4; issue 1887). The
|
||||||
// One publish reaches whoever asked, the controller that records it, and the catalogue that
|
// build module of each language claims its seat on every node it runs on; the builder and the checker put their
|
||||||
// places it in the graph — what the old bus's shared exchange did for free.
|
// asks on the seat's accepted kinds, which the broker derives as one work queue with a shared worker per kind, and
|
||||||
// A build says what it does as it does it (novox/hq ADR 0157): `started` when work is taken,
|
// each holder pulls delivery first, then check, then recheck, at most its node's build capacity at once. Its verbs
|
||||||
// `log.<build id>` for every line, `built` for the outcome. The log's tail token is the build's
|
// say what the node runs and pause or resume it there: every holder pulls from the same worker, so a node's pause is
|
||||||
// id, so a reader follows one build by subject alone.
|
// its holder taking nothing, kept on the module's own pause key (issue 1887's design limit 2). They replace
|
||||||
// **Node-scoped, and every holder takes from one queue** (novox/hq ADR 0190): a build is asked of
|
// node-build-agent, retired with build-agent (ADR 0524 §5).
|
||||||
// the role, and whichever machine holding the seat is idle pulls it. One holder per machine is
|
{Name: "node-build-go", Scope: ScopeNode, Accepts: buildAskKinds(), PulledByKind: true, Serves: buildSeatVerbs("Go"),
|
||||||
// what the scope says; sharing the work is what a seat's queue has always done.
|
Decision: "novox/hq ADR 0525, ADR 0536"},
|
||||||
//
|
{Name: "node-build-node", Scope: ScopeNode, Accepts: buildAskKinds(), PulledByKind: true, Serves: buildSeatVerbs("Node"),
|
||||||
// **And its holder answers for the build it is running** (novox/hq ADR 0219): what it is
|
Decision: "novox/hq ADR 0525, ADR 0536"},
|
||||||
// building, kill it, take nothing new, take again. The queue as a whole is the controller's to
|
{Name: "node-build-image", Scope: ScopeNode, Accepts: buildAskKinds(), PulledByKind: true, Serves: buildSeatVerbs("image"),
|
||||||
// show and change (`queue`, `cancel`, `clear`); what one machine does with an ask it already
|
Decision: "novox/hq ADR 0525, ADR 0536"},
|
||||||
// took only that machine can do. `paused.<node>` is each holder saying whether it takes work, so
|
|
||||||
// the controller can tell a plan waiting on a paused seat from one that is late.
|
|
||||||
{Name: "node-build-agent", Scope: ScopeNode,
|
|
||||||
Accepts: []string{"build"}, Emits: []string{"started", "built", "log.*", "paused.*"},
|
|
||||||
Serves: buildAgentVerbs(),
|
|
||||||
Decision: "novox/hq ADR 0190, ADR 0219"},
|
|
||||||
// **Retired by ADR 0190, kept while a manifest still claims it.** The one build machine's seat.
|
|
||||||
// A claim to a seat the mesh no longer defines is refused, and the module holding this one is
|
|
||||||
// assigned on a live machine until build-agent replaces it — removing the row first would make
|
|
||||||
// that machine unresolvable in the meantime. Deleted once no registered manifest claims it.
|
|
||||||
{Name: "mesh-build-machine", Scope: ScopeMesh,
|
|
||||||
Accepts: []string{"build"}, Emits: []string{"started", "built", "log.*"}, Decision: "novox/hq ADR 0190"},
|
|
||||||
// **The mesh's resolvers** (novox/hq ADR 0194, 0196, 0223): every node's internal domain, and
|
// **The mesh's resolvers** (novox/hq ADR 0194, 0196, 0223): every node's internal domain, and
|
||||||
// every node and container asks them and nothing else. Replicated since ADR 0223: held on more
|
// every node and container asks them and nothing else. Replicated since ADR 0223: held on more
|
||||||
// than one machine, each answering the same names from the same roster, and every machine's
|
// than one machine, each answering the same names from the same roster, and every machine's
|
||||||
@@ -498,6 +496,7 @@ func UseSeats(s []Seat) {
|
|||||||
row.Receives = d.Receives
|
row.Receives = d.Receives
|
||||||
row.Paths = d.Paths
|
row.Paths = d.Paths
|
||||||
row.Replicated = d.Replicated
|
row.Replicated = d.Replicated
|
||||||
|
row.PulledByKind = d.PulledByKind
|
||||||
row.Serves = optionalAsCompiled(row.Serves, d.Serves)
|
row.Serves = optionalAsCompiled(row.Serves, d.Serves)
|
||||||
}
|
}
|
||||||
merged = append(merged, row)
|
merged = append(merged, row)
|
||||||
@@ -623,6 +622,10 @@ func claimProblems(m Manifest) []string {
|
|||||||
// after UseSeats has replaced the set with the store's.
|
// after UseSeats has replaced the set with the store's.
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
if replaced, retired := RetiredSeats[c.Name]; retired {
|
||||||
|
problems = append(problems, fmt.Sprintf("%s claims the seat %q, which is retired: its work is %s", m.Module, c.Name, replaced))
|
||||||
|
continue
|
||||||
|
}
|
||||||
if isSystemSeatName(c.Name) {
|
if isSystemSeatName(c.Name) {
|
||||||
problems = append(problems, fmt.Sprintf(
|
problems = append(problems, fmt.Sprintf(
|
||||||
"%s claims %q, which is a seat in the mesh's own namespace (mesh-*/node-*) that it "+
|
"%s claims %q, which is a seat in the mesh's own namespace (mesh-*/node-*) that it "+
|
||||||
@@ -903,22 +906,28 @@ func loginShellVerbs() []Verb {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// buildAgentVerbs are what a holder of node-build-agent answers on its own machine (novox/hq ADR
|
// buildAskKinds are a build seat's accepted kinds, in the order a holder pulls them (ADR 0536 §4; mesh-sdk
|
||||||
// 0219). One build at a time per holder (ADR 0190), so "the build running here" is one or none.
|
// delivery.AskKinds).
|
||||||
func buildAgentVerbs() []Verb {
|
func buildAskKinds() []string { return []string{"delivery", "check", "recheck"} }
|
||||||
|
|
||||||
|
// RetiredSeats are seats the mesh no longer defines, each with what replaced it: a claim or a use of one is refused
|
||||||
|
// naming its replacement, not as a seat nobody declares.
|
||||||
|
var RetiredSeats = map[string]string{
|
||||||
|
"node-build-agent": "node-build-go, node-build-node and node-build-image, held by the build modules (novox/hq ADR 0525 §10)",
|
||||||
|
"mesh-build-machine": "node-build-go, node-build-node and node-build-image, held by the build modules (novox/hq ADR 0190, ADR 0525 §10)",
|
||||||
|
}
|
||||||
|
|
||||||
|
// buildSeatVerbs are what a build module answers on its own node for its seat (ADR 0525 §10).
|
||||||
|
func buildSeatVerbs(language string) []Verb {
|
||||||
return []Verb{
|
return []Verb{
|
||||||
{Name: "current", Description: "The build this machine is running — its id, repository, path, " +
|
{Name: "current", Description: "The " + language + " asks this node runs now (each ask's id, kind, module and when it " +
|
||||||
"the step it is at, when it started and for how long — or none; and whether this machine is " +
|
"started), its build capacity, and whether it is paused, taking no new ask.",
|
||||||
"paused, taking no new build.",
|
|
||||||
Input: schema(map[string]string{}, nil)},
|
Input: schema(map[string]string{}, nil)},
|
||||||
{Name: "kill", Description: "End the build with this id, running here: its commands and the " +
|
{Name: "pause", Description: "Take no new " + language + " ask on this node until resumed; an ask running here " +
|
||||||
"containers it started are stopped, and its outcome is announced as failed, killed by hand — " +
|
"ends in its place. Kept across a restart of the build module (its pause key). A capacity of 0 is the " +
|
||||||
"settled, so it is not handed to another machine.",
|
"lasting way to keep a node from building.",
|
||||||
Input: schema(map[string]string{"id": "the build's id, as `queue` or `current` says it"}, []string{"id"})},
|
|
||||||
{Name: "pause", Description: "Take no new build on this machine until resumed; a build running " +
|
|
||||||
"here finishes. Kept across a restart of the holder.",
|
|
||||||
Input: schema(map[string]string{}, nil)},
|
Input: schema(map[string]string{}, nil)},
|
||||||
{Name: "resume", Description: "Take builds again on this machine.",
|
{Name: "resume", Description: "Take " + language + " asks again on this node.",
|
||||||
Input: schema(map[string]string{}, nil)},
|
Input: schema(map[string]string{}, nil)},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -364,6 +364,10 @@ func CatalogueProblems(shelf Shelf) []string {
|
|||||||
// A `uses` naming nothing is where ADR 0110's guarantee lands under a derived set: the
|
// A `uses` naming nothing is where ADR 0110's guarantee lands under a derived set: the
|
||||||
// same refusal, at the same moment, from a set nobody maintains by hand.
|
// same refusal, at the same moment, from a set nobody maintains by hand.
|
||||||
for _, u := range m.Uses {
|
for _, u := range m.Uses {
|
||||||
|
if replaced, retired := RetiredSeats[u]; retired && !exists(u) {
|
||||||
|
problems = append(problems, fmt.Sprintf("%s uses the seat %q, which is retired: its work is %s", module, u, replaced))
|
||||||
|
continue
|
||||||
|
}
|
||||||
if !exists(u) {
|
if !exists(u) {
|
||||||
problems = append(problems, fmt.Sprintf(
|
problems = append(problems, fmt.Sprintf(
|
||||||
"%s uses the seat %q, "+UndeclaredSeat,
|
"%s uses the seat %q, "+UndeclaredSeat,
|
||||||
@@ -372,6 +376,10 @@ func CatalogueProblems(shelf Shelf) []string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
for _, c := range m.Claims {
|
for _, c := range m.Claims {
|
||||||
|
if replaced, retired := RetiredSeats[c.Name]; retired && !exists(c.Name) {
|
||||||
|
problems = append(problems, fmt.Sprintf("%s claims the seat %q, which is retired: its work is %s", module, c.Name, replaced))
|
||||||
|
continue
|
||||||
|
}
|
||||||
if !exists(c.Name) {
|
if !exists(c.Name) {
|
||||||
problems = append(problems, fmt.Sprintf(
|
problems = append(problems, fmt.Sprintf(
|
||||||
"%s claims the seat %q, "+UndeclaredSeat,
|
"%s claims the seat %q, "+UndeclaredSeat,
|
||||||
|
|||||||
@@ -43,7 +43,8 @@ func TestTheSeatsAreAClosedSetAndEachNamesItsDecision(t *testing.T) {
|
|||||||
delivered[s.Delivers] = s.Name
|
delivered[s.Delivers] = s.Name
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// Forty-five with node-files (novox/hq ADR 0394); forty-four again once node-reads goes.
|
// Forty-six with the three build seats replacing node-build-agent and the retired mesh-build-machine (novox/hq
|
||||||
|
// ADR 0525 §2, §10); forty-five with node-files (novox/hq ADR 0394); forty-four again once node-reads goes.
|
||||||
// Forty-four with node-provisioner (novox/hq ADR 0349 clause 3); forty-three with mesh-provisioner (novox/hq ADR 0349 clause 3); forty-two with mesh-config (novox/hq ADR 0348 §9); forty-one with node-reads (novox/hq ADR 0310); forty with node-nfs-server and node-mounts (novox/hq ADR 0263); thirty-eight with node-resolver (novox/hq ADR 0247); thirty-seven with mesh-delivery (novox/hq ADR 0239); thirty-six since node-resolver-config retired
|
// Forty-four with node-provisioner (novox/hq ADR 0349 clause 3); forty-three with mesh-provisioner (novox/hq ADR 0349 clause 3); forty-two with mesh-config (novox/hq ADR 0348 §9); forty-one with node-reads (novox/hq ADR 0310); forty with node-nfs-server and node-mounts (novox/hq ADR 0263); thirty-eight with node-resolver (novox/hq ADR 0247); thirty-seven with mesh-delivery (novox/hq ADR 0239); thirty-six since node-resolver-config retired
|
||||||
// into node-uplink (novox/hq ADR 0223); thirty-seven
|
// into node-uplink (novox/hq ADR 0223); thirty-seven
|
||||||
// since the retired node-dns-resolver went (novox/hq ADR 0220); thirty-eight with
|
// since the retired node-dns-resolver went (novox/hq ADR 0220); thirty-eight with
|
||||||
@@ -55,8 +56,8 @@ func TestTheSeatsAreAClosedSetAndEachNamesItsDecision(t *testing.T) {
|
|||||||
// node-container-runtime (ADR 0207); nineteen with node-environment and node-login-shell (ADR 0203,
|
// node-container-runtime (ADR 0207); nineteen with node-environment and node-login-shell (ADR 0203,
|
||||||
// ADR 0204); seventeen with node-build-agent (ADR 0190). One fewer once the retired
|
// ADR 0204); seventeen with node-build-agent (ADR 0190). One fewer once the retired
|
||||||
// mesh-build-machine row goes, when no registered manifest claims it.
|
// mesh-build-machine row goes, when no registered manifest claims it.
|
||||||
if len(Seats()) != 45 {
|
if len(Seats()) != 46 {
|
||||||
t.Errorf("the mesh defines %d seats rather than 45; the set is closed, so a change here is "+
|
t.Errorf("the mesh defines %d seats rather than 46; the set is closed, so a change here is "+
|
||||||
"a decision (novox/hq ADR 0110): %s", len(Seats()), seatNames())
|
"a decision (novox/hq ADR 0110): %s", len(Seats()), seatNames())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -300,3 +301,35 @@ func TestAFormerNameResolvesAfterARename(t *testing.T) {
|
|||||||
t.Fatalf("the holder recorded under the former name was not matched: %+v found=%v", holder, found)
|
t.Fatalf("the holder recorded under the former name was not matched: %+v found=%v", holder, found)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 1887/A9a: the catalogue defines no seat node-build-agent, and a manifest claiming it is refused naming its
|
||||||
|
// replacement; the build modules' seats accept the three kinds in their pull order and serve current, pause, resume.
|
||||||
|
func TestNodeBuildAgentIsRetiredForTheBuildSeats(t *testing.T) {
|
||||||
|
for _, gone := range []string{"node-build-agent", "mesh-build-machine"} {
|
||||||
|
if _, ok := SeatNamed(gone); ok {
|
||||||
|
t.Errorf("the mesh still defines %s", gone)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_, err := ParseManifest([]byte(`{"module":"build-agent","version":"1","claims":[{"name":"node-build-agent","scope":"node"}]}`))
|
||||||
|
if err == nil || !strings.Contains(err.Error(), `"node-build-agent", which is retired`) || !strings.Contains(err.Error(), "node-build-go") {
|
||||||
|
t.Fatalf("the claim is not refused naming its replacement: %v", err)
|
||||||
|
}
|
||||||
|
// And over a catalogue whose store still holds no row for it, a use of it is refused the same way.
|
||||||
|
user := Manifest{Module: "watcher", Uses: []string{"node-build-agent"}}
|
||||||
|
if joined := strings.Join(CatalogueProblems(Shelf{user.Module: user}), "; "); !strings.Contains(joined, "which is retired: its work is node-build-go") {
|
||||||
|
t.Fatalf("a use is not refused naming the replacement: %s", joined)
|
||||||
|
}
|
||||||
|
for _, name := range []string{"node-build-go", "node-build-node", "node-build-image"} {
|
||||||
|
s, ok := SeatNamed(name)
|
||||||
|
if !ok || s.Scope != ScopeNode || !s.PulledByKind || strings.Join(s.Accepts, ",") != "delivery,check,recheck" {
|
||||||
|
t.Fatalf("%s = %+v", name, s)
|
||||||
|
}
|
||||||
|
var verbs []string
|
||||||
|
for _, v := range s.Serves {
|
||||||
|
verbs = append(verbs, v.Name)
|
||||||
|
}
|
||||||
|
if strings.Join(verbs, ",") != "current,pause,resume" {
|
||||||
|
t.Errorf("%s serves %v", name, verbs)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -11,7 +11,8 @@ import (
|
|||||||
|
|
||||||
// builderNode is a machine that can run a build module: the package manager and user namespaces it asks of
|
// builderNode is a machine that can run a build module: the package manager and user namespaces it asks of
|
||||||
// the machine, and the forge account (mesh-scope, provided by the forge) and the artifact store the build
|
// the machine, and the forge account (mesh-scope, provided by the forge) and the artifact store the build
|
||||||
// modules publish to (ADR 0513, provided by distribution) stood in for.
|
// modules publish to (ADR 0513, provided by distribution) stood in for, and node-tools, the tool runner they pull their
|
||||||
|
// asks through (mesh-catalog issue 1911; mesh-tools' module, not in the catalogue).
|
||||||
func builderNode() Node {
|
func builderNode() Node {
|
||||||
return Node{Name: "builder", Site: "house",
|
return Node{Name: "builder", Site: "house",
|
||||||
Capabilities: map[string]bool{"package-manager": true, "user-namespaces": true}}
|
Capabilities: map[string]bool{"package-manager": true, "user-namespaces": true}}
|
||||||
@@ -20,7 +21,7 @@ func builderNode() Node {
|
|||||||
func toolchainShelf(t *testing.T) map[string]Manifest {
|
func toolchainShelf(t *testing.T) map[string]Manifest {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
m := map[string]Manifest{
|
m := map[string]Manifest{
|
||||||
"forge": {Module: "forge", Version: "1", Provides: []Offer{{Name: "forge-account"}, {Name: "npm-package-registry"}, {Name: "artifact-store"}}},
|
"forge": {Module: "forge", Version: "1", Provides: []Offer{{Name: "forge-account"}, {Name: "npm-package-registry"}, {Name: "artifact-store"}, {Name: "node-tools"}}},
|
||||||
}
|
}
|
||||||
for _, name := range []string{"go", "nodejs", "mesh-build-go", "mesh-build-node", "dev-tools"} {
|
for _, name := range []string{"go", "nodejs", "mesh-build-go", "mesh-build-node", "dev-tools"} {
|
||||||
m[name] = catalogueManifest(t, name)
|
m[name] = catalogueManifest(t, name)
|
||||||
|
|||||||
+67
-139
@@ -74,6 +74,29 @@ func VerbNames(verbs []Verb) []string {
|
|||||||
return out
|
return out
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// RemovedControllerVerbs are the controller seat's verbs release 6 removed (novox/hq ADR 0539, ADR 0429 §8): no
|
||||||
|
// delivery plan, batch, tier or push exists, so nothing starts, stops, retries, follows or reads one. Each stays in
|
||||||
|
// ControllerVerbs as a row with no input, so a caller is answered by name with its replacement, given here.
|
||||||
|
var RemovedControllerVerbs = map[string]string{
|
||||||
|
"plans": "the delivery view (nox-delivery): each machine's want and have, read from the assigner's wants and the " +
|
||||||
|
"node-engine's haves",
|
||||||
|
"plan": "the node's compositions: mesh-controller_composed holds each module's digest and judgement per node, and " +
|
||||||
|
"mesh-hand-compose prints one module's composition for one node",
|
||||||
|
"push": "a want: the assigner writes want.<node>.<module> by its rules, and by hand the operator's credential writes " +
|
||||||
|
"it, naming a kept composition (ADR 0539 clause 10)",
|
||||||
|
"deliver": "nothing to start: a merged change reaches each machine by its want",
|
||||||
|
"delivery-stop": "a bad fingerprint is held and its canary set back by the assigner (ADR 0429 §6, ADR 0539 clause 18)",
|
||||||
|
"delivery-backups-again": "the assigner's backup ask, answered on the phone or in the delivery view (ADR 0539 clause 16)",
|
||||||
|
"delivery-walks": "the delivery view (nox-delivery) and the wants, haves and compositions on the bus",
|
||||||
|
"delivery-order": "no order to keep: each module reaches its machines by its own want, its providers first by rule 5",
|
||||||
|
}
|
||||||
|
|
||||||
|
// removedInR6 is the row of a verb release 6 removed from the controller's seat: no input, refused by name.
|
||||||
|
func removedInR6(name string) Verb {
|
||||||
|
return Verb{Name: name, Description: "Removed in R6 (ADR 0539): refused by name, naming its replacement: " +
|
||||||
|
RemovedControllerVerbs[name], Input: schema(nil, nil)}
|
||||||
|
}
|
||||||
|
|
||||||
// ControllerSeatName is the seat the control plane holds, whose tools are the mesh's own verbs.
|
// ControllerSeatName is the seat the control plane holds, whose tools are the mesh's own verbs.
|
||||||
const ControllerSeatName = "mesh-controller"
|
const ControllerSeatName = "mesh-controller"
|
||||||
|
|
||||||
@@ -115,87 +138,23 @@ var ControllerVerbs = []Verb{
|
|||||||
"log": "a build's id (as `builds` lists it): print what the build machine said, line by line",
|
"log": "a build's id (as `builds` lists it): print what the build machine said, line by line",
|
||||||
"limit": "how many builds to list (default 20); not with log",
|
"limit": "how many builds to list (default 20); not with log",
|
||||||
}, nil)},
|
}, nil)},
|
||||||
{Name: "plans", Description: "What the last merges produced and where each stands (novox/hq ADR 0162): " +
|
removedInR6("plans"),
|
||||||
"the tiers, the tier a plan is at, what it waits for and since when; one plan whole, given its id; " +
|
|
||||||
"or, given wait, one plan followed until it moves.",
|
|
||||||
Input: schema(map[string]string{
|
|
||||||
"id": "a plan's id (as `plans` lists them): that plan, tier by tier",
|
|
||||||
"wait": "a plan's id: wait until it moves, then answer it as data — the plan, and what ended the wait " +
|
|
||||||
"(moved, tier, done, or bound); ask again to follow it further (novox/hq issue 229)",
|
|
||||||
"until": "with wait: moved (any change, the default), tier (it reaches another tier) or done (it ends)",
|
|
||||||
"bound": "with wait: how long to wait at most, as 15s or seconds — 20s, the default, is the longest, " +
|
|
||||||
"inside what a call is answered within",
|
|
||||||
"stop": "a plan's id: stop it — what was asked still builds, nothing further is asked",
|
|
||||||
"close": "a plan's id: close a plan that will not move again, as failed by hand (novox/hq issue 254)",
|
|
||||||
"retry": "a failed plan's id: ask its failed builds again under new ids, and carry the plan on from that tier (novox/hq ADR 0219)",
|
|
||||||
"go": "a walk's id that waits for its delivery's word: start it by hand, in place of mesh-delivery — with why, " +
|
|
||||||
"recorded in the hand-act log (novox/hq ADR 0239)",
|
|
||||||
"repository": "owner/repository: the plan a merge there would produce, saving nothing (what-if); with paths or modules",
|
|
||||||
"paths": "with repository: the files the merge would change, comma-separated, from the repository's root",
|
|
||||||
"modules": "with repository: or the modules it would change, comma-separated",
|
|
||||||
"module-dirs": "with repository and paths: the directories holding a module.json at the commit, comma-separated, " +
|
|
||||||
"as the forge's announcer says them (novox/hq issue 278); without it, a directory is a module only when the paths hold its manifest",
|
|
||||||
"data": "with repository and paths: true answers the change plan as data, the document delivery-plan answers " +
|
|
||||||
"(moved, dependents, new, tiers, machines with what each receives and waits for, steps, summary, class, head, base); " +
|
|
||||||
"without it the answer is text (novox/hq ADR 0450 §2)",
|
|
||||||
"head": "with data: the commit at hand",
|
|
||||||
"base": "with data: the branch it merges into (default main)",
|
|
||||||
"removed": "with data: the files among paths the change deletes, comma-separated",
|
|
||||||
"limit": "how many plans to list (default 10); only when listing",
|
|
||||||
"why": "with stop, close or go: why it is done by hand — required, and recorded in the hand-act log (novox/hq to-be 45 §7)",
|
|
||||||
"cause": "with stop, close or go: the cause in a word, or a condition's kind (optional)",
|
|
||||||
}, nil, "data")},
|
|
||||||
// The verbs the delivery's owner asks with (novox/hq ADR 0239): the planner's answer, a group's order and
|
// The verbs the delivery's owner asks with (novox/hq ADR 0239): the planner's answer, a group's order and
|
||||||
// composed check, and the start and end of a walk. Callable by a person too; mesh-delivery is who needs them.
|
// composed check, and the start and end of a walk. Callable by a person too; mesh-delivery is who needs them.
|
||||||
{Name: "delivery-plan", Description: "Removed in R4e (ADR 0501 §5 / ADR 0503 §3): refused by name, naming its replacement",
|
{Name: "delivery-plan", Description: "Removed in R4e (ADR 0501 §5 / ADR 0503 §3): refused by name, naming its replacement",
|
||||||
Input: schema(nil, nil)},
|
Input: schema(nil, nil)},
|
||||||
{Name: "delivery-order", Description: "A delivery group's order (novox/hq ADR 0419): its members in the order " +
|
removedInR6("delivery-order"),
|
||||||
"they are delivered, every pair and why — built by, verb before caller, version skew, engine before " +
|
|
||||||
"controller — read from the module graph and the manifests' change alone; no `after:` line is read. The " +
|
|
||||||
"cycle, with every module and edge of it, is the one refusal.",
|
|
||||||
Input: schema(map[string]string{"members": "the members, as JSON: [{id, repository, base, head, number, paths, " +
|
|
||||||
"module_dirs, module_dirs_said, removed}]"}, []string{"members"})},
|
|
||||||
{Name: "delivery-check", Description: "Answers that the checker (mesh-delivery-checker) judges a group (novox/hq " +
|
{Name: "delivery-check", Description: "Answers that the checker (mesh-delivery-checker) judges a group (novox/hq " +
|
||||||
"ADR 0503 §3); asks nothing. Its inputs stay, since hq's repository check still names it (ADR 0513 §4).",
|
"ADR 0503 §3); asks nothing. Its inputs stay, since hq's repository check still names it (ADR 0513 §4).",
|
||||||
Input: schema(map[string]string{"group": "the group's id (none for one head checked again)",
|
Input: schema(map[string]string{"group": "the group's id (none for one head checked again)",
|
||||||
"members": "the members, as JSON, as delivery-order takes them",
|
"members": "the members, as JSON, as delivery-order takes them",
|
||||||
"ready": "\"true\" when the pull request is marked ready: its check is queued before every other check (novox/hq ADR 0406 §3)"},
|
"ready": "\"true\" when the pull request is marked ready: its check is queued before every other check (novox/hq ADR 0406 §3)"},
|
||||||
[]string{"members"})},
|
[]string{"members"})},
|
||||||
{Name: "deliver", Description: "The delivery's word that a walk waiting for it may start (novox/hq ADR 0239): its " +
|
removedInR6("deliver"),
|
||||||
"first tier is asked at the controller's next pass. Refused for a walk that waits for nobody.",
|
removedInR6("delivery-stop"),
|
||||||
Input: schema(map[string]string{"plan": "the walk's id", "why": "what lets it go: its turn, a person's release"},
|
removedInR6("delivery-backups-again"),
|
||||||
[]string{"plan"})},
|
removedInR6("delivery-walks"),
|
||||||
{Name: "delivery-stop", Description: "End a walk on its delivery's word (novox/hq ADR 0239): failed, said as stopped " +
|
removedInR6("plan"),
|
||||||
"by whom and why; what it asked still builds and registers, nothing further is asked or sent. Given merges to " +
|
|
||||||
"leave out, every other merge the walk answered is walked again — in the open batch of its kind, or a new one — " +
|
|
||||||
"without them, without each later merge of their repository, which contains one, and without each merge moving " +
|
|
||||||
"a module one moves, each left out too and named (novox/hq ADR 0299); a batch not yet cut drops the merges. The " +
|
|
||||||
"answer names the batch, the merges walked again, the merges left out, the modules the stopped walk sent that " +
|
|
||||||
"stay on their machines, and the merges elsewhere that will still deliver a stopped change.",
|
|
||||||
Input: schema(map[string]string{"plan": "the walk's id", "why": "why", "by": "who stopped the delivery",
|
|
||||||
"without": "merges to leave out, <repository>@<commit>, comma-separated"},
|
|
||||||
[]string{"plan", "why"})},
|
|
||||||
{Name: "delivery-backups-again", Description: "Ask again the backups a walk was held for (novox/hq ADR 0404 " +
|
|
||||||
"decision 4): a walk whose backup before its send failed or did not answer is held, nothing asked or sent; this " +
|
|
||||||
"clears those failed backups and the next look at the plans asks them again, and only them. Refused for a walk " +
|
|
||||||
"with no failed backup. The delivery's release calls it. The answer names the walk and the backups asked again.",
|
|
||||||
Input: schema(map[string]string{"plan": "the held walk's id", "why": "a person's reason, as release passes it",
|
|
||||||
"by": "who released the delivery"}, []string{"plan", "why"})},
|
|
||||||
{Name: "delivery-walks", Description: "The walks the controller keeps (novox/hq ADR 0239): every open one and the " +
|
|
||||||
"last ended ones, each whole — its tiers, each module's state, first machines and first-node gate with its readings, and its " +
|
|
||||||
"phases from its merge to every machine running it (novox/hq ADR 0282) — and whether the delivery seat has a " +
|
|
||||||
"holder on record. Given a plan, that one.",
|
|
||||||
Input: schema(map[string]string{"plan": "one walk's id", "limit": "how many ended walks beside the open ones (default 50)"},
|
|
||||||
nil)},
|
|
||||||
{Name: "plan", Description: "What one machine would run, and why: the declaration the mesh would send it — " +
|
|
||||||
"or, with files, the files it would be given; or, with diff, what a push would change there against what " +
|
|
||||||
"it was last sent: resources added, removed and changed, a container's changed fields (it is recreated), " +
|
|
||||||
"and any mount whose directory on the machine would move (novox/hq ADR 0217).",
|
|
||||||
Input: schema(map[string]string{
|
|
||||||
"node": "the machine's name",
|
|
||||||
"files": "\"true\": the files this machine would be given, instead of the declaration as JSON",
|
|
||||||
"diff": "\"true\": what a push would change on this machine, against what it was last sent; not with files",
|
|
||||||
}, []string{"node"}, "files", "diff")},
|
|
||||||
{Name: "assign", Description: "Put a module on a machine. Refused with the mesh's own words when it cannot resolve there, " +
|
{Name: "assign", Description: "Put a module on a machine. Refused with the mesh's own words when it cannot resolve there, " +
|
||||||
"or when a seat its resources are applied through is held by nothing on the machine (novox/hq ADR 0207). " +
|
"or when a seat its resources are applied through is held by nothing on the machine (novox/hq ADR 0207). " +
|
||||||
"A module not registered yet is looked for (novox/hq issue 325, ADR 0261): while its build runs — a merge " +
|
"A module not registered yet is looked for (novox/hq issue 325, ADR 0261): while its build runs — a merge " +
|
||||||
@@ -221,22 +180,7 @@ var ControllerVerbs = []Verb{
|
|||||||
}, []string{"node", "provision", "from", "module"})},
|
}, []string{"node", "provision", "from", "module"})},
|
||||||
{Name: "unpin", Description: "Take that choice back, putting the question to the mesh again.",
|
{Name: "unpin", Description: "Take that choice back, putting the question to the mesh again.",
|
||||||
Input: schema(map[string]string{"node": "the machine's name", "provision": "the provision"}, []string{"node", "provision"})},
|
Input: schema(map[string]string{"node": "the machine's name", "provision": "the provision"}, []string{"node", "provision"})},
|
||||||
{Name: "push", Description: "Send one machine everything it should be. With no machine named it is a push of the " +
|
removedInR6("push"),
|
||||||
"WHOLE mesh — every machine that is behind — and the answer says so first; behind says that outright. " +
|
|
||||||
"Answers at once that it is running, with a call id: `calls` with that id says what it sent and, for a " +
|
|
||||||
"machine named, how that machine applied it — applied, refused with its reason, or each failed resource — " +
|
|
||||||
"once it reports within wait (a push can reload the bus, which then refuses any answer still to come). A push by hand is a repair, " +
|
|
||||||
"and says why: recorded in the hand-act log (novox/hq to-be 45 §7). A machine whose push would give a " +
|
|
||||||
"running module's data another directory is held and named, the others sent (novox/hq ADR 0217): read " +
|
|
||||||
"`plan` with diff, and name the machine with move to send it.",
|
|
||||||
Input: schema(map[string]string{
|
|
||||||
"node": "the machine's name; without it, every machine that is behind",
|
|
||||||
"move": "with node: the modules whose data may move with this push, comma-separated (optional)",
|
|
||||||
"wait": "with node: how long the call waits for the machine to report how it applied what it was sent, as \"90s\" or \"2m\"; \"0\" waits for nothing; without it, the controller's setting push-wait (optional)",
|
|
||||||
"behind": "\"true\": every machine that is behind, the whole mesh — the same as naming none, said outright; not with node",
|
|
||||||
"why": "why this is pushed by hand: recorded in the hand-act log",
|
|
||||||
"cause": "the cause in a word, or a condition's kind — the word a second push for the same reason uses (optional)",
|
|
||||||
}, []string{"why"}, "behind")},
|
|
||||||
{Name: "rotate", Description: "Replace a credential. A pair credential, by provision (and a consuming machine and module, " +
|
{Name: "rotate", Description: "Replace a credential. A pair credential, by provision (and a consuming machine and module, " +
|
||||||
"else every holder): both ends are re-sent together. Or a module's own secret, by machine, module and " +
|
"else every holder): both ends are re-sent together. Or a module's own secret, by machine, module and " +
|
||||||
"name: made anew and the machine sent, so the module starts again on it — for a secret its definition " +
|
"name: made anew and the machine sent, so the module starts again on it — for a secret its definition " +
|
||||||
@@ -350,36 +294,24 @@ var ControllerVerbs = []Verb{
|
|||||||
"its shell — `node show ace`, `module list`, `plans`, `conditions show <key>` — and answer what it " +
|
"its shell — `node show ace`, `module list`, `plans`, `conditions show <key>` — and answer what it " +
|
||||||
"printed. The generic verb beside the named ones (novox/hq ADR 0154), and since ADR 0266 it only reads: " +
|
"printed. The generic verb beside the named ones (novox/hq ADR 0154), and since ADR 0266 it only reads: " +
|
||||||
"status, version, help, seats, healers, hand-acts, durations, collection, images, artifacts, data, builds, " +
|
"status, version, help, seats, healers, hand-acts, durations, collection, images, artifacts, data, builds, " +
|
||||||
"queue, plan, plans (not stop/close/go), doctor (not run), conditions list/show/history, node list/show, " +
|
"plan, plans (not stop/close/go), doctor (not run), conditions list/show/history, node list/show, " +
|
||||||
"module list, settings show/preferences, retire list, cleanup list, delivery plan/walks, bus, mirrors (not " +
|
"module list, settings show/preferences, retire list, cleanup list, delivery plan/walks, bus, mirrors (not " +
|
||||||
"--record/--confirm). What writes has its named verb; what sets a key, issues a credential or a token, or " +
|
"--record/--confirm). What writes has its named verb; what sets a key, issues a credential or a token, or " +
|
||||||
"accepts, recovers or exports a secret is the controller's terminal's alone.",
|
"accepts, recovers or exports a secret is the controller's terminal's alone.",
|
||||||
Input: schema(map[string]string{
|
Input: schema(map[string]string{
|
||||||
"command": "the command line, as the controller's binary takes it; quotes group a word with spaces",
|
"command": "the command line, as the controller's binary takes it; quotes group a word with spaces",
|
||||||
}, []string{"command"})},
|
}, []string{"command"})},
|
||||||
// The build queue, controlled by hand (novox/hq ADR 0219). Every verb that drops an ask leaves a
|
// The build queue went with build-agent (novox/hq ADR 0525 §9): asks are the build seats' streams, their backlog the
|
||||||
// failed outcome for it, so a plan waiting on it fails visibly instead of hanging.
|
// streams' own state, shown in the delivery view. The verbs are refused by name for one release, naming that.
|
||||||
{Name: "queue", Description: "Every ask in the build queue: waiting, in flight (on which machine, for how long), " +
|
{Name: "queue", Description: "Removed in R4g (ADR 0525 §9): refused by name, naming its replacement: the build seats' backlog in the delivery view",
|
||||||
"and dead (handed out as often as allowed and never settled) — each with its id, repository, path, ref and when it was asked. " +
|
|
||||||
"Answers the table as text and, as data, each ask's state, kind (check or build), repository, commit, machine, since " +
|
|
||||||
"and position among the waiting (novox/hq issue 455).",
|
|
||||||
Input: schema(nil, nil)},
|
Input: schema(nil, nil)},
|
||||||
{Name: "cancel", Description: "Drop one waiting or dead ask from the build queue; its outcome is recorded failed, " +
|
{Name: "cancel", Description: "Removed in R4g (ADR 0525 §9): refused by name, naming its replacement", Input: schema(nil, nil)},
|
||||||
"cancelled by hand, and a plan that asked for it fails. One in flight is refused: `kill` ends it where it runs.",
|
{Name: "clear", Description: "Removed in R4g (ADR 0525 §9): refused by name, naming its replacement", Input: schema(nil, nil)},
|
||||||
Input: schema(map[string]string{"id": "the ask's build id, as `queue` lists it"}, []string{"id"})},
|
{Name: "replay", Description: "Removed in R4g (ADR 0525 §9): refused by name, naming its replacement", Input: schema(nil, nil)},
|
||||||
{Name: "clear", Description: "Cancel every waiting ask in the build queue — and with dead, every dead one too — each " +
|
|
||||||
"recorded failed, cancelled by hand. Never touches one in flight.",
|
|
||||||
Input: schema(map[string]string{"dead": "\"true\" to cancel the dead asks as well"}, nil, "dead")},
|
|
||||||
{Name: "rebuild", Description: "Removed in R4e (ADR 0501 §5 / ADR 0503 §3): refused by name, naming its replacement",
|
|
||||||
Input: schema(nil, nil)},
|
|
||||||
{Name: "replay", Description: "Ask a recorded build's repository and path again at the commit it built, under a new id: " +
|
|
||||||
"a dry run only, nothing recorded or registered (novox/hq ADR 0429 §18: a fingerprint's key is built again by the " +
|
|
||||||
"builder, never registered by hand).",
|
|
||||||
Input: schema(map[string]string{"id": "the build's id"}, []string{"id"})},
|
|
||||||
// novox/hq issue 686: a builder ran a branch's store tests for the first time in its pull request's merge check.
|
// novox/hq issue 686: a builder ran a branch's store tests for the first time in its pull request's merge check.
|
||||||
{Name: "try", Description: "Try a pushed branch or commit before its pull request (novox/hq issue 686): the " +
|
{Name: "try", Description: "Try a pushed branch or commit before its pull request (novox/hq issue 686): the " +
|
||||||
"checker (mesh-delivery-checker) merges the head onto the repository's trunk and runs its levels on the merge, " +
|
"checker (mesh-delivery-checker) merges the head onto the repository's trunk and runs its levels on the merge, " +
|
||||||
"as it judges a pull request (ADR 0503 §3); no merge-check.sh is run and build-agent is not asked. Answers at " +
|
"as it judges a pull request (ADR 0503 §3), its levels asks on the build seats (ADR 0525 §1); no merge-check.sh is run. Answers at " +
|
||||||
"once with an id; asked again with that id it waits up to 20 s and answers pass, fail or error, how long it " +
|
"once with an id; asked again with that id it waits up to 20 s and answers pass, fail or error, how long it " +
|
||||||
"took and the lines naming what failed — or that it is still waiting or running, to ask again. Sets no " +
|
"took and the lines naming what failed — or that it is still waiting or running, to ask again. Sets no " +
|
||||||
"status on the forge, registers and builds nothing for delivery. One try of a commit at a time — a second " +
|
"status on the forge, registers and builds nothing for delivery. One try of a commit at a time — a second " +
|
||||||
@@ -388,23 +320,14 @@ var ControllerVerbs = []Verb{
|
|||||||
"repository": "the repository on the forge, owner/name; with ref",
|
"repository": "the repository on the forge, owner/name; with ref",
|
||||||
"ref": "the branch or commit to try, as pushed to the forge",
|
"ref": "the branch or commit to try, as pushed to the forge",
|
||||||
"base": "the branch it is merged into (the repository's default branch when none is named)",
|
"base": "the branch it is merged into (the repository's default branch when none is named)",
|
||||||
"tests": "only the tests this `go test -run` pattern names, where the repository's merge-check.sh reads " +
|
"tests": "only the tests this `go test -run` pattern names",
|
||||||
"MESH_CHECK_TESTS; a script that does not runs whole",
|
|
||||||
"store-only": "\"true\": only the integration level",
|
"store-only": "\"true\": only the integration level",
|
||||||
"id": "instead of a repository: the id a try answered, to read what came of it",
|
"id": "instead of a repository: the id a try answered, to read what came of it",
|
||||||
}, nil, "store-only"),
|
}, nil, "store-only"),
|
||||||
Replaces: []string{"sh merge-check.sh", "docker run postgres"}},
|
Replaces: []string{"sh merge-check.sh", "docker run postgres"}},
|
||||||
// novox/hq ADR 0350 §5: asked by the delivery's owner when the forge says a pull request closed unmerged.
|
{Name: "kill", Description: "Removed in R4g (ADR 0525 §9): refused by name, naming its replacement: a build seat's ask ends where it runs", Input: schema(nil, nil)},
|
||||||
{Name: "forget-checks", Description: "Removed in R4e (ADR 0501 §5 / ADR 0503 §3): refused by name, naming its replacement",
|
{Name: "pause", Description: "Removed in R4g (ADR 0525 §9): refused by name, naming its replacement: <node>/node-build-<language>.pause", Input: schema(nil, nil)},
|
||||||
Input: schema(nil, nil)},
|
{Name: "resume", Description: "Removed in R4g (ADR 0525 §9): refused by name, naming its replacement: <node>/node-build-<language>.resume", Input: schema(nil, nil)},
|
||||||
{Name: "kill", Description: "End a build where it runs: the machine that took it stops its commands and containers and " +
|
|
||||||
"announces it failed, killed by hand — settled, never handed to another machine.",
|
|
||||||
Input: schema(map[string]string{"id": "the build's id"}, []string{"id"})},
|
|
||||||
{Name: "pause", Description: "The build seat's holder on one machine — or every holder — takes no new build until resumed; " +
|
|
||||||
"a build running finishes. Kept across a restart of the holder. A plan waiting on a paused seat says so and is not late.",
|
|
||||||
Input: schema(map[string]string{"node": "one machine; every holder when absent"}, nil)},
|
|
||||||
{Name: "resume", Description: "The build seat's holder on one machine — or every holder — takes builds again.",
|
|
||||||
Input: schema(map[string]string{"node": "one machine; every holder when absent"}, nil)},
|
|
||||||
// Acts done by hand, and what the bounds are set from (novox/hq to-be 45 §7, Phase 0).
|
// Acts done by hand, and what the bounds are set from (novox/hq to-be 45 §7, Phase 0).
|
||||||
{Name: "hand-act", Description: "Record an act done by hand outside the mesh — a container restarted, a file " +
|
{Name: "hand-act", Description: "Record an act done by hand outside the mesh — a container restarted, a file " +
|
||||||
"edited, a service started on a machine — with why and its cause, in the hand-act log beside the pushes and " +
|
"edited, a service started on a machine — with why and its cause, in the hand-act log beside the pushes and " +
|
||||||
@@ -478,26 +401,22 @@ var ControllerVerbs = []Verb{
|
|||||||
"probe": "one probe's id (D14): its verdict alone, with every finding — the verdict shows at most twenty a probe",
|
"probe": "one probe's id (D14): its verdict alone, with every finding — the verdict shows at most twenty a probe",
|
||||||
}, nil, "run", "probes", "signals")},
|
}, nil, "run", "probes", "signals")},
|
||||||
// How a module's new builds reach its machines, and the bus's planned step (novox/hq ADR 0236).
|
// How a module's new builds reach its machines, and the bus's planned step (novox/hq ADR 0236).
|
||||||
{Name: "upgrade", Description: "How each module's new builds reach its machines (novox/hq ADR 0236): rolled " +
|
{Name: "upgrade", Description: "Whether each module's new builds wait for a person (novox/hq ADR 0236, ADR 0539 clause 14): " +
|
||||||
"out one machine first and judged there at the gate, then the rest — or recorded, waiting for a person's " +
|
"for a module of policy record, the assigner writes no want naming a composition judged to recreate a container or move " +
|
||||||
"push — with where that comes from (a person, the module, the bus, its irreplaceable data, the default) and " +
|
"data until the operator answers its ask; with where the policy comes from (a person, the module, the bus, its " +
|
||||||
"why. With module, that one; with policy, a person's choice for it — roll-out, record (with why) or default " +
|
"irreplaceable data, the default) and why. With module, that one; with policy, a person's choice for it — roll-out, " +
|
||||||
"to take the choice back. The bus is never rolled out.",
|
"record (with why) or default to take the choice back. The bus is never moved by the assigner (ADR 0539 clause 15).",
|
||||||
Input: schema(map[string]string{
|
Input: schema(map[string]string{
|
||||||
"module": "one module",
|
"module": "one module",
|
||||||
"policy": "with module: roll-out, record or default",
|
"policy": "with module: roll-out, record or default",
|
||||||
"together": "\"true\": with roll-out, every machine at once instead of one machine first",
|
"why": "with policy: why — required for record, kept",
|
||||||
"why": "with policy or release-backlog: why — required for record and for a release, kept",
|
}, nil)},
|
||||||
"backlog": "\"true\": every build waiting for a gate, per machine — what a release plan would send",
|
{Name: "bus", Description: "The bus as a person's step (novox/hq to-be 45 §8, ADR 0236, ADR 0539 clause 15): what a bus " +
|
||||||
"release-backlog": "\"true\": release what waits now, one machine at a time, each judged — after a release " +
|
"upgrade would do — the bus's build on each machine against the one the mesh holds — and how the last step went. " +
|
||||||
"plan failed, the mesh waits for this; with why",
|
"With upgrade, check one: a person's act with why, after the streams are snapshotted (snapshot-taken says where, " +
|
||||||
"cause": "with release-backlog: the cause in a word (optional)",
|
"while the mesh takes none itself), saying first whether it can be reverted; then it answers the want the operator " +
|
||||||
}, nil, "together", "backlog", "release-backlog")},
|
"writes with the operator's credential, want.<node>.<bus module>, recorded — nothing is sent, and the assigner never " +
|
||||||
{Name: "bus", Description: "The bus as a planned step (novox/hq to-be 45 §8, ADR 0236): what a bus upgrade " +
|
"moves the bus.",
|
||||||
"would do — the bus's build on each machine against the one the mesh holds — and how the last step went. " +
|
|
||||||
"With upgrade, start one: a person's act with why, after the streams are snapshotted (snapshot-taken says " +
|
|
||||||
"where, while the mesh takes none itself), saying first whether it can be reverted; bus-maintenance is open " +
|
|
||||||
"while it runs and every stream, consumer and a round trip are checked after.",
|
|
||||||
Input: schema(map[string]string{
|
Input: schema(map[string]string{
|
||||||
"upgrade": "\"true\": start the bus's upgrade",
|
"upgrade": "\"true\": start the bus's upgrade",
|
||||||
"why": "with upgrade: why — required, recorded in the hand-act log",
|
"why": "with upgrade: why — required, recorded in the hand-act log",
|
||||||
@@ -587,6 +506,15 @@ var ControllerVerbs = []Verb{
|
|||||||
"repository": "only this repository's references, as <module>/<artifact> (the counts stay whole)",
|
"repository": "only this repository's references, as <module>/<artifact> (the counts stay whole)",
|
||||||
"collected": "\"true\": list the collected references too (they only grow; counted always)",
|
"collected": "\"true\": list the collected references too (they only grow; counted always)",
|
||||||
}, nil, "collected")},
|
}, nil, "collected")},
|
||||||
|
// Whether the artifact store holds what a builder's done key names, before the builder reuses it (novox/hq issue
|
||||||
|
// 1937): the store's collector deletes a blob nothing holds, and a key the controller never took in holds nothing.
|
||||||
|
{Name: "held", Description: "Whether the artifact store holds each reference given, asked with one HEAD each: " +
|
||||||
|
"held, gone (the store answered 404) or unknown with why. The builder asks it before it reuses a done key, and " +
|
||||||
|
"builds a key whose artifact is gone again. Reads only: nothing is held or written (novox/hq issue 1937).",
|
||||||
|
Input: listed(schema(map[string]string{
|
||||||
|
"references": "the artifacts' references, artifact-store://<module>/<artifact>/blobs/sha256:<hex>: a list, " +
|
||||||
|
"or one text separated by commas",
|
||||||
|
}, []string{"references"}), "references")},
|
||||||
{Name: "collect", Description: "The artifact store's sweep, now: what the mesh made and keeps for no reason " +
|
{Name: "collect", Description: "The artifact store's sweep, now: what the mesh made and keeps for no reason " +
|
||||||
"is let go of. Without confirm a dry run — every kept archive asked about with HEADs, what would be let go " +
|
"is let go of. Without confirm a dry run — every kept archive asked about with HEADs, what would be let go " +
|
||||||
"listed, nothing held or deleted. With confirm and why: every kept archive held first, then each eligible " +
|
"listed, nothing held or deleted. With confirm and why: every kept archive held first, then each eligible " +
|
||||||
|
|||||||
@@ -0,0 +1,31 @@
|
|||||||
|
package catalogue
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// 1887/A9b: the build queue's verbs are refused by name, naming what replaced them, and the verbs R4e removed are gone.
|
||||||
|
func TestTheBuildQueueVerbsAreRefusedByName(t *testing.T) {
|
||||||
|
rows := map[string]Verb{}
|
||||||
|
for _, v := range ControllerVerbs {
|
||||||
|
rows[v.Name] = v
|
||||||
|
}
|
||||||
|
for _, gone := range []string{"rebuild", "forget-checks"} {
|
||||||
|
if _, ok := rows[gone]; ok {
|
||||||
|
t.Errorf("the controller still lists %s", gone)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, refused := range []string{"queue", "cancel", "clear", "kill", "pause", "resume", "replay"} {
|
||||||
|
v, ok := rows[refused]
|
||||||
|
if !ok || !strings.HasPrefix(v.Description, "Removed in R4g (ADR 0525 §9): refused by name") {
|
||||||
|
t.Errorf("%s = %q, want refused by name", refused, v.Description)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !strings.Contains(rows["queue"].Description, "delivery view") || !strings.Contains(rows["pause"].Description, "node-build-") {
|
||||||
|
t.Errorf("queue and pause do not name their replacements: %q, %q", rows["queue"].Description, rows["pause"].Description)
|
||||||
|
}
|
||||||
|
if strings.Contains(rows["try"].Description, "build-agent") {
|
||||||
|
t.Errorf("try still names build-agent: %q", rows["try"].Description)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,115 @@
|
|||||||
|
package catalogue
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// 1943/AC4: the controller's seat no longer offers a verb that starts, stops, retries, follows or reads a delivery
|
||||||
|
// plan, nor a push: each is a row with no input whose description refuses it by name and names its replacement, and
|
||||||
|
// each is in the removed list the holder answers from. upgrade keeps its policy and drops the plan's backlog.
|
||||||
|
func TestTheControllerSeatHasNoPlanVerbs(t *testing.T) {
|
||||||
|
rows := map[string]Verb{}
|
||||||
|
for _, v := range ControllerVerbs {
|
||||||
|
rows[v.Name] = v
|
||||||
|
}
|
||||||
|
gone := []string{"plans", "plan", "push", "deliver", "delivery-stop", "delivery-backups-again", "delivery-walks", "delivery-order"}
|
||||||
|
for _, name := range gone {
|
||||||
|
v, ok := rows[name]
|
||||||
|
if !ok {
|
||||||
|
t.Errorf("%s is not in the table, so a caller is not answered by name", name)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
replacement, removed := RemovedControllerVerbs[name]
|
||||||
|
if !removed || replacement == "" {
|
||||||
|
t.Errorf("%s is not in the removed list with its replacement", name)
|
||||||
|
}
|
||||||
|
if !strings.HasPrefix(v.Description, "Removed in R6 (ADR 0539): refused by name") || !strings.Contains(v.Description, replacement) {
|
||||||
|
t.Errorf("%s = %q, want refused by name, naming %q", name, v.Description, replacement)
|
||||||
|
}
|
||||||
|
if props, _ := v.Input["properties"].(map[string]any); len(props) > 0 {
|
||||||
|
t.Errorf("%s still takes %v", name, props)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
props, _ := rows["upgrade"].Input["properties"].(map[string]any)
|
||||||
|
for _, arg := range []string{"together", "backlog", "release-backlog", "cause"} {
|
||||||
|
if _, has := props[arg]; has {
|
||||||
|
t.Errorf("upgrade still takes %s, a plan's", arg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, arg := range []string{"module", "policy", "why"} {
|
||||||
|
if _, has := props[arg]; !has {
|
||||||
|
t.Errorf("upgrade no longer takes %s", arg)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, word := range []string{"rolled", "gate", "backlog", "push"} {
|
||||||
|
if strings.Contains(rows["upgrade"].Description, word) {
|
||||||
|
t.Errorf("upgrade's description still speaks of %q: %q", word, rows["upgrade"].Description)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !strings.Contains(rows["bus"].Description, "want") {
|
||||||
|
t.Errorf("bus does not say the operator writes the bus's want: %q", rows["bus"].Description)
|
||||||
|
}
|
||||||
|
for name := range RemovedControllerVerbs {
|
||||||
|
if v := rows[name]; !strings.HasPrefix(v.Description, "Removed in R6") {
|
||||||
|
t.Errorf("%s is in the removed list and its row says %q", name, v.Description)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943/AC4: the delivery seat keeps the merge's verbs and no longer offers times, what-if, release, stop or
|
||||||
|
// retire-history: each is a row with no input, optional so the holder of before and the holder of release 6 both hold
|
||||||
|
// the seat, refusing it by name; mark-ready, served by nobody since issue 1022, is gone.
|
||||||
|
func TestTheDeliverySeatHasNoPlanVerbs(t *testing.T) {
|
||||||
|
seat, ok := SeatNamed(DeliverySeat)
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("the delivery seat is not in the set")
|
||||||
|
}
|
||||||
|
rows := map[string]Verb{}
|
||||||
|
for _, v := range seat.Serves {
|
||||||
|
rows[v.Name] = v
|
||||||
|
}
|
||||||
|
for _, name := range []string{"times", "what-if", "release", "stop", "retire-history"} {
|
||||||
|
v, ok := rows[name]
|
||||||
|
replacement, removed := RemovedDeliveryVerbs[name]
|
||||||
|
if !ok || !removed || replacement == "" {
|
||||||
|
t.Errorf("%s: in the table %v, in the removed list %v", name, ok, removed)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if !strings.HasPrefix(v.Description, "Removed in R6 (ADR 0539): refused by name") || !strings.Contains(v.Description, replacement) || !v.Optional {
|
||||||
|
t.Errorf("%s = %q (optional %v), want an optional row refusing it by name", name, v.Description, v.Optional)
|
||||||
|
}
|
||||||
|
if props, _ := v.Input["properties"].(map[string]any); len(props) > 0 {
|
||||||
|
t.Errorf("%s still takes %v", name, props)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, ok := rows["mark-ready"]; ok {
|
||||||
|
t.Errorf("mark-ready is still promised")
|
||||||
|
}
|
||||||
|
for _, kept := range []string{"deliveries", "show", "groups", "checks", "table", "recheck", "close", "stalled"} {
|
||||||
|
if v, ok := rows[kept]; !ok || strings.HasPrefix(v.Description, "Removed") {
|
||||||
|
t.Errorf("%s is not kept (ADR 0539 clause 17)", kept)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
gate := Manifest{Module: "mesh-delivery", Claims: []Claim{{Name: DeliverySeat, Scope: ScopeMesh,
|
||||||
|
Serves: []string{"deliveries", "show", "groups", "checks", "table", "stalled", "recheck", "close"}}}}
|
||||||
|
if err := CanHold(gate, seat); err != nil {
|
||||||
|
t.Errorf("the gate of release 6 cannot hold the seat: %v", err)
|
||||||
|
}
|
||||||
|
gate.Claims[0].Serves = append(gate.Claims[0].Serves, "times", "what-if", "release", "stop", "retire-history")
|
||||||
|
if err := CanHold(gate, seat); err != nil {
|
||||||
|
t.Errorf("the gate of release 5 cannot hold the seat: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943 (for 1945/AC14): the controller's seat says a bucket it deleted at its first start as its event, bucket-deleted
|
||||||
|
// (ADR 0539 clause 13).
|
||||||
|
func TestTheControllerSaysABucketItDeleted(t *testing.T) {
|
||||||
|
seat, ok := SeatNamed(ControllerSeatName)
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("no controller seat")
|
||||||
|
}
|
||||||
|
if !SeatSays(seat.Emits, "bucket-deleted") {
|
||||||
|
t.Errorf("the controller's seat does not emit bucket-deleted: %v", seat.Emits)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,163 @@
|
|||||||
|
// mesh-compose is mesh-sdk's composer command (novox/hq ADR 0482 clause 4, issue 1621): it reads a composer.Request on
|
||||||
|
// standard input, validates every manifest with this mesh-sdk's reader, composes the machines named in each case and
|
||||||
|
// writes one composer.Verdict on standard output. Built at any commit of mesh-sdk (or at the mesh-sdk a module pins),
|
||||||
|
// it answers what that commit's composition answers, so a program that links one mesh-sdk can have another's judged.
|
||||||
|
//
|
||||||
|
// mesh-compose < request.json > verdict.json
|
||||||
|
// mesh-compose -request request.json > verdict.json
|
||||||
|
// mesh-compose -catalogue <dir> [-node <name>]... [-depth resolve|compose] [-declarations] [< request.json]
|
||||||
|
//
|
||||||
|
// -catalogue reads <dir>/modules/*/module.json and a module.json at <dir>'s root as the first case's manifests (a
|
||||||
|
// checkout or `git archive` of the catalogue repository at a ref: the command fetches nothing). -node adds a machine to
|
||||||
|
// compose; -declarations answers each machine's declared paths with their owners and modes.
|
||||||
|
//
|
||||||
|
// It opens no network connection, bus, store or file beyond its standard input, the -request file and the -catalogue
|
||||||
|
// directory, and reads
|
||||||
|
// no environment. Exit codes: 0 the verdict is written (a machine that does not compose is a verdict, not an error);
|
||||||
|
// 1 the request cannot be read or run, said on standard error; 2 the flags are wrong.
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/catalogue"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/composer"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
os.Exit(run(os.Args[1:], os.Stdin, os.Stdout, os.Stderr))
|
||||||
|
}
|
||||||
|
|
||||||
|
type nodes []string
|
||||||
|
|
||||||
|
func (n *nodes) String() string { return strings.Join(*n, ",") }
|
||||||
|
func (n *nodes) Set(v string) error { *n = append(*n, v); return nil }
|
||||||
|
|
||||||
|
// run is the command: its arguments, standard input, output and error; it answers the exit code.
|
||||||
|
func run(args []string, stdin io.Reader, stdout, stderr io.Writer) int {
|
||||||
|
fs := flag.NewFlagSet("mesh-compose", flag.ContinueOnError)
|
||||||
|
fs.SetOutput(stderr)
|
||||||
|
catalogueDir := fs.String("catalogue", "", "a catalogue checkout: <dir>/modules/*/module.json are the first case's manifests")
|
||||||
|
var machines nodes
|
||||||
|
fs.Var(&machines, "node", "a machine to compose (repeatable)")
|
||||||
|
depth := fs.String("depth", "", "resolve or compose (default: the request's, else compose)")
|
||||||
|
declarations := fs.Bool("declarations", false, "answer each composed machine's declared paths, owners and modes")
|
||||||
|
requestFile := fs.String("request", "", "read the request from this file instead of standard input (a run step that hands no standard input)")
|
||||||
|
if err := fs.Parse(args); err != nil {
|
||||||
|
return 2
|
||||||
|
}
|
||||||
|
if fs.NArg() > 0 {
|
||||||
|
fmt.Fprintf(stderr, "mesh-compose: unexpected arguments %q\n", fs.Args())
|
||||||
|
return 2
|
||||||
|
}
|
||||||
|
var raw []byte
|
||||||
|
var err error
|
||||||
|
if *requestFile != "" {
|
||||||
|
raw, err = os.ReadFile(*requestFile)
|
||||||
|
} else {
|
||||||
|
raw, err = io.ReadAll(stdin)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintln(stderr, "mesh-compose: the request cannot be read:", err)
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
var req composer.Request
|
||||||
|
if strings.TrimSpace(string(raw)) == "" {
|
||||||
|
if *catalogueDir == "" {
|
||||||
|
fmt.Fprintln(stderr, "mesh-compose: no request on standard input and no -catalogue")
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
req = composer.Request{V: composer.Version}
|
||||||
|
} else if req, err = composer.Decode(raw); err != nil {
|
||||||
|
fmt.Fprintln(stderr, "mesh-compose:", err)
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
if *catalogueDir != "" {
|
||||||
|
read, err := readCatalogue(*catalogueDir)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintln(stderr, "mesh-compose:", err)
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
if len(req.Cases) == 0 {
|
||||||
|
req.Cases = []composer.Case{{Name: "catalogue", Manifests: map[string]composer.Manifest{}}}
|
||||||
|
}
|
||||||
|
if req.Cases[0].Manifests == nil {
|
||||||
|
req.Cases[0].Manifests = map[string]composer.Manifest{}
|
||||||
|
}
|
||||||
|
for name, m := range read {
|
||||||
|
if _, given := req.Cases[0].Manifests[name]; !given {
|
||||||
|
req.Cases[0].Manifests[name] = m
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// The catalogue's list of predefined keys is the one its manifests' fallbacks are judged against (ADR 0348 §7).
|
||||||
|
if req.Predefined == nil {
|
||||||
|
list, err := catalogue.ReadPredefined(*catalogueDir)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintln(stderr, "mesh-compose:", err)
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
req.Predefined = list
|
||||||
|
}
|
||||||
|
}
|
||||||
|
req.Machines = append(req.Machines, machines...)
|
||||||
|
if *depth != "" {
|
||||||
|
req.Depth = *depth
|
||||||
|
}
|
||||||
|
if *declarations {
|
||||||
|
req.Declarations = true
|
||||||
|
}
|
||||||
|
v, err := composer.Run(req)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintln(stderr, "mesh-compose:", err)
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
enc := json.NewEncoder(stdout)
|
||||||
|
if err := enc.Encode(v); err != nil {
|
||||||
|
fmt.Fprintln(stderr, "mesh-compose: the verdict cannot be written:", err)
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// readCatalogue reads every module.json of a catalogue checkout by its module's name: the root's and each of
|
||||||
|
// modules/*/. A manifest whose name cannot be read is kept under its directory's name, so the reader's refusal is said.
|
||||||
|
func readCatalogue(dir string) (map[string]composer.Manifest, error) {
|
||||||
|
paths, err := filepath.Glob(filepath.Join(dir, "modules", "*", "module.json"))
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(filepath.Join(dir, "module.json")); err == nil {
|
||||||
|
paths = append(paths, filepath.Join(dir, "module.json"))
|
||||||
|
}
|
||||||
|
if len(paths) == 0 {
|
||||||
|
return nil, fmt.Errorf("the catalogue %s holds no module.json", dir)
|
||||||
|
}
|
||||||
|
sort.Strings(paths)
|
||||||
|
out := map[string]composer.Manifest{}
|
||||||
|
for _, p := range paths {
|
||||||
|
raw, err := os.ReadFile(p)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
var probe struct {
|
||||||
|
Module string `json:"module"`
|
||||||
|
}
|
||||||
|
name := filepath.Base(filepath.Dir(p))
|
||||||
|
if json.Unmarshal(raw, &probe) == nil && probe.Module != "" {
|
||||||
|
name = probe.Module
|
||||||
|
}
|
||||||
|
if _, twice := out[name]; twice {
|
||||||
|
return nil, errors.New("the catalogue " + dir + " defines " + name + " twice")
|
||||||
|
}
|
||||||
|
out[name] = composer.Manifest{Raw: raw}
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,347 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"go/build"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"reflect"
|
||||||
|
"runtime"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/catalogue"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/compose"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/composer"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/internal/beside"
|
||||||
|
)
|
||||||
|
|
||||||
|
// captured is every manifest of the catalogue captured in testdata/beside (internal/beside), raw, by module name.
|
||||||
|
func captured(t *testing.T) map[string]composer.Manifest {
|
||||||
|
t.Helper()
|
||||||
|
read, err := readCatalogue(filepath.Dir(beside.Catalogue(t)))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if len(read) < 100 {
|
||||||
|
t.Fatalf("the captured catalogue holds %d manifests, fewer than the catalogue's", len(read))
|
||||||
|
}
|
||||||
|
return read
|
||||||
|
}
|
||||||
|
|
||||||
|
// meshOf is a mesh of three machines over the captured catalogue, each assigned real modules, the input the assigner
|
||||||
|
// composes with (nodes and their assignments, holdings from the claims): anchor runs the bus and the store, laptop a
|
||||||
|
// desktop's modules, ace a module whose requirement is provided elsewhere.
|
||||||
|
func meshOf() compose.Input {
|
||||||
|
return compose.Input{Nodes: []compose.Node{
|
||||||
|
{Name: "anchor", Assigned: []string{"nats", "postgres"}},
|
||||||
|
{Name: "laptop", Assigned: []string{"sudo", "zsh"}},
|
||||||
|
{Name: "ace", Assigned: []string{"mesh-reads", "nats"}},
|
||||||
|
}}
|
||||||
|
}
|
||||||
|
|
||||||
|
func request(t *testing.T, depth string) composer.Request {
|
||||||
|
t.Helper()
|
||||||
|
return composer.Request{V: composer.Version, Input: meshOf(), Depth: depth, HoldingsFromClaims: true,
|
||||||
|
Machines: []string{"anchor", "laptop", "ace"},
|
||||||
|
Cases: []composer.Case{{Name: "trunk", Manifests: captured(t)}}}
|
||||||
|
}
|
||||||
|
|
||||||
|
func runJSON(t *testing.T, args []string, in []byte) (int, composer.Verdict, string) {
|
||||||
|
t.Helper()
|
||||||
|
var out, errOut bytes.Buffer
|
||||||
|
code := run(args, bytes.NewReader(in), &out, &errOut)
|
||||||
|
var v composer.Verdict
|
||||||
|
if code == 0 {
|
||||||
|
if err := json.Unmarshal(out.Bytes(), &v); err != nil {
|
||||||
|
t.Fatalf("the verdict is not JSON: %v\n%s", err, out.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return code, v, errOut.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
func encode(t *testing.T, r composer.Request) []byte {
|
||||||
|
t.Helper()
|
||||||
|
raw, err := json.Marshal(r)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return raw
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1621/AC1: the command reads the plain input and the manifests on standard input, validates every manifest, composes
|
||||||
|
// the machines named and writes one verdict: per machine composes or the reason, per manifest accepted or the field
|
||||||
|
// refused.
|
||||||
|
func TestTheCommandWritesOneVerdictPerManifestAndMachine(t *testing.T) {
|
||||||
|
r := request(t, composer.DepthResolve)
|
||||||
|
r.Cases[0].Manifests["broken"] = composer.Manifest{Raw: json.RawMessage(`{"module":"broken","version":"1","shares":["x"]}`)}
|
||||||
|
code, v, stderr := runJSON(t, nil, encode(t, r))
|
||||||
|
if code != 0 {
|
||||||
|
t.Fatalf("exit %d: %s", code, stderr)
|
||||||
|
}
|
||||||
|
if len(v.Cases) != 1 || v.Cases[0].Name != "trunk" || v.SDK == "" {
|
||||||
|
t.Fatalf("verdict = %+v", v)
|
||||||
|
}
|
||||||
|
c := v.Cases[0]
|
||||||
|
if got := c.Manifests["broken"]; got.Accepted || !strings.Contains(got.Refused, `"shares"`) {
|
||||||
|
t.Errorf("the manifest with an unknown field reads %+v, want refused naming the field", got)
|
||||||
|
}
|
||||||
|
if got := c.Manifests["nats"]; !got.Accepted {
|
||||||
|
t.Errorf("nats reads %+v, want accepted", got)
|
||||||
|
}
|
||||||
|
if len(c.Machines) != 3 {
|
||||||
|
t.Fatalf("machines = %v, want the three named", c.Machines)
|
||||||
|
}
|
||||||
|
for name, m := range c.Machines {
|
||||||
|
if !m.Composes && m.Reason == "" {
|
||||||
|
t.Errorf("%s does not compose and says no reason", name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1621/AC3: over the captured catalogue and a mesh of three machines, the command's verdict equals, machine for
|
||||||
|
// machine and manifest for manifest, what the linked reader, resolution and composition answer, at both depths.
|
||||||
|
func TestTheCommandAnswersWhatTheLinkedCompositionAnswers(t *testing.T) {
|
||||||
|
for _, depth := range []string{composer.DepthResolve, composer.DepthCompose} {
|
||||||
|
r := request(t, depth)
|
||||||
|
code, v, stderr := runJSON(t, nil, encode(t, r))
|
||||||
|
if code != 0 {
|
||||||
|
t.Fatalf("%s: exit %d: %s", depth, code, stderr)
|
||||||
|
}
|
||||||
|
in := meshOf()
|
||||||
|
in.Catalogue = map[string]catalogue.Manifest{}
|
||||||
|
for name, m := range r.Cases[0].Manifests {
|
||||||
|
// A request without a list of predefined keys reads a fallback as the indexer does (Request.Predefined).
|
||||||
|
parsed, err := catalogue.ParseManifestForInputs(m.Raw)
|
||||||
|
got := v.Cases[0].Manifests[name]
|
||||||
|
if (err == nil) != got.Accepted || (err != nil && err.Error() != got.Refused) {
|
||||||
|
t.Errorf("%s: the manifest of %s: linked %v, command %+v", depth, name, err, got)
|
||||||
|
}
|
||||||
|
if err == nil {
|
||||||
|
in.Catalogue[name] = parsed
|
||||||
|
}
|
||||||
|
}
|
||||||
|
in.Holdings = composer.HoldingsOf(in.Catalogue, in.Nodes)
|
||||||
|
composed := 0
|
||||||
|
for _, node := range r.Machines {
|
||||||
|
got := v.Cases[0].Machines[node]
|
||||||
|
var want composer.Machine
|
||||||
|
if depth == composer.DepthResolve {
|
||||||
|
if _, err := compose.Resolve(in, node); err != nil {
|
||||||
|
want = composer.Machine{Reason: err.Error()}
|
||||||
|
} else {
|
||||||
|
want = composer.Machine{Composes: true}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
d, problems, err := compose.Compose(in, node)
|
||||||
|
switch {
|
||||||
|
case err != nil:
|
||||||
|
want = composer.Machine{Reason: err.Error()}
|
||||||
|
default:
|
||||||
|
want = composer.Machine{Composes: len(problems) == 0, Problems: problems, Refusals: d.Refusals()}
|
||||||
|
if len(problems) > 0 {
|
||||||
|
want.Reason = "the node-engine's validator refuses the declaration"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(got, want) {
|
||||||
|
t.Errorf("%s: %s: command %+v, linked %+v", depth, node, got, want)
|
||||||
|
}
|
||||||
|
if got.Composes {
|
||||||
|
composed++
|
||||||
|
} else {
|
||||||
|
t.Logf("%s: %s does not compose: %s %v", depth, node, got.Reason, got.Problems)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
t.Logf("%s: %d of %d machines compose", depth, composed, len(r.Machines))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1621 note 6: a person composes a catalogue checkout (repository@ref checked out or archived: the command fetches
|
||||||
|
// nothing) for a node and reads its declaration: each path with its kind, owner and mode.
|
||||||
|
func TestACatalogueCheckoutIsComposedForANode(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
if err := os.MkdirAll(filepath.Join(dir, "modules", "demo"), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
manifest := `{"module": "demo", "version": "1", "resources": [{"id": "state", "type": "directory", ` +
|
||||||
|
`"path": "/var/lib/demo", "mode": "0750", "owner": "root"}]}`
|
||||||
|
if err := os.WriteFile(filepath.Join(dir, "modules", "demo", "module.json"), []byte(manifest), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
in := encode(t, composer.Request{V: composer.Version, Input: compose.Input{Nodes: []compose.Node{{Name: "laptop", Assigned: []string{"demo"}}}}})
|
||||||
|
code, v, stderr := runJSON(t, []string{"-catalogue", dir, "-node", "laptop", "-declarations"}, in)
|
||||||
|
if code != 0 {
|
||||||
|
t.Fatalf("exit %d: %s", code, stderr)
|
||||||
|
}
|
||||||
|
m := v.Cases[0].Machines["laptop"]
|
||||||
|
want := []composer.Path{{Path: "/var/lib/demo", Kind: "directory", Owner: "root", Mode: "0750", Module: ""}}
|
||||||
|
if !m.Composes || len(m.Declared) != 1 || m.Declared[0].Path != want[0].Path || m.Declared[0].Mode != "0750" ||
|
||||||
|
m.Declared[0].Owner != "root" || m.Declared[0].Kind != "directory" {
|
||||||
|
t.Fatalf("laptop = %+v, want it composed declaring %+v", m, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A run step hands the command no standard input: the request is read from the file -request names, and a file that is
|
||||||
|
// not there is a request it cannot read.
|
||||||
|
func TestTheRequestIsReadFromAFile(t *testing.T) {
|
||||||
|
file := filepath.Join(t.TempDir(), "request.json")
|
||||||
|
r := composer.Request{V: composer.Version, Cases: []composer.Case{{Name: "only", Manifests: map[string]composer.Manifest{
|
||||||
|
"demo": {Raw: json.RawMessage(`{"module":"demo","version":"1"}`)}}}}}
|
||||||
|
if err := os.WriteFile(file, encode(t, r), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
code, v, stderr := runJSON(t, []string{"-request", file}, nil)
|
||||||
|
if code != 0 || len(v.Cases) != 1 || !v.Cases[0].Manifests["demo"].Accepted {
|
||||||
|
t.Fatalf("exit %d (%s), verdict %+v", code, stderr, v)
|
||||||
|
}
|
||||||
|
if code, _, stderr := runJSON(t, []string{"-request", file + ".gone"}, nil); code != 1 || !strings.Contains(stderr, "cannot be read") {
|
||||||
|
t.Errorf("a request file that is not there: exit %d, %q", code, stderr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The exit codes: 1 for a request that cannot be read or run, 2 for wrong flags, each said on standard error.
|
||||||
|
func TestTheExitCodesSayWhatFailed(t *testing.T) {
|
||||||
|
unfilled := encode(t, composer.Request{V: composer.Version, Cases: []composer.Case{{Name: "c", Manifests: map[string]composer.Manifest{"x": {Digest: "abc"}}}}})
|
||||||
|
for _, c := range []struct {
|
||||||
|
name string
|
||||||
|
args []string
|
||||||
|
in string
|
||||||
|
code int
|
||||||
|
says string
|
||||||
|
}{
|
||||||
|
{"not JSON", nil, "{", 1, "not JSON"},
|
||||||
|
{"another version", nil, `{"v":2}`, 1, "version 2"},
|
||||||
|
{"a digest left unfilled", nil, string(unfilled), 1, "digest"},
|
||||||
|
{"an unknown depth", nil, `{"v":1,"depth":"deep"}`, 1, "depth"},
|
||||||
|
{"nothing to read", nil, "", 1, "no request"},
|
||||||
|
{"a wrong flag", []string{"-nope"}, "", 2, "nope"},
|
||||||
|
{"an argument", []string{"extra"}, "", 2, "unexpected"},
|
||||||
|
} {
|
||||||
|
var out, errOut bytes.Buffer
|
||||||
|
if got := run(c.args, strings.NewReader(c.in), &out, &errOut); got != c.code || !strings.Contains(errOut.String(), c.says) {
|
||||||
|
t.Errorf("%s: exit %d saying %q, want %d saying %q", c.name, got, errOut.String(), c.code, c.says)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// sdkPackages is every package of this module the command imports, directly or not, with the packages each imports.
|
||||||
|
func sdkPackages(t *testing.T) map[string][]string {
|
||||||
|
t.Helper()
|
||||||
|
_, file, _, _ := runtime.Caller(0)
|
||||||
|
root := filepath.Join(filepath.Dir(file), "..", "..")
|
||||||
|
const module = "git.novox.be/novox/mesh-sdk/go"
|
||||||
|
out := map[string][]string{}
|
||||||
|
var walk func(path string)
|
||||||
|
walk = func(path string) {
|
||||||
|
if _, done := out[path]; done {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
rel := strings.TrimPrefix(strings.TrimPrefix(path, module), "/")
|
||||||
|
pkg, err := build.Default.ImportDir(filepath.Join(root, rel), 0)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("%s: %v", path, err)
|
||||||
|
}
|
||||||
|
out[path] = pkg.Imports
|
||||||
|
for _, imp := range pkg.Imports {
|
||||||
|
if strings.HasPrefix(imp, module+"/") {
|
||||||
|
walk(imp)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
walk(composer.Package)
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1621/AC2 and AC4: the command imports, through every package of mesh-sdk it reaches, only the standard library and
|
||||||
|
// mesh-sdk's own packages (so `go build` from mesh-sdk's module needs nothing beyond its lock), and none that reaches
|
||||||
|
// a bus, a store, a network service or another process.
|
||||||
|
func TestTheCommandImportsNoBusStoreNetworkOrProcess(t *testing.T) {
|
||||||
|
forbidden := []string{"net/http", "net/rpc", "net/smtp", "os/exec", "database/sql", "plugin", "syscall"}
|
||||||
|
for path, imports := range sdkPackages(t) {
|
||||||
|
for _, imp := range imports {
|
||||||
|
std := !strings.Contains(strings.SplitN(imp, "/", 2)[0], ".")
|
||||||
|
if !std && !strings.HasPrefix(imp, "git.novox.be/novox/mesh-sdk/go/") {
|
||||||
|
t.Errorf("%s imports %s, which is neither the standard library nor mesh-sdk", path, imp)
|
||||||
|
}
|
||||||
|
for _, f := range forbidden {
|
||||||
|
if imp == f {
|
||||||
|
t.Errorf("%s imports %s", path, imp)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1621/AC2: run with an empty network namespace, the command still writes its verdict: it needs no network. The test
|
||||||
|
// runs its own binary again under `unshare --net` as an unprivileged user's namespace; where the kernel or the sandbox
|
||||||
|
// allows no new namespace (a build module's run step is already one with no network), it says so and skips.
|
||||||
|
func TestTheCommandRunsWithNoNetwork(t *testing.T) {
|
||||||
|
if os.Getenv("MESH_COMPOSE_HELPER") == "1" {
|
||||||
|
os.Exit(run(nil, os.Stdin, os.Stdout, os.Stderr))
|
||||||
|
}
|
||||||
|
unshare, err := exec.LookPath("unshare")
|
||||||
|
if err != nil {
|
||||||
|
t.Skip("no unshare on this machine, so no empty network namespace can be made here")
|
||||||
|
}
|
||||||
|
if out, err := exec.Command(unshare, "--net", "--map-root-user", "true").CombinedOutput(); err != nil {
|
||||||
|
t.Skipf("this machine makes no unprivileged network namespace (%v: %s); a run step's own has no network", err, out)
|
||||||
|
}
|
||||||
|
r := request(t, composer.DepthResolve)
|
||||||
|
cmd := exec.Command(unshare, "--net", "--map-root-user", os.Args[0], "-test.run=^TestTheCommandRunsWithNoNetwork$")
|
||||||
|
cmd.Env = []string{"MESH_COMPOSE_HELPER=1"}
|
||||||
|
cmd.Stdin = bytes.NewReader(encode(t, r))
|
||||||
|
var out, errOut bytes.Buffer
|
||||||
|
cmd.Stdout, cmd.Stderr = &out, &errOut
|
||||||
|
if err := cmd.Run(); err != nil {
|
||||||
|
t.Fatalf("the command in an empty network namespace: %v: %s", err, errOut.String())
|
||||||
|
}
|
||||||
|
var v composer.Verdict
|
||||||
|
if err := json.Unmarshal(out.Bytes(), &v); err != nil || len(v.Cases) != 1 || len(v.Cases[0].Machines) != 3 {
|
||||||
|
t.Fatalf("no verdict from the command with no network: %v\n%s", err, out.String())
|
||||||
|
}
|
||||||
|
names := make([]string, 0, len(v.Cases[0].Machines))
|
||||||
|
for n := range v.Cases[0].Machines {
|
||||||
|
names = append(names, n)
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
t.Logf("composed with no network: %v", names)
|
||||||
|
}
|
||||||
|
|
||||||
|
// -catalogue judges a fallback to a predefined key against the predefined.json at the checkout's root (ADR 0348 §7):
|
||||||
|
// xterm (mesh-catalog at 835bf22b) falls back to "font-size", accepted where the root lists it and refused where the
|
||||||
|
// root's list does not.
|
||||||
|
func TestACatalogueCheckoutJudgesFallbacksAgainstItsPredefinedKeys(t *testing.T) {
|
||||||
|
raw, err := os.ReadFile("../../catalogue/testdata/catalogue-835bf22b-xterm.module.json")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for _, c := range []struct {
|
||||||
|
list string
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{`{"font-size": {"type": "number", "description": "the desktop's font size"}}`, true},
|
||||||
|
{`{"font-family": {"type": "string", "description": "the desktop's font"}}`, false},
|
||||||
|
} {
|
||||||
|
dir := t.TempDir()
|
||||||
|
if err := os.MkdirAll(filepath.Join(dir, "modules", "xterm"), 0o700); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(dir, "modules", "xterm", "module.json"), raw, 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(dir, catalogue.PredefinedFile), []byte(c.list), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
code, v, stderr := runJSON(t, []string{"-catalogue", dir}, nil)
|
||||||
|
if code != 0 {
|
||||||
|
t.Fatalf("exit %d: %s", code, stderr)
|
||||||
|
}
|
||||||
|
if got := v.Cases[0].Manifests["xterm"]; got.Accepted != c.want {
|
||||||
|
t.Errorf("predefined.json %s: xterm %+v, want accepted %v", c.list, got, c.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
These tests read files outside this directory (the whole catalogue, the repository, or its root files): mesh-build-go never keeps this package's verdict (issue 1935).
|
||||||
@@ -0,0 +1,209 @@
|
|||||||
|
// mesh-hand-compose composes one module for one node by hand, from the inputs the controller keeps, and signs it with the
|
||||||
|
// operator's key, for the hand path of novox/hq ADR 0539 clause 10: a fingerprint the controller never composed (a
|
||||||
|
// hand build), while the controller cannot compose its own fix. It composes with mesh-sdk's composition, the one the
|
||||||
|
// controller writes with (compose.Compositions), and prints the composition, its key and its digest; only with -write
|
||||||
|
// does it write them, with the operator's credential: the composition into the node's bucket composed-<node>, each
|
||||||
|
// file over 64 KiB into the node's object bucket, and the digest into mesh-controller_composed. The want is the
|
||||||
|
// operator's next act, naming that digest; each act is recorded in the hand-act log.
|
||||||
|
//
|
||||||
|
// mesh-hand-compose -input <inputs.json> -node <node> -module <module> -fp <src2:...> -key <operator key>
|
||||||
|
// [-write -nats <url> -creds <operator credential>]
|
||||||
|
//
|
||||||
|
// The inputs are a compose.Input as JSON. The key is the operator's ed25519 private key, PKCS#8 in PEM; the
|
||||||
|
// node-engine trusts it beside the controller's (ADR 0539 clause 3).
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/ed25519"
|
||||||
|
"crypto/x509"
|
||||||
|
"encoding/json"
|
||||||
|
"encoding/pem"
|
||||||
|
"errors"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/nats-io/nats.go"
|
||||||
|
"github.com/nats-io/nats.go/jetstream"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/compose"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/declaration"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
if err := run(os.Args[1:], os.Stdout); err != nil {
|
||||||
|
fmt.Fprintln(os.Stderr, "mesh-hand-compose:", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// printed is what mesh-hand-compose prints: where the composition goes, its digest, the composition, and whether it was
|
||||||
|
// written.
|
||||||
|
type printed struct {
|
||||||
|
Bucket string `json:"bucket"`
|
||||||
|
Key string `json:"key"`
|
||||||
|
Digest string `json:"digest"`
|
||||||
|
Composition json.RawMessage `json:"composition"`
|
||||||
|
Objects []string `json:"objects,omitempty"`
|
||||||
|
Written bool `json:"written"`
|
||||||
|
Next string `json:"next"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func run(args []string, stdout io.Writer) error {
|
||||||
|
fs := flag.NewFlagSet("mesh-hand-compose", flag.ContinueOnError)
|
||||||
|
input := fs.String("input", "", "the controller's kept inputs, a compose.Input as JSON")
|
||||||
|
node := fs.String("node", "", "the node to compose for")
|
||||||
|
module := fs.String("module", "", "the module to compose")
|
||||||
|
fp := fs.String("fp", "", "the module's fingerprint, src2: and 64 hex digits")
|
||||||
|
keyFile := fs.String("key", "", "the operator's ed25519 private key, PKCS#8 in PEM")
|
||||||
|
write := fs.Bool("write", false, "write the composition, its files and its digest, with the operator's credential")
|
||||||
|
url := fs.String("nats", nats.DefaultURL, "with -write: the bus")
|
||||||
|
creds := fs.String("creds", "", "with -write: the operator's credential file")
|
||||||
|
if err := fs.Parse(args); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case *input == "" || *node == "" || *module == "" || *fp == "":
|
||||||
|
return errors.New("-input, -node, -module and -fp are each required")
|
||||||
|
case *keyFile == "":
|
||||||
|
return errors.New("-key is required: a composition made by hand is signed by the operator's key, and the node-engine applies no other")
|
||||||
|
case *write && *creds == "":
|
||||||
|
return errors.New("-write needs -creds: the operator's credential is the only hand writer of a composition")
|
||||||
|
}
|
||||||
|
key, err := readKey(*keyFile)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
key2, err := delivery.ComposedKey(*node, *module, *fp)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
bucket, err := delivery.ComposedBucketFor(*node)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
raw, err := os.ReadFile(*input)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var in compose.Input
|
||||||
|
if err := json.Unmarshal(raw, &in); err != nil {
|
||||||
|
return fmt.Errorf("the inputs in %s are not a compose.Input: %w", *input, err)
|
||||||
|
}
|
||||||
|
all, _, err := compose.Compositions(in, *node, map[string]string{*module: *fp}, compose.Reading)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
c, ok := all[key2]
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("%s does not run %s: its composition holds none of it", *node, *module)
|
||||||
|
}
|
||||||
|
c, objects, err := c.ByDigest()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if c, err = delivery.SignComposed(c, key); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
encoded, err := delivery.EncodeComposed(c)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
digest, err := delivery.ComposedDigestOf(c)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
out := printed{Bucket: bucket, Key: key2, Digest: digest, Composition: encoded,
|
||||||
|
Next: fmt.Sprintf("write want.%s.%s naming fp %s and composed %s with the operator's credential, and record each act in the hand-act log", *node, *module, *fp, digest)}
|
||||||
|
for d := range objects {
|
||||||
|
out.Objects = append(out.Objects, d)
|
||||||
|
}
|
||||||
|
if *write {
|
||||||
|
if err := writeIt(*url, *creds, *node, bucket, key2, encoded, digest, objects); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
out.Written = true
|
||||||
|
}
|
||||||
|
enc := json.NewEncoder(stdout)
|
||||||
|
enc.SetIndent("", " ")
|
||||||
|
return enc.Encode(out)
|
||||||
|
}
|
||||||
|
|
||||||
|
func readKey(path string) (ed25519.PrivateKey, error) {
|
||||||
|
raw, err := os.ReadFile(path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
block, _ := pem.Decode(raw)
|
||||||
|
if block == nil {
|
||||||
|
return nil, fmt.Errorf("%s holds no PEM block", path)
|
||||||
|
}
|
||||||
|
parsed, err := x509.ParsePKCS8PrivateKey(block.Bytes)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("%s: %w", path, err)
|
||||||
|
}
|
||||||
|
key, ok := parsed.(ed25519.PrivateKey)
|
||||||
|
if !ok {
|
||||||
|
return nil, fmt.Errorf("%s is not an ed25519 key", path)
|
||||||
|
}
|
||||||
|
return key, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// writeIt writes the files by digest, then the composition, then its digest: a reader that finds the digest finds the
|
||||||
|
// composition and its files already there.
|
||||||
|
func writeIt(url, creds, node, bucket, key string, encoded []byte, digest string, objects map[string][]byte) error {
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
|
||||||
|
defer cancel()
|
||||||
|
nc, err := nats.Connect(url, nats.UserCredentials(creds), nats.Name("mesh-hand-compose"))
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer nc.Close()
|
||||||
|
js, err := jetstream.New(nc)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if len(objects) > 0 {
|
||||||
|
filesBucket, err := declaration.FileBucketFor(node)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
store, err := js.ObjectStore(ctx, filesBucket)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("the node's object bucket %s: %w", filesBucket, err)
|
||||||
|
}
|
||||||
|
for d, body := range objects {
|
||||||
|
name, err := declaration.ObjectName(d)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if _, err := store.PutBytes(ctx, name, body); err != nil {
|
||||||
|
return fmt.Errorf("the file %s: %w", d, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
composed, err := js.KeyValue(ctx, bucket)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("the bucket %s: %w", bucket, err)
|
||||||
|
}
|
||||||
|
if _, err := composed.Put(ctx, key, encoded); err != nil {
|
||||||
|
return fmt.Errorf("%s in %s: %w", key, bucket, err)
|
||||||
|
}
|
||||||
|
value, err := delivery.EncodeComposedDigest(delivery.ComposedDigest{Digest: digest, Judgement: delivery.JudgedCannot,
|
||||||
|
Words: "composed by hand with mesh-hand-compose (ADR 0539 clause 10): the operator writes the want"})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
digests, err := js.KeyValue(ctx, delivery.ControllerComposedBucket)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("the bucket %s: %w", delivery.ControllerComposedBucket, err)
|
||||||
|
}
|
||||||
|
if _, err := digests.Put(ctx, key, value); err != nil {
|
||||||
|
return fmt.Errorf("%s in %s: %w", key, delivery.ControllerComposedBucket, err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,145 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"crypto/ed25519"
|
||||||
|
"crypto/rand"
|
||||||
|
"crypto/x509"
|
||||||
|
"encoding/base64"
|
||||||
|
"encoding/json"
|
||||||
|
"encoding/pem"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/catalogue"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/compose"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/overlay"
|
||||||
|
)
|
||||||
|
|
||||||
|
// aMesh is the Input of mesh-controller's aMesh, as mesh-sdk's compose tests make it (compose/fixture_test.go): two
|
||||||
|
// machines on the private network, the module the mesh provides for itself assigned to both. The manifest is the one
|
||||||
|
// the controller provides (overlay.Manifest), read back as the catalogue reads it.
|
||||||
|
func aMesh(t *testing.T) compose.Input {
|
||||||
|
t.Helper()
|
||||||
|
var m catalogue.Manifest
|
||||||
|
b, _ := json.Marshal(overlay.Manifest())
|
||||||
|
if err := json.Unmarshal(b, &m); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
in := compose.Input{Catalogue: map[string]catalogue.Manifest{overlay.Name: m}}
|
||||||
|
for i, name := range []string{"anchor", "laptop"} {
|
||||||
|
pub, _, _ := ed25519.GenerateKey(rand.Reader)
|
||||||
|
in.Nodes = append(in.Nodes, compose.Node{Name: name,
|
||||||
|
Place: compose.Place{Key: base64.StdEncoding.EncodeToString(pub), Endpoint: name + ".example:51820", Site: "here", Hub: name == "anchor", Address: []string{"10.77.0.1", "10.77.0.2"}[i]},
|
||||||
|
Assigned: []string{overlay.Name}, Capabilities: map[string]bool{"container-runtime": true, "wireguard": true, "systemd": true}})
|
||||||
|
}
|
||||||
|
return in
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeKey(t *testing.T, dir string) ed25519.PublicKey {
|
||||||
|
t.Helper()
|
||||||
|
pub, priv, _ := ed25519.GenerateKey(rand.Reader)
|
||||||
|
der, err := x509.MarshalPKCS8PrivateKey(priv)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(dir, "operator.key"), pem.EncodeToMemory(&pem.Block{Type: "PRIVATE KEY", Bytes: der}), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return pub
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943/AC5: mesh-hand-compose, given the kept inputs, a node, a module and its fingerprint, prints that module's
|
||||||
|
// composition for that node signed by the operator's key and its digest: its resources are the controller's for that
|
||||||
|
// module on that node (compose.Compose), and it verifies against the operator's key. Without --write it writes nothing.
|
||||||
|
func TestMeshComposeGivesTheControllersResourcesSignedByTheOperator(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
in := aMesh(t)
|
||||||
|
raw, err := json.Marshal(in)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
input := filepath.Join(dir, "input.json")
|
||||||
|
if err := os.WriteFile(input, raw, 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
operator := writeKey(t, dir)
|
||||||
|
fp := delivery.SourcePrefix2 + strings.Repeat("a", 64)
|
||||||
|
|
||||||
|
var out bytes.Buffer
|
||||||
|
if err := run([]string{"-input", input, "-node", "laptop", "-module", overlay.Name, "-fp", fp,
|
||||||
|
"-key", filepath.Join(dir, "operator.key")}, &out); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
var printed struct {
|
||||||
|
Key string `json:"key"`
|
||||||
|
Bucket string `json:"bucket"`
|
||||||
|
Digest string `json:"digest"`
|
||||||
|
Composition json.RawMessage `json:"composition"`
|
||||||
|
Written bool `json:"written"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(out.Bytes(), &printed); err != nil {
|
||||||
|
t.Fatalf("%s: %v", out.String(), err)
|
||||||
|
}
|
||||||
|
c, err := delivery.DecodeComposed(printed.Composition)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if digest, err := delivery.VerifyComposed(c, []ed25519.PublicKey{operator}); err != nil || digest != printed.Digest {
|
||||||
|
t.Errorf("the composition verifies %q, %v against the operator's key; printed %s", digest, err, printed.Digest)
|
||||||
|
}
|
||||||
|
wantKey, _ := delivery.ComposedKey("laptop", overlay.Name, fp)
|
||||||
|
if printed.Key != wantKey || printed.Bucket != "composed-laptop" || printed.Written {
|
||||||
|
t.Errorf("printed key %s in %s, written %v", printed.Key, printed.Bucket, printed.Written)
|
||||||
|
}
|
||||||
|
|
||||||
|
d, _, err := compose.Compose(in, "laptop")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
var want, got []string
|
||||||
|
for _, r := range d.Resources {
|
||||||
|
want = append(want, r["id"].(string))
|
||||||
|
}
|
||||||
|
for _, r := range c.Resources {
|
||||||
|
var head struct{ ID string }
|
||||||
|
_ = json.Unmarshal(r, &head)
|
||||||
|
got = append(got, head.ID)
|
||||||
|
}
|
||||||
|
sort.Strings(want)
|
||||||
|
sort.Strings(got)
|
||||||
|
if len(got) == 0 || strings.Join(got, " ") != strings.Join(want, " ") {
|
||||||
|
t.Errorf("mesh-hand-compose gives %v, the controller's composition %v", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943/AC5: mesh-hand-compose refuses what it cannot compose, naming why: no key, a fingerprint not of the new form, a
|
||||||
|
// module the node does not run, a node the mesh does not have.
|
||||||
|
func TestMeshComposeRefuses(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
raw, _ := json.Marshal(aMesh(t))
|
||||||
|
input := filepath.Join(dir, "input.json")
|
||||||
|
_ = os.WriteFile(input, raw, 0o600)
|
||||||
|
writeKey(t, dir)
|
||||||
|
key := filepath.Join(dir, "operator.key")
|
||||||
|
fp := delivery.SourcePrefix2 + strings.Repeat("a", 64)
|
||||||
|
for _, c := range []struct {
|
||||||
|
args []string
|
||||||
|
why string
|
||||||
|
}{
|
||||||
|
{[]string{"-input", input, "-node", "laptop", "-module", overlay.Name, "-fp", fp}, "-key"},
|
||||||
|
{[]string{"-input", input, "-node", "laptop", "-module", overlay.Name, "-fp", "src2:1", "-key", key}, "fingerprint"},
|
||||||
|
{[]string{"-input", input, "-node", "laptop", "-module", "mesh-mail", "-fp", fp, "-key", key}, "does not run mesh-mail"},
|
||||||
|
{[]string{"-input", input, "-node", "nowhere", "-module", overlay.Name, "-fp", fp, "-key", key}, "nowhere"},
|
||||||
|
{[]string{"-input", input, "-node", "laptop", "-module", overlay.Name, "-fp", fp, "-key", key, "-write"}, "-creds"},
|
||||||
|
} {
|
||||||
|
var out bytes.Buffer
|
||||||
|
if err := run(c.args, &out); err == nil || !strings.Contains(err.Error(), c.why) {
|
||||||
|
t.Errorf("mesh-hand-compose %v = %v, want a refusal saying %q", c.args, err, c.why)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,111 @@
|
|||||||
|
// mesh-pack builds a Go bundle by hand with the recipe of the mesh-build-go module and packs it with mesh-sdk's own
|
||||||
|
// buildstep.Pack, printing the digest, so a hand build has the form of a built artifact and, with the same Go version,
|
||||||
|
// its digest (novox/hq ADR 0526; fallback record F1; issue 1499 for the Go version).
|
||||||
|
//
|
||||||
|
// mesh-pack -dir <module dir> -from <package> -binary <name> [-system arch] [-out <archive file>]
|
||||||
|
// mesh-pack -pack <directory> [-out <archive file>] (a `files` archive: pack a tree as it is)
|
||||||
|
//
|
||||||
|
// The recipe is mesh-catalog modules/mesh-build-go cmd/mesh-build-go/build.go (recipeFlags, recipeLinkerFlags,
|
||||||
|
// recipeSystemStamp, buildEnv): CGO_ENABLED=0, GOFLAGS "-trimpath -buildvcs=false -mod=mod" (-mod=vendor when the
|
||||||
|
// directory vendors), GOTOOLCHAIN=local, GOPROXY=off, and -ldflags "-s -w -X main.builtFor=<system>".
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/buildstep"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
recipeFlags = "-trimpath -buildvcs=false"
|
||||||
|
recipeLinkerFlags = "-s -w"
|
||||||
|
recipeSystemStamp = "main.builtFor"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Env is the build module's environment for the compile of dir, added to the caller's own.
|
||||||
|
func Env(dir string) []string {
|
||||||
|
mod := "-mod=mod"
|
||||||
|
if _, err := os.Stat(filepath.Join(dir, "vendor", "modules.txt")); err == nil {
|
||||||
|
mod = "-mod=vendor"
|
||||||
|
}
|
||||||
|
return append(os.Environ(),
|
||||||
|
"CGO_ENABLED=0",
|
||||||
|
"GOFLAGS="+recipeFlags+" "+mod,
|
||||||
|
"GOTOOLCHAIN=local",
|
||||||
|
"GOPROXY=off",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Args is the arguments of the go command of the recipe.
|
||||||
|
func Args(dir, from, out, binary, system string) []string {
|
||||||
|
linker := recipeLinkerFlags
|
||||||
|
if s := strings.TrimSpace(system); s != "" {
|
||||||
|
linker += " -X " + recipeSystemStamp + "=" + s
|
||||||
|
}
|
||||||
|
return []string{"-C", dir, "build", "-ldflags", linker, "-o", filepath.Join(out, binary), "./" + strings.Trim(from, "./")}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Build compiles the package into a fresh directory and answers it.
|
||||||
|
func Build(dir, from, binary, system string) (string, error) {
|
||||||
|
out, err := os.MkdirTemp("", "mesh-pack-")
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
cmd := exec.Command("go", Args(dir, from, out, binary, system)...)
|
||||||
|
cmd.Env = Env(dir)
|
||||||
|
cmd.Stdout, cmd.Stderr = os.Stderr, os.Stderr
|
||||||
|
if err := cmd.Run(); err != nil {
|
||||||
|
os.RemoveAll(out)
|
||||||
|
return "", fmt.Errorf("go build of %s: %w", from, err)
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func run(args []string) (string, error) {
|
||||||
|
fs := flag.NewFlagSet("mesh-pack", flag.ContinueOnError)
|
||||||
|
dir := fs.String("dir", ".", "the Go module's directory")
|
||||||
|
from := fs.String("from", "", "the package to build, relative to -dir (the artifact's from)")
|
||||||
|
binary := fs.String("binary", "", "the binary's name in the archive")
|
||||||
|
system := fs.String("system", "", "the system stamped into main.builtFor (an artifact's system, e.g. arch)")
|
||||||
|
pack := fs.String("pack", "", "pack this directory as it is (a files archive) instead of building")
|
||||||
|
outFile := fs.String("out", "", "write the archive here")
|
||||||
|
if err := fs.Parse(args); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
root := *pack
|
||||||
|
if root == "" {
|
||||||
|
if *from == "" || *binary == "" {
|
||||||
|
return "", fmt.Errorf("-from and -binary are needed (or -pack <directory>)")
|
||||||
|
}
|
||||||
|
out, err := Build(*dir, *from, *binary, *system)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
defer os.RemoveAll(out)
|
||||||
|
root = out
|
||||||
|
}
|
||||||
|
archive, digest, err := buildstep.Pack(root)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if *outFile != "" {
|
||||||
|
if err := os.WriteFile(*outFile, archive, 0o644); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return digest, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
digest, err := run(os.Args[1:])
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintln(os.Stderr, "mesh-pack:", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
fmt.Println(digest)
|
||||||
|
}
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/buildstep"
|
||||||
|
)
|
||||||
|
|
||||||
|
func fixture(t *testing.T) string {
|
||||||
|
t.Helper()
|
||||||
|
d := t.TempDir()
|
||||||
|
os.MkdirAll(filepath.Join(d, "sub"), 0o755)
|
||||||
|
os.WriteFile(filepath.Join(d, "a.txt"), []byte("alpha"), 0o644)
|
||||||
|
os.WriteFile(filepath.Join(d, "sub", "run"), []byte("#!/bin/sh\n"), 0o755)
|
||||||
|
return d
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPackFixtureTwiceGivesBuildstepsDigest(t *testing.T) {
|
||||||
|
d := fixture(t)
|
||||||
|
_, want, err := buildstep.Pack(d)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for i := 0; i < 2; i++ {
|
||||||
|
got, err := run([]string{"-pack", d, "-out", filepath.Join(t.TempDir(), "x.tgz")})
|
||||||
|
if err != nil || got != want {
|
||||||
|
t.Fatalf("run %d: %q, %v; want %q", i, got, err, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildTwiceGivesOneDigestAndRecipeArgs(t *testing.T) {
|
||||||
|
m := t.TempDir()
|
||||||
|
os.WriteFile(filepath.Join(m, "go.mod"), []byte("module x\n\ngo 1.21\n"), 0o644)
|
||||||
|
os.MkdirAll(filepath.Join(m, "cmd", "p"), 0o755)
|
||||||
|
os.WriteFile(filepath.Join(m, "cmd", "p", "main.go"), []byte("package main\n\nvar builtFor string\n\nfunc main() { println(builtFor) }\n"), 0o644)
|
||||||
|
args := []string{"-dir", m, "-from", "cmd/p", "-binary", "p", "-system", "arch"}
|
||||||
|
a, err := run(args)
|
||||||
|
if err != nil {
|
||||||
|
t.Skipf("no go toolchain that builds offline: %v", err)
|
||||||
|
}
|
||||||
|
b, err := run(args)
|
||||||
|
if err != nil || a != b {
|
||||||
|
t.Fatalf("two builds: %q, %q, %v", a, b, err)
|
||||||
|
}
|
||||||
|
got := Args("/d", "./cmd/p/", "/o", "p", "arch")
|
||||||
|
if got[len(got)-1] != "./cmd/p" || got[4] != "-s -w -X main.builtFor=arch" {
|
||||||
|
t.Fatalf("args %v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,94 @@
|
|||||||
|
package compose
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"sort"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/declaration"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Compositions is one node's compositions (novox/hq ADR 0539 clauses 1 and 2): its declaration composed over in, as
|
||||||
|
// the controller composes it, split into each module's composition at the fingerprint fps gives it and the node's own
|
||||||
|
// (`<node>.node`), by key (delivery.ComposedKey). Each resource says its module, whatever the node reported it reads.
|
||||||
|
// A module fps gives no fingerprint for is not composed and is named in skipped, so a caller composing one module
|
||||||
|
// (mesh-hand-compose) gets that one. Each module's Data says whether its manifest declares data. The compositions are not
|
||||||
|
// signed and not yet by digest: the writer does both (delivery.SignComposed, Composed.ByDigest).
|
||||||
|
func Compositions(in Input, node string, fps map[string]string, mode Mode) (out map[string]delivery.Composed, skipped []string, err error) {
|
||||||
|
reading := in
|
||||||
|
reading.Nodes = append([]Node(nil), in.Nodes...)
|
||||||
|
found := false
|
||||||
|
for i := range reading.Nodes {
|
||||||
|
if reading.Nodes[i].Name == node {
|
||||||
|
reading.Nodes[i].ReadsModules = true
|
||||||
|
found = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !found {
|
||||||
|
return nil, nil, fmt.Errorf("compose: the mesh has no node %q", node)
|
||||||
|
}
|
||||||
|
d, problems, err := ComposeIn(reading, node, mode)
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, err
|
||||||
|
}
|
||||||
|
if len(problems) > 0 {
|
||||||
|
return nil, nil, fmt.Errorf("compose: %s's declaration is refused by the node-engine's validator: %v", node, problems)
|
||||||
|
}
|
||||||
|
body, err := d.Body()
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, err
|
||||||
|
}
|
||||||
|
var envelope struct {
|
||||||
|
Resources []json.RawMessage `json:"resources"`
|
||||||
|
Adoption *declaration.Adoption `json:"adoption"`
|
||||||
|
Filled []string `json:"filled_files"`
|
||||||
|
Provisioner string `json:"provisioner_account"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(body, &envelope); err != nil {
|
||||||
|
return nil, nil, err
|
||||||
|
}
|
||||||
|
var kept []json.RawMessage
|
||||||
|
keptPaths := map[string]bool{}
|
||||||
|
left := map[string]bool{}
|
||||||
|
for _, raw := range envelope.Resources {
|
||||||
|
var head struct {
|
||||||
|
Module string `json:"module"`
|
||||||
|
Type string `json:"type"`
|
||||||
|
Path string `json:"path"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(raw, &head); err != nil {
|
||||||
|
return nil, nil, err
|
||||||
|
}
|
||||||
|
if _, ok := fps[head.Module]; head.Module != "" && !ok {
|
||||||
|
left[head.Module] = true
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if head.Type == string(declaration.TypeFile) {
|
||||||
|
keptPaths[head.Path] = true
|
||||||
|
}
|
||||||
|
kept = append(kept, raw)
|
||||||
|
}
|
||||||
|
var filled []string
|
||||||
|
for _, p := range envelope.Filled {
|
||||||
|
if keptPaths[p] {
|
||||||
|
filled = append(filled, p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out, err = delivery.SplitComposed(node, kept, fps, filled,
|
||||||
|
delivery.NodeOwn{Adoption: envelope.Adoption, Provisioner: envelope.Provisioner})
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, err
|
||||||
|
}
|
||||||
|
for key, c := range out {
|
||||||
|
if m, ok := in.Catalogue[c.Module]; ok && c.Module != "" {
|
||||||
|
c.Data = len(m.DataItems()) > 0
|
||||||
|
out[key] = c
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for m := range left {
|
||||||
|
skipped = append(skipped, m)
|
||||||
|
}
|
||||||
|
sort.Strings(skipped)
|
||||||
|
return out, skipped, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
package compose
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/catalogue"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
func fpFor(c byte) string { return delivery.SourcePrefix2 + strings.Repeat(string(c), 64) }
|
||||||
|
|
||||||
|
// 1943/AC5: a node's compositions are its declaration as Compose gives it, split by the module each resource belongs
|
||||||
|
// to: every resource once, each in its module's composition at the fingerprint given, the module's ownership said on
|
||||||
|
// it; a module given no fingerprint is named as skipped and composed nowhere.
|
||||||
|
func TestCompositionsAreTheDeclarationSplitByModule(t *testing.T) {
|
||||||
|
in := aSmallMesh(t)
|
||||||
|
d, _, err := Compose(in, "laptop")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
var want []string
|
||||||
|
for _, r := range d.Resources {
|
||||||
|
want = append(want, r["type"].(string)+":"+r["id"].(string))
|
||||||
|
}
|
||||||
|
sort.Strings(want)
|
||||||
|
|
||||||
|
fps := map[string]string{"mesh-wireguard": fpFor('a'), "files": fpFor('b')}
|
||||||
|
out, skipped, err := Compositions(in, "laptop", fps, Foreseeing)
|
||||||
|
if err != nil || len(skipped) != 0 {
|
||||||
|
t.Fatalf("Compositions = %v, skipped %v", err, skipped)
|
||||||
|
}
|
||||||
|
var got []string
|
||||||
|
for key, c := range out {
|
||||||
|
node, module, fp, isNode, err := delivery.ParseComposedKey(key)
|
||||||
|
if err != nil || node != "laptop" || module != c.Module || fp != c.FP || (isNode != (module == "")) {
|
||||||
|
t.Errorf("key %s holds %s at %s (%v)", key, c.Module, c.FP, err)
|
||||||
|
}
|
||||||
|
if !isNode && fp != fps[module] {
|
||||||
|
t.Errorf("%s is composed at %s, given %s", module, fp, fps[module])
|
||||||
|
}
|
||||||
|
if _, err := delivery.EncodeComposed(c); err != nil {
|
||||||
|
t.Errorf("%s: %v", key, err)
|
||||||
|
}
|
||||||
|
for _, raw := range c.Resources {
|
||||||
|
var r struct{ ID, Type, Module string }
|
||||||
|
_ = json.Unmarshal(raw, &r)
|
||||||
|
if r.Module != module {
|
||||||
|
t.Errorf("%s holds %s of %q", key, r.ID, r.Module)
|
||||||
|
}
|
||||||
|
got = append(got, r.Type+":"+r.ID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Strings(got)
|
||||||
|
if strings.Join(got, " ") != strings.Join(want, " ") {
|
||||||
|
t.Errorf("the compositions hold %v, the declaration %v", got, want)
|
||||||
|
}
|
||||||
|
|
||||||
|
one, skipped, err := Compositions(in, "laptop", map[string]string{"files": fpFor('b')}, Foreseeing)
|
||||||
|
if err != nil || strings.Join(skipped, ",") != "mesh-wireguard" {
|
||||||
|
t.Fatalf("one module: %v, skipped %v", err, skipped)
|
||||||
|
}
|
||||||
|
for _, c := range one {
|
||||||
|
if c.Module == "mesh-wireguard" {
|
||||||
|
t.Errorf("a module given no fingerprint was composed")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, _, err := Compositions(in, "nowhere", fps, Foreseeing); err == nil {
|
||||||
|
t.Errorf("a node the mesh does not have was composed")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943/AC1: the upgrade policies and sources a composition's value may name are the catalogue's own words.
|
||||||
|
func TestTheComposedPoliciesAreTheCatalogues(t *testing.T) {
|
||||||
|
for _, p := range []string{catalogue.PolicyRoll, catalogue.PolicyTogether, catalogue.PolicyRecord} {
|
||||||
|
for _, from := range []string{catalogue.FromPerson, catalogue.FromModule, catalogue.FromBus, catalogue.FromData, catalogue.FromDefault} {
|
||||||
|
v := delivery.ComposedDigest{Digest: "sha256:" + strings.Repeat("a", 64), Judgement: delivery.JudgedNeither, Policy: p, PolicyFrom: from}
|
||||||
|
if _, err := delivery.EncodeComposedDigest(v); err != nil {
|
||||||
|
t.Errorf("%s from %s: %v", p, from, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if delivery.PolicyRecord != catalogue.PolicyRecord {
|
||||||
|
t.Errorf("delivery.PolicyRecord = %q, the catalogue's %q", delivery.PolicyRecord, catalogue.PolicyRecord)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,347 @@
|
|||||||
|
// Package composer is mesh-sdk's composition and validator as one function over a plain request (novox/hq ADR 0482
|
||||||
|
// clause 4, issue 1621): what the command mesh-compose runs, so a program that links any one mesh-sdk can have the
|
||||||
|
// composition of another commit judged by building that commit's command and reading its verdict.
|
||||||
|
//
|
||||||
|
// **It reads its request and nothing else.** No bus, store, network, file or environment: the manifests come inside the
|
||||||
|
// request (raw, as their repository holds them), the rest of the mesh is a compose.Input, and the answer is a value.
|
||||||
|
// A manifest named only by its digest in the delivery indexer's bucket is filled before the run by Fill, by whoever
|
||||||
|
// holds the bus (the Go build module's compose job); Run refuses a digest left unfilled.
|
||||||
|
package composer
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"slices"
|
||||||
|
"sort"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/catalogue"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/compose"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/sdkversion"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Version is the version of a Request and of a Verdict; a reader refuses another.
|
||||||
|
const Version = 1
|
||||||
|
|
||||||
|
// Package is the import path of the command, which a compose job builds at a commit (in mesh-sdk's own module, or in
|
||||||
|
// a module that requires mesh-sdk, at the version it pins).
|
||||||
|
const Package = "git.novox.be/novox/mesh-sdk/go/cmd/mesh-compose"
|
||||||
|
|
||||||
|
// The depths of a composition.
|
||||||
|
const (
|
||||||
|
// DepthResolve resolves each machine's set over the rest of the mesh (compose.Resolve): what the assigner judges
|
||||||
|
// while the facts snapshot is not on the bus (issue 1461).
|
||||||
|
DepthResolve = "resolve"
|
||||||
|
// DepthCompose composes each machine's whole declaration and runs the node-engine's validator over it
|
||||||
|
// (compose.Compose).
|
||||||
|
DepthCompose = "compose"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Request is everything one run composes: the rest of the mesh, one or more cases of manifests composed over it, and
|
||||||
|
// the machines composed in each case.
|
||||||
|
type Request struct {
|
||||||
|
V int `json:"v"`
|
||||||
|
// Input is the composition's input without its catalogue (and without each node's kept manifests): the cases give
|
||||||
|
// those. A Catalogue or Kept it holds is ignored.
|
||||||
|
Input compose.Input `json:"input"`
|
||||||
|
// Cases are composed one after the other over Input, each with its own manifests; their names are unique.
|
||||||
|
Cases []Case `json:"cases"`
|
||||||
|
// Machines are the nodes composed in every case; none means the manifests are only read.
|
||||||
|
Machines []string `json:"machines,omitempty"`
|
||||||
|
// Depth is DepthResolve or DepthCompose; empty is DepthCompose.
|
||||||
|
Depth string `json:"depth,omitempty"`
|
||||||
|
// HoldingsFromClaims adds to Input's holdings every seat an assigned module claims, held on its node (the
|
||||||
|
// assigner's input, which has no holdings of record).
|
||||||
|
HoldingsFromClaims bool `json:"holdings_from_claims,omitempty"`
|
||||||
|
// Declarations asks each composed machine's declared paths (DepthCompose only).
|
||||||
|
Declarations bool `json:"declarations,omitempty"`
|
||||||
|
// Predefined is the list of predefined keys at the catalogue's root (predefined.json, novox/hq ADR 0348 §7) that
|
||||||
|
// every config value falling back to a key is judged against, when the asker has it (mesh-compose -catalogue
|
||||||
|
// reads it). Without it a fallback is read as catalogue.ParseManifestForInputs reads it: against the list the mesh
|
||||||
|
// published when this process holds one, else each key as its value declares it, for the merge gate judges the
|
||||||
|
// fallback in the catalogue and a manifest that only carries one is not refused here.
|
||||||
|
Predefined catalogue.PredefinedList `json:"predefined,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Case is one catalogue composed: every module's manifest by name, and per node the manifests kept at the build it runs.
|
||||||
|
type Case struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Manifests map[string]Manifest `json:"manifests"`
|
||||||
|
Kept map[string]map[string]Manifest `json:"kept,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Manifest is a module's manifest as its repository holds it (Raw, the bytes), or the digest the delivery indexer keeps
|
||||||
|
// it under (Digest), which Fill replaces by the bytes. On the wire it is the manifest itself, or {"digest": "..."}.
|
||||||
|
type Manifest struct {
|
||||||
|
Raw json.RawMessage
|
||||||
|
Digest string
|
||||||
|
}
|
||||||
|
|
||||||
|
// MarshalJSON writes the raw manifest, or {"digest": ...} when only the digest is known.
|
||||||
|
func (m Manifest) MarshalJSON() ([]byte, error) {
|
||||||
|
if len(m.Raw) > 0 {
|
||||||
|
return m.Raw, nil
|
||||||
|
}
|
||||||
|
return json.Marshal(map[string]string{"digest": m.Digest})
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON reads {"digest": "..."} (an object with that one key) as a digest, and any other value as the raw
|
||||||
|
// manifest.
|
||||||
|
func (m *Manifest) UnmarshalJSON(raw []byte) error {
|
||||||
|
var probe map[string]json.RawMessage
|
||||||
|
if json.Unmarshal(raw, &probe) == nil && len(probe) == 1 {
|
||||||
|
if d, ok := probe["digest"]; ok {
|
||||||
|
var digest string
|
||||||
|
if err := json.Unmarshal(d, &digest); err != nil {
|
||||||
|
return fmt.Errorf("a manifest's digest is not a string: %w", err)
|
||||||
|
}
|
||||||
|
*m = Manifest{Digest: digest}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
*m = Manifest{Raw: slices.Clone(raw)}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verdict is what one run answers: the mesh-sdk the command was built with, and each case's verdict in the order asked.
|
||||||
|
type Verdict struct {
|
||||||
|
V int `json:"v"`
|
||||||
|
SDK string `json:"sdk"`
|
||||||
|
Cases []CaseVerdict `json:"cases"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CaseVerdict is one case's: every manifest read or refused, every machine composed or not.
|
||||||
|
type CaseVerdict struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Manifests map[string]ManifestRead `json:"manifests"`
|
||||||
|
Machines map[string]Machine `json:"machines,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ManifestRead is one manifest as this mesh-sdk reads it: accepted, or refused with the reader's words.
|
||||||
|
type ManifestRead struct {
|
||||||
|
Accepted bool `json:"accepted"`
|
||||||
|
Refused string `json:"refused,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Machine is one machine composed: whether it composes (resolves, at DepthResolve), why not, the node-engine
|
||||||
|
// validator's problems and the composition's refusals (DepthCompose), and its declared paths when asked.
|
||||||
|
type Machine struct {
|
||||||
|
Composes bool `json:"composes"`
|
||||||
|
Reason string `json:"reason,omitempty"`
|
||||||
|
Problems []string `json:"problems,omitempty"`
|
||||||
|
Refusals []string `json:"refusals,omitempty"`
|
||||||
|
Declared []Path `json:"declared,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Path is one path a declaration puts on the machine, with its kind (the resource's type), owner, group and mode as
|
||||||
|
// declared, and the module it is of.
|
||||||
|
type Path struct {
|
||||||
|
Path string `json:"path"`
|
||||||
|
Kind string `json:"kind"`
|
||||||
|
Owner string `json:"owner,omitempty"`
|
||||||
|
Group string `json:"group,omitempty"`
|
||||||
|
Mode string `json:"mode,omitempty"`
|
||||||
|
Module string `json:"module,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ErrUnfilled is a manifest named by a digest that nobody replaced by its bytes.
|
||||||
|
var ErrUnfilled = errors.New("composer: a manifest is named by its digest and was not filled")
|
||||||
|
|
||||||
|
// Decode reads a request; it refuses one that is not JSON or of another version.
|
||||||
|
func Decode(data []byte) (Request, error) {
|
||||||
|
var r Request
|
||||||
|
if err := json.Unmarshal(data, &r); err != nil {
|
||||||
|
return Request{}, fmt.Errorf("composer: the request is not JSON of its shape: %w", err)
|
||||||
|
}
|
||||||
|
if r.V != Version {
|
||||||
|
return Request{}, fmt.Errorf("composer: a request of version %d, this composer reads %d", r.V, Version)
|
||||||
|
}
|
||||||
|
return r, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fill replaces every manifest named by its digest by the bytes get answers for that digest; a digest get cannot answer
|
||||||
|
// stops it, named.
|
||||||
|
func Fill(r *Request, get func(digest string) ([]byte, error)) error {
|
||||||
|
fill := func(m map[string]Manifest) error {
|
||||||
|
for name, man := range m {
|
||||||
|
if len(man.Raw) > 0 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
raw, err := get(man.Digest)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("composer: the manifest of %s (digest %s): %w", name, man.Digest, err)
|
||||||
|
}
|
||||||
|
m[name] = Manifest{Raw: raw}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
for _, c := range r.Cases {
|
||||||
|
if err := fill(c.Manifests); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
for _, kept := range c.Kept {
|
||||||
|
if err := fill(kept); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run composes every case of r and answers the verdict, its SDK this binary's mesh-sdk. An error is a request it
|
||||||
|
// cannot run (an unknown depth, a case named twice, a manifest left as a digest); a machine that does not compose is a
|
||||||
|
// verdict.
|
||||||
|
func Run(r Request) (Verdict, error) {
|
||||||
|
depth := r.Depth
|
||||||
|
if depth == "" {
|
||||||
|
depth = DepthCompose
|
||||||
|
}
|
||||||
|
if depth != DepthResolve && depth != DepthCompose {
|
||||||
|
return Verdict{}, fmt.Errorf("composer: the depth %q is not resolve or compose", r.Depth)
|
||||||
|
}
|
||||||
|
v := Verdict{V: Version, SDK: sdkversion.Version()}
|
||||||
|
seen := map[string]bool{}
|
||||||
|
for _, c := range r.Cases {
|
||||||
|
if seen[c.Name] {
|
||||||
|
return Verdict{}, fmt.Errorf("composer: the case %q is named twice", c.Name)
|
||||||
|
}
|
||||||
|
seen[c.Name] = true
|
||||||
|
cv, err := runCase(r, c, depth)
|
||||||
|
if err != nil {
|
||||||
|
return Verdict{}, err
|
||||||
|
}
|
||||||
|
v.Cases = append(v.Cases, cv)
|
||||||
|
}
|
||||||
|
return v, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// readManifest reads one manifest as this run reads every one: against the request's list of predefined keys when it
|
||||||
|
// has one, else as the indexer and the builder read it (Request.Predefined).
|
||||||
|
func readManifest(raw []byte, predefined catalogue.PredefinedList) (catalogue.Manifest, error) {
|
||||||
|
if predefined != nil {
|
||||||
|
return catalogue.ParseManifestWith(raw, predefined)
|
||||||
|
}
|
||||||
|
return catalogue.ParseManifestForInputs(raw)
|
||||||
|
}
|
||||||
|
|
||||||
|
func parse(m map[string]Manifest, reads map[string]ManifestRead, predefined catalogue.PredefinedList) (map[string]catalogue.Manifest, error) {
|
||||||
|
out := map[string]catalogue.Manifest{}
|
||||||
|
for name, man := range m {
|
||||||
|
if len(man.Raw) == 0 {
|
||||||
|
return nil, fmt.Errorf("%w: %s (digest %s)", ErrUnfilled, name, man.Digest)
|
||||||
|
}
|
||||||
|
parsed, err := readManifest(man.Raw, predefined)
|
||||||
|
if reads != nil {
|
||||||
|
if err != nil {
|
||||||
|
reads[name] = ManifestRead{Refused: err.Error()}
|
||||||
|
} else {
|
||||||
|
reads[name] = ManifestRead{Accepted: true}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err == nil {
|
||||||
|
out[name] = parsed
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func runCase(r Request, c Case, depth string) (CaseVerdict, error) {
|
||||||
|
cv := CaseVerdict{Name: c.Name, Manifests: map[string]ManifestRead{}}
|
||||||
|
shelf, err := parse(c.Manifests, cv.Manifests, r.Predefined)
|
||||||
|
if err != nil {
|
||||||
|
return CaseVerdict{}, err
|
||||||
|
}
|
||||||
|
in := r.Input
|
||||||
|
in.Catalogue = shelf
|
||||||
|
in.Nodes = slices.Clone(in.Nodes)
|
||||||
|
in.Holdings = slices.Clone(in.Holdings)
|
||||||
|
for i := range in.Nodes {
|
||||||
|
in.Nodes[i].Kept = nil
|
||||||
|
if kept := c.Kept[in.Nodes[i].Name]; len(kept) > 0 {
|
||||||
|
k, err := parse(kept, nil, r.Predefined)
|
||||||
|
if err != nil {
|
||||||
|
return CaseVerdict{}, err
|
||||||
|
}
|
||||||
|
in.Nodes[i].Kept = k
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if r.HoldingsFromClaims {
|
||||||
|
in.Holdings = append(in.Holdings, HoldingsOf(shelf, in.Nodes)...)
|
||||||
|
}
|
||||||
|
if len(r.Machines) == 0 {
|
||||||
|
return cv, nil
|
||||||
|
}
|
||||||
|
cv.Machines = map[string]Machine{}
|
||||||
|
for _, node := range r.Machines {
|
||||||
|
cv.Machines[node] = machine(in, node, depth, r.Declarations)
|
||||||
|
}
|
||||||
|
return cv, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// HoldingsOf is every seat an assigned module claims, held on the node it is assigned to, in node order: the holdings
|
||||||
|
// of an input that has none of record (the assigner's, mesh-delivery-assigner internal/assign input).
|
||||||
|
func HoldingsOf(shelf map[string]catalogue.Manifest, nodes []compose.Node) []catalogue.Held {
|
||||||
|
var out []catalogue.Held
|
||||||
|
sorted := slices.Clone(nodes)
|
||||||
|
sort.Slice(sorted, func(i, j int) bool { return sorted[i].Name < sorted[j].Name })
|
||||||
|
for _, n := range sorted {
|
||||||
|
for _, mod := range n.Assigned {
|
||||||
|
for _, cl := range shelf[mod].Claims {
|
||||||
|
scope := cl.Scope
|
||||||
|
if seat, ok := catalogue.SeatNamed(cl.Name); ok && scope == "" {
|
||||||
|
scope = seat.Scope
|
||||||
|
}
|
||||||
|
out = append(out, catalogue.Held{Claim: cl.Name, Scope: scope, Node: n.Name, Module: mod})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func machine(in compose.Input, node, depth string, declarations bool) Machine {
|
||||||
|
if depth == DepthResolve {
|
||||||
|
if _, err := compose.Resolve(in, node); err != nil {
|
||||||
|
return Machine{Reason: err.Error()}
|
||||||
|
}
|
||||||
|
return Machine{Composes: true}
|
||||||
|
}
|
||||||
|
d, problems, err := compose.Compose(in, node)
|
||||||
|
if err != nil {
|
||||||
|
return Machine{Reason: err.Error()}
|
||||||
|
}
|
||||||
|
m := Machine{Composes: len(problems) == 0, Problems: problems, Refusals: d.Refusals()}
|
||||||
|
if len(problems) > 0 {
|
||||||
|
m.Reason = "the node-engine's validator refuses the declaration"
|
||||||
|
}
|
||||||
|
if declarations {
|
||||||
|
m.Declared = pathsOf(d)
|
||||||
|
}
|
||||||
|
return m
|
||||||
|
}
|
||||||
|
|
||||||
|
// pathsOf is every resource of a declaration that names a path, with its owner, group and mode as declared, sorted by
|
||||||
|
// path.
|
||||||
|
func pathsOf(d compose.Declared) []Path {
|
||||||
|
var out []Path
|
||||||
|
str := func(r map[string]any, key string) string {
|
||||||
|
if v, ok := r[key]; ok && v != nil {
|
||||||
|
return fmt.Sprint(v)
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
for _, r := range d.Resources {
|
||||||
|
p := str(r, "path")
|
||||||
|
if p == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
out = append(out, Path{Path: p, Kind: str(r, "type"), Owner: str(r, "owner"), Group: str(r, "group"),
|
||||||
|
Mode: str(r, "mode"), Module: d.ModuleOf[str(r, "id")]})
|
||||||
|
}
|
||||||
|
sort.Slice(out, func(i, j int) bool {
|
||||||
|
if out[i].Path != out[j].Path {
|
||||||
|
return out[i].Path < out[j].Path
|
||||||
|
}
|
||||||
|
return out[i].Kind < out[j].Kind
|
||||||
|
})
|
||||||
|
return out
|
||||||
|
}
|
||||||
@@ -0,0 +1,137 @@
|
|||||||
|
package composer
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/catalogue"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/compose"
|
||||||
|
)
|
||||||
|
|
||||||
|
const demo = `{"module": "demo", "version": "1", "claims": [{"name": "node-files"}]}`
|
||||||
|
|
||||||
|
// A manifest named by its digest goes on the wire as {"digest": ...}, and Fill puts the bytes the indexer keeps in its
|
||||||
|
// place; a raw manifest goes as itself.
|
||||||
|
func TestAManifestIsItsBytesOrItsDigest(t *testing.T) {
|
||||||
|
r := Request{V: Version, Cases: []Case{{Name: "change", Manifests: map[string]Manifest{
|
||||||
|
"demo": {Digest: "d1"}, "raw": {Raw: json.RawMessage(`{"module":"raw","version":"1"}`)}},
|
||||||
|
Kept: map[string]map[string]Manifest{"laptop": {"demo": {Digest: "d1"}}}}}}
|
||||||
|
wire, err := json.Marshal(r)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(string(wire), `"demo":{"digest":"d1"}`) || !strings.Contains(string(wire), `"raw":{"module":"raw","version":"1"}`) {
|
||||||
|
t.Fatalf("on the wire: %s", wire)
|
||||||
|
}
|
||||||
|
back, err := Decode(wire)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := Run(back); !errors.Is(err, ErrUnfilled) {
|
||||||
|
t.Fatalf("a digest left unfilled runs: %v", err)
|
||||||
|
}
|
||||||
|
asked := 0
|
||||||
|
if err := Fill(&back, func(d string) ([]byte, error) {
|
||||||
|
asked++
|
||||||
|
if d != "d1" {
|
||||||
|
return nil, errors.New("no such digest")
|
||||||
|
}
|
||||||
|
return []byte(demo), nil
|
||||||
|
}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if asked != 2 || string(back.Cases[0].Manifests["demo"].Raw) != demo || string(back.Cases[0].Kept["laptop"]["demo"].Raw) != demo {
|
||||||
|
t.Fatalf("filled %d times: %+v", asked, back.Cases[0])
|
||||||
|
}
|
||||||
|
bad := Request{V: Version, Cases: []Case{{Name: "c", Manifests: map[string]Manifest{"x": {Digest: "nope"}}}}}
|
||||||
|
if err := Fill(&bad, func(string) ([]byte, error) { return nil, errors.New("not there") }); err == nil || !strings.Contains(err.Error(), "nope") {
|
||||||
|
t.Fatalf("a digest the indexer does not hold: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The input travels as JSON and comes back equal, so the command composes what its caller meant.
|
||||||
|
func TestTheInputTravelsAsJSON(t *testing.T) {
|
||||||
|
in := compose.Input{
|
||||||
|
Nodes: []compose.Node{{Name: "anchor", Assigned: []string{"nats"}, Capabilities: map[string]bool{"systemd": true},
|
||||||
|
Place: compose.Place{Endpoint: "anchor.example:51820", Site: "here", Hub: true, Address: "10.77.0.1"},
|
||||||
|
Pins: map[string]catalogue.Chosen{"bus": {Node: "anchor", Module: "nats"}},
|
||||||
|
Settings: map[string][]catalogue.Layer{"nats": {{Values: map[string]any{"port": float64(4222)}}}}}},
|
||||||
|
Holdings: []catalogue.Held{{Claim: "mesh-broker", Scope: "mesh", Node: "anchor", Module: "nats"}},
|
||||||
|
Issued: []compose.Issued{{Provision: "bus", Consumer: "laptop", ConsumerModule: "x", Provider: "anchor"}},
|
||||||
|
}
|
||||||
|
raw, err := json.Marshal(Request{V: Version, Input: in})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
back, err := Decode(raw)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(back.Input, in) {
|
||||||
|
t.Fatalf("the input came back as\n%+v\nwant\n%+v", back.Input, in)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The seats a node's assigned modules claim are held there when the request says the holdings come from the claims.
|
||||||
|
func TestHoldingsComeFromTheClaims(t *testing.T) {
|
||||||
|
m, err := catalogue.ParseManifest([]byte(demo))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
got := HoldingsOf(map[string]catalogue.Manifest{"demo": m}, []compose.Node{{Name: "b", Assigned: []string{"demo"}}, {Name: "a", Assigned: []string{"demo"}}})
|
||||||
|
if len(got) != 2 || got[0].Node != "a" || got[0].Claim != "node-files" || got[0].Scope != "node" {
|
||||||
|
t.Fatalf("holdings = %+v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A request the command cannot run is refused, never answered as a verdict: another version, a case named twice, an
|
||||||
|
// unknown depth.
|
||||||
|
func TestARequestItCannotRunIsRefused(t *testing.T) {
|
||||||
|
if _, err := Decode([]byte(`{"v": 2}`)); err == nil {
|
||||||
|
t.Error("a request of version 2 is read")
|
||||||
|
}
|
||||||
|
if _, err := Run(Request{V: Version, Cases: []Case{{Name: "a"}, {Name: "a"}}}); err == nil {
|
||||||
|
t.Error("a case named twice runs")
|
||||||
|
}
|
||||||
|
if _, err := Run(Request{V: Version, Depth: "deep"}); err == nil {
|
||||||
|
t.Error("an unknown depth runs")
|
||||||
|
}
|
||||||
|
v, err := Run(Request{V: Version, Cases: []Case{{Name: "only-read", Manifests: map[string]Manifest{"demo": {Raw: json.RawMessage(demo)}}}}})
|
||||||
|
if err != nil || len(v.Cases) != 1 || !v.Cases[0].Manifests["demo"].Accepted || v.Cases[0].Machines != nil || v.SDK == "" {
|
||||||
|
t.Fatalf("a request with no machines: %+v, %v", v, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A manifest whose config value falls back to a predefined key (novox/hq ADR 0348 §7) is read, not refused for the
|
||||||
|
// list of predefined keys at the catalogue's root that a run is never handed with its manifests: the merge gate judges
|
||||||
|
// the fallback in the catalogue. xterm's module.json from mesh-catalog at 835bf22b falls back to "font-size"; a group
|
||||||
|
// touching xterm or pacman failed its composition on this (group check 18df81380db3). A list in the request is the one
|
||||||
|
// judged against, so a fallback it does not name is still refused.
|
||||||
|
func TestAManifestFallingBackToAPredefinedKeyIsRead(t *testing.T) {
|
||||||
|
raw, err := os.ReadFile("../catalogue/testdata/catalogue-835bf22b-xterm.module.json")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(string(raw), `"predefined"`) {
|
||||||
|
t.Fatal("the fixture names no predefined key")
|
||||||
|
}
|
||||||
|
r := Request{V: Version, Cases: []Case{{Name: "change", Manifests: map[string]Manifest{"xterm": {Raw: raw}}}}}
|
||||||
|
v, err := Run(r)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got := v.Cases[0].Manifests["xterm"]; !got.Accepted {
|
||||||
|
t.Fatalf("xterm: %+v, want accepted", got)
|
||||||
|
}
|
||||||
|
r.Predefined = catalogue.PredefinedList{"something-else": {Type: "string", Description: "x"}}
|
||||||
|
if v, err = Run(r); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got := v.Cases[0].Manifests["xterm"]; got.Accepted || !strings.Contains(got.Refused, "not on the list of predefined keys") {
|
||||||
|
t.Fatalf("xterm judged against a list without its key: %+v, want refused naming the list", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
package declaration
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ParseResource reads one resource as Parse reads each of a declaration's resources: by its type, strictly, refusing
|
||||||
|
// a field its kind does not use and anything its kind refuses, and never an action (the link may not carry one, ADR
|
||||||
|
// 0005). It judges the resource alone: what Parse judges across resources (an opening on a node not adopted, the
|
||||||
|
// files the provisioner fills, what replaces what) is for the whole a node applies (novox/hq ADR 0539 clause 1: a
|
||||||
|
// composition is one module's resources, and a node applies its compositions together with its own key).
|
||||||
|
func ParseResource(raw json.RawMessage) (Resource, error) {
|
||||||
|
var head struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Type Type `json:"type"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(raw, &head); err != nil {
|
||||||
|
return nil, &RefusalError{Problems: []string{"not a resource: " + err.Error()}}
|
||||||
|
}
|
||||||
|
where := "resource"
|
||||||
|
if head.ID == "" {
|
||||||
|
return nil, &RefusalError{Problems: []string{where + ": no id. Identity is what lets the host know this is " +
|
||||||
|
"the same resource it applied last time"}}
|
||||||
|
}
|
||||||
|
where = fmt.Sprintf("resource %q", head.ID)
|
||||||
|
resource := newOf(head.Type)
|
||||||
|
if resource == nil {
|
||||||
|
return nil, &RefusalError{Problems: []string{fmt.Sprintf("%s: unknown type %q. This host understands %s",
|
||||||
|
where, head.Type, vocabulary())}}
|
||||||
|
}
|
||||||
|
if unknown := unknownFields(raw, resource); len(unknown) > 0 {
|
||||||
|
var problems []string
|
||||||
|
for _, field := range unknown {
|
||||||
|
problems = append(problems, fmt.Sprintf("%s: a %s does not use %q, and it is set. Refused rather "+
|
||||||
|
"than ignored", where, head.Type, field))
|
||||||
|
}
|
||||||
|
return nil, &RefusalError{Problems: problems}
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(raw, resource); err != nil {
|
||||||
|
return nil, &RefusalError{Problems: []string{fmt.Sprintf("%s: %s", where, err)}}
|
||||||
|
}
|
||||||
|
if problems := resource.validate(where, false); len(problems) > 0 {
|
||||||
|
return nil, &RefusalError{Problems: problems}
|
||||||
|
}
|
||||||
|
return resource, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,510 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// The assigner's keys (novox/hq ADR 0528 clauses 1 and 4, ADR 0429 §6, issue 1297). The assigner writes, by the six
|
||||||
|
// rules of ADR 0429 §6, what each node should run: `want.<node>.<module>` in its bucket wants, and beside it
|
||||||
|
// `held.<module>.<fingerprint>` for a fingerprint it holds after a failed health check. A module that leaves a node's
|
||||||
|
// modules gets its want written removed, never deleted (ADR 0408 §4). For each node and module it compares the want with
|
||||||
|
// what the controller sends (the build the controller's assignment names) and writes every difference under
|
||||||
|
// `<node>.<module>` in its bucket differences, with the rule that explains it or unexplained. In release 5 wants are
|
||||||
|
// only compared; the node agent applying them is release 6 (ADR 0429 §7). Only the assigner's credential writes these
|
||||||
|
// buckets; the watchman, the view and the controller read them.
|
||||||
|
//
|
||||||
|
// **Release 6** (ADR 0539 clauses 1, 6 and 16): a want also names the digest of the one composition it allows, written
|
||||||
|
// only once that composition exists (the seventh rule, RuleComposed), and carries the answer to a failed backup; the
|
||||||
|
// node's own want `want.<node>.node` names the digest of the node's own composition (NodeWant).
|
||||||
|
//
|
||||||
|
// **The bucket is the first word, the key the rest** (as the builder's `builds.<module>.<fp>` is the key
|
||||||
|
// `<module>.<fp>` in its builds bucket): the differences bucket's keys are `<node>.<module>`. The wants bucket holds
|
||||||
|
// two kinds of key, so each keeps its word: `want.<node>.<module>` and `held.<module>.<fingerprint hex>`.
|
||||||
|
const (
|
||||||
|
// AssignerModule is the module of the assigner part.
|
||||||
|
AssignerModule = "mesh-delivery-assigner"
|
||||||
|
// AssignerWantsBucket is the assigner's bucket of wants and holds, `<owner module>_<name>`.
|
||||||
|
AssignerWantsBucket = AssignerModule + "_wants"
|
||||||
|
// AssignerWantsHistory is the revisions the wants bucket keeps per key, so a want's history shows each move and
|
||||||
|
// the operator's manual write (ADR 0429 §6, the one escape).
|
||||||
|
AssignerWantsHistory = 20
|
||||||
|
// AssignerDifferencesBucket is the assigner's bucket of differences between a want and what the controller sends.
|
||||||
|
AssignerDifferencesBucket = AssignerModule + "_differences"
|
||||||
|
// AssignerDifferencesHistory is the revisions the differences bucket keeps per key: acceptance test 17 of design 47
|
||||||
|
// reads a day of them.
|
||||||
|
AssignerDifferencesHistory = 64
|
||||||
|
)
|
||||||
|
|
||||||
|
// The words that open the wants bucket's two kinds of key.
|
||||||
|
const (
|
||||||
|
wantWord = "want"
|
||||||
|
heldWord = "held"
|
||||||
|
)
|
||||||
|
|
||||||
|
// WantKey is the key, in AssignerWantsBucket, of a node's want for a module: `want.<node>.<module>`. A module named
|
||||||
|
// `node` is refused, since `want.<node>.node` is the node's own key (ADR 0429 §4), as HaveKey refuses it.
|
||||||
|
func WantKey(node, module string) (string, error) {
|
||||||
|
have, err := HaveKey(node, module)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return wantWord + "." + have, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// WantNodeKey is the key, in AssignerWantsBucket, of a node's own want: `want.<node>.node`, naming the digest of the
|
||||||
|
// node's own composition (ADR 0539 clause 6; ADR 0429 §4's node key). The assigner writes it once the node's own
|
||||||
|
// composition exists.
|
||||||
|
func WantNodeKey(node string) (string, error) {
|
||||||
|
own, err := HaveNodeKey(node)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return wantWord + "." + own, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseWantNodeKey is the inverse of WantNodeKey; it refuses a module's want key and any key of another bucket,
|
||||||
|
// naming it.
|
||||||
|
func ParseWantNodeKey(key string) (node string, err error) {
|
||||||
|
rest, ok := strings.CutPrefix(key, wantWord+".")
|
||||||
|
if !ok {
|
||||||
|
return "", fmt.Errorf("delivery: %q is not a node's own want key, want.<node>.node", key)
|
||||||
|
}
|
||||||
|
node, _, isNode, err := ParseHaveKey(rest)
|
||||||
|
if err != nil || !isNode {
|
||||||
|
return "", fmt.Errorf("delivery: %q is not a node's own want key, want.<node>.node", key)
|
||||||
|
}
|
||||||
|
return node, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseWantKey is the inverse of WantKey; it refuses a held key, a have key, the node's own want key and any key of
|
||||||
|
// another bucket, naming it.
|
||||||
|
func ParseWantKey(key string) (node, module string, err error) {
|
||||||
|
rest, ok := strings.CutPrefix(key, wantWord+".")
|
||||||
|
if !ok {
|
||||||
|
return "", "", fmt.Errorf("delivery: %q is not a want key, want.<node>.<module>", key)
|
||||||
|
}
|
||||||
|
node, module, isNode, err := ParseHaveKey(rest)
|
||||||
|
if err != nil || isNode {
|
||||||
|
return "", "", fmt.Errorf("delivery: %q is not a want key, want.<node>.<module>", key)
|
||||||
|
}
|
||||||
|
return node, module, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// HeldKey is the key, in AssignerWantsBucket, of a module's fingerprint the assigner holds: `held.<module>.<hex>`,
|
||||||
|
// the hex being the fingerprint's key part (FingerprintKeyPart).
|
||||||
|
func HeldKey(module, fingerprint string) (string, error) {
|
||||||
|
key, err := BuilderBuildKey(module, fingerprint)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return heldWord + "." + key, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseHeldKey is the inverse of HeldKey: the module and the fingerprint (`src2:` and the hex); it refuses a want key
|
||||||
|
// and any key of another bucket, naming it.
|
||||||
|
func ParseHeldKey(key string) (module, fingerprint string, err error) {
|
||||||
|
rest, ok := strings.CutPrefix(key, heldWord+".")
|
||||||
|
if !ok {
|
||||||
|
return "", "", fmt.Errorf("delivery: %q is not a held key, held.<module>.<fingerprint hex>", key)
|
||||||
|
}
|
||||||
|
if module, fingerprint, err = ParseBuilderBuildKey(rest); err != nil {
|
||||||
|
return "", "", fmt.Errorf("delivery: %q is not a held key: %w", key, err)
|
||||||
|
}
|
||||||
|
return module, fingerprint, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// DifferenceKey is the key, in AssignerDifferencesBucket, of the difference for a module on a node: `<node>.<module>`.
|
||||||
|
func DifferenceKey(node, module string) (string, error) {
|
||||||
|
return HaveKey(node, module)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseDifferenceKey is the inverse of DifferenceKey; it refuses a want or held key and a node's own key, naming it.
|
||||||
|
func ParseDifferenceKey(key string) (node, module string, err error) {
|
||||||
|
node, module, isNode, err := ParseHaveKey(key)
|
||||||
|
if err != nil || isNode {
|
||||||
|
return "", "", fmt.Errorf("delivery: %q is not a difference key, <node>.<module>", key)
|
||||||
|
}
|
||||||
|
return node, module, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// The rules of ADR 0429 §6 and ADR 0539 clause 6, by number, as a want or a difference names the one that holds a node
|
||||||
|
// back.
|
||||||
|
const (
|
||||||
|
RuleBuildDone = 1 // the build of F is done
|
||||||
|
RuleNotHeld = 2 // F is not held
|
||||||
|
RuleCanary = 3 // the node is the module's canary, or the canary runs F healthy
|
||||||
|
RuleStep = 4 // at most step other nodes are ahead (step 0: no limit, ADR 0528 §3)
|
||||||
|
RuleProviders = 5 // every provider the module requires runs healthy on that node, or at its canary
|
||||||
|
RuleGrant = 6 // the module's credential for F exists (grants.<module>.<fp>)
|
||||||
|
RuleComposed = 7 // the module's composition for that node at F exists (mesh-controller_composed, ADR 0539 §6)
|
||||||
|
)
|
||||||
|
|
||||||
|
func checkRule(rule int, of string) error {
|
||||||
|
if rule < RuleBuildDone || rule > RuleComposed {
|
||||||
|
return fmt.Errorf("delivery: %s names the rule %d, which is not one of the seven (1 to 7)", of, rule)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// The answers a want carries to a failed backup before an apply (ADR 0539 clause 16): the node agent reads them from
|
||||||
|
// its own want and from nothing else.
|
||||||
|
const (
|
||||||
|
// BackupAgain is the answer to back the module up again before the apply.
|
||||||
|
BackupAgain = "again"
|
||||||
|
// BackupSkip is the answer to go on without a backup.
|
||||||
|
BackupSkip = "skip"
|
||||||
|
)
|
||||||
|
|
||||||
|
func checkFingerprint(fp, of string) error {
|
||||||
|
if _, err := FingerprintKeyPart(fp); err != nil {
|
||||||
|
return fmt.Errorf("delivery: %s: %w", of, err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Want is a node's want for a module: the fingerprint FP the node should run and the digest Composed of the one
|
||||||
|
// composition of it the node may apply (ADR 0539 clause 1), or Removed for a module that left the node's modules (then
|
||||||
|
// both are empty). When the module's newest fingerprint is not yet allowed on this node, Newest names it and Rule the
|
||||||
|
// rule that holds the node back; both are empty when FP is the newest. Backup is the answer to a failed backup before
|
||||||
|
// the apply, BackupAgain or BackupSkip (clause 16), empty when none was asked. Words say why in a sentence. The
|
||||||
|
// entry's own time says since when.
|
||||||
|
type Want struct {
|
||||||
|
V int `json:"v"`
|
||||||
|
FP string `json:"fp,omitempty"`
|
||||||
|
Composed string `json:"composed,omitempty"`
|
||||||
|
Removed bool `json:"removed,omitempty"`
|
||||||
|
Newest string `json:"newest,omitempty"`
|
||||||
|
Rule int `json:"rule,omitempty"`
|
||||||
|
Backup string `json:"backup,omitempty"`
|
||||||
|
Words string `json:"words,omitempty"`
|
||||||
|
// Put says the want was written by a put (ADR 0546), and Hold that the put holds it: the rules pass over it until it
|
||||||
|
// is released. A put's want names no newest fingerprint or rule.
|
||||||
|
Put bool `json:"put,omitempty"`
|
||||||
|
Hold bool `json:"hold,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w Want) check() error {
|
||||||
|
if w.Removed {
|
||||||
|
if w.FP != "" || w.Composed != "" || w.Newest != "" || w.Rule != 0 || w.Backup != "" || w.Put || w.Hold {
|
||||||
|
return fmt.Errorf("delivery: a removed want names no fingerprint, composition, rule, backup answer or put")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if w.Hold && !w.Put {
|
||||||
|
return fmt.Errorf("delivery: only a put holds a want")
|
||||||
|
}
|
||||||
|
if w.Put && (w.Newest != "" || w.Rule != 0) {
|
||||||
|
return fmt.Errorf("delivery: a put's want is held back by no rule")
|
||||||
|
}
|
||||||
|
if err := checkFingerprint(w.FP, "a want's fingerprint"); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if w.Composed == "" {
|
||||||
|
return fmt.Errorf("delivery: the want of %s names no composition: a want names the digest of the one composition it allows (ADR 0539 clause 1)", w.FP)
|
||||||
|
}
|
||||||
|
if err := checkDigest(w.Composed, "a want's composition digest"); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
switch w.Backup {
|
||||||
|
case "", BackupAgain, BackupSkip:
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("delivery: the backup answer %q is not %s or %s", w.Backup, BackupAgain, BackupSkip)
|
||||||
|
}
|
||||||
|
if w.Newest == "" && w.Rule == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err := checkFingerprint(w.Newest, "a want's newest fingerprint"); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if w.Newest == w.FP {
|
||||||
|
return fmt.Errorf("delivery: a want at its newest fingerprint names no rule holding it back")
|
||||||
|
}
|
||||||
|
return checkRule(w.Rule, "a want held back")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Held is a fingerprint the assigner holds: the node whose health check failed on it, and the check's words.
|
||||||
|
type Held struct {
|
||||||
|
V int `json:"v"`
|
||||||
|
Node string `json:"node"`
|
||||||
|
Words string `json:"words,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h Held) check() error {
|
||||||
|
return checkName("node", h.Node)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Difference is where a want and what the controller sends differ for a module on a node (ADR 0528 clause 4): the
|
||||||
|
// want's fingerprint (Want, empty when the node has no want for the module, WantRemoved when the want is removed), the
|
||||||
|
// fingerprint of the build the controller's assignment names (Sent, empty when it sends none or the build names no
|
||||||
|
// fingerprint; SentBuild names that build), and the rule that explains the difference, or Unexplained.
|
||||||
|
type Difference struct {
|
||||||
|
V int `json:"v"`
|
||||||
|
Want string `json:"want,omitempty"`
|
||||||
|
WantRemoved bool `json:"want-removed,omitempty"`
|
||||||
|
Sent string `json:"sent,omitempty"`
|
||||||
|
SentBuild string `json:"sent-build,omitempty"`
|
||||||
|
Rule int `json:"rule,omitempty"`
|
||||||
|
Unexplained bool `json:"unexplained,omitempty"`
|
||||||
|
Words string `json:"words,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d Difference) check() error {
|
||||||
|
if d.WantRemoved && d.Want != "" {
|
||||||
|
return fmt.Errorf("delivery: a difference with a removed want names no wanted fingerprint")
|
||||||
|
}
|
||||||
|
if d.Want != "" {
|
||||||
|
if err := checkFingerprint(d.Want, "a difference's want"); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if d.Sent != "" {
|
||||||
|
if err := checkFingerprint(d.Sent, "a difference's sent fingerprint"); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !d.WantRemoved && d.Want == d.Sent && (d.Want != "" || d.SentBuild == "") {
|
||||||
|
return fmt.Errorf("delivery: a difference whose want and send are both %q is no difference", d.Want)
|
||||||
|
}
|
||||||
|
if d.Unexplained {
|
||||||
|
if d.Rule != 0 {
|
||||||
|
return fmt.Errorf("delivery: an unexplained difference names no rule")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return checkRule(d.Rule, "a difference")
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncodeWant is w as JSON at Version; it refuses a fingerprint not of the new form, a removed want naming one, and a
|
||||||
|
// want held back without its rule.
|
||||||
|
func EncodeWant(w Want) ([]byte, error) {
|
||||||
|
if err := w.check(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
w.V = Version
|
||||||
|
return json.Marshal(w)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecodeWant reads a want; it refuses an unknown version (ErrUnknownVersion) and what EncodeWant refuses.
|
||||||
|
func DecodeWant(data []byte) (Want, error) {
|
||||||
|
var w Want
|
||||||
|
if err := decode(data, &w); err != nil {
|
||||||
|
return Want{}, err
|
||||||
|
}
|
||||||
|
if err := w.check(); err != nil {
|
||||||
|
return Want{}, err
|
||||||
|
}
|
||||||
|
return w, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SameWant says whether two wants are the same value, so the assigner writes only when they differ.
|
||||||
|
func SameWant(a, b Want) bool { return a == b }
|
||||||
|
|
||||||
|
// NodeWant is a node's own want (WantNodeKey): the digest Composed of the node's own composition it may apply. Words
|
||||||
|
// say why in a sentence.
|
||||||
|
type NodeWant struct {
|
||||||
|
V int `json:"v"`
|
||||||
|
Composed string `json:"composed"`
|
||||||
|
Words string `json:"words,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncodeNodeWant is w as JSON at Version; it refuses a digest not of the sha256 form.
|
||||||
|
func EncodeNodeWant(w NodeWant) ([]byte, error) {
|
||||||
|
if err := checkDigest(w.Composed, "the node's own want's composition digest"); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
w.V = Version
|
||||||
|
return json.Marshal(w)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecodeNodeWant reads a node's own want; it refuses an unknown version (ErrUnknownVersion), a field a node's own want
|
||||||
|
// does not have (a fingerprint among them), and what EncodeNodeWant refuses.
|
||||||
|
func DecodeNodeWant(data []byte) (NodeWant, error) {
|
||||||
|
if err := checkVersion(data); err != nil {
|
||||||
|
return NodeWant{}, err
|
||||||
|
}
|
||||||
|
var w NodeWant
|
||||||
|
d := json.NewDecoder(bytes.NewReader(data))
|
||||||
|
d.DisallowUnknownFields()
|
||||||
|
if err := d.Decode(&w); err != nil {
|
||||||
|
return NodeWant{}, fmt.Errorf("delivery: a node's own want does not fit its shape: %w", err)
|
||||||
|
}
|
||||||
|
if err := checkDigest(w.Composed, "the node's own want's composition digest"); err != nil {
|
||||||
|
return NodeWant{}, err
|
||||||
|
}
|
||||||
|
return w, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncodeHeld is h as JSON at Version; it refuses a node name a key refuses.
|
||||||
|
func EncodeHeld(h Held) ([]byte, error) {
|
||||||
|
if err := h.check(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
h.V = Version
|
||||||
|
return json.Marshal(h)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecodeHeld reads a hold; it refuses an unknown version (ErrUnknownVersion) and what EncodeHeld refuses.
|
||||||
|
func DecodeHeld(data []byte) (Held, error) {
|
||||||
|
var h Held
|
||||||
|
if err := decode(data, &h); err != nil {
|
||||||
|
return Held{}, err
|
||||||
|
}
|
||||||
|
if err := h.check(); err != nil {
|
||||||
|
return Held{}, err
|
||||||
|
}
|
||||||
|
return h, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SameHeld says whether two holds are the same value.
|
||||||
|
func SameHeld(a, b Held) bool { return a == b }
|
||||||
|
|
||||||
|
// EncodeDifference is d as JSON at Version; it refuses a difference with neither a rule nor unexplained, one with both,
|
||||||
|
// a rule outside the six, and a want equal to the send.
|
||||||
|
func EncodeDifference(d Difference) ([]byte, error) {
|
||||||
|
if err := d.check(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
d.V = Version
|
||||||
|
return json.Marshal(d)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecodeDifference reads a difference; it refuses an unknown version (ErrUnknownVersion) and what EncodeDifference
|
||||||
|
// refuses.
|
||||||
|
func DecodeDifference(data []byte) (Difference, error) {
|
||||||
|
var d Difference
|
||||||
|
if err := decode(data, &d); err != nil {
|
||||||
|
return Difference{}, err
|
||||||
|
}
|
||||||
|
if err := d.check(); err != nil {
|
||||||
|
return Difference{}, err
|
||||||
|
}
|
||||||
|
return d, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SameDifference says whether two differences are the same value.
|
||||||
|
func SameDifference(a, b Difference) bool { return reflect.DeepEqual(a, b) }
|
||||||
|
|
||||||
|
// The assigner's composition check (novox/hq ADR 0446 clauses 1 to 5, ADR 0528 clause 5, ADR 0482 clauses 3 and 9): for
|
||||||
|
// each group the checker judges, the assigner composes the machines the change touches and writes its verdict under
|
||||||
|
// the checker's key of that check, `<escaped group>.<heads hash>` (CheckerVerdictKey's form), in its bucket
|
||||||
|
// compositions. The checker watches that key and reads it into its verdict's composition (Composition); a key not yet
|
||||||
|
// written is a composition still running.
|
||||||
|
const (
|
||||||
|
// AssignerCompositionsBucket is the assigner's bucket of composition verdicts.
|
||||||
|
AssignerCompositionsBucket = AssignerModule + "_compositions"
|
||||||
|
// AssignerCompositionsHistory is the revisions the bucket keeps per key.
|
||||||
|
AssignerCompositionsHistory = 5
|
||||||
|
// CompositionWaits is the state of a composition that waits for what it composes from (ADR 0446 clause 3: the
|
||||||
|
// indexer holds no candidates for the group yet), its Words saying what; it is no verdict.
|
||||||
|
CompositionWaits = "waits"
|
||||||
|
// CompositionRebuildWarning is the most modules a merge may rebuild before the composition warns (ADR 0446 clause 1).
|
||||||
|
CompositionRebuildWarning = 12
|
||||||
|
)
|
||||||
|
|
||||||
|
// CompositionKey is the key, in AssignerCompositionsBucket, of the composition of a group's check at its heads: the
|
||||||
|
// checker's verdict key of the same check (CheckerVerdictKey).
|
||||||
|
func CompositionKey(group, headsHash string) (string, error) {
|
||||||
|
return CheckerVerdictKey(group, headsHash)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseCompositionKey is the inverse of CompositionKey; it refuses a want, held or difference key, naming it.
|
||||||
|
func ParseCompositionKey(key string) (group, headsHash string, err error) {
|
||||||
|
if group, headsHash, err = ParseCheckerVerdictKey(key); err != nil {
|
||||||
|
return "", "", fmt.Errorf("delivery: %q is not a composition key, <group>.<heads hash>: %w", key, err)
|
||||||
|
}
|
||||||
|
return group, headsHash, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// CompositionVerdict is the value of a composition key: the group and its heads hash, the State (pass, fail or waits),
|
||||||
|
// the Words of a refusal or of what it waits for, the mesh-sdk commit it composed with (the assigner's own, or the
|
||||||
|
// group's mesh-sdk member's head, ADR 0482 clause 3), the machines composed, the first machine that failed, the
|
||||||
|
// warnings that fail nothing (more than twelve modules rebuilt; what was already broken before the change, ADR 0446
|
||||||
|
// clause 1), and the time it took in integer milliseconds.
|
||||||
|
type CompositionVerdict struct {
|
||||||
|
V int `json:"v"`
|
||||||
|
Group string `json:"group"`
|
||||||
|
Heads string `json:"heads"`
|
||||||
|
State string `json:"state"`
|
||||||
|
Words string `json:"words,omitempty"`
|
||||||
|
SDK string `json:"sdk,omitempty"`
|
||||||
|
Machines []string `json:"machines,omitempty"`
|
||||||
|
Machine string `json:"machine,omitempty"`
|
||||||
|
Warnings []string `json:"warnings,omitempty"`
|
||||||
|
Took int64 `json:"took,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c CompositionVerdict) check() error {
|
||||||
|
if c.Group == "" {
|
||||||
|
return fmt.Errorf("delivery: a composition names no group")
|
||||||
|
}
|
||||||
|
if !isHex12(c.Heads) {
|
||||||
|
return fmt.Errorf("delivery: the composition's heads hash %q is not 12 lowercase hex digits", c.Heads)
|
||||||
|
}
|
||||||
|
if c.Took < 0 {
|
||||||
|
return fmt.Errorf("delivery: the composition's time is negative")
|
||||||
|
}
|
||||||
|
switch c.State {
|
||||||
|
case CompositionPass:
|
||||||
|
if c.SDK == "" {
|
||||||
|
return fmt.Errorf("delivery: a composition that passed names no mesh-sdk commit")
|
||||||
|
}
|
||||||
|
if c.Machine != "" || c.Words != "" {
|
||||||
|
return fmt.Errorf("delivery: a composition that passed names no failure")
|
||||||
|
}
|
||||||
|
case CompositionFail:
|
||||||
|
if c.Words == "" {
|
||||||
|
return fmt.Errorf("delivery: a composition that failed gives no words")
|
||||||
|
}
|
||||||
|
if c.SDK == "" {
|
||||||
|
return fmt.Errorf("delivery: a composition that failed names no mesh-sdk commit")
|
||||||
|
}
|
||||||
|
case CompositionWaits:
|
||||||
|
if c.Words == "" {
|
||||||
|
return fmt.Errorf("delivery: a composition that waits does not say for what")
|
||||||
|
}
|
||||||
|
if c.Machine != "" || len(c.Machines) > 0 {
|
||||||
|
return fmt.Errorf("delivery: a composition that waits composed no machine")
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("delivery: the composition state %q is not %s, %s or %s", c.State, CompositionPass, CompositionFail, CompositionWaits)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Composition is what the checker writes into its verdict from c: nil while c waits (the check is still running).
|
||||||
|
func (c CompositionVerdict) Composition() *Composition {
|
||||||
|
if c.State == CompositionWaits {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return &Composition{State: c.State, Words: c.Words, SDK: c.SDK, Machines: c.Machines}
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncodeCompositionVerdict is c as JSON at Version; it refuses an unknown state, a pass or fail naming no mesh-sdk
|
||||||
|
// commit, a fail without words, a pass naming a failure, and a wait that composed a machine.
|
||||||
|
func EncodeCompositionVerdict(c CompositionVerdict) ([]byte, error) {
|
||||||
|
if err := c.check(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
c.V = Version
|
||||||
|
return json.Marshal(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecodeCompositionVerdict reads a composition; it refuses an unknown version (ErrUnknownVersion) and what
|
||||||
|
// EncodeCompositionVerdict refuses.
|
||||||
|
func DecodeCompositionVerdict(data []byte) (CompositionVerdict, error) {
|
||||||
|
var c CompositionVerdict
|
||||||
|
if err := decode(data, &c); err != nil {
|
||||||
|
return CompositionVerdict{}, err
|
||||||
|
}
|
||||||
|
if err := c.check(); err != nil {
|
||||||
|
return CompositionVerdict{}, err
|
||||||
|
}
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SameCompositionVerdict says whether two compositions are the same value.
|
||||||
|
func SameCompositionVerdict(a, b CompositionVerdict) bool { return reflect.DeepEqual(a, b) }
|
||||||
@@ -0,0 +1,317 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// 1297/B1a: a want key round-trips through its parser; a held key, a have key and a node's own key are refused,
|
||||||
|
// naming the key.
|
||||||
|
func TestWantKey(t *testing.T) {
|
||||||
|
key, err := WantKey("ace", "mesh-mail")
|
||||||
|
if err != nil || key != "want.ace.mesh-mail" {
|
||||||
|
t.Fatalf("WantKey = %q, %v", key, err)
|
||||||
|
}
|
||||||
|
node, module, err := ParseWantKey(key)
|
||||||
|
if err != nil || node != "ace" || module != "mesh-mail" {
|
||||||
|
t.Errorf("ParseWantKey = %q, %q, %v", node, module, err)
|
||||||
|
}
|
||||||
|
for _, n := range [][2]string{{"ace", "node"}, {"a.b", "m"}, {"ace", ""}, {"", "m"}, {"ace", "m*"}} {
|
||||||
|
if _, err := WantKey(n[0], n[1]); err == nil {
|
||||||
|
t.Errorf("WantKey(%q, %q) accepted", n[0], n[1])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
held, _ := HeldKey("mesh-mail", fp2of('a'))
|
||||||
|
for _, bad := range []string{"ace.mesh-mail", "want.ace.node", "want.ace", "want.ace.m.x", held, "wants.ace.m", ""} {
|
||||||
|
if _, _, err := ParseWantKey(bad); err == nil || !strings.Contains(err.Error(), "\""+bad+"\"") {
|
||||||
|
t.Errorf("ParseWantKey(%q) = %v, want a refusal naming it", bad, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1297/B1a: a held key round-trips; a want key, a builder build key and a fingerprint not of the new form are refused.
|
||||||
|
func TestHeldKey(t *testing.T) {
|
||||||
|
fp := fp2of('b')
|
||||||
|
key, err := HeldKey("mesh-mail", fp)
|
||||||
|
if err != nil || key != "held.mesh-mail."+strings.Repeat("b", 64) {
|
||||||
|
t.Fatalf("HeldKey = %q, %v", key, err)
|
||||||
|
}
|
||||||
|
module, back, err := ParseHeldKey(key)
|
||||||
|
if err != nil || module != "mesh-mail" || back != fp {
|
||||||
|
t.Errorf("ParseHeldKey = %q, %q, %v", module, back, err)
|
||||||
|
}
|
||||||
|
src1, _ := SourceFingerprint(SourceInputs{Module: "m", Tree: "t"})
|
||||||
|
if _, err := HeldKey("mesh-mail", src1); err == nil {
|
||||||
|
t.Errorf("a src1 fingerprint was held")
|
||||||
|
}
|
||||||
|
build, _ := BuilderBuildKey("mesh-mail", fp)
|
||||||
|
for _, bad := range []string{build, "want.ace.mesh-mail", "held.mesh-mail.abc", "held." + strings.Repeat("b", 64), ""} {
|
||||||
|
if _, _, err := ParseHeldKey(bad); err == nil || !strings.Contains(err.Error(), "\""+bad+"\"") {
|
||||||
|
t.Errorf("ParseHeldKey(%q) = %v, want a refusal naming it", bad, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1297/B1a: a difference key round-trips; a want or held key and a node's own key are refused.
|
||||||
|
func TestDifferenceKey(t *testing.T) {
|
||||||
|
key, err := DifferenceKey("g14", "mesh-mail")
|
||||||
|
if err != nil || key != "g14.mesh-mail" {
|
||||||
|
t.Fatalf("DifferenceKey = %q, %v", key, err)
|
||||||
|
}
|
||||||
|
node, module, err := ParseDifferenceKey(key)
|
||||||
|
if err != nil || node != "g14" || module != "mesh-mail" {
|
||||||
|
t.Errorf("ParseDifferenceKey = %q, %q, %v", node, module, err)
|
||||||
|
}
|
||||||
|
held, _ := HeldKey("mesh-mail", fp2of('a'))
|
||||||
|
for _, bad := range []string{"want.g14.mesh-mail", held, "g14.node", "g14", ""} {
|
||||||
|
if _, _, err := ParseDifferenceKey(bad); err == nil || !strings.Contains(err.Error(), "\""+bad+"\"") {
|
||||||
|
t.Errorf("ParseDifferenceKey(%q) = %v, want a refusal naming it", bad, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1297/B1a: wants, holds and differences round-trip through their encoders unchanged, at Version.
|
||||||
|
func TestAssignerValuesRoundTrip(t *testing.T) {
|
||||||
|
wants := []Want{
|
||||||
|
{FP: fp2of('a'), Composed: hashOf('1')},
|
||||||
|
{FP: fp2of('a'), Composed: hashOf('1'), Newest: fp2of('b'), Rule: RuleCanary, Words: "the canary ace does not run it healthy yet"},
|
||||||
|
{Removed: true, Words: "the module left g14"},
|
||||||
|
{FP: fp2of('a'), Composed: hashOf('1'), Put: true, Hold: true, Words: "put by the operator: the bus's user list"},
|
||||||
|
}
|
||||||
|
for _, w := range wants {
|
||||||
|
data, err := EncodeWant(w)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("EncodeWant(%+v): %v", w, err)
|
||||||
|
}
|
||||||
|
got, err := DecodeWant(data)
|
||||||
|
w.V = Version
|
||||||
|
if err != nil || !SameWant(got, w) {
|
||||||
|
t.Errorf("want %+v came back %+v, %v", w, got, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
at := time.Date(2026, 10, 25, 21, 0, 0, 0, time.UTC)
|
||||||
|
p := Put{FP: fp2of('a'), Hold: true, Why: "the bus's user list", By: "shanks.node-tools", At: at}.Said(at, PutAsked, "put asked")
|
||||||
|
p = p.Said(at, PutAsked, "put asked").Said(at.Add(time.Second), PutWanted, "want written")
|
||||||
|
p.Composed = hashOf('1')
|
||||||
|
if len(p.Steps) != 2 || p.Step != PutWanted || PutEnded(p.Step) || !PutEnded(PutReleased) {
|
||||||
|
t.Errorf("a put's steps are %+v at %s", p.Steps, p.Step)
|
||||||
|
}
|
||||||
|
pkey, _ := PutKey("novox", "nats")
|
||||||
|
if n, m, err := ParsePutKey(pkey); err != nil || n != "novox" || m != "nats" {
|
||||||
|
t.Errorf("the put key %s reads %s %s, %v", pkey, n, m, err)
|
||||||
|
}
|
||||||
|
pdata, err := EncodePut(p)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if gotP, err := DecodePut(pdata); err != nil || gotP.FP != p.FP || gotP.Step != PutWanted || len(gotP.Steps) != 2 || !gotP.Hold {
|
||||||
|
t.Errorf("the put came back %+v, %v", gotP, err)
|
||||||
|
}
|
||||||
|
h := Held{Node: "ace", Words: "its health check failed: connection refused"}
|
||||||
|
data, err := EncodeHeld(h)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
gotH, err := DecodeHeld(data)
|
||||||
|
h.V = Version
|
||||||
|
if err != nil || !SameHeld(gotH, h) {
|
||||||
|
t.Errorf("held came back %+v, %v", gotH, err)
|
||||||
|
}
|
||||||
|
diffs := []Difference{
|
||||||
|
{Want: fp2of('a'), Sent: fp2of('b'), Rule: RuleCanary},
|
||||||
|
{Sent: fp2of('b'), Rule: RuleBuildDone},
|
||||||
|
{WantRemoved: true, Sent: fp2of('b'), Unexplained: true},
|
||||||
|
{SentBuild: "build-17", Rule: RuleGrant},
|
||||||
|
}
|
||||||
|
for _, d := range diffs {
|
||||||
|
data, err := EncodeDifference(d)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("EncodeDifference(%+v): %v", d, err)
|
||||||
|
}
|
||||||
|
got, err := DecodeDifference(data)
|
||||||
|
d.V = Version
|
||||||
|
if err != nil || !SameDifference(got, d) {
|
||||||
|
t.Errorf("difference %+v came back %+v, %v", d, got, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1297/B1a: what a want, a hold and a difference may not say is refused on encode and on decode.
|
||||||
|
func TestAssignerValuesRefused(t *testing.T) {
|
||||||
|
src1, _ := SourceFingerprint(SourceInputs{Module: "m", Tree: "t"})
|
||||||
|
for _, w := range []Want{
|
||||||
|
{},
|
||||||
|
{FP: src1},
|
||||||
|
{Removed: true, FP: fp2of('a')},
|
||||||
|
{FP: fp2of('a'), Newest: fp2of('b')},
|
||||||
|
{FP: fp2of('a'), Newest: fp2of('a'), Rule: 3},
|
||||||
|
{FP: fp2of('a'), Composed: hashOf('1'), Newest: fp2of('b'), Rule: 8},
|
||||||
|
{FP: fp2of('a'), Composed: hashOf('1'), Hold: true},
|
||||||
|
{FP: fp2of('a'), Composed: hashOf('1'), Put: true, Newest: fp2of('b'), Rule: 3},
|
||||||
|
{Removed: true, Put: true},
|
||||||
|
} {
|
||||||
|
if _, err := EncodeWant(w); err == nil {
|
||||||
|
t.Errorf("EncodeWant(%+v) accepted", w)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := EncodeHeld(Held{Node: "a.b"}); err == nil {
|
||||||
|
t.Errorf("a held naming a dotted node was accepted")
|
||||||
|
}
|
||||||
|
for _, d := range []Difference{
|
||||||
|
{Want: fp2of('a'), Sent: fp2of('b')},
|
||||||
|
{Want: fp2of('a'), Sent: fp2of('b'), Rule: 3, Unexplained: true},
|
||||||
|
{Want: fp2of('a'), Sent: fp2of('a'), Rule: 3},
|
||||||
|
{},
|
||||||
|
{Want: fp2of('a'), Sent: fp2of('b'), Rule: 9},
|
||||||
|
{WantRemoved: true, Want: fp2of('a'), Rule: 1},
|
||||||
|
} {
|
||||||
|
if _, err := EncodeDifference(d); err == nil {
|
||||||
|
t.Errorf("EncodeDifference(%+v) accepted", d)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, p := range []Put{
|
||||||
|
{FP: fp2of('a'), Why: "w", Step: "walking"},
|
||||||
|
{FP: fp2of('a'), Step: PutAsked},
|
||||||
|
{FP: "src2:abc", Why: "w", Step: PutAsked},
|
||||||
|
{FP: fp2of('a'), Why: "w", Step: PutWanted, Composed: "sha256:x"},
|
||||||
|
} {
|
||||||
|
if _, err := EncodePut(p); err == nil {
|
||||||
|
t.Errorf("EncodePut(%+v) accepted", p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, _, err := ParsePutKey("ace.node"); err == nil {
|
||||||
|
t.Errorf("a node's own key was read as a put")
|
||||||
|
}
|
||||||
|
if _, err := DecodeWant([]byte(`{"v":2,"fp":"` + fp2of('a') + `"}`)); !errors.Is(err, ErrUnknownVersion) {
|
||||||
|
t.Errorf("a want of version 2 was read: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := DecodeDifference([]byte(`{"v":1,"want":"` + fp2of('a') + `","sent":"` + fp2of('b') + `"}`)); err == nil {
|
||||||
|
t.Errorf("a difference naming no rule was read")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1297/B1b: a composition key is the checker's verdict key of the same check, and round-trips; a want, held or
|
||||||
|
// difference key is refused, naming it.
|
||||||
|
func TestCompositionKey(t *testing.T) {
|
||||||
|
key, err := CompositionKey("feat/r4g", "0123456789ab")
|
||||||
|
verdict, _ := CheckerVerdictKey("feat/r4g", "0123456789ab")
|
||||||
|
if err != nil || key != verdict {
|
||||||
|
t.Fatalf("CompositionKey = %q, %v; the checker's key is %q", key, err, verdict)
|
||||||
|
}
|
||||||
|
group, heads, err := ParseCompositionKey(key)
|
||||||
|
if err != nil || group != "feat/r4g" || heads != "0123456789ab" {
|
||||||
|
t.Errorf("ParseCompositionKey = %q, %q, %v", group, heads, err)
|
||||||
|
}
|
||||||
|
held, _ := HeldKey("mesh-mail", fp2of('a'))
|
||||||
|
for _, bad := range []string{"want.ace.mesh-mail", held, "ace.mesh-mail", "g.0123456789AB", ""} {
|
||||||
|
if _, _, err := ParseCompositionKey(bad); err == nil || !strings.Contains(err.Error(), "\""+bad+"\"") {
|
||||||
|
t.Errorf("ParseCompositionKey(%q) = %v, want a refusal naming it", bad, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1297/B1b: a composition in each state round-trips; the checker's composition of a pass or fail carries its state,
|
||||||
|
// words, mesh-sdk commit and machines, and a wait gives none.
|
||||||
|
func TestCompositionVerdictRoundTrip(t *testing.T) {
|
||||||
|
for _, c := range []CompositionVerdict{
|
||||||
|
{Group: "g", Heads: "0123456789ab", State: CompositionPass, SDK: "7aacbc1", Machines: []string{"ace"}, Took: 120},
|
||||||
|
{Group: "g", Heads: "0123456789ab", State: CompositionFail, SDK: "7aacbc1", Machines: []string{"ace", "g14"}, Machine: "g14",
|
||||||
|
Words: "g14 runs mesh-mail, which the change removes from its source", Warnings: []string{"the merge rebuilds 13 modules"}},
|
||||||
|
{Group: "g", Heads: "0123456789ab", State: CompositionWaits, Words: "the indexer holds no candidates for the group yet"},
|
||||||
|
} {
|
||||||
|
data, err := EncodeCompositionVerdict(c)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("EncodeCompositionVerdict(%+v): %v", c, err)
|
||||||
|
}
|
||||||
|
got, err := DecodeCompositionVerdict(data)
|
||||||
|
c.V = Version
|
||||||
|
if err != nil || !SameCompositionVerdict(got, c) {
|
||||||
|
t.Errorf("composition %+v came back %+v, %v", c, got, err)
|
||||||
|
}
|
||||||
|
comp := got.Composition()
|
||||||
|
if c.State == CompositionWaits {
|
||||||
|
if comp != nil {
|
||||||
|
t.Errorf("a wait gave the checker a composition %+v", comp)
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if comp == nil || comp.State != c.State || comp.SDK != c.SDK || comp.Words != c.Words || len(comp.Machines) != len(c.Machines) {
|
||||||
|
t.Errorf("the checker's composition of %+v is %+v", c, comp)
|
||||||
|
}
|
||||||
|
if err := comp.check(); err != nil {
|
||||||
|
t.Errorf("the checker's composition of %+v is refused by the verdict: %v", c, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1297/B1b: what a composition may not say is refused.
|
||||||
|
func TestCompositionVerdictRefused(t *testing.T) {
|
||||||
|
for _, c := range []CompositionVerdict{
|
||||||
|
{Heads: "0123456789ab", State: CompositionPass, SDK: "x"},
|
||||||
|
{Group: "g", Heads: "0123", State: CompositionPass, SDK: "x"},
|
||||||
|
{Group: "g", Heads: "0123456789ab", State: CompositionPass},
|
||||||
|
{Group: "g", Heads: "0123456789ab", State: CompositionPass, SDK: "x", Machine: "ace"},
|
||||||
|
{Group: "g", Heads: "0123456789ab", State: CompositionFail, SDK: "x"},
|
||||||
|
{Group: "g", Heads: "0123456789ab", State: CompositionFail, Words: "w"},
|
||||||
|
{Group: "g", Heads: "0123456789ab", State: CompositionWaits},
|
||||||
|
{Group: "g", Heads: "0123456789ab", State: CompositionWaits, Words: "w", Machines: []string{"ace"}},
|
||||||
|
{Group: "g", Heads: "0123456789ab", State: CompositionNotRun},
|
||||||
|
{Group: "g", Heads: "0123456789ab", State: CompositionPass, SDK: "x", Took: -1},
|
||||||
|
} {
|
||||||
|
if _, err := EncodeCompositionVerdict(c); err == nil {
|
||||||
|
t.Errorf("EncodeCompositionVerdict(%+v) accepted", c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1394/B1b: a grant key round-trips; a want or held key is refused, naming it; a grant round-trips and one naming an
|
||||||
|
// empty account is refused.
|
||||||
|
func TestControllerGrant(t *testing.T) {
|
||||||
|
fp := fp2of('c')
|
||||||
|
key, err := ControllerGrantKey("mesh-delivery-assigner", fp)
|
||||||
|
if err != nil || key != "mesh-delivery-assigner."+strings.Repeat("c", 64) {
|
||||||
|
t.Fatalf("ControllerGrantKey = %q, %v", key, err)
|
||||||
|
}
|
||||||
|
module, back, err := ParseControllerGrantKey(key)
|
||||||
|
if err != nil || module != "mesh-delivery-assigner" || back != fp {
|
||||||
|
t.Errorf("ParseControllerGrantKey = %q, %q, %v", module, back, err)
|
||||||
|
}
|
||||||
|
held, _ := HeldKey("mesh-mail", fp)
|
||||||
|
for _, bad := range []string{"want.ace.mesh-mail", held, "ace.mesh-mail", ""} {
|
||||||
|
if _, _, err := ParseControllerGrantKey(bad); err == nil || !strings.Contains(err.Error(), "\""+bad+"\"") {
|
||||||
|
t.Errorf("ParseControllerGrantKey(%q) = %v, want a refusal naming it", bad, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, g := range []ControllerGrant{{}, {Accounts: []string{"UABC", "UDEF"}}} {
|
||||||
|
data, err := EncodeControllerGrant(g)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
got, err := DecodeControllerGrant(data)
|
||||||
|
g.V = Version
|
||||||
|
if err != nil || !SameControllerGrant(got, g) {
|
||||||
|
t.Errorf("grant %+v came back %+v, %v", g, got, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := EncodeControllerGrant(ControllerGrant{Accounts: []string{""}}); err == nil {
|
||||||
|
t.Errorf("a grant naming an empty account was accepted")
|
||||||
|
}
|
||||||
|
g := ControllerGrant{Accounts: []string{"ace.mesh-build-go", "shanks.mesh-mail.reader"}}
|
||||||
|
for _, c := range []struct {
|
||||||
|
g ControllerGrant
|
||||||
|
node, module string
|
||||||
|
names bool
|
||||||
|
}{
|
||||||
|
{g, "ace", "mesh-build-go", true},
|
||||||
|
{g, "shanks", "mesh-mail", true},
|
||||||
|
{g, "g14", "mesh-build-go", false},
|
||||||
|
{g, "ace", "mesh-build", false},
|
||||||
|
{ControllerGrant{}, "novox", "nats", true},
|
||||||
|
} {
|
||||||
|
if got := c.g.NamesNode(c.node, c.module); got != c.names {
|
||||||
|
t.Errorf("%v names %s.%s: %v, want %v", c.g.Accounts, c.node, c.module, got, c.names)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -184,6 +184,10 @@ type BuilderBuild struct {
|
|||||||
// does not yet hold: the key is not claimed until that package's trunk key is done and published (novox/hq ADR 0500
|
// does not yet hold: the key is not claimed until that package's trunk key is done and published (novox/hq ADR 0500
|
||||||
// clause 6). A reader that does not know the field reads the key as queued.
|
// clause 6). A reader that does not know the field reads the key as queued.
|
||||||
Waits string `json:"waits,omitempty"`
|
Waits string `json:"waits,omitempty"`
|
||||||
|
// Asks are, on a building key, the asks the builder put for it by build seat language (AskGo, AskNode, AskImage), each
|
||||||
|
// its id (novox/hq ADR 0525 §1; issue 1887 A4b): a builder that takes the key over at its start waits for those asks'
|
||||||
|
// steps and never puts them again. A reader that does not know the field reads the key as before.
|
||||||
|
Asks map[string]string `json:"asks,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
func (b BuilderBuild) check() error {
|
func (b BuilderBuild) check() error {
|
||||||
@@ -216,6 +220,17 @@ func (b BuilderBuild) check() error {
|
|||||||
return fmt.Errorf("delivery: the reference %q of the %s %q %s", a.Reference, a.Kind, a.Name, p)
|
return fmt.Errorf("delivery: the reference %q of the %s %q %s", a.Reference, a.Kind, a.Name, p)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
for language, id := range b.Asks {
|
||||||
|
if b.State != BuildBuilding {
|
||||||
|
return fmt.Errorf("delivery: a %s build names the ask %s; only a building key does", b.State, id)
|
||||||
|
}
|
||||||
|
if err := checkAskLanguage(language); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := checkAskID(id); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
if b.Waits != "" {
|
if b.Waits != "" {
|
||||||
if b.State != BuildQueued {
|
if b.State != BuildQueued {
|
||||||
return fmt.Errorf("delivery: a %s build waits for %q; only a queued key waits for a package", b.State, b.Waits)
|
return fmt.Errorf("delivery: a %s build waits for %q; only a queued key waits for a package", b.State, b.Waits)
|
||||||
|
|||||||
@@ -0,0 +1,265 @@
|
|||||||
|
package buildrun
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/nats-io/nats.go"
|
||||||
|
"github.com/nats-io/nats.go/jetstream"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
// **An asker puts an ask on its build seat's stream and waits for its step** (novox/hq ADR 0525 §1, §6; issue 1887 A4,
|
||||||
|
// A5). It chooses no node: whichever build node pulls the ask writes `<node>.<ask id>` in its build module's steps state,
|
||||||
|
// and the asker reads the first such key that is not running. The builder and the checker share it.
|
||||||
|
|
||||||
|
// AskPublisher puts an encoded ask on subject, de-duplicated by its id.
|
||||||
|
type AskPublisher interface {
|
||||||
|
PublishAsk(ctx context.Context, subject, id string, data []byte) error
|
||||||
|
}
|
||||||
|
|
||||||
|
// AskWaiter watches an ask's steps: every value a key `*.<ask id>` of the build module's steps state takes, running or
|
||||||
|
// ended, on the channel it answers, until ctx ends. A watch, not a poll.
|
||||||
|
type AskWaiter interface {
|
||||||
|
WatchAsk(ctx context.Context, module, askID string) (<-chan delivery.Step, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Asker puts asks and waits for their steps.
|
||||||
|
type Asker struct {
|
||||||
|
Publisher AskPublisher
|
||||||
|
Waiter AskWaiter
|
||||||
|
// Bound is how long a step may run once a build node took the ask (its key written running) before the asker stops
|
||||||
|
// waiting; zero waits as long as ctx. An ask waiting in its stream is not bounded: the stream's backlog is no fault
|
||||||
|
// (ADR 0525 §6, §9), and the bound starts again when another node takes the ask.
|
||||||
|
Bound time.Duration
|
||||||
|
}
|
||||||
|
|
||||||
|
// Put puts a on its stream: the seat's accept subject of its language and kind.
|
||||||
|
func (k Asker) Put(ctx context.Context, a delivery.StepAsk) error {
|
||||||
|
raw, err := delivery.EncodeStepAsk(a)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
subject, err := delivery.AskSubject(a.Language, a.Kind)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := k.Publisher.PublishAsk(ctx, subject, a.ID, raw); err != nil {
|
||||||
|
return fmt.Errorf("putting the %s ask %s: %w", a.Kind, a.ID, err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wait waits for the step of an ask already put (a builder that started again takes over its own asks with it, never
|
||||||
|
// putting them twice) and answers it when it ended, whatever its state. The bound runs from the step's start on the node
|
||||||
|
// that took the ask, read from its running key, so an ask that waits in the stream for a free slot waits as long as ctx.
|
||||||
|
func (k Asker) Wait(ctx context.Context, a delivery.StepAsk) (delivery.Step, error) {
|
||||||
|
module, err := delivery.BuildModuleOf(a.Language)
|
||||||
|
if err != nil {
|
||||||
|
return delivery.Step{}, err
|
||||||
|
}
|
||||||
|
watch, cancel := context.WithCancel(ctx)
|
||||||
|
defer cancel()
|
||||||
|
steps, err := k.Waiter.WatchAsk(watch, module, a.ID)
|
||||||
|
if err != nil {
|
||||||
|
return delivery.Step{}, err
|
||||||
|
}
|
||||||
|
var bound <-chan time.Time
|
||||||
|
var timer *time.Timer
|
||||||
|
defer func() {
|
||||||
|
if timer != nil {
|
||||||
|
timer.Stop()
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
running, since := "", time.Time{}
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return delivery.Step{}, ctx.Err()
|
||||||
|
case <-bound:
|
||||||
|
return delivery.Step{}, fmt.Errorf("the ask %s's step on %s did not end within %s of its start", a.ID, running, k.Bound)
|
||||||
|
case step, ok := <-steps:
|
||||||
|
if !ok {
|
||||||
|
return delivery.Step{}, errors.New("the watch of the ask's step ended")
|
||||||
|
}
|
||||||
|
if step.State != delivery.StepRunning {
|
||||||
|
return step, nil
|
||||||
|
}
|
||||||
|
if k.Bound <= 0 || (step.Node == running && step.Started.Equal(since)) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
// A node took the ask, or took it again after its run stopped (another node, or the same node's build module
|
||||||
|
// replaced mid-run: a new start): its step is bounded from its own start.
|
||||||
|
running, since = step.Node, step.Started
|
||||||
|
left := k.Bound
|
||||||
|
if !step.Started.IsZero() {
|
||||||
|
left = time.Until(step.Started.Add(k.Bound))
|
||||||
|
}
|
||||||
|
if timer != nil {
|
||||||
|
timer.Stop()
|
||||||
|
}
|
||||||
|
timer = time.NewTimer(max(left, 0))
|
||||||
|
bound = timer.C
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ask puts a and waits for its step; a step that did not pass is an error naming its node, its state and its reason.
|
||||||
|
func (k Asker) Ask(ctx context.Context, a delivery.StepAsk) (delivery.Step, error) {
|
||||||
|
if err := k.Put(ctx, a); err != nil {
|
||||||
|
return delivery.Step{}, err
|
||||||
|
}
|
||||||
|
return k.Passed(k.Wait(ctx, a))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Passed is step when it passed, else an error naming where it ended and why.
|
||||||
|
func (k Asker) Passed(step delivery.Step, err error) (delivery.Step, error) {
|
||||||
|
if err != nil {
|
||||||
|
return step, err
|
||||||
|
}
|
||||||
|
if step.State != delivery.StepPassed {
|
||||||
|
return step, fmt.Errorf("the ask %s on %s %s: %s", step.ID, step.Node, step.State, step.Reason)
|
||||||
|
}
|
||||||
|
return step, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// JetStreamAsks is the bus side of an Asker: a JetStream publish de-duplicated by the ask's id (Nats-Msg-Id), and a watch
|
||||||
|
// of `*.<ask id>` in the build module's steps bucket.
|
||||||
|
type JetStreamAsks struct {
|
||||||
|
JS jetstream.JetStream
|
||||||
|
}
|
||||||
|
|
||||||
|
// PublishAsk is AskPublisher's.
|
||||||
|
func (s JetStreamAsks) PublishAsk(ctx context.Context, subject, id string, data []byte) error {
|
||||||
|
msg := &nats.Msg{Subject: subject, Data: data, Header: nats.Header{}}
|
||||||
|
msg.Header.Set(jetstream.MsgIDHeader, id)
|
||||||
|
_, err := s.JS.PublishMsg(ctx, msg)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// WatchAsk is AskWaiter's: the watch hands over what the keys hold now, so a step that ended before it began is read at
|
||||||
|
// once, and every change after.
|
||||||
|
func (s JetStreamAsks) WatchAsk(ctx context.Context, module, askID string) (<-chan delivery.Step, error) {
|
||||||
|
pattern, err := delivery.AskStepWatch(askID)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
kv, err := s.JS.KeyValue(ctx, delivery.StepsBucket(module))
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("the bucket %s: %w", delivery.StepsBucket(module), err)
|
||||||
|
}
|
||||||
|
w, err := kv.Watch(ctx, pattern)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out := make(chan delivery.Step)
|
||||||
|
go func() {
|
||||||
|
defer close(out)
|
||||||
|
defer w.Stop()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
case e, ok := <-w.Updates():
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if e == nil || e.Operation() != jetstream.KeyValuePut {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
step, err := delivery.DecodeStep(e.Value())
|
||||||
|
if err != nil {
|
||||||
|
continue // not a step (a node's pause key never matches an ask id; anything else is not this ask's)
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case out <- step:
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// FakeAsks is a test double of the bus for an asker's tests: each ask put is kept and, when Answer is set, its step is
|
||||||
|
// written at once with what Answer says a build node wrote (running or ended). Write writes a step later. Safe for
|
||||||
|
// concurrent use.
|
||||||
|
type FakeAsks struct {
|
||||||
|
Answer func(a delivery.StepAsk) delivery.Step
|
||||||
|
|
||||||
|
mu sync.Mutex
|
||||||
|
asks []delivery.StepAsk
|
||||||
|
steps map[string][]delivery.Step
|
||||||
|
watchers map[string][]chan delivery.Step
|
||||||
|
}
|
||||||
|
|
||||||
|
// PublishAsk is AskPublisher's.
|
||||||
|
func (f *FakeAsks) PublishAsk(_ context.Context, _, id string, data []byte) error {
|
||||||
|
a, err := delivery.DecodeStepAsk(data)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
f.mu.Lock()
|
||||||
|
f.asks = append(f.asks, a)
|
||||||
|
f.mu.Unlock()
|
||||||
|
if f.Answer != nil {
|
||||||
|
f.Write(f.Answer(a))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write writes an ask's step, as a build node does.
|
||||||
|
func (f *FakeAsks) Write(step delivery.Step) {
|
||||||
|
f.mu.Lock()
|
||||||
|
if f.steps == nil {
|
||||||
|
f.steps, f.watchers = map[string][]delivery.Step{}, map[string][]chan delivery.Step{}
|
||||||
|
}
|
||||||
|
f.steps[step.ID] = append(f.steps[step.ID], step)
|
||||||
|
ws := append([]chan delivery.Step(nil), f.watchers[step.ID]...)
|
||||||
|
f.mu.Unlock()
|
||||||
|
for _, w := range ws {
|
||||||
|
w <- step
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// End is Write: kept for the tests that end a step.
|
||||||
|
func (f *FakeAsks) End(step delivery.Step) { f.Write(step) }
|
||||||
|
|
||||||
|
// WatchAsk is AskWaiter's: what was written so far, then every write.
|
||||||
|
func (f *FakeAsks) WatchAsk(ctx context.Context, _ string, askID string) (<-chan delivery.Step, error) {
|
||||||
|
out := make(chan delivery.Step, 64)
|
||||||
|
f.mu.Lock()
|
||||||
|
if f.steps == nil {
|
||||||
|
f.steps, f.watchers = map[string][]delivery.Step{}, map[string][]chan delivery.Step{}
|
||||||
|
}
|
||||||
|
for _, s := range f.steps[askID] {
|
||||||
|
out <- s
|
||||||
|
}
|
||||||
|
f.watchers[askID] = append(f.watchers[askID], out)
|
||||||
|
f.mu.Unlock()
|
||||||
|
go func() {
|
||||||
|
<-ctx.Done()
|
||||||
|
f.mu.Lock()
|
||||||
|
ws := f.watchers[askID]
|
||||||
|
for i, w := range ws {
|
||||||
|
if w == out {
|
||||||
|
f.watchers[askID] = append(ws[:i], ws[i+1:]...)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
f.mu.Unlock()
|
||||||
|
}()
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Asks are the asks put so far.
|
||||||
|
func (f *FakeAsks) Asks() []delivery.StepAsk {
|
||||||
|
f.mu.Lock()
|
||||||
|
defer f.mu.Unlock()
|
||||||
|
return append([]delivery.StepAsk(nil), f.asks...)
|
||||||
|
}
|
||||||
@@ -0,0 +1,61 @@
|
|||||||
|
//go:build integration
|
||||||
|
|
||||||
|
package buildrun
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/nats-io/nats.go"
|
||||||
|
"github.com/nats-io/nats.go/jetstream"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/testbus"
|
||||||
|
)
|
||||||
|
|
||||||
|
// 1887/A4a, 1887/AC3 on the real bus: an ask put twice under one id is one message, and the asker reads the step a node
|
||||||
|
// wrote under `<node>.<ask id>`.
|
||||||
|
func TestAnAskIsPutOnceAndItsStepIsRead(t *testing.T) {
|
||||||
|
nc, err := nats.Connect(testbus.URL(t))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer nc.Close()
|
||||||
|
js, _ := jetstream.New(nc)
|
||||||
|
ctx := context.Background()
|
||||||
|
if _, err := js.CreateStream(ctx, jetstream.StreamConfig{Name: "SEAT_NODE_BUILD_GO", Subjects: []string{"mesh.seat.node-build-go.accept.>"},
|
||||||
|
Retention: jetstream.WorkQueuePolicy}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
kv, err := js.CreateKeyValue(ctx, jetstream.KeyValueConfig{Bucket: delivery.StepsBucket("mesh-build-go")})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
bus := JetStreamAsks{JS: js}
|
||||||
|
k := Asker{Publisher: bus, Waiter: bus, Bound: 5 * time.Second}
|
||||||
|
a := goAsk("mvl0frv18d1960")
|
||||||
|
for i := 0; i < 2; i++ {
|
||||||
|
if err := k.Put(ctx, a); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
s, _ := js.Stream(ctx, "SEAT_NODE_BUILD_GO")
|
||||||
|
if info, _ := s.Info(ctx); info.State.Msgs != 1 {
|
||||||
|
t.Fatalf("%d messages for one ask put twice", info.State.Msgs)
|
||||||
|
}
|
||||||
|
go func() {
|
||||||
|
time.Sleep(100 * time.Millisecond)
|
||||||
|
key, _ := delivery.AskStepKey("ace", a.ID)
|
||||||
|
running, _ := delivery.EncodeStep(delivery.Step{ID: a.ID, Tool: "delivery ask", Node: "ace", State: delivery.StepRunning, Started: time.Now()})
|
||||||
|
_, _ = kv.Put(ctx, key, running)
|
||||||
|
passed, _ := delivery.EncodeStep(delivery.Step{ID: a.ID, Tool: "delivery ask", Node: "ace", State: delivery.StepPassed, Started: time.Now(),
|
||||||
|
Result: json.RawMessage(`{"artifacts":[]}`)})
|
||||||
|
_, _ = kv.Put(ctx, key, passed)
|
||||||
|
}()
|
||||||
|
step, err := k.Passed(k.Wait(ctx, a))
|
||||||
|
if err != nil || step.Node != "ace" {
|
||||||
|
t.Fatalf("step %+v, %v", step, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
package buildrun
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
func goAsk(id string) delivery.StepAsk {
|
||||||
|
return delivery.StepAsk{ID: id, Kind: delivery.AskDelivery, Language: delivery.AskGo, Asker: "mesh-delivery-builder", At: time.Now(),
|
||||||
|
Build: &delivery.BuildJob{Module: "m", Path: ".", Fetch: map[string]any{"repository": "novox/x", "commit": strings.Repeat("a", 40)},
|
||||||
|
Artifacts: []delivery.AskArtifact{{Artifact: "program"}}}}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1887/A4a: an asker puts the ask once and answers the step a build node wrote for it, naming the node; one that did not
|
||||||
|
// pass is an error naming the node and why; a wait of an ask already put puts nothing.
|
||||||
|
func TestAnAskerPutsOnceAndReadsTheStep(t *testing.T) {
|
||||||
|
f := &FakeAsks{Answer: func(a delivery.StepAsk) delivery.Step {
|
||||||
|
return delivery.Step{ID: a.ID, Node: "ace", State: delivery.StepPassed, Result: []byte(`{"artifacts":[]}`)}
|
||||||
|
}}
|
||||||
|
k := Asker{Publisher: f, Waiter: f}
|
||||||
|
step, err := k.Ask(context.Background(), goAsk("mvl0frv18d1957"))
|
||||||
|
if err != nil || step.Node != "ace" || len(f.Asks()) != 1 {
|
||||||
|
t.Fatalf("step %+v, %v, asks %d", step, err, len(f.Asks()))
|
||||||
|
}
|
||||||
|
f.Answer = func(a delivery.StepAsk) delivery.Step {
|
||||||
|
return delivery.Step{ID: a.ID, Node: "shanks", State: delivery.StepRefused, Reason: "go 1.27 installed"}
|
||||||
|
}
|
||||||
|
if _, err := k.Ask(context.Background(), goAsk("mvl0frv18d1958")); err == nil || !strings.Contains(err.Error(), "shanks refused: go 1.27 installed") {
|
||||||
|
t.Fatalf("a refused step: %v", err)
|
||||||
|
}
|
||||||
|
// review round 2 item 1: an ask that waits in its stream for a free slot is not bounded; once a node writes its step
|
||||||
|
// running, the step is bounded from its start, and the error names the node.
|
||||||
|
g := &FakeAsks{}
|
||||||
|
k = Asker{Publisher: g, Waiter: g, Bound: 20 * time.Millisecond}
|
||||||
|
waiting, cancel := context.WithTimeout(context.Background(), 100*time.Millisecond)
|
||||||
|
defer cancel()
|
||||||
|
if _, err := k.Wait(waiting, goAsk("mvl0frv18d1959")); err != context.DeadlineExceeded {
|
||||||
|
t.Fatalf("an ask no node took: %v, want it still waiting when ctx ended", err)
|
||||||
|
}
|
||||||
|
g.Write(delivery.Step{ID: "mvl0frv18d1961", Node: "ace", State: delivery.StepRunning, Started: time.Now()})
|
||||||
|
if _, err := k.Wait(context.Background(), goAsk("mvl0frv18d1961")); err == nil || !strings.Contains(err.Error(), "on ace did not end within") {
|
||||||
|
t.Fatalf("a step that never ends: %v", err)
|
||||||
|
}
|
||||||
|
if len(g.Asks()) != 0 {
|
||||||
|
t.Fatal("a wait put an ask")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Review (issue 734 path): an ask taken again by the same node (its build module replaced mid-run) is bounded from the
|
||||||
|
// new run's start, so its pass is answered after the first run's bound would have ended the wait.
|
||||||
|
func TestARedeliveryToTheSameNodeRestartsTheBound(t *testing.T) {
|
||||||
|
f := &FakeAsks{}
|
||||||
|
k := Asker{Publisher: f, Waiter: f, Bound: 60 * time.Millisecond}
|
||||||
|
const id = "mvl0frv18d1962"
|
||||||
|
first := time.Now()
|
||||||
|
f.Write(delivery.Step{ID: id, Node: "ace", State: delivery.StepRunning, Started: first})
|
||||||
|
go func() {
|
||||||
|
time.Sleep(40 * time.Millisecond)
|
||||||
|
f.Write(delivery.Step{ID: id, Node: "ace", State: delivery.StepRunning, Started: time.Now()})
|
||||||
|
time.Sleep(50 * time.Millisecond) // past the first run's bound, inside the second's
|
||||||
|
f.Write(delivery.Step{ID: id, Node: "ace", State: delivery.StepPassed, Started: time.Now()})
|
||||||
|
}()
|
||||||
|
step, err := k.Wait(context.Background(), goAsk(id))
|
||||||
|
if err != nil || step.State != delivery.StepPassed {
|
||||||
|
t.Fatalf("step %+v, %v, want the redelivered run's pass", step, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
+14
-5
@@ -96,10 +96,16 @@ type LevelResult struct {
|
|||||||
|
|
||||||
// The states of a Composition (ADR 0484 clause 6): the composition check is the assigner's, so until it delivers a
|
// The states of a Composition (ADR 0484 clause 6): the composition check is the assigner's, so until it delivers a
|
||||||
// verdict says CompositionNotRun, and a line never says the composition passed on that.
|
// verdict says CompositionNotRun, and a line never says the composition passed on that.
|
||||||
|
//
|
||||||
|
// A composition not run may say why in its Words: AssignerNotRunning when no instance of the assigner is online, so a
|
||||||
|
// check never waits for a composition nobody is making (issue 1297).
|
||||||
const (
|
const (
|
||||||
CompositionNotRun = "not-run"
|
CompositionNotRun = "not-run"
|
||||||
CompositionPass = "pass"
|
CompositionPass = "pass"
|
||||||
CompositionFail = "fail"
|
CompositionFail = "fail"
|
||||||
|
|
||||||
|
// AssignerNotRunning is the Words of a composition not run because no instance of the assigner is online.
|
||||||
|
AssignerNotRunning = "the assigner is not running"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Composition is what the check of the machines' composition made of a verdict: its State (not-run, pass or fail), the
|
// Composition is what the check of the machines' composition made of a verdict: its State (not-run, pass or fail), the
|
||||||
@@ -114,9 +120,12 @@ type Composition struct {
|
|||||||
// Took is the time of each part of a check in integer milliseconds (ADR 0447 clause 3): waiting in the queue, cloning,
|
// Took is the time of each part of a check in integer milliseconds (ADR 0447 clause 3): waiting in the queue, cloning,
|
||||||
// the unit level, the integration level's setup and its running, and the composition.
|
// the unit level, the integration level's setup and its running, and the composition.
|
||||||
type Took struct {
|
type Took struct {
|
||||||
Queue int64 `json:"queue"`
|
Queue int64 `json:"queue"`
|
||||||
Clone int64 `json:"clone"`
|
Clone int64 `json:"clone"`
|
||||||
Unit int64 `json:"unit"`
|
Unit int64 `json:"unit"`
|
||||||
|
// Lint is the unit level's gofmt and go vet before its tests (ADR 0529 §1; issue 1887 D7-go); absent from a verdict
|
||||||
|
// of a build module that runs none.
|
||||||
|
Lint int64 `json:"lint,omitempty"`
|
||||||
IntegrationSetup int64 `json:"integration-setup"`
|
IntegrationSetup int64 `json:"integration-setup"`
|
||||||
IntegrationRun int64 `json:"integration-run"`
|
IntegrationRun int64 `json:"integration-run"`
|
||||||
Composition int64 `json:"composition"`
|
Composition int64 `json:"composition"`
|
||||||
@@ -156,8 +165,8 @@ func (c *Composition) check() error {
|
|||||||
}
|
}
|
||||||
switch c.State {
|
switch c.State {
|
||||||
case CompositionNotRun:
|
case CompositionNotRun:
|
||||||
if c.Words != "" || c.SDK != "" || len(c.Machines) > 0 {
|
if c.SDK != "" || len(c.Machines) > 0 {
|
||||||
return fmt.Errorf("delivery: the verdict's composition is not run and says nothing of words, the mesh-sdk commit or machines")
|
return fmt.Errorf("delivery: the verdict's composition is not run and names no mesh-sdk commit or machines")
|
||||||
}
|
}
|
||||||
case CompositionPass:
|
case CompositionPass:
|
||||||
if c.SDK == "" {
|
if c.SDK == "" {
|
||||||
|
|||||||
@@ -262,6 +262,16 @@ func TestVerdictCarriesSkippedCompositionAndOverBound(t *testing.T) {
|
|||||||
if _, err := EncodeVerdict(notRun); err != nil {
|
if _, err := EncodeVerdict(notRun); err != nil {
|
||||||
t.Errorf("a composition not yet run refused: %v", err)
|
t.Errorf("a composition not yet run refused: %v", err)
|
||||||
}
|
}
|
||||||
|
// 1297: a composition not run says why when the assigner is not running, and round-trips with its words.
|
||||||
|
notRunning := passVerdict()
|
||||||
|
notRunning.Composition = &Composition{State: CompositionNotRun, Words: AssignerNotRunning}
|
||||||
|
data, err = EncodeVerdict(notRunning)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("a composition not run because the assigner is not running refused: %v", err)
|
||||||
|
}
|
||||||
|
if back, err := DecodeVerdict(data); err != nil || back.Composition.Words != AssignerNotRunning {
|
||||||
|
t.Errorf("its words came back as %+v, %v", back.Composition, err)
|
||||||
|
}
|
||||||
failed := passVerdict()
|
failed := passVerdict()
|
||||||
failed.State, failed.Failed = VerdictFail, FailedFirst{Machine: "ace", Words: "x"}
|
failed.State, failed.Failed = VerdictFail, FailedFirst{Machine: "ace", Words: "x"}
|
||||||
failed.Composition = &Composition{State: CompositionFail, Words: "path /etc/x is owned by two modules", SDK: failed.SDK, Machines: []string{"ace"}}
|
failed.Composition = &Composition{State: CompositionFail, Words: "path /etc/x is owned by two modules", SDK: failed.SDK, Machines: []string{"ace"}}
|
||||||
|
|||||||
@@ -0,0 +1,241 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// The controller's compositions (novox/hq ADR 0539 clauses 1 to 4). A **composition** is one module's resources
|
||||||
|
// composed for one node at one fingerprint, written by the controller, which keeps the inputs. It lives in a bucket of
|
||||||
|
// each node, `composed-<node>`, which only that node's node-engine reads (a composition can carry a sealed value), under
|
||||||
|
// `<node>.<module>.<fingerprint hex>`, and the node's own resources (adoption, firewall openings, accounts, the
|
||||||
|
// resolver, identities and groups) under `<node>.node`. Beside it, under the same key in `mesh-controller_composed`,
|
||||||
|
// which the assigner reads, the controller writes the composition's digest and its judgement of the move from the
|
||||||
|
// composition the node runs now (ComposedDigest). The controller writes both by compare-and-set while it holds the
|
||||||
|
// lease; the operator's credential is a second writer on the hand path alone (clause 10, mesh-hand-compose).
|
||||||
|
//
|
||||||
|
// A composition is derived state (clause 4): its key and its digest are deleted by the controller when its fingerprint
|
||||||
|
// is no longer among the module's five newest and no want names it, and each bucket keeps five revisions of a key.
|
||||||
|
const (
|
||||||
|
// ComposedBucketPrefix starts the name of a node's bucket of compositions, ComposedBucketFor(node).
|
||||||
|
ComposedBucketPrefix = "composed-"
|
||||||
|
// ComposedHistory is the revisions a node's composition bucket keeps per key (ADR 0539 clause 4).
|
||||||
|
ComposedHistory = 5
|
||||||
|
// ControllerModule is the module of the controller, the writer of the compositions.
|
||||||
|
ControllerModule = "mesh-controller"
|
||||||
|
// ControllerComposedBucket is the controller's bucket of each composition's digest and judgement, `<owner
|
||||||
|
// module>_<name>`, read by the assigner (ADR 0539 clauses 2 and 6).
|
||||||
|
ControllerComposedBucket = ControllerModule + "_composed"
|
||||||
|
// ControllerComposedHistory is the revisions that bucket keeps per key.
|
||||||
|
ControllerComposedHistory = 5
|
||||||
|
// ComposedKeep is how many of a module's newest fingerprints keep their compositions though no want names them
|
||||||
|
// (ADR 0539 clause 4).
|
||||||
|
ComposedKeep = 5
|
||||||
|
)
|
||||||
|
|
||||||
|
// nodeWord is the last part of a node's own key, in the have bucket and in a node's composition bucket alike.
|
||||||
|
const nodeWord = "node"
|
||||||
|
|
||||||
|
var bucketNode = regexp.MustCompile(`^[A-Za-z0-9_-]+$`)
|
||||||
|
|
||||||
|
// ComposedBucketFor is the name of a node's bucket of compositions, "composed-<node>", as declaration.FileBucketFor
|
||||||
|
// names a node's object bucket (ADR 0488 §4). The node name must be one a bucket and a subject token accept: letters,
|
||||||
|
// digits, '_' and '-'.
|
||||||
|
func ComposedBucketFor(node string) (string, error) {
|
||||||
|
if node == "" {
|
||||||
|
return "", fmt.Errorf("delivery: the node name is empty; a node's composition bucket is named for its node")
|
||||||
|
}
|
||||||
|
if !bucketNode.MatchString(node) {
|
||||||
|
return "", fmt.Errorf("delivery: the node name %q is not one a bucket accepts: letters, digits, '_' and '-' only", node)
|
||||||
|
}
|
||||||
|
return ComposedBucketPrefix + node, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ComposedKey is the key, in ComposedBucketFor(node) and in ControllerComposedBucket, of a module's composition for a
|
||||||
|
// node at a fingerprint: `<node>.<module>.<hex>`, the hex being the fingerprint's key part (FingerprintKeyPart). A
|
||||||
|
// module named `node` is refused, since `<node>.node` is the node's own key.
|
||||||
|
func ComposedKey(node, module, fingerprint string) (string, error) {
|
||||||
|
have, err := HaveKey(node, module)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
part, err := FingerprintKeyPart(fingerprint)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return have + "." + part, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ComposedNodeKey is the key of a node's own composition: `<node>.node`.
|
||||||
|
func ComposedNodeKey(node string) (string, error) {
|
||||||
|
return HaveNodeKey(node)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseComposedKey is the inverse of ComposedKey and ComposedNodeKey: isNode is true for `<node>.node`, with module
|
||||||
|
// and fingerprint empty. It refuses any other shape, naming the key.
|
||||||
|
func ParseComposedKey(key string) (node, module, fingerprint string, isNode bool, err error) {
|
||||||
|
refused := func(why error) (string, string, string, bool, error) {
|
||||||
|
return "", "", "", false, fmt.Errorf("delivery: %q is not a composition key, <node>.<module>.<fingerprint hex> or <node>.node: %w", key, why)
|
||||||
|
}
|
||||||
|
parts := strings.Split(key, ".")
|
||||||
|
switch len(parts) {
|
||||||
|
case 2:
|
||||||
|
if parts[1] != nodeWord {
|
||||||
|
return refused(fmt.Errorf("a module's composition names its fingerprint"))
|
||||||
|
}
|
||||||
|
if err := checkName("node", parts[0]); err != nil {
|
||||||
|
return refused(err)
|
||||||
|
}
|
||||||
|
return parts[0], "", "", true, nil
|
||||||
|
case 3:
|
||||||
|
node, module, isNode, err := ParseHaveKey(parts[0] + "." + parts[1])
|
||||||
|
if err != nil {
|
||||||
|
return refused(err)
|
||||||
|
}
|
||||||
|
if isNode {
|
||||||
|
return refused(fmt.Errorf("the node's own key names no fingerprint"))
|
||||||
|
}
|
||||||
|
fp, err := ParseFingerprintKeyPart(parts[2])
|
||||||
|
if err != nil {
|
||||||
|
return refused(err)
|
||||||
|
}
|
||||||
|
return node, module, fp, false, nil
|
||||||
|
}
|
||||||
|
return refused(fmt.Errorf("it has %d parts", len(parts)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Judgement is the controller's judgement of a move from the composition a node runs, as its have names it, to a new
|
||||||
|
// one (ADR 0539 clauses 2 and 14, by ADR 0377 §3's tests).
|
||||||
|
type Judgement string
|
||||||
|
|
||||||
|
// The judgements of a move.
|
||||||
|
const (
|
||||||
|
// JudgedRecreates is a move that recreates a container.
|
||||||
|
JudgedRecreates Judgement = "recreates"
|
||||||
|
// JudgedMovesData is a move that gives the module's data another place.
|
||||||
|
JudgedMovesData Judgement = "moves-data"
|
||||||
|
// JudgedNeither is a move that does neither, and the judgement of a composition the node never ran.
|
||||||
|
JudgedNeither Judgement = "neither"
|
||||||
|
// JudgedCannot is a move that cannot be judged, because the composition the node runs is gone or cannot be read.
|
||||||
|
JudgedCannot Judgement = "cannot-judge"
|
||||||
|
// JudgedUnchanged is a composition equal to the module's slice of the declaration the node last applied, for a node
|
||||||
|
// whose have names no composition yet (the first want at the switch, novox/hq ADR 0540 clause 9): applying it
|
||||||
|
// changes nothing on the node, so it needs no person's yes.
|
||||||
|
JudgedUnchanged Judgement = "unchanged"
|
||||||
|
)
|
||||||
|
|
||||||
|
var digestForm = regexp.MustCompile(`^sha256:[0-9a-f]{64}$`)
|
||||||
|
|
||||||
|
func checkDigest(digest, of string) error {
|
||||||
|
if !digestForm.MatchString(digest) {
|
||||||
|
return fmt.Errorf("delivery: %s %q is not sha256:<64 lowercase hex digits>", of, digest)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ComposedDigest is the value, in ControllerComposedBucket, beside a composition: its Digest (ComposedDigestOf), and
|
||||||
|
// the Judgement of the move to it from the composition the node runs now, whose digest is Against (empty when the node
|
||||||
|
// runs no composition of the module). Words say why, and are required for a move that cannot be judged. Rewritten when
|
||||||
|
// the node's have changes.
|
||||||
|
//
|
||||||
|
// Policy is the module's upgrade policy as the controller holds it (ADR 0236, ADR 0539 clause 14), with PolicyFrom
|
||||||
|
// where it comes from and PolicyWhy why: the assigner holds a move of a module of policy record from it, the operator's
|
||||||
|
// own choice (`upgrade` with policy) included. Rewritten when the policy changes. Empty on a composition made by hand
|
||||||
|
// (mesh-hand-compose), whose want the operator writes.
|
||||||
|
type ComposedDigest struct {
|
||||||
|
V int `json:"v"`
|
||||||
|
Digest string `json:"digest"`
|
||||||
|
Judgement Judgement `json:"judgement"`
|
||||||
|
Against string `json:"against,omitempty"`
|
||||||
|
Words string `json:"words,omitempty"`
|
||||||
|
// UserListOnly says the composition differs from the one the node's have names only in the bus's user list (the
|
||||||
|
// bus module's file `<module>.bus-users`), whatever the judgement says of its mount: the assigner writes such a
|
||||||
|
// revision into the bus node's want at once, outside the record hold, at the fingerprint the node runs (ADR 0539
|
||||||
|
// clause 7).
|
||||||
|
UserListOnly bool `json:"user-list-only,omitempty"`
|
||||||
|
Policy string `json:"policy,omitempty"`
|
||||||
|
PolicyFrom string `json:"policy-from,omitempty"`
|
||||||
|
PolicyWhy string `json:"policy-why,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// The upgrade policies and their sources a composition's value names: catalogue.PolicyRoll, PolicyTogether and
|
||||||
|
// PolicyRecord, and catalogue.FromPerson, FromModule, FromBus, FromData and FromDefault, the same words (the compose
|
||||||
|
// package's test holds them equal; this package does not import the catalogue).
|
||||||
|
var (
|
||||||
|
composedPolicies = []string{"roll", "together", "record"}
|
||||||
|
composedPolicyFroms = []string{"person", "module", "the bus", "irreplaceable data", "default"}
|
||||||
|
)
|
||||||
|
|
||||||
|
func oneOf(v string, of []string) bool {
|
||||||
|
for _, o := range of {
|
||||||
|
if v == o {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c ComposedDigest) check() error {
|
||||||
|
if err := checkDigest(c.Digest, "the composition's digest"); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if c.Against != "" {
|
||||||
|
if err := checkDigest(c.Against, "the digest a move is judged against"); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
switch c.Judgement {
|
||||||
|
case JudgedRecreates, JudgedMovesData:
|
||||||
|
if c.Against == "" {
|
||||||
|
return fmt.Errorf("delivery: a move judged %s names the composition it is judged against", c.Judgement)
|
||||||
|
}
|
||||||
|
case JudgedNeither, JudgedUnchanged:
|
||||||
|
case JudgedCannot:
|
||||||
|
if c.Words == "" {
|
||||||
|
return fmt.Errorf("delivery: a move that cannot be judged says why")
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("delivery: the judgement %q is not %s, %s, %s, %s or %s", c.Judgement, JudgedRecreates,
|
||||||
|
JudgedMovesData, JudgedNeither, JudgedCannot, JudgedUnchanged)
|
||||||
|
}
|
||||||
|
if c.Policy != "" || c.PolicyFrom != "" {
|
||||||
|
if !oneOf(c.Policy, composedPolicies) {
|
||||||
|
return fmt.Errorf("delivery: the upgrade policy %q is not one of %v", c.Policy, composedPolicies)
|
||||||
|
}
|
||||||
|
if !oneOf(c.PolicyFrom, composedPolicyFroms) {
|
||||||
|
return fmt.Errorf("delivery: the upgrade policy's source %q is not one of %v", c.PolicyFrom, composedPolicyFroms)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// PolicyRecord is the policy whose moves the assigner holds for a person's yes (ADR 0539 clause 14).
|
||||||
|
const PolicyRecord = "record"
|
||||||
|
|
||||||
|
// EncodeComposedDigest is c as JSON at Version; it refuses an unknown judgement, a digest not of the sha256 form, a
|
||||||
|
// move judged to recreate or move data against nothing, and a move that cannot be judged without its reason.
|
||||||
|
func EncodeComposedDigest(c ComposedDigest) ([]byte, error) {
|
||||||
|
if err := c.check(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
c.V = Version
|
||||||
|
return json.Marshal(c)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecodeComposedDigest reads the value beside a composition; it refuses an unknown version (ErrUnknownVersion) and
|
||||||
|
// what EncodeComposedDigest refuses.
|
||||||
|
func DecodeComposedDigest(data []byte) (ComposedDigest, error) {
|
||||||
|
var c ComposedDigest
|
||||||
|
if err := decode(data, &c); err != nil {
|
||||||
|
return ComposedDigest{}, err
|
||||||
|
}
|
||||||
|
if err := c.check(); err != nil {
|
||||||
|
return ComposedDigest{}, err
|
||||||
|
}
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SameComposedDigest says whether two values are the same, so the controller writes only when they differ.
|
||||||
|
func SameComposedDigest(a, b ComposedDigest) bool { return a == b }
|
||||||
@@ -0,0 +1,125 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// 1943/AC1: a node's composition bucket is named for the node, and a node with no name, or one a bucket refuses,
|
||||||
|
// is refused, naming why.
|
||||||
|
func TestComposedBucketFor(t *testing.T) {
|
||||||
|
b, err := ComposedBucketFor("ace")
|
||||||
|
if err != nil || b != "composed-ace" {
|
||||||
|
t.Fatalf("ComposedBucketFor(ace) = %q, %v", b, err)
|
||||||
|
}
|
||||||
|
for _, bad := range []string{"", "a.b", "a*", "a b", "a>"} {
|
||||||
|
if _, err := ComposedBucketFor(bad); err == nil || !strings.Contains(err.Error(), "node") {
|
||||||
|
t.Errorf("ComposedBucketFor(%q) = %v, want a refusal naming the node", bad, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943/AC1: a module's composition key and the node's own key round-trip through one parser; an empty node, a
|
||||||
|
// module named node, a bad fingerprint and a key of another shape are refused, naming why.
|
||||||
|
func TestComposedKeys(t *testing.T) {
|
||||||
|
fp := fp2of('c')
|
||||||
|
key, err := ComposedKey("ace", "mesh-mail", fp)
|
||||||
|
if err != nil || key != "ace.mesh-mail."+strings.Repeat("c", 64) {
|
||||||
|
t.Fatalf("ComposedKey = %q, %v", key, err)
|
||||||
|
}
|
||||||
|
node, module, back, isNode, err := ParseComposedKey(key)
|
||||||
|
if err != nil || node != "ace" || module != "mesh-mail" || back != fp || isNode {
|
||||||
|
t.Errorf("ParseComposedKey(%q) = %q, %q, %q, %v, %v", key, node, module, back, isNode, err)
|
||||||
|
}
|
||||||
|
own, err := ComposedNodeKey("ace")
|
||||||
|
if err != nil || own != "ace.node" {
|
||||||
|
t.Fatalf("ComposedNodeKey = %q, %v", own, err)
|
||||||
|
}
|
||||||
|
node, module, back, isNode, err = ParseComposedKey(own)
|
||||||
|
if err != nil || node != "ace" || module != "" || back != "" || !isNode {
|
||||||
|
t.Errorf("ParseComposedKey(%q) = %q, %q, %q, %v, %v", own, node, module, back, isNode, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
refusals := []struct {
|
||||||
|
node, module, fp, why string
|
||||||
|
}{
|
||||||
|
{"", "mesh-mail", fp, "node name is empty"},
|
||||||
|
{"ace", "node", fp, `"node" is refused`},
|
||||||
|
{"ace", "", fp, "module name is empty"},
|
||||||
|
{"ace", "mesh-mail", "src2:abc", "not a fingerprint of the new form"},
|
||||||
|
{"ace", "mesh-mail", "src1:" + strings.Repeat("c", 64), "not a fingerprint of the new form"},
|
||||||
|
{"a.b", "mesh-mail", fp, "node name"},
|
||||||
|
}
|
||||||
|
for _, r := range refusals {
|
||||||
|
if _, err := ComposedKey(r.node, r.module, r.fp); err == nil || !strings.Contains(err.Error(), r.why) {
|
||||||
|
t.Errorf("ComposedKey(%q, %q, %q) = %v, want a refusal saying %q", r.node, r.module, r.fp, err, r.why)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := ComposedNodeKey(""); err == nil {
|
||||||
|
t.Errorf("ComposedNodeKey(\"\") accepted")
|
||||||
|
}
|
||||||
|
for _, bad := range []string{"", "ace", "ace.mesh-mail", "ace.node.x", "ace.mesh-mail.abc", ".mesh-mail." + strings.Repeat("c", 64),
|
||||||
|
"ace.node." + strings.Repeat("c", 64), "ace.mesh-mail." + strings.Repeat("c", 64) + ".x", "want.ace.mesh-mail"} {
|
||||||
|
if _, _, _, _, err := ParseComposedKey(bad); err == nil || !strings.Contains(err.Error(), "\""+bad+"\"") {
|
||||||
|
t.Errorf("ParseComposedKey(%q) = %v, want a refusal naming it", bad, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943/AC1: the controller's value beside a composition, its digest and the judgement of the move, round-trips; an
|
||||||
|
// unknown judgement, a digest not of the sha256 form, a move judged against nothing, a cannot-judge without its
|
||||||
|
// reason, and an upgrade policy or source outside the catalogue's words are refused, naming why; an unknown version is
|
||||||
|
// refused as one. The module's upgrade policy and its source ride beside the judgement, for the assigner's hold.
|
||||||
|
func TestComposedDigestValue(t *testing.T) {
|
||||||
|
digest := "sha256:" + strings.Repeat("d", 64)
|
||||||
|
against := "sha256:" + strings.Repeat("e", 64)
|
||||||
|
for _, v := range []ComposedDigest{
|
||||||
|
{Digest: digest, Judgement: JudgedNeither},
|
||||||
|
{Digest: digest, Judgement: JudgedNeither, Against: against},
|
||||||
|
{Digest: digest, Judgement: JudgedRecreates, Against: against, Words: "the container's image changes"},
|
||||||
|
{Digest: digest, Judgement: JudgedMovesData, Against: against},
|
||||||
|
{Digest: digest, Judgement: JudgedCannot, Words: "the composition the node runs is gone"},
|
||||||
|
{Digest: digest, Judgement: JudgedUnchanged, Words: "equal to the declaration the node last applied"},
|
||||||
|
{Digest: digest, Judgement: JudgedNeither, Policy: "record", PolicyFrom: "person", PolicyWhy: "the operator: its data"},
|
||||||
|
{Digest: digest, Judgement: JudgedNeither, Policy: "roll", PolicyFrom: "default"},
|
||||||
|
{Digest: digest, Judgement: JudgedNeither, Against: against, UserListOnly: true, Words: "only the bus's user list changes"},
|
||||||
|
} {
|
||||||
|
raw, err := EncodeComposedDigest(v)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("EncodeComposedDigest(%+v): %v", v, err)
|
||||||
|
}
|
||||||
|
back, err := DecodeComposedDigest(raw)
|
||||||
|
v.V = Version
|
||||||
|
if err != nil || !SameComposedDigest(back, v) {
|
||||||
|
t.Errorf("round trip of %+v = %+v, %v", v, back, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
refusals := []struct {
|
||||||
|
v ComposedDigest
|
||||||
|
why string
|
||||||
|
}{
|
||||||
|
{ComposedDigest{Digest: digest, Judgement: "maybe"}, `judgement "maybe"`},
|
||||||
|
{ComposedDigest{Digest: digest}, `judgement ""`},
|
||||||
|
{ComposedDigest{Digest: "sha256:abc", Judgement: JudgedNeither}, "not sha256"},
|
||||||
|
{ComposedDigest{Judgement: JudgedNeither}, "not sha256"},
|
||||||
|
{ComposedDigest{Digest: digest, Judgement: JudgedRecreates}, "against"},
|
||||||
|
{ComposedDigest{Digest: digest, Judgement: JudgedMovesData}, "against"},
|
||||||
|
{ComposedDigest{Digest: digest, Judgement: JudgedCannot}, "why"},
|
||||||
|
{ComposedDigest{Digest: digest, Judgement: JudgedNeither, Against: "sha256:zz"}, "not sha256"},
|
||||||
|
{ComposedDigest{Digest: digest, Judgement: JudgedNeither, Policy: "sometimes", PolicyFrom: "person"}, `policy "sometimes"`},
|
||||||
|
{ComposedDigest{Digest: digest, Judgement: JudgedNeither, Policy: "record"}, `source ""`},
|
||||||
|
{ComposedDigest{Digest: digest, Judgement: JudgedNeither, PolicyFrom: "person"}, `policy ""`},
|
||||||
|
}
|
||||||
|
for _, r := range refusals {
|
||||||
|
if _, err := EncodeComposedDigest(r.v); err == nil || !strings.Contains(err.Error(), r.why) {
|
||||||
|
t.Errorf("EncodeComposedDigest(%+v) = %v, want a refusal saying %q", r.v, err, r.why)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := DecodeComposedDigest([]byte(`{"v":2,"digest":"` + digest + `","judgement":"neither"}`)); !errors.Is(err, ErrUnknownVersion) {
|
||||||
|
t.Errorf("version 2 = %v, want ErrUnknownVersion", err)
|
||||||
|
}
|
||||||
|
if _, err := DecodeComposedDigest([]byte(`{"v":1,"digest":"` + digest + `","judgement":"perhaps"}`)); err == nil {
|
||||||
|
t.Errorf("an unknown judgement was read")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,100 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/ed25519"
|
||||||
|
"encoding/base64"
|
||||||
|
"fmt"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A composition's signature (novox/hq ADR 0539 clause 3): the controller signs each composition it writes with its
|
||||||
|
// key, and the operator signs one made by hand with mesh-hand-compose with theirs. The node-engine trusts exactly these two
|
||||||
|
// signers and applies nothing of a composition whose signature fails or whose signer is neither. The signature is an
|
||||||
|
// ed25519 signature, as a declaration's is, of the composition's digest (ComposedDigestOf) after a context line, so a
|
||||||
|
// signature made for anything else never verifies here.
|
||||||
|
const composedSigningContext = "novox composition v1\n"
|
||||||
|
|
||||||
|
// Signature is who signed a composition and the signature: Signer the signer's ed25519 public key and Sig the
|
||||||
|
// signature, both in standard base64.
|
||||||
|
type Signature struct {
|
||||||
|
Signer string `json:"signer"`
|
||||||
|
Sig string `json:"sig"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s Signature) check() error {
|
||||||
|
if key, err := base64.StdEncoding.DecodeString(s.Signer); err != nil || len(key) != ed25519.PublicKeySize {
|
||||||
|
return fmt.Errorf("delivery: a composition's signer %q is not an ed25519 public key in base64", s.Signer)
|
||||||
|
}
|
||||||
|
if sig, err := base64.StdEncoding.DecodeString(s.Sig); err != nil || len(sig) != ed25519.SignatureSize {
|
||||||
|
return fmt.Errorf("delivery: a composition's signature is not an ed25519 signature in base64")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SignComposed is c signed with key: its digest signed, and the key's public half named as the signer. A signature c
|
||||||
|
// already carries is replaced.
|
||||||
|
func SignComposed(c Composed, key ed25519.PrivateKey) (Composed, error) {
|
||||||
|
if len(key) != ed25519.PrivateKeySize {
|
||||||
|
return Composed{}, fmt.Errorf("delivery: the key to sign a composition with is not an ed25519 private key")
|
||||||
|
}
|
||||||
|
return SignComposedBy(c, key.Public().(ed25519.PublicKey), func(message []byte) ([]byte, error) {
|
||||||
|
return ed25519.Sign(key, message), nil
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// SignComposedBy is SignComposed for a signer that keeps its private half to itself (the controller's identity store
|
||||||
|
// signs a message and hands back the signature): sign signs the message it is given with the key whose public half is
|
||||||
|
// signer. A signature that does not verify against signer is refused, so a composition is never written signed by a
|
||||||
|
// key other than the one it names.
|
||||||
|
func SignComposedBy(c Composed, signer ed25519.PublicKey, sign func(message []byte) ([]byte, error)) (Composed, error) {
|
||||||
|
if len(signer) != ed25519.PublicKeySize {
|
||||||
|
return Composed{}, fmt.Errorf("delivery: the signer of a composition is not an ed25519 public key")
|
||||||
|
}
|
||||||
|
c.Signature = nil
|
||||||
|
digest, err := ComposedDigestOf(c)
|
||||||
|
if err != nil {
|
||||||
|
return Composed{}, err
|
||||||
|
}
|
||||||
|
message := []byte(composedSigningContext + digest)
|
||||||
|
sig, err := sign(message)
|
||||||
|
if err != nil {
|
||||||
|
return Composed{}, err
|
||||||
|
}
|
||||||
|
if !ed25519.Verify(signer, message, sig) {
|
||||||
|
return Composed{}, fmt.Errorf("delivery: the signature made for the composition of %q on %s does not verify against its signer", c.Module, c.Node)
|
||||||
|
}
|
||||||
|
c.Signature = &Signature{Signer: base64.StdEncoding.EncodeToString(signer), Sig: base64.StdEncoding.EncodeToString(sig)}
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// VerifyComposed is c's digest when c is signed by one of the trusted keys and its signature verifies against its
|
||||||
|
// digest; otherwise it refuses, saying why, and nothing of c is to be applied: an unsigned composition, one whose
|
||||||
|
// signer is not a trusted key, and one changed after it was signed.
|
||||||
|
func VerifyComposed(c Composed, trusted []ed25519.PublicKey) (string, error) {
|
||||||
|
if c.Signature == nil {
|
||||||
|
return "", fmt.Errorf("delivery: the composition of %q on %s is unsigned, and only a signed one is applied", c.Module, c.Node)
|
||||||
|
}
|
||||||
|
if err := c.Signature.check(); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
signer, _ := base64.StdEncoding.DecodeString(c.Signature.Signer)
|
||||||
|
var key ed25519.PublicKey
|
||||||
|
for _, t := range trusted {
|
||||||
|
if t.Equal(ed25519.PublicKey(signer)) {
|
||||||
|
key = t
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if key == nil {
|
||||||
|
return "", fmt.Errorf("delivery: the composition of %q on %s is signed by %s, which is not a trusted signer (the controller's key or the operator's)",
|
||||||
|
c.Module, c.Node, c.Signature.Signer)
|
||||||
|
}
|
||||||
|
digest, err := ComposedDigestOf(c)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
sig, _ := base64.StdEncoding.DecodeString(c.Signature.Sig)
|
||||||
|
if !ed25519.Verify(key, []byte(composedSigningContext+digest), sig) {
|
||||||
|
return "", fmt.Errorf("delivery: the composition of %q on %s does not match its signature: it was changed after it was signed, or signed for another",
|
||||||
|
c.Module, c.Node)
|
||||||
|
}
|
||||||
|
return digest, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,103 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/ed25519"
|
||||||
|
"crypto/rand"
|
||||||
|
"encoding/json"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func aSigningKey(t *testing.T) (ed25519.PublicKey, ed25519.PrivateKey) {
|
||||||
|
t.Helper()
|
||||||
|
pub, priv, err := ed25519.GenerateKey(rand.Reader)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return pub, priv
|
||||||
|
}
|
||||||
|
|
||||||
|
func aComposition() Composed {
|
||||||
|
return Composed{Node: "ace", Module: "m", FP: fp2of('a'), Resources: []json.RawMessage{
|
||||||
|
json.RawMessage(`{"id":"m.f","type":"file","module":"m","path":"/etc/m","content":"x"}`)}}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943/AC5: a composition signed by the controller's key or by the operator's verifies against the two trusted keys,
|
||||||
|
// keeps its digest, and survives its encoding; one signed by another key, unsigned, or changed by one byte after it was
|
||||||
|
// signed does not verify, and nothing of it is to be applied.
|
||||||
|
func TestACompositionIsSignedByATrustedKey(t *testing.T) {
|
||||||
|
controllerPub, controller := aSigningKey(t)
|
||||||
|
operatorPub, operator := aSigningKey(t)
|
||||||
|
_, stranger := aSigningKey(t)
|
||||||
|
trusted := []ed25519.PublicKey{controllerPub, operatorPub}
|
||||||
|
c := aComposition()
|
||||||
|
want, _ := ComposedDigestOf(c)
|
||||||
|
|
||||||
|
for name, key := range map[string]ed25519.PrivateKey{"controller": controller, "operator": operator} {
|
||||||
|
signed, err := SignComposed(c, key)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("%s: %v", name, err)
|
||||||
|
}
|
||||||
|
raw, err := EncodeComposed(signed)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
back, err := DecodeComposed(raw)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
digest, err := VerifyComposed(back, trusted)
|
||||||
|
if err != nil || digest != want {
|
||||||
|
t.Errorf("%s's signature: %q, %v; want the digest %s", name, digest, err, want)
|
||||||
|
}
|
||||||
|
if d, _ := ComposedDigestOf(back); d != want {
|
||||||
|
t.Errorf("%s's signature changed the digest: %s", name, d)
|
||||||
|
}
|
||||||
|
|
||||||
|
changed := strings.Replace(string(raw), `"content":"x"`, `"content":"y"`, 1)
|
||||||
|
if changed == string(raw) {
|
||||||
|
t.Fatal("the test changed nothing")
|
||||||
|
}
|
||||||
|
if tampered, err := DecodeComposed([]byte(changed)); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
} else if _, err := VerifyComposed(tampered, trusted); err == nil || !strings.Contains(err.Error(), "signature") {
|
||||||
|
t.Errorf("%s: a composition changed by one byte verified: %v", name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
byStranger, _ := SignComposed(c, stranger)
|
||||||
|
if _, err := VerifyComposed(byStranger, trusted); err == nil || !strings.Contains(err.Error(), "not a trusted") {
|
||||||
|
t.Errorf("a stranger's signature = %v, want refused as no trusted signer", err)
|
||||||
|
}
|
||||||
|
if _, err := VerifyComposed(c, trusted); err == nil || !strings.Contains(err.Error(), "unsigned") {
|
||||||
|
t.Errorf("an unsigned composition = %v, want refused", err)
|
||||||
|
}
|
||||||
|
signed, _ := SignComposed(c, controller)
|
||||||
|
forged := signed
|
||||||
|
forged.Signature = &Signature{Signer: signed.Signature.Signer, Sig: byStranger.Signature.Sig}
|
||||||
|
if _, err := VerifyComposed(forged, trusted); err == nil {
|
||||||
|
t.Errorf("a stranger's signature under the controller's name verified")
|
||||||
|
}
|
||||||
|
if _, err := EncodeComposed(Composed{Node: "ace", Module: "m", FP: fp2of('a'), Resources: c.Resources,
|
||||||
|
Signature: &Signature{Signer: "not base64!", Sig: "x"}}); err == nil {
|
||||||
|
t.Errorf("a signature naming no key was encoded")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943/AC5: a signer that keeps its private half signs through a function, and the composition verifies as one signed
|
||||||
|
// with the key; a function that signs with another key than the one named is refused.
|
||||||
|
func TestACompositionIsSignedByAKeptKey(t *testing.T) {
|
||||||
|
pub, priv := aSigningKey(t)
|
||||||
|
_, other := aSigningKey(t)
|
||||||
|
c := aComposition()
|
||||||
|
signed, err := SignComposedBy(c, pub, func(m []byte) ([]byte, error) { return ed25519.Sign(priv, m), nil })
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := VerifyComposed(signed, []ed25519.PublicKey{pub}); err != nil {
|
||||||
|
t.Errorf("a composition signed through the function does not verify: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := SignComposedBy(c, pub, func(m []byte) ([]byte, error) { return ed25519.Sign(other, m), nil }); err == nil {
|
||||||
|
t.Errorf("a signature by another key than the one named was accepted")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,330 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/hex"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/declaration"
|
||||||
|
)
|
||||||
|
|
||||||
|
// NodeOwn is what a node's own composition (`<node>.node`) carries beside its resources: what the declaration says of
|
||||||
|
// the node as a whole (novox/hq ADR 0539 clause 2: adoption, accounts, identities and groups). A module's composition
|
||||||
|
// carries none of it.
|
||||||
|
type NodeOwn struct {
|
||||||
|
// Adoption says the node is adopted and which of its modules are taken (ADR 0100, ADR 0103); nil for a converged node.
|
||||||
|
Adoption *declaration.Adoption `json:"adoption,omitempty"`
|
||||||
|
// Identities is the identity of every module assigned to the node (ADR 0328 §4), Groups and Libraries every library
|
||||||
|
// it is reached by (ADR 0328 §3).
|
||||||
|
Identities []declaration.Identity `json:"identities,omitempty"`
|
||||||
|
Groups []declaration.Group `json:"groups,omitempty"`
|
||||||
|
Libraries []declaration.Library `json:"libraries,omitempty"`
|
||||||
|
// Provisioner is the account the provisioner's client runs as on the node (ADR 0349 §4).
|
||||||
|
Provisioner string `json:"provisioner_account,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (o NodeOwn) empty() bool {
|
||||||
|
return o.Adoption == nil && len(o.Identities) == 0 && len(o.Groups) == 0 && len(o.Libraries) == 0 && o.Provisioner == ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// Composed is a composition (ADR 0539 clause 1): one module's resources composed for one node at one fingerprint, or,
|
||||||
|
// with Module and FP empty, the node's own resources and parts (Own). Each resource is a declaration resource as the
|
||||||
|
// node-engine reads it, saying its module; it is kept as JSON and written canonically (its keys sorted, its spacing
|
||||||
|
// dropped), so its digest (ComposedDigestOf) is a function of its content alone. Data says the module declares data,
|
||||||
|
// so the node agent backs it up before it moves (ADR 0429 §14). Filled names the files of the module the provisioner
|
||||||
|
// fills (ADR 0349 §5). A file over 64 KiB travels by digest and size (ByDigest), its content in the node's object
|
||||||
|
// bucket (ADR 0539 clause 4).
|
||||||
|
type Composed struct {
|
||||||
|
V int
|
||||||
|
Node string
|
||||||
|
Module string
|
||||||
|
FP string
|
||||||
|
Data bool
|
||||||
|
Resources []json.RawMessage
|
||||||
|
Filled []string
|
||||||
|
Own NodeOwn
|
||||||
|
// Signature is the controller's or, made by hand, the operator's (ADR 0539 clause 3, SignComposed); it signs the
|
||||||
|
// digest and is never part of it.
|
||||||
|
Signature *Signature
|
||||||
|
}
|
||||||
|
|
||||||
|
// composedWire is a composition as it is written.
|
||||||
|
type composedWire struct {
|
||||||
|
V int `json:"v"`
|
||||||
|
Node string `json:"node"`
|
||||||
|
Module string `json:"module,omitempty"`
|
||||||
|
FP string `json:"fp,omitempty"`
|
||||||
|
Data bool `json:"data,omitempty"`
|
||||||
|
Resources []json.RawMessage `json:"resources"`
|
||||||
|
Filled []string `json:"filled_files,omitempty"`
|
||||||
|
Own *NodeOwn `json:"own,omitempty"`
|
||||||
|
Signature *Signature `json:"signature,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// canonicalJSON is raw with its object keys sorted and its spacing dropped, its numbers kept as written.
|
||||||
|
func canonicalJSON(raw json.RawMessage) (json.RawMessage, error) {
|
||||||
|
var v any
|
||||||
|
d := json.NewDecoder(bytes.NewReader(raw))
|
||||||
|
d.UseNumber()
|
||||||
|
if err := d.Decode(&v); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if _, err := d.Token(); err != io.EOF {
|
||||||
|
return nil, fmt.Errorf("more after the value")
|
||||||
|
}
|
||||||
|
return json.Marshal(v)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c Composed) check() error {
|
||||||
|
if _, err := HaveNodeKey(c.Node); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if c.Module == "" {
|
||||||
|
if c.FP != "" {
|
||||||
|
return fmt.Errorf("delivery: the node's own composition names no fingerprint, and this one names %s", c.FP)
|
||||||
|
}
|
||||||
|
// It carries the filled paths of its own files, those of a module with no fingerprint of the new form moved
|
||||||
|
// into it (issue 1945), and never a module's data.
|
||||||
|
if c.Data {
|
||||||
|
return fmt.Errorf("delivery: the node's own composition holds no module's data")
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if _, err := ComposedKey(c.Node, c.Module, c.FP); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !c.Own.empty() {
|
||||||
|
return fmt.Errorf("delivery: the composition of %s carries the node's own parts, which only <node>.node carries", c.Module)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
seen := map[string]bool{}
|
||||||
|
files := map[string][]*declaration.File{}
|
||||||
|
for _, raw := range c.Resources {
|
||||||
|
r, err := declaration.ParseResource(raw)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("delivery: the composition of %q on %s: %w", c.Module, c.Node, err)
|
||||||
|
}
|
||||||
|
if seen[r.Identity()] {
|
||||||
|
return fmt.Errorf("delivery: the composition of %q on %s holds the resource %q twice", c.Module, c.Node, r.Identity())
|
||||||
|
}
|
||||||
|
seen[r.Identity()] = true
|
||||||
|
if r.DeclaredModule() != c.Module {
|
||||||
|
return fmt.Errorf("delivery: the resource %q is of %q, and this is the composition of %q on %s",
|
||||||
|
r.Identity(), r.DeclaredModule(), c.Module, c.Node)
|
||||||
|
}
|
||||||
|
if f, ok := r.(*declaration.File); ok {
|
||||||
|
if f.TravelsByDigest() {
|
||||||
|
return fmt.Errorf("delivery: the file %q is over %d bytes and travels by digest (ByDigest), not whole",
|
||||||
|
f.ID, declaration.FileReferenceThreshold)
|
||||||
|
}
|
||||||
|
files[f.Path] = append(files[f.Path], f)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// A file the provisioner fills says no content, so a composition that does not say it is filled would have the
|
||||||
|
// node-engine write it empty (issue 1945, live on 2026-10-25): refused, naming it.
|
||||||
|
filledHere := make(map[string]bool, len(c.Filled))
|
||||||
|
for _, path := range c.Filled {
|
||||||
|
filledHere[path] = true
|
||||||
|
}
|
||||||
|
for path, fs := range files {
|
||||||
|
for _, f := range fs {
|
||||||
|
if f.OwnerAtRuntime == declaration.RuntimeOwned && !filledHere[path] && !saysContent(f) {
|
||||||
|
return fmt.Errorf("delivery: the file %q says no content and the composition of %q on %s does not say "+
|
||||||
|
"the provisioner fills %s: the node-engine would write it empty", f.ID, c.Module, c.Node, path)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, path := range c.Filled {
|
||||||
|
if len(files[path]) == 0 {
|
||||||
|
return fmt.Errorf("delivery: the composition of %q fills %q, and declares no file there", c.Module, path)
|
||||||
|
}
|
||||||
|
for _, f := range files[path] {
|
||||||
|
if f.OwnerAtRuntime == "" {
|
||||||
|
return fmt.Errorf("delivery: the file %q is filled by the provisioner and says no owner-at-runtime", f.ID)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if c.Signature != nil {
|
||||||
|
if err := c.Signature.check(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// saysContent says a file names what to write: content, bytes, a digest or a sealed value. A file the provisioner fills
|
||||||
|
// names none of them.
|
||||||
|
func saysContent(f *declaration.File) bool {
|
||||||
|
return f.Content != "" || f.Bytes != "" || f.Digest != "" || f.Sealed != "" || f.VaultSealed != nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// wire is c checked and made canonical, ready to marshal.
|
||||||
|
func (c Composed) wire() (composedWire, error) {
|
||||||
|
if err := c.check(); err != nil {
|
||||||
|
return composedWire{}, err
|
||||||
|
}
|
||||||
|
w := composedWire{V: Version, Node: c.Node, Module: c.Module, FP: c.FP, Data: c.Data, Filled: c.Filled,
|
||||||
|
Signature: c.Signature, Resources: make([]json.RawMessage, len(c.Resources))}
|
||||||
|
for i, r := range c.Resources {
|
||||||
|
canon, err := canonicalJSON(r)
|
||||||
|
if err != nil {
|
||||||
|
return composedWire{}, fmt.Errorf("delivery: a resource of %q is not JSON: %w", c.Module, err)
|
||||||
|
}
|
||||||
|
w.Resources[i] = canon
|
||||||
|
}
|
||||||
|
if !c.Own.empty() {
|
||||||
|
own := c.Own
|
||||||
|
w.Own = &own
|
||||||
|
}
|
||||||
|
return w, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncodeComposed is c as JSON at Version, each resource canonical. It refuses a composition whose node or fingerprint
|
||||||
|
// a key refuses, a resource its kind refuses (an action among them), a resource of another module, a module's
|
||||||
|
// composition carrying the node's own parts, a file over 64 KiB carried whole, and a filled path no file declares.
|
||||||
|
func EncodeComposed(c Composed) ([]byte, error) {
|
||||||
|
w, err := c.wire()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return json.Marshal(w)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecodeComposed reads a composition; it refuses an unknown version (ErrUnknownVersion), a field it does not know, and
|
||||||
|
// what EncodeComposed refuses.
|
||||||
|
func DecodeComposed(data []byte) (Composed, error) {
|
||||||
|
if err := checkVersion(data); err != nil {
|
||||||
|
return Composed{}, err
|
||||||
|
}
|
||||||
|
var w composedWire
|
||||||
|
d := json.NewDecoder(bytes.NewReader(data))
|
||||||
|
d.DisallowUnknownFields()
|
||||||
|
if err := d.Decode(&w); err != nil {
|
||||||
|
return Composed{}, fmt.Errorf("delivery: a composition does not fit its shape: %w", err)
|
||||||
|
}
|
||||||
|
c := Composed{V: w.V, Node: w.Node, Module: w.Module, FP: w.FP, Data: w.Data, Resources: w.Resources,
|
||||||
|
Filled: w.Filled, Signature: w.Signature}
|
||||||
|
if w.Own != nil {
|
||||||
|
c.Own = *w.Own
|
||||||
|
}
|
||||||
|
if err := c.check(); err != nil {
|
||||||
|
return Composed{}, err
|
||||||
|
}
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ComposedDigestOf is a composition's digest, "sha256:<hex>", of its encoding without its signature. A want names it
|
||||||
|
// (ADR 0539 clause 1), the controller writes it beside the composition, and the signature signs it.
|
||||||
|
func ComposedDigestOf(c Composed) (string, error) {
|
||||||
|
c.Signature = nil
|
||||||
|
raw, err := EncodeComposed(c)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
sum := sha256.Sum256(raw)
|
||||||
|
return "sha256:" + hex.EncodeToString(sum[:]), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SameComposed says whether two compositions are the same value, their signatures included, so the controller writes
|
||||||
|
// only when they differ.
|
||||||
|
func SameComposed(a, b Composed) bool {
|
||||||
|
ra, errA := EncodeComposed(a)
|
||||||
|
rb, errB := EncodeComposed(b)
|
||||||
|
return errA == nil && errB == nil && bytes.Equal(ra, rb)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ByDigest is c with every file over 64 KiB given by its digest and size, and the content of each by digest, for the
|
||||||
|
// writer to put in the node's object bucket (declaration.FileBucketFor) under declaration.ObjectName before it writes
|
||||||
|
// the composition (ADR 0539 clause 4, ADR 0488 §3). A file that is sealed, filled with secrets or written into another
|
||||||
|
// stays as it is (declaration.File.TravelsByDigest).
|
||||||
|
func (c Composed) ByDigest() (Composed, map[string][]byte, error) {
|
||||||
|
out := c
|
||||||
|
out.Resources = make([]json.RawMessage, len(c.Resources))
|
||||||
|
objects := map[string][]byte{}
|
||||||
|
for i, raw := range c.Resources {
|
||||||
|
out.Resources[i] = raw
|
||||||
|
r, err := declaration.ParseResource(raw)
|
||||||
|
if err != nil {
|
||||||
|
return Composed{}, nil, err
|
||||||
|
}
|
||||||
|
f, ok := r.(*declaration.File)
|
||||||
|
if !ok || !f.TravelsByDigest() {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
ref, body, err := f.AsReference()
|
||||||
|
if err != nil {
|
||||||
|
return Composed{}, nil, err
|
||||||
|
}
|
||||||
|
var fields map[string]json.RawMessage
|
||||||
|
if err := json.Unmarshal(raw, &fields); err != nil {
|
||||||
|
return Composed{}, nil, err
|
||||||
|
}
|
||||||
|
delete(fields, "content")
|
||||||
|
delete(fields, "bytes")
|
||||||
|
fields["digest"], _ = json.Marshal(ref.Digest)
|
||||||
|
fields["size"], _ = json.Marshal(ref.Size)
|
||||||
|
rewritten, err := json.Marshal(fields)
|
||||||
|
if err != nil {
|
||||||
|
return Composed{}, nil, err
|
||||||
|
}
|
||||||
|
out.Resources[i] = rewritten
|
||||||
|
objects[ref.Digest] = body
|
||||||
|
}
|
||||||
|
return out, objects, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SplitComposed splits a node's composed resources into its compositions, by key (ComposedKey, ComposedNodeKey): each
|
||||||
|
// resource into the composition of the module it says, under that module's fingerprint in fps, and a resource that
|
||||||
|
// says no module into the node's own, with own. Each filled path goes with the module whose file declares it. The order
|
||||||
|
// of the resources is kept within each composition. A resource of a module fps names no fingerprint for is refused,
|
||||||
|
// naming it. Data is the caller's to set, from the module's manifest.
|
||||||
|
func SplitComposed(node string, resources []json.RawMessage, fps map[string]string, filled []string, own NodeOwn) (map[string]Composed, error) {
|
||||||
|
nodeKey, err := ComposedNodeKey(node)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
out := map[string]Composed{nodeKey: {Node: node, Own: own, Resources: []json.RawMessage{}}}
|
||||||
|
pathOf := map[string]string{}
|
||||||
|
for _, raw := range resources {
|
||||||
|
var head struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Type string `json:"type"`
|
||||||
|
Module string `json:"module"`
|
||||||
|
Path string `json:"path"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(raw, &head); err != nil {
|
||||||
|
return nil, fmt.Errorf("delivery: a resource of %s is not JSON: %w", node, err)
|
||||||
|
}
|
||||||
|
key := nodeKey
|
||||||
|
if head.Module != "" {
|
||||||
|
fp, ok := fps[head.Module]
|
||||||
|
if !ok {
|
||||||
|
return nil, fmt.Errorf("delivery: the resource %q is of %q, whose fingerprint on %s is not given", head.ID, head.Module, node)
|
||||||
|
}
|
||||||
|
if key, err = ComposedKey(node, head.Module, fp); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if _, ok := out[key]; !ok {
|
||||||
|
out[key] = Composed{Node: node, Module: head.Module, FP: fp}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if head.Type == string(declaration.TypeFile) && head.Module != "" {
|
||||||
|
pathOf[head.Path] = key
|
||||||
|
}
|
||||||
|
c := out[key]
|
||||||
|
c.Resources = append(c.Resources, raw)
|
||||||
|
out[key] = c
|
||||||
|
}
|
||||||
|
for _, path := range filled {
|
||||||
|
key, ok := pathOf[path]
|
||||||
|
if !ok {
|
||||||
|
return nil, fmt.Errorf("delivery: the provisioner fills %q on %s, and no module's file declares it", path, node)
|
||||||
|
}
|
||||||
|
c := out[key]
|
||||||
|
c.Filled = append(c.Filled, path)
|
||||||
|
out[key] = c
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,364 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"compress/gzip"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/declaration"
|
||||||
|
)
|
||||||
|
|
||||||
|
// capturedDeclaration is a node's declaration as the controller's `plan` verb answered it on 2026-10-24 at 16:19
|
||||||
|
// (testdata/declaration-<node>.json.gz; the resources carrying a sealed value or a secret taken out, and the filled
|
||||||
|
// files that named them), never typed by hand.
|
||||||
|
type capturedDeclaration struct {
|
||||||
|
Builds map[string]string `json:"builds"`
|
||||||
|
Resources []json.RawMessage `json:"resources"`
|
||||||
|
Filled []string `json:"filled_files"`
|
||||||
|
Provisioner string `json:"provisioner_account"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func readCaptured(t *testing.T, node string) capturedDeclaration {
|
||||||
|
t.Helper()
|
||||||
|
f, err := os.Open("testdata/declaration-" + node + ".json.gz")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer f.Close()
|
||||||
|
z, err := gzip.NewReader(f)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
raw, err := io.ReadAll(z)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
var c capturedDeclaration
|
||||||
|
if err := json.Unmarshal(raw, &c); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
|
||||||
|
// fpOfBuild stands for each module's fingerprint in a captured declaration, which names builds, not fingerprints.
|
||||||
|
func fpOfBuild(build string) string {
|
||||||
|
var b strings.Builder
|
||||||
|
for b.Len() < 64 {
|
||||||
|
b.WriteString(fmt.Sprintf("%x", []byte(build)))
|
||||||
|
}
|
||||||
|
return SourcePrefix2 + b.String()[:64]
|
||||||
|
}
|
||||||
|
|
||||||
|
func splitCaptured(t *testing.T, node string, c capturedDeclaration) map[string]Composed {
|
||||||
|
t.Helper()
|
||||||
|
fps := map[string]string{}
|
||||||
|
for m, b := range c.Builds {
|
||||||
|
fps[m] = fpOfBuild(b)
|
||||||
|
}
|
||||||
|
// mesh-wireguard's resources are composed with no build of it named; its fingerprint is the indexer's, as every
|
||||||
|
// module's is, and stood in for here by its name.
|
||||||
|
for _, r := range c.Resources {
|
||||||
|
var head struct {
|
||||||
|
Module string `json:"module"`
|
||||||
|
}
|
||||||
|
_ = json.Unmarshal(r, &head)
|
||||||
|
if _, ok := fps[head.Module]; head.Module != "" && !ok {
|
||||||
|
fps[head.Module] = fpOfBuild(head.Module)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
split, err := SplitComposed(node, c.Resources, fps, c.Filled, NodeOwn{Provisioner: c.Provisioner})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("SplitComposed(%s): %v", node, err)
|
||||||
|
}
|
||||||
|
return split
|
||||||
|
}
|
||||||
|
|
||||||
|
func canonical(t *testing.T, raw json.RawMessage) string {
|
||||||
|
t.Helper()
|
||||||
|
var v any
|
||||||
|
d := json.NewDecoder(bytes.NewReader(raw))
|
||||||
|
d.UseNumber()
|
||||||
|
if err := d.Decode(&v); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
out, _ := json.Marshal(v)
|
||||||
|
return string(out)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943/AC2: each module's slice of a captured declaration of each node, and the node's own resources, round-trip
|
||||||
|
// through the composition's encoding with the same digest; together they are the declaration's resources, each once,
|
||||||
|
// each in the composition of the module it says.
|
||||||
|
func TestCompositionsOfACapturedDeclaration(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
for _, node := range []string{"ace", "g14"} {
|
||||||
|
t.Run(node, func(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
oneCapturedDeclaration(t, node)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func oneCapturedDeclaration(t *testing.T, node string) {
|
||||||
|
{
|
||||||
|
c := readCaptured(t, node)
|
||||||
|
split := splitCaptured(t, node, c)
|
||||||
|
modules := map[string]bool{}
|
||||||
|
for m := range c.Builds {
|
||||||
|
modules[m] = true
|
||||||
|
}
|
||||||
|
var union []string
|
||||||
|
for key, comp := range split {
|
||||||
|
n, module, fp, isNode, err := ParseComposedKey(key)
|
||||||
|
if err != nil || n != node || comp.Node != node || comp.Module != module || comp.FP != fp {
|
||||||
|
t.Fatalf("%s: key %q holds %s/%s/%s (%v)", node, key, comp.Node, comp.Module, comp.FP, err)
|
||||||
|
}
|
||||||
|
if !isNode && !modules[module] && module != "mesh-wireguard" {
|
||||||
|
t.Errorf("%s: a composition of %s, which the declaration names no build of", node, module)
|
||||||
|
}
|
||||||
|
raw, err := EncodeComposed(comp)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("%s: EncodeComposed(%s): %v", node, key, err)
|
||||||
|
}
|
||||||
|
back, err := DecodeComposed(raw)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("%s: DecodeComposed(%s): %v", node, key, err)
|
||||||
|
}
|
||||||
|
if !SameComposed(back, comp) {
|
||||||
|
t.Errorf("%s: %s did not round-trip", node, key)
|
||||||
|
}
|
||||||
|
// SameComposed encodes both, so the digest of what was read back, a hash of its encoding, is the one written.
|
||||||
|
if d, err := ComposedDigestOf(back); err != nil || !digestForm.MatchString(d) {
|
||||||
|
t.Errorf("%s: %s digests %q (%v)", node, key, d, err)
|
||||||
|
}
|
||||||
|
for _, r := range back.Resources {
|
||||||
|
var head struct {
|
||||||
|
Module string `json:"module"`
|
||||||
|
}
|
||||||
|
_ = json.Unmarshal(r, &head)
|
||||||
|
if head.Module != module {
|
||||||
|
t.Errorf("%s: %s holds a resource of %q", node, key, head.Module)
|
||||||
|
}
|
||||||
|
union = append(union, canonical(t, r))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var want []string
|
||||||
|
for _, r := range c.Resources {
|
||||||
|
want = append(want, canonical(t, r))
|
||||||
|
}
|
||||||
|
sort.Strings(union)
|
||||||
|
sort.Strings(want)
|
||||||
|
if strings.Join(union, "\n") != strings.Join(want, "\n") {
|
||||||
|
t.Errorf("%s: the compositions hold %d resources, the declaration %d, or they differ", node, len(union), len(want))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943/AC2: one changed byte of a resource is another digest; the same composition written with its keys in another
|
||||||
|
// order is the same digest.
|
||||||
|
func TestComposedDigestFollowsTheContent(t *testing.T) {
|
||||||
|
c := readCaptured(t, "g14")
|
||||||
|
split := splitCaptured(t, "g14", c)
|
||||||
|
var comp Composed
|
||||||
|
for _, v := range split {
|
||||||
|
if v.Module != "" && len(v.Resources) > 1 {
|
||||||
|
comp = v
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
d1, _ := ComposedDigestOf(comp)
|
||||||
|
var m map[string]json.RawMessage
|
||||||
|
_ = json.Unmarshal(comp.Resources[0], &m)
|
||||||
|
var keys []string
|
||||||
|
for k := range m {
|
||||||
|
keys = append(keys, k)
|
||||||
|
}
|
||||||
|
sort.Sort(sort.Reverse(sort.StringSlice(keys)))
|
||||||
|
var parts []string
|
||||||
|
for _, k := range keys {
|
||||||
|
parts = append(parts, fmt.Sprintf("%q : %s", k, m[k]))
|
||||||
|
}
|
||||||
|
reordered := json.RawMessage("{ " + strings.Join(parts, ",\n ") + " }")
|
||||||
|
shuffled := comp
|
||||||
|
shuffled.Resources = append([]json.RawMessage{reordered}, comp.Resources[1:]...)
|
||||||
|
if d2, _ := ComposedDigestOf(shuffled); d2 != d1 {
|
||||||
|
t.Errorf("the same resources in another order and spacing digest %s and %s", d1, d2)
|
||||||
|
}
|
||||||
|
changed := comp
|
||||||
|
changed.Resources = append([]json.RawMessage{json.RawMessage(strings.Replace(canonical(t, comp.Resources[0]), `"id":"`, `"id":"x`, 1))}, comp.Resources[1:]...)
|
||||||
|
if d3, _ := ComposedDigestOf(changed); d3 == d1 {
|
||||||
|
t.Errorf("a changed resource kept its digest")
|
||||||
|
}
|
||||||
|
revised := comp
|
||||||
|
revised.Data = !comp.Data
|
||||||
|
if d4, _ := ComposedDigestOf(revised); d4 == d1 {
|
||||||
|
t.Errorf("a changed data flag kept its digest")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943/AC2: a file over 64 KiB is carried by digest and size, its content handed back to be put in the node's object
|
||||||
|
// bucket; a composition that carries such a file whole is refused.
|
||||||
|
func TestAComposedFileOver64KiBIsCarriedByDigest(t *testing.T) {
|
||||||
|
c := readCaptured(t, "g14")
|
||||||
|
split := splitCaptured(t, "g14", c)
|
||||||
|
var comp Composed
|
||||||
|
var at int
|
||||||
|
for _, v := range split {
|
||||||
|
for i, r := range v.Resources {
|
||||||
|
var f map[string]any
|
||||||
|
_ = json.Unmarshal(r, &f)
|
||||||
|
if f["type"] == "file" && v.Module != "" && f["bytes"] == nil && f["into"] == nil {
|
||||||
|
comp, at = v, i
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if comp.Module != "" {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var f map[string]any
|
||||||
|
_ = json.Unmarshal(comp.Resources[at], &f)
|
||||||
|
// Grown past the threshold from a captured file: no captured file of this node is over 64 KiB.
|
||||||
|
body := strings.Repeat("x", declaration.FileReferenceThreshold+1)
|
||||||
|
f["content"] = body
|
||||||
|
big, _ := json.Marshal(f)
|
||||||
|
comp.Resources = append([]json.RawMessage{}, comp.Resources...)
|
||||||
|
comp.Resources[at] = big
|
||||||
|
if _, err := EncodeComposed(comp); err == nil || !strings.Contains(err.Error(), "by digest") {
|
||||||
|
t.Fatalf("a file over 64 KiB carried whole = %v, want refused", err)
|
||||||
|
}
|
||||||
|
byDigest, objects, err := comp.ByDigest()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
var ref map[string]any
|
||||||
|
_ = json.Unmarshal(byDigest.Resources[at], &ref)
|
||||||
|
digest := declaration.DigestOf([]byte(body))
|
||||||
|
if ref["digest"] != digest || ref["size"] != float64(len(body)) || ref["content"] != nil {
|
||||||
|
t.Errorf("the file became %v, want digest %s and size %d", ref, digest, len(body))
|
||||||
|
}
|
||||||
|
if string(objects[digest]) != body || len(objects) != 1 {
|
||||||
|
t.Errorf("the objects handed back are %d, want the file's content under its digest", len(objects))
|
||||||
|
}
|
||||||
|
if _, err := EncodeComposed(byDigest); err != nil {
|
||||||
|
t.Errorf("the composition by digest is refused: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943/AC2: an unknown version is refused as one; a module's composition carrying the node's own parts, a resource of
|
||||||
|
// another module, a resource its kind refuses, or no fingerprint, is refused, naming why.
|
||||||
|
func TestComposedRefusals(t *testing.T) {
|
||||||
|
fp := fp2of('a')
|
||||||
|
file := json.RawMessage(`{"id":"m.f","type":"file","module":"m","path":"/etc/m","content":"x"}`)
|
||||||
|
ok := Composed{Node: "ace", Module: "m", FP: fp, Resources: []json.RawMessage{file}}
|
||||||
|
raw, err := EncodeComposed(ok)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := DecodeComposed(bytes.Replace(raw, []byte(`"v":1`), []byte(`"v":2`), 1)); !errors.Is(err, ErrUnknownVersion) {
|
||||||
|
t.Errorf("version 2 = %v, want ErrUnknownVersion", err)
|
||||||
|
}
|
||||||
|
refusals := []struct {
|
||||||
|
c Composed
|
||||||
|
why string
|
||||||
|
}{
|
||||||
|
{Composed{Node: "ace", Module: "m", Resources: []json.RawMessage{file}}, "fingerprint"},
|
||||||
|
{Composed{Node: "", Module: "m", FP: fp, Resources: []json.RawMessage{file}}, "node name is empty"},
|
||||||
|
{Composed{Node: "ace", Module: "other", FP: fp, Resources: []json.RawMessage{file}}, `of "m"`},
|
||||||
|
{Composed{Node: "ace", Module: "m", FP: fp, Resources: []json.RawMessage{file}, Own: NodeOwn{Provisioner: "p"}}, "node's own"},
|
||||||
|
{Composed{Node: "ace", FP: fp, Resources: []json.RawMessage{}}, "names no fingerprint"},
|
||||||
|
{Composed{Node: "ace", Resources: []json.RawMessage{file}}, `of "m"`},
|
||||||
|
{Composed{Node: "ace", Module: "m", FP: fp, Resources: []json.RawMessage{json.RawMessage(`{"id":"m.f","type":"file","module":"m","path":"/etc/m","content":"x","image":"y"}`)}}, `"image"`},
|
||||||
|
{Composed{Node: "ace", Module: "m", FP: fp, Resources: []json.RawMessage{json.RawMessage(`{"id":"m.a","type":"action","module":"m"}`)}}, "action"},
|
||||||
|
}
|
||||||
|
for _, r := range refusals {
|
||||||
|
if _, err := EncodeComposed(r.c); err == nil || !strings.Contains(err.Error(), r.why) {
|
||||||
|
t.Errorf("EncodeComposed(%s/%s) = %v, want a refusal saying %q", r.c.Node, r.c.Module, err, r.why)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943/AC2 (issue 1150): a module whose name holds a dot keys its have, its want and its composition escaped, and the
|
||||||
|
// parsers give its name back; a name with a wildcard, whitespace or an escape of its own is still refused.
|
||||||
|
func TestADottedModuleKeysEscaped(t *testing.T) {
|
||||||
|
fp := fp2of('f')
|
||||||
|
have, err := HaveKey("ace", "novox.be")
|
||||||
|
if err != nil || have != "ace.novox=2ebe" {
|
||||||
|
t.Fatalf("HaveKey = %q, %v", have, err)
|
||||||
|
}
|
||||||
|
if n, m, isNode, err := ParseHaveKey(have); err != nil || n != "ace" || m != "novox.be" || isNode {
|
||||||
|
t.Errorf("ParseHaveKey(%q) = %q, %q, %v, %v", have, n, m, isNode, err)
|
||||||
|
}
|
||||||
|
want, err := WantKey("ace", "novox.be")
|
||||||
|
if err != nil || want != "want.ace.novox=2ebe" {
|
||||||
|
t.Fatalf("WantKey = %q, %v", want, err)
|
||||||
|
}
|
||||||
|
if n, m, err := ParseWantKey(want); err != nil || n != "ace" || m != "novox.be" {
|
||||||
|
t.Errorf("ParseWantKey(%q) = %q, %q, %v", want, n, m, err)
|
||||||
|
}
|
||||||
|
comp, err := ComposedKey("ace", "novox.be", fp)
|
||||||
|
if err != nil || comp != "ace.novox=2ebe."+strings.Repeat("f", 64) {
|
||||||
|
t.Fatalf("ComposedKey = %q, %v", comp, err)
|
||||||
|
}
|
||||||
|
if n, m, back, _, err := ParseComposedKey(comp); err != nil || n != "ace" || m != "novox.be" || back != fp {
|
||||||
|
t.Errorf("ParseComposedKey(%q) = %q, %q, %q, %v", comp, n, m, back, err)
|
||||||
|
}
|
||||||
|
for _, bad := range []string{"m*", "m x", "m=2e", "m>", ".m", "m.", "a..b"} {
|
||||||
|
if _, err := HaveKey("ace", bad); err == nil {
|
||||||
|
t.Errorf("HaveKey(ace, %q) accepted", bad)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, bad := range []string{"ace.m=2", "ace.m=2E", "ace.m=41", "ace.=6eode"} {
|
||||||
|
if _, _, _, err := ParseHaveKey(bad); err == nil {
|
||||||
|
t.Errorf("ParseHaveKey(%q) accepted", bad)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The node's own composition carries the filled paths of the files moved into it, the files of a module with no
|
||||||
|
// fingerprint of the new form: the provisioner fills them all the same (issue 1945, live on 2026-10-25: the paths were
|
||||||
|
// dropped and the node-engine wrote those files empty). It still holds no module's data.
|
||||||
|
func TestTheNodesOwnCompositionCarriesTheFilledPathsOfItsFiles(t *testing.T) {
|
||||||
|
filled := json.RawMessage(`{"id":"power.unit","type":"file","path":"/etc/systemd/system/p.service","mode":"0644","owner-at-runtime":"owned"}`)
|
||||||
|
own := Composed{Node: "ace", Resources: []json.RawMessage{filled}, Filled: []string{"/etc/systemd/system/p.service"},
|
||||||
|
Own: NodeOwn{Provisioner: "mesh-provisioner-client"}}
|
||||||
|
raw, err := EncodeComposed(own)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("the node's own composition with a filled file: %v", err)
|
||||||
|
}
|
||||||
|
back, err := DecodeComposed(raw)
|
||||||
|
if err != nil || len(back.Filled) != 1 {
|
||||||
|
t.Fatalf("read back: %v %v", back.Filled, err)
|
||||||
|
}
|
||||||
|
if _, err := EncodeComposed(Composed{Node: "ace", Data: true, Resources: []json.RawMessage{filled},
|
||||||
|
Filled: own.Filled}); err == nil {
|
||||||
|
t.Error("the node's own composition was let hold a module's data")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// A file the provisioner fills says no content: in a composition that does not say it is filled, the node-engine would
|
||||||
|
// write it empty. Such a composition is refused, in the node's own as in a module's (issue 1945).
|
||||||
|
func TestAFileWithNoContentThatIsNotFilledIsRefused(t *testing.T) {
|
||||||
|
fp := fp2of('a')
|
||||||
|
for _, c := range []Composed{
|
||||||
|
{Node: "ace", Resources: []json.RawMessage{json.RawMessage(
|
||||||
|
`{"id":"power.unit","type":"file","path":"/etc/p","mode":"0644","owner-at-runtime":"owned"}`)}},
|
||||||
|
{Node: "ace", Module: "m", FP: fp, Resources: []json.RawMessage{json.RawMessage(
|
||||||
|
`{"id":"m.f","type":"file","module":"m","path":"/etc/m","mode":"0644","owner-at-runtime":"owned"}`)}},
|
||||||
|
} {
|
||||||
|
if _, err := EncodeComposed(c); err == nil || !strings.Contains(err.Error(), "empty") {
|
||||||
|
t.Errorf("%s/%s: %v, want a refusal saying it would be written empty", c.Node, c.Module, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// A file that says its content, even an empty one, is written as it says.
|
||||||
|
if _, err := EncodeComposed(Composed{Node: "ace", Resources: []json.RawMessage{json.RawMessage(
|
||||||
|
`{"id":"x.f","type":"file","path":"/etc/x","mode":"0644","content":""}`)}}); err != nil {
|
||||||
|
t.Errorf("a file that says it is empty: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
+72
-22
@@ -11,7 +11,8 @@
|
|||||||
// `node`. A presence key is `<node>` for a node and `part.<part>.<instance>` for a part's instance, so a node may
|
// `node`. A presence key is `<node>` for a node and `part.<part>.<instance>` for a part's instance, so a node may
|
||||||
// not be named `part`. A pulse key is `<bucket>.<key>`: the full name of the bucket watched, then that bucket's key,
|
// not be named `part`. A pulse key is `<bucket>.<key>`: the full name of the bucket watched, then that bucket's key,
|
||||||
// which may hold dots, so it splits at the first dot. A name is refused when it is empty or holds a dot, a wildcard,
|
// which may hold dots, so it splits at the first dot. A name is refused when it is empty or holds a dot, a wildcard,
|
||||||
// whitespace or a character a bus key refuses, and the error names it.
|
// whitespace or a character a bus key refuses, and the error names it; but a module's name may hold dots between its
|
||||||
|
// parts (`novox.be`), and keys with each dot escaped as EscapeName writes it (`novox=2ebe`, issue 1150).
|
||||||
//
|
//
|
||||||
// **Values** are JSON of under about 500 bytes, each carrying its version in `v`. A reader refuses a value whose
|
// **Values** are JSON of under about 500 bytes, each carrying its version in `v`. A reader refuses a value whose
|
||||||
// version is missing or one it does not know, with an error that is ErrUnknownVersion (research 063 section 05
|
// version is missing or one it does not know, with an error that is ErrUnknownVersion (research 063 section 05
|
||||||
@@ -35,7 +36,7 @@
|
|||||||
// builder's build keys (builder.go) and the checker's verdicts and kept verdicts (checker.go). A manifests value is the
|
// builder's build keys (builder.go) and the checker's verdicts and kept verdicts (checker.go). A manifests value is the
|
||||||
// one exception to the size above: a manifest is up to about 21 KB, whole, byte for byte.
|
// one exception to the size above: a manifest is up to about 21 KB, whole, byte for byte.
|
||||||
//
|
//
|
||||||
// Standard library only, and this module's own asks package.
|
// Standard library only, and this module's own asks and declaration packages (a composition holds declaration resources).
|
||||||
package delivery
|
package delivery
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -89,6 +90,10 @@ const (
|
|||||||
// for which it had written a have key; the key is never deleted (issue 1369, ADR 0408 §4), so a reader can tell
|
// for which it had written a have key; the key is never deleted (issue 1369, ADR 0408 §4), so a reader can tell
|
||||||
// that the module stopped.
|
// that the module stopped.
|
||||||
PhaseRemoved Phase = "removed"
|
PhaseRemoved Phase = "removed"
|
||||||
|
// PhaseHeld is a module whose backup before an apply failed: it keeps running what it has, nothing of the new
|
||||||
|
// composition is applied, and the node waits for the answer in its want (novox/hq ADR 0539 clause 16). Detail
|
||||||
|
// carries the backup's own words.
|
||||||
|
PhaseHeld Phase = "held"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Health is what the module's own check says.
|
// Health is what the module's own check says.
|
||||||
@@ -164,13 +169,45 @@ func HaveKey(node, module string) (string, error) {
|
|||||||
if err := checkName("node", node); err != nil {
|
if err := checkName("node", node); err != nil {
|
||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
if err := checkName("module", module); err != nil {
|
part, err := moduleKeyPart(module)
|
||||||
|
if err != nil {
|
||||||
return "", err
|
return "", err
|
||||||
}
|
}
|
||||||
if module == "node" {
|
if module == "node" {
|
||||||
return "", fmt.Errorf(`delivery: the module name "node" is refused: %s.node is the node's own key`, node)
|
return "", fmt.Errorf(`delivery: the module name "node" is refused: %s.node is the node's own key`, node)
|
||||||
}
|
}
|
||||||
return node + "." + module, nil
|
return node + "." + part, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var moduleNameOK = regexp.MustCompile(`^[-/_a-zA-Z0-9]+(\.[-/_a-zA-Z0-9]+)*$`)
|
||||||
|
|
||||||
|
// moduleKeyPart is a module's name as a key part (issue 1150): a name may hold a dot (`novox.be`), which a key part
|
||||||
|
// may not, so a dot is escaped as EscapeName writes it (`novox=2ebe`); a name of letters, digits, `-`, `/` and `_` keys
|
||||||
|
// as it is. A name that is empty, or holds a wildcard, whitespace, `=`, or an empty part between dots, is refused.
|
||||||
|
func moduleKeyPart(module string) (string, error) {
|
||||||
|
if module == "" {
|
||||||
|
return "", fmt.Errorf("delivery: the module name is empty")
|
||||||
|
}
|
||||||
|
if !moduleNameOK.MatchString(module) {
|
||||||
|
return "", fmt.Errorf("delivery: the module name %q holds a wildcard, whitespace, '=', an empty part between dots or a character a key refuses", module)
|
||||||
|
}
|
||||||
|
return EscapeName(module), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseModuleKeyPart is the inverse of moduleKeyPart; it refuses a part that is not the one moduleKeyPart writes for
|
||||||
|
// its name (an escape of a character that keys as it is, an upper-case escape, an escape of a refused character).
|
||||||
|
func parseModuleKeyPart(part string) (string, error) {
|
||||||
|
if err := checkName("module", part); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
module, err := UnescapeName(part)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if back, err := moduleKeyPart(module); err != nil || back != part {
|
||||||
|
return "", fmt.Errorf("delivery: the module part %q is not a module name as a key writes it", part)
|
||||||
|
}
|
||||||
|
return module, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// HaveNodeKey is the key, in HaveBucket, of a node's own facts: `<node>.node`.
|
// HaveNodeKey is the key, in HaveBucket, of a node's own facts: `<node>.node`.
|
||||||
@@ -190,12 +227,13 @@ func ParseHaveKey(key string) (node, module string, isNode bool, err error) {
|
|||||||
if err := checkName("node", node); err != nil {
|
if err := checkName("node", node); err != nil {
|
||||||
return "", "", false, fmt.Errorf("delivery: %q is not a have key: %w", key, err)
|
return "", "", false, fmt.Errorf("delivery: %q is not a have key: %w", key, err)
|
||||||
}
|
}
|
||||||
if err := checkName("module", module); err != nil {
|
|
||||||
return "", "", false, fmt.Errorf("delivery: %q is not a have key: %w", key, err)
|
|
||||||
}
|
|
||||||
if module == "node" {
|
if module == "node" {
|
||||||
return node, "", true, nil
|
return node, "", true, nil
|
||||||
}
|
}
|
||||||
|
module, err = parseModuleKeyPart(module)
|
||||||
|
if err != nil {
|
||||||
|
return "", "", false, fmt.Errorf("delivery: %q is not a have key: %w", key, err)
|
||||||
|
}
|
||||||
return node, module, false, nil
|
return node, module, false, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -282,24 +320,31 @@ func PulseTTL(moveAge time.Duration) (ttl time.Duration, stalled bool) {
|
|||||||
// Have is a module's state on a node, written by that node's node-engine under HaveKey. FP is the module's
|
// Have is a module's state on a node, written by that node's node-engine under HaveKey. FP is the module's
|
||||||
// fingerprint once the indexer exists (design 47 release 3); until then Build is the build the node was sent, and
|
// fingerprint once the indexer exists (design 47 release 3); until then Build is the build the node was sent, and
|
||||||
// the view compares by build.
|
// the view compares by build.
|
||||||
|
//
|
||||||
|
// Composed is the digest of the composition the node runs for the module (novox/hq ADR 0539 clause 9): the
|
||||||
|
// controller judges a move against it (clause 14), and the assigner reads it to know a want was applied.
|
||||||
type Have struct {
|
type Have struct {
|
||||||
V int `json:"v"`
|
V int `json:"v"`
|
||||||
FP string `json:"fp,omitempty"`
|
FP string `json:"fp,omitempty"`
|
||||||
Build string `json:"build,omitempty"`
|
Composed string `json:"composed,omitempty"`
|
||||||
Phase Phase `json:"phase"`
|
Build string `json:"build,omitempty"`
|
||||||
Health Health `json:"health"`
|
Phase Phase `json:"phase"`
|
||||||
Detail string `json:"detail,omitempty"`
|
Health Health `json:"health"`
|
||||||
|
Detail string `json:"detail,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// HaveNode is a node's own facts, written under HaveNodeKey. Each field is the node-engine's own JSON, carried whole:
|
// HaveNode is a node's own facts, written under HaveNodeKey. Each field is the node-engine's own JSON, carried whole:
|
||||||
// this package names the facts and does not type them.
|
// this package names the facts and does not type them.
|
||||||
|
//
|
||||||
|
// Composed is the digest of the node's own composition it runs (ADR 0539 clause 9).
|
||||||
type HaveNode struct {
|
type HaveNode struct {
|
||||||
V int `json:"v"`
|
V int `json:"v"`
|
||||||
Windows json.RawMessage `json:"windows,omitempty"`
|
Composed string `json:"composed,omitempty"`
|
||||||
Busy json.RawMessage `json:"busy,omitempty"`
|
Windows json.RawMessage `json:"windows,omitempty"`
|
||||||
Strays json.RawMessage `json:"strays,omitempty"`
|
Busy json.RawMessage `json:"busy,omitempty"`
|
||||||
Filters json.RawMessage `json:"filters,omitempty"`
|
Strays json.RawMessage `json:"strays,omitempty"`
|
||||||
Profile json.RawMessage `json:"profile,omitempty"`
|
Filters json.RawMessage `json:"filters,omitempty"`
|
||||||
|
Profile json.RawMessage `json:"profile,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Presence is whether a node or a part's instance is online; the entry's own time says since when. The watchman
|
// Presence is whether a node or a part's instance is online; the entry's own time says since when. The watchman
|
||||||
@@ -347,9 +392,14 @@ func decode(data []byte, into any) error {
|
|||||||
|
|
||||||
func (h Have) check() error {
|
func (h Have) check() error {
|
||||||
switch h.Phase {
|
switch h.Phase {
|
||||||
case PhaseBackingUp, PhaseApplying, PhaseChecking, PhaseRunning, PhaseFailed, PhaseRemoved:
|
case PhaseBackingUp, PhaseApplying, PhaseChecking, PhaseRunning, PhaseFailed, PhaseRemoved, PhaseHeld:
|
||||||
default:
|
default:
|
||||||
return fmt.Errorf("delivery: phase %q is not backing-up, applying, checking, running, failed or removed", h.Phase)
|
return fmt.Errorf("delivery: phase %q is not backing-up, applying, checking, running, failed, removed or held", h.Phase)
|
||||||
|
}
|
||||||
|
if h.Composed != "" {
|
||||||
|
if err := checkDigest(h.Composed, "the have's composition digest"); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
}
|
}
|
||||||
switch h.Health {
|
switch h.Health {
|
||||||
case HealthOK, HealthFailed, HealthWaits, HealthUnknown:
|
case HealthOK, HealthFailed, HealthWaits, HealthUnknown:
|
||||||
@@ -424,7 +474,7 @@ func SameHave(a, b Have) bool { return a == b }
|
|||||||
|
|
||||||
// SameHaveNode says whether two node facts are the same value, comparing each carried JSON without its spacing.
|
// SameHaveNode says whether two node facts are the same value, comparing each carried JSON without its spacing.
|
||||||
func SameHaveNode(a, b HaveNode) bool {
|
func SameHaveNode(a, b HaveNode) bool {
|
||||||
return a.V == b.V && sameJSON(a.Windows, b.Windows) && sameJSON(a.Busy, b.Busy) &&
|
return a.V == b.V && a.Composed == b.Composed && sameJSON(a.Windows, b.Windows) && sameJSON(a.Busy, b.Busy) &&
|
||||||
sameJSON(a.Strays, b.Strays) && sameJSON(a.Filters, b.Filters) && sameJSON(a.Profile, b.Profile)
|
sameJSON(a.Strays, b.Strays) && sameJSON(a.Filters, b.Filters) && sameJSON(a.Profile, b.Profile)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,92 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// The controller's grants (novox/hq ADR 0528 clause 2, ADR 0429 §6 rule 6): when the controller has issued a module's
|
||||||
|
// bus credential for a fingerprint, it writes `<module>.<fingerprint hex>` in its bucket grants. The assigner reads
|
||||||
|
// it: a node's want moves to a fingerprint only once its grant exists. Only the controller writes the bucket.
|
||||||
|
//
|
||||||
|
// The names say Controller, since the catalogue's GrantKey (catalogue/streams.go) is a stream's grant pattern, unrelated.
|
||||||
|
const (
|
||||||
|
// ControllerGrantsBucket is the controller's bucket of issued credentials by fingerprint.
|
||||||
|
ControllerGrantsBucket = "mesh-controller_grants"
|
||||||
|
// ControllerGrantsHistory is the revisions the bucket keeps per key.
|
||||||
|
ControllerGrantsHistory = 5
|
||||||
|
)
|
||||||
|
|
||||||
|
// ControllerGrantKey is the key, in ControllerGrantsBucket, of a module's credential issued for a fingerprint:
|
||||||
|
// `<module>.<hex>`, the hex being the fingerprint's key part (FingerprintKeyPart).
|
||||||
|
func ControllerGrantKey(module, fingerprint string) (string, error) {
|
||||||
|
return BuilderBuildKey(module, fingerprint)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseControllerGrantKey is the inverse of ControllerGrantKey; it refuses a want or held key, naming it.
|
||||||
|
func ParseControllerGrantKey(key string) (module, fingerprint string, err error) {
|
||||||
|
if module, fingerprint, err = ParseBuilderBuildKey(key); err != nil {
|
||||||
|
return "", "", fmt.Errorf("delivery: %q is not a grant key, <module>.<fingerprint hex>: %w", key, err)
|
||||||
|
}
|
||||||
|
return module, fingerprint, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ControllerGrant is the value of a grant key: the bus accounts (their public keys) the module's processes were issued
|
||||||
|
// for that fingerprint, none for a module whose grants the tool runner's account carries, so a reissue for another
|
||||||
|
// account is a new revision. The entry's own time says when it was issued.
|
||||||
|
type ControllerGrant struct {
|
||||||
|
V int `json:"v"`
|
||||||
|
Accounts []string `json:"accounts,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (g ControllerGrant) check() error {
|
||||||
|
for _, a := range g.Accounts {
|
||||||
|
if strings.TrimSpace(a) == "" || strings.ContainsAny(a, " \t\n") {
|
||||||
|
return fmt.Errorf("delivery: a grant names an empty or spaced account %q", a)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncodeControllerGrant is g as JSON at Version; it refuses an empty or spaced account.
|
||||||
|
func EncodeControllerGrant(g ControllerGrant) ([]byte, error) {
|
||||||
|
if err := g.check(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
g.V = Version
|
||||||
|
return json.Marshal(g)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecodeControllerGrant reads a grant; it refuses an unknown version (ErrUnknownVersion) and an empty or spaced account.
|
||||||
|
func DecodeControllerGrant(data []byte) (ControllerGrant, error) {
|
||||||
|
var g ControllerGrant
|
||||||
|
if err := decode(data, &g); err != nil {
|
||||||
|
return ControllerGrant{}, err
|
||||||
|
}
|
||||||
|
if err := g.check(); err != nil {
|
||||||
|
return ControllerGrant{}, err
|
||||||
|
}
|
||||||
|
return g, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SameControllerGrant says whether two grants are the same value.
|
||||||
|
func SameControllerGrant(a, b ControllerGrant) bool { return reflect.DeepEqual(a, b) }
|
||||||
|
|
||||||
|
// NamesNode says whether the grant names module's accounts on node: its own `<node>.<module>` or a process's
|
||||||
|
// `<node>.<module>.<process>`. A grant that names no account (a module that does not speak on the bus) names every
|
||||||
|
// node. The assigner wants a node only once the grant names its account (issue 1945), and a put waits for it (ADR
|
||||||
|
// 0546 clause 4).
|
||||||
|
func (g ControllerGrant) NamesNode(node, module string) bool {
|
||||||
|
if len(g.Accounts) == 0 {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
own := node + "." + module
|
||||||
|
for _, a := range g.Accounts {
|
||||||
|
if a == own || strings.HasPrefix(a, own+".") {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
@@ -0,0 +1,104 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"sort"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Whether the artifact store still holds what a done key names (novox/hq issue 1937). A build module pushes a bundle or
|
||||||
|
// an archive as a bare blob (ADR 0498 §1), and the store's nightly collector deletes every blob no manifest names; only
|
||||||
|
// the controller's take-in and sweep hold one by its manifest. A done key the controller has not taken in can therefore
|
||||||
|
// name a blob that is gone, and reusing it sends a definition every machine fails on. So the builder asks before it
|
||||||
|
// reuses a done key, and the controller says when a take-in found a gone blob.
|
||||||
|
const (
|
||||||
|
// HeldVerb is the controller seat's verb the builder asks, as a module's invokes names it: references in, each
|
||||||
|
// answered held or gone.
|
||||||
|
HeldVerb = "seat:mesh-controller.held"
|
||||||
|
// ArtifactsGoneEvent is the controller seat's event said when a take-in is refused because the store does not hold
|
||||||
|
// an artifact the key names: as a consumer names it, `mesh-controller.artifacts-gone`.
|
||||||
|
ArtifactsGoneEvent = "artifacts-gone"
|
||||||
|
// ArtifactsGoneSubject is where it is published (the seat's event subject).
|
||||||
|
ArtifactsGoneSubject = "mesh.seat.mesh-controller.event." + ArtifactsGoneEvent
|
||||||
|
)
|
||||||
|
|
||||||
|
// HeldAnswer is the answer of HeldVerb: the references the store holds, and those it answered 404 for. A reference the
|
||||||
|
// store could not be asked about is in neither, and named in Unknown with why.
|
||||||
|
type HeldAnswer struct {
|
||||||
|
Store string `json:"store,omitempty"`
|
||||||
|
Held []string `json:"held"`
|
||||||
|
Gone []string `json:"gone"`
|
||||||
|
Unknown map[string]string `json:"unknown,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecodeHeldAnswer reads HeldVerb's answer: the verb answers {output, ok, answer}, the answer being HeldAnswer. A
|
||||||
|
// reference asked that the answer names in none of held, gone and unknown is an error: an answer that leaves one out
|
||||||
|
// would let a key with a gone blob be reused.
|
||||||
|
func DecodeHeldAnswer(raw []byte, asked []string) (HeldAnswer, error) {
|
||||||
|
var wrapped struct {
|
||||||
|
Output string `json:"output"`
|
||||||
|
OK bool `json:"ok"`
|
||||||
|
Answer json.RawMessage `json:"answer"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(raw, &wrapped); err != nil {
|
||||||
|
return HeldAnswer{}, fmt.Errorf("the answer of %s is not {output, ok, answer}: %w", HeldVerb, err)
|
||||||
|
}
|
||||||
|
if !wrapped.OK || len(wrapped.Answer) == 0 {
|
||||||
|
return HeldAnswer{}, fmt.Errorf("%s did not answer: %s", HeldVerb, wrapped.Output)
|
||||||
|
}
|
||||||
|
var a HeldAnswer
|
||||||
|
if err := json.Unmarshal(wrapped.Answer, &a); err != nil {
|
||||||
|
return HeldAnswer{}, fmt.Errorf("the answer of %s is not {held, gone}: %w", HeldVerb, err)
|
||||||
|
}
|
||||||
|
named := map[string]bool{}
|
||||||
|
for _, r := range a.Held {
|
||||||
|
named[r] = true
|
||||||
|
}
|
||||||
|
for _, r := range a.Gone {
|
||||||
|
named[r] = true
|
||||||
|
}
|
||||||
|
for r := range a.Unknown {
|
||||||
|
named[r] = true
|
||||||
|
}
|
||||||
|
for _, r := range asked {
|
||||||
|
if !named[r] {
|
||||||
|
return HeldAnswer{}, fmt.Errorf("the answer of %s names nothing of %s", HeldVerb, r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return a, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ArtifactsGone is the body of ArtifactsGoneEvent: the module whose builder's key the controller would not take in,
|
||||||
|
// the key and its fingerprint, and every reference of it the store does not hold.
|
||||||
|
type ArtifactsGone struct {
|
||||||
|
Event string `json:"event"`
|
||||||
|
Module string `json:"module"`
|
||||||
|
Key string `json:"key"`
|
||||||
|
Fingerprint string `json:"fingerprint"`
|
||||||
|
Gone []string `json:"gone"`
|
||||||
|
At time.Time `json:"at"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncodeArtifactsGone is the event's body, the references sorted.
|
||||||
|
func EncodeArtifactsGone(e ArtifactsGone) ([]byte, error) {
|
||||||
|
e.Event = ArtifactsGoneEvent
|
||||||
|
e.Gone = append([]string(nil), e.Gone...)
|
||||||
|
sort.Strings(e.Gone)
|
||||||
|
if e.Module == "" || e.Fingerprint == "" || len(e.Gone) == 0 {
|
||||||
|
return nil, fmt.Errorf("delivery: %s names a module, a fingerprint and at least one gone reference", ArtifactsGoneEvent)
|
||||||
|
}
|
||||||
|
return json.Marshal(e)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecodeArtifactsGone reads the event's body, refusing one that names no module, fingerprint or reference.
|
||||||
|
func DecodeArtifactsGone(raw []byte) (ArtifactsGone, error) {
|
||||||
|
var e ArtifactsGone
|
||||||
|
if err := json.Unmarshal(raw, &e); err != nil {
|
||||||
|
return ArtifactsGone{}, fmt.Errorf("delivery: %s is not one: %w", ArtifactsGoneEvent, err)
|
||||||
|
}
|
||||||
|
if e.Event != ArtifactsGoneEvent || e.Module == "" || e.Fingerprint == "" || len(e.Gone) == 0 {
|
||||||
|
return ArtifactsGone{}, fmt.Errorf("delivery: %s names no module, fingerprint or gone reference: %s", ArtifactsGoneEvent, raw)
|
||||||
|
}
|
||||||
|
return e, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,84 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/catalogue"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
refA = "artifact-store://node-tools/runtime/blobs/sha256:a46b5d51a30e8fe71107d75ceb46e3187022fe51f551d0498b8be817f22435cb"
|
||||||
|
refB = "artifact-store://mesh-host/host-arch/blobs/sha256:8a752f914f3523904a5442cae37ce3cb1ad297d6789b0f871585bce4d0c2ea00"
|
||||||
|
)
|
||||||
|
|
||||||
|
// 1937/AC1 (the contract): the controller's answer reads into held and gone, and an answer leaving a reference out is refused.
|
||||||
|
func TestDecodeHeldAnswer(t *testing.T) {
|
||||||
|
raw := []byte(`{"output":"…","ok":true,"answer":{"store":"s:5100","held":["` + refA + `"],"gone":["` + refB + `"]}}`)
|
||||||
|
a, err := DecodeHeldAnswer(raw, []string{refA, refB})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if len(a.Held) != 1 || a.Held[0] != refA || len(a.Gone) != 1 || a.Gone[0] != refB {
|
||||||
|
t.Fatalf("read %+v", a)
|
||||||
|
}
|
||||||
|
if _, err := DecodeHeldAnswer(raw, []string{refA, refB, "artifact-store://x/y/blobs/sha256:00"}); err == nil ||
|
||||||
|
!strings.Contains(err.Error(), "names nothing of") {
|
||||||
|
t.Fatalf("an answer leaving a reference out was taken: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := DecodeHeldAnswer([]byte(`{"output":"the store is down","ok":false}`), nil); err == nil ||
|
||||||
|
!strings.Contains(err.Error(), "the store is down") {
|
||||||
|
t.Fatalf("a failed verb was taken: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1937/AC2 (the contract): the event's body names the module, the fingerprint and the gone references, sorted.
|
||||||
|
func TestArtifactsGoneRoundTrip(t *testing.T) {
|
||||||
|
raw, err := EncodeArtifactsGone(ArtifactsGone{Module: "node-tools", Key: "node-tools.75", Fingerprint: "src2:75",
|
||||||
|
Gone: []string{refB, refA}, At: time.Unix(0, 0).UTC()})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
e, err := DecodeArtifactsGone(raw)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if e.Event != ArtifactsGoneEvent || e.Module != "node-tools" || len(e.Gone) != 2 || e.Gone[0] != refB {
|
||||||
|
t.Fatalf("read %+v", e)
|
||||||
|
}
|
||||||
|
if _, err := EncodeArtifactsGone(ArtifactsGone{Module: "m", Fingerprint: "src2:1"}); err == nil {
|
||||||
|
t.Fatal("an event naming no gone reference was made")
|
||||||
|
}
|
||||||
|
if _, err := DecodeArtifactsGone([]byte(`{"event":"artifacts-gone","module":"m"}`)); err == nil {
|
||||||
|
t.Fatal("an event naming no fingerprint was read")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The verb and the event are on the controller seat's contract under the names the builder uses.
|
||||||
|
func TestHeldOnTheControllerSeat(t *testing.T) {
|
||||||
|
if HeldVerb != "seat:"+catalogue.ControllerSeatName+".held" {
|
||||||
|
t.Fatalf("HeldVerb %q", HeldVerb)
|
||||||
|
}
|
||||||
|
found := false
|
||||||
|
for _, v := range catalogue.ControllerVerbs {
|
||||||
|
if v.Name == "held" {
|
||||||
|
found = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !found {
|
||||||
|
t.Fatal("the controller seat declares no verb held")
|
||||||
|
}
|
||||||
|
for _, s := range catalogue.DefaultSeats() {
|
||||||
|
if s.Name != catalogue.ControllerSeatName {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, e := range s.Emits {
|
||||||
|
if e == ArtifactsGoneEvent {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
t.Fatalf("the controller seat emits %v, not %s", s.Emits, ArtifactsGoneEvent)
|
||||||
|
}
|
||||||
|
t.Fatal("no controller seat")
|
||||||
|
}
|
||||||
@@ -0,0 +1,148 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// A put (novox/hq ADR 0546): one version of a module put on one node by the assigner's tool `assigner_put`. Each put is the
|
||||||
|
// key `<node>.<module>` of the assigner's state puts, which holds the version asked, the hold, why, and each step the
|
||||||
|
// assigner took or waits on, so a reader watches the key to follow it. The want the put writes carries Put (and Hold),
|
||||||
|
// so the assigner's rules pass over that key while the put holds it.
|
||||||
|
|
||||||
|
// AssignerPutsBucket is the assigner's bucket of puts, `<owner module>_puts`.
|
||||||
|
const AssignerPutsBucket = AssignerModule + "_puts"
|
||||||
|
|
||||||
|
// AssignerPutsHistory is the revisions the puts bucket keeps per key: each step of a put is one.
|
||||||
|
const AssignerPutsHistory = 20
|
||||||
|
|
||||||
|
// A put's steps, in the order they are taken (ADR 0546 clauses 3 to 9). A put stands at the last step written.
|
||||||
|
const (
|
||||||
|
// PutAsked is a put written by the tool, not taken up by a pass yet.
|
||||||
|
PutAsked = "asked"
|
||||||
|
// PutBuild waits for the builder's build at the fingerprint.
|
||||||
|
PutBuild = "build"
|
||||||
|
// PutCompose waits for the controller's composition (and grant) at the fingerprint.
|
||||||
|
PutCompose = "compose"
|
||||||
|
// PutPerson waits for the operator's answer to the ask about the move.
|
||||||
|
PutPerson = "person"
|
||||||
|
// PutSnapshot waits for the bus's streams to be snapshotted after the operator's yes.
|
||||||
|
PutSnapshot = "snapshot"
|
||||||
|
// PutWanted is the want written: the node's have has not reached it yet.
|
||||||
|
PutWanted = "wanted"
|
||||||
|
// PutHolding is a held put whose have runs it healthy: the want stays until released.
|
||||||
|
PutHolding = "holding"
|
||||||
|
// PutDone is a put without hold whose have ran it healthy: the rules write the want again.
|
||||||
|
PutDone = "done"
|
||||||
|
// PutReleased is a put released by the tool `assigner_release`.
|
||||||
|
PutReleased = "released"
|
||||||
|
// PutRefused is a put that cannot go on: a build that failed, an answer no, a snapshot not taken. Its words say why.
|
||||||
|
PutRefused = "refused"
|
||||||
|
)
|
||||||
|
|
||||||
|
// PutEnded says a put at this step is over: nothing more is done for it and the rules own the want.
|
||||||
|
func PutEnded(step string) bool {
|
||||||
|
return step == PutDone || step == PutReleased || step == PutRefused
|
||||||
|
}
|
||||||
|
|
||||||
|
// PutStep is one step a put took: when, which, and what was done or waits, in a sentence.
|
||||||
|
type PutStep struct {
|
||||||
|
At time.Time `json:"at"`
|
||||||
|
Step string `json:"step"`
|
||||||
|
Words string `json:"words"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PutStepsKept is how many steps a put keeps, newest last.
|
||||||
|
const PutStepsKept = 16
|
||||||
|
|
||||||
|
// Put is the value of a key of AssignerPutsBucket.
|
||||||
|
type Put struct {
|
||||||
|
V int `json:"v"`
|
||||||
|
// FP is the fingerprint put, of the new form.
|
||||||
|
FP string `json:"fp"`
|
||||||
|
// Hold keeps the want at FP until released.
|
||||||
|
Hold bool `json:"hold,omitempty"`
|
||||||
|
Why string `json:"why"`
|
||||||
|
// By is who asked, as the bus named the caller; "unproven" when it named none.
|
||||||
|
By string `json:"by,omitempty"`
|
||||||
|
At time.Time `json:"at"`
|
||||||
|
// Step is where the put stands now, one of the Put* steps; Words say it in a sentence.
|
||||||
|
Step string `json:"step"`
|
||||||
|
Words string `json:"words,omitempty"`
|
||||||
|
// Composed is the digest of the composition the want names, once known.
|
||||||
|
Composed string `json:"composed,omitempty"`
|
||||||
|
// Ask is the key, in AssignerAsksBucket, of the ask about the move, once asked.
|
||||||
|
Ask string `json:"ask,omitempty"`
|
||||||
|
// Snapshot says where the bus's streams were snapshotted, once they were.
|
||||||
|
Snapshot string `json:"snapshot,omitempty"`
|
||||||
|
// Steps are the steps taken, oldest first, at most PutStepsKept.
|
||||||
|
Steps []PutStep `json:"steps,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Said is p at step with words, the step added to its steps when it differs from the last one.
|
||||||
|
func (p Put) Said(at time.Time, step, words string) Put {
|
||||||
|
if p.Step == step && p.Words == words {
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
p.Step, p.Words = step, words
|
||||||
|
p.Steps = append(append([]PutStep(nil), p.Steps...), PutStep{At: at.UTC(), Step: step, Words: words})
|
||||||
|
if len(p.Steps) > PutStepsKept {
|
||||||
|
p.Steps = p.Steps[len(p.Steps)-PutStepsKept:]
|
||||||
|
}
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p Put) check() error {
|
||||||
|
if err := checkFingerprint(p.FP, "a put's fingerprint"); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if p.Why == "" {
|
||||||
|
return fmt.Errorf("delivery: a put says why")
|
||||||
|
}
|
||||||
|
switch p.Step {
|
||||||
|
case PutAsked, PutBuild, PutCompose, PutPerson, PutSnapshot, PutWanted, PutHolding, PutDone, PutReleased, PutRefused:
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("delivery: %q is not a step of a put", p.Step)
|
||||||
|
}
|
||||||
|
if p.Composed != "" {
|
||||||
|
return checkDigest(p.Composed, "a put's composition digest")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// PutKey is the key, in AssignerPutsBucket, of the put of module on node: `<node>.<module>`.
|
||||||
|
func PutKey(node, module string) (string, error) {
|
||||||
|
return HaveKey(node, module)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParsePutKey reads a PutKey.
|
||||||
|
func ParsePutKey(key string) (node, module string, err error) {
|
||||||
|
node, module, isNode, err := ParseHaveKey(key)
|
||||||
|
if err == nil && isNode {
|
||||||
|
err = fmt.Errorf("delivery: %q is a node's own key, and no put", key)
|
||||||
|
}
|
||||||
|
return node, module, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncodePut is p as JSON at Version; it refuses a fingerprint not of the new form, a put that says no why and an
|
||||||
|
// unknown step.
|
||||||
|
func EncodePut(p Put) ([]byte, error) {
|
||||||
|
if err := p.check(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
p.V = Version
|
||||||
|
return json.Marshal(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecodePut reads a put; it refuses an unknown version (ErrUnknownVersion) and what EncodePut refuses.
|
||||||
|
func DecodePut(data []byte) (Put, error) {
|
||||||
|
var p Put
|
||||||
|
if err := decode(data, &p); err != nil {
|
||||||
|
return Put{}, err
|
||||||
|
}
|
||||||
|
if err := p.check(); err != nil {
|
||||||
|
return Put{}, err
|
||||||
|
}
|
||||||
|
return p, nil
|
||||||
|
}
|
||||||
@@ -271,6 +271,10 @@ type CandidatePull struct {
|
|||||||
Fps map[string]CandidateModule `json:"fps,omitempty"`
|
Fps map[string]CandidateModule `json:"fps,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// CandidateNoneNoModule is the None2 of a candidate's module whose directory the merge preview names no manifest for:
|
||||||
|
// the change removes the module. The indexer writes it and the assigner reads it as a removal (issue 1297).
|
||||||
|
const CandidateNoneNoModule = "the merge preview names no manifest for the module's directory"
|
||||||
|
|
||||||
// CandidateModule is one touched module's new-form fingerprint FP2 (`src2:` and 64 hex digits), or None2, the reason
|
// CandidateModule is one touched module's new-form fingerprint FP2 (`src2:` and 64 hex digits), or None2, the reason
|
||||||
// it has none; exactly one of them. Manifest is the digest of the module's manifest as read at the preview.
|
// it has none; exactly one of them. Manifest is the digest of the module's manifest as read at the preview.
|
||||||
type CandidateModule struct {
|
type CandidateModule struct {
|
||||||
|
|||||||
@@ -0,0 +1,574 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/hex"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"path"
|
||||||
|
"regexp"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// **Asks: a build or a check step is a message a build node pulls when it has a free slot** (novox/hq ADR 0525, as
|
||||||
|
// ADR 0536 §4 changes it; issue 1887). The builder puts a trunk fingerprint's build on the delivery stream of the
|
||||||
|
// artifact's language and a candidate's on the check stream; the checker puts a check of one level on the check stream,
|
||||||
|
// and a re-judge after a trunk move on the recheck stream. Each build module claims the node seat of its language
|
||||||
|
// (`node-build-go`, `node-build-node`, `node-build-image`), whose accepted kinds the broker derives as the work queue
|
||||||
|
// `SEAT_NODE_BUILD_<LANGUAGE>` with one shared pull worker per kind; a holder pulls delivery first, then check, then
|
||||||
|
// recheck, at most its node's build capacity at once (ADR 0525 §4, §5).
|
||||||
|
//
|
||||||
|
// **An ask is one whole job on one node** (ADR 0525 §3): a build ask is the fetch, the build (or copy) of each artifact
|
||||||
|
// and the push; a check ask is the fetch, the digest and the tests of one level. Its end is written on the build module's
|
||||||
|
// step key `<node>.<ask id>` (StepsBucket), which the asker watches with AskStepWatch (ADR 0525 §6).
|
||||||
|
|
||||||
|
// The kinds of ask: the seat's accepted kinds, in the order a holder pulls them.
|
||||||
|
const (
|
||||||
|
AskDelivery = "delivery"
|
||||||
|
AskCheck = "check"
|
||||||
|
AskRecheck = "recheck"
|
||||||
|
)
|
||||||
|
|
||||||
|
// AskKinds are the accepted kinds of a build seat, in the order a holder pulls them (ADR 0536 §4).
|
||||||
|
var AskKinds = []string{AskDelivery, AskCheck, AskRecheck}
|
||||||
|
|
||||||
|
// The languages of the build seats: each is one build module's (mesh-build-<language>) and one seat's
|
||||||
|
// (node-build-<language>).
|
||||||
|
const (
|
||||||
|
AskGo = "go"
|
||||||
|
AskNode = "node"
|
||||||
|
AskImage = "image"
|
||||||
|
)
|
||||||
|
|
||||||
|
// AskLanguages are the build seats' languages.
|
||||||
|
var AskLanguages = []string{AskGo, AskNode, AskImage}
|
||||||
|
|
||||||
|
// AskRuns is how many times an ask is run before it is taken for poison (issue 1907): an ask whose run never ends (it
|
||||||
|
// takes its node down, or its process dies with it) is delivered again by its stream to the next free node (ADR 0525
|
||||||
|
// §6); the holder that takes it past AskRuns runs it no more, writes its step failed saying so, and ends it, so the
|
||||||
|
// asker's key fails with why and no further node is taken down. NATS-native: the count is the stream's own delivery
|
||||||
|
// count of the message, no timer.
|
||||||
|
const AskRuns = 3
|
||||||
|
|
||||||
|
// AskMaxDeliver is the build seats' workers' bound of deliveries (the broker's MaxDeliver): past AskRuns, so the holder
|
||||||
|
// that says the poison gets its delivery, with one more for a holder that dies saying it.
|
||||||
|
const AskMaxDeliver = AskRuns + 2
|
||||||
|
|
||||||
|
// StepAskVersion is the version of an Ask value; a reader refuses another (ErrUnknownVersion).
|
||||||
|
const StepAskVersion = 1
|
||||||
|
|
||||||
|
func checkAskKind(kind string) error {
|
||||||
|
for _, k := range AskKinds {
|
||||||
|
if kind == k {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return fmt.Errorf("delivery: the ask kind %q is not delivery, check or recheck", kind)
|
||||||
|
}
|
||||||
|
|
||||||
|
func checkAskLanguage(language string) error {
|
||||||
|
for _, l := range AskLanguages {
|
||||||
|
if language == l {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return fmt.Errorf("delivery: the ask language %q is not go, node or image", language)
|
||||||
|
}
|
||||||
|
|
||||||
|
// BuildSeat is the node seat a build module of language claims: node-build-<language>.
|
||||||
|
func BuildSeat(language string) (string, error) {
|
||||||
|
if err := checkAskLanguage(language); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return "node-build-" + language, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// BuildModuleOf is the build module that holds language's seat: mesh-build-<language>.
|
||||||
|
func BuildModuleOf(language string) (string, error) {
|
||||||
|
if err := checkAskLanguage(language); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return "mesh-build-" + language, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// AskSubject is the subject an ask of kind for language is published on: the seat's accept subject,
|
||||||
|
// `mesh.seat.node-build-<language>.accept.<kind>` (mesh-controller internal/broker SeatStreams).
|
||||||
|
func AskSubject(language, kind string) (string, error) {
|
||||||
|
seat, err := BuildSeat(language)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if err := checkAskKind(kind); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return "mesh.seat." + seat + ".accept." + kind, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseAskSubject is the inverse of AskSubject; it refuses a subject of another seat or kind.
|
||||||
|
func ParseAskSubject(subject string) (language, kind string, err error) {
|
||||||
|
rest, ok := strings.CutPrefix(subject, "mesh.seat.node-build-")
|
||||||
|
if !ok {
|
||||||
|
return "", "", fmt.Errorf("delivery: %q is not a build seat's accept subject", subject)
|
||||||
|
}
|
||||||
|
language, kind, ok = strings.Cut(rest, ".accept.")
|
||||||
|
if !ok {
|
||||||
|
return "", "", fmt.Errorf("delivery: %q is not a build seat's accept subject", subject)
|
||||||
|
}
|
||||||
|
if want, err := AskSubject(language, kind); err != nil || want != subject {
|
||||||
|
return "", "", fmt.Errorf("delivery: %q is not a build seat's accept subject: %v", subject, err)
|
||||||
|
}
|
||||||
|
return language, kind, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// AskStream is the work-queue stream of language's seat, as the broker names a seat's stream: SEAT_NODE_BUILD_<LANGUAGE>.
|
||||||
|
func AskStream(language string) (string, error) {
|
||||||
|
seat, err := BuildSeat(language)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return "SEAT_" + strings.ToUpper(strings.ReplaceAll(seat, "-", "_")), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// AskWorker is the shared pull consumer of one kind on language's stream, filtered on that kind's subject:
|
||||||
|
// SEAT_NODE_BUILD_<LANGUAGE>_<KIND>_worker. Every holder of the seat pulls from it, so the work is shared without a
|
||||||
|
// holder knowing the others (ADR 0190), and the kinds' workers are apart so a holder can pull them in their order.
|
||||||
|
func AskWorker(language, kind string) (string, error) {
|
||||||
|
stream, err := AskStream(language)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if err := checkAskKind(kind); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return stream + "_" + strings.ToUpper(kind) + "_worker", nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// An ask id is a step id of the form buildstep.NewID gives: the time in milliseconds in base 36 (8 or 9 digits) and six
|
||||||
|
// random hex digits. Its form keeps it apart from a module's or a node's name in a key.
|
||||||
|
var askIDOK = regexp.MustCompile(`^[0-9a-z]{8,9}[0-9a-f]{6}$`)
|
||||||
|
|
||||||
|
func checkAskID(id string) error {
|
||||||
|
if !askIDOK.MatchString(id) {
|
||||||
|
return fmt.Errorf("delivery: %q is not an ask id (base-36 milliseconds and six hex digits)", id)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// StepAsk is the message on a build seat's stream: who asked what, of which kind and language, and the one whole job.
|
||||||
|
// Exactly one of Build, Check and Compose is set: a delivery ask is a build; a check ask a build (a candidate's
|
||||||
|
// fingerprint), a check or, on the Go seat, a compose; a recheck ask a check; an image ask is always a build.
|
||||||
|
type StepAsk struct {
|
||||||
|
V int `json:"v"`
|
||||||
|
ID string `json:"id"`
|
||||||
|
Kind string `json:"kind"`
|
||||||
|
Language string `json:"language"`
|
||||||
|
// Asker is the module that put the ask (mesh-delivery-builder or mesh-delivery-checker); the stream's grant is what
|
||||||
|
// makes it true, this field only names it to a reader.
|
||||||
|
Asker string `json:"asker"`
|
||||||
|
At time.Time `json:"at"`
|
||||||
|
Build *BuildJob `json:"build,omitempty"`
|
||||||
|
Check *CheckJob `json:"check,omitempty"`
|
||||||
|
Compose *ComposeJob `json:"compose,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ComposeJob is a compose ask's job (novox/hq ADR 0482 clause 4, issue 1622): fetch the commit, build the composer
|
||||||
|
// command (Package) in the Go module at Dir of the fetched tree, once per ComposerKey, run it in a run step shut off
|
||||||
|
// with Request on its standard input, and answer its standard output whole (ComposeAnswer). The assigner asks it, to
|
||||||
|
// compose a group with its mesh-sdk member's head, and to read the group's manifests with the mesh-sdk the running
|
||||||
|
// controller and node-engine pin (ADR 0482 clause 5, issue 1623).
|
||||||
|
type ComposeJob struct {
|
||||||
|
// Fetch is the fetch tool's arguments: the repository and the full commit whose mesh-sdk composes (mesh-sdk itself
|
||||||
|
// at a head, or a module that requires mesh-sdk, at the version it pins).
|
||||||
|
Fetch map[string]any `json:"fetch"`
|
||||||
|
// Dir is the directory of the Go module the composer is built in, relative to the repository's root ("go" for
|
||||||
|
// mesh-sdk, RootPath for a module at the root); Package is the composer's import path (mesh-sdk composer.Package).
|
||||||
|
Dir string `json:"dir"`
|
||||||
|
Package string `json:"package"`
|
||||||
|
// Request is the composer's request (mesh-sdk composer.Request), its manifests named by their digests in the
|
||||||
|
// indexer's ManifestsBucket: the build module fills them before the run (composer.Fill).
|
||||||
|
Request json.RawMessage `json:"request"`
|
||||||
|
// Reader names, for a reader of the ask, whose composition this is: the mesh-sdk head of a group, or a module whose
|
||||||
|
// mesh-sdk reads the group's manifests (mesh-controller, mesh-host).
|
||||||
|
Reader string `json:"reader,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ComposeAnswer is a compose ask's step result: whether this run built the composer or took the one kept under its
|
||||||
|
// key, the key, and the composer's verdict (mesh-sdk composer.Verdict) whole.
|
||||||
|
type ComposeAnswer struct {
|
||||||
|
Built bool `json:"built"`
|
||||||
|
Key string `json:"key"`
|
||||||
|
Verdict json.RawMessage `json:"verdict"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ComposerKey is the key a build module keeps a built composer under: the repository, commit, directory and package it
|
||||||
|
// was built from and the toolchain it was built with, hashed (`composer-` and 16 hex digits), so each head is built once
|
||||||
|
// on a node (ADR 0482 clause 4).
|
||||||
|
func ComposerKey(repository, commit, dir, pkg string, toolchain ToolchainUsed) string {
|
||||||
|
sum := sha256.Sum256([]byte(strings.Join([]string{repository, commit, dir, pkg, toolchain.Version, toolchain.Recipe}, "\n")))
|
||||||
|
return "composer-" + hex.EncodeToString(sum[:8])
|
||||||
|
}
|
||||||
|
|
||||||
|
// BuildJob is a build ask's job: fetch the commit (unless every artifact is a copy), then build or copy each artifact,
|
||||||
|
// pushing it when Publish says so, and answer each artifact's digest and reference (BuildAnswer).
|
||||||
|
type BuildJob struct {
|
||||||
|
// Module is the module's name; Path its directory in the repository (the build tool's `module`, "." for its root).
|
||||||
|
Module string `json:"module"`
|
||||||
|
Path string `json:"path,omitempty"`
|
||||||
|
// FP is the fingerprint the build is of (the builder's key), named for a reader of the ask.
|
||||||
|
FP string `json:"fp,omitempty"`
|
||||||
|
// Fetch is the fetch tool's arguments, as the build module's fetch tool takes them (buildstep.FetchRequest's Args);
|
||||||
|
// absent when every artifact is a copy.
|
||||||
|
Fetch map[string]any `json:"fetch,omitempty"`
|
||||||
|
// Artifacts are built in this order.
|
||||||
|
Artifacts []AskArtifact `json:"artifacts"`
|
||||||
|
// Publish says the build pushes an image or publishes a package: a trunk build only (ADR 0487 clause 12).
|
||||||
|
Publish bool `json:"publish,omitempty"`
|
||||||
|
// Toolchain is the toolchain the fingerprint was computed with; a build module running another refuses the ask.
|
||||||
|
Toolchain *ToolchainUsed `json:"toolchain,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// AskArtifact is one artifact of a build ask: built from the fetched tree, or copied from From, an upstream pin (ADR
|
||||||
|
// 0498 clause 4).
|
||||||
|
type AskArtifact struct {
|
||||||
|
Artifact string `json:"artifact"`
|
||||||
|
From string `json:"from,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CheckJob is a check ask's job, the levels of one check (ADR 0525 §3): fetch the head merged onto its trunk once, then
|
||||||
|
// for each level in order digest its packages, take the kept verdicts for the digests that have one, and test the rest,
|
||||||
|
// the packages the change's own tests are in first, stopping at the first level that does not pass (CheckAnswer).
|
||||||
|
type CheckJob struct {
|
||||||
|
// Fetch is the fetch tool's arguments (repository, commit, ref, base, and the build module's own: beside, package).
|
||||||
|
Fetch map[string]any `json:"fetch"`
|
||||||
|
// Levels are run in this order (LevelUnit, LevelIntegration); a try may name one.
|
||||||
|
Levels []string `json:"levels"`
|
||||||
|
// Kept says the build module takes the kept verdicts of the checker's kept bucket (CheckerKeptBucket, by KeptKey)
|
||||||
|
// for the packages whose digest has one and covers the siblings the fetch placed, and tests only the others (issue
|
||||||
|
// 1887's design limit 1). A try that runs some tests (Run), and a level the candidate's own build module judges
|
||||||
|
// (Runner), keep nothing.
|
||||||
|
Kept bool `json:"kept,omitempty"`
|
||||||
|
// Runner is the test step's runner ("workspace": the candidate's own build module judges it, ADR 0535 §4), used
|
||||||
|
// when the merge changes a path under RunnerWhen (every merge when RunnerWhen is empty).
|
||||||
|
Runner string `json:"runner,omitempty"`
|
||||||
|
RunnerWhen string `json:"runner_when,omitempty"`
|
||||||
|
// Run is a try's test pattern (go test -run): each level runs it alone, digesting nothing.
|
||||||
|
Run string `json:"run,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a StepAsk) check() error {
|
||||||
|
if err := checkAskID(a.ID); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := checkAskKind(a.Kind); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := checkAskLanguage(a.Language); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := checkName("asker", a.Asker); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if a.At.IsZero() {
|
||||||
|
return fmt.Errorf("delivery: the ask %s names no time", a.ID)
|
||||||
|
}
|
||||||
|
jobs := 0
|
||||||
|
for _, set := range []bool{a.Build != nil, a.Check != nil, a.Compose != nil} {
|
||||||
|
if set {
|
||||||
|
jobs++
|
||||||
|
}
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case jobs != 1:
|
||||||
|
return fmt.Errorf("delivery: the ask %s holds a build, a check or a compose, exactly one", a.ID)
|
||||||
|
case a.Compose != nil && (a.Kind != AskCheck || a.Language != AskGo):
|
||||||
|
return fmt.Errorf("delivery: the ask %s is a compose, which the Go seat's check stream alone carries", a.ID)
|
||||||
|
case a.Build != nil && a.Kind == AskRecheck:
|
||||||
|
return fmt.Errorf("delivery: the ask %s is a build on the recheck stream, which carries checks alone", a.ID)
|
||||||
|
case a.Check != nil && a.Kind == AskDelivery:
|
||||||
|
return fmt.Errorf("delivery: the ask %s is a check on the delivery stream, which carries trunk builds alone", a.ID)
|
||||||
|
case a.Check != nil && a.Language == AskImage:
|
||||||
|
return fmt.Errorf("delivery: the ask %s is a check of an image, which has no tests", a.ID)
|
||||||
|
}
|
||||||
|
if a.Build != nil {
|
||||||
|
return a.Build.check(a.ID)
|
||||||
|
}
|
||||||
|
if a.Compose != nil {
|
||||||
|
return a.Compose.check(a.ID)
|
||||||
|
}
|
||||||
|
return a.Check.check(a.ID)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c ComposeJob) check(id string) error {
|
||||||
|
if err := checkFetchArgs(id, c.Fetch); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if c.Dir == "" || c.Dir != path.Clean(c.Dir) || strings.HasPrefix(c.Dir, "/") || c.Dir == ".." || strings.HasPrefix(c.Dir, "../") {
|
||||||
|
return fmt.Errorf("delivery: the compose ask %s names no clean directory inside the repository (%q)", id, c.Dir)
|
||||||
|
}
|
||||||
|
if c.Package == "" {
|
||||||
|
return fmt.Errorf("delivery: the compose ask %s names no package to build", id)
|
||||||
|
}
|
||||||
|
if !json.Valid(c.Request) || len(c.Request) == 0 || c.Request[0] != '{' {
|
||||||
|
return fmt.Errorf("delivery: the compose ask %s holds no request object", id)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b BuildJob) check(id string) error {
|
||||||
|
if err := checkName("module", b.Module); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if len(b.Artifacts) == 0 {
|
||||||
|
return fmt.Errorf("delivery: the build ask %s names no artifact", id)
|
||||||
|
}
|
||||||
|
fetch := false
|
||||||
|
for _, a := range b.Artifacts {
|
||||||
|
if err := checkName("artifact", a.Artifact); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
fetch = fetch || a.From == ""
|
||||||
|
}
|
||||||
|
if fetch {
|
||||||
|
if b.Path == "" {
|
||||||
|
return fmt.Errorf("delivery: the build ask %s names no directory (path) for the module %s", id, b.Module)
|
||||||
|
}
|
||||||
|
if err := checkFetchArgs(id, b.Fetch); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c CheckJob) check(id string) error {
|
||||||
|
if len(c.Levels) == 0 {
|
||||||
|
return fmt.Errorf("delivery: the check ask %s names no level", id)
|
||||||
|
}
|
||||||
|
for _, l := range c.Levels {
|
||||||
|
if err := checkLevel(l); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return checkFetchArgs(id, c.Fetch)
|
||||||
|
}
|
||||||
|
|
||||||
|
var askCommitOK = regexp.MustCompile(`^[0-9a-f]{40}$`)
|
||||||
|
|
||||||
|
// checkFetchArgs refuses fetch arguments with no repository or no full commit; the rest is the build module's fetch to
|
||||||
|
// judge, as a direct call's is.
|
||||||
|
func checkFetchArgs(id string, args map[string]any) error {
|
||||||
|
repository, _ := args["repository"].(string)
|
||||||
|
commit, _ := args["commit"].(string)
|
||||||
|
if repository == "" || !strings.Contains(repository, "/") {
|
||||||
|
return fmt.Errorf("delivery: the ask %s fetches no repository <owner>/<name>", id)
|
||||||
|
}
|
||||||
|
if !askCommitOK.MatchString(commit) {
|
||||||
|
return fmt.Errorf("delivery: the ask %s fetches no full commit", id)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncodeStepAsk is a as JSON at StepAskVersion; it refuses what DecodeStepAsk refuses.
|
||||||
|
func EncodeStepAsk(a StepAsk) ([]byte, error) {
|
||||||
|
a.V = StepAskVersion
|
||||||
|
a.At = a.At.UTC()
|
||||||
|
if err := a.check(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return json.Marshal(a)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecodeStepAsk reads an ask; it refuses an unknown version (ErrUnknownVersion), an unknown kind or language, an id that
|
||||||
|
// is not an ask id, a build and a check together or neither, a job on a stream that does not carry it, and a fetch with
|
||||||
|
// no repository or no full commit.
|
||||||
|
func DecodeStepAsk(data []byte) (StepAsk, error) {
|
||||||
|
var probe struct {
|
||||||
|
V *int `json:"v"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(data, &probe); err != nil {
|
||||||
|
return StepAsk{}, fmt.Errorf("delivery: an ask is not JSON: %w", err)
|
||||||
|
}
|
||||||
|
if probe.V == nil || *probe.V != StepAskVersion {
|
||||||
|
return StepAsk{}, fmt.Errorf("%w: an ask of version %v, this reader reads %d", ErrUnknownVersion, probe.V, StepAskVersion)
|
||||||
|
}
|
||||||
|
var a StepAsk
|
||||||
|
if err := json.Unmarshal(data, &a); err != nil {
|
||||||
|
return StepAsk{}, fmt.Errorf("delivery: an ask does not fit its shape: %w", err)
|
||||||
|
}
|
||||||
|
if err := a.check(); err != nil {
|
||||||
|
return StepAsk{}, err
|
||||||
|
}
|
||||||
|
return a, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// BuildAnswer is a build ask's step result: each artifact's digest and, for a pushed one, its reference.
|
||||||
|
type BuildAnswer struct {
|
||||||
|
Artifacts []AskBuilt `json:"artifacts"`
|
||||||
|
Toolchain *ToolchainUsed `json:"toolchain,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// AskBuilt is one artifact a build ask built.
|
||||||
|
type AskBuilt struct {
|
||||||
|
Artifact string `json:"artifact"`
|
||||||
|
Digest string `json:"digest"`
|
||||||
|
Reference string `json:"reference,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// CheckAnswer is a check ask's step result, each part the build module's own tool's answer whole: the fetch's, then one
|
||||||
|
// LevelAnswer per level run, in order; a level that did not pass is the last. The checker judges and keeps from it as it
|
||||||
|
// did from the tools' answers.
|
||||||
|
type CheckAnswer struct {
|
||||||
|
Fetch json.RawMessage `json:"fetch"`
|
||||||
|
Levels []LevelAnswer `json:"levels,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// LevelAnswer is one level of a check ask: the digest's answer (absent when nothing was digested: the level ran whole and
|
||||||
|
// keeps nothing), the kept verdicts taken, and one test result per test step run, in the order run.
|
||||||
|
type LevelAnswer struct {
|
||||||
|
Level string `json:"level"`
|
||||||
|
// Judged is what the digest under the candidate's runner said of the program that ran it ("candidate <merge>"),
|
||||||
|
// when the candidate judged the level (ADR 0535 §4, §5); empty otherwise.
|
||||||
|
Judged string `json:"judged,omitempty"`
|
||||||
|
Digest *LevelDigest `json:"digest,omitempty"`
|
||||||
|
Kept []KeptTaken `json:"kept,omitempty"`
|
||||||
|
Tests []json.RawMessage `json:"tests,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// LevelDigest is the digest's answer as a level keeps it in the ask's step result: its packages a list of
|
||||||
|
// {package, digest} sorted by package, never a map keyed by the package's path (issue 1930). The step result is a
|
||||||
|
// state value, and the node runtime refuses a value with a field name ending in a credential word (novox/hq ADR 0201):
|
||||||
|
// a Go package such as .../internal/token is such a name as a map key, and is a plain value in the list. It decodes
|
||||||
|
// the digest tool's own answer, and a value stored before issue 1930, with packages as a map too.
|
||||||
|
type LevelDigest struct {
|
||||||
|
Level string `json:"level,omitempty"`
|
||||||
|
Packages []PackageDigest `json:"packages"`
|
||||||
|
Beside []string `json:"beside,omitempty"`
|
||||||
|
WithoutTests []string `json:"without_tests,omitempty"`
|
||||||
|
JudgedBy string `json:"judged_by,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// PackageDigest is one package's digest at a level.
|
||||||
|
type PackageDigest struct {
|
||||||
|
Package string `json:"package"`
|
||||||
|
Digest string `json:"digest"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnmarshalJSON reads packages as the list or as the map keyed by package path (the digest tool's answer, and a level
|
||||||
|
// answer stored before issue 1930), and sorts them by package.
|
||||||
|
func (d *LevelDigest) UnmarshalJSON(raw []byte) error {
|
||||||
|
var v struct {
|
||||||
|
Level string `json:"level"`
|
||||||
|
Packages json.RawMessage `json:"packages"`
|
||||||
|
Beside []string `json:"beside"`
|
||||||
|
WithoutTests []string `json:"without_tests"`
|
||||||
|
JudgedBy string `json:"judged_by"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(raw, &v); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
var pkgs []PackageDigest
|
||||||
|
if p := strings.TrimSpace(string(v.Packages)); p != "" && p != "null" {
|
||||||
|
if strings.HasPrefix(p, "{") {
|
||||||
|
var m map[string]string
|
||||||
|
if err := json.Unmarshal(v.Packages, &m); err != nil {
|
||||||
|
return fmt.Errorf("a digest's packages: %w", err)
|
||||||
|
}
|
||||||
|
for pkg, digest := range m {
|
||||||
|
pkgs = append(pkgs, PackageDigest{Package: pkg, Digest: digest})
|
||||||
|
}
|
||||||
|
} else if err := json.Unmarshal(v.Packages, &pkgs); err != nil {
|
||||||
|
return fmt.Errorf("a digest's packages: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Slice(pkgs, func(i, j int) bool { return pkgs[i].Package < pkgs[j].Package })
|
||||||
|
*d = LevelDigest{Level: v.Level, Packages: pkgs, Beside: v.Beside, WithoutTests: v.WithoutTests, JudgedBy: v.JudgedBy}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Map is the digests by package, for a lookup; nil when it names none.
|
||||||
|
func (d *LevelDigest) Map() map[string]string {
|
||||||
|
if d == nil || len(d.Packages) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
m := make(map[string]string, len(d.Packages))
|
||||||
|
for _, p := range d.Packages {
|
||||||
|
m[p.Package] = p.Digest
|
||||||
|
}
|
||||||
|
return m
|
||||||
|
}
|
||||||
|
|
||||||
|
// KeptTaken is a package whose kept verdict the check took instead of testing it.
|
||||||
|
type KeptTaken struct {
|
||||||
|
Package string `json:"package"`
|
||||||
|
Digest string `json:"digest"`
|
||||||
|
Tests int `json:"tests"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// AskStepKey is the key, in the build module's StepsBucket, of the step that runs an ask on node: `<node>.<ask id>`
|
||||||
|
// (ADR 0525 §6). The node is the one that pulled the ask, which the asker learns from the key.
|
||||||
|
func AskStepKey(node, askID string) (string, error) {
|
||||||
|
if err := checkAskID(askID); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return StepKey(node, askID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AskStepWatch is the pattern an asker watches its ask's step with, the node a wildcard: `*.<ask id>`.
|
||||||
|
func AskStepWatch(askID string) (string, error) {
|
||||||
|
if err := checkAskID(askID); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return "*." + askID, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseAskStepKey reads the node and the ask id from a step key of an ask; it refuses a key that is not `<node>.<ask
|
||||||
|
// id>`, such as a have key `<node>.<module>` or a step key a direct tool call wrote under another id form.
|
||||||
|
func ParseAskStepKey(key string) (node, askID string, err error) {
|
||||||
|
node, askID, err = ParseStepKey(key)
|
||||||
|
if err != nil {
|
||||||
|
return "", "", err
|
||||||
|
}
|
||||||
|
if err := checkAskID(askID); err != nil {
|
||||||
|
return "", "", fmt.Errorf("delivery: %q is not an ask's step key: %w", key, err)
|
||||||
|
}
|
||||||
|
return node, askID, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// PausesState is the state a build module keeps its nodes' pause keys in. It has no age, unlike StepsState, whose keys
|
||||||
|
// are per step and dropped after their age: a pause kept among the steps would end by itself.
|
||||||
|
const PausesState = "pauses"
|
||||||
|
|
||||||
|
// PauseKey is the key, in a build module's PausesState, that keeps whether the module on node takes asks:
|
||||||
|
// `paused.<node>` (issue 1887's design limit 2: every holder pulls from one shared worker, so a node's pause is its holder
|
||||||
|
// not fetching, kept so a restart keeps it). A pause key is never an ask's step key: its second part is a node.
|
||||||
|
func PauseKey(node string) (string, error) {
|
||||||
|
if err := checkName("node", node); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return "paused." + node, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Pause is the value of a pause key: whether the node's module takes no asks, who said so and when.
|
||||||
|
type Pause struct {
|
||||||
|
V int `json:"v"`
|
||||||
|
Paused bool `json:"paused"`
|
||||||
|
By string `json:"by,omitempty"`
|
||||||
|
At time.Time `json:"at"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncodePause is p as JSON at Version.
|
||||||
|
func EncodePause(p Pause) ([]byte, error) {
|
||||||
|
p.V = Version
|
||||||
|
p.At = p.At.UTC()
|
||||||
|
return json.Marshal(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecodePause reads a pause value; it refuses an unknown version (ErrUnknownVersion).
|
||||||
|
func DecodePause(data []byte) (Pause, error) {
|
||||||
|
var p Pause
|
||||||
|
if err := decode(data, &p); err != nil {
|
||||||
|
return Pause{}, err
|
||||||
|
}
|
||||||
|
return p, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,76 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func composeAsk() StepAsk {
|
||||||
|
return StepAsk{ID: "mh3k2x9qa1b2c5", Kind: AskCheck, Language: AskGo, Asker: "mesh-delivery-assigner",
|
||||||
|
At: time.Date(2026, 10, 24, 3, 0, 0, 0, time.UTC),
|
||||||
|
Compose: &ComposeJob{Fetch: map[string]any{"repository": "novox/mesh-sdk", "commit": askCommit},
|
||||||
|
Dir: "go", Package: "git.novox.be/novox/mesh-sdk/go/cmd/mesh-compose",
|
||||||
|
Request: json.RawMessage(`{"v":1,"cases":[{"name":"change","manifests":{"demo":{"digest":"d1"}}}]}`), Reader: "mesh-sdk head"}}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1622: a compose ask encodes and decodes with every field.
|
||||||
|
func TestAComposeAskRoundTrips(t *testing.T) {
|
||||||
|
a := composeAsk()
|
||||||
|
raw, err := EncodeStepAsk(a)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
got, err := DecodeStepAsk(raw)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
a.V = StepAskVersion
|
||||||
|
if !reflect.DeepEqual(got, a) {
|
||||||
|
t.Fatalf("round trip:\n got %+v\nwant %+v", got, a)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1622: a compose ask goes only on the Go seat's check stream, holds no other job beside it, fetches a full commit,
|
||||||
|
// builds a package in a clean directory of the repository and carries a request object.
|
||||||
|
func TestAComposeAskIsRefusedWhereItDoesNotBelong(t *testing.T) {
|
||||||
|
for name, change := range map[string]func(*StepAsk){
|
||||||
|
"on the delivery stream": func(a *StepAsk) { a.Kind = AskDelivery },
|
||||||
|
"on the recheck stream": func(a *StepAsk) { a.Kind = AskRecheck },
|
||||||
|
"on the Node seat": func(a *StepAsk) { a.Language = AskNode },
|
||||||
|
"beside a check": func(a *StepAsk) { a.Check = checkAsk().Check },
|
||||||
|
"with a short commit": func(a *StepAsk) { a.Compose.Fetch["commit"] = "0123456" },
|
||||||
|
"in no directory": func(a *StepAsk) { a.Compose.Dir = "" },
|
||||||
|
"outside the repository": func(a *StepAsk) { a.Compose.Dir = "../x" },
|
||||||
|
"with no package": func(a *StepAsk) { a.Compose.Package = "" },
|
||||||
|
"with no request": func(a *StepAsk) { a.Compose.Request = nil },
|
||||||
|
"with a request not JSON": func(a *StepAsk) { a.Compose.Request = json.RawMessage(`[1]`) },
|
||||||
|
} {
|
||||||
|
a := composeAsk()
|
||||||
|
change(&a)
|
||||||
|
if _, err := EncodeStepAsk(a); err == nil {
|
||||||
|
t.Errorf("a compose ask %s is encoded", name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1622/AC3: a composer is kept under one key per repository, commit, directory, package and toolchain, so two asks of
|
||||||
|
// one head build it once on a node, and another head or toolchain builds its own.
|
||||||
|
func TestAComposerIsKeptByWhatItWasBuiltFrom(t *testing.T) {
|
||||||
|
tc := ToolchainUsed{Version: "go1.26.0", Recipe: "3"}
|
||||||
|
k := ComposerKey("novox/mesh-sdk", askCommit, "go", "p", tc)
|
||||||
|
if k != ComposerKey("novox/mesh-sdk", askCommit, "go", "p", tc) || !strings.HasPrefix(k, "composer-") || len(k) != len("composer-")+16 {
|
||||||
|
t.Fatalf("key = %q", k)
|
||||||
|
}
|
||||||
|
for _, other := range []string{
|
||||||
|
ComposerKey("novox/mesh-sdk", strings.Repeat("1", 40), "go", "p", tc),
|
||||||
|
ComposerKey("novox/mesh-controller", askCommit, ".", "p", tc),
|
||||||
|
ComposerKey("novox/mesh-sdk", askCommit, "go", "p", ToolchainUsed{Version: "go1.26.1", Recipe: "3"}),
|
||||||
|
} {
|
||||||
|
if other == k {
|
||||||
|
t.Errorf("two composers built from different inputs share the key %s", k)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
package delivery_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/buildstep"
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/delivery"
|
||||||
|
)
|
||||||
|
|
||||||
|
// 1887/A1b: the ask's step key is <node>.<ask id>, watched with *.<ask id>, and its parser refuses another bucket's key.
|
||||||
|
func TestAskStepKey(t *testing.T) {
|
||||||
|
id := buildstep.NewID() // an ask's id is a step id
|
||||||
|
key, err := delivery.AskStepKey("shanks", id)
|
||||||
|
if err != nil || key != "shanks."+id {
|
||||||
|
t.Fatalf("AskStepKey = %q, %v", key, err)
|
||||||
|
}
|
||||||
|
if w, err := delivery.AskStepWatch(id); err != nil || w != "*."+id {
|
||||||
|
t.Fatalf("AskStepWatch = %q, %v", w, err)
|
||||||
|
}
|
||||||
|
node, got, err := delivery.ParseAskStepKey(key)
|
||||||
|
if err != nil || node != "shanks" || got != id {
|
||||||
|
t.Fatalf("ParseAskStepKey = %q %q %v", node, got, err)
|
||||||
|
}
|
||||||
|
for _, other := range []string{
|
||||||
|
"shanks.mesh-delivery-view", // a have key
|
||||||
|
"shanks.node", // a node's own have key
|
||||||
|
"shanks.postgres", // a have key whose module is one token
|
||||||
|
"mesh-delivery-builder_builds.x", // a pulse key
|
||||||
|
"shanks",
|
||||||
|
} {
|
||||||
|
if _, _, err := delivery.ParseAskStepKey(other); err == nil {
|
||||||
|
t.Errorf("parsed %q", other)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := delivery.AskStepKey("shanks", "postgres"); err == nil {
|
||||||
|
t.Error("AskStepKey took a module's name for an ask id")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,180 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
const askCommit = "0123456789abcdef0123456789abcdef01234567"
|
||||||
|
|
||||||
|
func buildAsk() StepAsk {
|
||||||
|
return StepAsk{ID: "mh3k2x9qa1b2c3", Kind: AskDelivery, Language: AskGo, Asker: "mesh-delivery-builder",
|
||||||
|
At: time.Date(2026, 10, 23, 13, 0, 0, 0, time.UTC),
|
||||||
|
Build: &BuildJob{Module: "mesh-delivery-view", Path: "modules/mesh-delivery-view", FP: "ab12",
|
||||||
|
Fetch: map[string]any{"repository": "novox/mesh-delivery", "commit": askCommit, "dir": "modules/mesh-delivery-view", "paths": []any{"cmd"}},
|
||||||
|
Artifacts: []AskArtifact{{Artifact: "bundle"}, {Artifact: "base", From: "registry/x@sha256:00"}},
|
||||||
|
Publish: true, Toolchain: &ToolchainUsed{Version: "go1.26.0", Recipe: "3"}}}
|
||||||
|
}
|
||||||
|
|
||||||
|
func checkAsk() StepAsk {
|
||||||
|
return StepAsk{ID: "mh3k2x9qa1b2c4", Kind: AskCheck, Language: AskNode, Asker: "mesh-delivery-checker",
|
||||||
|
At: time.Date(2026, 10, 23, 13, 0, 0, 0, time.UTC),
|
||||||
|
Check: &CheckJob{Fetch: map[string]any{"repository": "novox/mesh-catalog", "commit": askCommit, "ref": "refs/pull/3/head", "base": askCommit},
|
||||||
|
Levels: []string{LevelUnit, LevelIntegration}, Kept: true, Runner: "workspace", RunnerWhen: "modules/mesh-build-go/", Run: ""}}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1887/A1a: an ask encodes and decodes with every field.
|
||||||
|
func TestAskRoundTrips(t *testing.T) {
|
||||||
|
for _, a := range []StepAsk{buildAsk(), checkAsk()} {
|
||||||
|
raw, err := EncodeStepAsk(a)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
got, err := DecodeStepAsk(raw)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
a.V = StepAskVersion
|
||||||
|
if !reflect.DeepEqual(got, a) {
|
||||||
|
t.Fatalf("round trip:\n got %+v\nwant %+v", got, a)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1887/A1a: an ask with an unknown kind or language is refused.
|
||||||
|
func TestAskRefusesUnknownKindAndLanguage(t *testing.T) {
|
||||||
|
cases := map[string]func(*StepAsk){
|
||||||
|
"kind": func(a *StepAsk) { a.Kind = "build" },
|
||||||
|
"language": func(a *StepAsk) { a.Language = "typescript" },
|
||||||
|
"id": func(a *StepAsk) { a.ID = "postgres" },
|
||||||
|
"neither": func(a *StepAsk) { a.Build = nil },
|
||||||
|
"both": func(a *StepAsk) { a.Check = &CheckJob{Levels: []string{LevelUnit}, Fetch: a.Build.Fetch} },
|
||||||
|
"recheck": func(a *StepAsk) { a.Kind = AskRecheck },
|
||||||
|
"commit": func(a *StepAsk) { a.Build.Fetch = map[string]any{"repository": "novox/x", "commit": "main"} },
|
||||||
|
"path": func(a *StepAsk) { a.Build.Path = "" },
|
||||||
|
}
|
||||||
|
for name, change := range cases {
|
||||||
|
a := buildAsk()
|
||||||
|
change(&a)
|
||||||
|
if _, err := EncodeStepAsk(a); err == nil {
|
||||||
|
t.Errorf("%s: encoded", name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// A copy alone fetches nothing and needs no path.
|
||||||
|
a := buildAsk()
|
||||||
|
a.Build.Fetch, a.Build.Path, a.Build.Artifacts = nil, "", []AskArtifact{{Artifact: "base", From: "registry/x@sha256:00"}}
|
||||||
|
if _, err := EncodeStepAsk(a); err != nil {
|
||||||
|
t.Errorf("a copy alone: %v", err)
|
||||||
|
}
|
||||||
|
c := checkAsk()
|
||||||
|
c.Kind = AskDelivery
|
||||||
|
if _, err := EncodeStepAsk(c); err == nil {
|
||||||
|
t.Error("a check on the delivery stream encoded")
|
||||||
|
}
|
||||||
|
c = checkAsk()
|
||||||
|
c.Language = AskImage
|
||||||
|
if _, err := EncodeStepAsk(c); err == nil {
|
||||||
|
t.Error("a check of an image encoded")
|
||||||
|
}
|
||||||
|
raw, _ := EncodeStepAsk(buildAsk())
|
||||||
|
for _, bad := range []string{
|
||||||
|
strings.Replace(string(raw), `"kind":"delivery"`, `"kind":"queue"`, 1),
|
||||||
|
strings.Replace(string(raw), `"language":"go"`, `"language":"rust"`, 1),
|
||||||
|
} {
|
||||||
|
if _, err := DecodeStepAsk([]byte(bad)); err == nil {
|
||||||
|
t.Errorf("decoded %s", bad)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := DecodeStepAsk([]byte(strings.Replace(string(raw), `"v":1`, `"v":2`, 1))); !errors.Is(err, ErrUnknownVersion) {
|
||||||
|
t.Errorf("version 2: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1887/A1a: the subjects, stream and workers are the seat's, as the broker derives them.
|
||||||
|
func TestAskSubjects(t *testing.T) {
|
||||||
|
s, err := AskSubject(AskGo, AskCheck)
|
||||||
|
if err != nil || s != "mesh.seat.node-build-go.accept.check" {
|
||||||
|
t.Fatalf("AskSubject = %q, %v", s, err)
|
||||||
|
}
|
||||||
|
language, kind, err := ParseAskSubject("mesh.seat.node-build-image.accept.delivery")
|
||||||
|
if err != nil || language != AskImage || kind != AskDelivery {
|
||||||
|
t.Fatalf("ParseAskSubject = %q %q %v", language, kind, err)
|
||||||
|
}
|
||||||
|
for _, bad := range []string{"mesh.seat.node-build-agent.accept.build", "mesh.seat.node-build-go.accept.queue", "mesh.seat.node-build-go.event.x"} {
|
||||||
|
if _, _, err := ParseAskSubject(bad); err == nil {
|
||||||
|
t.Errorf("parsed %s", bad)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if st, _ := AskStream(AskNode); st != "SEAT_NODE_BUILD_NODE" {
|
||||||
|
t.Errorf("AskStream = %q", st)
|
||||||
|
}
|
||||||
|
if w, _ := AskWorker(AskGo, AskRecheck); w != "SEAT_NODE_BUILD_GO_RECHECK_worker" {
|
||||||
|
t.Errorf("AskWorker = %q", w)
|
||||||
|
}
|
||||||
|
if seat, _ := BuildSeat(AskImage); seat != "node-build-image" {
|
||||||
|
t.Errorf("BuildSeat = %q", seat)
|
||||||
|
}
|
||||||
|
if m, _ := BuildModuleOf(AskNode); m != "mesh-build-node" {
|
||||||
|
t.Errorf("BuildModuleOf = %q", m)
|
||||||
|
}
|
||||||
|
if _, err := BuildSeat("agent"); err == nil {
|
||||||
|
t.Error("BuildSeat(agent)")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1887/A4b: a building key names the asks put for it; a done key or a name that is no ask id is refused.
|
||||||
|
func TestABuildingKeyNamesItsAsks(t *testing.T) {
|
||||||
|
b := BuilderBuild{State: BuildBuilding, By: "novox.builder", Asks: map[string]string{AskGo: "mh3k2x9qa1b2c3"}}
|
||||||
|
raw, err := EncodeBuilderBuild(b)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
got, err := DecodeBuilderBuild(raw)
|
||||||
|
if err != nil || len(got.Asks) != 1 || got.Asks[AskGo] != "mh3k2x9qa1b2c3" {
|
||||||
|
t.Fatalf("decoded %+v, %v", got, err)
|
||||||
|
}
|
||||||
|
for _, bad := range []BuilderBuild{
|
||||||
|
{State: BuildBuilding, Asks: map[string]string{AskGo: "postgres"}},
|
||||||
|
{State: BuildBuilding, Asks: map[string]string{"typescript": "mh3k2x9qa1b2c3"}},
|
||||||
|
{State: BuildFailed, Error: "x", Asks: map[string]string{AskGo: "mh3k2x9qa1b2c3"}},
|
||||||
|
} {
|
||||||
|
if _, err := EncodeBuilderBuild(bad); err == nil {
|
||||||
|
t.Errorf("encoded %+v", bad)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1930/AC1: a level answer stored before issue 1930, its digest's packages a map keyed by package path, and the digest
|
||||||
|
// tool's own answer, read as the list sorted by package; the list form reads back the same and keys no field by a path.
|
||||||
|
func TestALevelDigestReadsTheMapAndTheList(t *testing.T) {
|
||||||
|
var old LevelAnswer
|
||||||
|
if err := json.Unmarshal([]byte(`{"level":"unit","digest":{"level":"unit","packages":{"x/pkg/a":"d-a","x/internal/token":"d-t"},"beside":["novox/y abc"],"judged_by":"installed"}}`), &old); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
want := []PackageDigest{{Package: "x/internal/token", Digest: "d-t"}, {Package: "x/pkg/a", Digest: "d-a"}}
|
||||||
|
if old.Digest == nil || !reflect.DeepEqual(old.Digest.Packages, want) || old.Digest.JudgedBy != "installed" || len(old.Digest.Beside) != 1 {
|
||||||
|
t.Fatalf("the old form read %+v", old.Digest)
|
||||||
|
}
|
||||||
|
raw, err := json.Marshal(old)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if strings.Contains(string(raw), `"x/internal/token":`) {
|
||||||
|
t.Errorf("the list form keys a field by a package path: %s", raw)
|
||||||
|
}
|
||||||
|
var back LevelAnswer
|
||||||
|
if err := json.Unmarshal(raw, &back); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(back.Digest, old.Digest) || back.Digest.Map()["x/internal/token"] != "d-t" {
|
||||||
|
t.Errorf("the list form read back %+v, want %+v", back.Digest, old.Digest)
|
||||||
|
}
|
||||||
|
var none LevelAnswer
|
||||||
|
if err := json.Unmarshal([]byte(`{"level":"unit"}`), &none); err != nil || none.Digest != nil || none.Digest.Map() != nil {
|
||||||
|
t.Errorf("a level without a digest read %+v, %v", none.Digest, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
BIN
Binary file not shown.
BIN
Binary file not shown.
@@ -0,0 +1,321 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/asks"
|
||||||
|
)
|
||||||
|
|
||||||
|
// The asks the view may answer, and its answers (novox/hq ADR 0528 clause 6, ADR 0429 §3 and §6, ADR 0437 §10). The
|
||||||
|
// gate's merge ask (`merge.<group>.<heads hash>`, MergeAskKey) needs proof of who answered (ADR 0421 §1), so it is
|
||||||
|
// answered on the phone alone until issue 953 closes. The assigner's asks need no such proof, and the view may
|
||||||
|
// answer them: the hold of a fingerprint whose health check failed (`hold.<module>.<fingerprint hex>`: release it or
|
||||||
|
// keep it held) and the restore of a data module set back (`restore.<node>.<module>.<fingerprint hex>`: restore and
|
||||||
|
// lose newer writes, or leave it stopped, ADR 0429 §6). The assigner writes them in its bucket asks; the view writes
|
||||||
|
// its answer `<ask key>.view` in its bucket answers, and the teller, which alone fills an ask's answer, takes it from
|
||||||
|
// there as it takes a warrant from the phone.
|
||||||
|
const (
|
||||||
|
// ViewModule is the module of the view part.
|
||||||
|
ViewModule = "mesh-delivery-view"
|
||||||
|
// ViewAnswersBucket is the view's bucket of answers, the only state the view writes.
|
||||||
|
ViewAnswersBucket = ViewModule + "_answers"
|
||||||
|
// ViewAnswersHistory is the revisions the bucket keeps per key.
|
||||||
|
ViewAnswersHistory = 5
|
||||||
|
// AssignerAsksBucket is the assigner's bucket of asks that need no proof of who answered.
|
||||||
|
AssignerAsksBucket = AssignerModule + "_asks"
|
||||||
|
// AssignerAsksHistory is the revisions the bucket keeps per key.
|
||||||
|
AssignerAsksHistory = 5
|
||||||
|
|
||||||
|
// AskKindHold is the kind of the assigner's ask about a held fingerprint.
|
||||||
|
AskKindHold = "hold"
|
||||||
|
// AskKindRestore is the kind of the assigner's ask about a data module set back.
|
||||||
|
AskKindRestore = "restore"
|
||||||
|
// AskKindBackup is the kind of the assigner's ask about a backup before an apply that failed: back up again, or go
|
||||||
|
// on without one (novox/hq ADR 0539 clause 16).
|
||||||
|
AskKindBackup = "backup"
|
||||||
|
// AskKindRecord is the kind of the assigner's ask about a move a person must allow, for a module of policy record:
|
||||||
|
// a composition judged to recreate a container or move data, or one that cannot be judged (ADR 0539 clause 14).
|
||||||
|
AskKindRecord = "record"
|
||||||
|
|
||||||
|
viewWord = "view"
|
||||||
|
)
|
||||||
|
|
||||||
|
// AskKey is an ask's key read whole: its Kind, and the parts its kind has: a merge's Group and heads Hash, a hold's
|
||||||
|
// Module and fingerprint FP, a restore's and a backup's Node, Module and FP, a record's Node, Module and the digest
|
||||||
|
// Composed of the composition it would allow.
|
||||||
|
type AskKey struct {
|
||||||
|
Kind string
|
||||||
|
Group string
|
||||||
|
Hash string
|
||||||
|
Node string
|
||||||
|
Module string
|
||||||
|
FP string
|
||||||
|
Composed string
|
||||||
|
}
|
||||||
|
|
||||||
|
// AskNeedsProof says whether an ask of this kind must prove who answered it, so the view may not answer it: the
|
||||||
|
// merge's Approve does (ADR 0421 §1, issue 953), the assigner's hold and restore do not. An unknown kind is refused.
|
||||||
|
func AskNeedsProof(kind string) (bool, error) {
|
||||||
|
switch kind {
|
||||||
|
case AskKindMerge:
|
||||||
|
return true, nil
|
||||||
|
case AskKindHold, AskKindRestore, AskKindBackup, AskKindRecord:
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
return false, fmt.Errorf("delivery: %q is not a kind of ask, %s, %s, %s, %s or %s", kind, AskKindMerge, AskKindHold,
|
||||||
|
AskKindRestore, AskKindBackup, AskKindRecord)
|
||||||
|
}
|
||||||
|
|
||||||
|
// HoldAskKey is the key, in AssignerAsksBucket, of the ask about a module's held fingerprint: `hold.<module>.<hex>`.
|
||||||
|
func HoldAskKey(module, fingerprint string) (string, error) {
|
||||||
|
key, err := BuilderBuildKey(module, fingerprint)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return AskKindHold + "." + key, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// RestoreAskKey is the key, in AssignerAsksBucket, of the ask about a data module set back on a node from a
|
||||||
|
// fingerprint: `restore.<node>.<module>.<hex>`.
|
||||||
|
func RestoreAskKey(node, module, fingerprint string) (string, error) {
|
||||||
|
if err := checkName("node", node); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
key, err := BuilderBuildKey(module, fingerprint)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return AskKindRestore + "." + node + "." + key, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// BackupAskKey is the key, in AssignerAsksBucket, of the ask about a module's failed backup on a node before it applies
|
||||||
|
// a fingerprint: `backup.<node>.<module>.<hex>`.
|
||||||
|
func BackupAskKey(node, module, fingerprint string) (string, error) {
|
||||||
|
key, err := ComposedKey(node, module, fingerprint)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return AskKindBackup + "." + key, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// RecordAskKey is the key, in AssignerAsksBucket, of the ask about a move of a module on a node to the composition
|
||||||
|
// whose digest it names: `record.<node>.<module>.<digest hex>`, so a new revision at the same fingerprint is asked
|
||||||
|
// again (ADR 0539 clause 14).
|
||||||
|
func RecordAskKey(node, module, composed string) (string, error) {
|
||||||
|
have, err := HaveKey(node, module)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if err := checkDigest(composed, "a record ask's composition digest"); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
return AskKindRecord + "." + have + "." + strings.TrimPrefix(composed, "sha256:"), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseAnyAskKey reads an ask key of any kind (MergeAskKey, HoldAskKey, RestoreAskKey, BackupAskKey, RecordAskKey); it
|
||||||
|
// refuses an unknown kind
|
||||||
|
// and a key whose parts do not fit its kind, naming the key.
|
||||||
|
func ParseAnyAskKey(key string) (AskKey, error) {
|
||||||
|
kind, rest, _ := strings.Cut(key, ".")
|
||||||
|
refused := func(err error) (AskKey, error) {
|
||||||
|
return AskKey{}, fmt.Errorf("delivery: %q is not an ask key: %w", key, err)
|
||||||
|
}
|
||||||
|
switch kind {
|
||||||
|
case AskKindMerge:
|
||||||
|
_, group, hash, err := ParseAskKey(key)
|
||||||
|
if err != nil {
|
||||||
|
return AskKey{}, err
|
||||||
|
}
|
||||||
|
return AskKey{Kind: kind, Group: group, Hash: hash}, nil
|
||||||
|
case AskKindHold:
|
||||||
|
module, fp, err := ParseBuilderBuildKey(rest)
|
||||||
|
if err != nil {
|
||||||
|
return refused(err)
|
||||||
|
}
|
||||||
|
return AskKey{Kind: kind, Module: module, FP: fp}, nil
|
||||||
|
case AskKindRestore:
|
||||||
|
node, build, ok := strings.Cut(rest, ".")
|
||||||
|
if !ok {
|
||||||
|
return refused(fmt.Errorf("a restore ask is restore.<node>.<module>.<fingerprint hex>"))
|
||||||
|
}
|
||||||
|
if err := checkName("node", node); err != nil {
|
||||||
|
return refused(err)
|
||||||
|
}
|
||||||
|
module, fp, err := ParseBuilderBuildKey(build)
|
||||||
|
if err != nil {
|
||||||
|
return refused(err)
|
||||||
|
}
|
||||||
|
return AskKey{Kind: kind, Node: node, Module: module, FP: fp}, nil
|
||||||
|
case AskKindBackup:
|
||||||
|
node, module, fp, isNode, err := ParseComposedKey(rest)
|
||||||
|
if err != nil || isNode {
|
||||||
|
return refused(fmt.Errorf("a backup ask is backup.<node>.<module>.<fingerprint hex>"))
|
||||||
|
}
|
||||||
|
return AskKey{Kind: kind, Node: node, Module: module, FP: fp}, nil
|
||||||
|
case AskKindRecord:
|
||||||
|
parts := strings.Split(rest, ".")
|
||||||
|
if len(parts) != 3 {
|
||||||
|
return refused(fmt.Errorf("a record ask is record.<node>.<module>.<digest hex>"))
|
||||||
|
}
|
||||||
|
node, module, isNode, err := ParseHaveKey(parts[0] + "." + parts[1])
|
||||||
|
if err != nil || isNode {
|
||||||
|
return refused(fmt.Errorf("a record ask is record.<node>.<module>.<digest hex>"))
|
||||||
|
}
|
||||||
|
composed := "sha256:" + parts[2]
|
||||||
|
if err := checkDigest(composed, "a record ask's composition digest"); err != nil {
|
||||||
|
return refused(err)
|
||||||
|
}
|
||||||
|
return AskKey{Kind: kind, Node: node, Module: module, Composed: composed}, nil
|
||||||
|
}
|
||||||
|
_, err := AskNeedsProof(kind)
|
||||||
|
return refused(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ViewAnswerKey is the key, in ViewAnswersBucket, of the view's answer to the ask at askKey: `<ask key>.view`. An ask
|
||||||
|
// that needs proof of who answered is refused with its reason: it is answered on the phone (issue 953).
|
||||||
|
func ViewAnswerKey(askKey string) (string, error) {
|
||||||
|
ask, err := ParseAnyAskKey(askKey)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if proof, _ := AskNeedsProof(ask.Kind); proof {
|
||||||
|
return "", fmt.Errorf("delivery: the ask %s needs proof of who answered: answer it on the phone (issue 953)", askKey)
|
||||||
|
}
|
||||||
|
return askKey + "." + viewWord, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseViewAnswerKey is the inverse of ViewAnswerKey: the ask's key. It refuses a key without `.view`, an ask key of
|
||||||
|
// a kind that needs proof, and a key of another bucket, naming it.
|
||||||
|
func ParseViewAnswerKey(key string) (askKey string, err error) {
|
||||||
|
askKey, ok := strings.CutSuffix(key, "."+viewWord)
|
||||||
|
if !ok {
|
||||||
|
return "", fmt.Errorf("delivery: %q is not a view answer key, <ask key>.view", key)
|
||||||
|
}
|
||||||
|
if _, err := ViewAnswerKey(askKey); err != nil {
|
||||||
|
return "", fmt.Errorf("delivery: %q is not a view answer key: %w", key, err)
|
||||||
|
}
|
||||||
|
return askKey, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// AssignerAsk is the value of a key in AssignerAsksBucket: the router's ask whole, as the assigner composes it, so the
|
||||||
|
// teller publishes it unchanged. Asking counts the times the assigner wrote the ask at this key, as the gate's Ask
|
||||||
|
// does: 0 or 1 for the first, n for the n-th, and the ask's id is AskingID(key, Asking), so each asking has its own id
|
||||||
|
// and an answer to an earlier asking is never taken for a later one.
|
||||||
|
type AssignerAsk struct {
|
||||||
|
V int `json:"v"`
|
||||||
|
Ask asks.Ask `json:"ask"`
|
||||||
|
Asking int `json:"asking,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a AssignerAsk) check(key string) error {
|
||||||
|
ask, err := ParseAnyAskKey(key)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if proof, _ := AskNeedsProof(ask.Kind); proof {
|
||||||
|
return fmt.Errorf("delivery: the assigner asks no %s ask: it needs proof of who answered", ask.Kind)
|
||||||
|
}
|
||||||
|
if a.Asking < 0 {
|
||||||
|
return fmt.Errorf("delivery: the ask's asking %d is negative", a.Asking)
|
||||||
|
}
|
||||||
|
if want := AskingID(key, a.Asking); a.Ask.ID != want {
|
||||||
|
return fmt.Errorf("delivery: the ask's id %q is not %q, the id its key and asking %d give", a.Ask.ID, want, a.Asking)
|
||||||
|
}
|
||||||
|
if len(a.Ask.Options) == 0 {
|
||||||
|
return fmt.Errorf("delivery: the ask has no option")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncodeAssignerAsk is a, the ask at key, as JSON at Version; it refuses a key of a kind that needs proof or of no
|
||||||
|
// kind, an id other than the one the key and the asking give, and an ask with no option.
|
||||||
|
func EncodeAssignerAsk(key string, a AssignerAsk) ([]byte, error) {
|
||||||
|
if err := a.check(key); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
a.V = Version
|
||||||
|
return json.Marshal(a)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecodeAssignerAsk reads the ask at key; it refuses an unknown version (ErrUnknownVersion) and what EncodeAssignerAsk
|
||||||
|
// refuses.
|
||||||
|
func DecodeAssignerAsk(key string, data []byte) (AssignerAsk, error) {
|
||||||
|
var a AssignerAsk
|
||||||
|
if err := decode(data, &a); err != nil {
|
||||||
|
return AssignerAsk{}, err
|
||||||
|
}
|
||||||
|
if err := a.check(key); err != nil {
|
||||||
|
return AssignerAsk{}, err
|
||||||
|
}
|
||||||
|
return a, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SameAssignerAsk says whether two asks are the same value.
|
||||||
|
func SameAssignerAsk(a, b AssignerAsk) bool {
|
||||||
|
return a.V == b.V && a.Asking == b.Asking && a.Ask.Digest() == b.Ask.Digest()
|
||||||
|
}
|
||||||
|
|
||||||
|
// ViewAnswer is the view's answer to an ask: the id of the asking it answers (the ask's id, AskingID of its key and
|
||||||
|
// asking), the option the operator chose and their words. The entry's own time says when.
|
||||||
|
type ViewAnswer struct {
|
||||||
|
V int `json:"v"`
|
||||||
|
Asking string `json:"asking"`
|
||||||
|
Option string `json:"option"`
|
||||||
|
Words string `json:"words,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a ViewAnswer) check() error {
|
||||||
|
if strings.TrimSpace(a.Asking) == "" {
|
||||||
|
return fmt.Errorf("delivery: a view answer names no asking")
|
||||||
|
}
|
||||||
|
if strings.TrimSpace(a.Option) == "" {
|
||||||
|
return fmt.Errorf("delivery: a view answer names no option")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ViewAnswerFits says whether the view's answer a answers the ask as it stands now: it refuses an answer to another
|
||||||
|
// asking of the ask (a stale answer to an earlier writing of the same key) and an option the ask does not offer,
|
||||||
|
// naming both.
|
||||||
|
func ViewAnswerFits(a ViewAnswer, ask AssignerAsk) error {
|
||||||
|
if a.Asking != ask.Ask.ID {
|
||||||
|
return fmt.Errorf("delivery: the view's answer is to the asking %s, and the ask stands at the asking %s", a.Asking, ask.Ask.ID)
|
||||||
|
}
|
||||||
|
o, ok := ask.Ask.Option(a.Option)
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("delivery: the view's answer chose %q, which the asking %s does not offer", a.Option, ask.Ask.ID)
|
||||||
|
}
|
||||||
|
if o.Level != "" && o.Level != asks.Acknowledge {
|
||||||
|
// An option that authorises is answered on a channel that proves who answered (ADR 0259 §5, ADR 0546 clause 8),
|
||||||
|
// never in the view, which proves nobody.
|
||||||
|
return fmt.Errorf("delivery: the view's answer chose %q, an option of level %s, which only a channel that proves who answered takes", a.Option, o.Level)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// EncodeViewAnswer is a as JSON at Version; it refuses an answer naming no asking or no option.
|
||||||
|
func EncodeViewAnswer(a ViewAnswer) ([]byte, error) {
|
||||||
|
if err := a.check(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
a.V = Version
|
||||||
|
return json.Marshal(a)
|
||||||
|
}
|
||||||
|
|
||||||
|
// DecodeViewAnswer reads a view answer; it refuses an unknown version (ErrUnknownVersion) and an answer naming no
|
||||||
|
// asking or no option.
|
||||||
|
func DecodeViewAnswer(data []byte) (ViewAnswer, error) {
|
||||||
|
var a ViewAnswer
|
||||||
|
if err := decode(data, &a); err != nil {
|
||||||
|
return ViewAnswer{}, err
|
||||||
|
}
|
||||||
|
if err := a.check(); err != nil {
|
||||||
|
return ViewAnswer{}, err
|
||||||
|
}
|
||||||
|
return a, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SameViewAnswer says whether two view answers are the same value.
|
||||||
|
func SameViewAnswer(a, b ViewAnswer) bool { return a == b }
|
||||||
@@ -0,0 +1,168 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.novox.be/novox/mesh-sdk/go/asks"
|
||||||
|
)
|
||||||
|
|
||||||
|
// 1297/B1c: the kinds of ask, and which need proof of who answered: the merge does, hold and restore do not, an
|
||||||
|
// unknown kind is refused.
|
||||||
|
func TestAskNeedsProof(t *testing.T) {
|
||||||
|
for kind, want := range map[string]bool{AskKindMerge: true, AskKindHold: false, AskKindRestore: false} {
|
||||||
|
if got, err := AskNeedsProof(kind); err != nil || got != want {
|
||||||
|
t.Errorf("AskNeedsProof(%q) = %v, %v; want %v", kind, got, err, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := AskNeedsProof("approve"); err == nil {
|
||||||
|
t.Errorf("an unknown kind was read")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1297/B1c: each kind of ask key round-trips through ParseAnyAskKey; a key that fits no kind is refused, naming it.
|
||||||
|
func TestParseAnyAskKey(t *testing.T) {
|
||||||
|
fp := fp2of('d')
|
||||||
|
merge, _ := MergeAskKey("feat/r4g", []Head{{Repository: "novox/mesh-sdk", Number: 1, Head: strings.Repeat("1", 40)}})
|
||||||
|
hold, err := HoldAskKey("mesh-mail", fp)
|
||||||
|
if err != nil || hold != "hold.mesh-mail."+strings.Repeat("d", 64) {
|
||||||
|
t.Fatalf("HoldAskKey = %q, %v", hold, err)
|
||||||
|
}
|
||||||
|
restore, err := RestoreAskKey("ace", "mesh-mail", fp)
|
||||||
|
if err != nil || restore != "restore.ace.mesh-mail."+strings.Repeat("d", 64) {
|
||||||
|
t.Fatalf("RestoreAskKey = %q, %v", restore, err)
|
||||||
|
}
|
||||||
|
for key, want := range map[string]AskKey{
|
||||||
|
hold: {Kind: AskKindHold, Module: "mesh-mail", FP: fp},
|
||||||
|
restore: {Kind: AskKindRestore, Node: "ace", Module: "mesh-mail", FP: fp},
|
||||||
|
} {
|
||||||
|
if got, err := ParseAnyAskKey(key); err != nil || got != want {
|
||||||
|
t.Errorf("ParseAnyAskKey(%q) = %+v, %v", key, got, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if got, err := ParseAnyAskKey(merge); err != nil || got.Kind != AskKindMerge || got.Group != "feat/r4g" || len(got.Hash) != 12 {
|
||||||
|
t.Errorf("ParseAnyAskKey(%q) = %+v, %v", merge, got, err)
|
||||||
|
}
|
||||||
|
for _, bad := range []string{"want.ace.mesh-mail", "hold.mesh-mail", "restore.mesh-mail." + strings.Repeat("d", 64), "approve.x.y", "restore.a.b.c.d", ""} {
|
||||||
|
if _, err := ParseAnyAskKey(bad); err == nil || !strings.Contains(err.Error(), "\""+bad+"\"") {
|
||||||
|
t.Errorf("ParseAnyAskKey(%q) = %v, want a refusal naming it", bad, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := RestoreAskKey("a.b", "m", fp); err == nil {
|
||||||
|
t.Errorf("a restore ask on a dotted node was keyed")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1297/B1c: the view's answer key is the ask's key and `.view`, and round-trips; the merge's ask is refused with its
|
||||||
|
// reason (issue 953); another bucket's key is refused, naming it.
|
||||||
|
func TestViewAnswerKey(t *testing.T) {
|
||||||
|
hold, _ := HoldAskKey("mesh-mail", fp2of('e'))
|
||||||
|
key, err := ViewAnswerKey(hold)
|
||||||
|
if err != nil || key != hold+".view" {
|
||||||
|
t.Fatalf("ViewAnswerKey = %q, %v", key, err)
|
||||||
|
}
|
||||||
|
if back, err := ParseViewAnswerKey(key); err != nil || back != hold {
|
||||||
|
t.Errorf("ParseViewAnswerKey = %q, %v", back, err)
|
||||||
|
}
|
||||||
|
merge, _ := MergeAskKey("g", []Head{{Repository: "novox/hq", Number: 2, Head: strings.Repeat("2", 40)}})
|
||||||
|
if _, err := ViewAnswerKey(merge); err == nil || !strings.Contains(err.Error(), "phone") || !strings.Contains(err.Error(), "953") {
|
||||||
|
t.Errorf("the merge's ask was answerable in the view, or its reason is missing: %v", err)
|
||||||
|
}
|
||||||
|
for _, bad := range []string{hold, merge + ".view", "want.ace.mesh-mail.view", "ace.mesh-mail", ""} {
|
||||||
|
if _, err := ParseViewAnswerKey(bad); err == nil || !strings.Contains(err.Error(), "\""+bad+"\"") {
|
||||||
|
t.Errorf("ParseViewAnswerKey(%q) = %v, want a refusal naming it", bad, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1297/B1c: a view answer round-trips; one naming no asking or no option is refused.
|
||||||
|
func TestViewAnswerRoundTrip(t *testing.T) {
|
||||||
|
a := ViewAnswer{Asking: "hold-mesh-mail-aaaa-0123456789ab", Option: "release", Words: "fixed by #12"}
|
||||||
|
data, err := EncodeViewAnswer(a)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
got, err := DecodeViewAnswer(data)
|
||||||
|
a.V = Version
|
||||||
|
if err != nil || !SameViewAnswer(got, a) {
|
||||||
|
t.Errorf("view answer came back %+v, %v", got, err)
|
||||||
|
}
|
||||||
|
if _, err := EncodeViewAnswer(ViewAnswer{Asking: "x", Option: " "}); err == nil {
|
||||||
|
t.Errorf("a view answer naming no option was accepted")
|
||||||
|
}
|
||||||
|
if _, err := EncodeViewAnswer(ViewAnswer{Option: "release"}); err == nil {
|
||||||
|
t.Errorf("a view answer naming no asking was accepted")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func holdAsk(t *testing.T, asking int) (string, AssignerAsk) {
|
||||||
|
t.Helper()
|
||||||
|
key, err := HoldAskKey("mesh-mail", fp2of('f'))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return key, AssignerAsk{Asking: asking, Ask: asks.Ask{ID: AskingID(key, asking), Headline: "mesh-mail is held", Explanation: "its health failed",
|
||||||
|
Options: []asks.Option{{ID: "release", Label: "Release"}, {ID: "keep", Label: "Keep held"}}, Who: "operator",
|
||||||
|
Expires: time.Date(2026, 10, 30, 0, 0, 0, 0, time.UTC), OnExpiry: "it stays held"}}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1297/B1c: the assigner's ask round-trips at its key; an id another key or asking gives, an ask of a kind that needs
|
||||||
|
// proof and one with no option are refused.
|
||||||
|
func TestAssignerAskRoundTrip(t *testing.T) {
|
||||||
|
key, a := holdAsk(t, 2)
|
||||||
|
data, err := EncodeAssignerAsk(key, a)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.HasPrefix(string(data), `{"v":1,"ask":`) {
|
||||||
|
t.Errorf("the ask is written as %s", data)
|
||||||
|
}
|
||||||
|
got, err := DecodeAssignerAsk(key, data)
|
||||||
|
a.V = Version
|
||||||
|
if err != nil || !SameAssignerAsk(got, a) {
|
||||||
|
t.Errorf("the ask came back %+v, %v", got, err)
|
||||||
|
}
|
||||||
|
other, _ := HoldAskKey("mesh-web", fp2of('f'))
|
||||||
|
if _, err := DecodeAssignerAsk(other, data); err == nil {
|
||||||
|
t.Errorf("an ask was read at another key")
|
||||||
|
}
|
||||||
|
stale := a
|
||||||
|
stale.Asking = 3
|
||||||
|
if _, err := EncodeAssignerAsk(key, stale); err == nil {
|
||||||
|
t.Errorf("an ask whose id is another asking's was accepted")
|
||||||
|
}
|
||||||
|
merge, _ := MergeAskKey("g", []Head{{Repository: "novox/hq", Number: 2, Head: strings.Repeat("2", 40)}})
|
||||||
|
if _, err := EncodeAssignerAsk(merge, AssignerAsk{Ask: asks.Ask{ID: AskingID(merge, 0), Options: a.Ask.Options}}); err == nil {
|
||||||
|
t.Errorf("the assigner was let write a merge's ask")
|
||||||
|
}
|
||||||
|
none := a
|
||||||
|
none.Ask.Options = nil
|
||||||
|
if _, err := EncodeAssignerAsk(key, none); err == nil {
|
||||||
|
t.Errorf("an ask with no option was accepted")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1297/B1c: a view answer fits only the asking it names: an answer to an earlier asking of the same key is refused,
|
||||||
|
// naming both, and so is an option the ask does not offer.
|
||||||
|
func TestViewAnswerFits(t *testing.T) {
|
||||||
|
key, first := holdAsk(t, 0)
|
||||||
|
_, second := holdAsk(t, 2)
|
||||||
|
answer := ViewAnswer{Asking: AskingID(key, 0), Option: "release"}
|
||||||
|
if err := ViewAnswerFits(answer, first); err != nil {
|
||||||
|
t.Errorf("the answer to the first asking does not fit it: %v", err)
|
||||||
|
}
|
||||||
|
if err := ViewAnswerFits(answer, second); err == nil || !strings.Contains(err.Error(), first.Ask.ID) || !strings.Contains(err.Error(), second.Ask.ID) {
|
||||||
|
t.Errorf("a stale answer fits the later asking, or the refusal names neither: %v", err)
|
||||||
|
}
|
||||||
|
if err := ViewAnswerFits(ViewAnswer{Asking: first.Ask.ID, Option: "restore"}, first); err == nil {
|
||||||
|
t.Errorf("an option the ask does not offer fits")
|
||||||
|
}
|
||||||
|
// An option that authorises is never answered in the view (ADR 0546 clause 8).
|
||||||
|
approving := first
|
||||||
|
approving.Ask.Options = append([]asks.Option(nil), first.Ask.Options...)
|
||||||
|
approving.Ask.Options[0].Level = asks.Approve
|
||||||
|
if err := ViewAnswerFits(answer, approving); err == nil || !strings.Contains(err.Error(), "approve") {
|
||||||
|
t.Errorf("the view answered an option of level approve: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,176 @@
|
|||||||
|
package delivery
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func hashOf(c byte) string { return "sha256:" + digestOf(c) }
|
||||||
|
|
||||||
|
// 1943/AC3: a want naming its fingerprint and the digest of the composition it allows round-trips, and so does one
|
||||||
|
// carrying the answer to a failed backup; a want naming a fingerprint without a digest, a digest not of the sha256
|
||||||
|
// form, a removed want naming a digest, an unknown backup answer and a rule past the seventh are refused.
|
||||||
|
func TestAWantNamesItsComposition(t *testing.T) {
|
||||||
|
for _, w := range []Want{
|
||||||
|
{FP: fp2of('a'), Composed: hashOf('1')},
|
||||||
|
{FP: fp2of('a'), Composed: hashOf('1'), Backup: BackupAgain},
|
||||||
|
{FP: fp2of('a'), Composed: hashOf('1'), Backup: BackupSkip, Words: "the operator: go on without a backup"},
|
||||||
|
{FP: fp2of('a'), Composed: hashOf('1'), Newest: fp2of('b'), Rule: RuleComposed, Words: "no composition of b for ace yet"},
|
||||||
|
{Removed: true},
|
||||||
|
} {
|
||||||
|
raw, err := EncodeWant(w)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("EncodeWant(%+v): %v", w, err)
|
||||||
|
}
|
||||||
|
back, err := DecodeWant(raw)
|
||||||
|
w.V = Version
|
||||||
|
if err != nil || !SameWant(back, w) {
|
||||||
|
t.Errorf("want %+v came back %+v, %v", w, back, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
refusals := []struct {
|
||||||
|
w Want
|
||||||
|
why string
|
||||||
|
}{
|
||||||
|
{Want{FP: fp2of('a')}, "names no composition"},
|
||||||
|
{Want{FP: fp2of('a'), Composed: "sha256:12"}, "not sha256"},
|
||||||
|
{Want{Removed: true, Composed: hashOf('1')}, "removed want names no"},
|
||||||
|
{Want{FP: fp2of('a'), Composed: hashOf('1'), Backup: "later"}, `backup answer "later"`},
|
||||||
|
{Want{Removed: true, Backup: BackupAgain}, "removed want names no"},
|
||||||
|
{Want{FP: fp2of('a'), Composed: hashOf('1'), Newest: fp2of('b'), Rule: 8}, "rule 8"},
|
||||||
|
}
|
||||||
|
for _, r := range refusals {
|
||||||
|
if _, err := EncodeWant(r.w); err == nil || !strings.Contains(err.Error(), r.why) {
|
||||||
|
t.Errorf("EncodeWant(%+v) = %v, want a refusal saying %q", r.w, err, r.why)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := DecodeWant([]byte(`{"v":1,"fp":"` + fp2of('a') + `"}`)); err == nil || !strings.Contains(err.Error(), "names no composition") {
|
||||||
|
t.Errorf("a want of release 5, naming no composition, was read: %v", err)
|
||||||
|
}
|
||||||
|
if RuleComposed != 7 {
|
||||||
|
t.Errorf("RuleComposed = %d, want the seventh rule", RuleComposed)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943/AC3: the node's own want is `want.<node>.node` and round-trips through its parser, while a module named node is
|
||||||
|
// still refused a want key; its value names the digest of the node's own composition and no fingerprint.
|
||||||
|
func TestTheNodesOwnWant(t *testing.T) {
|
||||||
|
key, err := WantNodeKey("ace")
|
||||||
|
if err != nil || key != "want.ace.node" {
|
||||||
|
t.Fatalf("WantNodeKey = %q, %v", key, err)
|
||||||
|
}
|
||||||
|
if node, err := ParseWantNodeKey(key); err != nil || node != "ace" {
|
||||||
|
t.Errorf("ParseWantNodeKey(%q) = %q, %v", key, node, err)
|
||||||
|
}
|
||||||
|
if _, err := WantKey("ace", "node"); err == nil {
|
||||||
|
t.Errorf(`WantKey(ace, "node") accepted`)
|
||||||
|
}
|
||||||
|
if _, _, err := ParseWantKey(key); err == nil {
|
||||||
|
t.Errorf("ParseWantKey read the node's own want as a module's")
|
||||||
|
}
|
||||||
|
for _, bad := range []string{"want.ace.mesh-mail", "want.node", "ace.node", "want.a.b.node", ""} {
|
||||||
|
if _, err := ParseWantNodeKey(bad); err == nil || !strings.Contains(err.Error(), "\""+bad+"\"") {
|
||||||
|
t.Errorf("ParseWantNodeKey(%q) = %v, want a refusal naming it", bad, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := WantNodeKey(""); err == nil {
|
||||||
|
t.Errorf("WantNodeKey(\"\") accepted")
|
||||||
|
}
|
||||||
|
w := NodeWant{Composed: hashOf('2'), Words: "the node's own composition"}
|
||||||
|
raw, err := EncodeNodeWant(w)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
back, err := DecodeNodeWant(raw)
|
||||||
|
w.V = Version
|
||||||
|
if err != nil || back != w {
|
||||||
|
t.Errorf("node want came back %+v, %v", back, err)
|
||||||
|
}
|
||||||
|
for _, bad := range []NodeWant{{}, {Composed: "sha256:1"}} {
|
||||||
|
if _, err := EncodeNodeWant(bad); err == nil {
|
||||||
|
t.Errorf("EncodeNodeWant(%+v) accepted", bad)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := DecodeNodeWant([]byte(`{"v":1,"composed":"` + hashOf('2') + `","fp":"` + fp2of('a') + `"}`)); err == nil {
|
||||||
|
t.Errorf("a node want naming a fingerprint was read")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943/AC3: a have held after a failed backup, naming the composition it runs, round-trips; so does the node's own have
|
||||||
|
// naming its composition; a have's digest not of the sha256 form is refused.
|
||||||
|
func TestAHaveNamesItsComposition(t *testing.T) {
|
||||||
|
for _, h := range []Have{
|
||||||
|
{FP: fp2of('a'), Composed: hashOf('3'), Phase: PhaseHeld, Health: HealthOK, Detail: "the backup failed: no space left"},
|
||||||
|
{FP: fp2of('a'), Composed: hashOf('3'), Phase: PhaseRunning, Health: HealthOK},
|
||||||
|
} {
|
||||||
|
raw, err := EncodeHave(h)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("EncodeHave(%+v): %v", h, err)
|
||||||
|
}
|
||||||
|
back, err := DecodeHave(raw)
|
||||||
|
h.V = Version
|
||||||
|
if err != nil || !SameHave(back, h) {
|
||||||
|
t.Errorf("have %+v came back %+v, %v", h, back, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := EncodeHave(Have{Composed: "sha256:x", Phase: PhaseRunning, Health: HealthOK}); err == nil || !strings.Contains(err.Error(), "not sha256") {
|
||||||
|
t.Errorf("a have naming a bad digest = %v", err)
|
||||||
|
}
|
||||||
|
n := HaveNode{Composed: hashOf('4')}
|
||||||
|
raw, err := EncodeHaveNode(n)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
back, err := DecodeHaveNode(raw)
|
||||||
|
n.V = Version
|
||||||
|
if err != nil || !SameHaveNode(back, n) {
|
||||||
|
t.Errorf("node have came back %+v, %v", back, err)
|
||||||
|
}
|
||||||
|
if SameHaveNode(n, HaveNode{V: Version, Composed: hashOf('5')}) {
|
||||||
|
t.Errorf("node haves naming two compositions are the same")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 1943/AC3: the assigner's backup ask (back up again, or go on without one, ADR 0539 clause 16) and its record ask (a
|
||||||
|
// move a person must allow, clause 14) key by node, module and fingerprint or composition, round-trip through
|
||||||
|
// ParseAnyAskKey, and the view may answer both.
|
||||||
|
func TestTheBackupAndRecordAsks(t *testing.T) {
|
||||||
|
fp, digest := fp2of('a'), hashOf('6')
|
||||||
|
backup, err := BackupAskKey("ace", "mesh-mail", fp)
|
||||||
|
if err != nil || backup != "backup.ace.mesh-mail."+strings.Repeat("a", 64) {
|
||||||
|
t.Fatalf("BackupAskKey = %q, %v", backup, err)
|
||||||
|
}
|
||||||
|
record, err := RecordAskKey("ace", "mesh-mail", digest)
|
||||||
|
if err != nil || record != "record.ace.mesh-mail."+strings.Repeat("6", 64) {
|
||||||
|
t.Fatalf("RecordAskKey = %q, %v", record, err)
|
||||||
|
}
|
||||||
|
if got, err := ParseAnyAskKey(backup); err != nil || got != (AskKey{Kind: AskKindBackup, Node: "ace", Module: "mesh-mail", FP: fp}) {
|
||||||
|
t.Errorf("ParseAnyAskKey(%q) = %+v, %v", backup, got, err)
|
||||||
|
}
|
||||||
|
if got, err := ParseAnyAskKey(record); err != nil || got != (AskKey{Kind: AskKindRecord, Node: "ace", Module: "mesh-mail", Composed: digest}) {
|
||||||
|
t.Errorf("ParseAnyAskKey(%q) = %+v, %v", record, got, err)
|
||||||
|
}
|
||||||
|
for _, kind := range []string{AskKindBackup, AskKindRecord} {
|
||||||
|
if proof, err := AskNeedsProof(kind); err != nil || proof {
|
||||||
|
t.Errorf("AskNeedsProof(%s) = %v, %v; the view may answer it", kind, proof, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, k := range []string{backup, record} {
|
||||||
|
if _, err := ViewAnswerKey(k); err != nil {
|
||||||
|
t.Errorf("the view may not answer %s: %v", k, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, bad := range [][3]string{{"", "mesh-mail", fp}, {"ace", "node", fp}, {"ace", "mesh-mail", "src2:1"}} {
|
||||||
|
if _, err := BackupAskKey(bad[0], bad[1], bad[2]); err == nil {
|
||||||
|
t.Errorf("BackupAskKey(%v) accepted", bad)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := RecordAskKey("ace", "mesh-mail", "sha256:1"); err == nil {
|
||||||
|
t.Errorf("a record ask naming a bad digest was keyed")
|
||||||
|
}
|
||||||
|
for _, bad := range []string{"backup.ace.mesh-mail", "record.ace.mesh-mail.12", "record.ace." + strings.Repeat("6", 64)} {
|
||||||
|
if _, err := ParseAnyAskKey(bad); err == nil {
|
||||||
|
t.Errorf("ParseAnyAskKey(%q) accepted", bad)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -15,7 +15,12 @@
|
|||||||
// `mesh/repo-check` runs; a repository missing there fails the test, never skips it. Which clones a
|
// `mesh/repo-check` runs; a repository missing there fails the test, never skips it. Which clones a
|
||||||
// check gets is chosen from the inventory: mesh-catalog by the source of the `nats` module, mesh-host
|
// check gets is chosen from the inventory: mesh-catalog by the source of the `nats` module, mesh-host
|
||||||
// by the source of `mesh-host`, and mesh-sdk as the controller's sibling at the commit the controller's
|
// by the source of `mesh-host`, and mesh-sdk as the controller's sibling at the commit the controller's
|
||||||
// go.mod pins. In a mesh where either module has no source repository nothing is
|
// go.mod pins. Each repository's tests read these siblings, and the checker places exactly these
|
||||||
|
// (mesh-delivery's checker, besideRules, follows this list): mesh-controller's read mesh-catalog,
|
||||||
|
// mesh-host and mesh-sdk; mesh-host's read mesh-catalog, mesh-sdk and mesh-controller (its step-nine
|
||||||
|
// test reads the controller's own manifest, novox/hq issue 1295); mesh-sdk's read mesh-catalog and
|
||||||
|
// mesh-host; mesh-catalog's read mesh-sdk and mesh-controller; mesh-delivery's read mesh-sdk and
|
||||||
|
// mesh-catalog. In a mesh where either module has no source repository nothing is
|
||||||
// cloned, and these tests fail loudly with "not beside this check": a cause in the setup, not in the
|
// cloned, and these tests fail loudly with "not beside this check": a cause in the setup, not in the
|
||||||
// change. And in a delivery group that holds a mesh-catalog pull request, these tests read the
|
// change. And in a delivery group that holds a mesh-catalog pull request, these tests read the
|
||||||
// catalogue's main, not the group's head.
|
// catalogue's main, not the group's head.
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
These tests read files outside this directory (the whole catalogue, the repository, or its root files): mesh-build-go never keeps this package's verdict (issue 1935).
|
||||||
@@ -1,136 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# mesh-check-toolchain: go
|
|
||||||
#
|
|
||||||
# The Go part of the SDK's own check (novox/hq ADR 0237 as amended, ADR 0272): the Go binding, run by the build
|
|
||||||
# seat in the mesh's Go toolchain, its own container, because the SDK's merge-check.sh declares it
|
|
||||||
# (`# mesh-check-also: go go/merge-check.sh`) — and by hand, from anywhere: `sh go/merge-check.sh`.
|
|
||||||
#
|
|
||||||
# Formatted, vetted (with and without the build tag `integration`), and run at two levels (novox/hq ADR 0391):
|
|
||||||
#
|
|
||||||
# 1. the unit level: `go test ./...` untagged, no bus or other process, timed and held to a bound
|
|
||||||
# (unit_bound below); over it the check fails and names the slowest tests (issue 895);
|
|
||||||
# 2. the integration level: the whole suite with `-tags integration`, each test against a bus of its
|
|
||||||
# own (testbus, which issue 1171 brings with the first test that needs a bus) so nothing is
|
|
||||||
# serialised. With no tagged test yet, the level runs the unit tests again and says their count.
|
|
||||||
#
|
|
||||||
# **A test that starts a bus or another process carries `//go:build integration`** as the first line of
|
|
||||||
# its file; a file that held both kinds is two files (`<name>_integration_test.go` beside `<name>_test.go`).
|
|
||||||
# Each level says its test count and its time.
|
|
||||||
#
|
|
||||||
# **A test that needs bubblewrap carries `//go:build integration && isolation`** (issue 1309's proof that a run step
|
|
||||||
# is shut off): this script vets it but does not run it, since the toolchain it runs in has no bubblewrap; the checker
|
|
||||||
# runs the `isolation` tag on the build nodes, which have it (R4e).
|
|
||||||
#
|
|
||||||
# No dependency is committed (no vendor directory: .gitignore; the operator, 2026-10-19; issue 1304). Every dependency
|
|
||||||
# is resolved by the version and checksum go.sum names (novox/hq ADR 0405 §5), from its public source: this binding
|
|
||||||
# requires nothing of the mesh's own forge. `go mod verify` fails by module name when a downloaded dependency does not
|
|
||||||
# match go.sum, and -mod=readonly fails a build whose go.sum lacks an entry instead of writing it. gofmt reads only
|
|
||||||
# the binding's own files.
|
|
||||||
#
|
|
||||||
# Exit 0 is a pass; anything else fails `mesh/repo-check` with the last line printed.
|
|
||||||
set -eu
|
|
||||||
cd "$(dirname "$0")"
|
|
||||||
# The toolchain the check runs in sets -mod=vendor; there is no vendor directory, so it is replaced.
|
|
||||||
GOFLAGS="$(printf '%s' "${GOFLAGS:-}" | sed 's/-mod=[a-z]*//g') -mod=readonly"
|
|
||||||
export GOFLAGS
|
|
||||||
export GOPRIVATE=git.novox.be
|
|
||||||
|
|
||||||
# **The unit level's bound, in seconds** (issue 895): the slowest package's own test time of the untagged run,
|
|
||||||
# the compile not counted. A run over it fails the check and names the slowest tests. The SDK's unit suite is
|
|
||||||
# small (its slowest package measured well under a second on a quiet machine), so 2 s leaves room for a busier
|
|
||||||
# build node without hiding a test that should carry `integration` instead.
|
|
||||||
unit_bound=2
|
|
||||||
|
|
||||||
# judge_unit_run says the unit level as `go test -v` reported it and fails when it was over the bound: $1 the
|
|
||||||
# file holding the output of the untagged `go test -v` of every package (packages one after another, each
|
|
||||||
# ending in its `ok <package> <time>` line), $2 the bound in seconds. Packages run side by side, so the
|
|
||||||
# level's time is that of its slowest package; the five slowest tests of the run are named when it is over,
|
|
||||||
# so that the bound is kept by making them cheap or by tagging them `integration`, and never by raising it
|
|
||||||
# (issue 895).
|
|
||||||
judge_unit_run() {
|
|
||||||
out=$1 bound=$2
|
|
||||||
awk '
|
|
||||||
/^--- (PASS|FAIL|SKIP): / {
|
|
||||||
name = $3; took = $4; gsub(/[()s]/, "", took)
|
|
||||||
pending[++n] = took "\t" name
|
|
||||||
if ($2 == "SKIP:") skipped++
|
|
||||||
next
|
|
||||||
}
|
|
||||||
/^(ok|FAIL)[ \t]/ && NF >= 3 && $3 ~ /^[0-9.]+s$/ {
|
|
||||||
t = $3; sub(/s$/, "", t)
|
|
||||||
for (i = 1; i <= n; i++) print "T\t" pending[i] "\t" $2
|
|
||||||
n = 0
|
|
||||||
print "P\t" t "\t" $2
|
|
||||||
}
|
|
||||||
END { print "S\t" skipped + 0 }
|
|
||||||
' "$out" >"$out.judged"
|
|
||||||
tests=$(grep -c '^T' "$out.judged" || true)
|
|
||||||
skipped=$(awk -F'\t' '$1 == "S" {print $2}' "$out.judged")
|
|
||||||
level=$(awk -F'\t' '$1 == "P" && $2 + 0 > m {m = $2 + 0} END {printf "%.2f", m}' "$out.judged")
|
|
||||||
echo "unit level: $tests tests ($skipped skipped), $level s (bound $bound s)"
|
|
||||||
if awk -v t="$level" -v b="$bound" 'BEGIN {exit !(t + 0 > b + 0)}'; then
|
|
||||||
echo "the unit level took $level s, over its bound of $bound s; the slowest tests:"
|
|
||||||
awk -F'\t' '$1 == "T" {print $2 "\t" $4 "\t" $3}' "$out.judged" | sort -t"$(printf '\t')" -k1,1 -nr | head -n 5 |
|
|
||||||
awk -F'\t' '{printf " %s s %s %s\n", $1, $3, $2}'
|
|
||||||
echo "make them cheap (no wait, no process), or give their files //go:build integration if they start a bus or another process"
|
|
||||||
return 1
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
# `sh go/merge-check.sh judge-unit-run <output> <bound>` runs only the judging of the unit level, on a
|
|
||||||
# recorded output.
|
|
||||||
if [ "${1:-}" = judge-unit-run ]; then
|
|
||||||
shift
|
|
||||||
judge_unit_run "$@"
|
|
||||||
exit
|
|
||||||
fi
|
|
||||||
|
|
||||||
if ! fetched=$(go mod download 2>&1); then
|
|
||||||
echo "FAILED: the dependencies cannot be fetched: $(printf '%s\n' "$fetched" | tail -n 1)"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
if ! verified=$(go mod verify 2>&1); then
|
|
||||||
echo "FAILED: a dependency does not match go.sum: $verified"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
unformatted=$(find . -name '*.go' -not -path './vendor/*' | xargs gofmt -l)
|
|
||||||
if [ -n "$unformatted" ]; then
|
|
||||||
echo "not gofmt'd:"
|
|
||||||
echo "$unformatted"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
go vet ./...
|
|
||||||
# The files tagged `integration` are vetted too, or nothing would read them.
|
|
||||||
go vet -tags integration ./...
|
|
||||||
go vet -tags integration,isolation ./...
|
|
||||||
|
|
||||||
# NOT RACE-CHECKED here: the SDK's suite is small and carries no store or other shared state between
|
|
||||||
# packages, so the race detector is not required of this check (novox/hq issue 1175); a module that needs
|
|
||||||
# it asks for it in its own merge-check.sh.
|
|
||||||
echo "NOT RACE-CHECKED: the Go binding's check runs without the race detector"
|
|
||||||
|
|
||||||
work=$(mktemp -d)
|
|
||||||
trap 'rm -rf "$work"' EXIT
|
|
||||||
|
|
||||||
# The unit level first and alone: every package untagged, no bus or other process (judged above).
|
|
||||||
status=0
|
|
||||||
go test -count=1 -v ./... >"$work/unit.out" 2>&1 || status=$?
|
|
||||||
if [ "$status" -ne 0 ]; then
|
|
||||||
grep -vE '^(=== |[[:space:]]*--- PASS)' "$work/unit.out"
|
|
||||||
echo "the unit level failed (go test exited $status)"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
judge_unit_run "$work/unit.out" "$unit_bound"
|
|
||||||
|
|
||||||
# The integration level: the whole suite with the tag, each test against its own bus (testbus).
|
|
||||||
integration_start=$(date +%s)
|
|
||||||
status=0
|
|
||||||
go test -tags integration -count=1 -v ./... >"$work/integration.out" 2>&1 || status=$?
|
|
||||||
grep -vE '^(=== |[[:space:]]*--- PASS)' "$work/integration.out" || true
|
|
||||||
tests=$(grep -cE '^--- (PASS|FAIL|SKIP): ' "$work/integration.out" || true)
|
|
||||||
skipped=$(grep -cE '^--- SKIP: ' "$work/integration.out" || true)
|
|
||||||
echo "integration level: $tests tests ($skipped skipped), $(($(date +%s) - integration_start)) s"
|
|
||||||
if [ "$status" -ne 0 ]; then
|
|
||||||
echo "the integration level failed (go test exited $status)"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
package stdio
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// The checker runs gofmt, go vet at both levels' tags and both test levels by Go's convention, and fetches the
|
||||||
|
// dependencies beside the change (novox/hq ADR 0529, ADR 0484 clause 4): no script of the repository's own runs
|
||||||
|
// beside them.
|
||||||
|
func TestTheRepositoryHoldsNoCheckScript(t *testing.T) {
|
||||||
|
for _, rel := range []string{"../merge-check.sh", "merge-check.sh"} {
|
||||||
|
if _, err := os.Stat(filepath.FromSlash(rel)); err == nil {
|
||||||
|
t.Errorf("%s is back: the checker's levels run the tests", rel)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,104 @@
|
|||||||
|
package packageguard
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/hex"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io/fs"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
// The registry refuses a second, different package under one version
|
||||||
|
// ("version taken", issues 1899 and 1331). This guard fails before a merge when
|
||||||
|
// what npm packs changes while the version stays: package-version.sum holds the
|
||||||
|
// version and a sha256 over the inputs of the packed dist (package.json without
|
||||||
|
// its version, src/, tsconfig.json) and of the README npm always packs.
|
||||||
|
// The lock file is not packed, so it is not hashed.
|
||||||
|
|
||||||
|
const sumFile = "package-version.sum"
|
||||||
|
|
||||||
|
func packedInputs(root string) (version, sum string, err error) {
|
||||||
|
raw, err := os.ReadFile(filepath.Join(root, "package.json"))
|
||||||
|
if err != nil {
|
||||||
|
return "", "", err
|
||||||
|
}
|
||||||
|
var pkg map[string]any
|
||||||
|
if err := json.Unmarshal(raw, &pkg); err != nil {
|
||||||
|
return "", "", err
|
||||||
|
}
|
||||||
|
version, _ = pkg["version"].(string)
|
||||||
|
delete(pkg, "version")
|
||||||
|
canon, err := json.Marshal(pkg) // map keys are sorted: stable bytes
|
||||||
|
if err != nil {
|
||||||
|
return "", "", err
|
||||||
|
}
|
||||||
|
files := map[string][]byte{"package.json": canon}
|
||||||
|
for _, name := range []string{"tsconfig.json", "README.md"} {
|
||||||
|
b, err := os.ReadFile(filepath.Join(root, name))
|
||||||
|
if err != nil {
|
||||||
|
return "", "", err
|
||||||
|
}
|
||||||
|
files[name] = b
|
||||||
|
}
|
||||||
|
err = filepath.WalkDir(filepath.Join(root, "src"), func(p string, d fs.DirEntry, err error) error {
|
||||||
|
if err != nil || d.IsDir() {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
b, err := os.ReadFile(p)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
rel, _ := filepath.Rel(root, p)
|
||||||
|
files[filepath.ToSlash(rel)] = b
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return "", "", err
|
||||||
|
}
|
||||||
|
names := make([]string, 0, len(files))
|
||||||
|
for n := range files {
|
||||||
|
names = append(names, n)
|
||||||
|
}
|
||||||
|
sort.Strings(names)
|
||||||
|
h := sha256.New()
|
||||||
|
for _, n := range names {
|
||||||
|
fmt.Fprintf(h, "%s\x00%d\x00", n, len(files[n]))
|
||||||
|
h.Write(files[n])
|
||||||
|
}
|
||||||
|
return version, hex.EncodeToString(h.Sum(nil)), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPackageVersionMatchesPackedInputs(t *testing.T) {
|
||||||
|
root := "../.."
|
||||||
|
if r := os.Getenv("MESH_SDK_ROOT"); r != "" {
|
||||||
|
root = r
|
||||||
|
}
|
||||||
|
version, sum, err := packedInputs(root)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
line := version + " " + sum + "\n"
|
||||||
|
if os.Getenv("UPDATE_PACKAGE_VERSION_SUM") != "" {
|
||||||
|
if err := os.WriteFile(filepath.Join(root, sumFile), []byte(line), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
raw, err := os.ReadFile(filepath.Join(root, sumFile))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("%s is missing: %v", sumFile, err)
|
||||||
|
}
|
||||||
|
recVersion, recSum, _ := strings.Cut(strings.TrimSpace(string(raw)), " ")
|
||||||
|
switch {
|
||||||
|
case recVersion == version && recSum == sum:
|
||||||
|
case recVersion == version:
|
||||||
|
t.Fatalf("what npm packs for @novox/mesh-sdk changed while its version stayed %s: the registry would refuse a second, different %s. Raise @novox/mesh-sdk's version (package.json and package-lock.json) and update %s (UPDATE_PACKAGE_VERSION_SUM=1 go test -run TestPackageVersionMatchesPackedInputs in go/packageguard)", version, version, sumFile)
|
||||||
|
default:
|
||||||
|
t.Fatalf("package.json says %s but %s records %s: update %s (UPDATE_PACKAGE_VERSION_SUM=1 go test -run TestPackageVersionMatchesPackedInputs in go/packageguard)", version, sumFile, recVersion, sumFile)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
These tests read files outside this directory (the whole catalogue, the repository, or its root files): mesh-build-go never keeps this package's verdict (issue 1935).
|
||||||
@@ -1,11 +1,16 @@
|
|||||||
package process
|
package process
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
|
"github.com/nats-io/nats.go/jetstream"
|
||||||
)
|
)
|
||||||
|
|
||||||
// 1171/AC2: given an account file broker-<process id> in the controller's form {url, fingerprint, node,
|
// 1171/AC2: given an account file broker-<process id> in the controller's form {url, fingerprint, node,
|
||||||
@@ -46,6 +51,28 @@ func TestReadAccountToleratesNoClaimsAtAll(t *testing.T) {
|
|||||||
// 1171/AC2: a file missing url, user or password is refused, naming the field; the password never appears
|
// 1171/AC2: a file missing url, user or password is refused, naming the field; the password never appears
|
||||||
// in the error even when it is the field present and another is missing.
|
// in the error even when it is the field present and another is missing.
|
||||||
func TestReadAccountRefusesAFileMissingAField(t *testing.T) {
|
func TestReadAccountRefusesAFileMissingAField(t *testing.T) {
|
||||||
|
t.Run("1945: a refused bucket stops a start only when the part cannot work without it", func(t *testing.T) {
|
||||||
|
refusal := errors.New("nats: permissions violation for publish to $JS.API.STREAM.INFO.KV_mesh-delivery-gate_source")
|
||||||
|
for _, c := range []struct {
|
||||||
|
name string
|
||||||
|
err error
|
||||||
|
}{{"refused", refusal}, {"not answered", context.DeadlineExceeded}} {
|
||||||
|
var said []string
|
||||||
|
logf := func(f string, a ...any) { said = append(said, fmt.Sprintf(f, a...)) }
|
||||||
|
if kv := OptionalBucket(context.Background(), refusingBus{c.err}, "b", "b is not heard", logf); kv != nil {
|
||||||
|
t.Errorf("%s: an optional bucket answered %v", c.name, kv)
|
||||||
|
}
|
||||||
|
NotWatched(logf, "b", c.err, "b is not heard")
|
||||||
|
if len(said) != 2 || !strings.Contains(said[0], c.err.Error()) || !strings.Contains(said[1], "cannot be watched") {
|
||||||
|
t.Errorf("%s: said %q", c.name, said)
|
||||||
|
}
|
||||||
|
if _, err := EssentialBucket(context.Background(), refusingBus{c.err}, "builder", "b", "build"); err == nil ||
|
||||||
|
!strings.Contains(err.Error(), "grant of b") || !strings.Contains(err.Error(), "the builder cannot build") {
|
||||||
|
t.Errorf("%s: an essential bucket: %v", c.name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
for _, tc := range []struct {
|
for _, tc := range []struct {
|
||||||
field string
|
field string
|
||||||
values map[string]any
|
values map[string]any
|
||||||
@@ -82,3 +109,8 @@ func writeAccount(t *testing.T, fields map[string]any) string {
|
|||||||
}
|
}
|
||||||
return path
|
return path
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// refusingBus refuses every bucket with err.
|
||||||
|
type refusingBus struct{ err error }
|
||||||
|
|
||||||
|
func (r refusingBus) KeyValue(context.Context, string) (jetstream.KeyValue, error) { return nil, r.err }
|
||||||
|
|||||||
@@ -0,0 +1,55 @@
|
|||||||
|
package process
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/nats-io/nats.go/jetstream"
|
||||||
|
)
|
||||||
|
|
||||||
|
// **A part does not stop for a bucket it can work without** (novox/hq issue 1945, met twice on 2026-10-25: the delivery
|
||||||
|
// builder exited on a refused read of the gate's source and crash-looped). A grant reaches the bus with a delivery, so a
|
||||||
|
// bucket, a watch or a consumer the bus refuses, or times out on, at start is often only not granted yet: exiting for it
|
||||||
|
// stops the part until a person's hand. A part opens what it cannot do its job at all without with EssentialBucket, which
|
||||||
|
// stops its start with an error naming the bucket and its grant, and everything else with OptionalBucket, which says what
|
||||||
|
// is not heard and goes on; a watch the bus refuses on an optional bucket is said with NotWatched. Here, beside State,
|
||||||
|
// because this is where a process opens what it keeps and reads on the bus; the parts that open buckets with their own
|
||||||
|
// JetStream (the delivery parts) take the same three.
|
||||||
|
|
||||||
|
// BucketOpener is the part of the bus a start opens buckets with: a jetstream.JetStream, or a test's fake.
|
||||||
|
type BucketOpener interface {
|
||||||
|
KeyValue(ctx context.Context, bucket string) (jetstream.KeyValue, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EssentialBucket opens a bucket part cannot work without (it cannot `does` without it); its error is EssentialErr's.
|
||||||
|
func EssentialBucket(ctx context.Context, js BucketOpener, part, name, does string) (jetstream.KeyValue, error) {
|
||||||
|
kv, err := js.KeyValue(ctx, name)
|
||||||
|
if err != nil {
|
||||||
|
return nil, EssentialErr(part, name, does, err)
|
||||||
|
}
|
||||||
|
return kv, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// EssentialErr is the error of a bucket, consumer or stream named name that part cannot work without: it says what part
|
||||||
|
// cannot do, that it stops, and the grant to look at.
|
||||||
|
func EssentialErr(part, name, does string, err error) error {
|
||||||
|
return fmt.Errorf("%s cannot be read (%v): the %s cannot %s without it, so it stops; where the bus refused it or did not "+
|
||||||
|
"answer, this module's grant of %s (its manifest's reads, state or consumes, issued with its credential) has not "+
|
||||||
|
"reached the bus yet", name, err, part, does, name)
|
||||||
|
}
|
||||||
|
|
||||||
|
// OptionalBucket opens a bucket the part works without: any error is said with what is not heard (without), and nil
|
||||||
|
// answered.
|
||||||
|
func OptionalBucket(ctx context.Context, js BucketOpener, name, without string, logf func(string, ...any)) jetstream.KeyValue {
|
||||||
|
kv, err := js.KeyValue(ctx, name)
|
||||||
|
if err != nil {
|
||||||
|
logf("the bucket %s cannot be read (%v): %s", name, err, without)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return kv
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotWatched says that an optional bucket opened but its watch was refused or not answered: what is not heard.
|
||||||
|
func NotWatched(logf func(string, ...any), name string, err error, without string) {
|
||||||
|
logf("the bucket %s cannot be watched (%v): %s", name, err, without)
|
||||||
|
}
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
These tests read files outside this directory (the whole catalogue, the repository, or its root files): mesh-build-go never keeps this package's verdict (issue 1935).
|
||||||
@@ -24,7 +24,11 @@ func Version() string {
|
|||||||
|
|
||||||
// FromBuildInfo reads the SDK's version out of a build info. A dependency replaced by another module version is that
|
// FromBuildInfo reads the SDK's version out of a build info. A dependency replaced by another module version is that
|
||||||
// version; replaced by a local path it is the path, never empty. When the SDK is the main module it is "(devel)",
|
// version; replaced by a local path it is the path, never empty. When the SDK is the main module it is "(devel)",
|
||||||
// followed by a space and the vcs.revision when the build stamped one. Without the SDK in the build it is "unknown".
|
// followed by a space and the vcs.revision when the build stamped one. An SDK command built from another module that
|
||||||
|
// requires the SDK (`go build git.novox.be/novox/mesh-sdk/go/cmd/mesh-compose` in a reader's tree, as mesh-build-go's
|
||||||
|
// compose job builds it: novox/hq ADR 0482 clause 5) has the SDK as its main module at the version that module pins,
|
||||||
|
// read from the module cache with no vcs stamp: it is that version, never a bare "(devel)" that names no SDK. Without
|
||||||
|
// the SDK in the build it is "unknown".
|
||||||
func FromBuildInfo(bi *debug.BuildInfo) string {
|
func FromBuildInfo(bi *debug.BuildInfo) string {
|
||||||
if bi == nil {
|
if bi == nil {
|
||||||
return "unknown"
|
return "unknown"
|
||||||
@@ -35,6 +39,9 @@ func FromBuildInfo(bi *debug.BuildInfo) string {
|
|||||||
return "(devel) " + s.Value
|
return "(devel) " + s.Value
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if v := bi.Main.Version; v != "" && v != "(devel)" {
|
||||||
|
return v
|
||||||
|
}
|
||||||
return "(devel)"
|
return "(devel)"
|
||||||
}
|
}
|
||||||
for _, d := range bi.Deps {
|
for _, d := range bi.Deps {
|
||||||
|
|||||||
@@ -42,6 +42,18 @@ func TestTheMainModuleIsDevelWithItsRevision(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The shape go gives `go build <the SDK's command>` run in a module that requires the SDK (captured with go1.27 from
|
||||||
|
// mesh-compose built in a reader's tree at bc0c25e51052: "mod git.novox.be/novox/mesh-sdk/go v0.1.14-…-bc0c25e51052",
|
||||||
|
// no vcs settings): the SDK is the main module at the pinned version, which names the SDK the binary carries.
|
||||||
|
func TestAnSDKCommandBuiltFromAReaderIsThePinnedVersion(t *testing.T) {
|
||||||
|
bi := &debug.BuildInfo{Path: sdkPath + "/cmd/mesh-compose",
|
||||||
|
Main: debug.Module{Path: sdkPath, Version: "v0.1.14-0.20261024112544-bc0c25e51052"},
|
||||||
|
Settings: []debug.BuildSetting{{Key: "-trimpath", Value: "true"}, {Key: "CGO_ENABLED", Value: "0"}}}
|
||||||
|
if got := FromBuildInfo(bi); got != "v0.1.14-0.20261024112544-bc0c25e51052" {
|
||||||
|
t.Fatalf("got %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestNoBuildInfoIsUnknown(t *testing.T) {
|
func TestNoBuildInfoIsUnknown(t *testing.T) {
|
||||||
if got := FromBuildInfo(nil); got != "unknown" {
|
if got := FromBuildInfo(nil); got != "unknown" {
|
||||||
t.Fatalf("got %q", got)
|
t.Fatalf("got %q", got)
|
||||||
|
|||||||
+55
@@ -69,6 +69,61 @@ func SeatTake(worker string, handle func(Work) error) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Pulled is one message a bundle pulled from a seat's worker (SeatPull), named by the runtime's id for it, which
|
||||||
|
// SeatSettle gives its fate.
|
||||||
|
type Pulled struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Worker string `json:"worker"`
|
||||||
|
Subject string `json:"subject"`
|
||||||
|
Body json.RawMessage `json:"body"`
|
||||||
|
Headers map[string]string `json:"headers,omitempty"`
|
||||||
|
Delivered uint64 `json:"delivered"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// The fates SeatSettle gives a pulled message: done, handed back to be delivered again, dropped, or still being worked.
|
||||||
|
const (
|
||||||
|
SettleAck = "ack"
|
||||||
|
SettleNak = "nak"
|
||||||
|
SettleTerm = "term"
|
||||||
|
SettleProgress = "progress"
|
||||||
|
)
|
||||||
|
|
||||||
|
// SeatPull pulls at most one message from a held seat's worker the module's membership lists, waiting at most wait
|
||||||
|
// (none when 0, at most 25 s): nil when none came. Unlike SeatTake nothing is fetched ahead: a build module pulls an
|
||||||
|
// ask only when it has a free slot (novox/hq ADR 0525 §4; issue 1887 A11). A message never settled is delivered again
|
||||||
|
// by the worker's acknowledgement wait.
|
||||||
|
func SeatPull(worker string, wait time.Duration) (*Pulled, error) {
|
||||||
|
c, err := live()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
raw, err := c.ask("mesh/seat.pull", map[string]any{"worker": worker, "wait_ms": wait.Milliseconds()}, seatTimeout)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if len(raw) == 0 || string(raw) == "null" {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
var p Pulled
|
||||||
|
if err := json.Unmarshal(raw, &p); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if p.ID == "" {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
return &p, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SeatSettle gives the message pulled under id its fate (SettleAck, SettleNak, SettleTerm, SettleProgress).
|
||||||
|
func SeatSettle(id, fate string) error {
|
||||||
|
c, err := live()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
_, err = c.ask("mesh/seat.settle", map[string]any{"id": id, "fate": fate}, seatTimeout)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
// SeatRecord reads one key of a record a seat keeps for this module, under its own name, or nil.
|
// SeatRecord reads one key of a record a seat keeps for this module, under its own name, or nil.
|
||||||
func SeatRecord(bucket, key string) (*StateEntry, error) {
|
func SeatRecord(bucket, key string) (*StateEntry, error) {
|
||||||
c, err := live()
|
c, err := live()
|
||||||
|
|||||||
@@ -0,0 +1,65 @@
|
|||||||
|
package stdio
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bufio"
|
||||||
|
"encoding/json"
|
||||||
|
"io"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// 1887/A11: a bundle pulls one message through its runtime, naming the worker and the wait, and settles it by the id the
|
||||||
|
// runtime gave.
|
||||||
|
func TestABundlePullsAndSettlesThroughTheRuntime(t *testing.T) {
|
||||||
|
t.Setenv(ServedAs, "mesh-build-go")
|
||||||
|
inR, inW := io.Pipe()
|
||||||
|
outR, outW := io.Pipe()
|
||||||
|
got := make(chan *Pulled, 1)
|
||||||
|
go func() {
|
||||||
|
_ = ServeOn("", []Tool{{Name: "start", Run: func(map[string]any) (any, error) {
|
||||||
|
p, err := SeatPull("SEAT_NODE_BUILD_GO_DELIVERY_worker", 1500*time.Millisecond)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
got <- p
|
||||||
|
return map[string]any{}, SeatSettle(p.ID, SettleAck)
|
||||||
|
}}}, inR, outW)
|
||||||
|
}()
|
||||||
|
lines := bufio.NewScanner(outR)
|
||||||
|
next := func() map[string]any {
|
||||||
|
done := make(chan map[string]any, 1)
|
||||||
|
go func() {
|
||||||
|
if lines.Scan() {
|
||||||
|
var m map[string]any
|
||||||
|
_ = json.Unmarshal(lines.Bytes(), &m)
|
||||||
|
done <- m
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case m := <-done:
|
||||||
|
return m
|
||||||
|
case <-time.After(3 * time.Second):
|
||||||
|
t.Fatal("the bundle said nothing")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
send := func(m map[string]any) { b, _ := json.Marshal(m); _, _ = inW.Write(append(b, '\n')) }
|
||||||
|
send(map[string]any{"jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": map[string]any{"name": "start"}})
|
||||||
|
asked := next()
|
||||||
|
params, _ := asked["params"].(map[string]any)
|
||||||
|
if asked["method"] != "mesh/seat.pull" || params["worker"] != "SEAT_NODE_BUILD_GO_DELIVERY_worker" || params["wait_ms"] != 1500.0 {
|
||||||
|
t.Fatalf("asked %v", asked)
|
||||||
|
}
|
||||||
|
send(map[string]any{"jsonrpc": "2.0", "id": asked["id"], "result": map[string]any{"id": "p1", "worker": "SEAT_NODE_BUILD_GO_DELIVERY_worker",
|
||||||
|
"subject": "mesh.seat.node-build-go.accept.delivery", "body": map[string]any{"v": 1}, "delivered": 1}})
|
||||||
|
p := <-got
|
||||||
|
if p.ID != "p1" || string(p.Body) != `{"v":1}` {
|
||||||
|
t.Fatalf("pulled %+v", p)
|
||||||
|
}
|
||||||
|
asked = next()
|
||||||
|
params, _ = asked["params"].(map[string]any)
|
||||||
|
if asked["method"] != "mesh/seat.settle" || params["id"] != "p1" || params["fate"] != "ack" {
|
||||||
|
t.Fatalf("settled %v", asked)
|
||||||
|
}
|
||||||
|
send(map[string]any{"jsonrpc": "2.0", "id": asked["id"], "result": map[string]any{}})
|
||||||
|
}
|
||||||
@@ -154,8 +154,15 @@ const CodeChanged = -32010
|
|||||||
var (
|
var (
|
||||||
current *channel
|
current *channel
|
||||||
currentMu sync.Mutex
|
currentMu sync.Mutex
|
||||||
|
// served is closed once Serve has the runtime's channel (Served).
|
||||||
|
served = make(chan struct{})
|
||||||
|
servedOnce sync.Once
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Served is closed once Serve has the runtime's channel, so code started before Serve can wait for it instead of
|
||||||
|
// asking again until the runtime takes it: a watch of a config value, a subscribe.
|
||||||
|
func Served() <-chan struct{} { return served }
|
||||||
|
|
||||||
// Serve answers the runtime on stdin and stdout until stdin closes. An empty name serves as the
|
// Serve answers the runtime on stdin and stdout until stdin closes. An empty name serves as the
|
||||||
// module the runtime named in MESH_SERVED_MODULE.
|
// module the runtime named in MESH_SERVED_MODULE.
|
||||||
func Serve(name string, tools []Tool) error {
|
func Serve(name string, tools []Tool) error {
|
||||||
@@ -180,6 +187,7 @@ func ServeOn(name string, tools []Tool, in io.Reader, out io.Writer) error {
|
|||||||
currentMu.Lock()
|
currentMu.Lock()
|
||||||
current = c
|
current = c
|
||||||
currentMu.Unlock()
|
currentMu.Unlock()
|
||||||
|
servedOnce.Do(func() { close(served) })
|
||||||
// What the bundle said it keeps is announced once it serves: the runtime answers the publish on this channel, so
|
// What the bundle said it keeps is announced once it serves: the runtime answers the publish on this channel, so
|
||||||
// it is asked from beside the loop that reads the answer.
|
// it is asked from beside the loop that reads the answer.
|
||||||
go func() { _ = announce1() }()
|
go func() { _ = announce1() }()
|
||||||
|
|||||||
@@ -16,6 +16,22 @@ func TestABundleEmitsThroughTheRuntimeAndServesAsItsModule(t *testing.T) {
|
|||||||
t.Setenv(ServedAs, "chime")
|
t.Setenv(ServedAs, "chime")
|
||||||
t.Setenv("MESH_MODULE", "chime")
|
t.Setenv("MESH_MODULE", "chime")
|
||||||
t.Setenv("MESH_NODE", "anchor")
|
t.Setenv("MESH_NODE", "anchor")
|
||||||
|
// 1887/AC-wake: Served closes once Serve has the runtime's channel, not before; the globals are put back after.
|
||||||
|
oldServed := served
|
||||||
|
served, servedOnce = make(chan struct{}), sync.Once{}
|
||||||
|
t.Cleanup(func() {
|
||||||
|
served, servedOnce = oldServed, sync.Once{}
|
||||||
|
select {
|
||||||
|
case <-oldServed: // it was closed: its Once is spent too
|
||||||
|
servedOnce.Do(func() {})
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
})
|
||||||
|
select {
|
||||||
|
case <-Served():
|
||||||
|
t.Fatal("Served closed before Serve")
|
||||||
|
default:
|
||||||
|
}
|
||||||
inR, inW := io.Pipe()
|
inR, inW := io.Pipe()
|
||||||
outR, outW := io.Pipe()
|
outR, outW := io.Pipe()
|
||||||
go func() {
|
go func() {
|
||||||
@@ -50,6 +66,11 @@ func TestABundleEmitsThroughTheRuntimeAndServesAsItsModule(t *testing.T) {
|
|||||||
if got := next()["result"].(map[string]any)["serverInfo"].(map[string]any)["name"]; got != "chime" {
|
if got := next()["result"].(map[string]any)["serverInfo"].(map[string]any)["name"]; got != "chime" {
|
||||||
t.Fatalf("served as %v, want the module the runtime named", got)
|
t.Fatalf("served as %v, want the module the runtime named", got)
|
||||||
}
|
}
|
||||||
|
select {
|
||||||
|
case <-Served():
|
||||||
|
case <-time.After(2 * time.Second):
|
||||||
|
t.Fatal("Served did not close once serving")
|
||||||
|
}
|
||||||
send(map[string]any{"jsonrpc": "2.0", "id": 2, "method": "tools/call", "params": map[string]any{"name": "ring", "arguments": map[string]any{}}})
|
send(map[string]any{"jsonrpc": "2.0", "id": 2, "method": "tools/call", "params": map[string]any{"name": "ring", "arguments": map[string]any{}}})
|
||||||
asked := next()
|
asked := next()
|
||||||
if asked["method"] != "mesh/publish" {
|
if asked["method"] != "mesh/publish" {
|
||||||
|
|||||||
@@ -1,27 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
# mesh-check-toolchain: typescript
|
|
||||||
# mesh-check-also: go go/merge-check.sh
|
|
||||||
#
|
|
||||||
# The SDK's own check (novox/hq ADR 0237 as amended): the second layer of a pull request's merge check,
|
|
||||||
# `mesh/repo-check`, run by the build seat in the mesh's TypeScript toolchain — and by hand.
|
|
||||||
#
|
|
||||||
# The gate is the build seat's first layer (`mesh/merge-gate`), run because the mesh's module graph builds
|
|
||||||
# mesh-sdk from here — and every module whose build packages it. This is the SDK's own: the TypeScript
|
|
||||||
# spine every module imports, type-checked and its suite run, its dependencies installed from the lock
|
|
||||||
# file alone (public packages: the SDK depends on nothing of the mesh's).
|
|
||||||
#
|
|
||||||
# **Said, never passed silently**: the Python, Rust and C bindings are not tested in any toolchain. The Go
|
|
||||||
# binding runs in the Go toolchain, from go/merge-check.sh, declared on the second line (novox/hq ADR 0272); here
|
|
||||||
# it runs only when a Go compiler is present (a person's run).
|
|
||||||
set -eu
|
|
||||||
|
|
||||||
npm ci --no-audit --no-fund --loglevel=error
|
|
||||||
node node_modules/typescript/bin/tsc --noEmit
|
|
||||||
npm test
|
|
||||||
|
|
||||||
if command -v go >/dev/null 2>&1; then
|
|
||||||
sh go/merge-check.sh
|
|
||||||
else
|
|
||||||
echo "NOT TESTED HERE: go/ (the Go binding) — the Go toolchain runs it from go/merge-check.sh"
|
|
||||||
fi
|
|
||||||
echo "NOT TESTED HERE: python/, rust/, c/ — no toolchain of theirs runs a merge check"
|
|
||||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "@novox/mesh-sdk",
|
"name": "@novox/mesh-sdk",
|
||||||
"version": "0.1.15",
|
"version": "0.1.17",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "@novox/mesh-sdk",
|
"name": "@novox/mesh-sdk",
|
||||||
"version": "0.1.15",
|
"version": "0.1.17",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/node": "^22.0.0",
|
"@types/node": "^22.0.0",
|
||||||
"typescript": "^5.6.0"
|
"typescript": "^5.6.0"
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
0.1.17 90cca0bf1acfb386d66ccddb9f612703cf8f0205791b846982a524d0044aa0fb
|
||||||
+2
-1
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@novox/mesh-sdk",
|
"name": "@novox/mesh-sdk",
|
||||||
"version": "0.1.15",
|
"version": "0.1.17",
|
||||||
"description": "The stable spine a Novox Mesh module's own code builds against.",
|
"description": "The stable spine a Novox Mesh module's own code builds against.",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"exports": {
|
"exports": {
|
||||||
@@ -21,6 +21,7 @@
|
|||||||
],
|
],
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsc",
|
"build": "tsc",
|
||||||
|
"pretest": "tsc --noEmit",
|
||||||
"test": "node --test --experimental-strip-types 'test/*.test.ts'",
|
"test": "node --test --experimental-strip-types 'test/*.test.ts'",
|
||||||
"prepare": "tsc"
|
"prepare": "tsc"
|
||||||
},
|
},
|
||||||
|
|||||||
Reference in New Issue
Block a user