diff --git a/checks/environment/main.go b/checks/environment/main.go index e8cd65a69..2ffb4b89a 100644 --- a/checks/environment/main.go +++ b/checks/environment/main.go @@ -77,6 +77,7 @@ func Check(root string) (map[string]map[string][]string, error) { } set := map[string]bool{} setBy(manifest, set) + settingWords(manifest, set) reads := map[string]map[string]bool{} consts := map[string]map[string]string{} // directory -> constant -> word var goFiles []string @@ -180,6 +181,17 @@ func setBy(v any, set map[string]bool) { } } +// settingWords collects the words the node-engine composes for every setting the manifest's `config` declares, +// MESH_CONFIG_, the key upper-cased with '-' and '.' as '_', into the module's processes and its tool runner slice +// alike (design 47 H2 §781; H-A-370, H-A-400 (2)). +func settingWords(v any, set map[string]bool) { + m, _ := v.(map[string]any) + config, _ := m["config"].(map[string]any) + for key := range config { + set["MESH_CONFIG_"+strings.NewReplacer("-", "_", ".", "_").Replace(strings.ToUpper(key))] = true + } +} + // Listed is the list's ` ` lines; a line starting with # and a blank line are not entries. func Listed(path string) (map[string]bool, error) { f, err := os.Open(path) diff --git a/checks/environment/main_test.go b/checks/environment/main_test.go index f79842cd1..fd69078e7 100644 --- a/checks/environment/main_test.go +++ b/checks/environment/main_test.go @@ -32,13 +32,14 @@ func module(t *testing.T, root, name, manifest string, files map[string]string) // not; tests, node_modules and dist are not read. func TestAWordReadThatNothingSetsIsFound(t *testing.T) { root := t.TempDir() - module(t, root, "reader", `{"module":"reader","build":{"artifacts":[{"name":"tools","env":{"MESH_SET":"x"}}]},`+ + module(t, root, "reader", `{"module":"reader","config":{"ask-taken-bound":{"type":"string"}},"build":{"artifacts":[{"name":"tools","env":{"MESH_SET":"x"}}]},`+ `"resources":[{"id":"p","type":"process","environment":{"variables":{"MESH_VARIABLE":"y"}}}]}`, map[string]string{ - "cmd/a/main.go": `package main; const reach = "MESH_REACH"; var _ = os.Getenv(reach); var _ = os.Getenv("MESH_SET")`, - "cmd/a/other.go": `package main; var _, _ = os.LookupEnv("MESH_LITERAL"); var _ = os.Getenv("MESH_MODULE")`, - "cmd/a/write.go": `package main; var _ = []string{"MESH_WRITTEN_FOR_A_CHILD=1"}`, - "cmd/a/a_test.go": `package main; var _ = os.Getenv("MESH_IN_A_TEST")`, - "client.ts": `const a = process.env.MESH_TS ?? "d"; const b = env["MESH_BRACKET"]; const c = env.MESH_VARIABLE;`, + "cmd/a/main.go": `package main; const reach = "MESH_REACH"; var _ = os.Getenv(reach); var _ = os.Getenv("MESH_SET")`, + "cmd/a/other.go": `package main; var _, _ = os.LookupEnv("MESH_LITERAL"); var _ = os.Getenv("MESH_MODULE")`, + "cmd/a/write.go": `package main; var _ = []string{"MESH_WRITTEN_FOR_A_CHILD=1"}`, + "cmd/a/a_test.go": `package main; var _ = os.Getenv("MESH_IN_A_TEST")`, + // 47 H2 §781, H-A-370: a declared setting's word, which the node-engine composes; one undeclared is set by nothing. + "client.ts": `const a = process.env.MESH_TS ?? "d"; const b = env["MESH_BRACKET"]; const c = env.MESH_VARIABLE; const d = env.MESH_CONFIG_ASK_TAKEN_BOUND; const e = env.MESH_CONFIG_UNDECLARED;`, "files/env": "MESH_FROM_FILE=${config:x}\n", "index.ts": `const f = env.MESH_FROM_FILE;`, "test/x.test.ts": `env.MESH_IN_A_TEST_DIR`, @@ -50,16 +51,17 @@ func TestAWordReadThatNothingSetsIsFound(t *testing.T) { t.Fatal(err) } want := map[string]map[string][]string{"reader": { - "MESH_REACH": {"cmd/a/main.go"}, - "MESH_LITERAL": {"cmd/a/other.go"}, - "MESH_TS": {"client.ts"}, - "MESH_BRACKET": {"client.ts"}, + "MESH_REACH": {"cmd/a/main.go"}, + "MESH_LITERAL": {"cmd/a/other.go"}, + "MESH_TS": {"client.ts"}, + "MESH_BRACKET": {"client.ts"}, + "MESH_CONFIG_UNDECLARED": {"client.ts"}, }} if !reflect.DeepEqual(got, want) { t.Fatalf("found %v, want %v", got, want) } refused, stale := Judge(got, map[string]bool{"reader MESH_REACH": true, "reader MESH_GONE": true}) - if !reflect.DeepEqual(refused, []string{"reader MESH_BRACKET", "reader MESH_LITERAL", "reader MESH_TS"}) || + if !reflect.DeepEqual(refused, []string{"reader MESH_BRACKET", "reader MESH_CONFIG_UNDECLARED", "reader MESH_LITERAL", "reader MESH_TS"}) || !reflect.DeepEqual(stale, []string{"reader MESH_GONE"}) { t.Errorf("refused %v, stale %v", refused, stale) } diff --git a/modules/adwaita/module.json b/modules/adwaita/module.json index b47fbf37e..44bbe78dd 100644 --- a/modules/adwaita/module.json +++ b/modules/adwaita/module.json @@ -1,6 +1,7 @@ { "module": "adwaita", "version": "0.1", + "class": "leaf", "moved": true, "capabilities": [ "package-manager" diff --git a/modules/artifact-store-tools/module.json b/modules/artifact-store-tools/module.json index 5ed0d1b66..26622f54e 100644 --- a/modules/artifact-store-tools/module.json +++ b/modules/artifact-store-tools/module.json @@ -1,6 +1,7 @@ { "module": "artifact-store-tools", "version": "0.1", + "class": "core", "packages": { "git.novox.be/novox/mesh-delivery/modules/mesh-delivery-builder/builds": "0.1" }, @@ -111,7 +112,10 @@ { "name": "findings", "storage": "key-value", - "template": "state" + "template": "state", + "options": { + "max-mib": 8 + } }, { "name": "finding-events", @@ -124,7 +128,7 @@ "findings-stated.*" ], "max-age-days": 7, - "max-mib": 16 + "max-mib": 8 } } ] diff --git a/modules/asus-zephyrus-g14/module.json b/modules/asus-zephyrus-g14/module.json index b5152b6d7..4055b81cd 100644 --- a/modules/asus-zephyrus-g14/module.json +++ b/modules/asus-zephyrus-g14/module.json @@ -1,6 +1,7 @@ { "module": "asus-zephyrus-g14", "version": "0.1", + "class": "leaf", "moved": true, "templates": "templates", "capabilities": [ diff --git a/modules/audit-logger/module.json b/modules/audit-logger/module.json index 2ed839dce..4314b5af2 100644 --- a/modules/audit-logger/module.json +++ b/modules/audit-logger/module.json @@ -1,6 +1,7 @@ { "module": "audit-logger", "version": "0.1", + "class": "leaf", "slug": "audit", "consumes": [ "**" diff --git a/modules/avahi/module.json b/modules/avahi/module.json index 01731ee6e..b73cbcca7 100644 --- a/modules/avahi/module.json +++ b/modules/avahi/module.json @@ -1,6 +1,7 @@ { "module": "avahi", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager", "service-manager" diff --git a/modules/baserow/module.json b/modules/baserow/module.json index f92a50402..ef7de33b6 100644 --- a/modules/baserow/module.json +++ b/modules/baserow/module.json @@ -1,6 +1,7 @@ { "module": "baserow", "version": "0.1", + "class": "leaf", "capabilities": [ "container-runtime" ], diff --git a/modules/blueman/module.json b/modules/blueman/module.json index 8a79ba2d6..c896e7afb 100644 --- a/modules/blueman/module.json +++ b/modules/blueman/module.json @@ -1,6 +1,7 @@ { "module": "blueman", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager" ], diff --git a/modules/bluetooth/module.json b/modules/bluetooth/module.json index 6ee44cb77..8d908e6b5 100644 --- a/modules/bluetooth/module.json +++ b/modules/bluetooth/module.json @@ -1,6 +1,7 @@ { "module": "bluetooth", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager", "service-manager" diff --git a/modules/brother/module.json b/modules/brother/module.json index e1c1f7ae1..158ea6898 100644 --- a/modules/brother/module.json +++ b/modules/brother/module.json @@ -1,6 +1,7 @@ { "module": "brother", "version": "0.1", + "class": "core", "requires": [ { "name": "s3-bucket", diff --git a/modules/buildah/module.json b/modules/buildah/module.json index 4e97d7cdd..4f2cdad59 100644 --- a/modules/buildah/module.json +++ b/modules/buildah/module.json @@ -1,6 +1,7 @@ { "module": "buildah", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager", "user-namespaces" diff --git a/modules/ca-trust/module.json b/modules/ca-trust/module.json index 88602b90a..eed1faf32 100644 --- a/modules/ca-trust/module.json +++ b/modules/ca-trust/module.json @@ -1,6 +1,7 @@ { "module": "ca-trust", "version": "0.1", + "class": "core", "slug": "catrust", "capabilities": [ "service-manager" diff --git a/modules/claude-code/module.json b/modules/claude-code/module.json index 73ae6b48b..fd0a9fc56 100644 --- a/modules/claude-code/module.json +++ b/modules/claude-code/module.json @@ -1,6 +1,7 @@ { "module": "claude-code", "version": "0.1", + "class": "leaf", "moved": true, "slug": "agent", "capabilities": [ @@ -23,7 +24,7 @@ "findings-stated.*" ], "max-age-days": 7, - "max-mib": 16 + "max-mib": 8 } }, { diff --git a/modules/claude-licence-manager/module.json b/modules/claude-licence-manager/module.json index 62145c08b..5b6c70668 100644 --- a/modules/claude-licence-manager/module.json +++ b/modules/claude-licence-manager/module.json @@ -1,6 +1,7 @@ { "module": "claude-licence-manager", "version": "0.1", + "class": "core", "slug": "licmgr", "runs-as": "claude-licence-manager", "requires": [ diff --git a/modules/clipmenu/module.json b/modules/clipmenu/module.json index 1c59e061b..168f925de 100644 --- a/modules/clipmenu/module.json +++ b/modules/clipmenu/module.json @@ -1,6 +1,7 @@ { "module": "clipmenu", "version": "0.1", + "class": "core", "moved": true, "capabilities": [ "package-manager" diff --git a/modules/confluence/module.json b/modules/confluence/module.json index 3580e2d1f..26dbb3333 100644 --- a/modules/confluence/module.json +++ b/modules/confluence/module.json @@ -1,6 +1,7 @@ { "module": "confluence", "version": "0.1", + "class": "leaf", "slug": "confl", "own-secrets": { "token": "${dir:state}/token" diff --git a/modules/cups/module.json b/modules/cups/module.json index a11903c28..2156e3bbc 100644 --- a/modules/cups/module.json +++ b/modules/cups/module.json @@ -1,6 +1,7 @@ { "module": "cups", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager", "service-manager" diff --git a/modules/dbus/module.json b/modules/dbus/module.json index e71f5100a..9bdd57ba8 100644 --- a/modules/dbus/module.json +++ b/modules/dbus/module.json @@ -1,6 +1,7 @@ { "module": "dbus", "version": "0.1", + "class": "core", "capabilities": [ "package-manager", "service-manager" diff --git a/modules/desk-channel/module.json b/modules/desk-channel/module.json index 562945690..bf8b4487a 100644 --- a/modules/desk-channel/module.json +++ b/modules/desk-channel/module.json @@ -1,6 +1,7 @@ { "module": "desk-channel", "version": "0.1", + "class": "core", "slug": "desk", "runs-as": "desk-channel", "claims": [ diff --git a/modules/dev-tools/module.json b/modules/dev-tools/module.json index 0505c8666..754963765 100644 --- a/modules/dev-tools/module.json +++ b/modules/dev-tools/module.json @@ -1,6 +1,7 @@ { "module": "dev-tools", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager" ], diff --git a/modules/disk-load/module.json b/modules/disk-load/module.json index a2798476a..f19a46849 100644 --- a/modules/disk-load/module.json +++ b/modules/disk-load/module.json @@ -1,6 +1,7 @@ { "module": "disk-load", "version": "0.1", + "class": "leaf", "tools": [ "disk_load", "disk_top", diff --git a/modules/dmenu/module.json b/modules/dmenu/module.json index 61986d1e2..71d0c4172 100644 --- a/modules/dmenu/module.json +++ b/modules/dmenu/module.json @@ -1,6 +1,7 @@ { "module": "dmenu", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager" ], diff --git a/modules/dnsmasq/module.json b/modules/dnsmasq/module.json index 2318baa09..8516bb620 100644 --- a/modules/dnsmasq/module.json +++ b/modules/dnsmasq/module.json @@ -1,6 +1,7 @@ { "module": "dnsmasq", "version": "0.1", + "class": "core", "upgrade": { "policy": "record", "why": "the mesh's resolver: a build that breaks it can stop a machine resolving the bus, and then neither the gate's rollback nor a push reaches it (hq ADR 0236, issue 260)" diff --git a/modules/docker-compose/module.json b/modules/docker-compose/module.json index 7ace4b8ce..92caf5835 100644 --- a/modules/docker-compose/module.json +++ b/modules/docker-compose/module.json @@ -1,6 +1,7 @@ { "module": "docker-compose", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager" ], diff --git a/modules/docker/module.json b/modules/docker/module.json index a51d21c9d..c4be0284b 100644 --- a/modules/docker/module.json +++ b/modules/docker/module.json @@ -1,6 +1,7 @@ { "module": "docker", "version": "0.1", + "class": "core", "capabilities": [ "package-manager", "service-manager", diff --git a/modules/dunst/module.json b/modules/dunst/module.json index 7321e05e7..7821e3f9d 100644 --- a/modules/dunst/module.json +++ b/modules/dunst/module.json @@ -1,6 +1,7 @@ { "module": "dunst", "version": "0.1", + "class": "core", "moved": true, "capabilities": [ "package-manager" diff --git a/modules/fail2ban/module.json b/modules/fail2ban/module.json index 7e5008ab3..1fe831870 100644 --- a/modules/fail2ban/module.json +++ b/modules/fail2ban/module.json @@ -1,6 +1,7 @@ { "module": "fail2ban", "version": "0.1", + "class": "core", "capabilities": [ "firewall" ], diff --git a/modules/feh/module.json b/modules/feh/module.json index 14de69d04..49dada45b 100644 --- a/modules/feh/module.json +++ b/modules/feh/module.json @@ -1,6 +1,7 @@ { "module": "feh", "version": "0.1", + "class": "leaf", "moved": true, "capabilities": [ "package-manager" diff --git a/modules/flatpak/module.json b/modules/flatpak/module.json index d7fc53c52..da3d6ae04 100644 --- a/modules/flatpak/module.json +++ b/modules/flatpak/module.json @@ -1,6 +1,7 @@ { "module": "flatpak", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager" ], diff --git a/modules/fonts/module.json b/modules/fonts/module.json index cac0dc2d9..14b7463c2 100644 --- a/modules/fonts/module.json +++ b/modules/fonts/module.json @@ -1,6 +1,7 @@ { "module": "fonts", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager" ], diff --git a/modules/forticlient/module.json b/modules/forticlient/module.json index 24ce2f444..c849b0fe4 100644 --- a/modules/forticlient/module.json +++ b/modules/forticlient/module.json @@ -1,6 +1,7 @@ { "module": "forticlient", "version": "0.1", + "class": "leaf", "upgrade": { "policy": "record", "why": "its adapter routes the company's domains on the machine a person works on: a build that breaks it cuts the person off from work names until a person pushes the next (hq ADR 0236, ADR 0247)" diff --git a/modules/gitea/README.md b/modules/gitea/README.md index c946a02b0..321c54e1f 100644 --- a/modules/gitea/README.md +++ b/modules/gitea/README.md @@ -100,7 +100,8 @@ search that reaches the call's deadline stops there and answers what it found, w It reaches the forge through the same HTTP client as the package-registry bundle (`internal/forgehttp`), as the tools' own account (novox/hq ADR 0365 §2, issue 469): the token the TypeScript bundle mints for `mesh-tools` and -keeps (`MESH_GITEA_TOKEN_FILE`), sent only when its scopes line names that account, never the admin login. One tool +keeps in the vault as the module's own (`module/gitea/mesh-tools`, design 47 H2 §808), read through the vault seat's +`get` at start and at each `secret-changed` naming it, never the admin login. One tool call takes at most 50 seconds. `go test ./cmd/forge` runs it against a fake forge: the files of one commit created, updated and deleted on a new branch from its base; an existing branch committed on; the default branch, a protected branch and @@ -247,9 +248,10 @@ version already gone counts as deleted. Over the forge's HTTP interface on the machine (`MESH_GITEA_URL`), never as the admin account (design 51: each holder keeps its write side as an own secret beside a read-only tool token). It **reads** as the tools' account, -with the token the TypeScript bundle keeps for it (`MESH_GITEA_TOKEN_FILE`, scopes including `read:package`), and -**writes** (a publish, a remove, retention's deletion) as the packages account `mesh-packages` -(`MESH_GITEA_PACKAGES_USER`), with its own token (`MESH_GITEA_PACKAGES_TOKEN_FILE`, the one scope `write:package`). +with the token the TypeScript bundle keeps for it in the vault (`module/gitea/mesh-tools`, scopes including +`read:package`), and **writes** (a publish, a remove, retention's deletion) as the packages account `mesh-packages` +(`MESH_GITEA_PACKAGES_USER`), with its own token (`module/gitea/mesh-packages`, the one scope `write:package`), both +read through the vault seat's `get` at start and at each `secret-changed` (design 47 H2 §808). That account is plain, a member of the team `mesh-packages` that writes the organisation's packages and nothing else; the watcher makes it with the administrator's login and mints and keeps its token at its start (`packages-account.ts`). No timer looks at it after that: when the forge refuses a write (401) this bundle raises the finding diff --git a/modules/gitea/client.ts b/modules/gitea/client.ts index 1b761a8b3..54c39d5d4 100644 --- a/modules/gitea/client.ts +++ b/modules/gitea/client.ts @@ -192,6 +192,9 @@ export class DirectoryNotInTree extends Error { } /** One request to the forge, cut at the limit and failing loud naming the request. */ +/** What a forge's answer says when its store does not answer (design 47 H2 §776). */ +const STORE_UNAVAILABLE = /database|\bdb\b|store/i; + async function timedFetch(url: string, init: RequestInit, label: string, timeoutMs: number): Promise { try { return await fetch(url, { ...init, signal: init.signal ? AbortSignal.any([init.signal, AbortSignal.timeout(timeoutMs)]) : AbortSignal.timeout(timeoutMs) }); @@ -276,6 +279,28 @@ export class GiteaClient { return this.request(path, options); } + /** + * The forge's own version read, unauthenticated (GET /api/v1/version): whether the forge answers at all, and whether + * it names its store unavailable (design 47 H2 §776). What the seat git reads before it says a 401, a 502, a 503 or a + * connection fault is the forge's refusal or the forge away; never throws. + */ + async forgeVersion(): Promise<{ ok: true; version: string } | { ok: false; words: string; store: boolean }> { + const label = "GET /version"; + try { + const res = await timedFetch(`${this.baseUrl}/api/v1/version`, { headers: { Accept: "application/json" } }, label, this.requestTimeoutMs); + const text = await res.text(); + const store = STORE_UNAVAILABLE.test(text); + if (!res.ok) return { ok: false, words: `the forge's version read answered ${res.status} ${text}`.trim(), store }; + let version = ""; + try { version = String(JSON.parse(text)?.version ?? ""); } catch { /* no version said */ } + if (store) return { ok: false, words: `the forge's version read names its store unavailable: ${text}`, store }; + if (!version) return { ok: false, words: `the forge's version read named no version: ${text}`, store }; + return { ok: true, version }; + } catch (err) { + return { ok: false, words: `the forge's version read: ${err instanceof Error ? err.message : String(err)}`, store: false }; + } + } + // ---- Repositories ---- /** Every repository this token can see, one page. `/user/repos` is only what the token's own @@ -499,11 +524,17 @@ export class GiteaClient { } /** One page of a repository's tags, newest first, by name: what the seat git's `tags` answers. */ - async tags(owner: string, repo: string, page: number, limit: number): Promise { + async tags(owner: string, repo: string, page: number, limit: number): Promise<{ tag: string; commit: string }[]> { if (!Number.isInteger(page) || page < 1) throw new Error(`${page} is not a page, from 1`); const list = await this.request(`${repoPath(owner, repo)}/tags?page=${page}&limit=${limit}`); if (!Array.isArray(list)) throw new Error(`the forge answered no list of the tags of ${owner}/${repo}`); - return list.map((t) => String(t?.name ?? "")).filter((n) => n !== ""); + // Each tag with the commit it names (design 47 H2 §796): a tag the forge names no commit for is no answer, never a + // tag without its commit. + return list.filter((t) => String(t?.name ?? "") !== "").map((t) => { + const tag = String(t.name), commit = String(t?.commit?.sha ?? ""); + if (!/^[0-9a-f]{40}$/.test(commit)) throw new Error(`the forge named no commit for ${owner}/${repo}'s tag ${tag}`); + return { tag, commit }; + }); } /** The commit a tag names, or null when the repository has no such tag (the forge's 404 only). */ diff --git a/modules/gitea/cmd/forge/account_test.go b/modules/gitea/cmd/forge/account_test.go index d37c6594d..f0995aa60 100644 --- a/modules/gitea/cmd/forge/account_test.go +++ b/modules/gitea/cmd/forge/account_test.go @@ -1,35 +1,54 @@ package main // The commit and the reads act as the tools' own account (novox/hq ADR 0365 §2, issue 469): the token the module -// keeps for `mesh-tools`, never the admin login. That account is no repository's administrator, so the forge +// keeps for `mesh-tools` in the vault (design 47 H2 §808), never the admin login. That account is no repository's administrator, so the forge // refuses it the protection rules (403, as gitea's reqAdmin does); the commit then judges an existing branch by the // protection the forge says it applies, and leaves a branch not made yet to the forge's own judgement. import ( "context" + "encoding/json" + "fmt" "net/http" "net/http/httptest" - "os" - "path/filepath" "strings" "testing" + "git.novox.be/novox/mesh-sdk/go/seal" + "gitea/internal/forgehttp" ) const toolsToken = "tools-token-never-shown" -// asTools serves the fake forge to a bundle holding the tools' token: only that token is taken, the rules are -// refused as to a non-administrator, and the branches named protected say so as the forge does. -func asTools(t *testing.T, f *fakeForge, protected map[string]string, scopes string) (*Forge, *[]string) { - dir := t.TempDir() - file := filepath.Join(dir, "token") - if err := os.WriteFile(file, []byte(toolsToken+"\n"), 0o600); err != nil { - t.Fatal(err) - } - if err := os.WriteFile(file+".scopes", []byte(scopes+"\n"), 0o600); err != nil { +// vaultHolding is the vault seat's get answering account's token sealed to the key it is asked with; "" holds none. +func vaultHolding(t *testing.T, account, token string) *forgehttp.VaultToken { + t.Helper() + v, err := forgehttp.NewVaultToken(account, func(address string, args any) (json.RawMessage, error) { + a := args.(map[string]any) + if address != forgehttp.VaultGet || a["name"] != forgehttp.VaultName(account) { + return nil, fmt.Errorf("asked %s for %v", address, a["name"]) + } + if token == "" { + return nil, fmt.Errorf("the vault holds no secret named %s", a["name"]) + } + // The value the minter writes: the token and the scopes it was minted with (H-A-439). + value, _ := json.Marshal(map[string]any{"token": token, "scopes": []string{"write:repository", "write:issue", "read:user", "read:package"}}) + box, err := seal.Seal(string(value), a["public_key"].(string)) + if err != nil { + return nil, err + } + return json.Marshal(map[string]any{"name": a["name"], "generation": 1, "sealed": box}) + }) + if err != nil { t.Fatal(err) } + return v +} + +// asTools serves the fake forge to a bundle holding the token the vault hands: only the tools' token is taken, the +// rules are refused as to a non-administrator, and the branches named protected say so as the forge does. +func asTools(t *testing.T, f *fakeForge, protected map[string]string, held string) (*Forge, *[]string) { var seen []string const repo = "/api/v1/repos/acme/app" srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { @@ -52,12 +71,12 @@ func asTools(t *testing.T, f *fakeForge, protected map[string]string, scopes str f.handle(w, r) })) t.Cleanup(srv.Close) - return &Forge{Client: forgehttp.Client{URL: srv.URL, TokenFile: file, Account: "mesh-tools"}}, &seen + return &Forge{Client: forgehttp.Client{URL: srv.URL, Token: vaultHolding(t, "mesh-tools", held), Account: "mesh-tools"}}, &seen } func TestTheToolsAccountCommitsOnANewBranchWithItsTokenThoughTheRulesAreNotItsToRead(t *testing.T) { f := newFake(t) - forge, _ := asTools(t, f, nil, "read:user,write:issue,write:repository for mesh-tools") + forge, _ := asTools(t, f, nil, toolsToken) got, err := commit(context.Background(), forge, ask(t, map[string]any{"branch": "fix/365", "files": filesArg(map[string]any{"path": "x", "content": "x"})})) if err != nil { @@ -75,7 +94,7 @@ func TestTheToolsAccountIsRefusedAProtectedBranchTheForgeSaysItGuardsAndTheDefau if rule != "" { protected[branch] = rule } - forge, _ := asTools(t, f, protected, "read:user,write:issue,write:repository for mesh-tools") + forge, _ := asTools(t, f, protected, toolsToken) _, err := commit(context.Background(), forge, ask(t, map[string]any{"branch": branch, "files": filesArg(map[string]any{"path": "x", "content": "x"})})) if err == nil || !strings.Contains(err.Error(), "refused") || !strings.Contains(err.Error(), "ADR 0266") { @@ -90,13 +109,13 @@ func TestTheToolsAccountIsRefusedAProtectedBranchTheForgeSaysItGuardsAndTheDefau } } -func TestATokenKeptForTheAdministratorIsNeverSent(t *testing.T) { +func TestNoTokenIsSentWhileTheVaultHoldsNoneForTheAccount(t *testing.T) { f := newFake(t) - // What the module kept before ADR 0365: the admin's token, its scopes line naming no account. - forge, seen := asTools(t, f, nil, "read:user,write:issue,write:repository") + // Design 47 H2 §808: the token is read through the vault seat's get; while the module has minted none, nothing goes. + forge, seen := asTools(t, f, nil, "") _, err := commit(context.Background(), forge, ask(t, map[string]any{"branch": "fix/365", "files": filesArg(map[string]any{"path": "x", "content": "x"})})) - if err == nil || !strings.Contains(err.Error(), "not mesh-tools's") { + if err == nil || !strings.Contains(err.Error(), "not kept yet") { t.Fatalf("%v", err) } if len(*seen) != 0 { @@ -104,9 +123,8 @@ func TestATokenKeptForTheAdministratorIsNeverSent(t *testing.T) { } } -func TestTheBundleHandedATokenFileNeedsNoAdminLogin(t *testing.T) { +func TestTheBundleReadsItsTokenFromTheVaultAndNeedsNoAdminLogin(t *testing.T) { t.Setenv("MESH_GITEA_URL", "http://127.0.0.1:3000") - t.Setenv("MESH_GITEA_TOKEN_FILE", "/state/token") t.Setenv("MESH_GITEA_TOOLS_USER", "") t.Setenv("MESH_GITEA_ADMIN_USER", "") t.Setenv("MESH_GITEA_ADMIN_PASSWORD_FILE", "") @@ -114,7 +132,7 @@ func TestTheBundleHandedATokenFileNeedsNoAdminLogin(t *testing.T) { if err != nil { t.Fatal(err) } - if f.TokenFile != "/state/token" || f.Account != "mesh-tools" || f.User != "" || f.PasswordFile != "" { + if f.Token == nil || f.Token.Account != "mesh-tools" || f.Account != "mesh-tools" || f.User != "" || f.PasswordFile != "" { t.Fatalf("%+v", f.Client) } } diff --git a/modules/gitea/cmd/forge/forge.go b/modules/gitea/cmd/forge/forge.go index a9d279306..1be60c00b 100644 --- a/modules/gitea/cmd/forge/forge.go +++ b/modules/gitea/cmd/forge/forge.go @@ -21,7 +21,10 @@ type Forge struct { // ForgeFromEnv is the forge as the manifest hands it to this bundle. func ForgeFromEnv() (*Forge, error) { - c, missing := forgehttp.FromEnv() + c, missing, err := forgehttp.ToolsFromEnv() + if err != nil { + return nil, err + } if len(missing) > 0 { return nil, fmt.Errorf("the forge cannot be reached: %s not set by the manifest", strings.Join(missing, ", ")) } diff --git a/modules/gitea/cmd/forge/forge_test.go b/modules/gitea/cmd/forge/forge_test.go index 427330873..73c0db149 100644 --- a/modules/gitea/cmd/forge/forge_test.go +++ b/modules/gitea/cmd/forge/forge_test.go @@ -691,8 +691,8 @@ func TestToolsAreTheOnesTheReadmeNamesAndTheManifestBuilds(t *testing.T) { // The tools' own account, never the admin login (novox/hq ADR 0365 §2); the package registry's bundle also writes // as the packages account (design 51: the write side an own secret beside a read-only tool token). wants := map[string][]string{ - "cmd/forge": {"MESH_GITEA_URL", "MESH_GITEA_TOOLS_USER", "MESH_GITEA_TOKEN_FILE"}, - "cmd/package-registry": {"MESH_GITEA_URL", "MESH_GITEA_TOOLS_USER", "MESH_GITEA_TOKEN_FILE", "MESH_GITEA_PACKAGES_USER", "MESH_GITEA_PACKAGES_TOKEN_FILE"}, + "cmd/forge": {"MESH_GITEA_URL", "MESH_GITEA_TOOLS_USER"}, + "cmd/package-registry": {"MESH_GITEA_URL", "MESH_GITEA_TOOLS_USER", "MESH_GITEA_PACKAGES_USER"}, } for _, a := range m.Build.Artifacts { want, ok := wants[a.From] @@ -713,6 +713,12 @@ func TestToolsAreTheOnesTheReadmeNamesAndTheManifestBuilds(t *testing.T) { t.Errorf("%s is given %s: it acts as an account of its own, not the administrator", a.From, k) } } + // Design 47 H2 §808, H-A-422 (1): the token is read through the vault seat's get, never from a file. + for _, k := range []string{"MESH_GITEA_TOKEN_FILE", "MESH_GITEA_PACKAGES_TOKEN_FILE"} { + if a.Env[k] != "" { + t.Errorf("%s is given %s: its token is read from the vault", a.From, k) + } + } } for from := range wants { t.Errorf("the manifest builds no %s bundle", from) diff --git a/modules/gitea/cmd/forge/main.go b/modules/gitea/cmd/forge/main.go index fadedecdd..ec2132339 100644 --- a/modules/gitea/cmd/forge/main.go +++ b/modules/gitea/cmd/forge/main.go @@ -14,6 +14,8 @@ import ( "strings" stdio "git.novox.be/novox/mesh-sdk/go" + + "gitea/internal/forgehttp" ) // ToolNames are the tools this bundle serves. The module's manifest lists no `tools` (see the package-registry @@ -21,6 +23,16 @@ import ( var ToolNames = []string{"gitea_commit", "gitea_commits", "gitea_compare", "gitea_pull_reviews", "gitea_list_dir", "gitea_search_code"} func main() { + // The tools' account's token, read from the vault at start and at each secret-changed naming it (design 47 H2 §808). + go func() { + account := os.Getenv("MESH_GITEA_TOOLS_USER") + if account == "" { + account = forgehttp.ToolsAccount + } + if err := forgehttp.Follow(func(f string, a ...any) { fmt.Fprintf(os.Stderr, f+"\n", a...) }, account); err != nil { + fmt.Fprintln(os.Stderr, "the vault's changes of the forge token are not heard:", err) + } + }() if err := stdio.Serve("", Tools(ForgeFromEnv)); err != nil { fmt.Fprintln(os.Stderr, err) os.Exit(1) diff --git a/modules/gitea/cmd/package-registry/forge.go b/modules/gitea/cmd/package-registry/forge.go index 82fb0e69a..3823e2e5a 100644 --- a/modules/gitea/cmd/package-registry/forge.go +++ b/modules/gitea/cmd/package-registry/forge.go @@ -78,8 +78,14 @@ func (f *Forge) As(typ string) *Forge { // ForgeFromEnv is the forge as the manifest hands it to this bundle. func ForgeFromEnv() (*Forge, error) { - c, missing := forgehttp.FromEnv() - w, writeMissing := forgehttp.WriterFromEnv() + c, missing, err := forgehttp.ToolsFromEnv() + if err != nil { + return nil, err + } + w, writeMissing, err := forgehttp.WriterFromEnv() + if err != nil { + return nil, err + } for _, m := range writeMissing { if m != "MESH_GITEA_URL" { missing = append(missing, m) @@ -168,7 +174,7 @@ func (f *Forge) DistTags(ctx context.Context, name string) (map[string]string, e // write is the registry's write side, refused when the manifest handed none. func (f *Forge) write() (*forgehttp.Client, error) { if f.Writer == nil { - return nil, errors.New("the package registry's write side is not handed to this bundle (MESH_GITEA_PACKAGES_TOKEN_FILE); nothing was written") + return nil, errors.New("the package registry's write side is not handed to this bundle (the packages account's token); nothing was written") } return f.Writer, nil } diff --git a/modules/gitea/cmd/package-registry/main.go b/modules/gitea/cmd/package-registry/main.go index 02de1384c..96adda433 100644 --- a/modules/gitea/cmd/package-registry/main.go +++ b/modules/gitea/cmd/package-registry/main.go @@ -17,6 +17,7 @@ import ( stdio "git.novox.be/novox/mesh-sdk/go" "git.novox.be/novox/mesh-sdk/go/views" + "gitea/internal/forgehttp" "gitea/internal/packageseats" ) @@ -49,6 +50,19 @@ func main() { os.Exit(1) } }() + // Both accounts' tokens, read from the vault at start and at each secret-changed naming one (design 47 H2 §808). + go func() { + tools, packages := os.Getenv("MESH_GITEA_TOOLS_USER"), os.Getenv("MESH_GITEA_PACKAGES_USER") + if tools == "" { + tools = forgehttp.ToolsAccount + } + if packages == "" { + packages = forgehttp.PackagesAccount + } + if err := forgehttp.Follow(func(f string, a ...any) { fmt.Fprintf(os.Stderr, f+"\n", a...) }, tools, packages); err != nil { + fmt.Fprintln(os.Stderr, "the vault's changes of the forge tokens are not heard:", err) + } + }() forge := func() (*Forge, error) { return ForgeFromEnv() } holder := func() (*packageseats.Holder, error) { return busHolder(forge) } go followIdle(holder) diff --git a/modules/gitea/cmd/package-registry/retention_test.go b/modules/gitea/cmd/package-registry/retention_test.go index 4eb926efb..9dd5ee5cd 100644 --- a/modules/gitea/cmd/package-registry/retention_test.go +++ b/modules/gitea/cmd/package-registry/retention_test.go @@ -480,22 +480,24 @@ func TestToolsAreTheOnesTheReadmeNamesAndSayWhatTheyDo(t *testing.T) { Objects any `json:"objects"` State any `json:"state"` }{m.Objects, m.State}) - for _, want := range []string{`"name":"incoming"`, `"transfers"`, `"key-ttl":true,"name":"idle"`} { + // Each with its cap (design 47 H2 §812, H-A-411 (2)). + for _, want := range []string{`"name":"incoming"`, `"name":"transfers"`, `"key-ttl":true,"max-mib":8,"name":"idle"`} { if !strings.Contains(string(req), want) { t.Errorf("the manifest does not keep %s in its old sections (%s)", want, req) } } // findings is one local name in one form (novox/hq ADR 0595 §11): the old section state, which the TypeScript bundle // announces readable for the condition keeper (kept.ts), never also under requires. - if strings.Contains(string(req), `"name":"findings"`) { - t.Errorf("findings is required as well as kept in state: %s", req) + if required, _ := json.Marshal(m.Requires); strings.Contains(string(required), `"name":"findings"`) { + t.Errorf("findings is required as well as kept in state: %s", required) } // transfers keeps for good: a lifetime of its own would drop a transfer's key and leave its chunks in incoming. if strings.Contains(string(req), `"name":"transfers","options"`) { t.Errorf("transfers has options (a lifetime): %s", req) } // The retention asks the builder's versions; the forge's other bundles ask the catalog half and record a re-read. - if strings.Join(m.Invokes, ",") != "seat:mesh-catalog.revision,seat:mesh-catalog.registrations,seat:mesh-hand-acts.hand-act,seat:mesh-builds.reserved" { + // The forge module's tokens through the vault seat: own-put by the minter, get by every process (design 47 H2 §808). + if strings.Join(m.Invokes, ",") != "seat:mesh-catalog.revision,seat:mesh-catalog.registrations,seat:mesh-hand-acts.hand-act,seat:mesh-builds.reserved,seat:mesh-vault.own-put,seat:mesh-vault.get" { t.Errorf("the manifest invokes %v", m.Invokes) } if len(m.Tools) != 0 { @@ -505,7 +507,7 @@ func TestToolsAreTheOnesTheReadmeNamesAndSayWhatTheyDo(t *testing.T) { for _, a := range m.Build.Artifacts { if a.From == "cmd/package-registry" { found = true - for _, k := range []string{"MESH_GITEA_URL", "MESH_GITEA_TOKEN_FILE", "MESH_GITEA_PACKAGES_TOKEN_FILE", "MESH_NPM_OWNER"} { + for _, k := range []string{"MESH_GITEA_URL", "MESH_NPM_OWNER"} { if a.Env[k] == "" { t.Errorf("the bundle is not given %s", k) } diff --git a/modules/gitea/cmd/package-registry/seats_test.go b/modules/gitea/cmd/package-registry/seats_test.go index 13d4fbd0f..5d30aff98 100644 --- a/modules/gitea/cmd/package-registry/seats_test.go +++ b/modules/gitea/cmd/package-registry/seats_test.go @@ -9,17 +9,17 @@ import ( "encoding/base64" "encoding/hex" "encoding/json" + "fmt" "io" "net/http" "net/http/httptest" - "os" - "path/filepath" "strings" "sync" "testing" "time" keyparts "git.novox.be/novox/mesh-sdk/go/keys" + "git.novox.be/novox/mesh-sdk/go/seal" "git.novox.be/novox/mesh-sdk/go/views" "gitea/internal/forgehttp" @@ -116,15 +116,10 @@ func TestThePackageSeatsStoreIntoTheForge(t *testing.T) { g := ®istry{uploaded: map[string][]byte{}, held: map[string][]byte{}} srv := httptest.NewServer(http.HandlerFunc(g.handle)) defer srv.Close() - dir := t.TempDir() - kept := func(name, token, line string) string { - file := filepath.Join(dir, name) - _ = os.WriteFile(file, []byte(token+"\n"), 0o600) - _ = os.WriteFile(file+".scopes", []byte(line+"\n"), 0o600) - return file - } - reader := forgehttp.Client{URL: srv.URL, TokenFile: kept("token", "reader", "read:package,read:user for mesh-tools"), Account: "mesh-tools"} - writer := forgehttp.Client{URL: srv.URL, TokenFile: kept("packages-token", "writer", "write:package for mesh-packages"), Account: "mesh-packages"} + vault := map[string]string{"mesh-tools": "reader", "mesh-packages": "writer"} + writerToken := vaultHolding(t, "mesh-packages", vault) + reader := forgehttp.Client{URL: srv.URL, Token: vaultHolding(t, "mesh-tools", vault), Account: "mesh-tools"} + writer := forgehttp.Client{URL: srv.URL, Token: writerToken, Account: "mesh-packages"} forge := &Forge{Client: reader, Writer: &writer, Owner: "acme"} if _, err := (seatStore{forge: func() (*Forge, error) { return &Forge{Client: reader, Owner: "acme"}, nil }}).Put(packageseats.GoSeat, packageseats.Publish{}, nil); err == nil || !strings.Contains(err.Error(), "write side") { @@ -138,12 +133,22 @@ func TestThePackageSeatsStoreIntoTheForge(t *testing.T) { if k := views.FindingKey("seat", keyparts.EscapeName(packageseats.Self)+".write", PackagesTokenRefused); k != PackagesTokenRefusedKey { t.Errorf("the refusal's key is %s, the watcher watches %s", k, PackagesTokenRefusedKey) } - _ = os.WriteFile(writer.TokenFile, []byte("stale\n"), 0o600) + vault["mesh-packages"] = "stale" + if read, err := writerToken.Changed([]byte(`{"name":"module/gitea/mesh-packages","generation":2}`)); !read || err != nil { + t.Fatalf("the secret-changed of the packages token was not read again: %v %v", read, err) + } if _, err := s.Put(packageseats.GoSeat, packageseats.Publish{Version: "0.1.15"}, moduleZip(t, "git.example/acme/sdk@v0.1.15")); err == nil || len(refused) != 1 || !refused[0] { t.Errorf("a write the forge refused with 401 raised no finding: %v %v", err, refused) } - _ = os.WriteFile(writer.TokenFile, []byte("writer\n"), 0o600) + vault["mesh-packages"] = "writer" + // Design 47 H2 §808: a secret-changed naming another secret reads nothing; the one naming this token reads it again. + if read, _ := writerToken.Changed([]byte(`{"name":"module/gitea/mesh-tools","generation":3}`)); read { + t.Error("a secret-changed of the tools' token read the packages token again") + } + if read, err := writerToken.Changed([]byte(`{"name":"module/gitea/mesh-packages","generation":3}`)); !read || err != nil { + t.Fatalf("the secret-changed of the packages token was not read again: %v %v", read, err) + } tgz := tarball(t, `{"name":"@acme/contracts","version":"0.1.15-feat-x.2","main":"index.js"}`) p := packageseats.Publish{Name: "@acme/contracts", Version: "0.1.15-feat-x.2", Tag: "feat-x", Kind: packageseats.KindPackage, Digest: "sha256:" + sha(tgz)} @@ -197,3 +202,30 @@ func TestThePackageSeatsStoreIntoTheForge(t *testing.T) { t.Errorf("a write the forge took after the refusal did not clear it: %v", refused) } } + +// vaultHolding is the vault seat's get answering account's token from held, sealed to the key it is asked with; an +// account held has no entry is a secret the vault holds none of. +func vaultHolding(t *testing.T, account string, held map[string]string) *forgehttp.VaultToken { + t.Helper() + v, err := forgehttp.NewVaultToken(account, func(address string, args any) (json.RawMessage, error) { + a := args.(map[string]any) + if address != forgehttp.VaultGet || a["name"] != forgehttp.VaultName(account) { + return nil, fmt.Errorf("asked %s for %v", address, a["name"]) + } + token, ok := held[account] + if !ok { + return nil, fmt.Errorf("the vault holds no secret named %s", a["name"]) + } + // The value the minter writes: the token and the scopes it was minted with (H-A-439). + value, _ := json.Marshal(map[string]any{"token": token, "scopes": []string{"write:repository", "write:issue", "read:user", "read:package"}}) + box, err := seal.Seal(string(value), a["public_key"].(string)) + if err != nil { + return nil, err + } + return json.Marshal(map[string]any{"name": a["name"], "generation": 1, "sealed": box}) + }) + if err != nil { + t.Fatal(err) + } + return v +} diff --git a/modules/gitea/cmd/package-registry/whole_integration_test.go b/modules/gitea/cmd/package-registry/whole_integration_test.go index b7b76057f..1f4f511f4 100644 --- a/modules/gitea/cmd/package-registry/whole_integration_test.go +++ b/modules/gitea/cmd/package-registry/whole_integration_test.go @@ -40,6 +40,7 @@ import ( "github.com/nats-io/nats.go/jetstream" "git.novox.be/novox/mesh-sdk/go/buscalls" + "git.novox.be/novox/mesh-sdk/go/seal" "git.novox.be/novox/mesh-sdk/go/testbus" "gitea/internal/packageseats" @@ -65,6 +66,7 @@ type player struct { answers map[string]chan wire puts map[string][]byte // the put sessions open, by call gets map[string][]byte // the get sessions open, by call + vault map[string]string // the vault's secrets the seat's get hands, by name (design 47 H2 §808) } func (p *player) send(m map[string]any) { @@ -130,6 +132,21 @@ func (p *player) handle(m wire) { break } p.answer(m.ID, map[string]any{"module": "m", "version": q.Version, "artifacts": []map[string]any{{"artifact": "m:a", "digest": d}}}, nil) + case m.Method == "mesh/ask" && a.Key == "seat:mesh-vault.get": + var q struct { + Name string `json:"name"` + PublicKey string `json:"public_key"` + } + _ = json.Unmarshal(a.Body, &q) + token, ok := p.vault[q.Name] + if !ok { + p.answer(m.ID, nil, errors.New("the vault holds no secret named "+q.Name)) + break + } + // The value the minter writes: the token and the scopes it was minted with (H-A-439). + value, _ := json.Marshal(map[string]any{"token": token, "scopes": []string{"write:repository", "write:issue", "read:user", "read:package"}}) + box, err := seal.Seal(string(value), q.PublicKey) + p.answer(m.ID, map[string]any{"name": q.Name, "generation": 1, "sealed": box}, err) case m.Method == "mesh/seat.publish": p.answer(m.ID, map[string]any{}, p.nc.Publish(a.Subject, a.Body)) case m.Method == "mesh/capabilities": @@ -378,17 +395,9 @@ func TestThePackageSeatsWhole(t *testing.T) { } })) t.Cleanup(srv.Close) - dir := t.TempDir() - kept := func(name, token, line string) string { - file := filepath.Join(dir, name) - _ = os.WriteFile(file, []byte(token+"\n"), 0o600) - _ = os.WriteFile(file+".scopes", []byte(line+"\n"), 0o600) - return file - } cmd := exec.CommandContext(ctx, bin) cmd.Env = append(os.Environ(), "MESH_NODE=novox", "MESH_GITEA_URL="+srv.URL, "MESH_NPM_OWNER=acme", "MESH_GITEA_TOOLS_USER=mesh-tools", - "MESH_GITEA_TOKEN_FILE="+kept("token", "reader", "read:package,read:user,write:issue,write:repository for mesh-tools"), - "MESH_GITEA_PACKAGES_TOKEN_FILE="+kept("packages-token", "writer", "write:package for mesh-packages")) + "MESH_GITEA_PACKAGES_USER=mesh-packages") cmd.Stderr = os.Stderr in, _ := cmd.StdinPipe() out, _ := cmd.StdoutPipe() @@ -400,6 +409,7 @@ func TestThePackageSeatsWhole(t *testing.T) { zipped := bigZip(t, "git.example/acme/sdk@v0.1.15") digest := "sha256:" + sha(zipped) p := &player{ctx: ctx, t: t, nc: nc, js: js, in: in, answers: map[string]chan wire{}, + vault: map[string]string{"module/gitea/mesh-tools": "reader", "module/gitea/mesh-packages": "writer"}, numbered: map[string]string{"git.example/acme/sdk@0.1.15": digest}} go p.serve(out) p.send(map[string]any{"id": "init", "method": "initialize", "params": map[string]any{}}) diff --git a/modules/gitea/cmd/repositories/main.go b/modules/gitea/cmd/repositories/main.go index fea644bc2..a6b791ec0 100644 --- a/modules/gitea/cmd/repositories/main.go +++ b/modules/gitea/cmd/repositories/main.go @@ -36,10 +36,6 @@ func runSync() int { missing = append(missing, k) } } - if forge.TokenFile != "" { - // The tools' account cannot make or protect a repository, and must not (ADR 0428 §8). - missing = append(missing, "the setup login (MESH_GITEA_TOKEN_FILE is set instead)") - } if len(missing) > 0 { fmt.Fprintf(os.Stderr, "repositories: %v not set by the manifest; nothing was changed\n", missing) return 1 diff --git a/modules/gitea/delivery.ts b/modules/gitea/delivery.ts index ed65da6f4..6548954e0 100644 --- a/modules/gitea/delivery.ts +++ b/modules/gitea/delivery.ts @@ -68,6 +68,15 @@ export async function appendNote(runner: Runner, container: string, owner: strin return { added: true, lines: lines.length + 1 }; } +/** Whether a commit's note holds a line carrying the act's id, read without writing (design 47 H2 §775: a repeat of a + * taken ask answers what its act did). */ +export async function noteHolds(runner: Runner, container: string, owner: string, repo: string, commit: string, + notesRef: string, id: string): Promise { + const shown = await runner("docker", noteArgs(container, owner, repo, commit, notesRef)); + if (shown.code !== 0 && shown.code !== 1) throw new Error(`the note on ${commit.slice(0, 8)} could not be read (git exited ${shown.code})`); + return shown.code === 0 && shown.stdout.split("\n").some((l) => l.includes(`[${id}]`)); +} + /** The marker that makes one comment of a pull request the delivery's view. */ export const VIEW_MARKER = ""; diff --git a/modules/gitea/index.ts b/modules/gitea/index.ts index 6418924f7..4e31b6d4b 100644 --- a/modules/gitea/index.ts +++ b/modules/gitea/index.ts @@ -32,7 +32,7 @@ import { emit } from "@novox/mesh-sdk/events"; import { registerModuleTools } from "@novox/mesh-sdk/tools"; import { statesAnnouncement } from "./kept.js"; -import { state } from "@novox/mesh-sdk/state"; +import { state, TAKEN_STATE } from "@novox/mesh-sdk/state"; import { on } from "@novox/mesh-sdk/events"; import { broker } from "@novox/mesh-sdk/messaging"; import { STATUS_STATE, keepStatus, statusTools, viewWaitsFinding, type Follower, type Status } from "@novox/mesh-sdk/views"; @@ -45,8 +45,11 @@ import { REGISTRATION_CHANGED_EVENT, Registrations } from "./registrations.js"; import { FailedSteps, Heads, readHeads } from "./failedsteps.js"; import { failedStepsTools } from "./tools/failedsteps.js"; import { Calls, callRetentionDays, sayUnsaid } from "./calls.js"; +import { Once, askTakenBoundMs, takenState } from "./taken.js"; import { Partials } from "./partials.js"; -import { callTools } from "./tools/calls.js"; +import { callTools, mergedTool } from "./tools/calls.js"; +import { tokenLeaseTool } from "./tools/tokenlease.js"; +import { processVaultAndLease } from "./token.js"; import { seatPublish } from "@novox/mesh-sdk/runtime"; import { seat as GIT, events as GIT_EVENTS, type BranchMovedEvent, type PullClosedEvent, type PullMergedEvent, type PullUpdatedEvent } from "@novox/mesh-delivery-contracts-git"; import { seat as RUNNER, events as RUNNER_EVENTS, type StepEndedEvent } from "@novox/mesh-delivery-contracts-mesh-pipeline-runner"; @@ -59,7 +62,7 @@ import { announcementOf } from "./updated.js"; import { ReadAll, readAllTools } from "./readall.js"; import { DeliveredWrites, writeTools } from "./writes.js"; import { TOOLS_ACCOUNT, TOOLS_ORG, meshAccounts } from "./tools-account.js"; -import { PACKAGES_TOKEN_REFUSED, keepPackagesToken, packagesToken, renewOnRefusal } from "./packages-account.js"; +import { PACKAGES_ACCOUNT, PACKAGES_TOKEN_REFUSED, keepPackagesToken, packagesToken, renewOnRefusal } from "./packages-account.js"; // Without a way to a token — configured, or mintable with the admin account (token.ts) — there is // nothing to watch; log and stay quiet rather than crash the runtime. With one, the first poll mints @@ -282,6 +285,10 @@ const heldHeads = new Heads(); let reloadHeads: () => Promise = async () => {}; // The merge calls, each written before its first merge (calls.ts; design 47 H §766). const calls = new Calls(state("calls"), () => callRetentionDays(), (line) => console.log(`[gitea] ${line}`)); +// Each act of the seat git is taken once by its ask id, the ids kept in the state taken for ask-taken-bound (taken.ts; +// design 47 H2 §775). +const once = new Once(takenState(state(TAKEN_STATE), askTakenBoundMs(process.env, (line) => console.log(`[gitea] ${line}`))), + (line) => console.log(`[gitea] ${line}`)); // At the start, every call whose merge-called is not said says it for what landed (§766). const partials = new Partials(state("findings"), calls, (line) => console.log(`[gitea] ${line}`)); void sayUnsaid(calls, seatPublish, (line) => console.log(`[gitea] ${line}`)).catch((err) => @@ -297,8 +304,11 @@ void failedSteps.expireSeen().catch((err) => console.log(`[gitea] the seen keys registerModuleTools("gitea", () => [eventsTool(pace), ...readAllTools(readAll), ...writeTools(writes), ...statusTools("gitea", "gitea_first_views", "gitea_first_view_again", followers, firstViews, async (act) => { await broker().request("seat:mesh-hand-acts.hand-act", act); }), ...(gitea ? seatTools(gitea, { run, container: FORGE_CONTAINER, registered: () => registrations.written, judge: (head) => failedSteps.judge(head), - watched: () => registrations.watched, calls, say: seatPublish, partials }) : []), + watched: () => registrations.watched, calls, say: seatPublish, partials, once }) : []), ...callTools(calls, partials, seatPublish, async (act) => { await broker().request("seat:mesh-hand-acts.hand-act", act); }), + ...(gitea ? [mergedTool(gitea, calls)] : []), + tokenLeaseTool(processVaultAndLease().vault, processVaultAndLease().lease, + [process.env.MESH_GITEA_TOOLS_USER || TOOLS_ACCOUNT, process.env.MESH_GITEA_PACKAGES_USER || PACKAGES_ACCOUNT]), ...failedStepsTools(failedSteps, async (act) => { await broker().request("seat:mesh-hand-acts.hand-act", act); })]); /** What the forge's event asks of the announcer at once (issue 729, 1422): see watch.ts. */ @@ -453,7 +463,9 @@ if (gitea) { const read = await readHeads(forge, registrations.watched, (line) => console.log(`[gitea] ${line}`)); await failedSteps.lost(heldHeads.replace(read.names, read.branches, read.pulls)); }; - // The runner's step-ended is said on step-ended... (the seat's definition). + // The runner's step-ended is said on step-ended... (the seat's definition); a source-only + // check's module is the registration's key source.. (design 47 H2 §815, H-A-408), one subject part as + // a key part escapes it (mesh-sdk keys.EscapeName), and its body names it whole. const stepEnded = `${RUNNER}.${RUNNER_EVENTS.stepEnded}.*.*.*`; void bindUntilHeld(stepEnded, () => on(stepEnded, (event) => failedSteps.stepEnded(event.body))); // A branch's head is read from the forge, never taken from the event (the seat's definition of branch-moved). diff --git a/modules/gitea/internal/forgehttp/forgehttp.go b/modules/gitea/internal/forgehttp/forgehttp.go index 3951ce342..b9d5a77e0 100644 --- a/modules/gitea/internal/forgehttp/forgehttp.go +++ b/modules/gitea/internal/forgehttp/forgehttp.go @@ -3,13 +3,12 @@ // // Two ways in, by what the manifest hands the bundle: // -// - **as the tools' account** (novox/hq ADR 0365 §2), when MESH_GITEA_TOKEN_FILE names the token the module -// keeps for it (token.ts mints it, for `mesh-tools`, and keeps it at 0600 with its scopes line beside it). A -// token whose scopes line does not say it is the tools' account's — one kept from before, the administrator's — -// is never sent: the call fails, saying so, until the module has minted the account's own. This bundle mints -// nothing; a token the forge rejects is renewed by the module's next call, and said here. +// - **as the tools' account or the packages account** (novox/hq ADR 0365 §2; design 47 H2 §808), with the account's +// token the module keeps in the vault as its own (token.ts mints it; vault.go reads it through the vault seat's +// `get` at start and at `secret-changed`). This bundle mints nothing; a token the forge rejects is renewed by the +// module's next call, and said here. // - **as the admin account**, whose password the vault delivered into a file this module owns (novox/hq ADR -// 0086), by basic authentication, when no token file is named. +// 0086), by basic authentication, when no token is given. // // A credential is read when a call is made and never logged, answered or put in an error. package forgehttp @@ -35,12 +34,12 @@ type Client struct { URL string // e.g. http://127.0.0.1:3000 User string PasswordFile string - // TokenFile, when set, is the tools' account's token (MESH_GITEA_TOKEN_FILE), sent instead of the admin login; - // Account the account its scopes line must name (MESH_GITEA_TOOLS_USER, default mesh-tools). - TokenFile string - Account string - HTTP *http.Client // when nil, a client with Timeout - Timeout time.Duration // one request's limit when HTTP is nil; 20 s when zero + // Token, when set, is the account's token as the vault holds it (vault.go), sent instead of the admin login; + // Account the account it is (MESH_GITEA_TOOLS_USER, default mesh-tools; MESH_GITEA_PACKAGES_USER for the writer). + Token *VaultToken + Account string + HTTP *http.Client // when nil, a client with Timeout + Timeout time.Duration // one request's limit when HTTP is nil; 20 s when zero } // ToolsAccount is the account the forge's tools act as when the manifest names none (token.ts, tools-account.ts). @@ -52,37 +51,35 @@ const ToolsAccount = "mesh-tools" const PackagesAccount = "mesh-packages" // WriterFromEnv is the package registry's write side as the manifest hands it to a bundle: the packages account's -// token (MESH_GITEA_PACKAGES_TOKEN_FILE, kept by the module beside the tools' token) and the names of the variables -// it left unset. Never the admin login: a bundle handed no writer's token writes nothing. -func WriterFromEnv() (Client, []string) { - c := Client{URL: strings.TrimRight(os.Getenv("MESH_GITEA_URL"), "/"), TokenFile: os.Getenv("MESH_GITEA_PACKAGES_TOKEN_FILE"), - Account: os.Getenv("MESH_GITEA_PACKAGES_USER")} - if c.Account == "" { - c.Account = PackagesAccount - } - var missing []string - for _, kv := range [][2]string{{"MESH_GITEA_URL", c.URL}, {"MESH_GITEA_PACKAGES_TOKEN_FILE", c.TokenFile}} { - if kv[1] == "" { - missing = append(missing, kv[0]) - } - } - return c, missing +// token, read from the vault (vault.go), and the names of the variables it left unset. Never the admin login. +func WriterFromEnv() (Client, []string, error) { + return accountFromEnv(os.Getenv("MESH_GITEA_PACKAGES_USER"), PackagesAccount) } -// FromEnv is the forge as the manifest hands it to a bundle, and the names of the variables it left unset. A bundle -// handed MESH_GITEA_TOKEN_FILE acts as the tools' account and needs no admin login. -func FromEnv() (Client, []string) { - if file := os.Getenv("MESH_GITEA_TOKEN_FILE"); file != "" { - c := Client{URL: strings.TrimRight(os.Getenv("MESH_GITEA_URL"), "/"), TokenFile: file, - Account: os.Getenv("MESH_GITEA_TOOLS_USER")} - if c.Account == "" { - c.Account = ToolsAccount - } - if c.URL == "" { - return c, []string{"MESH_GITEA_URL"} - } - return c, nil +// ToolsFromEnv is the forge as the tools' account, its token read from the vault (vault.go), and the names of the +// variables the manifest left unset; it needs no admin login. +func ToolsFromEnv() (Client, []string, error) { + return accountFromEnv(os.Getenv("MESH_GITEA_TOOLS_USER"), ToolsAccount) +} + +func accountFromEnv(account, fallback string) (Client, []string, error) { + if account == "" { + account = fallback } + token, err := TokenOf(account) + if err != nil { + return Client{}, nil, err + } + c := Client{URL: strings.TrimRight(os.Getenv("MESH_GITEA_URL"), "/"), Token: token, Account: account} + if c.URL == "" { + return c, []string{"MESH_GITEA_URL"}, nil + } + return c, nil, nil +} + +// FromEnv is the forge as the admin account, as the manifest hands it to a bundle, and the names of the variables it +// left unset. +func FromEnv() (Client, []string) { c := Client{ URL: strings.TrimRight(os.Getenv("MESH_GITEA_URL"), "/"), User: os.Getenv("MESH_GITEA_ADMIN_USER"), @@ -132,27 +129,10 @@ func (c *Client) password() (string, error) { return strings.TrimSpace(string(raw)), nil } -// token is the tools' account's token, refused unless its scopes line names that account. -func (c *Client) token() (string, error) { - raw, err := os.ReadFile(c.TokenFile) - if err != nil { - return "", fmt.Errorf("the token for %s is not kept yet (the module mints it): %w", c.Account, err) - } - line, err := os.ReadFile(c.TokenFile + ".scopes") - if err != nil || !strings.HasSuffix(strings.TrimSpace(string(line)), " for "+c.Account) { - return "", fmt.Errorf("the token kept at %s is not %s's (novox/hq ADR 0365): the module mints that account's own at its next call; nothing was sent", c.TokenFile, c.Account) - } - token := strings.TrimSpace(string(raw)) - if token == "" { - return "", fmt.Errorf("the token kept at %s is empty; nothing was sent", c.TokenFile) - } - return token, nil -} - // authorize puts the bundle's credential on a request: the tools' token, or the admin login. func (c *Client) authorize(req *http.Request) error { - if c.TokenFile != "" { - token, err := c.token() + if c.Token != nil { + token, err := c.Token.Token() if err != nil { return err } @@ -212,7 +192,7 @@ func (c *Client) Send(ctx context.Context, method, path string, raw []byte, cont return nil, fmt.Errorf("the forge's answer to %s %s is larger than %d MiB and was not read whole", method, path, limit>>20) } switch { - case res.StatusCode == http.StatusUnauthorized && c.TokenFile != "": + case res.StatusCode == http.StatusUnauthorized && c.Token != nil: return nil, fmt.Errorf("the forge rejected %s's token for %s (401): the module mints it afresh; nothing was done: %w", c.Account, method+" "+path, &StatusError{method, path, res.StatusCode, "unauthorized"}) case res.StatusCode == http.StatusNotFound: diff --git a/modules/gitea/internal/forgehttp/vault.go b/modules/gitea/internal/forgehttp/vault.go new file mode 100644 index 000000000..2fec629c6 --- /dev/null +++ b/modules/gitea/internal/forgehttp/vault.go @@ -0,0 +1,173 @@ +package forgehttp + +// The forge module's tokens as its Go bundles read them (design 47 H2 §808; H-A-422 (1), H-A-426): kept in the vault as +// the module's own, `module/gitea/`, written by the TypeScript bundle's minter through own-put, and read here +// through the seat `mesh-vault`'s `get`, sealed to this process's own key (the Go SDK's seal opens it), at start and at +// each `secret-changed` that names it. Never a file: the bundle holds the token in memory only, and says nothing of it. + +import ( + "encoding/json" + "errors" + "fmt" + "strings" + "sync" + + stdio "git.novox.be/novox/mesh-sdk/go" + "git.novox.be/novox/mesh-sdk/go/seal" +) + +// VaultGet is the vault seat's verb a token is read by, and SecretChanged the vault's event that a secret changed. +const ( + VaultGet = "seat:mesh-vault.get" + SecretChanged = "mesh-vault.secret-changed" +) + +// VaultName is the vault's name of an account's token (H-A-426). +func VaultName(account string) string { return "module/gitea/" + account } + +// Ask asks one seat verb and answers its reply (stdio.Ask). +type Ask func(address string, args any) (json.RawMessage, error) + +// VaultToken is one account's token as this process holds it, read from the vault. +type VaultToken struct { + Account string + ask Ask + keys seal.KeyPair + + mu sync.Mutex + token string + generation int +} + +// NewVaultToken is an account's token read through ask, sealed to a key made for this process. +func NewVaultToken(account string, ask Ask) (*VaultToken, error) { + keys, err := seal.GenerateKeyPair() + if err != nil { + return nil, fmt.Errorf("no key to read %s's token with: %w", account, err) + } + return &VaultToken{Account: account, ask: ask, keys: keys}, nil +} + +// Load reads the account's token from the vault again. +func (t *VaultToken) Load() error { + raw, err := t.ask(VaultGet, map[string]any{"name": VaultName(t.Account), "public_key": t.keys.PublicKey}) + if err != nil { + return fmt.Errorf("the vault did not hand %s: %w", VaultName(t.Account), err) + } + var got struct { + Generation int `json:"generation"` + Sealed *seal.Box `json:"sealed"` + } + if err := json.Unmarshal(raw, &got); err != nil || got.Sealed == nil { + return fmt.Errorf("the vault answered no sealed %s", VaultName(t.Account)) + } + opened, err := seal.Open(*got.Sealed, t.keys.PrivateKey) + if err != nil { + return fmt.Errorf("%s does not open with this process's key: %w", VaultName(t.Account), err) + } + // The value holds the token and the scopes it was minted with (H-A-439); the minter judges the scopes, this reads the token. + var value struct { + Token string `json:"token"` + } + if err := json.Unmarshal([]byte(opened), &value); err != nil { + return fmt.Errorf("the vault's %s is not a token with its scopes: %w", VaultName(t.Account), err) + } + token := strings.TrimSpace(value.Token) + if token == "" { + return fmt.Errorf("the vault's %s is empty", VaultName(t.Account)) + } + t.mu.Lock() + t.token, t.generation = token, got.Generation + t.mu.Unlock() + return nil +} + +// Token is the token held; read from the vault when none is yet (the module mints it first). +func (t *VaultToken) Token() (string, error) { + t.mu.Lock() + token := t.token + t.mu.Unlock() + if token != "" { + return token, nil + } + if err := t.Load(); err != nil { + return "", fmt.Errorf("the token for %s is not kept yet (the module mints it): %w", t.Account, err) + } + t.mu.Lock() + defer t.mu.Unlock() + return t.token, nil +} + +// Generation is the vault's generation of the token held, 0 when none is held. +func (t *VaultToken) Generation() int { + t.mu.Lock() + defer t.mu.Unlock() + return t.generation +} + +// Changed takes one `secret-changed`: the token is read again when it names this account's; answers whether it did. +func (t *VaultToken) Changed(body []byte) (bool, error) { + var e struct { + Name string `json:"name"` + } + if err := json.Unmarshal(body, &e); err != nil { + return false, fmt.Errorf("%s is not a secret's change: %w", SecretChanged, err) + } + if e.Name != VaultName(t.Account) { + return false, nil + } + return true, t.Load() +} + +var ( + processTokens = map[string]*VaultToken{} + processTokensMu sync.Mutex +) + +// TokenOf is this process's one token of account, read through the runtime's seat calls. +func TokenOf(account string) (*VaultToken, error) { + processTokensMu.Lock() + defer processTokensMu.Unlock() + if t, ok := processTokens[account]; ok { + return t, nil + } + t, err := NewVaultToken(account, stdio.Ask) + if err != nil { + return nil, err + } + processTokens[account] = t + return t, nil +} + +// Follow reads each account's token once the runtime serves, and again at each `secret-changed` naming it, saying +// through logf what it read (never the token). It returns when the subscription ends. +func Follow(logf func(format string, args ...any), accounts ...string) error { + var held []*VaultToken + for _, a := range accounts { + t, err := TokenOf(a) + if err != nil { + return err + } + held = append(held, t) + } + <-stdio.Served() + for _, t := range held { + if err := t.Load(); err != nil { + logf("%s is not read at the start (the module mints it): %v", VaultName(t.Account), err) + } else { + logf("read %s at generation %d", VaultName(t.Account), t.Generation()) + } + } + return stdio.Subscribe(SecretChanged, func(e stdio.Envelope) error { + var errs []error + for _, t := range held { + if read, err := t.Changed(e.Body); err != nil { + errs = append(errs, err) + logf("%s changed and could not be read again: %v", VaultName(t.Account), err) + } else if read { + logf("read %s again at generation %d", VaultName(t.Account), t.Generation()) + } + } + return errors.Join(errs...) + }) +} diff --git a/modules/gitea/internal/seatgit/whole_integration_test.go b/modules/gitea/internal/seatgit/whole_integration_test.go index 2109e7eb2..eaa20face 100644 --- a/modules/gitea/internal/seatgit/whole_integration_test.go +++ b/modules/gitea/internal/seatgit/whole_integration_test.go @@ -12,6 +12,8 @@ package seatgit // - A runner's step-ended of a failed required step at a pull request's head and fingerprint is kept, and a merge call // naming that head merges nothing and names the step (§735, test 114). // - A call naming two pull requests in two repositories merges both, in order, and says one merge-called (§734, §736). +// - An hq pull request, of a source-only registration, whose Go checks failed is refused naming the step (H2 §815). +// - With the forge's store stopped a merge call answers away, and called again once it is back it lands (H2 §776). // - A forge that refuses the second merge gives one merge-called with the first member and `refused`, and merge-partial // raised; a later call landing the refused member clears it (§767, test 115). @@ -54,12 +56,26 @@ type forge struct { pulls map[string]*pull merges []string paths []string + // away is the forge's store stopped (§776): the API answers 503 and the version read names the store unavailable. + away bool } func (f *forge) serve(w http.ResponseWriter, r *http.Request) { f.mu.Lock() defer f.mu.Unlock() f.paths = append(f.paths, r.Method+" "+r.URL.Path) + if r.URL.Path == "/api/v1/version" { + if f.away { + http.Error(w, `{"message":"the database is unavailable"}`, http.StatusInternalServerError) + return + } + _, _ = w.Write([]byte(`{"version":"1.27.3"}`)) + return + } + if f.away { + http.Error(w, "Service Unavailable", http.StatusServiceUnavailable) + return + } m := regexp.MustCompile(`^/api/v1/repos/([^/]+/[^/]+)/pulls/(\d+)(/merge)?$`).FindStringSubmatch(r.URL.Path) if m != nil { p := f.pulls[m[1]+"#"+m[2]] @@ -390,7 +406,7 @@ func TestTheSeatGitWholeOverARealBus(t *testing.T) { } kvs[name] = kv } - A, B, X := strings.Repeat("a", 40), strings.Repeat("b", 40), strings.Repeat("e", 40) + A, B, X, H := strings.Repeat("a", 40), strings.Repeat("b", 40), strings.Repeat("e", 40), strings.Repeat("f", 40) // A call stopped after the second of three merges, kept and not said (§766). stopped, _ := json.Marshal(map[string]any{"by": "lead@shanks", "account": "shanks.claude-code", "at": "2026-11-20T03:00:00Z", "said": false, "members": []any{ @@ -407,6 +423,7 @@ func TestTheSeatGitWholeOverARealBus(t *testing.T) { "novox/app#7": {repo: "novox/app", base: "main", head: A, number: 7}, "novox/lib#9": {repo: "novox/lib", base: "main", head: B, number: 9, refuse: true}, "novox/lib#10": {repo: "novox/lib", base: "main", head: B, number: 10}, + "novox/hq#11": {repo: "novox/hq", base: "main", head: H, number: 11}, }} srv := httptest.NewServer(http.HandlerFunc(f.serve)) t.Cleanup(srv.Close) @@ -426,7 +443,10 @@ func TestTheSeatGitWholeOverARealBus(t *testing.T) { t.Cleanup(func() { _ = in.Close(); _ = cmd.Process.Kill(); _ = cmd.Wait() }) rt := &runtime{t: t, in: in, js: js, kvs: kvs, wait: map[string]chan json.RawMessage{}, regs: []map[string]any{ {"module": "app", "origin": "novox/app", "branches": []string{"main"}}, - {"module": "lib", "origin": "novox/lib", "branches": []string{"main"}}}} + {"module": "lib", "origin": "novox/lib", "branches": []string{"main"}}, + // A source-only registration (H2 §815): no module, one watched branch, its check a build seat's step. + {"origin": "novox/hq", "branches": []string{"main"}, "policy": map[string]any{"steps": map[string]any{"unit": "required"}}, + "check": map[string]any{"seat": "node-build-go", "step": "unit"}}}} go rt.read(out) // At the start the stopped call says one merge-called naming the two that landed (§766). @@ -456,6 +476,32 @@ func TestTheSeatGitWholeOverARealBus(t *testing.T) { t.Fatalf("merged %v", got) } + // An hq pull request whose Go checks fail is refused by merge-pull naming the failed step (H2 §815): the runner's + // step-ended of a source-only check names the registration's key as its module and the commit's root tree hash as its + // fingerprint (H-A-408), escaped as one part of its subject, judged as a module's. + rt.ask("mesh/event", map[string]any{"envelope": map[string]any{"key": "mesh-pipeline-runner.step-ended.source=2enovox=2ehq.main." + H, "node": "test", + "body": map[string]any{"v": 1, "pipeline": "main.5", "module": "source.novox.hq", "branch": "main", "commit": H, "fingerprint": strings.Repeat("7", 40), + "at": "2026-11-22T01:00:00Z", "result": map[string]any{"step": "unit", "status": "required", "outcome": "failed"}}}}) + hq := rt.mergePull(map[string]any{"repository": "novox/hq", "number": 11, "head": H}) + hqm, _ := hq["members"].([]any) + if len(hqm) != 1 || hqm[0].(map[string]any)["state"] != "refused" || + !strings.Contains(fmt.Sprint(hqm[0].(map[string]any)["why"]), "the unit step of source.novox.hq failed in run main.5") { + t.Fatalf("an hq head at a failed check answered %v", hq) + } + + // With the forge's store stopped, a merge call answers away, merging nothing (H2 §776); called again once the store is + // back, it lands (below). + f.mu.Lock() + f.away = true + f.mu.Unlock() + away := rt.mergePull(map[string]any{"repository": "novox/app", "number": 7, "head": A}, map[string]any{"repository": "novox/lib", "number": 10, "head": B}) + if away["error-kind"] != "away" || away["part"] != "the forge's store" || len(f.merged()) != 0 { + t.Fatalf("a merge call with the forge's store stopped answered %v, merged %v", away, f.merged()) + } + f.mu.Lock() + f.away = false + f.mu.Unlock() + // Two pull requests in two repositories merge, in order, and say one merge-called (§734, §736). both := rt.mergePull(map[string]any{"repository": "novox/app", "number": 7, "head": A}, map[string]any{"repository": "novox/lib", "number": 10, "head": B}) call, _ := both["call"].(string) diff --git a/modules/gitea/kept.ts b/modules/gitea/kept.ts index 790780182..deba4f89d 100644 --- a/modules/gitea/kept.ts +++ b/modules/gitea/kept.ts @@ -12,6 +12,8 @@ export const KEPT: readonly { readonly name: string; readonly readable?: boolean { name: "failed-steps" }, { name: "first-views" }, { name: "idle" }, + { name: "taken" }, + { name: "token-lease" }, { name: "transfers" }, ]; diff --git a/modules/gitea/module.json b/modules/gitea/module.json index 40de8e851..04d479f64 100644 --- a/modules/gitea/module.json +++ b/modules/gitea/module.json @@ -1,6 +1,7 @@ { "module": "gitea", "version": "0.1", + "class": "core", "moved": true, "requires": [ "postgres-database", @@ -237,6 +238,27 @@ "default": [ "jschoubben" ] + }, + "ask-taken-bound": { + "type": "string", + "description": "How long the forge module keeps the id of an act of the seat git it took, as a duration such as 10m (design 47 H2 §775): an act given again with that id within it acts not again but answers what the forge holds of it. The largest caller's bound, the pipeline runner's ask-unanswered-bound, by default.", + "trusted": false, + "runtime": true, + "default": "10m" + }, + "token-ttl": { + "type": "string", + "description": "How old the forge module's token of an account may grow, as a duration such as 24h (design 47 H2 \u00a7808): a token the vault has kept longer than this, by its changed-at, is minted again, one process at a time, and the one it replaces is deleted at the forge.", + "trusted": false, + "runtime": true, + "default": "24h" + }, + "mint-lease": { + "type": "string", + "description": "How long one process of the forge module may hold the lease to mint a token, as a duration such as 60s (design 47 H2 \u00a7808): the lease key mint in the state token-lease lives this long, so a process that died holding it is replaced after it, and a process that finds it taken waits at most this long.", + "trusted": false, + "runtime": true, + "default": "60s" } }, "facts": { @@ -519,9 +541,7 @@ "env": { "MESH_GITEA_URL": "http://127.0.0.1:${port:3000}", "MESH_GITEA_TOOLS_USER": "mesh-tools", - "MESH_GITEA_TOKEN_FILE": "${dir:runtime-state}/token", "MESH_GITEA_PACKAGES_USER": "mesh-packages", - "MESH_GITEA_PACKAGES_TOKEN_FILE": "${dir:runtime-state}/packages-token", "MESH_NPM_OWNER": "novox" } }, @@ -538,7 +558,6 @@ "env": { "MESH_GITEA_URL": "http://127.0.0.1:${port:3000}", "MESH_GITEA_TOOLS_USER": "mesh-tools", - "MESH_GITEA_TOKEN_FILE": "${dir:runtime-state}/token", "MESH_GITEA_PATCH_DIR": "${dir:forge-patches}" } }, @@ -616,25 +635,51 @@ } ], "state": [ - "bound", - "announced", - "findings", + { + "name": "bound", + "max-mib": 8 + }, + { + "name": "announced", + "max-mib": 8 + }, + { + "name": "findings", + "max-mib": 8 + }, { "name": "first-views", - "history": 1 + "history": 1, + "max-mib": 8 + }, + { + "name": "transfers", + "max-mib": 8 }, - "transfers", { "name": "idle", - "key-ttl": true + "key-ttl": true, + "max-mib": 8 }, { "name": "failed-steps", - "history": 1 + "history": 1, + "max-mib": 8 }, { "name": "calls", - "history": 1 + "history": 1, + "max-mib": 8 + }, + { + "name": "taken", + "key-ttl": true, + "max-mib": 8 + }, + { + "name": "token-lease", + "key-ttl": true, + "max-mib": 1 } ], "reads": [ @@ -649,7 +694,9 @@ "seat:mesh-catalog.revision", "seat:mesh-catalog.registrations", "seat:mesh-hand-acts.hand-act", - "seat:mesh-builds.reserved" + "seat:mesh-builds.reserved", + "seat:mesh-vault.own-put", + "seat:mesh-vault.get" ], "consumes": [ "mesh-catalog.catalog-revision", @@ -659,7 +706,8 @@ "git.pull-updated", "git.pull-closed", "git.pull-merged", - "mesh-conditions.findings-asked" + "mesh-conditions.findings-asked", + "mesh-vault.secret-changed" ], "streams": [ { @@ -670,7 +718,7 @@ "findings-stated.*" ], "max-age-days": 7, - "max-mib": 16 + "max-mib": 8 } ], "objects": [ diff --git a/modules/gitea/packages-account.ts b/modules/gitea/packages-account.ts index ac0ec296b..bc264d44d 100644 --- a/modules/gitea/packages-account.ts +++ b/modules/gitea/packages-account.ts @@ -9,28 +9,25 @@ // makes `mesh-tools`; its password random, sent once and kept nowhere. // - **the team**: `mesh-packages` in the organisation that owns the registry, writing packages and nothing else: // no code, no issues, no pull requests, no administration. -// - **the token**: minted for the account by the administrator's login with the one scope `write:package`, kept at -// 0600 in the module's runtime state as `packages-token`, its scopes line beside it saying whose it is -// (MintedToken: one mint at a time across the bundle's processes, re-minted when the kept one is gone or other). +// - **the token**: minted for the account by the administrator's login with the one scope `write:package`, kept in +// the vault as the module's own `module/gitea/mesh-packages` (design 47 H2 §808, H-A-422, H-A-426; MintedToken: one +// mint at a time across the bundle's processes, a name per mint, re-minted when refused or older than token-ttl). // // The watcher mints it at its start (keepPackagesToken). No timer looks at it after that: the Go bundle mints nothing, // and when the forge refuses its write it raises the finding PACKAGES_TOKEN_REFUSED in the module's findings state; the // watcher, watching that key, looks again (a refused token is minted afresh) and clears the finding (renewOnRefusal). import { randomBytes } from "node:crypto"; -import { join } from "node:path"; -import { MintedToken } from "./token.js"; +import { adminFromEnv, MintedToken } from "./token.js"; import { TOOLS_ORG, type ToolsForge } from "./tools-account.js"; /** The account the package seats write as (internal/forgehttp PackagesAccount). */ export const PACKAGES_ACCOUNT = "mesh-packages"; -/** Its team in the registry's organisation, and the token's name in the account's list. */ +/** Its team in the registry's organisation, and the token's fixed name in the account's list before a name per mint. */ export const PACKAGES_TEAM = "mesh-packages"; export const PACKAGES_TOKEN_NAME = "mesh-packages"; /** The one scope the write side needs; reads go with the tools' token. */ export const PACKAGES_TOKEN_SCOPES: readonly string[] = ["write:package"]; -/** Where the token is kept in the module's runtime state (the manifest's MESH_GITEA_PACKAGES_TOKEN_FILE). */ -export const PACKAGES_TOKEN_FILE = "packages-token"; /** What the team grants: write on the organisation's packages, and no more. */ export const PACKAGES_TEAM_UNITS = { @@ -47,26 +44,19 @@ export async function setUpPackagesAccount(forge: ToolsForge, account = PACKAGES } /** The packages account's token, minted by the administrator's login from what the manifest hands the watcher. */ -export function packagesToken(url: string, env: NodeJS.ProcessEnv = process.env, log?: (line: string) => void): MintedToken { - const admin = env.MESH_GITEA_ADMIN_USER; - const passwordFile = env.MESH_GITEA_ADMIN_PASSWORD_FILE; - const stateDir = env.MESH_GITEA_STATE_DIR; - const missing = [ - admin ? null : "MESH_GITEA_ADMIN_USER", - passwordFile ? null : "MESH_GITEA_ADMIN_PASSWORD_FILE", - stateDir ? null : "MESH_GITEA_STATE_DIR", - ].filter((v): v is string => v !== null); - if (missing.length) throw new Error(`the package seats' write token cannot be minted: ${missing.join(", ")} not set by the manifest`); +export function packagesToken(url: string, env: NodeJS.ProcessEnv = process.env, log?: (line: string) => void, + over: Partial[0], "vault" | "lease" | "fetch" | "now">> = {}): MintedToken { + const { admin, passwordFile } = adminFromEnv(env, "the package seats' write token cannot be minted:"); const account = env.MESH_GITEA_PACKAGES_USER || PACKAGES_ACCOUNT; if (account === admin) throw new Error(`MESH_GITEA_PACKAGES_USER names the admin account "${admin}"; the package seats write as an account of their own`); + const base = over.vault && over.lease ? {} : MintedToken.settingsFromEnv(env); return new MintedToken({ - url, admin: admin!, passwordFile: passwordFile!, file: join(stateDir!, PACKAGES_TOKEN_FILE), account, - name: PACKAGES_TOKEN_NAME, scopes: PACKAGES_TOKEN_SCOPES, log, + ...base, ...over, url, admin, passwordFile, account, oldName: PACKAGES_TOKEN_NAME, scopes: PACKAGES_TOKEN_SCOPES, log, setUp: async (password) => { const { GiteaAdmin } = await import("./client.js"); - await setUpPackagesAccount(new GiteaAdmin(url, admin!, password), account, () => randomBytes(24).toString("base64url")); + await setUpPackagesAccount(new GiteaAdmin(url, admin, password), account, () => randomBytes(24).toString("base64url")); }, - }); + } as ConstructorParameters[0]); } /** diff --git a/modules/gitea/seat.ts b/modules/gitea/seat.ts index 4af16387d..ffefb69fe 100644 --- a/modules/gitea/seat.ts +++ b/modules/gitea/seat.ts @@ -7,7 +7,8 @@ // // **A failed read answers an error, never an empty answer**: the forge's 404 is the kind `not-found`, its refusal (another // 4xx, or a refusal of this holder) the kind `refused`, a forge that failed or did not answer the kind `failed`; an empty list or an absent file is answered -// only when the forge said so. +// only when the forge said so. A 401, 502, 503 or connection fault whose version read fails, or names the forge's store +// unavailable, is the kind `away` (design 47 H2 §776; failureOf). // // **The acts carry the caller's id** (status, comment, view, note): an id the pull request or the note already holds is // answered `held` and nothing is done again. `merge-pull` is one merge call of one or more pull requests, every member @@ -24,11 +25,15 @@ import type { CommitStatus, GiteaClient, GiteaComment, GiteaPull } from "./clien import { DirectoryNotInTree, MAX_FILE_BYTES } from "./client.js"; import { containedFrom, newestByContext } from "./checks.js"; import { Refused, checkName } from "./guard.js"; -import { appendNote, viewBody, viewComment, type Runner } from "./delivery.js"; +import { AdminRefused } from "./token.js"; +import { awayAnswer } from "@novox/mesh-sdk/callers"; +import { appendNote, noteHolds, viewBody, viewComment, type Runner } from "./delivery.js"; import type { Judged } from "./failedsteps.js"; -import { mergeCall } from "./mergecall.js"; +import { mergeCall, membersOf } from "./mergecall.js"; import type { Calls, Say } from "./calls.js"; import type { Partials } from "./partials.js"; +import type { Once } from "./taken.js"; +import { askIdOf } from "@novox/mesh-sdk/callers"; /** The verbs of the seat, in its definition's order. */ export const VERBS: readonly string[] = Object.values(GIT_VERBS); @@ -57,6 +62,8 @@ export interface SeatDeps { say?: Say; /** The findings merge-partial (partials.ts; design 47 H §767). */ partials?: Partials; + /** Takes each act once by its ask id (taken.ts; design 47 H2 §775): absent, an act acts at every call. */ + once?: Once; } /** A failure as the contract says it: the forge's or this holder's refusal, or a forge that failed. */ @@ -71,6 +78,39 @@ export function failure(err: unknown): { error: string; "error-kind": ErrorKind return { error: text, "error-kind": refused ? "refused" : "failed" }; } +/** The forge's own version read, which tells the forge away from its refusal (client.ts forgeVersion). */ +export type VersionRead = Pick; + +/** + * Which failure may mean the forge or its store is away (design 47 H2 §776): a 401 (or the admin account refused at the + * mint the 401 asked), a 502 or 503, or a connection fault (no answer, or an answer cut at its limit); else null. + */ +function awayCause(err: unknown): "unauthorized" | "unavailable" | null { + if (err instanceof AdminRefused) return "unauthorized"; + const text = err instanceof Error ? err.message : String(err); + if (/^Gitea [^:]*: 401 /.test(text)) return "unauthorized"; + if (/^Gitea [^:]*: 50[23] /.test(text)) return "unavailable"; + if (/^Gitea API [^:]*: no answer in /.test(text)) return "unavailable"; + if (err instanceof TypeError && /fetch failed/.test(text)) return "unavailable"; + return null; +} + +/** + * A failure as the contract says it, the forge's own version read deciding a 401, a 502, a 503 or a connection fault + * (design 47 H2 §776): the read failing, or naming the forge's store unavailable, answers `away`, which every caller reads + * as a transport fault; the read passing, a 401 is the forge refusing the mesh's admin account (the client minted a + * fresh token on the first 401 and was refused again, token.ts), never worded as an account to create; else as failure. + */ +export async function failureOf(forge: VersionRead, err: unknown): Promise<{ error: string; "error-kind": ErrorKind; part?: string; words?: string }> { + const cause = awayCause(err); + if (cause === null) return failure(err); + const text = err instanceof Error ? err.message : String(err); + const read = await forge.forgeVersion(); + if (read.ok === false) return awayAnswer(read.store ? "the forge's store" : "the forge", `${text}; ${read.words}`); + if (cause === "unauthorized") return { error: `the forge refuses the mesh's admin account: ${text}`, "error-kind": "refused" }; + return failure(err); +} + /** owner/name of a `repository` argument, each checked as a name (guard.ts). */ export function repositoryOf(raw: unknown): { owner: string; repo: string; full: string } { const parts = String(raw ?? "").split("/"); @@ -80,8 +120,10 @@ export function repositoryOf(raw: unknown): { owner: string; repo: string; full: } const SHA = /^[0-9a-f]{40}$/; -/** The git tag of a released Go version (design 51; design 47 §370). */ -const GO_TAG = /^go\/v\d+\.\d+\.\d+$/; +/** The git tag of a released version, /vMAJOR.MINOR.PATCH (design 47 H2 §796; design 47 §370). */ +const VERSION_TAG = /^(?:[A-Za-z0-9_][A-Za-z0-9._-]*\/)+v\d+\.\d+\.\d+$/; +/** The form of the seat git's values and answers this holder answers in (design 47 H2 §780, §796). */ +const GIT_FORM = 2; const STATES = new Set(["pending", "success", "failure", "error", "warning"]); function commitOf(name: string, raw: unknown): string { const sha = String(raw ?? "").trim(); @@ -133,18 +175,24 @@ async function mergingOf(gitea: GiteaClient, owner: string, repo: string, p: Git /** The seat's verbs as tools `git.`, each answering in the seat's contract. */ export function seatTools(gitea: GiteaClient, deps: SeatDeps): ToolDefinition[] { - const verb = (name: string, description: string, act: (args: Record) => Promise): ToolDefinition => ({ + const answered = async (args: Record, act: (args: Record) => Promise): Promise => { + try { + return await act(args); + } catch (err) { + return failureOf(gitea, err); + } + }; + // An act given `standing`, what it did read afresh, is taken once by its ask id (§775, H-A-381, H-A-400). + const verb = (name: string, description: string, act: (args: Record) => Promise, + standing?: (args: Record) => Promise): ToolDefinition => ({ name: `${GIT}.${name}`, description, input: {}, - run: async (args: Record) => { - try { - return await act(args); - } catch (err) { - return failure(err); - } - }, + run: async (args: Record) => standing && deps.once + ? deps.once.run(askIdOf(args), () => answered(args, act), () => answered(args, standing)) + : answered(args, act), }); + const s = standingActs(gitea, deps); return [ verb(GIT_VERBS.pull, "The seat git's pull: one pull request by its repository and number or by its merge commit, and for an open one what the forge would merge now.", @@ -178,7 +226,7 @@ export function seatTools(gitea: GiteaClient, deps: SeatDeps): ToolDefinition[] })); return { pulls }; }), - verb(GIT_VERBS.tags, "The seat git's tags: a repository's tags, a page at a time, newest first; more when another page exists.", + verb(GIT_VERBS.tags, "The seat git's tags: a repository's tags, each with the commit it names, a page at a time, newest first; more when another page exists.", async (args): Promise => { const { owner, repo, full } = repositoryOf(args.repository); const page = args.page === undefined ? 1 : Number(args.page); @@ -186,8 +234,8 @@ export function seatTools(gitea: GiteaClient, deps: SeatDeps): ToolDefinition[] // One more than the page is asked, so whether another page exists is the forge's answer, not a guess. const got = await gitea.tags(owner, repo, page, TAGS_PAGE + 1); const more = got.length > TAGS_PAGE; - const tags = got.slice(0, TAGS_PAGE).filter((t) => t.startsWith(prefix)); - return { repository: full, page, bound: TAGS_PAGE, tags, ...(more ? { more } : {}) }; + const tags = got.slice(0, TAGS_PAGE).filter((t) => t.tag.startsWith(prefix)); + return { form: GIT_FORM, repository: full, page, bound: TAGS_PAGE, tags, ...(more ? { more } : {}) }; }), verb(GIT_VERBS.trees, "The seat git's trees: the trees of one commit, with files and paths when asked; a listing the forge cut is refused.", async (args): Promise => { @@ -235,7 +283,7 @@ export function seatTools(gitea: GiteaClient, deps: SeatDeps): ToolDefinition[] await gitea.setCommitStatus(owner, repo, commit, { state: state as CommitStatus["state"], context: String(args.context ?? ""), description: String(args.description ?? ""), ...(args.target ? { target_url: String(args.target) } : {}) }); return { id, performed: true }; - }), + }, s.status), verb(GIT_VERBS.comment, "The seat git's comment: an act of the forge bridge, a comment on a pull request carrying the act's id; an id it already holds is held.", async (args): Promise => { const id = idOf(args.id); @@ -244,7 +292,7 @@ export function seatTools(gitea: GiteaClient, deps: SeatDeps): ToolDefinition[] if (holds(await gitea.listComments(owner, repo, number), id)) return { id, held: true, performed: true }; await gitea.addComment(owner, repo, number, `${String(args.text ?? "")}\n\n${actMarker(id)}`); return { id, performed: true }; - }), + }, s.comment), verb(GIT_VERBS.view, "The seat git's view: an act of the forge bridge, the delivery's one view comment kept on a pull request; an id it already holds is held.", async (args): Promise => { const id = idOf(args.id); @@ -256,7 +304,7 @@ export function seatTools(gitea: GiteaClient, deps: SeatDeps): ToolDefinition[] if (existing) await gitea.editComment(owner, repo, existing.id, body); else await gitea.addComment(owner, repo, number, body); return { id, performed: true }; - }), + }, s.view), verb(GIT_VERBS.note, "The seat git's note: an act of the forge bridge, one line on a commit's note under refs/notes/mesh-plan carrying the act's id; an id it already holds is held.", async (args): Promise => { const id = idOf(args.id); @@ -264,24 +312,92 @@ export function seatTools(gitea: GiteaClient, deps: SeatDeps): ToolDefinition[] const commit = commitOf("commit", args.commit); const said = await appendNote(deps.run, deps.container, owner, repo, commit, "mesh-plan", `${String(args.line ?? "")} [${id}]`, id); return said.added ? { id, performed: true } : { id, held: true, performed: true }; - }), + }, s.note), verb(GIT_VERBS.mergePull, "The seat git's merge-pull: one merge call, a delivery's start and its group: the pull requests named (pulls, each {repository, number, head}) and by (who@node); every member is judged before any is merged (still its head, its base a watched branch, no required step failed at its fingerprint), none merged when one is refused, then each merged in the order named; it answers the call and each member's outcome.", - async (args): Promise => mergeCall(gitea, args, deps)), - verb(GIT_VERBS.tag, "The seat git's tag: the git tag go/vMAJOR.MINOR.PATCH of a released version, written at the commit its build was made from; a tag that is at that commit is performed.", + async (args): Promise => mergeCall(gitea, args, deps), s.mergePull), + verb(GIT_VERBS.tag, "The seat git's tag: the git tag /vMAJOR.MINOR.PATCH of a released version, written at the commit its build was made from; a tag that is at that commit is performed.", async (args): Promise => { const { owner, repo } = repositoryOf(args.repository); const tag = String(args.tag ?? ""); - if (!GO_TAG.test(tag)) throw new Refused(`${JSON.stringify(tag)} is not go/vMAJOR.MINOR.PATCH`); + if (!VERSION_TAG.test(tag)) throw new Refused(`${JSON.stringify(tag)} is not /vMAJOR.MINOR.PATCH`); const commit = commitOf("commit", args.commit); const at = await gitea.tagCommit(owner, repo, tag); if (at === commit) return { tag, performed: true }; if (at !== null) throw new Refused(`${tag} is at ${at.slice(0, 12)} already, not at ${commit.slice(0, 12)}; a tag is never moved`); await gitea.createTag(owner, repo, tag, commit); return { tag, performed: true }; - }), + }, s.tag), ]; } function holds(comments: GiteaComment[], id: string): boolean { return comments.some((c) => String(c.body ?? "").includes(actMarker(id))); } + +/** + * What each act did, read afresh from the forge, for an ask given again after its act ended (design 47 H2 §775; H-A-381 + * (1)): the act is never performed twice, and what the forge holds is what the act answers when done. A repeat for which + * the forge holds nothing of the act is a refusal naming it. + */ +function standingActs(gitea: GiteaClient, deps: SeatDeps) { + const never = (ask: string, what: string) => new Refused(`the ask ${ask} was taken and its act acted, but ${what}: answered as it stands, never acted again`); + const askOf = (args: Record) => askIdOf(args); + return { + status: async (args: Record): Promise => { + const id = idOf(args.id); + const { owner, repo } = repositoryOf(args.repository); + const commit = commitOf("commit", args.commit); + const context = String(args.context ?? ""), state = String(args.state ?? ""); + const now = newestByContext((await gitea.combinedStatus(owner, repo, commit)).statuses).find((x) => x.context === context); + if (!now || now.state !== state) throw never(askOf(args), `${commit.slice(0, 12)} carries no ${context} ${state}`); + return { id, held: true, performed: true }; + }, + comment: async (args: Record): Promise => { + const id = idOf(args.id); + const { owner, repo, full } = repositoryOf(args.repository); + const number = numberOf(args.number); + if (!holds(await gitea.listComments(owner, repo, number), id)) throw never(askOf(args), `${full}#${number} holds no comment of the act ${id}`); + return { id, held: true, performed: true }; + }, + view: async (args: Record): Promise => { + const id = idOf(args.id); + const { owner, repo, full } = repositoryOf(args.repository); + const number = numberOf(args.number); + const existing = viewComment(await gitea.listComments(owner, repo, number)); + if (!existing?.body.includes(actMarker(id))) throw never(askOf(args), `${full}#${number}'s view is not the act ${id}'s`); + return { id, held: true, performed: true }; + }, + note: async (args: Record): Promise => { + const id = idOf(args.id); + const { owner, repo } = repositoryOf(args.repository); + const commit = commitOf("commit", args.commit); + if (!(await noteHolds(deps.run, deps.container, owner, repo, commit, "mesh-plan", id))) { + throw never(askOf(args), `the note on ${commit.slice(0, 12)} holds no line of the act ${id}`); + } + return { id, held: true, performed: true }; + }, + mergePull: async (args: Record): Promise => { + // Each member as the forge holds it: merged, with its merge commit; the call that merged them, when one is kept. + const members = membersOf(args.pulls); + const out = await Promise.all(members.map(async (m) => { + const p = await gitea.getPullRequest(m.owner, m.repo, m.number); + return p.merged && p.merge_commit_sha + ? { repository: m.repository, number: m.number, state: "merged" as const, commit: p.merge_commit_sha } + : { repository: m.repository, number: m.number, state: "refused" as const, why: `not merged: the forge holds it ${p.state === "open" ? "open" : "closed"}` }; + })); + if (!out.some((m) => m.state === "merged")) throw never(askOf(args), "the forge merged none of its pull requests"); + const named = (c: { members: { repository: string; number: number; state: string }[] }) => + out.every((m) => m.state !== "merged" || c.members.some((k) => k.repository === m.repository && k.number === m.number && k.state === "merged")); + const kept = (await deps.calls?.all())?.find(named); + return { ...(kept ? { call: kept.call } : {}), members: out }; + }, + tag: async (args: Record): Promise => { + const { owner, repo } = repositoryOf(args.repository); + const tag = String(args.tag ?? ""); + const commit = commitOf("commit", args.commit); + const at = await gitea.tagCommit(owner, repo, tag); + if (at !== commit) throw never(askOf(args), at === null ? `the forge holds no tag ${tag}` : `${tag} is at ${at.slice(0, 12)}, not ${commit.slice(0, 12)}`); + return { tag, performed: true }; + }, + }; +} diff --git a/modules/gitea/taken.ts b/modules/gitea/taken.ts new file mode 100644 index 000000000..90d73e676 --- /dev/null +++ b/modules/gitea/taken.ts @@ -0,0 +1,107 @@ +// **The forge module takes an act of the seat git once by its ask id** (novox/hq design 47 H2 §775; H-A-381, H-A-400): a +// kept call carries its ask id (the runtime names it in the call's `_meta`, mesh-sdk askIdOf), and the forge module keeps +// each id it took in its state `taken`, key `git.`, for `ask-taken-bound` (a setting, default 10 minutes, the +// largest caller's bound). An ask given again while its act runs joins that act and gets its answer; given again after +// the act ended, it answers the act's state as it stands, read afresh from the forge (a merge call answers each pull +// request as it is: merged, with its merge commit), and the act is never performed twice. No answer is kept in `taken`. +// The key is kept only for an act that acted: an answer that performed nothing (away, a transport fault, a refusal +// before any act) drops it, so the kept call's repeat under the same id acts (H-A-400 (1)). A repeat for which the +// forge's state says the act that acted never happened is a refusal naming it. + +import { takeOnce, takenKey, TAKEN_STATE, type State } from "@novox/mesh-sdk/state"; + +/** The seat the forge module takes asks of. */ +export const SEAT = "git"; + +/** ask-taken-bound's default (H-A-381 (2)). */ +export const ASK_TAKEN_BOUND_DEFAULT = "10m"; + +/** A duration as the mesh writes one ("10m", "1h30m", "45s", "500ms"), in milliseconds; null when it is none. */ +export function durationMs(text: string): number | null { + const s = text.trim(); + if (!/^(\d+(\.\d+)?(ms|h|m|s))+$/.test(s)) return null; + let ms = 0; + for (const [, n, , unit] of s.matchAll(/(\d+(\.\d+)?)(ms|h|m|s)/g)) { + ms += Number(n) * ({ ms: 1, s: 1_000, m: 60_000, h: 3_600_000 } as Record)[unit]; + } + return ms > 0 ? ms : null; +} + +/** ask-taken-bound in milliseconds, from the word the node-engine composes for it (H-A-370, H-A-400 (2)); the default when + * it is unset. A value that is no duration is said and the default taken. */ +export function askTakenBoundMs(env: NodeJS.ProcessEnv = process.env, log: (line: string) => void = () => {}): number { + const raw = env.MESH_CONFIG_ASK_TAKEN_BOUND; + const fallback = durationMs(ASK_TAKEN_BOUND_DEFAULT)!; + if (raw === undefined || raw.trim() === "") return fallback; + const ms = durationMs(raw); + if (ms === null) { + log(`the setting ask-taken-bound is ${JSON.stringify(raw)}, no duration: the default ${ASK_TAKEN_BOUND_DEFAULT} holds`); + return fallback; + } + return ms; +} + +/** The state taken, as the forge module reaches it: take an ask once, drop a key whose act performed nothing. */ +export interface Taken { + /** Whether this holder takes the ask now (mesh-sdk takeOnce: created, refused when the key exists). */ + take(ask: string): Promise; + /** Drops the key of an ask whose act performed nothing, so its repeat acts. */ + drop(ask: string): Promise; +} + +/** The module's state taken over the runtime, its keys living ask-taken-bound. */ +export function takenState(st: Pick, "delete">, boundMs: number): Taken { + return { + take: (ask) => takeOnce(SEAT, ask, boundMs, TAKEN_STATE), + drop: (ask) => st.delete(takenKey(SEAT, ask)), + }; +} + +/** Whether an act's answer performed nothing: an error answer, or a merge call that merged no member. */ +export function performedNothing(answer: object): boolean { + const a = answer as Record; + if (a["error-kind"] !== undefined) return true; + if (Array.isArray(a.members)) return !a.members.some((m: any) => m?.state === "merged"); + return false; +} + +/** + * Takes an act once by its ask id: `act` runs for an ask this holder takes now; an ask given while its act runs joins it; + * an ask taken before whose act ended answers `standing`, the act's state read afresh. An act with no ask id acts as + * before. The taken key is dropped when the act performed nothing. + */ +export class Once { + private readonly running = new Map>(); + + constructor(private readonly taken: Taken, private readonly log: (line: string) => void = () => {}) {} + + async run(ask: string, act: () => Promise, standing: () => Promise): Promise { + if (!ask) return act(); + const joined = this.running.get(ask); + if (joined) return joined; + if (!(await this.taken.take(ask))) { + // Taken before, and its act ended (or another process runs it): what it did, read afresh, never done again. + return this.running.get(ask) ?? standing(); + } + const acting = (async () => { + let answer: object; + try { + answer = await act(); + } catch (err) { + await this.taken.drop(ask).catch(() => {}); + throw err; + } + if (performedNothing(answer)) { + await this.taken.drop(ask).catch((err) => + this.log(`the ask ${ask} performed nothing and its taken key could not be dropped, so its repeat is answered as it stands — ${err instanceof Error ? err.message : err}`)); + } + return answer; + })(); + this.running.set(ask, acting); + try { + return await acting; + } finally { + this.running.delete(ask); + } + } +} diff --git a/modules/gitea/test/calls.test.ts b/modules/gitea/test/calls.test.ts index fddb0574a..be2bc43eb 100644 --- a/modules/gitea/test/calls.test.ts +++ b/modules/gitea/test/calls.test.ts @@ -117,3 +117,27 @@ test("forge_calls reads the calls newest first; forge_call_say_again says one ag const none: any = await tool("forge_call_say_again").run({ call: "00000000000000bb", why: "x" }); assert.equal(none.said, false, "a call that landed none says none"); }); + +// 47 H2 §812, §811, H-A-402: forge_merged lists a repository's merged pull requests by number, from..to, each with its merge +// commit, when, and the merge call that made it; a number the forge does not hold or one not merged is left out; capped at +// 768 KB with the next number as the cursor. +test("forge_merged lists merged pull requests by number with the merge call that made each", async () => { + const { mergedTool, ANSWER_CAP_BYTES } = await import("../dist/tools/calls.js"); + const sha = (n: number) => String(n % 10).repeat(40); + const forge = { getPullRequest: async (_o: string, _r: string, n: number) => { + if (n === 3) throw new Error("Gitea API /repos/novox/app/pulls/3: 404 Not Found"); + return n === 4 ? { number: n, state: "open", merged: false } : { number: n, state: "closed", merged: true, merge_commit_sha: sha(n), merged_at: `2026-11-2${n}T10:00:00Z` }; + } }; + const calls = { all: async () => [{ call: "00000000000000aa", members: [{ repository: "novox/app", number: 2, state: "merged" }, { repository: "novox/lib", number: 1, state: "merged" }] }] }; + const got: any = await mergedTool(forge as any, calls as any).run({ repository: "novox/app", from: 1, to: 5 }); + assert.deepEqual(got, { repository: "novox/app", from: 1, to: 5, total: 5, merged: [ + { number: 1, "merge-commit": sha(1), "merged-at": "2026-11-21T10:00:00Z" }, + { number: 2, "merge-commit": sha(2), "merged-at": "2026-11-22T10:00:00Z", call: "00000000000000aa" }, + { number: 5, "merge-commit": sha(5), "merged-at": "2026-11-25T10:00:00Z" }] }); + await assert.rejects(mergedTool(forge as any, calls as any).run({ repository: "novox/app", from: 5, to: 4 }), /to not below from/); + // Past 768 KB it is capped, the cursor the next number to read from. + const many: any = await mergedTool(forge as any, { all: async () => [] } as any).run({ repository: "novox/app", from: 5, to: 20_000 }); + assert.equal(many.capped, true); + assert.ok(JSON.stringify(many.merged).length <= ANSWER_CAP_BYTES); + assert.equal(many.cursor, many.merged.at(-1).number + 1); +}); diff --git a/modules/gitea/test/fakebus.ts b/modules/gitea/test/fakebus.ts new file mode 100644 index 000000000..3c218e648 --- /dev/null +++ b/modules/gitea/test/fakebus.ts @@ -0,0 +1,96 @@ +// The bus as the forge module's token needs it, in memory (design 47 H2 §808, §822): the vault seat's `own-put` in its +// two sealed steps and its `get` sealed to the asker's key, and the runtime's state with a create-only key that lives +// its TTL, as the runtime that launched the bundle answers them. `order` records each own-put and each forge delete a +// test also writes into it, so the delete's place after the own-put can be read. + +import nacl from "tweetnacl"; +import blakejs from "blakejs"; +import { seal } from "@novox/mesh-sdk/seal"; +import { useBroker, type Broker } from "@novox/mesh-sdk/messaging"; +import { useRuntime } from "@novox/mesh-sdk/runtime"; +import { useStateChannel, type StateChange } from "@novox/mesh-sdk/state"; + +export interface Held { value: string; generation: number; changedAt: string } + +export function fakeBus(now: () => Date = () => new Date(), order: string[] = []) { + const vault = new Map(); + const calls = new Map(); + const kv = new Map(); + const watchers: { state: string; key: string; deliver: (c: StateChange) => Promise }[] = []; + let revision = 0; + const keyOf = (state: string, key: string) => `${state}/${key}`; + const live = (k: string) => { + const e = kv.get(k); + if (e && e.until !== null && e.until <= now().getTime()) kv.delete(k); + return kv.get(k); + }; + const tell = async (state: string, key: string, op: "put" | "delete", value?: unknown) => { + revision++; + for (const w of watchers) if (w.state === state && (w.key === "" || w.key === key)) await w.deliver({ state, key, op, value, revision, current: false }); + }; + const broker: Broker = { + async request(key: string, body: Req): Promise { + const b = body as Record; + if (key === "seat:mesh-vault.own-put" && b.call === undefined) { + const keys = nacl.box.keyPair(); + const call = `call-${calls.size + 1}`; + calls.set(call, { name: `module/gitea/${b.name}`, secretKey: keys.secretKey }); + return { call, seal_to: Buffer.from(keys.publicKey).toString("base64"), secret: `module/gitea/${b.name}` } as Res; + } + if (key === "seat:mesh-vault.own-put") { + const c = calls.get(b.call); + if (!c) throw new Error(`no own-put call ${b.call}`); + calls.delete(b.call); + const boxed = new Uint8Array(Buffer.from(b.sealed, "base64")); + const eph = boxed.subarray(0, 32); + const pub = nacl.box.keyPair.fromSecretKey(c.secretKey).publicKey; + const nonce = blakejs.blake2b(Buffer.concat([eph, pub]), undefined, 24); + const opened = nacl.box.open(boxed.subarray(32), nonce, eph, c.secretKey); + if (!opened) throw new Error("the sealed value does not open"); + const generation = (vault.get(c.name)?.generation ?? 0) + 1; + vault.set(c.name, { value: Buffer.from(opened).toString("utf8"), generation, changedAt: now().toISOString() }); + order.push(`own-put ${c.name} ${generation}`); + return { name: c.name, generation } as Res; + } + if (key === "seat:mesh-vault.get") { + const held = vault.get(b.name); + if (!held) throw new Error(`the vault holds no secret named ${b.name}`); + return { name: b.name, generation: held.generation, "changed-at": held.changedAt, sealed: seal(held.value, b.public_key) } as Res; + } + throw new Error(`not played here: ${key}`); + }, + handle: async () => () => {}, + publish: async () => {}, + subscribe: async () => () => {}, + close: async () => {}, + }; + const ask = async (method: string, params: unknown): Promise => { + const p = params as { state: string; key: string; value?: unknown; ttl_seconds?: number }; + const k = keyOf(p.state, p.key); + switch (method) { + case "mesh/state.create": + if (live(k)) throw Object.assign(new Error("the key has a value"), { code: -32010 }); + kv.set(k, { value: p.value, until: p.ttl_seconds ? now().getTime() + p.ttl_seconds * 1000 : null }); + await tell(p.state, p.key, "put", p.value); + return { revision }; + case "mesh/state.get": { + const e = live(k); + return e ? { key: p.key, value: e.value, revision } : null; + } + case "mesh/state.put": + kv.set(k, { value: p.value, until: null }); + await tell(p.state, p.key, "put", p.value); + return { revision }; + case "mesh/state.delete": + kv.delete(k); + await tell(p.state, p.key, "delete"); + return null; + default: + throw new Error(`not played here: ${method}`); + } + }; + useBroker(() => broker); + useRuntime(ask); + useStateChannel({ ask, watch: async (params, deliver) => { const w = params as { state: string; key: string }; watchers.push({ ...w, deliver }); } }); + return { vault, kv, order, ask }; +} diff --git a/modules/gitea/test/guard.test.ts b/modules/gitea/test/guard.test.ts index ae7348ab7..397877407 100644 --- a/modules/gitea/test/guard.test.ts +++ b/modules/gitea/test/guard.test.ts @@ -474,6 +474,7 @@ test("every read and act of the seat git answers its contract, and an error is a const SHA = "a".repeat(40), OTHER = "b".repeat(40); const gone = () => { throw new Error("Gitea API GET /repos/novox/app/pulls/9: 404 Not Found"); }; const down = () => { throw new Error("Gitea API GET /repos/novox/app/x: 502 Bad Gateway"); }; + const unauthorized = () => { throw new Error("Gitea API /repos/novox/app/pulls/9: 401 Unauthorized"); }; const pr = { number: 9, title: "t", state: "open", merged: false, head: "feat/x", head_sha: SHA, base: "main", user: "jochen", html_url: "http://f/9", mergeable: true }; const tagged: string[] = []; let comments: { id: number; body: string }[] = [], noteShown = "", added = 0, noteWritten = 0; @@ -483,7 +484,8 @@ test("every read and act of the seat git answers its contract, and an error is a appliedProtection: async () => ({ rule_name: "main", enable_status_check: true, status_check_contexts: ["mesh/check"] }), getRepo: async () => ({ writes: true }), openPulls: async () => [{ owner: "novox", repo: "app", number: 9, base: "main", head: "feat/x", head_sha: SHA, required: ["mesh/check"], checks: {} }], - tags: async () => ["go/v0.1.1", "go/v0.1.0", "v1"], + forgeVersion: async () => ({ ok: true, version: "1.27.3" }), + tags: async () => [{ tag: "go/v0.1.1", commit: SHA }, { tag: "go/v0.1.0", commit: OTHER }, { tag: "v1", commit: SHA }], commitTrees: async () => ({ root: SHA, trees: { "": SHA } }), getFile: async (_o: string, _r: string, path: string) => (path === "gone" ? (() => { throw new Error("Gitea API GET /repos/novox/app/contents/gone: 404 Not Found"); })() : path === "down" ? down() : { path, sha: OTHER, size: 3, content: "abc" }), compare: async () => ({ total_commits: 2, commits: [{ sha: OTHER }, { sha: SHA }] }), @@ -505,11 +507,18 @@ test("every read and act of the seat git answers its contract, and an error is a ["pull", "by merge commit", { repository: "novox/app", "merge-commit": OTHER }, {}, (a) => [a.pull.state, a.pull["merge-commit"], a.merging], ["merged", OTHER, undefined]], ["pull", "unknown", { repository: "novox/app", number: 404 }, {}, (a) => [a.pull, a["error-kind"]], [undefined, "not-found"]], ["pull", "forge down", { repository: "novox/app", number: 9 }, { getPullRequest: down }, (a) => [a.pull, a["error-kind"]], [undefined, "failed"]], + // 47 H2 §776: a 401, 502, 503 or connection fault is away when the forge's version read fails or names its store + // unavailable; with the read passing a 401 (the fresh token refused too) is the forge refusing the mesh's admin account. + ["pull", "502 and the version read failing is away", { repository: "novox/app", number: 9 }, { getPullRequest: down, forgeVersion: async () => ({ ok: false, words: "no answer", store: false }) }, (a) => [a.pull, a["error-kind"], a.part], [undefined, "away", "the forge"]], + ["pull", "401 and the store named unavailable is away", { repository: "novox/app", number: 9 }, { getPullRequest: unauthorized, forgeVersion: async () => ({ ok: false, words: "database is down", store: true }) }, (a) => [a["error-kind"], a.part, /401/.test(a.words)], ["away", "the forge's store", true]], + ["pull", "a connection fault and the version read failing is away", { repository: "novox/app", number: 9 }, { getPullRequest: async () => { throw new TypeError("fetch failed"); }, forgeVersion: async () => ({ ok: false, words: "fetch failed", store: false }) }, (a) => [a["error-kind"]], ["away"]], + ["pull", "401 with the version read passing is refused", { repository: "novox/app", number: 9 }, { getPullRequest: unauthorized }, (a) => [a["error-kind"], /refuses the mesh's admin account/.test(a.error), /[Cc]reate/.test(a.error)], ["refused", true, false]], ["branch", "a branch's head, no protection read (ADR 0682 §13)", { repository: "novox/app", branch: "main" }, { branchHead: async () => SHA, appliedProtection: async () => { throw new Error("read"); } }, (a) => [a.head, a.protected, a.error], [SHA, undefined, undefined]], ["branch", "no such branch", { repository: "novox/app", branch: "nope" }, { branchHead: gone }, (a) => [a.head, a["error-kind"]], [undefined, "not-found"]], ["open-pulls", "one", {}, {}, (a) => [a.pulls.length, a.pulls[0].required], [1, ["mesh/check"]]], ["open-pulls", "forge down", {}, { openPulls: down }, (a) => [a.pulls, a["error-kind"]], [undefined, "failed"]], - ["tags", "a page", { repository: "novox/app", prefix: "go/" }, {}, (a) => [a.tags, a.page, a.bound, a.more], [["go/v0.1.1", "go/v0.1.0"], 1, 50, undefined]], + // 47 H2 §796: each tag names its commit, at the seat's form 2. + ["tags", "a page, each tag with its commit", { repository: "novox/app", prefix: "go/" }, {}, (a) => [a.tags, a.page, a.bound, a.more, a.form], [[{ tag: "go/v0.1.1", commit: SHA }, { tag: "go/v0.1.0", commit: OTHER }], 1, 50, undefined, 2]], ["tags", "forge down", { repository: "novox/app" }, { tags: down }, (a) => [a.tags, a["error-kind"]], [undefined, "failed"]], ["trees", "root", { repository: "novox/app", commit: SHA }, {}, (a) => [a.commit, a.root], [SHA, SHA]], ["trees", "forge down", { repository: "novox/app", commit: SHA }, { commitTrees: down }, (a) => [a.root, a["error-kind"]], [undefined, "failed"]], @@ -523,6 +532,9 @@ test("every read and act of the seat git answers its contract, and an error is a ["tag", "written", { repository: "novox/app", tag: "go/v1.2.3", commit: SHA }, { tagCommit: async () => null, createTag: async (_o: string, _r: string, tag: string, c: string) => { tagged.push(`${tag}@${c}`); } }, (a) => [a.performed, tagged.splice(0)], [true, [`go/v1.2.3@${SHA}`]]], ["tag", "already at that commit", { repository: "novox/app", tag: "go/v1.2.3", commit: SHA }, { tagCommit: async () => SHA, createTag: async () => { throw new Error("written again"); } }, (a) => [a.performed, a.error], [true, undefined]], ["tag", "at another commit is never moved", { repository: "novox/app", tag: "go/v1.2.3", commit: SHA }, { tagCommit: async () => OTHER }, (a) => [a.performed, a["error-kind"]], [undefined, "refused"]], + // 47 H2 §796: a Go package's tag is /v. + ["tag", "a package directory's version", { repository: "novox/app", tag: "modules/x/go/v1.2.3", commit: SHA }, { tagCommit: async () => null, createTag: async (_o: string, _r: string, tag: string, c: string) => { tagged.push(`${tag}@${c}`); } }, (a) => [a.performed, tagged.splice(0)], [true, [`modules/x/go/v1.2.3@${SHA}`]]], + ["tag", "no directory", { repository: "novox/app", tag: "v1.2.3", commit: SHA }, {}, (a) => [a.performed, a["error-kind"]], [undefined, "refused"]], ["tag", "no Go version", { repository: "novox/app", tag: "v1", commit: SHA }, {}, (a) => [a.performed, a["error-kind"]], [undefined, "refused"]], ["status", "refused state", { id: "s1", repository: "novox/app", commit: SHA, context: "c", state: "bogus" }, {}, (a) => [a.performed, a["error-kind"]], [undefined, "refused"]], ["comment", "first time", { id: "c1", repository: "novox/app", number: 9, text: "hi" }, {}, (a) => [a.performed, a.held, added], [true, undefined, 1]], diff --git a/modules/gitea/test/kept.test.ts b/modules/gitea/test/kept.test.ts index d4a1cb604..5595321c0 100644 --- a/modules/gitea/test/kept.test.ts +++ b/modules/gitea/test/kept.test.ts @@ -16,8 +16,8 @@ test("the states the module announces are the states its manifest declares", asy test("the announcement has the layout mesh-sdk's go/announce reads: version 1, the module, the node, the states sorted by name", async () => { const { statesAnnouncement } = await import("../kept.ts"); - assert.deepEqual(statesAnnouncement("gitea", "ace"), { v: 1, module: "gitea", node: "ace", states: [{ name: "announced" }, { name: "bound", readable: true }, { name: "calls" }, { name: "failed-steps" }, { name: "findings", readable: true }, { name: "first-views" }, { name: "idle" }, { name: "transfers" }] }); - assert.deepEqual(statesAnnouncement("gitea", undefined), { v: 1, module: "gitea", states: [{ name: "announced" }, { name: "bound", readable: true }, { name: "calls" }, { name: "failed-steps" }, { name: "findings", readable: true }, { name: "first-views" }, { name: "idle" }, { name: "transfers" }] }); + assert.deepEqual(statesAnnouncement("gitea", "ace"), { v: 1, module: "gitea", node: "ace", states: [{ name: "announced" }, { name: "bound", readable: true }, { name: "calls" }, { name: "failed-steps" }, { name: "findings", readable: true }, { name: "first-views" }, { name: "idle" }, { name: "taken" }, { name: "token-lease" }, { name: "transfers" }] }); + assert.deepEqual(statesAnnouncement("gitea", undefined), { v: 1, module: "gitea", states: [{ name: "announced" }, { name: "bound", readable: true }, { name: "calls" }, { name: "failed-steps" }, { name: "findings", readable: true }, { name: "first-views" }, { name: "idle" }, { name: "taken" }, { name: "token-lease" }, { name: "transfers" }] }); }); test("index.ts says the announcement as the event `states` before the tools are served", () => { diff --git a/modules/gitea/test/paging.test.ts b/modules/gitea/test/paging.test.ts index 8bf0bcca9..f5d3010c4 100644 --- a/modules/gitea/test/paging.test.ts +++ b/modules/gitea/test/paging.test.ts @@ -108,3 +108,48 @@ test("a file over 512 KiB is refused from its directory listing, and its body is await new Promise((r) => server.close(() => r())); } }); + +// 47 H2 §796: a tag names its commit; a tag the forge names no commit for is an error, never a tag without one. +test("the forge's tags are read with the commit each names", async () => { + const { GiteaClient } = await import("../client.ts"); + let body: unknown[] = []; + const server = createServer((_req, res) => res.end(JSON.stringify(body))); + await new Promise((r) => server.listen(0, r)); + try { + const client = new GiteaClient(`http://127.0.0.1:${(server.address() as any).port}`, "t"); + body = [{ name: "go/v0.1.1", commit: { sha: "a".repeat(40) } }, { name: "go/v0.1.0", commit: { sha: "b".repeat(40) } }]; + assert.deepEqual(await client.tags("novox", "hq", 1, 51), [{ tag: "go/v0.1.1", commit: "a".repeat(40) }, { tag: "go/v0.1.0", commit: "b".repeat(40) }]); + body = [{ name: "go/v0.1.2" }]; + await assert.rejects(client.tags("novox", "hq", 1, 51), /named no commit for novox\/hq's tag go\/v0.1.2/); + } finally { + server.close(); + } +}); + +// 47 H2 §776: the forge's own version read, unauthenticated, tells the forge away from its refusal. +test("the forge's version read says whether the forge answers and whether its store is away", async () => { + const { GiteaClient } = await import("../client.ts"); + let status = 200, body = `{"version":"1.27.3"}`; + const auth: (string | undefined)[] = []; + const server = createServer((req, res) => { auth.push(req.headers.authorization); res.statusCode = status; res.end(body); }); + await new Promise((r) => server.listen(0, r)); + const port = (server.address() as any).port; + try { + const client = new GiteaClient(`http://127.0.0.1:${port}`, "t"); + const rows: [number, string, unknown][] = [ + [200, `{"version":"1.27.3"}`, { ok: true, version: "1.27.3" }], + [500, "database is locked", { ok: false, store: true }], + [503, "Service Unavailable", { ok: false, store: false }], + ]; + for (const [s, b, want] of rows) { + status = s; body = b; + const got: any = await client.forgeVersion(); + assert.deepEqual(got.ok ? got : { ok: got.ok, store: got.store }, want, `${s} ${b}`); + } + assert.deepEqual(auth.filter(Boolean), [], "the version read is unauthenticated"); + } finally { + server.close(); + } + const gone: any = await new GiteaClient(`http://127.0.0.1:${port}`, "t").forgeVersion(); + assert.deepEqual([gone.ok, gone.store], [false, false]); +}); diff --git a/modules/gitea/test/taken.test.ts b/modules/gitea/test/taken.test.ts new file mode 100644 index 000000000..c053ae422 --- /dev/null +++ b/modules/gitea/test/taken.test.ts @@ -0,0 +1,63 @@ +import assert from "node:assert/strict"; +import { test } from "node:test"; + +// 47 H2 §775, H-A-381, H-A-400: the forge module takes an act of the seat git once by its ask id. Given the same ask id +// twice it acts once: a repeat while the act runs joins it, a repeat after it ended answers what the forge holds of the +// act; an act that performed nothing (away, a refusal before any merge) drops its key, so the repeat acts. +test("an act of the seat git given the same ask id twice acts once", async () => { + const { seatTools } = await import("../dist/seat.js"); + const { Once, durationMs, askTakenBoundMs } = await import("../dist/taken.js"); + const { runAs } = await import("@novox/mesh-sdk/callers"); + const SHA = "a".repeat(40), MERGE = "c".repeat(40); + const keys = new Set(); + const taken = { take: async (ask: string) => (keys.has(ask) ? false : (keys.add(ask), true)), drop: async (ask: string) => { keys.delete(ask); } }; + let merges = 0, comments: { id: number; body: string }[] = [], added = 0, away = false; + const pr = () => ({ number: 9, state: merges ? "closed" : "open", merged: merges > 0, head: "feat/x", head_sha: SHA, base: "main", ...(merges ? { merge_commit_sha: MERGE } : {}) }); + let release: () => void = () => {}, entered: () => void = () => {}; + const merging = new Promise((r) => { entered = r; }); + const forge: Record = { + forgeVersion: async () => (away ? { ok: false, words: "no answer", store: true } : { ok: true, version: "1.27.3" }), + getPullRequest: async () => { if (away) throw new Error("Gitea API /repos/novox/app/pulls/9: 503 Service Unavailable"); return pr(); }, + mergePullRequest: async () => { const held = new Promise((r) => { release = r; }); entered(); await held; merges++; }, + commitParents: async () => [SHA, SHA], + listComments: async () => comments, + addComment: async (_o: string, _r: string, _n: number, body: string) => { added++; comments.push({ id: added, body }); }, + }; + const seat = seatTools(forge as any, { run: (async () => ({ stdout: "", code: 1 })) as any, container: "gitea", registered: () => true, + judge: async () => null, watched: () => new Map([["novox/app", new Set(["main"])]]), once: new Once(taken) }); + const call = (verb: string, ask: string, args: Record) => + runAs({ "mesh/caller": "ace.x", "mesh/ask": ask }, args, () => seat.find((x: any) => x.name === `git.${verb}`)!.run(args)) as Promise; + const merge = { by: "lead@shanks", pulls: [{ repository: "novox/app", number: 9, head: SHA }] }; + + // Away first: nothing performed, the key dropped, so the kept call's repeat under the same id acts (H-A-400 (1)). + away = true; + assert.equal((await call("merge-pull", "ask1", merge))["error-kind"], "away"); + assert.equal(keys.has("ask1"), false, "an act that performed nothing keeps no taken key"); + away = false; + + // The repeat while the first runs joins it: one merge, both answered the same. + const first = call("merge-pull", "ask1", merge); + await merging; + const joined = call("merge-pull", "ask1", merge); + release(); + const [a, b] = await Promise.all([first, joined]); + assert.equal(merges, 1, "a repeat while the act runs joins it"); + assert.deepEqual(b, a); + assert.equal(a.members[0].state, "merged"); + + // After it ended, the repeat answers the pull request as the forge holds it, merged with its merge commit, and merges nothing. + const again = await call("merge-pull", "ask1", merge); + assert.deepEqual([merges, again.members], [1, [{ repository: "novox/app", number: 9, state: "merged", commit: MERGE }]]); + + // A comment given its ask again is not written twice; a repeat whose comment the forge does not hold is refused, naming it. + const comment = { id: "c1", repository: "novox/app", number: 9, text: "hi" }; + assert.equal((await call("comment", "ask2", comment)).performed, true); + assert.deepEqual([(await call("comment", "ask2", comment)).held, added], [true, 1]); + comments = []; + const gone = await call("comment", "ask2", comment); + assert.deepEqual([gone["error-kind"], /ask2 was taken/.test(gone.error), added], ["refused", true, 1]); + + // ask-taken-bound is read from the word the node-engine composes (H-A-400 (2)), 10 minutes by default. + assert.deepEqual([askTakenBoundMs({}), askTakenBoundMs({ MESH_CONFIG_ASK_TAKEN_BOUND: "90s" }), askTakenBoundMs({ MESH_CONFIG_ASK_TAKEN_BOUND: "soon" }), durationMs("1h30m")], + [600_000, 90_000, 600_000, 5_400_000]); +}); diff --git a/modules/gitea/test/token.test.ts b/modules/gitea/test/token.test.ts index a33477b82..0bd3e0008 100644 --- a/modules/gitea/test/token.test.ts +++ b/modules/gitea/test/token.test.ts @@ -10,15 +10,19 @@ import { test, after } from "node:test"; import assert from "node:assert/strict"; import { createServer, type IncomingMessage, type ServerResponse } from "node:http"; -import { mkdir, mkdtemp, readFile, rm, stat, writeFile } from "node:fs/promises"; +import { mkdtemp, stat, writeFile } from "node:fs/promises"; import { tmpdir } from "node:os"; import { join } from "node:path"; import { collectTools } from "@novox/mesh-sdk/tools"; -import { AdminRefused, MintedToken, TOKEN_SCOPES } from "../dist/token.js"; +import { AdminRefused, MintedToken, TOKEN_NAME, TOKEN_SCOPES, leaseOverState, openValue, vaultOverBus, vaultValue, type MintedTokenOptions } from "../dist/token.js"; +import { tokenLeaseTool } from "../dist/tools/tokenlease.js"; +import { fakeBus } from "./fakebus.ts"; import { GiteaClient } from "../dist/client.js"; import { getGiteaTools } from "../dist/tools/index.js"; +/** What the vault and the forge were asked, in order: each own-put and each token deleted (design 47 H2 §808). */ +const ORDER: string[] = []; const ADMIN = "mesh-admin"; const PASSWORD = "the-vault-minted-this"; @@ -126,6 +130,7 @@ function fakeForge(): Promise { if (matches.length > 1) return json(res, 422, { message: `multiple matches for token name '${key}'` }); const t = matches[0]; forge.deletedBy.push(byId ? "id" : "name"); + ORDER.push(`delete ${t.name}`); const twin = forge.twins.findIndex((w) => w.id === t.id); if (twin >= 0) forge.twins.splice(twin, 1); else forge.tokens.delete(t.name); @@ -253,58 +258,62 @@ function fakeForge(): Promise { // ---- What the runtime's environment gives the module. ---- -async function delivered(forge: Forge): Promise<{ env: NodeJS.ProcessEnv; file: string; logs: string[] }> { +async function delivered(forge: Forge, now: () => Date = () => new Date()) { const dir = await mkdtemp(join(tmpdir(), "gitea-")); const passwordFile = join(dir, "admin.secret"); await writeFile(passwordFile, PASSWORD + "\n", { mode: 0o600 }); - const state = join(dir, "state"); + ORDER.length = 0; return { env: { MESH_GITEA_URL: forge.url, MESH_GITEA_ADMIN_USER: ADMIN, MESH_GITEA_ADMIN_PASSWORD_FILE: passwordFile, - MESH_GITEA_STATE_DIR: state, - }, - file: join(state, "token"), - logs: [], + MESH_GITEA_STATE_DIR: join(dir, "state"), + } as NodeJS.ProcessEnv, + bus: fakeBus(now, ORDER), + logs: [] as string[], }; } -/** A client as a fresh process would build it: a new source over the kept file, its log captured. */ -function minted(env: NodeJS.ProcessEnv, logs: string[]): GiteaClient { - const source = new MintedToken({ - url: env.MESH_GITEA_URL!, - admin: env.MESH_GITEA_ADMIN_USER!, - passwordFile: env.MESH_GITEA_ADMIN_PASSWORD_FILE!, - file: join(env.MESH_GITEA_STATE_DIR!, "token"), - log: (l) => logs.push(l), - }); - return new GiteaClient(env.MESH_GITEA_URL!, source); +/** A client as a fresh process would build it: a new source over the vault and the lease on the bus, its log captured. */ +function minted(env: NodeJS.ProcessEnv, logs: string[], extra: Partial = {}): GiteaClient { + return new GiteaClient(env.MESH_GITEA_URL!, source(env, logs, extra)); } +function source(env: NodeJS.ProcessEnv, logs: string[], extra: Partial = {}): MintedToken { + return new MintedToken({ + url: env.MESH_GITEA_URL!, admin: env.MESH_GITEA_ADMIN_USER!, passwordFile: env.MESH_GITEA_ADMIN_PASSWORD_FILE!, + account: "mesh-tools", oldName: TOKEN_NAME, vault: vaultOverBus(), lease: leaseOverState(), log: (l) => logs.push(l), ...extra, + }); +} + +const VAULT = "module/gitea/mesh-tools"; +/** The token the vault keeps for the tools' account, out of the value that holds it with its scopes (H-A-439). */ +const vaulted = (bus: ReturnType) => openValue(bus.vault.get(VAULT)?.value ?? "").token; const forge = await fakeForge(); after(() => forge.close()); -test("first start: mints with the admin account, keeps the token at 0600, asks for the tools' scopes only", async () => { - const { env, file, logs } = await delivered(forge); +test("first start: mints mesh-tools-1 with the admin account, writes it through own-put, asks for the tools' scopes only", async () => { + const { env, bus, logs } = await delivered(forge); + forge.tokens.clear(); const repos = await minted(env, logs).listRepos(); assert.equal(repos[0]?.full_name, "novox/hq"); - assert.equal(forge.mints, 1); // Never write:admin (novox/hq ADR 0266): the forge's administration is the operator's, not a tool's. assert.deepEqual(forge.lastScopes, ["write:repository", "write:issue", "read:user", "read:package"]); assert.deepEqual(forge.lastScopes, [...TOKEN_SCOPES]); - const token = forge.tokens.get("mesh-tools")!; - assert.equal(await readFile(file, "utf8"), token + "\n"); - assert.equal(await readFile(file + ".scopes", "utf8"), "read:package,read:user,write:issue,write:repository\n"); - assert.equal((await stat(file)).mode & 0o777, 0o600); - // Said that it minted, and where it keeps it — never what it is. - assert.ok(logs.some((l) => l.startsWith("minted a token")), logs.join("\n")); + // Design 47 H2 §808, H-A-422 (2), H-A-426: named per mint, kept as the module's own secret, never a file. + const token = forge.tokens.get("mesh-tools-1")!; + assert.ok(token); + assert.deepEqual([vaulted(bus), bus.vault.get(VAULT)?.generation], [token, 1]); + assert.deepEqual(openValue(bus.vault.get(VAULT)!.value).scopes, [...TOKEN_SCOPES], "kept with the scopes it was minted with (H-A-439)"); + await assert.rejects(stat(join(env.MESH_GITEA_STATE_DIR!, "token")), /ENOENT/); + assert.ok(logs.some((l) => l.startsWith("minted mesh-tools-1")), logs.join("\n")); assert.ok(logs.every((l) => !l.includes(token) && !l.includes(PASSWORD)), logs.join("\n")); }); -test("second start: reuses the kept token, mints nothing", async () => { +test("second start: reuses the vault's token, mints nothing", async () => { const { env, logs } = await delivered(forge); await minted(env, logs).listRepos(); const before = forge.mints; @@ -313,54 +322,83 @@ test("second start: reuses the kept token, mints nothing", async () => { await minted(env, again).listRepos(); assert.equal(forge.mints, before); - assert.ok(again.some((l) => l.startsWith("reusing the token kept at")), again.join("\n")); - assert.ok(again.every((l) => !l.includes(forge.tokens.get("mesh-tools")!)), again.join("\n")); + assert.ok(again.some((l) => l.startsWith(`reusing the token the vault keeps as ${VAULT}`)), again.join("\n")); }); -test("the forge rejects the kept token (its data was restored): minted afresh, once, and the call goes through", async () => { - const { env, file, logs } = await delivered(forge); +test("the forge rejects the vault's token: mesh-tools-2 is minted once, written through own-put, and only then is mesh-tools-1 deleted by its id", async () => { + const { env, bus, logs } = await delivered(forge); + forge.tokens.clear(); const client = minted(env, logs); await client.listRepos(); const before = forge.mints; + ORDER.length = 0; + forge.deletedBy.length = 0; - forge.tokens.clear(); // the forge no longer knows any token — a restore from the predecessor + forge.tokens.set("mesh-tools-1", "revoked-meanwhile"); // the forge no longer takes the vault's token const repos = await client.listRepos(); assert.equal(repos.length, 1); assert.equal(forge.mints, before + 1); - assert.equal(await readFile(file, "utf8"), forge.tokens.get("mesh-tools") + "\n"); - assert.ok(logs.some((l) => l.startsWith("the forge rejected the kept token")), logs.join("\n")); + assert.equal(vaulted(bus), forge.tokens.get("mesh-tools-2")); + // H-A-422 (2): the own-put first, the replaced token's delete after, by id; the forge holds one tools' token after. + assert.deepEqual(ORDER, [`own-put ${VAULT} 2`, "delete mesh-tools-1"]); + assert.deepEqual(forge.deletedBy, ["id"]); + assert.deepEqual([...forge.tokens.keys()].filter((n) => n.startsWith("mesh-tools")), ["mesh-tools-2"]); + assert.ok(logs.some((l) => l.startsWith("the forge rejected the vault's token")), logs.join("\n")); }); -test("a token kept with write:admin by an earlier build is minted again without it at the next start, and the forge drops the old one", async () => { - const { env, file, logs } = await delivered(forge); - await minted(env, logs).listRepos(); - const old = forge.tokens.get("mesh-tools")!; - forge.scopesOf.set(old, ["write:repository", "write:issue", "read:user", "write:admin"]); - await rm(file + ".scopes"); // an earlier build kept no scopes beside it +test("an own-put that fails leaves the old token standing, and the next mint replaces the unused one it left", async () => { + const { env, bus, logs } = await delivered(forge); + forge.tokens.clear(); + const client = minted(env, logs); + await client.listRepos(); + const old = forge.tokens.get("mesh-tools-1")!; + forge.tokens.set("mesh-tools-1", "revoked-meanwhile"); + ORDER.length = 0; + let failPut = true; + const failing = minted(env, logs, { vault: { get: vaultOverBus().get, put: async (a, t, scopes) => { + if (failPut) { failPut = false; throw new Error("the vault is away"); } + return vaultOverBus().put(a, t, scopes); + } } }); + + await assert.rejects(failing.listRepos(), /the vault is away/); + assert.deepEqual(ORDER, [], "nothing deleted while the vault holds the old token"); + assert.equal(bus.vault.get(VAULT)?.generation, 1); + assert.ok(forge.tokens.has("mesh-tools-2"), "the unused token of the failed mint stands"); + + assert.equal((await failing.listRepos()).length, 1); + assert.deepEqual(ORDER, ["delete mesh-tools-2", `own-put ${VAULT} 2`, "delete mesh-tools-1"]); + assert.notEqual(vaulted(bus), old); +}); + +test("a token older than token-ttl is minted again, and the one it replaces deleted", async () => { + let clock = Date.parse("2026-11-22T00:00:00Z"); + const now = () => new Date(clock); + const { env, bus, logs } = await delivered(forge, now); + forge.tokens.clear(); + const client = minted(env, logs, { now, ttlMs: 24 * 3600_000 }); + await client.listRepos(); const before = forge.mints; - const again: string[] = []; - await minted(env, again).listRepos(); + clock += 23 * 3600_000; + await client.listRepos(); + assert.equal(forge.mints, before, "a token within token-ttl is used"); + clock += 2 * 3600_000; + await client.listRepos(); assert.equal(forge.mints, before + 1); - assert.deepEqual(forge.lastScopes, [...TOKEN_SCOPES]); - assert.ok(!forge.lastScopes!.includes("write:admin")); - assert.notEqual(forge.tokens.get("mesh-tools"), old); - assert.ok(![...forge.tokens.values()].includes(old), "the old token still stands on the forge"); - assert.ok(again.some((l) => l.includes("minted with other scopes")), again.join("\n")); - // An admin route through the escape hatch is refused before it is sent. - const tool = getGiteaTools(minted(env, again)).find((t) => t.name === "gitea_api")!; - await assert.rejects(tool.run({ path: "/admin/users/mesh_novox_builder", method: "PATCH", body: { admin: true } }), - /not a write gitea_api makes/); + assert.equal(bus.vault.get(VAULT)?.generation, 2); + assert.deepEqual([...forge.tokens.keys()].filter((n) => n.startsWith("mesh-tools")), ["mesh-tools-2"]); + assert.ok(logs.some((l) => l.includes("older than token-ttl")), logs.join("\n")); }); -test("a kept token lacking a scope the tools need: the forge refuses the call for the scope, the token is re-minted with the whole list, and the call goes through", async () => { - const { env, file, logs } = await delivered(forge); +test("a token lacking a scope the tools need: the forge refuses the call for the scope, the token is re-minted with the whole list, and the call goes through", async (t) => { + const { env, bus, logs } = await delivered(forge); + forge.tokens.clear(); const client = minted(env, logs); await client.listRepos(); const before = forge.mints; - const old = forge.tokens.get("mesh-tools")!; + const old = forge.tokens.get("mesh-tools-1")!; forge.scopesOf.set(old, ["write:repository", "write:issue"]); // minted before read:user was added const repos = await client.api("/user/repos"); @@ -368,37 +406,37 @@ test("a kept token lacking a scope the tools need: the forge refuses the call fo assert.equal(repos.length, 1); assert.equal(forge.mints, before + 1); assert.deepEqual(forge.lastScopes, [...TOKEN_SCOPES]); - assert.notEqual(forge.tokens.get("mesh-tools"), old); - assert.equal(await readFile(file, "utf8"), forge.tokens.get("mesh-tools") + "\n"); - assert.ok(logs.some((l) => l.startsWith("the forge rejected the kept token")), logs.join("\n")); + assert.equal(vaulted(bus), forge.tokens.get("mesh-tools-2")); + + // Design 47 H2 §808, H-A-439: the vault keeps the scopes beside the token, so one carrying a scope beyond the tools' + // is minted again unasked, as when they were kept in a file beside it. + await t.test("a token kept with write:admin is minted again without it at the next start, and the forge drops the old one", async () => { + const { env, bus, logs } = await delivered(forge); + forge.tokens.clear(); + await minted(env, logs).listRepos(); + const old = forge.tokens.get("mesh-tools-1")!; + // An earlier mint asked write:admin too, and the vault keeps what it asked. + bus.vault.get(VAULT)!.value = vaultValue(old, [...TOKEN_SCOPES, "write:admin"]); + forge.scopesOf.set(old, [...TOKEN_SCOPES, "write:admin"]); + const before = forge.mints; + + const again: string[] = []; + await minted(env, again).listRepos(); + + assert.equal(forge.mints, before + 1); + assert.deepEqual(forge.lastScopes, [...TOKEN_SCOPES]); + assert.ok(![...forge.tokens.values()].includes(old), "the old token still stands on the forge"); + assert.deepEqual(openValue(bus.vault.get(VAULT)!.value), { token: forge.tokens.get("mesh-tools-2"), scopes: [...TOKEN_SCOPES] }); + assert.ok(again.some((l) => l.includes("minted with other scopes")), again.join("\n")); + // An admin route through the escape hatch is refused before it is sent. + const tool = getGiteaTools(minted(env, again)).find((x) => x.name === "gitea_api")!; + await assert.rejects(tool.run({ path: "/admin/users/mesh_novox_builder", method: "PATCH", body: { admin: true } }, undefined as never), + /not a write gitea_api makes/); + }); }); -test("the kept file is gone but the forge still holds a token by that name: replaced, not refused", async () => { - const { env, file, logs } = await delivered(forge); - await minted(env, logs).listRepos(); - const before = forge.mints; - await rm(file); - - const repos = await minted(env, logs).listRepos(); - - assert.equal(repos.length, 1); - assert.equal(forge.mints, before + 1); - assert.equal([...forge.tokens.keys()].filter((n) => n === "mesh-tools").length, 1); - assert.ok(logs.some((l) => l.includes('already holds a token named "mesh-tools"')), logs.join("\n")); -}); - -test("concurrent first calls share one mint", async () => { +test("the first mint deletes by id every token under the old fixed name, two raced ones too, and keeps the account's others", async () => { const { env, logs } = await delivered(forge); - const client = minted(env, logs); - const before = forge.mints; - - await Promise.all([client.listRepos(), client.listRepos(), client.listRepos()]); - - assert.equal(forge.mints, before + 1); -}); - -test("two tokens hold the name (two mints raced): both are deleted by their id, and one fresh token is minted", async () => { - const { env, file, logs } = await delivered(forge); forge.tokens.clear(); forge.twins.length = 0; for (const other of ["laptop", "backup", "ci"]) forge.plant(other); // the account's other tokens: kept @@ -411,44 +449,68 @@ test("two tokens hold the name (two mints raced): both are deleted by their id, assert.equal(repos.length, 1); assert.equal(forge.mints, before + 1); + // H-A-430 (1): the tokens the module kept before under the old fixed name are the ones the first mint replaces. assert.deepEqual(forge.deletedBy, ["id", "id"]); + assert.deepEqual(ORDER, [`own-put ${VAULT} 1`, "delete mesh-tools", "delete mesh-tools"]); assert.equal(forge.twins.length, 0); - assert.deepEqual([...forge.tokens.keys()].sort(), ["backup", "ci", "laptop", "mesh-tools"]); - assert.equal(await readFile(file, "utf8"), forge.tokens.get("mesh-tools") + "\n"); - assert.ok(logs.some((l) => l.includes('holds 2 tokens named "mesh-tools"')), logs.join("\n")); + assert.deepEqual([...forge.tokens.keys()].sort(), ["backup", "ci", "laptop", "mesh-tools-1"]); }); -test("two processes on one kept file, both without a token, mint once: the second waits for the first and reuses it", async () => { +test("concurrent first calls share one mint", async () => { const { env, logs } = await delivered(forge); forge.tokens.clear(); - forge.twins.length = 0; + const client = minted(env, logs); const before = forge.mints; - // Two sources over one state directory, as the tools bundle and the watcher are two processes. - const first = minted(env, logs); - const second = minted(env, logs); - await Promise.all([first.listRepos(), second.listRepos()]); + await Promise.all([client.listRepos(), client.listRepos(), client.listRepos()]); assert.equal(forge.mints, before + 1); - assert.equal(forge.twins.length, 0); - assert.ok(logs.some((l) => l.includes("another process minted it")), logs.join("\n")); }); -test("a lock left by a process that died mid-mint is taken over, not waited on for ever", async () => { - const { env, file, logs } = await delivered(forge); +test("two processes, one holding the old token, both refused, mint one token in all: the second waits for the lease and uses the vault's newer token", async () => { + const { env, bus, logs } = await delivered(forge); forge.tokens.clear(); forge.twins.length = 0; - await mkdir(join(env.MESH_GITEA_STATE_DIR!), { recursive: true }); - await writeFile(`${file}.lock`, `2147483646 ${Date.now()} gone\n`); // a pid no process holds + const first = minted(env, logs); + await first.listRepos(); + const second = minted(env, logs); + await second.listRepos(); // both hold mesh-tools-1 const before = forge.mints; - assert.equal((await minted(env, logs).listRepos()).length, 1); + forge.tokens.set("mesh-tools-1", "revoked-meanwhile"); + await Promise.all([first.listRepos(), second.listRepos()]); + + // Design 47 H2 §808: one mint in all, and the forge holds one token for the account after. assert.equal(forge.mints, before + 1); - await assert.rejects(stat(`${file}.lock`), /ENOENT/); + assert.deepEqual([...forge.tokens.keys()].filter((n) => n.startsWith("mesh-tools")), ["mesh-tools-2"]); + assert.equal(bus.vault.get(VAULT)?.generation, 2); + assert.ok(logs.some((l) => l.includes("another process holds the mint lease")), logs.join("\n")); + assert.equal(bus.kv.size, 0, "the lease is deleted after the mint"); +}); + +test("a minter killed while holding the lease is replaced after mint-lease: the waiter creates the lease itself and mints", async () => { + let clock = Date.parse("2026-11-22T00:00:00Z"); + const now = () => new Date(clock); + const { env, bus, logs } = await delivered(forge, now); + forge.tokens.clear(); + // A process that took the lease and died: its key lives mint-lease (60 s) and nobody deletes it. + await bus.ask("mesh/state.create", { state: "token-lease", key: "mint", value: { holder: "ace/4242", since: now().toISOString() }, ttl_seconds: 60 }); + const waited: number[] = []; + const lease = leaseOverState(); + // Waiting for the key to change: nothing changes, so the wait lasts its bound, the clock moving on by it. + const before = forge.mints; + + const repos = await minted(env, logs, { lease: { ...lease, changed: async (ms) => { waited.push(ms); clock += ms; } } }).listRepos(); + + assert.equal(repos.length, 1); + assert.deepEqual(waited, [60_000], "the waiter waited mint-lease once"); + assert.equal(forge.mints, before + 1); + assert.ok(logs.some((l) => l.includes("another process holds the mint lease (ace/4242 since")), logs.join("\n")); }); test("the admin account is refused: said plainly, nothing kept, and the next call fails the same way rather than crashing", async () => { - const { env, file, logs } = await delivered(forge); + const { env, bus, logs } = await delivered(forge); + forge.tokens.clear(); forge.admins.delete(ADMIN); // the forge's data came from a predecessor; mesh-admin was never created there try { const client = minted(env, logs); @@ -456,15 +518,15 @@ test("the admin account is refused: said plainly, nothing kept, and the next cal await assert.rejects(client.listRepos(), (err: unknown) => { assert.ok(err instanceof AdminRefused, String(err)); - assert.match(err.message, /refused the admin account "mesh-admin" \(401\)/); - assert.match(err.message, /admin-bootstrap step creates it/); - assert.match(err.message, /came from a predecessor/); + // 47 H2 §776: the forge's refusal, never worded as an account to create. + assert.match(err.message, /the forge refuses the mesh's admin account "mesh-admin" \(401\)/); + assert.doesNotMatch(err.message, /[Cc]reate/); assert.ok(!err.message.includes(PASSWORD)); return true; }); await assert.rejects(client.listRepos(), AdminRefused); assert.equal(forge.mints, before); - await assert.rejects(stat(file), /ENOENT/); + assert.equal(bus.vault.size, 0); // The account appears (the operator created it): the very next call mints and works. forge.admins.set(ADMIN, PASSWORD); @@ -475,25 +537,47 @@ test("the admin account is refused: said plainly, nothing kept, and the next cal } }); -test("one process shares one source per kept file — the watcher and the tools never renew against each other", async () => { +test("one process shares one source per account — the watcher and the tools never renew against each other", async () => { const { env } = await delivered(forge); assert.equal(MintedToken.fromEnv(env.MESH_GITEA_URL!, env), MintedToken.fromEnv(env.MESH_GITEA_URL!, env)); }); -test("a second process finds the token the first renewed, and reuses it instead of minting over it", async () => { +test("a second process finds the token the first renewed in the vault, and reuses it instead of minting over it", async () => { const { env, logs } = await delivered(forge); + forge.tokens.clear(); const first = minted(env, logs); const second = minted(env, logs); await first.listRepos(); - await second.listRepos(); // both hold the same kept token + await second.listRepos(); // both hold the same token const before = forge.mints; - forge.tokens.clear(); + forge.tokens.set("mesh-tools-1", "revoked-meanwhile"); await first.listRepos(); // renews: one mint - await second.listRepos(); // rejected too — but the kept file already carries the renewed one + await second.listRepos(); // rejected too — but the vault already holds the renewed one assert.equal(forge.mints, before + 1); - assert.ok(logs.some((l) => l.includes("is newer — reusing it")), logs.join("\n")); + assert.ok(logs.some((l) => l.includes("is newer (generation 2) — reusing it")), logs.join("\n")); +}); + +test("forge_token_lease says the lease's holder and since when, and each token's age from the vault, never the token", async () => { + let clock = Date.parse("2026-11-22T00:00:00Z"); + const now = () => new Date(clock); + const { env, bus, logs } = await delivered(forge, now); + forge.tokens.clear(); + await minted(env, logs, { now }).listRepos(); + await bus.ask("mesh/state.create", { state: "token-lease", key: "mint", value: { holder: "ace/4242", since: "2026-11-22T00:00:30Z" }, ttl_seconds: 60 }); + clock += 90_000; + const tool = tokenLeaseTool(vaultOverBus(), leaseOverState(), ["mesh-tools", "mesh-packages"], now); + + const said = await tool.run({}, undefined as never) as any; + + assert.equal(tool.name, "forge_token_lease"); + assert.deepEqual(said.tokens.map((t: any) => [t.account, t.held, t.generation, t["age-seconds"]]), + [["mesh-tools", true, 1, 90], ["mesh-packages", false, undefined, undefined]]); + assert.ok(!JSON.stringify(said).includes(vaulted(bus)), "the token is never said"); + // The lease lives mint-lease: past it, nobody holds it. + clock += 30_000; + assert.deepEqual((await tool.run({}, undefined as never) as any).lease, { held: false }); }); test("a configured token wins, and is reported rather than minted over when the forge rejects it", async () => { @@ -510,8 +594,8 @@ test("a configured token wins, and is reported rather than minted over when the test("nothing to mint with and no token: the client says what is missing", async () => { assert.throws( - () => GiteaClient.fromEnv({ MESH_GITEA_URL: forge.url, MESH_GITEA_ADMIN_USER: ADMIN }), - /set GITEA_TOKEN, or MESH_GITEA_ADMIN_PASSWORD_FILE, MESH_GITEA_STATE_DIR/, + () => GiteaClient.fromEnv({ MESH_GITEA_URL: forge.url, MESH_GITEA_ADMIN_USER: ADMIN, MESH_GITEA_TOOLS_USER: "mesh-tools-nothing" }), + /set GITEA_TOKEN, or MESH_GITEA_ADMIN_PASSWORD_FILE/, ); }); diff --git a/modules/gitea/test/tools-account.test.ts b/modules/gitea/test/tools-account.test.ts index 637d9ed1a..2ef7431a9 100644 --- a/modules/gitea/test/tools-account.test.ts +++ b/modules/gitea/test/tools-account.test.ts @@ -10,11 +10,12 @@ import { test, after } from "node:test"; import assert from "node:assert/strict"; import { createServer, type IncomingMessage, type ServerResponse } from "node:http"; -import { mkdtemp, readFile, writeFile, mkdir } from "node:fs/promises"; +import { mkdtemp, readFile, writeFile } from "node:fs/promises"; import { tmpdir } from "node:os"; import { join } from "node:path"; -import { MintedToken, TOKEN_SCOPES } from "../dist/token.js"; +import { MintedToken, TOKEN_NAME, TOKEN_SCOPES, leaseOverState, openValue, vaultOverBus } from "../dist/token.js"; +import { fakeBus } from "./fakebus.ts"; import { GiteaClient } from "../dist/client.js"; import { TOOLS_ACCOUNT, TOOLS_TEAM_UNITS, BUILDER_ACCOUNT, AGENT_ACCOUNT, meshAccounts } from "../dist/tools-account.js"; import { PACKAGES_ACCOUNT, PACKAGES_TEAM_UNITS, PACKAGES_TOKEN_REFUSED, keepPackagesToken, packagesToken, renewOnRefusal } from "../dist/packages-account.js"; @@ -266,7 +267,12 @@ function fakeForge() { const forge = await fakeForge(); after(() => forge.close()); +/** The bus of the environment made last: the vault's secrets and the lease (design 47 H2 §808). */ +let bus = fakeBus(); +const vaulted = (account: string) => { const v = bus.vault.get(`module/gitea/${account}`)?.value; return v === undefined ? undefined : openValue(v).token; }; + async function environment(keepMainRules = false): Promise { + bus = fakeBus(); const dir = await mkdtemp(join(tmpdir(), "gitea-tools-account-")); const passwordFile = join(dir, "admin.secret"); await writeFile(passwordFile, PASSWORD + "\n", { mode: 0o600 }); @@ -281,7 +287,7 @@ async function environment(keepMainRules = false): Promise t.name === "mesh-tools"); - assert.deepEqual(held.map((t) => t.user), [TOOLS_ACCOUNT], "the one token is the tools' account's, none is the administrator's"); - assert.equal(await readFile(join(env.MESH_GITEA_STATE_DIR, "token"), "utf8"), held[0].sha1 + "\n"); + const held = forge.tokens.filter((t) => t.name === "mesh-tools-1" || t.name === "mesh-tools"); + assert.deepEqual(held.map((t) => [t.user, t.name]), [[TOOLS_ACCOUNT, "mesh-tools-1"]], "the one token is the tools' account's, none is the administrator's"); + assert.equal(vaulted(TOOLS_ACCOUNT), held[0].sha1, "kept in the vault as the module's own (design 47 H2 §808)"); const team = forge.teams.find((t) => t.name === "mesh-tools"); assert.ok(team, "the team is made in the mesh's organisation"); @@ -334,17 +340,13 @@ test("the administrator's token from before goes: a kept admin token is minted a // What the module kept before ADR 0365: a token of the administrator's own, by the same name, its scopes beside it. const old = { id: 900, name: "mesh-tools", sha1: "sha-admin-old", user: ADMIN, scopes: ["write:repository", "write:issue", "read:user"] }; forge.tokens.push(old); - await mkdir(env.MESH_GITEA_STATE_DIR, { recursive: true }); - await writeFile(join(env.MESH_GITEA_STATE_DIR, "token"), old.sha1 + "\n", { mode: 0o600 }); - await writeFile(join(env.MESH_GITEA_STATE_DIR, "token.scopes"), "read:user,write:issue,write:repository\n", { mode: 0o600 }); await fresh(env).listRepos(); assert.ok(!forge.tokens.some((t) => t.user === ADMIN), "the administrator holds no tools' token any more"); - const kept = (await readFile(join(env.MESH_GITEA_STATE_DIR, "token"), "utf8")).trim(); + const kept = vaulted(TOOLS_ACCOUNT)!; assert.notEqual(kept, old.sha1); assert.equal(forge.tokens.find((t) => t.sha1 === kept)?.user, TOOLS_ACCOUNT); - assert.match(await readFile(join(env.MESH_GITEA_STATE_DIR, "token.scopes"), "utf8"), / for mesh-tools\n$/); }); test("a tools' account someone made an administrator is made a plain account again at the next mint", async () => { @@ -363,17 +365,24 @@ test("the manifest hands the tools their account, and the Go forge bundle holds const manifest = JSON.parse(await readFile(new URL("../module.json", import.meta.url), "utf8")); const code = manifest.build.artifacts.find((a: any) => a.name === "code"); assert.equal(code.env.MESH_GITEA_TOOLS_USER, TOOLS_ACCOUNT); - // The Go forge bundle reads the token the tools' account holds, never the administrator's password. + // The Go forge bundle reads the token the tools' account holds, never the administrator's password; through the + // vault seat's get, never a file (design 47 H2 §808, H-A-422 (1)). const forgeBundle = manifest.build.artifacts.find((a: any) => a.name === "forge"); - assert.ok(forgeBundle.env.MESH_GITEA_TOKEN_FILE); + assert.equal(forgeBundle.env.MESH_GITEA_TOOLS_USER, TOOLS_ACCOUNT); assert.equal(forgeBundle.env.MESH_GITEA_ADMIN_PASSWORD_FILE, undefined); // The package registry's bundle reads with the tools' token and writes with the packages account's (design 51). const packages = manifest.build.artifacts.find((a: any) => a.name === "package-registry"); - assert.equal(packages.env.MESH_GITEA_TOKEN_FILE, forgeBundle.env.MESH_GITEA_TOKEN_FILE); assert.equal(packages.env.MESH_GITEA_PACKAGES_USER, PACKAGES_ACCOUNT); - assert.match(packages.env.MESH_GITEA_PACKAGES_TOKEN_FILE, /^\$\{dir:runtime-state\}\/packages-token$/); assert.equal(packages.env.MESH_GITEA_ADMIN_PASSWORD_FILE, undefined); - assert.equal(code.env.MESH_GITEA_STATE_DIR, "${dir:runtime-state}", "the watcher mints the packages token where the bundle reads it"); + for (const a of manifest.build.artifacts) { + assert.equal(a.env?.MESH_GITEA_TOKEN_FILE ?? a.env?.MESH_GITEA_PACKAGES_TOKEN_FILE, undefined, `${a.name} is handed a token file`); + } + assert.ok(manifest.invokes.includes("seat:mesh-vault.own-put") && manifest.invokes.includes("seat:mesh-vault.get"), manifest.invokes.join(",")); + assert.ok(manifest.consumes.includes("mesh-vault.secret-changed"), "the Go bundles hear the vault's changes"); + // The lease and the two settings (§808, §820). + assert.deepEqual(manifest.state.find((s: any) => s.name === "token-lease"), { name: "token-lease", "key-ttl": true, "max-mib": 1 }); + assert.deepEqual([manifest.config["token-ttl"]?.default, manifest.config["token-ttl"]?.runtime], ["24h", true]); + assert.deepEqual([manifest.config["mint-lease"]?.default, manifest.config["mint-lease"]?.runtime], ["60s", true]); }); test("the package seats write as an account of their own: plain, in a team writing only packages, its token write:package alone, renewed when the forge rejects it", async () => { @@ -383,10 +392,10 @@ test("the package seats write as an account of their own: plain, in a team writi const account = forge.users.get(PACKAGES_ACCOUNT); assert.ok(account, "the module made the packages account"); assert.equal(account!.admin, false, "the packages account is no administrator"); - const held = forge.tokens.filter((t) => t.name === "mesh-packages"); - assert.deepEqual(held.map((t) => [t.user, t.scopes]), [[PACKAGES_ACCOUNT, ["write:package"]]]); - assert.equal(await readFile(join(env.MESH_GITEA_STATE_DIR, "packages-token"), "utf8"), held[0].sha1 + "\n"); - assert.equal(await readFile(join(env.MESH_GITEA_STATE_DIR, "packages-token.scopes"), "utf8"), "write:package for mesh-packages\n"); + const named = (t: { name: string }) => t.name === "mesh-packages" || t.name.startsWith("mesh-packages-"); + const held = forge.tokens.filter(named); + assert.deepEqual(held.map((t) => [t.user, t.name, t.scopes]), [[PACKAGES_ACCOUNT, "mesh-packages-1", ["write:package"]]]); + assert.equal(vaulted(PACKAGES_ACCOUNT), held[0].sha1, "kept in the vault as module/gitea/mesh-packages (H-A-426)"); const team = forge.teams.find((t) => t.name === "mesh-packages"); assert.ok(team?.members.has(PACKAGES_ACCOUNT)); assert.deepEqual(team!.units.units_map, PACKAGES_TEAM_UNITS.units_map, "the team writes packages and nothing else"); @@ -398,11 +407,12 @@ test("the package seats write as an account of their own: plain, in a team writi const renew = renewOnRefusal(source, forge.url, { delete: async (k) => { cleared.push(k); } }, (l) => said.push(l)); await renew({ key: "seat.gitea.other", op: "put" }); await renew({ key: PACKAGES_TOKEN_REFUSED, op: "delete" }); - assert.equal(forge.tokens.filter((t) => t.name === "mesh-packages").length, 0, "nothing renews but the refusal"); + assert.equal(forge.tokens.filter(named).length, 0, "nothing renews but the refusal"); await renew({ key: PACKAGES_TOKEN_REFUSED, op: "put" }); assert.deepEqual(said, ["the forge rejected the package seats' write token; minted afresh"]); assert.deepEqual(cleared, [PACKAGES_TOKEN_REFUSED]); - assert.equal(forge.tokens.filter((t) => t.name === "mesh-packages").length, 1); + assert.deepEqual(forge.tokens.filter(named).map((t) => t.name), ["mesh-packages-2"]); + assert.equal(vaulted(PACKAGES_ACCOUNT), forge.tokens.find(named)!.sha1); // The tools' token reads packages too: read:package (design 51's read-only tool token). assert.ok(TOKEN_SCOPES.includes("read:package")); }); @@ -433,12 +443,12 @@ test("an old token that cannot be deleted after the mint is said, the new token } finally { forge.faults.deleteToken = false; } - const kept = (await readFile(join(env.MESH_GITEA_STATE_DIR, "token"), "utf8")).trim(); + const kept = vaulted(TOOLS_ACCOUNT)!; assert.equal(forge.tokens.find((t) => t.sha1 === kept)?.user, TOOLS_ACCOUNT, "the account's token is kept and works"); assert.ok(forge.tokens.some((t) => t.sha1 === old.sha1)); - // The next process reuses the kept token and retires the old one it could not before. + // The next process reuses the vault's token and retires the old one it could not before. const next = new MintedToken({ url: forge.url, admin: ADMIN, passwordFile: env.MESH_GITEA_ADMIN_PASSWORD_FILE!, - file: join(env.MESH_GITEA_STATE_DIR, "token"), account: TOOLS_ACCOUNT, log: () => {} }); + account: TOOLS_ACCOUNT, oldName: TOKEN_NAME, vault: vaultOverBus(), lease: leaseOverState(), stateDir: env.MESH_GITEA_STATE_DIR, log: () => {} }); assert.equal(await next.current(), kept); assert.ok(!forge.tokens.some((t) => t.sha1 === old.sha1), "the admin's old token was deleted at the next start"); }); @@ -548,7 +558,7 @@ test("the start's pass gives each of the mesh's accounts read, as a collaborator assert.deepEqual((await fresh(env).listAllRepos()).map((r) => r.full_name).sort(), ["jschoubben/txt-game", "novox/hq"]); // The account's own token cannot grant itself: the forge asks the repository's administration (the reason for the admin login). - const own = (await readFile(join(env.MESH_GITEA_STATE_DIR, "token"), "utf8")).trim(); + const own = vaulted(TOOLS_ACCOUNT)!; const self = await fetch(`${forge.url}/api/v1/repos/jschoubben/car-hunter/collaborators/${TOOLS_ACCOUNT}`, { method: "PUT", headers: { Authorization: `token ${own}`, "Content-Type": "application/json" }, body: JSON.stringify({ permission: "read" }) }); assert.equal(self.status, 404, "a repository the account cannot read is not even there for it"); diff --git a/modules/gitea/token.ts b/modules/gitea/token.ts index 2c02a65d7..c02c3fa01 100644 --- a/modules/gitea/token.ts +++ b/modules/gitea/token.ts @@ -4,45 +4,88 @@ // paste in, and pasting one into settings would put a secret in the inventory in plaintext. What // the mesh does deliver is the admin account: a login the manifest names and a password the vault // minted and the host unsealed into a file (novox/hq ADR 0086). That account is enough to mint a -// token, so the module mints its own (hq issue 100, the forge's tools): +// token, so the module mints its own (hq issue 100, the forge's tools), for each of its two accounts, the tools' +// (`mesh-tools`) and the package seats' (`mesh-packages`): // -// - at first use, when none is kept: POST /users/{admin}/tokens over basic auth, with the two -// scopes the tools and the watcher need, and no more; -// - kept in the module's own state, a 0600 file, and read back on the next start — the forge -// hands a token's value out exactly once, so a token not kept is a token lost; -// - re-minted when the forge rejects it (401) or the kept file is gone. The one case that is not -// a fault: the forge's data was restored from a predecessor and the token the file names never -// existed there; -// - minted by one process at a time. The runtime starts each of the bundle's entrypoints as a process -// of its own (novox/hq ADR 0193): the watcher (index.js) and the tools (tools/index.js) are two -// processes over one kept file. Two that minted at once left the forge two tokens by one name, which -// gitea then refuses to delete by name — for ever, and every forge tool with it (the 2026-10-14 -// outage). So a mint holds a lock file beside the kept token, and reads the kept file again once it -// holds it: what another process minted meanwhile is reused, not minted over; -// - replaced by id: an old token by this name is found in the account's list and deleted by its id, -// every one of them, so a name held twice is cleared rather than refused. -// -// - minted for the tools' account, not the administrator (novox/hq ADR 0365 §2, issue 469): the administrator's -// login mints it for `mesh-tools` (tools-account.ts), after making that account and its team, and deletes any -// token by this name the administrator itself still holds — the token the tools used before. A token kept -// for another account than the one asked (the scopes line says whose) is minted again at the next start. +// - **kept as a secret, the module's own in the vault** (design 47 H2 §808, §822; H-A-422, H-A-426): written through +// the seat `mesh-vault`'s two-step sealed write `own-put` under the account's name, so the vault keeps it as +// `module/gitea/`, its newest generation only, and read through the seat's `get`, sealed to this process's +// key. Never a file in the runtime state and never plain in a state: the forge hands a token's value out exactly +// once, and the vault is where the module keeps what it must not lose; +// - **one name per mint**, `-`, the generation the one this own-put makes (get's generation plus +// one; 1 when the vault holds none; H-A-430 (1)). The token minted is written through own-put first, and only then +// is the token it replaces deleted at the forge, by its id: no moment is without a valid token, and a mint that +// fails leaves the old one standing. The first mint replaces the tokens the module kept before under the account's +// old fixed name; +// - **minted by one process at a time** (§808). The runtime starts each of the bundle's entrypoints as a process of its +// own (novox/hq ADR 0193), and two that minted at once left the forge two tokens by one name (the 2026-10-14 outage). +// A process the forge refuses first reads the vault's token; only when the refused token is the vault's current one +// does it take the lease — the key `mint` in the module's state `token-lease`, created only, living `mint-lease` (a +// setting, default 60 s) — and mint. A process that finds the lease taken waits for that key to change, at most the +// lease, then reads the vault again; past it, the lease has expired and the waiter creates it itself; +// - **minted again when older than `token-ttl`** (a setting, default 24 hours), its age the vault's `changed-at`; +// - **minted again when minted with other scopes** (H-A-439): the value the vault keeps holds the token and the scopes +// it was minted with, so a token carrying a scope beyond the ones the tools take (such as write:admin) is minted again +// unasked, and the one it replaces deleted, as when the scopes were kept in a file beside the token; +// - minted for the account, not the administrator (novox/hq ADR 0365 §2, issue 469): the administrator's login mints +// it for the account, after making that account and its team, and deletes any token named `mesh-tools` the +// administrator itself still holds — the token the tools used before. // // An explicitly configured token still wins, and is never minted over: if it is rejected, that is // reported, not repaired — somebody chose it. // -// The token is never logged. Lines say that one was minted, reused or renewed, and where it is -// kept; never what it is. +// The token is never logged. Lines say that one was minted, reused or renewed, and under which name; +// never what it is. -import { chmodSync, closeSync, existsSync, mkdirSync, openSync, readFileSync, renameSync, rmSync, statSync, unlinkSync, writeFileSync, writeSync } from "node:fs"; +import { existsSync, mkdirSync, rmSync, writeFileSync, readFileSync } from "node:fs"; import { randomBytes } from "node:crypto"; -import { dirname, join } from "node:path"; +import { join } from "node:path"; +import { generateKeyPair, open, sealAnonymous, type Box, type KeyPair } from "@novox/mesh-sdk/seal"; +import { broker } from "@novox/mesh-sdk/messaging"; +import { askRuntime } from "@novox/mesh-sdk/runtime"; +import { state, type State } from "@novox/mesh-sdk/state"; import { setUpToolsAccount, TOOLS_ACCOUNT, type AdminCall } from "./tools-account.js"; - -/** The name the token carries in the forge's own list — one per mesh runtime, found by name. */ import { keepMainRules } from "./mainrules.js"; +import { durationMs } from "./taken.js"; +/** The tools' token's old fixed name in the forge's list, the one the admin's own token carried too (ADR 0365 §2). */ export const TOKEN_NAME = "mesh-tools"; +/** The module whose own secrets the vault keeps its tokens as (§822: the module named by the caller's account). */ +export const VAULT_MODULE = "gitea"; + +/** The vault's name of an account's token: `module/gitea/` (H-A-426). */ +export function vaultName(account: string): string { + return `module/${VAULT_MODULE}/${account}`; +} + +/** The forge's name of an account's token of one generation: `-` (H-A-422 (2)). */ +export function mintName(account: string, generation: number): string { + return `${account}-${generation}`; +} + +/** The state the mint's lease is kept in, and its one key (§808, §820). */ +export const LEASE_STATE = "token-lease"; +export const LEASE_KEY = "mint"; + +/** token-ttl's and mint-lease's defaults (§808). */ +export const TOKEN_TTL_DEFAULT = "24h"; +export const MINT_LEASE_DEFAULT = "60s"; + +/** A setting the node-engine composes as `MESH_CONFIG_`, a duration, in milliseconds; the default when unset, and + * when it is no duration (said). */ +export function settingMs(env: NodeJS.ProcessEnv, setting: string, fallback: string, log: (line: string) => void = () => {}): number { + const raw = env[`MESH_CONFIG_${setting.toUpperCase().replace(/-/g, "_")}`]; + const dflt = durationMs(fallback)!; + if (raw === undefined || raw.trim() === "") return dflt; + const ms = durationMs(raw); + if (ms === null) { + log(`the setting ${setting} is ${JSON.stringify(raw)}, no duration: the default ${fallback} holds`); + return dflt; + } + return ms; +} + /** * The least the fifteen tools and the watcher need (gitea's route groups, 1.20+ scoped tokens): * write:repository — create/delete repositories, pull requests (list/get/open/merge); @@ -58,8 +101,6 @@ export const TOKEN_NAME = "mesh-tools"; * **Not write:admin** (novox/hq ADR 0266). It was here so a person could settle the forge's users through * `gitea_api` (novox/hq 229); whoever may call a tool includes agents, and the forge's administration is the * operator's. The provisioner settles users with the admin account's own login (GiteaAdmin), never this token. - * A token kept with a different list is minted again with this one at the next start (the scopes are kept - * beside it), and the old one is deleted from the forge by its id — so the scope a kept token had does not outlive this. * * A token kept from before a scope was added lacks it: the forge answers such a call with * `403 token does not have at least one of required scope(s)`, and the client treats that like a @@ -91,19 +132,135 @@ export class ConfiguredToken implements TokenSource { } } -/** The forge would not take the admin account: it is missing, or its password is not the one the mesh holds. */ +/** The forge would not take the admin account: it refused the login the mesh holds (design 47 H2 §776). Said as the + * forge's refusal, never as an account to create: whether the forge is away is the seat's to judge (seat.ts). */ export class AdminRefused extends Error { constructor(admin: string, status: number) { - super( - `the forge refused the admin account "${admin}" (${status}) — it does not exist there, or its password is not ` + - `the one the vault delivered. The admin-bootstrap step creates it on a forge the mesh raised; a forge whose data ` + - `came from a predecessor does not have it. Create "${admin}" on the forge with the delivered password and the ` + - `token is minted on the next call — the tools stay registered and the watcher keeps trying`, - ); + super(`the forge refuses the mesh's admin account "${admin}" (${status})`); this.name = "AdminRefused"; } } +/** A token as the vault holds it: the token, the scopes it was minted with, the generation and when it changed (`get`'s + * answer, opened). */ +export interface VaultToken { + readonly token: string; + readonly scopes: readonly string[]; + readonly generation: number; + readonly changedAt: string; +} + +/** The value the vault keeps for an account: the token and the scopes it was minted with (§808, H-A-439). */ +export function vaultValue(token: string, scopes: readonly string[]): string { + return JSON.stringify({ token, scopes: [...scopes] }); +} + +/** A value the vault keeps, opened: its token and scopes. A value of another form names no scopes, so it is minted again. */ +export function openValue(value: string): { token: string; scopes: readonly string[] } { + try { + const v = JSON.parse(value); + if (v && typeof v.token === "string" && Array.isArray(v.scopes)) return { token: v.token, scopes: v.scopes.map(String) }; + } catch { + // not the token and its scopes + } + return { token: value.trim(), scopes: [] }; +} + +/** Whether two lists name the same scopes, in any order. */ +function sameScopes(a: readonly string[], b: readonly string[]): boolean { + return [...a].sort().join(",") === [...b].sort().join(","); +} + +/** The vault as the minter reaches it: the seat `mesh-vault`'s `get` and `own-put` (§808, §822). */ +export interface TokenVault { + /** The account's token the vault holds, or null when it holds none. */ + get(account: string): Promise; + /** Write the account's token and the scopes it was minted with as the module's own; answers the generation the vault kept. */ + put(account: string, token: string, scopes: readonly string[]): Promise; +} + +/** The lease `mint` in the state `token-lease` (§808). */ +export interface MintLease { + /** Create the lease for `holder`, living `ms`; false when another holds it. */ + take(holder: string, ms: number): Promise; + /** The lease's holder and since when, or null when nobody holds it. */ + read(): Promise<{ holder: string; since: string } | null>; + /** Delete the lease, when `holder` still holds it. */ + release(holder: string): Promise; + /** Resolves when the lease's key changes (deleted, or written again), or after `ms`, whichever is first. */ + changed(ms: number): Promise; +} + +/** The vault's words when it holds no secret by the name asked (mesh-vault's Get). */ +const HOLDS_NONE = /the vault holds no secret named/; + +/** The vault over the bus: `get` sealed to this process's own key, made once a process; `own-put` in its two steps. */ +export function vaultOverBus(request: (verb: string, body: unknown) => Promise = (v, b) => broker().request(v, b)): TokenVault { + let keys: KeyPair | undefined; + return { + async get(account) { + keys ??= generateKeyPair(); + let answer: { generation?: number; "changed-at"?: string; sealed?: Box }; + try { + answer = (await request("seat:mesh-vault.get", { name: vaultName(account), public_key: keys.publicKey })) as typeof answer; + } catch (err) { + if (HOLDS_NONE.test(err instanceof Error ? err.message : String(err))) return null; + throw err; + } + if (!answer?.sealed) throw new Error(`the vault answered no sealed ${vaultName(account)}`); + return { ...openValue(open(answer.sealed, keys.privateKey)), generation: answer.generation ?? 0, changedAt: answer["changed-at"] ?? "" }; + }, + async put(account, token, scopes) { + const opened = (await request("seat:mesh-vault.own-put", { name: account })) as { call?: string; seal_to?: string }; + if (!opened?.call || !opened.seal_to) throw new Error(`the vault opened no own-put call for ${vaultName(account)}`); + const kept = (await request("seat:mesh-vault.own-put", { call: opened.call, sealed: sealAnonymous(vaultValue(token, scopes), opened.seal_to) })) as { generation?: number }; + return kept?.generation ?? 0; + }, + }; +} + +/** The runtime's refusal of a create whose key has a value (mesh-sdk's CODE_CHANGED). */ +const CODE_CHANGED = -32010; + +/** The lease in the module's state `token-lease` over the runtime: a create with the lease as its time to live, and one + * watch of the key a process, handing each change to the waiters. */ +export function leaseOverState(st: State<{ holder: string; since: string }> = state(LEASE_STATE), + ask: (method: string, params: unknown) => Promise = askRuntime): MintLease { + const waiters = new Set<() => void>(); + let watching: Promise | undefined; + return { + async take(holder, ms) { + try { + await ask("mesh/state.create", { state: LEASE_STATE, key: LEASE_KEY, value: { holder, since: new Date().toISOString() }, + ttl_seconds: Math.max(1, Math.ceil(ms / 1000)) }); + return true; + } catch (err) { + if ((err as { code?: number }).code === CODE_CHANGED) return false; + throw err; + } + }, + async read() { + return (await st.get(LEASE_KEY))?.value ?? null; + }, + async release(holder) { + if ((await st.get(LEASE_KEY))?.value?.holder === holder) await st.delete(LEASE_KEY); + }, + async changed(ms) { + watching ??= st.watch((change) => { + if (!change.current) for (const wake of [...waiters]) wake(); + }, { key: LEASE_KEY }); + await watching; + await new Promise((resolve) => { + const wake = () => { clearTimeout(timer); waiters.delete(wake); resolve(); }; + const timer = setTimeout(wake, ms); + waiters.add(wake); + // Released between the refused create and this wait: nothing to wait for. + void st.get(LEASE_KEY).then((e) => { if (!e) wake(); }, () => {}); + }); + }, + }; +} + export interface MintedTokenOptions { /** The forge, e.g. http://127.0.0.1:3000. */ readonly url: string; @@ -111,115 +268,121 @@ export interface MintedTokenOptions { readonly admin: string; /** The file the host unsealed the admin password into (ADR 0086). Read at mint time, so a rotation takes. */ readonly passwordFile: string; - /** Where the token is kept: a 0600 file in the module's own state. */ - readonly file: string; - readonly name?: string; + /** The account the token is minted for, and the vault name it is kept under (H-A-426). */ + readonly account: string; + /** The token's fixed name before a name per mint: the first mint deletes the account's tokens by it (H-A-430 (1)). */ + readonly oldName: string; readonly scopes?: readonly string[]; - /** - * The account the token is minted for: the tools' own (novox/hq ADR 0365 §2). The admin login mints it, after - * `setUp` made the account, and the admin's own tokens by this name are deleted. Left out, the token is the - * admin's own, as it was before. - */ - readonly account?: string; - /** Run with the admin's password before each mint for `account`: makes the account and its team (tools-account.ts). */ + /** Run with the admin's password before each mint: makes the account and its team (tools-account.ts). */ readonly setUp?: (password: string) => Promise; + /** Where the module keeps its token, and the mint's lease (§808). */ + readonly vault: TokenVault; + readonly lease: MintLease; + /** token-ttl and mint-lease, in milliseconds (§808). */ + readonly ttlMs?: number; + readonly leaseMs?: number; + /** Who holds the lease when this process does: the node and the process. */ + readonly holder?: string; + /** The module's runtime state directory, where a retirement of the admin's old token that failed is remembered. */ + readonly stateDir?: string; + readonly now?: () => Date; readonly log?: (line: string) => void; readonly fetch?: typeof fetch; } -/** The token the module mints for itself, kept in its state and renewed when the forge rejects it. */ +/** The token the module mints for itself, kept in the vault and renewed when the forge rejects it. */ export class MintedToken implements TokenSource { - private held: string | null = null; - private readFile = false; + private held: VaultToken | null = null; private inflight: Promise | null = null; - private readonly name: string; private readonly scopes: readonly string[]; - private readonly account: string; + private readonly ttlMs: number; + private readonly leaseMs: number; + private readonly holder: string; + private readonly now: () => Date; private readonly log: (line: string) => void; private readonly fetchImpl: typeof fetch; constructor(private readonly opts: MintedTokenOptions) { - this.name = opts.name ?? TOKEN_NAME; this.scopes = opts.scopes ?? TOKEN_SCOPES; - this.account = opts.account ?? opts.admin; + this.ttlMs = opts.ttlMs ?? durationMs(TOKEN_TTL_DEFAULT)!; + this.leaseMs = opts.leaseMs ?? durationMs(MINT_LEASE_DEFAULT)!; + this.holder = opts.holder ?? `${process.env.MESH_NODE || "unknown"}/${process.pid}`; + this.now = opts.now ?? (() => new Date()); this.log = opts.log ?? ((line) => console.log(`[gitea] ${line}`)); this.fetchImpl = opts.fetch ?? fetch; } + /** The account this source mints for. */ + get account(): string { + return this.opts.account; + } + /** - * Build from the runtime's environment: the forge's URL, the admin login and password file the - * manifest hands the runtime, and the module's state directory (MESH_GITEA_STATE_DIR, a directory - * the runtime mounts writable). Throws, naming what is missing, rather than hand back a source - * that cannot mint. + * The tools' token from the runtime's environment: the forge's URL, the admin login and password file the manifest + * hands the runtime, the vault and the lease over the bus. Throws, naming what is missing, rather than hand back a + * source that cannot mint. One source per account and runtime state in a process: two would each renew on a 401. */ static fromEnv(url: string, env: NodeJS.ProcessEnv = process.env): MintedToken { - const opts = MintedToken.optionsFromEnv(url, env); - // One source per kept file in a process: two sources in one process would each renew on a 401. - // This covers one process only. The watcher and the tools are two processes (the runtime starts - // each entrypoint as its own), and those are kept apart by the mint's lock file (mint, below). - const shared = MintedToken.shared.get(opts.file); + const account = env.MESH_GITEA_TOOLS_USER || TOOLS_ACCOUNT; + const { admin, passwordFile } = adminFromEnv(env, "no Gitea token, and nothing to mint one with — set GITEA_TOKEN, or"); + const key = `${account} ${env.MESH_GITEA_STATE_DIR ?? ""}`; + const shared = MintedToken.shared.get(key); if (shared) return shared; - const source = new MintedToken(opts); - MintedToken.shared.set(opts.file, source); + if (account === admin) throw new Error(`MESH_GITEA_TOOLS_USER names the admin account "${admin}"; the tools act as an account of their own (novox/hq ADR 0365)`); + const source = new MintedToken({ + ...MintedToken.settingsFromEnv(env), url, admin, passwordFile, account, oldName: TOKEN_NAME, + // GiteaAdmin is loaded when first used: client.ts imports this file. + setUp: async (password) => { + const { GiteaAdmin } = await import("./client.js"); + await setUpToolsAccount(new GiteaAdmin(url, admin, password), account, () => randomBytes(24).toString("base64url"), keepMainRules(env)); + }, + }); + MintedToken.shared.set(key, source); return source; } private static readonly shared = new Map(); - private static optionsFromEnv(url: string, env: NodeJS.ProcessEnv): MintedTokenOptions { - const admin = env.MESH_GITEA_ADMIN_USER; - const passwordFile = env.MESH_GITEA_ADMIN_PASSWORD_FILE; - const stateDir = env.MESH_GITEA_STATE_DIR; - const missing = [ - admin ? null : "MESH_GITEA_ADMIN_USER", - passwordFile ? null : "MESH_GITEA_ADMIN_PASSWORD_FILE", - stateDir ? null : "MESH_GITEA_STATE_DIR", - ].filter((v): v is string => v !== null); - if (missing.length) { - throw new Error(`no Gitea token, and nothing to mint one with — set GITEA_TOKEN, or ${missing.join(", ")}`); - } - // The tools' own account, never the administrator (novox/hq ADR 0365 §2): MESH_GITEA_TOOLS_USER names it. - const account = env.MESH_GITEA_TOOLS_USER || TOOLS_ACCOUNT; - if (account === admin) throw new Error(`MESH_GITEA_TOOLS_USER names the admin account "${admin}"; the tools act as an account of their own (novox/hq ADR 0365)`); + /** What every account's source takes from the environment: the vault and lease over the bus, the two settings. */ + static settingsFromEnv(env: NodeJS.ProcessEnv): Pick { + const log = (line: string) => console.log(`[gitea] ${line}`); return { - url, admin: admin!, passwordFile: passwordFile!, file: join(stateDir!, "token"), account, - // GiteaAdmin is loaded when first used: client.ts imports this file. - setUp: async (password) => { - const { GiteaAdmin } = await import("./client.js"); - await setUpToolsAccount(new GiteaAdmin(url, admin!, password), account, () => randomBytes(24).toString("base64url"), keepMainRules(env)); - }, + vault: sharedVault(), lease: sharedLease(), + ttlMs: settingMs(env, "token-ttl", TOKEN_TTL_DEFAULT, log), leaseMs: settingMs(env, "mint-lease", MINT_LEASE_DEFAULT, log), + stateDir: env.MESH_GITEA_STATE_DIR || undefined, }; } + /** The token held, read from the vault when none is, minted when the vault holds none or one older than token-ttl. */ async current(): Promise { - if (this.held !== null) return this.held; - if (!this.readFile) { - this.readFile = true; - const kept = this.read(); - if (kept !== null && this.keptScopes() === this.scopesLine()) { - this.held = kept; - this.log(`reusing the token kept at ${this.opts.file}`); - // A retirement of the admin's old token that failed after the mint is tried again, once a process. - if (existsSync(this.retireFile)) await this.locked(() => this.retireAdmin()).catch((err) => this.log(`${err}`)); - return kept; - } - if (kept !== null) return this.mint("the kept token was minted with other scopes than the tools take now — minting one with them", kept); + if (this.held !== null && !this.expired(this.held)) return this.held.token; + const kept = await this.opts.vault.get(this.opts.account); + if (kept === null) return this.mint("the vault holds no token for this account — minting one", null); + if (this.expired(kept)) return this.mint(`the vault's token is older than token-ttl (${this.ttlMs / 1000}s) — minting one`, kept.token); + if (!sameScopes(kept.scopes, this.scopes)) { + return this.mint(`the vault's token was minted with other scopes than the tools take now (${kept.scopes.join(", ") || "none kept"}) — minting one with them`, kept.token); } - return this.mint("no token kept — minting one", null); + if (this.held === null) { + this.log(`reusing the token the vault keeps as ${vaultName(this.opts.account)} (generation ${kept.generation})`); + // A retirement of the admin's old token that failed after the mint is tried again, once a process. + if (this.retireFile && existsSync(this.retireFile)) await this.retireAdmin().catch((err) => this.log(`${err}`)); + } + this.held = kept; + return kept.token; } async renew(rejected: string): Promise { // Another caller already renewed while this one was in flight with the old token. - if (this.held !== null && this.held !== rejected) return this.held; - // Or another process did, and kept it: use what is kept before minting over it. - const kept = this.read(); - if (kept !== null && kept !== rejected) { + if (this.held !== null && this.held.token !== rejected) return this.held.token; + // A refusal of a stale token mints nothing: the vault's newer one is used (§808). + const kept = await this.opts.vault.get(this.opts.account); + if (kept !== null && kept.token !== rejected) { this.held = kept; - this.log(`the forge rejected the token held; the kept one at ${this.opts.file} is newer — reusing it`); - return kept; + this.log(`the forge rejected the token held; the vault's ${vaultName(this.opts.account)} is newer (generation ${kept.generation}) — reusing it`); + return kept.token; } this.held = null; - return this.mint("the forge rejected the kept token — minting a fresh one", rejected); + return this.mint("the forge rejected the vault's token — minting a fresh one", rejected); } /** What the forge's scoped tokens say when a kept token predates a scope the tools now need. */ @@ -227,132 +390,55 @@ export class MintedToken implements TokenSource { return status === 403 && /required scope/i.test(body); } + private expired(t: VaultToken): boolean { + const at = Date.parse(t.changedAt); + return Number.isFinite(at) && this.now().getTime() - at > this.ttlMs; + } + /** - * One mint at a time: concurrent first calls in this process share it, and a mint in another process - * on this machine is waited for (the lock file). Once the lock is held, the kept file is read again: - * a token there that is not `stale` (the one rejected, or kept with other scopes) and carries the - * scopes asked for was minted by the process that held the lock before — it is reused. + * One mint at a time: concurrent calls in this process share it, and a mint in another process is waited for (the + * lease). Holding the lease, the vault is read again: a token there that is not `stale` (the one refused or expired) + * was minted by the process that held the lease before — it is used, not minted over. */ private mint(why: string, stale: string | null): Promise { if (this.inflight === null) { this.log(why); - this.inflight = this.locked(async () => { - const kept = this.read(); - if (kept !== null && kept !== stale && this.keptScopes() === this.scopesLine()) { - this.held = kept; - this.log(`another process minted it meanwhile — reusing the token kept at ${this.opts.file}`); - return kept; - } - return this.doMint(); - }).finally(() => { + this.inflight = this.leased(stale).finally(() => { this.inflight = null; }); } return this.inflight; } - /** How long a mint may hold the lock before another process takes it as left behind, and how long one waits. */ - static readonly LOCK_STALE_MS = 120_000; - static readonly LOCK_WAIT_MS = 150_000; - - /** - * Run `work` holding the lock file beside the kept token: created exclusively, holding this process's - * pid, the time and a nonce; removed after, only when it is still ours. A lock whose process is gone, - * or older than LOCK_STALE_MS, was left by a process that died mid-mint and is taken over — never - * waited on for ever, which would be the same lock-out by another road. - */ - private async locked(work: () => Promise): Promise { - const lock = `${this.opts.file}.lock`; - mkdirSync(dirname(this.opts.file), { recursive: true, mode: 0o700 }); - const mine = `${process.pid} ${Date.now()} ${randomBytes(8).toString("hex")}\n`; - const deadline = Date.now() + MintedToken.LOCK_WAIT_MS; + private async leased(stale: string | null): Promise { for (;;) { - try { - const fd = openSync(lock, "wx", 0o600); - try { writeSync(fd, mine); } finally { closeSync(fd); } - break; - } catch (err) { - if ((err as NodeJS.ErrnoException).code !== "EEXIST") { - throw new Error(`cannot take the mint lock at ${lock}: ${(err as Error).message}`); + if (await this.opts.lease.take(this.holder, this.leaseMs)) { + try { + const kept = await this.opts.vault.get(this.opts.account); + if (kept !== null && kept.token !== stale && !this.expired(kept) && sameScopes(kept.scopes, this.scopes)) { + this.held = kept; + this.log(`another process minted it meanwhile — reusing the vault's generation ${kept.generation}`); + return kept.token; + } + return await this.doMint(kept); + } finally { + await this.opts.lease.release(this.holder).catch((err) => + this.log(`the mint lease could not be deleted; it ends with mint-lease — ${err instanceof Error ? err.message : err}`)); } } - if (this.leftBehind(lock)) { - this.log(`the mint lock at ${lock} was left by a process that is gone — taking it over`); - try { unlinkSync(lock); } catch { /* another waiter took it over first */ } - continue; + const other = await this.opts.lease.read().catch(() => null); + this.log(`another process holds the mint lease${other ? ` (${other.holder} since ${other.since})` : ""} — waiting for it, at most mint-lease (${this.leaseMs / 1000}s)`); + await this.opts.lease.changed(this.leaseMs); + const kept = await this.opts.vault.get(this.opts.account); + if (kept !== null && kept.token !== stale && !this.expired(kept) && sameScopes(kept.scopes, this.scopes)) { + this.held = kept; + this.log(`the process that held the mint lease minted generation ${kept.generation} — reusing it`); + return kept.token; } - if (Date.now() > deadline) { - throw new Error(`another process has held the mint lock at ${lock} for over ${MintedToken.LOCK_WAIT_MS / 1000}s — not minting beside it`); - } - await new Promise((r) => setTimeout(r, 50 + Math.floor(Math.random() * 50))); - } - try { - return await work(); - } finally { - try { - if (readFileSync(lock, "utf8") === mine) unlinkSync(lock); - } catch { /* already gone */ } } } - /** Whether the lock's holder is gone: its pid answers no signal, or it is older than LOCK_STALE_MS. */ - private leftBehind(lock: string): boolean { - let text: string; - let age: number; - try { - text = readFileSync(lock, "utf8"); - age = Date.now() - statSync(lock).mtimeMs; - } catch { - return false; // released meanwhile: the next attempt takes it - } - if (age > MintedToken.LOCK_STALE_MS) return true; - const pid = Number(text.split(" ")[0]); - if (!Number.isInteger(pid) || pid <= 0) return age > 1_000; // half-written, or not ours: give it a moment - try { - process.kill(pid, 0); - return false; - } catch (err) { - return (err as NodeJS.ErrnoException).code === "ESRCH"; - } - } - - private read(): string | null { - try { - const token = readFileSync(this.opts.file, "utf8").replace(/\n$/, ""); - return token.length ? token : null; - } catch (err) { - if ((err as NodeJS.ErrnoException).code === "ENOENT") return null; - throw new Error(`cannot read the kept Gitea token at ${this.opts.file}: ${(err as Error).message}`); - } - } - - /** The scopes as kept beside the token: sorted, one line, and whose it is when it is not the admin's. */ - private scopesLine(): string { - const scopes = [...this.scopes].sort().join(","); - return this.account === this.opts.admin ? scopes : `${scopes} for ${this.account}`; - } - - /** The scopes the kept token was minted with, "" when not kept (a token kept before they were). */ - private keptScopes(): string { - try { - return readFileSync(`${this.opts.file}.scopes`, "utf8").trim(); - } catch { - return ""; - } - } - - /** Write the token at 0600, whole or not at all: a temp file beside it, then a rename. Its scopes beside it. */ - private keep(token: string): void { - mkdirSync(dirname(this.opts.file), { recursive: true, mode: 0o700 }); - const tmp = `${this.opts.file}.tmp`; - writeFileSync(tmp, token + "\n", { mode: 0o600 }); - chmodSync(tmp, 0o600); - renameSync(tmp, this.opts.file); - writeFileSync(`${this.opts.file}.scopes.tmp`, this.scopesLine() + "\n", { mode: 0o600 }); - renameSync(`${this.opts.file}.scopes.tmp`, `${this.opts.file}.scopes`); - } - - /** One call to the forge's API with the admin login, the password read now. */ + /** The admin password, read now. */ private password(): string { try { return readFileSync(this.opts.passwordFile, "utf8").replace(/\n$/, ""); @@ -361,6 +447,7 @@ export class MintedToken implements TokenSource { } } + /** One call to the forge's API with the admin login. */ private adminCall(password = this.password()): AdminCall { const authorization = "Basic " + Buffer.from(`${this.opts.admin}:${password}`).toString("base64"); const api = `${this.opts.url.replace(/\/+$/, "")}/api/v1`; @@ -381,71 +468,81 @@ export class MintedToken implements TokenSource { } /** Where a retirement of the admin's old token that failed is remembered, to be tried again (retireAdmin). */ - private get retireFile(): string { - return `${this.opts.file}.retire-admin`; + private get retireFile(): string | null { + return this.opts.stateDir ? join(this.opts.stateDir, `${this.opts.account}.retire-admin`) : null; } /** - * The admin's own token by this name goes: what the tools used before must not outlive the move (novox/hq ADR - * 0365 §2). Run after the account's token is minted and kept, so a failure here never leaves the tools without - * a token: it is said, remembered beside the kept token, and tried again when a process next reads that token. + * The admin's own token named `mesh-tools` goes: what the tools used before must not outlive the move (novox/hq ADR + * 0365 §2). Run after the account's token is minted and kept, so a failure here never leaves the tools without a + * token: it is said, remembered, and tried again when a process next reads the vault's token. */ private async retireAdmin(admin: AdminCall = this.adminCall()): Promise { - if (this.account === this.opts.admin) return; + if (this.opts.oldName !== TOKEN_NAME) return; try { - const retired = await this.dropNamed(admin, `/users/${encodeURIComponent(this.opts.admin)}/tokens`, this.opts.admin); - if (retired > 0) this.log(`deleted ${retired} token(s) named "${this.name}" the admin account "${this.opts.admin}" held: the tools act as "${this.account}" now`); - rmSync(this.retireFile, { force: true }); + const retired = await this.dropNamed(admin, `/users/${encodeURIComponent(this.opts.admin)}/tokens`, this.opts.admin, TOKEN_NAME); + if (retired > 0) this.log(`deleted ${retired} token(s) named "${TOKEN_NAME}" the admin account "${this.opts.admin}" held: the tools act as "${this.opts.account}" now`); + if (this.retireFile) rmSync(this.retireFile, { force: true }); } catch (err) { - writeFileSync(this.retireFile, `${new Date().toISOString()}\n`, { mode: 0o600 }); - this.log(`FAILED to delete the token(s) named "${this.name}" the admin account "${this.opts.admin}" holds — tried again at the next start: ${(err as Error).message}`); + if (this.retireFile) { + mkdirSync(this.opts.stateDir!, { recursive: true, mode: 0o700 }); + writeFileSync(this.retireFile, `${new Date().toISOString()}\n`, { mode: 0o600 }); + } + this.log(`FAILED to delete the token(s) named "${TOKEN_NAME}" the admin account "${this.opts.admin}" holds — tried again at the next start: ${(err as Error).message}`); } } - private async doMint(): Promise { + /** + * Mint `-` (the generation this own-put makes), write it through own-put, and only then delete + * at the forge, by id, the token it replaces: `replaced`'s by its name, or at the first mint the tokens under the + * account's old fixed name (H-A-422 (2), H-A-430 (1)). + */ + private async doMint(replaced: VaultToken | null): Promise { const password = this.password(); const admin = this.adminCall(password); - const tokensOf = (account: string) => `/users/${encodeURIComponent(account)}/tokens`; - const call = (method: string, path = "", body?: unknown) => admin(method, tokensOf(this.account) + path, body); + const account = this.opts.account; + const tokens = `/users/${encodeURIComponent(account)}/tokens`; + const generation = (replaced?.generation ?? 0) + 1; + const name = mintName(account, generation); - if (this.account !== this.opts.admin) { - // The tools' account and its team first (novox/hq ADR 0365 §2): a failure here fails the mint, tried again - // at the next call. - const me = await admin("GET", "/user"); - if (me.status === 401 || me.status === 403) throw new AdminRefused(this.opts.admin, me.status); - await this.opts.setUp?.(password); - } + // The account and its team first (novox/hq ADR 0365 §2): a failure here fails the mint, tried again at the next call. + const me = await admin("GET", "/user"); + if (me.status === 401 || me.status === 403) throw new AdminRefused(this.opts.admin, me.status); + await this.opts.setUp?.(password); - let res = await call("POST", "", { name: this.name, scopes: this.scopes }); + let res = await admin("POST", tokens, { name, scopes: this.scopes }); if (res.status === 401 || res.status === 403) throw new AdminRefused(this.opts.admin, res.status); if (res.status === 400 || res.status === 422) { - // The forge still holds a token by this name whose value we no longer have — the kept file - // went while the forge's data stayed, or two processes once minted at once and left two. It is - // ours to replace: find every one by this name in the account's list and delete each by its id - // (gitea refuses a delete by a name held twice: "multiple matches for token name"), then mint. - await this.dropNamed(admin, tokensOf(this.account), this.account, true); - res = await call("POST", "", { name: this.name, scopes: this.scopes }); + // A mint of this generation whose own-put never landed left its token at the forge, unused: deleted by its id + // (gitea refuses a delete by a name held twice), then minted again. + await this.dropNamed(admin, tokens, account, name, true); + res = await admin("POST", tokens, { name, scopes: this.scopes }); } if (res.status !== 201 && res.status !== 200) { - throw new Error(`Gitea POST /users/${this.account}/tokens: ${res.status} ${detail(res.body)}`); + throw new Error(`Gitea POST /users/${account}/tokens: ${res.status} ${detail(res.body)}`); } const token = typeof res.body?.sha1 === "string" ? res.body.sha1 : null; - if (!token) throw new Error(`Gitea POST /users/${this.account}/tokens: ${res.status} but no token in the reply`); + if (!token) throw new Error(`Gitea POST /users/${account}/tokens: ${res.status} but no token in the reply`); - this.keep(token); - this.held = token; - this.log(`minted a token for "${this.account}" (${this.scopes.join(", ")}), kept at ${this.opts.file}`); - // Only now, with the account's own token kept, does the admin's old one go. + const kept = await this.opts.vault.put(account, token, this.scopes); + if (kept !== generation) this.log(`the vault kept ${vaultName(account)} at generation ${kept}, the forge names it ${name}`); + this.held = { token, scopes: this.scopes, generation: kept, changedAt: this.now().toISOString() }; + this.log(`minted ${name} for "${account}" (${this.scopes.join(", ")}), kept in the vault as ${vaultName(account)}`); + + // Only now, with the new token kept, does the one it replaces go. + const gone = replaced ? mintName(account, replaced.generation) : this.opts.oldName; + try { + const dropped = await this.dropNamed(admin, tokens, account, gone); + if (dropped > 0) this.log(`deleted ${dropped} token(s) named "${gone}" "${account}" held: ${name} replaces them`); + } catch (err) { + this.log(`FAILED to delete the token "${gone}" ${name} replaces; the forge holds both until the next mint — ${(err as Error).message}`); + } await this.retireAdmin(admin); return token; } - /** - * Delete every token by this name an account holds, each by its id (gitea refuses a delete by a name held twice: - * "multiple matches for token name"); answers how many. `replacing` says the line for a mint that found its name - * taken. - */ - private async dropNamed(admin: AdminCall, tokens: string, account: string, replacing = false): Promise { + /** Delete every token named `name` an account holds, each by its id; answers how many. */ + private async dropNamed(admin: AdminCall, tokens: string, account: string, name: string, replacing = false): Promise { const held: number[] = []; for (let page = 1; page <= 100; page++) { const listed = await admin("GET", `${tokens}?page=${page}&limit=50`); @@ -453,23 +550,59 @@ export class MintedToken implements TokenSource { throw new Error(`Gitea GET /users/${account}/tokens: ${listed.status} ${detail(listed.body)}`); } if (listed.body.length === 0) break; - for (const t of listed.body) if (t?.name === this.name && typeof t.id === "number") held.push(t.id); - } - if (replacing) { - this.log(held.length === 1 - ? `the forge already holds a token named "${this.name}" — replacing it` - : `the forge holds ${held.length} tokens named "${this.name}" — deleting each by its id and minting one`); + for (const t of listed.body) if (t?.name === name && typeof t.id === "number") held.push(t.id); } + if (replacing) this.log(`the forge already holds ${held.length} token(s) named "${name}" — deleting each by its id and minting one`); for (const id of held) { const dropped = await admin("DELETE", `${tokens}/${id}`); if (dropped.status !== 204 && dropped.status !== 404) { - throw new Error(`Gitea DELETE /users/${account}/tokens/${id} (named ${this.name}): ${dropped.status} ${detail(dropped.body)}`); + throw new Error(`Gitea DELETE /users/${account}/tokens/${id} (named ${name}): ${dropped.status} ${detail(dropped.body)}`); } } return held.length; } } +/** The admin login and password file the manifest hands the runtime, or an error naming what is missing. */ +export function adminFromEnv(env: NodeJS.ProcessEnv, missingWords: string): { admin: string; passwordFile: string } { + const admin = env.MESH_GITEA_ADMIN_USER; + const passwordFile = env.MESH_GITEA_ADMIN_PASSWORD_FILE; + const missing = [admin ? null : "MESH_GITEA_ADMIN_USER", passwordFile ? null : "MESH_GITEA_ADMIN_PASSWORD_FILE"] + .filter((v): v is string => v !== null); + if (missing.length) throw new Error(`${missingWords} ${missing.join(", ")}`); + return { admin: admin!, passwordFile: passwordFile! }; +} + +// One vault and one lease a process, shared by both accounts' sources: one key and one watch. +let vaultOnce: TokenVault | undefined; +let leaseOnce: MintLease | undefined; +function sharedVault(): TokenVault { + return (vaultOnce ??= vaultOverBus()); +} +function sharedLease(): MintLease { + return (leaseOnce ??= leaseOverState()); +} + +/** The tool forge_token_lease's reading (§808): the lease's holder and since when, and each account's token age, read + * from the vault's `changed-at`; never the token. */ +export async function tokenLease(vault: TokenVault, lease: MintLease, accounts: readonly string[], now: Date = new Date()) { + const held = await lease.read(); + const out: { account: string; vault: string; generation?: number; "changed-at"?: string; "age-seconds"?: number; held: boolean }[] = []; + for (const account of accounts) { + const t = await vault.get(account); + out.push(t === null ? { account, vault: vaultName(account), held: false } : { + account, vault: vaultName(account), held: true, generation: t.generation, "changed-at": t.changedAt, + "age-seconds": Math.max(0, Math.floor((now.getTime() - Date.parse(t.changedAt)) / 1000)), + }); + } + return { lease: held === null ? { held: false } : { held: true, holder: held.holder, since: held.since }, tokens: out }; +} + +/** The vault and the lease this process mints through, for the tool forge_token_lease. */ +export function processVaultAndLease(): { vault: TokenVault; lease: MintLease } { + return { vault: sharedVault(), lease: sharedLease() }; +} + function detail(body: unknown): string { return typeof body === "string" ? body : JSON.stringify(body); } diff --git a/modules/gitea/tools/calls.ts b/modules/gitea/tools/calls.ts index 5737a80eb..06f0789fb 100644 --- a/modules/gitea/tools/calls.ts +++ b/modules/gitea/tools/calls.ts @@ -7,6 +7,8 @@ import { callerOf } from "@novox/mesh-sdk/callers"; import type { HandAct } from "@novox/mesh-sdk/views"; import type { Partials } from "../partials.js"; import { sayCall, type Calls, type Say } from "../calls.js"; +import type { GiteaClient } from "../client.js"; +import { repositoryOf } from "../seat.js"; const word = (v: unknown): string => (typeof v === "string" ? v.trim() : ""); @@ -70,3 +72,55 @@ export function callTools(calls: Calls, partials: Partials, say: Say, acts: (act }, ]; } + +/** The most a read tool answers (design 47 H2 §811). */ +export const ANSWER_CAP_BYTES = 768 * 1024; + +/** + * forge_merged (design 47 H2 §812, §811; H-A-402): a repository's merged pull requests by number, from `from` to `to` + * inclusive, each read from the forge one by one (the forge lists none by number), with its merge commit, when it was + * merged, and the merge call that made it when a kept call names it merged. A number the forge does not hold, or a pull + * request not merged, is left out. At most 768 KB: past it `capped`, with `cursor` the next number to give as `from`. + */ +export function mergedTool(forge: Pick, calls: Pick): ToolDefinition { + return { + name: "forge_merged", + description: "A repository's merged pull requests by number, from..to inclusive: each with its merge commit, when it was merged, and " + + "the merge call that made it (none when it was merged outside a merge call). At most 768 KB: capped, with the cursor to give as from " + + "(design 47 H2 §812).", + input: { type: "object", required: ["repository", "from", "to"], properties: { + repository: { type: "string", description: "the repository, /" }, + from: { type: "integer", description: "the first pull request number" }, + to: { type: "integer", description: "the last pull request number" } } }, + run: async (args: Record) => { + const { owner, repo, full } = repositoryOf(args.repository); + const from = Number(args.from), to = Number(args.to); + if (!Number.isInteger(from) || from < 1 || !Number.isInteger(to) || to < from) { + throw new Error("forge_merged names from and to, pull request numbers from 1, to not below from"); + } + const madeBy = new Map(); + for (const c of await calls.all()) { + for (const m of c.members) if (m.repository === full && m.state === "merged") madeBy.set(m.number, c.call); + } + const merged: { number: number; "merge-commit": string; "merged-at"?: string; call?: string }[] = []; + let size = 0; + for (let n = from; n <= to; n++) { + let p; + try { + p = await forge.getPullRequest(owner, repo, n); + } catch (err) { + if (/: 404 /.test(err instanceof Error ? err.message : "")) continue; + throw err; + } + if (!p.merged || !p.merge_commit_sha) continue; + const row = { number: n, "merge-commit": p.merge_commit_sha, ...(p.merged_at ? { "merged-at": p.merged_at } : {}), + ...(madeBy.has(n) ? { call: madeBy.get(n) } : {}) }; + const rowSize = JSON.stringify(row).length + 1; + if (size + rowSize > ANSWER_CAP_BYTES) return { repository: full, from, to, total: to - from + 1, merged, capped: true, cursor: n }; + size += rowSize; + merged.push(row); + } + return { repository: full, from, to, total: to - from + 1, merged }; + }, + }; +} diff --git a/modules/gitea/tools/tokenlease.ts b/modules/gitea/tools/tokenlease.ts new file mode 100644 index 000000000..fc8a4f40f --- /dev/null +++ b/modules/gitea/tools/tokenlease.ts @@ -0,0 +1,16 @@ +// The tool forge_token_lease (design 47 H2 §808, the tools table): the mint lease's holder and since when, and each +// account's token age, read from the vault's `changed-at`; never the token. + +import type { ToolDefinition } from "@novox/mesh-sdk/tools"; +import { tokenLease, type MintLease, type TokenVault } from "../token.js"; + +export function tokenLeaseTool(vault: TokenVault, lease: MintLease, accounts: readonly string[], now: () => Date = () => new Date()): ToolDefinition { + return { + name: "forge_token_lease", + description: "The forge token's mint lease and each account's token age (design 47 H2 §808): who holds the lease `mint` in the " + + "state token-lease and since when, and for each account (" + accounts.join(", ") + ") the vault's generation of its token " + + "and when it changed, never the token itself.", + input: { type: "object", properties: {} }, + run: async () => tokenLease(vault, lease, accounts, now()), + }; +} diff --git a/modules/gitlab/module.json b/modules/gitlab/module.json index 960832669..7bded31ca 100644 --- a/modules/gitlab/module.json +++ b/modules/gitlab/module.json @@ -1,6 +1,7 @@ { "module": "gitlab", "version": "0.1", + "class": "leaf", "own-secrets": { "token": "${dir:state}/token" }, diff --git a/modules/gnome-keyring/module.json b/modules/gnome-keyring/module.json index 76ca633c5..a7b663deb 100644 --- a/modules/gnome-keyring/module.json +++ b/modules/gnome-keyring/module.json @@ -1,6 +1,7 @@ { "module": "gnome-keyring", "version": "0.1", + "class": "core", "moved": true, "capabilities": [ "package-manager" diff --git a/modules/go/module.json b/modules/go/module.json index ca0264bd8..10cb723e5 100644 --- a/modules/go/module.json +++ b/modules/go/module.json @@ -1,6 +1,7 @@ { "module": "go", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager" ], diff --git a/modules/grafana/module.json b/modules/grafana/module.json index ce84cc904..8acd7b622 100644 --- a/modules/grafana/module.json +++ b/modules/grafana/module.json @@ -1,6 +1,7 @@ { "module": "grafana", "version": "0.1", + "class": "leaf", "emits": [ "alert.firing" ], diff --git a/modules/hello-web/module.json b/modules/hello-web/module.json index bbe7fd9af..d6cf28b03 100644 --- a/modules/hello-web/module.json +++ b/modules/hello-web/module.json @@ -2,6 +2,7 @@ "module": "hello-web", "slug": "hello", "version": "0.1", + "class": "leaf", "capabilities": [ "container-runtime" ], diff --git a/modules/home-assistant/module.json b/modules/home-assistant/module.json index f43735649..fad6eec97 100644 --- a/modules/home-assistant/module.json +++ b/modules/home-assistant/module.json @@ -1,6 +1,7 @@ { "module": "home-assistant", "version": "0.1", + "class": "leaf", "slug": "hass", "capabilities": [ "container-runtime" diff --git a/modules/hostname/module.json b/modules/hostname/module.json index 94ec44788..dc9a84014 100644 --- a/modules/hostname/module.json +++ b/modules/hostname/module.json @@ -1,6 +1,7 @@ { "module": "hostname", "version": "0.1", + "class": "core", "claims": [ { "name": "node-hostname", diff --git a/modules/i3/module.json b/modules/i3/module.json index 04a5810b4..315b77deb 100644 --- a/modules/i3/module.json +++ b/modules/i3/module.json @@ -1,6 +1,7 @@ { "module": "i3", "version": "0.1", + "class": "core", "moved": true, "capabilities": [ "package-manager" diff --git a/modules/i3status-rust/module.json b/modules/i3status-rust/module.json index 8e052bf67..4e85779f9 100644 --- a/modules/i3status-rust/module.json +++ b/modules/i3status-rust/module.json @@ -1,6 +1,7 @@ { "module": "i3status-rust", "version": "0.1", + "class": "core", "moved": true, "capabilities": [ "package-manager" diff --git a/modules/icecast/module.json b/modules/icecast/module.json index 052147018..ca6de7876 100644 --- a/modules/icecast/module.json +++ b/modules/icecast/module.json @@ -1,6 +1,7 @@ { "module": "icecast", "version": "0.1", + "class": "leaf", "requires": [ "route", "secret" diff --git a/modules/influxdb/module.json b/modules/influxdb/module.json index 23e0e4b25..80d2f225a 100644 --- a/modules/influxdb/module.json +++ b/modules/influxdb/module.json @@ -1,6 +1,7 @@ { "module": "influxdb", "version": "0.1", + "class": "leaf", "provides": [ { "name": "influxdb-api", diff --git a/modules/invoicing/module.json b/modules/invoicing/module.json index 89ace98a3..f56e75359 100644 --- a/modules/invoicing/module.json +++ b/modules/invoicing/module.json @@ -1,6 +1,7 @@ { "module": "invoicing", "version": "0.1", + "class": "leaf", "slug": "invoice", "capabilities": [ "container-runtime" diff --git a/modules/jira/module.json b/modules/jira/module.json index 81b7e845d..3d48f9f63 100644 --- a/modules/jira/module.json +++ b/modules/jira/module.json @@ -1,6 +1,7 @@ { "module": "jira", "version": "0.1", + "class": "leaf", "own-secrets": { "token": "${dir:state}/token" }, diff --git a/modules/kernel/module.json b/modules/kernel/module.json index d5fd22bc9..97a21caed 100644 --- a/modules/kernel/module.json +++ b/modules/kernel/module.json @@ -1,6 +1,7 @@ { "module": "kernel", "version": "0.1", + "class": "leaf", "capabilities": [ "service-manager" ], diff --git a/modules/keycloak/module.json b/modules/keycloak/module.json index 38f9b0610..cfad61b60 100644 --- a/modules/keycloak/module.json +++ b/modules/keycloak/module.json @@ -1,6 +1,7 @@ { "module": "keycloak", "version": "0.1", + "class": "leaf", "moved": true, "upgrade": { "policy": "record", diff --git a/modules/lab/module.json b/modules/lab/module.json index 4bddf1725..0d2f574e2 100644 --- a/modules/lab/module.json +++ b/modules/lab/module.json @@ -1,6 +1,7 @@ { "module": "lab", "version": "0.1", + "class": "leaf", "moved": true, "capabilities": [ "container-runtime", diff --git a/modules/lemurs/module.json b/modules/lemurs/module.json index 668e94a1f..8c143702d 100644 --- a/modules/lemurs/module.json +++ b/modules/lemurs/module.json @@ -1,6 +1,7 @@ { "module": "lemurs", "version": "0.1", + "class": "core", "capabilities": [ "package-manager", "service-manager", diff --git a/modules/letta/module.json b/modules/letta/module.json index d97ba80cb..fffb0e5ce 100644 --- a/modules/letta/module.json +++ b/modules/letta/module.json @@ -1,6 +1,7 @@ { "module": "letta", "version": "0.1", + "class": "leaf", "capabilities": [ "container-runtime" ], diff --git a/modules/local-model-consumer/module.json b/modules/local-model-consumer/module.json index 47403651f..cb35bdcad 100644 --- a/modules/local-model-consumer/module.json +++ b/modules/local-model-consumer/module.json @@ -1,6 +1,7 @@ { "module": "local-model-consumer", "version": "0.1", + "class": "leaf", "slug": "local", "requires": [ "model-access" diff --git a/modules/localization/module.json b/modules/localization/module.json index 14d5845e8..dad52ffbf 100644 --- a/modules/localization/module.json +++ b/modules/localization/module.json @@ -1,6 +1,7 @@ { "module": "localization", "version": "0.1", + "class": "leaf", "capabilities": [ "service-manager" ], diff --git a/modules/logrotate/module.json b/modules/logrotate/module.json index 1c41ac39b..4ec39c136 100644 --- a/modules/logrotate/module.json +++ b/modules/logrotate/module.json @@ -1,6 +1,7 @@ { "module": "logrotate", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager", "service-manager" diff --git a/modules/mailu/module.json b/modules/mailu/module.json index c1dd44617..f88907ddd 100644 --- a/modules/mailu/module.json +++ b/modules/mailu/module.json @@ -1,6 +1,7 @@ { "module": "mailu", "version": "0.1", + "class": "leaf", "upgrade": { "policy": "record", "why": "people's mail: any change to how its containers are declared recreates them together in one send, and the mail is down for everyone until they are up again — a person chooses the moment (hq ADR 0242, issue 295)" diff --git a/modules/marrytts/module.json b/modules/marrytts/module.json index ddadf075c..916c106f2 100644 --- a/modules/marrytts/module.json +++ b/modules/marrytts/module.json @@ -1,6 +1,7 @@ { "module": "marrytts", "version": "0.1", + "class": "leaf", "capabilities": [ "container-runtime" ], diff --git a/modules/matrix/module.json b/modules/matrix/module.json index 3c6282545..38ff40b06 100644 --- a/modules/matrix/module.json +++ b/modules/matrix/module.json @@ -1,6 +1,7 @@ { "module": "matrix", "version": "0.1", + "class": "leaf", "capabilities": [ "container-runtime" ], diff --git a/modules/memory-pressure/module.json b/modules/memory-pressure/module.json index 6fe32ff11..c4fc5ffec 100644 --- a/modules/memory-pressure/module.json +++ b/modules/memory-pressure/module.json @@ -1,6 +1,7 @@ { "module": "memory-pressure", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager", "service-manager" diff --git a/modules/mesh-catalog/module.json b/modules/mesh-catalog/module.json index f3353220c..421804df1 100644 --- a/modules/mesh-catalog/module.json +++ b/modules/mesh-catalog/module.json @@ -2,6 +2,7 @@ "module": "mesh-catalog", "slug": "catalog", "version": "0.1", + "class": "leaf", "capabilities": [ "container-runtime" ], diff --git a/modules/mesh-cli/module.json b/modules/mesh-cli/module.json index d07f47d85..86325ec23 100644 --- a/modules/mesh-cli/module.json +++ b/modules/mesh-cli/module.json @@ -1,6 +1,7 @@ { "module": "mesh-cli", "version": "0.1", + "class": "leaf", "moved": true, "requires": [ "mcp-endpoint" diff --git a/modules/mesh-conditions/module.json b/modules/mesh-conditions/module.json index f8b9ca440..4bfcc3fe1 100644 --- a/modules/mesh-conditions/module.json +++ b/modules/mesh-conditions/module.json @@ -1,6 +1,7 @@ { "module": "mesh-conditions", "version": "0.1", + "class": "core", "runs-as": "mesh-conditions", "claims": [ { diff --git a/modules/mesh-config/module.json b/modules/mesh-config/module.json index 58d0d9540..e6ac9ed63 100644 --- a/modules/mesh-config/module.json +++ b/modules/mesh-config/module.json @@ -1,6 +1,7 @@ { "module": "mesh-config", "version": "0.1", + "class": "core", "runs-as": "mesh-config", "claims": [ { diff --git a/modules/mesh-delivery-gate/cmd/mesh-delivery-gate/heads.go b/modules/mesh-delivery-gate/cmd/mesh-delivery-gate/heads.go index ea4d1d7bd..c2b80d4dd 100644 --- a/modules/mesh-delivery-gate/cmd/mesh-delivery-gate/heads.go +++ b/modules/mesh-delivery-gate/cmd/mesh-delivery-gate/heads.go @@ -12,7 +12,9 @@ import ( "encoding/json" "errors" "fmt" + "os" "sort" + "sync" "time" "git.novox.be/novox/mesh-contracts/health-and-repair/go/seats/meshconditions" @@ -20,6 +22,8 @@ import ( "git.novox.be/novox/mesh-delivery/modules/mesh-delivery-forge-bridge/forgemsg" stdio "git.novox.be/novox/mesh-sdk/go" "git.novox.be/novox/mesh-sdk/go/keys" + "git.novox.be/novox/mesh-sdk/go/stateobjects" + "git.novox.be/novox/mesh-sdk/go/views" ) // HeadUntaken is the finding of a head no merge call delivered; warning, the operator its resolver (H-A-81). @@ -61,10 +65,27 @@ func (kvHeads) Get(key string) (*HeldHead, error) { } func (kvHeads) Put(key string, v HeldHead) error { - _, err := stdio.State(seat.StateHeads).Put(key, v) + _, err := prunedHeads().Put(key, v) return err } +// prunedHeads is the state heads, pruned toward its cap at the gate's own writes (design 47 H2 §812; H-A-411 (3)): past +// prune-mark of its 8 MiB the oldest keys go down to prune-target, in one journal line. A setting that is no percentage +// is said, and the defaults hold. +var prunedHeads = sync.OnceValue(func() *stdio.PrunedState { + p, err := stdio.PruneSettings() + if err != nil { + fmt.Fprintf(os.Stderr, "the prune of heads keeps its defaults (%d %% to %d %%): %v\n", stdio.PruneMarkDefault, stdio.PruneTargetDefault, err) + p = stdio.Prune{Mark: stdio.PruneMarkDefault, Target: stdio.PruneTargetDefault} + } + return stdio.State(seat.StateHeads).Pruned(p) +}) + +// headsPruneTools are the gate's two prune tools over heads, each written in the hand-act log (H-A-380 (3)). +func headsPruneTools(acts views.HandActs) []stdio.Tool { + return stateobjects.PruneTools(Module, []stateobjects.Pruning{{Name: seat.StateHeads, State: prunedHeads()}}, acts) +} + func (kvHeads) Delete(key string) error { return stdio.State(seat.StateHeads).Delete(key) } func (s kvHeads) All() (map[string]HeldHead, error) { diff --git a/modules/mesh-delivery-gate/cmd/mesh-delivery-gate/main.go b/modules/mesh-delivery-gate/cmd/mesh-delivery-gate/main.go index 7075dd84a..42dadf5a4 100644 --- a/modules/mesh-delivery-gate/cmd/mesh-delivery-gate/main.go +++ b/modules/mesh-delivery-gate/cmd/mesh-delivery-gate/main.go @@ -263,6 +263,8 @@ func tools(h *Holder, l *listening) []stdio.Tool { list = append(list, recordTools(h, meshhandactsclient.Recorder{Ask: stdio.Ask})...) list = append(list, sourceTools(h, meshhandactsclient.Recorder{Ask: stdio.Ask})...) list = append(list, headTools(h, meshhandactsclient.Recorder{Ask: stdio.Ask})...) + // The prune of heads by hand, now or kept from it (design 47 H2 §812, H-A-380 (3)). + list = append(list, headsPruneTools(meshhandactsclient.Recorder{Ask: stdio.Ask})...) // A verb that changes a delivery asks for a look at what it makes possible (react.go). for i := range list { run := list[i].Run diff --git a/modules/mesh-delivery-gate/cmd/mesh-delivery-gate/owed.go b/modules/mesh-delivery-gate/cmd/mesh-delivery-gate/owed.go index 938dd0466..4e52798cd 100644 --- a/modules/mesh-delivery-gate/cmd/mesh-delivery-gate/owed.go +++ b/modules/mesh-delivery-gate/cmd/mesh-delivery-gate/owed.go @@ -48,6 +48,9 @@ func (h *Holder) owe(r *Record, o seat.Owed) error { return errors.New("no seat to say owed on") } now := h.Now().UTC() + // The act names its delivery record by its source revision, ., so the forge bridge keeps it with the act + // and bridge_owed_again finds a record's acts in its own state (design 47 H2 §807, H-A-432 (1)). + o.Record = r.Milestone if had, ok := r.Acts[o.ID]; ok && had.Owed.Said != nil { o.Said = had.Owed.Said } else { diff --git a/modules/mesh-delivery-gate/cmd/mesh-delivery-gate/owedacts_test.go b/modules/mesh-delivery-gate/cmd/mesh-delivery-gate/owedacts_test.go index 29bea18c0..41338b81c 100644 --- a/modules/mesh-delivery-gate/cmd/mesh-delivery-gate/owedacts_test.go +++ b/modules/mesh-delivery-gate/cmd/mesh-delivery-gate/owedacts_test.go @@ -6,6 +6,7 @@ import ( "time" seat "git.novox.be/novox/mesh-delivery/modules/mesh-delivery-contracts/go/seats/meshdelivery" + "git.novox.be/novox/mesh-delivery/modules/mesh-delivery-forge-bridge/forgemsg" ) type sayerFake struct{ said []seat.Owed } @@ -54,6 +55,10 @@ func TestARecordsChangesOweTheNoteTheViewAndWhenFailedOrHeldAComment(t *testing. if _, ok := r.Acts[o.ID]; !ok { t.Fatalf("act %s not kept in the record", o.ID) } + // H-A-432 (1): each act names its record by its source revision, said and kept alike. + if o.Record != "main.47" || r.Acts[o.ID].Owed.Record != o.Record { + t.Fatalf("act %s names the record %q, kept %q, not main.47", o.ID, o.Record, r.Acts[o.ID].Owed.Record) + } if o.Act == seat.OwedActNote && (o.Line != "2026-11-11T21:00:00Z record "+r.Instance+": mesh-x on ace build built (built it)" || o.Commit != head) { t.Fatalf("note %+v", o) } @@ -66,6 +71,34 @@ func TestARecordsChangesOweTheNoteTheViewAndWhenFailedOrHeldAComment(t *testing. t.Fatalf("said again: %v %d", err, len(f.said)) } }) + // Design 47 H2 §807, H-A-432 (2): an act whose pull request closed unmerged ends not-needed, kept in the record's acts as + // ended like performed and could not be performed, and no longer owed. + t.Run("an act the forge bridge ends not-needed is ended in the record and owed no more", func(t *testing.T) { + h, rs, r, f := setup(t) + h.Logf = func(string, ...any) {} + if _, err := rs.Outcome(r, RecordOutcome{Module: "mesh-x", Fingerprint: "src2:f1", Node: "ace", Step: "build", Outcome: OutcomeBuilt, Why: "built it"}); err != nil { + t.Fatal(err) + } + id := f.said[0].ID + body, err := forgemsg.EncodeOwedEnded(forgemsg.OwedEnded{V: 1, Of: seat.Seat, ID: id, Outcome: forgemsg.OwedNotNeeded, + Words: "novox/app#7 closed unmerged", At: at}) + if err != nil { + t.Fatal(err) + } + if err := h.OwedEnded(body); err != nil { + t.Fatal(err) + } + kept, err := rs.Kept() + if err != nil || len(kept) != 1 { + t.Fatalf("kept %d records: %v", len(kept), err) + } + if a := kept[0].Acts[id]; a.Outcome != forgemsg.OwedNotNeeded || a.Words != "novox/app#7 closed unmerged" { + t.Fatalf("the act is kept as %+v", a) + } + if owed := h.Status("")["owed"]; owed != 1 { + t.Fatalf("%v acts owed, not the one left", owed) + } + }) t.Run("a record ended failed says a comment naming why; ended healthy says none", func(t *testing.T) { _, rs, r, f := setup(t) if _, err := rs.Outcome(r, RecordOutcome{Module: "mesh-x", Fingerprint: "src2:f1", Node: "ace", Step: "build", Outcome: OutcomeFailed, Why: "tests red"}); err != nil { diff --git a/modules/mesh-delivery-gate/module.json b/modules/mesh-delivery-gate/module.json index 199323090..37f784c26 100644 --- a/modules/mesh-delivery-gate/module.json +++ b/modules/mesh-delivery-gate/module.json @@ -1,6 +1,7 @@ { "module": "mesh-delivery-gate", "version": "0.1", + "class": "core", "slug": "gate", "claims": [ { @@ -368,12 +369,18 @@ { "name": "heads", "storage": "key-value", - "template": "state" + "template": "state", + "options": { + "max-mib": 8 + } }, { "name": "findings", "storage": "key-value", - "template": "state" + "template": "state", + "options": { + "max-mib": 8 + } }, { "name": "finding-events", @@ -386,7 +393,7 @@ "findings-stated.*" ], "max-age-days": 7, - "max-mib": 16 + "max-mib": 8 } } ], @@ -405,7 +412,8 @@ "state": [ { "name": "source", - "history": 64 + "history": 64, + "max-mib": 8 } ], "capabilities": [ @@ -425,7 +433,9 @@ "gate_source_again", "gate_source_seed", "gate_source_start", - "gate_times" + "gate_times", + "mesh-delivery-gate_state_keep", + "mesh-delivery-gate_state_prune_now" ], "config": { "record-retention": { @@ -456,6 +466,24 @@ "trusted": false, "runtime": true, "default": "3m" + }, + "prune-mark": { + "type": "number", + "description": "The fill of the gate's state heads, in percent of its cap, past which the gate prunes it at its own write, oldest first (design 47 H2 §812): below the bus module's raise mark of 75 %.", + "trusted": false, + "runtime": true, + "minimum": 1, + "maximum": 100, + "default": 70 + }, + "prune-target": { + "type": "number", + "description": "The fill, in percent of the cap, a prune of the gate's state heads takes it down to (design 47 H2 §812); below prune-mark.", + "trusted": false, + "runtime": true, + "minimum": 1, + "maximum": 100, + "default": 50 } }, "resources": [ diff --git a/modules/mesh-files/module.json b/modules/mesh-files/module.json index c43c13d49..4b75b5f33 100644 --- a/modules/mesh-files/module.json +++ b/modules/mesh-files/module.json @@ -1,6 +1,7 @@ { "module": "mesh-files", "version": "0.1", + "class": "core", "claims": [ { "name": "node-files", diff --git a/modules/mesh-hand-acts/module.json b/modules/mesh-hand-acts/module.json index ef8bb16a9..6131b4e2e 100644 --- a/modules/mesh-hand-acts/module.json +++ b/modules/mesh-hand-acts/module.json @@ -1,6 +1,7 @@ { "module": "mesh-hand-acts", "version": "0.1", + "class": "core", "runs-as": "mesh-hand-acts", "claims": [ { diff --git a/modules/mesh-healers/module.json b/modules/mesh-healers/module.json index ccfb3216d..930c16ec9 100644 --- a/modules/mesh-healers/module.json +++ b/modules/mesh-healers/module.json @@ -1,6 +1,7 @@ { "module": "mesh-healers", "version": "0.1", + "class": "core", "runs-as": "mesh-healers", "claims": [ { @@ -93,7 +94,7 @@ "findings-stated.*" ], "max-age-days": 7, - "max-mib": 16 + "max-mib": 8 } } ] diff --git a/modules/mesh-issues/module.json b/modules/mesh-issues/module.json index 7e1f48975..ec6bdc8f8 100644 --- a/modules/mesh-issues/module.json +++ b/modules/mesh-issues/module.json @@ -1,6 +1,7 @@ { "module": "mesh-issues", "version": "0.1", + "class": "core", "slug": "issues", "seats": [ { diff --git a/modules/mesh-knowledge/module.json b/modules/mesh-knowledge/module.json index 73ab8fe61..43fbf81f2 100644 --- a/modules/mesh-knowledge/module.json +++ b/modules/mesh-knowledge/module.json @@ -1,6 +1,7 @@ { "module": "mesh-knowledge", "version": "0.1", + "class": "core", "slug": "knowledge", "requires": [ "postgres-database", @@ -81,7 +82,7 @@ {"name": "reviews", "storage": "stream", "configuration": {"when-full": "refuse", "max-mib": 512, "max-age-days": "none", "grant": "readers", "events": ["part-reviewed"]}}, { "name": "finding-events", "storage": "stream", "template": "events", - "options": {"events": ["finding-written.*", "finding-cleared.*", "findings-stated.*"], "max-age-days": 7, "max-mib": 16} + "options": {"events": ["finding-written.*", "finding-cleared.*", "findings-stated.*"], "max-age-days": 7, "max-mib": 8} } ], "contributes": { diff --git a/modules/mesh-mail-notifier/module.json b/modules/mesh-mail-notifier/module.json index 8197fb30f..290b2b2c2 100644 --- a/modules/mesh-mail-notifier/module.json +++ b/modules/mesh-mail-notifier/module.json @@ -1,6 +1,7 @@ { "module": "mesh-mail-notifier", "version": "0.1", + "class": "core", "runs-as": "mesh-mail-notifier", "claims": [ { diff --git a/modules/mesh-mail-reader/module.json b/modules/mesh-mail-reader/module.json index 5ec31bd2b..211b6dbe5 100644 --- a/modules/mesh-mail-reader/module.json +++ b/modules/mesh-mail-reader/module.json @@ -1,6 +1,7 @@ { "module": "mesh-mail-reader", "version": "0.1", + "class": "core", "runs-as": "mesh-mail-reader", "claims": [ { diff --git a/modules/mesh-mail-web/module.json b/modules/mesh-mail-web/module.json index ddb16db66..f9192aac6 100644 --- a/modules/mesh-mail-web/module.json +++ b/modules/mesh-mail-web/module.json @@ -1,6 +1,7 @@ { "module": "mesh-mail-web", "version": "0.1", + "class": "core", "slug": "mail-web", "runs-as": "mesh-mail-web", "claims": [ diff --git a/modules/mesh-mail/module.json b/modules/mesh-mail/module.json index ce94111a8..42ad7e902 100644 --- a/modules/mesh-mail/module.json +++ b/modules/mesh-mail/module.json @@ -1,6 +1,7 @@ { "module": "mesh-mail", "version": "0.1", + "class": "core", "slug": "mail", "seats": [ { diff --git a/modules/mesh-provisioner-client/module.json b/modules/mesh-provisioner-client/module.json index 53a205b6c..c086a9afc 100644 --- a/modules/mesh-provisioner-client/module.json +++ b/modules/mesh-provisioner-client/module.json @@ -1,6 +1,7 @@ { "module": "mesh-provisioner-client", "version": "0.1", + "class": "core", "claims": [ { "name": "node-provisioner", diff --git a/modules/mesh-provisioner/module.json b/modules/mesh-provisioner/module.json index 15028d356..dd980a5c0 100644 --- a/modules/mesh-provisioner/module.json +++ b/modules/mesh-provisioner/module.json @@ -1,6 +1,7 @@ { "module": "mesh-provisioner", "version": "0.1", + "class": "core", "runs-as": "mesh-provisioner", "claims": [ { @@ -118,7 +119,7 @@ "findings-stated.*" ], "max-age-days": 7, - "max-mib": 16 + "max-mib": 8 } }, { diff --git a/modules/mesh-reads/module.json b/modules/mesh-reads/module.json index 4dae766f8..1067ef63e 100644 --- a/modules/mesh-reads/module.json +++ b/modules/mesh-reads/module.json @@ -1,6 +1,7 @@ { "module": "mesh-reads", "version": "0.1", + "class": "core", "runs-as": "mesh-reads", "claims": [ { diff --git a/modules/mesh-recovery/module.json b/modules/mesh-recovery/module.json index 9a955a3f8..2719831e7 100644 --- a/modules/mesh-recovery/module.json +++ b/modules/mesh-recovery/module.json @@ -1,6 +1,7 @@ { "module": "mesh-recovery", "version": "0.1", + "class": "core", "runs-as": "mesh-recovery", "claims": [ { @@ -93,7 +94,7 @@ "findings-stated.*" ], "max-age-days": 7, - "max-mib": 16 + "max-mib": 8 } } ], diff --git a/modules/mesh-self-check/module.json b/modules/mesh-self-check/module.json index 9b07d05fe..ec9dfb550 100644 --- a/modules/mesh-self-check/module.json +++ b/modules/mesh-self-check/module.json @@ -1,6 +1,7 @@ { "module": "mesh-self-check", "version": "0.1", + "class": "core", "packages": { "git.novox.be/novox/mesh-catalog/modules/restic/backupgood": "0.1", "git.novox.be/novox/mesh-catalog/modules/disk-load/diskreadings": "0.1" @@ -115,7 +116,7 @@ "findings-stated.*" ], "max-age-days": 7, - "max-mib": 16 + "max-mib": 8 } } ] diff --git a/modules/mesh-vault/module.json b/modules/mesh-vault/module.json index 9332157b0..1e9300a8e 100644 --- a/modules/mesh-vault/module.json +++ b/modules/mesh-vault/module.json @@ -1,6 +1,7 @@ { "module": "mesh-vault", "version": "0.1", + "class": "core", "packages": { "git.novox.be/novox/mesh-delivery/modules/mesh-grants/grantsstate": "0.1" }, diff --git a/modules/mesh-watcher/module.json b/modules/mesh-watcher/module.json index 020e049a6..23877ef24 100644 --- a/modules/mesh-watcher/module.json +++ b/modules/mesh-watcher/module.json @@ -1,6 +1,7 @@ { "module": "mesh-watcher", "version": "0.1", + "class": "leaf", "slug": "watch", "consumes": [ "mesh-self-check.checked", @@ -92,7 +93,7 @@ "findings-stated.*" ], "max-age-days": 7, - "max-mib": 16 + "max-mib": 8 } } ] diff --git a/modules/messenger/module.json b/modules/messenger/module.json index 020de147d..4f89a31b8 100644 --- a/modules/messenger/module.json +++ b/modules/messenger/module.json @@ -1,6 +1,7 @@ { "module": "messenger", "version": "0.1", + "class": "core", "slug": "msgr", "runs-as": "messenger", "seats": [ diff --git a/modules/minio/module.json b/modules/minio/module.json index 4f829c495..956a69fb6 100644 --- a/modules/minio/module.json +++ b/modules/minio/module.json @@ -1,6 +1,7 @@ { "module": "minio", "version": "0.1", + "class": "core", "upgrade": { "policy": "record", "why": "holds the photos themselves (irreplaceable, kept by photos) for its consumers: a person takes each build, after a backup (hq ADR 0236)" @@ -36,7 +37,7 @@ "findings-stated.*" ], "max-age-days": 7, - "max-mib": 16 + "max-mib": 8 } } ], diff --git a/modules/model-usage/module.json b/modules/model-usage/module.json index 6e5b3c96f..86ef6f202 100644 --- a/modules/model-usage/module.json +++ b/modules/model-usage/module.json @@ -1,6 +1,7 @@ { "module": "model-usage", "version": "0.1", + "class": "leaf", "slug": "usage", "capabilities": [ "container-runtime" diff --git a/modules/mongodb/module.json b/modules/mongodb/module.json index 5e0961211..27ab92027 100644 --- a/modules/mongodb/module.json +++ b/modules/mongodb/module.json @@ -1,6 +1,7 @@ { "module": "mongodb", "version": "0.1", + "class": "leaf", "upgrade": { "policy": "record", "why": "a provider whose restart drops every consumer on its machine, and which holds the photos' albums (irreplaceable, kept by photos): a person takes each build, after a backup (hq ADR 0236)" diff --git a/modules/mosquitto/module.json b/modules/mosquitto/module.json index e1e0bf0c6..a8bb15153 100644 --- a/modules/mosquitto/module.json +++ b/modules/mosquitto/module.json @@ -1,6 +1,7 @@ { "module": "mosquitto", "version": "0.1", + "class": "leaf", "slug": "mosq", "provides": [ { diff --git a/modules/mounts/module.json b/modules/mounts/module.json index cd89f3659..2da577468 100644 --- a/modules/mounts/module.json +++ b/modules/mounts/module.json @@ -1,6 +1,7 @@ { "module": "mounts", "version": "0.1", + "class": "core", "packages": { "git.novox.be/novox/mesh-catalog/modules/disk-load/diskreadings": "0.1" }, diff --git a/modules/mssql/module.json b/modules/mssql/module.json index a34bcea2e..52f62daa9 100644 --- a/modules/mssql/module.json +++ b/modules/mssql/module.json @@ -1,6 +1,7 @@ { "module": "mssql", "version": "0.1", + "class": "leaf", "upgrade": { "policy": "record", "why": "a provider whose restart drops every consumer on its machine, and whose new version may upgrade its databases in place: a person takes each build, after a backup (hq ADR 0236)" diff --git a/modules/n8n/module.json b/modules/n8n/module.json index bdbfbd24d..d67bc7a60 100644 --- a/modules/n8n/module.json +++ b/modules/n8n/module.json @@ -1,6 +1,7 @@ { "module": "n8n", "version": "0.1", + "class": "leaf", "capabilities": [ "container-runtime" ], diff --git a/modules/nats/module.json b/modules/nats/module.json index 105d9a30d..bcc65be90 100644 --- a/modules/nats/module.json +++ b/modules/nats/module.json @@ -1,6 +1,7 @@ { "module": "nats", "version": "0.1", + "class": "core", "packages": { "git.novox.be/novox/mesh-delivery/modules/mesh-grants/busgrants": "0.1" }, diff --git a/modules/netcheck/module.json b/modules/netcheck/module.json index bb9b92f93..ba762203c 100644 --- a/modules/netcheck/module.json +++ b/modules/netcheck/module.json @@ -1,6 +1,7 @@ { "module": "netcheck", "version": "0.1", + "class": "leaf", "emits": [ "tunnel.endpoint-changed", "tunnel.handshake-stale", diff --git a/modules/networkmanager/module.json b/modules/networkmanager/module.json index 89d4ecc40..3433f40ba 100644 --- a/modules/networkmanager/module.json +++ b/modules/networkmanager/module.json @@ -1,6 +1,7 @@ { "module": "networkmanager", "version": "0.1", + "class": "core", "upgrade": { "policy": "record", "why": "the machine's network: a build that breaks it can cut the machine off from the bus, and then neither the gate's rollback nor a push reaches it (hq ADR 0236)" diff --git a/modules/nextcloud-client/module.json b/modules/nextcloud-client/module.json index 9b6c1c0c5..5b603e465 100644 --- a/modules/nextcloud-client/module.json +++ b/modules/nextcloud-client/module.json @@ -1,6 +1,7 @@ { "module": "nextcloud-client", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager" ], diff --git a/modules/nextcloud/module.json b/modules/nextcloud/module.json index 4560c106a..c4efbe8a4 100644 --- a/modules/nextcloud/module.json +++ b/modules/nextcloud/module.json @@ -1,6 +1,7 @@ { "module": "nextcloud", "version": "0.1", + "class": "leaf", "slug": "ncloud", "requires": [ "postgres-database", diff --git a/modules/nfs-server/cmd/nfs-server/reconcile_test.go b/modules/nfs-server/cmd/nfs-server/reconcile_test.go index d6be1ada7..94194c704 100644 --- a/modules/nfs-server/cmd/nfs-server/reconcile_test.go +++ b/modules/nfs-server/cmd/nfs-server/reconcile_test.go @@ -21,7 +21,7 @@ func countExportfs(ran []string) int { // and the kernel still exported the refused folder while the module said it was healthy. A failed reload // is tried again on the next pass, and while the kernel exports anything of the module's that the file no // longer carries, the module is unhealthy and says what. -func TestARefusalWhoseReloadFailedIsReloadedAgainAndIsUnhealthyUntilItIs(t *testing.T) { +func testARefusalWhoseReloadFailedIsReloadedAgainAndIsUnhealthyUntilItIs(t *testing.T) { f := newFake(t) f.mountinfo("/", "/srv/pool") f.dir("/srv/pool") @@ -72,7 +72,7 @@ func TestARefusalWhoseReloadFailedIsReloadedAgainAndIsUnhealthyUntilItIs(t *test // that never happened — is reconciled: the first pass always reloads, a later pass reloads when the kernel // exports one of the module's folders to a client the file no longer has, and the module is unhealthy // while it cannot. -func TestAWithdrawnGrantIsTakenFromTheKernel(t *testing.T) { +func testAWithdrawnGrantIsTakenFromTheKernel(t *testing.T) { f := newFake(t) f.mountinfo("/", "/srv/library") f.dir("/srv/library") @@ -122,7 +122,7 @@ func TestAWithdrawnGrantIsTakenFromTheKernel(t *testing.T) { // The review of #142: SIGTERM in the middle of a pass on a plain restart (the config is still there) ends // the pass, and the exports stay: the export file is unchanged and the kernel's table keeps the share. -func TestSIGTERMDuringAPassOnARestartLeavesTheExports(t *testing.T) { +func testSIGTERMDuringAPassOnARestartLeavesTheExports(t *testing.T) { f := newFake(t) f.mountinfo("/", "/srv/library") f.dir("/srv/library") @@ -173,7 +173,7 @@ func TestSIGTERMDuringAPassOnARestartLeavesTheExports(t *testing.T) { // unassignment then stops it with the config still there. The node-engine disables a process's unit before // it stops it (`systemctl disable --now`), and a restart or a shutdown leaves it enabled, so a process // whose own unit is disabled when it is stopped is being taken away, whatever the config says. -func TestAProcessWhoseUnitIsDisabledAtStopCleansUpWithTheConfigStillThere(t *testing.T) { +func testAProcessWhoseUnitIsDisabledAtStopCleansUpWithTheConfigStillThere(t *testing.T) { f := newFake(t) f.mountinfo("/", "/srv/library") f.dir("/srv/library") @@ -199,3 +199,20 @@ func TestAProcessWhoseUnitIsDisabledAtStopCleansUpWithTheConfigStillThere(t *tes t.Errorf("the kernel still exports the library after an unassignment with the config in place: %q", f.read(Etab)) } } + +// TestARefusalWhoseReloadFailedIsReloadedAgainAndIsUnhealthyUntilItIs runs this file's cases in order as one test, each a row: the check counts every top-level test against the +// module's budget of 50 (design 47 H2 §819). A failing case is named by the line logged before it. +func TestARefusalWhoseReloadFailedIsReloadedAgainAndIsUnhealthyUntilItIs(t *testing.T) { + for _, c := range []struct { + name string + run func(*testing.T) + }{ + {"TestARefusalWhoseReloadFailedIsReloadedAgainAndIsUnhealthyUntilItIs", testARefusalWhoseReloadFailedIsReloadedAgainAndIsUnhealthyUntilItIs}, + {"TestAWithdrawnGrantIsTakenFromTheKernel", testAWithdrawnGrantIsTakenFromTheKernel}, + {"TestSIGTERMDuringAPassOnARestartLeavesTheExports", testSIGTERMDuringAPassOnARestartLeavesTheExports}, + {"TestAProcessWhoseUnitIsDisabledAtStopCleansUpWithTheConfigStillThere", testAProcessWhoseUnitIsDisabledAtStopCleansUpWithTheConfigStillThere}, + } { + t.Logf("case %s", c.name) + c.run(t) + } +} diff --git a/modules/nfs-server/module.json b/modules/nfs-server/module.json index 1bb18465f..b3f027d18 100644 --- a/modules/nfs-server/module.json +++ b/modules/nfs-server/module.json @@ -1,6 +1,7 @@ { "module": "nfs-server", "version": "0.1", + "class": "core", "packages": { "git.novox.be/novox/mesh-catalog/modules/disk-load/diskreadings": "0.1" }, @@ -216,7 +217,7 @@ "findings-stated.*" ], "max-age-days": 7, - "max-mib": 16 + "max-mib": 8 } } ] diff --git a/modules/nftables/allowances.ts b/modules/nftables/allowances.ts index ce60ceb39..69826a2c6 100644 --- a/modules/nftables/allowances.ts +++ b/modules/nftables/allowances.ts @@ -324,8 +324,8 @@ export class Allowances { const until = untilOf(args.until, now); const why = whyOf(args.why); if (!source && privateOnly(await this.asks.meshTable(), protocol, port)) { - refuse("port", `${protocol} ${port} is admitted by a derived rule of the loaded mesh table from given sources only (the private network's, such as the store's ` + - "port or the broker's management port); an allowance from any source would widen it: give a source"); + refuse("port", `${protocol} ${port} is admitted by a derived rule of the loaded mesh table from given sources only (its scope private-network or ` + + "local-network, such as the store's port or the broker's management port); an allowance from any source would widen it: give a source"); } const most = await this.asks.most(); const kept = await this.ownKeys(); @@ -442,23 +442,27 @@ export function markLoaded(allowances: Allowance[], meshTable: string): { }; } -/** Whether the loaded mesh table's input chain accepts `protocol` `port` only with a source match (`ip saddr` or `ip6 - * saddr`) and never from any source: a port a derived rule admits from the private network only (§3, H-A-315 (7), - * H-A-319). */ -export function privateOnly(meshTable: string, protocol: Protocol, port: number): boolean { - const input = /chain input \{([\s\S]*?)\n\t?\}/.exec(meshTable)?.[1] ?? ""; - let withSource = false; - for (const line of input.split("\n")) { - if (!/\baccept\b/.test(line) || !line.includes(`${protocol} dport `)) continue; - const ports = /dport (\{[^}]*\}|\S+)/.exec(line)?.[1] ?? ""; - const names = ports.replace(/[{}]/g, "").split(",").map((p) => p.trim()).filter(Boolean); - const named = names.some((p) => { - const [lo, hi] = p.split("-").map(Number); - return hi === undefined ? lo === port : lo <= port && port <= hi; - }); - if (!named) continue; - if (!/\bip6? saddr\b/.test(line)) return false; - withSource = true; +/** The scopes the node-engine's render writes on a derived accept rule (design 47 H2 §813 (4), H-A-357). */ +export type Scope = "any" | "private-network" | "local-network"; + +/** + * The scopes the loaded mesh table's derived accept rules give `protocol` `port`, read from each rule's one comment + * `derived / scope ` (design 47 H2 §813 (4), + * H-A-357), the module list cut with a count past 128 bytes (`derived a,b,+4 tcp/443 scope any`, H-A-384 (1)); never + * from the rule's shape. A port is one port or a range `lo-hi`. + */ +export function portScopes(meshTable: string, protocol: Protocol, port: number): Scope[] { + const out: Scope[] = []; + for (const m of meshTable.matchAll(/comment "derived \S+ (tcp|udp)\/(\d+)(?:-(\d+))? scope (any|private-network|local-network)"/g)) { + const lo = Number(m[2]), hi = m[3] === undefined ? lo : Number(m[3]); + if (m[1] === protocol && lo <= port && port <= hi) out.push(m[4] as Scope); } - return withSource; + return out; +} + +/** Whether a derived rule admits `protocol` `port` from given sources only (the private network or the local network) + * and none from any source: its scope read from the rules' comments (§813 (4), H-A-315 (7), H-A-319). */ +export function privateOnly(meshTable: string, protocol: Protocol, port: number): boolean { + const scopes = portScopes(meshTable, protocol, port); + return scopes.length > 0 && !scopes.includes("any"); } diff --git a/modules/nftables/module.json b/modules/nftables/module.json index 68964f4fa..f4b31b727 100644 --- a/modules/nftables/module.json +++ b/modules/nftables/module.json @@ -1,6 +1,7 @@ { "module": "nftables", "version": "0.1", + "class": "core", "upgrade": { "policy": "record", "why": "the machine's packet filter: a build that breaks it can cut the machine off from the bus, and then neither the gate's rollback nor a push reaches it (hq ADR 0236)" @@ -94,6 +95,7 @@ "type": "number", "description": "The most allowances this machine keeps, which allow refuses past (design 33 control-verbs §3): it keeps the rendered chain readable and allowed in one answer.", "trusted": false, + "runtime": true, "default": 100 } }, diff --git a/modules/nftables/test/allowances.test.ts b/modules/nftables/test/allowances.test.ts index f905db821..7bd8d219c 100644 --- a/modules/nftables/test/allowances.test.ts +++ b/modules/nftables/test/allowances.test.ts @@ -10,10 +10,18 @@ import { interface Timer { ms: number; fire: () => void; cancelled: boolean } -// The loaded mesh table: the store's port from the private network only, 80 from anywhere and 8443 from both. +// The loaded mesh table: the store's port from the private network only, 80 from anywhere and 8443 from both; each derived +// accept rule carries the one comment the node-engine's render writes, `derived / scope ` +// (47 H2 §813 (4), H-A-357), its module list cut with a count past 128 bytes (H-A-384 (1)). const TABLE = 'table inet mesh {\n\tchain input {\n\t\ttype filter hook input priority filter; policy drop;\n' + - '\t\tip saddr { 10.77.0.1, 10.77.0.2 } tcp dport 5432 accept\n\t\tip6 saddr { fd77::1 } tcp dport 5432 accept\n' + - '\t\ttcp dport 80 accept\n\t\tip saddr { 10.77.0.1 } tcp dport { 8443, 9500-9600 } accept\n\t\ttcp dport 8443 accept\n\t}\n}\n'; + '\t\tip saddr { 10.77.0.1, 10.77.0.2 } tcp dport 5432 accept comment "derived postgres tcp/5432 scope private-network"\n' + + '\t\tip6 saddr { fd77::1 } tcp dport 5432 accept comment "derived postgres tcp/5432 scope private-network"\n' + + '\t\ttcp dport 80 accept comment "derived route-proxy tcp/80 scope any"\n' + + '\t\tip saddr { 10.77.0.1 } tcp dport 8443 accept comment "derived a,b,+4 tcp/8443 scope private-network"\n' + + '\t\ttcp dport 8443 accept comment "derived c tcp/8443 scope any"\n' + + '\t\tip saddr { 192.168.1.0/24 } tcp dport 9500-9600 accept comment "derived nats tcp/9500-9600 scope local-network"\n' + + '\t\ttcp dport 7000 accept comment "derived x,+2 tcp/7000 scope private-network"\n' + + '\t\tip saddr { 10.77.0.1 } tcp dport 7100 accept\n\t}\n}\n'; // gate, when given, holds every delete until it opens, and every get waits a turn of the event loop: a slow store. function fake(at = "2026-11-21T20:00:00Z", node = "shanks", kept = new Map(), gate?: Promise) { @@ -189,9 +197,12 @@ test("allowed asks converged again while none answered, and refuses when it does assert.equal(asks.asked, asked + 2, "an answer held is not asked again"); }); -test("privateOnly: a port accepted only with a source match, never from any source", () => { +test("privateOnly: a port a derived rule's comment scopes to the private or the local network, none to any", () => { assert.equal(privateOnly(TABLE, "tcp", 5432), true); - assert.equal(privateOnly(TABLE, "tcp", 9550), true, "a range of a set"); + assert.equal(privateOnly(TABLE, "tcp", 9550), true, "a range, local-network"); + // 47 H2 §813 (4): the scope is read from the rule's comment, never from its shape. + assert.equal(privateOnly(TABLE, "tcp", 7000), true, "a comment cut with a count says private-network, whatever the shape"); + assert.equal(privateOnly(TABLE, "tcp", 7100), false, "a rule with a source match and no derived comment names no scope"); assert.equal(privateOnly(TABLE, "tcp", 80), false); assert.equal(privateOnly(TABLE, "tcp", 8443), false, "accepted from anywhere too"); assert.equal(privateOnly(TABLE, "udp", 5432), false); @@ -342,4 +353,5 @@ test("the manifest serves the six verbs, requires the state per machine, invokes assert.deepEqual(m.invokes, ["seat:node-engine.converged", "seat:mesh-hand-acts.hand-act"]); assert.equal(m.emits, undefined, "the claim says the seat's event (H-A-317)"); assert.equal(m.config["allowances-max"].default, MOST); + assert.equal(m.config["allowances-max"].runtime, true, "the holder's code reads it itself; no file places it (H-A-430 (4))"); }); diff --git a/modules/nm-applet/module.json b/modules/nm-applet/module.json index 7552731c7..22f916059 100644 --- a/modules/nm-applet/module.json +++ b/modules/nm-applet/module.json @@ -1,6 +1,7 @@ { "module": "nm-applet", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager" ], diff --git a/modules/node-env/module.json b/modules/node-env/module.json index 83437459e..db48bb5f4 100644 --- a/modules/node-env/module.json +++ b/modules/node-env/module.json @@ -1,6 +1,7 @@ { "module": "node-env", "version": "0.1", + "class": "core", "moved": true, "claims": [ { diff --git a/modules/nodejs/module.json b/modules/nodejs/module.json index d34a6d884..0762ab3ac 100644 --- a/modules/nodejs/module.json +++ b/modules/nodejs/module.json @@ -1,6 +1,7 @@ { "module": "nodejs", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager" ], diff --git a/modules/nodered/module.json b/modules/nodered/module.json index a633c7c0a..672625046 100644 --- a/modules/nodered/module.json +++ b/modules/nodered/module.json @@ -1,6 +1,7 @@ { "module": "nodered", "version": "0.1", + "class": "leaf", "emits": [ "flows.deployed" ], diff --git a/modules/ollama/module.json b/modules/ollama/module.json index d22f5f721..690f62adc 100644 --- a/modules/ollama/module.json +++ b/modules/ollama/module.json @@ -1,6 +1,7 @@ { "module": "ollama", "version": "0.1", + "class": "leaf", "capabilities": [ "container-runtime" ], diff --git a/modules/only-office/module.json b/modules/only-office/module.json index e54ee8b06..98f530cf5 100644 --- a/modules/only-office/module.json +++ b/modules/only-office/module.json @@ -1,6 +1,7 @@ { "module": "only-office", "version": "0.1", + "class": "core", "slug": "office", "provides": [ { diff --git a/modules/openai-consumer/module.json b/modules/openai-consumer/module.json index 1a6d7408b..20d633cfa 100644 --- a/modules/openai-consumer/module.json +++ b/modules/openai-consumer/module.json @@ -1,6 +1,7 @@ { "module": "openai-consumer", "version": "0.1", + "class": "leaf", "slug": "openai", "capabilities": [ "container-runtime" diff --git a/modules/openrazer/module.json b/modules/openrazer/module.json index 7337e9e17..6e30f9513 100644 --- a/modules/openrazer/module.json +++ b/modules/openrazer/module.json @@ -1,6 +1,7 @@ { "module": "openrazer", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager" ], diff --git a/modules/pacman/cmd/pacman-tools/aftercheck_test.go b/modules/pacman/cmd/pacman-tools/aftercheck_test.go index 5410f8bb6..9b4d80f3d 100644 --- a/modules/pacman/cmd/pacman-tools/aftercheck_test.go +++ b/modules/pacman/cmd/pacman-tools/aftercheck_test.go @@ -74,7 +74,7 @@ func checkUpgrades(t *testing.T, m *Machine) *Upgrades { return &Upgrades{Node: "node-a", Machine: m, Runs: runs} } -func TestTheCheckNamesTheFilesTheTransactionLeftAndTheNewsSinceThePreviousUpgrade(t *testing.T) { +func testTheCheckNamesTheFilesTheTransactionLeftAndTheNewsSinceThePreviousUpgrade(t *testing.T) { u := checkUpgrades(t, checkMachine("", "7.2.8-arch1-2")) c := u.AfterCheck(checkedRun(StepStarted, StepFinished), &Record{}) if strings.Join(c.Pacnew, " ") != "/etc/pacman.d/mirrorlist.pacnew" || strings.Join(c.Pacsave, " ") != "/etc/lemurs/config.toml.pacsave" { @@ -88,7 +88,7 @@ func TestTheCheckNamesTheFilesTheTransactionLeftAndTheNewsSinceThePreviousUpgrad } } -func TestNewsThatCannotBeReadIsSaidNotShownAsNone(t *testing.T) { +func testNewsThatCannotBeReadIsSaidNotShownAsNone(t *testing.T) { u := checkUpgrades(t, checkMachine("", "7.2.8-arch1-2")) fetch = func(string) ([]byte, error) { return nil, errors.New("no route to host") } c := u.AfterCheck(checkedRun(StepStarted, StepFinished), &Record{}) @@ -97,7 +97,7 @@ func TestNewsThatCannotBeReadIsSaidNotShownAsNone(t *testing.T) { } } -func TestAUnitNewlyFailedFailsTheCheckAndOneFailedBeforeDoesNot(t *testing.T) { +func testAUnitNewlyFailedFailsTheCheckAndOneFailedBeforeDoesNot(t *testing.T) { u := checkUpgrades(t, checkMachine("backup.service loaded failed failed The backup\nweb.service loaded failed failed The web\n", "7.2.8-arch1-2")) c := u.AfterCheck(checkedRun(StepStarted, StepFinished), &Record{FailedUnits: []string{"backup.service"}}) if strings.Join(c.NewlyFailed, " ") != "web.service" || c.Passed { @@ -105,7 +105,7 @@ func TestAUnitNewlyFailedFailsTheCheckAndOneFailedBeforeDoesNot(t *testing.T) { } } -func TestARestartIsNeededWhenTheRunningKernelIsNoLongerTheInstalledOne(t *testing.T) { +func testARestartIsNeededWhenTheRunningKernelIsNoLongerTheInstalledOne(t *testing.T) { u := checkUpgrades(t, checkMachine("", "7.2.9-arch1-1")) c := u.AfterCheck(checkedRun(StepStarted, StepFinished), &Record{}) if !c.RestartNeeded || c.InstalledKernel != "7.2.9-arch1-1" || !c.Passed { @@ -113,9 +113,27 @@ func TestARestartIsNeededWhenTheRunningKernelIsNoLongerTheInstalledOne(t *testin } } -func TestTheCheckPassesOnlyWhenTheTransactionSucceeded(t *testing.T) { +func testTheCheckPassesOnlyWhenTheTransactionSucceeded(t *testing.T) { u := checkUpgrades(t, checkMachine("", "7.2.8-arch1-2")) if c := u.AfterCheck(checkedRun(StepStarted, StepFailed), &Record{}); c.Passed { t.Errorf("%+v", c) } } + +// TestTheCheckNamesTheFilesTheTransactionLeftAndTheNewsSinceThePreviousUpgrade runs this file's cases in order as one test, each a row: the check counts every top-level test against the +// module's budget of 50 (design 47 H2 §819). A failing case is named by the line logged before it. +func TestTheCheckNamesTheFilesTheTransactionLeftAndTheNewsSinceThePreviousUpgrade(t *testing.T) { + for _, c := range []struct { + name string + run func(*testing.T) + }{ + {"TestTheCheckNamesTheFilesTheTransactionLeftAndTheNewsSinceThePreviousUpgrade", testTheCheckNamesTheFilesTheTransactionLeftAndTheNewsSinceThePreviousUpgrade}, + {"TestNewsThatCannotBeReadIsSaidNotShownAsNone", testNewsThatCannotBeReadIsSaidNotShownAsNone}, + {"TestAUnitNewlyFailedFailsTheCheckAndOneFailedBeforeDoesNot", testAUnitNewlyFailedFailsTheCheckAndOneFailedBeforeDoesNot}, + {"TestARestartIsNeededWhenTheRunningKernelIsNoLongerTheInstalledOne", testARestartIsNeededWhenTheRunningKernelIsNoLongerTheInstalledOne}, + {"TestTheCheckPassesOnlyWhenTheTransactionSucceeded", testTheCheckPassesOnlyWhenTheTransactionSucceeded}, + } { + t.Logf("case %s", c.name) + c.run(t) + } +} diff --git a/modules/pacman/cmd/pacman-tools/dkms_test.go b/modules/pacman/cmd/pacman-tools/dkms_test.go index 1c3961381..ca3124570 100644 --- a/modules/pacman/cmd/pacman-tools/dkms_test.go +++ b/modules/pacman/cmd/pacman-tools/dkms_test.go @@ -9,7 +9,7 @@ import ( "testing" ) -func TestTheNewKernelsReleaseIsDerivedAsTheInstalledOnesIs(t *testing.T) { +func testTheNewKernelsReleaseIsDerivedAsTheInstalledOnesIs(t *testing.T) { for _, c := range [][4]string{ {"7.2.8.arch1-2", "7.2.8-arch1-2", "7.3.1.arch1-1", "7.3.1-arch1-1"}, {"6.18.54-2", "6.18.54-2-lts", "6.18.60-1", "6.18.60-1-lts"}, @@ -72,7 +72,7 @@ func gateUpgrades(t *testing.T, m *Machine, linuxTo string, reachable bool) *Upg const zfsStatus = "zfs/2.4.4, 7.2.8-arch1-2, x86_64: installed\nzfs/2.4.4, 6.18.54-2-lts, x86_64: installed\n" -func TestAKernelPastAModulesLinuxMaximumIsHeldWithItsHeaders(t *testing.T) { +func testAKernelPastAModulesLinuxMaximumIsHeldWithItsHeaders(t *testing.T) { u := gateUpgrades(t, gateMachine(t, zfsStatus, capturedZFSSource(t)), "7.3.1.arch1-1", true) held, ignore, why := u.Gate() if why != "" { @@ -86,14 +86,14 @@ func TestAKernelPastAModulesLinuxMaximumIsHeldWithItsHeaders(t *testing.T) { } } -func TestAKernelWithinTheBoundIsNotHeld(t *testing.T) { +func testAKernelWithinTheBoundIsNotHeld(t *testing.T) { u := gateUpgrades(t, gateMachine(t, zfsStatus, capturedZFSSource(t)), "7.2.9.arch1-1", true) if held, ignore, why := u.Gate(); why != "" || len(held) != 0 || len(ignore) != 0 { t.Errorf("%+v %v %q", held, ignore, why) } } -func TestABuildExclusivePatternHoldsTheKernelsItDoesNotMatch(t *testing.T) { +func testABuildExclusivePatternHoldsTheKernelsItDoesNotMatch(t *testing.T) { src := map[string]string{"/usr/src/made-up-driver-1.0/dkms.conf": "PACKAGE_NAME=\"made-up-driver\"\nBUILD_EXCLUSIVE_KERNEL=\"^(6\\.|7\\.[0-2]\\.)\"\n"} u := gateUpgrades(t, gateMachine(t, "made-up-driver/1.0, 7.2.8-arch1-2, x86_64: installed\n", src), "7.3.1.arch1-1", true) held, ignore, why := u.Gate() @@ -103,7 +103,7 @@ func TestABuildExclusivePatternHoldsTheKernelsItDoesNotMatch(t *testing.T) { } } -func TestNoRunWhenWhatTheUpgradeWouldChangeIsNotKnown(t *testing.T) { +func testNoRunWhenWhatTheUpgradeWouldChangeIsNotKnown(t *testing.T) { u := gateUpgrades(t, gateMachine(t, zfsStatus, capturedZFSSource(t)), "7.3.1.arch1-1", false) if _, _, why := u.Gate(); !strings.Contains(why, "could not reach its mirrors") { t.Errorf("unreachable: %q", why) @@ -113,3 +113,21 @@ func TestNoRunWhenWhatTheUpgradeWouldChangeIsNotKnown(t *testing.T) { t.Errorf("no updates key: %q", why) } } + +// TestTheNewKernelsReleaseIsDerivedAsTheInstalledOnesIs runs this file's cases in order as one test, each a row: the check counts every top-level test against the +// module's budget of 50 (design 47 H2 §819). A failing case is named by the line logged before it. +func TestTheNewKernelsReleaseIsDerivedAsTheInstalledOnesIs(t *testing.T) { + for _, c := range []struct { + name string + run func(*testing.T) + }{ + {"TestTheNewKernelsReleaseIsDerivedAsTheInstalledOnesIs", testTheNewKernelsReleaseIsDerivedAsTheInstalledOnesIs}, + {"TestAKernelPastAModulesLinuxMaximumIsHeldWithItsHeaders", testAKernelPastAModulesLinuxMaximumIsHeldWithItsHeaders}, + {"TestAKernelWithinTheBoundIsNotHeld", testAKernelWithinTheBoundIsNotHeld}, + {"TestABuildExclusivePatternHoldsTheKernelsItDoesNotMatch", testABuildExclusivePatternHoldsTheKernelsItDoesNotMatch}, + {"TestNoRunWhenWhatTheUpgradeWouldChangeIsNotKnown", testNoRunWhenWhatTheUpgradeWouldChangeIsNotKnown}, + } { + t.Logf("case %s", c.name) + c.run(t) + } +} diff --git a/modules/pacman/cmd/pacman-tools/keeper_manifest_test.go b/modules/pacman/cmd/pacman-tools/keeper_manifest_test.go index 658c1e7da..7576e9bd2 100644 --- a/modules/pacman/cmd/pacman-tools/keeper_manifest_test.go +++ b/modules/pacman/cmd/pacman-tools/keeper_manifest_test.go @@ -40,7 +40,7 @@ func strs(v any) []string { return out } -func TestTheWeeklyTimerAndItsServiceAreGone(t *testing.T) { +func testTheWeeklyTimerAndItsServiceAreGone(t *testing.T) { m := manifest(t) for _, r := range m.Resources { id, _ := r["id"].(string) @@ -58,7 +58,7 @@ func TestTheWeeklyTimerAndItsServiceAreGone(t *testing.T) { } } -func TestTheKeeperIsAProcessUnderItsOwnAccountWithABusAccountOfItsOwn(t *testing.T) { +func testTheKeeperIsAProcessUnderItsOwnAccountWithABusAccountOfItsOwn(t *testing.T) { m := manifest(t) user := m.resource(t, "keeper-account") if user["type"] != "user" || user["name"] != "pacman-keeper" || user["shell"] != "/usr/bin/nologin" { @@ -95,7 +95,7 @@ func TestTheKeeperIsAProcessUnderItsOwnAccountWithABusAccountOfItsOwn(t *testing } } -func TestTheKeeperDeclaresTheModulesStatesAndEvents(t *testing.T) { +func testTheKeeperDeclaresTheModulesStatesAndEvents(t *testing.T) { raw := rawManifest(t) k := manifest(t).resource(t, "keeper") bus, _ := k["bus"].(map[string]any) @@ -152,7 +152,7 @@ func configValue(t *testing.T, key string) map[string]any { return v } -func TestTheConfigValuesLandInTheKeepersConfigFileWhichRestartsIt(t *testing.T) { +func testTheConfigValuesLandInTheKeepersConfigFileWhichRestartsIt(t *testing.T) { order := configValue(t, "upgrade-order") if order["type"] != "list" || order["trusted"] != true || order["predefined"] != "upgrade-order" || !reflect.DeepEqual(order["default"], []any{}) || order["required"] != nil { @@ -191,7 +191,7 @@ func TestTheConfigValuesLandInTheKeepersConfigFileWhichRestartsIt(t *testing.T) } } -func TestUpgradeOrderIsATrustedListOfTheMesh(t *testing.T) { +func testUpgradeOrderIsATrustedListOfTheMesh(t *testing.T) { raw, err := os.ReadFile(filepath.Join(moduleDir, "..", "..", "predefined.json")) if err != nil { t.Fatal(err) @@ -216,7 +216,7 @@ func TestUpgradeOrderIsATrustedListOfTheMesh(t *testing.T) { // never place "." or a placement by default: for this module both resolve under /var/lib/pacman, the package manager's // own database directory (issue 1841: the node-engine used it as found and reported it unhealthy, and wrote keeper.json // into it). What the keeper and its root helper keep there is still named through ${dir:state}. -func TestTheStateDirectoryIsOutsideThePackageManagersOwn(t *testing.T) { +func testTheStateDirectoryIsOutsideThePackageManagersOwn(t *testing.T) { m := rawManifest(t) resources, _ := m["resources"].([]any) var state map[string]any @@ -245,3 +245,22 @@ func TestTheStateDirectoryIsOutsideThePackageManagersOwn(t *testing.T) { } } } + +// TestTheWeeklyTimerAndItsServiceAreGone runs this file's cases in order as one test, each a row: the check counts every top-level test against the +// module's budget of 50 (design 47 H2 §819). A failing case is named by the line logged before it. +func TestTheWeeklyTimerAndItsServiceAreGone(t *testing.T) { + for _, c := range []struct { + name string + run func(*testing.T) + }{ + {"TestTheWeeklyTimerAndItsServiceAreGone", testTheWeeklyTimerAndItsServiceAreGone}, + {"TestTheKeeperIsAProcessUnderItsOwnAccountWithABusAccountOfItsOwn", testTheKeeperIsAProcessUnderItsOwnAccountWithABusAccountOfItsOwn}, + {"TestTheKeeperDeclaresTheModulesStatesAndEvents", testTheKeeperDeclaresTheModulesStatesAndEvents}, + {"TestTheConfigValuesLandInTheKeepersConfigFileWhichRestartsIt", testTheConfigValuesLandInTheKeepersConfigFileWhichRestartsIt}, + {"TestUpgradeOrderIsATrustedListOfTheMesh", testUpgradeOrderIsATrustedListOfTheMesh}, + {"TestTheStateDirectoryIsOutsideThePackageManagersOwn", testTheStateDirectoryIsOutsideThePackageManagersOwn}, + } { + t.Logf("case %s", c.name) + c.run(t) + } +} diff --git a/modules/pacman/cmd/pacman-tools/keeper_test.go b/modules/pacman/cmd/pacman-tools/keeper_test.go index 21ddf0946..beb9826d2 100644 --- a/modules/pacman/cmd/pacman-tools/keeper_test.go +++ b/modules/pacman/cmd/pacman-tools/keeper_test.go @@ -342,7 +342,7 @@ func installedOf(t *testing.T, s *fakeStore, key string) InstalledValue { // 1840/AC1: at the start every package is written with its version, its reason and its repository or foreign, // and written again only when it differs from the key. -func TestAtItsStartTheKeeperWritesEveryPackageOnlyWhenItDiffersFromTheKey(t *testing.T) { +func testAtItsStartTheKeeperWritesEveryPackageOnlyWhenItDiffersFromTheKey(t *testing.T) { db := &pacmanDB{sl: syncDBs, checkup: Ran{Status: 2}} db.set("glibc 2.42-1\nlinux 6.17.1-1\nyay 12.0-1\nzsh 5.9-1\n", "linux\nyay\nzsh\n") k, states, ev, _, _ := newTestKeeper(db) @@ -375,7 +375,7 @@ func TestAtItsStartTheKeeperWritesEveryPackageOnlyWhenItDiffersFromTheKey(t *tes // 1840/AC2: a transaction that adds, removes and changes packages is one package.changed naming the node and // exactly those; one that changes nothing writes and emits nothing; a lock held again waits for its release. -func TestAReleasedLockSaysExactlyWhatTheTransactionChangedOnce(t *testing.T) { +func testAReleasedLockSaysExactlyWhatTheTransactionChangedOnce(t *testing.T) { db := &pacmanDB{sl: syncDBs, checkup: Ran{Status: 2}} db.set("glibc 2.42-1\nlinux 6.17.1-1\nzsh 5.9-1\n", "linux\nzsh\n") k, states, ev, clock, _ := newTestKeeper(db) @@ -440,7 +440,7 @@ func bigDB(n int) string { // 1840/AC3: a value over the bus's cap is not written: the key keeps its last value and `.not-current` // holds the size and since when, written once; the next write that fits deletes it. -func TestAValueOverTheCapKeepsTheLastAndMarksTheNodeNotCurrent(t *testing.T) { +func testAValueOverTheCapKeepsTheLastAndMarksTheNodeNotCurrent(t *testing.T) { db := &pacmanDB{sl: syncDBs, checkup: Ran{Status: 2}} db.set("glibc 2.42-1\n", "") k, states, ev, clock, _ := newTestKeeper(db) @@ -483,7 +483,7 @@ func TestAValueOverTheCapKeepsTheLastAndMarksTheNodeNotCurrent(t *testing.T) { } // The mark goes too when the node's packages come back to what the key holds: the key is current again. -func TestTheMarkGoesWhenThePackagesComeBackToTheKey(t *testing.T) { +func testTheMarkGoesWhenThePackagesComeBackToTheKey(t *testing.T) { db := &pacmanDB{sl: syncDBs, checkup: Ran{Status: 2}} db.set("glibc 2.42-1\n", "") k, states, _, _, _ := newTestKeeper(db) @@ -501,7 +501,7 @@ func TestTheMarkGoesWhenThePackagesComeBackToTheKey(t *testing.T) { // The loop: a released lock is read, a hook runs after it with what it changed, a watched state's change reaches // its hook, and a wake comes at the time it asked. -func TestTheLoopRunsTheHooksOnItsOneGoroutine(t *testing.T) { +func testTheLoopRunsTheHooksOnItsOneGoroutine(t *testing.T) { db := &pacmanDB{sl: syncDBs, checkup: Ran{Status: 2}} db.set("glibc 2.42-1\n", "") k, states, _, clock, w := newTestKeeper(db) @@ -567,7 +567,7 @@ func waitFor(t *testing.T, mu *sync.Mutex, seen *[]string, want string) { } // The watch ending ends the keeper, loudly. -func TestTheKeeperStopsWhenTheWatchEnds(t *testing.T) { +func testTheKeeperStopsWhenTheWatchEnds(t *testing.T) { db := &pacmanDB{sl: syncDBs, checkup: Ran{Status: 2}} k, _, _, _, w := newTestKeeper(db) close(w.c) @@ -578,7 +578,7 @@ func TestTheKeeperStopsWhenTheWatchEnds(t *testing.T) { // The machine's watch: the lock deleted and the mirror list written or moved in are each a signal; anything else // in those directories is none. -func TestTheWatchSeesTheLockReleasedAndTheMirrorListRewritten(t *testing.T) { +func testTheWatchSeesTheLockReleasedAndTheMirrorListRewritten(t *testing.T) { lockDir, mirrorDir := t.TempDir(), t.TempDir() w, err := WatchMachine(lockDir, LockName, mirrorDir, MirrorName) if err != nil { @@ -628,3 +628,23 @@ func TestTheWatchSeesTheLockReleasedAndTheMirrorListRewritten(t *testing.T) { } } } + +// TestAtItsStartTheKeeperWritesEveryPackageOnlyWhenItDiffersFromTheKey runs this file's cases in order as one test, each a row: the check counts every top-level test against the +// module's budget of 50 (design 47 H2 §819). A failing case is named by the line logged before it. +func TestAtItsStartTheKeeperWritesEveryPackageOnlyWhenItDiffersFromTheKey(t *testing.T) { + for _, c := range []struct { + name string + run func(*testing.T) + }{ + {"TestAtItsStartTheKeeperWritesEveryPackageOnlyWhenItDiffersFromTheKey", testAtItsStartTheKeeperWritesEveryPackageOnlyWhenItDiffersFromTheKey}, + {"TestAReleasedLockSaysExactlyWhatTheTransactionChangedOnce", testAReleasedLockSaysExactlyWhatTheTransactionChangedOnce}, + {"TestAValueOverTheCapKeepsTheLastAndMarksTheNodeNotCurrent", testAValueOverTheCapKeepsTheLastAndMarksTheNodeNotCurrent}, + {"TestTheMarkGoesWhenThePackagesComeBackToTheKey", testTheMarkGoesWhenThePackagesComeBackToTheKey}, + {"TestTheLoopRunsTheHooksOnItsOneGoroutine", testTheLoopRunsTheHooksOnItsOneGoroutine}, + {"TestTheKeeperStopsWhenTheWatchEnds", testTheKeeperStopsWhenTheWatchEnds}, + {"TestTheWatchSeesTheLockReleasedAndTheMirrorListRewritten", testTheWatchSeesTheLockReleasedAndTheMirrorListRewritten}, + } { + t.Logf("case %s", c.name) + c.run(t) + } +} diff --git a/modules/pacman/cmd/pacman-tools/manifest_test.go b/modules/pacman/cmd/pacman-tools/manifest_test.go index 45cd3f68e..2aaafdee5 100644 --- a/modules/pacman/cmd/pacman-tools/manifest_test.go +++ b/modules/pacman/cmd/pacman-tools/manifest_test.go @@ -14,7 +14,7 @@ import ( "testing" ) -func TestItHoldsThePackageManagerSeatAndDeclaresItsPackage(t *testing.T) { +func testItHoldsThePackageManagerSeatAndDeclaresItsPackage(t *testing.T) { m := manifest(t) if len(m.Claims) != 1 || m.Claims[0]["name"] != "node-package-manager" || m.Claims[0]["scope"] != "node" || m.Claims[0]["serves"] != nil { t.Fatalf("claims: %v", m.Claims) @@ -34,7 +34,7 @@ func TestItHoldsThePackageManagerSeatAndDeclaresItsPackage(t *testing.T) { } } -func TestPacmanConfIsWholeTheUnionOfRepositoriesAndTheImprovedOptions(t *testing.T) { +func testPacmanConfIsWholeTheUnionOfRepositoriesAndTheImprovedOptions(t *testing.T) { f := manifest(t).resource(t, "config") content := templateText(t, f) if f["path"] != "/etc/pacman.conf" || f["into"] != nil || !strings.HasPrefix(content, MeshHeader) { @@ -79,7 +79,7 @@ func TestPacmanConfIsWholeTheUnionOfRepositoriesAndTheImprovedOptions(t *testing // Every repository of the shipped file reads the mirror list reflector writes, and the file pacman-conf proves reads // nothing of the machine: the unit level runs shut off (novox/hq ADR 0448), where /etc/pacman.d is not there // (issue 1891). -func TestTheProvenConfReadsNothingOfTheMachine(t *testing.T) { +func testTheProvenConfReadsNothingOfTheMachine(t *testing.T) { content := templateText(t, manifest(t).resource(t, "config")) if n := strings.Count(content, "Include = "+Mirrorlist+"\n"); n != 3 || strings.Count(content, "Include") != n { t.Fatalf("every repository reads %s, and nothing else is included: %d of 3\n%s", Mirrorlist, n, content) @@ -105,7 +105,7 @@ func provenConf(t *testing.T, content, dir string) string { return strings.ReplaceAll(content, "Include = "+Mirrorlist, "Include = "+list) } -func TestReflectorRanksWithTheModulesOptionsAndSavesNoList(t *testing.T) { +func testReflectorRanksWithTheModulesOptionsAndSavesNoList(t *testing.T) { content := templateText(t, manifest(t).resource(t, "mirrors")) opts := map[string]string{} for _, l := range strings.Split(content, "\n") { @@ -124,7 +124,7 @@ func TestReflectorRanksWithTheModulesOptionsAndSavesNoList(t *testing.T) { } } -func TestTheReflectorPackageIsDeclaredBeforeTheFileItShips(t *testing.T) { +func testTheReflectorPackageIsDeclaredBeforeTheFileItShips(t *testing.T) { order := map[string]int{} for i, r := range manifest(t).Resources { order[r["id"].(string)] = i @@ -136,7 +136,7 @@ func TestTheReflectorPackageIsDeclaredBeforeTheFileItShips(t *testing.T) { // TestThePackageManagersConfigIsDeclaredBeforeItsPackage holds design 42 zfs-owns-zfs §1 and A-26: the // apply stops at the first failure, and the package fails while its config file is missing. -func TestThePackageManagersConfigIsDeclaredBeforeItsPackage(t *testing.T) { +func testThePackageManagersConfigIsDeclaredBeforeItsPackage(t *testing.T) { order := map[string]int{} for i, r := range manifest(t).Resources { order[r["id"].(string)] = i @@ -145,3 +145,23 @@ func TestThePackageManagersConfigIsDeclaredBeforeItsPackage(t *testing.T) { t.Fatalf("the config file comes before the package: %v", order) } } + +// TestItHoldsThePackageManagerSeatAndDeclaresItsPackage runs this file's cases in order as one test, each a row: the check counts every top-level test against the +// module's budget of 50 (design 47 H2 §819). A failing case is named by the line logged before it; the case that +// skips where pacman-conf is not installed runs last, so its skip ends no other case. +func TestItHoldsThePackageManagerSeatAndDeclaresItsPackage(t *testing.T) { + for _, c := range []struct { + name string + run func(*testing.T) + }{ + {"TestItHoldsThePackageManagerSeatAndDeclaresItsPackage", testItHoldsThePackageManagerSeatAndDeclaresItsPackage}, + {"TestTheProvenConfReadsNothingOfTheMachine", testTheProvenConfReadsNothingOfTheMachine}, + {"TestReflectorRanksWithTheModulesOptionsAndSavesNoList", testReflectorRanksWithTheModulesOptionsAndSavesNoList}, + {"TestTheReflectorPackageIsDeclaredBeforeTheFileItShips", testTheReflectorPackageIsDeclaredBeforeTheFileItShips}, + {"TestThePackageManagersConfigIsDeclaredBeforeItsPackage", testThePackageManagersConfigIsDeclaredBeforeItsPackage}, + {"TestPacmanConfIsWholeTheUnionOfRepositoriesAndTheImprovedOptions", testPacmanConfIsWholeTheUnionOfRepositoriesAndTheImprovedOptions}, + } { + t.Logf("case %s", c.name) + c.run(t) + } +} diff --git a/modules/pacman/cmd/pacman-tools/pacman_test.go b/modules/pacman/cmd/pacman-tools/pacman_test.go index f980d2b5e..a93360bca 100644 --- a/modules/pacman/cmd/pacman-tools/pacman_test.go +++ b/modules/pacman/cmd/pacman-tools/pacman_test.go @@ -16,7 +16,7 @@ core/base-devel 1-2 (base-devel) Basic tools to build Arch Linux packages ` -func TestSearchReadsHeaderAndDescriptionAndWhatIsInstalled(t *testing.T) { +func testSearchReadsHeaderAndDescriptionAndWhatIsInstalled(t *testing.T) { f := ParseSearch(searchOut) if len(f) != 3 { t.Fatalf("%+v", f) @@ -32,7 +32,7 @@ func TestSearchReadsHeaderAndDescriptionAndWhatIsInstalled(t *testing.T) { } } -func TestASearchThatFindsNothingIsEmptyAndAFailureIsAnError(t *testing.T) { +func testASearchThatFindsNothingIsEmptyAndAFailureIsAnError(t *testing.T) { m := machine(fake(func(c call) Ran { return Ran{Status: 1} }, nil), 1000) r, err := m.Search("nothing", 50) if err != nil || r["count"] != 0 { @@ -54,7 +54,7 @@ Install Reason : Explicitly installed ` -func TestInfoReadsListsAsListsAndFallsBackToTheRepositories(t *testing.T) { +func testInfoReadsListsAsListsAndFallsBackToTheRepositories(t *testing.T) { p := ParseInfo(infoOut) if len(p) != 1 { t.Fatalf("%v", p) @@ -79,7 +79,7 @@ func TestInfoReadsListsAsListsAndFallsBackToTheRepositories(t *testing.T) { } } -func TestReadInstalledSaysWhyAndWhichRepositoryOrForeign(t *testing.T) { +func testReadInstalledSaysWhyAndWhichRepositoryOrForeign(t *testing.T) { m := machine(byLine(map[string]Ran{ "pacman -Q": {Stdout: "zsh 5.9-1\nglibc 2.42-1\nyay 12.0-1\n"}, "pacman -Qeq": {Stdout: "yay\nzsh\n"}, @@ -95,7 +95,7 @@ func TestReadInstalledSaysWhyAndWhichRepositoryOrForeign(t *testing.T) { } } -func TestOwnsAnswersNoOwnerAsAnAnswer(t *testing.T) { +func testOwnsAnswersNoOwnerAsAnAnswer(t *testing.T) { m := machine(byLine(map[string]Ran{ "pacman -Qo -- /usr/bin/zsh": {Stdout: "/usr/bin/zsh is owned by zsh 5.9.2-1\n"}, "pacman -Qo -- /etc/hostname": {Status: 1, Stderr: "error: No package owns /etc/hostname\n"}, @@ -115,7 +115,7 @@ func TestOwnsAnswersNoOwnerAsAnAnswer(t *testing.T) { } } -func TestUpdateListReadsCheckupdatesAndItsNothingToDo(t *testing.T) { +func testUpdateListReadsCheckupdatesAndItsNothingToDo(t *testing.T) { m := machine(byLine(map[string]Ran{"checkupdates": {Stdout: "zsh 5.9-1 -> 5.9-2\nlinux 6.1-1 -> 6.2-1\n"}}, nil), 1000) r, err := m.UpdateList() if err != nil || len(r) != 2 || r[0] != (VersionChange{"linux", "6.1-1", "6.2-1"}) { @@ -136,7 +136,7 @@ func lockless(m *Machine) *Machine { return m } -func TestAnUpgradesUnitIsReadBack(t *testing.T) { +func testAnUpgradesUnitIsReadBack(t *testing.T) { unit := "mesh-pacman-upgrade-1791115200" m := machine(byLine(map[string]Ran{ "systemctl show " + unit + " --no-pager --property=LoadState --property=ActiveState --property=SubState --property=Result --property=ExecMainStatus": {Stdout: "LoadState=loaded\nActiveState=failed\nSubState=failed\nResult=exit-code\nExecMainStatus=1\n"}, @@ -165,7 +165,7 @@ func orphanMachine(calls *[]call) *Machine { }, calls), 1000)) } -func TestRemovingOrphansTakesOnlyOrphansNamedOrAll(t *testing.T) { +func testRemovingOrphansTakesOnlyOrphansNamedOrAll(t *testing.T) { var calls []call m := orphanMachine(&calls) if _, err := m.RemoveOrphans(nil, false); err == nil || !strings.Contains(err.Error(), "name the orphans") { @@ -193,7 +193,7 @@ func TestRemovingOrphansTakesOnlyOrphansNamedOrAll(t *testing.T) { } } -func TestCacheSaysWhatCleaningWouldFreeAndCleansThroughSudo(t *testing.T) { +func testCacheSaysWhatCleaningWouldFreeAndCleansThroughSudo(t *testing.T) { var calls []call m := machine(fake(func(c call) Ran { switch c.String() { @@ -227,7 +227,7 @@ const pacmanLog = `[2026-09-24T17:47:36+0200] [PACMAN] starting full system upgr [2022-01-01 10:00] [ALPM] installed old (1-1) ` -func TestHistoryReadsTheLogSinceADayAndTheLastFullUpgrade(t *testing.T) { +func testHistoryReadsTheLogSinceADayAndTheLastFullUpgrade(t *testing.T) { m := machine(nil, 1000) m.ReadFile = func(p string) ([]byte, error) { return []byte(pacmanLog), nil } r, err := m.History("2026-09-01", "", "", 10) @@ -263,7 +263,7 @@ const feed = ` Old newshttps://example.org/news/b/oldMon, 01 Jun 2026 09:00:00 +0000 ` -func TestNewsSinceTheLastUpgrade(t *testing.T) { +func testNewsSinceTheLastUpgrade(t *testing.T) { items, err := ParseNews([]byte(feed), time.Date(2026, 9, 1, 0, 0, 0, 0, time.UTC)) if err != nil || len(items) != 1 || items[0].Title != "Manual intervention needed" || items[0].Summary != "Do this first ." { t.Fatalf("%+v %v", items, err) @@ -314,7 +314,7 @@ var rankedAt = time.Date(2026, 11, 1, 15, 0, 0, 0, time.UTC) // and never its --save; a ranking that fails or keeps none is no list. pacman_mirrors answers the shared list, its // ranker and age and whether this node's file matches it (the file as found when not); with refresh it asks this node's // keeper to rank again, refused while a round runs, naming it. -func TestTheMeshsMirrorListIsRankedFreshAndAnsweredWithThisNodesFile(t *testing.T) { +func testTheMeshsMirrorListIsRankedFreshAndAnsweredWithThisNodesFile(t *testing.T) { conf := "# comment\n--save /etc/pacman.d/mirrorlist\n--country Belgium,Netherlands\n--sort rate\n" if o := strings.Join(ReflectorOptions(conf), " "); o != "--country Belgium,Netherlands --sort rate" { t.Errorf("the options are %q", o) @@ -381,7 +381,7 @@ func TestTheMeshsMirrorListIsRankedFreshAndAnsweredWithThisNodesFile(t *testing. } } -func TestConfigIsReadAsPacmanConfResolvesIt(t *testing.T) { +func testConfigIsReadAsPacmanConfResolvesIt(t *testing.T) { c := ParseConf("[options]\nHoldPkg = pacman\nHoldPkg = glibc\nCheckSpace\nParallelDownloads = 5\n[core]\nUsage = All\nServer = https://a/core\nServer = https://b/core\n[extra]\nServer = https://a/extra\n") if len(c.Options["HoldPkg"]) != 2 || c.Options["ParallelDownloads"][0] != "5" || len(c.Repositories) != 2 || c.Repositories[0].Servers != 2 || c.Repositories[0].FirstServer != "https://a/core" { t.Fatalf("%+v", c) @@ -430,3 +430,29 @@ func checkFreshest(t *testing.T) { t.Errorf("unknown syncs not detected: %+v", r) } } + +// TestSearchReadsHeaderAndDescriptionAndWhatIsInstalled runs this file's cases in order as one test, each a row: the check counts every top-level test against the +// module's budget of 50 (design 47 H2 §819). A failing case is named by the line logged before it. +func TestSearchReadsHeaderAndDescriptionAndWhatIsInstalled(t *testing.T) { + for _, c := range []struct { + name string + run func(*testing.T) + }{ + {"TestSearchReadsHeaderAndDescriptionAndWhatIsInstalled", testSearchReadsHeaderAndDescriptionAndWhatIsInstalled}, + {"TestASearchThatFindsNothingIsEmptyAndAFailureIsAnError", testASearchThatFindsNothingIsEmptyAndAFailureIsAnError}, + {"TestInfoReadsListsAsListsAndFallsBackToTheRepositories", testInfoReadsListsAsListsAndFallsBackToTheRepositories}, + {"TestReadInstalledSaysWhyAndWhichRepositoryOrForeign", testReadInstalledSaysWhyAndWhichRepositoryOrForeign}, + {"TestOwnsAnswersNoOwnerAsAnAnswer", testOwnsAnswersNoOwnerAsAnAnswer}, + {"TestUpdateListReadsCheckupdatesAndItsNothingToDo", testUpdateListReadsCheckupdatesAndItsNothingToDo}, + {"TestAnUpgradesUnitIsReadBack", testAnUpgradesUnitIsReadBack}, + {"TestRemovingOrphansTakesOnlyOrphansNamedOrAll", testRemovingOrphansTakesOnlyOrphansNamedOrAll}, + {"TestCacheSaysWhatCleaningWouldFreeAndCleansThroughSudo", testCacheSaysWhatCleaningWouldFreeAndCleansThroughSudo}, + {"TestHistoryReadsTheLogSinceADayAndTheLastFullUpgrade", testHistoryReadsTheLogSinceADayAndTheLastFullUpgrade}, + {"TestNewsSinceTheLastUpgrade", testNewsSinceTheLastUpgrade}, + {"TestTheMeshsMirrorListIsRankedFreshAndAnsweredWithThisNodesFile", testTheMeshsMirrorListIsRankedFreshAndAnsweredWithThisNodesFile}, + {"TestConfigIsReadAsPacmanConfResolvesIt", testConfigIsReadAsPacmanConfResolvesIt}, + } { + t.Logf("case %s", c.name) + c.run(t) + } +} diff --git a/modules/pacman/cmd/pacman-tools/rollback_test.go b/modules/pacman/cmd/pacman-tools/rollback_test.go index ff7ac532d..54bdf82fd 100644 --- a/modules/pacman/cmd/pacman-tools/rollback_test.go +++ b/modules/pacman/cmd/pacman-tools/rollback_test.go @@ -45,7 +45,7 @@ func rollbackStates(t *testing.T) (*fakeStates, *Machine, *[]call) { return states, m, &calls } -func TestThePlanSaysEachPackageNowToTheRecordWithItsSourceTheAddedAndNoForeign(t *testing.T) { +func testThePlanSaysEachPackageNowToTheRecordWithItsSourceTheAddedAndNoForeign(t *testing.T) { _, m, calls := rollbackStates(t) p, err := PlanRollback(m, m.States(StateInstalled), m.States(StateRecords), "node-a", rollbackRecord.Run, false, true) if err != nil { @@ -79,7 +79,7 @@ func TestThePlanSaysEachPackageNowToTheRecordWithItsSourceTheAddedAndNoForeign(t } } -func TestAnotherNodesPlanReadsNoCacheAndTakesUnknownArchitecturesFromTheDatedRepository(t *testing.T) { +func testAnotherNodesPlanReadsNoCacheAndTakesUnknownArchitecturesFromTheDatedRepository(t *testing.T) { _, m, calls := rollbackStates(t) m.Node = "node-b" r, err := m.Rollback("node-a", rollbackRecord.Run, false, false) @@ -97,7 +97,7 @@ func TestAnotherNodesPlanReadsNoCacheAndTakesUnknownArchitecturesFromTheDatedRep } } -func TestNoPlanFromPackagesNotCurrentOrWithoutARecord(t *testing.T) { +func testNoPlanFromPackagesNotCurrentOrWithoutARecord(t *testing.T) { states, m, _ := rollbackStates(t) if _, err := m.Rollback("node-a", "20250101T000000Z", false, false); err == nil || !strings.Contains(err.Error(), "no record") { t.Errorf("no record: %v", err) @@ -108,7 +108,7 @@ func TestNoPlanFromPackagesNotCurrentOrWithoutARecord(t *testing.T) { } } -func TestApplyWritesAnAskForTheNodesKeeper(t *testing.T) { +func testApplyWritesAnAskForTheNodesKeeper(t *testing.T) { _, m, _ := rollbackStates(t) asks := newBucket() saved := upgradeState @@ -125,7 +125,7 @@ func TestApplyWritesAnAskForTheNodesKeeper(t *testing.T) { } } -func TestAnAskedRollbackIsOneTransactionWithItsEventsAndTheCheck(t *testing.T) { +func testAnAskedRollbackIsOneTransactionWithItsEventsAndTheCheck(t *testing.T) { k := newKeeperBed(t) k.records.Put(NodeKey("node-a", rollbackRecord.Run), rollbackRecord) k.installed.Put("node-a", rollbackNow) @@ -193,3 +193,21 @@ func (k *keeperBed) takeAsk(t *testing.T, a Ask) error { raw, _ := json.Marshal(a) return k.u.TakeAsk(stdio.StateChange{State: StateAsks, Key: key, Op: "put", Value: raw, Revision: rev}) } + +// TestThePlanSaysEachPackageNowToTheRecordWithItsSourceTheAddedAndNoForeign runs this file's cases in order as one test, each a row: the check counts every top-level test against the +// module's budget of 50 (design 47 H2 §819). A failing case is named by the line logged before it. +func TestThePlanSaysEachPackageNowToTheRecordWithItsSourceTheAddedAndNoForeign(t *testing.T) { + for _, c := range []struct { + name string + run func(*testing.T) + }{ + {"TestThePlanSaysEachPackageNowToTheRecordWithItsSourceTheAddedAndNoForeign", testThePlanSaysEachPackageNowToTheRecordWithItsSourceTheAddedAndNoForeign}, + {"TestAnotherNodesPlanReadsNoCacheAndTakesUnknownArchitecturesFromTheDatedRepository", testAnotherNodesPlanReadsNoCacheAndTakesUnknownArchitecturesFromTheDatedRepository}, + {"TestNoPlanFromPackagesNotCurrentOrWithoutARecord", testNoPlanFromPackagesNotCurrentOrWithoutARecord}, + {"TestApplyWritesAnAskForTheNodesKeeper", testApplyWritesAnAskForTheNodesKeeper}, + {"TestAnAskedRollbackIsOneTransactionWithItsEventsAndTheCheck", testAnAskedRollbackIsOneTransactionWithItsEventsAndTheCheck}, + } { + t.Logf("case %s", c.name) + c.run(t) + } +} diff --git a/modules/pacman/cmd/pacman-tools/root_test.go b/modules/pacman/cmd/pacman-tools/root_test.go index c5303f7e6..b0bf3f231 100644 --- a/modules/pacman/cmd/pacman-tools/root_test.go +++ b/modules/pacman/cmd/pacman-tools/root_test.go @@ -15,6 +15,7 @@ import ( "path/filepath" "reflect" "strings" + "sync/atomic" "testing" ) @@ -64,13 +65,16 @@ func (s stubProc) Readlink(name string) (string, error) { const aRun = "20261024T040000Z" -// testSocket is a socket in the abstract namespace, named for the test: a path under a test's temporary -// directory can pass the 108 bytes a socket's path may hold. +// testSocket is a socket in the abstract namespace, named for the test and numbered per call, as one test runs +// several cases whose listeners live until its end: a path under a test's temporary directory can pass the 108 +// bytes a socket's path may hold. func testSocket(t *testing.T) string { - return fmt.Sprintf("@pacman-root-test-%d-%s", os.Getpid(), t.Name()) + return fmt.Sprintf("@pacman-root-test-%d-%s-%d", os.Getpid(), t.Name(), sockets.Add(1)) } -func TestTheRootHelperStartsAnUpgradeAsTheRunsUnit(t *testing.T) { +var sockets atomic.Int64 + +func testTheRootHelperStartsAnUpgradeAsTheRunsUnit(t *testing.T) { b := newRootBed(t) a := b.h.Handle(RootRequest{Verb: VerbTransaction, Kind: RunUpgrade, Run: aRun, Ignore: []string{"linux", "linux-headers"}}) if a.Error != "" { @@ -83,7 +87,7 @@ func TestTheRootHelperStartsAnUpgradeAsTheRunsUnit(t *testing.T) { } } -func TestTheRootHelperStartsARollbackWithThePlanInTheRequest(t *testing.T) { +func testTheRootHelperStartsARollbackWithThePlanInTheRequest(t *testing.T) { b := newRootBed(t) plan := []RollbackItem{ {Name: "bash", From: "5.3.20-1", To: "5.3.15-1", Source: SourceCache, Location: CacheDir + "/bash-5.3.15-1-x86_64.pkg.tar.zst"}, @@ -115,7 +119,7 @@ func TestTheRootHelperStartsARollbackWithThePlanInTheRequest(t *testing.T) { } // And (ADR 0585 §3) the verb mirrorlist writes the mirror list file whole from the servers it is sent, running nothing. -func TestTheRootHelperReadsTheReplacedFilesMappings(t *testing.T) { +func testTheRootHelperReadsTheReplacedFilesMappings(t *testing.T) { b := newRootBed(t) servers := []string{"https://a.example/$repo/os/$arch", "https://b.example/archlinux/$repo/os/$arch"} if a := b.h.Handle(RootRequest{Verb: VerbMirrorlist, Servers: servers}); a.Error != "" { @@ -131,7 +135,7 @@ func TestTheRootHelperReadsTheReplacedFilesMappings(t *testing.T) { } } -func TestTheRootHelperReadsATransactionUnitsJournal(t *testing.T) { +func testTheRootHelperReadsATransactionUnitsJournal(t *testing.T) { b := newRootBed(t) unit := TransactionUnit(RunUpgrade, aRun) a := b.h.Handle(RootRequest{Verb: VerbJournal, Unit: unit, Lines: 40}) @@ -144,7 +148,7 @@ func TestTheRootHelperReadsATransactionUnitsJournal(t *testing.T) { } } -func TestTheRootHelperRefusesEverythingOffItsList(t *testing.T) { +func testTheRootHelperRefusesEverythingOffItsList(t *testing.T) { good := RollbackItem{Name: "bash", From: "5.3.20-1", To: "5.3.15-1", Source: SourceCache, Location: CacheDir + "/bash-5.3.15-1-x86_64.pkg.tar.zst"} with := func(f func(*RollbackItem)) []RollbackItem { i := good; f(&i); return []RollbackItem{i} } cases := map[string]RootRequest{ @@ -211,14 +215,14 @@ func serveOnce(t *testing.T, peer int, req RootRequest) (RootAnswer, error) { return rootClient{Socket: sock}.ask(req) } -func TestTheRootHelperAnswersTheKeepersAccountOverItsSocket(t *testing.T) { +func testTheRootHelperAnswersTheKeepersAccountOverItsSocket(t *testing.T) { a, err := serveOnce(t, os.Getuid(), RootRequest{Verb: VerbMaps}) if err != nil || a.Error != "" || len(a.Mapped) != 1 { t.Fatalf("the keeper's own account was answered %+v, %v", a, err) } } -func TestTheRootHelperRefusesAnyOtherAccount(t *testing.T) { +func testTheRootHelperRefusesAnyOtherAccount(t *testing.T) { a, err := serveOnce(t, os.Getuid()+1, RootRequest{Verb: VerbMaps}) if err == nil && a.Error == "" { t.Fatalf("another account was answered: %+v", a) @@ -228,7 +232,7 @@ func TestTheRootHelperRefusesAnyOtherAccount(t *testing.T) { } } -func TestTheClientCarriesTheRootActsAndSaysARefusal(t *testing.T) { +func testTheClientCarriesTheRootActsAndSaysARefusal(t *testing.T) { b := newRootBed(t) b.h.Peer = os.Getuid() sock := testSocket(t) @@ -254,7 +258,7 @@ func TestTheClientCarriesTheRootActsAndSaysARefusal(t *testing.T) { } } -func TestTheRootHelperIsRootWithNoBusAndNoSudoRule(t *testing.T) { +func testTheRootHelperIsRootWithNoBusAndNoSudoRule(t *testing.T) { m := manifest(t) r := m.resource(t, "root-helper") if r["type"] != "process" || r["name"] != "pacman-root" || r["artifact"] != "tools" || @@ -283,7 +287,7 @@ func TestTheRootHelperIsRootWithNoBusAndNoSudoRule(t *testing.T) { } } -func TestTheRollbackUnitInstallsThePlanThenRemovesWhatWasAskedInOrder(t *testing.T) { +func testTheRollbackUnitInstallsThePlanThenRemovesWhatWasAskedInOrder(t *testing.T) { dir := t.TempDir() plan := []RollbackItem{ {Name: "bash", To: "5.3.15-1", Source: SourceCache, Location: CacheDir + "/bash-5.3.15-1-x86_64.pkg.tar.zst"}, @@ -314,7 +318,7 @@ func TestTheRollbackUnitInstallsThePlanThenRemovesWhatWasAskedInOrder(t *testing } } -func TestTheRollbackUnitChangesNothingWhenAPackageIsNotFound(t *testing.T) { +func testTheRollbackUnitChangesNothingWhenAPackageIsNotFound(t *testing.T) { file := filepath.Join(t.TempDir(), aRun+".json") raw, _ := json.Marshal([]RollbackItem{{Name: "zlib", To: "1.3.1-2", Source: SourceRepository, Location: ArchiveURL + "/repos/2026/10/04/core/os/$arch"}}) _ = os.WriteFile(file, raw, 0o600) @@ -324,3 +328,27 @@ func TestTheRollbackUnitChangesNothingWhenAPackageIsNotFound(t *testing.T) { t.Fatalf("exit %d, ran %q: a package the archive does not hold fails the unit before any change", code, ran) } } + +// TestTheRootHelperStartsAnUpgradeAsTheRunsUnit runs this file's cases in order as one test, each a row: the check counts every top-level test against the +// module's budget of 50 (design 47 H2 §819). A failing case is named by the line logged before it. +func TestTheRootHelperStartsAnUpgradeAsTheRunsUnit(t *testing.T) { + for _, c := range []struct { + name string + run func(*testing.T) + }{ + {"TestTheRootHelperStartsAnUpgradeAsTheRunsUnit", testTheRootHelperStartsAnUpgradeAsTheRunsUnit}, + {"TestTheRootHelperStartsARollbackWithThePlanInTheRequest", testTheRootHelperStartsARollbackWithThePlanInTheRequest}, + {"TestTheRootHelperReadsTheReplacedFilesMappings", testTheRootHelperReadsTheReplacedFilesMappings}, + {"TestTheRootHelperReadsATransactionUnitsJournal", testTheRootHelperReadsATransactionUnitsJournal}, + {"TestTheRootHelperRefusesEverythingOffItsList", testTheRootHelperRefusesEverythingOffItsList}, + {"TestTheRootHelperAnswersTheKeepersAccountOverItsSocket", testTheRootHelperAnswersTheKeepersAccountOverItsSocket}, + {"TestTheRootHelperRefusesAnyOtherAccount", testTheRootHelperRefusesAnyOtherAccount}, + {"TestTheClientCarriesTheRootActsAndSaysARefusal", testTheClientCarriesTheRootActsAndSaysARefusal}, + {"TestTheRootHelperIsRootWithNoBusAndNoSudoRule", testTheRootHelperIsRootWithNoBusAndNoSudoRule}, + {"TestTheRollbackUnitInstallsThePlanThenRemovesWhatWasAskedInOrder", testTheRollbackUnitInstallsThePlanThenRemovesWhatWasAskedInOrder}, + {"TestTheRollbackUnitChangesNothingWhenAPackageIsNotFound", testTheRollbackUnitChangesNothingWhenAPackageIsNotFound}, + } { + t.Logf("case %s", c.name) + c.run(t) + } +} diff --git a/modules/pacman/cmd/pacman-tools/rounds_test.go b/modules/pacman/cmd/pacman-tools/rounds_test.go index 65463f51b..5a9545e67 100644 --- a/modules/pacman/cmd/pacman-tools/rounds_test.go +++ b/modules/pacman/cmd/pacman-tools/rounds_test.go @@ -85,7 +85,7 @@ func (b *roundBed) state(t *testing.T) map[string]NodeInRound { return out } -func TestTheRoundOpensSaturdayAtFourAndThePassedCheckGivesTheNextItsTurn(t *testing.T) { +func testTheRoundOpensSaturdayAtFourAndThePassedCheckGivesTheNextItsTurn(t *testing.T) { if o := RoundOpening(time.Date(2026, 10, 22, 15, 0, 0, 0, time.UTC)); !o.Equal(time.Date(2026, 10, 24, 4, 0, 0, 0, time.UTC)) { t.Fatalf("the opening of the week of Thursday 22 October: %s", o) } @@ -144,7 +144,7 @@ func TestTheRoundOpensSaturdayAtFourAndThePassedCheckGivesTheNextItsTurn(t *test } } -func TestNoOrderNoRound(t *testing.T) { +func testNoOrderNoRound(t *testing.T) { b := newRoundBed(t) b.now = time.Date(2026, 10, 24, 5, 0, 0, 0, time.UTC) if next := b.step(t, "node-a"); !next.IsZero() { @@ -155,7 +155,7 @@ func TestNoOrderNoRound(t *testing.T) { } } -func TestANodeOffAtItsTurnRunsAtItsNextStartAndAStalledTurnIsSaid(t *testing.T) { +func testANodeOffAtItsTurnRunsAtItsNextStartAndAStalledTurnIsSaid(t *testing.T) { b := newRoundBed(t, "node-a", "node-b", "node-c") b.now = time.Date(2026, 10, 24, 4, 0, 0, 0, time.UTC) b.step(t, "node-a") @@ -183,7 +183,7 @@ func warrant(a oc.Ask, option string, level string, at time.Time) json.RawMessag return raw } -func TestOnlyTheOperatorsApprovePassesANodeAndAPassNeedsAReason(t *testing.T) { +func testOnlyTheOperatorsApprovePassesANodeAndAPassNeedsAReason(t *testing.T) { b := newRoundBed(t, "node-a", "node-b", "node-c") b.now = time.Date(2026, 10, 24, 4, 0, 0, 0, time.UTC) b.step(t, "node-a") @@ -254,7 +254,7 @@ func TestOnlyTheOperatorsApprovePassesANodeAndAPassNeedsAReason(t *testing.T) { } } -func TestAPassTheOperatorKeepsWaitingPassesNothing(t *testing.T) { +func testAPassTheOperatorKeepsWaitingPassesNothing(t *testing.T) { b := newRoundBed(t, "node-a", "node-b") b.now = time.Date(2026, 10, 24, 4, 0, 0, 0, time.UTC) b.step(t, "node-a") // node-a runs and never ends @@ -287,7 +287,7 @@ func TestAPassTheOperatorKeepsWaitingPassesNothing(t *testing.T) { } } -func TestPacmanRoundReadsTheRounds(t *testing.T) { +func testPacmanRoundReadsTheRounds(t *testing.T) { b := newRoundBed(t, "node-a", "node-b") b.now = time.Date(2026, 10, 24, 4, 0, 0, 0, time.UTC) b.step(t, "node-a") @@ -304,3 +304,22 @@ func TestPacmanRoundReadsTheRounds(t *testing.T) { t.Error("a round that is not there") } } + +// TestTheRoundOpensSaturdayAtFourAndThePassedCheckGivesTheNextItsTurn runs this file's cases in order as one test, each a row: the check counts every top-level test against the +// module's budget of 50 (design 47 H2 §819). A failing case is named by the line logged before it. +func TestTheRoundOpensSaturdayAtFourAndThePassedCheckGivesTheNextItsTurn(t *testing.T) { + for _, c := range []struct { + name string + run func(*testing.T) + }{ + {"TestTheRoundOpensSaturdayAtFourAndThePassedCheckGivesTheNextItsTurn", testTheRoundOpensSaturdayAtFourAndThePassedCheckGivesTheNextItsTurn}, + {"TestNoOrderNoRound", testNoOrderNoRound}, + {"TestANodeOffAtItsTurnRunsAtItsNextStartAndAStalledTurnIsSaid", testANodeOffAtItsTurnRunsAtItsNextStartAndAStalledTurnIsSaid}, + {"TestOnlyTheOperatorsApprovePassesANodeAndAPassNeedsAReason", testOnlyTheOperatorsApprovePassesANodeAndAPassNeedsAReason}, + {"TestAPassTheOperatorKeepsWaitingPassesNothing", testAPassTheOperatorKeepsWaitingPassesNothing}, + {"TestPacmanRoundReadsTheRounds", testPacmanRoundReadsTheRounds}, + } { + t.Logf("case %s", c.name) + c.run(t) + } +} diff --git a/modules/pacman/cmd/pacman-tools/runs_test.go b/modules/pacman/cmd/pacman-tools/runs_test.go index d339b695f..98352a4e5 100644 --- a/modules/pacman/cmd/pacman-tools/runs_test.go +++ b/modules/pacman/cmd/pacman-tools/runs_test.go @@ -24,7 +24,7 @@ func capturedLog(t *testing.T) string { // The captured log holds three full upgrades among other commands: one that ended before any transaction, one // whose transaction completed, and a later one that upgraded one package. -func TestEveryFullUpgradeOfTheLogIsARunReadFromIt(t *testing.T) { +func testEveryFullUpgradeOfTheLogIsARunReadFromIt(t *testing.T) { runs := PastUpgrades("node-a", capturedLog(t)) if len(runs) != 3 { t.Fatalf("%d runs, want the three full upgrades and none of the other commands: %+v", len(runs), runs) @@ -61,7 +61,7 @@ func TestEveryFullUpgradeOfTheLogIsARunReadFromIt(t *testing.T) { } } -func TestATransactionWithoutAnEndOrThatFailedIsAFailedRun(t *testing.T) { +func testATransactionWithoutAnEndOrThatFailedIsAFailedRun(t *testing.T) { log := "[2026-10-10T04:00:00+0000] [PACMAN] Running 'pacman -Syu --noconfirm'\n" + "[2026-10-10T04:00:01+0000] [PACMAN] starting full system upgrade\n" + "[2026-10-10T04:00:05+0000] [ALPM] transaction started\n" + @@ -82,7 +82,7 @@ func TestATransactionWithoutAnEndOrThatFailedIsAFailedRun(t *testing.T) { } } -func TestTheLogIsReadIntoRunsOnceAndASecondStartReadsNothing(t *testing.T) { +func testTheLogIsReadIntoRunsOnceAndASecondStartReadsNothing(t *testing.T) { m := machine(nil, 1000) reads := 0 log := capturedLog(t) @@ -116,7 +116,7 @@ func TestTheLogIsReadIntoRunsOnceAndASecondStartReadsNothing(t *testing.T) { // A run's key is created at its first step and then only updated from the revision its writer holds: a step // is written once, and a run another writer changed meanwhile is refused, never overwritten. -func TestAStepIsWrittenOnceAndAnotherWritersChangeIsNeverOverwritten(t *testing.T) { +func testAStepIsWrittenOnceAndAnotherWritersChangeIsNeverOverwritten(t *testing.T) { runs := newBucket() u := &Upgrades{Node: "node-a", Runs: runs} r := &openRun{Run: Run{Node: "node-a", Run: "20261024T040000Z", Kind: RunUpgrade, From: FromAsk}} @@ -142,7 +142,7 @@ func TestAStepIsWrittenOnceAndAnotherWritersChangeIsNeverOverwritten(t *testing. } } -func TestPacmanUpgradesAnswersAllOneNodeDaysAndOneRun(t *testing.T) { +func testPacmanUpgradesAnswersAllOneNodeDaysAndOneRun(t *testing.T) { runs := newBucket() put := func(node, id string, steps ...Step) { r := Run{Node: node, Run: id, Kind: RunUpgrade, From: FromRound, Round: "2026-W43", Steps: steps} @@ -194,7 +194,7 @@ func TestPacmanUpgradesAnswersAllOneNodeDaysAndOneRun(t *testing.T) { } } -func TestTheUpgradesToolReadsTheRunsState(t *testing.T) { +func testTheUpgradesToolReadsTheRunsState(t *testing.T) { runs := newBucket() saved := upgradeState upgradeState = func(name string) Bucket { @@ -215,3 +215,22 @@ func TestTheUpgradesToolReadsTheRunsState(t *testing.T) { } t.Fatal("no pacman_upgrades") } + +// TestEveryFullUpgradeOfTheLogIsARunReadFromIt runs this file's cases in order as one test, each a row: the check counts every top-level test against the +// module's budget of 50 (design 47 H2 §819). A failing case is named by the line logged before it. +func TestEveryFullUpgradeOfTheLogIsARunReadFromIt(t *testing.T) { + for _, c := range []struct { + name string + run func(*testing.T) + }{ + {"TestEveryFullUpgradeOfTheLogIsARunReadFromIt", testEveryFullUpgradeOfTheLogIsARunReadFromIt}, + {"TestATransactionWithoutAnEndOrThatFailedIsAFailedRun", testATransactionWithoutAnEndOrThatFailedIsAFailedRun}, + {"TestTheLogIsReadIntoRunsOnceAndASecondStartReadsNothing", testTheLogIsReadIntoRunsOnceAndASecondStartReadsNothing}, + {"TestAStepIsWrittenOnceAndAnotherWritersChangeIsNeverOverwritten", testAStepIsWrittenOnceAndAnotherWritersChangeIsNeverOverwritten}, + {"TestPacmanUpgradesAnswersAllOneNodeDaysAndOneRun", testPacmanUpgradesAnswersAllOneNodeDaysAndOneRun}, + {"TestTheUpgradesToolReadsTheRunsState", testTheUpgradesToolReadsTheRunsState}, + } { + t.Logf("case %s", c.name) + c.run(t) + } +} diff --git a/modules/pacman/cmd/pacman-tools/transaction_test.go b/modules/pacman/cmd/pacman-tools/transaction_test.go index 1ea5466a2..18306804f 100644 --- a/modules/pacman/cmd/pacman-tools/transaction_test.go +++ b/modules/pacman/cmd/pacman-tools/transaction_test.go @@ -180,7 +180,7 @@ func steps(r Run) string { return strings.Join(s, " ") } -func TestAnAskedUpgradeIsARunWrittenAndEmittedAtEachStep(t *testing.T) { +func testAnAskedUpgradeIsARunWrittenAndEmittedAtEachStep(t *testing.T) { k := newKeeperBed(t) key, err := k.ask(t, "node-a", ActUpgrade) if err != nil { @@ -238,7 +238,7 @@ func TestAnAskedUpgradeIsARunWrittenAndEmittedAtEachStep(t *testing.T) { } } -func TestAFailedTransactionIsWrittenWithItsExitAndLastErrorAndChecked(t *testing.T) { +func testAFailedTransactionIsWrittenWithItsExitAndLastErrorAndChecked(t *testing.T) { k := newKeeperBed(t) if _, err := k.ask(t, "node-a", ActUpgrade); err != nil { t.Fatal(err) @@ -259,7 +259,7 @@ func TestAFailedTransactionIsWrittenWithItsExitAndLastErrorAndChecked(t *testing } } -func TestATransactionThatCannotStartFailsAndIsChecked(t *testing.T) { +func testATransactionThatCannotStartFailsAndIsChecked(t *testing.T) { k := newKeeperBed(t) k.root.fail = errors.New("the root helper's socket is not there") if _, err := k.ask(t, "node-a", ActUpgrade); err != nil { @@ -271,7 +271,7 @@ func TestATransactionThatCannotStartFailsAndIsChecked(t *testing.T) { } } -func TestAnAskIsTakenByItsNodesKeeperAlone(t *testing.T) { +func testAnAskIsTakenByItsNodesKeeperAlone(t *testing.T) { k := newKeeperBed(t) key, err := k.ask(t, "node-b", ActUpgrade) if err != nil { @@ -288,7 +288,7 @@ func TestAnAskIsTakenByItsNodesKeeperAlone(t *testing.T) { } } -func TestAnAskARunAlreadyNamesIsDeletedAndNotRunAgain(t *testing.T) { +func testAnAskARunAlreadyNamesIsDeletedAndNotRunAgain(t *testing.T) { k := newKeeperBed(t) done := Run{Node: "node-a", Run: "20261004T115900Z", Kind: RunUpgrade, From: FromAsk, Ask: RunID(k.now) + "-abc123", Steps: []Step{{Step: StepRefused, At: k.now, Why: "x"}}} @@ -307,7 +307,7 @@ func TestAnAskARunAlreadyNamesIsDeletedAndNotRunAgain(t *testing.T) { } } -func TestARunDoesNotStartWhileTheDatabaseIsLockedOrAnotherRunGoesOn(t *testing.T) { +func testARunDoesNotStartWhileTheDatabaseIsLockedOrAnotherRunGoesOn(t *testing.T) { k := newKeeperBed(t) k.locked = true if _, err := k.ask(t, "node-a", ActUpgrade); err != nil { @@ -336,7 +336,7 @@ func TestARunDoesNotStartWhileTheDatabaseIsLockedOrAnotherRunGoesOn(t *testing.T } } -func TestAKeeperStartedAgainFollowsItsRunToItsEnd(t *testing.T) { +func testAKeeperStartedAgainFollowsItsRunToItsEnd(t *testing.T) { k := newKeeperBed(t) if _, err := k.ask(t, "node-a", ActUpgrade); err != nil { t.Fatal(err) @@ -357,7 +357,7 @@ func TestAKeeperStartedAgainFollowsItsRunToItsEnd(t *testing.T) { } } -func TestAKeeperStartedAgainTakesUpARunStoppedBetweenItsSteps(t *testing.T) { +func testAKeeperStartedAgainTakesUpARunStoppedBetweenItsSteps(t *testing.T) { // Stopped after the gate, before the transaction started: nothing started, so the run is refused. k := newKeeperBed(t) stopped := Run{Node: "node-a", Run: "20261004T115900Z", Kind: RunUpgrade, From: FromAsk, @@ -401,7 +401,7 @@ func TestAKeeperStartedAgainTakesUpARunStoppedBetweenItsSteps(t *testing.T) { } } -func TestPacmanUpgradeWritesAnAskForTheNodeAndStartsNothing(t *testing.T) { +func testPacmanUpgradeWritesAnAskForTheNodeAndStartsNothing(t *testing.T) { asks := newBucket() savedState, savedNode, savedFetch := upgradeState, thisNode, fetch upgradeState = func(name string) Bucket { @@ -445,3 +445,25 @@ func TestPacmanUpgradeWritesAnAskForTheNodeAndStartsNothing(t *testing.T) { } t.Fatal("no pacman_upgrade") } + +// TestAnAskedUpgradeIsARunWrittenAndEmittedAtEachStep runs this file's cases in order as one test, each a row: the check counts every top-level test against the +// module's budget of 50 (design 47 H2 §819). A failing case is named by the line logged before it. +func TestAnAskedUpgradeIsARunWrittenAndEmittedAtEachStep(t *testing.T) { + for _, c := range []struct { + name string + run func(*testing.T) + }{ + {"TestAnAskedUpgradeIsARunWrittenAndEmittedAtEachStep", testAnAskedUpgradeIsARunWrittenAndEmittedAtEachStep}, + {"TestAFailedTransactionIsWrittenWithItsExitAndLastErrorAndChecked", testAFailedTransactionIsWrittenWithItsExitAndLastErrorAndChecked}, + {"TestATransactionThatCannotStartFailsAndIsChecked", testATransactionThatCannotStartFailsAndIsChecked}, + {"TestAnAskIsTakenByItsNodesKeeperAlone", testAnAskIsTakenByItsNodesKeeperAlone}, + {"TestAnAskARunAlreadyNamesIsDeletedAndNotRunAgain", testAnAskARunAlreadyNamesIsDeletedAndNotRunAgain}, + {"TestARunDoesNotStartWhileTheDatabaseIsLockedOrAnotherRunGoesOn", testARunDoesNotStartWhileTheDatabaseIsLockedOrAnotherRunGoesOn}, + {"TestAKeeperStartedAgainFollowsItsRunToItsEnd", testAKeeperStartedAgainFollowsItsRunToItsEnd}, + {"TestAKeeperStartedAgainTakesUpARunStoppedBetweenItsSteps", testAKeeperStartedAgainTakesUpARunStoppedBetweenItsSteps}, + {"TestPacmanUpgradeWritesAnAskForTheNodeAndStartsNothing", testPacmanUpgradeWritesAnAskForTheNodeAndStartsNothing}, + } { + t.Logf("case %s", c.name) + c.run(t) + } +} diff --git a/modules/pacman/cmd/pacman-tools/upgrade_health_test.go b/modules/pacman/cmd/pacman-tools/upgrade_health_test.go index 866902368..884e60e93 100644 --- a/modules/pacman/cmd/pacman-tools/upgrade_health_test.go +++ b/modules/pacman/cmd/pacman-tools/upgrade_health_test.go @@ -32,14 +32,14 @@ func passedRun(node string, at time.Time) Run { {Step: StepFinished, At: at.Add(5 * time.Minute)}, {Step: StepCheckedAfter, At: at.Add(6 * time.Minute), Check: &Check{Passed: true}}}} } -func TestWithNoOrderEveryNodesHealthSaysWhy(t *testing.T) { +func testWithNoOrderEveryNodesHealthSaysWhy(t *testing.T) { m, _ := healthBed(t, nil) if h := m.UpgradeHealth(); h.Healthy || !strings.Contains(h.Why, "upgrade-order") { t.Fatalf("%+v", h) } } -func TestANodeWithNoRunYetIsHealthy(t *testing.T) { +func testANodeWithNoRunYetIsHealthy(t *testing.T) { m, _ := healthBed(t, []string{"node-a", "node-b"}) if h := m.UpgradeHealth(); !h.Healthy { t.Fatalf("%+v", h) @@ -48,7 +48,7 @@ func TestANodeWithNoRunYetIsHealthy(t *testing.T) { // issue 1579: a run that failed is unhealthy until a later run passes, whenever the node woke; a run read from // the log is history and judges nothing. -func TestTheLatestRunJudgesTheNodeNotAUnitsAge(t *testing.T) { +func testTheLatestRunJudgesTheNodeNotAUnitsAge(t *testing.T) { m, states := healthBed(t, []string{"node-a", "node-b"}) exit := 1 failedAt := healthNow.Add(-7 * 24 * time.Hour) @@ -68,7 +68,7 @@ func TestTheLatestRunJudgesTheNodeNotAUnitsAge(t *testing.T) { } } -func TestAFailedCheckIsUnhealthy(t *testing.T) { +func testAFailedCheckIsUnhealthy(t *testing.T) { m, states := healthBed(t, []string{"node-b"}) r := passedRun("node-b", healthNow.Add(-time.Hour)) r.Steps[len(r.Steps)-1].Check = &Check{Passed: false, Unbuilt: []DKMSBuild{{Module: "made-up-dkms", Version: "1.0", Kernel: "7.3.1-arch1-1"}}} @@ -78,7 +78,7 @@ func TestAFailedCheckIsUnhealthy(t *testing.T) { } } -func TestARunPastTheLimitIsHungAndOneWithinItIsHealthy(t *testing.T) { +func testARunPastTheLimitIsHungAndOneWithinItIsHealthy(t *testing.T) { m, states := healthBed(t, []string{"node-b"}) started := healthNow.Add(-3 * time.Hour) putRun(states, Run{Node: "node-b", Run: RunID(started), Kind: RunUpgrade, From: FromAsk, Steps: []Step{{Step: StepRecorded, At: started}, {Step: StepStarted, At: started, Unit: TransactionUnit(RunUpgrade, RunID(started))}}}) @@ -94,7 +94,7 @@ func TestARunPastTheLimitIsHungAndOneWithinItIsHealthy(t *testing.T) { } // 1841/AC4: a held kernel keeps the health unhealthy, naming it, until a later run upgrades it. -func TestAHeldKernelIsSaidUntilARunUpgradesIt(t *testing.T) { +func testAHeldKernelIsSaidUntilARunUpgradesIt(t *testing.T) { m, states := healthBed(t, []string{"node-b"}) r := passedRun("node-b", healthNow.Add(-2*time.Hour)) r.Steps[1].Held = []HeldKernel{{Package: "linux", Version: "7.3.1.arch1-1", Module: "zfs", Bound: "Linux-Maximum 7.2"}} @@ -111,7 +111,7 @@ func TestAHeldKernelIsSaidUntilARunUpgradesIt(t *testing.T) { // 1841/AC7: a turn not started within round-start-minutes makes the waiting node's health name the node it // waits for and since when; the stalled node's own health says it too. -func TestAStalledRoundIsSaidByTheNodesWaitingOnIt(t *testing.T) { +func testAStalledRoundIsSaidByTheNodesWaitingOnIt(t *testing.T) { order := []string{"node-a", "node-b", "node-c"} m, states := healthBed(t, order) round := RoundID(healthNow) @@ -131,7 +131,7 @@ func TestAStalledRoundIsSaidByTheNodesWaitingOnIt(t *testing.T) { } } -func TestARoundStoppedByAFailureIsSaidByTheNodesWaitingOnIt(t *testing.T) { +func testARoundStoppedByAFailureIsSaidByTheNodesWaitingOnIt(t *testing.T) { order := []string{"node-a", "node-b"} m, states := healthBed(t, order) round := RoundID(healthNow) @@ -145,3 +145,24 @@ func TestARoundStoppedByAFailureIsSaidByTheNodesWaitingOnIt(t *testing.T) { t.Fatalf("%+v", h) } } + +// TestWithNoOrderEveryNodesHealthSaysWhy runs this file's cases in order as one test, each a row: the check counts every top-level test against the +// module's budget of 50 (design 47 H2 §819). A failing case is named by the line logged before it. +func TestWithNoOrderEveryNodesHealthSaysWhy(t *testing.T) { + for _, c := range []struct { + name string + run func(*testing.T) + }{ + {"TestWithNoOrderEveryNodesHealthSaysWhy", testWithNoOrderEveryNodesHealthSaysWhy}, + {"TestANodeWithNoRunYetIsHealthy", testANodeWithNoRunYetIsHealthy}, + {"TestTheLatestRunJudgesTheNodeNotAUnitsAge", testTheLatestRunJudgesTheNodeNotAUnitsAge}, + {"TestAFailedCheckIsUnhealthy", testAFailedCheckIsUnhealthy}, + {"TestARunPastTheLimitIsHungAndOneWithinItIsHealthy", testARunPastTheLimitIsHungAndOneWithinItIsHealthy}, + {"TestAHeldKernelIsSaidUntilARunUpgradesIt", testAHeldKernelIsSaidUntilARunUpgradesIt}, + {"TestAStalledRoundIsSaidByTheNodesWaitingOnIt", testAStalledRoundIsSaidByTheNodesWaitingOnIt}, + {"TestARoundStoppedByAFailureIsSaidByTheNodesWaitingOnIt", testARoundStoppedByAFailureIsSaidByTheNodesWaitingOnIt}, + } { + t.Logf("case %s", c.name) + c.run(t) + } +} diff --git a/modules/pacman/cmd/pacman-tools/view_test.go b/modules/pacman/cmd/pacman-tools/view_test.go index 82c1f3a55..7b6dc1853 100644 --- a/modules/pacman/cmd/pacman-tools/view_test.go +++ b/modules/pacman/cmd/pacman-tools/view_test.go @@ -42,7 +42,7 @@ func viewStates(t *testing.T) (*fakeStates, *Machine) { return states, m } -func TestOnePackageOnEveryNodeWithWhoDeclaresIt(t *testing.T) { +func testOnePackageOnEveryNodeWithWhoDeclaresIt(t *testing.T) { _, m := viewStates(t) r, err := m.Packages("zsh", 500) if err != nil { @@ -99,7 +99,7 @@ func TestOnePackageOnEveryNodeWithWhoDeclaresIt(t *testing.T) { } } -func TestTheViewSaysWhatDiffersWhatIsOnSomeNodesWhatNoModuleDeclaresAndTheForeignApart(t *testing.T) { +func testTheViewSaysWhatDiffersWhatIsOnSomeNodesWhatNoModuleDeclaresAndTheForeignApart(t *testing.T) { _, m := viewStates(t) r, err := m.Packages("", 500) if err != nil { @@ -135,7 +135,7 @@ func TestTheViewSaysWhatDiffersWhatIsOnSomeNodesWhatNoModuleDeclaresAndTheForeig } } -func TestInstalledAndForeignAnswerFromTheBus(t *testing.T) { +func testInstalledAndForeignAnswerFromTheBus(t *testing.T) { _, m := viewStates(t) r, err := m.InstalledFrom("", "", "", false, 10) if err != nil || r["node"] != "node-a" || r["count"] != 4 || r["current"] != true { @@ -161,7 +161,7 @@ func TestInstalledAndForeignAnswerFromTheBus(t *testing.T) { } } -func TestUpdatesAnswerEveryNodeAndWhenItsListLastChanged(t *testing.T) { +func testUpdatesAnswerEveryNodeAndWhenItsListLastChanged(t *testing.T) { states, m := viewStates(t) up := states.store(StateUpdates) up.now = func() time.Time { return t0.Add(-2 * time.Hour) } @@ -183,7 +183,7 @@ func TestUpdatesAnswerEveryNodeAndWhenItsListLastChanged(t *testing.T) { } } -func TestANodeArgumentIsOneKeyToken(t *testing.T) { +func testANodeArgumentIsOneKeyToken(t *testing.T) { for _, bad := range []string{"node-a.not-current", "node-a.*", "a b"} { if _, err := nodeOf(map[string]any{"node": bad}); err == nil { t.Errorf("%q was taken as a node", bad) @@ -200,3 +200,21 @@ type failingReader struct{ err error } func (f failingReader) Get(string) (*stdio.StateEntry, error) { return nil, f.err } func (f failingReader) Keys() ([]string, error) { return nil, f.err } func (f failingReader) History(string) ([]stdio.StateRevision, error) { return nil, f.err } + +// TestOnePackageOnEveryNodeWithWhoDeclaresIt runs this file's cases in order as one test, each a row: the check counts every top-level test against the +// module's budget of 50 (design 47 H2 §819). A failing case is named by the line logged before it. +func TestOnePackageOnEveryNodeWithWhoDeclaresIt(t *testing.T) { + for _, c := range []struct { + name string + run func(*testing.T) + }{ + {"TestOnePackageOnEveryNodeWithWhoDeclaresIt", testOnePackageOnEveryNodeWithWhoDeclaresIt}, + {"TestTheViewSaysWhatDiffersWhatIsOnSomeNodesWhatNoModuleDeclaresAndTheForeignApart", testTheViewSaysWhatDiffersWhatIsOnSomeNodesWhatNoModuleDeclaresAndTheForeignApart}, + {"TestInstalledAndForeignAnswerFromTheBus", testInstalledAndForeignAnswerFromTheBus}, + {"TestUpdatesAnswerEveryNodeAndWhenItsListLastChanged", testUpdatesAnswerEveryNodeAndWhenItsListLastChanged}, + {"TestANodeArgumentIsOneKeyToken", testANodeArgumentIsOneKeyToken}, + } { + t.Logf("case %s", c.name) + c.run(t) + } +} diff --git a/modules/pacman/module.json b/modules/pacman/module.json index fff50da70..580aaaa54 100644 --- a/modules/pacman/module.json +++ b/modules/pacman/module.json @@ -1,6 +1,7 @@ { "module": "pacman", "version": "0.1", + "class": "core", "capabilities": [ "package-manager", "service-manager" diff --git a/modules/photos-eef/module.json b/modules/photos-eef/module.json index 3bb9940f3..6f9989e33 100644 --- a/modules/photos-eef/module.json +++ b/modules/photos-eef/module.json @@ -1,6 +1,7 @@ { "module": "photos-eef", "version": "0.1", + "class": "leaf", "slug": "eef", "capabilities": [ "container-runtime" diff --git a/modules/photos-filip/module.json b/modules/photos-filip/module.json index 8287b4a1f..c526f3818 100644 --- a/modules/photos-filip/module.json +++ b/modules/photos-filip/module.json @@ -1,6 +1,7 @@ { "module": "photos-filip", "version": "0.1", + "class": "leaf", "slug": "filip", "capabilities": [ "container-runtime" diff --git a/modules/picom/module.json b/modules/picom/module.json index 31d53c43e..bc61080d1 100644 --- a/modules/picom/module.json +++ b/modules/picom/module.json @@ -1,6 +1,7 @@ { "module": "picom", "version": "0.1", + "class": "core", "capabilities": [ "package-manager" ], diff --git a/modules/polychromatic/module.json b/modules/polychromatic/module.json index b02d2a30f..8930b1469 100644 --- a/modules/polychromatic/module.json +++ b/modules/polychromatic/module.json @@ -1,6 +1,7 @@ { "module": "polychromatic", "version": "0.1", + "class": "leaf", "moved": true, "requires": [ "x11-display" diff --git a/modules/postgres/module.json b/modules/postgres/module.json index c441d7181..e41fab60c 100644 --- a/modules/postgres/module.json +++ b/modules/postgres/module.json @@ -1,6 +1,7 @@ { "module": "postgres", "version": "0.1", + "class": "core", "moved": true, "upgrade": { "policy": "record", diff --git a/modules/power/module.json b/modules/power/module.json index cf5b061bc..e4b54f8f4 100644 --- a/modules/power/module.json +++ b/modules/power/module.json @@ -1,6 +1,7 @@ { "module": "power", "version": "0.1", + "class": "core", "moved": true, "templates": "templates", "capabilities": [ diff --git a/modules/powerlevel10k/module.json b/modules/powerlevel10k/module.json index 72c4e0243..d719efb31 100644 --- a/modules/powerlevel10k/module.json +++ b/modules/powerlevel10k/module.json @@ -1,6 +1,7 @@ { "module": "powerlevel10k", "version": "0.1", + "class": "leaf", "moved": true, "resources": [ { diff --git a/modules/records/module.json b/modules/records/module.json index 3e23fe06d..a41fe6961 100644 --- a/modules/records/module.json +++ b/modules/records/module.json @@ -1,6 +1,7 @@ { "module": "records", "version": "0.1", + "class": "leaf", "slug": "records", "requires": [ "git" diff --git a/modules/redis/module.json b/modules/redis/module.json index 4a7c95998..357accec8 100644 --- a/modules/redis/module.json +++ b/modules/redis/module.json @@ -1,6 +1,7 @@ { "module": "redis", "version": "0.1", + "class": "leaf", "provides": [ { "name": "redis-cache", diff --git a/modules/restic/module.json b/modules/restic/module.json index 313d3e7de..1a006be0e 100644 --- a/modules/restic/module.json +++ b/modules/restic/module.json @@ -1,6 +1,7 @@ { "module": "restic", "version": "0.1", + "class": "core", "packages": { "git.novox.be/novox/mesh-catalog/modules/disk-load/diskreadings": "0.1" }, @@ -261,7 +262,7 @@ "findings-stated.*" ], "max-age-days": 7, - "max-mib": 16 + "max-mib": 8 } } ] diff --git a/modules/rofi/module.json b/modules/rofi/module.json index 69e7a5f70..1bba3a54f 100644 --- a/modules/rofi/module.json +++ b/modules/rofi/module.json @@ -1,6 +1,7 @@ { "module": "rofi", "version": "0.1", + "class": "core", "moved": true, "capabilities": [ "package-manager" diff --git a/modules/route-adapter/module.json b/modules/route-adapter/module.json index 28bbfa869..ee7e27f74 100644 --- a/modules/route-adapter/module.json +++ b/modules/route-adapter/module.json @@ -1,6 +1,7 @@ { "module": "route-adapter", "version": "0.1", + "class": "leaf", "moved": true, "slug": "radapt", "capabilities": [ diff --git a/modules/screen-lock/module.json b/modules/screen-lock/module.json index e73e79230..5f184f289 100644 --- a/modules/screen-lock/module.json +++ b/modules/screen-lock/module.json @@ -1,6 +1,7 @@ { "module": "screen-lock", "version": "0.1", + "class": "core", "moved": true, "capabilities": [ "package-manager" diff --git a/modules/searxng/module.json b/modules/searxng/module.json index d066a5cfb..14add9c82 100644 --- a/modules/searxng/module.json +++ b/modules/searxng/module.json @@ -1,6 +1,7 @@ { "module": "searxng", "version": "0.1", + "class": "leaf", "capabilities": [ "container-runtime" ], diff --git a/modules/sensors/module.json b/modules/sensors/module.json index d029e350d..79a476d6f 100644 --- a/modules/sensors/module.json +++ b/modules/sensors/module.json @@ -1,6 +1,7 @@ { "module": "sensors", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager", "service-manager" diff --git a/modules/showcase/module.json b/modules/showcase/module.json index 7152479c7..06fea3efc 100644 --- a/modules/showcase/module.json +++ b/modules/showcase/module.json @@ -1,6 +1,7 @@ { "module": "showcase", "version": "0.1", + "class": "core", "templates": "templates", "slug": "show", "capabilities": [ diff --git a/modules/slack/module.json b/modules/slack/module.json index 7736b3a1e..f791e2451 100644 --- a/modules/slack/module.json +++ b/modules/slack/module.json @@ -1,6 +1,7 @@ { "module": "slack", "version": "0.1", + "class": "leaf", "moved": true, "requires": [ "x11-display" diff --git a/modules/snapd/module.json b/modules/snapd/module.json index e0049a7fc..cd5ecd1d3 100644 --- a/modules/snapd/module.json +++ b/modules/snapd/module.json @@ -1,6 +1,7 @@ { "module": "snapd", "version": "0.1", + "class": "leaf", "tools": [ "snapd_status", "snapd_list", diff --git a/modules/ssh-client/module.json b/modules/ssh-client/module.json index 933b64acb..c4f8c3a91 100644 --- a/modules/ssh-client/module.json +++ b/modules/ssh-client/module.json @@ -1,6 +1,7 @@ { "module": "ssh-client", "version": "0.1", + "class": "leaf", "moved": true, "tools": [ "ssh_client_hosts", diff --git a/modules/sshd/module.json b/modules/sshd/module.json index c8bd15edd..b799d5a87 100644 --- a/modules/sshd/module.json +++ b/modules/sshd/module.json @@ -1,6 +1,7 @@ { "module": "sshd", "version": "0.1", + "class": "leaf", "upgrade": { "policy": "record", "why": "the operator's way into the machine when the mesh cannot reach it: a build that breaks it is found only when that way is needed, which no gate sees (hq ADR 0236)" diff --git a/modules/step-ca/module.json b/modules/step-ca/module.json index 0656bdfa8..887945e1f 100644 --- a/modules/step-ca/module.json +++ b/modules/step-ca/module.json @@ -1,6 +1,7 @@ { "module": "step-ca", "version": "0.1", + "class": "leaf", "capabilities": [ "container-runtime" ], diff --git a/modules/sudo/module.json b/modules/sudo/module.json index 5b84c2a6e..019d9f992 100644 --- a/modules/sudo/module.json +++ b/modules/sudo/module.json @@ -1,6 +1,7 @@ { "module": "sudo", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager" ], diff --git a/modules/supabase/module.json b/modules/supabase/module.json index 64141d342..e67fad8e2 100644 --- a/modules/supabase/module.json +++ b/modules/supabase/module.json @@ -1,6 +1,7 @@ { "module": "supabase", "version": "0.1", + "class": "leaf", "capabilities": [ "container-runtime" ], diff --git a/modules/systemd-networkd/module.json b/modules/systemd-networkd/module.json index e906eee0a..5c0e60f68 100644 --- a/modules/systemd-networkd/module.json +++ b/modules/systemd-networkd/module.json @@ -1,6 +1,7 @@ { "module": "systemd-networkd", "version": "0.1", + "class": "core", "upgrade": { "policy": "record", "why": "the machine's network: a build that breaks it can cut the machine off from the bus, and then neither the gate's rollback nor a push reaches it (hq ADR 0236)" diff --git a/modules/systemd-resolved/module.json b/modules/systemd-resolved/module.json index 270010bb6..c62dbd7b4 100644 --- a/modules/systemd-resolved/module.json +++ b/modules/systemd-resolved/module.json @@ -1,6 +1,7 @@ { "module": "systemd-resolved", "version": "0.1", + "class": "core", "upgrade": { "policy": "record", "why": "the machine's names: a build that breaks this resolver stops every name resolving on a machine a person works on, the bus's included, and then neither the gate's rollback nor a push reaches it (hq ADR 0236, ADR 0247)" diff --git a/modules/systemd/module.json b/modules/systemd/module.json index a2c492a17..2f3cff730 100644 --- a/modules/systemd/module.json +++ b/modules/systemd/module.json @@ -1,6 +1,7 @@ { "module": "systemd", "version": "0.1", + "class": "core", "capabilities": [ "service-manager", "package-manager" diff --git a/modules/telegram/module.json b/modules/telegram/module.json index a333cfce8..22304d74c 100644 --- a/modules/telegram/module.json +++ b/modules/telegram/module.json @@ -1,6 +1,7 @@ { "module": "telegram", "version": "0.1", + "class": "core", "slug": "tgrm", "runs-as": "telegram", "claims": [ diff --git a/modules/time-sync/module.json b/modules/time-sync/module.json index ba4f1cf53..de09c9e59 100644 --- a/modules/time-sync/module.json +++ b/modules/time-sync/module.json @@ -1,6 +1,7 @@ { "module": "time-sync", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager", "service-manager" diff --git a/modules/triggerhappy/module.json b/modules/triggerhappy/module.json index bbc84be9e..babb95e7b 100644 --- a/modules/triggerhappy/module.json +++ b/modules/triggerhappy/module.json @@ -1,6 +1,7 @@ { "module": "triggerhappy", "version": "0.1", + "class": "core", "moved": true, "capabilities": [ "service-manager" diff --git a/modules/umami/module.json b/modules/umami/module.json index eb8df76e3..d1c618a88 100644 --- a/modules/umami/module.json +++ b/modules/umami/module.json @@ -1,6 +1,7 @@ { "module": "umami", "version": "0.1", + "class": "leaf", "capabilities": [ "container-runtime" ], diff --git a/modules/unifi/module.json b/modules/unifi/module.json index 67348a912..c9f09c7e5 100644 --- a/modules/unifi/module.json +++ b/modules/unifi/module.json @@ -1,6 +1,7 @@ { "module": "unifi", "version": "0.1", + "class": "leaf", "capabilities": [ "container-runtime" ], diff --git a/modules/website/module.json b/modules/website/module.json index b65fb187a..07970c19e 100644 --- a/modules/website/module.json +++ b/modules/website/module.json @@ -1,6 +1,7 @@ { "module": "website", "version": "0.1", + "class": "leaf", "capabilities": [ "container-runtime" ], diff --git a/modules/xclip/module.json b/modules/xclip/module.json index 9c0829670..a094b45ed 100644 --- a/modules/xclip/module.json +++ b/modules/xclip/module.json @@ -1,6 +1,7 @@ { "module": "xclip", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager" ], diff --git a/modules/xdg/module.json b/modules/xdg/module.json index f9afd0214..72b0650a2 100644 --- a/modules/xdg/module.json +++ b/modules/xdg/module.json @@ -1,6 +1,7 @@ { "module": "xdg", "version": "0.1", + "class": "leaf", "capabilities": [ "package-manager" ], diff --git a/modules/xorg/module.json b/modules/xorg/module.json index 72ea858d5..26550fec3 100644 --- a/modules/xorg/module.json +++ b/modules/xorg/module.json @@ -1,6 +1,7 @@ { "module": "xorg", "version": "0.1", + "class": "core", "moved": true, "capabilities": [ "package-manager", diff --git a/modules/xterm/module.json b/modules/xterm/module.json index def76a72d..195510057 100644 --- a/modules/xterm/module.json +++ b/modules/xterm/module.json @@ -1,6 +1,7 @@ { "module": "xterm", "version": "0.1", + "class": "core", "moved": true, "capabilities": [ "package-manager" diff --git a/modules/zfs/module.json b/modules/zfs/module.json index 072a3f285..9e41b0586 100644 --- a/modules/zfs/module.json +++ b/modules/zfs/module.json @@ -1,6 +1,7 @@ { "module": "zfs", "version": "0.1", + "class": "leaf", "capabilities": [ "bus-state-calls", "ledger-calls", @@ -118,7 +119,7 @@ "findings-stated.*" ], "max-age-days": 7, - "max-mib": 16 + "max-mib": 8 } } ], diff --git a/modules/zsh-autosuggestions/module.json b/modules/zsh-autosuggestions/module.json index b4702085c..16415c596 100644 --- a/modules/zsh-autosuggestions/module.json +++ b/modules/zsh-autosuggestions/module.json @@ -1,6 +1,7 @@ { "module": "zsh-autosuggestions", "version": "0.1", + "class": "leaf", "moved": true, "capabilities": [ "package-manager" diff --git a/modules/zsh-syntax-highlighting/module.json b/modules/zsh-syntax-highlighting/module.json index 4e4ea24a0..8fa4c1cb4 100644 --- a/modules/zsh-syntax-highlighting/module.json +++ b/modules/zsh-syntax-highlighting/module.json @@ -1,6 +1,7 @@ { "module": "zsh-syntax-highlighting", "version": "0.1", + "class": "leaf", "moved": true, "capabilities": [ "package-manager" diff --git a/modules/zsh/module.json b/modules/zsh/module.json index 028f2213d..c4bbfb570 100644 --- a/modules/zsh/module.json +++ b/modules/zsh/module.json @@ -1,6 +1,7 @@ { "module": "zsh", "version": "0.1", + "class": "core", "moved": true, "capabilities": [ "package-manager"