feat(client): deliver items only to clients with a matching label
- Add internal/labels: parse and validate the optional work-repo file
agent-lib.labels.json (version 1; unlabeled items go to every client;
names match across types)
- Add "labels" to the client config: absent = no filtering, [] = unlabeled
items only; labels from the admin default config are pinned and cannot be
overridden by user, env or flag configs; a broken admin config aborts
- Filter in prepare() before planning; deselected items follow the
upstream-deletion rules (unmodified removed, modified kept + warn,
--force removes) with reason "not selected for this client's labels"
- Abort sync before any change when the labels file does not validate;
names that match no item only warn on the client
- Report the active selection in sync output and status (--json: labels
object with client, source, labels_file, not_selected, unknown_names)
- validate checks the labels file, including that every name resolves to
an own, vendored or MCP item
- Document in README ("Client labels"), fleet handoff and the proposal;
revise the "client-side selection" non-goal
- Tests: labels parser, config precedence, planner deselection, e2e for
filter/remove/keep-modified/abort/unknown names, validate
Refs: agent_lib-fh4
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
39952ceb02
commit
59735c3b24
16 files changed
+896
-30
No files matched your search
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
{"_type":"issue","id":"agent_lib-fh4","title":"Client labels: deliver items only to clients with a matching label","description":"Design: docs/proposals/client-labels.md (proposed 14.11.2026).\n\nOptional repo file agent-lib.labels.json ({version:1, labels:{label:[item names]}}); unlabeled items go to everyone. Client config gains 'labels'; absent = no filtering, [] = only unlabeled. Admin default config's labels win over user/env config. Invalid labels file aborts sync before any disk change. Filter before planning (internal/client/sync.go loop over inv.Deployable()); deselected items reuse the upstream-deleted path with reason 'not selected for this client's labels'. status --json reports labels/source/filtered; validate checks the file (names resolve incl. MCP). Revises README non-goal 'client-side selection or profiles'.\n\nConsumer: az-agent-defaults (agent-lib.labels.json already prepared) + az-fleet agent_lib role.","acceptance_criteria":"Tests per proposal section 'Tests' green; README documents file format, config field, admin precedence; release tagged; second sync with labels is a byte-level no-op.","status":"open","priority":2,"issue_type":"feature","owner":"m3ta-chiron@agentmail.to","created_at":"2026-11-14T09:11:57Z","created_by":"m3ta-chiron","updated_at":"2026-11-14T09:11:57Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
{"_type":"issue","id":"agent_lib-fh4","title":"Client labels: deliver items only to clients with a matching label","description":"Design: docs/proposals/client-labels.md (proposed 14.11.2026).\n\nOptional repo file agent-lib.labels.json ({version:1, labels:{label:[item names]}}); unlabeled items go to everyone. Client config gains 'labels'; absent = no filtering, [] = only unlabeled. Admin default config's labels win over user/env config. Invalid labels file aborts sync before any disk change. Filter before planning (internal/client/sync.go loop over inv.Deployable()); deselected items reuse the upstream-deleted path with reason 'not selected for this client's labels'. status --json reports labels/source/filtered; validate checks the file (names resolve incl. MCP). Revises README non-goal 'client-side selection or profiles'.\n\nConsumer: az-agent-defaults (agent-lib.labels.json already prepared) + az-fleet agent_lib role.","acceptance_criteria":"Tests per proposal section 'Tests' green; README documents file format, config field, admin precedence; release tagged; second sync with labels is a byte-level no-op.","notes":"14.11.: implementiert auf Branch feat/client-labels (internal/labels, config labels + ApplyAdminLabels, Filter in prepare(), PlanOptions.Deselected, status/sync-Ausgabe, validate-Check, README/fleet-handoff). go test ./... grün, Windows-Build ok, echter Sync gegen az-agent-defaults geprüft. Offen: Review, Merge, Release-Tag. Nicht committet.","status":"in_progress","priority":2,"issue_type":"feature","assignee":"m3ta-chiron","owner":"m3ta-chiron@agentmail.to","created_at":"2026-11-14T09:11:57Z","created_by":"m3ta-chiron","updated_at":"2026-11-14T09:31:19Z","started_at":"2026-11-14T09:24:34Z","lease_expires_at":"2026-11-14T09:29:34Z","heartbeat_at":"2026-11-14T09:24:34Z","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||||
{"_type":"issue","id":"agent-lib-u5t","title":"vendor rename: Vendor-Skills nachträglich umbenennen","description":"Kuratoren sollen vendored Items nachträglich (nicht nur bei vendor add) benutzerfreundlich umbenennen können. Neuer Befehl vendor rename \u003csource\u003e up=new / --reset; umbenannte Skills bekommen den name: im SKILL.md-Frontmatter angepasst (OpenCode verlangt name == Ordnername).","status":"closed","priority":2,"issue_type":"feature","assignee":"m3ta-chiron","owner":"m3ta-chiron@agentmail.to","created_at":"2026-11-05T07:43:31Z","created_by":"m3ta-chiron","updated_at":"2026-11-05T07:45:14Z","started_at":"2026-11-05T07:43:50Z","closed_at":"2026-11-05T07:45:14Z","close_reason":"vendor rename implemented with SKILL.md name rewrite, tests + README","dependency_count":0,"dependent_count":0,"comment_count":0}
|
{"_type":"issue","id":"agent-lib-u5t","title":"vendor rename: Vendor-Skills nachträglich umbenennen","description":"Kuratoren sollen vendored Items nachträglich (nicht nur bei vendor add) benutzerfreundlich umbenennen können. Neuer Befehl vendor rename \u003csource\u003e up=new / --reset; umbenannte Skills bekommen den name: im SKILL.md-Frontmatter angepasst (OpenCode verlangt name == Ordnername).","status":"closed","priority":2,"issue_type":"feature","assignee":"m3ta-chiron","owner":"m3ta-chiron@agentmail.to","created_at":"2026-11-05T07:43:31Z","created_by":"m3ta-chiron","updated_at":"2026-11-05T07:45:14Z","started_at":"2026-11-05T07:43:50Z","closed_at":"2026-11-05T07:45:14Z","close_reason":"vendor rename implemented with SKILL.md name rewrite, tests + README","dependency_count":0,"dependent_count":0,"comment_count":0}
|
||||||
{"_type":"issue","id":"agent-lib-4wx.11","title":"Deliver end-to-end documentation and release gate","description":"Finish the MVP by documenting the full workflow and proving it through an offline end-to-end acceptance path. The slice should provide README content, quickstart, CLI reference, Home Manager examples, security/trust notes, troubleshooting, and a release gate that demonstrates init, Source add, inspect, snippet, Home Manager eval/render, target Manifests, and a green offline check.","acceptance_criteria":"- Documentation covers installation, quickstart, CLI reference, Home Manager configuration, Lockfile behavior, discovery conventions, security/trust model, troubleshooting, MVP scope, and non-goals\n- An offline end-to-end fixture workflow demonstrates initialization, Source discovery, selection, Pi and Opencode Rendered output, target Manifests, and no unmanaged overwrites\n- nix flake check is green without external network access and verifies the MVP acceptance criteria","notes":"E2E fixture check green. All steps verified: init creates lockfile, discover finds all items, lockfile has rev/narHash/HM-compatible schema, inspect/snippet/validate commands work, managed-file protection present. nix flake check passes.","status":"closed","priority":2,"issue_type":"feature","assignee":"m3ta-chiron","owner":"p@m3ta.dev","created_at":"2026-05-27T17:50:02Z","created_by":"m3tam3re","updated_at":"2026-05-28T08:13:15Z","started_at":"2026-05-28T07:46:50Z","closed_at":"2026-05-28T08:13:15Z","labels":["ready-for-agent"],"dependencies":[{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx","type":"parent-child","created_at":"2026-05-27T19:50:01Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.1","type":"blocks","created_at":"2026-05-27T19:50:02Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.10","type":"blocks","created_at":"2026-05-27T19:50:03Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.2","type":"blocks","created_at":"2026-05-27T19:50:02Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.3","type":"blocks","created_at":"2026-05-27T19:50:02Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.4","type":"blocks","created_at":"2026-05-27T19:50:02Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.5","type":"blocks","created_at":"2026-05-27T19:50:02Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.6","type":"blocks","created_at":"2026-05-27T19:50:02Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.7","type":"blocks","created_at":"2026-05-27T19:50:02Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.8","type":"blocks","created_at":"2026-05-27T19:50:03Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.9","type":"blocks","created_at":"2026-05-27T19:50:03Z","created_by":"m3tam3re","metadata":"{}"}],"dependency_count":10,"dependent_count":0,"comment_count":0}
|
{"_type":"issue","id":"agent-lib-4wx.11","title":"Deliver end-to-end documentation and release gate","description":"Finish the MVP by documenting the full workflow and proving it through an offline end-to-end acceptance path. The slice should provide README content, quickstart, CLI reference, Home Manager examples, security/trust notes, troubleshooting, and a release gate that demonstrates init, Source add, inspect, snippet, Home Manager eval/render, target Manifests, and a green offline check.","acceptance_criteria":"- Documentation covers installation, quickstart, CLI reference, Home Manager configuration, Lockfile behavior, discovery conventions, security/trust model, troubleshooting, MVP scope, and non-goals\n- An offline end-to-end fixture workflow demonstrates initialization, Source discovery, selection, Pi and Opencode Rendered output, target Manifests, and no unmanaged overwrites\n- nix flake check is green without external network access and verifies the MVP acceptance criteria","notes":"E2E fixture check green. All steps verified: init creates lockfile, discover finds all items, lockfile has rev/narHash/HM-compatible schema, inspect/snippet/validate commands work, managed-file protection present. nix flake check passes.","status":"closed","priority":2,"issue_type":"feature","assignee":"m3ta-chiron","owner":"p@m3ta.dev","created_at":"2026-05-27T17:50:02Z","created_by":"m3tam3re","updated_at":"2026-05-28T08:13:15Z","started_at":"2026-05-28T07:46:50Z","closed_at":"2026-05-28T08:13:15Z","labels":["ready-for-agent"],"dependencies":[{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx","type":"parent-child","created_at":"2026-05-27T19:50:01Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.1","type":"blocks","created_at":"2026-05-27T19:50:02Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.10","type":"blocks","created_at":"2026-05-27T19:50:03Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.2","type":"blocks","created_at":"2026-05-27T19:50:02Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.3","type":"blocks","created_at":"2026-05-27T19:50:02Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.4","type":"blocks","created_at":"2026-05-27T19:50:02Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.5","type":"blocks","created_at":"2026-05-27T19:50:02Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.6","type":"blocks","created_at":"2026-05-27T19:50:02Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.7","type":"blocks","created_at":"2026-05-27T19:50:02Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.8","type":"blocks","created_at":"2026-05-27T19:50:03Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.11","depends_on_id":"agent-lib-4wx.9","type":"blocks","created_at":"2026-05-27T19:50:03Z","created_by":"m3tam3re","metadata":"{}"}],"dependency_count":10,"dependent_count":0,"comment_count":0}
|
||||||
{"_type":"issue","id":"agent-lib-4wx.10","title":"Complete CLI operational workflows and snippets","description":"Complete the day-to-day CLI workflow around existing Sources, Profiles, and Targets. The slice should make update/review/switch workflows practical with added/removed Item reports, offline and fetch validation modes, minimal and full Nix snippets, JSON output, non-interactive defaults, and an optional interactive entry point without automatic Nix edits.","acceptance_criteria":"- source update and source update --all report added and removed Items without changing Home Manager selection\n- validate runs offline by default, validate --fetch performs explicit reachability checks, and list/inspect/validate support stable JSON output\n- snippet emits both minimal Profile include snippets and full example configuration, while the CLI remains non-interactive by default and never edits Nix files","status":"closed","priority":2,"issue_type":"feature","assignee":"m3ta-chiron","owner":"p@m3ta.dev","created_at":"2026-05-27T17:49:57Z","created_by":"m3tam3re","updated_at":"2026-05-28T07:46:28Z","started_at":"2026-05-28T07:39:36Z","closed_at":"2026-05-28T07:46:28Z","close_reason":"Closed","labels":["ready-for-agent"],"dependencies":[{"issue_id":"agent-lib-4wx.10","depends_on_id":"agent-lib-4wx","type":"parent-child","created_at":"2026-05-27T19:49:56Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.10","depends_on_id":"agent-lib-4wx.3","type":"blocks","created_at":"2026-05-27T19:49:57Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.10","depends_on_id":"agent-lib-4wx.5","type":"blocks","created_at":"2026-05-27T19:49:57Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.10","depends_on_id":"agent-lib-4wx.7","type":"blocks","created_at":"2026-05-27T19:49:57Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.10","depends_on_id":"agent-lib-4wx.8","type":"blocks","created_at":"2026-05-27T19:49:57Z","created_by":"m3tam3re","metadata":"{}"}],"dependency_count":4,"dependent_count":1,"comment_count":0}
|
{"_type":"issue","id":"agent-lib-4wx.10","title":"Complete CLI operational workflows and snippets","description":"Complete the day-to-day CLI workflow around existing Sources, Profiles, and Targets. The slice should make update/review/switch workflows practical with added/removed Item reports, offline and fetch validation modes, minimal and full Nix snippets, JSON output, non-interactive defaults, and an optional interactive entry point without automatic Nix edits.","acceptance_criteria":"- source update and source update --all report added and removed Items without changing Home Manager selection\n- validate runs offline by default, validate --fetch performs explicit reachability checks, and list/inspect/validate support stable JSON output\n- snippet emits both minimal Profile include snippets and full example configuration, while the CLI remains non-interactive by default and never edits Nix files","status":"closed","priority":2,"issue_type":"feature","assignee":"m3ta-chiron","owner":"p@m3ta.dev","created_at":"2026-05-27T17:49:57Z","created_by":"m3tam3re","updated_at":"2026-05-28T07:46:28Z","started_at":"2026-05-28T07:39:36Z","closed_at":"2026-05-28T07:46:28Z","close_reason":"Closed","labels":["ready-for-agent"],"dependencies":[{"issue_id":"agent-lib-4wx.10","depends_on_id":"agent-lib-4wx","type":"parent-child","created_at":"2026-05-27T19:49:56Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.10","depends_on_id":"agent-lib-4wx.3","type":"blocks","created_at":"2026-05-27T19:49:57Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.10","depends_on_id":"agent-lib-4wx.5","type":"blocks","created_at":"2026-05-27T19:49:57Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.10","depends_on_id":"agent-lib-4wx.7","type":"blocks","created_at":"2026-05-27T19:49:57Z","created_by":"m3tam3re","metadata":"{}"},{"issue_id":"agent-lib-4wx.10","depends_on_id":"agent-lib-4wx.8","type":"blocks","created_at":"2026-05-27T19:49:57Z","created_by":"m3tam3re","metadata":"{}"}],"dependency_count":4,"dependent_count":1,"comment_count":0}
|
||||||
|
|||||||
@@ -45,6 +45,7 @@ agents/<id>.md own OpenCode agents
|
|||||||
mcp/<id>.yaml own MCP fragments (never deployed by the binary)
|
mcp/<id>.yaml own MCP fragments (never deployed by the binary)
|
||||||
external/<source>/<type>/ vendored content, mirrors the same four types
|
external/<source>/<type>/ vendored content, mirrors the same four types
|
||||||
agent-lib.lock.json lockfile v2 — pins every source
|
agent-lib.lock.json lockfile v2 — pins every source
|
||||||
|
agent-lib.labels.json optional — restricts items to labeled clients
|
||||||
```
|
```
|
||||||
|
|
||||||
This layout is **exactly** what OpenCode natively consumes — agent-lib is
|
This layout is **exactly** what OpenCode natively consumes — agent-lib is
|
||||||
@@ -291,6 +292,62 @@ agent-lib sync --repo https://github.com/you/your-agent-content.git
|
|||||||
The work repository must be a committed git repository (sync pulls it
|
The work repository must be a committed git repository (sync pulls it
|
||||||
read-only via go-git; local uncommitted state is ignored).
|
read-only via go-git; local uncommitted state is ignored).
|
||||||
|
|
||||||
|
### Client labels
|
||||||
|
|
||||||
|
Not every client needs every item. Restrict items to clients that carry a
|
||||||
|
matching label with an optional `agent-lib.labels.json` at the work
|
||||||
|
repository root:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"version": 1,
|
||||||
|
"labels": {
|
||||||
|
"sales": ["crm-agent", "quote-writer"],
|
||||||
|
"finance": ["officecli-financial-model", "crm-agent"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Unlabeled items go to every client.** Only restricted items appear in
|
||||||
|
the file; a new item needs no entry to reach everyone.
|
||||||
|
- Entries are deployed item names (after renames) and match across types —
|
||||||
|
one entry covers a skill and a command of the same name. MCP fragment
|
||||||
|
names are allowed too (fleet tooling can scope MCP from the same file;
|
||||||
|
the binary never deploys MCP).
|
||||||
|
- An item under several labels reaches clients with any of them.
|
||||||
|
- Labels match `^[a-z0-9][a-z0-9-]*$`; lists must be non-empty; unknown
|
||||||
|
keys and unknown versions are errors.
|
||||||
|
|
||||||
|
Clients opt in through `labels` in their config:
|
||||||
|
|
||||||
|
| `labels` | Delivered |
|
||||||
|
|---|---|
|
||||||
|
| absent | everything — no filtering (default, backward compatible) |
|
||||||
|
| `[]` | unlabeled items only |
|
||||||
|
| `["sales", "lead"]` | unlabeled items plus items labeled `sales` or `lead` |
|
||||||
|
|
||||||
|
**Admin-pinned:** when the admin default config exists and sets `labels`,
|
||||||
|
that value applies no matter which config supplied `repo_url` — a user-level
|
||||||
|
config, `AGENT_LIB_CONFIG` or `--config` can neither widen nor drop it. An
|
||||||
|
admin config that exists but cannot be parsed aborts the run.
|
||||||
|
|
||||||
|
Sync filters before planning. An item that is no longer selected follows
|
||||||
|
the upstream-deletion rules: unmodified copies are removed, locally modified
|
||||||
|
copies are kept with a warning (`--force` removes them); the reason reads
|
||||||
|
"not selected for this client's labels". A labels file that does not
|
||||||
|
validate **aborts the sync before any change** — it never falls back to
|
||||||
|
delivering everything. Names that match no item only warn on the client;
|
||||||
|
`agent-lib validate` treats them as errors on the curator side.
|
||||||
|
|
||||||
|
`sync` and `status` print the active selection
|
||||||
|
(`labels: sales (admin) — 12 item(s) not selected`); `status --json` adds a
|
||||||
|
`labels` object with `client`, `source`, `labels_file`, `not_selected` and
|
||||||
|
`unknown_names`.
|
||||||
|
|
||||||
|
Labels are a relevance filter, **not access control**: every client still
|
||||||
|
fetches the whole revision into its cache. Keep confidential material in a
|
||||||
|
separately authenticated repository.
|
||||||
|
|
||||||
### Notifications
|
### Notifications
|
||||||
|
|
||||||
On Windows, a toast fires when (and only when) a sync kept local
|
On Windows, a toast fires when (and only when) a sync kept local
|
||||||
@@ -347,7 +404,10 @@ In scope: vendoring with selection/renames into any git work repository;
|
|||||||
OpenCode-only deployment with three-state protection; toast notifications;
|
OpenCode-only deployment with three-state protection; toast notifications;
|
||||||
goreleaser/GitHub release pipeline.
|
goreleaser/GitHub release pipeline.
|
||||||
|
|
||||||
Not in scope: client-side selection or profiles, additional targets (Pi,
|
Client-side selection is limited to label filtering (see Client labels) —
|
||||||
|
no per-client profiles, overrides or inheritance.
|
||||||
|
|
||||||
|
Not in scope: additional targets (Pi,
|
||||||
Hermes, Crush, Amp), MCP merge/vault (fleet-controller concern), binary
|
Hermes, Crush, Amp), MCP merge/vault (fleet-controller concern), binary
|
||||||
self-update, git submodule sources, migration tooling from the Python-era
|
self-update, git submodule sources, migration tooling from the Python-era
|
||||||
lockfile.
|
lockfile.
|
||||||
@@ -56,6 +56,10 @@ root-owned, mode 0644).
|
|||||||
- Employees must be able to read the config (sync runs in their context) but
|
- Employees must be able to read the config (sync runs in their context) but
|
||||||
must not be able to alter it.
|
must not be able to alter it.
|
||||||
- Per-run overrides for testing: `--config <path>` or `AGENT_LIB_CONFIG`.
|
- Per-run overrides for testing: `--config <path>` or `AGENT_LIB_CONFIG`.
|
||||||
|
- Optional `"labels": ["<label>", ...]` selects labeled content for this
|
||||||
|
client (README, "Client labels"). Labels in this admin config are pinned:
|
||||||
|
user-level configs cannot override them. Omit the field to deliver
|
||||||
|
everything; `[]` delivers unlabeled items only.
|
||||||
|
|
||||||
Local state (manifest, cached bare repo, sync log) lives per-user:
|
Local state (manifest, cached bare repo, sync log) lives per-user:
|
||||||
`%LocalAppData%\agent-lib` on Windows, `~/.local/state/agent-lib` on Linux
|
`%LocalAppData%\agent-lib` on Windows, `~/.local/state/agent-lib` on Linux
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Proposal: client labels — deliver content to a subset of clients
|
# Proposal: client labels — deliver content to a subset of clients
|
||||||
|
|
||||||
Status: proposed (14.11.2026)
|
Status: implemented on branch feat/client-labels (14.11.2026) — user docs in the README, section "Client labels"
|
||||||
|
|
||||||
## Problem
|
## Problem
|
||||||
|
|
||||||
@@ -108,8 +108,9 @@ a separately authenticated repository.
|
|||||||
- Invalid (parse error, bad label form, empty list, unknown key,
|
- Invalid (parse error, bad label form, empty list, unknown key,
|
||||||
unknown version) → **sync aborts before any change** with a clear
|
unknown version) → **sync aborts before any change** with a clear
|
||||||
error. Never fall back to "deliver everything".
|
error. Never fall back to "deliver everything".
|
||||||
- A name that matches no item → warning in sync log/status, not fatal
|
- A name that matches no item → warning on sync output and in
|
||||||
(the curator-side `validate` is the hard gate).
|
`status`, not fatal and no toast (the curator-side `validate` is the
|
||||||
|
hard gate).
|
||||||
3. Drop items whose labels do not intersect the client labels before
|
3. Drop items whose labels do not intersect the client labels before
|
||||||
hashing/planning (`internal/client/sync.go`, loop over
|
hashing/planning (`internal/client/sync.go`, loop over
|
||||||
`inv.Deployable()`).
|
`inv.Deployable()`).
|
||||||
@@ -124,11 +125,16 @@ a separately authenticated repository.
|
|||||||
`status --json` gains:
|
`status --json` gains:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
"labels": { "client": ["sales"], "source": "admin", "filtered": 12 }
|
"labels": {
|
||||||
|
"client": ["sales"], "source": "admin", "labels_file": true,
|
||||||
|
"not_selected": ["skills/officecli-financial-model"],
|
||||||
|
"unknown_names": []
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
`source` is `admin` | `user` | `env` | `flag` | `none`. Human output
|
The object is omitted when the client has no labels. `source` is `admin`
|
||||||
prints one line: `labels: sales (admin) — 12 items not selected`.
|
| `user` | `env` | `flag`. Human output prints one line:
|
||||||
|
`labels: sales (admin) — 12 item(s) not selected`.
|
||||||
|
|
||||||
## Curator side
|
## Curator side
|
||||||
|
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ import (
|
|||||||
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
|
|
||||||
|
"github.com/m3tam3re/agent-lib/internal/labels"
|
||||||
"github.com/m3tam3re/agent-lib/internal/lockfile"
|
"github.com/m3tam3re/agent-lib/internal/lockfile"
|
||||||
"github.com/m3tam3re/agent-lib/internal/vendor"
|
"github.com/m3tam3re/agent-lib/internal/vendor"
|
||||||
)
|
)
|
||||||
@@ -46,6 +47,9 @@ func newValidateCmd() *cobra.Command {
|
|||||||
w := cmd.OutOrStdout()
|
w := cmd.OutOrStdout()
|
||||||
if result.Valid {
|
if result.Valid {
|
||||||
fmt.Fprintf(w, "lockfile valid (%d sources)\n", len(lf.Sources))
|
fmt.Fprintf(w, "lockfile valid (%d sources)\n", len(lf.Sources))
|
||||||
|
if _, err := os.Stat(labels.FileName); err == nil {
|
||||||
|
fmt.Fprintf(w, "%s valid\n", labels.FileName)
|
||||||
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
for _, e := range result.Errors {
|
for _, e := range result.Errors {
|
||||||
|
|||||||
+78
-10
@@ -11,6 +11,7 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"github.com/m3tam3re/agent-lib/internal/gitsource"
|
"github.com/m3tam3re/agent-lib/internal/gitsource"
|
||||||
|
"github.com/m3tam3re/agent-lib/internal/labels"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ClientConfig is the client configuration for sync: fleet-provided or
|
// ClientConfig is the client configuration for sync: fleet-provided or
|
||||||
@@ -20,6 +21,14 @@ type ClientConfig struct {
|
|||||||
Ref string `json:"ref,omitempty"`
|
Ref string `json:"ref,omitempty"`
|
||||||
Token string `json:"token,omitempty"`
|
Token string `json:"token,omitempty"`
|
||||||
TokenUser string `json:"token_user,omitempty"`
|
TokenUser string `json:"token_user,omitempty"`
|
||||||
|
// Labels restricts delivery to unlabeled items plus items carrying one
|
||||||
|
// of these labels (see the labels package). nil = no filtering; an
|
||||||
|
// empty list = only unlabeled items.
|
||||||
|
Labels *[]string `json:"labels,omitempty"`
|
||||||
|
|
||||||
|
// LabelSource names where Labels came from: "admin", "user", "env",
|
||||||
|
// "flag" or "" when no labels apply. Not part of the file format.
|
||||||
|
LabelSource string `json:"-"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ConfigEnv names the override environment variables.
|
// ConfigEnv names the override environment variables.
|
||||||
@@ -115,50 +124,102 @@ func (e *MissingConfigError) Error() string {
|
|||||||
// default — first existing file wins. Explicit flag/env paths that do not
|
// default — first existing file wins. Explicit flag/env paths that do not
|
||||||
// exist are hard errors; a completely empty chain yields *MissingConfigError.
|
// exist are hard errors; a completely empty chain yields *MissingConfigError.
|
||||||
func LoadClientConfig(flagPath string) (*ClientConfig, error) {
|
func LoadClientConfig(flagPath string) (*ClientConfig, error) {
|
||||||
path, ok, err := resolveConfigPath(flagPath)
|
path, desc, ok, err := resolveConfigPath(flagPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
if !ok {
|
if !ok {
|
||||||
return nil, &MissingConfigError{Chain: ConfigSearchChain(flagPath)}
|
return nil, &MissingConfigError{Chain: ConfigSearchChain(flagPath)}
|
||||||
}
|
}
|
||||||
return readClientConfig(path)
|
cfg, err := readClientConfig(path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
cfg.LabelSource = labelSourceFor(cfg, desc)
|
||||||
|
return cfg, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// LoadOptionalConfig behaves like LoadClientConfig but returns (nil, nil)
|
// LoadOptionalConfig behaves like LoadClientConfig but returns (nil, nil)
|
||||||
// when no config exists anywhere — for runs that carry their own --repo.
|
// when no config exists anywhere — for runs that carry their own --repo.
|
||||||
// Malformed existing configs are still hard errors.
|
// Malformed existing configs are still hard errors.
|
||||||
func LoadOptionalConfig(flagPath string) (*ClientConfig, error) {
|
func LoadOptionalConfig(flagPath string) (*ClientConfig, error) {
|
||||||
path, ok, err := resolveConfigPath(flagPath)
|
path, desc, ok, err := resolveConfigPath(flagPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
if !ok {
|
if !ok {
|
||||||
return nil, nil
|
return nil, nil
|
||||||
}
|
}
|
||||||
return readClientConfig(path)
|
cfg, err := readClientConfig(path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
cfg.LabelSource = labelSourceFor(cfg, desc)
|
||||||
|
return cfg, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// resolveConfigPath walks the search chain and returns the config to read.
|
// resolveConfigPath walks the search chain and returns the config to read.
|
||||||
// The flag and env legs must exist when set (explicit intent); the user and
|
// The flag and env legs must exist when set (explicit intent); the user and
|
||||||
// admin legs are skipped when absent.
|
// admin legs are skipped when absent.
|
||||||
func resolveConfigPath(flagPath string) (path string, found bool, err error) {
|
func resolveConfigPath(flagPath string) (path, source string, found bool, err error) {
|
||||||
if flagPath != "" {
|
if flagPath != "" {
|
||||||
return flagPath, true, nil
|
return flagPath, "flag", true, nil
|
||||||
}
|
}
|
||||||
if envPath := os.Getenv(ConfigEnv); envPath != "" {
|
if envPath := os.Getenv(ConfigEnv); envPath != "" {
|
||||||
return envPath, true, nil
|
return envPath, "env", true, nil
|
||||||
}
|
}
|
||||||
if p := UserConfigPath(); p != "" {
|
if p := UserConfigPath(); p != "" {
|
||||||
if _, statErr := os.Stat(p); statErr == nil {
|
if _, statErr := os.Stat(p); statErr == nil {
|
||||||
return p, true, nil
|
return p, "user", true, nil
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
admin := DefaultConfigPath()
|
admin := DefaultConfigPath()
|
||||||
if _, statErr := os.Stat(admin); statErr == nil {
|
if _, statErr := os.Stat(admin); statErr == nil {
|
||||||
return admin, true, nil
|
return admin, "admin", true, nil
|
||||||
}
|
}
|
||||||
return "", false, nil
|
return "", "", false, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func labelSourceFor(cfg *ClientConfig, source string) string {
|
||||||
|
if cfg.Labels == nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return source
|
||||||
|
}
|
||||||
|
|
||||||
|
// ApplyAdminLabels enforces admin-pinned labels: when the admin default
|
||||||
|
// config at adminPath exists and sets "labels", that value replaces
|
||||||
|
// whatever the chosen config said — user-level, env and flag configs can
|
||||||
|
// neither widen nor drop an admin selection. A missing admin file (or one
|
||||||
|
// without "labels") leaves cfg untouched. An admin file that exists but
|
||||||
|
// cannot be read or parsed is a hard error: the admin's intent is unknown,
|
||||||
|
// so no selection may be guessed.
|
||||||
|
func ApplyAdminLabels(cfg *ClientConfig, adminPath string) error {
|
||||||
|
data, err := os.ReadFile(adminPath)
|
||||||
|
if err != nil {
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return fmt.Errorf("reading admin config %s for labels: %w", adminPath, err)
|
||||||
|
}
|
||||||
|
var admin struct {
|
||||||
|
Labels *[]string `json:"labels"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(data, &admin); err != nil {
|
||||||
|
return fmt.Errorf("admin config %s is not valid JSON: %w", adminPath, err)
|
||||||
|
}
|
||||||
|
if admin.Labels == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
for _, l := range *admin.Labels {
|
||||||
|
if !labels.ValidLabel(l) {
|
||||||
|
return fmt.Errorf("admin config %s: label %q must be lowercase letters, digits and dashes", adminPath, l)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
pinned := append([]string{}, (*admin.Labels)...)
|
||||||
|
cfg.Labels = &pinned
|
||||||
|
cfg.LabelSource = "admin"
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func readClientConfig(path string) (*ClientConfig, error) {
|
func readClientConfig(path string) (*ClientConfig, error) {
|
||||||
@@ -173,6 +234,13 @@ func readClientConfig(path string) (*ClientConfig, error) {
|
|||||||
if cfg.RepoURL == "" {
|
if cfg.RepoURL == "" {
|
||||||
return nil, fmt.Errorf("client config %s: repo_url is required", path)
|
return nil, fmt.Errorf("client config %s: repo_url is required", path)
|
||||||
}
|
}
|
||||||
|
if cfg.Labels != nil {
|
||||||
|
for _, l := range *cfg.Labels {
|
||||||
|
if !labels.ValidLabel(l) {
|
||||||
|
return nil, fmt.Errorf("client config %s: label %q must be lowercase letters, digits and dashes", path, l)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
return &cfg, nil
|
return &cfg, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -163,3 +163,103 @@ func TestFillTokenAuthEnvOnlyFillsEmptyToken(t *testing.T) {
|
|||||||
t.Errorf("env must never override a config token: %+v", configured)
|
t.Errorf("env must never override a config token: %+v", configured)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func writeRaw(t *testing.T, path, content string) {
|
||||||
|
t.Helper()
|
||||||
|
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(path, []byte(content), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigLabelsAbsentEmptyAndSet(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
cases := map[string]struct {
|
||||||
|
body string
|
||||||
|
want *[]string
|
||||||
|
source string
|
||||||
|
}{
|
||||||
|
"absent": {`{"repo_url":"r"}`, nil, ""},
|
||||||
|
"empty": {`{"repo_url":"r","labels":[]}`, &[]string{}, "flag"},
|
||||||
|
"set": {`{"repo_url":"r","labels":["sales","lead"]}`, &[]string{"sales", "lead"}, "flag"},
|
||||||
|
}
|
||||||
|
for name, tc := range cases {
|
||||||
|
p := filepath.Join(dir, name+".json")
|
||||||
|
writeRaw(t, p, tc.body)
|
||||||
|
cfg, err := LoadClientConfig(p)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("%s: %v", name, err)
|
||||||
|
}
|
||||||
|
if (cfg.Labels == nil) != (tc.want == nil) {
|
||||||
|
t.Fatalf("%s: labels nil-ness mismatch: %v", name, cfg.Labels)
|
||||||
|
}
|
||||||
|
if tc.want != nil && strings.Join(*cfg.Labels, ",") != strings.Join(*tc.want, ",") {
|
||||||
|
t.Errorf("%s: labels = %v", name, *cfg.Labels)
|
||||||
|
}
|
||||||
|
if cfg.LabelSource != tc.source {
|
||||||
|
t.Errorf("%s: source = %q, want %q", name, cfg.LabelSource, tc.source)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigRejectsMalformedLabel(t *testing.T) {
|
||||||
|
p := filepath.Join(t.TempDir(), "c.json")
|
||||||
|
writeRaw(t, p, `{"repo_url":"r","labels":["Sales"]}`)
|
||||||
|
if _, err := LoadClientConfig(p); err == nil {
|
||||||
|
t.Fatal("an uppercase label must be rejected")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAdminLabelsWinOverUserLabels(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
admin := filepath.Join(dir, "admin.json")
|
||||||
|
writeRaw(t, admin, `{"repo_url":"r","labels":["finance"]}`)
|
||||||
|
user := []string{"sales", "it"}
|
||||||
|
cfg := &ClientConfig{RepoURL: "r", Labels: &user, LabelSource: "user"}
|
||||||
|
if err := ApplyAdminLabels(cfg, admin); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if cfg.LabelSource != "admin" || strings.Join(*cfg.Labels, ",") != "finance" {
|
||||||
|
t.Fatalf("admin labels must replace user labels, got %v (%s)", *cfg.Labels, cfg.LabelSource)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAdminEmptyLabelsAlsoPin(t *testing.T) {
|
||||||
|
admin := filepath.Join(t.TempDir(), "admin.json")
|
||||||
|
writeRaw(t, admin, `{"repo_url":"r","labels":[]}`)
|
||||||
|
user := []string{"sales"}
|
||||||
|
cfg := &ClientConfig{Labels: &user, LabelSource: "user"}
|
||||||
|
if err := ApplyAdminLabels(cfg, admin); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if cfg.Labels == nil || len(*cfg.Labels) != 0 {
|
||||||
|
t.Fatalf("an admin [] must pin 'unlabeled only', got %v", cfg.Labels)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAdminWithoutLabelsLeavesUserLabels(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
admin := filepath.Join(dir, "admin.json")
|
||||||
|
writeRaw(t, admin, `{"repo_url":"r"}`)
|
||||||
|
user := []string{"sales"}
|
||||||
|
cfg := &ClientConfig{Labels: &user, LabelSource: "user"}
|
||||||
|
if err := ApplyAdminLabels(cfg, admin); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if cfg.LabelSource != "user" || strings.Join(*cfg.Labels, ",") != "sales" {
|
||||||
|
t.Fatalf("without admin labels the user's labels apply, got %v (%s)", *cfg.Labels, cfg.LabelSource)
|
||||||
|
}
|
||||||
|
if err := ApplyAdminLabels(cfg, filepath.Join(dir, "missing.json")); err != nil {
|
||||||
|
t.Fatalf("a missing admin config is not an error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAdminConfigBrokenIsFatal(t *testing.T) {
|
||||||
|
admin := filepath.Join(t.TempDir(), "admin.json")
|
||||||
|
writeRaw(t, admin, `{`)
|
||||||
|
if err := ApplyAdminLabels(&ClientConfig{}, admin); err == nil {
|
||||||
|
t.Fatal("an unreadable admin config must abort: its label intent is unknown")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -17,6 +17,16 @@ const (
|
|||||||
ActKeep Action = "keep"
|
ActKeep Action = "keep"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// ReasonNotSelected explains removals caused by the client's labels.
|
||||||
|
const ReasonNotSelected = "not selected for this client's labels"
|
||||||
|
|
||||||
|
// PlanOptions tune planning. Force overwrites/removes locally modified
|
||||||
|
// managed items; Deselected holds manifest keys filtered out by labels.
|
||||||
|
type PlanOptions struct {
|
||||||
|
Force bool
|
||||||
|
Deselected map[string]bool
|
||||||
|
}
|
||||||
|
|
||||||
// PlannedItem is one deployable inventory item with its repo-side hash.
|
// PlannedItem is one deployable inventory item with its repo-side hash.
|
||||||
type PlannedItem struct {
|
type PlannedItem struct {
|
||||||
Type string
|
Type string
|
||||||
@@ -51,7 +61,12 @@ type PlanEntry struct {
|
|||||||
// locally modified managed items are overwritten with the upstream version
|
// locally modified managed items are overwritten with the upstream version
|
||||||
// (and removed after upstream deletion) instead of being skipped; items
|
// (and removed after upstream deletion) instead of being skipped; items
|
||||||
// agent-lib never managed are never touched, even with force.
|
// agent-lib never managed are never touched, even with force.
|
||||||
func Plan(items []PlannedItem, manifest *Manifest, disk map[string]DiskFact, pathFor func(typ, name string) string, force bool) []PlanEntry {
|
//
|
||||||
|
// Deselected marks keys that exist upstream but are not selected for this
|
||||||
|
// client's labels. Planning treats them exactly like upstream deletions —
|
||||||
|
// only the reasons differ, so users learn why an item went away.
|
||||||
|
func Plan(items []PlannedItem, manifest *Manifest, disk map[string]DiskFact, pathFor func(typ, name string) string, opts PlanOptions) []PlanEntry {
|
||||||
|
force := opts.Force
|
||||||
invByKey := map[string]PlannedItem{}
|
invByKey := map[string]PlannedItem{}
|
||||||
for _, it := range items {
|
for _, it := range items {
|
||||||
invByKey[manifestKey(it.Type, it.Name)] = it
|
invByKey[manifestKey(it.Type, it.Name)] = it
|
||||||
@@ -87,6 +102,10 @@ func Plan(items []PlannedItem, manifest *Manifest, disk map[string]DiskFact, pat
|
|||||||
it, inInv := invByKey[key]
|
it, inInv := invByKey[key]
|
||||||
rec := manifest.Items[key]
|
rec := manifest.Items[key]
|
||||||
fact := disk[key]
|
fact := disk[key]
|
||||||
|
gone := "upstream deleted"
|
||||||
|
if opts.Deselected[key] {
|
||||||
|
gone = ReasonNotSelected
|
||||||
|
}
|
||||||
|
|
||||||
switch {
|
switch {
|
||||||
case inInv && rec == nil:
|
case inInv && rec == nil:
|
||||||
@@ -102,12 +121,12 @@ func Plan(items []PlannedItem, manifest *Manifest, disk map[string]DiskFact, pat
|
|||||||
case rec != nil && !fact.Exists:
|
case rec != nil && !fact.Exists:
|
||||||
emit(ActRemove, PlannedItem{Type: rec.Type, Name: rec.Name, Origin: rec.Origin}, "already gone from disk; dropping manifest record")
|
emit(ActRemove, PlannedItem{Type: rec.Type, Name: rec.Name, Origin: rec.Origin}, "already gone from disk; dropping manifest record")
|
||||||
case rec != nil && fact.Hash == rec.Hash:
|
case rec != nil && fact.Hash == rec.Hash:
|
||||||
emit(ActRemove, PlannedItem{Type: rec.Type, Name: rec.Name, Origin: rec.Origin}, "upstream deleted")
|
emit(ActRemove, PlannedItem{Type: rec.Type, Name: rec.Name, Origin: rec.Origin}, gone)
|
||||||
case rec != nil && force:
|
case rec != nil && force:
|
||||||
emit(ActRemove, PlannedItem{Type: rec.Type, Name: rec.Name, Origin: rec.Origin}, "upstream deleted; forced removal of the locally modified copy")
|
emit(ActRemove, PlannedItem{Type: rec.Type, Name: rec.Name, Origin: rec.Origin}, gone+"; forced removal of the locally modified copy")
|
||||||
case rec != nil:
|
case rec != nil:
|
||||||
emit(ActSkip, PlannedItem{Type: rec.Type, Name: rec.Name, Origin: rec.Origin},
|
emit(ActSkip, PlannedItem{Type: rec.Type, Name: rec.Name, Origin: rec.Origin},
|
||||||
"upstream deleted but the local copy was modified; keeping it")
|
gone+" but the local copy was modified; keeping it")
|
||||||
default:
|
default:
|
||||||
emit(ActLeave, PlannedItem{Type: typeOfKey(key), Name: nameOfKey(key)},
|
emit(ActLeave, PlannedItem{Type: typeOfKey(key), Name: nameOfKey(key)},
|
||||||
"unmanaged local item; left untouched")
|
"unmanaged local item; left untouched")
|
||||||
|
|||||||
@@ -98,7 +98,7 @@ func TestPlanMatrix(t *testing.T) {
|
|||||||
diskFacts[key] = DiskFact{Exists: true, Hash: hashMod}
|
diskFacts[key] = DiskFact{Exists: true, Hash: hashMod}
|
||||||
}
|
}
|
||||||
|
|
||||||
plan := Plan(items, manifest, diskFacts, testPathFor, false)
|
plan := Plan(items, manifest, diskFacts, testPathFor, PlanOptions{})
|
||||||
if tc.disk == diskNone && tc.up == upAbsent {
|
if tc.disk == diskNone && tc.up == upAbsent {
|
||||||
if len(plan) != 0 {
|
if len(plan) != 0 {
|
||||||
t.Fatalf("a key present nowhere must produce no entry, got %+v", plan)
|
t.Fatalf("a key present nowhere must produce no entry, got %+v", plan)
|
||||||
@@ -151,7 +151,7 @@ func TestPlanForceMatrix(t *testing.T) {
|
|||||||
}
|
}
|
||||||
disk := map[string]DiskFact{key: {Exists: true, Hash: hashMod}}
|
disk := map[string]DiskFact{key: {Exists: true, Hash: hashMod}}
|
||||||
|
|
||||||
plan := Plan(items, manifest, disk, testPathFor, true)
|
plan := Plan(items, manifest, disk, testPathFor, PlanOptions{Force: true})
|
||||||
if len(plan) != 1 {
|
if len(plan) != 1 {
|
||||||
t.Fatalf("want exactly 1 entry, got %d: %+v", len(plan), plan)
|
t.Fatalf("want exactly 1 entry, got %d: %+v", len(plan), plan)
|
||||||
}
|
}
|
||||||
@@ -164,7 +164,7 @@ func TestPlanForceMatrix(t *testing.T) {
|
|||||||
t.Run("never-managed occupancy stays skipped", func(t *testing.T) {
|
t.Run("never-managed occupancy stays skipped", func(t *testing.T) {
|
||||||
items := []PlannedItem{{Type: "skills", Name: "alpha", RelPath: "skills/alpha", Hash: hashV1}}
|
items := []PlannedItem{{Type: "skills", Name: "alpha", RelPath: "skills/alpha", Hash: hashV1}}
|
||||||
disk := map[string]DiskFact{manifestKey("skills", "alpha"): {Exists: true, Hash: hashMod}}
|
disk := map[string]DiskFact{manifestKey("skills", "alpha"): {Exists: true, Hash: hashMod}}
|
||||||
plan := Plan(items, NewManifest(), disk, testPathFor, true)
|
plan := Plan(items, NewManifest(), disk, testPathFor, PlanOptions{Force: true})
|
||||||
if len(plan) != 1 || plan[0].Action != ActSkip {
|
if len(plan) != 1 || plan[0].Action != ActSkip {
|
||||||
t.Fatalf("force must not deploy over a never-managed item: %+v", plan)
|
t.Fatalf("force must not deploy over a never-managed item: %+v", plan)
|
||||||
}
|
}
|
||||||
@@ -199,7 +199,7 @@ func TestPlanMixedFixture(t *testing.T) {
|
|||||||
"agents/helper": {Exists: true, Hash: hashV1}, // unmodified × unchanged
|
"agents/helper": {Exists: true, Hash: hashV1}, // unmodified × unchanged
|
||||||
}
|
}
|
||||||
|
|
||||||
plan := Plan(items, manifest, disk, testPathFor, false)
|
plan := Plan(items, manifest, disk, testPathFor, PlanOptions{})
|
||||||
got := map[string]Action{}
|
got := map[string]Action{}
|
||||||
for _, e := range plan {
|
for _, e := range plan {
|
||||||
got[e.Type+"/"+e.Name] = e.Action
|
got[e.Type+"/"+e.Name] = e.Action
|
||||||
@@ -243,8 +243,8 @@ func TestPlanPureGuarantee(t *testing.T) {
|
|||||||
manifest := manifestWith(map[string]*ManifestItem{"skills/b": {Name: "b", Type: "skills", Hash: hashV1}})
|
manifest := manifestWith(map[string]*ManifestItem{"skills/b": {Name: "b", Type: "skills", Hash: hashV1}})
|
||||||
disk := map[string]DiskFact{"skills/b": {Exists: true, Hash: hashV1}}
|
disk := map[string]DiskFact{"skills/b": {Exists: true, Hash: hashV1}}
|
||||||
|
|
||||||
p1 := Plan(items, manifest, disk, testPathFor, false)
|
p1 := Plan(items, manifest, disk, testPathFor, PlanOptions{})
|
||||||
p2 := Plan(items, manifest, disk, testPathFor, false)
|
p2 := Plan(items, manifest, disk, testPathFor, PlanOptions{})
|
||||||
if len(p1) != len(p2) {
|
if len(p1) != len(p2) {
|
||||||
t.Fatal("same inputs must yield same plan length")
|
t.Fatal("same inputs must yield same plan length")
|
||||||
}
|
}
|
||||||
@@ -257,3 +257,31 @@ func TestPlanPureGuarantee(t *testing.T) {
|
|||||||
t.Error("planner must not mutate its inputs")
|
t.Error("planner must not mutate its inputs")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Deselected items follow the upstream-deleted rules exactly; only the
|
||||||
|
// reason tells the user that labels, not a deletion, caused the change.
|
||||||
|
func TestPlanDeselectedFollowsDeletionRules(t *testing.T) {
|
||||||
|
key := manifestKey("skills", "alpha")
|
||||||
|
cases := []struct {
|
||||||
|
name string
|
||||||
|
disk DiskFact
|
||||||
|
force bool
|
||||||
|
action Action
|
||||||
|
reason string
|
||||||
|
}{
|
||||||
|
{"clean copy removed", DiskFact{Exists: true, Hash: hashV1}, false, ActRemove, ReasonNotSelected},
|
||||||
|
{"modified copy kept", DiskFact{Exists: true, Hash: hashMod}, false, ActSkip, ReasonNotSelected + " but the local copy was modified; keeping it"},
|
||||||
|
{"modified copy forced", DiskFact{Exists: true, Hash: hashMod}, true, ActRemove, ReasonNotSelected + "; forced removal of the locally modified copy"},
|
||||||
|
}
|
||||||
|
for _, tc := range cases {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
manifest := NewManifest()
|
||||||
|
manifest.Items[key] = &ManifestItem{Name: "alpha", Type: "skills", Hash: hashV1}
|
||||||
|
plan := Plan(nil, manifest, map[string]DiskFact{key: tc.disk}, testPathFor,
|
||||||
|
PlanOptions{Force: tc.force, Deselected: map[string]bool{key: true}})
|
||||||
|
if len(plan) != 1 || plan[0].Action != tc.action || plan[0].Reason != tc.reason {
|
||||||
|
t.Fatalf("got %+v, want %s %q", plan, tc.action, tc.reason)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -23,6 +23,7 @@ type StatusReport struct {
|
|||||||
Pending []StatusEntry `json:"pending_changes,omitempty"`
|
Pending []StatusEntry `json:"pending_changes,omitempty"`
|
||||||
Skipped []StatusEntry `json:"skipped_items,omitempty"`
|
Skipped []StatusEntry `json:"skipped_items,omitempty"`
|
||||||
Unrecognized []StatusEntry `json:"unrecognized_items,omitempty"`
|
Unrecognized []StatusEntry `json:"unrecognized_items,omitempty"`
|
||||||
|
Labels *LabelSelection `json:"labels,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Status reports the local state without mutating anything. Drift is true
|
// Status reports the local state without mutating anything. Drift is true
|
||||||
@@ -38,6 +39,7 @@ func Status(opts SyncOptions) (*StatusReport, error) {
|
|||||||
Version: version.Version,
|
Version: version.Version,
|
||||||
DeployedRev: p.manifest.Revision,
|
DeployedRev: p.manifest.Revision,
|
||||||
RepoRev: p.pull.Rev,
|
RepoRev: p.pull.Rev,
|
||||||
|
Labels: p.labels,
|
||||||
}
|
}
|
||||||
for _, e := range p.plan {
|
for _, e := range p.plan {
|
||||||
item := e.Type + "/" + e.Name
|
item := e.Type + "/" + e.Name
|
||||||
@@ -85,6 +87,12 @@ func PrintStatus(w io.Writer, r *StatusReport) bool {
|
|||||||
fmt.Fprintln(w)
|
fmt.Fprintln(w)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if r.Labels != nil {
|
||||||
|
fmt.Fprintln(w, r.Labels.Summary())
|
||||||
|
for _, n := range r.Labels.Unknown {
|
||||||
|
fmt.Fprintf(w, " warning: labels file names %q, which matches no item\n", n)
|
||||||
|
}
|
||||||
|
}
|
||||||
printSection("pending changes", r.Pending)
|
printSection("pending changes", r.Pending)
|
||||||
printSection("skipped (local modifications)", r.Skipped)
|
printSection("skipped (local modifications)", r.Skipped)
|
||||||
printSection("unrecognized local items", r.Unrecognized)
|
printSection("unrecognized local items", r.Unrecognized)
|
||||||
|
|||||||
+103
-2
@@ -1,12 +1,17 @@
|
|||||||
package client
|
package client
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
|
"github.com/go-git/go-git/v5/plumbing/object"
|
||||||
|
|
||||||
|
"github.com/m3tam3re/agent-lib/internal/gitsource"
|
||||||
|
"github.com/m3tam3re/agent-lib/internal/labels"
|
||||||
"github.com/m3tam3re/agent-lib/internal/target"
|
"github.com/m3tam3re/agent-lib/internal/target"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -29,6 +34,18 @@ type prepared struct {
|
|||||||
manifest *Manifest
|
manifest *Manifest
|
||||||
items []PlannedItem
|
items []PlannedItem
|
||||||
plan []PlanEntry
|
plan []PlanEntry
|
||||||
|
labels *LabelSelection
|
||||||
|
}
|
||||||
|
|
||||||
|
// LabelSelection describes an active label filter for one run: the client
|
||||||
|
// labels, where they came from, which items were left out and which names
|
||||||
|
// in the labels file match no item. nil when the client carries no labels.
|
||||||
|
type LabelSelection struct {
|
||||||
|
Client []string `json:"client"`
|
||||||
|
Source string `json:"source"`
|
||||||
|
File bool `json:"labels_file"`
|
||||||
|
NotSelected []string `json:"not_selected,omitempty"`
|
||||||
|
Unknown []string `json:"unknown_names,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// prepare pulls, inventories, hashes and plans — the complete read-only
|
// prepare pulls, inventories, hashes and plans — the complete read-only
|
||||||
@@ -66,11 +83,29 @@ func prepare(opts SyncOptions) (*prepared, error) {
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
lf, err := readLabelsFile(pull.Tree)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
var sel *LabelSelection
|
||||||
|
if cfg.Labels != nil {
|
||||||
|
sel = &LabelSelection{Client: append([]string{}, (*cfg.Labels)...), Source: cfg.LabelSource, File: lf != nil}
|
||||||
|
if lf != nil {
|
||||||
|
sel.Unknown = unknownLabelNames(lf, inv)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
items := make([]PlannedItem, 0, len(inv.Items))
|
items := make([]PlannedItem, 0, len(inv.Items))
|
||||||
|
deselected := map[string]bool{}
|
||||||
for _, it := range inv.Deployable() {
|
for _, it := range inv.Deployable() {
|
||||||
if _, ok := oc.DeployPath(it.Type, it.Name); !ok {
|
if _, ok := oc.DeployPath(it.Type, it.Name); !ok {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
if sel != nil && !lf.Selected(it.Name, sel.Client) {
|
||||||
|
deselected[manifestKey(it.Type, it.Name)] = true
|
||||||
|
sel.NotSelected = append(sel.NotSelected, it.Type+"/"+it.Name)
|
||||||
|
continue
|
||||||
|
}
|
||||||
hash, err := HashItem(pull.Tree, it)
|
hash, err := HashItem(pull.Tree, it)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("hashing %s/%s: %w", it.Type, it.Name, err)
|
return nil, fmt.Errorf("hashing %s/%s: %w", it.Type, it.Name, err)
|
||||||
@@ -82,13 +117,48 @@ func prepare(opts SyncOptions) (*prepared, error) {
|
|||||||
path, _ := oc.DeployPath(typ, name)
|
path, _ := oc.DeployPath(typ, name)
|
||||||
return path
|
return path
|
||||||
}
|
}
|
||||||
plan := Plan(items, manifest, diskFacts(oc, manifest, items), pathFor, opts.Force)
|
plan := Plan(items, manifest, diskFacts(oc, manifest, items), pathFor, PlanOptions{Force: opts.Force, Deselected: deselected})
|
||||||
for _, e := range plan {
|
for _, e := range plan {
|
||||||
if !safePath(e.DstPath) {
|
if !safePath(e.DstPath) {
|
||||||
return nil, fmt.Errorf("refusing unsafe deploy path %q", e.DstPath)
|
return nil, fmt.Errorf("refusing unsafe deploy path %q", e.DstPath)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return &prepared{paths: paths, pull: pull, manifest: manifest, items: items, plan: plan}, nil
|
return &prepared{paths: paths, pull: pull, manifest: manifest, items: items, plan: plan, labels: sel}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// readLabelsFile loads the labels file from the pulled revision. A missing
|
||||||
|
// file restricts nothing (nil); a file that exists but does not validate
|
||||||
|
// aborts the run before any mutation — never fall back to "everything".
|
||||||
|
func readLabelsFile(tree *gitsource.GitTree) (*labels.File, error) {
|
||||||
|
data, err := tree.ReadFile(labels.FileName)
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, object.ErrFileNotFound) {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("reading %s: %w", labels.FileName, err)
|
||||||
|
}
|
||||||
|
lf, err := labels.Parse(data)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("work repository %w — sync aborted, nothing changed", err)
|
||||||
|
}
|
||||||
|
return lf, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// unknownLabelNames lists names in the labels file that match no inventory
|
||||||
|
// item of any type (MCP fragments included). Not fatal on the client: the
|
||||||
|
// curator-side validate is the hard gate.
|
||||||
|
func unknownLabelNames(lf *labels.File, inv *Inventory) []string {
|
||||||
|
known := map[string]bool{}
|
||||||
|
for _, it := range inv.Items {
|
||||||
|
known[it.Name] = true
|
||||||
|
}
|
||||||
|
var out []string
|
||||||
|
for _, n := range lf.Names() {
|
||||||
|
if !known[n] {
|
||||||
|
out = append(out, n)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
}
|
}
|
||||||
|
|
||||||
// resolveRunConfig applies the --repo inline override to the config chain:
|
// resolveRunConfig applies the --repo inline override to the config chain:
|
||||||
@@ -101,6 +171,9 @@ func resolveRunConfig(opts SyncOptions) (*ClientConfig, error) {
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
cfg.FillTokenAuth()
|
cfg.FillTokenAuth()
|
||||||
|
if err := ApplyAdminLabels(cfg, DefaultConfigPath()); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
return cfg, nil
|
return cfg, nil
|
||||||
}
|
}
|
||||||
cfg, err := LoadOptionalConfig(opts.ConfigPath)
|
cfg, err := LoadOptionalConfig(opts.ConfigPath)
|
||||||
@@ -115,6 +188,9 @@ func resolveRunConfig(opts SyncOptions) (*ClientConfig, error) {
|
|||||||
cfg.Ref = opts.Ref
|
cfg.Ref = opts.Ref
|
||||||
}
|
}
|
||||||
cfg.FillTokenAuth()
|
cfg.FillTokenAuth()
|
||||||
|
if err := ApplyAdminLabels(cfg, DefaultConfigPath()); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
return cfg, nil
|
return cfg, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -127,6 +203,7 @@ func Sync(opts SyncOptions, stdout io.Writer) (*SyncReport, error) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
printLabelSelection(stdout, p.labels)
|
||||||
return ExecutePlan(p.pull.Tree, p.plan, p.manifest, p.paths, p.pull.Rev, stdout)
|
return ExecutePlan(p.pull.Tree, p.plan, p.manifest, p.paths, p.pull.Rev, stdout)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -145,3 +222,27 @@ func safePath(dst string) bool {
|
|||||||
}
|
}
|
||||||
return rel != ".." && rel != "." && !strings.HasPrefix(rel, ".."+string(filepath.Separator))
|
return rel != ".." && rel != "." && !strings.HasPrefix(rel, ".."+string(filepath.Separator))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// printLabelSelection reports an active label filter in one line, plus a
|
||||||
|
// warning line per labels-file name that matches no item.
|
||||||
|
func printLabelSelection(w io.Writer, sel *LabelSelection) {
|
||||||
|
if sel == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
fmt.Fprintln(w, sel.Summary())
|
||||||
|
for _, n := range sel.Unknown {
|
||||||
|
fmt.Fprintf(w, "warning: %s names %q, which matches no item in the repository\n", labels.FileName, n)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Summary renders the selection as one human-readable line.
|
||||||
|
func (s *LabelSelection) Summary() string {
|
||||||
|
client := strings.Join(s.Client, ", ")
|
||||||
|
if client == "" {
|
||||||
|
client = "(none — unlabeled items only)"
|
||||||
|
}
|
||||||
|
if !s.File {
|
||||||
|
return fmt.Sprintf("labels: %s (%s) — repository has no %s, nothing filtered", client, s.Source, labels.FileName)
|
||||||
|
}
|
||||||
|
return fmt.Sprintf("labels: %s (%s) — %d item(s) not selected", client, s.Source, len(s.NotSelected))
|
||||||
|
}
|
||||||
@@ -0,0 +1,166 @@
|
|||||||
|
package e2e
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func (e *syncEnv) writeLabelConfig(t *testing.T, labelsJSON string) {
|
||||||
|
t.Helper()
|
||||||
|
e.config = filepath.Join(e.configDir, "config.json")
|
||||||
|
body := `{"repo_url":"` + filepath.ToSlash(e.workRepo) + `","ref":"main"`
|
||||||
|
if labelsJSON != "" {
|
||||||
|
body += `,"labels":` + labelsJSON
|
||||||
|
}
|
||||||
|
body += "}"
|
||||||
|
if err := os.WriteFile(e.config, []byte(body), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func commitLabels(t *testing.T, h *harness, dir, content string) {
|
||||||
|
t.Helper()
|
||||||
|
if err := os.WriteFile(filepath.Join(dir, "agent-lib.labels.json"), []byte(content), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
h.git(t, dir, "add", "-A")
|
||||||
|
h.git(t, dir, "commit", "-m", "labels")
|
||||||
|
}
|
||||||
|
|
||||||
|
func exists(p string) bool {
|
||||||
|
_, err := os.Stat(p)
|
||||||
|
return err == nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSyncLabelsFilterAndRemove(t *testing.T) {
|
||||||
|
h := newHarness(t)
|
||||||
|
env := newSyncEnv(t, h)
|
||||||
|
buildWorkRepo(t, h, env.workRepo)
|
||||||
|
commitLabels(t, h, env.workRepo, `{"version":1,"labels":{"ops":["deploy"],"dev":["helper","own-skill"]}}`)
|
||||||
|
|
||||||
|
skill := filepath.Join(env.home, ".agents/skills/own-skill")
|
||||||
|
cmd := filepath.Join(env.home, ".config/opencode/commands/deploy.md")
|
||||||
|
agent := filepath.Join(env.home, ".config/opencode/agents/helper.md")
|
||||||
|
|
||||||
|
// No labels field: no filtering at all (backward compatible).
|
||||||
|
env.writeLabelConfig(t, "")
|
||||||
|
if out, err := env.run(t); err != nil {
|
||||||
|
t.Fatalf("sync failed: %v\n%s", err, out)
|
||||||
|
}
|
||||||
|
if !exists(skill) || !exists(cmd) || !exists(agent) {
|
||||||
|
t.Fatal("without client labels every item must deploy")
|
||||||
|
}
|
||||||
|
|
||||||
|
// labels ["ops"]: dev items go away, ops item stays.
|
||||||
|
env.writeLabelConfig(t, `["ops"]`)
|
||||||
|
out, err := env.run(t)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("sync failed: %v\n%s", err, out)
|
||||||
|
}
|
||||||
|
if !strings.Contains(out, "labels: ops") || !strings.Contains(out, "2 item(s) not selected") {
|
||||||
|
t.Errorf("sync must report the active selection, got:\n%s", out)
|
||||||
|
}
|
||||||
|
if exists(skill) || exists(agent) {
|
||||||
|
t.Error("deselected unmodified items must be removed")
|
||||||
|
}
|
||||||
|
if !exists(cmd) {
|
||||||
|
t.Error("selected item must stay")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Second identical run is a no-op.
|
||||||
|
out, err = env.run(t)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("sync failed: %v\n%s", err, out)
|
||||||
|
}
|
||||||
|
if !strings.Contains(out, "deployed: 0") || !strings.Contains(out, "removed: 0") || !strings.Contains(out, "updated: 0") {
|
||||||
|
t.Errorf("second run must change nothing, got:\n%s", out)
|
||||||
|
}
|
||||||
|
|
||||||
|
// [] = unlabeled items only: everything here is labeled.
|
||||||
|
env.writeLabelConfig(t, `[]`)
|
||||||
|
if out, err := env.run(t); err != nil {
|
||||||
|
t.Fatalf("sync failed: %v\n%s", err, out)
|
||||||
|
}
|
||||||
|
if exists(cmd) {
|
||||||
|
t.Error("labels [] must deliver unlabeled items only")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSyncLabelsKeepModifiedCopy(t *testing.T) {
|
||||||
|
h := newHarness(t)
|
||||||
|
env := newSyncEnv(t, h)
|
||||||
|
buildWorkRepo(t, h, env.workRepo)
|
||||||
|
commitLabels(t, h, env.workRepo, `{"version":1,"labels":{"dev":["helper"]}}`)
|
||||||
|
|
||||||
|
env.writeLabelConfig(t, `["dev"]`)
|
||||||
|
if out, err := env.run(t); err != nil {
|
||||||
|
t.Fatalf("sync failed: %v\n%s", err, out)
|
||||||
|
}
|
||||||
|
agent := filepath.Join(env.home, ".config/opencode/agents/helper.md")
|
||||||
|
if err := os.WriteFile(agent, []byte("my edit\n"), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
env.writeLabelConfig(t, `["ops"]`)
|
||||||
|
if out, err := env.run(t); err != nil {
|
||||||
|
t.Fatalf("sync failed: %v\n%s", err, out)
|
||||||
|
}
|
||||||
|
if !exists(agent) {
|
||||||
|
t.Fatal("a locally modified copy must survive deselection")
|
||||||
|
}
|
||||||
|
log, _ := os.ReadFile(filepath.Join(env.stateDir, "sync.log"))
|
||||||
|
if !strings.Contains(string(log), "not selected for this client's labels") {
|
||||||
|
t.Errorf("sync log must explain the label-based skip, got:\n%s", log)
|
||||||
|
}
|
||||||
|
|
||||||
|
if out, err := env.run(t, "--force"); err != nil {
|
||||||
|
t.Fatalf("sync --force failed: %v\n%s", err, out)
|
||||||
|
}
|
||||||
|
if exists(agent) {
|
||||||
|
t.Error("--force must remove the deselected modified copy")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSyncInvalidLabelsFileAbortsWithoutChange(t *testing.T) {
|
||||||
|
h := newHarness(t)
|
||||||
|
env := newSyncEnv(t, h)
|
||||||
|
buildWorkRepo(t, h, env.workRepo)
|
||||||
|
env.writeLabelConfig(t, `["ops"]`)
|
||||||
|
if out, err := env.run(t); err != nil {
|
||||||
|
t.Fatalf("sync failed: %v\n%s", err, out)
|
||||||
|
}
|
||||||
|
manifestBefore, _ := os.ReadFile(filepath.Join(env.stateDir, "manifest.json"))
|
||||||
|
|
||||||
|
commitLabels(t, h, env.workRepo, `{"version":1,"labels":{"Ops":["deploy"]}}`)
|
||||||
|
out, err := env.run(t)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatalf("an invalid labels file must fail the sync, got:\n%s", out)
|
||||||
|
}
|
||||||
|
if !strings.Contains(out, "agent-lib.labels.json") || !strings.Contains(out, "nothing changed") {
|
||||||
|
t.Errorf("error must name the file and promise no change, got:\n%s", out)
|
||||||
|
}
|
||||||
|
manifestAfter, _ := os.ReadFile(filepath.Join(env.stateDir, "manifest.json"))
|
||||||
|
if string(manifestBefore) != string(manifestAfter) {
|
||||||
|
t.Error("an aborted sync must not touch the manifest")
|
||||||
|
}
|
||||||
|
if !exists(filepath.Join(env.home, ".config/opencode/commands/deploy.md")) {
|
||||||
|
t.Error("an aborted sync must not remove anything")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSyncLabelsUnknownNameWarns(t *testing.T) {
|
||||||
|
h := newHarness(t)
|
||||||
|
env := newSyncEnv(t, h)
|
||||||
|
buildWorkRepo(t, h, env.workRepo)
|
||||||
|
commitLabels(t, h, env.workRepo, `{"version":1,"labels":{"ops":["deploy","no-such-item"]}}`)
|
||||||
|
env.writeLabelConfig(t, `["ops"]`)
|
||||||
|
out, err := env.run(t)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("an unknown name must not fail the client sync: %v\n%s", err, out)
|
||||||
|
}
|
||||||
|
if !strings.Contains(out, `"no-such-item"`) {
|
||||||
|
t.Errorf("sync must warn about the unknown name, got:\n%s", out)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,128 @@
|
|||||||
|
// Package labels parses the optional work-repository file that restricts
|
||||||
|
// items to clients carrying a matching label.
|
||||||
|
//
|
||||||
|
// Semantics: an item that appears under no label is delivered to every
|
||||||
|
// client; an item that appears under one or more labels is delivered to a
|
||||||
|
// client that carries at least one of them. Entries are deployed item names
|
||||||
|
// and match across types (a skill and a command of the same name are both
|
||||||
|
// covered by one entry).
|
||||||
|
package labels
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"regexp"
|
||||||
|
"sort"
|
||||||
|
)
|
||||||
|
|
||||||
|
// FileName is the labels file at the work-repository root.
|
||||||
|
const FileName = "agent-lib.labels.json"
|
||||||
|
|
||||||
|
// Version is the only file format version this binary understands.
|
||||||
|
const Version = 1
|
||||||
|
|
||||||
|
var labelForm = regexp.MustCompile(`^[a-z0-9][a-z0-9-]*$`)
|
||||||
|
|
||||||
|
// ValidLabel reports whether s has the required label form.
|
||||||
|
func ValidLabel(s string) bool { return labelForm.MatchString(s) }
|
||||||
|
|
||||||
|
// File is a parsed labels file.
|
||||||
|
type File struct {
|
||||||
|
Version int `json:"version"`
|
||||||
|
Labels map[string][]string `json:"labels"`
|
||||||
|
|
||||||
|
byItem map[string][]string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Parse decodes and validates a labels file strictly: unknown keys, an
|
||||||
|
// unsupported version, malformed labels, empty lists and empty names are
|
||||||
|
// errors. A file that does not validate must never be applied.
|
||||||
|
func Parse(data []byte) (*File, error) {
|
||||||
|
dec := json.NewDecoder(bytes.NewReader(data))
|
||||||
|
dec.DisallowUnknownFields()
|
||||||
|
var f File
|
||||||
|
if err := dec.Decode(&f); err != nil {
|
||||||
|
return nil, fmt.Errorf("%s is not valid: %w", FileName, err)
|
||||||
|
}
|
||||||
|
if dec.More() {
|
||||||
|
return nil, fmt.Errorf("%s is not valid: trailing data after the JSON object", FileName)
|
||||||
|
}
|
||||||
|
if f.Version != Version {
|
||||||
|
return nil, fmt.Errorf("%s: unsupported version %d (this binary understands version %d)", FileName, f.Version, Version)
|
||||||
|
}
|
||||||
|
if f.Labels == nil {
|
||||||
|
return nil, fmt.Errorf("%s: \"labels\" is required (use {} for no restrictions)", FileName)
|
||||||
|
}
|
||||||
|
f.byItem = map[string][]string{}
|
||||||
|
for _, label := range f.SortedLabels() {
|
||||||
|
names := f.Labels[label]
|
||||||
|
if !ValidLabel(label) {
|
||||||
|
return nil, fmt.Errorf("%s: label %q must match %s", FileName, label, labelForm)
|
||||||
|
}
|
||||||
|
if len(names) == 0 {
|
||||||
|
return nil, fmt.Errorf("%s: label %q has an empty item list (remove the label instead)", FileName, label)
|
||||||
|
}
|
||||||
|
for _, name := range names {
|
||||||
|
if name == "" {
|
||||||
|
return nil, fmt.Errorf("%s: label %q contains an empty item name", FileName, label)
|
||||||
|
}
|
||||||
|
if !contains(f.byItem[name], label) {
|
||||||
|
f.byItem[name] = append(f.byItem[name], label)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return &f, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SortedLabels returns the declared labels in stable order.
|
||||||
|
func (f *File) SortedLabels() []string {
|
||||||
|
out := make([]string, 0, len(f.Labels))
|
||||||
|
for l := range f.Labels {
|
||||||
|
out = append(out, l)
|
||||||
|
}
|
||||||
|
sort.Strings(out)
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// Names returns every item name the file mentions, sorted and unique.
|
||||||
|
func (f *File) Names() []string {
|
||||||
|
out := make([]string, 0, len(f.byItem))
|
||||||
|
for n := range f.byItem {
|
||||||
|
out = append(out, n)
|
||||||
|
}
|
||||||
|
sort.Strings(out)
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// LabelsOf returns the labels an item carries (nil = unlabeled).
|
||||||
|
func (f *File) LabelsOf(name string) []string {
|
||||||
|
if f == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return f.byItem[name]
|
||||||
|
}
|
||||||
|
|
||||||
|
// Selected reports whether an item goes to a client carrying clientLabels.
|
||||||
|
// Unlabeled items always do; a nil file restricts nothing.
|
||||||
|
func (f *File) Selected(name string, clientLabels []string) bool {
|
||||||
|
itemLabels := f.LabelsOf(name)
|
||||||
|
if len(itemLabels) == 0 {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
for _, l := range itemLabels {
|
||||||
|
if contains(clientLabels, l) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func contains(list []string, s string) bool {
|
||||||
|
for _, v := range list {
|
||||||
|
if v == s {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
@@ -0,0 +1,76 @@
|
|||||||
|
package labels
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestParseAndSelect(t *testing.T) {
|
||||||
|
f, err := Parse([]byte(`{"version":1,"labels":{"sales":["crm","quote"],"finance":["model","crm"]}}`))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
cases := []struct {
|
||||||
|
item string
|
||||||
|
client []string
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{"unlabeled", nil, true},
|
||||||
|
{"unlabeled", []string{}, true},
|
||||||
|
{"crm", nil, false},
|
||||||
|
{"crm", []string{"sales"}, true},
|
||||||
|
{"crm", []string{"finance"}, true},
|
||||||
|
{"quote", []string{"finance"}, false},
|
||||||
|
{"quote", []string{"finance", "sales"}, true},
|
||||||
|
{"model", []string{"other"}, false},
|
||||||
|
}
|
||||||
|
for _, c := range cases {
|
||||||
|
if got := f.Selected(c.item, c.client); got != c.want {
|
||||||
|
t.Errorf("Selected(%q, %v) = %v, want %v", c.item, c.client, got, c.want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if got := strings.Join(f.Names(), ","); got != "crm,model,quote" {
|
||||||
|
t.Errorf("Names() = %s", got)
|
||||||
|
}
|
||||||
|
if got := strings.Join(f.LabelsOf("crm"), ","); got != "finance,sales" {
|
||||||
|
t.Errorf("LabelsOf(crm) = %s", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNilFileRestrictsNothing(t *testing.T) {
|
||||||
|
var f *File
|
||||||
|
if !f.Selected("anything", nil) {
|
||||||
|
t.Error("a nil file must select every item")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEmptyLabelsMapIsValid(t *testing.T) {
|
||||||
|
f, err := Parse([]byte(`{"version":1,"labels":{}}`))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !f.Selected("x", nil) {
|
||||||
|
t.Error("no labels declared means no restrictions")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseRejects(t *testing.T) {
|
||||||
|
cases := map[string]string{
|
||||||
|
"not json": `{`,
|
||||||
|
"unknown key": `{"version":1,"labels":{},"extra":true}`,
|
||||||
|
"wrong version": `{"version":2,"labels":{}}`,
|
||||||
|
"missing version": `{"labels":{}}`,
|
||||||
|
"missing labels": `{"version":1}`,
|
||||||
|
"upper label": `{"version":1,"labels":{"Sales":["a"]}}`,
|
||||||
|
"space label": `{"version":1,"labels":{"sales team":["a"]}}`,
|
||||||
|
"leading dash": `{"version":1,"labels":{"-sales":["a"]}}`,
|
||||||
|
"empty list": `{"version":1,"labels":{"sales":[]}}`,
|
||||||
|
"empty name": `{"version":1,"labels":{"sales":[""]}}`,
|
||||||
|
"trailing data": `{"version":1,"labels":{}} {}`,
|
||||||
|
}
|
||||||
|
for name, data := range cases {
|
||||||
|
if _, err := Parse([]byte(data)); err == nil {
|
||||||
|
t.Errorf("%s: expected an error", name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+61
@@ -0,0 +1,61 @@
|
|||||||
|
package vendor
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/m3tam3re/agent-lib/internal/lockfile"
|
||||||
|
)
|
||||||
|
|
||||||
|
func labelsWorkDir(t *testing.T, labelsJSON string) string {
|
||||||
|
t.Helper()
|
||||||
|
dir := t.TempDir()
|
||||||
|
write := func(rel, content string) {
|
||||||
|
p := filepath.Join(dir, rel)
|
||||||
|
if err := os.MkdirAll(filepath.Dir(p), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(p, []byte(content), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
write("skills/alpha/SKILL.md", "---\nname: alpha\ndescription: a\n---\n")
|
||||||
|
write("agents/beta.md", "---\ndescription: b\n---\n")
|
||||||
|
write("mcp/websearch.yaml", "websearch: {}\n")
|
||||||
|
if labelsJSON != "" {
|
||||||
|
write("agent-lib.labels.json", labelsJSON)
|
||||||
|
}
|
||||||
|
return dir
|
||||||
|
}
|
||||||
|
|
||||||
|
func labelErrors(v Validation) []string {
|
||||||
|
var out []string
|
||||||
|
for _, e := range v.Errors {
|
||||||
|
if e.Rule == "labels" {
|
||||||
|
out = append(out, e.Message)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestValidateLabels(t *testing.T) {
|
||||||
|
lf := lockfile.New()
|
||||||
|
if errs := labelErrors(Validate(labelsWorkDir(t, ""), lf)); len(errs) != 0 {
|
||||||
|
t.Errorf("no labels file is fine, got %v", errs)
|
||||||
|
}
|
||||||
|
ok := `{"version":1,"labels":{"sales":["alpha","websearch"],"dev":["beta"]}}`
|
||||||
|
if errs := labelErrors(Validate(labelsWorkDir(t, ok), lf)); len(errs) != 0 {
|
||||||
|
t.Errorf("valid file reported errors: %v", errs)
|
||||||
|
}
|
||||||
|
unknown := `{"version":1,"labels":{"sales":["alpha","gamma"]}}`
|
||||||
|
errs := labelErrors(Validate(labelsWorkDir(t, unknown), lf))
|
||||||
|
if len(errs) != 1 || !strings.Contains(errs[0], `"gamma"`) {
|
||||||
|
t.Errorf("unknown name must be reported once, got %v", errs)
|
||||||
|
}
|
||||||
|
bad := `{"version":1,"labels":{"Sales":["alpha"]}}`
|
||||||
|
if errs := labelErrors(Validate(labelsWorkDir(t, bad), lf)); len(errs) != 1 {
|
||||||
|
t.Errorf("malformed label must be reported, got %v", errs)
|
||||||
|
}
|
||||||
|
}
|
||||||
Vendored
+37
@@ -8,6 +8,7 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"github.com/m3tam3re/agent-lib/internal/discovery"
|
"github.com/m3tam3re/agent-lib/internal/discovery"
|
||||||
|
"github.com/m3tam3re/agent-lib/internal/labels"
|
||||||
"github.com/m3tam3re/agent-lib/internal/lockfile"
|
"github.com/m3tam3re/agent-lib/internal/lockfile"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -34,6 +35,7 @@ func Validate(workDir string, lf *lockfile.Lockfile) Validation {
|
|||||||
v.checkExternalArea(workDir, name, src)
|
v.checkExternalArea(workDir, name, src)
|
||||||
}
|
}
|
||||||
v.Errors = append(v.Errors, validateCollisions(workDir, lf)...)
|
v.Errors = append(v.Errors, validateCollisions(workDir, lf)...)
|
||||||
|
v.checkLabels(workDir, lf)
|
||||||
sort.Slice(v.Errors, func(i, j int) bool {
|
sort.Slice(v.Errors, func(i, j int) bool {
|
||||||
if v.Errors[i].Source != v.Errors[j].Source {
|
if v.Errors[i].Source != v.Errors[j].Source {
|
||||||
return v.Errors[i].Source < v.Errors[j].Source
|
return v.Errors[i].Source < v.Errors[j].Source
|
||||||
@@ -44,6 +46,41 @@ func Validate(workDir string, lf *lockfile.Lockfile) Validation {
|
|||||||
return v
|
return v
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// checkLabels validates the optional labels file: format rules (via the
|
||||||
|
// labels parser) and that every name resolves to an item of any type —
|
||||||
|
// own items, vendored items under their deployed names, MCP fragments.
|
||||||
|
func (v *Validation) checkLabels(workDir string, lf *lockfile.Lockfile) {
|
||||||
|
data, err := os.ReadFile(filepath.Join(workDir, labels.FileName))
|
||||||
|
if err != nil {
|
||||||
|
if !os.IsNotExist(err) {
|
||||||
|
v.fail("", "labels", "reading %s: %v", labels.FileName, err)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
file, err := labels.Parse(data)
|
||||||
|
if err != nil {
|
||||||
|
v.fail("", "labels", "%v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
own, err := ownDeployed(workDir)
|
||||||
|
if err != nil {
|
||||||
|
v.fail("", "labels", "scanning own items: %v", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
known := map[string]bool{}
|
||||||
|
for _, m := range mergeIndex(own, lockfileDeployed(lf, "")) {
|
||||||
|
for name := range m {
|
||||||
|
known[name] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, name := range file.Names() {
|
||||||
|
if !known[name] {
|
||||||
|
v.fail("", "labels", "%s: %q (labels %s) matches no item in the work repository",
|
||||||
|
labels.FileName, name, strings.Join(file.LabelsOf(name), ", "))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func (v *Validation) fail(source, rule, format string, args ...any) {
|
func (v *Validation) fail(source, rule, format string, args ...any) {
|
||||||
v.Errors = append(v.Errors, ValidationError{
|
v.Errors = append(v.Errors, ValidationError{
|
||||||
Source: source,
|
Source: source,
|
||||||
|
|||||||
Reference in new issue
Block a user