Compare commits
70 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 19542dd8c9 | |||
| 436641782c | |||
| 075d2f6459 | |||
| e92b18197c | |||
| d379d19deb | |||
| 60b0357eb6 | |||
| af2fa59172 | |||
| 667f20a7b3 | |||
| fef03c5b56 | |||
| 7bb31d4c09 | |||
| 7b5193674e | |||
| f6de82d712 | |||
| 437aab39b4 | |||
| e5d2711d71 | |||
| dd81eedcd9 | |||
| fc94326b0e | |||
| 40b5e781ce | |||
| 7315916fbc | |||
| e9f1073954 | |||
| 3c0ac65dc6 | |||
| 8631a698ce | |||
| 642a79f604 | |||
| e008c53966 | |||
| 8b19c9ab68 | |||
| 70c5718505 | |||
| 46bd07c792 | |||
| b6d514ee21 | |||
| 7bd8e47241 | |||
| 016039d1a3 | |||
| fc2b020423 | |||
| f4192be5d1 | |||
| 11da458883 | |||
| d66b3b9a0a | |||
| 2dcb14377a | |||
| 13e6762f0f | |||
| 325a5662f4 | |||
| 8b0cbe10ae | |||
| bd17e6e114 | |||
| 7cb12c52ce | |||
| 08481d35ce | |||
| 00869c6f5b | |||
| aa3462826b | |||
| dea358d40b | |||
| 367a338a72 | |||
| 2ce6622055 | |||
| 6408342a7f | |||
| 2d47cd9135 | |||
| 9727edf4df | |||
| e45232f395 | |||
| 82f3bcacfd | |||
| 7a834357ec | |||
| 40906a0697 | |||
| 16e4f8a1f2 | |||
| 2786de166d | |||
| 97a10353da | |||
| a288eb93ea | |||
| 285ffee863 | |||
| a0b3b7439d | |||
| a052bf20f1 | |||
| 7bb533c2fb | |||
| d7d6961261 | |||
| afcd15cde4 | |||
| 0b58286ca2 | |||
| f8b135e7a8 | |||
| d9d0beda3b | |||
| 007d3a12e8 | |||
| cd07e435d9 | |||
| 27f2abf8fb | |||
| 04d9dccd41 | |||
| c100892ad9 |
@@ -79,6 +79,8 @@ and a **dispatcher** for multi-node job execution.
|
||||
|
||||
### 2. Daemon Layer (`internal/daemon`)
|
||||
|
||||
> **⚠️ DEPRECATED in v0.9**: This section describes the v0.8 architecture, superseded by the v0.9 re-architecture. See the "v0.9 Architecture" section at the bottom of this file and `.ciagent/PRD_v0.9.md`.
|
||||
|
||||
- **Server**: `net/http` with `http.ServeMux` (no external router)
|
||||
- **TLS (P01)**: `crypto/tls` with `MinVersion=tls.VersionTLS13` and
|
||||
AEAD cipher allowlist
|
||||
@@ -93,6 +95,8 @@ and a **dispatcher** for multi-node job execution.
|
||||
|
||||
### 3. Transport Layer (`internal/transport`, NEW in P01/P02)
|
||||
|
||||
> **⚠️ DEPRECATED in v0.9**: This section describes the v0.8 architecture, superseded by the v0.9 re-architecture. See the "v0.9 Architecture" section at the bottom of this file and `.ciagent/PRD_v0.9.md`.
|
||||
|
||||
- **Client**: `http.Client` with `http.Transport.TLSClientConfig` populated
|
||||
from `internal/security.NewClientTLSConfig`
|
||||
- **Server**: `http.Server.TLSConfig` populated from
|
||||
@@ -108,6 +112,8 @@ and a **dispatcher** for multi-node job execution.
|
||||
|
||||
### 4. Core Engine (`internal/engine`)
|
||||
|
||||
> **⚠️ DEPRECATED in v0.9**: This section describes the v0.8 architecture, superseded by the v0.9 re-architecture. The Dispatcher and PeerRegistry peer-dispatch path is replaced by a CLI-side scheduler + SSH-push (R-001). See the "v0.9 Architecture" section at the bottom of this file and `.ciagent/PRD_v0.9.md`.
|
||||
|
||||
- **Node Registry**: In-memory map of node IDs → metadata, persisted to SQLite
|
||||
(CPU/memory capacity, available slots, last-seen)
|
||||
- **Task Executor**: `os/exec.CommandContext` with `WaitDelay` (Go 1.25+) for
|
||||
@@ -423,6 +429,8 @@ as a function that takes a `yield func(Job) bool` callback.
|
||||
|
||||
## Security Architecture
|
||||
|
||||
> **⚠️ DEPRECATED in v0.9**: This section describes the v0.8 internal-CA architecture, superseded by the v0.9 re-architecture (step-ca, D-101/REQ-076). See the "v0.9 Architecture" section at the bottom of this file and `.ciagent/PRD_v0.9.md`.
|
||||
|
||||
### Authentication
|
||||
- **v0.1**: mTLS for all API endpoints (self-signed CA)
|
||||
- **v0.2 P01**: Internal CA with CSR join (see Flow 1 + 2)
|
||||
@@ -449,6 +457,8 @@ as a function that takes a `yield func(Job) bool` callback.
|
||||
|
||||
## Key Architectural Decisions (v0.1 + v0.2)
|
||||
|
||||
> **⚠️ DEPRECATED in v0.9**: AD-007 (HCL canonical for jobspecs) below is superseded by R-013/R-014 (Markdown with YAML frontmatter canonical; HCL legacy). See the "v0.9 Architecture" section at the bottom of this file and `.ciagent/PRD_v0.9.md`.
|
||||
|
||||
| ID | Decision | Rationale |
|
||||
|----|----------|-----------|
|
||||
| AD-001 | Single binary with subcommands | Simpler distribution, aligns with simplicity pillar |
|
||||
@@ -638,3 +648,83 @@ heredoc).
|
||||
| AD-019 | `orca@pam` realm (not `orca@pve`) | SSH creates a Linux system user; PAM realm maps it to PVE RBAC without a separate PVE password. `@pve` requires interactive password prompt over non-PTY SSH (hangs). |
|
||||
| AD-020 | Exclude `pvesh` from sudoers; NOEXEC on `pct`/`qm` | `pvesh` can trigger API execute endpoint bypassing NOEXEC. `pct`/`qm` are Perl scripts via dynamically-linked perl → NOEXEC effective. `apt-get`/`dpkg` need exec for maintainer scripts → no NOEXEC. |
|
||||
| AD-021 | TOFU host-key via `knownhosts.New` | Avoids deprecated `ssh.InsecureIgnoreHostKey`. Capture-on-first-connect, verify-on-subsequent. Fail closed on mismatch (operator runs key-reset). |
|
||||
|
||||
---
|
||||
|
||||
# v0.9 Architecture (Supersedes v0.8)
|
||||
|
||||
> **⚠️ v0.9 DIRECTION CHANGE**: This section supersedes the v0.1–v0.8
|
||||
> architecture described above. The re-architecture is justified by a
|
||||
> six-part evidence basis recorded in `PROJECT.md` (Supersession Table).
|
||||
> The v0.8 sections above are retained for historical context but are
|
||||
> **deprecated**. The 16 load-bearing rules (R-001…R-016) in
|
||||
> `PRD_v0.9.md` are now the canonical invariants.
|
||||
|
||||
## Superseded Decisions (AD-series reversals)
|
||||
|
||||
| Old decision | Was | Superseded by | Evidence basis |
|
||||
|---|---|---|---|
|
||||
| AD-010 (line 463 above) | step-ca/cfssl/vault-pki "too heavyweight" | **D-101** (step-ca) | External PKI mandate (override ground 2) |
|
||||
| SPIFFE rejection (line 94, PROJECT.md) | internal CA chosen over SPIFFE | **D-068** (SPIFFE SVIDs) | Multi-tenancy requires per-workload identity (override ground 3) |
|
||||
| No-container-runtime (line 477 above) | explicit anti-pattern | **D-088** (5 runtimes; wasmtime primary) | WASM is the workload profile (override ground 4) |
|
||||
| No-multi-tenancy (line 478 above) | explicit anti-pattern | **D-158 / R-002** (multi-namespace) | Hard multi-tenant product req (override ground 3) |
|
||||
| AD-007 (HCL canonical) | HCL for jobspec | **R-013 / R-014** (Markdown canonical; HCL legacy) | PRD §8 operator-facing format |
|
||||
| Daemon-on-every-node | `orca daemon` on all peers | **R-001** (no orca binary on any server) | Daemon operationally failing + SSH-push only viable target (override grounds 1 + 5) |
|
||||
|
||||
## The Five-Layer CLI (v0.9)
|
||||
|
||||
The `orca` binary is one Go program, structured internally as five layers:
|
||||
|
||||
1. **CLI subcommand tree** (cobra) — `internal/cli/`
|
||||
2. **Jobspec + config parsers** — `internal/spec/` (Markdown frontmatter
|
||||
canonical, `.md`/`.yaml`/`.hcl` dispatcher per R-013/R-014)
|
||||
3. **Cluster-state store** — `internal/store/` + `internal/paths/`
|
||||
(per-namespace modernc/sqlite DBs + CLI-side `orca_cache` DB per R-002/R-008)
|
||||
4. **Server-side config emitters** — `internal/emitter/` (pure string
|
||||
templates → systemd units, Traefik YAML, sudoers, syncthing config;
|
||||
SCP via SSH per R-001)
|
||||
5. **Workflow orchestrators** — `internal/orch/` (compose SSH + local FS
|
||||
writes into multi-step commands)
|
||||
|
||||
## The Server Side (R-001 — no Orca binary on any server)
|
||||
|
||||
Servers hold only: rendered config in `/etc/orca/actual/<txn-id>/`,
|
||||
systemd units, Traefik dynamic config, sudoers, sshd_config snippets,
|
||||
`step-ca`/`traefik`/`syncthing`/`podman`/`wasmtime`/`age`/`auditd`
|
||||
(installed via apt), and bash scripts in `scripts/` (orca-pull.sh,
|
||||
orca-drift.sh, orca-collect.sh, orca-aggregate.sh, orca-apply-render.sh,
|
||||
orca-verify-render.sh, orca-rollback-render.sh, orca-cleanup-credentials.sh).
|
||||
Nothing on any server is "Orca software" — Orca is the CLI plus a tree of
|
||||
files.
|
||||
|
||||
## Multi-namespace Layout (R-002)
|
||||
|
||||
```
|
||||
$ORCA_HOME/
|
||||
├── cluster/ # cluster-wide (NOT a workload namespace)
|
||||
│ ├── ca.crt, ca.key # step-ca root (R-006, D-101)
|
||||
│ ├── master.key # AES-256-GCM root (R-011, mode 0600)
|
||||
│ ├── config.md # Markdown frontmatter (R-014)
|
||||
│ ├── peers/<host>/
|
||||
│ ├── pve/<endpoint>/
|
||||
│ ├── txns/{desired,applied,refused}/<txn-id>/
|
||||
│ ├── txn.sqlite
|
||||
│ └── state/
|
||||
├── _defaults/ # implicit root namespace (always exists)
|
||||
│ ├── ns.md
|
||||
│ ├── .env, .env.secrets
|
||||
│ ├── db/orca.db
|
||||
│ ├── jobs/, alloc/
|
||||
│ └── syncthing/
|
||||
├── <explicit-namespace>/ # operator-created
|
||||
└── orca_cache.db # CLI-side cache (R-008)
|
||||
```
|
||||
|
||||
## Execution gates (from GRILL_v0.9.md)
|
||||
|
||||
The 19 binding conditions (C-01..C-19) and 10 phase challenges
|
||||
(PC-01..PC-10) gate specific phases. See `GRILL_v0.9.md` for the full
|
||||
list. Key gates: C-01 (wasmtime/CGO before P07b), C-07 (CA migration
|
||||
spec before P14a), C-08 (SPIFFE mint spike before P02), C-09
|
||||
(orida-pull.sh failure contract before P10), C-19 (threat model before
|
||||
P15.5).
|
||||
|
||||
@@ -0,0 +1,60 @@
|
||||
# Phase 4 Audit — v0.8 Coverage & Trust Hardening (Final Phase)
|
||||
|
||||
**Milestone**: v0.8 — Coverage & Trust Hardening
|
||||
**Date**: 2026-08-04
|
||||
**Branch**: `phase/04-final-review-ship`
|
||||
**Result**: ✅ PASS (with P1 branch-hygiene finding — pre-existing, non-blocking for v0.8)
|
||||
|
||||
## Step 1 — Reconstruction Test ✅
|
||||
|
||||
- Latest `---ci---` block (HEAD of milestone/v0.8): `project: orca, phase: 3, milestone: v0.8, status: verify, requirements: covered: [REQ-060]` — matches CHECKPOINT.json (`phase: 2, stage: verify` — note: checkpoint is one phase behind because the P03 verify commit didn't update it to phase 3; the git log `---ci---` block is authoritative and correct).
|
||||
- config.json `milestone: v0.8` — matches.
|
||||
- `make verify-reqs` → `✓ 60 requirements consistent with roadmap` — ROADMAP ↔ REQUIREMENTS consistent.
|
||||
- All 35 v0.8 commits have `---ci---` blocks (100% commit discipline).
|
||||
|
||||
## Step 2 — .ciagent/ File Discipline ✅
|
||||
|
||||
- `config.json`: valid JSON, `milestone: v0.8`, `phase: 0` (stale — should be 3 post-P03; minor, will be corrected at milestone-complete), `milestone_type: nfr`, `active_projects: ["orca"]` — all required fields present.
|
||||
- `PROJECT.md`: has v0.8 scope summary + D-043..D-047 + the vision/constraints/decisions sections — complete.
|
||||
- `ROADMAP.md`: v0.8 milestone section present with 4 phases (P0-P4), phases P0-P3 marked `[x]` (shipped tags v0.7.0..v0.7.3), P4 pending — matches git branches + tags. v0.8 milestone header NOT yet marked COMPLETE (milestone ship step will add this).
|
||||
- `REQUIREMENTS.md`: REQ-057..060 present, status `Pending` (milestone ship step will mark `Complete`). All 56 prior REQs (REQ-001..056) `Complete`. Traceability matrix complete.
|
||||
- `ARCHITECTURE.md`: not updated for v0.8 (no new components — verify-reqs is a `cmd/` program, not an architecture component; the trust-surface changes refine existing proxmox/doctor/cli packages). Acceptable — v0.8 is NFR, no architecture changes.
|
||||
- `PERSONAS.md`: v0.8 roster at top (lead/backend/data active; frontend/security/cli-engineer deactivated with reasons), v0.7 baseline preserved — complete.
|
||||
- `RESEARCH_v0.8.md`, `PLAN_v0.8.md`, `GRILL_v0.8.md`, `REVIEW_v0.8.md`, `PHASE1..3_VERIFICATION_v0.8.md` — all present.
|
||||
|
||||
## Step 3 — Branch Hygiene ⚠️ P1 (pre-existing, non-blocking)
|
||||
|
||||
**Stale merged local branches** (should have been deleted by prior ship workflows — v0.6 + v0.7 milestones):
|
||||
- `milestone/v0.6-node-bootstrap-proxmox` (merged to main via v0.6 ship)
|
||||
- `milestone/v0.7-hardening-completion` (merged to main via v0.7 ship)
|
||||
- `phase/01-cert-register`, `phase/02-config-parser`, `phase/03-coverage-uplift`, `phase/04-pprof-daemon`, `phase/05-final-review-ship` (all v0.7 phase branches, merged to v0.7 milestone)
|
||||
|
||||
**Stale remote branches** (same set + older v0.6-era branches): `origin/milestone/v0.6-*`, `origin/milestone/v0.7-*`, `origin/phase/01-init-bootstrap`, `origin/phase/02-proxmox-join`, `origin/phase/03-doctor-extensions`, `origin/phase/04-final-review-ship`, etc.
|
||||
|
||||
**v0.8 branches** (`phase/01-coverage-round2`, `phase/02-ssh-trust-hardening`, `phase/03-requirements-hygiene-gate`, `phase/04-final-review-ship`, `milestone/v0.8-coverage-trust-hardening`) are all active or just-merged — NOT stale.
|
||||
|
||||
**Finding**: The ship workflow's branch-cleanup step (audit.md:46-49 "Step 6.5") is not running for prior milestones. This is a P1 process gap (recurring across v0.6 + v0.7) but does NOT block v0.8 ship. **Recommendation**: after v0.8 milestone ship, delete the stale v0.6/v0.7 local + remote branches (tags preserve the history). Defer to post-ship cleanup; do NOT block the milestone release.
|
||||
|
||||
## Step 4 — Commit Discipline ✅
|
||||
|
||||
- All 35 v0.8 commits have `---ci---` blocks (100%).
|
||||
- No stale decisions: D-043..D-047 are all reflected in code (T02.3 flag per D-044, T02.5 callback per D-045, T02.8 local-only per D-046, T01.6 tiered floor per D-047, T02.6 bugfix per D-043 chore classification).
|
||||
- No unresolved escalations (the only escalation was P0's `release_pending` from GITEA_TOKEN unset — auto-resolved, local-only fallback, pipeline not halted).
|
||||
- All 4 GRILL binding conditions satisfied (verified in REVIEW_v0.8.md).
|
||||
|
||||
## Step 5 — Run Audit Checks ✅
|
||||
|
||||
- `go build ./...` PASS
|
||||
- `go vet ./...` PASS
|
||||
- `go test ./...` PASS (16 packages)
|
||||
- `make verify-reqs` PASS (60 consistent)
|
||||
- `make build` PASS
|
||||
- `gofmt -l .` clean
|
||||
|
||||
## Overall Verdict
|
||||
|
||||
✅ **PASS** — v0.8 is shippable. The P1 branch-hygiene finding (stale v0.6/v0.7 branches) is pre-existing, non-blocking, and recommended for post-ship cleanup. The checkpoint phase-staleness (config.json `phase: 0` vs actual phase 3) is a minor bookkeeping gap corrected at milestone-complete.
|
||||
|
||||
## Recommendation
|
||||
|
||||
Proceed to milestone ship: mark REQ-057..060 `Complete` in REQUIREMENTS.md, mark v0.8 `COMPLETE` in ROADMAP.md, update config.json `phase: 4`, merge `phase/04-final-review-ship` → `milestone/v0.8` → `main`, tag `v0.7.4` (= milestone release), push, then delete stale v0.6/v0.7 branches as post-ship cleanup.
|
||||
@@ -0,0 +1,32 @@
|
||||
# Bash Capability Map — v0.9 (grill C-18)
|
||||
|
||||
Maps every capability in the shipped `internal/transport` package to its
|
||||
bash-side equivalent (or accepted drop with recorded rationale) in the v0.9
|
||||
re-architecture. The grill (C-18) required this mapping so capability
|
||||
regressions are visible, not silent.
|
||||
|
||||
| Shipped capability (internal/transport) | Bash-side equivalent | Status | Rationale |
|
||||
|---|---|---|---|
|
||||
| Retry with exponential backoff (`retry.go`: 100ms start, ×2, cap 5s, max 5 attempts) | `orca-retry()` function in `scripts/lib/orca-retry.sh` (to be written in v0.9-P01 SSH-push transport phase, REQ-073) | **planned** (v0.9-P01) | SSH dial/exec failures need the same bounded retry. The pattern is transport-agnostic; the Go retry logic is extracted into the new `internal/sshpush/` package and a bash-side helper mirrors it for the lead-applier scripts. |
|
||||
| Idempotency keys (`idempotency.go`: in-memory `sync.Map` of keys, `X-Orca-Idempotency-Key` header) | Content-addressed filenames — skip SCP if the target hash already exists on the peer | **planned** (v0.9-P01) | SSH-push doesn't have HTTP headers; idempotency is achieved by content-addressing the rendered file (`<hash>.unit`) and skipping if the peer already has it. The bash applier checks `test -f /run/orca/<hash>` before applying. |
|
||||
| Structured mTLS failure logging (`handshake_log.go`: slog JSON per mTLS failure) | `orca_log_error` via `scripts/lib/orca-log.sh` (C-17, shipped in this phase P00) | **dropped (mTLS removed by R-001)** | The v0.9 re-architecture removes mTLS daemon-to-daemon transport entirely (R-001). SSH failures are logged via the new `orca_log_*` functions which emit the same slog-compatible JSON field set (ts, level, actor, action, resource, result, error) to syslog. The mTLS-specific handshake-log fields (cipher suite, TLS version, cert SAN) have no SSH equivalent and are dropped — the SSH error message is captured in the `error` field instead. |
|
||||
| TLS 1.3 + AEAD cipher allowlist (`mtls.go`: MinVersion=tls.VersionTLS13, CipherSuites limited) | SSH's own cipher config (`/etc/ssh/sshd_config` `Ciphers`, `MACs`, `KexAlgorithms`) managed by the operator | **dropped (transport replaced)** | R-001 replaces mTLS HTTP with SSH. SSH's transport security is governed by the peer's sshd_config, not the orca binary. The CLI's SSH client (`golang.org/x/crypto/ssh`, already a dep) uses Go's default modern SSH cipher set. The PRD does not require orca to manage sshd_config cipher policy in v0.9. |
|
||||
| mTLS client/server handshake (`mtls.go`: `MTLSClient`, daemon-side `SubmitHandler`) | `ssh.Dial` + `ssh.PublicKeys` auth (CLI-side `internal/sshpush/`, REQ-073) | **replaced** (v0.9-P01) | The daemon-to-daemon mTLS handshake is replaced by CLI-to-server SSH. The CLI holds an Ed25519 key (`cluster/orca_ssh_key`, D-037) and authenticates to each peer's sshd. TOFU host-key handling (`proxmox.TOFUHostKeyCallback`, v0.8 REQ-058) is reused for all peers, not just Proxmox. |
|
||||
|
||||
## Net-new capabilities in v0.9 (no shipped equivalent)
|
||||
|
||||
| Net-new capability | Bash-side | Status |
|
||||
|---|---|---|
|
||||
| Transaction bundle apply (R-010, REQ-075) | `orca-apply-render.sh` (v0.10-P10) | planned |
|
||||
| Drift detection (R-010) | `orca-drift.sh` (v0.10-P10) | planned |
|
||||
| Per-node state collection | `orca-collect.sh` (v0.10-P09) | planned |
|
||||
| Lead aggregation | `orca-aggregate.sh` (v0.10-P09) | planned |
|
||||
| Credential cleanup (5-min shred) | `orca-cleanup-credentials.sh` (v0.10) | planned |
|
||||
| Render-bundle validation (C-16) | `orca-verify-render.sh` (shipped this phase P00) | ✅ shipped |
|
||||
| Structured logging (C-17) | `orca-log.sh` (shipped this phase P00) | ✅ shipped |
|
||||
|
||||
## Review cadence
|
||||
|
||||
This map is reviewed at each phase that introduces or modifies a bash
|
||||
script. The security-engineer persona reviews the SSH trust surface; the
|
||||
devops-engineer persona reviews the bash tooling gate (C-15..C-18).
|
||||
@@ -0,0 +1,109 @@
|
||||
# CA Migration Spec — v0.8 Internal CA → v0.9 step-ca (grill C-07)
|
||||
|
||||
**Status**: spec (must be implemented in v0.10-P14a, REQ-066)
|
||||
**Gate**: C-07 — blocks v0.10-P14a until this spec is reviewed and a dry-run passes on a test cluster
|
||||
|
||||
## Problem
|
||||
|
||||
The v0.8 internal Go CA (`internal/security/ca.go`) issues RSA-3072 CA
|
||||
certs (10-year validity) and ECDSA P-256 server certs (90-day). The CA
|
||||
material lives at `~/.orca/ca.crt` and `~/.orca/ca.key` (flat layout, D-011).
|
||||
The v0.9 re-architecture reverses AD-010 and replaces the internal CA with
|
||||
step-ca (D-101, REQ-076). Existing v0.8 deployments have an internal CA
|
||||
root + issued server certs that must be migrated without invalidating
|
||||
trust across the cluster.
|
||||
|
||||
## Migration options (decision required before v0.10-P14a implementation)
|
||||
|
||||
### Option A — Preserve trust root (RECOMMENDED)
|
||||
|
||||
Import the existing `ca.key` into step-ca as the root CA key. The cluster's
|
||||
trust fingerprint stays unchanged; existing server certs continue to
|
||||
validate until their natural expiry; new SVIDs are minted by step-ca using
|
||||
the same root.
|
||||
|
||||
```bash
|
||||
orca upgrade --to-v1.0 --import-ca
|
||||
# reads ~/.orca/ca.key → step ca init --deployment-type standalone \
|
||||
# --remote-management --key $(cat ~/.orca/ca.key)
|
||||
# issues new SVIDs from step-ca for all existing workloads
|
||||
```
|
||||
|
||||
**Pros**: zero trust breakage; existing server certs keep working; minimal
|
||||
operator disruption.
|
||||
**Cons**: requires step-ca to accept an imported RSA-3072 key (step-ca
|
||||
supports imported keys via `--key` flag; verify in the spike).
|
||||
**Post-migration**: old `internal/security/ca.go` and `csr.go` are deleted
|
||||
(v0.10-P14); the `cert_repo` SQLite table (0004) is dropped (step-ca
|
||||
manages cert state).
|
||||
|
||||
### Option B — Forced re-bootstrap
|
||||
|
||||
Document that v0.8 certs are invalidated; every cluster re-bootstraps under
|
||||
step-ca with a new root. Existing workloads are re-enrolled.
|
||||
|
||||
**Pros**: clean slate; no legacy RSA root.
|
||||
**Cons**: trust breakage — every peer's `known_hosts` + CA cert must be
|
||||
rotated; running workloads lose mTLS until re-enrolled; higher operator
|
||||
disruption.
|
||||
**Use case**: only if Option A is technically infeasible (step-ca rejects
|
||||
the v0.8 key format).
|
||||
|
||||
## Pre-flight checks (must pass before migration)
|
||||
|
||||
1. `orca doctor` reports zero FAILs on the v0.8 cluster
|
||||
2. All peers reachable via SSH
|
||||
3. No in-flight transactions (the migration is stop-the-world for the CA)
|
||||
4. Snapshot taken (`orca backup --include-master-key`)
|
||||
5. step-ca installed on the lead via `apt-get install step-ca`
|
||||
6. `step ca init` dry-run succeeds with the imported key
|
||||
|
||||
## Migration steps (Option A)
|
||||
|
||||
1. SSH to the lead; install step-ca via apt
|
||||
2. Run `step ca init --deployment-type standalone --remote-management \
|
||||
--key <v0.8-ca-key-path> --provisioner orca-admin`
|
||||
3. Move the root cert: `cp ~/.orca/ca.crt $ORCA_HOME/cluster/ca.crt`
|
||||
4. Issue new SVIDs for every registered workload (via `step ca token` +
|
||||
`step ca certificate` — the CLI mints the provisioner token using
|
||||
`cluster/master.key`-derived material)
|
||||
5. Deploy the new SVIDs to peers via SSH-push (the v0.9 SSH-push transport)
|
||||
6. Verify: `orca doctor` reports zero FAILs; CA fingerprint unchanged;
|
||||
all workload SVIDs valid
|
||||
7. Archive the old `internal/security/ca.go`/`csr.go` and `cert_repo` table
|
||||
|
||||
## Rollback
|
||||
|
||||
If any post-migration invariant fails:
|
||||
1. Restore the v0.8 snapshot via `orca upgrade --rollback <tarball>`
|
||||
2. Restart the v0.8 orca daemon on the lead
|
||||
3. Verify `orca doctor` passes on the v0.8 cluster
|
||||
|
||||
The v0.8 internal CA remains functional during the dual-write window
|
||||
(REQ-090); step-ca is additive until the migration completes.
|
||||
|
||||
## Post-migration invariants (must all pass)
|
||||
|
||||
- CA fingerprint unchanged (Option A)
|
||||
- Node count unchanged
|
||||
- Workload count unchanged
|
||||
- All SVIDs valid (mTLS handshake succeeds lead↔every peer)
|
||||
- `orca doctor` zero FAILs
|
||||
- No `internal/security/ca.go` or `cert_repo` references remain in code
|
||||
|
||||
## Decision required
|
||||
|
||||
This spec is gated by C-07. The decision (Option A vs B) must be made
|
||||
before v0.10-P14a implementation. Default: Option A (preserve trust root)
|
||||
unless the step-ca imported-key spike fails.
|
||||
|
||||
## Spike (must run before v0.10-P14a)
|
||||
|
||||
Run on a test cluster:
|
||||
1. Install step-ca on a clean Linux host
|
||||
2. Generate a v0.8-style RSA-3072 CA key via the v0.8 `internal/security` package
|
||||
3. Run `step ca init --key <v8-key>` and verify step-ca accepts it
|
||||
4. Mint a test SVID via `step ca token` + `step ca certificate`
|
||||
5. Verify the SVID validates against the imported root
|
||||
|
||||
If the spike fails, fall back to Option B (forced re-bootstrap) and document.
|
||||
@@ -1,11 +1 @@
|
||||
{
|
||||
"phase": 0,
|
||||
"stage": "plan",
|
||||
"milestone": "v0.7",
|
||||
"milestone_slug": "hardening-completion",
|
||||
"phase_role": "pre_execution",
|
||||
"attempts": 0,
|
||||
"updated_at": "2026-08-03T20:55:00Z",
|
||||
"milestone_complete": false,
|
||||
"next_milestone": null
|
||||
}
|
||||
{ "phase": "P02", "stage": "verify", "milestone": "v0.9", "phase_role": "execution", "updated_at": "2026-08-05T03:55:00Z", "milestone_complete": false, "gates_cleared_this_phase": ["C-10"], "verify": { "build": "pass", "go_test": "22/22", "bats": "20/20", "gofmt": "clean", "verify_reqs": "90 consistent" } }
|
||||
|
||||
@@ -0,0 +1,592 @@
|
||||
# Grill Report: Orca v0.8 — Coverage & Trust Hardening
|
||||
|
||||
**Date:** 2026-08-04
|
||||
**Reviewer:** ci-griller (red-team, adversarial)
|
||||
**Plan under review:** `.ciagent/PLAN_v0.8.md` (commit 4780e4d)
|
||||
**Branch:** `phase/00-specify` (milestone `milestone/v0.8-coverage-trust-hardening`)
|
||||
**Mode:** Full autonomy
|
||||
|
||||
---
|
||||
|
||||
## Methodology
|
||||
|
||||
Every material claim in `PLAN_v0.8.md` and `RESEARCH_v0.8.md` was cross-checked
|
||||
against the actual codebase (verified coverage baselines via `go test -cover`,
|
||||
read `internal/proxmox/bootstrap.go:75-234`, `internal/security/ca.go`,
|
||||
`internal/doctor/doctor.go`, `.ciagent/ROADMAP.md`, `.ciagent/REQUIREMENTS.md`,
|
||||
PERSONAS, ARCHITECTURE) AND the `golang.org/x/crypto` v0.54.0 source for
|
||||
`knownhosts.New` / `checkAddr` behavior. The TOFU-capture claim was not taken
|
||||
on faith — the upstream `checkAddr` (knownhosts.go:370-385) was read directly.
|
||||
|
||||
Findings are scored on the 9 axes. Binding verdicts are **PROCEED**,
|
||||
**PROCEED-WITH-CONDITION** (plan proceeds but must incorporate a named change),
|
||||
or **REPLAN** (axis has a fatal flaw; revise before execution).
|
||||
|
||||
---
|
||||
|
||||
## Summary Verdict
|
||||
|
||||
| Verdict | Count |
|
||||
|---------|-------|
|
||||
| PROCEED | 7 |
|
||||
| PROCEED-WITH-CONDITION | 4 |
|
||||
| REPLAN | 0 |
|
||||
|
||||
**Overall verdict: PROCEED-WITH-CONDITION**
|
||||
|
||||
The v0.8 plan is fundamentally sound: scope is right-sized, the no-new-deps
|
||||
promise holds (verified `ssh.FingerprintSHA256` + `knownhosts.Line` are in the
|
||||
existing `golang.org/x/crypto` v0.54.0 dep), the tiered coverage floor (D-047)
|
||||
is realistic per-package with the named seams, and the persona territory
|
||||
collision on `internal/cli/node.go` is explicitly adjudicated in PERSONAS.md
|
||||
(backend owns implementation, lead owns `_test.go`). The 4 conditions below are
|
||||
**targeted correctness fixes**, not scope expansions:
|
||||
|
||||
1. **P02 must add a regression test asserting first-connect Proxmox join
|
||||
succeeds end-to-end** (the latent TOFU bug means v0.6's first-connect has
|
||||
been broken since ship; the fix in T02.6 is correct but must be proven by a
|
||||
test that would have failed pre-fix).
|
||||
2. **P03's verify-reqs regex must match `**COMPLETE**` as a *substring* within
|
||||
the bold span** (v0.2's header `**COMPLETE (merged to main via v0.3)**` is
|
||||
not matched by the current `\*\*COMPLETE\*\*` literal — a silent blind spot).
|
||||
3. **P03 must add a second assertion: every REQUIREMENTS row marked `Complete`
|
||||
must reference a milestone ROADMAP marks COMPLETE** (the reverse direction).
|
||||
The v0.7 `cert_repo_test.go` omission (REQ-053 marked Complete but the test
|
||||
file does not exist) proves forward-direction-only checks miss the most
|
||||
dangerous drift class: *claimed-Complete-but-actually-incomplete*.
|
||||
4. **P02 T02.6's TOFU fix must be reviewed against `doctor proxmox`'s callback
|
||||
(T02.9) as a paired change, not a follow-on** — they share the exact
|
||||
`knownhosts.New` defect; fixing one and not the other in the same phase
|
||||
creates an inconsistent trust surface.
|
||||
|
||||
With these 4 conditions applied, this plan is ready to execute. No REPLAN.
|
||||
|
||||
---
|
||||
|
||||
## Per-Axis Findings
|
||||
|
||||
### Axis 1 — Business Case
|
||||
|
||||
#### A1-F1 — Is v0.8 the right next milestone, or polish-for-polish's-sake?
|
||||
|
||||
**Evidence:**
|
||||
- v0.7 P03 (REQ-055) shipped a ≥50% coverage floor; v0.8 re-baselines six
|
||||
packages still under 50% (engine 8.3%, proxmox 5.1%, cli 27.6%, transport
|
||||
26.3%, store 47.2%, jobspec 47.6%) — **verified identical via `go test
|
||||
-cover`**.
|
||||
- RESEARCH §2.1 surfaces a **latent v0.6 defect**: `knownhosts.New` returns
|
||||
`KeyError{Want:[]}` on first connect and does NOT auto-write. Verified
|
||||
directly in `golang.org/x/crypto@v0.54.0/ssh/knownhosts/knownhosts.go:370-385`
|
||||
(`checkAddr` returns `&KeyError{}` with empty `Want` when no line matches).
|
||||
`bootstrap.go:140-142` treats this as a dial failure. **This means
|
||||
first-connect `orca node join --type proxmox` has been broken since v0.6
|
||||
shipped** (the v0.6 RESEARCH §A.5 claim that `knownhosts.New` "handles both
|
||||
capture and verify" was wrong).
|
||||
- `bootstrap.go:123` comment is literally false: "on first connect it captures
|
||||
the host key" — it does not.
|
||||
|
||||
**Confidence:** 0.90 that v0.8 is the right next milestone.
|
||||
**Verdict:** **PROCEED**. v0.8 is not polish-for-polish: it closes a real
|
||||
security defect (TOFU broken since v0.6), populates a `Result` field that D-045
|
||||
*assumed* was already populated (it isn't — `bootstrap.go:195-198`), and lifts
|
||||
coverage off floors that v0.7 explicitly under-shot. The diminishing-returns
|
||||
risk is real for the 3 zero-test toe-holds (audit/certpaths/cmd-orca), but
|
||||
D-047 tiered them to 50% precisely to avoid the rathole — that call is sound.
|
||||
|
||||
---
|
||||
|
||||
### Axis 2 — Scope and Requirements
|
||||
|
||||
#### A2-F1 — Is the TOFU bugfix correctly scoped into P02, or should it be a hotfix on main?
|
||||
|
||||
**Evidence:**
|
||||
- The TOFU capture bug (RESEARCH §2.1, PLAN T02.6) is a v0.6 latent defect,
|
||||
not a v0.8 feature. First-connect Proxmox join is broken **today on main**.
|
||||
- PLAN bundles the fix into P02 (trust hardening phase) alongside REQ-058
|
||||
(`--host-key-fingerprint`) and REQ-059 (`key-reset`).
|
||||
- ROADMAP tags run on the v0.7.x patch line: `v0.7.0` (P0) … `v0.7.4` (P04).
|
||||
P02 ships as `v0.7.2` — i.e., the fix lands on a milestone branch, not main,
|
||||
and only reaches main at P04 merge (`v0.7.4`).
|
||||
|
||||
**Confidence:** 0.62 that bundling into P02 is the right call (low confidence —
|
||||
this is a judgment call with real downside).
|
||||
**Verdict:** **PROCEED-WITH-CONDITION.** The fix is correctly designed (T02.6's
|
||||
`KeyError{Want:[]}` capture-and-persist is the right shape), but the plan must
|
||||
either (a) document explicitly *why* this isn't hotfixed on main (e.g., "no
|
||||
operator has hit first-connect yet because all deployments pre-populate
|
||||
`known_hosts` manually — confirmed by the v0.6 ship audit"), OR (b) flag the
|
||||
bug in the P04 audit as a v0.6 ship-defect with a post-mortem note. **The plan
|
||||
currently treats T02.6 as a feature task; it is a bugfix for shipped code and
|
||||
must be labeled as such** so the P04 audit can distinguish "new hardening" from
|
||||
"closing a v0.6 gap." Blast radius if T02.6's fix is wrong: every existing
|
||||
Proxmox node's `known_hosts` could be re-pinned on next join — moderate, but
|
||||
mitigated by T02.10 case 3/4/5 integration tests.
|
||||
|
||||
**Condition:** Add a note to T02.6 in PLAN marking it as a **v0.6 ship-defect
|
||||
bugfix** (not a v0.8 feature), and ensure P04 audit (T04.2) records it as such.
|
||||
|
||||
#### A2-F2 — Are the 3 zero-test packages worth a 50% toe-hold, or scope creep?
|
||||
|
||||
**Evidence:**
|
||||
- `cmd/orca` is 15 LOC of glue (`main()` → `cli.Execute()`). 50% coverage = ~7
|
||||
lines. RESEARCH §1.1, §5 pitfall #6 explicitly flags the effort:coverage
|
||||
ratio as poor.
|
||||
- `internal/certpaths` is 64 LOC of pure path-join functions. 50% is trivial.
|
||||
- `internal/audit` is 125 LOC, 4 exported funcs. 50% is trivial.
|
||||
- D-047 explicitly tiered these to 50% to avoid a coverage rathole; v0.9 can
|
||||
raise the floor.
|
||||
|
||||
**Confidence:** 0.85.
|
||||
**Verdict:** **PROCEED.** The tiered floor is the right call. The
|
||||
`cmd/orca` toe-hold is low-value but low-cost (one `run() int` refactor + one
|
||||
smoke test), and dropping it would leave a `covdata` tooling error in CI output
|
||||
that looks like a broken build to a casual reader. Keeping it at 50% is
|
||||
defensible.
|
||||
|
||||
#### A2-F3 — Scope size: 4 REQs, 37 tasks — too lean, too fat, or right?
|
||||
|
||||
**Evidence:**
|
||||
- 37 tasks, 36 must-haves, 4 phases each shipping a patch. Comparable to v0.7
|
||||
(5 phases, similar task density).
|
||||
- P01 is the heaviest (12 tasks, 9 packages) — the risk concentration is here.
|
||||
|
||||
**Confidence:** 0.80.
|
||||
**Verdict:** **PROCEED.** Right-sized for an NFR milestone. P01 density is the
|
||||
watch item (see Axis 5).
|
||||
|
||||
---
|
||||
|
||||
### Axis 3 — Architecture and Technical Feasibility
|
||||
|
||||
#### A3-F1 — Do the proxmox `sessionRunner` and engine `peerDispatcher` seams leak test concerns into production?
|
||||
|
||||
**Evidence:**
|
||||
- T01.1 `sessionRunner` (`internal/proxmox/bootstrap.go`): 1 interface,
|
||||
~10 LOC, `CombinedOutput(cmd) ([]byte, error)`. Default impl wraps
|
||||
`*ssh.Client.NewSession().CombinedOutput(...)`. Backward compatible —
|
||||
existing callers unchanged. This is the **same pattern as the existing
|
||||
`sshDialer` seam** (`bootstrap.go:201-213`), which shipped in v0.6 without
|
||||
concern. The seam is a standard testability extraction, not a test concern
|
||||
leak.
|
||||
- T01.2 `peerDispatcher` (`internal/engine/dispatcher.go`): **conditional** —
|
||||
only added if T01.4 cannot hit 70% via `httptest.NewTLSServer` alone. Plan
|
||||
explicitly prefers `httptest.NewTLSServer` (RESEARCH §1.3 gap #2, §5 pitfall
|
||||
#8). This is the right ordering: try the stdlib test fixture first, add the
|
||||
seam only if needed.
|
||||
|
||||
**Confidence:** 0.88.
|
||||
**Verdict:** **PROCEED.** Both seams are backward-compatible interface
|
||||
extractions matching an existing pattern (`sshDialer`). No test-concern leak.
|
||||
The conditional-gate on T01.2 is correctly conservative.
|
||||
|
||||
#### A3-F2 — Does P02's trust work stay within the existing security boundary?
|
||||
|
||||
**Evidence:**
|
||||
- P02 touches `internal/proxmox/bootstrap.go` (pinned callback, TOFU fix),
|
||||
`internal/cli/node.go` (flag + subcommand), `internal/security/sshkey.go`
|
||||
(fingerprint helper), `internal/doctor/doctor.go` (T02.9 TOFU fix). All
|
||||
within the existing SSH trust surface established in v0.6.
|
||||
- No new crypto, no new CA, no new X.509. `ssh.FingerprintSHA256` is in the
|
||||
existing `golang.org/x/crypto` v0.54.0 dep (verified: not a new direct dep).
|
||||
- PERSONAS correctly keeps `security-engineer` deactivated — the work is SSH
|
||||
dialer + known_hosts file manipulation, not new security architecture.
|
||||
|
||||
**Confidence:** 0.90.
|
||||
**Verdict:** **PROCEED.** Boundary is respected.
|
||||
|
||||
#### A3-F3 — T02.9 (doctor proxmox TOFU fix) is a paired change with T02.6, not a follow-on
|
||||
|
||||
**Evidence:**
|
||||
- `internal/doctor/doctor.go:412` uses the **exact same** `knownhosts.New(...)`
|
||||
callback pattern as `bootstrap.go:125`. Both share the latent defect.
|
||||
- T02.9 is listed as a separate task ("Apply the TOFU capture-fix to `doctor
|
||||
proxmox` probe") but is in the same Wave 2 as T02.6. If T02.6 lands and T02.9
|
||||
doesn't (e.g., a mid-phase blocker), the trust surface is **inconsistent**:
|
||||
join captures, doctor fails.
|
||||
|
||||
**Confidence:** 0.75.
|
||||
**Verdict:** **PROCEED-WITH-CONDITION.** T02.6 and T02.9 must be reviewed as a
|
||||
paired change in P02 verification — the phase is not done until BOTH callbacks
|
||||
use the capture-fix wrapper. Add to P02 Verification: "doctor proxmox
|
||||
first-connect → captures + succeeds (mirrors T02.10 case 3 for bootstrap)."
|
||||
|
||||
**Condition:** Add a P02 verification line asserting doctor proxmox
|
||||
first-connect parity with bootstrap.
|
||||
|
||||
---
|
||||
|
||||
### Axis 4 — People, Skills, and Organization
|
||||
|
||||
#### A4-F1 — Territory collision on `internal/cli/node.go`
|
||||
|
||||
**Evidence:**
|
||||
- PERSONAS.md line 62: lead-developer territory = `internal/cli/**`.
|
||||
- PERSONAS.md line 70: backend-engineer territory = `internal/cli/node.go`.
|
||||
- PERSONAS.md line 107 explicitly adjudicates: "backend owns the command
|
||||
implementation; lead owns the test files (`node_test.go`)."
|
||||
- Territory mode is `warn` (not `block`) — collisions log but don't fail.
|
||||
|
||||
**Confidence:** 0.82.
|
||||
**Verdict:** **PROCEED.** The collision is **explicitly adjudicated** in
|
||||
PERSONAS.md with a clean boundary (impl vs test files). This is the right
|
||||
answer. The `warn` mode means a backend commit touching `node_test.go` (or a
|
||||
lead commit touching `node.go` impl) would log — acceptable for a 3-persona
|
||||
team. No replan.
|
||||
|
||||
#### A4-F2 — Key-person dependency: is the 3-persona roster sufficient?
|
||||
|
||||
**Evidence:**
|
||||
- 3 active personas, all retained from v0.7. No phase-specific personas.
|
||||
- backend-engineer owns 60%+ of P02 (the security-critical phase). If
|
||||
backend-engineer is unavailable, P02 stalls entirely.
|
||||
|
||||
**Confidence:** 0.70.
|
||||
**Verdict:** **PROCEED.** Key-person risk is real but inherent to a 3-persona
|
||||
NFR milestone. The work is not novel (refining existing surface), so the bus
|
||||
factor is acceptable for hardening. Flagged, not blocking.
|
||||
|
||||
---
|
||||
|
||||
### Axis 5 — Timeline and Estimates
|
||||
|
||||
#### A5-F1 — Is the 70% coverage target for 6 packages in one phase (P01) realistic?
|
||||
|
||||
**Evidence:**
|
||||
- RESEARCH §1.1 + §1.4 per-package achievability assessments:
|
||||
- engine → 70% REALISTIC (with LocalExecutor stubs + `openTestDB`).
|
||||
- proxmox → 70% REALISTIC **but requires the `sessionRunner` seam (T01.1)** —
|
||||
without it, only 50-55% (validation paths + sudoersContent asserts, already
|
||||
done).
|
||||
- cli → 70% AMBITIOUS (17 files, ~2000 LOC); RESEARCH says "55-65% is more
|
||||
realistic for one phase" even with `daemon.go` excluded.
|
||||
- transport → 70% REALISTIC (`httptest.NewTLSServer` is standard).
|
||||
- store → 70% REALISTIC (cert_repo_test.go gap is the main lift).
|
||||
- jobspec → 70% REALISTIC (easiest of the six).
|
||||
- **`internal/cli` is the swing package.** RESEARCH explicitly says 55-65% is
|
||||
the realistic single-phase outcome, not 70%. The plan sets the floor at 70%
|
||||
"excluding daemon.go" — but even excluding daemon.go, RESEARCH's own evidence
|
||||
says 70% is a stretch.
|
||||
|
||||
**Confidence:** 0.65 (split: 5 of 6 packages at 0.85, cli at 0.45).
|
||||
**Verdict:** **PROCEED-WITH-CONDITION.** The plan must add an explicit fallback
|
||||
for `internal/cli`: if T01.6 hits ≥65% (excluding daemon.go) but not 70% after
|
||||
a reasonable effort, the phase ships at 65% with a documented note + a v0.9
|
||||
follow-up to lift to 70%. **Hard-requiring 70% on cli risks a coverage rathole
|
||||
that delays the entire milestone** (P02/P03 are gated on P01 ship). The other 5
|
||||
packages at 70% is realistic.
|
||||
|
||||
**Condition:** Add to T01.6 acceptance criterion: "If ≥65% (excluding
|
||||
daemon.go) is achieved but 70% is not after Wave 2 effort, document the gap in
|
||||
the task comment + record a v0.9 follow-up; ship at 65%. Do NOT block P02/P03
|
||||
on the last 5% of cli coverage." (This mirrors RESEARCH §1.4's own flag, which
|
||||
the plan currently does not carry forward as an escape valve.)
|
||||
|
||||
---
|
||||
|
||||
### Axis 6 — Budget and Financial Realism
|
||||
|
||||
#### A6-F1 — Zero new deps: is that realistic given P02's needs?
|
||||
|
||||
**Evidence:**
|
||||
- `ssh.FingerprintSHA256`: verified in `golang.org/x/crypto/ssh` (direct dep
|
||||
since v0.6 D-030).
|
||||
- `knownhosts.Line` / `Normalize` / `KeyError`: same `golang.org/x/crypto`
|
||||
module (already imported in `bootstrap.go:32` and `doctor.go:29`).
|
||||
- `verify-reqs`: stdlib only (`regexp`, `os`, `fmt`).
|
||||
- `go.mod` unchanged by v0.8 (PLAN line 62).
|
||||
|
||||
**Confidence:** 0.95.
|
||||
**Verdict:** **PROCEED.** Zero-new-deps is verified and realistic.
|
||||
|
||||
---
|
||||
|
||||
### Axis 7 — Risks, Assumptions, and Dependencies
|
||||
|
||||
#### A7-F1 — The 10 pitfalls: are mitigations real or hand-waves?
|
||||
|
||||
**Evidence (spot-check of the 4 most material pitfalls):**
|
||||
- **Pitfall #1 (TOFU broken):** Mitigation T02.6 is **concrete and correct** —
|
||||
wrap `knownhosts.New`, capture on `KeyError{Want:[]}` via `knownhosts.Line` +
|
||||
`security.WriteAtomic`, return nil. Verified against x/crypto v0.54.0
|
||||
`checkAddr` semantics. **Real mitigation.**
|
||||
- **Pitfall #2 (Result.HostKeyFingerprint never populated):** T02.7 adds
|
||||
`ssh.FingerprintSHA256(hostKey)`. 1-line once host key is available. **Real.**
|
||||
- **Pitfall #3 (no sessionRunner seam):** T01.1 adds it, ~10 LOC. **Real.**
|
||||
- **Pitfall #10 (writeAtomic unexported):** T02.2 exports it. Verified
|
||||
`ca.go:305` — `func writeAtomic(...)` is indeed unexported. **Real.**
|
||||
|
||||
**Confidence:** 0.88.
|
||||
**Verdict:** **PROCEED.** Mitigations are concrete, not hand-waves.
|
||||
|
||||
#### A7-F2 — TOFI bugfix blast radius if P02's fix is wrong
|
||||
|
||||
**Evidence:**
|
||||
- T02.6 changes the `HostKeyCallback` for every `orca node join --type proxmox`
|
||||
+ every `doctor proxmox` probe. If the capture-and-persist logic is wrong,
|
||||
every existing Proxmox node's `known_hosts` could be corrupted (e.g.,
|
||||
duplicate entries, wrong-format lines, partial writes on crash).
|
||||
- Mitigations: T02.10 integration tests (cases 3/4/5 cover first-connect,
|
||||
second-connect, mismatch); AD-029 atomic rewrite via `security.WriteAtomic`.
|
||||
- **Gap:** no test for "known_hosts already has an entry, join re-connects" —
|
||||
i.e., the idempotent re-run path after the fix. T02.10 case 4 covers
|
||||
second-connect-match, but not "known_hosts was written by the OLD (broken)
|
||||
code path and is now being read by the NEW code path."
|
||||
|
||||
**Confidence:** 0.70.
|
||||
**Verdict:** **PROCEED-WITH-CONDITION.** T02.10 must add a case for
|
||||
"known_hosts pre-populated in the expected format (e.g., from a manual
|
||||
`ssh-keyscan` or a prior v0.6 deployment that somehow succeeded) →
|
||||
second-connect matches + succeeds." This covers the migration path from
|
||||
v0.6's (broken) state to v0.8's fixed state.
|
||||
|
||||
**Condition:** Add T02.10 case 7: "known_hosts pre-populated with a valid
|
||||
OpenSSH line for the host → connect matches + succeeds (covers v0.6→v0.8
|
||||
migration)."
|
||||
|
||||
---
|
||||
|
||||
### Axis 8 — Governance, Decision-Making, and Communication
|
||||
|
||||
#### A8-F1 — Does `make verify-reqs` actually prevent drift, or is it cosmetic?
|
||||
|
||||
**Evidence:**
|
||||
- T03.1 regex (PLAN line 216):
|
||||
- ROADMAP milestone-complete: `^##\s*Milestone\s+v0\.\d+:.*—\s*\*\*COMPLETE\*\*`
|
||||
- REQUIREMENTS row: `^\|\s*(REQ-\d+)\s*\|.*?\|\s*\*\*(Complete|Pending)\*\*\s*\|`
|
||||
- **ROADMAP v0.2 header (line 23):** `## Milestone v0.2: Networking,
|
||||
Observability, Security Hardening — **COMPLETE (merged to main via v0.3)**`
|
||||
- The regex `\*\*COMPLETE\*\*` requires the literal `**COMPLETE**` with closing
|
||||
`**` immediately after `COMPLETE`. v0.2's header has `**COMPLETE (merged to
|
||||
main via v0.3)**` — the `**` closes after the parenthetical, NOT after
|
||||
`COMPLETE`. **The regex does NOT match v0.2 as complete.**
|
||||
- **Consequence:** all v0.2 REQs (REQ-011, 014, 023, 025-040) are **silently
|
||||
exempted** from the check. A stale v0.2 REQ-035 row (marked Pending) would
|
||||
NOT fail the gate.
|
||||
- **ROADMAP v0.6 has TWO headers** (line 92 without COMPLETE, line 94 with) —
|
||||
the regex matches line 94, but the duplicate is a markdown smell that could
|
||||
confuse the milestone→REQ mapping if the parser takes the first match.
|
||||
|
||||
**Confidence:** 0.92 (high — the regex mismatch is verifiable).
|
||||
**Verdict:** **PROCEED-WITH-CONDITION.** The regex must match `**COMPLETE**`
|
||||
as a *substring within the bold span*, not as a literal `**COMPLETE**` token.
|
||||
Change to `—\s*\*\*[^*]*COMPLETE[^*]*\*\*` (matches `**COMPLETE**`,
|
||||
`**COMPLETE (merged to main via v0.3)**`, and any future variant). Add a
|
||||
golden-file test case (T03.2) with the v0.2-style parenthetical header to
|
||||
prevent regression.
|
||||
|
||||
**Condition:** T03.1 regex changed to substring-match COMPLETE within the bold
|
||||
span; T03.2 adds a golden fixture with `**COMPLETE (merged to main via v0.3)**`.
|
||||
|
||||
#### A8-F2 — Is the single-direction check (ROADMAP→REQUIREMENTS) enough?
|
||||
|
||||
**Evidence:**
|
||||
- PLAN line 35-37 explicitly scopes out the reverse direction: "forward
|
||||
direction (ROADMAP-shipped → REQUIREMENTS Complete) is the priority per the
|
||||
v0.7 drift that motivated REQ-060."
|
||||
- **But the v0.7 drift had TWO symptoms:**
|
||||
1. ROADMAP said COMPLETE, REQUIREMENTS said Pending (forward drift — caught
|
||||
by the current check).
|
||||
2. **REQ-053 was marked Complete in REQUIREMENTS, but
|
||||
`internal/store/cert_repo_test.go` was never written** — verified: only
|
||||
`cert_repo.go` exists in `internal/store/`. The "Complete" status was
|
||||
false. **No markdown-based check can catch this** (it's a code-vs-doc
|
||||
drift, not a doc-vs-doc drift).
|
||||
- The reverse-direction check (REQUIREMENTS Complete ↔ ROADMAP COMPLETE) would
|
||||
catch a different class: a REQ marked Complete in REQUIREMENTS for a
|
||||
milestone ROADMAP does NOT mark COMPLETE (e.g., premature marking). This is
|
||||
a cheaper class of drift but still real.
|
||||
|
||||
**Confidence:** 0.78.
|
||||
**Verdict:** **PROCEED-WITH-CONDITION.** Add the reverse-direction assertion
|
||||
to T03.1 (it's ~10 LOC on top of the existing parser — same maps, just diff
|
||||
both ways). Document explicitly that **no markdown check can catch the
|
||||
code-vs-doc drift** (REQ-053 case) — that requires a code-level audit
|
||||
(`ciagent-audit` in P04). The plan should note this as a known limitation of
|
||||
REQ-060, not pretend the gate is complete.
|
||||
|
||||
**Condition:** T03.1 adds reverse-direction assertion; PLAN adds a note that
|
||||
REQ-060 catches doc-vs-doc drift only, not code-vs-doc (the REQ-053
|
||||
cert_repo_test.go case).
|
||||
|
||||
#### A8-F3 — Is there a "stop the project" trigger?
|
||||
|
||||
**Evidence:** P04 (T04.1-T04.9) is the final review + ship. No explicit
|
||||
"stop" trigger if P01 coverage stalls or P02 TOFU fix proves unfixable.
|
||||
|
||||
**Confidence:** 0.60.
|
||||
**Verdict:** **PROCEED.** The 4-phase structure with per-phase tags means a
|
||||
stall is visible (phase tag doesn't ship). Acceptable for an NFR milestone.
|
||||
|
||||
---
|
||||
|
||||
### Axis 9 — Change, Adoption, and Operational Readiness
|
||||
|
||||
#### A9-F1 — Who benefits from v0.8? Is there operator pull for `--host-key-fingerprint`?
|
||||
|
||||
**Evidence:**
|
||||
- `--host-key-fingerprint` (REQ-058) is operator-facing: pre-pinning a
|
||||
Proxmox host's SSH key before first join. This is the standard
|
||||
high-security-deployment pattern (the v0.6 D-035 caveat explicitly promised
|
||||
it as a "future enhancement").
|
||||
- `orca node key-reset` (REQ-059) is operator-facing: the `ssh-keygen -R`
|
||||
equivalent for orca's known_hosts.
|
||||
- The TOFU bugfix (T02.6) benefits **every operator who has tried
|
||||
first-connect Proxmox join since v0.6** — i.e., it fixes a feature that was
|
||||
advertised as working but wasn't.
|
||||
- Coverage uplift (REQ-057) is developer-facing (no operator pull).
|
||||
- verify-reqs (REQ-060) is internal-governance (no operator pull).
|
||||
|
||||
**Confidence:** 0.82.
|
||||
**Verdict:** **PROCEED.** The trust features have real operator pull
|
||||
(pre-pinning is a documented security best practice; the v0.6 caveat promised
|
||||
it). The coverage + hygiene work is internal-debt paydown — justified by the
|
||||
v0.7 under-shot, not by operator demand. The mix is appropriate for an NFR
|
||||
milestone.
|
||||
|
||||
#### A9-F2 — Rollback plan if P02's trust changes go wrong
|
||||
|
||||
**Evidence:**
|
||||
- P02 changes `HostKeyCallback` for all Proxmox joins + doctor probes. If the
|
||||
capture-fix corrupts `known_hosts`, the rollback is: revert the phase commit
|
||||
+ manually restore `known_hosts` from backup.
|
||||
- No data migration in P02 (known_hosts is a flat file; atomic rewrite via
|
||||
`WriteAtomic` preserves crash safety).
|
||||
- `key-reset` (T02.8) is local-only (D-046) — no remote side effects to
|
||||
reverse.
|
||||
|
||||
**Confidence:** 0.80.
|
||||
**Verdict:** **PROCEED.** Rollback is straightforward (revert + file restore).
|
||||
The atomic-rewrite requirement (AD-029) is the right mitigation.
|
||||
|
||||
---
|
||||
|
||||
## Binding Verdicts Table
|
||||
|
||||
| # | Axis | Finding | Verdict | Condition | Confidence |
|
||||
|---|------|---------|---------|-----------|------------|
|
||||
| A2-F1 | Scope | TOFU bugfix is a v0.6 ship-defect bundled into P02 as a feature task | PROCEED-WITH-CONDITION | Label T02.6 as a v0.6 bugfix in PLAN; P04 audit records it as a ship-defect closure | 0.62 |
|
||||
| A2-F2 | Scope | 3 zero-test packages at 50% toe-hold | PROCEED | — | 0.85 |
|
||||
| A2-F3 | Scope | 37 tasks / 4 phases size | PROCEED | — | 0.80 |
|
||||
| A1-F1 | Business | v0.8 is the right next milestone (not polish) | PROCEED | — | 0.90 |
|
||||
| A3-F1 | Architecture | sessionRunner + peerDispatcher seams do not leak test concerns | PROCEED | — | 0.88 |
|
||||
| A3-F2 | Architecture | P02 stays within existing security boundary | PROCEED | — | 0.90 |
|
||||
| A3-F3 | Architecture | T02.6 + T02.9 are paired changes (bootstrap + doctor share the defect) | PROCEED-WITH-CONDITION | Add P02 verification line for doctor proxmox first-connect parity with bootstrap | 0.75 |
|
||||
| A4-F1 | People | internal/cli/node.go territory collision adjudicated | PROCEED | — | 0.82 |
|
||||
| A4-F2 | People | Key-person risk on backend-engineer in P02 | PROCEED | — | 0.70 |
|
||||
| A5-F1 | Timeline | 70% cli coverage in one phase is a stretch (RESEARCH says 55-65%) | PROCEED-WITH-CONDITION | Add escape valve: ship cli at 65% if 70% not reached after Wave 2; do not block P02/P03 | 0.65 |
|
||||
| A6-F1 | Budget | Zero new deps verified | PROCEED | — | 0.95 |
|
||||
| A7-F1 | Risks | 10 pitfalls mitigations are concrete | PROCEED | — | 0.88 |
|
||||
| A7-F2 | Risks | TOFU fix blast radius — no migration-path test | PROCEED-WITH-CONDITION | Add T02.10 case 7: known_hosts pre-populated → second-connect matches (v0.6→v0.8 migration) | 0.70 |
|
||||
| A8-F1 | Governance | verify-reqs regex does not match v0.2's `**COMPLETE (merged...)**` header | PROCEED-WITH-CONDITION | Change regex to substring-match COMPLETE within bold span; add golden fixture | 0.92 |
|
||||
| A8-F2 | Governance | Single-direction check misses reverse drift + code-vs-doc drift (REQ-053 case) | PROCEED-WITH-CONDITION | Add reverse-direction assertion; document that code-vs-doc drift is out of scope for REQ-060 | 0.78 |
|
||||
| A8-F3 | Governance | No explicit "stop" trigger | PROCEED | — | 0.60 |
|
||||
| A9-F1 | Adoption | Operator pull exists for trust features; coverage/hygiene is internal debt | PROCEED | — | 0.82 |
|
||||
| A9-F2 | Adoption | Rollback plan is straightforward (revert + file restore) | PROCEED | — | 0.80 |
|
||||
|
||||
---
|
||||
|
||||
## Required Plan Changes (4 conditions)
|
||||
|
||||
1. **T02.6 labeling (A2-F1):** Add a note to T02.6 in `PLAN_v0.8.md` marking
|
||||
it as a **v0.6 ship-defect bugfix** (first-connect Proxmox join has been
|
||||
broken since v0.6 shipped due to `knownhosts.New` returning
|
||||
`KeyError{Want:[]}` with no capture-and-persist). P04 audit (T04.2) must
|
||||
record it as a ship-defect closure, not a v0.8 feature.
|
||||
|
||||
2. **P02 verification parity for doctor (A3-F3):** Add to Phase 2 Verification:
|
||||
"`doctor proxmox` first-connect on a node with empty known_hosts → captures
|
||||
the key + writes known_hosts + probe succeeds (mirrors T02.10 case 3 for
|
||||
bootstrap). T02.6 and T02.9 are a paired change; the phase is not complete
|
||||
until both callbacks use the capture-fix wrapper."
|
||||
|
||||
3. **T01.6 cli coverage escape valve (A5-F1):** Add to T01.6 acceptance
|
||||
criterion: "If ≥65% (excluding `daemon.go`) is achieved but 70% is not after
|
||||
Wave 2 effort, document the gap in a test-file comment + record a v0.9
|
||||
follow-up; ship P01 at 65% for cli. Do NOT block P02/P03 on the last 5% of
|
||||
cli coverage." (Carries forward RESEARCH §1.4's own flag as an explicit
|
||||
escape valve.)
|
||||
|
||||
4. **verify-reqs regex + reverse direction (A8-F1 + A8-F2):**
|
||||
- Change T03.1 ROADMAP-complete regex from
|
||||
`^##\s*Milestone\s+v0\.\d+:.*—\s*\*\*COMPLETE\*\*` to
|
||||
`^##\s*Milestone\s+v0\.\d+:.*—\s*\*\*[^*]*COMPLETE[^*]*\*\*` (substring
|
||||
match within the bold span — handles `**COMPLETE**`,
|
||||
`**COMPLETE (merged to main via v0.3)**`, and future variants).
|
||||
- Add T03.2 golden fixture: a ROADMAP with
|
||||
`**COMPLETE (merged to main via v0.3)**` → assert the milestone is
|
||||
detected as complete.
|
||||
- Add reverse-direction assertion to T03.1: every REQUIREMENTS row marked
|
||||
`**Complete**` must reference a milestone ROADMAP marks COMPLETE (catches
|
||||
premature-Complete drift).
|
||||
- Add a PLAN note: "REQ-060 catches doc-vs-doc drift only. Code-vs-doc
|
||||
drift (e.g., REQ-053 marked Complete but `cert_repo_test.go` missing —
|
||||
verified missing in v0.7 ship) is NOT caught by this gate; it requires
|
||||
the P04 `ciagent-audit` code-level review."
|
||||
|
||||
Additionally (lower-priority, from A7-F2):
|
||||
|
||||
5. **T02.10 case 7 (A7-F2):** Add integration test case: "known_hosts
|
||||
pre-populated with a valid OpenSSH line for the host (simulating a v0.6
|
||||
deployment or manual `ssh-keyscan`) → connect matches + succeeds. Covers
|
||||
the v0.6→v0.8 migration path."
|
||||
|
||||
---
|
||||
|
||||
## Escalations
|
||||
|
||||
None. All 9 axes resolved at confidence ≥ 0.60. No axis requires escalation to
|
||||
the operator; the 4 conditions are within the plan-author's authority to apply
|
||||
before P01 execution begins.
|
||||
|
||||
---
|
||||
|
||||
## What the Plan Is NOT Doing (and should it?)
|
||||
|
||||
- **Not lifting the 3 zero-test packages to 70%.** Correct per D-047 — deferred
|
||||
to v0.9. Not a gap.
|
||||
- **Not adding a `peerDispatcher` seam unless needed.** Correct — conditional
|
||||
on T01.4's 70% via `httptest.NewTLSServer`. Not a gap.
|
||||
- **Not pre-populating `known_hosts` from a remote keyscan API.** Correct —
|
||||
TOFU + manual `--host-key-fingerprint` cover the v0.8 surface. Not a gap.
|
||||
- **Not catching code-vs-doc drift in verify-reqs.** **Known limitation** —
|
||||
REQ-060 is a markdown-vs-markdown check. The REQ-053
|
||||
`cert_repo_test.go`-missing case proves this class of drift is real. P04
|
||||
`ciagent-audit` is the backstop. Documented in condition #4.
|
||||
|
||||
---
|
||||
|
||||
## Simplest 80%-of-the-value version
|
||||
|
||||
If forced to cut v0.8 to its smallest valuable form: **keep P02 (trust
|
||||
hardening + TOFU bugfix) and P03 (verify-reqs); drop P01's coverage uplift for
|
||||
the 3 zero-test packages + cli.** The TOFU bugfix alone (T02.6 + T02.9) fixes a
|
||||
shipped security defect — that's the highest-value work. The verify-reqs gate
|
||||
prevents the v0.7 drift from recurring. The coverage uplift on the 6
|
||||
under-50% packages is valuable but not urgent; the 3 zero-test toe-holds are
|
||||
the lowest-value work in the milestone. **The plan as written does not over-
|
||||
scope** — it includes all of the above because the marginal cost is low — but
|
||||
if P01 slips, the 3 toe-holds + cli are the first cuts to make.
|
||||
|
||||
---
|
||||
|
||||
## What Would Have to Be True for v0.8 to Succeed in the Next 90 Days
|
||||
|
||||
1. The `sessionRunner` seam (T01.1) unlocks proxmox 70% — **plausible** (same
|
||||
pattern as the existing `sshDialer` seam).
|
||||
2. `httptest.NewTLSServer` suffices for transport 70% without a new seam —
|
||||
**plausible** (standard Go testing fixture).
|
||||
3. The TOFU capture-fix (T02.6) is correct — **plausible** (verified against
|
||||
x/crypto v0.54.0 semantics; integration tests T02.10 cover the cases).
|
||||
4. `verify-reqs` regex matches all ROADMAP milestone header variants — **NOT
|
||||
true today** (v0.2 header mismatch — condition #4 fixes this).
|
||||
5. cli hits 70% in one phase — **NOT confirmed** (RESEARCH says 55-65%;
|
||||
condition #3 adds the escape valve).
|
||||
|
||||
(4) and (5) are the two conditions that move the plan from "optimistic" to
|
||||
"sound." Both are addressed by the 4 required changes.
|
||||
|
||||
---
|
||||
|
||||
**End of grill report.** Apply the 4 conditions to `PLAN_v0.8.md` before P01
|
||||
execution. No REPLAN; no escalations. Overall verdict: **PROCEED-WITH-
|
||||
CONDITION** (confidence 0.78).
|
||||
@@ -0,0 +1,485 @@
|
||||
# Grill v0.9 — Adversarial Review of Re-Architecture
|
||||
|
||||
**Reviewer**: ci-griller (adversarial red-team)
|
||||
**Date**: 2026-08-05
|
||||
**Subject**: PRD that SUPERSEDES shipped v0.8 architecture; user committed to full re-architecture
|
||||
**Default stance**: infeasible / over-scoped / too costly until evidence forces otherwise
|
||||
|
||||
## Resolution note (recorded after grill completion)
|
||||
|
||||
The grill returned an overall **REPLAN** verdict (0.74) on three axes
|
||||
(Scope, Migration, Re-architecture Justification). The user reviewed the fork
|
||||
and **overrode the Re-architecture Justification axis' *direction*** with a
|
||||
recorded six-part evidence basis (see PROJECT.md Supersession Table):
|
||||
|
||||
1. The v0.8 daemon model is operationally failing in the target environment.
|
||||
2. step-ca is externally mandated.
|
||||
3. Multi-tenancy is a hard product requirement.
|
||||
4. WASM is a hard workload requirement.
|
||||
5. SSH-push is the only viable deployment target for the operator's environment.
|
||||
6. Simplicity/vision correction — the v0.1-v0.8 daemon model was a wrong turn.
|
||||
|
||||
Per the override, the three REPLAN axes' **direction** is settled (the
|
||||
re-architecture proceeds). Their **mechanics** remain as binding work items:
|
||||
- **Scope** mechanics → reorder phases (PC-01..PC-10), add deprecation sweep
|
||||
phase, split heavy phases.
|
||||
- **Migration** mechanics → split P14 into P14a/P14b/P14c, design migration
|
||||
ordering in v0.9-P00.
|
||||
- **Security** mechanics → threat model in v0.10-P15.5 (C-19).
|
||||
|
||||
The 19 binding conditions (C-01..C-19) and 10 phase challenges (PC-01..PC-10)
|
||||
are adopted in full as execution gates.
|
||||
|
||||
---
|
||||
|
||||
## Axis 1 — Feasibility
|
||||
|
||||
**Forcing questions**: Can five external apt packages (step-ca, Traefik,
|
||||
Syncthing, wasmtime, podman) truly be orchestrated from a single stateless CLI
|
||||
over SSH with no Orca-side code on the server, while still satisfying the
|
||||
"single binary, minimal deps" constraint? Is the SSH-push-to-bare-servers
|
||||
model sound at the latency/reliability required for a 10-second pull loop?
|
||||
wasmtime's canonical Go binding (`bytecodealliance/wasmtime-go`) is CGO — does
|
||||
wasmtime integration break the cross-compile story (D-002 modernc/sqlite was
|
||||
chosen for exactly CGO-freedom)?
|
||||
|
||||
**Evidence**: Constraint conflict between PROJECT.md:5 ("no container runtime")
|
||||
and PRD R-001 (podman as one of 5 runtimes). D-002 selected modernc/sqlite for
|
||||
"Cross-compile friendly, no CGO dependency." No evidence in the PRD that a
|
||||
CGO-free wasmtime binding exists. The PRD itself was not checked in (now
|
||||
resolved: `.ciagent/PRD_v0.9.md`).
|
||||
|
||||
**Verdict**: PROCEED-WITH-CONDITION
|
||||
**Confidence**: 0.62
|
||||
|
||||
**Binding conditions**:
|
||||
- **C-01**: Before P07b (wasmtime), produce a written evaluation of wasmtime Go
|
||||
bindings including CGO impact on the cross-compile target matrix. If
|
||||
wasmtime-go requires CGO, either (a) drop wasmtime as *primary* runtime and
|
||||
promote podman/process, or (b) explicitly revoke D-002's CGO-free rationale
|
||||
with a documented scope-consequence note. No silent reversal.
|
||||
- **C-02**: Before P09 (Storage replication), produce a Syncthing feasibility
|
||||
spike: successful CLI-driven config injection, conflict-resolution policy,
|
||||
and a documented failure mode when Syncthing diverges. The 10-second pull
|
||||
loop must still terminate with a deterministic state under conflict.
|
||||
- **C-03**: The PRD must be checked into `.ciagent/` before any v0.9 phase
|
||||
begins execution. ✅ Resolved — committed as `.ciagent/PRD_v0.9.md`.
|
||||
|
||||
**Rationale**: SSH-push is individually feasible — Ansible, Salt prove the
|
||||
pattern. The aggregate is the risk: five daemons, all configured over SSH,
|
||||
with bash as the reconciliation language. The wasmtime/CGO conflict could
|
||||
silently break the build story; must be spiked before commitment.
|
||||
|
||||
## Axis 2 — Scope
|
||||
|
||||
**Forcing questions**: Is the 27-phase plan realistically scoped when it
|
||||
simultaneously deprecates 7 shipped subsystems and adds 8 net-new subsystems?
|
||||
The deprecation of ~10k lines of shipped daemon/transport/CA code is not listed
|
||||
as a phase. v0.9 P0a..P10 ship 10 phases of workload features before the
|
||||
transactional control plane (R-010 deferred to v0.10 P10) — is that intentional
|
||||
or a sequencing error? Hidden requirements (step-ca self-upgrade, master.key
|
||||
rotation, Syncthing version drift)?
|
||||
|
||||
**Evidence**: v0.9 phase ordering ships P0a..P10 workloads, then P10 lead rules
|
||||
+ migration *last*. The transactional plane (R-010) is deferred to v0.10 P10 —
|
||||
two milestones away. v0.8 was a 4-phase NFR milestone; v0.6 was 4-phase feature.
|
||||
The PRD's v0.9 (11) + v1.0 (16) = 27 phases is 3-4× prior milestone size with
|
||||
no evidence the throughput model was re-validated. No phase is labeled
|
||||
"deprecate daemon/transport/internal-CA."
|
||||
|
||||
**Verdict**: REPLAN (mechanics — direction settled by override)
|
||||
**Confidence**: 0.78
|
||||
|
||||
**Mechanics adopted**:
|
||||
- **PC-01**: Move the transactional plane primitives forward. The
|
||||
transactional primitives (desired-state, lead-applier, drift, rollback) are
|
||||
the substrate every workload phase depends on. Design spike in v0.9-P00;
|
||||
full implementation in v0.10-P10 per PRD ordering (workloads first is accepted
|
||||
given the dual-write window mitigation in I-C-006).
|
||||
- **PC-02**: Add `v0.9-P00 — Deprecation sweep` as an explicit phase. Must land
|
||||
before any new feature phase so coverage gates don't measure dead packages.
|
||||
- **PC-03**: Split migration: `v0.9-P00b — Migration design + dry-run` (early,
|
||||
parallel to deprecation) and `v0.10-P14 — Production migration` (final).
|
||||
Migration design must inform every earlier phase, not be informed by them.
|
||||
|
||||
**Rationale**: 27 phases framed as "two milestones" while simultaneously
|
||||
deleting 10k lines and adding 8 subsystems is a multi-quarter effort. The
|
||||
deprecation work is a real phase that was not on the plan. With the override
|
||||
and the v0.9-P00 additions, the plan is now structurally sound.
|
||||
|
||||
## Axis 3 — Cost / Effort
|
||||
|
||||
**Forcing questions**: Realistic phase count if each phase is held to the same
|
||||
4-layer verification bar (REQ-060) and 70% coverage floor (D-042/D-047)?
|
||||
Personas active: 3 of 8; 5 dormant map directly to the 5 new apt dependencies.
|
||||
Deprecation cost — deleting 10k lines, rewriting tests, removing coverage-gate
|
||||
packages? The bash scripts (8 in §26.D) are a net-new language surface; bash
|
||||
testing frameworks not in current dep map — what's the cost?
|
||||
|
||||
**Evidence**: Active roster has 3 of 8 active; the 5 dormant personas map
|
||||
directly to the 5 new apt dependencies. v0.8 took 4 phases for a pure
|
||||
test/coverage milestone; v0.10 includes 11 distinct subsystems in one
|
||||
"milestone." No bash test infrastructure exists today.
|
||||
|
||||
**Verdict**: PROCEED-WITH-CONDITION
|
||||
**Confidence**: 0.70
|
||||
|
||||
**Binding conditions**:
|
||||
- **C-04**: Produce a per-phase sizing estimate using v0.6/v0.7/v0.8 actuals
|
||||
as the analogous baseline. If realistic phase count exceeds 35, the
|
||||
milestone must be split into v0.9 + v0.10 (three milestones), not two.
|
||||
- **C-05**: Reactivate or explicitly assign coverage for the dormant personas'
|
||||
domains (security, network, devops); no "dormant" = "unowned."
|
||||
- **C-06**: Decide and document whether bash scripts count toward the coverage
|
||||
gate. If exempt, the exemption is recorded as a binding decision with a
|
||||
compensating control (bats/shellcheck/shfmt in CI). If not exempt, the effort
|
||||
estimate must include bash test authoring.
|
||||
|
||||
**Rationale**: The work is physically doable, but the framing as "two
|
||||
milestones" is a cost fiction. The realistic shape is three milestones minimum,
|
||||
with the deprecation work as its own phase and bash testing either added to
|
||||
the gate or explicitly exempted with a documented compensating control.
|
||||
|
||||
## Axis 4 — Technical Risk
|
||||
|
||||
**Forcing questions**: CA migration — PRD reverses AD-010 and replaces the
|
||||
shipped internal Go CA. What is the migration path for existing `ca.crt`/
|
||||
`ca.key`/`server.crt`/`server.key` on every running cluster? SPIFFE SVID
|
||||
minting at submit time (D-068) reverses the PROJECT.md:94 SPIFFE rejection —
|
||||
has anyone prototyped the mint-at-submit path? Lead-applier as bash + systemd
|
||||
with no Orca code on the server — when `orca-pull.sh` fails mid-render, what
|
||||
is the recovery? Traefik dynamic config atomicity — mid-write, Traefik may
|
||||
re-read a half-written file. Syncthing replication correctness on a 10-second
|
||||
pull loop means the lead may render against stale state.
|
||||
|
||||
**Evidence**: AD-010 (ARCHITECTURE.md:463) is an explicit documented decision
|
||||
*against* step-ca. The PRD reversal has no recorded re-evidence of what changed
|
||||
(now resolved by the override justification). SPIFFE rejection at PROJECT.md:94
|
||||
is the same pattern. No mention in the PRD of a tmpfile+rename protocol for
|
||||
Traefik config, no Syncthing conflict-resolution policy, no `orca-pull.sh`
|
||||
failure semantics. The shipped `internal/transport/mtls.go` had
|
||||
retry+backoff+idempotency (REQ-037). The bash replacement has no equivalent
|
||||
specified.
|
||||
|
||||
**Verdict**: PROCEED-WITH-CONDITION
|
||||
**Confidence**: 0.72
|
||||
|
||||
**Binding conditions**:
|
||||
- **C-07**: Before P0a, write a CA migration spec: either (a) preserve existing
|
||||
`ca.crt` trust root and import into step-ca, or (b) document forced
|
||||
re-bootstrap as an accepted breaking change with per-cluster upgrade
|
||||
procedure. Cannot be deferred.
|
||||
- **C-08**: Before the first SPIFFE-touching phase (v0.10 P02 ACL), produce a
|
||||
working spike of step-ca JWT-SVID or X.509-SVID minting from the orca CLI
|
||||
(v0.10-P01.5). If the spike fails, SPIFFE is deferred and ACL falls back to
|
||||
mTLS identity (which the shipped model already had).
|
||||
- **C-09**: Define and test the `orca-pull.sh` failure contract: idempotent
|
||||
re-run, bounded retry, deterministic state on partial failure, syslog
|
||||
emission on every failure with a structured tag the CLI can scrape.
|
||||
- **C-10**: Define the Traefik config atomicity protocol (tmpfile + fsync +
|
||||
rename) and verify Traefik's behavior on malformed config (does it
|
||||
hold-last-good or fail?). Documented, tested.
|
||||
|
||||
**Rationale**: Each of the five technical unknowns is independently survivable
|
||||
with a spike; the risk is that all five land in the same milestone without
|
||||
any of them being spiked first. The CA-migration and SPIFFE items reverse
|
||||
documented rejections and so carry the highest re-evidence burden (now met by
|
||||
the override). The bash-control-plane risk is the one most likely to produce a
|
||||
"works in demo, fails in week 3 of production" failure mode.
|
||||
|
||||
## Axis 5 — Migration Risk
|
||||
|
||||
**Forcing questions**: §24 covers *data* migration (cert paths,
|
||||
config.hcl→config.md, db relocation). It does *not* cover *daemon cutover*: how
|
||||
do you stop `orca daemon` on every peer without losing the in-flight
|
||||
allocations those daemons are supervising? What happens to running
|
||||
allocations during `orca upgrade --to-v1.0`? The old model has the daemon as
|
||||
process parent; the new model has systemd units emitted by the CLI — there is
|
||||
no process-parent continuity. The transition period where some peers are v0.8
|
||||
(daemon) and some are v1.0 (no daemon) — what is the failure mode? In-flight
|
||||
jobs during upgrade — wait for drain, force-kill, or queue-and-replay?
|
||||
|
||||
**Evidence**: §24 covers cert paths, config.hcl→config.md, db relocation —
|
||||
three file-layout migrations. It omits four operational migrations: daemon
|
||||
cutover, running-allocation adoption, mixed-version cluster, in-flight jobs.
|
||||
The shipped executor (`internal/engine/executor.go:163`) uses
|
||||
`os/exec.CommandContext` — the daemon is the process parent. systemd units
|
||||
emit by the CLI would be a *different* parent (systemd). Process reparenting
|
||||
is not portable across the orca model. "Atomic, auto-rollback" is asserted for
|
||||
§24 but no trigger, no unit, no boundary is defined.
|
||||
|
||||
**Verdict**: REPLAN (mechanics — direction settled by override)
|
||||
**Confidence**: 0.82
|
||||
|
||||
**Mechanics adopted**:
|
||||
- **PC-04**: Split P14 into `v0.10-P14a — Data migration` (current scope),
|
||||
`v0.10-P14b — Daemon cutover + running-allocation adoption`,
|
||||
`v0.10-P14c — Mixed-version cluster tolerance + no-orca-on-server enforcement`.
|
||||
Three sub-phases, each with its own integration test.
|
||||
|
||||
**Rationale**: The migration plan as described covers the easy third (file
|
||||
layout) and omits the hard two-thirds (running processes and mixed-version
|
||||
clusters). A re-architecture that has no answer for "what happens to running
|
||||
workloads during the upgrade" is not shippable. With the P14 split, the plan
|
||||
is now complete.
|
||||
|
||||
## Axis 6 — Operational Risk
|
||||
|
||||
**Forcing questions**: When `orca-pull.sh` fails on the lead, what happens to
|
||||
workloads? When step-ca is down, can new workloads start? When Syncthing
|
||||
conflicts, what is the conflict-resolution policy? The lead's systemd timers
|
||||
drift when the lead is under load — how is timer starvation detected? No Orca
|
||||
binary on the server means no `orca doctor` on the server — the shipped doctor
|
||||
(REQ-032, REQ-052) ran locally on each node; the new model requires every
|
||||
diagnostic to be SSH-pushed from the CLI.
|
||||
|
||||
**Evidence**: The shipped `orca doctor` runs locally (ARCHITECTURE.md §5,
|
||||
REQ-032). The PRD's R-001 ("no orca binary on any server") implicitly deletes
|
||||
server-side doctor. The shipped model had `orca daemon` on every node
|
||||
providing `/healthz` — a local liveness signal. The new model has no
|
||||
server-side health producer. step-ca as a single point of failure is
|
||||
documented in step-ca's own operations guide (out-of-band knowledge).
|
||||
|
||||
**Verdict**: PROCEED-WITH-CONDITION
|
||||
**Confidence**: 0.68
|
||||
|
||||
**Binding conditions**:
|
||||
- **C-11**: Define the lead-side watchdog: a meta-timer that fires when
|
||||
`orca-pull.sh` has not successfully run in N seconds, emitting a structured
|
||||
alert. Document the alert path (syslog? CLI-pull?).
|
||||
- **C-12**: Document step-ca's HA story. If step-ca is single-node, that
|
||||
decision is recorded as an accepted SPOF with the mitigation being
|
||||
"workloads continue to run; only new submits are blocked." If step-ca is
|
||||
multi-node, the RAFT/sync story is part of the orca plan and must be sized.
|
||||
- **C-13**: Replace server-side doctor with a CLI-driven equivalent that
|
||||
SSH-probes every node and reconstructs the health view the daemon used to
|
||||
provide locally. This is a new requirement, not a feature; added as
|
||||
I-C-002 / v0.10-P14c.
|
||||
- **C-14**: Syncthing conflict-resolution policy must be deterministic,
|
||||
documented, and tested with a forced-divergence integration test.
|
||||
|
||||
**Rationale**: The operational model replaces a distributed system (daemons
|
||||
with health endpoints) with a centralized polling system (CLI over SSH) and a
|
||||
bash control plane on the lead. The mitigations are knowable but unspecified.
|
||||
|
||||
## Axis 7 — Security
|
||||
|
||||
**Forcing questions**: The master.key (AES-256-GCM for `.env.secrets`) is mode
|
||||
0600 on the CLI host with no passphrase — stolen key = all secrets in
|
||||
plaintext. The shipped model distributed keys with operator mediation (D-012).
|
||||
SSH is now the primary transport to every server — does the orca SSH key have
|
||||
a passphrase, or is it also bare 0600? The sudoers allowlist on peers grants
|
||||
the `orca` user privileged command access — does it grow to include
|
||||
`systemctl restart traefik`, `step ca ...`, `podman ...`? Five new attack
|
||||
surfaces: step-ca, Traefik, Syncthing, wasmtime, podman. SPIFFE SVIDs minted
|
||||
at submit time means the CLI holds the minting authority — if the CLI host is
|
||||
compromised, it mints valid SVIDs for the whole cluster.
|
||||
|
||||
**Evidence**: Shipped security posture: mTLS daemon-to-daemon, internal CA on
|
||||
a node, operator-mediated CA cert distribution (D-012 "no secret distribution
|
||||
over the wire, matches offline-first"). The shipped model was deliberately
|
||||
designed to avoid secret transport. New posture: CLI holds master.key (no
|
||||
passphrase), CLI mints SVIDs, SSH from CLI to every server with a (presumably)
|
||||
un-passphrased Ed25519 key, 5 daemons on every server each with their own
|
||||
attack surface. ARCHITECTURE.md:464 "AD-011 Operator-mediated CA cert
|
||||
distribution: No secret distribution over the wire." The new model puts a
|
||||
master.key on the CLI and uses SSH to push to every server — secret-over-the-wire
|
||||
is now the default.
|
||||
|
||||
**Verdict**: REPLAN (mechanics — direction settled by override)
|
||||
**Confidence**: 0.74
|
||||
|
||||
**Mechanics adopted**:
|
||||
- **C-19**: Write a threat model for the new posture before any
|
||||
security-touching phase (v0.10-P15.5). Defend master.key + CLI mint authority
|
||||
or revise. The shipped model deliberately avoided putting a single stealable
|
||||
file on a single host that decrypts all secrets and mints all identities.
|
||||
The threat model must document why the new posture is acceptable or specify
|
||||
mitigations (OS keyring, hardware secret, split keys).
|
||||
|
||||
**Rationale**: The re-architecture reverses the offline-first, no-secret-transport
|
||||
principle (AD-011) and centralizes minting authority + secret encryption on
|
||||
the CLI host with no passphrase. A threat model must be written and the
|
||||
master.key + CLI-mint-authority design defended or revised before any
|
||||
security-touching phase begins.
|
||||
|
||||
## Axis 8 — Maintainability
|
||||
|
||||
**Forcing questions**: The PRD moves logic from Go (type-safe, tested, in the
|
||||
orca binary, gated by REQ-057 coverage) to bash (untyped, hard to test, 8
|
||||
scripts in `scripts/`). How will the 8 bash scripts be tested under the
|
||||
project's coverage gate? Drift between Go-side emitters and bash-side appliers
|
||||
— when the Go side changes a render format, the bash side must change in
|
||||
lockstep; there is no compiler to catch this. The shipped `internal/transport`
|
||||
had retry, backoff, idempotency keys, structured mTLS failure logs. The bash
|
||||
replacement has none specified. Bash has no native structured logging (the
|
||||
project standard is slog JSON, REQ-008). The 8 scripts are a new language
|
||||
surface in a Go-only project.
|
||||
|
||||
**Evidence**: PROJECT.md:5 vision: "minimalist, offline-first, CLI-first
|
||||
orchestration engine prioritizing stability, security, and simplicity over
|
||||
feature richness." An 8-script bash control plane is not minimal by any prior
|
||||
definition used in this project. The shipped code has structured slog JSON
|
||||
logging (REQ-008), audit log (REQ-006), error wrapping (REQ-018), context
|
||||
propagation (REQ-017). Bash has none of these natively. No bash test
|
||||
framework in current dep map; no `bats`/`shunit2` reference. The 70%/50%
|
||||
coverage gate (D-042/D-047) is Go-specific.
|
||||
|
||||
**Verdict**: PROCEED-WITH-CONDITION
|
||||
**Confidence**: 0.66
|
||||
|
||||
**Binding conditions**:
|
||||
- **C-15**: Adopt a bash testing framework (bats or shunit2) and a static-analysis
|
||||
gate (`shellcheck`, `shfmt -d`) in CoreCI before any bash script ships. Bash
|
||||
scripts must have at least one integration test covering the happy path and
|
||||
one covering the failure path.
|
||||
- **C-16**: Define a **render-format contract** between Go emitters and bash
|
||||
appliers. Minimum: a versioned JSON schema for every rendered artifact,
|
||||
validated on both sides. The bash side rejects unparseable input with a
|
||||
structured error, never silently.
|
||||
- **C-17**: Bash scripts must emit slog-compatible JSON to syslog with the same
|
||||
field set (timestamp, actor, action, resource, result, error) as the Go
|
||||
audit log (REQ-006). No unstructured text in audit.
|
||||
- **C-18**: Every capability present in shipped `internal/transport` (retry,
|
||||
backoff, idempotency, structured mTLS failure logs) must have a documented
|
||||
bash-side equivalent or be explicitly accepted as dropped with a recorded
|
||||
rationale. Capability regressions must be visible, not silent.
|
||||
|
||||
**Rationale**: Bash is not inherently unmaintainable, but bash *in a Go-only,
|
||||
coverage-gated, structured-logging project* is a language-without-rails. Without
|
||||
the four conditions above, the bash control plane becomes the part of the
|
||||
codebase that everyone is afraid to touch by v0.10 P05. The drift between Go
|
||||
emitters and bash appliers is the single most likely source of "works on the
|
||||
CLI's machine, fails on the lead" bugs.
|
||||
|
||||
## Axis 9 — Re-Architecture Justification
|
||||
|
||||
**Forcing questions**: The PRD reverses 6 documented decisions (AD-010
|
||||
step-ca, SPIFFE rejection, no-container-runtime, no-multi-tenancy,
|
||||
HCL-canonical, daemon-on-every-node). For each reversal, what *new evidence*
|
||||
since the original decision justifies the reversal? The shipped v0.8 model is
|
||||
*working* — 8 milestones, REQ-001..060 Complete, 4-layer verification passing,
|
||||
coverage gates met. What is the *specific failure* of the shipped model that
|
||||
an incremental extension could not fix? What would be *lost* by incrementally
|
||||
extending the shipped model: add workload kinds, add secrets, add a
|
||||
transactional layer *on top of the daemon*? Is this re-architecture driven by a
|
||||
*real operational pain* or by an *architectural preference*?
|
||||
|
||||
**Evidence**: ROADMAP.md and PROJECT.md: every milestone from v0.1 to v0.8
|
||||
explicitly says "the vision is unchanged; this milestone is not a direction
|
||||
change." v0.9/v0.10 is the *first* milestone in the project's history that
|
||||
reverses the vision's anti-patterns. AD-010's rationale: "step-ca/cfssl/
|
||||
vault-pki too heavyweight for Orca's footprint." Nothing in the original PRD
|
||||
suggested Orca's footprint changed. The shipped model's `internal/transport`
|
||||
provides retry, backoff, idempotency, structured mTLS failure logs. The PRD
|
||||
replaces this with bash + systemd + SSH. No evidence the shipped transport
|
||||
was a source of operational pain.
|
||||
|
||||
**Verdict**: REPLAN (direction overridden by user with recorded justification)
|
||||
**Confidence**: 0.70
|
||||
|
||||
**Override**: The user provided a six-part evidence basis that addresses the
|
||||
reversal of each documented decision (see PROJECT.md Supersession Table):
|
||||
operational failure of the daemon model, external step-ca mandate, hard
|
||||
multi-tenancy requirement, hard WASM requirement, SSH-push as the only viable
|
||||
deployment target, and vision correction. The override is recorded; the
|
||||
direction holds.
|
||||
|
||||
**Residual mechanics**: The incremental-additive alternative was evaluated
|
||||
(the grill's Open Q1, Q2, Q10) and rejected on the grounds that the daemon
|
||||
model is operationally failing (ground 1) and SSH-push is the only viable
|
||||
deployment target (ground 5) — both of which foreclose the additive path.
|
||||
|
||||
**Rationale**: The default assumption — that a re-architecture of working
|
||||
shipped code is a mistake unless the case is overwhelming — is now met by the
|
||||
six-part justification. The re-architecture proceeds.
|
||||
|
||||
---
|
||||
|
||||
# Overall Verdict
|
||||
|
||||
**Verdict**: PROCEED-WITH-CONDITION (direction settled by override; mechanics gated by C-01..C-19)
|
||||
**Confidence**: 0.74
|
||||
|
||||
**Summary**: The re-architecture is technically feasible in pieces but
|
||||
structurally large as a single two-milestone jump. The override justification
|
||||
closes the Re-architecture Justification axis with a six-part evidence basis.
|
||||
The remaining mechanics: reorder phases (PC-01..PC-10), split heavy phases,
|
||||
add the v0.9-P00 deprecation/migration-ordering pre-phase, split P14 into
|
||||
three sub-phases, write the threat model in P15.5, and gate the 19 binding
|
||||
conditions (C-01..C-19) as execution gates. If the C-04 sizing estimate exceeds
|
||||
35 phases, the milestone splits into v0.9 + v0.10 + v1.0.
|
||||
|
||||
# Binding Conditions (aggregated — execution gates)
|
||||
|
||||
| ID | Condition | Blocks phase | Testable how |
|
||||
|----|-----------|--------------|--------------|
|
||||
| C-01 | Evaluate wasmtime Go binding CGO impact; if CGO-required, drop wasmtime as primary or revoke D-002 | v0.9-P07b | Build matrix spike on linux/amd64+arm64; revocation decision recorded |
|
||||
| C-02 | Syncthing feasibility spike: config injection, conflict policy, deterministic failure mode | v0.9-P09 | Spike report + forced-divergence integration test |
|
||||
| C-03 | Check PRD into `.ciagent/PRD_v0.9.md` before any v0.9 phase begins | (gate) | ✅ Resolved — file committed |
|
||||
| C-04 | Per-phase sizing estimate vs v0.6/v0.7/v0.8 actuals; if >35, split into v0.9+v0.10 | v0.9 start | ✅ RESOLVED — operator decision: keep 2 milestones (v0.9+v0.10), keep all phases (40 total), v1.0 UAT-gated after v0.10 |
|
||||
| C-05 | Reactivate or assign dormant persona domains (security, network, devops) | v0.9-P00 | PERSONAS.md updated with named owners |
|
||||
| C-06 | Decide bash coverage-gate status; if exempt, record compensating control | v0.9-P00 | Decision recorded in PROJECT.md D-series; CI pipeline shows the gate |
|
||||
| C-07 | CA migration spec: preserve existing trust root or document forced re-bootstrap | v0.10-P14a | Spec doc + migration dry-run on test cluster |
|
||||
| C-08 | SPIFFE SVID minting spike; if fails, fall back to mTLS identity | v0.10-P02 (spike in P01.5) | Working SVID mint from orca CLI in sandbox |
|
||||
| C-09 | `orca-pull.sh` failure contract: idempotent re-run, bounded retry, deterministic state, structured syslog | v0.10-P10 | Failure-path integration test + syslog structured-tag verification |
|
||||
| C-10 | Traefik config atomicity protocol (tmpfile+fsync+rename) + malformed-config behavior verified | v0.9-P02 | Atomic-rename test + Traefik malconfig-hold-last-good assertion |
|
||||
| C-11 | Lead-side watchdog meta-timer for `orca-pull.sh` starvation, with structured alert path | v0.10-P09 | Watchdog fires on injected pull failure; alert received |
|
||||
| C-12 | Document step-ca HA story; if single-node, record as accepted SPOF with mitigation | v0.10-P09 | Decision doc; if HA, RAFT/sync story in orca plan |
|
||||
| C-13 | Replace server-side doctor with CLI-SSH-driven equivalent | v0.10-P14c | New REQ-086 in REQUIREMENTS.md; integration test SSH-probes N nodes |
|
||||
| C-14 | Syncthing conflict-resolution policy deterministic + forced-divergence integration test | v0.10-P09 | Test induces divergence; resolves to single deterministic state |
|
||||
| C-15 | Bash testing framework (bats/shunit2) + shellcheck + shfmt in CoreCI before any bash ships | v0.9-P00 | CI pipeline green with the gate on a sample script |
|
||||
| C-16 | Versioned JSON-schema render-format contract between Go emitters and bash appliers | v0.9-P00 | Schema file in repo; both sides validate; mismatch fails CI |
|
||||
| C-17 | Bash scripts emit slog-compatible JSON to syslog with audit-log field set (REQ-006) | v0.9-P00 | Syslog capture test verifies field-presence + JSON parse |
|
||||
| C-18 | Document bash-side equivalents (or accepted drops) for shipped transport capabilities | v0.9-P00 | Capability-mapping doc in `.ciagent/` |
|
||||
| C-19 | Write a threat model for the new posture; defend master.key + CLI mint authority or revise | v0.10-P15.5 | Threat-model doc reviewed and committed; design revised if regression found |
|
||||
|
||||
# Phase Plan Challenges
|
||||
|
||||
| # | Phase | Problem | Fix |
|
||||
|---|-------|---------|-----|
|
||||
| PC-01 | v0.9 P0a–P10 | Ship 10 phases of workload features before the transactional control plane | Design spike in v0.9-P00; full impl in v0.10-P10 per PRD ordering (workloads first accepted with dual-write mitigation) |
|
||||
| PC-02 | (missing) | Deprecation of ~10k lines of daemon/transport/CA code is not a phase | Add `v0.9-P00 — Deprecation sweep` as explicit phase before any new feature phase |
|
||||
| PC-03 | v0.9 P10 | Migration is the last phase of v0.9 but is highest-risk | Split: migration design in v0.9-P00 (early), implementation in v0.10-P14 (final) |
|
||||
| PC-04 | v0.10 P14 | Covers data migration only; omits running-allocation cutover, mixed-version cluster, rollback trigger | Split into P14a (data), P14b (daemon cutover), P14c (mixed-version tolerance) |
|
||||
| PC-05 | v0.10 P02 | SPIFFE is a documented reversal with no spike; lands before spike possible | Insert `v0.10-P01.5 — SPIFFE mint spike` as hard gate before P02 |
|
||||
| PC-06 | v0.10 P10 | Transactional plane depends on lead-applier bash scripts (C-09) not gated | Reorder to v0.9-P00 design + add C-09 gate |
|
||||
| PC-07 | v0.10 P15/P16 | README before security threat model | Add `v0.10-P15.5 — Threat model + security review` before final review |
|
||||
| PC-08 | (missing) | No phase replaces server-side `orca doctor` | Add as I-C-002 / v0.10-P14c (CLI-SSH-driven doctor) |
|
||||
| PC-09 | v0.9 P09 | Syncthing lands before feasibility spike (C-02) | Spike must precede P09; if P09 is the spike, rename + gate on spike success |
|
||||
| PC-10 | v0.9 P07 | Five runtimes in one phase, including wasmtime (CGO risk) and pve-vm/pve-ct | Split: P07a (process+podman), P07b (wasmtime, C-01 gated), P07c (pve-vm+ct) |
|
||||
|
||||
# Open Questions (feed back to IDEATE/PLAN; resolved where noted)
|
||||
|
||||
1. **What measured operational failure of the shipped v0.8 daemon model is the re-architecture responding to?** — ✅ Resolved by override ground 1.
|
||||
2. **Can the v0.9 scope be delivered as additive extensions?** — ✅ Resolved: rejected per override grounds 1 + 5.
|
||||
3. **What is the wasmtime/CGO resolution?** — Closes via C-01 spike in v0.9-P07b.
|
||||
4. **What is the master.key threat model?** — Closes via C-19 in v0.10-P15.5.
|
||||
5. **What is the rollback unit of work for §24, and what triggers it?** — Must be answered in v0.9-P00 txn-design spike (I-B-007).
|
||||
6. **Is step-ca single-node acceptable as a cluster SPOF?** — Closes via C-12 in v0.10-P09.
|
||||
7. **Can the bash control plane be reduced?** — Closes in v0.9-P00 (fold 3+ scripts into Go-side SSH invocations where possible).
|
||||
8. **What is the realistic phase count?** — Closes via C-04 sizing before v0.9 starts; if >35, the plan becomes three milestones.
|
||||
9. **Does the PRD's reversal of 6 documented decisions require a formal AD-series supersession?** — ✅ Resolved: supersession table recorded in PROJECT.md + ARCHITECTURE.md.
|
||||
10. **What is the smallest possible version of this re-architecture that delivers 80% of the value?** — ✅ Resolved: the override rejected the incremental-additive path; the full re-architecture proceeds per the six-part justification.
|
||||
|
||||
# Binding Decisions (this grill session, G-001..G-009)
|
||||
|
||||
| ID | Decision | Confidence |
|
||||
|----|----------|-----------|
|
||||
| G-001 | Feasibility: PROCEED-WITH-CONDITION (C-01..C-03) | 0.62 |
|
||||
| G-002 | Scope: REPLAN mechanics (PC-01..PC-03) — direction settled by override | 0.78 |
|
||||
| G-003 | Cost: PROCEED-WITH-CONDITION (C-04..C-06) | 0.70 |
|
||||
| G-004 | Tech Risk: PROCEED-WITH-CONDITION (C-07..C-10) | 0.72 |
|
||||
| G-005 | Migration: REPLAN mechanics (PC-04) — direction settled by override | 0.82 |
|
||||
| G-006 | Op Risk: PROCEED-WITH-CONDITION (C-11..C-14) | 0.68 |
|
||||
| G-007 | Security: REPLAN mechanics (C-19) — direction settled by override | 0.74 |
|
||||
| G-008 | Maintainability: PROCEED-WITH-CONDITION (C-15..C-18) | 0.66 |
|
||||
| G-009 | Re-architecture Justification: direction overridden by user with six-part evidence basis; mechanics closed | 0.70 |
|
||||
|
||||
# Escalations (auto-resolved under full autonomy)
|
||||
|
||||
| E-ID | Item | Auto-decision | Mitigation |
|
||||
|------|------|---------------|-----------|
|
||||
| E-01 | Whether the re-architecture is justified vs incremental | OVERRIDDEN by user — direction holds | Six-part evidence basis recorded in PROJECT.md Supersession Table |
|
||||
| E-02 | Whether master.key passphrase-less posture is acceptable | REPLAN mechanics — threat model first | C-19 in v0.10-P15.5; if threat model shows regression vs shipped, revise design |
|
||||
| E-03 | Whether 27 phases fit in 2 milestones | Auto-split if sizing exceeds 35 | ✅ RESOLVED — operator: keep 2 milestones (v0.9+v0.10), keep all phases, v1.0 UAT-gated |
|
||||
@@ -0,0 +1,363 @@
|
||||
# Ideation v0.9 — Re-architecture Foundation
|
||||
|
||||
**Project**: orca (single-project mode) | **Milestone**: v0.9/v0.10 re-architecture
|
||||
**Date**: 2026-08-05 | **Agent**: ideation agent | **Confidence threshold**: 0.60
|
||||
**Next REQ ID prior to this run**: REQ-060 (v0.8 complete)
|
||||
|
||||
## Context
|
||||
|
||||
The v0.8 codebase (REQ-001..060, all Complete) is a daemon-based, mTLS,
|
||||
HCL, single-namespace orchestration engine. The adopted PRD supersedes this
|
||||
with a CLI-only, SSH-push, step-ca, Markdown-frontmatter, multi-namespace
|
||||
stack. 9 packages are deprecation targets (~2,400 LOC of v0.8
|
||||
daemon/transport/security-ca/engine-dispatch/jobspec-hcl/config-hcl/certpaths
|
||||
code), 7 packages are adaptable, and 8 subsystems are net-new with zero
|
||||
implementation. The §23 milestone plan has 11 v0.9 phases + 17 v0.10 phases but
|
||||
under-specifies the deprecation mechanics, the SSH-push transport design, the
|
||||
lead-applier execution model, several adapter/bridge layers, and the
|
||||
migration ordering risk.
|
||||
|
||||
This ideation produced 30 ideas across three tiers, all accepted at ≥0.60
|
||||
confidence, mapped to REQ-061..REQ-090. Seven phase-reordering flags against
|
||||
the PRD §23 plan are listed at the end.
|
||||
|
||||
## Tier 1 — Mechanical (Codebase-Observable Gaps & Hygiene)
|
||||
|
||||
### I-M-001 — `orca daemon` deprecation command and build-tag removal path
|
||||
- **Tier**: mechanical
|
||||
- **Description**: The PRD deprecates `internal/daemon/` (R-001) but §23 never says *how*. `internal/cli/daemon.go` (100 LOC) registers the `daemon` cobra command and wires `daemon.NewServer` + `engine.Dispatcher`. Big-bang removal would break the v0.8→v1.0 migration path (v0.10-P14) because `orca upgrade --to-v1.0` must run against a live v0.8 cluster that still has daemons. Proposal: (1) in v0.9, `orca daemon` emits a deprecation warning and still runs (dual-write window); (2) in v1.0, `orca daemon` is repurposed to `orca daemon drain-and-stop` (stops v0.8 daemons on peers via SSH, confirms workloads survive via systemd); (3) post-v1.0, the command and `internal/daemon/` are deleted. Add `// Deprecated` Go doc comments + `slog.Warn` on every run.
|
||||
- **Rationale**: R-001 is an invariant, but the *transition* off the daemon is a mechanical gap. The v0.8 `daemon.go` is wired in `root.go` init; removing it without a transition plan breaks the §24 migration.
|
||||
- **Proposed REQ ID**: REQ-061
|
||||
- **Proposed phase placement**: v0.10-P14 (migration) — deprecation warning lands in v0.9-P0X
|
||||
- **Confidence**: 0.82
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-M-002 — Coverage follow-ups: 3 zero-test packages + `internal/cli` to 70%
|
||||
- **Tier**: mechanical
|
||||
- **Description**: v0.8 P01 (REQ-057) raised 6 packages to ≥70% and added first tests for `internal/audit`, `internal/certpaths`, `cmd/orca` at a 50% toe-hold. The v0.9 re-architecture will *replace* several of these packages, but the *adaptable* ones (`internal/store`, `internal/doctor`, `internal/cli`) must keep their 70% floor through the refactor. Once `daemon.go` is deprecated/removed (I-M-001), the exclusion reason disappears and the floor applies to the whole package. Add a coverage-gate assertion in the v0.9 P0X ship phase that `internal/cli` ≥ 70% *including* all new subcommand files (ns, txn, pve, secrets, volume, cache, backup).
|
||||
- **Rationale**: The PRD §23 does not mention coverage. The config.json policy says 70% floor for new packages, 50% minimum. The 8 net-new subsystems will need 70% floors from their first phase. Without an explicit gate, the v0.7/v0.8 "toe-hold at 50% then defer" pattern will repeat.
|
||||
- **Proposed REQ ID**: REQ-062
|
||||
- **Proposed phase placement**: v0.9-P0X (ship+audit) + each net-new package's first phase
|
||||
- **Confidence**: 0.88
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-M-003 — `known_hosts` flock concurrency gap (deferred P1 from REVIEW_v0.8 A2)
|
||||
- **Tier**: mechanical
|
||||
- **Description**: REVIEW_v0.8 flagged A2 (P1): `TOFUHostKeyCallback` capture path (`bootstrap.go:290-302`) and `ResetHostKey` (`bootstrap.go:479-523`) both do read-modify-write on `known_hosts` with no lock. The review said "Defer to v0.9." This is now load-bearing because the SSH-push transport (R-001) will do *many more* concurrent SSH operations than v0.8 did. Add a `flock`-style advisory lock (stdlib `syscall.Flock` wrapper) around the RMW in both paths. Lock file is `cluster/known_hosts.lock` (multi-namespace layout, R-002).
|
||||
- **Rationale**: The v0.8 single-operator mitigation is weaker under v0.9's parallel SSH fan-out. The PRD doesn't mention this, but the SSH-push transport makes the race more likely.
|
||||
- **Proposed REQ ID**: REQ-063
|
||||
- **Proposed phase placement**: v0.9-P0a1 (path resolver, since it establishes `cluster/` layout)
|
||||
- **Confidence**: 0.74
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-M-004 — HCL→Markdown jobspec adapter/bridge layer
|
||||
- **Tier**: mechanical
|
||||
- **Description**: R-013 says the Markdown parser is canonical; `.yaml` and `.hcl` are "accepted by parser dispatcher." But `internal/jobspec/spec.go` (69 LOC) is an HCL-only parser with a flat `Spec{Job, Tasks}` schema — no `kind:` (R-012), runtime blocks, or body preservation (R-014/R-015). The "dispatcher" implies the new parser detects file extension and dispatches. Proposal: keep `internal/jobspec/spec.go` as the legacy HCL path behind `// Deprecated`; add `internal/jobspec/markdown.go` (canonical) + `internal/jobspec/dispatch.go` (extension-based dispatcher: `.md`→Markdown, `.hcl`→legacy, `.yaml`→Markdown-with-empty-body). The dispatcher returns a unified `*WorkloadSpec` that the legacy parser populates via an adapter. Preserves `orca job run old-spec.hcl` during the migration window.
|
||||
- **Rationale**: R-013 explicitly accepts `.hcl`, so a dispatcher is required. §23 v0.9-P0b says "parser dispatcher" but doesn't specify the adapter.
|
||||
- **Proposed REQ ID**: REQ-064
|
||||
- **Proposed phase placement**: v0.9-P0b (Markdown jobspec parser)
|
||||
- **Confidence**: 0.85
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-M-005 — `orca doctor --legacy-paths` detection for v0.8 residue
|
||||
- **Tier**: mechanical
|
||||
- **Description**: The v0.8 layout is `~/.orca/{orca.db, ca.crt, ca.key, server.crt, server.key, orca_ssh_key, known_hosts, config.hcl}`. The v1.0 layout is `ORCA_HOME/{_defaults/, cluster/{ca,master.key,peers,pve,txns}, <ns>/{db,.env,.env.secrets,jobs,alloc,ns.md}, orca_cache.db}`. `orca doctor` (`internal/doctor/doctor.go`, 501 LOC, adaptable) must gain a `doctor legacy` subcommand that detects v0.8 residue: presence of `orca.db` at ORCA_HOME root, `ca.crt`/`ca.key` (internal CA, superseded by step-ca), `config.hcl` (HCL, demoted), flat `server.crt` (single-namespace), and a `namespace` column in any `*.db` (R-002 says no namespace column). Output: list of detected legacy artifacts with migration recommendations. This is the *detection* half of v0.10-P14; the *migration* half is I-C-001.
|
||||
- **Rationale**: §23 v0.10-P14 says "orca upgrade --to-v1.0, post-invariant checks" but doesn't specify the detection surface. `doctor` is the diagnostics framework and is explicitly adaptable.
|
||||
- **Proposed REQ ID**: REQ-065
|
||||
- **Proposed phase placement**: v0.10-P14c (mixed-version tolerance + no-orca enforcement)
|
||||
- **Confidence**: 0.80
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-M-006 — Legacy CA state migration to step-ca (cert import)
|
||||
- **Tier**: mechanical
|
||||
- **Description**: `internal/security/ca.go` (338 LOC) holds an internal Go CA with `ca.crt`/`ca.key` (RSA 3072, 10-year). The PRD replaces this with step-ca (R-006, D-101 reverses AD-010). The v0.10-P14 migration must handle existing deployments with an internal CA: (a) import the existing CA key into step-ca as `step ca init --deployment-type standalone --remote-management` with the existing key; (b) issue new SVIDs from step-ca and let old certs expire; (c) document that v0.8 certs are invalidated and re-bootstrap is required. The codebase audit says `ca.go`+`csr.go` are *replaced* — but the *state* (the CA key + issued server certs in `cert_repo` SQLite) may need to be preserved for audit history even if the live trust root changes. Proposal: `orca upgrade --to-v1.0 --import-ca` reads `~/.orca/ca.key`, initializes step-ca with it, and re-issues workload SVIDs. Without this, existing deployments lose their trust root with no path back.
|
||||
- **Rationale**: AD-010 is explicitly reversed by D-101, but the reversal doesn't address what happens to the existing CA material. §24 covers data migration but not CA migration.
|
||||
- **Proposed REQ ID**: REQ-066
|
||||
- **Proposed phase placement**: v0.10-P14a (data migration)
|
||||
- **Confidence**: 0.70
|
||||
- **Accept/Defer**: accept (design in v0.9-P00 so step-ca integration knows the import contract)
|
||||
|
||||
### I-M-007 — Fuzz test harness for the Markdown frontmatter parser
|
||||
- **Tier**: mechanical
|
||||
- **Description**: R-014/R-015 require byte-exact body preservation — "body of every .md config file preserved verbatim." This is a class of bug that's easy to get wrong (off-by-one on the `---` delimiter, trailing newline handling, BOM, CRLF, nested code fences containing `---`). v0.8 has no fuzz tests at all. Proposal: add a `testing.F` fuzz target in `internal/jobspec/markdown_test.go` that round-trips random frontmatter+body through `ParseMarkdown` and asserts `body == roundtripped.body` byte-exact. Also add a corpus of adversarial fixtures (CRLF, BOM, no-frontmatter, empty-frontmatter, frontmatter-with-only-separator). §23 v0.10-P08 mentions integration tests but not fuzzing.
|
||||
- **Rationale**: R-015 is a *load-bearing invariant* (body appears in inspect/history). Byte-exactness is exactly what fuzz tests are for. The v0.8 jobspec tests are golden-file only (no fuzz).
|
||||
- **Proposed REQ ID**: REQ-067
|
||||
- **Proposed phase placement**: v0.9-P0b (Markdown parser) — fuzz from day one
|
||||
- **Confidence**: 0.78
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-M-008 — Deprecation warnings on removed/repurposed CLI subcommands
|
||||
- **Tier**: mechanical
|
||||
- **Description**: The v0.8 CLI has `orca cert {ca-init,gen,show,renew,fingerprint}` (`internal/cli/cert.go`), `orca node join` with mTLS handshake semantics (`internal/cli/node.go`), `orca job run <spec.hcl>`. The PRD repurposes `node join` to SSH-bootstrap (no mTLS), deprecates `cert` (step-ca handles it), and changes `job run` to accept `.md` specs. Each removed/changed command should emit a `slog.Warn` deprecation banner with the v1.0 replacement, *except* when run under `orca upgrade`. The existing `root.go` `PersistentPreRunE` is the natural hook for a global `--no-deprecation-warnings` flag.
|
||||
- **Rationale**: Operators running v0.8 commands against v0.9/v0.10 need to know what changed. The PRD doesn't mention deprecation UX.
|
||||
- **Proposed REQ ID**: REQ-068
|
||||
- **Proposed phase placement**: v0.9-P0X (ship) + v0.10-P13 (ns subcommands, when CLI surface is finalized)
|
||||
- **Confidence**: 0.72
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-M-009 — `internal/config/config.go` HCL config demotion via adapter
|
||||
- **Tier**: mechanical
|
||||
- **Description**: `internal/config/config.go` (127 LOC) parses HCL config with keys `db_path, listen_addr, ca_path, server_cert_path, server_key_path, node_capacity`. The PRD replaces this with Markdown-frontmatter config (R-014) + per-namespace `.env`/`.env.secrets` (R-011). The `listen_addr` and `server_*_path` keys are daemon-specific (deprecated by R-001). The `root.go` `PersistentPreRunE` calls `config.Load(configPath)` on every command — must be repointed to the new Markdown config loader. Proposal: keep `internal/config/` as `legacy_config.go` with `// Deprecated`; add `internal/config/markdown.go` for the new loader; `root.go` dispatches on file extension (`.hcl`→legacy, `.md`→new). The `--config` flag semantics change: `.hcl` is read-only legacy, `.md` is canonical.
|
||||
- **Rationale**: R-014 makes Markdown canonical but `.hcl` must still parse during migration. The existing `config.Load` is called unconditionally in `root.go:42-47`.
|
||||
- **Proposed REQ ID**: REQ-069
|
||||
- **Proposed phase placement**: v0.9-P0a1 (path resolver + config demotion)
|
||||
- **Confidence**: 0.76
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-M-010 — `internal/certpaths/` replacement with multi-namespace path resolver
|
||||
- **Tier**: mechanical
|
||||
- **Description**: `internal/certpaths/certpaths.go` (64 LOC) returns flat paths: `Dir() = $ORCA_HOME`, `CACertPath() = Dir/ca.crt`, `DBPath() = Dir/orca.db`. R-002 requires multi-namespace layout: `ORCA_HOME/<ns>/db/`, `ORCA_HOME/cluster/{ca,master.key,peers,pve,txns}`, `ORCA_HOME/_defaults/`. The package is imported by `doctor`, `proxmox`, `store`, `cli` — changing it is cross-cutting. Proposal: replace `certpaths` with a new `internal/paths` package: `paths.NamespaceDir(ns)`, `paths.ClusterDir()`, `paths.CacheDB()`, `paths.MasterKey()`, `paths.NSDb(ns)`, `paths.NSEnv(ns)`, `paths.NSSecrets(ns)`. Keep `certpaths` as a thin shim that calls `paths` with the default namespace for v0.8 compat, then remove the shim post-v1.0.
|
||||
- **Rationale**: R-002 is foundational and `certpaths` is the single source of path truth. Every adaptable package (`store.Open`, `doctor`, `proxmox`) imports it. Highest-blast-radius mechanical change.
|
||||
- **Proposed REQ ID**: REQ-070
|
||||
- **Proposed phase placement**: v0.9-P0a1 (must come first)
|
||||
- **Confidence**: 0.84
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-M-011 — `internal/store/` schema: per-namespace DBs, drop ns column
|
||||
- **Tier**: mechanical
|
||||
- **Description**: R-002 says "No `namespace` column in SQLite." The v0.8 schema has 7 migrations (`0001`..`0007`) with a single `orca.db`. The v0.10 model has one DB per namespace (`<ns>/db/orca.db`) plus a CLI-side cache DB (`orca_cache.db`, R-008). The existing `store.Open(path)` takes a path arg — adaptable. But the migrations are global; they need to apply *per namespace DB*. Proposal: `store.Open` gains a namespace parameter (or caller passes `paths.NSDb(ns)`); `migrate.go` runs `0001`..`0007` (minus `0006_node_kind_os` which is v0.8-specific) plus new `0008_namespace_layout.sql`. The `cert_repo` (`0004_certs.sql`) is removed (step-ca handles certs). The audit_log table moves to the CLI-side cache DB (R-008). Existing v0.8 `orca.db` is migrated by splitting tables into per-namespace DBs during v0.10-P14.
|
||||
- **Rationale**: R-002 is explicit ("No namespace column in SQLite") but the existing schema has a single DB. §23 doesn't specify the schema split mechanics.
|
||||
- **Proposed REQ ID**: REQ-071
|
||||
- **Proposed phase placement**: v0.9-P0a1 + v0.10-P06 (alloc history, which uses cache DB)
|
||||
- **Confidence**: 0.80
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-M-012 — `internal/transport/` deletion + SSH-push package introduction
|
||||
- **Tier**: mechanical
|
||||
- **Description**: `internal/transport/` (7 files, ~1300 LOC incl tests) implements mTLS client/server, dispatch, idempotency, retry, handshake logging. R-001 + R-006 replace this with SSH-push. The *idempotency* and *retry* logic (`idempotency.go` 123 LOC, `retry.go` 151 LOC) is conceptually reusable for SSH-push (retry on SSH failure, idempotency keys for SCP'd configs). Proposal: delete `mtls.go`, `dispatch.go`, `handshake_log.go`; extract retry/idempotency patterns into a new `internal/sshpush/` package. The existing `transport.IdempotencyStore` (in-memory `sync.Map` of keys) is directly reusable. This avoids re-implementing retry semantics from scratch.
|
||||
- **Rationale**: The codebase audit marks `internal/transport/` as fully replaced, but the retry/idempotency *patterns* are transport-agnostic. §23 doesn't call this out.
|
||||
- **Proposed REQ ID**: REQ-072
|
||||
- **Proposed phase placement**: v0.9-P00 (deprecation sweep) — delete in v0.10-P14
|
||||
- **Confidence**: 0.68
|
||||
- **Accept/Defer**: accept (defer deletion to v0.10-P14 to keep dual-write window open)
|
||||
|
||||
## Tier 2 — Backend-Enriched (Structural / Architectural)
|
||||
|
||||
### I-B-001 — SSH-push transport layer design
|
||||
- **Tier**: backend-enriched
|
||||
- **Description**: The PRD replaces `internal/transport/` (mTLS HTTP) with SSH-push but §23 never specifies the transport's internal design. Key decisions: (1) **Connection pooling**: reuse `*ssh.Client` per peer across multiple SCP/exec operations within a single CLI invocation. (2) **Idempotency**: SCP of a config file is idempotent if content hash matches — use content-addressed filename (`/run/orca/<hash>.unit`) and skip if present. (3) **Retry**: reuse v0.8's exponential backoff (100ms start, ×2, cap 5s, max 5 attempts) applied to SSH dial/exec failures. (4) **Timeout**: per-operation `context.WithTimeout` (default 30s SCP, 10s exec). (5) **Fan-out**: `errgroup.Group` with bounded concurrency for N-peer ops (default 8). (6) **known_hosts**: reuse `proxmox.TOFUHostKeyCallback` for all peers, not just Proxmox.
|
||||
- **Rationale**: Load-bearing replacement for the entire v0.8 transport layer. §23 assumes it but never designs it. Without connection pooling, every CLI operation re-dials SSH.
|
||||
- **Proposed REQ ID**: REQ-073
|
||||
- **Proposed phase placement**: v0.9-P01 (first phase needing SSH-push) — design in v0.9-P0a1
|
||||
- **Confidence**: 0.86
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-B-002 — Emitter template system (Layer 4)
|
||||
- **Tier**: backend-enriched
|
||||
- **Description**: The PRD §5 describes a 4-layer architecture where Layer 4 is "emitters" that render systemd units, Traefik dynamic config, Syncthing config, etc. from the workload spec. §23 never specifies the emitter interface. Proposal: an `internal/emitter/` package with `Emitter` interface: `Render(spec *WorkloadSpec, node *Node) ([]File, error)` where `File{Path, Content, Mode}`. Implementations: `systemdEmitter`, `traefikEmitter`, `syncthingEmitter`, `socketEmitter`. The SSH-push transport SCPs the `[]File` atomically (write-to-tmp + rename). Emitters registered per workload kind + runtime.
|
||||
- **Rationale**: The emitter layer is the bridge between the declarative spec and the server-side files. Without a defined interface, each phase (P02 service, P04 hooks, P08 sockets, P09 storage) will invent its own rendering.
|
||||
- **Proposed REQ ID**: REQ-074
|
||||
- **Proposed phase placement**: v0.9-P0c (schemas + emitter interface)
|
||||
- **Confidence**: 0.82
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-B-003 — Lead applier execution model: pure bash + systemd timer vs CLI-invoked
|
||||
- **Tier**: backend-enriched
|
||||
- **Description**: R-001 says "no orca binary on servers." R-010 says the lead applies desired-state transactionally. Unresolved: does the lead run `orca-pull.sh` (pure bash that SCPs a desired-state bundle and applies it via `systemctl daemon-reload` + `systemctl restart`) or does the operator's CLI SSH into the lead and runs `orca apply` remotely (which would put an orca binary on the lead, violating R-001)? The PRD's intent is the former: the lead is bare Linux with systemd timers + bash. Proposal: (1) the CLI renders a *transaction bundle* (tarball of desired-state files + `apply.sh` + `verify.sh`) on the operator host; (2) SCPs it to the lead's `/run/orca/txns/<txn-id>/`; (3) the lead's systemd timer runs `/run/orca/txns/<txn-id>/apply.sh` which idempotently applies and runs verify; (4) the CLI polls the lead for txn status via SSH (`cat /run/orca/txns/<txn-id>/status.json`). The bash scripts are generated by the CLI's emitter (I-B-002), not hand-written per cluster.
|
||||
- **Rationale**: The most ambiguous load-bearing design decision in the PRD. R-001 + R-010 together imply the lead runs no orca binary, but the lead must apply transactions. §23 doesn't resolve this. Getting it wrong means either violating R-001 or having no transactional apply.
|
||||
- **Proposed REQ ID**: REQ-075
|
||||
- **Proposed phase placement**: v0.10-P10 (transactional plane) — bundle format designed in v0.9-P00
|
||||
- **Confidence**: 0.78
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-B-004 — step-ca integration: provisioning, CA bootstrap, cert signing API, SVID minting
|
||||
- **Tier**: backend-enriched
|
||||
- **Description**: D-101 reverses AD-010 (which rejected step-ca as "too heavyweight"). §23 mentions step-ca in R-006 but never specifies the integration. Key surfaces: (1) **Provisioning**: `orca init` (adapted from v0.8's `internal/cli/init.go`) runs `step ca init` on the lead, stores root + intermediate in `cluster/ca/`. (2) **CA bootstrap**: CLI SSHs to the lead, installs step-ca via apt, runs `step ca init`, stores `step-ca.json` config. (3) **Cert signing API**: workloads request SVIDs via `step ca token` (JWE provisioner token minted by CLI) → `step ca certificate`. The CLI mints the token because it holds the provisioner password (in `cluster/master.key`-derived form). (4) **SVID minting**: each workload gets a SPIFFE ID (`spiffe://orca/<ns>/<workload>/<instance>`) encoded as a SAN in the step-ca-issued cert. The v0.8 `internal/security/ca.go` is deleted; a new `internal/stepca/` package wraps the `step` CLI via SSH (no Go step-ca client library — keep zero-new-dep posture if possible, or add `github.com/smallstep/cli` as a dep).
|
||||
- **Rationale**: step-ca is a new external dependency with its own config format, provisioner model, and CLI. §23 assumes it but never designs the integration. security-engineer persona must be reactivated.
|
||||
- **Proposed REQ ID**: REQ-076
|
||||
- **Proposed phase placement**: v0.9-P07 (runtime block — runtimes need SVIDs) + v0.10-P02 (ACL — SPIFFE identities)
|
||||
- **Confidence**: 0.74
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-B-005 — Traefik dynamic config generation and atomic reload
|
||||
- **Tier**: backend-enriched
|
||||
- **Description**: R-006 makes Traefik load-bearing (mTLS termination + health checks). §23 puts service blocks + Traefik health checks in v0.9-P02. Design: the CLI's Traefik emitter (I-B-002) renders a dynamic config file (`/etc/traefik/dynamic/orca-<ns>-<svc>.yaml`) with backends (the socket paths from R-007), health checks, and mTLS config pointing at step-ca's root. Atomic reload: Traefik watches the dynamic dir with `fsnotify` — writing the file atomically (tmp+rename) triggers a reload. Drain (v0.10-P05) works by writing a config with the backend's `weight=0` or removing it, triggering Traefik to stop routing. The v0.8 codebase has no Traefik integration at all. **Gated by grill C-10** (Traefik config atomicity protocol: tmpfile+fsync+rename + malformed-config hold-last-good verified).
|
||||
- **Rationale**: Traefik is net-new and load-bearing. §23 mentions it in R-006/P02/P05 but never specifies config generation or reload mechanism.
|
||||
- **Proposed REQ ID**: REQ-077
|
||||
- **Proposed phase placement**: v0.9-P02 (Service block + checks)
|
||||
- **Confidence**: 0.80
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-B-006 — Runtime abstraction interface (5 backends: wasm/podman/process/pve-vm/pve-ct)
|
||||
- **Tier**: backend-enriched
|
||||
- **Description**: v0.8's `internal/engine/executor.go` (211 LOC) is `os/exec` only. R-004/R-007 require 5 runtime backends. §23 puts this in v0.9-P07. Proposal: a `Runtime` interface in `internal/runtime/`: `Prepare(ctx, spec, node) (*Alloc, error)`, `Start(ctx, alloc) (pid/unit, error)`, `Stop(ctx, alloc) error`, `Status(ctx, alloc) (State, error)`. Implementations: `processRuntime` (wraps existing `executor.go` — directly reusable), `wasmRuntime` (wasmtime via CLI SSH exec), `podmanRuntime` (`podman run` via SSH), `pveVMRuntime` (`qm create`/`qm start` via v0.8 `proxmox` SSH session), `pveCTRuntime` (`pct create`/`pct start`). Each registered in a `runtimeRegistry` keyed by the `runtime:` frontmatter value. R-004 (migration with runtime change) means the `Alloc` carries a `runtime` field that can change on migration — `Prepare` re-runs with the new runtime.
|
||||
- **Rationale**: The 5 backends are the largest net-new implementation surface. §23 lists them as one phase (P07) but under-specifies the interface contract. The existing `executor.go` is a good starting point for the `processRuntime` adapter.
|
||||
- **Proposed REQ ID**: REQ-078
|
||||
- **Proposed phase placement**: v0.9-P07a/P07b/P07c (split per grill PC-10)
|
||||
- **Confidence**: 0.82
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-B-007 — Transaction bundle format and atomicity across N peers
|
||||
- **Tier**: backend-enriched
|
||||
- **Description**: R-010 requires transactional control-plane updates. §23 puts this in v0.10-P10. Design: a *transaction bundle* is a tarball containing: (1) `desired-state.json` (full desired state for affected namespaces), (2) `apply.sh` (idempotent apply script), (3) `verify.sh` (post-apply invariants), (4) `rollback.sh` (revert to previous state), (5) `manifest.sig` (signature with `cluster/master.key`). Atomicity across N peers: the CLI uploads the bundle to the lead; the lead applies to itself first, then fans out to peers via SSH. If any peer fails verify, the lead runs `rollback.sh` on all peers that applied. The bundle is content-addressed (`<txn-id> = sha256(desired-state.json)`) and stored in `cluster/txns/<txn-id>/`. Drift detection (R-010) compares the last applied bundle's desired-state against the live state (polled via SSH `systemctl show` + file checksums). **Gated by grill C-09** (orca-pull.sh failure contract: idempotent re-run, bounded retry, deterministic state, structured syslog).
|
||||
- **Rationale**: Multi-peer atomicity is the hardest part of R-010. §23 says "ArgoCD-style" but ArgoCD is Kubernetes-native; the SSH-push model needs a custom bundle format.
|
||||
- **Proposed REQ ID**: REQ-079
|
||||
- **Proposed phase placement**: v0.10-P10 (transactional plane) — designed in v0.9-P00
|
||||
- **Confidence**: 0.76
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-B-008 — Master key management and HKDF-SHA256 per-line .env.secrets encryption
|
||||
- **Tier**: backend-enriched
|
||||
- **Description**: R-011 specifies `.env.secrets` with AES-256-GCM, per-line nonce, master key at `cluster/master.key`. §23 puts this in v0.10-P03. Design: (1) `cluster/master.key` is a 32-byte random key generated by `orca init` (extend v0.8 `internal/security/ca.go`'s `WriteAtomic` pattern for the file write). (2) Each line of `.env.secrets` is `base64(nonce || ciphertext || tag)` where `nonce = random(12 bytes)` and `ciphertext = AES-256-GCM(plaintext, key=master.key, nonce, aad=line-number)`. (3) The AAD is the 1-indexed line number to prevent line-swap attacks. (4) Decryption reads the master key, iterates lines, decrypts with AAD. (5) `orca secrets set <ns> <key> <value>` appends an encrypted line; `orca secrets get <ns> <key>` decrypts and prints (redacted by default, `--reveal` to show). (6) The v0.8 `internal/security/redact.go` (103 LOC) is directly reusable for redaction. HKDF-SHA256 derives per-namespace sub-keys from the master key (`HKDF-SHA256(master, info=<ns>)`) so compromising one namespace's key doesn't compromise others — but the master key is the root of trust. **Gated by grill C-19** (threat model for master.key passphrase-less posture).
|
||||
- **Rationale**: R-011 is precise about the crypto but §23 doesn't specify key derivation, AAD, or CLI surface. The existing `redact.go` and `WriteAtomic` are reusable.
|
||||
- **Proposed REQ ID**: REQ-080
|
||||
- **Proposed phase placement**: v0.10-P03 (secrets subsystem)
|
||||
- **Confidence**: 0.84
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-B-009 — Syncthing config rendering and folder-ID content-addressing
|
||||
- **Tier**: backend-enriched
|
||||
- **Description**: R-005 requires storage replication via per-namespace Syncthing. §23 puts this in v0.9-P09. Design: (1) each namespace gets a Syncthing folder `orca-<ns>` with a content-addressed folder ID (`sha256(ns + master-key-fingerprint)`). (2) The CLI renders `config.xml` for each peer's Syncthing instance, including the folder, devices (all peers in the namespace), and the path (`<ns>/alloc/<alloc-id>/`). (3) Syncthing runs as a systemd unit (emitted by the systemd emitter, I-B-002). (4) The CLI discovers peers via `cluster/peers/` and adds their Syncthing device IDs (each peer's Syncthing generates its own device key on first run, reported back via SSH). (5) R-005 says "a Service's count replicas share one runtime block" — the Syncthing folder is shared across the Service's alloc instances so all replicas see the same data. Migration (R-004) works because the new node joins the Syncthing folder and syncs before the workload starts. **Gated by grill C-02** (Syncthing feasibility spike) and **C-14** (deterministic conflict-resolution policy + forced-divergence integration test).
|
||||
- **Rationale**: Syncthing is net-new. §23 lists it in P09 but doesn't specify config rendering, folder-ID scheme, or device discovery.
|
||||
- **Proposed REQ ID**: REQ-081
|
||||
- **Proposed phase placement**: v0.9-P09 (storage replication) — spike in v0.9-P00
|
||||
- **Confidence**: 0.72
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-B-010 — Namespace inheritance resolver algorithm
|
||||
- **Tier**: backend-enriched
|
||||
- **Description**: v0.9-P0a2 requires a "parent walker, cycle detection" for namespace inheritance. Each `ns.md` has a `parent:` field in frontmatter. The resolver walks up the parent chain, merging inherited values (constraints, env, runtime defaults). Cycle detection: DFS with a visited set; if a namespace is revisited, return a cycle error. The resolver returns a flattened `ResolvedNamespace` struct. The `_defaults/` namespace is the implicit root (always exists, has no parent). Inheritance semantics: child overrides parent for scalar fields; arrays (e.g., constraints) are unioned (child adds to parent, not replaces). The resolver is pure (no I/O) — it takes a map of `nsName → *NSConfig` and returns `nsName → *ResolvedNS`. This makes it trivially testable.
|
||||
- **Rationale**: §23 mentions "parent walker, cycle detection" but not the merge semantics (override vs union) or the resolver's purity for testing. Getting merge semantics wrong breaks constraint inheritance (P05).
|
||||
- **Proposed REQ ID**: REQ-082
|
||||
- **Proposed phase placement**: v0.9-P0a2 (namespace CRUD + inheritance)
|
||||
- **Confidence**: 0.86
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-B-011 — Bin-packing scheduler redesign (CLI-side, runtime-compatibility scoring)
|
||||
- **Tier**: backend-enriched
|
||||
- **Description**: v0.8's `internal/engine/scheduler.go` (117 LOC) does best-fit bin-packing by CPU+memory. The v0.9 scheduler must: (1) run CLI-side (not on a daemon), (2) score nodes by runtime compatibility (a wasm workload can only go to a node with wasmtime installed; a pve-vm workload can only go to Proxmox nodes), (3) respect constraints/affinity (CEL over node attributes, P05), (4) handle the 3 kinds differently (Job = one-shot, Service = count replicas spread across nodes, DaemonSet = one per node). The existing `scheduler.go` is a good skeleton but the scoring function changes entirely. Proposal: `Score(node, workload) (score int, fits bool)` where `fits` checks runtime compatibility + constraints, and `score` is the bin-packing score (most free capacity = highest score). For Services, the scheduler picks `count` distinct nodes (anti-affinity by default). For DaemonSets, it picks all matching nodes.
|
||||
- **Rationale**: The scheduler moves from daemon-side to CLI-side (R-001) and gains runtime-awareness. §23 scatters this across P05 (constraints), P06 (task groups), P07 (runtime), P10 (migration) but never designs the scheduler itself.
|
||||
- **Proposed REQ ID**: REQ-083
|
||||
- **Proposed phase placement**: v0.9-P05 (constraints & affinity — scheduler needs constraints to be meaningful) — skeleton in P0c
|
||||
- **Confidence**: 0.80
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-B-012 — `orca job lint` category-driven lint engine design
|
||||
- **Tier**: backend-enriched
|
||||
- **Description**: v0.10-P11 requires `orca job lint` with `--explain`. Design: a `Linter` that takes a `*WorkloadSpec` and runs a series of `Rule` checks, each returning a `Finding{Category, Severity, Message, Explanation}`. Categories: `schema` (missing required fields), `runtime` (incompatible runtime+constraint), `security` (missing SVID, plaintext secret in env), `migration` (missing storage replication for a migratable service), `best-practice` (no health check on a Service). `--explain` prints the rationale for each finding. Rules are registered in a `ruleRegistry` and individually testable. The linter is pure (no I/O) — it checks the spec against static rules, not live cluster state (that's `orca job verify`, P12).
|
||||
- **Rationale**: §23 puts this in P11 but only says "category-driven." The rule interface and category taxonomy are unspecified.
|
||||
- **Proposed REQ ID**: REQ-084
|
||||
- **Proposed phase placement**: v0.10-P11 (orca job lint)
|
||||
- **Confidence**: 0.78
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
## Tier 3 — Cross-Cutting (Risk & Multi-Phase)
|
||||
|
||||
### I-C-001 — v0.8→v1.0 migration ordering: daemon deprecation vs. new model rollout
|
||||
- **Tier**: cross-cutting
|
||||
- **Description**: The PRD §24 covers *data* migration but not *binary/daemon* deprecation ordering. The risk: v0.9 builds the new Markdown+kinds+runtime+SSH-push model, but v0.8 daemons are still running on peers. If v0.9 ships the new `orca job run` (Markdown) while the old daemon is still the execution engine, there's a split-brain: new specs can't run on the old daemon. Ordering proposal: (1) v0.9 ships the new parser + kinds + runtime + SSH-push *alongside* the old daemon (dual-write window); (2) `orca job run` in v0.9 uses the new SSH-push path if the spec is `.md` and the old daemon path if `.hcl`; (3) v0.10-P05 (drain) stops the old daemons; (4) v0.10-P14 (migration) converts remaining `.hcl` specs to `.md` and removes the daemon. The dual-write window means v0.9 is *not* a clean break — it's a compatibility milestone. This must be explicit in the plan or the v0.9 phases will assume the daemon is gone.
|
||||
- **Rationale**: Single largest risk in the re-architecture. §23 implicitly assumes v0.9 builds the new model in isolation, but existing deployments have running daemons. Getting the ordering wrong means either (a) v0.9 can't be tested against real deployments, or (b) workloads are orphaned when the daemon is removed.
|
||||
- **Proposed REQ ID**: REQ-085
|
||||
- **Proposed phase placement**: spans v0.9-P00 through v0.10-P14 — the *ordering decision* must be made in v0.9-P00
|
||||
- **Confidence**: 0.88
|
||||
- **Accept/Defer**: accept (most important idea in this report)
|
||||
|
||||
### I-C-002 — "No orca on server" enforcement (doctor post-migration invariant check)
|
||||
- **Tier**: cross-cutting
|
||||
- **Description**: R-001 is an invariant: "no orca Go binary on any server." §23 v0.10-P14 says "post-invariant checks" but doesn't specify them. `orca doctor` must gain a `doctor no-orca-on-server` check that SSHs to each peer and verifies: (1) no `orca` binary in PATH (`ssh peer which orca` returns nothing), (2) no `orca` systemd service (`ssh peer systemctl list-units 'orca*'` returns empty), (3) no `orca` process (`ssh peer pgrep -x orca` returns empty), (4) no `/etc/orca/` directory. This check must run *after* v0.10-P05 (drain) and *before* v0.10-P16 (ship). The v0.8 `internal/proxmox/bootstrap.go` already has the SSH session infrastructure (`sessionRunner` seam) — directly reusable for the doctor check.
|
||||
- **Rationale**: R-001 is a hard invariant but §23 doesn't enforce it post-migration. Without this check, a failed migration could leave orphaned daemons that cause split-brain.
|
||||
- **Proposed REQ ID**: REQ-086
|
||||
- **Proposed phase placement**: v0.10-P14c (mixed-version tolerance)
|
||||
- **Confidence**: 0.82
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-C-003 — Test infrastructure: hermetic 3-linux + 1-proxmox cluster pipeline
|
||||
- **Tier**: cross-cutting
|
||||
- **Description**: §23 v0.10-P08 requires "hermetic CoreCI integration pipeline." The PRD §26.E mentions 3 linux + 1 proxmox. This is net-new test infra with zero current implementation. Design: (1) a `test/integration/` directory with a `docker-compose.yml` or `vagrant` setup that creates 4 containers/VMs (3 linux + 1 proxmox-simulated); (2) a Go test harness that SSHes to each, runs the CLI, and asserts end-to-end workflows (namespace create → workload submit → migrate → drain); (3) the proxmox node is simulated via a mock `pct`/`qm` script (the v0.8 `proxmox` package already has a `sessionRunner` seam for testability — extend it). The integration tests run in CoreCI on every milestone merge. The v0.8 e2e tests (`bootstrapE2ESetup` in `bootstrap_test.go`) use an in-process SSH server — this is the foundation but needs to scale to 4 nodes.
|
||||
- **Rationale**: §23 assumes the infra exists but doesn't design it. devops-engineer persona should be reactivated. Without hermetic infra, the integration tests can't run in CI.
|
||||
- **Proposed REQ ID**: REQ-087
|
||||
- **Proposed phase placement**: v0.10-P08 (integration tests) — harness bootstrapped in v0.9-P00
|
||||
- **Confidence**: 0.80
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-C-004 — Security-engineer + network-engineer persona reactivation for new attack surfaces
|
||||
- **Tier**: cross-cutting
|
||||
- **Description**: The config.json has `security-engineer` and `network-engineer` dormant. The re-architecture introduces step-ca (PKI), Traefik (edge proxy), Syncthing (P2P file sync), wasmtime (sandbox), podman (container runtime) — all new attack surfaces. AD-010 (step-ca rejection) is reversed. The v0.8 security posture (internal CA, mTLS daemon-to-daemon) is replaced by (step-ca, SSH-push, Traefik mTLS). The security-engineer persona must be reactivated to review: (1) step-ca provisioner model (the CLI holds the provisioner password — is that in `cluster/master.key` or a separate secret?), (2) SSH-push blast radius (compromised CLI key = full cluster), (3) Traefik as the new edge (DoS, config injection), (4) `.env.secrets` crypto (I-B-008). The network-engineer persona must review: (1) socket-based service exposure (R-007), (2) Syncthing P2P ports, (3) Traefik routing. §23 doesn't mention persona reactivation.
|
||||
- **Rationale**: config.json explicitly notes the re-architecture "should reactivate security-engineer and network-engineer." Cross-cutting review concern, not a single phase.
|
||||
- **Proposed REQ ID**: REQ-088
|
||||
- **Proposed phase placement**: spans v0.9 through v0.10 — reactivation in v0.9-P00, review at v0.10-P15.5 (threat model) and v0.10-P16 (final audit)
|
||||
- **Confidence**: 0.84
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-C-005 — Documentation rewrite: ARCHITECTURE.md, PROJECT.md, README, AD-010 supersession
|
||||
- **Tier**: cross-cutting
|
||||
- **Description**: All three docs describe the OLD architecture. `ARCHITECTURE.md` (640 lines) describes the daemon layer, mTLS transport, internal CA, HCL jobspec — all deprecated. `PROJECT.md` (30k chars) has D-001..D-010 decisions, several now superseded. `README.md` has the v0.8 quickstart. AD-010 (step-ca rejection) must be explicitly superseded by D-101 with a dated rationale reversal. The anti-patterns section in `ARCHITECTURE.md:471-484` lists "No external PKI" — now reversed. Proposal: (1) in v0.9-P00, add a "v0.9 Architecture (Supersedes v0.8)" section to ARCHITECTURE.md with the new 4-layer model; (2) mark the old sections as "v0.8 (deprecated)" with banners; (3) add a "Superseded Decisions" table (AD-009, AD-010 reversed by D-101; AD-007 HCL demoted by R-013); (4) in v0.10-P15, rewrite README quickstart for the new `curl | sh` + `orca init` + `orca ns create` flow.
|
||||
- **Rationale**: The docs are the first thing new contributors read. Leaving v0.8 docs as canonical during v0.9 development causes confusion. §23 mentions README in P15 but not ARCHITECTURE.md/PROJECT.md.
|
||||
- **Proposed REQ ID**: REQ-089
|
||||
- **Proposed phase placement**: v0.9-P00 (banners + supersession table) + v0.10-P15 (README quickstart) + v0.10-P16 (final review)
|
||||
- **Confidence**: 0.82
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
### I-C-006 — Dual-write window: can v0.9 ship new parser while old daemon runs?
|
||||
- **Tier**: cross-cutting
|
||||
- **Description**: Focused version of I-C-001. The specific question: in v0.9, when the new Markdown parser + kinds + SSH-push are shipped, can they coexist with v0.8 daemons still running on peers? The answer depends on whether `orca job run <spec.md>` uses the new SSH-push path (bypassing the daemon entirely) or routes through the old daemon. If it bypasses, the daemon is irrelevant for new specs but still serves old `.hcl` specs. If it routes through, the daemon can't handle `.md` specs. Proposal: v0.9 `orca job run` dispatches on extension (`.md`→SSH-push new path, `.hcl`→old daemon path) via the parser dispatcher (I-M-004). This is a *dual-write window* where both paths coexist. The daemon is not removed until v0.10-P05 (drain). The risk: if a `.md` workload and a `.hcl` workload target the same node, the SSH-push path writes systemd units directly while the daemon also manages units — they can conflict. Mitigation: the SSH-push path writes to a separate systemd unit namespace (`orca-v1-<alloc>.service`) while the daemon uses `orca-<job>.service`. No unit name overlap = no conflict.
|
||||
- **Rationale**: Operational feasibility question for v0.9. §23 doesn't address it. If the answer is "no dual-write, daemon must be removed first," then v0.9 can't be tested incrementally and must ship as a big-bang — much higher risk.
|
||||
- **Proposed REQ ID**: REQ-090
|
||||
- **Proposed phase placement**: v0.9-P00 (decision before any v0.9 execution phase)
|
||||
- **Confidence**: 0.86
|
||||
- **Accept/Defer**: accept
|
||||
|
||||
## Summary Table
|
||||
|
||||
| ID | Tier | Title | REQ | Phase | Conf | Accept |
|
||||
|----|------|-------|-----|-------|------|--------|
|
||||
| I-M-001 | M | `orca daemon` deprecation path | REQ-061 | v0.10-P14 (warn v0.9-P0X) | 0.82 | accept |
|
||||
| I-M-002 | M | Coverage follow-ups to 70% | REQ-062 | v0.9-P0X + each new pkg | 0.88 | accept |
|
||||
| I-M-003 | M | known_hosts flock concurrency | REQ-063 | v0.9-P0a1 | 0.74 | accept |
|
||||
| I-M-004 | M | HCL→Markdown jobspec adapter | REQ-064 | v0.9-P0b | 0.85 | accept |
|
||||
| I-M-005 | M | `doctor --legacy-paths` detection | REQ-065 | v0.10-P14c | 0.80 | accept |
|
||||
| I-M-006 | M | Legacy CA state migration to step-ca | REQ-066 | v0.10-P14a | 0.70 | accept |
|
||||
| I-M-007 | M | Fuzz harness for Markdown parser | REQ-067 | v0.9-P0b | 0.78 | accept |
|
||||
| I-M-008 | M | Deprecation warnings on CLI subcommands | REQ-068 | v0.9-P0X + v0.10-P13 | 0.72 | accept |
|
||||
| I-M-009 | M | HCL config demotion via adapter | REQ-069 | v0.9-P0a1 | 0.76 | accept |
|
||||
| I-M-010 | M | certpaths → multi-namespace path resolver | REQ-070 | v0.9-P0a1 | 0.84 | accept |
|
||||
| I-M-011 | M | store schema: per-namespace DBs | REQ-071 | v0.9-P0a1 + v0.10-P06 | 0.80 | accept |
|
||||
| I-M-012 | M | transport deletion + SSH-push package | REQ-072 | v0.9-P00 (delete v0.10-P14) | 0.68 | accept |
|
||||
| I-B-001 | B | SSH-push transport layer design | REQ-073 | v0.9-P01 | 0.86 | accept |
|
||||
| I-B-002 | B | Emitter template system (Layer 4) | REQ-074 | v0.9-P0c | 0.82 | accept |
|
||||
| I-B-003 | B | Lead applier execution model | REQ-075 | v0.10-P10 (design v0.9-P00) | 0.78 | accept |
|
||||
| I-B-004 | B | step-ca integration | REQ-076 | v0.9-P07 + v0.10-P02 | 0.74 | accept |
|
||||
| I-B-005 | B | Traefik dynamic config + atomic reload | REQ-077 | v0.9-P02 | 0.80 | accept |
|
||||
| I-B-006 | B | Runtime abstraction (5 backends) | REQ-078 | v0.9-P07a/b/c | 0.82 | accept |
|
||||
| I-B-007 | B | Transaction bundle + N-peer atomicity | REQ-079 | v0.10-P10 (design v0.9-P00) | 0.76 | accept |
|
||||
| I-B-008 | B | Master key + HKDF per-line encryption | REQ-080 | v0.10-P03 | 0.84 | accept |
|
||||
| I-B-009 | B | Syncthing config + folder-ID | REQ-081 | v0.9-P09 | 0.72 | accept |
|
||||
| I-B-010 | B | Namespace inheritance resolver | REQ-082 | v0.9-P0a2 | 0.86 | accept |
|
||||
| I-B-011 | B | CLI-side scheduler redesign | REQ-083 | v0.9-P05 (skeleton P0c) | 0.80 | accept |
|
||||
| I-B-012 | B | `orca job lint` category-driven engine | REQ-084 | v0.10-P11 | 0.78 | accept |
|
||||
| I-C-001 | C | v0.8→v1.0 migration ordering | REQ-085 | spans v0.9-P00→v0.10-P14 | 0.88 | accept |
|
||||
| I-C-002 | C | "No orca on server" enforcement | REQ-086 | v0.10-P14c | 0.82 | accept |
|
||||
| I-C-003 | C | Hermetic test infra (3 linux + 1 pve) | REQ-087 | v0.10-P08 (bootstrap v0.9-P00) | 0.80 | accept |
|
||||
| I-C-004 | C | security/network persona reactivation | REQ-088 | spans v0.9→v0.10-P16 | 0.84 | accept |
|
||||
| I-C-005 | C | Docs rewrite + AD-010 supersession | REQ-089 | v0.9-P00 + v0.10-P15/P16 | 0.82 | accept |
|
||||
| I-C-006 | C | Dual-write window decision | REQ-090 | v0.9-P00 | 0.86 | accept |
|
||||
|
||||
## Phase Reordering / Addition Flags (against PRD §23)
|
||||
|
||||
1. **I-C-001 / I-C-006 (dual-write + migration ordering)** — require a decision in v0.9-P00 (before any execution phase). **Recommendation: add v0.9-P00 deprecation/migration-ordering pre-phase.** Most important structural addition.
|
||||
2. **I-M-010 / I-M-011 / I-M-009 / I-M-003** — all land in v0.9-P0a. P0a may be overloaded. **Recommendation: split P0a into P0a1 (path/layout resolver + config demotion) and P0a2 (namespace CRUD + inheritance).** Path resolver is prerequisite for everything; highest blast radius.
|
||||
3. **I-B-001 (SSH-push transport)** — §23 v0.9-P01 needs SSH-push. The design is a prerequisite. **Recommendation: SSH-push design in P0a1, not deferred to P01.**
|
||||
4. **I-B-002 (emitter template system)** — should be designed *with* the schemas (P0c). **Recommendation: expand P0c to "schemas + emitter interface."**
|
||||
5. **I-B-003 (lead applier model)** — bundle format + lead applier model must be designed *in v0.9* so the emitter can produce bundle-compatible output. **Recommendation: design spike in v0.9-P00.**
|
||||
6. **I-C-003 (test infra)** — hermetic cluster harness should be bootstrapped in v0.9-P00 so every v0.9 phase can run integration tests. **Recommendation: bootstrap in v0.9-P00, expand in v0.10-P08.**
|
||||
7. **I-C-004 / I-C-005 (persona reactivation + docs)** — span the whole milestone. **Recommendation: fold persona reviews into v0.9-P00 and v0.10-P16; fold doc banners into v0.9-P00.**
|
||||
|
||||
## Cross-Reference Against Existing Decisions
|
||||
|
||||
- **AD-009 (Internal CA, no external PKI)** — Superseded by D-101 (step-ca). I-B-004, I-M-006 implement the reversal.
|
||||
- **AD-010 (Roll-our-own CA)** — Superseded by D-101. I-C-005 documents the supersession. No re-litigation — the PRD has decided; the override justification records the evidence basis.
|
||||
- **AD-007 (HCL for job specs)** — Demoted by R-013 (Markdown canonical, HCL accepted). I-M-004 implements the adapter. Not a full reversal — HCL still parses.
|
||||
- **AD-001 (Single binary with subcommands)** — Still holds. The CLI is the single binary; no orca on servers (R-001) refines this.
|
||||
- **AD-015 (Best-fit bin-packing)** — Extended, not reversed. I-B-011 adds runtime-compatibility scoring.
|
||||
- **D-035 (TOFU host-key)** — Still holds for non-Proxmox peers. I-M-003 hardens the concurrency. I-B-001 reuses `TOFUHostKeyCallback`.
|
||||
- **D-046 (key-reset is local-only)** — Still holds. I-M-003 adds the lock.
|
||||
- **D-047 (tiered coverage floor)** — Extended by I-M-002 to cover new packages.
|
||||
|
||||
No accepted idea re-litigates a settled decision. All reversals (AD-009, AD-010, SPIFFE, no-container, no-multi-tenancy, HCL-canonical, daemon-on-every-node) are explicitly mandated by the PRD and justified by the recorded override justification.
|
||||
|
||||
## Final Notes
|
||||
|
||||
- **Total ideas**: 30 (12 mechanical, 12 backend-enriched, 6 cross-cutting).
|
||||
- **Highest-confidence, highest-impact**: I-C-001 (migration ordering, 0.88) and I-C-006 (dual-write window, 0.86) — these shape the entire v0.9 execution strategy.
|
||||
- **Highest-blast-radius mechanical**: I-M-010 (path resolver, 0.84) — touches every adaptable package.
|
||||
- **Most under-specified by PRD**: I-B-003 (lead applier execution model, 0.78) — R-001 + R-010 create a tension the PRD doesn't resolve.
|
||||
+150
-22
@@ -1,3 +1,144 @@
|
||||
---
|
||||
active:
|
||||
- lead-developer
|
||||
- backend-engineer
|
||||
- data-engineer
|
||||
- security-engineer
|
||||
- network-engineer
|
||||
- devops-engineer
|
||||
deactivated:
|
||||
- cli-engineer
|
||||
- frontend-engineer
|
||||
phase_specific: []
|
||||
reason: |
|
||||
Orca v0.9 is the first DIRECTION-CHANGE milestone in the project's
|
||||
history. It supersedes the shipped v0.1–v0.8 architecture per the adopted
|
||||
PRD (.ciagent/PRD_v0.9.md). The re-architecture deprecates the daemon/
|
||||
transport/internal-CA/HCL/single-namespace stack and builds a CLI-only/
|
||||
SSH-push/step-ca/Markdown-frontmatter/multi-namespace stack plus 8
|
||||
net-new subsystems. The user overrode the grill's Re-architecture
|
||||
Justification REPLAN with a six-part evidence basis (see PROJECT.md
|
||||
Supersession Table). The ci-griller's 19 binding conditions (C-01..C-19)
|
||||
and 10 phase challenges (PC-01..PC-10) are adopted as execution gates
|
||||
(see GRILL_v0.9.md).
|
||||
|
||||
Roster changes vs v0.8 (implements grill C-05):
|
||||
- lead-developer: RETAINED — owns the CLI subcommand tree, deprecation
|
||||
sweep (P00), path resolver (P0a1), parser dispatch (P0b), emitter
|
||||
interface (P0c), and milestone coordination.
|
||||
- backend-engineer: RETAINED — owns SSH-push transport (P01), runtime
|
||||
abstraction (P07a/b/c), transaction bundle (P10 design), step-ca
|
||||
integration, secrets crypto. Frameworks updated: golang.org/x/crypto/ssh
|
||||
(existing), golang.org/x/crypto/ssh/knownhosts (existing); pending
|
||||
deps: bytecodealliance/wasmtime-go (C-01 gate), smallstep/cli (I-B-004).
|
||||
- data-engineer: RETAINED — owns per-namespace DB schema split (P0a1,
|
||||
REQ-071), CLI cache DB (R-008), namespace inheritance resolver state
|
||||
(P0a2). Frameworks: modernc/sqlite.
|
||||
- security-engineer: REACTIVATED — owns step-ca provisioning (REQ-076),
|
||||
master.key + AES-256-GCM crypto (REQ-080, C-19 threat model), SPIFFE
|
||||
SVID minting (C-08 spike), SSH-push blast-radius review, Traefik edge,
|
||||
.env.secrets threat model. The re-architecture reverses AD-010
|
||||
(step-ca rejection) and the SPIFFE rejection at PROJECT.md:94; both
|
||||
reversals are justified in the Supersession Table.
|
||||
- network-engineer: REACTIVATED — owns socket-based service exposure
|
||||
(R-007, P08), Syncthing P2P ports (P09), Traefik routing + dynamic
|
||||
config atomicity (P02, C-10). The transport layer moves from mTLS
|
||||
HTTP daemon-to-daemon to SSH CLI-to-server; network-engineer reviews
|
||||
the new trust surface.
|
||||
- devops-engineer: REACTIVATED — owns bash scripts (scripts/orca-*.sh,
|
||||
C-15..C-18: bats/shellcheck/shfmt gate, render-format contract,
|
||||
slog-syslog), systemd timers (orca-pull/drift/aggregate, C-09 failure
|
||||
contract, C-11 watchdog), hermetic test infra (P00 bootstrap, P08
|
||||
expand, REQ-087).
|
||||
- cli-engineer: remains DEACTIVATED — CLI surface growth is owned by
|
||||
lead-developer (cobra subcommands) + backend-engineer (transport);
|
||||
reactivation optional if CLI subcommand surface exceeds lead-developer
|
||||
bandwidth.
|
||||
- frontend-engineer: remains DEACTIVATED — no web UI (unchanged from
|
||||
v0.1 onward; R-014 makes Markdown canonical, not a web UI).
|
||||
---
|
||||
|
||||
# Personas: Orca
|
||||
|
||||
## v0.9 persona assessment (supersedes v0.8)
|
||||
|
||||
The v0.9 re-architecture introduces 5 new external apt dependencies (step-ca,
|
||||
Traefik, Syncthing, wasmtime, podman), 8 net-new subsystems, and deprecates
|
||||
~10k lines of shipped daemon/transport/CA/HCL code. The active roster grows
|
||||
from 3 to 6 to cover the new attack surfaces and deployment model. Territory
|
||||
enforcement remains in `warn` mode per config.json.
|
||||
|
||||
### lead-developer
|
||||
- **Domain**: coordination
|
||||
- **Frameworks**: `cobra`, `net/http/httptest`, `testing`
|
||||
- **Constraints**: `boundary-enforcement`, `offline-first`, `no-redundant-implementations`, `coverage-floor-70`
|
||||
- **Territory**: `cmd/**`, `internal/cli/**`, `cmd/verify-reqs/**`, `Makefile`, `.coreci.yml`, `.ciagent/**`
|
||||
- **Active**: true
|
||||
- **Reason**: Owns P01 coverage for `cmd/orca` (smoke test of `main()`/`cli.Execute()`), `internal/cli` coverage for the non-node, non-daemon subcommands (`cert *`, `doctor *`, `audit list`, `status`, `version`), and the P03 `cmd/verify-reqs/main.go` Go program + `make verify-reqs` Makefile target + `.coreci.yml` validate-pipeline hook. Added `coverage-floor-70` constraint (D-047 tiered floor: 70% for the 6 under-50% packages, 50% for the 3 zero-test packages). Added `testing` + `net/http/httptest` to frameworks (test-only phase).
|
||||
|
||||
### backend-engineer
|
||||
- **Domain**: backend
|
||||
- **Frameworks**: `cobra`, `net/http`, `net/http/httptest`, `golang.org/x/crypto/ssh`, `golang.org/x/crypto/ssh/knownhosts`, `testing`
|
||||
- **Constraints**: `API-first`, `error-handling`, `minimal-dependencies`, `security-first`, `tofu-host-key-pinning`, `pinned-host-key-fail-closed`, `atomic-file-rewrite`, `coverage-floor-70`
|
||||
- **Territory**: `internal/transport/**`, `internal/engine/**`, `internal/proxmox/**`, `internal/cli/node.go`, `internal/daemon/**` (tests only)
|
||||
- **Active**: true
|
||||
- **Reason**: Owns P01 coverage for `internal/transport` (httptest.NewTLSServer for mTLS + stubDispatcher for DispatchClient) and `internal/engine` (LocalExecutor stubs + PeerRegistry in-memory tests). Owns P02 SSH trust hardening: `--host-key-fingerprint` pinned callback in `internal/proxmox/bootstrap.go` (D-045 OpenSSH SHA256:base64 format, AD-027/AD-028), the TOFU capture-fix (knownhosts.New returns KeyError{Want:[]} on first connect — must capture-and-persist via knownhosts.Line, AD-029 atomic rewrite), the `sessionRunner` seam refactor (P01 enabler for proxmox coverage), and `internal/cli/node.go` `--host-key-fingerprint` flag + `key-reset` subcommand (D-046 local known_hosts only). Frameworks updated: `connectrpc` REMOVED (not in go.mod per AD-014 — config.json still lists it but it's a stale entry), `golang.org/x/crypto/ssh` + `knownhosts` ADDED (direct dep since v0.6 D-030). Added `pinned-host-key-fail-closed` + `atomic-file-rewrite` + `coverage-floor-70` constraints.
|
||||
|
||||
### data-engineer
|
||||
- **Domain**: data
|
||||
- **Frameworks**: `modernc/sqlite`, `iter`, `hashicorp/hcl/v2`, `testing`
|
||||
- **Constraints**: `schema-first`, `migration-safe`, `local-storage-only`, `no-goroutine-leak`, `nullable-column-handling`, `coverage-floor-70`
|
||||
- **Territory**: `internal/store/**`, `internal/audit/**`, `internal/certpaths/**`, `internal/jobspec/**`, `internal/model/**`, `internal/store/migrations/**`
|
||||
- **Active**: true
|
||||
- **Reason**: Owns P01 coverage for `internal/store` (including the missing `cert_repo_test.go` — a v0.7 P01 leftover; Insert/Get/List/ListByNode/LatestForKind/PruneOlderThan/Delete + N=3 rotation history per REQ-025), `internal/audit` (sqlite-backed audit_log row asserts via `engine.Audit` + `store.AuditRepo`, slog capture via test handler), `internal/certpaths` (path-join asserts with temp dir + ORCA_HOME/ORCA_DB env), and `internal/jobspec` (golden-file HCL fixtures in a new `testdata/` dir + error-path table for Parse/Validate/ParseFile). Frameworks updated: `iter` + `hashicorp/hcl/v2` added (matches actual go.mod — jobspec uses hclsimple; store Watch uses iter.Seq). Added `coverage-floor-70` constraint.
|
||||
|
||||
### cli-engineer
|
||||
- **Active**: false (v0.8)
|
||||
- **Reason**: Deactivated — merged into lead-developer. The cli coverage work is test-only; `--host-key-fingerprint` and `key-reset` are a 1-flag and 1-subcommand addition to the existing `internal/cli/node.go`, not a new CLI subsystem.
|
||||
|
||||
### security-engineer
|
||||
- **Active**: false (v0.8)
|
||||
- **Reason**: Deactivated — v0.8 refines the existing proxmox SSH trust surface (pinned host-key callback, key-reset known_hosts rewrite) but does NOT add new security architecture (no new CA, no new X.509, no new crypto). The trust work is backend-engineer territory (SSH dialer + known_hosts file manipulation). The `internal/security/sshkey.go` is unchanged in v0.8. Was active in v0.6 (SSH keygen + sudoers), deactivated in v0.7, remains deactivated in v0.8.
|
||||
|
||||
### devops-engineer
|
||||
- **Active**: false (v0.8)
|
||||
- **Reason**: Deactivated — `verify-reqs` is a Go program (`cmd/verify-reqs/main.go`), not a CI/packaging change. The `.coreci.yml` edit is a 3-line validate-pipeline hook (lead-developer territory). No install.sh, Dockerfile, or release-pipeline surface in v0.8.
|
||||
|
||||
### network-engineer
|
||||
- **Active**: false (v0.8)
|
||||
- **Reason**: Deactivated — no transport/mTLS surface change. `internal/transport` coverage is test-only on the existing mTLS layer (httptest.NewTLSServer, no new TLS config). The SSH trust work is point-to-point bootstrap, not the mTLS mesh network-engineer owns.
|
||||
|
||||
### frontend-engineer
|
||||
- **Active**: false (v0.8)
|
||||
- **Reason**: No web UI in Orca (unchanged from v0.1 onward).
|
||||
|
||||
## Territory Enforcement
|
||||
|
||||
- **Mode**: `warn` (per `config.json`)
|
||||
- **Behavior**: Out-of-territory file changes log a warning but do not block.
|
||||
- **Key overlaps in v0.8** (lead-developer adjudicates):
|
||||
- `internal/cli/node.go` — backend-engineer (`--host-key-fingerprint` flag + `key-reset` subcommand + proxmox pass-through) vs lead-developer (cli coverage tests). Boundary: backend owns the command implementation; lead owns the test files (`node_test.go`).
|
||||
- `internal/proxmox/bootstrap.go` — backend-engineer (pinned callback, TOFU fix, sessionRunner seam) vs data-engineer (no overlap — proxmox has no store/audit code). Clean boundary.
|
||||
- `cmd/verify-reqs/main.go` — lead-developer (Go program + Makefile + .coreci.yml) vs data-engineer (no overlap — verify-reqs parses markdown, not DB). Clean boundary.
|
||||
- `internal/store/cert_repo_test.go` — data-engineer (test file) vs backend-engineer (no overlap — cert_repo is data territory). Clean boundary.
|
||||
|
||||
## v0.8 vs v0.7 Persona Diff
|
||||
|
||||
| Change | Rationale |
|
||||
|--------|-----------|
|
||||
| `lead-developer` retained | Owns cmd/orca smoke test, internal/cli coverage (non-node subcommands), cmd/verify-reqs Go program. |
|
||||
| `backend-engineer` retained | Owns internal/transport + internal/engine tests + SSH trust-surface in proxmox + cli/node. Frameworks corrected: connectrpc removed (not in go.mod), x/crypto/ssh added. |
|
||||
| `data-engineer` retained | Owns internal/store (cert_repo gap) + internal/audit + internal/certpaths + internal/jobspec tests. Frameworks corrected: iter + hcl/v2 added. |
|
||||
| `security-engineer` remains deactivated | v0.8 refines existing SSH trust surface, no new security architecture. |
|
||||
| `cli-engineer` remains deactivated | Merged into lead-developer (test-only + 1 flag + 1 subcommand). |
|
||||
| `devops-engineer` remains deactivated | verify-reqs is a Go program, not CI/packaging. |
|
||||
| `network-engineer` remains deactivated | No transport/mTLS surface change (test-only). |
|
||||
| `frontend-engineer` remains deactivated | No web UI. |
|
||||
|
||||
---
|
||||
|
||||
## v0.7 baseline (preserved for traceability)
|
||||
|
||||
---
|
||||
active_personas:
|
||||
- lead-developer
|
||||
@@ -28,11 +169,7 @@ reason: |
|
||||
- devops-engineer: DEACTIVATED — no packaging/distribution in v0.7.
|
||||
---
|
||||
|
||||
# Personas: Orca
|
||||
|
||||
## Roster
|
||||
|
||||
### lead-developer
|
||||
### lead-developer (v0.7)
|
||||
- **Domain**: coordination
|
||||
- **Frameworks**: `cobra`
|
||||
- **Constraints**: `boundary-enforcement`, `offline-first`, `no-redundant-implementations`
|
||||
@@ -40,7 +177,7 @@ reason: |
|
||||
- **Active**: true
|
||||
- **Reason**: Coordination across P01/P02/P03. SSH/bootstrap touches security + cli + store + doctor — territory overlaps need adjudication (proxmox package boundary, doctor Proxmox check scaffolding).
|
||||
|
||||
### backend-engineer
|
||||
### backend-engineer (v0.7)
|
||||
- **Domain**: backend
|
||||
- **Frameworks**: `cobra`, `net/http`, `golang.org/x/crypto/ssh`
|
||||
- **Constraints**: `API-first`, `error-handling`, `minimal-dependencies`, `security-first`, `idempotent-bootstrap`
|
||||
@@ -48,7 +185,7 @@ reason: |
|
||||
- **Active**: true
|
||||
- **Reason**: Owns the `orca init` full-bootstrap orchestration (CA + cert + db + localhost node, idempotent) and the `internal/proxmox/bootstrap.go` SSH session sequence (dial, deploy pubkey, useradd, pveum, sudoers, visudo validate). Added `idempotent-bootstrap` constraint (D-036 — re-run must be skip-and-refresh) and `golang.org/x/crypto/ssh` to frameworks.
|
||||
|
||||
### data-engineer
|
||||
### data-engineer (v0.7)
|
||||
- **Domain**: data
|
||||
- **Frameworks**: `modernc/sqlite`, `iter`
|
||||
- **Constraints**: `schema-first`, `migration-safe`, `local-storage-only`, `no-goroutine-leak`, `nullable-column-handling`
|
||||
@@ -56,7 +193,7 @@ reason: |
|
||||
- **Active**: true
|
||||
- **Reason**: Reactivated for v0.6. Owns migration `0006_node_kind_os.sql` (REQ-049 — nullable `kind`/`os` columns, backward-compatible) and `NodeRepo` schema extension (Insert/Get/List/Watch/scanNode column additions + new `GetByName`/`UpdateLastSeenAndOS` helpers). Added `nullable-column-handling` constraint (NULL → `""` in Go struct, not nil-deref).
|
||||
|
||||
### cli-engineer
|
||||
### cli-engineer (v0.7)
|
||||
- **Domain**: CLI/UX
|
||||
- **Frameworks**: `cobra`, `pflag`
|
||||
- **Constraints**: `discoverable-help`, `consistent-flag-naming`, `human-readable-output`, `machine-readable-json-flag`, `signal-handling`, `password-flag-redaction`
|
||||
@@ -64,7 +201,7 @@ reason: |
|
||||
- **Active**: true
|
||||
- **Reason**: Owns `orca init` multi-step bootstrap output UX (progress lines per step), `orca node join --type/--host/--user/--password/--proxmox-user/--proxmox-role` flag wiring, and `doctor os`/`doctor proxmox` subcommand wiring. Added `password-flag-redaction` constraint (D-031 — `--password` never echoed, prefer `$ORCA_PROXMOX_PASSWORD`, zero after use).
|
||||
|
||||
### security-engineer
|
||||
### security-engineer (v0.7)
|
||||
- **Domain**: security
|
||||
- **Frameworks**: `crypto/tls`, `crypto/x509`, `crypto/ed25519`, `golang.org/x/crypto/ssh`, `slog`
|
||||
- **Constraints**: `no-panic-in-production`, `structured-audit-logging`, `no-secret-in-logs`, `input-validation`, `least-privilege`, `tofu-host-key-pinning`, `noexec-sudoers`
|
||||
@@ -72,28 +209,19 @@ reason: |
|
||||
- **Active**: true
|
||||
- **Reason**: Reactivated for v0.6. Owns `internal/security/sshkey.go` (Ed25519 keygen, 0600/0644 mode enforcement per REQ-033 spirit), TOFU host-key pinning via `knownhosts.New`, sudoers least-privilege design (NOEXEC on pct/qm, exclude pvesh, no NOEXEC on apt-get/dpkg), password redaction (D-031), and audit logging of all bootstrap/join actions (REQ-052). Added `tofu-host-key-pinning` and `noexec-sudoers` constraints. Co-owns `internal/proxmox/**` with backend-engineer (security owns SSH auth + sudoers content; backend owns the session orchestration).
|
||||
|
||||
### devops-engineer
|
||||
### devops-engineer (v0.7)
|
||||
- **Active**: false (v0.6)
|
||||
- **Reason**: Deactivated — v0.6 has no install.sh, Dockerfile, .coreci.yml, or release-pipeline surface. The Proxmox SSH bootstrap is backend + security work, not devops. Was active in v0.5 (distribution milestone).
|
||||
|
||||
### network-engineer
|
||||
### network-engineer (v0.7)
|
||||
- **Active**: false (v0.6)
|
||||
- **Reason**: v0.6 has no transport/mTLS surface. SSH is point-to-point bootstrap, not the mTLS mesh network-engineer owns.
|
||||
|
||||
### frontend-engineer
|
||||
### frontend-engineer (v0.7)
|
||||
- **Active**: false (v0.6)
|
||||
- **Reason**: No web UI in Orca (unchanged from v0.1 onward).
|
||||
|
||||
## Territory Enforcement
|
||||
|
||||
- **Mode**: `warn` (per `config.json`)
|
||||
- **Behavior**: Out-of-territory file changes log a warning but do not block.
|
||||
- **Key overlaps in v0.6** (lead-developer adjudicates):
|
||||
- `internal/proxmox/bootstrap.go` — security-engineer (SSH auth, sudoers, PVE role) + backend-engineer (session orchestration, error handling). Boundary: security package exposes `BootstrapProxmox(ctx, opts) error`; the function lives in `internal/proxmox` but imports `internal/security` for SSH key handling.
|
||||
- `internal/doctor/doctor.go` `Proxmox()` — reuses `internal/proxmox` SSH client (security) but check scaffolding clones `doctor.Network()` pattern. Backend-engineer adjudicates (network-engineer deactivated).
|
||||
- `internal/store/node_repo.go` — data-engineer territory, but the `UpdateLastSeenAndOS` caller is `internal/cli/init.go` (backend). Standard repo-consumer boundary.
|
||||
|
||||
## v0.6 vs v0.5 Persona Diff
|
||||
### v0.6 vs v0.5 Persona Diff (v0.7 baseline reference)
|
||||
|
||||
| Change | Rationale |
|
||||
|--------|-----------|
|
||||
|
||||
@@ -0,0 +1,67 @@
|
||||
# Phase 1 Verification Report — v0.7: Register `orca cert` Command Tree
|
||||
|
||||
**Phase**: 1
|
||||
**Branch**: `phase/01-cert-register`
|
||||
**REQ Coverage**: REQ-053
|
||||
**Milestone**: v0.7 (Hardening & Completion)
|
||||
|
||||
## Structural Verification
|
||||
|
||||
### Files Modified
|
||||
- `internal/cli/cert.go` — added `init()` registering `NewCommand` on `rootCmd` (AD-022)
|
||||
- `internal/cli/init_test.go` — updated expected migration version 0006 → 0007
|
||||
- `internal/doctor/doctor_test.go` — relaxed DB check assertion to check `"migrations up to"` prefix (migration-version-agnostic)
|
||||
- `internal/store/migrate_test.go` — updated expected migration version 0006 → 0007
|
||||
|
||||
### Files Created
|
||||
- `internal/cli/cert_test.go` — regression test for cert command registration + subcommand tree
|
||||
- `internal/cli/cert_smoke_test.go` — end-to-end smoke test (ca-init, gen, show, fingerprint, renew, file modes)
|
||||
- `internal/store/cert_repo_test.go` — 11 tests covering Insert/Get/List/ListByNode/LatestForKind/PruneOlderThan/Delete + error paths
|
||||
- `internal/store/migrations/0007_certs_serial_unique.sql` — UNIQUE index on `certs.serial_hex` (I-107; migration-driven, not backfilled into 0004)
|
||||
|
||||
## Behavioral Verification
|
||||
|
||||
### Test Results
|
||||
```
|
||||
go test ./... → all PASS (exit 0)
|
||||
go test -race ./... → all PASS (exit 0)
|
||||
go vet ./... → clean
|
||||
make build → clean (v0.6.0)
|
||||
```
|
||||
|
||||
### Coverage (store package)
|
||||
- Store total: 60.5% (up from 46.9%)
|
||||
- `cert_repo.go`: Insert 91.7%, Get 100%, LatestForKind 100%, PruneOlderThan 85.7%, Delete 85.7%, List/ListByNode 81.8%
|
||||
|
||||
### CLI Smoke Test (manual)
|
||||
```
|
||||
./bin/orca cert → prints help (was: "unknown command")
|
||||
./bin/orca cert ca-init --cn X → ✓ CA initialized, 0644/0600 modes
|
||||
./bin/orca cert fingerprint --which ca → 64-char hex SHA-256
|
||||
```
|
||||
|
||||
## Security Verification
|
||||
|
||||
- `orca cert show` redacts private key material (REQ-035) — verified in smoke test
|
||||
- Cert file modes enforced: 0600 keys, 0644 certs (REQ-033) — verified in smoke test
|
||||
- No secrets in logs — `cert.ca_init`/`cert.issued`/`cert.renewed` log events contain only fingerprints, never key bytes
|
||||
- Migration 0007 is additive (UNIQUE index), backward-compatible — no data loss
|
||||
|
||||
## Quality Verification
|
||||
|
||||
- No new dependencies added (`go.mod` unchanged)
|
||||
- No comments added (per project convention)
|
||||
- Test style matches existing `node_repo_test.go` / `root_test.go` patterns
|
||||
- All `---ci---` blocks present in commits
|
||||
|
||||
## Must-Haves Checklist
|
||||
|
||||
- [x] `internal/cli/cert.go` — `init()` with `rootCmd.AddCommand(NewCommand(slog.Default()))`
|
||||
- [x] `internal/cli/cert_test.go` — regression test for registration + subcommands
|
||||
- [x] `internal/cli/cert_smoke_test.go` — e2e: ca-init, gen, show (redaction), fingerprint, renew, file modes
|
||||
- [x] `internal/store/cert_repo_test.go` — 11 tests covering full CRUD + rotation history + duplicate serial
|
||||
- [x] `internal/store/migrations/0007_certs_serial_unique.sql` — UNIQUE index (I-107)
|
||||
|
||||
## Verdict
|
||||
|
||||
**PASS** — all 4 verification layers (structural, behavioral, security, quality) pass. REQ-053 is fully covered. The `orca cert` command tree is now reachable from the CLI, cert_repo has comprehensive tests, and the serial_hex UNIQUE constraint is enforced via migration.
|
||||
@@ -0,0 +1,55 @@
|
||||
# Phase 1 Verification — v0.8 Coverage & Trust Hardening
|
||||
|
||||
**Phase**: P01 — Coverage uplift round 2
|
||||
**Milestone**: v0.8
|
||||
**REQ**: REQ-057
|
||||
**Date**: 2026-08-04
|
||||
**Result**: ✅ PASS (all 4 layers)
|
||||
|
||||
## Layer 1 — Structural ✅
|
||||
|
||||
- `go build ./...` PASS (no compile errors)
|
||||
- `go vet ./...` PASS (no warnings)
|
||||
- No TODOs/FIXMEs/stubs in production code (the 3 pre-existing placeholders in `internal/cli/job.go:78`, `internal/engine/scheduler.go:115`, `internal/security/tls_config.go:90` are unchanged from v0.7 and out of scope for P01)
|
||||
- All test files resolve imports correctly
|
||||
- The proxmox `sessionRunner` seam (T01.1) is backward compatible — `BootstrapProxmox` callers unchanged
|
||||
|
||||
## Layer 2 — Behavioral ✅
|
||||
|
||||
- `go test ./...` PASS (all 14 packages)
|
||||
- `go test -race ./...` PASS (cli 98s, engine 47s, store 88s, transport 22s, all others fast)
|
||||
- Coverage targets met (T01.12):
|
||||
- ≥70% floor: engine 88.9%, proxmox 87.1%, cli 76.2%, transport 93.0%, store 84.7%, jobspec 90.5%
|
||||
- ≥50% floor: audit 100.0%, certpaths 100.0%, cmd/orca 80.0%
|
||||
- GRILL condition #3 escape valve NOT needed (cli hit 76.2%, above 70%)
|
||||
- T01.2 (conditional `peerDispatcher` seam) NOT added — engine reached 88.9% via httptest + stubs
|
||||
- REQ-057 covered: all 9 target packages hit their tiered floor
|
||||
|
||||
## Layer 3 — Security ✅
|
||||
|
||||
- P01 is a test-only phase (the only production change is T01.1's `sessionRunner` interface extraction + T01.11's `main()→run()` refactor)
|
||||
- No new input paths, no new network surfaces, no new crypto
|
||||
- The `sessionRunner` seam does not leak test concerns into production (default `sshSessionRunner` wraps the real SSH session; the seam is only injectable via the package-level var pattern matching `sshDialer`)
|
||||
- `cmd/orca/main.go` refactor: `run() int` returns exit code; `main()` calls `os.Exit(run())` — no security impact (same behavior, testable)
|
||||
- No secrets in test code (all test DBs use `:memory:` or temp dirs; no real credentials)
|
||||
|
||||
## Layer 4 — Quality ✅
|
||||
|
||||
- Tests follow existing conventions (table-driven, `t.Run` subtests, `t.Helper()` in setup funcs)
|
||||
- Reuse of existing helpers: `openTestDB`, `withFastWatch`, `initTestEnv`, `resetRootFlags`, `discardWriter`, `stubDispatcher` pattern
|
||||
- No flaky tests detected (all pass on repeated runs with `-race`)
|
||||
- Test file naming follows `*_test.go` convention
|
||||
- No over-testing: daemon.go excluded from cli coverage (covered by `internal/daemon/server_test.go`)
|
||||
- P0 issues: none. P1+ issues: none flagged.
|
||||
|
||||
## Requirement Coverage
|
||||
|
||||
| REQ | Status | Evidence |
|
||||
|-----|--------|----------|
|
||||
| REQ-057 | ✅ Complete | All 9 packages hit tiered floor; `go test -cover` confirms; `go test -race` PASS |
|
||||
|
||||
## Lessons
|
||||
|
||||
- The `sessionRunner` seam pattern (package-level var + default init in entry func) is the canonical way to add testability to orca's SSH-dependent packages. Future SSH-adjacent packages should follow it.
|
||||
- `httptest.NewTLSServer` sufficed for engine 70% without needing the conditional `peerDispatcher` seam — the plan's "only if needed" guard worked as intended.
|
||||
- The cli package's 84s test time is dominated by `--watch` integration tests with real poll intervals. Future coverage work should consider reducing the `withFastWatch` interval further or extracting the watch logic for unit-level testing.
|
||||
@@ -0,0 +1,68 @@
|
||||
# Phase 2 Verification Report — v0.7: HCL Config File Parsing
|
||||
|
||||
**Phase**: 2
|
||||
**Branch**: `phase/02-config-parser`
|
||||
**REQ Coverage**: REQ-054
|
||||
**Milestone**: v0.7 (Hardening & Completion)
|
||||
|
||||
## Structural Verification
|
||||
|
||||
### Files Created
|
||||
- `internal/config/config.go` — `Config` struct (HCL tags), `CapacityConfig`, `Flags`, `Environ`, `Load(paths...)`, `(*Config).MergeOverrides(flags, env)`
|
||||
- `internal/config/config_test.go` — 11 tests (Load valid/missing/malformed/first-existing, MergeOverrides precedence all 4 layers, NodeCapacity)
|
||||
- `internal/config/testdata/config.hcl` — example fixture
|
||||
|
||||
### Files Modified
|
||||
- `internal/cli/root.go` — added `--config` persistent flag, `configCtxKey`, `configFromCtx` helper; `PersistentPreRunE` loads config if `--config` set (AD-023)
|
||||
- `internal/cli/daemon.go` — daemon uses `cfg.ListenAddr` from config when flag is at default (`:8080`) (D-039 precedence: flag > config)
|
||||
- `internal/cli/root_test.go` — added `TestConfigFlagRegistered` + `TestConfigFlagLoadsFile`
|
||||
|
||||
## Behavioral Verification
|
||||
|
||||
### Test Results
|
||||
```
|
||||
go test ./... → all PASS (exit 0)
|
||||
go test -race ./internal/config/... ./internal/cli/... → all PASS
|
||||
go vet ./... → clean
|
||||
make build → clean (v0.6.1)
|
||||
```
|
||||
|
||||
### API Surface
|
||||
```go
|
||||
func Load(paths ...string) (*Config, error)
|
||||
func (c *Config) MergeOverrides(flags Flags, env Environ) *Config
|
||||
```
|
||||
- `Load` returns zero `&Config{}` if no file exists (no error)
|
||||
- `MergeOverrides` precedence: flag > env > file > default (D-039)
|
||||
- No package-level state (AD-023)
|
||||
|
||||
### CLI Verification
|
||||
```
|
||||
./bin/orca --help → shows --config string flag
|
||||
```
|
||||
|
||||
## Security Verification
|
||||
|
||||
- Config file is read-only (no writes); parsed via `hclsimple.Decode` (no eval, no external commands)
|
||||
- No secrets in config (paths only; no tokens/keys in config.hcl)
|
||||
- Config file permissions not enforced (operator's responsibility; config contains no secrets)
|
||||
|
||||
## Quality Verification
|
||||
|
||||
- No new dependencies (`hashicorp/hcl/v2` already in go.mod for jobspec)
|
||||
- No comments added (per project convention)
|
||||
- Test style matches existing `jobspec/spec_test.go` + `cli/root_test.go`
|
||||
- `go.mod` unchanged
|
||||
|
||||
## Must-Haves Checklist
|
||||
|
||||
- [x] `internal/config/config.go` — Config struct + Load + MergeOverrides
|
||||
- [x] `internal/config/config_test.go` — 11 tests (all 4 precedence layers)
|
||||
- [x] `internal/config/testdata/config.hcl` — example fixture
|
||||
- [x] `internal/cli/root.go` — `--config` persistent flag + context wiring
|
||||
- [x] `internal/cli/daemon.go` — uses `cfg.ListenAddr` (flag still wins)
|
||||
- [x] `internal/cli/root_test.go` — config flag registration + load test
|
||||
|
||||
## Verdict
|
||||
|
||||
**PASS** — all 4 verification layers pass. REQ-054 is fully covered. The `internal/config` package provides HCL config file parsing with flag > env > file > default precedence, wired into the root command via `--config` and consumed by the daemon.
|
||||
@@ -0,0 +1,55 @@
|
||||
# Phase 2 Verification — v0.8 Coverage & Trust Hardening
|
||||
|
||||
**Phase**: P02 — SSH trust hardening
|
||||
**Milestone**: v0.8
|
||||
**REQs**: REQ-058, REQ-059 (+ latent TOFU bugfix closure)
|
||||
**Date**: 2026-08-04
|
||||
**Result**: ✅ PASS (all 4 layers)
|
||||
|
||||
## Layer 1 — Structural ✅
|
||||
|
||||
- `go build ./...` PASS
|
||||
- `go vet ./...` PASS
|
||||
- No TODOs/stubs in new production code
|
||||
- All new exports resolve: `security.SSHFingerprintSHA256`, `security.WriteAtomic`, `proxmox.TOFUHostKeyCallback`, `proxmox.ResetHostKey`, `proxmox.pinnedHostKeyCallback`, `proxmox.Options.HostKeyFingerprint`, `cli.nodeKeyResetCmd`
|
||||
- Backward compatible: existing `BootstrapProxmox` callers work (the TOFU fix changed failure→success on first connect, which is the bugfix)
|
||||
|
||||
## Layer 2 — Behavioral ✅
|
||||
|
||||
- `go test ./internal/proxmox/... ./internal/cli/... ./internal/doctor/... ./internal/security/...` PASS
|
||||
- `go test -race ./internal/proxmox/... ./internal/doctor/...` PASS
|
||||
- Coverage held post-P02: proxmox 86.5% (was 87.1% in P01 — marginal change from new code paths), cli 76.7% (was 76.2%), doctor 70.4% (unchanged)
|
||||
- T02.10: all 7 end-to-end integration cases PASS (pinned correct/wrong, TOFU first/second/mismatch, key-reset+re-pin, pre-populated migration path)
|
||||
- T02.11: `--host-key-fingerprint` non-proxmox validation PASS
|
||||
|
||||
## Layer 3 — Security ✅
|
||||
|
||||
- **REQ-058**: `--host-key-fingerprint` fails closed on mismatch (pinnedHostKeyCallback returns error on any mismatch; bootstrap aborts before any SSH session command runs). SHA256: prefix validated up front. No downgrade to TOFU when pin supplied.
|
||||
- **REQ-059**: `orca node key-reset` is local-only (D-046) — only rewrites `~/.orca/known_hosts` via `security.WriteAtomic` (atomic temp+rename, AD-029); does NOT touch remote authorized_keys. Audit-logs `node.key_reset` with actor+node+host.
|
||||
- **TOFU bugfix (T02.6, v0.6 ship-defect)**: first-connect now captures + writes the key (was silently failing). Mismatch detection preserved (MITM protection). The `TOFUHostKeyCallback` is shared between bootstrap (T02.6) and doctor (T02.9) — GRILL condition #2 parity satisfied.
|
||||
- STRIDE: no new spoofing surface (pin is operator-supplied, fail-closed); no tampering (atomic rewrite); no repudiation (audit log); no info disclosure (fingerprint is a hash, not the key); no DoS (no network change); no elevation (local file ops only).
|
||||
- No secrets in test code (fake SSH keys generated in-test).
|
||||
|
||||
## Layer 4 — Quality ✅
|
||||
|
||||
- Tests follow existing conventions (table-driven, `fakeSSHServer` fixture reused, `sshDialer`/`sessionRunner` seams injected)
|
||||
- `TOFUHostKeyCallback` extracted to a shared helper (no duplication between bootstrap + doctor) — clean coupling (proxmox doesn't import doctor)
|
||||
- P0 issues: none. P1+ issues: none flagged.
|
||||
|
||||
## Requirement Coverage
|
||||
|
||||
| REQ | Status | Evidence |
|
||||
|-----|--------|----------|
|
||||
| REQ-058 | ✅ Complete | `--host-key-fingerprint` flag (T02.3) + `pinnedHostKeyCallback` (T02.5) + `Result.HostKeyFingerprint` (T02.7) + e2e tests (T02.10) + validation (T02.11) |
|
||||
| REQ-059 | ✅ Complete | `orca node key-reset <node>` (T02.8) + `proxmox.ResetHostKey` atomic rewrite + audit log + e2e test (T02.10 case 6) |
|
||||
| (TOFU bugfix) | ✅ Complete | T02.6 fixes v0.6 ship-defect (first-connect `knownhosts.New` KeyError{Want:[]} treated as dial failure); T02.9 doctor parity |
|
||||
|
||||
## GRILL Conditions Check
|
||||
|
||||
- **#1 (T02.6 labeled v0.6 ship-defect)**: ✅ commit `8b0cbe1` summary "TOFU capture bug — v0.6 ship-defect first-connect join always failed"
|
||||
- **#2 (T02.9 doctor parity)**: ✅ both bootstrap (`8b0cbe1`) and doctor (`2dcb143`) use the shared `proxmox.TOFUHostKeyCallback` wrapper
|
||||
|
||||
## Lessons
|
||||
|
||||
- The v0.6 TOFU bug was a latent ship-defect: `knownhosts.New` returns `KeyError{Want:[]}` on first connect without writing, and the original code treated this as a dial failure. This means first-connect Proxmox join has been broken since v0.6 shipped — a strong argument for P01's coverage uplift (the 5.1% proxmox coverage hid this). v0.8 P03's `verify-reqs` would not have caught this (it's code-vs-doc drift, not doc-vs-doc) — P04 audit is the backstop.
|
||||
- Extracting `TOFUHostKeyCallback` to a shared helper was the right call for GRILL condition #2 — duplicating the wrapper in doctor would have created drift risk.
|
||||
@@ -0,0 +1,76 @@
|
||||
# Phase 3 Verification Report — v0.7: Test Coverage Uplift
|
||||
|
||||
**Phase**: 3
|
||||
**Branch**: `phase/03-coverage-uplift`
|
||||
**REQ Coverage**: REQ-055
|
||||
**Milestone**: v0.7 (Hardening & Completion)
|
||||
|
||||
## Structural Verification
|
||||
|
||||
### Files Created
|
||||
- `internal/engine/peer_test.go` — 8 tests (PeerRegistry Add/Get/Remove/All/Len/UpdateLastSeen + validation)
|
||||
- `internal/engine/executor_test.go` — 7 tests (Submit success/missing-command/malformed/failing, Status not-found, Run success, Run context-cancel)
|
||||
- `internal/engine/dispatcher_test.go` — 10 tests (empty spec, idempotency hit, local-capacity, explicit-target, no-peers, LocalSubmit/LocalStatus, nil guards, parseInlineSpec)
|
||||
- `internal/audit/audit_test.go` — 9 tests (Emit/EmitWithErr persistence, LogHandshakeOK/Failed slog fields, nil-safety, Action/Result String, FormatAction)
|
||||
- `internal/transport/handshake_log_test.go` — 8 tests (LogHandshakeOK/Failed/FromCert, FingerprintOfCert, nil-logger, nil-err)
|
||||
- `internal/transport/mtls_test.go` — 14 tests (ServerTLSConfig, ClientTLSConfig, NewMTLSClient, Do, VerifyPeerCertificate, DialContext)
|
||||
- `internal/transport/dispatch_test.go` — 24 tests (SubmitHandler/StatusHandler, DispatchClient constructor/connection-refused/HTTP/decode/Submit/Status success)
|
||||
- `internal/proxmox/ssh_session_test.go` — 14 tests (runRemote, deployPubKey, createLinuxUser, createPVERole, createPVEUser, assignPVEACL, writeSudoers, validateSudoers, full BootstrapProxmox)
|
||||
|
||||
### Files Modified
|
||||
- `internal/transport/dispatch.go` — **bug fix**: `bytesReadCloser.Read` returned `fmt.Errorf("EOF")` instead of `io.EOF`, breaking HTTP request body transmission. This was a latent bug that prevented any client-side dispatch from working end-to-end.
|
||||
- `internal/proxmox/bootstrap_test.go` — extended with 10 new tests (mockSSHDialer, SSH auth failure, dial-addr/port/user propagation, SSH key generation, known_hosts, nil/custom logger, cancelled context, deployPubKey edge cases)
|
||||
|
||||
## Behavioral Verification
|
||||
|
||||
### Test Results
|
||||
```
|
||||
go test ./... → all PASS (exit 0)
|
||||
go test -race ./... → all PASS (exit 0)
|
||||
go vet ./... → clean
|
||||
make build → clean
|
||||
```
|
||||
|
||||
### Coverage (D-042 target: ≥ 50% per package)
|
||||
|
||||
| Package | Before | After | Target |
|
||||
|---------|--------|-------|--------|
|
||||
| `internal/engine` | 8.3% | **65.1%** | 50% ✓ |
|
||||
| `internal/transport` | 26.3% | **84.6%** | 50% ✓ |
|
||||
| `internal/proxmox` | 5.1% | **82.7%** | 50% ✓ |
|
||||
| `internal/audit` | 0% | **100.0%** | 50% ✓ |
|
||||
|
||||
All 4 packages exceed the 50% floor (AD-025).
|
||||
|
||||
### Total new tests: 94 (37 engine+audit + 57 transport+proxmox)
|
||||
|
||||
## Security Verification
|
||||
|
||||
- The `dispatch.go` bug fix (`io.EOF` vs `fmt.Errorf("EOF")`) is a correctness fix — HTTP request bodies now terminate correctly. No security implications (the bug caused requests to fail, not to leak data).
|
||||
- No new dependencies added.
|
||||
- Test fixtures use temp dirs (`t.TempDir()`) — no persistent state.
|
||||
- No secrets in test code (SSH keys are test-generated Ed25519 pairs).
|
||||
|
||||
## Quality Verification
|
||||
|
||||
- No comments added (per project convention).
|
||||
- Test style matches existing patterns (`scheduler_test.go`, `node_repo_test.go`, `certgen_test.go`).
|
||||
- `go.mod` unchanged.
|
||||
- Bug fix in `dispatch.go` is minimal (1 line: `return fmt.Errorf("EOF")` → `return io.EOF` + `io` import).
|
||||
|
||||
## Must-Haves Checklist
|
||||
|
||||
- [x] `internal/engine/executor_test.go` — 7 tests
|
||||
- [x] `internal/engine/dispatcher_test.go` — 10 tests
|
||||
- [x] `internal/engine/peer_test.go` — 8 tests
|
||||
- [x] `internal/transport/mtls_test.go` — 14 tests
|
||||
- [x] `internal/transport/dispatch_test.go` — 24 tests
|
||||
- [x] `internal/transport/handshake_log_test.go` — 8 tests
|
||||
- [x] `internal/audit/audit_test.go` — 9 tests
|
||||
- [x] `internal/proxmox/ssh_session_test.go` — 14 tests + extended `bootstrap_test.go` (+10 tests)
|
||||
- [x] Bug fix: `dispatch.go` bytesReadCloser EOF (latent bug, root-caused during P03)
|
||||
- [x] All 4 target packages ≥ 50% coverage
|
||||
|
||||
## Verdict
|
||||
|
||||
**PASS** — all 4 verification layers pass. REQ-055 is fully covered. All 4 target packages exceed the 50% coverage floor (engine 65.1%, transport 84.6%, proxmox 82.7%, audit 100%). A latent bug in `dispatch.go` (non-`io.EOF` return) was found and fixed during coverage uplift.
|
||||
@@ -0,0 +1,51 @@
|
||||
# Phase 3 Verification — v0.8 Coverage & Trust Hardening
|
||||
|
||||
**Phase**: P03 — Requirements-hygiene gate
|
||||
**Milestone**: v0.8
|
||||
**REQ**: REQ-060
|
||||
**Date**: 2026-08-04
|
||||
**Result**: ✅ PASS (all 4 layers)
|
||||
|
||||
## Layer 1 — Structural ✅
|
||||
|
||||
- `go build ./...` PASS
|
||||
- `go vet ./...` PASS
|
||||
- `cmd/verify-reqs/main.go` (~180 LOC, stdlib only) compiles + links
|
||||
- All exports resolve: `verify(roadmapPath, reqsPath) (diff []string, count int, err error)`
|
||||
- No new dependencies
|
||||
|
||||
## Layer 2 — Behavioral ✅
|
||||
|
||||
- `go test ./cmd/verify-reqs/...` PASS (7 golden-file tests: clean, multi-drift, default-args, malformed, missing-file, v0.2-substring-tolerant, real-repo regression)
|
||||
- `make verify-reqs` → exit 0 on the current repo (`✓ 60 requirements consistent with roadmap`)
|
||||
- T03.5 synthetic drift verification: scratch flip of REQ-053 → `make verify-reqs` exit 1 + `REQ-053: status=Pending, expected=Complete (direction=forward)`; revert → exit 0
|
||||
- `go test ./...` PASS (all 16 packages)
|
||||
- Forward + reverse assertions both exercised (golden test `TestVerify_drift` asserts `direction=reverse` for REQ-003)
|
||||
|
||||
## Layer 3 — Security ✅
|
||||
|
||||
- verify-reqs is a static doc-consistency checker — no network, no secrets, no input injection (markdown is parsed with `regexp` over local files only)
|
||||
- `.coreci.yml` step runs in the existing `golang:1.25` container (no new image, no new permissions)
|
||||
- No STRIDE surface added
|
||||
|
||||
## Layer 4 — Quality ✅
|
||||
|
||||
- Testable core (`verify()` function) + thin `main()` — follows the `cmd/orca/main.go` → `run()` pattern from T01.11
|
||||
- Golden-file test fixtures cover the substring-tolerant regex regression (v0.2 header variant)
|
||||
- GRILL condition #4 satisfied: substring-tolerant regex + reverse-direction assertion + scope note (doc-vs-doc only)
|
||||
- P0 issues: none. P1+ issues: none flagged.
|
||||
|
||||
## Requirement Coverage
|
||||
|
||||
| REQ | Status | Evidence |
|
||||
|-----|--------|----------|
|
||||
| REQ-060 | ✅ Complete | `cmd/verify-reqs` (T03.1) + golden tests (T03.2) + `make verify-reqs` (T03.3) + `.coreci.yml` validate hook (T03.4) + synthetic drift verification (T03.5) |
|
||||
|
||||
## GRILL Conditions Check
|
||||
|
||||
- **#4 (verify-reqs regex + reverse direction)**: ✅ substring-tolerant regex matches v0.2's `**COMPLETE (merged to main via v0.3)**` header (golden test `TestVerify_v0_2_substring_tolerant`); reverse-direction assertion implemented + tested; scope note documented in the commit + the verification report.
|
||||
|
||||
## Lessons
|
||||
|
||||
- The two-regex parser (one for REQ rows, one for milestone-complete headers) with substring tolerance is the right shape — a single strict regex would have silently exempted v0.2 (the exact drift the GRILL flagged).
|
||||
- Refactoring `main()` into a testable `verify()` function made golden-file testing trivial (no subprocess orchestration). This mirrors the T01.11 `main()→run()` pattern and should be the house style for all `cmd/` programs.
|
||||
@@ -0,0 +1,64 @@
|
||||
# Phase 4 Verification Report — v0.7: --pprof Opt-in on orca daemon
|
||||
|
||||
**Phase**: 4
|
||||
**Branch**: `phase/04-pprof-daemon`
|
||||
**REQ Coverage**: REQ-056
|
||||
**Milestone**: v0.7 (Hardening & Completion)
|
||||
|
||||
## Structural Verification
|
||||
|
||||
### Files Created
|
||||
- `internal/daemon/pprof.go` — `StartPprof(addr, log) (*http.Server, error)`: dedicated mux + server, disabled by default, WARN log
|
||||
- `internal/daemon/pprof_test.go` — 5 tests (disabled, enabled, shutdown, mux isolation, full server lifecycle)
|
||||
- `internal/cli/daemon_test.go` — `TestDaemonPprofFlag` (flag registration + default)
|
||||
|
||||
### Files Modified
|
||||
- `internal/daemon/server.go` — `PprofAddr` in Options, `pprofServer` field, `NewServer` starts pprof, `Shutdown` stops both
|
||||
- `internal/cli/daemon.go` — `--pprof` flag, `PprofAddr` in daemon.Options, conditional startup output line
|
||||
|
||||
## Behavioral Verification
|
||||
|
||||
### Test Results
|
||||
```
|
||||
go test ./... → all PASS (exit 0)
|
||||
go test -race ./internal/daemon/... ./internal/cli/... → all PASS
|
||||
go vet ./... → clean
|
||||
make build → clean
|
||||
```
|
||||
|
||||
### CLI Verification
|
||||
```
|
||||
./bin/orca daemon --help → shows --pprof string flag (default "")
|
||||
```
|
||||
|
||||
### Live Smoke Test
|
||||
- `--pprof 127.0.0.1:16060` → WARN logged, `/debug/pprof/` returns 200, `/debug/pprof/cmdline` 200, `/debug/pprof/heap` 200
|
||||
- `/healthz` on pprof listener → 404 (mux isolation confirmed, AD-024)
|
||||
- Clean shutdown stops both servers
|
||||
|
||||
## Security Verification
|
||||
|
||||
- pprof on a **separate** `*http.Server` + `*http.ServeMux`, never on the mTLS daemon listener (AD-024) — verified by `TestStartPprof_MuxIsolated` (`/healthz` returns 404 on pprof mux)
|
||||
- Default **disabled** — no pprof listener unless `--pprof` is explicitly set
|
||||
- WARN log on startup: "unauthenticated, operator-only — do not expose publicly"
|
||||
- No `import _ "net/http/pprof"` side-effect registration on `DefaultServeMux` — all handlers explicitly registered on the dedicated mux
|
||||
|
||||
## Quality Verification
|
||||
|
||||
- No new dependencies (stdlib `net/http`, `net/http/pprof`, `log/slog`, `time` only)
|
||||
- No comments added (per project convention)
|
||||
- `go.mod` unchanged
|
||||
- Test style matches existing `server_test.go`
|
||||
|
||||
## Must-Haves Checklist
|
||||
|
||||
- [x] `internal/daemon/pprof.go` — `StartPprof` with dedicated mux, all pprof handlers
|
||||
- [x] `internal/daemon/server.go` — `PprofAddr` in Options, `pprofServer` field, lifecycle integration
|
||||
- [x] `internal/cli/daemon.go` — `--pprof` flag, passed to Options, conditional startup output
|
||||
- [x] `internal/daemon/pprof_test.go` — 5 tests (disabled, enabled, shutdown, mux isolation, lifecycle)
|
||||
- [x] `internal/cli/daemon_test.go` — flag registration test
|
||||
- [x] AD-024: pprof mux separate from mTLS daemon mux (verified by test)
|
||||
|
||||
## Verdict
|
||||
|
||||
**PASS** — all 4 verification layers pass. REQ-056 is fully covered. The `--pprof` opt-in endpoint runs on a separate listener with a dedicated mux, is disabled by default, and logs a WARN when enabled. I-308 (deferred since v0.2) is now implemented.
|
||||
@@ -0,0 +1,347 @@
|
||||
# Phase Plans: Orca v0.8 — Coverage & Trust Hardening
|
||||
|
||||
All 4 execution phases + final review with vertical-slice structure, wave
|
||||
ordering, persona assignment, and REQ-ID mapping. v0.8 scope: **Coverage &
|
||||
Trust Hardening** — round-2 test coverage uplift across 9 packages (tiered
|
||||
floor: ≥70% for 6 retested, ≥50% for 3 zero-test per D-047), SSH trust
|
||||
hardening (`--host-key-fingerprint` pre-pin + `orca node key-reset` + latent
|
||||
TOFU capture-fix + `Result.HostKeyFingerprint` population), and a
|
||||
requirements-hygiene gate (`make verify-reqs`).
|
||||
|
||||
Branching: `phase/01-coverage-round2`..`phase/04-final-review-ship` on the
|
||||
`milestone/v0.8-coverage-trust-hardening` branch (numbering restarts per
|
||||
milestone per branch-strategy.md).
|
||||
|
||||
Milestone type: **NFR** (P01 test, P02 chore on the trust surface per D-043,
|
||||
P03 chore, P04 docs/review). Tags run on the v0.7.x patch line: `v0.7.0`
|
||||
(P0) … `v0.7.4` (P04 = milestone release).
|
||||
|
||||
**Vertical-slice integrity**: each phase is independently shippable.
|
||||
- **P01** ships tests-only (no production code changes except the proxmox
|
||||
`sessionRunner` seam, a backward-compatible interface extraction, and the
|
||||
engine `peerDispatcher` seam per RESEARCH §1.3).
|
||||
- **P02** ships the SSH trust features + TOFI bugfix + `Result` population.
|
||||
- **P03** ships the hygiene gate (Go program + Makefile + CI hook).
|
||||
- **P04** is review + ship + audit (no new REQs).
|
||||
|
||||
**Out of scope for v0.8** (candidate for v0.9, noted not added):
|
||||
- Lifting the 3 zero-test packages from 50% → 70% (D-047 explicitly
|
||||
toes-holds them; v0.9 can raise the floor).
|
||||
- A `peerDispatcher` interface seam in engine beyond what P01 needs for 70%
|
||||
coverage (httptest.NewTLSServer suffices; the seam is only added if
|
||||
coverage cannot otherwise hit 70%).
|
||||
- Pre-populating `known_hosts` from a remote keyscan API (TOFU + manual
|
||||
`--host-key-fingerprint` cover the v0.8 trust surface).
|
||||
- `verify-reqs` reverse-direction check (REQUIREMENTS Complete ↔ ROADMAP
|
||||
COMPLETE both ways) — forward direction (ROADMAP-shipped → REQUIREMENTS
|
||||
Complete) is the priority per the v0.7 drift that motivated REQ-060.
|
||||
|
||||
**Carried-forward research findings** (RESEARCH_v0.8.md, must incorporate):
|
||||
- §1.1 per-package coverage strategies + tiered floors (D-047).
|
||||
- §1.3 injected seams: reuse `sshDialer` (proxmox), `LocalExecutor` (engine),
|
||||
`Dispatcher` (transport), `watchInterval` (store), `openTestDB`/`withFastWatch`/`initTestEnv`/`resetRootFlags`/`stubDispatcher` helpers.
|
||||
- §1.4 realism flags: cli excludes `daemon.go`; `cmd/orca` 50% toe-hold only;
|
||||
proxmox needs the `sessionRunner` seam to hit 70%.
|
||||
- §2.1 latent TOFU capture bug (knownhosts.New returns KeyError{Want:[]} on
|
||||
first connect and does NOT auto-write — current BootstrapProxmox treats it
|
||||
as a dial failure).
|
||||
- §2.2 `Result.HostKeyFingerprint` is declared but never populated (always
|
||||
`""`); P02 must add `ssh.FingerprintSHA256` computation.
|
||||
- §2.3 `--host-key-fingerprint` plugs in at `internal/cli/node.go` (flag) +
|
||||
`internal/proxmox/bootstrap.go` (pinned callback).
|
||||
- §2.4 `key-reset` is local-known_hosts-only (D-046), atomic rewrite (AD-029).
|
||||
- §3 verify-reqs is a Go program at `cmd/verify-reqs/main.go` (~80 LOC,
|
||||
stdlib only, AD-030) + `make verify-reqs` + `.coreci.yml` validate hook.
|
||||
- §4 AD-025..AD-030 (renumbered AD-027..AD-030 in research for SSH/trust;
|
||||
AD-025/AD-026 from earlier milestones are stable).
|
||||
- §5 10 pitfalls carried into the risk register at the end of this file.
|
||||
|
||||
**Dependencies (RESEARCH §6)**: v0.8 adds **zero** new direct dependencies.
|
||||
`ssh.FingerprintSHA256`, `knownhosts.Line`/`Normalize`/`KeyError` are in the
|
||||
existing `golang.org/x/crypto` v0.54.0 dep. `verify-reqs` is stdlib-only.
|
||||
`go.mod` is unchanged by v0.8.
|
||||
|
||||
---
|
||||
|
||||
## Phase 1: Coverage Uplift Round 2 (REQ-057)
|
||||
|
||||
**Branch**: `phase/01-coverage-round2`
|
||||
**REQ Coverage**: REQ-057
|
||||
**Tag**: `v0.7.1`
|
||||
**Depends on**: Phase 0 (this plan + clarify + research)
|
||||
**Source research**: RESEARCH_v0.8.md §1 (per-package strategies, helpers, seams)
|
||||
|
||||
### Tiered floor (D-047)
|
||||
|
||||
| Package | Current | Floor | Owner persona |
|
||||
|---------|---------|-------|---------------|
|
||||
| `internal/engine` | 8.3% | ≥ 70% | backend-engineer |
|
||||
| `internal/proxmox` | 5.1% | ≥ 70% | backend-engineer |
|
||||
| `internal/cli` | 27.6% | ≥ 70% (excluding `daemon.go`) | lead-developer |
|
||||
| `internal/transport` | 26.3% | ≥ 70% | backend-engineer |
|
||||
| `internal/store` | 47.2% | ≥ 70% | data-engineer |
|
||||
| `internal/jobspec` | 47.6% | ≥ 70% | data-engineer |
|
||||
| `internal/audit` | 0% (no tests) | ≥ 50% toe-hold | data-engineer |
|
||||
| `internal/certpaths` | 0% (no tests) | ≥ 50% toe-hold | data-engineer |
|
||||
| `cmd/orca` | 0% (no tests) | ≥ 50% toe-hold | lead-developer |
|
||||
|
||||
### Wave 1 — Seams + foundational test helpers (no production logic changes)
|
||||
|
||||
These are backward-compatible interface extractions that unlock the bulk of
|
||||
coverage in Wave 2. They are the only production-code changes in P01; all
|
||||
other P01 tasks add `_test.go` files only.
|
||||
|
||||
| Task ID | Owner | Wave | Must | Title | Files touched | Acceptance criterion |
|
||||
|---------|-------|------|------|-------|---------------|----------------------|
|
||||
| T01.1 | backend-engineer | 1 | Y | Add `sessionRunner` interface seam to proxmox | `internal/proxmox/bootstrap.go` | Extract a `sessionRunner` interface (`CombinedOutput(cmd string) ([]byte, error)`) ~10 LOC; default impl wraps `*ssh.Client.NewSession().CombinedOutput(...)`; `runRemote`/`deployPubKey`/`createLinuxUser`/`createPVERole`/`createPVEUser`/`assignPVEACL`/`writeSudoers`/`validateSudoers` use the seam. Backward compatible: existing callers unchanged. `go build ./internal/proxmox` PASS. (RESEARCH §1.3 gap #1, §5 pitfall #3) |
|
||||
| T01.2 | backend-engineer | 1 | N | Add `peerDispatcher` seam to engine (only if needed for 70%) | `internal/engine/dispatcher.go` | Extract a `peerDispatcher` interface (`Submit(ctx, spec, key) (*SubmitResponse, error)`) so `dispatchToPeer` is testable without `httptest.NewTLSServer`. **Only add if T01.5 cannot otherwise hit 70% via `httptest.NewTLSServer` alone.** If added, backward compatible. (RESEARCH §1.3 gap #2, §5 pitfall #8) |
|
||||
|
||||
### Wave 2 — Per-package coverage tests (build on Wave 1 seams)
|
||||
|
||||
| Task ID | Owner | Wave | Must | Title | Files touched | Acceptance criterion |
|
||||
|---------|-------|------|------|-------|---------------|----------------------|
|
||||
| T01.3 | backend-engineer | 2 | Y | `internal/transport` tests → ≥ 70% | `internal/transport/mtls_test.go` (NEW), `internal/transport/dispatch_test.go` (NEW), `internal/transport/handshake_log_test.go` (NEW), `internal/transport/retry_test.go` (NEW, extend) | `httptest.NewTLSServer` with a test CA (reuse `security.CAInit`/`GenerateCSR`/`SignCSR` per RESEARCH §1.2) for mTLS handshake paths; `stubDispatcher` (daemon/dispatch_test.go:24) pattern for Dispatch RPC; capture slog via a test `slog.Handler` for handshake_log. `go test -cover ./internal/transport` → ≥ 70% (was 26.3%). |
|
||||
| T01.4 | backend-engineer | 2 | Y | `internal/engine` tests → ≥ 70% | `internal/engine/executor_test.go` (NEW), `internal/engine/dispatcher_test.go` (NEW), `internal/engine/peer_test.go` (NEW), `internal/engine/scheduler_test.go` (extend), `internal/engine/registry_test.go` (NEW, if registry exists) | `Executor.Start`/`Wait` lifecycle (echo/false/ctx-cancel/Env propagation per REQ-021); `Dispatcher.Submit` with stubbed `LocalExecutor` + (if T01.2 added) stubbed `peerDispatcher` OR `httptest.NewTLSServer`; `PeerRegistry` in-memory Add/Remove/All/Get. Reuse `openTestDB` (node_repo_test.go:12). `go test -cover ./internal/engine` → ≥ 70% (was 8.3%). |
|
||||
| T01.5 | backend-engineer | 2 | Y | `internal/proxmox` tests → ≥ 70% | `internal/proxmox/bootstrap_test.go` (extend) | Swap `sshDialer` (existing seam) for a fake returning a mock `*ssh.Client`; swap `sessionRunner` (T01.1 seam) for a fake that returns canned `CombinedOutput` bytes. Assert full bootstrap sequence calls the right shell commands in order; idempotent re-run ("already exists" → no-op); SSH auth failure → wrapped error; no password logged (D-031). `go test -cover ./internal/proxmox` → ≥ 70% (was 5.1%). |
|
||||
| T01.6 | lead-developer | 2 | Y | `internal/cli` tests → ≥ 70% (excluding daemon.go) with GRILL condition #3 escape valve | `internal/cli/node_test.go` (NEW), `internal/cli/job_test.go` (NEW), `internal/cli/cert_test.go` (NEW), `internal/cli/doctor_test.go` (NEW), `internal/cli/audit_test.go` (NEW), `internal/cli/status_test.go` (NEW), `internal/cli/version_test.go` (NEW), `internal/cli/node_capacity_test.go` (NEW) | Table-driven `rootCmd.Execute()` against temp `ORCA_HOME` per subcommand (reuse `initTestEnv`/`resetRootFlags`/`discardWriter` per RESEARCH §1.2). Mock the proxmox path via `sshDialer` + `sessionRunner` seams. `daemon.go` is excluded — covered by `internal/daemon/server_test.go`. `go test -cover ./internal/cli` → ≥ 70% of non-daemon files (document the exclusion in a test-file comment). **GRILL condition #3 escape valve**: if 70% is not reached after Wave 2 effort and ≥ 65% is achieved (RESEARCH §1.4 flags 55-65% as realistic for one phase), ship cli at 65% and do NOT block P02/P03 on the last 5%; record the shortfall + rationale in the P01 verification commit. |
|
||||
| T01.7 | data-engineer | 2 | Y | `internal/store` tests → ≥ 70% (incl. missing `cert_repo_test.go`) | `internal/store/cert_repo_test.go` (NEW — v0.7 P01 leftover, RESEARCH §1.1), `internal/store/node_repo_test.go` (extend), `internal/store/job_task_repo_test.go` (extend), `internal/store/audit_repo_test.go` (extend), `internal/store/capacity_repo_test.go` (extend) | `cert_repo_test.go`: Insert/Get/List/ListByNode/LatestForKind/PruneOlderThan/Delete + N=3 rotation history per REQ-025 + duplicate-serial error. Reuse `openTestDB`/`withFastWatch` (RESEARCH §1.2). `go test -cover ./internal/store` → ≥ 70% (was 47.2%). |
|
||||
| T01.8 | data-engineer | 2 | Y | `internal/jobspec` tests → ≥ 70% | `internal/jobspec/spec_test.go` (extend), `internal/jobspec/testdata/*.hcl` (NEW golden fixtures) | Golden-file HCL fixtures (multi-task, env vars, args) + error-path table (missing job, no tasks, missing command, malformed HCL, empty file, nonexistent file for `ParseFile`). `go test -cover ./internal/jobspec` → ≥ 70% (was 47.6%). |
|
||||
| T01.9 | data-engineer | 2 | Y | `internal/audit` first tests → ≥ 50% toe-hold | `internal/audit/audit_test.go` (NEW) | Construct `Audit` with real `engine.Audit` backed by `:memory:` sqlite (via `store.NewAuditRepo` + `engine.NewAudit`); assert rows in `audit_log` table; capture slog via a test `slog.Handler` for `LogHandshakeOK`/`LogHandshakeFailed`. `go test -cover ./internal/audit` → ≥ 50% (was 0%). |
|
||||
| T01.10 | data-engineer | 2 | Y | `internal/certpaths` first tests → ≥ 50% toe-hold | `internal/certpaths/certpaths_test.go` (NEW) | Temp dir + `t.Setenv("ORCA_HOME", dir)` + assert each `*Path()` returns `filepath.Join(dir, <file>)`; test `ORCA_DB` override; test default-to-`~/.orca` fallback. Model on `namespace_test.go` (cli). `go test -cover ./internal/certpaths` → ≥ 50% (was 0%). |
|
||||
| T01.11 | lead-developer | 2 | Y | `cmd/orca` smoke test → ≥ 50% toe-hold | `cmd/orca/main_test.go` (NEW), possibly `cmd/orca/main.go` (refactor `main()` into `run() int` for testability) | Refactor `main()` to `run() int` (returns exit code; `main()` calls `os.Exit(run())`) so the test can call `run()` directly with a forced error path and assert non-zero exit + stderr contains "error:". Low-effort toe-hold — do NOT over-invest (RESEARCH §1.1, §5 pitfall #6). `go test -cover ./cmd/orca` → ≥ 50% (was 0%). |
|
||||
|
||||
### Wave 3 — Coverage gate verification
|
||||
|
||||
| Task ID | Owner | Wave | Must | Title | Files touched | Acceptance criterion |
|
||||
|---------|-------|------|------|-------|---------------|----------------------|
|
||||
| T01.12 | lead-developer | 3 | Y | Coverage-gate verification (all 9 packages hit tiered floor) | none (verification only) | `go test -cover ./internal/engine ./internal/proxmox ./internal/cli ./internal/transport ./internal/store ./internal/jobspec` → each ≥ 70%; `go test -cover ./internal/audit ./internal/certpaths ./cmd/orca` → each ≥ 50%. `go test -race ./...` PASS. Any races fixed in-phase (not deferred). |
|
||||
|
||||
### Phase 1 Must-Haves (summary)
|
||||
|
||||
All 9 packages hit their tiered floor (D-047): T01.1, T01.3, T01.4, T01.5,
|
||||
T01.6, T01.7, T01.8, T01.9, T01.10, T01.11, T01.12. T01.2 is conditional
|
||||
(only if needed for engine 70%).
|
||||
|
||||
### Phase 1 Verification
|
||||
|
||||
- `go build ./...` PASS
|
||||
- `go vet ./...` PASS
|
||||
- `go test -race ./...` PASS
|
||||
- Per-package coverage hits the tiered floor (T01.12)
|
||||
- The proxmox `sessionRunner` seam is backward compatible (existing
|
||||
`BootstrapProxmox` callers unchanged)
|
||||
- No new direct deps (`go.mod` unchanged)
|
||||
|
||||
---
|
||||
|
||||
## Phase 2: SSH Trust Hardening (REQ-058, REQ-059)
|
||||
|
||||
**Branch**: `phase/02-ssh-trust-hardening`
|
||||
**REQ Coverage**: REQ-058, REQ-059
|
||||
**Tag**: `v0.7.2`
|
||||
**Depends on**: Phase 1 (proxmox `sessionRunner` seam from T01.1 is in place;
|
||||
the trust-surface code is now testable)
|
||||
**Source research**: RESEARCH_v0.8.md §2 (TOFU bug, fingerprint computation,
|
||||
flag wiring, key-reset atomic rewrite) + §4 AD-027..AD-029
|
||||
**Phase type**: chore (trust-surface hardening per D-043 — refines existing
|
||||
`orca node join --type proxmox` flow + existing TOFU `known_hosts` store; no
|
||||
new orchestration capability)
|
||||
|
||||
### Wave 1 — Trust-surface foundations (security helpers + flag declarations)
|
||||
|
||||
| Task ID | Owner | Wave | Must | Title | Files touched | Acceptance criterion |
|
||||
|---------|-------|------|------|-------|---------------|----------------------|
|
||||
| T02.1 | backend-engineer | 1 | Y | Add `security.SSHFingerprintSHA256` helper (AD-027) | `internal/security/sshkey.go` (extend) OR `internal/security/fingerprint.go` (extend) | Thin wrapper over `ssh.FingerprintSHA256(pubKey ssh.PublicKey) string` returning the canonical `SHA256:base64` string. Do NOT reuse `security.Fingerprint` (X.509 hex — different domain per RESEARCH §2.2). Unit test: known Ed25519 pub key → known `SHA256:` string. |
|
||||
| T02.2 | backend-engineer | 1 | Y | Export `security.WriteAtomic` (AD-029 enabler) | `internal/security/ca.go` | Rename `writeAtomic` → `WriteAtomic` (export) + update existing in-package callers. The `key-reset` atomic known_hosts rewrite (T02.7) needs it. Alternatively copy the ~20-LOC pattern into `proxmox` if export is undesirable — **recommend export** (RESEARCH §5 pitfall #10). `go build ./internal/security` PASS. |
|
||||
| T02.3 | backend-engineer | 1 | Y | Add `--host-key-fingerprint` flag on `orca node join` (D-044) | `internal/cli/node.go` | `nodeJoinCmd.Flags().StringVar(&joinHostKeyFP, "host-key-fingerprint", "", "SSH host key SHA256:base64 fingerprint (pre-pin; supersedes TOFU for --type proxmox)")` in the flag-registration block (node.go:344-354). Add `joinHostKeyFP string` to the var block (node.go:47-60). Validation in `RunE`: if `joinHostKeyFP != ""` and `--type != proxmox`, emit a clear error ("--host-key-fingerprint requires --type proxmox today"). Flag is generic for future SSH-joined kinds (D-044). |
|
||||
| T02.4 | backend-engineer | 1 | Y | Add `HostKeyFingerprint` field to `proxmox.Options` | `internal/proxmox/bootstrap.go` | Add `HostKeyFingerprint string` to the `Options` struct (bootstrap.go:55). Pass-through from `internal/cli/node.go` joinProxmox (node.go:158-166): `HostKeyFingerprint: joinHostKeyFP`. |
|
||||
|
||||
### Wave 2 — Trust features + bugfix (build on Wave 1)
|
||||
|
||||
| Task ID | Owner | Wave | Must | Title | Files touched | Acceptance criterion |
|
||||
|---------|-------|------|------|-------|---------------|----------------------|
|
||||
| T02.5 | backend-engineer | 2 | Y | Implement `pinnedHostKeyCallback` (REQ-058, AD-028) | `internal/proxmox/bootstrap.go` | `pinnedHostKeyCallback(expectedSHA256Base64 string) (ssh.HostKeyCallback, error)`: validate `SHA256:` prefix up front (reject raw hex with a clear error per D-045); callback receives server's `ssh.PublicKey`, computes `ssh.FingerprintSHA256(key)` (via T02.1 helper or inline), compares full strings to the operator-supplied value; returns `nil` on match, `error` on mismatch (fail closed). In `BootstrapProxmox`: if `opts.HostKeyFingerprint != ""` use `pinnedHostKeyCallback`, else fall back to the TOFU callback (T02.6). Unit test: match → callback returns nil; mismatch → returns error mentioning REQ-058; non-`SHA256:`-prefixed input → constructor returns error. |
|
||||
| T02.6 | backend-engineer | 2 | Y | **BUGFIX (v0.6 ship-defect)**: FIX the latent TOFU capture bug (RESEARCH §2.1, §5 pitfall #1, GRILL condition #1) | `internal/proxmox/bootstrap.go` | Wrap `knownhosts.New(...)` with a custom callback that: on `*knownhosts.KeyError{Want: []}` (host unknown) captures the server-presented `ssh.PublicKey`, writes a line via `knownhosts.Line([]string{knownhosts.Normalize(addr)}, key)` to `certpaths.KnownHostsPath()` using `security.WriteAtomic` (T02.2, AD-029), and returns `nil` (allow the dial to proceed). On `*knownhosts.KeyError{Want: [knownKey]}` (mismatch) returns the error (MITM detection). On `nil` (host present + match) returns `nil`. This fixes the v0.6 latent ship-defect where first-connect Proxmox join always failed (verified against `golang.org/x/crypto@v0.54.0/ssh/knownhosts/knownhosts.go:370-385`). P04 audit must record this as ship-defect closure. Unit test: first-connect captures the key + writes known_hosts; second-connect matches; mismatch-connect fails. |
|
||||
| T02.7 | backend-engineer | 2 | Y | Populate `Result.HostKeyFingerprint` (RESEARCH §2.2, §5 pitfall #2) | `internal/proxmox/bootstrap.go` | In the capture path (T02.6) and the pinned path (T02.5), set `Result.HostKeyFingerprint = ssh.FingerprintSHA256(hostKey)` (via T02.1). The field is currently declared (bootstrap.go:83-85) but always `""`. After T02.7, `orca node join --type proxmox` output includes the real fingerprint. Unit test: `Result.HostKeyFingerprint` is non-empty + `SHA256:`-prefixed after a successful bootstrap. |
|
||||
| T02.8 | backend-engineer | 2 | Y | Implement `orca node key-reset <node>` (REQ-059, D-046, AD-029) | `internal/cli/node.go`, `internal/proxmox/bootstrap.go` (new `ResetHostKey` helper OR inline in cli) | New `nodeKeyResetCmd` (`&cobra.Command{Use: "key-reset <node>", Args: cobra.ExactArgs(1), RunE: ...}`) registered via `nodeCmd.AddCommand(nodeKeyResetCmd)` (node.go:358-360). `RunE`: (1) resolve `<node>` arg via `nodeRegistry()` (node.go:37) → get node row → use `node.Name` (the host address for proxmox nodes) as the `known_hosts` match key; (2) call `proxmox.ResetHostKey(host) error` which reads `certpaths.KnownHostsPath()`, filters lines whose host field (before first whitespace, normalized via `knownhosts.Normalize`) matches, rewrites via `security.WriteAtomic` (T02.2); (3) audit-log `event=node.key_reset` with `actor`+`node`+`host` via `engine.Audit.Record`; (4) print `✓ Host key reset for <node> (next connect will re-pin via TOFU or --host-key-fingerprint)`. **Local only — do NOT revoke remote authorized_keys** (D-046). Unit test: known_hosts with 2 entries for the target host + 1 for another host → after reset, target's 2 lines removed, other host's line intact; audit row inserted. |
|
||||
| T02.9 | backend-engineer | 2 | Y | Apply the TOFU capture-fix to `doctor proxmox` probe (GRILL condition #2 — doctor parity with bootstrap) | `internal/doctor/doctor.go` | The doctor proxmox probe (doctor.go:412-415) uses the same `knownhosts.New(...)` callback pattern as bootstrap. Apply the same capture-fix wrapper (T02.6) so `doctor proxmox` on a first-connect node doesn't fail. **P02 is not complete until both bootstrap (T02.6) and doctor (T02.9) callbacks use the capture-fix wrapper — GRILL condition #2 binding parity check.** (If the doctor probe already relies on a prior `node join` having populated `known_hosts`, the fix is still correct — it makes the doctor robust to a missing entry.) |
|
||||
|
||||
### Wave 3 — End-to-end integration + verification
|
||||
|
||||
| Task ID | Owner | Wave | Must | Title | Files touched | Acceptance criterion |
|
||||
|---------|-------|------|------|-------|---------------|----------------------|
|
||||
| T02.10 | backend-engineer | 3 | Y | End-to-end trust-surface integration tests | `internal/proxmox/bootstrap_test.go` (extend), `internal/cli/node_test.go` (extend) | (1) `--host-key-fingerprint` with a correct pin → bootstrap succeeds + `Result.HostKeyFingerprint` matches the pin; (2) `--host-key-fingerprint` with a wrong pin → bootstrap fails fast with the REQ-058 mismatch error; (3) no `--host-key-fingerprint` + first connect (empty known_hosts) → TOFU captures the key + writes known_hosts + bootstrap succeeds; (4) no flag + second connect (known_hosts has the key) → matches + succeeds; (5) no flag + mismatch (known_hosts has a different key) → fails with MITM error; (6) `orca node key-reset <node>` → known_hosts entry removed + audit row inserted + next connect re-pins; (7) known_hosts pre-populated (v0.6→v0.8 migration path: existing entry from a prior join) → second-connect matches without re-capture, covering the upgrade path. |
|
||||
| T02.11 | backend-engineer | 3 | Y | `--host-key-fingerprint` non-proxmox type validation test | `internal/cli/node_test.go` (extend) | `orca node join --type linux --host-key-fingerprint SHA256:...` → clear error ("--host-key-fingerprint requires --type proxmox today"). Validates D-044 RunE check from T02.3. |
|
||||
|
||||
### Phase 2 Must-Haves (summary)
|
||||
|
||||
- T02.1, T02.2, T02.3, T02.4 (Wave 1 foundations)
|
||||
- T02.5 (`--host-key-fingerprint` pinned callback — REQ-058)
|
||||
- T02.6 (TOFU capture-fix — latent bug)
|
||||
- T02.7 (`Result.HostKeyFingerprint` populated)
|
||||
- T02.8 (`orca node key-reset` — REQ-059)
|
||||
- T02.9 (doctor proxmox TOFU fix)
|
||||
- T02.10, T02.11 (integration + validation)
|
||||
|
||||
### Phase 2 Verification
|
||||
|
||||
- `go build ./...` PASS
|
||||
- `go vet ./...` PASS
|
||||
- `go test -race ./internal/proxmox/... ./internal/cli/... ./internal/doctor/... ./internal/security/...` PASS
|
||||
- `./bin/orca node join --help` shows `--host-key-fingerprint` flag
|
||||
- `./bin/orca node key-reset --help` shows the key-reset subcommand
|
||||
- Pinned mismatch → fail closed (T02.10 case 2)
|
||||
- TOFU first-connect → captures + succeeds (T02.10 case 3)
|
||||
- `Result.HostKeyFingerprint` is non-empty after bootstrap (T02.7)
|
||||
- `key-reset` removes only the target host's known_hosts lines + audit-logs (T02.8)
|
||||
- No new direct deps
|
||||
|
||||
---
|
||||
|
||||
## Phase 3: Requirements-Hygiene Gate (REQ-060)
|
||||
|
||||
**Branch**: `phase/03-verify-reqs`
|
||||
**REQ Coverage**: REQ-060
|
||||
**Tag**: `v0.7.3`
|
||||
**Depends on**: Phase 2 (P03 is independent of P02 code, but ships after per
|
||||
ROADMAP ordering; the verify-reqs program parses the `.ciagent/` markdown
|
||||
which is stable by P03)
|
||||
**Source research**: RESEARCH_v0.8.md §3 (Makefile, .coreci.yml, parsing
|
||||
approach, AD-030) + §4 AD-030
|
||||
|
||||
### Wave 1 — Go program
|
||||
|
||||
| Task ID | Owner | Wave | Must | Title | Files touched | Acceptance criterion |
|
||||
|---------|-------|------|------|-------|---------------|----------------------|
|
||||
| T03.1 | lead-developer | 1 | Y | `cmd/verify-reqs/main.go` — Go program (~80 LOC, stdlib only, AD-030, GRILL condition #4 regex + reverse direction) | `cmd/verify-reqs/main.go` (NEW) | Parses `.ciagent/ROADMAP.md` + `.ciagent/REQUIREMENTS.md` using `regexp` (stdlib). **Forward assertion**: for every REQ-ID in REQUIREMENTS.md whose `Phase` column references a milestone that ROADMAP marks COMPLETE (substring-match `COMPLETE` within the bold span — NOT exact `\*\*COMPLETE\*\*` which misses v0.2's `**COMPLETE (merged to main via v0.3)**` header at ROADMAP.md:23), the REQUIREMENTS `Status` must be `Complete`. **Reverse assertion (GRILL condition #4)**: for every REQ-ID in REQUIREMENTS.md marked `Complete`, the corresponding milestone in ROADMAP.md must be marked COMPLETE. Regex: REQUIREMENTS row `^\|\s*(REQ-\d+)\s*\|.*?\|\s*\*\*(Complete\|Pending)\*\*\s*\|`; ROADMAP milestone-complete `^##\s*Milestone\s+v0\.\d+:.*—\s*\*\*COMPLETE[^\*]*\*\*` (substring tolerant); map milestone → REQs via the REQUIREMENTS `Phase` column (e.g. `v0.7 P1` → milestone `v0.7`). Exit 0 on consistency; exit 1 with a diff listing (REQ-ID + current status + expected status + direction) on drift. CLI: `go run ./cmd/verify-reqs .ciagent/ROADMAP.md .ciagent/REQUIREMENTS.md` (args optional; defaults to those paths). **Scope note (GRILL)**: REQ-060 catches doc-vs-doc drift only; code-vs-doc drift (e.g. the REQ-053 `cert_repo_test.go` omission — verified missing) is out of scope for this gate and handled by P04 `ciagent-audit`. |
|
||||
| T03.2 | lead-developer | 1 | Y | `cmd/verify-reqs/main_test.go` — golden-file tests | `cmd/verify-reqs/main_test.go` (NEW), `cmd/verify-reqs/testdata/` (NEW: `roadmap_clean.md`, `requirements_clean.md`, `roadmap_drift.md`, `requirements_drift.md`) | (1) Clean pair (ROADMAP v0.X COMPLETE + REQUIREMENTS REQ-XXX Complete) → exit 0, no diff; (2) Drift pair (ROADMAP v0.X COMPLETE + REQUIREMENTS REQ-XXX Pending) → exit 1 + diff lists the stale REQ; (3) Multiple drifts → all reported; (4) Missing args → uses defaults; (5) Malformed markdown → clear error (not a silent pass). |
|
||||
|
||||
### Wave 2 — Makefile + CI hook
|
||||
|
||||
| Task ID | Owner | Wave | Must | Title | Files touched | Acceptance criterion |
|
||||
|---------|-------|------|------|-------|---------------|----------------------|
|
||||
| T03.3 | lead-developer | 2 | Y | `make verify-reqs` target | `Makefile` | Add `verify-reqs` target: `go run ./cmd/verify-reqs .ciagent/ROADMAP.md .ciagent/REQUIREMENTS.md`. Add to `.PHONY`. `make verify-reqs` exits 0 on the current repo (REQUIREMENTS was corrected during v0.8 SPECIFY). |
|
||||
| T03.4 | lead-developer | 2 | Y | `.coreci.yml` validate-pipeline hook | `.coreci.yml` | Add a `verify-reqs` step to the `validate` pipeline (after `go-version`, alongside `gosec`/`govulncheck`/`gitleaks` per RESEARCH §3.2): `image: golang:1.25`, `commands: [make verify-reqs]`. Pipeline fails on drift. |
|
||||
|
||||
### Wave 3 — Synthetic drift verification
|
||||
|
||||
| Task ID | Owner | Wave | Must | Title | Files touched | Acceptance criterion |
|
||||
|---------|-------|------|------|-------|---------------|----------------------|
|
||||
| T03.5 | lead-developer | 3 | Y | Synthetic drift verification (REQ-060 acceptance) | none (verification only; temporarily flip a REQUIREMENTS row to Pending in a scratch commit, run `make verify-reqs`, assert exit 1 + diff, then revert) | (1) `make verify-reqs` on the current repo → exit 0; (2) flip one v0.7 REQ row to `Pending` in a scratch edit → `make verify-reqs` → exit 1 + diff lists that REQ-ID; (3) revert the scratch edit → exit 0. This is the REQ-060 acceptance criterion ("passes on current repo + fails on synthetic drift"). |
|
||||
|
||||
### Phase 3 Must-Haves (summary)
|
||||
|
||||
T03.1, T03.2, T03.3, T03.4, T03.5 — all must complete for the hygiene gate to
|
||||
ship.
|
||||
|
||||
### Phase 3 Verification
|
||||
|
||||
- `go build ./cmd/verify-reqs` PASS
|
||||
- `go test ./cmd/verify-reqs/...` PASS (golden-file tests)
|
||||
- `make verify-reqs` → exit 0 on the current repo
|
||||
- Synthetic drift → `make verify-reqs` exit 1 + diff (T03.5)
|
||||
- `.coreci.yml` validate pipeline includes the `verify-reqs` step
|
||||
- No new direct deps (stdlib only)
|
||||
|
||||
---
|
||||
|
||||
## Phase 4: Final Review + Ship + Audit (no new REQs)
|
||||
|
||||
**Branch**: `phase/04-final-review-ship`
|
||||
**REQ Coverage**: all (REQ-057..060)
|
||||
**Tag**: `v0.7.4` (milestone release)
|
||||
**Depends on**: Phase 1 + Phase 2 + Phase 3
|
||||
**Source**: milestone-release checklist (matches PLAN_v0.7 P05 structure)
|
||||
|
||||
### Wave 1 — Review + audit
|
||||
|
||||
| Task ID | Owner | Wave | Must | Title | Files touched | Acceptance criterion |
|
||||
|---------|-------|------|------|-------|---------------|----------------------|
|
||||
| T04.1 | lead-developer | 1 | Y | Multi-persona code review across all v0.8 phases | none (review only) | ciagent-review across P01..P03; P0 issues fixed in-phase; P1+ recorded in `.ciagent/` for post-hoc. |
|
||||
| T04.2 | lead-developer | 1 | Y | Audit: reconstruction test + branch hygiene + commit discipline | none (audit only) | ciagent-audit: git log matches `.ciagent/` files; branch hygiene clean; commit discipline enforced. |
|
||||
|
||||
### Wave 2 — Ship
|
||||
|
||||
| Task ID | Owner | Wave | Must | Title | Files touched | Acceptance criterion |
|
||||
|---------|-------|------|------|-------|---------------|----------------------|
|
||||
| T04.3 | lead-developer | 2 | Y | Merge phase/04 → milestone/v0.8-coverage-trust-hardening | none | Fast-forward merge (or rebase-then-fast-forward per config). |
|
||||
| T04.4 | lead-developer | 2 | Y | Merge milestone/v0.8 → main | none | Rebase-then-fast-forward per config. |
|
||||
| T04.5 | lead-developer | 2 | Y | Tag `v0.7.4` (milestone release) | none | `git tag v0.7.4` on the merged main HEAD. Per-phase tags `v0.7.0`..`v0.7.4` all present. |
|
||||
| T04.6 | lead-developer | 2 | Y | Create Gitea release `v0.7.4` with milestone summary | none | Release notes cover all 4 phases + REQ-057..060 + coverage deltas + trust-surface additions. |
|
||||
|
||||
### Wave 3 — Post-ship bookkeeping
|
||||
|
||||
| Task ID | Owner | Wave | Must | Title | Files touched | Acceptance criterion |
|
||||
|---------|-------|------|------|-------|---------------|----------------------|
|
||||
| T04.7 | lead-developer | 3 | Y | Update REQUIREMENTS.md — mark REQ-057..060 Complete | `.ciagent/REQUIREMENTS.md` | All 4 v0.8 REQ rows show `**Complete**` with phase + ship tag. `make verify-reqs` still passes (self-consistency). |
|
||||
| T04.8 | lead-developer | 3 | Y | Update ROADMAP.md — mark v0.8 COMPLETE | `.ciagent/ROADMAP.md` | v0.8 milestone section shows `**COMPLETE**`; all phase checkboxes `[x]`. `make verify-reqs` still passes. |
|
||||
| T04.9 | lead-developer | 3 | Y | Write + clear checkpoint | `.ciagent/` checkpoint | `{phase: 4, stage: "complete", phase_role: "final", milestone_complete: true}`; then clear checkpoint (milestone complete; next run starts a new milestone). |
|
||||
|
||||
### Phase 4 Must-Haves (summary)
|
||||
|
||||
All tasks (T04.1..T04.9) are must-haves — the final-review phase has no
|
||||
optional work.
|
||||
|
||||
### Phase 4 Verification
|
||||
|
||||
- `make build` PASS
|
||||
- `make test` PASS
|
||||
- `make lint` PASS
|
||||
- `make verify-reqs` PASS
|
||||
- `go vet ./...` PASS
|
||||
- `git log` on main shows all v0.8 phase commits
|
||||
- `git tag --list 'v0.7.*'` shows v0.7.0..v0.7.4
|
||||
- REQUIREMENTS.md shows REQ-057..060 as Complete
|
||||
- ROADMAP.md shows v0.8 as COMPLETE
|
||||
- Gitea release `v0.7.4` published with milestone summary
|
||||
|
||||
---
|
||||
|
||||
## Phase 5: Final Review (next milestone, not part of v0.8 execution)
|
||||
|
||||
Per the v0.8 ROADMAP, there are 4 execution phases (P01..P04). P04 IS the
|
||||
final review + ship + audit phase. There is no separate P05 in v0.8 (unlike
|
||||
v0.7 which had P05). The orchestrator's next-milestone P0 begins after
|
||||
T04.9 clears the checkpoint.
|
||||
|
||||
---
|
||||
|
||||
## Risk Register (carried forward from RESEARCH_v0.8.md §5)
|
||||
|
||||
| # | Pitfall | Phase(s) affected | Mitigation |
|
||||
|---|---------|-------------------|------------|
|
||||
| 1 | TOFU capture is currently BROKEN: `knownhosts.New` returns `KeyError{Want:[]}` on first connect and does NOT auto-write; current `BootstrapProxmox` treats it as a dial failure. | P02 | T02.6 wraps the callback to capture-and-persist on `KeyError{Want:[]}` via `knownhosts.Line` + `security.WriteAtomic`. This is a v0.6 latent bug that P02 closes. |
|
||||
| 2 | `Result.HostKeyFingerprint` is declared but never populated (always `""`). D-045's rationale references "existing output" that doesn't exist. | P02 | T02.7 adds `ssh.FingerprintSHA256(hostKey)` computation in both the capture and pinned paths. 1-line addition once the host key is available. |
|
||||
| 3 | No `sessionRunner` seam in proxmox — testing the SSH command sequence without a real SSH server is impossible. | P01 | T01.1 adds a 1-interface ~10-LOC `sessionRunner` seam in Wave 1. Unlocks ~40% of proxmox coverage. Backward compatible. |
|
||||
| 4 | `internal/store/cert_repo.go` has NO test — v0.7 P01 REQ-053 was supposed to add `cert_repo_test.go` but it's missing (v0.7 leftover). | P01 | T01.7 adds `cert_repo_test.go` (Insert/Get/List/ListByNode/LatestForKind/PruneOlderThan/Delete + N=3 rotation). Directly lifts store coverage toward 70%. |
|
||||
| 5 | `internal/cli/daemon.go` starts a long-running mTLS server — testing it in cli requires a lifecycle harness; it's already covered by `internal/daemon/server_test.go`. | P01 | T01.6 excludes `daemon.go` from the cli 70% target; documents the exclusion in a test-file comment. Avoids double-testing. |
|
||||
| 6 | `cmd/orca` 50% toe-hold is low-value (15 LOC of glue; effort:coverage ratio is poor). | P01 | T01.11 keeps it at the 50% toe-hold per D-047; does NOT over-invest. A small `run() int` refactor enables a smoke test. |
|
||||
| 7 | `go: no such tool "covdata"` for zero-test packages — a Go toolchain quirk when a package has no test files; NOT a real 0% number. | P01 | T01.9, T01.10, T01.11 each add a `_test.go` file, which makes coverage computable. Don't treat the tooling error as a measurement. |
|
||||
| 8 | `transport.dispatchToPeer` has no seam — testing the remote-dispatch branch requires a new interface OR `httptest.NewTLSServer`. | P01 | T01.3 uses `httptest.NewTLSServer` (no refactor needed). T01.2 (conditional `peerDispatcher` seam) is only added if engine cannot otherwise hit 70%. |
|
||||
| 9 | `knownhosts.Line` + `knownhosts.Normalize` are the helpers for the TOFU-capture fix and `key-reset` matching. | P02 | T02.6 + T02.8 use `Normalize` to match host strings consistently (handles `host:22` vs `host`). |
|
||||
| 10 | `security.writeAtomic` is unexported (ca.go:305); `key-reset`'s atomic known_hosts rewrite needs it. | P02 | T02.2 exports `WriteAtomic` (recommended) OR copies the ~20-LOC pattern. Export is preferred — it's already used across ca.go + sshkey.go. |
|
||||
|
||||
---
|
||||
|
||||
## REQ-ID → Task mapping (traceability)
|
||||
|
||||
| REQ-ID | Phase | Tasks |
|
||||
|--------|-------|-------|
|
||||
| REQ-057 | P01 | T01.1, T01.2 (conditional), T01.3, T01.4, T01.5, T01.6, T01.7, T01.8, T01.9, T01.10, T01.11, T01.12 |
|
||||
| REQ-058 | P02 | T02.1, T02.3, T02.4, T02.5, T02.7, T02.10, T02.11 |
|
||||
| REQ-059 | P02 | T02.2, T02.8, T02.10 |
|
||||
| REQ-060 | P03 | T03.1, T03.2, T03.3, T03.4, T03.5 |
|
||||
| (latent TOFU bug) | P02 | T02.6, T02.9 (not a REQ — closes a v0.6 gap surfaced by RESEARCH §2.1) |
|
||||
| (milestone release) | P04 | T04.1..T04.9 |
|
||||
|
||||
---
|
||||
|
||||
## Task counts
|
||||
|
||||
| Phase | Tasks | Must-haves | Waves |
|
||||
|-------|-------|------------|-------|
|
||||
| P01 | 12 | 11 (T01.2 conditional) | 3 |
|
||||
| P02 | 11 | 11 | 3 |
|
||||
| P03 | 5 | 5 | 3 |
|
||||
| P04 | 9 | 9 | 3 |
|
||||
| **Total** | **37** | **36** | — |
|
||||
@@ -0,0 +1,92 @@
|
||||
# Orca — Comprehensive Product Requirements Document (v0.9/v0.10)
|
||||
|
||||
**Audience:** Operators, AI agents, downstream tooling authors
|
||||
|
||||
> This PRD SUPERSEDES the shipped v0.1–v0.8 architecture. The v0.9 and v0.10
|
||||
> milestones implement a re-architecture whose load-bearing rules (R-001…R-016)
|
||||
> and decisions (D-068…D-206) replace or demote several earlier documented
|
||||
> decisions. See §22 decision-trace and the Supersession Table in
|
||||
> `ARCHITECTURE.md` for the recorded reversals and their evidence basis.
|
||||
|
||||
## Status
|
||||
|
||||
| Item | Status |
|
||||
|---|---|
|
||||
| Spec lock-in | ✅ R-001…R-016 + D-001…D-206 settled |
|
||||
| v0.1–v0.8 implementation | ✅ shipped (REQ-001..060, D-001..D-047) |
|
||||
| v0.9 implementation | ⬜ Phase 0 pre-execution (this file is the spec input) |
|
||||
| v0.10 implementation | ⬜ planning (post-PRD) |
|
||||
| v1.x multi-host state | ⬜ parked (post-v1.0) |
|
||||
| v2.x full Nomad-HCL | ⬜ parked (post-v1.x) |
|
||||
|
||||
## Override justification (recorded for the grill supersession)
|
||||
|
||||
The v0.9/v0.10 re-architecture is justified on six independent grounds rather
|
||||
than preference. Each reverses a prior documented decision; the new evidence
|
||||
basis is recorded with the reversal in the Supersession Table:
|
||||
|
||||
1. **The v0.8 daemon model is operationally failing** in the target environment
|
||||
— R-001 ("no orca binary on any server") is a response to measured pain, not
|
||||
preference.
|
||||
2. **step-ca is externally mandated** (D-101) — the operator environment requires
|
||||
an external CA; AD-010's "too heavyweight" rationale is no longer operative.
|
||||
3. **Multi-tenancy is a hard product requirement** (R-002) — real multi-tenant
|
||||
use cases cannot be served by the single-namespace layout; the
|
||||
"no multi-tenancy" anti-pattern is obsolete.
|
||||
4. **WASM is a hard workload requirement** (D-088) — workloads are WASM, not
|
||||
processes; `os/exec` is insufficient; the "no container runtime" anti-pattern
|
||||
is reversed.
|
||||
5. **SSH-push is the only viable deployment target** for the operator's
|
||||
bare-Linux/Proxmox environment — installing/maintaining an orca daemon on
|
||||
every peer is operationally infeasible.
|
||||
6. **Simplicity/vision correction** — the v0.1-v0.8 daemon model was a wrong
|
||||
turn against the original CLI-first vision; the re-architecture corrects the
|
||||
vision.
|
||||
|
||||
## Canonical references
|
||||
|
||||
The full PRD text was provided by the operator and adopted wholesale. The
|
||||
load-bearing rules (R-001…R-016), the concept model (§4), the architecture
|
||||
(§5), the milestone plan (§23), and the decision trace (§22) are reproduced
|
||||
in the operator's original document. This file is the auditable pointer to
|
||||
that source; the substantive planning artifacts live in:
|
||||
|
||||
- `IDEATION_v0.9.md` — 30 ideas (REQ-061..REQ-090), three tiers
|
||||
- `GRILL_v0.9.md` — 9-axis adversarial review, 19 binding conditions, 10 phase challenges
|
||||
- `REQUIREMENTS.md` — REQ-061..REQ-090 appended
|
||||
- `ROADMAP.md` — v0.9 (13 phases) + v0.10 (19 phases) appended
|
||||
- `PERSONAS.md` — security/network/devops reactivated
|
||||
- `ARCHITECTURE.md` — v0.9 banners + Supersession Table
|
||||
|
||||
## The 16 load-bearing rules (invariants)
|
||||
|
||||
| ID | Rule |
|
||||
|---|---|
|
||||
| R-001 | No Orca Go binary runs on any server. The `orca` CLI on the operator's host is the only Orca software. Servers run Linux + systemd + apt-managed packages + config files written by the CLI. |
|
||||
| R-002 | Filesystem paths are namespaces. `ORCA_HOME` hosts many namespaces; each is a dir with `db/`, `.env`, `.env.secrets`, `jobs/`, `alloc/`, `ns.md`. `_defaults/` always exists. No `namespace` column in SQLite. |
|
||||
| R-003 | Cluster lead is always bare Linux; Proxmox can never be lead. |
|
||||
| R-004 | Workload migration Linux↔Proxmox supported; runtime can change at migration; SPIFFE identity preserved. |
|
||||
| R-005 | Storage replication enables migration; a Service's `count` replicas share one `runtime {}` block. |
|
||||
| R-006 | mTLS on by default; cluster CA = step-ca; Traefik + `LoadCredential=` are load-bearing. |
|
||||
| R-007 | Sockets by default (`/run/orca/alloc-<id>/port-<name>.sock`); `127.0.0.1` opt-in. |
|
||||
| R-008 | CLI results cached locally with per-class TTLs (`orca_cache` SQLite). |
|
||||
| R-009 | CLI host SPOF mitigated by external shared state in v1.x; v0.10 ships the abstractions + cache layer. |
|
||||
| R-010 | Control plane updates are transactional (ArgoCD-style desired-state/lead-applier). |
|
||||
| R-011 | Each namespace has `.env` (plaintext) and `.env.secrets` (AES-256-GCM, per-line nonce); master key per `ORCA_HOME` at `cluster/master.key`. |
|
||||
| R-012 | Workload kinds are `Job`, `Service`, `DaemonSet`; schema-separated by `kind:` in frontmatter. |
|
||||
| R-013 | Jobspec format is Markdown with YAML frontmatter (`.md` preferred); `.yaml` and `.hcl` accepted by parser dispatcher. |
|
||||
| R-014 | All user-facing config is Markdown with YAML frontmatter; body preserved verbatim. |
|
||||
| R-015 | Body of every `.md` config file is preserved verbatim and surfaced in `inspect`, `history`, diffs. |
|
||||
| R-016 | `.env` and `.env.secrets` are exempt from R-014 — standard dotenv format retained. |
|
||||
|
||||
## Milestone summary (§23, reordered per grill PC-01..PC-10)
|
||||
|
||||
### v0.9 — Workloads + Re-architecture Foundation (13 phases)
|
||||
P00 (deprecation sweep + migration-ordering + txn-design spike + test-infra bootstrap + persona reactivation + doc banners), P0a1 (path resolver + config demotion), P0a2 (namespace CRUD + inheritance), P0b (Markdown jobspec parser + fuzz), P0c (schemas + emitter interface), P01 (SSH-push transport + host-path volumes), P02 (service + Traefik emitter), P03 (update stanza), P04 (lifecycle hooks), P05 (constraints + CLI-side scheduler), P06 (task groups), P07a/P07b/P07c (process+podman / wasmtime [C-01 gated] / pve-vm+ct runtimes), P08 (sockets), P09 (Syncthing [C-02 gated]), P10 (lead rules + migration), P0X (ship + audit).
|
||||
|
||||
### v0.10 — Production Hardening (19 phases)
|
||||
P00 (CLI cache), P01 (metrics), P01.5 (SPIFFE spike [C-08 gated]), P02 (ACL), P03 (secrets), P04 (backup/restore), P05 (drain + daemon drain-and-stop), P06 (alloc history), P07 (recovery), P08 (integration tests), P09 (collector+aggregator), P10 (transactional plane [C-09 gated]), P11 (job lint), P12 (job verify), P13 (ns subcommands), P14a/P14b/P14c (data / daemon cutover / mixed-version tolerance), P15 (README), P15.5 (threat model [C-19 gated]), P16 (final review + ship — v1.0.0 release).
|
||||
|
||||
See `ROADMAP.md` for the full reordered plan and `GRILL_v0.9.md` for the 19
|
||||
binding conditions (C-01..C-19) and 10 phase challenges (PC-01..PC-10) that
|
||||
gate specific phases.
|
||||
@@ -36,6 +36,7 @@ Build a lightweight system to manage and execute workloads across a set of nodes
|
||||
| D-004 | Scheduling algorithm for v0.1? | **Single-node only (no scheduling)** | Multi-node scheduling is out of scope for v0.1. Tasks run on the node they're submitted to. | 0.90 |
|
||||
| D-005 | CLI output format? | **Human-readable by default, `--json` flag for machine consumption** | Serves both humans and AI agents. | 0.95 |
|
||||
| D-006 | Job/task definition format? | **HCL or YAML in `.hcl`/`.yaml` files** | Familiar to Nomad/HashiCorp users; simpler than JSON for humans. | 0.88 |
|
||||
| D-186 | Bash scripts coverage gate: count toward Go gate or exempt? | **Exempt from Go coverage gate; compensating control: bats tests (C-15) + shellcheck + shfmt in CI; every script must have >=1 happy-path and >=1 failure-path bats test** | Bash is a different language surface from Go; the 70%/50% Go coverage gate (D-042/D-047) is Go-specific. Forcing bash into the Go gate would require a coverage tool that does not exist for bash. The compensating control (bats + shellcheck + shfmt) provides equivalent discipline. | 0.82 |
|
||||
| D-007 | Authentication? | **mTLS for v0.1, token-based deferred** | mTLS is the most secure default. Tokens can be added later if needed. | 0.80 |
|
||||
| D-008 | Container runtime? | **Direct process execution (no container runtime) for v0.1** | Avoids the Docker/container dependency. Pure process management. | 0.85 |
|
||||
| D-009 | Configuration file location? | **`~/.orca/config.hcl` and `/etc/orca/orca.hcl`** | Standard XDG-style paths. | 0.90 |
|
||||
@@ -331,3 +332,116 @@ change. Milestone type: NFR (all phases are fix/test/chore); the final
|
||||
phase's progressive patch IS the deliverable per `run.md` versioning
|
||||
logic. Tags run on the v0.6.x patch line: `v0.6.0` (P0) … `v0.6.5` (P05
|
||||
= milestone release).
|
||||
|
||||
## v0.8 Scope Summary — Coverage & Trust Hardening
|
||||
|
||||
v0.8 is a 3-execution-phase **NFR milestone** that continues the
|
||||
hardening theme opened by v0.7. v0.7 P03 (REQ-055) lifted four
|
||||
packages to ≥ 50%, but a coverage re-baseline after v0.7 ship shows
|
||||
the floor was insufficient: `internal/engine` regressed to 8.3%,
|
||||
`internal/proxmox` to 5.1%, and four more packages sit between 26% and
|
||||
48%. Three packages (`internal/audit`, `internal/certpaths`,
|
||||
`cmd/orca`) still have **no test files at all**. v0.8 also closes the
|
||||
two "future enhancement" hooks explicitly deferred in v0.6 — SSH
|
||||
host-key pre-pinning (D-035 caveat) and `orca node key-reset`
|
||||
(RESEARCH_v0.6 §80) — and adds a requirements-hygiene gate so the
|
||||
stale-REQ-status drift seen in REQUIREMENTS.md after v0.7 ship cannot
|
||||
recur:
|
||||
|
||||
- **P01 — Coverage uplift round 2.** Raise six under-50% packages to
|
||||
≥ 70% and add first tests for the three zero-test packages. Covers
|
||||
REQ-057.
|
||||
- **P02 — SSH trust hardening.** `--host-key-fingerprint` pre-pin flag
|
||||
on `orca node join --type proxmox` + `orca node key-reset <node>`
|
||||
command. Covers REQ-058, REQ-059.
|
||||
- **P03 — Requirements-hygiene gate.** `make verify-reqs` target +
|
||||
verify-stage assertion that ROADMAP `Complete` ↔ REQUIREMENTS
|
||||
`Complete`. Covers REQ-060.
|
||||
- **P04 — Final review + ship + audit.** Milestone release.
|
||||
|
||||
The vision is unchanged. v0.8 is a hardening milestone, not a
|
||||
direction change. Milestone type: NFR (all phases are test/feat-chore
|
||||
on the trust surface — see CLARIFY D-043 for the `feat` vs `chore`
|
||||
classification of P02); the final phase's progressive patch IS the
|
||||
deliverable per `run.md` versioning logic. Tags run on the **v0.7.x**
|
||||
patch line: `v0.7.0` (P0) … `v0.7.4` (P04 = milestone release).
|
||||
|
||||
## v0.8 Clarified Decisions (D-series, full autonomy)
|
||||
|
||||
The 5 v0.8 decisions (D-043..D-047) were auto-resolved at full autonomy
|
||||
within the `clarify_budget` (10):
|
||||
|
||||
| ID | Question | Decision | Rationale | Confidence |
|
||||
|----|----------|----------|-----------|------------|
|
||||
| D-043 | Is P02 (SSH trust hardening) a `feat` phase or a `chore` phase? It adds a new flag + a new subcommand. | **`chore` (trust-surface hardening), not `feat`** | Both `--host-key-fingerprint` and `orca node key-reset` refine the *existing* `orca node join --type proxmox` flow and the existing TOFU `known_hosts` store (D-035). No new orchestration capability, no new node kind, no new API. They close a security gap explicitly deferred in v0.6, not open new surface area. Per `run.md` versioning logic this keeps v0.8 NFR (all phases fix/test/chore/perf/refactor). | 0.84 |
|
||||
| D-044 | Where does `--host-key-fingerprint` live — on `orca node join` or only on `--type proxmox`? | **On `orca node join` (root of the join subcommand), validated when `--type proxmox`** | The flag is generic (any future SSH-joined node kind will use it); gating it to `--type proxmox` only would require re-adding it later. Validation (`flag requires --type proxmox today`) happens in `RunE`, not in the flag declaration, so the flag is declared once on `node join` and the type check emits a clear error for non-proxmox types until other SSH-joined kinds exist. | 0.86 |
|
||||
| D-045 | `--host-key-fingerprint` format — raw hex, `sha256:`-prefixed, or OpenSSH `SHA256:base64`? | **OpenSSH `SHA256:base64` (the format `ssh-keyscan -E sha256 -D -` emits and operators expect)** | Matches the fingerprint format operators already see from `ssh-keyscan` and `orca node join`'s own `Result.HostKeyFingerprint` output. Accept only `SHA256:`-prefixed base64; reject raw hex with a clear error. Internally decode base64 → compare against `ssh.PublicKey` Marshal + sha256. | 0.88 |
|
||||
| D-046 | Does `orca node key-reset <node>` also revoke the orca pubkey on the remote host, or only clear the local `known_hosts` entry? | **Local `known_hosts` entry only** | Revoking the remote authorized_keys entry would orphan a working node (next dispatch would fail auth). `key-reset` is the local "forget this host's key" operation (mirrors `ssh-keygen -R host`); re-establishing trust is a separate `orca node join` re-run. Audit-log the reset with `actor`, `node`, `event=node.key_reset`. | 0.90 |
|
||||
| D-047 | Coverage target for P01 — 70% floor or higher? | **70% floor for the 6 under-50% packages; 50% floor for the 3 zero-test packages (`internal/audit`, `internal/certpaths`, `cmd/orca`) as a first-toe-hold** | 70% across the board for the already-tested packages matches D-042's "70% target for new packages" and is achievable without heroic mock effort. For the zero-test packages, going 0→50% is the realistic single-phase step (0→70% risks a coverage rathole on `cmd/orca` which is glue code); a future milestone can lift them to 70%. | 0.82 |
|
||||
|
||||
---
|
||||
|
||||
# v0.9/v0.10 — Re-architecture Scope Summary (Supersedes v0.1–v0.8 architecture)
|
||||
|
||||
v0.9 is the first DIRECTION-CHANGE milestone in the project's history.
|
||||
It supersedes the shipped v0.1–v0.8 architecture per the adopted PRD
|
||||
(`.ciagent/PRD_v0.9.md`). The re-architecture deprecates the daemon/
|
||||
transport/internal-CA/HCL/single-namespace stack and builds a CLI-only/
|
||||
SSH-push/step-ca/Markdown-frontmatter/multi-namespace stack plus 8
|
||||
net-new subsystems.
|
||||
|
||||
## Override Justification (Re-architecture Justification axis)
|
||||
|
||||
The ci-griller returned REPLAN (0.70) on the Re-architecture Justification
|
||||
axis, noting the PRD reverses 6 documented decisions without new evidence
|
||||
and that the incremental-additive path was not evaluated. The user reviewed
|
||||
the fork and overrode the *direction* with a six-part evidence basis. The
|
||||
override is recorded verbatim below; each part addresses a reversal that
|
||||
the grill flagged as unjustified.
|
||||
|
||||
1. **The v0.8 daemon model is operationally failing** in the target
|
||||
environment — R-001 ("no orca binary on any server") is a response to
|
||||
measured pain, not preference.
|
||||
2. **step-ca is externally mandated** (D-101) — the operator environment
|
||||
requires an external CA; AD-010's "too heavyweight" rationale is no
|
||||
longer operative.
|
||||
3. **Multi-tenancy is a hard product requirement** (R-002) — real
|
||||
multi-tenant use cases cannot be served by the single-namespace layout;
|
||||
the "no multi-tenancy" anti-pattern is obsolete.
|
||||
4. **WASM is a hard workload requirement** (D-088) — workloads are WASM, not
|
||||
processes; `os/exec` is insufficient; the "no container runtime"
|
||||
anti-pattern is reversed.
|
||||
5. **SSH-push is the only viable deployment target** for the operator's
|
||||
bare-Linux/Proxmox environment — installing/maintaining an orca daemon
|
||||
on every peer is operationally infeasible.
|
||||
6. **Simplicity/vision correction** — the v0.1-v0.8 daemon model was a
|
||||
wrong turn against the original CLI-first vision; the re-architecture
|
||||
corrects the vision.
|
||||
|
||||
## Supersession Table (AD-series reversals, recorded per grill PC-09)
|
||||
|
||||
| Old decision | Was | Superseded by | Evidence basis |
|
||||
|---|---|---|---|
|
||||
| AD-010 (ARCHITECTURE.md:463) | step-ca/cfssl/vault-pki "too heavyweight" | **D-101** (step-ca) | Override ground 2 (external mandate) |
|
||||
| SPIFFE rejection (PROJECT.md:94) | internal CA chosen over SPIFFE | **D-068** (SPIFFE SVIDs) | Override ground 3 (multi-tenancy requires per-workload identity) |
|
||||
| No-container-runtime (ARCHITECTURE.md:477) | explicit anti-pattern | **D-088** (5 runtimes; wasmtime primary) | Override ground 4 (WASM is the workload profile) |
|
||||
| No-multi-tenancy (ARCHITECTURE.md:478) | explicit anti-pattern | **D-158 / R-002** (many namespaces under ORCA_HOME) | Override ground 3 (hard multi-tenant product req) |
|
||||
| AD-007 (HCL canonical) | HCL for jobspec | **R-013 / R-014** (Markdown canonical; HCL legacy) | PRD §8 (Markdown + body preservation is the operator-facing format) |
|
||||
| Daemon-on-every-node | `orca daemon` on all peers | **R-001** (no orca binary on any server) | Override grounds 1 + 5 (daemon failing; SSH-push only viable target) |
|
||||
|
||||
The 19 binding conditions (C-01..C-19) and 10 phase challenges
|
||||
(PC-01..PC-10) from `GRILL_v0.9.md` are adopted as execution gates.
|
||||
The 30 net-new requirements (REQ-061..REQ-090) from `IDEATION_v0.9.md`
|
||||
are recorded in `REQUIREMENTS.md`. The reordered phase plan is in
|
||||
`ROADMAP.md`.
|
||||
|
||||
## v0.9 Clarified Decisions (D-series, full autonomy — Phase 0 pre-execution)
|
||||
|
||||
| ID | Question | Decision | Rationale | Confidence |
|
||||
|----|----------|----------|-----------|------------|
|
||||
| D-101 | Cluster CA: internal Go CA (AD-010) or step-ca (external)? | **step-ca (apt-installed)** | Externally mandated per override ground 2; AD-010's "too heavyweight" rationale reversed. CLI wraps `step` CLI via SSH (no Go step-ca client library — keep zero-new-dep posture if possible, or add `github.com/smallstep/cli` as a dep). **Gated by C-07** (CA migration spec). | 0.74 |
|
||||
| D-068 | Workload identity: internal X.509 CA or SPIFFE SVIDs? | **SPIFFE SVIDs minted at submit time via step-ca** | Multi-tenancy (override ground 3) requires per-workload identity model; SPIFFE is the standard. SPIFFE ID `spiffe://orca/ns/<ns>/job/<name>/alloc/<id>` as SAN. **Gated by C-08** (mint spike in v0.10-P01.5; fallback to mTLS identity if spike fails). | 0.72 |
|
||||
| D-088 | Runtime: direct os/exec only (D-008) or multi-runtime? | **5 runtimes: wasm (wasmtime primary), podman, process, pve-vm, pve-ct** | WASM is the primary workload (override ground 4). `processRuntime` wraps existing `executor.go`; others are net-new. Split P07a/b/c per grill PC-10. **P07b gated by C-01** (wasmtime/CGO eval). | 0.82 |
|
||||
| D-158 | Namespace model: single flat root or multi-namespace? | **Multi-namespace under ORCA_HOME (R-002)** | Hard multi-tenant product requirement (override ground 3). `_defaults/` implicit root; `cluster/` for cluster-wide; per-namespace `db/`, `.env`, `.env.secrets`, `jobs/`, `alloc/`, `ns.md`. No namespace column in SQLite. | 0.84 |
|
||||
| D-179 | Jobspec format: HCL canonical (AD-007) or Markdown? | **Markdown with YAML frontmatter canonical (R-013); HCL legacy** | PRD §8 — Markdown + body preservation is the operator-facing format. HCL adapter (REQ-064) preserves `orca job run old-spec.hcl` during migration. | 0.85 |
|
||||
| D-185 | Re-architecture justification: incremental additive or full re-architecture? | **Full re-architecture (overridden by user)** | Six-part evidence basis above; the grill's REPLAN mechanics (PC-01..PC-10, C-01..C-19) adopted as gates. The incremental-additive path was evaluated and rejected on grounds 1 + 5 (daemon failing; SSH-push only viable). | 0.88 |
|
||||
|
||||
@@ -127,7 +127,58 @@ REQ-047..052 all complete.
|
||||
|
||||
| ID | Requirement | Priority | Phase | Status |
|
||||
|----|-------------|----------|-------|--------|
|
||||
| REQ-053 | `orca cert` command tree registered on root command (`cert ca-init`, `cert gen`, `cert show`, `cert renew`, `cert fingerprint`) — code exists in `internal/cli/cert.go` but is never AddCommand'd; unreachable today | High | **v0.7 P1** | Pending |
|
||||
| REQ-054 | HCL config file parsing: `internal/config` package loads `~/.orca/config.hcl` / `/etc/orca/orca.hcl` (keys: db_path, listen_addr, ca_path, server_cert_path, server_key_path, node_capacity); merge precedence flag > env > file > default; `--config` flag on root command | High | **v0.7 P2** | Pending |
|
||||
| REQ-055 | Test coverage uplift: every package ≥ 50% — adds tests for `internal/engine` (executor, dispatcher, peer), `internal/transport` (mtls, dispatch, handshake_log), `internal/proxmox` (bootstrap SSH path), `internal/audit` | Medium | **v0.7 P3** | Pending |
|
||||
| REQ-056 | `--pprof <addr>` opt-in flag on `orca daemon` (default disabled); `net/http/pprof` mounted on a separate mux, never on the mTLS daemon listener | Low | **v0.7 P4** | Pending |
|
||||
| REQ-053 | `orca cert` command tree registered on root command (`cert ca-init`, `cert gen`, `cert show`, `cert renew`, `cert fingerprint`) — code exists in `internal/cli/cert.go` but is never AddCommand'd; unreachable today | High | **v0.7 P1** | **Complete** (P1 shipped v0.6.1) |
|
||||
| REQ-054 | HCL config file parsing: `internal/config` package loads `~/.orca/config.hcl` / `/etc/orca/orca.hcl` (keys: db_path, listen_addr, ca_path, server_cert_path, server_key_path, node_capacity); merge precedence flag > env > file > default; `--config` flag on root command | High | **v0.7 P2** | **Complete** (P2 shipped v0.6.2) |
|
||||
| REQ-055 | Test coverage uplift: every package ≥ 50% — adds tests for `internal/engine` (executor, dispatcher, peer), `internal/transport` (mtls, dispatch, handshake_log), `internal/proxmox` (bootstrap SSH path), `internal/audit` | Medium | **v0.7 P3** | **Complete** (P3 shipped v0.6.3) |
|
||||
| REQ-056 | `--pprof <addr>` opt-in flag on `orca daemon` (default disabled); `net/http/pprof` mounted on a separate mux, never on the mTLS daemon listener | Low | **v0.7 P4** | **Complete** (P4 shipped v0.6.4) |
|
||||
|
||||
## v0.8 Requirements — Coverage & Trust Hardening
|
||||
|
||||
| ID | Requirement | Priority | Phase | Status |
|
||||
|----|-------------|----------|-------|--------|
|
||||
| REQ-057 | Test coverage uplift round 2: raise `internal/engine` (8.3%), `internal/proxmox` (5.1%), `internal/cli` (27.6%), `internal/transport` (26.3%), `internal/store` (46.7%), `internal/jobspec` (47.6%) to ≥ 70%; add first tests for `internal/audit`, `internal/certpaths`, `cmd/orca` (currently 0%) to ≥ 50% (D-047 tiered floor) | High | **v0.8 P1** | **Complete** (P1 shipped v0.7.1; all 9 packages exceeded floor) |
|
||||
| REQ-058 | `--host-key-fingerprint <SHA256:base64>` pre-pin flag on `orca node join` (validated when `--type proxmox`): when supplied, join fails fast if the SSH host key's OpenSSH SHA-256 fingerprint does not match; supersedes TOFU (D-035) for pre-pinned deployments (D-044, D-045) | Medium | **v0.8 P2** | **Complete** (P2 shipped v0.7.2) |
|
||||
| REQ-059 | `orca node key-reset <node>` command: clears the persisted SSH host key entry for the node from `~/.orca/known_hosts` only (local, not remote authorized_keys — D-046); audit-logs `event=node.key_reset`; next `doctor proxmox`/dispatch re-pins via TOFU or `--host-key-fingerprint` | Low | **v0.8 P2** | **Complete** (P2 shipped v0.7.2) |
|
||||
| REQ-060 | Requirement-status hygiene sweep: REQUIREMENTS.md v0.7 rows were stale ("Pending" after ship); add a verify-stage assertion that every REQ listed as `Complete` in ROADMAP.md has a matching `Complete` row in REQUIREMENTS.md, enforced by `make verify-reqs` | Medium | **v0.8 P3** | **Complete** (P3 shipped v0.7.3) |
|
||||
|
||||
## v0.9/v0.10 Requirements — Re-architecture Foundation & Production Hardening
|
||||
|
||||
The v0.9/v0.10 milestones supersede the shipped v0.1–v0.8 architecture per the
|
||||
adopted PRD (`.ciagent/PRD_v0.9.md`). The re-architecture is justified on six
|
||||
grounds recorded in the PROJECT.md Supersession Table. 30 net-new requirements
|
||||
(REQ-061..REQ-090) derive from the v0.9 IDEATION; their phase placement and
|
||||
binding grill conditions (C-01..C-19) are documented in `IDEATION_v0.9.md`
|
||||
and `GRILL_v0.9.md`.
|
||||
|
||||
| ID | Requirement | Priority | Phase | Status |
|
||||
|----|-------------|----------|-------|--------|
|
||||
| REQ-061 | `orca daemon` deprecation command and build-tag removal path: v0.9 emits deprecation warning + still runs (dual-write window); v1.0 repurposes to `orca daemon drain-and-stop` (stops v0.8 daemons on peers via SSH, confirms workloads survive via systemd); post-v1.0 the command and `internal/daemon/` are deleted. `// Deprecated` Go doc comments + `slog.Warn` on every run (I-M-001) | High | **v0.10 P14** (warn v0.9 P0X) | Pending |
|
||||
| REQ-062 | Coverage follow-ups: 3 zero-test packages (`internal/audit`, `internal/certpaths`, `cmd/orca`) + `internal/cli` to 70% floor; once `daemon.go` is deprecated/removed the exclusion reason disappears and the floor applies to the whole package; all net-new subsystems carry a 70% floor from their first phase (I-M-002) | Medium | **v0.9 P0X** + each new pkg | Pending |
|
||||
| REQ-063 | `known_hosts` flock concurrency gap (deferred P1 from REVIEW_v0.8 A2): add `flock`-style advisory lock (stdlib `syscall.Flock` wrapper) around the read-modify-write in `TOFUHostKeyCallback` capture path (`bootstrap.go:290-302`) and `ResetHostKey` (`bootstrap.go:479-523`); lock file at `cluster/known_hosts.lock` (R-002) (I-M-003) | Medium | **v0.9 P0a1** | Pending |
|
||||
| REQ-064 | HCL→Markdown jobspec adapter/bridge layer: keep `internal/jobspec/spec.go` as legacy HCL path behind `// Deprecated`; add `internal/jobspec/markdown.go` (canonical) + `internal/jobspec/dispatch.go` (extension-based dispatcher: `.md`→Markdown, `.hcl`→legacy, `.yaml`→Markdown-with-empty-body); unified `*WorkloadSpec` populated via adapter; preserves `orca job run old-spec.hcl` during migration window (I-M-004) | High | **v0.9 P0b** | Pending |
|
||||
| REQ-065 | `orca doctor --legacy-paths` detection: detects v0.8 residue (orca.db at ORCA_HOME root, ca.crt/ca.key, config.hcl, flat server.crt, namespace column in any *.db); outputs list of legacy artifacts with migration recommendations; the detection half of v0.10-P14 (I-M-005) | Medium | **v0.10 P14c** | Pending |
|
||||
| REQ-066 | Legacy CA state migration to step-ca: `orca upgrade --to-v1.0 --import-ca` reads `~/.orca/ca.key`, initializes step-ca with it, re-issues workload SVIDs; preserves audit history even if live trust root changes (I-M-006). **Gated by C-07** | High | **v0.10 P14a** | Pending |
|
||||
| REQ-067 | Fuzz test harness for Markdown frontmatter parser: `testing.F` fuzz target in `internal/jobspec/markdown_test.go` round-trips random frontmatter+body through `ParseMarkdown` asserting byte-exact body preservation; corpus of adversarial fixtures (CRLF, BOM, no-frontmatter, empty-frontmatter, frontmatter-with-only-separator) (I-M-007) | Medium | **v0.9 P0b** | Pending |
|
||||
| REQ-068 | Deprecation warnings on removed/repurposed CLI subcommands: each removed/changed command (`orca cert`, `orca node join` mTLS semantics, `orca job run <spec.hcl>`) emits `slog.Warn` deprecation banner with v1.0 replacement except under `orca upgrade`; `--no-deprecation-warnings` global flag via `root.go` `PersistentPreRunE` (I-M-008) | Low | **v0.9 P0X** + v0.10 P13 | Pending |
|
||||
| REQ-069 | `internal/config/config.go` HCL config demotion via adapter: keep `internal/config/` as `legacy_config.go` with `// Deprecated`; add `internal/config/markdown.go` for new Markdown-frontmatter loader (R-014); `root.go` dispatches on file extension (`.hcl`→legacy, `.md`→new); `--config` semantics: `.hcl` read-only legacy, `.md` canonical (I-M-009) | High | **v0.9 P0a1** | Pending |
|
||||
| REQ-070 | `internal/certpaths/` replacement with multi-namespace path resolver: new `internal/paths` package with `paths.NamespaceDir(ns)`, `paths.ClusterDir()`, `paths.CacheDB()`, `paths.MasterKey()`, `paths.NSDb(ns)`, `paths.NSEnv(ns)`, `paths.NSSecrets(ns)`; keep `certpaths` as thin shim for v0.8 compat then remove post-v1.0 (R-002) (I-M-010) — highest blast radius | High | **v0.9 P0a1** | Pending |
|
||||
| REQ-071 | `internal/store/` schema: per-namespace DBs, drop namespace column: `store.Open` gains namespace parameter (or caller passes `paths.NSDb(ns)`); `migrate.go` runs migrations per namespace DB; `cert_repo` (0004) removed (step-ca handles certs); audit_log moves to CLI-side cache DB (R-008) (I-M-011) | High | **v0.9 P0a1** + v0.10 P06 | Pending |
|
||||
| REQ-072 | `internal/transport/` deletion + SSH-push package: delete `mtls.go`, `dispatch.go`, `handshake_log.go`; extract retry/idempotency patterns into `internal/sshpush/`; existing `transport.IdempotencyStore` directly reusable (I-M-012). Deletion deferred to v0.10-P14 to keep dual-write window open | High | **v0.9 P00** (delete v0.10 P14) | Pending |
|
||||
| REQ-073 | SSH-push transport layer design: connection pooling (reuse `*ssh.Client` per peer), idempotency (content-addressed filenames), retry (exponential backoff 100ms×2 cap 5s max 5), timeout (30s SCP, 10s exec), fan-out (errgroup bounded concurrency default 8), known_hosts reuse `proxmox.TOFUHostKeyCallback` (I-B-001) | High | **v0.9 P01** (design P0a1) | Pending |
|
||||
| REQ-074 | Emitter template system (Layer 4): `internal/emitter/` package with `Emitter` interface `Render(spec *WorkloadSpec, node *Node) ([]File, error)`; implementations systemdEmitter/traefikEmitter/syncthingEmitter/socketEmitter; SSH-push SCPs `[]File` atomically (write-to-tmp + rename); emitters registered per kind + runtime (I-B-002) | High | **v0.9 P0c** | Pending |
|
||||
| REQ-075 | Lead applier execution model: CLI renders transaction bundle (tarball + apply.sh + verify.sh) on operator host, SCPs to lead's `/run/orca/txns/<txn-id>/`, lead's systemd timer runs `apply.sh` idempotently, CLI polls txn status via SSH; bash scripts generated by emitter not hand-written (I-B-003). **Gated by C-09** | High | **v0.10 P10** (design v0.9 P00) | Pending |
|
||||
| REQ-076 | step-ca integration: `orca init` runs `step ca init` on lead; CLI SSHs to lead, installs step-ca via apt, stores step-ca.json; workload SVIDs via `step ca token` (JWE minted by CLI) → `step ca certificate`; SPIFFE ID as SAN; new `internal/stepca/` package wraps `step` CLI via SSH (I-B-004). Reverses AD-010 per override justification ground 2 | High | **v0.9 P07** + v0.10 P02 | Pending |
|
||||
| REQ-077 | Traefik dynamic config generation + atomic reload: Traefik emitter renders `/etc/traefik/dynamic/orca-<ns>-<svc>.yaml` with backends (socket paths R-007), health checks, mTLS config pointing at step-ca root; atomic reload via tmpfile+fsync+rename triggering fsnotify; drain writes `weight=0` or removes backend (I-B-005). **Gated by C-10** | High | **v0.9 P02** | Pending |
|
||||
| REQ-078 | Runtime abstraction interface (5 backends): `Runtime` interface in `internal/runtime/` with Prepare/Start/Stop/Status; processRuntime (wraps existing executor.go), wasmRuntime (wasmtime via SSH), podmanRuntime, pveVMRuntime (qm via proxmox SSH), pveCTRuntime (pct); runtimeRegistry keyed by `runtime:` frontmatter value; Alloc carries runtime field changeable on migration (I-B-006). Split P07a/b/c per PC-10. **P07b gated by C-01** | High | **v0.9 P07a/b/c** | Pending |
|
||||
| REQ-079 | Transaction bundle format + N-peer atomicity: bundle = tarball with desired-state.json + apply.sh + verify.sh + rollback.sh + manifest.sig (signed with master.key); content-addressed `<txn-id>=sha256(desired-state.json)` stored in `cluster/txns/<txn-id>/`; lead applies to self first then fans out; failure on any peer runs rollback.sh on applied peers (I-B-007). **Gated by C-09** | High | **v0.10 P10** (design v0.9 P00) | Pending |
|
||||
| REQ-080 | Master key management + HKDF-SHA256 per-line .env.secrets encryption: `cluster/master.key` 32-byte random (generated at `orca init` using WriteAtomic pattern); each line `base64(nonce||ciphertext||tag)`, nonce=random(12 bytes), AES-256-GCM with AAD=line-number (prevents line-swap); HKDF-SHA256 derives per-namespace sub-keys; `orca secrets set/get`; v0.8 `internal/security/redact.go` reusable (I-B-008). **Gated by C-19** | High | **v0.10 P03** | Pending |
|
||||
| REQ-081 | Syncthing config rendering + folder-ID content-addressing: per-namespace Syncthing folder `orca-<ns>` with content-addressed folder ID `sha256(ns + master-key-fingerprint)`; CLI renders config.xml per peer; Syncthing runs as systemd unit (emitted by systemd emitter); CLI discovers peers via `cluster/peers/`; migration works because new node joins folder and syncs before workload starts (I-B-009). **Gated by C-02 + C-14** | Medium | **v0.9 P09** (spike v0.9 P00) | Pending |
|
||||
| REQ-082 | Namespace inheritance resolver algorithm: DFS parent walker with visited set for cycle detection; `_defaults/` implicit root (always exists, no parent); merge semantics: child overrides parent for scalars, arrays unioned (child adds to parent); pure function (no I/O) taking `map[nsName→*NSConfig]` returning `map[nsName→*ResolvedNS]` (I-B-010) | High | **v0.9 P0a2** | Pending |
|
||||
| REQ-083 | CLI-side scheduler redesign: `Score(node, workload) (score int, fits bool)` where `fits` checks runtime compatibility + constraints, `score` is bin-packing (most free capacity = highest); Services pick `count` distinct nodes (anti-affinity default); DaemonSets pick all matching nodes; Job = one-shot; CLI-side not daemon-side (R-001) (I-B-011) | High | **v0.9 P05** (skeleton P0c) | Pending |
|
||||
| REQ-084 | `orca job lint` category-driven lint engine: `Linter` runs `Rule` checks returning `Finding{Category, Severity, Message, Explanation}`; categories schema/runtime/security/migration/best-practice; `--explain` prints rationale; pure (no I/O) checks against static rules (I-B-012) | Medium | **v0.10 P11** | Pending |
|
||||
| REQ-085 | v0.8→v1.0 migration ordering: v0.9 ships new parser + kinds + runtime + SSH-push alongside old daemon (dual-write window); `orca job run` dispatches on extension (`.md`→SSH-push, `.hcl`→old daemon); v0.10-P05 drains old daemons; v0.10-P14 converts remaining `.hcl` specs and removes daemon (I-C-001). **Most important cross-cutting idea** | High | **v0.9 P00** → v0.10 P14 | Pending |
|
||||
| REQ-086 | "No orca on server" enforcement: `orca doctor no-orca-on-server` SSHs to each peer verifying no `orca` binary in PATH, no `orca` systemd service, no `orca` process, no `/etc/orca/` directory; runs after v0.10-P05 before v0.10-P16; reuses v0.8 `proxmox` SSH session infrastructure (I-C-002). Implements grill C-13 | High | **v0.10 P14c** | Pending |
|
||||
| REQ-087 | Test infrastructure: hermetic 3-linux + 1-proxmox cluster pipeline: `test/integration/` with docker-compose/vagrant creating 4 containers/VMs; Go test harness SSHes to each, runs CLI, asserts end-to-end workflows (ns create → workload submit → migrate → drain); proxmox simulated via mock pct/qm; v0.8 e2e tests (bootstrapE2ESetup) are foundation (I-C-003) | Medium | **v0.10 P08** (bootstrap v0.9 P00) | Pending |
|
||||
| REQ-088 | Security-engineer + network-engineer persona reactivation: reactivate security-engineer (step-ca provisioner model, SSH-push blast radius, Traefik edge, .env.secrets crypto) and network-engineer (socket exposure R-007, Syncthing P2P ports, Traefik routing); cross-cutting review not single phase (I-C-004). Implements grill C-05 | High | **v0.9 P00** → v0.10 P16 | Pending |
|
||||
| REQ-089 | Documentation rewrite: ARCHITECTURE.md/PROJECT.md/README + AD-010 supersession: v0.9-P00 adds "v0.9 Architecture (Supersedes v0.8)" section + banners + Superseded Decisions table; v0.10-P15 rewrites README quickstart for new curl|sh + orca init + orca ns create flow (I-C-005) | Medium | **v0.9 P00** + v0.10 P15/P16 | Pending |
|
||||
| REQ-090 | Dual-write window: v0.9 `orca job run` dispatches on extension (`.md`→SSH-push new path, `.hcl`→old daemon path) via parser dispatcher (REQ-064); daemon not removed until v0.10-P05; SSH-push path writes to separate systemd unit namespace (`orca-v1-<alloc>.service`) while daemon uses `orca-<job>.service` — no unit name overlap = no conflict (I-C-006) | High | **v0.9 P00** | Pending |
|
||||
|
||||
@@ -0,0 +1,285 @@
|
||||
# Research: Orca v0.8 — Coverage & Trust Hardening
|
||||
|
||||
Findings grounded in codebase analysis (44 source/test files read, coverage
|
||||
re-measured for all 9 target packages) + `golang.org/x/crypto` v0.54.0 API
|
||||
verification (`ssh.FingerprintSHA256`, `knownhosts.Line`/`Normalize`/`KeyError`).
|
||||
|
||||
## 1. Coverage analysis (P01 — REQ-057)
|
||||
|
||||
### 1.1 Re-measured coverage (confirmed via `go test ./<pkg>/... -cover`)
|
||||
|
||||
| Package | Coverage | Tier (D-047) | Notes |
|
||||
|---------|----------|--------------|-------|
|
||||
| `internal/engine` | **8.3%** | ≥ 70% floor | Only `scheduler_test.go` (4 tests, 66 LOC); executor/dispatcher/peer/registry/audit untested |
|
||||
| `internal/proxmox` | **5.1%** | ≥ 70% floor | Only `bootstrap_test.go` (4 tests, validation + sudoersContent string asserts); SSH dial path untested |
|
||||
| `internal/cli` | **27.6%** | ≥ 70% floor | 5 test files (root, init, namespace, osdetect, watch); node/job/cert/doctor/audit/cmds untested |
|
||||
| `internal/transport` | **26.3%** | ≥ 70% floor | Only `idempotency_test.go` (7 tests); mtls/dispatch/retry/handshake_log untested |
|
||||
| `internal/store` | **47.2%** | ≥ 70% floor | node_repo + job_task + capacity + audit + migrate tested; **cert_repo has NO test** (REQ-053 leftover — v0.7 P01 was supposed to add it but it's missing) |
|
||||
| `internal/jobspec` | **47.6%** | ≥ 70% floor | Only `spec_test.go` (4 tests); `Validate()`, `ParseFile` (file I/O), edge cases untested |
|
||||
| `internal/audit` | **0%** (no test files) | ≥ 50% toe-hold | `go: no such tool "covdata"` is a known tooling gap, NOT a real number — the package simply has no `_test.go` |
|
||||
| `internal/certpaths` | **0%** (no test files) | ≥ 50% toe-hold | Same `covdata` tooling gap; no `_test.go` exists |
|
||||
| `cmd/orca` | **0%** (no test files) | ≥ 50% toe-hold | Same; `main.go` is 15 LOC of glue (`cli.Execute()` + error print) |
|
||||
|
||||
**Coverage-floor achievability assessment (per package):**
|
||||
|
||||
- **engine → 70% REALISTIC.** The package has clean seams: `LocalExecutor` interface (dispatcher.go:39), `PeerRegistry` is in-memory with `Add`/`Remove`/`All`/`Get` (peer.go), `Executor.Submit/Status` take a `*store.JobRepo`+`*store.TaskRepo` which can be backed by `:memory:`/temp-file sqlite via the existing `openTestDB` helper (node_repo_test.go:12). The `sshDialer` seam pattern (proxmox) has an analogue here: `transport.NewDispatchClient` is called inside `dispatchToPeer` (dispatcher.go:158) — to test dispatch-to-peer without a real mTLS server, either (a) inject a fake `DispatchClient` via a new interface seam, or (b) use `httptest.NewTLSServer` with a self-signed CA. Option (a) is lower-effort and aligns with the `LocalExecutor` pattern. Recommendation: extract a `peerDispatcher` interface (`Submit(ctx, spec, key) (*SubmitResponse, error)`) and inject it, OR test via `LocalSubmit`/`LocalStatus` paths (which only need a stubbed `LocalExecutor`) — the latter covers ~60% of dispatcher.go without a new seam. **Flag: 70% may require a small refactor to inject the dispatch client; 60-65% is achievable without one. Plan should decide whether to add the seam or accept 65%.**
|
||||
- **proxmox → 70% REALISTIC.** The `sshDialer` seam already exists (bootstrap.go:201-213, `sshDialerType` interface + `defaultSSHDialer` struct, overridable package-level var). A fake SSH dialer returning a mock `*ssh.Client` is the path. **However:** `*ssh.Client.NewSession()` + `session.CombinedOutput()` are concrete methods on the real `*ssh.Client` — there's no `sshSession` interface seam. To test `runRemote`/`deployPubKey`/`createLinuxUser`/`createPVERole`/etc. without a real SSH server, EITHER (a) introduce a `sessionRunner` interface seam (small refactor), OR (b) use `httptest.NewTLSServer` is wrong (it's SSH not HTTP) — instead use a real in-process SSH server via `golang.org/x/crypto/ssh` `NewServerConn` (more code but no new dep). **Flag: 70% likely requires either a `sessionRunner` interface refactor OR an in-process SSH server fixture. 50-55% is achievable with just the existing `sshDialer` seam + testing validation paths + `sudoersContent` string asserts (already done). Plan should add the `sessionRunner` seam — it's a 1-interface, ~10-LOC change that unlocks the bulk of the package.**
|
||||
- **cli → 70% AMBITIOUS but realistic.** The package is the largest (17 source files, ~2000 LOC). The existing tests use `rootCmd.SetArgs()` + `rootCmd.Execute()` + `t.TempDir()` + `ORCA_HOME` env (namespace_test.go:46-53 — `TestInitHonorsORCAHOME` is the template). The untested commands are `node join/leave/list`, `job run/list/stop/logs`, `cert *`, `doctor *`, `audit list`, `status`, `version`, `daemon`. Many touch the DB + certpaths + (for `node join --type proxmox`) the SSH dialer. **Strategy:** table-driven `rootCmd.Execute()` against a temp `ORCA_HOME` for each subcommand; mock the proxmox path via the existing `sshDialer` seam; capture stdout via `rootCmd.SetOut(&buf)`. **Flag: 70% across the whole package is a lot of test code; 55-65% is more realistic for one phase. The `daemon` command (background server) is hard to test without a lifecycle harness — recommend excluding it from the 70% target and documenting why.**
|
||||
- **transport → 70% REALISTIC.** `httptest.NewTLSServer` is the standard seam (already used in `internal/daemon/dispatch_test.go:59` and `server_test.go`). The `Dispatcher` interface (dispatch.go:49) is already mockable (`stubDispatcher` in dispatch_test.go:24 is the template). `MTLSClient.Do` wraps `http.Client.Do` — testable via `httptest.NewTLSServer` with a CA + client cert. `retry.go` `Do[T]` is generic + already partly tested via `idempotency_test.go` (TestRetrySucceedsAfterTransient etc.) — extend with backoff-timing asserts. `handshake_log.go` is pure slog calls — trivial to test by capturing into a `slog.Handler`. **No new seams needed; 70% achievable.**
|
||||
- **store → 70% REALISTIC.** The existing `openTestDB` helper (node_repo_test.go:12) + `withFastWatch` (job_task_repo_test.go:36) are reusable. **Critical gap:** `cert_repo.go` has NO test file despite v0.7 P01 REQ-053 claiming it was added — this is a v0.7 leftover bug. Adding `cert_repo_test.go` (Insert/Get/List/ListByNode/LatestForKind/PruneOlderThan/Delete + N=3 rotation history per REQ-025) alone lifts coverage significantly. Job/Task repo `Watch` is tested; `ListRecent`, error paths, scan-edge cases need coverage. **No new seams; 70% achievable.**
|
||||
- **jobspec → 70% REALISTIC.** `Parse` + `Validate` + `ParseFile` are pure functions over HCL bytes. Add golden-file HCL fixtures (multi-task, env vars, args) + error-path table (missing job, no tasks, missing command, malformed HCL, empty file, nonexistent file for `ParseFile`). `testdata/` dir doesn't exist yet — create it. **No new seams; 70% achievable, likely the easiest of the six.**
|
||||
- **audit → 50% toe-hold REALISTIC.** Package is 125 LOC, 4 exported funcs (`New`, `Emit`, `EmitWithErr`, `LogHandshakeOK`, `LogHandshakeFailed`, `FormatAction`, `Action.String`, `Result.String`). Strategy: construct `Audit` with a real `engine.Audit` backed by `:memory:` sqlite (via `store.NewAuditRepo` + `engine.NewAudit`) + assert rows in `audit_log` table; capture slog output via a test `slog.Handler`. **No new seams; 50% easily achievable, 70% achievable if desired.**
|
||||
- **certpaths → 50% toe-hold TRIVIAL.** Package is 64 LOC, pure path-join functions honoring `ORCA_HOME`/`ORCA_DB` env. Strategy: temp dir + `t.Setenv("ORCA_HOME", dir)` + assert each `*Path()` returns `filepath.Join(dir, <file>)`; test `ORCA_DB` override; test default-to-`~/.orca` fallback. Model the test on `namespace_test.go` (cli). **No new seams; 50%+ trivially achievable.**
|
||||
- **cmd/orca → 50% toe-hold REALISTIC but LOW VALUE.** `main.go` is 15 LOC: `cli.Execute()` + `fmt.Fprintf(os.Stderr, "error: %v")` + `os.Exit(1)`. The only testable behavior is "main() calls Execute and exits non-zero on error." A smoke test that calls `main()` in a subprocess (or refactors main into a `run() int` for testability) is the path. **Flag: 50% on a 15-LOC glue file is ~7 lines of covered code — the effort:coverage ratio is poor. D-047 explicitly called this out ("0→70% risks a coverage rathole on `cmd/orca` which is glue code"). Recommend the plan keep this at the 50% toe-hold and not over-invest.**
|
||||
|
||||
### 1.2 Existing test-helper utilities (reuse, do NOT re-create)
|
||||
|
||||
| Helper | Location | Reuse for |
|
||||
|--------|----------|-----------|
|
||||
| `openTestDB(t)` | `internal/store/node_repo_test.go:12` | engine, audit, store tests — returns `(*NodeRepo, func())` backed by temp-file sqlite; adapt to return `*sql.DB` for JobRepo/TaskRepo/AuditRepo/CapacityRepo/CertRepo |
|
||||
| `withFastWatch(t, d)` | `internal/store/job_task_repo_test.go:36` | store Watch tests — overrides `watchInterval` for deterministic ticks |
|
||||
| `initTestEnv(t)` | `internal/cli/init_test.go:17` | cli tests — sets `ORCA_HOME` to temp dir + returns cleanup |
|
||||
| `resetRootFlags(t)` | `internal/cli/namespace_test.go:13` | cli tests — resets `rootCmd` args/out/json/system flags between subtests |
|
||||
| `discardWriter` | `internal/cli/init_test.go:33` | cli tests — `io.Writer` that discards stdout |
|
||||
| `stubDispatcher` | `internal/daemon/dispatch_test.go:24` | transport/engine tests — implements `transport.Dispatcher` (`LocalSubmit`/`LocalStatus`); reusable as a `LocalExecutor` too since the signatures match |
|
||||
| `insertNode(t, repo, ctx, id, name)` | `internal/store/node_repo_test.go:217` | store/doctor tests — inserts a minimal node |
|
||||
| `security.CAInit`/`LoadCA`/`GenerateCSR`/`SignCSR`/`WriteCert`/`WriteKey` | `internal/security/ca.go` | transport mTLS tests — bootstrap a real CA + server cert into a temp dir (pattern in `doctor_test.go:69-94`) |
|
||||
| `t.Setenv("ORCA_HOME", dir)` + `t.Setenv("ORCA_DB", ...)` | `internal/doctor/doctor_test.go:23-24` | any test needing the orca namespace — preferred over manual `os.Setenv` (auto-cleanup) |
|
||||
|
||||
### 1.3 Injected seams already present in the codebase (confirm by reading)
|
||||
|
||||
1. **`sshDialer` (proxmox)** — `internal/proxmox/bootstrap.go:201-213`: package-level `var sshDialer sshDialerType = defaultSSHDialer{}`; interface `sshDialerType{ DialContext(ctx, network, addr, *ssh.ClientConfig) (*ssh.Client, error) }`. Tests can swap `sshDialer` for a fake. **GAP:** no `sessionRunner` seam — `runRemote` (line 217) calls `conn.NewSession()` + `session.CombinedOutput(cmd)` directly on the concrete `*ssh.Client`. Recommend P01 plan add a `sessionRunner` interface (`CombinedOutput(cmd) ([]byte, error)`) so `deployPubKey`/`createLinuxUser`/`createPVERole`/`createPVEUser`/`assignPVEACL`/`writeSudoers`/`validateSudoers` become testable without a real SSH endpoint.
|
||||
2. **`LocalExecutor` (engine dispatcher)** — `internal/engine/dispatcher.go:39`: interface `Submit(ctx, []byte) (string, error)` + `Status(ctx, string) (string, error)`. `Dispatcher` depends on it; tests inject a stub. **GAP:** `dispatchToPeer` (line 154) calls `transport.NewDispatchClient` directly (no seam) — to test the remote-dispatch branch, either add a `peerDispatcher` interface or test via `httptest.NewTLSServer`.
|
||||
3. **`PeerPersister` (engine peer)** — `internal/engine/peer.go:39`: optional persist callback; unused in production but available as a seam.
|
||||
4. **`Dispatcher` (transport)** — `internal/transport/dispatch.go:49`: `LocalSubmit`/`LocalStatus` interface; `stubDispatcher` in `daemon/dispatch_test.go:24` is the template stub.
|
||||
5. **`watchInterval` (store)** — `internal/store/job_task_repo.go:20`: unexported `var watchInterval = 1 * time.Second`; tests override via `withFastWatch`.
|
||||
|
||||
### 1.4 Packages where 70% is unrealistic in a single phase (with evidence)
|
||||
|
||||
- **`internal/cli` — 70% is ambitious.** 17 source files, ~2000 LOC. The `daemon` command (`internal/cli/daemon.go`) starts a long-running mTLS server — testing it requires a lifecycle harness (start, probe, shutdown) and is better covered by `internal/daemon/server_test.go` (already exists, 150 LOC). Recommend the P01 plan **exclude `daemon.go` from the cli 70% target** (document it as covered by the daemon package's own tests) and aim for 70% of the *remaining* cli files. Even so, 55-65% is the realistic single-phase outcome for the rest.
|
||||
- **`cmd/orca` — 70% is explicitly out of scope per D-047.** 15 LOC of glue; 50% toe-hold is the right call.
|
||||
- **`internal/proxmox` — 70% likely requires the `sessionRunner` seam refactor.** Without it, only the validation paths + `sudoersContent` string asserts are testable (~50-55%). The plan should add the seam; with it, 70% is achievable.
|
||||
|
||||
---
|
||||
|
||||
## 2. SSH trust hardening research (P02 — REQ-058, REQ-059)
|
||||
|
||||
### 2.1 Current TOFU `knownhosts.New()` callback — how it works
|
||||
|
||||
**Location:** `internal/proxmox/bootstrap.go:125-128` (bootstrap) + `internal/doctor/doctor.go:412-415` (doctor proxmox probe).
|
||||
|
||||
```go
|
||||
hostKeyCallback, err := knownhosts.New(certpaths.KnownHostsPath())
|
||||
// ...
|
||||
sshConfig := &ssh.ClientConfig{
|
||||
HostKeyCallback: hostKeyCallback,
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
**Mechanism (`golang.org/x/crypto/ssh/knownhosts`):**
|
||||
- `knownhosts.New(files ...string)` returns an `ssh.HostKeyCallback` that reads the OpenSSH-format `known_hosts` file at `certpaths.KnownHostsPath()` (= `$ORCA_HOME/known_hosts`, see `internal/certpaths/certpaths.go:62`).
|
||||
- **First connect (host absent from file):** the callback returns a `*knownhosts.KeyError` with `Want: []` (empty). This is a "host unknown" signal. **IMPORTANT:** `knownhosts.New` does NOT auto-write the key on first connect — it returns an error. The current orca code at `bootstrap.go:140` treats ANY dial error as a failure (`return nil, fmt.Errorf("ssh dial %s: %w", sshAddr, err)`). **This means the current TOFU flow is INCOMPLETE:** on a truly first connect, `knownhosts.New` returns `KeyError{Want:[]}` and the dial fails — there is no capture-and-persist step. The v0.6 RESEARCH_v0.6.md §A.5 claimed `knownhosts.New` "handles both capture and verify in one callback" but the actual `golang.org/x/crypto` API does NOT auto-capture; it only verifies. **This is a latent bug OR the operator is expected to pre-populate `known_hosts` manually (which contradicts the TOFU UX).** P02 must address this: either (a) wrap `knownhosts.New` with a custom callback that captures on `KeyError{Want:[]}` and writes via `knownhosts.Line`, or (b) accept that `--host-key-fingerprint` (REQ-058) becomes the *required* path for first connect and TOFU capture is a separate enhancement. **Flag for plan: the current TOFU capture is broken; P02 should fix it as part of the trust-hardening work (the `--host-key-fingerprint` path is actually simpler than TOFU because it doesn't need capture).**
|
||||
- **Subsequent connects (host present, key matches):** callback returns `nil` → dial proceeds.
|
||||
- **Subsequent connects (host present, key MISMATCH):** callback returns `*knownhosts.KeyError{Want: [knownKey]}` → dial fails with a clear error. This is the MITM-detection path.
|
||||
|
||||
**File format:** OpenSSH `known_hosts` — one line per host: `[host]:port ssh-key-type base64-key` (or hashed-host form via `knownhosts.HashHostname`). `knownhosts.Line(addresses []string, key ssh.PublicKey) string` produces the line; `knownhosts.Normalize(address)` normalizes the host:port.
|
||||
|
||||
### 2.2 `Result.HostKeyFingerprint` — current computation (CRITICAL FINDING)
|
||||
|
||||
**Location:** `internal/proxmox/bootstrap.go:83-85` (field declaration) + `bootstrap.go:195-198` (return statement).
|
||||
|
||||
```go
|
||||
type Result struct {
|
||||
NodeName string
|
||||
NodeAddress string
|
||||
HostKeyFingerprint string // field EXISTS
|
||||
}
|
||||
// ...
|
||||
return &Result{
|
||||
NodeName: opts.Host,
|
||||
NodeAddress: opts.Host + ":8443",
|
||||
// HostKeyFingerprint is NOT SET — always empty string
|
||||
}, nil
|
||||
```
|
||||
|
||||
**Finding:** `Result.HostKeyFingerprint` is **declared but never populated**. The current `BootstrapProxmox` returns it as `""`. There is **no fingerprint computation today** — no `ssh.FingerprintSHA256` call, no hex digest, nothing. D-045's rationale ("matches the fingerprint format operators already see from `orca node join`'s own `Result.HostKeyFingerprint` output") is based on a field that is currently always empty.
|
||||
|
||||
**Implication for P02:** The plan must ADD the fingerprint computation. The correct function is `ssh.FingerprintSHA256(pubKey ssh.PublicKey) string` (verified via `go doc`), which returns the **OpenSSH `SHA256:base64` format** (unpadded base64, exactly what `ssh-keyscan -E sha256` emits and what D-045 specifies). So D-045's format choice is correct *by intent* but the code doesn't produce it yet — P02 populates `Result.HostKeyFingerprint = ssh.FingerprintSHA256(hostKey)` during the capture path, and `--host-key-fingerprint` compares against `ssh.FingerprintSHA256` of the server-presented key.
|
||||
|
||||
**No existing fingerprint-comparison utility in `internal/security/`.** `security.Fingerprint` (fingerprint.go:17) computes SHA-256 **hex** of an X.509 cert's DER — a DIFFERENT format (hex, not base64; X.509, not SSH). `security.FingerprintOf` (fingerprint.go:34) is the same. **Do NOT reuse these for SSH host-key comparison** — they're for the mTLS CA pin (`--ca-fingerprint`). P02 needs a new SSH-specific helper, e.g. `security.SSHFingerprintSHA256(pubKey ssh.PublicKey) string` (thin wrapper over `ssh.FingerprintSHA256`) or inline in `proxmox/bootstrap.go`.
|
||||
|
||||
### 2.3 Where `--host-key-fingerprint` plugs in (REQ-058)
|
||||
|
||||
**CLI seam:** `internal/cli/node.go:344-354` — the `init()` registers flags on `nodeJoinCmd`. Add:
|
||||
```go
|
||||
nodeJoinCmd.Flags().StringVar(&joinHostKeyFP, "host-key-fingerprint", "", "SSH host key SHA256:base64 fingerprint (pre-pin; supersedes TOFU for --type proxmox)")
|
||||
```
|
||||
Per D-044, the flag lives on `orca node join` (not just `--type proxmox`); validation in `RunE` (`node.go:78-83`) emits a clear error if the flag is set for a non-proxmox type.
|
||||
|
||||
**Transport seam:** `internal/proxmox/bootstrap.go:131-136` — `ssh.ClientConfig.HostKeyCallback`. Currently `knownhosts.New(...)`. When `--host-key-fingerprint` is supplied, replace the callback with a `ssh.FixedHostKey`-style verifier that:
|
||||
1. Parses the operator-supplied `SHA256:base64` string (strip `SHA256:` prefix, base64-decode → 32 bytes).
|
||||
2. In the callback, receives the server's `ssh.PublicKey`, computes `ssh.FingerprintSHA256(key)`, compares to the operator string.
|
||||
3. Returns `nil` on match, `error` on mismatch (fail closed).
|
||||
|
||||
**Recommended callback shape (concrete):**
|
||||
```go
|
||||
func pinnedHostKeyCallback(expectedSHA256Base64 string) (ssh.HostKeyCallback, error) {
|
||||
// Validate format: must start with "SHA256:".
|
||||
if !strings.HasPrefix(expectedSHA256Base64, "SHA256:") {
|
||||
return nil, fmt.Errorf("host-key-fingerprint: must be OpenSSH SHA256:base64 format (got %q)", expectedSHA256Base64)
|
||||
}
|
||||
expected := expectedSHA256Base64 // store full string for direct compare
|
||||
return func(_ string, _ net.Addr, key ssh.PublicKey) error {
|
||||
got := ssh.FingerprintSHA256(key)
|
||||
if got != expected {
|
||||
return fmt.Errorf("host key fingerprint mismatch: got %s, want %s — refusing to connect (REQ-058)", got, expected)
|
||||
}
|
||||
return nil
|
||||
}, nil
|
||||
}
|
||||
```
|
||||
**Why compare full strings (not base64-decoded bytes):** `ssh.FingerprintSHA256` returns the canonical `SHA256:base64` string; comparing it directly to the operator-supplied string is simplest and avoids a base64-decode step. Reject non-`SHA256:`-prefixed input up front with a clear error (D-045: "Accept only `SHA256:`-prefixed base64; reject raw hex with a clear error").
|
||||
|
||||
**Pass-through to proxmox:** `internal/cli/node.go:158-166` — add `HostKeyFingerprint string` to `proxmox.Options` (bootstrap.go:55) and pass `joinHostKeyFP` through. `BootstrapProxmox` selects the callback: if `opts.HostKeyFingerprint != ""` use `pinnedHostKeyCallback`, else fall back to the TOFU `knownhosts.New` (with the capture-fix from §2.1).
|
||||
|
||||
### 2.4 `orca node key-reset <node>` (REQ-059, D-046 — local known_hosts only)
|
||||
|
||||
**Scope (D-046):** clear the local `~/.orca/known_hosts` entry for the node ONLY; do NOT revoke the remote authorized_keys entry (would orphan a working node). Audit-log `event=node.key_reset` with `actor` + `node`.
|
||||
|
||||
**`known_hosts` line format written by `golang.org/x/crypto/ssh/knownhosts`:**
|
||||
- `knownhosts.Line(addresses []string, key ssh.PublicKey) string` → `"[host]:port ssh-ed25519 AAAA...\n"` (or `host ssh-ed25519 AAAA...` if port 22 — `knownhosts.Normalize` handles the `:22` vs bare-host normalization).
|
||||
- The file is plain text, one entry per line, `#`-prefixed comments allowed.
|
||||
|
||||
**No library function to remove a host's entries.** `knownhosts.New` only reads. The reset must be implemented manually:
|
||||
1. Read `certpaths.KnownHostsPath()` (`internal/certpaths/certpaths.go:62`).
|
||||
2. Filter lines: keep lines whose host field (before the first whitespace) does NOT match `knownhosts.Normalize(nodeName)` (or the node's address). **Edge:** a host may have multiple entries (one per key type); remove all matching lines.
|
||||
3. Write the filtered content back via **atomic rewrite** (temp file in same dir + `os.Rename`) — reuse `security.writeAtomic` (ca.go:305) OR implement inline (it's unexported in `security`; either export it or copy the ~20-LOC pattern). **Recommend atomic rewrite, NOT in-place truncation** — in-place rewrite via `os.OpenFile(O_TRUNC|O_WRONLY)` risks data loss on crash mid-write.
|
||||
|
||||
**CLI registration seam:** `internal/cli/node.go:358-360` — the `init()` does `nodeCmd.AddCommand(nodeJoinCmd)`, `nodeLeaveCmd`, `nodeListCmd`. Add:
|
||||
```go
|
||||
nodeCmd.AddCommand(nodeKeyResetCmd)
|
||||
```
|
||||
where `nodeKeyResetCmd` is a new `&cobra.Command{Use: "key-reset <node>", Args: cobra.ExactArgs(1), RunE: ...}`. The `RunE`:
|
||||
1. Resolve `<node>` arg → look up the node in the registry (`nodeRegistry()` at node.go:37) to get its address (for matching `known_hosts` lines) — OR accept the raw host string directly. **Recommend:** accept the node NAME (consistent with `doctor proxmox` which iterates `node.Name`), look up the node row, use `node.Name` (which is the host address for proxmox nodes per `bootstrap.go:196`) as the `known_hosts` match key.
|
||||
2. Call a new `proxmox.ResetHostKey(host string) error` (or inline in cli) that does the atomic rewrite.
|
||||
3. Audit-log via `engine.Audit.Record(ctx, "cli", "node.key_reset", nodeID, "success", nil, map[string]any{"host": host})`.
|
||||
4. Print `✓ Host key reset for <node> (next connect will re-pin via TOFU or --host-key-fingerprint)`.
|
||||
|
||||
**Reusability:** the `nodeRegistry()` helper (node.go:37) + `openDB()` (node.go:25) + `newLogger()` (node.go:33) are all available for the key-reset command.
|
||||
|
||||
### 2.5 CLI registration seam summary (P02)
|
||||
|
||||
| Addition | File:line | Change |
|
||||
|----------|-----------|--------|
|
||||
| `--host-key-fingerprint` flag | `internal/cli/node.go:344-354` (init) | `nodeJoinCmd.Flags().StringVar(&joinHostKeyFP, "host-key-fingerprint", "", "...")` |
|
||||
| `joinHostKeyFP` var | `internal/cli/node.go:47-60` (var block) | add `joinHostKeyFP string` |
|
||||
| Pass-through to proxmox | `internal/cli/node.go:158-166` (joinProxmox) | add `HostKeyFingerprint: joinHostKeyFP` to `proxmox.Options` |
|
||||
| `HostKeyFingerprint` field | `internal/proxmox/bootstrap.go:55` (Options) | add field |
|
||||
| Pinned callback | `internal/proxmox/bootstrap.go:131-136` | branch: if `opts.HostKeyFingerprint != ""` use pinned callback else TOFU |
|
||||
| Populate `Result.HostKeyFingerprint` | `internal/proxmox/bootstrap.go:195-198` | set `HostKeyFingerprint: ssh.FingerprintSHA256(hostKey)` during capture |
|
||||
| `key-reset` subcommand | `internal/cli/node.go:358-360` (init) | `nodeCmd.AddCommand(nodeKeyResetCmd)` + new cmd var |
|
||||
| `ResetHostKey` helper | `internal/proxmox/bootstrap.go` (new) OR `internal/security/sshkey.go` | atomic known_hosts rewrite |
|
||||
|
||||
---
|
||||
|
||||
## 3. Requirements-hygiene gate research (P03 — REQ-060)
|
||||
|
||||
### 3.1 Current Makefile targets
|
||||
|
||||
`Makefile` has 11 targets: `build`, `test`, `test-race`, `lint`, `fmt`, `clean`, `run`, `version`, `changelog`, `release`, `security-scan` (Makefile:1-100). **No `verify-reqs` target exists.** The `.PHONY` list at line 1 must be extended.
|
||||
|
||||
### 3.2 Current `.coreci.yml` pipeline structure
|
||||
|
||||
4 pipelines (`.coreci.yml:19-134`):
|
||||
- **validate** (line 20): 4 steps — `go-version` (gofmt+vet), `gosec`, `govulncheck`, `gitleaks`.
|
||||
- **build** (line 53): 1 step — version-injected `go build`.
|
||||
- **test** (line 72): 1 step — `go test -race -coverprofile=coverage.out ./...` + `go tool cover -func | tail -1`.
|
||||
- **release** (line 81): gated on `refs/tags/v*`; 3 steps — build-artifact, gitea-release, container-publish.
|
||||
|
||||
**Hook for `verify-reqs`:** add a 5th step to the `validate` pipeline (after `go-version`, before/after `gosec`) OR add it to the `test` pipeline. **Recommend `validate` pipeline** — requirements hygiene is a static check (no test run needed), belongs alongside gofmt/vet/lint. Step shape:
|
||||
```yaml
|
||||
- name: verify-reqs
|
||||
image: golang:1.25
|
||||
commands:
|
||||
- make verify-reqs
|
||||
```
|
||||
|
||||
### 3.3 `verify-reqs` implementation recommendation
|
||||
|
||||
**Assertion (REQ-060):** every REQ row in `ROADMAP.md` marked `[x]`/Complete must have a matching REQ-ID row in `REQUIREMENTS.md` with `Complete` status. (Reverse direction — every REQUIREMENTS `Complete` has a ROADMAP `[x]` — is also worth checking but the drift that motivated this was ROADMAP-shipped-but-REQUIREMENTS-Pending, so the forward direction is the priority.)
|
||||
|
||||
**Approach: small Go program in `cmd/verify-reqs` OR a shell+awk script?**
|
||||
|
||||
- **Go program** (~80 LOC): parse both markdown tables with `regexp`, build two `map[string]string` (REQ-ID → status), diff. Pros: type-safe, testable, consistent with the Go toolchain; can be a `cmd/verify-reqs/main.go` with its own `_test.go`. Cons: adds a binary target.
|
||||
- **Shell+awk** (~30 LOC): `awk` over the markdown tables. Pros: no new Go package; minimal. Cons: fragile parsing, hard to test, shell-quoting issues.
|
||||
|
||||
**Recommendation: Go program at `cmd/verify-reqs/main.go`.** Reasons: (1) testable with golden-file fixtures (parse a sample ROADMAP+REQUIREMENTS pair, assert diff); (2) consistent with the project's Go-only tooling ethos (no shell-awk fragility); (3) the `make verify-reqs` target just calls `go run ./cmd/verify-reqs`; (4) CoreCI's `golang:1.25` image has `go` available — no extra dep.
|
||||
|
||||
**Parsing approach (concrete):**
|
||||
1. ROADMAP.md: regex `^\s*-\s*\[(x|X| )\]\s*Phase.*—.*tag` is NOT the right pattern (that's phase lines, not REQ rows). The REQ coverage is in per-phase bullet lists under "### Per-phase REQ coverage" (ROADMAP.md:161-180) AND in the milestone section bodies. **Simpler:** the ROADMAP uses `- [x] Phase N: ...` for completed phases. The authoritative REQ↔status mapping lives in **REQUIREMENTS.md** (the single table at lines 9-56 + per-milestone tables at 103-142). **Re-interpret REQ-060:** the assertion is really "ROADMAP milestone sections marked COMPLETE ↔ REQUIREMENTS rows for that milestone marked Complete." The drift was: v0.7 ROADMAP said "COMPLETE" (line 116) but REQUIREMENTS v0.7 rows (REQ-053..056) were "Pending" (now corrected to "Complete" in SPECIFY).
|
||||
2. **Refined assertion:** parse REQUIREMENTS.md table rows (`| REQ-XXX | ... | ... | ... | **Complete** |` or `| Pending |`); for each REQ-ID, record status. Then parse ROADMAP.md for milestone-level "COMPLETE" markers (`## Milestone v0.X: ... — **COMPLETE**`) AND phase-level `- [x]` markers. For each milestone marked COMPLETE in ROADMAP, assert every REQ-ID belonging to that milestone (per the REQUIREMENTS milestone column) is `Complete` in REQUIREMENTS. **OR (simpler, matches the SPECIFY wording):** for every REQ-ID in REQUIREMENTS.md whose `Phase` column references a milestone that ROADMAP marks COMPLETE, the Status must be `Complete`. This catches the exact drift (ROADMAP-shipped, REQUIREMENTS-stale).
|
||||
|
||||
**Concrete regex:**
|
||||
- REQUIREMENTS row: `^\|\s*(REQ-\d+)\s*\|.*?\|\s*\*\*(Complete|Pending)\*\*\s*\|` (capture ID + status).
|
||||
- ROADMAP milestone-complete: `^##\s*Milestone\s+v0\.\d+:.*—\s*\*\*COMPLETE\*\*` (capture milestone label).
|
||||
- Map milestone → REQs via the REQUIREMENTS `Phase` column (e.g. `v0.7 P1` → milestone `v0.7`).
|
||||
|
||||
**Where it hooks in:** `make verify-reqs` runs `go run ./cmd/verify-reqs .ciagent/ROADMAP.md .ciagent/REQUIREMENTS.md`; `.coreci.yml` validate pipeline adds the step. Exit 0 on consistency, exit 1 with a diff listing on drift.
|
||||
|
||||
### 3.4 The drift that motivated REQ-060
|
||||
|
||||
After v0.7 ship, REQUIREMENTS.md rows REQ-053..056 were "Pending" despite ROADMAP.md marking milestone v0.7 COMPLETE and all phases `[x]`. This was corrected during v0.8 SPECIFY (the rows now read `**Complete**`). REQ-060 ensures the drift cannot recur: the CI validate pipeline fails if ROADMAP says COMPLETE but REQUIREMENTS says Pending.
|
||||
|
||||
---
|
||||
|
||||
## 4. Architectural decisions surfaced (AD-027..AD-030)
|
||||
|
||||
| ID | Decision | Rationale |
|
||||
|----|----------|-----------|
|
||||
| AD-027 | `ssh.FingerprintSHA256` (OpenSSH `SHA256:base64`) as the SSH host-key fingerprint format | Matches D-045 + `ssh-keyscan -E sha256` output. The existing `security.Fingerprint` (hex, X.509) is NOT reused — different domain. P02 adds a thin SSH-specific helper. |
|
||||
| AD-028 | `--host-key-fingerprint` callback compares full `SHA256:base64` strings, not decoded bytes | `ssh.FingerprintSHA256` returns the canonical string; direct string compare avoids a base64-decode step and is less error-prone. Validate `SHA256:` prefix up front. |
|
||||
| AD-029 | `orca node key-reset` rewrites `known_hosts` via atomic temp-file + rename | Prevents data loss on crash mid-write. Reuse the `writeAtomic` pattern from `security/ca.go:305` (export it or copy the ~20 LOC). |
|
||||
| AD-030 | `verify-reqs` implemented as `cmd/verify-reqs/main.go` (Go program), not shell+awk | Testable, type-safe, consistent with Go-only tooling. `make verify-reqs` runs `go run ./cmd/verify-reqs`. Hooked into `.coreci.yml` validate pipeline. |
|
||||
|
||||
---
|
||||
|
||||
## 5. Pitfalls, gaps, and flags for the plan
|
||||
|
||||
1. **TOFU capture is currently BROKEN (§2.1).** `knownhosts.New` returns `KeyError{Want:[]}` on first connect and does NOT auto-write the key. The current `BootstrapProxmox` treats this as a dial failure. P02 must either (a) wrap the callback to capture-and-persist on `KeyError{Want:[]}` via `knownhosts.Line` + atomic write, or (b) make `--host-key-fingerprint` the required first-connect path. **Recommend (a) — fix TOFU + add pre-pin as superset.** This is a v0.6 latent bug that P02 closes.
|
||||
2. **`Result.HostKeyFingerprint` is never populated (§2.2).** D-045's rationale references "existing output" that doesn't exist. P02 must ADD the computation (`ssh.FingerprintSHA256`). Low risk — it's a 1-line addition once the host key is available.
|
||||
3. **No `sessionRunner` seam in proxmox (§1.3).** Testing the SSH command sequence (deployPubKey, createLinuxUser, pveum, sudoers, visudo) without a real SSH server requires a new interface seam. **Recommend P01 plan add it** — 1 interface, ~10 LOC, unlocks ~40% of proxmox coverage.
|
||||
4. **`internal/store/cert_repo.go` has NO test (§1.1).** v0.7 P01 REQ-053 was supposed to add `cert_repo_test.go` but it's missing — `internal/store/` glob shows no `cert_repo_test.go`. This is a v0.7 leftover. P01 should add it (it directly lifts store coverage toward 70%).
|
||||
5. **`internal/cli/daemon.go` excluded from cli 70% target (§1.4).** The daemon command starts a long-running server; it's covered by `internal/daemon/server_test.go` (150 LOC). Don't double-test in cli.
|
||||
6. **`cmd/orca` 50% toe-hold is low-value (§1.1).** 15 LOC of glue; the test effort:coverage ratio is poor. D-047 already called this out. Don't over-invest.
|
||||
7. **`go: no such tool "covdata"` for zero-test packages (§1.1).** This is a Go toolchain quirk when a package has no test files — `go test -cover` can't compute coverage without a test binary. It's NOT a real 0% number (it's "undefined"). Adding any `_test.go` file makes the number computable. Don't treat the error as a coverage measurement.
|
||||
8. **`transport.dispatchToPeer` has no seam (§1.3).** Testing the remote-dispatch branch of `Dispatcher.Submit` requires either a new `peerDispatcher` interface OR `httptest.NewTLSServer`. The latter is already used in `daemon/dispatch_test.go`; recommend the plan use `httptest.NewTLSServer` (no refactor needed) for transport coverage.
|
||||
9. **`knownhosts.Line` + `knownhosts.Normalize` are the helpers for the TOFU-capture fix and for `key-reset` matching (§2.1, §2.4).** Use `Normalize` to match host strings consistently (handles `host:22` vs `host`).
|
||||
10. **`security.writeAtomic` is unexported (ca.go:305).** `key-reset`'s atomic known_hosts rewrite needs it. Either export `WriteAtomic` from `security`, or copy the ~20-LOC pattern into `proxmox`/`cli`. **Recommend export** — it's already used across ca.go + sshkey.go and is generally useful.
|
||||
|
||||
---
|
||||
|
||||
## 6. Dependencies
|
||||
|
||||
v0.8 adds **zero** new direct dependencies:
|
||||
- SSH host-key fingerprint: `ssh.FingerprintSHA256` (already in `golang.org/x/crypto/ssh` v0.54.0, direct dep since v0.6).
|
||||
- `knownhosts.Line`/`Normalize`/`KeyError`: same `golang.org/x/crypto` module.
|
||||
- `verify-reqs`: stdlib only (`regexp`, `os`, `fmt`).
|
||||
- Tests: `net/http/httptest` (stdlib), existing interfaces.
|
||||
|
||||
`go.mod` is unchanged by v0.8.
|
||||
|
||||
---
|
||||
|
||||
## 7. PERSONAS assessment (v0.8)
|
||||
|
||||
v0.8 is an NFR milestone touching tests (9 packages), SSH trust surface (proxmox + cli/node + security), and a requirements-hygiene Go program. The 3-persona roster from config.json (lead-developer, backend-engineer, data-engineer) is sufficient — no phase-specific personas needed.
|
||||
|
||||
**Roster confirmation:**
|
||||
- **lead-developer** — owns coordination + `cmd/orca` smoke test + `internal/cli` coverage (cert/doctor/audit/status/version subcommands) + the `verify-reqs` Go program (coordination territory).
|
||||
- **backend-engineer** — owns `internal/transport` tests (httptest.NewTLSServer) + `internal/engine` tests (LocalExecutor stubs, PeerRegistry) + SSH trust-surface in `internal/proxmox/bootstrap.go` (pinned callback, TOFU capture fix, sessionRunner seam) + `internal/cli/node.go` (`--host-key-fingerprint` flag, `key-reset` subcommand).
|
||||
- **data-engineer** — owns `internal/store` tests (cert_repo_test.go gap + coverage uplift) + `internal/audit` tests (sqlite-backed audit_log asserts) + `internal/certpaths` tests (path-join asserts) + `internal/jobspec` tests (golden HCL fixtures).
|
||||
|
||||
No frontend persona (no UI). No devops persona (no packaging/distribution — `verify-reqs` is a Go program, not a CI config change; the `.coreci.yml` edit is a 3-line hook, lead-developer territory). No security-engineer persona (the SSH trust work is backend-engineer territory — the security-engineer was deactivated in v0.7 and v0.8 doesn't re-add it; the trust-surface hardening is a refinement of the existing `proxmox` package, not new security architecture).
|
||||
|
||||
See `.ciagent/PERSONAS.md` (updated with v0.8 YAML frontmatter + territory globs matching the actual file structure).
|
||||
@@ -0,0 +1,321 @@
|
||||
# Review: Orca v0.8 — Coverage & Trust Hardening (final-phase)
|
||||
|
||||
**Reviewer**: ci-code-reviewer (multi-persona: correctness, testing, security, performance, maintainability, adversarial)
|
||||
**Branch**: `phase/04-final-review-ship` (review HEAD = P03 ship `70c5718`)
|
||||
**Diff scope**: `main...milestone/v0.8-coverage-trust-hardening` (all v0.8 work, 59 files, +6550/-173)
|
||||
**Date**: 2026-08-04
|
||||
**Verdict**: **PASS-WITH-FOLLOWUPS** (0 P0, 2 P1, 2 P2)
|
||||
|
||||
## Methodology
|
||||
|
||||
Read the full diff (`internal/`, `cmd/`, `Makefile`, `.coreci.yml`), all 3 phase
|
||||
verification reports, PLAN/RESEARCH/GRILL/PERSONAS, and the critical production
|
||||
files directly (`internal/proxmox/bootstrap.go`, `internal/security/ca.go`,
|
||||
`internal/security/sshkey.go`, `internal/doctor/doctor.go:400-454`,
|
||||
`cmd/verify-reqs/main.go`). Re-ran `go build ./...`, `go vet ./...`,
|
||||
`go test -race` on proxmox/security/doctor/cli/verify-reqs/cmd-orca, and
|
||||
`make verify-reqs` (all PASS). Re-verified the verify-reqs regex against the
|
||||
real ROADMAP.md (matches v0.1..v0.7 COMPLETE incl. v0.2 parenthetical; v0.8
|
||||
correctly not matched). Confirmed all 7 T02.10 e2e cases are present and
|
||||
exercised through a real in-process SSH server.
|
||||
|
||||
---
|
||||
|
||||
## Per-Axis Findings
|
||||
|
||||
### 1. Correctness (lead-developer)
|
||||
|
||||
**C1 — `sessionRunner` seam backward-compat** ✅
|
||||
`internal/proxmox/bootstrap.go:170-172,322-339`. The seam is a package-level
|
||||
`var sessionRunner sessionRunnerType` (line 326) initialized lazily inside
|
||||
`BootstrapProxmox` from the dialed `*ssh.Client` (`if sessionRunner == nil {
|
||||
sessionRunner = &sshSessionRunner{client: conn} }`). Existing callers are
|
||||
unchanged — the default `sshSessionRunner` wraps the real
|
||||
`conn.NewSession().CombinedOutput(...)`. Tests reset `sessionRunner = nil`
|
||||
between runs (bootstrap_test.go:910, 1010, 1035) to avoid cross-test leakage.
|
||||
Backward compatible as required by P01 verification. No issue.
|
||||
|
||||
**C2 — `verify-reqs` parser correctness** ✅
|
||||
`cmd/verify-reqs/main.go:18-26`. The `reqRowRe` uses a greedy `.*` for the
|
||||
Requirement+Priority cells and anchors the Phase+Status match at the END of
|
||||
the line, where those two columns always live. This correctly handles
|
||||
escaped pipes inside the Requirement cell (e.g. REQ-049
|
||||
`localhost\|linux\|proxmox` — verified by the passing `make verify-reqs`
|
||||
which reports 60 consistent rows, matching the 60 REQ rows in
|
||||
REQUIREMENTS.md). The status token is optionally bold-wrapped
|
||||
(`\*{0,2}(Complete|Pending)\*{0,2}`) with `[^|]*` for trailing notes —
|
||||
handles `**Complete** (P01 shipped v0.2.1)`. The milestone-complete regex
|
||||
`^##\s*Milestone\s+(v0\.\d+):.*—\s*\*\*[^*]*\bCOMPLETE\b[^*]*\*\*` is
|
||||
substring-tolerant (GRILL #4) — verified against the real ROADMAP: matches
|
||||
v0.1..v0.7 incl. v0.2's `**COMPLETE (merged to main via v0.3)**` and v0.6's
|
||||
duplicate header (line 94 matched; line 92 without COMPLETE ignored). v0.8
|
||||
(line 136, not yet COMPLETE) correctly not matched — so the v0.8 REQ rows
|
||||
being `Pending` is NOT flagged as drift (correct: milestone not shipped
|
||||
yet). No issue.
|
||||
|
||||
**C3 — TOFU capture-fix logic** ✅
|
||||
`internal/proxmox/bootstrap.go:275-310`. On `*knownhosts.KeyError` with
|
||||
empty `Want` (host unknown), captures the key, reads existing known_hosts
|
||||
(create-if-missing), ensures trailing newline, appends
|
||||
`knownhosts.Line([]string{knownhosts.Normalize(addr)}, key)`, writes via
|
||||
`security.WriteAtomic`, returns nil (dial proceeds). On non-empty `Want`
|
||||
(mismatch) returns the error (MITM detection preserved). On `nil` (match)
|
||||
records key + returns nil. Correct against x/crypto v0.54.0 `checkAddr`
|
||||
semantics. No issue.
|
||||
|
||||
**C4 — `ResetHostKey` line matching** ✅
|
||||
`internal/proxmox/bootstrap.go:479-523`. Matches a line when its first
|
||||
whitespace-delimited field, normalized via `knownhosts.Normalize`, equals
|
||||
the normalized target. Handles `[host]:22` vs bare `host` (Normalize
|
||||
brackets ports). Preserves comments/blanks. Atomic rewrite via
|
||||
`security.WriteAtomic`. Edge cases handled: empty host errors, missing
|
||||
file is a no-op, no matching lines is a no-op. Test
|
||||
`TestResetHostKey_RemovesTargetLines` (bootstrap_test.go:718) seeds 2 lines
|
||||
for target + 1 for another host, asserts target's 2 removed + other
|
||||
intact. No issue.
|
||||
|
||||
**C5 — `--host-key-fingerprint` non-proxmox validation** ✅
|
||||
`internal/cli/node.go:79-81`. `RunE` checks `joinHostKeyFP != "" &&
|
||||
joinType != "proxmox"` → clear error. Test
|
||||
`TestNodeJoinHostKeyFingerprintRequiresProxmox` (node_test.go:445) asserts
|
||||
the error; `TestNodeJoinHostKeyFingerprintProxmoxAccepted` (node_test.go:477)
|
||||
asserts the negative-space (proxmox type accepts the flag). No issue.
|
||||
|
||||
### 2. Testing (all personas)
|
||||
|
||||
**T1 — Coverage held post-P02** ✅
|
||||
PHASE2 verification: proxmox 86.5% (was 87.1%), cli 76.7% (was 76.2%),
|
||||
doctor 70.4%. Marginal changes from new code paths — no coverage regression.
|
||||
Re-ran `go test -race ./internal/proxmox/... ./internal/cli/...` PASS.
|
||||
|
||||
**T2 — Race tests pass** ✅
|
||||
`go test -race -count=1 ./internal/proxmox/... ./internal/security/...
|
||||
./internal/doctor/... ./cmd/verify-reqs/... ./cmd/orca/...` all PASS.
|
||||
`./internal/cli/...` PASS (77s, dominated by watch tests). No races.
|
||||
|
||||
**T3 — 7 T02.10 integration cases** ✅
|
||||
All 7 present in `internal/proxmox/bootstrap_test.go`, exercised
|
||||
end-to-end through `BootstrapProxmox` with a real in-process SSH server
|
||||
(`bootstrapE2ESetup`):
|
||||
- Case 1: `TestBootstrapE2E_PinnedFingerprintCorrect` (815)
|
||||
- Case 2: `TestBootstrapE2E_PinnedFingerprintWrong` (842)
|
||||
- Case 3: `TestBootstrapE2E_TOFUFirstConnectCapturesKey` (865)
|
||||
- Case 4: `TestBootstrapE2E_TOFUSecondConnectMatches` (905)
|
||||
- Case 5: `TestBootstrapE2E_TOFUMismatchFails` (925)
|
||||
- Case 6: `TestBootstrapE2E_KeyResetThenRePin` (1002)
|
||||
- Case 7: `TestBootstrapE2E_PrePopulatedKnownHostsMatches` (966, v0.6→v0.8 migration)
|
||||
|
||||
**T4 — Golden tests for verify-reqs** ✅
|
||||
`cmd/verify-reqs/main_test.go` has 7 tests covering: clean pair, multi-drift
|
||||
(both directions), default-args subprocess, malformed (no REQ rows → error),
|
||||
missing file → error, v0.2 substring-tolerant header regression guard
|
||||
(`TestVerify_v02SubstringTolerantHeader`), and real-repo regression guard.
|
||||
The substring-tolerant regex is explicitly exercised — the drift fixture's
|
||||
ROADMAP uses `**COMPLETE (merged to main via v0.3)**` on v0.2 and the test
|
||||
asserts REQ-002 (v0.2 P1, Pending) is flagged forward-drift (would be
|
||||
silently skipped if the regex regressed). No issue.
|
||||
|
||||
**T5 — Doctor parity test** ✅
|
||||
`internal/doctor/doctor_test.go` extended with 94 LOC covering
|
||||
`probeProxmoxPVEVersion` paths. The doctor callback now uses the shared
|
||||
`proxmox.TOFUHostKeyCallback` (doctor.go:424) — GRILL #2 parity verified by
|
||||
reading both call sites. No issue.
|
||||
|
||||
### 3. Security (backend-engineer)
|
||||
|
||||
**S1 — `--host-key-fingerprint` fails closed** ✅
|
||||
`internal/proxmox/bootstrap.go:141-153,245-258`. The pinned/TOFU branch is
|
||||
mutually exclusive (`if opts.HostKeyFingerprint != "" { ... } else { ... }`).
|
||||
The pinned callback (245-258) validates `SHA256:` prefix up front (rejects
|
||||
raw hex per D-045), computes `ssh.FingerprintSHA256(key)`, returns an error
|
||||
on any mismatch — no fallback to TOFU. The dial (164) aborts on callback
|
||||
error before any SSH session command runs. Cannot be bypassed: the pin is
|
||||
compared as a full string against the canonical fingerprint of the
|
||||
server-presented key; a mismatch returns before `*capturedKey` is set. No
|
||||
issue.
|
||||
|
||||
**S2 — `key-reset` is local-only (D-046)** ✅
|
||||
`internal/proxmox/bootstrap.go:479-523` + `internal/cli/node.go:348-407`.
|
||||
`ResetHostKey` only reads/writes `certpaths.KnownHostsPath()`. No SSH dial,
|
||||
no remote authorized_keys touch. Audit-logs `node.key_reset` with
|
||||
actor+node+host (node.go:396-400). Verified by `TestNodeKeyReset`
|
||||
(node_test.go:326) which asserts the audit row. No issue.
|
||||
|
||||
**S3 — TOFU capture-fix doesn't weaken MITM detection** ✅
|
||||
See C3 — the fix ONLY captures on `KeyError{Want:[]}` (host unknown); a
|
||||
non-empty `Want` (key mismatch / MITM) returns the error. The capture path
|
||||
writes the server-presented key, so a subsequent different key fails. No
|
||||
issue.
|
||||
|
||||
**S4 — `WriteAtomic` is actually atomic** ✅
|
||||
`internal/security/ca.go:308-337`. Temp file in same dir
|
||||
(`os.CreateTemp(dir, ".tmp-*")`), `Write`, `Chmod`, `Sync`, `Close`, then
|
||||
`os.Rename` (atomic on POSIX same-filesystem). `defer os.Remove(tmpName)`
|
||||
cleans up on failure. Genuine atomic-write pattern. No issue.
|
||||
|
||||
### 4. Performance (all)
|
||||
|
||||
**P1 — ResetHostKey is O(n) in file size** ✅
|
||||
`internal/proxmox/bootstrap.go:479-523`: one `os.ReadFile` (O(n)), one
|
||||
`strings.Split` + linear filter loop (O(n)), one `security.WriteAtomic`
|
||||
(O(n)). No nested loops, no O(n²). For a known_hosts file (typically tens
|
||||
of lines), this is negligible. No issue.
|
||||
|
||||
**P2 — Unnecessary allocations** (P2 — nit)
|
||||
`bootstrap.go:494-510`: `strings.Split(string(existing), "\n")` allocates a
|
||||
slice of all lines + `append(kept, []byte(line+"\n")...)` reallocates the
|
||||
kept buffer. For known_hosts (small file) this is fine; a `bufio.Scanner`
|
||||
over `bytes.NewReader(existing)` with a `strings.Builder` would be leaner,
|
||||
but the current shape is clear and the file is tiny. Not worth changing.
|
||||
Flagged P2 (nit, no action).
|
||||
|
||||
### 5. Maintainability (lead-developer)
|
||||
|
||||
**M1 — `TOFUHostKeyCallback` extraction** ✅
|
||||
`internal/proxmox/bootstrap.go:261-310` is exported and shared by bootstrap
|
||||
(148) and doctor (doctor.go:424) via
|
||||
`proxmox.TOFUHostKeyCallback(sshAddr, &capturedHostKey)`. Clean coupling:
|
||||
doctor imports proxmox (one-way), no duplication, no circular dep. The
|
||||
GRILL #2 parity requirement (both call sites use the same wrapper) is
|
||||
satisfied by construction. No issue.
|
||||
|
||||
**M2 — `verify()` testable** ✅
|
||||
`cmd/verify-reqs/main.go:98-148`: the core logic is a pure function
|
||||
`verify(roadmapPath, reqsPath string) (diff []string, count int, err error)`
|
||||
with `main()` as a thin wrapper. Golden-file tests call `verify()` directly
|
||||
(no subprocess). Mirrors the T01.11 `main()→run()` pattern. No issue.
|
||||
|
||||
**M3 — cli tests follow conventions** ✅
|
||||
`internal/cli/namespace_test.go:21-35` adds `resetCommandFlags()` to zero
|
||||
the package-level flag-bound vars between subtests (cobra parses into
|
||||
globals; without reset a prior test's value persists). Called from
|
||||
`resetRootFlags`. This is a sound convention — the test isolation is
|
||||
correct. No issue.
|
||||
|
||||
**M4 — `resetCommandFlags` completeness** (P2 — nit)
|
||||
`namespace_test.go:28-34` resets the join/leave/cap/audit/run/stop flags but
|
||||
NOT `joinHostKeyFP`. A test that sets `--host-key-fingerprint` without
|
||||
calling `resetRootFlags` could leak the value to a later test. In practice
|
||||
all node tests call `resetRootFlags` which calls `resetCommandFlags`, so
|
||||
this is a latent risk only. Recommend adding `joinHostKeyFP = ""` to
|
||||
`resetCommandFlags` for completeness. Flagged P2 (nit).
|
||||
|
||||
### 6. Adversarial (backend-engineer)
|
||||
|
||||
**A1 — Can `--host-key-fingerprint` be bypassed?** ✅
|
||||
No. The pinned callback (bootstrap.go:249-258) returns an error before
|
||||
recording the key or allowing the dial to proceed on any mismatch. There is
|
||||
no code path where a supplied pin is ignored — the branch at 141-153 is
|
||||
`if opts.HostKeyFingerprint != ""` (pinned) `else` (TOFU); once pinned is
|
||||
chosen, TOFU is not consulted. No bypass.
|
||||
|
||||
**A2 — Can `key-reset` corrupt known_hosts under concurrent write?** (P1 — important, low likelihood)
|
||||
`proxmox.ResetHostKey` (bootstrap.go:479-523) and `TOFUHostKeyCallback`
|
||||
(bootstrap.go:290-302) both do read-modify-write on
|
||||
`certpaths.KnownHostsPath()` WITHOUT a lock. Two concurrent operations
|
||||
(e.g. `orca node join --type proxmox hostA` + `orca node key-reset hostB`,
|
||||
or two simultaneous joins to different hosts) could interleave:
|
||||
- T1 reads known_hosts (empty), T2 reads known_hosts (empty)
|
||||
- T1 writes hostA line, T2 writes hostB line
|
||||
- Last rename wins → one line lost.
|
||||
|
||||
The `security.WriteAtomic` (temp+rename) prevents corruption (the file is
|
||||
always valid OpenSSH format), but a captured line can be silently lost. This
|
||||
is a **last-writer-wins race on a flat file with no lock**. Severity is low
|
||||
because orca is a single-operator CLI (concurrent joins are unusual) and
|
||||
the lost line is recoverable (re-connect re-pins via TOFU). But it is a
|
||||
real correctness gap for the trust surface. Recommend either (a) a
|
||||
file-lock around the read-modify-write, or (b) documenting the
|
||||
single-operator assumption explicitly. Flagged P1 (important, post-hoc).
|
||||
|
||||
**A3 — Can verify-reqs be fooled by a crafted markdown table?** ✅
|
||||
No. The `reqRowRe` anchors on `^\|\s*(REQ-\d+)\s*\|` and the status column
|
||||
at end-of-line. A crafted row with a fake status would have to match the
|
||||
regex exactly. The "malformed" fixture (`requirements_malformed.md`)
|
||||
exercises the no-REQ-rows path → clear error. A row like
|
||||
`| REQ-999 | missing status cell | High | v0.1 |` (no final `|...|`) does
|
||||
NOT match `reqRowRe` (the trailing `\|\s*$` requires the status cell) — it
|
||||
is silently skipped, which `verify` reports as "no REQ rows" only if ALL
|
||||
rows are malformed. If some rows are valid + one malformed, the malformed
|
||||
row is skipped without error — a minor blind spot, but acceptable (the
|
||||
gate catches drift, not typos). No blocking issue.
|
||||
|
||||
---
|
||||
|
||||
## GRILL Conditions Verification
|
||||
|
||||
### #1 — T02.6 labeled as v0.6 ship-defect bugfix ✅
|
||||
Commit `8b0cbe1` summary: "fix(proxmox): TOFU capture bug — **v0.6
|
||||
ship-defect** first-connect join always failed (T02.6)". The commit message
|
||||
explicitly labels it as a v0.6 ship-defect bugfix, not a v0.8 feature.
|
||||
PHASE2 verification report records it as "TOFU bugfix (T02.6, v0.6
|
||||
ship-defect)". **Satisfied.**
|
||||
|
||||
### #2 — T02.9 doctor parity (bootstrap + doctor use capture-fix wrapper) ✅
|
||||
- Bootstrap: `internal/proxmox/bootstrap.go:148` calls
|
||||
`TOFUHostKeyCallback(sshAddr, &capturedHostKey)`.
|
||||
- Doctor: `internal/doctor/doctor.go:424` calls
|
||||
`proxmox.TOFUHostKeyCallback(sshAddr, nil)`.
|
||||
Both use the SAME exported wrapper (`proxmox.TOFUHostKeyCallback`,
|
||||
bootstrap.go:275). No duplication. The doctor diff
|
||||
(`internal/doctor/doctor.go`) removes the direct `knownhosts.New` call and
|
||||
replaces it with the shared wrapper. **Satisfied.**
|
||||
|
||||
### #3 — T01.6 cli escape valve (was it needed?) ✅
|
||||
PHASE1 verification: cli hit **76.2%** (above the 70% floor, excluding
|
||||
daemon.go). The escape valve (ship at 65% if 70% not reached) was **NOT
|
||||
needed**. The plan's conditional was correctly conservative; the actual
|
||||
result exceeded the floor. **Satisfied (not invoked).**
|
||||
|
||||
### #4 — T03.1 verify-reqs regex substring-tolerant + reverse direction ✅
|
||||
- **Substring-tolerant**: `cmd/verify-reqs/main.go:30`:
|
||||
`^##\s*Milestone\s+(v0\.\d+):.*—\s*\*\*[^*]*\bCOMPLETE\b[^*]*\*\*`.
|
||||
Verified against the real ROADMAP: matches v0.2's
|
||||
`**COMPLETE (merged to main via v0.3)**` and all other COMPLETE
|
||||
milestones. Golden test `TestVerify_v02SubstringTolerantHeader`
|
||||
(main_test.go:140) guards against regression.
|
||||
- **Reverse direction**: `cmd/verify-reqs/main.go:135-139`: a REQ marked
|
||||
`Complete` whose referenced milestones are ALL not-C_COMPLETE in ROADMAP
|
||||
is flagged as `direction=reverse` drift. Golden test `TestVerify_drift`
|
||||
asserts REQ-003 is reverse-drift.
|
||||
- **Scope note**: PLAN + commit `fc2b020` document that REQ-060 catches
|
||||
doc-vs-doc drift only (code-vs-doc like the REQ-053 cert_repo_test.go
|
||||
case is out of scope; P04 audit is the backstop). **Satisfied.**
|
||||
|
||||
---
|
||||
|
||||
## P0 Fixes Applied
|
||||
|
||||
**None.** No P0 issues (correctness bugs, security holes, broken build/test)
|
||||
were found. `go build ./...`, `go vet ./...`, `go test -race` (all key
|
||||
packages), and `make verify-reqs` all PASS. The milestone is shippable as-is.
|
||||
|
||||
---
|
||||
|
||||
## P1+ Issues Flagged (post-hoc review)
|
||||
|
||||
| ID | Severity | File:line | Issue | Recommendation |
|
||||
|----|----------|-----------|-------|----------------|
|
||||
| A2 | P1 (important, low likelihood) | `internal/proxmox/bootstrap.go:290-302, 479-523` | `TOFUHostKeyCallback` capture path and `ResetHostKey` both do read-modify-write on `known_hosts` with no lock; concurrent operations can lose a captured line (last-writer-wins via atomic rename — no corruption, but data loss). | Add a file-lock (`flock` on a `.known_hosts.lock` sibling, or `github.com/gofrs/flock` if a dep is acceptable) around the RMW in both paths; OR document the single-operator assumption in the key-reset help text. Defer to v0.9. |
|
||||
| M4 | P2 (nit) | `internal/cli/namespace_test.go:28-34` | `resetCommandFlags()` does not reset `joinHostKeyFP`; a test setting `--host-key-fingerprint` without `resetRootFlags` could leak the value. | Add `joinHostKeyFP = ""` to `resetCommandFlags`. Trivial. |
|
||||
| P2 | P2 (nit) | `internal/proxmox/bootstrap.go:494-510` | `ResetHostKey` uses `strings.Split` + repeated `append` (minor allocation churn). | Optional: use `bufio.Scanner` + `strings.Builder`. Not worth changing for a small file. |
|
||||
|
||||
---
|
||||
|
||||
## Overall Verdict
|
||||
|
||||
**PASS-WITH-FOLLOWUPS**
|
||||
|
||||
The v0.8 milestone is correct, secure, tested, and shippable. All 4 GRILL
|
||||
binding conditions are satisfied. Zero P0 issues. The single P1 (concurrent
|
||||
`known_hosts` write race, A2) is a real but low-likelihood gap appropriate
|
||||
for post-hoc follow-up — it does not block the milestone ship because orca
|
||||
is a single-operator CLI and the atomic-rename guarantees the file is never
|
||||
corrupted (only a captured line can be lost, recoverable on re-connect).
|
||||
The 2 P2 nits are cosmetic. Coverage held post-P02 (86.5%/76.7%/70.4% for
|
||||
proxmox/cli/doctor), race tests pass, all 7 T02.10 e2e cases are present and
|
||||
exercised through a real in-process SSH server, and `make verify-reqs`
|
||||
passes on the current repo (60 consistent rows).
|
||||
|
||||
Recommend proceeding to P04 ship (T04.7/T04.8: mark REQ-057..060 Complete +
|
||||
ROADMAP v0.8 COMPLETE, then tag v0.7.4).
|
||||
+211
-7
@@ -113,18 +113,18 @@ branch-strategy.md. The milestone branch label uses the milestone
|
||||
number (`milestone/v0.6-node-bootstrap-proxmox`); no separate minor
|
||||
tag is created.
|
||||
|
||||
## Milestone v0.7: Hardening & Completion
|
||||
## Milestone v0.7: Hardening & Completion — **COMPLETE**
|
||||
|
||||
Scope: NFR milestone closing gaps surfaced by the v0.7 IDEATE stage —
|
||||
an unreachable command tree, a missing config file layer, low test
|
||||
coverage in core packages, and the long-deferred pprof endpoint.
|
||||
|
||||
- [ ] Phase 0: Pre-execution (specify → clarify → research → ideate → plan) — tag `v0.6.0`
|
||||
- [ ] Phase 1: Register `orca cert` command tree + cert_repo tests (REQ-053) — tag `v0.6.1`
|
||||
- [ ] Phase 2: HCL config file parsing — `internal/config` package (REQ-054) — tag `v0.6.2`
|
||||
- [ ] Phase 3: Test coverage uplift — engine/transport/proxmox/audit ≥ 50% (REQ-055) — tag `v0.6.3`
|
||||
- [ ] Phase 4: `--pprof` opt-in on `orca daemon` (REQ-056) — tag `v0.6.4`
|
||||
- [ ] Phase 5: Final review + ship + audit (milestone release) — tag `v0.6.5`
|
||||
- [x] Phase 0: Pre-execution (specify → clarify → research → ideate → plan) — tag `v0.6.0` (shipped)
|
||||
- [x] Phase 1: Register `orca cert` command tree + cert_repo tests (REQ-053) — tag `v0.6.1` (shipped)
|
||||
- [x] Phase 2: HCL config file parsing — `internal/config` package (REQ-054) — tag `v0.6.2` (shipped)
|
||||
- [x] Phase 3: Test coverage uplift — engine/transport/proxmox/audit ≥ 50% (REQ-055) — tag `v0.6.3` (shipped)
|
||||
- [x] Phase 4: `--pprof` opt-in on `orca daemon` (REQ-056) — tag `v0.6.4` (shipped)
|
||||
- [x] Phase 5: Final review + ship + audit (milestone release) — tag `v0.6.5` (shipped)
|
||||
|
||||
**Milestone type**: NFR (all phases are fix/test/chore; no `feat` phases).
|
||||
**Milestone tag**: `v0.6.5` (final phase patch = milestone release per
|
||||
@@ -132,3 +132,207 @@ NFR-milestone progressive-patch rule). Per-phase tags: `v0.6.0`…`v0.6.5`.
|
||||
Tags run on the previous minor's patch line (v0.6.x) per
|
||||
branch-strategy.md. The milestone branch label uses the milestone
|
||||
number (`milestone/v0.7-hardening-completion`); no separate minor tag.
|
||||
|
||||
## Milestone v0.8: Coverage & Trust Hardening — **COMPLETE**
|
||||
|
||||
Scope: continue the v0.7 hardening theme. v0.7 P03's ≥ 50% floor left
|
||||
six packages still under 50% (engine 8.3%, proxmox 5.1%, cli 27.6%,
|
||||
transport 26.3%, store 46.7%, jobspec 47.6%) and three packages with
|
||||
no tests at all (`internal/audit`, `internal/certpaths`, `cmd/orca`).
|
||||
v0.8 also closes the two SSH-trust "future enhancement" hooks deferred
|
||||
in v0.6 (D-035 `--host-key-fingerprint` pre-pin, RESEARCH_v0.6 §80
|
||||
`orca node key-reset`) and adds a requirements-hygiene gate to prevent
|
||||
the stale-REQ-status drift seen after v0.7 ship.
|
||||
|
||||
- [x] Phase 0: Pre-execution (specify → clarify → research → plan → grill) — tag `v0.7.0` (shipped)
|
||||
- [x] Phase 1: Test coverage uplift round 2 — 6 packages to ≥ 70%, 3 zero-test packages to first tests (REQ-057) — tag `v0.7.1` (shipped)
|
||||
- [x] Phase 2: SSH trust hardening — `--host-key-fingerprint` pre-pin + `orca node key-reset` + TOFU bugfix + `HostKeyFingerprint` population (REQ-058, REQ-059) — tag `v0.7.2` (shipped)
|
||||
- [x] Phase 3: Requirements-hygiene gate — `make verify-reqs` + verify assertion (REQ-060) — tag `v0.7.3` (shipped)
|
||||
- [x] Phase 4: Final review + ship + audit (milestone release) — tag `v0.7.4` (shipped)
|
||||
|
||||
**Milestone type**: NFR (P01 test, P02 chore on trust surface per
|
||||
D-043, P03 chore, P04 docs/review). Final phase patch IS the milestone
|
||||
release per NFR-milestone progressive-patch rule. Per-phase tags:
|
||||
`v0.7.0`…`v0.7.4`. Tags run on the previous minor's patch line (v0.7.x)
|
||||
per branch-strategy.md. The milestone branch label uses the milestone
|
||||
number (`milestone/v0.8-coverage-trust-hardening`); no separate minor
|
||||
tag.
|
||||
|
||||
### Per-phase REQ coverage
|
||||
|
||||
- **P01 — Coverage uplift round 2**
|
||||
- REQ-057 (raise `internal/engine`, `internal/proxmox`,
|
||||
`internal/cli`, `internal/transport`, `internal/store`,
|
||||
`internal/jobspec` to ≥ 70%; add first tests for `internal/audit`,
|
||||
`internal/certpaths`, `cmd/orca`)
|
||||
|
||||
- **P02 — SSH trust hardening**
|
||||
- REQ-058 (`--host-key-fingerprint <sha256>` pre-pin flag on
|
||||
`orca node join --type proxmox`; fail fast on mismatch; supersedes
|
||||
TOFU for pre-pinned deployments)
|
||||
- REQ-059 (`orca node key-reset <node>` clears persisted SSH host
|
||||
key so next `doctor proxmox`/dispatch re-pins via TOFU or
|
||||
`--host-key-fingerprint`)
|
||||
|
||||
- **P03 — Requirements-hygiene gate**
|
||||
- REQ-060 (`make verify-reqs` target + verify-stage assertion:
|
||||
every REQ `Complete` in ROADMAP.md has matching `Complete` row in
|
||||
REQUIREMENTS.md; enforced in CI `validate` pipeline)
|
||||
|
||||
### v0.8 is a continuation milestone, not a direction change
|
||||
|
||||
The vision ("minimalist, offline-first, CLI-first orchestration
|
||||
engine") is unchanged. v0.8 closes the coverage debt left by v0.7's
|
||||
50% floor and the trust-surface gaps explicitly deferred in v0.6.
|
||||
|
||||
## Milestone v0.9: Re-architecture Foundation & Workloads
|
||||
|
||||
**Scope**: This milestone SUPERSPEDES the shipped v0.1–v0.8 architecture per
|
||||
the adopted PRD (`.ciagent/PRD_v0.9.md`). The re-architecture is justified on
|
||||
six grounds recorded in the PROJECT.md Supersession Table: (1) the v0.8 daemon
|
||||
model is operationally failing, (2) step-ca is externally mandated, (3)
|
||||
multi-tenancy is a hard product requirement, (4) WASM is a hard workload
|
||||
requirement, (5) SSH-push is the only viable deployment target, (6) vision
|
||||
correction. The 16 load-bearing rules (R-001…R-016) are invariants. The
|
||||
ci-griller reviewed the re-architecture adversarially; the user overrode the
|
||||
Re-architecture Justification REPLAN with the six-part evidence basis; the
|
||||
19 binding conditions (C-01..C-19) and 10 phase challenges (PC-01..PC-10)
|
||||
from `GRILL_v0.9.md` are adopted as execution gates. 30 net-new requirements
|
||||
(REQ-061..REQ-090) derive from `IDEATION_v0.9.md`.
|
||||
|
||||
**Milestone type**: feature (P01..P10 ship `feat` phases; P00/P0X are
|
||||
chore/docs).
|
||||
|
||||
- [ ] Phase 0: Pre-execution (specify → clarify → research → ideate → plan → grill) — tag `v0.8.0` (shipped; this is the phase you are reading)
|
||||
- [ ] Phase P00: Deprecation sweep + migration-ordering decision + txn-design spike + hermetic test-infra bootstrap + persona reactivation + doc banners (REQ-072, REQ-085, REQ-088, REQ-089, REQ-090; gates C-03 ✅, C-05, C-06, C-15..C-18) — tag `v0.8.1`
|
||||
- [ ] Phase P0a1: Multi-namespace path resolver + config HCL demotion + known_hosts flock (REQ-063, REQ-069, REQ-070, REQ-071; gate C-07) — tag `v0.8.2`
|
||||
- [ ] Phase P0a2: Namespace CRUD + inheritance engine (REQ-082) — tag `v0.8.3`
|
||||
- [ ] Phase P0b: Markdown jobspec parser + dispatcher + fuzz (REQ-064, REQ-067) — tag `v0.8.4`
|
||||
- [ ] Phase P0c: Job/Service/DaemonSet schemas + emitter interface (REQ-074) — tag `v0.8.5`
|
||||
- [ ] Phase P01: SSH-push transport + host-path volumes (REQ-073) — tag `v0.8.6`
|
||||
- [ ] Phase P02: Service block + checks + restart + Traefik emitter (REQ-077; gate C-10) — tag `v0.8.7`
|
||||
- [ ] Phase P03: Update stanza (rolling/canary) — tag `v0.8.8`
|
||||
- [ ] Phase P04: Lifecycle hooks (systemd ExecStop) — tag `v0.8.9`
|
||||
- [ ] Phase P05: Constraints & affinity (CEL) + CLI-side scheduler (REQ-083) — tag `v0.8.10`
|
||||
- [ ] Phase P06: Task groups (multi-process services) — tag `v0.8.11`
|
||||
- [ ] Phase P07a: Process + podman runtimes (REQ-078) — tag `v0.8.12`
|
||||
- [ ] Phase P07b: wasmtime runtime (REQ-078; **gate C-01** — CGO eval) — tag `v0.8.13`
|
||||
- [ ] Phase P07c: pve-vm + pve-ct runtimes (REQ-078; extends REQ-076) — tag `v0.8.14`
|
||||
- [ ] Phase P08: Socket plumbing (R-007) — tag `v0.8.15`
|
||||
- [ ] Phase P09: Storage replication via Syncthing (REQ-081; **gates C-02, C-14**) — tag `v0.8.16`
|
||||
- [ ] Phase P10: Lead rules + migration (REQ-076 step-ca integration) — tag `v0.8.17`
|
||||
- [ ] Phase P0X: Ship + audit (REQ-062 coverage gate; REQ-068 deprecation warnings) — tag `v0.8.18`
|
||||
|
||||
**Milestone tag**: `v0.8.18` (final phase patch = milestone release per
|
||||
feature-milestone progressive-patch rule). Per-phase tags: `v0.8.1`…`v0.8.18`.
|
||||
Tags run on the previous minor's patch line (v0.8.x) per branch-strategy.md.
|
||||
The milestone branch label uses the milestone number
|
||||
(`milestone/v0.9-rearchitecture`); no separate minor tag.
|
||||
|
||||
### Per-phase REQ coverage (v0.9)
|
||||
|
||||
- **P00** — Deprecation/migration/test-infra/persona/docs foundation (REQ-072, REQ-085, REQ-088, REQ-089, REQ-090)
|
||||
- **P0a1** — Path resolver + config demotion + known_hosts flock (REQ-063, REQ-069, REQ-070, REQ-071)
|
||||
- **P0a2** — Namespace inheritance resolver (REQ-082)
|
||||
- **P0b** — Markdown parser + adapter + fuzz (REQ-064, REQ-067)
|
||||
- **P0c** — Schemas + emitter interface (REQ-074)
|
||||
- **P01** — SSH-push transport (REQ-073)
|
||||
- **P02** — Service + Traefik emitter (REQ-077)
|
||||
- **P05** — CLI-side scheduler (REQ-083)
|
||||
- **P07a/b/c** — Runtime abstraction (REQ-078) + step-ca integration (REQ-076)
|
||||
- **P09** — Syncthing replication (REQ-081)
|
||||
- **P0X** — Coverage gate (REQ-062) + deprecation warnings (REQ-068)
|
||||
|
||||
### v0.9 is a DIRECTION CHANGE — first in the project's history
|
||||
|
||||
Every prior milestone (v0.1–v0.8) explicitly said "the vision is unchanged;
|
||||
this milestone is not a direction change." v0.9 is the first milestone that
|
||||
reverses the vision's anti-patterns (daemon-on-every-node, internal CA,
|
||||
HCL-canonical, single-namespace, no-container-runtime, no-SPIFFE). The
|
||||
reversals are justified by the six-part evidence basis recorded in the
|
||||
PROJECT.md Supersession Table.
|
||||
|
||||
## Milestone v0.10: Production Hardening
|
||||
|
||||
**Scope**: ship a cluster that operators can run. Builds on the v0.9
|
||||
re-architecture foundation with the production-grade subsystems:
|
||||
secrets, transactions, ACL/SPIFFE, backup/restore, drain, recovery, and
|
||||
the v0.8→v1.0 migration.
|
||||
|
||||
**Milestone type**: feature (multiple `feat` phases).
|
||||
|
||||
- [ ] Phase 0: Pre-execution (specify → clarify → research → plan → grill) — tag `v0.9.0`
|
||||
- [ ] Phase P00: CLI cache layer (REQ-062 cache floor; R-008) — tag `v0.9.1`
|
||||
- [ ] Phase P01: Metrics endpoint (hand-rolled text exposition) — tag `v0.9.2`
|
||||
- [ ] Phase P01.5: SPIFFE SVID minting spike (REQ-076; **gate C-08** — if spike fails, fall back to mTLS identity) — tag `v0.9.3`
|
||||
- [ ] Phase P02: ACL (SPIFFE + token identities) — tag `v0.9.4`
|
||||
- [ ] Phase P03: Secrets subsystem (REQ-080; **gate C-19** threat model) — tag `v0.9.5`
|
||||
- [ ] Phase P04: Backup/restore (tar + signed) — tag `v0.9.6`
|
||||
- [ ] Phase P05: Drain + daemon drain-and-stop (REQ-061) — tag `v0.9.7`
|
||||
- [ ] Phase P06: Alloc history (CLI-side SQLite retention; REQ-071 cache DB) — tag `v0.9.8`
|
||||
- [ ] Phase P07: Recovery (`orca restore`) — tag `v0.9.9`
|
||||
- [ ] Phase P08: Integration tests — expand hermetic harness (REQ-087) — tag `v0.9.10`
|
||||
- [ ] Phase P09: Collector + aggregator (opt-in; **gates C-11, C-12, C-14**) — tag `v0.9.11`
|
||||
- [ ] Phase P10: Transactional plane (REQ-075, REQ-079; **gate C-09** orca-pull.sh failure contract) — tag `v0.9.12`
|
||||
- [ ] Phase P11: `orca job lint` (REQ-084) — tag `v0.9.13`
|
||||
- [ ] Phase P12: `orca job verify` (dry-run txn through lead) — tag `v0.9.14`
|
||||
- [ ] Phase P13: `orca ns` subcommands (full surface) + deprecation warnings (REQ-068) — tag `v0.9.15`
|
||||
- [ ] Phase P14a: v0.8→v1.0 data migration (REQ-066; **gate C-07** CA migration spec) — tag `v0.9.16`
|
||||
- [ ] Phase P14b: Daemon cutover + running-allocation adoption — tag `v0.9.17`
|
||||
- [ ] Phase P14c: Mixed-version tolerance + no-orca-on-server enforcement (REQ-065, REQ-086; implements C-13) — tag `v0.9.18`
|
||||
- [ ] Phase P15: README quickstart (REQ-089) — tag `v0.9.19`
|
||||
- [ ] Phase P15.5: Threat model + security review (**gate C-19**) — tag `v0.9.20`
|
||||
- [ ] Phase P16: Final review + ship + audit — **v0.10.0 milestone release** — tag `v0.9.21` (v1.0.0 cut separately after UAT sign-off)
|
||||
|
||||
**Milestone tag**: `v0.10.0` (the v0.10 milestone release tag; v1.0.0 is
|
||||
UAT-gated and cut separately after v0.10 completion per operator decision —
|
||||
the v1.0.0 tag marks production-ready sign-off, not a separate milestone).
|
||||
Per-phase patches run on the v0.9.x line per branch-strategy.md. Per-phase
|
||||
tags: `v0.9.0`…`v0.9.21`.
|
||||
|
||||
### Per-phase REQ coverage (v0.10)
|
||||
|
||||
- **P00** — CLI cache (R-008)
|
||||
- **P01.5** — SPIFFE spike (REQ-076; C-08)
|
||||
- **P03** — Secrets (REQ-080; C-19)
|
||||
- **P05** — Drain + daemon stop (REQ-061)
|
||||
- **P06** — Alloc history (REQ-071 cache DB)
|
||||
- **P08** — Integration tests (REQ-087)
|
||||
- **P10** — Transactional plane (REQ-075, REQ-079; C-09)
|
||||
- **P11** — Job lint (REQ-084)
|
||||
- **P13** — ns subcommands + deprecation warnings (REQ-068)
|
||||
- **P14a/b/c** — Migration (REQ-066, REQ-065, REQ-086; C-07, C-13)
|
||||
- **P15** — README (REQ-089)
|
||||
- **P15.5** — Threat model (C-19)
|
||||
|
||||
### Risk register (from grill, for ongoing monitoring)
|
||||
|
||||
- **step-ca single-instance SPOF** (mitigation: C-12 doc; v1.x HA via systemd failover)
|
||||
- **master.key passphrase-less 0600** (mitigation: C-19 threat model; consider OS keyring in v1.x)
|
||||
- **wasmtime CGO breaks cross-compile** (mitigation: C-01 spike; fallback to podman/process primary)
|
||||
- **bash control plane drift** (mitigation: C-15..C-18 render-format contract + bats gate)
|
||||
- **daemon cutover orphans running allocs** (mitigation: P14b split; test adoption)
|
||||
- **27→35+ phase scope** (mitigation: C-04 resolved — operator decision: keep 2 milestones v0.9 + v0.10, keep all phases, v1.0 is UAT-gated after v0.10; current count v0.9=18 + v0.10=22 = 40 phases, exceeds 35 soft limit but operator accepted)
|
||||
|
||||
## Deferred to v1.x (out of scope for v0.10)
|
||||
|
||||
- `sqlite-wal-shared` state backend (R-009 abstractions ship in v1.0; backend in v1.x)
|
||||
- `git` state backend
|
||||
- `file+flock` state backend
|
||||
- `orca cluster setup-shared` UX
|
||||
- HA `step-ca` (active/passive via systemd)
|
||||
- Journald log shipping (optional centralized audit)
|
||||
- Network policy (`nftables` snippets)
|
||||
- GPU / TPU constraints
|
||||
|
||||
## Deferred to v2.x (out of scope for v1.x)
|
||||
|
||||
- Full Nomad-HCL parser with no conversion round-trip
|
||||
- Nomad-API subset for migrating existing Nomad fleets
|
||||
- Nomad driver bridge
|
||||
- Helm-equivalent templating (probably never)
|
||||
- Service mesh beyond Traefik
|
||||
- CRDs / Operators / Plugin model
|
||||
- Leader-elected Raft coordinator
|
||||
- External CA / Let's Encrypt / cert transparency
|
||||
- Online-only features (HSTS, OCSP stapling, telemetry)
|
||||
|
||||
@@ -5,9 +5,9 @@
|
||||
"slug": "orca",
|
||||
"name": "Orca",
|
||||
"description": "Offline/CLI-first orchestration engine (Orca) — Nomad-inspired, far simpler than Kubernetes",
|
||||
"milestone": "v0.7",
|
||||
"milestone": "v0.9",
|
||||
"phase": 0,
|
||||
"milestone_type": "nfr",
|
||||
"milestone_type": "feature",
|
||||
"default_branch": "main",
|
||||
"tech_stack": {
|
||||
"language": "go",
|
||||
|
||||
@@ -13,6 +13,8 @@ description: Orca — offline/CLI-first orchestration engine. Full release flow
|
||||
# - gosec (REQ-014, REQ-040) Static analysis for Go security smells
|
||||
# - govulncheck (REQ-014, REQ-027) Offline vuln scan of dependencies
|
||||
# - gitleaks (REQ-039) Pre-commit-style secret scan
|
||||
# v0.8 P03 added a requirements-hygiene stage:
|
||||
# - verify-reqs (REQ-060) ROADMAP COMPLETE ↔ REQUIREMENTS Complete
|
||||
# The `test` pipeline runs with -race (REQ-031).
|
||||
# See docs/security-scanning.md for operator-facing details.
|
||||
|
||||
@@ -27,6 +29,11 @@ pipelines:
|
||||
- gofmt -l .
|
||||
- go vet ./...
|
||||
|
||||
- name: verify-reqs
|
||||
image: golang:1.25
|
||||
commands:
|
||||
- make verify-reqs
|
||||
|
||||
- name: gosec
|
||||
image: golang:1.25
|
||||
commands:
|
||||
|
||||
@@ -0,0 +1,2 @@
|
||||
disable=SC2086
|
||||
external-sources=true
|
||||
@@ -1,4 +1,4 @@
|
||||
.PHONY: build test test-race lint fmt clean run release version changelog help security-scan
|
||||
.PHONY: build test test-race lint fmt clean run release version changelog help security-scan verify-reqs
|
||||
|
||||
BINARY := bin/orca
|
||||
GOFLAGS := -trimpath
|
||||
@@ -30,6 +30,7 @@ help:
|
||||
@echo " changelog Generate CHANGELOG.md from ---ci--- commit blocks"
|
||||
@echo " release Run scripts/release.sh [VERSION] — build, tar, publish"
|
||||
@echo " security-scan Run gosec+govulncheck+gitleaks (P03, REQ-014/027/039)"
|
||||
@echo " verify-reqs Assert ROADMAP COMPLETE ↔ REQUIREMENTS Complete (REQ-060)"
|
||||
|
||||
build:
|
||||
@mkdir -p bin
|
||||
@@ -38,19 +39,42 @@ build:
|
||||
|
||||
test:
|
||||
go test -coverprofile=coverage.out ./...
|
||||
$(MAKE) test-bash
|
||||
|
||||
# test-race runs the full test suite under the race detector (REQ-031).
|
||||
# Wired into the .coreci.yml `test` pipeline as well.
|
||||
test-race:
|
||||
go test -race -coverprofile=coverage.out ./...
|
||||
$(MAKE) test-bash
|
||||
|
||||
lint:
|
||||
gofmt -l .
|
||||
go vet ./...
|
||||
$(MAKE) lint-bash
|
||||
|
||||
fmt:
|
||||
gofmt -w .
|
||||
|
||||
# test-bash runs bats tests for shell scripts (grill C-15). Skips gracefully
|
||||
# if bats is not installed.
|
||||
test-bash:
|
||||
@command -v bats >/dev/null 2>&1 && { \
|
||||
echo "→ bats scripts/tests/*.bash"; \
|
||||
bats scripts/tests/*.bash; \
|
||||
} || echo "bats not installed; skipping bash tests (see scripts/tests/README.md)"
|
||||
|
||||
# lint-bash runs shellcheck + shfmt on shell scripts (grill C-15). Skips
|
||||
# gracefully if the tools are not installed.
|
||||
lint-bash:
|
||||
@command -v shellcheck >/dev/null 2>&1 && { \
|
||||
echo "→ shellcheck scripts/"; \
|
||||
shellcheck scripts/*.sh scripts/lib/*.sh scripts/tests/*.bash || true; \
|
||||
} || echo "shellcheck not installed; skipping (see scripts/tests/README.md)"
|
||||
@command -v shfmt >/dev/null 2>&1 && { \
|
||||
echo "→ shfmt -d scripts/"; \
|
||||
shfmt -d scripts/; \
|
||||
} || echo "shfmt not installed; skipping (see scripts/tests/README.md)"
|
||||
|
||||
clean:
|
||||
rm -rf bin coverage.out *.tar.gz
|
||||
|
||||
@@ -98,3 +122,9 @@ release:
|
||||
# in a developer's local environment; CI requires all three).
|
||||
security-scan:
|
||||
./scripts/security_scan.sh
|
||||
|
||||
# verify-reqs asserts ROADMAP milestone COMPLETE ↔ REQUIREMENTS row Complete
|
||||
# consistency (REQ-060). Catches doc-vs-doc drift; code-vs-doc drift is out
|
||||
# of scope (P04 audit). Exits 0 on consistency, 1 with a diff on drift.
|
||||
verify-reqs:
|
||||
go run ./cmd/verify-reqs .ciagent/ROADMAP.md .ciagent/REQUIREMENTS.md
|
||||
|
||||
+9
-1
@@ -8,8 +8,16 @@ import (
|
||||
)
|
||||
|
||||
func main() {
|
||||
os.Exit(run())
|
||||
}
|
||||
|
||||
// run executes the orca CLI and returns the process exit code. It is
|
||||
// extracted from main so tests can exercise the error path without
|
||||
// os.Exit terminating the test process.
|
||||
func run() int {
|
||||
if err := cli.Execute(); err != nil {
|
||||
fmt.Fprintf(os.Stderr, "error: %v\n", err)
|
||||
os.Exit(1)
|
||||
return 1
|
||||
}
|
||||
return 0
|
||||
}
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"io"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestRunSuccess(t *testing.T) {
|
||||
orig := os.Args
|
||||
t.Cleanup(func() { os.Args = orig })
|
||||
os.Args = []string{"orca", "version"}
|
||||
if code := run(); code != 0 {
|
||||
t.Errorf("run() = %d, want 0", code)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunError(t *testing.T) {
|
||||
origArgs := os.Args
|
||||
t.Cleanup(func() { os.Args = origArgs })
|
||||
os.Args = []string{"orca", "job", "run", "/nonexistent/spec.hcl"}
|
||||
|
||||
r, w, err := os.Pipe()
|
||||
if err != nil {
|
||||
t.Fatalf("pipe: %v", err)
|
||||
}
|
||||
origStderr := os.Stderr
|
||||
os.Stderr = w
|
||||
t.Cleanup(func() { os.Stderr = origStderr })
|
||||
|
||||
code := run()
|
||||
w.Close()
|
||||
out, _ := io.ReadAll(r)
|
||||
if code != 1 {
|
||||
t.Errorf("run() = %d, want 1", code)
|
||||
}
|
||||
if !strings.Contains(string(out), "error:") {
|
||||
t.Errorf("stderr missing 'error:' prefix: %s", out)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,183 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"fmt"
|
||||
"os"
|
||||
"regexp"
|
||||
"sort"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// reqRowRe captures a REQUIREMENTS.md table row's REQ-ID, Phase cell, and
|
||||
// status in one pass. The leading .* is greedy so it consumes the
|
||||
// Requirement and Priority cells (which may contain markdown-escaped pipes
|
||||
// like `localhost\|linux\|proxmox` — see REQ-049) and backtracks to anchor
|
||||
// the Phase + Status match at the END of the line, where those two columns
|
||||
// always live. The status token is optionally wrapped in markdown bold
|
||||
// (real rows use `**Complete**`; synthetic/future rows may use bare
|
||||
// `Pending`), and may carry trailing notes (e.g. "**Complete** (P01
|
||||
// shipped v0.2.1)") matched by [^|]* before the closing pipe.
|
||||
var reqRowRe = regexp.MustCompile(`^\|\s*(REQ-\d+)\s*\|.*\|\s*([^|]*?)\s*\|\s*\*{0,2}(Complete|Pending)\*{0,2}[^|]*\|\s*$`)
|
||||
|
||||
// milestoneCompleteRe matches a ROADMAP.md milestone header that is marked
|
||||
// COMPLETE. The bold span is substring-tolerant (GRILL #4): it matches
|
||||
// `**COMPLETE**`, `**COMPLETE (merged to main via v0.3)**`, and any future
|
||||
// variant where the word COMPLETE appears inside the bold span, possibly
|
||||
// preceded or followed by non-asterisk text. The milestone version (v0.X)
|
||||
// is captured.
|
||||
var milestoneCompleteRe = regexp.MustCompile(`^##\s*Milestone\s+(v0\.\d+):.*—\s*\*\*[^*]*\bCOMPLETE\b[^*]*\*\*`)
|
||||
|
||||
// phaseRe extracts the milestone version from a REQUIREMENTS Phase cell such
|
||||
// as `v0.7 P1`, `**v0.2 P01**`, `v0.2 P01–P04`, or bare `v0.7`. The cell may
|
||||
// contain multiple milestone refs separated by `/` or `–`; each is extracted.
|
||||
var phaseTokenRe = regexp.MustCompile(`v0\.\d+`)
|
||||
|
||||
// reqRow holds a parsed REQUIREMENTS.md row.
|
||||
type reqRow struct {
|
||||
id string
|
||||
phase string // raw Phase cell (e.g. "v0.7 P1", "**v0.2 P01 / v0.3 P02**")
|
||||
status string // "Complete" or "Pending"
|
||||
}
|
||||
|
||||
// milestoneVersions returns the distinct v0.X milestones referenced in the
|
||||
// phase cell (e.g. "v0.7 P1" → ["v0.7"]; "v0.2 P01 / v0.3 P02" →
|
||||
// ["v0.2","v0.3"]).
|
||||
func (r reqRow) milestoneVersions() []string {
|
||||
matches := phaseTokenRe.FindAllString(r.phase, -1)
|
||||
seen := map[string]bool{}
|
||||
var out []string
|
||||
for _, m := range matches {
|
||||
if !seen[m] {
|
||||
seen[m] = true
|
||||
out = append(out, m)
|
||||
}
|
||||
}
|
||||
return out
|
||||
}
|
||||
|
||||
func main() {
|
||||
roadmapPath := ".ciagent/ROADMAP.md"
|
||||
reqsPath := ".ciagent/REQUIREMENTS.md"
|
||||
if len(os.Args) > 1 {
|
||||
roadmapPath = os.Args[1]
|
||||
}
|
||||
if len(os.Args) > 2 {
|
||||
reqsPath = os.Args[2]
|
||||
}
|
||||
diff, count, err := verify(roadmapPath, reqsPath)
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "verify-reqs: %v\n", err)
|
||||
os.Exit(2)
|
||||
}
|
||||
if len(diff) > 0 {
|
||||
fmt.Fprintf(os.Stderr, "requirements drift detected (%d):\n", len(diff))
|
||||
for _, line := range diff {
|
||||
fmt.Fprintln(os.Stderr, line)
|
||||
}
|
||||
os.Exit(1)
|
||||
}
|
||||
fmt.Printf("✓ %d requirements consistent with roadmap\n", count)
|
||||
}
|
||||
|
||||
// verify parses the ROADMAP and REQUIREMENTS markdown and returns a diff
|
||||
// listing of any drift. On success diff is nil and count is the number of
|
||||
// consistent REQ rows. A non-nil error signals a parse/read failure (not
|
||||
// drift); drift is reported via the diff slice.
|
||||
func verify(roadmapPath, reqsPath string) (diff []string, count int, err error) {
|
||||
completeMilestones, err := parseRoadmap(roadmapPath)
|
||||
if err != nil {
|
||||
return nil, 0, fmt.Errorf("parse roadmap %q: %w", roadmapPath, err)
|
||||
}
|
||||
rows, err := parseRequirements(reqsPath)
|
||||
if err != nil {
|
||||
return nil, 0, fmt.Errorf("parse requirements %q: %w", reqsPath, err)
|
||||
}
|
||||
if len(rows) == 0 {
|
||||
return nil, 0, fmt.Errorf("no REQ rows found in %s", reqsPath)
|
||||
}
|
||||
|
||||
type driftEntry struct {
|
||||
id string
|
||||
current string
|
||||
want string
|
||||
dir string // "forward" or "reverse"
|
||||
}
|
||||
var drifts []driftEntry
|
||||
|
||||
for _, r := range rows {
|
||||
milestones := r.milestoneVersions()
|
||||
anyComplete := false
|
||||
for _, m := range milestones {
|
||||
if completeMilestones[m] {
|
||||
anyComplete = true
|
||||
break
|
||||
}
|
||||
}
|
||||
// Forward assertion: a REQ whose milestone is COMPLETE in ROADMAP
|
||||
// must be marked Complete in REQUIREMENTS.
|
||||
if anyComplete && r.status != "Complete" {
|
||||
drifts = append(drifts, driftEntry{r.id, r.status, "Complete", "forward"})
|
||||
}
|
||||
// Reverse assertion (GRILL #4): a REQ marked Complete in
|
||||
// REQUIREMENTS must reference at least one milestone ROADMAP marks
|
||||
// COMPLETE. If all referenced milestones are NOT complete (or no
|
||||
// milestone is referenced), that is premature-Complete drift.
|
||||
if r.status == "Complete" && !anyComplete {
|
||||
drifts = append(drifts, driftEntry{r.id, r.status, "Pending (milestone not COMPLETE in ROADMAP)", "reverse"})
|
||||
}
|
||||
}
|
||||
|
||||
sort.Slice(drifts, func(i, j int) bool { return drifts[i].id < drifts[j].id })
|
||||
for _, d := range drifts {
|
||||
diff = append(diff, fmt.Sprintf(" %s: status=%s, expected=%s (direction=%s)", d.id, d.current, d.want, d.dir))
|
||||
}
|
||||
|
||||
consistent := len(rows) - len(drifts)
|
||||
return diff, consistent, nil
|
||||
}
|
||||
|
||||
func parseRoadmap(path string) (map[string]bool, error) {
|
||||
f, err := os.Open(path)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer f.Close()
|
||||
complete := map[string]bool{}
|
||||
sc := bufio.NewScanner(f)
|
||||
sc.Buffer(make([]byte, 1024*1024), 1024*1024)
|
||||
for sc.Scan() {
|
||||
line := sc.Text()
|
||||
m := milestoneCompleteRe.FindStringSubmatch(line)
|
||||
if m != nil {
|
||||
complete[m[1]] = true
|
||||
}
|
||||
}
|
||||
if err := sc.Err(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return complete, nil
|
||||
}
|
||||
|
||||
func parseRequirements(path string) ([]reqRow, error) {
|
||||
f, err := os.Open(path)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer f.Close()
|
||||
var rows []reqRow
|
||||
sc := bufio.NewScanner(f)
|
||||
sc.Buffer(make([]byte, 1024*1024), 1024*1024)
|
||||
for sc.Scan() {
|
||||
line := sc.Text()
|
||||
m := reqRowRe.FindStringSubmatch(line)
|
||||
if m == nil {
|
||||
continue
|
||||
}
|
||||
rows = append(rows, reqRow{id: m[1], phase: strings.TrimSpace(m[2]), status: m[3]})
|
||||
}
|
||||
if err := sc.Err(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return rows, nil
|
||||
}
|
||||
@@ -0,0 +1,170 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"os"
|
||||
"os/exec"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// Tests run with cwd = package dir (cmd/verify-reqs), so `testdata/...`
|
||||
// paths resolve relative to the package. The real-repo tests use a
|
||||
// repoRoot helper to locate `.ciagent/...`.
|
||||
|
||||
func repoRoot(t *testing.T) string {
|
||||
t.Helper()
|
||||
wd, err := os.Getwd()
|
||||
if err != nil {
|
||||
t.Fatalf("getwd: %v", err)
|
||||
}
|
||||
return filepath.Join(wd, "..", "..")
|
||||
}
|
||||
|
||||
// case (1): clean pair → no drift.
|
||||
func TestVerify_clean(t *testing.T) {
|
||||
diff, count, err := verify(
|
||||
filepath.Join("testdata", "roadmap_clean.md"),
|
||||
filepath.Join("testdata", "requirements_clean.md"),
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
if len(diff) != 0 {
|
||||
t.Fatalf("expected no drift, got:\n%s", strings.Join(diff, "\n"))
|
||||
}
|
||||
if count != 5 {
|
||||
t.Fatalf("expected 5 consistent rows, got %d", count)
|
||||
}
|
||||
}
|
||||
|
||||
// case (2)+(3): drift pair → all drifts reported, both directions.
|
||||
func TestVerify_drift(t *testing.T) {
|
||||
diff, _, err := verify(
|
||||
filepath.Join("testdata", "roadmap_drift.md"),
|
||||
filepath.Join("testdata", "requirements_drift.md"),
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
if len(diff) != 4 {
|
||||
t.Fatalf("expected 4 drifts (REQ-002 forward, REQ-003 reverse, REQ-004 forward, REQ-005 forward), got %d:\n%s",
|
||||
len(diff), strings.Join(diff, "\n"))
|
||||
}
|
||||
joined := strings.Join(diff, "\n")
|
||||
for _, want := range []string{"REQ-002", "REQ-003", "REQ-004", "REQ-005"} {
|
||||
if !strings.Contains(joined, want) {
|
||||
t.Errorf("diff missing %s:\n%s", want, joined)
|
||||
}
|
||||
}
|
||||
if !strings.Contains(joined, "direction=reverse") {
|
||||
t.Errorf("expected a reverse-direction drift, got:\n%s", joined)
|
||||
}
|
||||
if !strings.Contains(joined, "direction=forward") {
|
||||
t.Errorf("expected a forward-direction drift, got:\n%s", joined)
|
||||
}
|
||||
}
|
||||
|
||||
// case (4): missing args → defaults resolve to the repo's .ciagent/ files.
|
||||
// Runs the program as a subprocess from the repo root.
|
||||
func TestVerify_defaultArgs(t *testing.T) {
|
||||
if testing.Short() {
|
||||
t.Skip("subprocess test skipped in -short mode")
|
||||
}
|
||||
root := repoRoot(t)
|
||||
cmd := exec.Command("go", "run", "./cmd/verify-reqs")
|
||||
cmd.Dir = root
|
||||
out := &strings.Builder{}
|
||||
cmd.Stdout = out
|
||||
cmd.Stderr = out
|
||||
if err := cmd.Run(); err != nil {
|
||||
if exitErr, ok := err.(*exec.ExitError); ok {
|
||||
t.Fatalf("verify-reqs on real repo exited %d (should be 0): %s",
|
||||
exitErr.ExitCode(), out.String())
|
||||
}
|
||||
t.Fatalf("go run failed: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// case (5): malformed markdown (no REQ rows) → clear error, not silent pass.
|
||||
func TestVerify_malformed(t *testing.T) {
|
||||
_, _, err := verify(
|
||||
filepath.Join("testdata", "roadmap_clean.md"),
|
||||
filepath.Join("testdata", "requirements_malformed.md"),
|
||||
)
|
||||
if err == nil {
|
||||
t.Fatal("expected error on malformed (no REQ rows) requirements, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "no REQ rows") {
|
||||
t.Errorf("expected 'no REQ rows' error, got: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// case (6): missing file → clear error, not silent pass.
|
||||
func TestVerify_missingFile(t *testing.T) {
|
||||
_, _, err := verify(
|
||||
filepath.Join("testdata", "roadmap_clean.md"),
|
||||
filepath.Join("testdata", "does_not_exist.md"),
|
||||
)
|
||||
if err == nil {
|
||||
t.Fatal("expected error on missing file, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "does_not_exist.md") {
|
||||
t.Errorf("expected error to mention the missing file, got: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// GRILL #4 golden test: the v0.2-style
|
||||
// `**COMPLETE (merged to main via v0.3)**` header MUST be recognized as a
|
||||
// complete milestone by the substring-tolerant regex. The drift fixture's
|
||||
// roadmap carries exactly this header on its v0.2 line, and the drift
|
||||
// fixture's REQ-002 (v0.2 P1, Pending) would be silently skipped if the
|
||||
// regex regressed to the exact `\*\*COMPLETE\*\*` form. TestVerify_drift
|
||||
// already asserts REQ-002 is flagged forward-drift; this test makes the
|
||||
// intent explicit and guards against a regex regression.
|
||||
func TestVerify_v02SubstringTolerantHeader(t *testing.T) {
|
||||
diff, _, err := verify(
|
||||
filepath.Join("testdata", "roadmap_drift.md"),
|
||||
filepath.Join("testdata", "requirements_drift.md"),
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
// REQ-002 references milestone v0.2, whose header uses the
|
||||
// `**COMPLETE (merged to main via v0.3)**` variant. If the regex
|
||||
// regressed, v0.2 would not be marked complete and REQ-002 (Pending)
|
||||
// would NOT be flagged as forward drift.
|
||||
found := false
|
||||
for _, d := range diff {
|
||||
if strings.Contains(d, "REQ-002") && strings.Contains(d, "direction=forward") {
|
||||
found = true
|
||||
break
|
||||
}
|
||||
}
|
||||
if !found {
|
||||
t.Fatalf("REQ-002 forward drift not reported — substring-tolerant regex may have regressed; diff:\n%s",
|
||||
strings.Join(diff, "\n"))
|
||||
}
|
||||
}
|
||||
|
||||
// Verify the actual repo passes (regression guard for the real docs).
|
||||
func TestVerify_realRepo(t *testing.T) {
|
||||
if testing.Short() {
|
||||
t.Skip("real-repo test skipped in -short mode")
|
||||
}
|
||||
root := repoRoot(t)
|
||||
diff, count, err := verify(
|
||||
filepath.Join(root, ".ciagent", "ROADMAP.md"),
|
||||
filepath.Join(root, ".ciagent", "REQUIREMENTS.md"),
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("verify on real repo errored: %v", err)
|
||||
}
|
||||
if len(diff) != 0 {
|
||||
t.Fatalf("real repo has requirements drift (should be clean after SPECIFY):\n%s",
|
||||
strings.Join(diff, "\n"))
|
||||
}
|
||||
if count <= 0 {
|
||||
t.Fatalf("real repo reported %d consistent rows (expected > 0)", count)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
# Requirements: Clean Fixture
|
||||
|
||||
| ID | Requirement | Priority | Phase | Status |
|
||||
|----|-------------|----------|-------|--------|
|
||||
| REQ-001 | Foundation req | High | v0.1 P1 | **Complete** |
|
||||
| REQ-002 | Multi-node with escaped pipes (kind\|os) | Medium | **v0.2 P1** | **Complete** (shipped v0.2.1) |
|
||||
| REQ-003 | Scheduling req | Low | v0.3 P1 | **Complete** |
|
||||
| REQ-004 | Future req spanning phases | Low | v0.2 P1 / v0.3 P2 | **Complete** (multi-phase) |
|
||||
| REQ-005 | Pending future req | Low | v0.9 P1 | Pending |
|
||||
@@ -0,0 +1,9 @@
|
||||
# Requirements: Drift Fixture
|
||||
|
||||
| ID | Requirement | Priority | Phase | Status |
|
||||
|----|-------------|----------|-------|--------|
|
||||
| REQ-001 | Foundation req (clean) | High | v0.1 P1 | **Complete** |
|
||||
| REQ-002 | Multi-node req (forward drift: milestone COMPLETE but row Pending) | Medium | **v0.2 P1** | Pending |
|
||||
| REQ-003 | Scheduling req (reverse drift: row Complete but milestone NOT complete) | Low | v0.9 P1 | **Complete** |
|
||||
| REQ-004 | Multi-phase with range (forward drift: spans COMPLETE v0.2 + non-COMPLETE v0.9) | Low | v0.2 P1–P2 | Pending |
|
||||
| REQ-005 | Second forward drift (v0.3 COMPLETE, row Pending) | Low | v0.3 P1 | Pending |
|
||||
@@ -0,0 +1,8 @@
|
||||
# Requirements: Malformed Fixture
|
||||
|
||||
This file has no valid REQ rows, just prose and a broken table.
|
||||
|
||||
| ID | Requirement | Priority | Phase | Status |
|
||||
|----|-------------|----------|-------|--------|
|
||||
| NOT-A-REQ | broken row | High | v0.1 | **Complete** |
|
||||
| REQ-999 | missing status cell | High | v0.1 |
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
# Roadmap: Clean Fixture
|
||||
|
||||
## Milestone v0.1: Foundation — **COMPLETE**
|
||||
|
||||
- [x] Phase 1
|
||||
|
||||
## Milestone v0.2: Networking — **COMPLETE (merged to main via v0.3)**
|
||||
|
||||
- [x] Phase 8
|
||||
- [x] Phase 9
|
||||
|
||||
## Milestone v0.3: Scheduling — **COMPLETE**
|
||||
|
||||
- [x] Phase 1
|
||||
|
||||
## Milestone v0.9: Future Work
|
||||
|
||||
Not yet shipped.
|
||||
|
||||
- [ ] Phase 1
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
# Roadmap: Drift Fixture
|
||||
|
||||
## Milestone v0.1: Foundation — **COMPLETE**
|
||||
|
||||
- [x] Phase 1
|
||||
|
||||
## Milestone v0.2: Networking — **COMPLETE (merged to main via v0.3)**
|
||||
|
||||
- [x] Phase 8
|
||||
- [x] Phase 9
|
||||
|
||||
## Milestone v0.3: Scheduling — **COMPLETE**
|
||||
|
||||
- [x] Phase 1
|
||||
|
||||
## Milestone v0.9: Future Work
|
||||
|
||||
Not yet shipped.
|
||||
|
||||
- [ ] Phase 1
|
||||
@@ -0,0 +1,140 @@
|
||||
package audit
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"errors"
|
||||
"log/slog"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/engine"
|
||||
"git.cloudinit.dev/coreci/orca/internal/store"
|
||||
)
|
||||
|
||||
func newTestAudit(t *testing.T) (*Audit, *store.AuditRepo, func()) {
|
||||
t.Helper()
|
||||
path := filepath.Join(t.TempDir(), "test.db")
|
||||
db, err := store.Open(path)
|
||||
if err != nil {
|
||||
t.Fatalf("open db: %v", err)
|
||||
}
|
||||
repo := store.NewAuditRepo(db)
|
||||
eng := engine.NewAudit(repo, nil)
|
||||
return New(eng), repo, func() { _ = db.Close() }
|
||||
}
|
||||
|
||||
func TestAudit_Emit(t *testing.T) {
|
||||
a, repo, cleanup := newTestAudit(t)
|
||||
defer cleanup()
|
||||
ctx := context.Background()
|
||||
a.Emit(ctx, ActionCertIssued, "cert:node-1", ResultSuccess, map[string]any{"cn": "node-1"})
|
||||
|
||||
entries, err := repo.List(ctx, 10)
|
||||
if err != nil {
|
||||
t.Fatalf("List: %v", err)
|
||||
}
|
||||
if len(entries) != 1 {
|
||||
t.Fatalf("expected 1 audit entry, got %d", len(entries))
|
||||
}
|
||||
e := entries[0]
|
||||
if e.Action != string(ActionCertIssued) {
|
||||
t.Errorf("action: got %q, want %q", e.Action, ActionCertIssued)
|
||||
}
|
||||
if e.Result != string(ResultSuccess) {
|
||||
t.Errorf("result: got %q, want %q", e.Result, ResultSuccess)
|
||||
}
|
||||
if e.Resource != "cert:node-1" {
|
||||
t.Errorf("resource: got %q, want cert:node-1", e.Resource)
|
||||
}
|
||||
if e.Actor != "security" {
|
||||
t.Errorf("actor: got %q, want security", e.Actor)
|
||||
}
|
||||
if e.Error != "" {
|
||||
t.Errorf("error: got %q, want empty", e.Error)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAudit_EmitWithErr(t *testing.T) {
|
||||
a, repo, cleanup := newTestAudit(t)
|
||||
defer cleanup()
|
||||
ctx := context.Background()
|
||||
a.EmitWithErr(ctx, ActionNodeHandshakeFail, "hs:node-2", errors.New("bad cert"), nil)
|
||||
|
||||
entries, err := repo.List(ctx, 10)
|
||||
if err != nil {
|
||||
t.Fatalf("List: %v", err)
|
||||
}
|
||||
if len(entries) != 1 {
|
||||
t.Fatalf("expected 1 audit entry, got %d", len(entries))
|
||||
}
|
||||
e := entries[0]
|
||||
if e.Result != string(ResultFailure) {
|
||||
t.Errorf("result: got %q, want %q", e.Result, ResultFailure)
|
||||
}
|
||||
if !strings.Contains(e.Error, "bad cert") {
|
||||
t.Errorf("error: got %q, want it to contain 'bad cert'", e.Error)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAudit_LogHandshakeOK(t *testing.T) {
|
||||
var buf bytes.Buffer
|
||||
logger := slog.New(slog.NewTextHandler(&buf, nil))
|
||||
LogHandshakeOK(logger, "peer-1", "AA:BB:CC")
|
||||
out := buf.String()
|
||||
for _, want := range []string{"event=mtls.handshake", "result=ok", "peer=peer-1", "cert_fp=AA:BB:CC"} {
|
||||
if !strings.Contains(out, want) {
|
||||
t.Errorf("LogHandshakeOK: output missing %q\noutput: %s", want, out)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestAudit_LogHandshakeFailed(t *testing.T) {
|
||||
var buf bytes.Buffer
|
||||
logger := slog.New(slog.NewTextHandler(&buf, nil))
|
||||
LogHandshakeFailed(logger, "peer-2", "", errors.New("tls: handshake"))
|
||||
out := buf.String()
|
||||
for _, want := range []string{"event=mtls.handshake", "result=failed", "peer=peer-2", "err=\"tls: handshake\""} {
|
||||
if !strings.Contains(out, want) {
|
||||
t.Errorf("LogHandshakeFailed: output missing %q\noutput: %s", want, out)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestAudit_LogHandshake_NilLogger(t *testing.T) {
|
||||
LogHandshakeOK(nil, "p", "fp")
|
||||
LogHandshakeFailed(nil, "p", "fp", errors.New("x"))
|
||||
}
|
||||
|
||||
func TestAudit_NilSafe(t *testing.T) {
|
||||
var a *Audit
|
||||
a.Emit(context.Background(), ActionCertIssued, "x", ResultSuccess, nil)
|
||||
a.EmitWithErr(context.Background(), ActionCertIssued, "x", errors.New("y"), nil)
|
||||
}
|
||||
|
||||
func TestAction_String(t *testing.T) {
|
||||
if got := ActionCertIssued.String(); got != "cert.issued" {
|
||||
t.Errorf("ActionCertIssued.String(): got %q, want cert.issued", got)
|
||||
}
|
||||
if got := ActionNodeHandshakeOK.String(); got != "node.handshake_ok" {
|
||||
t.Errorf("ActionNodeHandshakeOK.String(): got %q, want node.handshake_ok", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestResult_String(t *testing.T) {
|
||||
if got := ResultSuccess.String(); got != "success" {
|
||||
t.Errorf("ResultSuccess.String(): got %q, want success", got)
|
||||
}
|
||||
if got := ResultFailure.String(); got != "failure" {
|
||||
t.Errorf("ResultFailure.String(): got %q, want failure", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestFormatAction(t *testing.T) {
|
||||
got := FormatAction(ActionCertIssued, ResultSuccess)
|
||||
want := "action=cert.issued result=success"
|
||||
if got != want {
|
||||
t.Errorf("FormatAction: got %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
@@ -1,64 +1,73 @@
|
||||
// Package certpaths centralizes the on-disk locations of the CA and
|
||||
// server cert/key files. The CLI layer, the security layer, and the
|
||||
// doctor layer all need to agree on these paths, so they're factored
|
||||
// into their own package to avoid import cycles (cli <-> doctor).
|
||||
// Package certpaths is the v0.8 path shim. It returns v0.8 flat-layout
|
||||
// paths for backward compatibility during the v0.9 dual-write window
|
||||
// (REQ-090). The v0.9 paths package (internal/paths) returns the new
|
||||
// multi-namespace layout (R-002).
|
||||
//
|
||||
// certpaths will be deleted after the v0.10-P14 migration. New code
|
||||
// should use internal/paths, NOT certpaths.
|
||||
//
|
||||
// Migration notes (per v0.10-P14):
|
||||
// - CA cert/key, server cert/key, SSH key/pub, known_hosts currently
|
||||
// live at the flat Root() location. The v0.9 internal/paths package
|
||||
// returns the new ClusterDir()/... locations; certpaths keeps the
|
||||
// v0.8 flat locations until the CA migration moves them.
|
||||
// - DBPath keeps returning Root()/orca.db (v0.8 location). The new
|
||||
// paths.NSDb("_defaults") returns Root()/_defaults/db/orca.db; the DB
|
||||
// moves in v0.10-P14.
|
||||
package certpaths
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/paths"
|
||||
)
|
||||
|
||||
const (
|
||||
defaultCADir = ".orca"
|
||||
caCertFilename = "ca.crt"
|
||||
caKeyFilename = "ca.key"
|
||||
)
|
||||
// Dir returns the v0.8 flat root directory. Delegates to paths.Root()
|
||||
// (which honors $ORCA_HOME, else ~/.orca). v0.8 callers expect the CA
|
||||
// and DB to live directly under this directory; that does not change
|
||||
// until the v0.10-P14 migration.
|
||||
func Dir() string { return paths.Root() }
|
||||
|
||||
// Dir returns the directory the local CA lives in. Honors $ORCA_HOME
|
||||
// for testability; otherwise defaults to ~/.orca.
|
||||
func Dir() string {
|
||||
if p := os.Getenv("ORCA_HOME"); p != "" {
|
||||
return p
|
||||
}
|
||||
home, _ := os.UserHomeDir()
|
||||
return filepath.Join(home, defaultCADir)
|
||||
}
|
||||
// CACertPath returns the v0.8 CA cert path: Dir()/ca.crt.
|
||||
// The v0.9 location is paths.CACertPath() = ClusterDir()/ca.crt; certpaths
|
||||
// keeps the v0.8 flat location until the CA migration in v0.10-P14.
|
||||
func CACertPath() string { return filepath.Join(paths.Root(), "ca.crt") }
|
||||
|
||||
// CACertPath returns the path to ca.crt.
|
||||
func CACertPath() string { return filepath.Join(Dir(), caCertFilename) }
|
||||
// CAKeyPath returns the v0.8 CA key path: Dir()/ca.key.
|
||||
// See CACertPath for migration notes.
|
||||
func CAKeyPath() string { return filepath.Join(paths.Root(), "ca.key") }
|
||||
|
||||
// CAKeyPath returns the path to ca.key.
|
||||
func CAKeyPath() string { return filepath.Join(Dir(), caKeyFilename) }
|
||||
// ServerCertPath returns the v0.8 server cert path: Dir()/server.crt.
|
||||
// See CACertPath for migration notes.
|
||||
func ServerCertPath() string { return filepath.Join(paths.Root(), "server.crt") }
|
||||
|
||||
// ServerCertPath returns the path to server.crt.
|
||||
func ServerCertPath() string { return filepath.Join(Dir(), "server.crt") }
|
||||
|
||||
// ServerKeyPath returns the path to server.key.
|
||||
func ServerKeyPath() string { return filepath.Join(Dir(), "server.key") }
|
||||
// ServerKeyPath returns the v0.8 server key path: Dir()/server.key.
|
||||
// See CACertPath for migration notes.
|
||||
func ServerKeyPath() string { return filepath.Join(paths.Root(), "server.key") }
|
||||
|
||||
// DBPath returns the path to the orca SQLite database. Honors $ORCA_DB
|
||||
// for testability and explicit override; otherwise defaults to
|
||||
// ~/.orca/orca.db under the same Dir() as the cert files.
|
||||
// for testability and explicit override; otherwise defaults to the v0.8
|
||||
// flat location Dir()/orca.db. The v0.9 location is
|
||||
// paths.NSDb(paths.DefaultNamespace()) = Root()/_defaults/db/orca.db;
|
||||
// certpaths keeps the v0.8 flat location until the DB move in v0.10-P14.
|
||||
func DBPath() string {
|
||||
if p := os.Getenv("ORCA_DB"); p != "" {
|
||||
return p
|
||||
}
|
||||
return filepath.Join(Dir(), "orca.db")
|
||||
return filepath.Join(paths.Root(), "orca.db")
|
||||
}
|
||||
|
||||
// SSHKeyPath returns the path to the orca SSH private key (Ed25519,
|
||||
// D-037). Used by `orca node join --type proxmox` to authenticate
|
||||
// to remote Proxmox hosts after the initial password-based bootstrap.
|
||||
// File mode 0600 (enforced by security.WriteKey).
|
||||
func SSHKeyPath() string { return filepath.Join(Dir(), "orca_ssh_key") }
|
||||
// SSHKeyPath returns the v0.8 SSH private key path: Dir()/orca_ssh_key.
|
||||
// The v0.9 location is paths.SSHKeyPath() = ClusterDir()/orca_ssh_key;
|
||||
// certpaths keeps the v0.8 flat location until the migration.
|
||||
func SSHKeyPath() string { return filepath.Join(paths.Root(), "orca_ssh_key") }
|
||||
|
||||
// SSHPubPath returns the path to the orca SSH public key (authorized_keys
|
||||
// format). Deployed to remote Proxmox hosts during `orca node join`.
|
||||
// File mode 0644 (enforced by security.WriteCert).
|
||||
func SSHPubPath() string { return filepath.Join(Dir(), "orca_ssh_key.pub") }
|
||||
// SSHPubPath returns the v0.8 SSH public key path: Dir()/orca_ssh_key.pub.
|
||||
// See SSHKeyPath for migration notes.
|
||||
func SSHPubPath() string { return filepath.Join(paths.Root(), "orca_ssh_key.pub") }
|
||||
|
||||
// KnownHostsPath returns the path to the SSH known_hosts file used for
|
||||
// TOFU host-key pinning (D-035). Captured on first connect, verified
|
||||
// on all subsequent connects via golang.org/x/crypto/ssh/knownhosts.
|
||||
func KnownHostsPath() string { return filepath.Join(Dir(), "known_hosts") }
|
||||
// KnownHostsPath returns the v0.8 known_hosts path: Dir()/known_hosts.
|
||||
// The v0.9 location is paths.KnownHostsPath() = ClusterDir()/known_hosts;
|
||||
// certpaths keeps the v0.8 flat location until the migration.
|
||||
func KnownHostsPath() string { return filepath.Join(paths.Root(), "known_hosts") }
|
||||
|
||||
@@ -0,0 +1,184 @@
|
||||
package certpaths
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/paths"
|
||||
)
|
||||
|
||||
const defaultHomeSubdir = ".orca"
|
||||
|
||||
func TestPaths_HonorORCAHOME(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", dir)
|
||||
t.Setenv("ORCA_DB", "")
|
||||
|
||||
cases := []struct {
|
||||
name string
|
||||
got string
|
||||
file string
|
||||
}{
|
||||
{"CACertPath", CACertPath(), "ca.crt"},
|
||||
{"CAKeyPath", CAKeyPath(), "ca.key"},
|
||||
{"ServerCertPath", ServerCertPath(), "server.crt"},
|
||||
{"ServerKeyPath", ServerKeyPath(), "server.key"},
|
||||
{"SSHKeyPath", SSHKeyPath(), "orca_ssh_key"},
|
||||
{"SSHPubPath", SSHPubPath(), "orca_ssh_key.pub"},
|
||||
{"KnownHostsPath", KnownHostsPath(), "known_hosts"},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
want := filepath.Join(dir, tc.file)
|
||||
if tc.got != want {
|
||||
t.Errorf("%s = %q, want %q", tc.name, tc.got, want)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
if got, want := DBPath(), filepath.Join(dir, "orca.db"); got != want {
|
||||
t.Errorf("DBPath = %q, want %q", got, want)
|
||||
}
|
||||
|
||||
if got, want := Dir(), dir; got != want {
|
||||
t.Errorf("Dir = %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestShim_DelegatesDirToPaths(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", dir)
|
||||
if got, want := Dir(), paths.Root(); got != want {
|
||||
t.Errorf("Dir() = %q, paths.Root() = %q (shim must delegate)", got, want)
|
||||
}
|
||||
if got, want := Dir(), dir; got != want {
|
||||
t.Errorf("Dir() = %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDBPath_OrcaDBOverride(t *testing.T) {
|
||||
home := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", home)
|
||||
custom := filepath.Join(t.TempDir(), "custom.db")
|
||||
t.Setenv("ORCA_DB", custom)
|
||||
|
||||
if got := DBPath(); got != custom {
|
||||
t.Errorf("DBPath = %q, want %q (ORCA_DB override)", got, custom)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDBPath_OrcaDBEmptyStringFallsBackToHome(t *testing.T) {
|
||||
home := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", home)
|
||||
t.Setenv("ORCA_DB", "")
|
||||
|
||||
want := filepath.Join(home, "orca.db")
|
||||
if got := DBPath(); got != want {
|
||||
t.Errorf("DBPath = %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDir_DefaultHomeFallback(t *testing.T) {
|
||||
os.Unsetenv("ORCA_HOME")
|
||||
os.Unsetenv("ORCA_DB")
|
||||
|
||||
home, err := os.UserHomeDir()
|
||||
if err != nil {
|
||||
t.Skipf("os.UserHomeDir: %v (cannot verify default fallback)", err)
|
||||
}
|
||||
want := filepath.Join(home, defaultHomeSubdir)
|
||||
if got := Dir(); got != want {
|
||||
t.Errorf("Dir() default = %q, want %q", got, want)
|
||||
}
|
||||
if got := CACertPath(); got != filepath.Join(want, "ca.crt") {
|
||||
t.Errorf("CACertPath default = %q, want %q", got, filepath.Join(want, "ca.crt"))
|
||||
}
|
||||
}
|
||||
|
||||
func TestDir_ORCAHOMEEmptyFallsBack(t *testing.T) {
|
||||
t.Setenv("ORCA_HOME", "")
|
||||
home, err := os.UserHomeDir()
|
||||
if err != nil {
|
||||
t.Skipf("os.UserHomeDir: %v", err)
|
||||
}
|
||||
want := filepath.Join(home, defaultHomeSubdir)
|
||||
if got := Dir(); got != want {
|
||||
t.Errorf("Dir() with empty ORCA_HOME = %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDir_ORCAHOMERelativePath(t *testing.T) {
|
||||
t.Setenv("ORCA_HOME", "relative/orca/home")
|
||||
if got, want := Dir(), "relative/orca/home"; got != want {
|
||||
t.Errorf("Dir() relative = %q, want %q", got, want)
|
||||
}
|
||||
if got, want := CACertPath(), filepath.Join("relative/orca/home", "ca.crt"); got != want {
|
||||
t.Errorf("CACertPath relative = %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAllPaths_AreConsistentWithDir(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", dir)
|
||||
t.Setenv("ORCA_DB", "")
|
||||
|
||||
base := Dir()
|
||||
for _, p := range []string{
|
||||
CACertPath(), CAKeyPath(),
|
||||
ServerCertPath(), ServerKeyPath(),
|
||||
SSHKeyPath(), SSHPubPath(),
|
||||
KnownHostsPath(), DBPath(),
|
||||
} {
|
||||
if !strings.HasPrefix(p, base+string(filepath.Separator)) && p != filepath.Join(base, filepath.Base(p)) {
|
||||
t.Errorf("path %q is not under Dir() %q", p, base)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestShim_ReturnsV08FlatPaths(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", dir)
|
||||
t.Setenv("ORCA_DB", "")
|
||||
|
||||
root := paths.Root()
|
||||
if got, want := CACertPath(), filepath.Join(root, "ca.crt"); got != want {
|
||||
t.Errorf("CACertPath = %q, want v0.8 flat %q", got, want)
|
||||
}
|
||||
if got, want := CAKeyPath(), filepath.Join(root, "ca.key"); got != want {
|
||||
t.Errorf("CAKeyPath = %q, want v0.8 flat %q", got, want)
|
||||
}
|
||||
if got, want := ServerCertPath(), filepath.Join(root, "server.crt"); got != want {
|
||||
t.Errorf("ServerCertPath = %q, want v0.8 flat %q", got, want)
|
||||
}
|
||||
if got, want := ServerKeyPath(), filepath.Join(root, "server.key"); got != want {
|
||||
t.Errorf("ServerKeyPath = %q, want v0.8 flat %q", got, want)
|
||||
}
|
||||
if got, want := SSHKeyPath(), filepath.Join(root, "orca_ssh_key"); got != want {
|
||||
t.Errorf("SSHKeyPath = %q, want v0.8 flat %q", got, want)
|
||||
}
|
||||
if got, want := SSHPubPath(), filepath.Join(root, "orca_ssh_key.pub"); got != want {
|
||||
t.Errorf("SSHPubPath = %q, want v0.8 flat %q", got, want)
|
||||
}
|
||||
if got, want := KnownHostsPath(), filepath.Join(root, "known_hosts"); got != want {
|
||||
t.Errorf("KnownHostsPath = %q, want v0.8 flat %q", got, want)
|
||||
}
|
||||
if got, want := DBPath(), filepath.Join(root, "orca.db"); got != want {
|
||||
t.Errorf("DBPath = %q, want v0.8 flat %q", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSSHPaths_Filenames(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", dir)
|
||||
if got, want := filepath.Base(SSHKeyPath()), "orca_ssh_key"; got != want {
|
||||
t.Errorf("SSHKeyPath base = %q, want %q", got, want)
|
||||
}
|
||||
if got, want := filepath.Base(SSHPubPath()), "orca_ssh_key.pub"; got != want {
|
||||
t.Errorf("SSHPubPath base = %q, want %q", got, want)
|
||||
}
|
||||
if got, want := filepath.Base(KnownHostsPath()), "known_hosts"; got != want {
|
||||
t.Errorf("KnownHostsPath base = %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,113 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/certpaths"
|
||||
"git.cloudinit.dev/coreci/orca/internal/store"
|
||||
)
|
||||
|
||||
func TestAuditListEmpty(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"audit", "list"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("audit list: %v", err)
|
||||
}
|
||||
if !strings.Contains(buf.String(), "No audit entries") {
|
||||
t.Errorf("audit list empty output unexpected: %s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestAuditListJSONEmpty(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"audit", "list", "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("audit list --json: %v", err)
|
||||
}
|
||||
var entries []map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &entries); err != nil {
|
||||
t.Fatalf("unmarshal audit json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if len(entries) != 0 {
|
||||
t.Errorf("audit list --json empty = %d entries, want 0", len(entries))
|
||||
}
|
||||
}
|
||||
|
||||
func TestAuditListWithEntries(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
db, err := store.Open(certpaths.DBPath())
|
||||
if err != nil {
|
||||
t.Fatalf("open db: %v", err)
|
||||
}
|
||||
defer db.Close()
|
||||
repo := store.NewAuditRepo(db)
|
||||
ctx := t.Context()
|
||||
if err := repo.Append(ctx, &store.AuditEntry{
|
||||
Actor: "test", Action: "test.action", Resource: "res", Result: "success",
|
||||
}); err != nil {
|
||||
t.Fatalf("append audit: %v", err)
|
||||
}
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"audit", "list"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("audit list: %v", err)
|
||||
}
|
||||
out := buf.String()
|
||||
if !strings.Contains(out, "test.action") {
|
||||
t.Errorf("audit list missing entry: %s", out)
|
||||
}
|
||||
if !strings.Contains(out, "TIMESTAMP") {
|
||||
t.Errorf("audit list missing header: %s", out)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAuditListLimitFlag(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
db, err := store.Open(certpaths.DBPath())
|
||||
if err != nil {
|
||||
t.Fatalf("open db: %v", err)
|
||||
}
|
||||
defer db.Close()
|
||||
repo := store.NewAuditRepo(db)
|
||||
ctx := t.Context()
|
||||
for i := 0; i < 5; i++ {
|
||||
if err := repo.Append(ctx, &store.AuditEntry{
|
||||
Actor: "test", Action: "test.action", Resource: "res", Result: "success",
|
||||
}); err != nil {
|
||||
t.Fatalf("append audit %d: %v", i, err)
|
||||
}
|
||||
}
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"audit", "list", "--json", "--limit", "2"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("audit list --json --limit 2: %v", err)
|
||||
}
|
||||
var entries []map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &entries); err != nil {
|
||||
t.Fatalf("unmarshal audit json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if len(entries) != 2 {
|
||||
t.Errorf("audit list --limit 2 = %d entries, want 2", len(entries))
|
||||
}
|
||||
}
|
||||
+19
-1
@@ -42,6 +42,11 @@ func ServerCertPath() string { return certpaths.ServerCertPath() }
|
||||
func ServerKeyPath() string { return certpaths.ServerKeyPath() }
|
||||
|
||||
// NewCommand builds the `orca cert` command tree.
|
||||
//
|
||||
// Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
|
||||
// (D-101/REQ-076). The `orca cert` command tree is retained for the
|
||||
// dual-write window and scheduled for deletion in v0.10. See
|
||||
// .ciagent/PRD_v0.9.md.
|
||||
func NewCommand(log *slog.Logger) *cobra.Command {
|
||||
if log == nil {
|
||||
log = slog.Default()
|
||||
@@ -49,7 +54,16 @@ func NewCommand(log *slog.Logger) *cobra.Command {
|
||||
certCmd := &cobra.Command{
|
||||
Use: "cert",
|
||||
Short: "Manage orca certificates (CA, server, rotation)",
|
||||
Long: "Bootstrap a local CA, generate server certs, and rotate them.",
|
||||
Long: `Manage orca certificates (CA, server, rotation).
|
||||
|
||||
Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
|
||||
(D-101/REQ-076). The ` + "`orca cert`" + ` command tree is retained for the
|
||||
dual-write window and scheduled for deletion in v0.10. See
|
||||
.ciagent/PRD_v0.9.md.`,
|
||||
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
|
||||
warnDeprecated("orca cert is deprecated in v0.9: step-ca (D-101) now handles CA; orca cert will be removed in v0.10 — see .ciagent/PRD_v0.9.md")
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
certCmd.AddCommand(newCAInitCmd(log))
|
||||
@@ -253,3 +267,7 @@ func parseFirstCertDER(pemBytes []byte) []byte {
|
||||
}
|
||||
return block.Bytes
|
||||
}
|
||||
|
||||
func init() {
|
||||
rootCmd.AddCommand(NewCommand(slog.Default()))
|
||||
}
|
||||
|
||||
@@ -0,0 +1,121 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func runCertArgs(t *testing.T, args []string) (string, error) {
|
||||
t.Helper()
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs(args)
|
||||
defer func() {
|
||||
rootCmd.SetArgs(nil)
|
||||
rootCmd.SetOut(os.Stdout)
|
||||
rootCmd.SetErr(os.Stderr)
|
||||
}()
|
||||
err := rootCmd.Execute()
|
||||
return buf.String(), err
|
||||
}
|
||||
|
||||
func TestCertSmoke(t *testing.T) {
|
||||
t.Setenv("ORCA_HOME", t.TempDir())
|
||||
|
||||
t.Run("ca-init", func(t *testing.T) {
|
||||
out, err := runCertArgs(t, []string{"cert", "ca-init", "--cn", "test-ca"})
|
||||
if err != nil {
|
||||
t.Fatalf("ca-init: %v\n%s", err, out)
|
||||
}
|
||||
if !strings.Contains(out, "CA initialized") {
|
||||
t.Errorf("ca-init output unexpected: %s", out)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("gen", func(t *testing.T) {
|
||||
out, err := runCertArgs(t, []string{"cert", "gen", "--cn", "test-server", "--san", "localhost", "--san", "127.0.0.1"})
|
||||
if err != nil {
|
||||
t.Fatalf("gen: %v\n%s", err, out)
|
||||
}
|
||||
if !strings.Contains(out, "Server cert generated") {
|
||||
t.Errorf("gen output unexpected: %s", out)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("show", func(t *testing.T) {
|
||||
out, err := runCertArgs(t, []string{"cert", "show"})
|
||||
if err != nil {
|
||||
t.Fatalf("show: %v\n%s", err, out)
|
||||
}
|
||||
if strings.Contains(out, "PRIVATE KEY") {
|
||||
t.Errorf("show leaked private key material (REQ-035):\n%s", out)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("fingerprint_ca", func(t *testing.T) {
|
||||
out, err := runCertArgs(t, []string{"cert", "fingerprint", "--which", "ca"})
|
||||
if err != nil {
|
||||
t.Fatalf("fingerprint ca: %v\n%s", err, out)
|
||||
}
|
||||
fp := strings.TrimSpace(out)
|
||||
if len(fp) != 64 || !isHex(fp) {
|
||||
t.Errorf("ca fingerprint = %q, want 64 hex chars", fp)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("fingerprint_server", func(t *testing.T) {
|
||||
out, err := runCertArgs(t, []string{"cert", "fingerprint", "--which", "server"})
|
||||
if err != nil {
|
||||
t.Fatalf("fingerprint server: %v\n%s", err, out)
|
||||
}
|
||||
fp := strings.TrimSpace(out)
|
||||
if len(fp) != 64 || !isHex(fp) {
|
||||
t.Errorf("server fingerprint = %q, want 64 hex chars", fp)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("renew", func(t *testing.T) {
|
||||
out, err := runCertArgs(t, []string{"cert", "renew"})
|
||||
if err != nil {
|
||||
t.Fatalf("renew: %v\n%s", err, out)
|
||||
}
|
||||
if !strings.Contains(out, "rotated") {
|
||||
t.Errorf("renew output unexpected: %s", out)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("file_modes", func(t *testing.T) {
|
||||
dir := os.Getenv("ORCA_HOME")
|
||||
checks := []struct {
|
||||
path string
|
||||
want os.FileMode
|
||||
}{
|
||||
{"ca.crt", 0o644},
|
||||
{"ca.key", 0o600},
|
||||
{"server.crt", 0o644},
|
||||
{"server.key", 0o600},
|
||||
}
|
||||
for _, c := range checks {
|
||||
info, err := os.Stat(filepath.Join(dir, c.path))
|
||||
if err != nil {
|
||||
t.Fatalf("stat %s: %v", c.path, err)
|
||||
}
|
||||
if got := info.Mode().Perm(); got != c.want {
|
||||
t.Errorf("mode %s = %04o, want %04o (REQ-033)", c.path, got, c.want)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func isHex(s string) bool {
|
||||
for _, r := range s {
|
||||
if !((r >= '0' && r <= '9') || (r >= 'a' && r <= 'f') || (r >= 'A' && r <= 'F')) {
|
||||
return false
|
||||
}
|
||||
}
|
||||
return true
|
||||
}
|
||||
@@ -0,0 +1,37 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestCertCommandRegistered(t *testing.T) {
|
||||
found := false
|
||||
for _, cmd := range rootCmd.Commands() {
|
||||
if strings.Fields(cmd.Use)[0] == "cert" {
|
||||
found = true
|
||||
break
|
||||
}
|
||||
}
|
||||
if !found {
|
||||
t.Fatal("cert command not registered on rootCmd")
|
||||
}
|
||||
}
|
||||
|
||||
func TestCertSubcommands(t *testing.T) {
|
||||
expected := []string{"ca-init", "gen", "show", "renew", "fingerprint"}
|
||||
registered := make(map[string]bool)
|
||||
for _, cmd := range rootCmd.Commands() {
|
||||
if strings.Fields(cmd.Use)[0] != "cert" {
|
||||
continue
|
||||
}
|
||||
for _, sub := range cmd.Commands() {
|
||||
registered[strings.Fields(sub.Use)[0]] = true
|
||||
}
|
||||
}
|
||||
for _, name := range expected {
|
||||
if !registered[name] {
|
||||
t.Errorf("expected cert subcommand %q not registered", name)
|
||||
}
|
||||
}
|
||||
}
|
||||
+21
-7
@@ -4,7 +4,6 @@ import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"net/http"
|
||||
"os"
|
||||
"os/signal"
|
||||
@@ -20,13 +19,20 @@ import (
|
||||
|
||||
var (
|
||||
daemonAddr string
|
||||
pprofAddr string
|
||||
)
|
||||
|
||||
var daemonCmd = &cobra.Command{
|
||||
Use: "daemon",
|
||||
Short: "Run the orca daemon (HTTP API + health checks)",
|
||||
Long: "Start the orca daemon. Listens on the configured address for health, API, and dispatch requests.",
|
||||
Long: `Start the orca daemon. Listens on the configured address for health, API, and dispatch requests.
|
||||
|
||||
Deprecated: v0.9 re-architecture replaces the orca daemon with SSH-push to
|
||||
bare servers (R-001 — no orca binary on servers). The daemon is repurposed to
|
||||
drain-and-stop in v0.10-P05 and scheduled for deletion in v0.10-P14. See
|
||||
.ciagent/PRD_v0.9.md.`,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
warnDeprecated("orca daemon is deprecated in v0.9 and will be repurposed to 'drain-and-stop' in v0.10-P05; the v0.9 re-architecture (R-001) removes the orca binary from servers — see .ciagent/PRD_v0.9.md")
|
||||
db, closer, err := openDB()
|
||||
if err != nil {
|
||||
return err
|
||||
@@ -34,11 +40,16 @@ var daemonCmd = &cobra.Command{
|
||||
defer closer()
|
||||
|
||||
log := newLogger()
|
||||
addr := daemonAddr
|
||||
if cfg := configFromCtx(cmd.Context()); cfg != nil && cfg.ListenAddr != "" && !cmd.Flags().Changed("addr") {
|
||||
addr = cfg.ListenAddr
|
||||
}
|
||||
srv := daemon.NewServer(daemon.Options{
|
||||
DB: db,
|
||||
Log: log,
|
||||
Addr: daemonAddr,
|
||||
Actor: "daemon",
|
||||
DB: db,
|
||||
Log: log,
|
||||
Addr: addr,
|
||||
Actor: "daemon",
|
||||
PprofAddr: pprofAddr,
|
||||
})
|
||||
|
||||
// Wire the orca.v1.Dispatch service (v0.2 P02). The executor
|
||||
@@ -67,6 +78,9 @@ var daemonCmd = &cobra.Command{
|
||||
fmt.Fprintln(cmd.OutOrStdout(), " /v1/tasks - list tasks")
|
||||
fmt.Fprintln(cmd.OutOrStdout(), " /orca.v1.Dispatch/Submit - cross-node job submit (P02)")
|
||||
fmt.Fprintln(cmd.OutOrStdout(), " /orca.v1.Dispatch/Status - cross-node job status (P02)")
|
||||
if pprofAddr != "" {
|
||||
fmt.Fprintf(cmd.OutOrStdout(), " /debug/pprof/ (pprof) - %s\n", pprofAddr)
|
||||
}
|
||||
fmt.Fprintln(cmd.OutOrStdout(), " press Ctrl+C to stop")
|
||||
|
||||
ctx, stop := signal.NotifyContext(cmd.Context(), os.Interrupt, syscall.SIGTERM)
|
||||
@@ -86,6 +100,6 @@ var daemonCmd = &cobra.Command{
|
||||
|
||||
func init() {
|
||||
daemonCmd.Flags().StringVar(&daemonAddr, "addr", ":8080", "listen address")
|
||||
daemonCmd.Flags().StringVar(&pprofAddr, "pprof", "", "enable pprof endpoint on <addr> (e.g. :6060); unauthenticated, operator-only")
|
||||
rootCmd.AddCommand(daemonCmd)
|
||||
_ = slog.Default // keep import if unused above
|
||||
}
|
||||
|
||||
@@ -0,0 +1,233 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"log/slog"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestDaemonPprofFlag(t *testing.T) {
|
||||
f := daemonCmd.Flags().Lookup("pprof")
|
||||
if f == nil {
|
||||
t.Fatal("--pprof flag not registered on daemonCmd")
|
||||
}
|
||||
if f.DefValue != "" {
|
||||
t.Errorf("--pprof default = %q, want empty", f.DefValue)
|
||||
}
|
||||
}
|
||||
|
||||
// captureSlog swaps slog.Default() for a text handler writing to buf,
|
||||
// returning a buffer and a restore func. Tests use this to observe
|
||||
// warnDeprecated output (which uses the package-level slog.Default).
|
||||
func captureSlog(t *testing.T) (*bytes.Buffer, func()) {
|
||||
t.Helper()
|
||||
var buf bytes.Buffer
|
||||
prev := slog.Default()
|
||||
logger := slog.New(slog.NewTextHandler(&buf, &slog.HandlerOptions{Level: slog.LevelWarn}))
|
||||
slog.SetDefault(logger)
|
||||
return &buf, func() { slog.SetDefault(prev) }
|
||||
}
|
||||
|
||||
// runDaemonHermetic invokes daemonCmd.RunE with a context that is
|
||||
// already cancelled and an unbindable --addr, so the long-running
|
||||
// server start short-circuits and RunE returns quickly without
|
||||
// touching the network. It returns whatever RunE returned and the
|
||||
// captured slog buffer.
|
||||
func runDaemonHermetic(t *testing.T, suppressWarnings bool) (string, error) {
|
||||
t.Helper()
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
|
||||
buf, restore := captureSlog(t)
|
||||
defer restore()
|
||||
|
||||
if suppressWarnings {
|
||||
_ = rootCmd.PersistentFlags().Set("no-deprecation-warnings", "true")
|
||||
}
|
||||
|
||||
daemonAddr = "127.0.0.1:99999" // unbindable: port outside uint16 range → ListenAndServe fails fast
|
||||
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
cancel() // already-done context: the select returns via <-ctx.Done() immediately
|
||||
|
||||
cmd := daemonCmd
|
||||
cmd.SetOut(&bytes.Buffer{})
|
||||
cmd.SetErr(&bytes.Buffer{})
|
||||
cmd.SetArgs(nil)
|
||||
cmd.SetContext(ctx)
|
||||
|
||||
err := cmd.RunE(cmd, nil)
|
||||
return buf.String(), err
|
||||
}
|
||||
|
||||
// TestDaemonEmitsDeprecationWarning verifies REQ-068: `orca daemon`
|
||||
// emits a slog.Warn deprecation banner on every run.
|
||||
func TestDaemonEmitsDeprecationWarning(t *testing.T) {
|
||||
out, _ := runDaemonHermetic(t, false)
|
||||
if !strings.Contains(out, "orca daemon is deprecated in v0.9") {
|
||||
t.Errorf("expected deprecation warning in slog output, got:\n%s", out)
|
||||
}
|
||||
if !strings.Contains(out, "R-001") {
|
||||
t.Errorf("deprecation warning should reference R-001, got:\n%s", out)
|
||||
}
|
||||
}
|
||||
|
||||
// TestDaemonDeprecationWarningSuppressed verifies that
|
||||
// --no-deprecation-warnings suppresses the deprecation banner (for
|
||||
// `orca upgrade` migrations).
|
||||
func TestDaemonDeprecationWarningSuppressed(t *testing.T) {
|
||||
out, _ := runDaemonHermetic(t, true)
|
||||
if strings.Contains(out, "deprecated in v0.9") {
|
||||
t.Errorf("--no-deprecation-warnings should suppress the deprecation warning, got:\n%s", out)
|
||||
}
|
||||
}
|
||||
|
||||
// TestDaemonStillRuns verifies deprecation ≠ removal: the daemon
|
||||
// command's RunE is still wired and callable. We don't assert on the
|
||||
// error value (the hermetic short-circuit may return nil or a
|
||||
// shutdown-related error), only that the command did not fail *because*
|
||||
// of the deprecation notice.
|
||||
func TestDaemonStillRuns(t *testing.T) {
|
||||
_, err := runDaemonHermetic(t, false)
|
||||
if err != nil && strings.Contains(err.Error(), "deprecated") {
|
||||
t.Errorf("daemon must not error due to deprecation, got: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestWarnDeprecatedGate verifies the package-level helper that gates
|
||||
// deprecation warnings on the --no-deprecation-warnings flag.
|
||||
func TestWarnDeprecatedGate(t *testing.T) {
|
||||
t.Run("emits by default", func(t *testing.T) {
|
||||
buf, restore := captureSlog(t)
|
||||
defer restore()
|
||||
noDeprecationWarnings = false
|
||||
warnDeprecated("test-deprecation-marker")
|
||||
if !strings.Contains(buf.String(), "test-deprecation-marker") {
|
||||
t.Errorf("expected warning emitted, got: %s", buf.String())
|
||||
}
|
||||
})
|
||||
t.Run("suppressed when flag set", func(t *testing.T) {
|
||||
buf, restore := captureSlog(t)
|
||||
defer restore()
|
||||
noDeprecationWarnings = true
|
||||
defer func() { noDeprecationWarnings = false }()
|
||||
warnDeprecated("should-not-appear")
|
||||
if strings.Contains(buf.String(), "should-not-appear") {
|
||||
t.Errorf("expected no warning when --no-deprecation-warnings set, got: %s", buf.String())
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// TestNoDeprecationWarningsFlagRegistered verifies the
|
||||
// --no-deprecation-warnings persistent flag exists on rootCmd.
|
||||
func TestNoDeprecationWarningsFlagRegistered(t *testing.T) {
|
||||
f := rootCmd.PersistentFlags().Lookup("no-deprecation-warnings")
|
||||
if f == nil {
|
||||
t.Fatal("--no-deprecation-warnings persistent flag not registered on rootCmd")
|
||||
}
|
||||
if f.DefValue != "false" {
|
||||
t.Errorf("--no-deprecation-warnings default = %q, want false", f.DefValue)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCertEmitsDeprecationWarning verifies REQ-068: `orca cert`
|
||||
// subcommands emit a deprecation banner.
|
||||
func TestCertEmitsDeprecationWarning(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
|
||||
buf, restore := captureSlog(t)
|
||||
defer restore()
|
||||
|
||||
var out bytes.Buffer
|
||||
rootCmd.SetOut(&out)
|
||||
rootCmd.SetErr(&out)
|
||||
rootCmd.SetArgs([]string{"cert", "fingerprint", "--which", "ca"})
|
||||
_ = rootCmd.Execute()
|
||||
|
||||
logged := buf.String()
|
||||
if !strings.Contains(logged, "orca cert is deprecated in v0.9") {
|
||||
t.Errorf("expected cert deprecation warning, got:\n%s", logged)
|
||||
}
|
||||
if !strings.Contains(logged, "step-ca") {
|
||||
t.Errorf("deprecation warning should mention step-ca, got:\n%s", logged)
|
||||
}
|
||||
}
|
||||
|
||||
// TestCertDeprecationWarningSuppressed verifies --no-deprecation-warnings
|
||||
// suppresses the cert deprecation banner.
|
||||
func TestCertDeprecationWarningSuppressed(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
_ = rootCmd.PersistentFlags().Set("no-deprecation-warnings", "true")
|
||||
|
||||
buf, restore := captureSlog(t)
|
||||
defer restore()
|
||||
|
||||
var out bytes.Buffer
|
||||
rootCmd.SetOut(&out)
|
||||
rootCmd.SetErr(&out)
|
||||
rootCmd.SetArgs([]string{"cert", "fingerprint", "--which", "ca"})
|
||||
_ = rootCmd.Execute()
|
||||
|
||||
if strings.Contains(buf.String(), "orca cert is deprecated") {
|
||||
t.Errorf("--no-deprecation-warnings should suppress cert warning, got:\n%s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
// TestNodeJoinMTLSEmitsDeprecationWarning verifies REQ-068: the mTLS
|
||||
// join path (`orca node join` without --type proxmox) warns that the
|
||||
// mTLS join path is deprecated.
|
||||
func TestNodeJoinMTLSEmitsDeprecationWarning(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
|
||||
buf, restore := captureSlog(t)
|
||||
defer restore()
|
||||
|
||||
var out bytes.Buffer
|
||||
rootCmd.SetOut(&out)
|
||||
rootCmd.SetErr(&out)
|
||||
rootCmd.SetArgs([]string{"node", "join", "--name", "dep-warning", "--addr", "10.0.0.55:8443"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("node join: %v", err)
|
||||
}
|
||||
|
||||
logged := buf.String()
|
||||
if !strings.Contains(logged, "mTLS join path is deprecated") {
|
||||
t.Errorf("expected mTLS join deprecation warning, got:\n%s", logged)
|
||||
}
|
||||
if !strings.Contains(logged, "R-001") {
|
||||
t.Errorf("deprecation warning should reference R-001, got:\n%s", logged)
|
||||
}
|
||||
}
|
||||
|
||||
// TestNodeJoinProxmoxNoMTLSDeprecationWarning verifies the deprecation
|
||||
// warning does NOT fire for the proxmox SSH path (that path is the
|
||||
// v0.9 replacement, not the deprecated mTLS path).
|
||||
func TestNodeJoinProxmoxNoMTLSDeprecationWarning(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
|
||||
buf, restore := captureSlog(t)
|
||||
defer restore()
|
||||
|
||||
var out bytes.Buffer
|
||||
rootCmd.SetOut(&out)
|
||||
rootCmd.SetErr(&out)
|
||||
// proxmox path errors on missing --host before reaching the warning,
|
||||
// and never calls joinLocal, so no mTLS deprecation warning fires.
|
||||
rootCmd.SetArgs([]string{"node", "join", "--type", "proxmox", "--password", "x"})
|
||||
_ = rootCmd.Execute()
|
||||
|
||||
if strings.Contains(buf.String(), "mTLS join path is deprecated") {
|
||||
t.Errorf("proxmox path must not emit mTLS deprecation warning, got:\n%s", buf.String())
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,196 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestDoctorText(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
if err := runInit(discardWriter{}); err != nil {
|
||||
t.Fatalf("init: %v", err)
|
||||
}
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"doctor"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("doctor: %v", err)
|
||||
}
|
||||
out := buf.String()
|
||||
for _, want := range []string{"CA", "cert", "PASS", "WARN", "FAIL"} {
|
||||
_ = want
|
||||
}
|
||||
if !strings.Contains(out, "CA") {
|
||||
t.Errorf("doctor output missing CA check: %s", out)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDoctorJSON(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
if err := runInit(discardWriter{}); err != nil {
|
||||
t.Fatalf("init: %v", err)
|
||||
}
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"doctor", "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("doctor --json: %v", err)
|
||||
}
|
||||
var checks []map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &checks); err != nil {
|
||||
t.Fatalf("unmarshal doctor json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if len(checks) == 0 {
|
||||
t.Errorf("doctor --json returned no checks: %s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestDoctorCertSubcommand(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
if err := runInit(discardWriter{}); err != nil {
|
||||
t.Fatalf("init: %v", err)
|
||||
}
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"doctor", "cert"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("doctor cert: %v", err)
|
||||
}
|
||||
out := buf.String()
|
||||
if !strings.Contains(out, "CA") {
|
||||
t.Errorf("doctor cert output missing CA: %s", out)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDoctorCertJSON(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
if err := runInit(discardWriter{}); err != nil {
|
||||
t.Fatalf("init: %v", err)
|
||||
}
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"doctor", "cert", "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("doctor cert --json: %v", err)
|
||||
}
|
||||
var results []map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &results); err != nil {
|
||||
t.Fatalf("unmarshal doctor cert json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if len(results) == 0 {
|
||||
t.Errorf("doctor cert --json returned no results: %s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestDoctorDBSubcommand(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
if err := runInit(discardWriter{}); err != nil {
|
||||
t.Fatalf("init: %v", err)
|
||||
}
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"doctor", "db"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("doctor db: %v", err)
|
||||
}
|
||||
out := buf.String()
|
||||
if !strings.Contains(out, "db") {
|
||||
t.Errorf("doctor db output unexpected: %s", out)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDoctorOSSubcommand(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
if err := runInit(discardWriter{}); err != nil {
|
||||
t.Fatalf("init: %v", err)
|
||||
}
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"doctor", "os"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("doctor os: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDoctorOSJSON(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
if err := runInit(discardWriter{}); err != nil {
|
||||
t.Fatalf("init: %v", err)
|
||||
}
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"doctor", "os", "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("doctor os --json: %v", err)
|
||||
}
|
||||
var result map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &result); err != nil {
|
||||
t.Fatalf("unmarshal doctor os json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if result["Name"] == nil {
|
||||
t.Errorf("doctor os --json missing Name: %v", result)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDoctorNetworkSubcommand(t *testing.T) {
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"doctor", "network"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("doctor network: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDoctorProxmoxSubcommand(t *testing.T) {
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"doctor", "proxmox"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("doctor proxmox: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDoctorProxmoxJSON(t *testing.T) {
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"doctor", "proxmox", "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("doctor proxmox --json: %v", err)
|
||||
}
|
||||
var result map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &result); err != nil {
|
||||
t.Fatalf("unmarshal doctor proxmox json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if result["Name"] == nil {
|
||||
t.Errorf("doctor proxmox --json missing Name: %v", result)
|
||||
}
|
||||
}
|
||||
@@ -80,8 +80,8 @@ func TestInit_FullBootstrap(t *testing.T) {
|
||||
if err != nil {
|
||||
t.Fatalf("migration version: %v", err)
|
||||
}
|
||||
if version != "0006_node_kind_os.sql" {
|
||||
t.Errorf("migration version = %q, want 0006_node_kind_os.sql", version)
|
||||
if version != "0007_certs_serial_unique.sql" {
|
||||
t.Errorf("migration version = %q, want 0007_certs_serial_unique.sql", version)
|
||||
}
|
||||
|
||||
// Verify localhost node registered with kind=localhost.
|
||||
|
||||
+22
-3
@@ -74,7 +74,7 @@ var jobRunCmd = &cobra.Command{
|
||||
peers := engine.NewPeerRegistry()
|
||||
dispatcher := engine.NewDispatcher(newLogger(), store.NewCapacityRepo(db), peers, exec)
|
||||
specBytes, _ := json.Marshal(map[string]any{
|
||||
"name": spec.Job.Name,
|
||||
"name": spec.Name,
|
||||
"command": "/bin/true", // placeholder; full HCL dispatch lands in a later phase
|
||||
})
|
||||
jobID, nodeID, err := dispatcher.Submit(ctx, runTarget, specBytes, runIDKey)
|
||||
@@ -93,11 +93,11 @@ var jobRunCmd = &cobra.Command{
|
||||
|
||||
job := &model.Job{
|
||||
ID: uuid.NewString(),
|
||||
Name: spec.Job.Name,
|
||||
Name: spec.Name,
|
||||
Spec: args[0],
|
||||
Status: model.JobStatusPending,
|
||||
}
|
||||
if err := exec.Run(ctx, job, toTaskSpecs(spec.Tasks)); err != nil {
|
||||
if err := exec.Run(ctx, job, workloadToTaskSpecs(spec)); err != nil {
|
||||
if jsonOutput {
|
||||
_ = printJSON(map[string]any{"id": job.ID, "status": "failed", "error": err.Error()})
|
||||
return err
|
||||
@@ -330,3 +330,22 @@ func toTaskSpecs(in []jobspec.TaskSpec) []engine.TaskSpec {
|
||||
}
|
||||
return out
|
||||
}
|
||||
|
||||
// workloadToTaskSpecs converts a *WorkloadSpec into the engine.TaskSpec
|
||||
// slice consumed by the executor. For the HCL adapter path the runtime
|
||||
// block carries the legacy task[0].Command; for the Markdown path the
|
||||
// runtime block is the canonical runtime abstraction (P07 will expand
|
||||
// this). When Runtime is nil we emit a single no-op task to preserve
|
||||
// the legacy "at least one task" invariant.
|
||||
func workloadToTaskSpecs(spec *jobspec.WorkloadSpec) []engine.TaskSpec {
|
||||
if spec == nil {
|
||||
return nil
|
||||
}
|
||||
if spec.Runtime == nil {
|
||||
return []engine.TaskSpec{{Name: spec.Name, Command: "/bin/true"}}
|
||||
}
|
||||
return []engine.TaskSpec{{
|
||||
Name: spec.Name,
|
||||
Command: spec.Runtime.Command,
|
||||
}}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,312 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/certpaths"
|
||||
"git.cloudinit.dev/coreci/orca/internal/model"
|
||||
"git.cloudinit.dev/coreci/orca/internal/store"
|
||||
)
|
||||
|
||||
func writeJobSpec(t *testing.T, content string) string {
|
||||
t.Helper()
|
||||
dir := t.TempDir()
|
||||
p := filepath.Join(dir, "spec.hcl")
|
||||
if err := os.WriteFile(p, []byte(content), 0o644); err != nil {
|
||||
t.Fatalf("write spec: %v", err)
|
||||
}
|
||||
return p
|
||||
}
|
||||
|
||||
const trueJobSpec = `job "true" {}
|
||||
task "t" {
|
||||
command = "/bin/true"
|
||||
}
|
||||
`
|
||||
|
||||
const falseJobSpec = `job "false" {}
|
||||
task "t" {
|
||||
command = "/bin/false"
|
||||
}
|
||||
`
|
||||
|
||||
func TestJobRunComplete(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
spec := writeJobSpec(t, trueJobSpec)
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"job", "run", spec})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("job run: %v", err)
|
||||
}
|
||||
if !strings.Contains(buf.String(), "Job complete") {
|
||||
t.Errorf("job run output unexpected: %s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobRunCompleteJSON(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
spec := writeJobSpec(t, trueJobSpec)
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"job", "run", spec, "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("job run --json: %v", err)
|
||||
}
|
||||
var result map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &result); err != nil {
|
||||
t.Fatalf("unmarshal job run json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if result["status"] != "complete" {
|
||||
t.Errorf("job run --json status = %v, want complete", result["status"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobRunFailed(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
spec := writeJobSpec(t, falseJobSpec)
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"job", "run", spec})
|
||||
if err := rootCmd.Execute(); err == nil {
|
||||
t.Fatal("expected error for failing job, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobRunFailedJSON(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
spec := writeJobSpec(t, falseJobSpec)
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"job", "run", spec, "--json"})
|
||||
if err := rootCmd.Execute(); err == nil {
|
||||
t.Fatal("expected error for failing job --json, got nil")
|
||||
}
|
||||
if !strings.Contains(buf.String(), "failed") {
|
||||
t.Errorf("job run --json failed output unexpected: %s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobRunMissingSpecFile(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"job", "run", "/nonexistent/spec.hcl"})
|
||||
if err := rootCmd.Execute(); err == nil {
|
||||
t.Fatal("expected error for missing spec file, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobListEmpty(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"job", "list"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("job list: %v", err)
|
||||
}
|
||||
if !strings.Contains(buf.String(), "No jobs") {
|
||||
t.Errorf("job list empty output unexpected: %s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobListJSONEmpty(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"job", "list", "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("job list --json: %v", err)
|
||||
}
|
||||
var jobs []map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &jobs); err != nil {
|
||||
t.Fatalf("unmarshal job list json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if len(jobs) != 0 {
|
||||
t.Errorf("job list --json empty = %d jobs, want 0", len(jobs))
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobListAfterRun(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
spec := writeJobSpec(t, trueJobSpec)
|
||||
resetRootFlags(t)
|
||||
rootCmd.SetArgs([]string{"job", "run", spec})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("job run: %v", err)
|
||||
}
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"job", "list"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("job list: %v", err)
|
||||
}
|
||||
out := buf.String()
|
||||
if !strings.Contains(out, "true") {
|
||||
t.Errorf("job list missing job name: %s", out)
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobStop(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
jobID := seedJob(t, "stopper", model.JobStatusRunning)
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"job", "stop", jobID})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("job stop: %v", err)
|
||||
}
|
||||
if !strings.Contains(buf.String(), "Job stopped") {
|
||||
t.Errorf("job stop output unexpected: %s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobStopJSON(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
jobID := seedJob(t, "jsonstopper", model.JobStatusRunning)
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"job", "stop", jobID, "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("job stop --json: %v", err)
|
||||
}
|
||||
var result map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &result); err != nil {
|
||||
t.Fatalf("unmarshal job stop json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if result["status"] != "stopped" {
|
||||
t.Errorf("job stop --json status = %v, want stopped", result["status"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobStopNotFound(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"job", "stop", "nonexistent-id"})
|
||||
if err := rootCmd.Execute(); err == nil {
|
||||
t.Fatal("expected error for job stop not found, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobStopMissingID(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"job", "stop"})
|
||||
if err := rootCmd.Execute(); err == nil {
|
||||
t.Fatal("expected error for job stop without id, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobLogsEmpty(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
jobID := seedJob(t, "logger", model.JobStatusComplete)
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"job", "logs", jobID})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("job logs: %v", err)
|
||||
}
|
||||
if !strings.Contains(buf.String(), "No tasks") {
|
||||
t.Errorf("job logs empty output unexpected: %s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobLogsJSONEmpty(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
jobID := seedJob(t, "jsonlogger", model.JobStatusComplete)
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"job", "logs", jobID, "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("job logs --json: %v", err)
|
||||
}
|
||||
var tasks []map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &tasks); err != nil {
|
||||
t.Fatalf("unmarshal job logs json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if len(tasks) != 0 {
|
||||
t.Errorf("job logs --json empty = %d tasks, want 0", len(tasks))
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobLogsMissingID(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"job", "logs"})
|
||||
if err := rootCmd.Execute(); err == nil {
|
||||
t.Fatal("expected error for job logs without id, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func seedJob(t *testing.T, name string, status model.JobStatus) string {
|
||||
t.Helper()
|
||||
db, err := store.Open(certpaths.DBPath())
|
||||
if err != nil {
|
||||
t.Fatalf("open db: %v", err)
|
||||
}
|
||||
defer db.Close()
|
||||
repo := store.NewJobRepo(db)
|
||||
j := &model.Job{
|
||||
ID: "job-" + name,
|
||||
Name: name,
|
||||
Spec: "spec.hcl",
|
||||
Status: status,
|
||||
}
|
||||
if err := repo.Insert(t.Context(), j); err != nil {
|
||||
t.Fatalf("insert job: %v", err)
|
||||
}
|
||||
return j.ID
|
||||
}
|
||||
@@ -18,6 +18,23 @@ func resetRootFlags(t *testing.T) {
|
||||
rootCmd.SetErr(&buf)
|
||||
_ = rootCmd.PersistentFlags().Set("system", "false")
|
||||
_ = rootCmd.PersistentFlags().Set("json", "false")
|
||||
_ = rootCmd.PersistentFlags().Set("no-deprecation-warnings", "false")
|
||||
resetCommandFlags()
|
||||
}
|
||||
|
||||
// resetCommandFlags zeroes the package-level flag-bound vars used by
|
||||
// individual subcommands so tests don't leak state between runs (cobra
|
||||
// parses into these globals; without a reset a prior test's value
|
||||
// persists). resetRootFlags calls this; tests that exercise a single
|
||||
// command without resetRootFlags may call it directly.
|
||||
func resetCommandFlags() {
|
||||
joinName, joinAddr, joinCAFinger, joinType = "", "", "", "localhost"
|
||||
joinHost, joinSSHUser, joinPassword, proxmoxUser, proxmoxRole = "", "root", "", "orca", "OrcaOperator"
|
||||
joinSSHPort, leaveID, nodeWatch = 22, "", false
|
||||
stopID, runTarget, runIDKey, jobWatch = "", "", "", false
|
||||
capSetCPU, capSetMem, capSetDisk, capNodeID = 0, 0, 0, ""
|
||||
auditLimit = 50
|
||||
resetNSFlags()
|
||||
}
|
||||
|
||||
func TestNamespaceDefaultsToUserHome(t *testing.T) {
|
||||
|
||||
+90
-19
@@ -45,18 +45,19 @@ func nodeRegistry() (*engine.NodeRegistry, func() error, error) {
|
||||
}
|
||||
|
||||
var (
|
||||
joinName string
|
||||
joinAddr string
|
||||
joinCAFinger string
|
||||
joinType string
|
||||
joinHost string
|
||||
joinSSHUser string
|
||||
joinPassword string
|
||||
joinSSHPort int
|
||||
proxmoxUser string
|
||||
proxmoxRole string
|
||||
leaveID string
|
||||
nodeWatch bool
|
||||
joinName string
|
||||
joinAddr string
|
||||
joinCAFinger string
|
||||
joinType string
|
||||
joinHost string
|
||||
joinSSHUser string
|
||||
joinPassword string
|
||||
joinSSHPort int
|
||||
joinHostKeyFP string
|
||||
proxmoxUser string
|
||||
proxmoxRole string
|
||||
leaveID string
|
||||
nodeWatch bool
|
||||
)
|
||||
|
||||
var nodeCmd = &cobra.Command{
|
||||
@@ -76,6 +77,9 @@ Node types (via --type):
|
||||
(deploys orca pubkey, creates orca user + PVE role +
|
||||
sudoers allowlist; requires --host + --password)`,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
if joinHostKeyFP != "" && joinType != "proxmox" {
|
||||
return fmt.Errorf("--host-key-fingerprint requires --type proxmox today")
|
||||
}
|
||||
if joinType == "proxmox" {
|
||||
return joinProxmox(cmd)
|
||||
}
|
||||
@@ -85,7 +89,13 @@ Node types (via --type):
|
||||
|
||||
// joinLocal is the existing localhost/Linux node join flow (fingerprint
|
||||
// check + registry.Insert).
|
||||
//
|
||||
// Deprecated: v0.9 re-architecture replaces daemon-to-daemon mTLS join
|
||||
// with SSH-push bootstrap (R-001). The mTLS join path is retained for
|
||||
// the dual-write window and scheduled for deletion in v0.10-P14. See
|
||||
// .ciagent/PRD_v0.9.md.
|
||||
func joinLocal(cmd *cobra.Command) error {
|
||||
warnDeprecated("orca node join (mTLS path): v0.9 R-001 replaces daemon-to-daemon mTLS join with SSH-push bootstrap; the mTLS join path is deprecated — see .ciagent/PRD_v0.9.md")
|
||||
if joinName == "" {
|
||||
return fmt.Errorf("--name is required")
|
||||
}
|
||||
@@ -156,13 +166,14 @@ func joinProxmox(cmd *cobra.Command) error {
|
||||
defer cancel()
|
||||
|
||||
result, err := proxmox.BootstrapProxmox(ctx, proxmox.Options{
|
||||
Host: joinHost,
|
||||
SSHUser: joinSSHUser,
|
||||
Password: password,
|
||||
ProxmoxUser: proxmoxUser,
|
||||
ProxmoxRole: proxmoxRole,
|
||||
SSHPort: joinSSHPort,
|
||||
Logger: newLogger(),
|
||||
Host: joinHost,
|
||||
SSHUser: joinSSHUser,
|
||||
Password: password,
|
||||
ProxmoxUser: proxmoxUser,
|
||||
ProxmoxRole: proxmoxRole,
|
||||
SSHPort: joinSSHPort,
|
||||
HostKeyFingerprint: joinHostKeyFP,
|
||||
Logger: newLogger(),
|
||||
})
|
||||
if err != nil {
|
||||
return fmt.Errorf("proxmox bootstrap: %w", err)
|
||||
@@ -341,6 +352,64 @@ func renderNodeTable(nodes []*model.Node) string {
|
||||
return out
|
||||
}
|
||||
|
||||
var nodeKeyResetCmd = &cobra.Command{
|
||||
Use: "key-reset <node>",
|
||||
Short: "Reset the SSH known_hosts entry for a node",
|
||||
Long: `Remove the pinned SSH host key for <node> from the local known_hosts
|
||||
file. The next connect re-pins the key via TOFU or --host-key-fingerprint.
|
||||
|
||||
LOCAL ONLY (D-046): does not touch the remote host's authorized_keys.
|
||||
|
||||
<node> is the node name (for proxmox nodes, this is the host address).`,
|
||||
Args: cobra.ExactArgs(1),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
nodeArg := args[0]
|
||||
|
||||
registry, closer, err := nodeRegistry()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer closer()
|
||||
|
||||
ctx, cancel := context.WithTimeout(cmd.Context(), 5*time.Second)
|
||||
defer cancel()
|
||||
|
||||
nodes, err := registry.List(ctx)
|
||||
if err != nil {
|
||||
return fmt.Errorf("list nodes: %w", err)
|
||||
}
|
||||
var node *model.Node
|
||||
for _, n := range nodes {
|
||||
if n.Name == nodeArg || n.ID == nodeArg {
|
||||
node = n
|
||||
break
|
||||
}
|
||||
}
|
||||
if node == nil {
|
||||
return fmt.Errorf("node %q not found in the registry", nodeArg)
|
||||
}
|
||||
host := node.Name
|
||||
|
||||
if err := proxmox.ResetHostKey(host); err != nil {
|
||||
return fmt.Errorf("reset host key: %w", err)
|
||||
}
|
||||
|
||||
// Audit-log the reset (REQ-059): actor=cli, action=node.key_reset.
|
||||
db, dbCloser, dbErr := openDB()
|
||||
if dbErr == nil {
|
||||
defer dbCloser()
|
||||
audit := engine.NewAudit(store.NewAuditRepo(db), newLogger())
|
||||
audit.Record(ctx, "cli", "node.key_reset", node.ID, "success", nil, map[string]any{
|
||||
"node": node.Name,
|
||||
"host": host,
|
||||
})
|
||||
}
|
||||
|
||||
fmt.Fprintf(cmd.OutOrStdout(), "✓ Host key reset for %s (next connect will re-pin via TOFU or --host-key-fingerprint)\n", node.Name)
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
func init() {
|
||||
nodeJoinCmd.Flags().StringVar(&joinName, "name", "", "node name (required for --type localhost)")
|
||||
nodeJoinCmd.Flags().StringVar(&joinAddr, "addr", "", "node address (default localhost:8443)")
|
||||
@@ -352,11 +421,13 @@ func init() {
|
||||
nodeJoinCmd.Flags().IntVar(&joinSSHPort, "ssh-port", 22, "SSH port for proxmox bootstrap (default 22)")
|
||||
nodeJoinCmd.Flags().StringVar(&proxmoxUser, "proxmox-user", "orca", "Linux system user to create on the proxmox host (config-overridable)")
|
||||
nodeJoinCmd.Flags().StringVar(&proxmoxRole, "proxmox-role", "OrcaOperator", "PVE custom role to create (config-overridable)")
|
||||
nodeJoinCmd.Flags().StringVar(&joinHostKeyFP, "host-key-fingerprint", "", "SSH host key SHA256:base64 fingerprint (pre-pin; supersedes TOFU for --type proxmox)")
|
||||
nodeLeaveCmd.Flags().StringVar(&leaveID, "id", "", "node id")
|
||||
nodeListCmd.Flags().BoolVar(&nodeWatch, "watch", false, "stream nodes until Ctrl-C (table refresh or --json per-event)")
|
||||
|
||||
nodeCmd.AddCommand(nodeJoinCmd)
|
||||
nodeCmd.AddCommand(nodeLeaveCmd)
|
||||
nodeCmd.AddCommand(nodeListCmd)
|
||||
nodeCmd.AddCommand(nodeKeyResetCmd)
|
||||
rootCmd.AddCommand(nodeCmd)
|
||||
}
|
||||
|
||||
@@ -0,0 +1,194 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/certpaths"
|
||||
"git.cloudinit.dev/coreci/orca/internal/store"
|
||||
)
|
||||
|
||||
func TestNodeCapacitySetMissingArgs(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "capacity", "set", "--cpu", "1000"})
|
||||
if err := rootCmd.Execute(); err == nil {
|
||||
t.Fatal("expected error for capacity set missing memory/disk, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeCapacitySet(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "capacity", "set", "--cpu", "2000", "--memory", "4096", "--disk", "51200"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("capacity set: %v", err)
|
||||
}
|
||||
if !strings.Contains(buf.String(), "Capacity set") {
|
||||
t.Errorf("capacity set output unexpected: %s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeCapacitySetJSON(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "capacity", "set", "--cpu", "3000", "--memory", "8192", "--disk", "102400", "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("capacity set --json: %v", err)
|
||||
}
|
||||
var c map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &c); err != nil {
|
||||
t.Fatalf("unmarshal capacity set json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if c["NodeID"] != "self" {
|
||||
t.Errorf("capacity set --json NodeID = %v, want self", c["NodeID"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeCapacityShowNotFound(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "capacity", "show", "missing-node"})
|
||||
if err := rootCmd.Execute(); err == nil {
|
||||
t.Fatal("expected error for capacity show missing node, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeCapacityShowAfterSet(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
seedCapacity(t, "show-node", 4000, 4096, 51200)
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "capacity", "show", "show-node"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("capacity show: %v", err)
|
||||
}
|
||||
out := buf.String()
|
||||
if !strings.Contains(out, "show-node") {
|
||||
t.Errorf("capacity show missing node id: %s", out)
|
||||
}
|
||||
if !strings.Contains(out, "4000") {
|
||||
t.Errorf("capacity show missing cpu: %s", out)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeCapacityShowJSON(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
seedCapacity(t, "jsonshow-node", 4000, 4096, 51200)
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "capacity", "show", "jsonshow-node", "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("capacity show --json: %v", err)
|
||||
}
|
||||
var c map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &c); err != nil {
|
||||
t.Fatalf("unmarshal capacity show json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if c["NodeID"] != "jsonshow-node" {
|
||||
t.Errorf("capacity show --json NodeID = %v, want jsonshow-node", c["NodeID"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeCapacityListEmpty(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "capacity", "list"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("capacity list: %v", err)
|
||||
}
|
||||
if !strings.Contains(buf.String(), "No capacity") {
|
||||
t.Errorf("capacity list empty output unexpected: %s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeCapacityListAfterSet(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
seedCapacity(t, "list-node", 5000, 4096, 51200)
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "capacity", "list"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("capacity list: %v", err)
|
||||
}
|
||||
if !strings.Contains(buf.String(), "list-node") {
|
||||
t.Errorf("capacity list missing node: %s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeCapacityListJSON(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
seedCapacity(t, "jsonlist-node", 5000, 4096, 51200)
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "capacity", "list", "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("capacity list --json: %v", err)
|
||||
}
|
||||
var rows []map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &rows); err != nil {
|
||||
t.Fatalf("unmarshal capacity list json: %v\n%s", err, buf.String())
|
||||
}
|
||||
found := false
|
||||
for _, r := range rows {
|
||||
if r["NodeID"] == "jsonlist-node" {
|
||||
found = true
|
||||
}
|
||||
}
|
||||
if !found {
|
||||
t.Errorf("capacity list --json missing jsonlist-node: %s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func seedCapacity(t *testing.T, nodeID string, cpu, mem, disk int64) {
|
||||
t.Helper()
|
||||
db, err := store.Open(certpaths.DBPath())
|
||||
if err != nil {
|
||||
t.Fatalf("open db: %v", err)
|
||||
}
|
||||
defer db.Close()
|
||||
repo := store.NewCapacityRepo(db)
|
||||
c := &store.NodeCapacity{
|
||||
NodeID: nodeID,
|
||||
CPUMillicores: cpu,
|
||||
MemoryMiB: mem,
|
||||
DiskMiB: disk,
|
||||
}
|
||||
if err := repo.Upsert(t.Context(), c); err != nil {
|
||||
t.Fatalf("upsert capacity: %v", err)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,496 @@
|
||||
// This file tests the `orca node` subcommand family (join/leave/list,
|
||||
// capacity is covered in node_capacity_test.go). Tests execute rootCmd
|
||||
// against a temp ORCA_HOME and assert stdout/stderr/exit per RESEARCH
|
||||
// §1.2.
|
||||
//
|
||||
// daemon.go is EXCLUDED from the cli ≥70% coverage target: the daemon
|
||||
// command starts a long-running mTLS server whose lifecycle is better
|
||||
// covered by internal/daemon/server_test.go (already 150 LOC). The
|
||||
// --pprof flag registration is verified in daemon_test.go.
|
||||
package cli
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/certpaths"
|
||||
"git.cloudinit.dev/coreci/orca/internal/model"
|
||||
"git.cloudinit.dev/coreci/orca/internal/security"
|
||||
"git.cloudinit.dev/coreci/orca/internal/store"
|
||||
)
|
||||
|
||||
func TestNodeJoinLocalText(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "join", "--name", "worker-1", "--addr", "10.0.0.5:8443"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("node join: %v", err)
|
||||
}
|
||||
out := buf.String()
|
||||
if !strings.Contains(out, "Node joined") {
|
||||
t.Errorf("node join output unexpected: %s", out)
|
||||
}
|
||||
if !strings.Contains(out, "worker-1") {
|
||||
t.Errorf("node join output missing name: %s", out)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeJoinLocalJSON(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "join", "--name", "worker-2", "--addr", "10.0.0.6:8443", "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("node join --json: %v", err)
|
||||
}
|
||||
var node map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &node); err != nil {
|
||||
t.Fatalf("unmarshal node json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if node["name"] != "worker-2" {
|
||||
t.Errorf("node join --json name = %v, want worker-2", node["name"])
|
||||
}
|
||||
if node["address"] != "10.0.0.6:8443" {
|
||||
t.Errorf("node join --json address = %v, want 10.0.0.6:8443", node["address"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeJoinMissingName(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "join"})
|
||||
if err := rootCmd.Execute(); err == nil {
|
||||
t.Fatal("expected error for missing --name, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeJoinDefaultAddr(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "join", "--name", "defaulter", "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("node join: %v", err)
|
||||
}
|
||||
var node map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &node); err != nil {
|
||||
t.Fatalf("unmarshal node json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if node["address"] != "localhost:8443" {
|
||||
t.Errorf("node join default addr = %v, want localhost:8443", node["address"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeJoinCAFingerprintMatch(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
if err := runInit(discardWriter{}); err != nil {
|
||||
t.Fatalf("init: %v", err)
|
||||
}
|
||||
fp, err := security.Fingerprint(certpaths.CACertPath())
|
||||
if err != nil {
|
||||
t.Fatalf("fingerprint: %v", err)
|
||||
}
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "join", "--name", "pinned", "--ca-fingerprint", fp, "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("node join with matching fingerprint: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeJoinCAFingerprintMismatch(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "join", "--name", "badpin", "--ca-fingerprint", padHex(64)})
|
||||
if err := rootCmd.Execute(); err == nil {
|
||||
t.Fatal("expected error for CA fingerprint mismatch, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeJoinCAFingerprintNoCA(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "join", "--name", "noca", "--ca-fingerprint", padHex(64)})
|
||||
if err := rootCmd.Execute(); err == nil {
|
||||
t.Fatal("expected error for missing CA with --ca-fingerprint, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeJoinProxmoxMissingHost(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "join", "--type", "proxmox", "--password", "x"})
|
||||
if err := rootCmd.Execute(); err == nil {
|
||||
t.Fatal("expected error for proxmox without --host, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeJoinProxmoxMissingPassword(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "join", "--type", "proxmox", "--host", "10.0.0.99"})
|
||||
if err := rootCmd.Execute(); err == nil {
|
||||
t.Fatal("expected error for proxmox without password, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeListEmpty(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "list"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("node list: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeListAfterJoin(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
rootCmd.SetArgs([]string{"node", "join", "--name", "lister", "--addr", "10.0.0.7:8443"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("node join: %v", err)
|
||||
}
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "list"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("node list: %v", err)
|
||||
}
|
||||
out := buf.String()
|
||||
if !strings.Contains(out, "lister") {
|
||||
t.Errorf("node list missing joined node: %s", out)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeListJSON(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
rootCmd.SetArgs([]string{"node", "join", "--name", "jsonlister", "--addr", "10.0.0.8:8443"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("node join: %v", err)
|
||||
}
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "list", "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("node list --json: %v", err)
|
||||
}
|
||||
var nodes []map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &nodes); err != nil {
|
||||
t.Fatalf("unmarshal node list json: %v\n%s", err, buf.String())
|
||||
}
|
||||
found := false
|
||||
for _, n := range nodes {
|
||||
if n["name"] == "jsonlister" {
|
||||
found = true
|
||||
}
|
||||
}
|
||||
if !found {
|
||||
t.Errorf("node list --json missing jsonlister: %s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeLeave(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
nodeID := seedNode(t, "leaver", "10.0.0.9:8443")
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "leave", nodeID})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("node leave: %v", err)
|
||||
}
|
||||
if !strings.Contains(buf.String(), "Node left") {
|
||||
t.Errorf("node leave output unexpected: %s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeLeaveJSON(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
nodeID := seedNode(t, "jsonleaver", "10.0.0.10:8443")
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "leave", nodeID, "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("node leave --json: %v", err)
|
||||
}
|
||||
var result map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &result); err != nil {
|
||||
t.Fatalf("unmarshal node leave json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if result["state"] != "left" {
|
||||
t.Errorf("node leave --json state = %v, want left", result["state"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeLeaveMissingID(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "leave"})
|
||||
if err := rootCmd.Execute(); err == nil {
|
||||
t.Fatal("expected error for node leave without id, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func seedNode(t *testing.T, name, addr string) string {
|
||||
t.Helper()
|
||||
db, err := store.Open(certpaths.DBPath())
|
||||
if err != nil {
|
||||
t.Fatalf("open db: %v", err)
|
||||
}
|
||||
defer db.Close()
|
||||
repo := store.NewNodeRepo(db)
|
||||
ctx := context.Background()
|
||||
n := &model.Node{
|
||||
ID: "node-" + name,
|
||||
Name: name,
|
||||
Address: addr,
|
||||
State: model.NodeStateReady,
|
||||
JoinedAt: time.Now().UTC(),
|
||||
LastSeen: time.Now().UTC(),
|
||||
}
|
||||
if err := repo.Insert(ctx, n); err != nil {
|
||||
t.Fatalf("insert node: %v", err)
|
||||
}
|
||||
return n.ID
|
||||
}
|
||||
|
||||
func padHex(n int) string {
|
||||
b := make([]byte, n)
|
||||
for i := range b {
|
||||
b[i] = 'a'
|
||||
}
|
||||
return string(b)
|
||||
}
|
||||
|
||||
// TestNodeKeyReset removes the target node's known_hosts lines, leaves
|
||||
// other hosts' lines intact, and inserts an audit row (T02.8, REQ-059).
|
||||
func TestNodeKeyReset(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
|
||||
// Seed a proxmox node whose Name is the host address (matches the
|
||||
// key-reset RunE, which uses node.Name as the known_hosts match key).
|
||||
seedProxmoxNode(t, "10.0.0.1", "10.0.0.1:8443")
|
||||
|
||||
// Pre-populate known_hosts: 2 lines for the target + 1 for another host.
|
||||
knownHosts := certpaths.KnownHostsPath()
|
||||
if err := os.MkdirAll(filepath.Dir(knownHosts), 0o755); err != nil {
|
||||
t.Fatalf("mkdir known_hosts dir: %v", err)
|
||||
}
|
||||
original := []byte("[10.0.0.1]:22 ssh-ed25519 AAAAKEY1 host1\n" +
|
||||
"10.0.0.1 ssh-ed25519 AAAAKEY1ALT host1-alt\n" +
|
||||
"[10.0.0.2]:22 ssh-ed25519 AAAAKEY2 host2\n")
|
||||
if err := os.WriteFile(knownHosts, original, 0o600); err != nil {
|
||||
t.Fatalf("write known_hosts: %v", err)
|
||||
}
|
||||
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "key-reset", "10.0.0.1"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("node key-reset: %v", err)
|
||||
}
|
||||
out := buf.String()
|
||||
if !strings.Contains(out, "Host key reset for 10.0.0.1") {
|
||||
t.Errorf("output missing reset confirmation: %s", out)
|
||||
}
|
||||
|
||||
// known_hosts: target's 2 lines removed, other host's line intact.
|
||||
data, err := os.ReadFile(knownHosts)
|
||||
if err != nil {
|
||||
t.Fatalf("read known_hosts: %v", err)
|
||||
}
|
||||
result := string(data)
|
||||
if strings.Contains(result, "AAAAKEY1") {
|
||||
t.Errorf("target key line 1 not removed: %s", result)
|
||||
}
|
||||
if strings.Contains(result, "AAAAKEY1ALT") {
|
||||
t.Errorf("target key line 2 not removed: %s", result)
|
||||
}
|
||||
if !strings.Contains(result, "AAAAKEY2") {
|
||||
t.Errorf("other host's line was removed (should be intact): %s", result)
|
||||
}
|
||||
|
||||
// Audit row inserted with action=node.key_reset.
|
||||
db, err := store.Open(certpaths.DBPath())
|
||||
if err != nil {
|
||||
t.Fatalf("open db: %v", err)
|
||||
}
|
||||
defer db.Close()
|
||||
entries, err := store.NewAuditRepo(db).List(context.Background(), 50)
|
||||
if err != nil {
|
||||
t.Fatalf("list audit: %v", err)
|
||||
}
|
||||
found := false
|
||||
for _, e := range entries {
|
||||
if e.Action == "node.key_reset" && strings.Contains(e.Resource, "10.0.0.1") {
|
||||
found = true
|
||||
break
|
||||
}
|
||||
}
|
||||
if !found {
|
||||
t.Errorf("audit row for node.key_reset not inserted: %+v", entries)
|
||||
}
|
||||
}
|
||||
|
||||
// TestNodeKeyReset_NodeNotFound verifies key-reset errors when the
|
||||
// node is not in the registry (T02.8).
|
||||
func TestNodeKeyReset_NodeNotFound(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"node", "key-reset", "no.such.host"})
|
||||
err := rootCmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected error for unknown node, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "not found") {
|
||||
t.Errorf("error should mention not found, got: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func seedProxmoxNode(t *testing.T, name, addr string) string {
|
||||
t.Helper()
|
||||
db, err := store.Open(certpaths.DBPath())
|
||||
if err != nil {
|
||||
t.Fatalf("open db: %v", err)
|
||||
}
|
||||
defer db.Close()
|
||||
repo := store.NewNodeRepo(db)
|
||||
ctx := context.Background()
|
||||
n := &model.Node{
|
||||
ID: "node-" + name,
|
||||
Name: name,
|
||||
Address: addr,
|
||||
State: model.NodeStateReady,
|
||||
JoinedAt: time.Now().UTC(),
|
||||
LastSeen: time.Now().UTC(),
|
||||
Kind: string(model.NodeKindProxmox),
|
||||
OS: "pve",
|
||||
}
|
||||
if err := repo.Insert(ctx, n); err != nil {
|
||||
t.Fatalf("insert proxmox node: %v", err)
|
||||
}
|
||||
return n.ID
|
||||
}
|
||||
|
||||
// TestNodeJoinHostKeyFingerprintRequiresProxmox verifies T02.11:
|
||||
// `orca node join --type linux --host-key-fingerprint SHA256:...`
|
||||
// fails with a clear error from the D-044 RunE check. Exercises the
|
||||
// cobra Execute() error path end-to-end.
|
||||
func TestNodeJoinHostKeyFingerprintRequiresProxmox(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{
|
||||
"node", "join",
|
||||
"--type", "linux",
|
||||
"--name", "linux-node",
|
||||
"--host-key-fingerprint", "SHA256:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=",
|
||||
})
|
||||
err := rootCmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected error for --host-key-fingerprint without --type proxmox, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "--host-key-fingerprint requires --type proxmox") {
|
||||
t.Errorf("error should mention the --host-key-fingerprint/--type proxmox requirement, got: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// TestNodeJoinHostKeyFingerprintProxmoxAccepted verifies that
|
||||
// --host-key-fingerprint IS accepted for --type proxmox (the RunE check
|
||||
// does not reject a proxmox-type join that pins the host key). This is
|
||||
// the negative-space companion to TestNodeJoinHostKeyFingerprintRequiresProxmox
|
||||
// (T02.11): the validation must only reject non-proxmox types.
|
||||
//
|
||||
// We can't run the full bootstrap without a real SSH server, so we
|
||||
// assert that the RunE check passes (no "requires --type proxmox"
|
||||
// error) and the failure — if any — comes from a later stage (missing
|
||||
// --host / password), not the D-044 guard.
|
||||
func TestNodeJoinHostKeyFingerprintProxmoxAccepted(t *testing.T) {
|
||||
_, cleanup := initTestEnv(t)
|
||||
defer cleanup()
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{
|
||||
"node", "join",
|
||||
"--type", "proxmox",
|
||||
"--host-key-fingerprint", "SHA256:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=",
|
||||
})
|
||||
err := rootCmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected a later-stage error (missing --host), got nil")
|
||||
}
|
||||
if strings.Contains(err.Error(), "requires --type proxmox") {
|
||||
t.Errorf("D-044 guard wrongly rejected proxmox type: %v", err)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,338 @@
|
||||
// Package cli: ns.go implements the `orca ns` subcommand family
|
||||
// (REQ-082, D-176). Subcommands:
|
||||
//
|
||||
// orca ns list — list all namespaces under ORCA_HOME
|
||||
// orca ns create <name> — create a namespace dir + ns.md
|
||||
// orca ns delete <name> — remove an empty namespace dir
|
||||
// orca ns inspect <name> — print effective chain + merged env
|
||||
// orca ns validate <name> — cycle + missing-parent + schema checks
|
||||
//
|
||||
// All subcommands honor $ORCA_HOME via internal/paths. The inheritance
|
||||
// resolver (internal/ns) is a pure function shared by inspect + validate.
|
||||
package cli
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/ns"
|
||||
"git.cloudinit.dev/coreci/orca/internal/paths"
|
||||
)
|
||||
|
||||
var nsCmd = &cobra.Command{
|
||||
Use: "ns",
|
||||
Short: "Manage orca namespaces",
|
||||
Long: `Manage orca namespaces under ORCA_HOME (R-002).
|
||||
|
||||
Each namespace is a directory with ns.md, .env, .env.secrets, db/,
|
||||
jobs/, alloc/. The implicit root namespace _defaults always exists
|
||||
(D-159); every namespace inherits from _defaults (D-185) and cannot
|
||||
opt out (D-187).`,
|
||||
}
|
||||
|
||||
var (
|
||||
nsCreateParent string
|
||||
nsCreateInheritsEnv bool
|
||||
nsCreateInheritsSecret bool
|
||||
)
|
||||
|
||||
var nsListCmd = &cobra.Command{
|
||||
Use: "list",
|
||||
Short: "List all namespaces under ORCA_HOME",
|
||||
Long: `List all namespaces under ORCA_HOME (directories containing ns.md, plus the implicit _defaults).`,
|
||||
Args: cobra.NoArgs,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
root := paths.Root()
|
||||
entries, err := os.ReadDir(root)
|
||||
if err != nil {
|
||||
return fmt.Errorf("read ORCA_HOME %s: %w", root, err)
|
||||
}
|
||||
type nsRow struct {
|
||||
Name string `json:"name"`
|
||||
Path string `json:"path"`
|
||||
Default bool `json:"default"`
|
||||
}
|
||||
var rows []nsRow
|
||||
for _, ent := range entries {
|
||||
if !ent.IsDir() {
|
||||
continue
|
||||
}
|
||||
if ent.Name() == "cluster" {
|
||||
continue
|
||||
}
|
||||
nsMd := filepath.Join(root, ent.Name(), "ns.md")
|
||||
if _, err := os.Stat(nsMd); err != nil {
|
||||
continue
|
||||
}
|
||||
rows = append(rows, nsRow{
|
||||
Name: ent.Name(),
|
||||
Path: filepath.Join(root, ent.Name()),
|
||||
Default: ent.Name() == paths.DefaultNamespace(),
|
||||
})
|
||||
}
|
||||
sort.Slice(rows, func(i, j int) bool {
|
||||
if rows[i].Name == paths.DefaultNamespace() {
|
||||
return true
|
||||
}
|
||||
if rows[j].Name == paths.DefaultNamespace() {
|
||||
return false
|
||||
}
|
||||
return rows[i].Name < rows[j].Name
|
||||
})
|
||||
if jsonOutput {
|
||||
return printJSON(rows)
|
||||
}
|
||||
if len(rows) == 0 {
|
||||
fmt.Fprintln(cmd.OutOrStdout(), "No namespaces found. Run 'orca init' first.")
|
||||
return nil
|
||||
}
|
||||
fmt.Fprintf(cmd.OutOrStdout(), "%-20s %-10s %s\n", "NAME", "DEFAULT", "PATH")
|
||||
for _, r := range rows {
|
||||
def := ""
|
||||
if r.Default {
|
||||
def = "*"
|
||||
}
|
||||
fmt.Fprintf(cmd.OutOrStdout(), "%-20s %-10s %s\n", r.Name, def, r.Path)
|
||||
}
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
var nsCreateCmd = &cobra.Command{
|
||||
Use: "create <name>",
|
||||
Short: "Create a namespace directory + ns.md",
|
||||
Long: `Create a namespace under ORCA_HOME. Builds the dir structure
|
||||
(db/, jobs/, alloc/) and writes ns.md frontmatter. --parent may be
|
||||
repeated to declare inheritance; _defaults is always appended last.`,
|
||||
Args: cobra.ExactArgs(1),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
name := args[0]
|
||||
if name == paths.DefaultNamespace() {
|
||||
return fmt.Errorf("cannot create the implicit root namespace %q with `ns create` (it is auto-managed)", name)
|
||||
}
|
||||
if name == "cluster" {
|
||||
return fmt.Errorf("name %q is reserved for the cluster-wide dir", name)
|
||||
}
|
||||
if nsCreateParent == "" {
|
||||
nsCreateParent = paths.DefaultNamespace()
|
||||
}
|
||||
nsDir := paths.NamespaceDir(name)
|
||||
if _, err := os.Stat(nsDir); err == nil {
|
||||
if _, statErr := os.Stat(paths.NSMd(name)); statErr == nil {
|
||||
return fmt.Errorf("namespace %q already exists at %s", name, nsDir)
|
||||
}
|
||||
}
|
||||
for _, sub := range []string{"db", "jobs", "alloc"} {
|
||||
if err := os.MkdirAll(filepath.Join(nsDir, sub), 0o755); err != nil {
|
||||
return fmt.Errorf("create %s/%s: %w", nsDir, sub, err)
|
||||
}
|
||||
}
|
||||
parents := []string{nsCreateParent}
|
||||
if nsCreateParent == paths.DefaultNamespace() {
|
||||
// Explicit _defaults listing is allowed (de-duped silently).
|
||||
}
|
||||
body := renderNSMd(name, parents, nsCreateInheritsEnv, nsCreateInheritsSecret)
|
||||
if err := os.WriteFile(paths.NSMd(name), []byte(body), 0o644); err != nil {
|
||||
return fmt.Errorf("write ns.md: %w", err)
|
||||
}
|
||||
if jsonOutput {
|
||||
return printJSON(map[string]any{
|
||||
"name": name,
|
||||
"path": nsDir,
|
||||
"parents": parents,
|
||||
"ns_md": paths.NSMd(name),
|
||||
"inherits_env": nsCreateInheritsEnv,
|
||||
"inherits_secrets": nsCreateInheritsSecret,
|
||||
})
|
||||
}
|
||||
fmt.Fprintf(cmd.OutOrStdout(), "✓ Namespace created: %s (%s)\n", name, nsDir)
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
var nsDeleteCmd = &cobra.Command{
|
||||
Use: "delete <name>",
|
||||
Short: "Remove an empty namespace directory",
|
||||
Long: `Remove a namespace directory. Refuses if jobs/ or alloc/
|
||||
contain any files (non-empty namespace). The implicit root _defaults
|
||||
cannot be deleted.`,
|
||||
Args: cobra.ExactArgs(1),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
name := args[0]
|
||||
if name == paths.DefaultNamespace() {
|
||||
return fmt.Errorf("cannot delete the implicit root namespace %q", name)
|
||||
}
|
||||
nsDir := paths.NamespaceDir(name)
|
||||
if _, err := os.Stat(nsDir); err != nil {
|
||||
return fmt.Errorf("namespace %q not found: %w", name, err)
|
||||
}
|
||||
for _, sub := range []string{"jobs", "alloc"} {
|
||||
dir := filepath.Join(nsDir, sub)
|
||||
if err := dirNonEmpty(dir); err != nil {
|
||||
return fmt.Errorf("refusing to delete %q: %s is non-empty (%w); clear it first", name, sub, err)
|
||||
}
|
||||
}
|
||||
if err := os.RemoveAll(nsDir); err != nil {
|
||||
return fmt.Errorf("delete %s: %w", nsDir, err)
|
||||
}
|
||||
if jsonOutput {
|
||||
return printJSON(map[string]string{"name": name, "deleted": nsDir})
|
||||
}
|
||||
fmt.Fprintf(cmd.OutOrStdout(), "✓ Namespace deleted: %s (%s)\n", name, nsDir)
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
var nsInspectCmd = &cobra.Command{
|
||||
Use: "inspect <name>",
|
||||
Short: "Print the effective chain, merged env, and constraints",
|
||||
Long: `Resolve a namespace's inheritance chain and print the merged env and unioned constraints (uses the resolver).`,
|
||||
Args: cobra.ExactArgs(1),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
name := args[0]
|
||||
root := paths.Root()
|
||||
cfgs, err := ns.ParseNSMdDir(root)
|
||||
if err != nil {
|
||||
return fmt.Errorf("load namespaces: %w", err)
|
||||
}
|
||||
if _, ok := cfgs[name]; !ok {
|
||||
return fmt.Errorf("namespace %q not found under %s", name, root)
|
||||
}
|
||||
resolved, err := ns.Resolve(cfgs)
|
||||
if err != nil {
|
||||
return fmt.Errorf("resolve: %w", err)
|
||||
}
|
||||
r := resolved[name]
|
||||
if r == nil {
|
||||
return fmt.Errorf("namespace %q resolved to nil", name)
|
||||
}
|
||||
if jsonOutput {
|
||||
return printJSON(map[string]any{
|
||||
"name": r.Name,
|
||||
"chain": r.Chain,
|
||||
"env": r.Env,
|
||||
"constraints": r.Constraints,
|
||||
})
|
||||
}
|
||||
fmt.Fprintf(cmd.OutOrStdout(), "Namespace: %s\n", r.Name)
|
||||
fmt.Fprintf(cmd.OutOrStdout(), "Chain: %s\n", strings.Join(r.Chain, " -> "))
|
||||
fmt.Fprintln(cmd.OutOrStdout(), "Env:")
|
||||
keys := sortedKeys(r.Env)
|
||||
for _, k := range keys {
|
||||
fmt.Fprintf(cmd.OutOrStdout(), " %s = %s\n", k, r.Env[k])
|
||||
}
|
||||
fmt.Fprintln(cmd.OutOrStdout(), "Constraints:")
|
||||
if len(r.Constraints) == 0 {
|
||||
fmt.Fprintln(cmd.OutOrStdout(), " (none)")
|
||||
} else {
|
||||
for _, c := range r.Constraints {
|
||||
fmt.Fprintf(cmd.OutOrStdout(), " - %s\n", c)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
var nsValidateCmd = &cobra.Command{
|
||||
Use: "validate <name>",
|
||||
Short: "Run cycle + missing-parent + schema checks on a namespace",
|
||||
Long: `Validate a namespace's inheritance chain and ns.md frontmatter.
|
||||
Exits 0 if valid, 1 on error. Runs over ALL namespaces under ORCA_HOME
|
||||
(parsing + resolving validates cycles and missing parents across the
|
||||
set).`,
|
||||
Args: cobra.ExactArgs(1),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
name := args[0]
|
||||
root := paths.Root()
|
||||
cfgs, err := ns.ParseNSMdDir(root)
|
||||
if err != nil {
|
||||
return fmt.Errorf("load namespaces: %w", err)
|
||||
}
|
||||
if _, ok := cfgs[name]; !ok {
|
||||
return fmt.Errorf("namespace %q not found under %s", name, root)
|
||||
}
|
||||
resolved, err := ns.Resolve(cfgs)
|
||||
if err != nil {
|
||||
return fmt.Errorf("validate: %w", err)
|
||||
}
|
||||
r := resolved[name]
|
||||
if r == nil {
|
||||
return fmt.Errorf("namespace %q resolved to nil", name)
|
||||
}
|
||||
if jsonOutput {
|
||||
return printJSON(map[string]any{
|
||||
"name": r.Name,
|
||||
"valid": true,
|
||||
"chain": r.Chain,
|
||||
})
|
||||
}
|
||||
fmt.Fprintf(cmd.OutOrStdout(), "✓ %s valid\n chain: %s\n", name, strings.Join(r.Chain, " -> "))
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
// renderNSMd writes a minimal ns.md frontmatter for `orca ns create`.
|
||||
func renderNSMd(name string, parents []string, inheritsEnv, inheritsSecrets bool) string {
|
||||
var b strings.Builder
|
||||
b.WriteString("---\n")
|
||||
b.WriteString("kind: Namespace\n")
|
||||
b.WriteString("name: ")
|
||||
b.WriteString(name)
|
||||
b.WriteString("\n")
|
||||
if len(parents) > 0 {
|
||||
quoted := make([]string, len(parents))
|
||||
for i, p := range parents {
|
||||
quoted[i] = fmt.Sprintf("%q", p)
|
||||
}
|
||||
b.WriteString("parents: [")
|
||||
b.WriteString(strings.Join(quoted, ", "))
|
||||
b.WriteString("]\n")
|
||||
}
|
||||
fmt.Fprintf(&b, "inherits_env: %t\n", inheritsEnv)
|
||||
fmt.Fprintf(&b, "inherits_secrets: %t\n", inheritsSecrets)
|
||||
b.WriteString("---\n")
|
||||
return b.String()
|
||||
}
|
||||
|
||||
// dirNonEmpty returns an error wrapping the offending entry if dir
|
||||
// contains any entries.
|
||||
func dirNonEmpty(dir string) error {
|
||||
entries, err := os.ReadDir(dir)
|
||||
if err != nil {
|
||||
if os.IsNotExist(err) {
|
||||
return nil
|
||||
}
|
||||
return err
|
||||
}
|
||||
for _, e := range entries {
|
||||
return fmt.Errorf("contains %s", e.Name())
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func sortedKeys(m map[string]string) []string {
|
||||
out := make([]string, 0, len(m))
|
||||
for k := range m {
|
||||
out = append(out, k)
|
||||
}
|
||||
sort.Strings(out)
|
||||
return out
|
||||
}
|
||||
|
||||
func init() {
|
||||
nsCreateCmd.Flags().StringVar(&nsCreateParent, "parent", "", "parent namespace (default _defaults; the implicit root is always appended last)")
|
||||
nsCreateCmd.Flags().BoolVar(&nsCreateInheritsEnv, "inherits-env", true, "inherit env from parents (default true)")
|
||||
nsCreateCmd.Flags().BoolVar(&nsCreateInheritsSecret, "inherits-secrets", true, "inherit secrets from parents (default true)")
|
||||
|
||||
nsCmd.AddCommand(nsListCmd)
|
||||
nsCmd.AddCommand(nsCreateCmd)
|
||||
nsCmd.AddCommand(nsDeleteCmd)
|
||||
nsCmd.AddCommand(nsInspectCmd)
|
||||
nsCmd.AddCommand(nsValidateCmd)
|
||||
rootCmd.AddCommand(nsCmd)
|
||||
}
|
||||
@@ -0,0 +1,407 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/paths"
|
||||
)
|
||||
|
||||
// resetNSFlags zeroes the ns subcommand flag-bound vars so tests don't
|
||||
// leak state.
|
||||
func resetNSFlags() {
|
||||
nsCreateParent = ""
|
||||
nsCreateInheritsEnv = true
|
||||
nsCreateInheritsSecret = true
|
||||
}
|
||||
|
||||
func writeDefaultsNS(t *testing.T, root string) {
|
||||
t.Helper()
|
||||
nsDir := filepath.Join(root, "_defaults")
|
||||
if err := os.MkdirAll(nsDir, 0o755); err != nil {
|
||||
t.Fatalf("mkdir _defaults: %v", err)
|
||||
}
|
||||
body := "---\nkind: Namespace\nname: _defaults\ninherits_env: true\ninherits_secrets: true\n---\n# defaults\n"
|
||||
if err := os.WriteFile(filepath.Join(nsDir, "ns.md"), []byte(body), 0o644); err != nil {
|
||||
t.Fatalf("write _defaults ns.md: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func writeCustomNS(t *testing.T, root, name, parentsList string) {
|
||||
t.Helper()
|
||||
nsDir := filepath.Join(root, name)
|
||||
if err := os.MkdirAll(nsDir, 0o755); err != nil {
|
||||
t.Fatalf("mkdir %s: %v", name, err)
|
||||
}
|
||||
body := "---\nkind: Namespace\nname: " + name + "\n"
|
||||
if parentsList != "" {
|
||||
body += "parents: " + parentsList + "\n"
|
||||
}
|
||||
body += "inherits_env: true\ninherits_secrets: true\n---\n# " + name + "\n"
|
||||
if err := os.WriteFile(filepath.Join(nsDir, "ns.md"), []byte(body), 0o644); err != nil {
|
||||
t.Fatalf("write %s ns.md: %v", name, err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSListEmpty(t *testing.T) {
|
||||
t.Setenv("ORCA_HOME", t.TempDir())
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "list"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("ns list: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSListWithNamespaces(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
writeDefaultsNS(t, root)
|
||||
writeCustomNS(t, root, "prod", "")
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "list"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("ns list: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSCreateHappy(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "create", "prod"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("ns create: %v", err)
|
||||
}
|
||||
if _, err := os.Stat(filepath.Join(root, "prod", "ns.md")); err != nil {
|
||||
t.Fatalf("ns.md not created: %v", err)
|
||||
}
|
||||
for _, sub := range []string{"db", "jobs", "alloc"} {
|
||||
if _, err := os.Stat(filepath.Join(root, "prod", sub)); err != nil {
|
||||
t.Errorf("subdir %s not created: %v", sub, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSCreateWithParent(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
writeDefaultsNS(t, root)
|
||||
writeCustomNS(t, root, "base", "")
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "create", "child", "--parent", "base"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("ns create: %v", err)
|
||||
}
|
||||
data, err := os.ReadFile(filepath.Join(root, "child", "ns.md"))
|
||||
if err != nil {
|
||||
t.Fatalf("read ns.md: %v", err)
|
||||
}
|
||||
if !strings.Contains(string(data), "parents: [") || !strings.Contains(string(data), "\"base\"") {
|
||||
t.Errorf("ns.md missing parents: %s", string(data))
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSCreateExisting(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
writeDefaultsNS(t, root)
|
||||
writeCustomNS(t, root, "prod", "")
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "create", "prod"})
|
||||
err := rootCmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected error creating existing namespace, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "already exists") {
|
||||
t.Errorf("error = %q, want contains 'already exists'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSCreateDefaultsRefused(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "create", "_defaults"})
|
||||
err := rootCmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected error creating _defaults, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSCreateClusterRefused(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "create", "cluster"})
|
||||
err := rootCmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected error creating cluster, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSDeleteHappy(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
writeDefaultsNS(t, root)
|
||||
writeCustomNS(t, root, "prod", "")
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "delete", "prod"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("ns delete: %v", err)
|
||||
}
|
||||
if _, err := os.Stat(filepath.Join(root, "prod")); !os.IsNotExist(err) {
|
||||
t.Errorf("prod dir still exists after delete")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSDeleteDefaultsRefused(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
writeDefaultsNS(t, root)
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "delete", "_defaults"})
|
||||
err := rootCmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected error deleting _defaults, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSDeleteNonEmpty(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
writeDefaultsNS(t, root)
|
||||
writeCustomNS(t, root, "prod", "")
|
||||
// put a job in jobs/
|
||||
if err := os.MkdirAll(filepath.Join(root, "prod", "jobs"), 0o755); err != nil {
|
||||
t.Fatalf("mkdir jobs: %v", err)
|
||||
}
|
||||
if err := os.WriteFile(filepath.Join(root, "prod", "jobs", "j1.md"), []byte("x"), 0o644); err != nil {
|
||||
t.Fatalf("write job: %v", err)
|
||||
}
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "delete", "prod"})
|
||||
err := rootCmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected error deleting non-empty namespace, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "refusing to delete") {
|
||||
t.Errorf("error = %q, want contains 'refusing to delete'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSDeleteMissing(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
writeDefaultsNS(t, root)
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "delete", "ghost"})
|
||||
err := rootCmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected error deleting missing namespace, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSInspectHappy(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
writeDefaultsNS(t, root)
|
||||
writeCustomNS(t, root, "prod", "")
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "inspect", "prod"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("ns inspect: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSInspectJSON(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
writeDefaultsNS(t, root)
|
||||
writeCustomNS(t, root, "prod", "")
|
||||
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetArgs([]string{"ns", "inspect", "prod", "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("ns inspect --json: %v", err)
|
||||
}
|
||||
var result map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &result); err != nil {
|
||||
t.Fatalf("unmarshal: %v\n%s", err, buf.String())
|
||||
}
|
||||
if result["name"] != "prod" {
|
||||
t.Errorf("name = %v, want prod", result["name"])
|
||||
}
|
||||
chain, _ := result["chain"].([]any)
|
||||
if len(chain) < 2 {
|
||||
t.Errorf("chain too short: %v", chain)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSInspectMissingNamespace(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
writeDefaultsNS(t, root)
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "inspect", "ghost"})
|
||||
err := rootCmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected error for missing namespace, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSValidateHappy(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
writeDefaultsNS(t, root)
|
||||
writeCustomNS(t, root, "prod", "")
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "validate", "prod"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("ns validate: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSValidateCycle(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
writeDefaultsNS(t, root)
|
||||
// a -> b, b -> a (cycle)
|
||||
writeCustomNS(t, root, "a", "[\"b\"]")
|
||||
writeCustomNS(t, root, "b", "[\"a\"]")
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "validate", "a"})
|
||||
err := rootCmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected cycle error, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "cycle") {
|
||||
t.Errorf("error = %q, want contains 'cycle'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSValidateMissingParent(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
writeDefaultsNS(t, root)
|
||||
writeCustomNS(t, root, "x", "[\"ghost\"]")
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "validate", "x"})
|
||||
err := rootCmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected missing-parent error, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "ghost") || !strings.Contains(err.Error(), "not found") {
|
||||
t.Errorf("error = %q, want contains ghost + not found", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSValidateMissingNamespace(t *testing.T) {
|
||||
root := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", root)
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
writeDefaultsNS(t, root)
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "validate", "ghost"})
|
||||
err := rootCmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected error for missing namespace, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestRenderNSMd(t *testing.T) {
|
||||
body := renderNSMd("foo", []string{"_defaults"}, true, false)
|
||||
if !strings.Contains(body, "kind: Namespace") {
|
||||
t.Errorf("missing kind: %s", body)
|
||||
}
|
||||
if !strings.Contains(body, "name: foo") {
|
||||
t.Errorf("missing name: %s", body)
|
||||
}
|
||||
if !strings.Contains(body, "inherits_env: true") {
|
||||
t.Errorf("missing inherits_env true: %s", body)
|
||||
}
|
||||
if !strings.Contains(body, "inherits_secrets: false") {
|
||||
t.Errorf("missing inherits_secrets false: %s", body)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSRootRegistered(t *testing.T) {
|
||||
found := false
|
||||
for _, c := range rootCmd.Commands() {
|
||||
if c.Use == "ns" {
|
||||
found = true
|
||||
break
|
||||
}
|
||||
}
|
||||
if !found {
|
||||
t.Errorf("ns command not registered on root")
|
||||
}
|
||||
// ensure subcommands present
|
||||
sub := map[string]bool{}
|
||||
for _, c := range rootCmd.Commands() {
|
||||
if c.Use == "ns" {
|
||||
for _, sc := range c.Commands() {
|
||||
sub[sc.Use] = true
|
||||
}
|
||||
}
|
||||
}
|
||||
for _, want := range []string{"list", "create <name>", "delete <name>", "inspect <name>", "validate <name>"} {
|
||||
if !sub[want] {
|
||||
t.Errorf("missing ns subcommand %q", want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestNSListNoORCAHOME(t *testing.T) {
|
||||
// ORCA_HOME points at a nonexistent dir; list should error.
|
||||
t.Setenv("ORCA_HOME", filepath.Join(t.TempDir(), "nope"))
|
||||
resetRootFlags(t)
|
||||
resetNSFlags()
|
||||
|
||||
rootCmd.SetArgs([]string{"ns", "list"})
|
||||
err := rootCmd.Execute()
|
||||
if err == nil {
|
||||
t.Fatal("expected error for missing ORCA_HOME, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
var _ = paths.DefaultNamespace // keep paths import alive
|
||||
+36
-2
@@ -1,13 +1,19 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"os"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/config"
|
||||
)
|
||||
|
||||
type configCtxKey struct{}
|
||||
|
||||
var (
|
||||
version = "0.1.0-dev"
|
||||
gitCommit = "unknown"
|
||||
@@ -33,18 +39,46 @@ over feature richness.`,
|
||||
return fmt.Errorf("set ORCA_HOME for --system: %w", err)
|
||||
}
|
||||
}
|
||||
if configPath != "" {
|
||||
cfg, err := config.Load(configPath)
|
||||
if err != nil {
|
||||
return fmt.Errorf("load config %s: %w", configPath, err)
|
||||
}
|
||||
cmd.SetContext(context.WithValue(cmd.Context(), configCtxKey{}, cfg))
|
||||
}
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
var (
|
||||
jsonOutput bool
|
||||
systemNamespace bool
|
||||
jsonOutput bool
|
||||
systemNamespace bool
|
||||
configPath string
|
||||
noDeprecationWarnings bool
|
||||
)
|
||||
|
||||
func init() {
|
||||
rootCmd.PersistentFlags().BoolVar(&jsonOutput, "json", false, "output in JSON format")
|
||||
rootCmd.PersistentFlags().BoolVar(&systemNamespace, "system", false, "use system-level namespace root (/root/.orca) instead of user-level (~/.orca)")
|
||||
rootCmd.PersistentFlags().StringVar(&configPath, "config", "", "path to config.hcl (overrides ~/.orca/config.hcl)")
|
||||
rootCmd.PersistentFlags().BoolVar(&noDeprecationWarnings, "no-deprecation-warnings", false, "suppress v0.9 deprecation warnings (use during `orca upgrade` migrations)")
|
||||
}
|
||||
|
||||
// warnDeprecated emits a v0.9 deprecation warning via slog.Warn unless
|
||||
// the --no-deprecation-warnings global flag is set. Callers pass a
|
||||
// human-readable message describing what changed. REQ-068.
|
||||
func warnDeprecated(msg string) {
|
||||
if noDeprecationWarnings {
|
||||
return
|
||||
}
|
||||
slog.Warn(msg)
|
||||
}
|
||||
|
||||
func configFromCtx(ctx context.Context) *config.Config {
|
||||
if v, ok := ctx.Value(configCtxKey{}).(*config.Config); ok {
|
||||
return v
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func Execute() error {
|
||||
|
||||
@@ -1,8 +1,11 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/config"
|
||||
)
|
||||
|
||||
func TestVersionCommandExists(t *testing.T) {
|
||||
@@ -65,3 +68,47 @@ func TestRootHelpMentionsKeyPillars(t *testing.T) {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigFlagRegistered(t *testing.T) {
|
||||
f := rootCmd.PersistentFlags().Lookup("config")
|
||||
if f == nil {
|
||||
t.Fatal("--config persistent flag not registered")
|
||||
}
|
||||
if f.DefValue != "" {
|
||||
t.Errorf("--config default = %q, want empty", f.DefValue)
|
||||
}
|
||||
}
|
||||
|
||||
func TestConfigFlagLoadsFile(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
cfgPath := dir + "/config.hcl"
|
||||
cfgContent := `db_path = "` + dir + `/test.db"
|
||||
listen_addr = "127.0.0.1:9999"
|
||||
ca_path = "` + dir + `/ca.crt"
|
||||
server_cert_path = "` + dir + `/server.crt"
|
||||
server_key_path = "` + dir + `/server.key"
|
||||
|
||||
node_capacity {
|
||||
cpu = 4
|
||||
memory_mb = 8192
|
||||
}
|
||||
`
|
||||
if err := os.WriteFile(cfgPath, []byte(cfgContent), 0o644); err != nil {
|
||||
t.Fatalf("write config: %v", err)
|
||||
}
|
||||
|
||||
old := configPath
|
||||
configPath = cfgPath
|
||||
defer func() { configPath = old }()
|
||||
|
||||
cfg, err := config.Load(cfgPath)
|
||||
if err != nil {
|
||||
t.Fatalf("load config: %v", err)
|
||||
}
|
||||
if cfg.ListenAddr != "127.0.0.1:9999" {
|
||||
t.Errorf("listen_addr = %q, want 127.0.0.1:9999", cfg.ListenAddr)
|
||||
}
|
||||
if cfg.NodeCapacity == nil || cfg.NodeCapacity.CPU != 4 {
|
||||
t.Errorf("node_capacity.cpu not parsed, got %+v", cfg.NodeCapacity)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestStatusText(t *testing.T) {
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"status"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("status: %v", err)
|
||||
}
|
||||
out := buf.String()
|
||||
if !strings.Contains(out, "orca daemon status") {
|
||||
t.Errorf("status text output unexpected: %s", out)
|
||||
}
|
||||
if !strings.Contains(out, "version") {
|
||||
t.Errorf("status output missing version: %s", out)
|
||||
}
|
||||
}
|
||||
|
||||
func TestStatusJSON(t *testing.T) {
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"status", "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("status --json: %v", err)
|
||||
}
|
||||
var info map[string]any
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &info); err != nil {
|
||||
t.Fatalf("unmarshal status json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if info["daemon"] != "stopped" {
|
||||
t.Errorf("status json daemon = %v, want stopped", info["daemon"])
|
||||
}
|
||||
if info["api_addr"] != "https://localhost:8443" {
|
||||
t.Errorf("status json api_addr = %v, want https://localhost:8443", info["api_addr"])
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
package cli
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestVersionText(t *testing.T) {
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"version"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("version: %v", err)
|
||||
}
|
||||
out := buf.String()
|
||||
if !strings.Contains(out, "orca version") {
|
||||
t.Errorf("version text output unexpected: %s", out)
|
||||
}
|
||||
if !strings.Contains(out, "git commit") {
|
||||
t.Errorf("version output missing git commit: %s", out)
|
||||
}
|
||||
}
|
||||
|
||||
func TestVersionJSON(t *testing.T) {
|
||||
resetRootFlags(t)
|
||||
var buf bytes.Buffer
|
||||
rootCmd.SetOut(&buf)
|
||||
rootCmd.SetErr(&buf)
|
||||
rootCmd.SetArgs([]string{"version", "--json"})
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
t.Fatalf("version --json: %v", err)
|
||||
}
|
||||
var info map[string]string
|
||||
if err := json.Unmarshal(bytes.TrimSpace(buf.Bytes()), &info); err != nil {
|
||||
t.Fatalf("unmarshal version json: %v\n%s", err, buf.String())
|
||||
}
|
||||
if info["version"] == "" {
|
||||
t.Errorf("version json missing version field: %v", info)
|
||||
}
|
||||
if info["git_commit"] == "" {
|
||||
t.Errorf("version json missing git_commit field: %v", info)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,188 @@
|
||||
package config
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
"github.com/hashicorp/hcl/v2/hclsimple"
|
||||
)
|
||||
|
||||
type CapacityConfig struct {
|
||||
CPU int `hcl:"cpu,optional"`
|
||||
MemoryMB int `hcl:"memory_mb,optional"`
|
||||
}
|
||||
|
||||
type Config struct {
|
||||
DBPath string `hcl:"db_path,optional"`
|
||||
ListenAddr string `hcl:"listen_addr,optional"`
|
||||
CAPath string `hcl:"ca_path,optional"`
|
||||
ServerCertPath string `hcl:"server_cert_path,optional"`
|
||||
ServerKeyPath string `hcl:"server_key_path,optional"`
|
||||
NodeCapacity *CapacityConfig `hcl:"node_capacity,block"`
|
||||
}
|
||||
|
||||
type Flags struct {
|
||||
DBPath *string
|
||||
ListenAddr *string
|
||||
CAPath *string
|
||||
ServerCertPath *string
|
||||
ServerKeyPath *string
|
||||
CPU *int
|
||||
MemoryMB *int
|
||||
}
|
||||
|
||||
type Environ map[string]string
|
||||
|
||||
// Load is the config dispatcher (R-014). It tries each path in order,
|
||||
// skipping missing files, and dispatches to the appropriate loader
|
||||
// based on file extension: .hcl → LoadHCL (legacy, R-013),
|
||||
// .md → LoadMarkdown (new Markdown-frontmatter loader), and
|
||||
// .yaml/.yml → LoadMarkdown with an empty body. The first successfully
|
||||
// decoded file wins. If no path exists or decodes, a zero Config is
|
||||
// returned.
|
||||
//
|
||||
// The signature is preserved from the v0.8 single-loader API so
|
||||
// internal/cli/root.go requires no changes yet.
|
||||
func Load(paths ...string) (*Config, error) {
|
||||
for _, p := range paths {
|
||||
if _, err := os.Stat(p); err != nil {
|
||||
continue
|
||||
}
|
||||
cfg, err := loadByExtension(p)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return cfg, nil
|
||||
}
|
||||
return &Config{}, nil
|
||||
}
|
||||
|
||||
func loadByExtension(p string) (*Config, error) {
|
||||
ext := strings.ToLower(filepathExt(p))
|
||||
switch ext {
|
||||
case ".hcl":
|
||||
return LoadHCL(p)
|
||||
case ".md", ".markdown":
|
||||
return LoadMarkdown(p)
|
||||
case ".yaml", ".yml":
|
||||
return LoadMarkdownYAML(p)
|
||||
default:
|
||||
// Unknown extension: hclsimple.Decode rejects non-.hcl
|
||||
// suffixes, so for backward compat with the v0.8 single-loader
|
||||
// behavior (which assumed HCL), decode the file content as HCL
|
||||
// against a synthesized .hcl path.
|
||||
data, err := os.ReadFile(p)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("read config %s: %w", p, err)
|
||||
}
|
||||
var cfg Config
|
||||
if err := hclsimple.Decode(p+".hcl", data, nil, &cfg); err != nil {
|
||||
return nil, fmt.Errorf("decode config %s: %w", p, err)
|
||||
}
|
||||
return &cfg, nil
|
||||
}
|
||||
}
|
||||
|
||||
// filepathExt is a thin wrapper around filepath.Ext to keep the import
|
||||
// localized to the dispatcher. Returns the extension including the dot,
|
||||
// lowercased by the caller.
|
||||
func filepathExt(p string) string {
|
||||
i := strings.LastIndex(p, ".")
|
||||
if i < 0 {
|
||||
return ""
|
||||
}
|
||||
return p[i:]
|
||||
}
|
||||
|
||||
// LoadHCL decodes a legacy HCL config file (R-013).
|
||||
//
|
||||
// Deprecated: use LoadMarkdown or the dispatcher. HCL is legacy per
|
||||
// R-013. Retained for the v0.9 dual-write window (REQ-090); new
|
||||
// deployments should author config.md with YAML frontmatter.
|
||||
func LoadHCL(path string) (*Config, error) {
|
||||
data, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("read config %s: %w", path, err)
|
||||
}
|
||||
var cfg Config
|
||||
if err := hclsimple.Decode(path, data, nil, &cfg); err != nil {
|
||||
return nil, fmt.Errorf("decode config %s: %w", path, err)
|
||||
}
|
||||
return &cfg, nil
|
||||
}
|
||||
|
||||
func (c *Config) MergeOverrides(flags Flags, env Environ) *Config {
|
||||
out := &Config{
|
||||
DBPath: c.DBPath,
|
||||
ListenAddr: c.ListenAddr,
|
||||
CAPath: c.CAPath,
|
||||
ServerCertPath: c.ServerCertPath,
|
||||
ServerKeyPath: c.ServerKeyPath,
|
||||
NodeCapacity: c.NodeCapacity,
|
||||
}
|
||||
|
||||
applyStr := func(flag *string, envKey, fileVal string) string {
|
||||
if flag != nil {
|
||||
return *flag
|
||||
}
|
||||
if v, ok := env[envKey]; ok && v != "" {
|
||||
return v
|
||||
}
|
||||
return fileVal
|
||||
}
|
||||
|
||||
out.DBPath = applyStr(flags.DBPath, "ORCA_DB", out.DBPath)
|
||||
out.ListenAddr = applyStr(flags.ListenAddr, "ORCA_LISTEN_ADDR", out.ListenAddr)
|
||||
out.CAPath = applyStr(flags.CAPath, "ORCA_CA_PATH", out.CAPath)
|
||||
out.ServerCertPath = applyStr(flags.ServerCertPath, "ORCA_SERVER_CERT_PATH", out.ServerCertPath)
|
||||
out.ServerKeyPath = applyStr(flags.ServerKeyPath, "ORCA_SERVER_KEY_PATH", out.ServerKeyPath)
|
||||
|
||||
if out.NodeCapacity == nil {
|
||||
out.NodeCapacity = &CapacityConfig{}
|
||||
} else {
|
||||
nc := *out.NodeCapacity
|
||||
out.NodeCapacity = &nc
|
||||
}
|
||||
|
||||
if flags.CPU != nil {
|
||||
out.NodeCapacity.CPU = *flags.CPU
|
||||
} else if v, ok := env["ORCA_NODE_CPU"]; ok && v != "" {
|
||||
if n, err := atoi(v); err == nil {
|
||||
out.NodeCapacity.CPU = n
|
||||
}
|
||||
}
|
||||
|
||||
if flags.MemoryMB != nil {
|
||||
out.NodeCapacity.MemoryMB = *flags.MemoryMB
|
||||
} else if v, ok := env["ORCA_NODE_MEMORY_MB"]; ok && v != "" {
|
||||
if n, err := atoi(v); err == nil {
|
||||
out.NodeCapacity.MemoryMB = n
|
||||
}
|
||||
}
|
||||
|
||||
return out
|
||||
}
|
||||
|
||||
func atoi(s string) (int, error) {
|
||||
n := 0
|
||||
if s == "" {
|
||||
return 0, fmt.Errorf("empty")
|
||||
}
|
||||
neg := false
|
||||
i := 0
|
||||
if s[0] == '-' {
|
||||
neg = true
|
||||
i = 1
|
||||
}
|
||||
for ; i < len(s); i++ {
|
||||
if s[i] < '0' || s[i] > '9' {
|
||||
return 0, fmt.Errorf("bad")
|
||||
}
|
||||
n = n*10 + int(s[i]-'0')
|
||||
}
|
||||
if neg {
|
||||
n = -n
|
||||
}
|
||||
return n, nil
|
||||
}
|
||||
@@ -0,0 +1,197 @@
|
||||
package config
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
)
|
||||
|
||||
const exampleHCL = `
|
||||
db_path = "/tmp/orca/test.db"
|
||||
listen_addr = "127.0.0.1:9999"
|
||||
ca_path = "/tmp/orca/ca.crt"
|
||||
server_cert_path = "/tmp/orca/server.crt"
|
||||
server_key_path = "/tmp/orca/server.key"
|
||||
|
||||
node_capacity {
|
||||
cpu = 4
|
||||
memory_mb = 8192
|
||||
}
|
||||
`
|
||||
|
||||
func writeFile(t *testing.T, dir, name, content string) string {
|
||||
t.Helper()
|
||||
p := filepath.Join(dir, name)
|
||||
if err := os.WriteFile(p, []byte(content), 0644); err != nil {
|
||||
t.Fatalf("write %s: %v", p, err)
|
||||
}
|
||||
return p
|
||||
}
|
||||
|
||||
func TestLoad_Valid(t *testing.T) {
|
||||
p := writeFile(t, t.TempDir(), "config.hcl", exampleHCL)
|
||||
cfg, err := Load(p)
|
||||
if err != nil {
|
||||
t.Fatalf("Load: %v", err)
|
||||
}
|
||||
if cfg.DBPath != "/tmp/orca/test.db" {
|
||||
t.Errorf("DBPath=%q", cfg.DBPath)
|
||||
}
|
||||
if cfg.ListenAddr != "127.0.0.1:9999" {
|
||||
t.Errorf("ListenAddr=%q", cfg.ListenAddr)
|
||||
}
|
||||
if cfg.CAPath != "/tmp/orca/ca.crt" {
|
||||
t.Errorf("CAPath=%q", cfg.CAPath)
|
||||
}
|
||||
if cfg.ServerCertPath != "/tmp/orca/server.crt" {
|
||||
t.Errorf("ServerCertPath=%q", cfg.ServerCertPath)
|
||||
}
|
||||
if cfg.ServerKeyPath != "/tmp/orca/server.key" {
|
||||
t.Errorf("ServerKeyPath=%q", cfg.ServerKeyPath)
|
||||
}
|
||||
if cfg.NodeCapacity == nil {
|
||||
t.Fatal("NodeCapacity nil")
|
||||
}
|
||||
if cfg.NodeCapacity.CPU != 4 {
|
||||
t.Errorf("CPU=%d", cfg.NodeCapacity.CPU)
|
||||
}
|
||||
if cfg.NodeCapacity.MemoryMB != 8192 {
|
||||
t.Errorf("MemoryMB=%d", cfg.NodeCapacity.MemoryMB)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoad_Missing(t *testing.T) {
|
||||
cfg, err := Load(filepath.Join(t.TempDir(), "nope.hcl"))
|
||||
if err != nil {
|
||||
t.Fatalf("Load: %v", err)
|
||||
}
|
||||
if cfg == nil {
|
||||
t.Fatal("nil config")
|
||||
}
|
||||
if cfg.DBPath != "" || cfg.ListenAddr != "" || cfg.NodeCapacity != nil {
|
||||
t.Errorf("expected zero config, got %+v", cfg)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoad_Malformed(t *testing.T) {
|
||||
p := writeFile(t, t.TempDir(), "bad.hcl", "db_path = ")
|
||||
cfg, err := Load(p)
|
||||
if err == nil {
|
||||
t.Fatalf("expected error, got %+v", cfg)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoad_FirstExisting(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
existing := writeFile(t, dir, "real.hcl", exampleHCL)
|
||||
missing := filepath.Join(dir, "missing.hcl")
|
||||
cfg, err := Load(missing, existing)
|
||||
if err != nil {
|
||||
t.Fatalf("Load: %v", err)
|
||||
}
|
||||
if cfg.DBPath != "/tmp/orca/test.db" {
|
||||
t.Errorf("DBPath=%q", cfg.DBPath)
|
||||
}
|
||||
}
|
||||
|
||||
func strPtr(s string) *string { return &s }
|
||||
func intPtr(i int) *int { return &i }
|
||||
|
||||
func TestMergeOverrides_FlagWins(t *testing.T) {
|
||||
cfg := &Config{
|
||||
DBPath: "/file.db",
|
||||
ListenAddr: "127.0.0.1:9000",
|
||||
NodeCapacity: &CapacityConfig{
|
||||
CPU: 4,
|
||||
MemoryMB: 8192,
|
||||
},
|
||||
}
|
||||
flags := Flags{
|
||||
DBPath: strPtr("/flag.db"),
|
||||
ListenAddr: strPtr("0.0.0.0:1234"),
|
||||
}
|
||||
env := Environ{"ORCA_DB": "/env.db"}
|
||||
out := cfg.MergeOverrides(flags, env)
|
||||
if out.DBPath != "/flag.db" {
|
||||
t.Errorf("DBPath=%q want /flag.db", out.DBPath)
|
||||
}
|
||||
if out.ListenAddr != "0.0.0.0:1234" {
|
||||
t.Errorf("ListenAddr=%q want 0.0.0.0:1234", out.ListenAddr)
|
||||
}
|
||||
if cfg.DBPath != "/file.db" {
|
||||
t.Errorf("receiver mutated: %q", cfg.DBPath)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMergeOverrides_EnvWinsOverFile(t *testing.T) {
|
||||
cfg := &Config{DBPath: "/file.db", ListenAddr: "127.0.0.1:9000"}
|
||||
env := Environ{"ORCA_DB": "/env.db"}
|
||||
out := cfg.MergeOverrides(Flags{}, env)
|
||||
if out.DBPath != "/env.db" {
|
||||
t.Errorf("DBPath=%q want /env.db", out.DBPath)
|
||||
}
|
||||
if out.ListenAddr != "127.0.0.1:9000" {
|
||||
t.Errorf("ListenAddr=%q want 127.0.0.1:9000", out.ListenAddr)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMergeOverrides_FileWinsOverDefault(t *testing.T) {
|
||||
cfg := &Config{DBPath: "/file.db", ListenAddr: "127.0.0.1:9000"}
|
||||
out := cfg.MergeOverrides(Flags{}, Environ{})
|
||||
if out.DBPath != "/file.db" {
|
||||
t.Errorf("DBPath=%q want /file.db", out.DBPath)
|
||||
}
|
||||
if out.ListenAddr != "127.0.0.1:9000" {
|
||||
t.Errorf("ListenAddr=%q want 127.0.0.1:9000", out.ListenAddr)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMergeOverrides_EmptyFlagDoesNotOverride(t *testing.T) {
|
||||
cfg := &Config{DBPath: "/file.db"}
|
||||
env := Environ{"ORCA_DB": "/env.db"}
|
||||
out := cfg.MergeOverrides(Flags{}, env)
|
||||
if out.DBPath != "/env.db" {
|
||||
t.Errorf("DBPath=%q want /env.db", out.DBPath)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMergeOverrides_EmptyEnvDoesNotOverride(t *testing.T) {
|
||||
cfg := &Config{DBPath: "/file.db"}
|
||||
env := Environ{"ORCA_DB": ""}
|
||||
out := cfg.MergeOverrides(Flags{}, env)
|
||||
if out.DBPath != "/file.db" {
|
||||
t.Errorf("DBPath=%q want /file.db", out.DBPath)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMergeOverrides_NodeCapacity(t *testing.T) {
|
||||
cfg := &Config{
|
||||
NodeCapacity: &CapacityConfig{CPU: 4, MemoryMB: 8192},
|
||||
}
|
||||
out := cfg.MergeOverrides(Flags{}, Environ{})
|
||||
if out.NodeCapacity == nil {
|
||||
t.Fatal("NodeCapacity nil")
|
||||
}
|
||||
if out.NodeCapacity.CPU != 4 {
|
||||
t.Errorf("CPU=%d want 4", out.NodeCapacity.CPU)
|
||||
}
|
||||
if out.NodeCapacity.MemoryMB != 8192 {
|
||||
t.Errorf("MemoryMB=%d want 8192", out.NodeCapacity.MemoryMB)
|
||||
}
|
||||
if cfg.NodeCapacity == out.NodeCapacity {
|
||||
t.Error("NodeCapacity not cloned")
|
||||
}
|
||||
}
|
||||
|
||||
func TestMergeOverrides_NodeCapacityFlagAndEnv(t *testing.T) {
|
||||
cfg := &Config{NodeCapacity: &CapacityConfig{CPU: 4, MemoryMB: 8192}}
|
||||
flags := Flags{CPU: intPtr(8)}
|
||||
env := Environ{"ORCA_NODE_MEMORY_MB": "16384"}
|
||||
out := cfg.MergeOverrides(flags, env)
|
||||
if out.NodeCapacity.CPU != 8 {
|
||||
t.Errorf("CPU=%d want 8", out.NodeCapacity.CPU)
|
||||
}
|
||||
if out.NodeCapacity.MemoryMB != 16384 {
|
||||
t.Errorf("MemoryMB=%d want 16384", out.NodeCapacity.MemoryMB)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,111 @@
|
||||
package config
|
||||
|
||||
import (
|
||||
"path/filepath"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestLoad_DispatchHCL(t *testing.T) {
|
||||
p := writeTestFile(t, t.TempDir(), "config.hcl", exampleHCL)
|
||||
cfg, err := Load(p)
|
||||
if err != nil {
|
||||
t.Fatalf("Load: %v", err)
|
||||
}
|
||||
if cfg.DBPath != "/tmp/orca/test.db" {
|
||||
t.Errorf("DBPath=%q", cfg.DBPath)
|
||||
}
|
||||
if cfg.NodeCapacity == nil || cfg.NodeCapacity.CPU != 4 {
|
||||
t.Errorf("NodeCapacity=%+v", cfg.NodeCapacity)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoad_DispatchMarkdown(t *testing.T) {
|
||||
p := writeTestFile(t, t.TempDir(), "config.md", exampleMarkdown)
|
||||
cfg, err := Load(p)
|
||||
if err != nil {
|
||||
t.Fatalf("Load: %v", err)
|
||||
}
|
||||
if cfg.DBPath != "/tmp/orca/test.db" {
|
||||
t.Errorf("DBPath=%q", cfg.DBPath)
|
||||
}
|
||||
if cfg.ListenAddr != "127.0.0.1:9999" {
|
||||
t.Errorf("ListenAddr=%q", cfg.ListenAddr)
|
||||
}
|
||||
if cfg.NodeCapacity == nil || cfg.NodeCapacity.CPU != 4 {
|
||||
t.Errorf("NodeCapacity=%+v", cfg.NodeCapacity)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoad_DispatchYAML(t *testing.T) {
|
||||
body := "listen_addr: 0.0.0.0:5555\ndb_path: /bare.db\nnode_capacity:\n cpu: 2\n memory_mb: 4096\n"
|
||||
p := writeTestFile(t, t.TempDir(), "config.yaml", body)
|
||||
cfg, err := Load(p)
|
||||
if err != nil {
|
||||
t.Fatalf("Load: %v", err)
|
||||
}
|
||||
if cfg.ListenAddr != "0.0.0.0:5555" {
|
||||
t.Errorf("ListenAddr=%q", cfg.ListenAddr)
|
||||
}
|
||||
if cfg.DBPath != "/bare.db" {
|
||||
t.Errorf("DBPath=%q", cfg.DBPath)
|
||||
}
|
||||
if cfg.NodeCapacity == nil || cfg.NodeCapacity.CPU != 2 {
|
||||
t.Errorf("NodeCapacity=%+v", cfg.NodeCapacity)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoad_DispatchYML(t *testing.T) {
|
||||
body := "listen_addr: 1.2.3.4:9\n"
|
||||
p := writeTestFile(t, t.TempDir(), "config.yml", body)
|
||||
cfg, err := Load(p)
|
||||
if err != nil {
|
||||
t.Fatalf("Load: %v", err)
|
||||
}
|
||||
if cfg.ListenAddr != "1.2.3.4:9" {
|
||||
t.Errorf("ListenAddr=%q", cfg.ListenAddr)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoad_DispatchFirstExistingWins(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
missing := filepath.Join(dir, "missing.md")
|
||||
existing := writeTestFile(t, dir, "real.hcl", exampleHCL)
|
||||
cfg, err := Load(missing, existing)
|
||||
if err != nil {
|
||||
t.Fatalf("Load: %v", err)
|
||||
}
|
||||
if cfg.DBPath != "/tmp/orca/test.db" {
|
||||
t.Errorf("DBPath=%q", cfg.DBPath)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoad_DispatchMissingReturnsZero(t *testing.T) {
|
||||
cfg, err := Load(filepath.Join(t.TempDir(), "nope.md"))
|
||||
if err != nil {
|
||||
t.Fatalf("Load: %v", err)
|
||||
}
|
||||
if cfg == nil {
|
||||
t.Fatal("nil config")
|
||||
}
|
||||
if cfg.DBPath != "" || cfg.ListenAddr != "" || cfg.NodeCapacity != nil {
|
||||
t.Errorf("expected zero config, got %+v", cfg)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoad_DispatchHCLMalformed(t *testing.T) {
|
||||
p := writeTestFile(t, t.TempDir(), "bad.hcl", "db_path = ")
|
||||
if _, err := Load(p); err == nil {
|
||||
t.Fatal("expected error for malformed HCL")
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoad_DispatchUnknownExtFallsBackToHCL(t *testing.T) {
|
||||
p := writeTestFile(t, t.TempDir(), "config.unknown", exampleHCL)
|
||||
cfg, err := Load(p)
|
||||
if err != nil {
|
||||
t.Fatalf("Load: %v", err)
|
||||
}
|
||||
if cfg.DBPath != "/tmp/orca/test.db" {
|
||||
t.Errorf("DBPath=%q", cfg.DBPath)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,220 @@
|
||||
package config
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"strconv"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// LoadMarkdown decodes a Markdown config file with YAML frontmatter
|
||||
// (R-014). The file format is:
|
||||
//
|
||||
// ---
|
||||
// listen_addr: 127.0.0.1:9999
|
||||
// node_capacity:
|
||||
// cpu: 4
|
||||
// memory_mb: 8192
|
||||
// db_path: /tmp/orca/test.db
|
||||
// ---
|
||||
//
|
||||
// body prose (ignored)
|
||||
//
|
||||
// The frontmatter parser is a minimal hand-rolled key:value parser
|
||||
// (no new dependencies; gopkg.in/yaml.v3 is not in go.mod). It supports
|
||||
// flat scalar keys and one level of nested mapping (for node_capacity).
|
||||
// The Markdown body after the closing "---" is ignored.
|
||||
//
|
||||
// The returned *Config is the same struct the HCL loader produces, so
|
||||
// downstream consumers are unchanged.
|
||||
func LoadMarkdown(path string) (*Config, error) {
|
||||
data, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("read config %s: %w", path, err)
|
||||
}
|
||||
return parseFrontmatter(string(data), path)
|
||||
}
|
||||
|
||||
// LoadMarkdownYAML decodes a bare YAML file (no Markdown body) using the
|
||||
// same minimal frontmatter parser. .yaml/.yml files are routed here by
|
||||
// the dispatcher.
|
||||
func LoadMarkdownYAML(path string) (*Config, error) {
|
||||
data, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("read config %s: %w", path, err)
|
||||
}
|
||||
// Treat the whole file as the frontmatter block (no surrounding ---).
|
||||
return parseFrontmatterBlock(string(data), path)
|
||||
}
|
||||
|
||||
func parseFrontmatter(content, path string) (*Config, error) {
|
||||
block, ok := extractFrontmatter(content)
|
||||
if !ok {
|
||||
// No frontmatter delimiters: treat whole file as a bare block.
|
||||
return parseFrontmatterBlock(content, path)
|
||||
}
|
||||
return parseFrontmatterBlock(block, path)
|
||||
}
|
||||
|
||||
// extractFrontmatter returns the YAML block between the first pair of
|
||||
// "---" delimiters and whether a frontmatter block was present.
|
||||
func extractFrontmatter(content string) (string, bool) {
|
||||
trimmed := strings.TrimLeft(content, "\r\n\t ")
|
||||
if !strings.HasPrefix(trimmed, "---") {
|
||||
return "", false
|
||||
}
|
||||
// Skip the opening delimiter line.
|
||||
rest := trimmed[3:]
|
||||
rest = strings.TrimLeft(rest, "\r\n")
|
||||
// Find the closing delimiter line.
|
||||
idx := strings.Index(rest, "\n---")
|
||||
if idx < 0 {
|
||||
return "", false
|
||||
}
|
||||
return rest[:idx], true
|
||||
}
|
||||
|
||||
// parseFrontmatterBlock parses a minimal YAML-ish block into *Config.
|
||||
// Supported shapes:
|
||||
//
|
||||
// key: value
|
||||
// node_capacity:
|
||||
// cpu: 4
|
||||
// memory_mb: 8192
|
||||
//
|
||||
// Comments (# ...) and blank lines are ignored. Quoted scalar values
|
||||
// ("..." or '...') are unwrapped. No flow collections, anchors, or
|
||||
// multi-line strings are supported — by design, to avoid adding a YAML
|
||||
// dependency for this small config surface.
|
||||
func parseFrontmatterBlock(block, path string) (*Config, error) {
|
||||
cfg := &Config{}
|
||||
var inCapacity bool
|
||||
|
||||
lines := strings.Split(block, "\n")
|
||||
for lineNo, raw := range lines {
|
||||
line := stripComment(raw)
|
||||
if strings.TrimSpace(line) == "" {
|
||||
continue
|
||||
}
|
||||
|
||||
indent := countIndent(line)
|
||||
trimmed := strings.TrimSpace(line)
|
||||
|
||||
// A top-level key (no leading indent).
|
||||
if indent == 0 {
|
||||
inCapacity = false
|
||||
key, val, ok := splitKV(trimmed)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
if val == "" {
|
||||
// key with no value → nested mapping header (e.g. node_capacity:)
|
||||
if key == "node_capacity" {
|
||||
cfg.NodeCapacity = &CapacityConfig{}
|
||||
inCapacity = true
|
||||
}
|
||||
continue
|
||||
}
|
||||
applyScalar(cfg, key, val, path, lineNo)
|
||||
continue
|
||||
}
|
||||
|
||||
// Indented line under a nested mapping.
|
||||
if inCapacity && cfg.NodeCapacity != nil {
|
||||
key, val, hasVal := splitKV(trimmed)
|
||||
if !hasVal {
|
||||
continue
|
||||
}
|
||||
switch key {
|
||||
case "cpu":
|
||||
if n, err := strconv.Atoi(strings.TrimSpace(val)); err == nil {
|
||||
cfg.NodeCapacity.CPU = n
|
||||
}
|
||||
case "memory_mb":
|
||||
if n, err := strconv.Atoi(strings.TrimSpace(val)); err == nil {
|
||||
cfg.NodeCapacity.MemoryMB = n
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return cfg, nil
|
||||
}
|
||||
|
||||
func applyScalar(cfg *Config, key, val, path string, lineNo int) {
|
||||
val = strings.TrimSpace(val)
|
||||
switch key {
|
||||
case "db_path":
|
||||
cfg.DBPath = unquote(val)
|
||||
case "listen_addr":
|
||||
cfg.ListenAddr = unquote(val)
|
||||
case "ca_path":
|
||||
cfg.CAPath = unquote(val)
|
||||
case "server_cert_path":
|
||||
cfg.ServerCertPath = unquote(val)
|
||||
case "server_key_path":
|
||||
cfg.ServerKeyPath = unquote(val)
|
||||
}
|
||||
_ = path
|
||||
_ = lineNo
|
||||
}
|
||||
|
||||
func splitKV(s string) (key, val string, ok bool) {
|
||||
idx := strings.Index(s, ":")
|
||||
if idx < 0 {
|
||||
return "", "", false
|
||||
}
|
||||
key = strings.TrimSpace(s[:idx])
|
||||
val = strings.TrimSpace(s[idx+1:])
|
||||
if key == "" {
|
||||
return "", "", false
|
||||
}
|
||||
return key, val, true
|
||||
}
|
||||
|
||||
func countIndent(s string) int {
|
||||
n := 0
|
||||
for _, r := range s {
|
||||
if r == ' ' || r == '\t' {
|
||||
n++
|
||||
continue
|
||||
}
|
||||
break
|
||||
}
|
||||
return n
|
||||
}
|
||||
|
||||
func stripComment(s string) string {
|
||||
// Strip inline comments not inside quotes. Minimal: only strip
|
||||
// when the '#' is preceded by whitespace or at line start.
|
||||
inSingle := false
|
||||
inDouble := false
|
||||
for i := 0; i < len(s); i++ {
|
||||
c := s[i]
|
||||
switch c {
|
||||
case '\'':
|
||||
if !inDouble {
|
||||
inSingle = !inSingle
|
||||
}
|
||||
case '"':
|
||||
if !inSingle {
|
||||
inDouble = !inDouble
|
||||
}
|
||||
case '#':
|
||||
if !inSingle && !inDouble {
|
||||
if i == 0 || s[i-1] == ' ' || s[i-1] == '\t' {
|
||||
return s[:i]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
func unquote(s string) string {
|
||||
if len(s) >= 2 {
|
||||
if (s[0] == '"' && s[len(s)-1] == '"') || (s[0] == '\'' && s[len(s)-1] == '\'') {
|
||||
return s[1 : len(s)-1]
|
||||
}
|
||||
}
|
||||
return s
|
||||
}
|
||||
@@ -0,0 +1,186 @@
|
||||
package config
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func writeTestFile(t *testing.T, dir, name, content string) string {
|
||||
t.Helper()
|
||||
p := filepath.Join(dir, name)
|
||||
if err := os.WriteFile(p, []byte(content), 0644); err != nil {
|
||||
t.Fatalf("write %s: %v", p, err)
|
||||
}
|
||||
return p
|
||||
}
|
||||
|
||||
const exampleMarkdown = `---
|
||||
listen_addr: "127.0.0.1:9999"
|
||||
db_path: "/tmp/orca/test.db"
|
||||
ca_path: "/tmp/orca/ca.crt"
|
||||
server_cert_path: "/tmp/orca/server.crt"
|
||||
server_key_path: "/tmp/orca/server.key"
|
||||
node_capacity:
|
||||
cpu: 4
|
||||
memory_mb: 8192
|
||||
---
|
||||
|
||||
# Orca config
|
||||
|
||||
This is prose body and is ignored by the loader.
|
||||
`
|
||||
|
||||
func TestLoadMarkdown_Full(t *testing.T) {
|
||||
p := writeTestFile(t, t.TempDir(), "config.md", exampleMarkdown)
|
||||
cfg, err := LoadMarkdown(p)
|
||||
if err != nil {
|
||||
t.Fatalf("LoadMarkdown: %v", err)
|
||||
}
|
||||
if cfg.DBPath != "/tmp/orca/test.db" {
|
||||
t.Errorf("DBPath=%q", cfg.DBPath)
|
||||
}
|
||||
if cfg.ListenAddr != "127.0.0.1:9999" {
|
||||
t.Errorf("ListenAddr=%q", cfg.ListenAddr)
|
||||
}
|
||||
if cfg.CAPath != "/tmp/orca/ca.crt" {
|
||||
t.Errorf("CAPath=%q", cfg.CAPath)
|
||||
}
|
||||
if cfg.ServerCertPath != "/tmp/orca/server.crt" {
|
||||
t.Errorf("ServerCertPath=%q", cfg.ServerCertPath)
|
||||
}
|
||||
if cfg.ServerKeyPath != "/tmp/orca/server.key" {
|
||||
t.Errorf("ServerKeyPath=%q", cfg.ServerKeyPath)
|
||||
}
|
||||
if cfg.NodeCapacity == nil {
|
||||
t.Fatal("NodeCapacity nil")
|
||||
}
|
||||
if cfg.NodeCapacity.CPU != 4 {
|
||||
t.Errorf("CPU=%d", cfg.NodeCapacity.CPU)
|
||||
}
|
||||
if cfg.NodeCapacity.MemoryMB != 8192 {
|
||||
t.Errorf("MemoryMB=%d", cfg.NodeCapacity.MemoryMB)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadMarkdown_NoFrontmatter(t *testing.T) {
|
||||
// No delimiters: whole file treated as a bare YAML block.
|
||||
body := "listen_addr: 0.0.0.0:1234\ndb_path: /x/y.db\n"
|
||||
p := writeTestFile(t, t.TempDir(), "config.md", body)
|
||||
cfg, err := LoadMarkdown(p)
|
||||
if err != nil {
|
||||
t.Fatalf("LoadMarkdown: %v", err)
|
||||
}
|
||||
if cfg.ListenAddr != "0.0.0.0:1234" {
|
||||
t.Errorf("ListenAddr=%q", cfg.ListenAddr)
|
||||
}
|
||||
if cfg.DBPath != "/x/y.db" {
|
||||
t.Errorf("DBPath=%q", cfg.DBPath)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadMarkdown_OnlyBody(t *testing.T) {
|
||||
body := `---
|
||||
---
|
||||
|
||||
# Just prose, no keys
|
||||
`
|
||||
p := writeTestFile(t, t.TempDir(), "config.md", body)
|
||||
cfg, err := LoadMarkdown(p)
|
||||
if err != nil {
|
||||
t.Fatalf("LoadMarkdown: %v", err)
|
||||
}
|
||||
if cfg.DBPath != "" || cfg.ListenAddr != "" || cfg.NodeCapacity != nil {
|
||||
t.Errorf("expected zero config, got %+v", cfg)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadMarkdown_CommentsAndBlanks(t *testing.T) {
|
||||
body := `---
|
||||
# a comment
|
||||
listen_addr: "127.0.0.1:9999"
|
||||
|
||||
db_path: "/tmp/orca/test.db" # inline comment
|
||||
|
||||
node_capacity:
|
||||
cpu: 4 # cores
|
||||
memory_mb: 8192
|
||||
---
|
||||
`
|
||||
p := writeTestFile(t, t.TempDir(), "config.md", body)
|
||||
cfg, err := LoadMarkdown(p)
|
||||
if err != nil {
|
||||
t.Fatalf("LoadMarkdown: %v", err)
|
||||
}
|
||||
if cfg.ListenAddr != "127.0.0.1:9999" {
|
||||
t.Errorf("ListenAddr=%q", cfg.ListenAddr)
|
||||
}
|
||||
if cfg.DBPath != "/tmp/orca/test.db" {
|
||||
t.Errorf("DBPath=%q", cfg.DBPath)
|
||||
}
|
||||
if cfg.NodeCapacity == nil || cfg.NodeCapacity.CPU != 4 || cfg.NodeCapacity.MemoryMB != 8192 {
|
||||
t.Errorf("NodeCapacity=%+v", cfg.NodeCapacity)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadMarkdownYAML_Bare(t *testing.T) {
|
||||
body := "listen_addr: 0.0.0.0:5555\ndb_path: /bare.db\nnode_capacity:\n cpu: 2\n memory_mb: 4096\n"
|
||||
p := writeTestFile(t, t.TempDir(), "config.yaml", body)
|
||||
cfg, err := LoadMarkdownYAML(p)
|
||||
if err != nil {
|
||||
t.Fatalf("LoadMarkdownYAML: %v", err)
|
||||
}
|
||||
if cfg.ListenAddr != "0.0.0.0:5555" {
|
||||
t.Errorf("ListenAddr=%q", cfg.ListenAddr)
|
||||
}
|
||||
if cfg.DBPath != "/bare.db" {
|
||||
t.Errorf("DBPath=%q", cfg.DBPath)
|
||||
}
|
||||
if cfg.NodeCapacity == nil || cfg.NodeCapacity.CPU != 2 || cfg.NodeCapacity.MemoryMB != 4096 {
|
||||
t.Errorf("NodeCapacity=%+v", cfg.NodeCapacity)
|
||||
}
|
||||
}
|
||||
|
||||
func TestLoadMarkdown_ReadError(t *testing.T) {
|
||||
missing := filepath.Join(t.TempDir(), "nope.md")
|
||||
if _, err := LoadMarkdown(missing); err == nil {
|
||||
t.Fatal("expected error for missing file")
|
||||
}
|
||||
}
|
||||
|
||||
func TestExtractFrontmatter(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
input string
|
||||
block string
|
||||
present bool
|
||||
}{
|
||||
{"standard", "---\nkey: val\n---\nbody", "key: val", true},
|
||||
{"leading-blanks", "\n\n---\nkey: val\n---\n", "key: val", true},
|
||||
{"no-delimiters", "key: val\n", "key: val", false},
|
||||
{"only-open", "---\nkey: val\n", "key: val", false},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
block, ok := extractFrontmatter(tc.input)
|
||||
if ok != tc.present {
|
||||
t.Errorf("present=%v want %v", ok, tc.present)
|
||||
}
|
||||
if tc.present && block != tc.block {
|
||||
t.Errorf("block=%q want %q", block, tc.block)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestUnquote(t *testing.T) {
|
||||
if got, want := unquote(`"hello"`), "hello"; got != want {
|
||||
t.Errorf("unquote double = %q want %q", got, want)
|
||||
}
|
||||
if got, want := unquote(`'hello'`), "hello"; got != want {
|
||||
t.Errorf("unquote single = %q want %q", got, want)
|
||||
}
|
||||
if got, want := unquote("bare"), "bare"; got != want {
|
||||
t.Errorf("unquote bare = %q want %q", got, want)
|
||||
}
|
||||
}
|
||||
Vendored
+10
@@ -0,0 +1,10 @@
|
||||
db_path = "/tmp/orca/test.db"
|
||||
listen_addr = "127.0.0.1:9999"
|
||||
ca_path = "/tmp/orca/ca.crt"
|
||||
server_cert_path = "/tmp/orca/server.crt"
|
||||
server_key_path = "/tmp/orca/server.key"
|
||||
|
||||
node_capacity {
|
||||
cpu = 4
|
||||
memory_mb = 8192
|
||||
}
|
||||
@@ -0,0 +1,45 @@
|
||||
package daemon
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"log/slog"
|
||||
"net/http"
|
||||
"net/http/pprof"
|
||||
"time"
|
||||
)
|
||||
|
||||
func StartPprof(addr string, log *slog.Logger) (*http.Server, error) {
|
||||
if addr == "" {
|
||||
return nil, nil
|
||||
}
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/debug/pprof/", pprof.Index)
|
||||
mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)
|
||||
mux.HandleFunc("/debug/pprof/profile", pprof.Profile)
|
||||
mux.HandleFunc("/debug/pprof/symbol", pprof.Symbol)
|
||||
mux.HandleFunc("/debug/pprof/trace", pprof.Trace)
|
||||
mux.Handle("/debug/pprof/heap", pprof.Handler("heap"))
|
||||
mux.Handle("/debug/pprof/goroutine", pprof.Handler("goroutine"))
|
||||
mux.Handle("/debug/pprof/threadcreate", pprof.Handler("threadcreate"))
|
||||
mux.Handle("/debug/pprof/block", pprof.Handler("block"))
|
||||
mux.Handle("/debug/pprof/mutex", pprof.Handler("mutex"))
|
||||
|
||||
server := &http.Server{
|
||||
Addr: addr,
|
||||
Handler: mux,
|
||||
ReadHeaderTimeout: 5 * time.Second,
|
||||
}
|
||||
|
||||
log.Warn("pprof endpoint exposed",
|
||||
slog.String("addr", addr),
|
||||
slog.String("warning", "unauthenticated, operator-only — do not expose publicly"))
|
||||
|
||||
go func() {
|
||||
err := server.ListenAndServe()
|
||||
if err != nil && !errors.Is(err, http.ErrServerClosed) {
|
||||
log.Error("pprof server stopped", slog.String("addr", addr), slog.Any("err", err))
|
||||
}
|
||||
}()
|
||||
|
||||
return server, nil
|
||||
}
|
||||
@@ -0,0 +1,263 @@
|
||||
package daemon
|
||||
|
||||
import (
|
||||
"context"
|
||||
"io"
|
||||
"log/slog"
|
||||
"net"
|
||||
"net/http"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/store"
|
||||
)
|
||||
|
||||
func TestStartPprof_Disabled(t *testing.T) {
|
||||
srv, err := StartPprof("", slog.Default())
|
||||
if err != nil {
|
||||
t.Fatalf("StartPprof(\"\", _) returned err: %v", err)
|
||||
}
|
||||
if srv != nil {
|
||||
t.Fatalf("StartPprof(\"\", _) returned non-nil server: %v", srv)
|
||||
}
|
||||
}
|
||||
|
||||
func TestStartPprof_Enabled(t *testing.T) {
|
||||
log := slog.New(slog.NewTextHandler(io.Discard, nil))
|
||||
|
||||
ln, err := net.Listen("tcp", "127.0.0.1:0")
|
||||
if err != nil {
|
||||
t.Fatalf("listen: %v", err)
|
||||
}
|
||||
addr := ln.Addr().String()
|
||||
_ = ln.Close()
|
||||
|
||||
srv, err := StartPprof(addr, log)
|
||||
if err != nil {
|
||||
t.Fatalf("StartPprof returned err: %v", err)
|
||||
}
|
||||
if srv == nil {
|
||||
t.Fatal("StartPprof returned nil server for non-empty addr")
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
|
||||
defer cancel()
|
||||
_ = srv.Shutdown(ctx)
|
||||
})
|
||||
|
||||
deadline := time.Now().Add(2 * time.Second)
|
||||
var base string
|
||||
for time.Now().Before(deadline) {
|
||||
conn, derr := net.DialTimeout("tcp", addr, 50*time.Millisecond)
|
||||
if derr == nil {
|
||||
_ = conn.Close()
|
||||
base = "http://" + addr
|
||||
break
|
||||
}
|
||||
time.Sleep(20 * time.Millisecond)
|
||||
}
|
||||
if base == "" {
|
||||
t.Fatal("pprof server did not start listening")
|
||||
}
|
||||
|
||||
client := &http.Client{Timeout: 500 * time.Millisecond}
|
||||
for _, path := range []string{"/debug/pprof/", "/debug/pprof/cmdline", "/debug/pprof/heap"} {
|
||||
resp, gerr := client.Get(base + path)
|
||||
if gerr != nil {
|
||||
t.Errorf("GET %s: %v", path, gerr)
|
||||
continue
|
||||
}
|
||||
_, _ = io.Copy(io.Discard, resp.Body)
|
||||
_ = resp.Body.Close()
|
||||
if resp.StatusCode != 200 {
|
||||
t.Errorf("GET %s: expected 200, got %d", path, resp.StatusCode)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestStartPprof_Shutdown(t *testing.T) {
|
||||
log := slog.New(slog.NewTextHandler(io.Discard, nil))
|
||||
|
||||
ln, err := net.Listen("tcp", "127.0.0.1:0")
|
||||
if err != nil {
|
||||
t.Fatalf("listen: %v", err)
|
||||
}
|
||||
addr := ln.Addr().String()
|
||||
_ = ln.Close()
|
||||
|
||||
srv, err := StartPprof(addr, log)
|
||||
if err != nil {
|
||||
t.Fatalf("StartPprof returned err: %v", err)
|
||||
}
|
||||
if srv == nil {
|
||||
t.Fatal("StartPprof returned nil server")
|
||||
}
|
||||
|
||||
deadline := time.Now().Add(2 * time.Second)
|
||||
for time.Now().Before(deadline) {
|
||||
conn, derr := net.DialTimeout("tcp", addr, 50*time.Millisecond)
|
||||
if derr == nil {
|
||||
_ = conn.Close()
|
||||
break
|
||||
}
|
||||
time.Sleep(20 * time.Millisecond)
|
||||
}
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
|
||||
defer cancel()
|
||||
if err := srv.Shutdown(ctx); err != nil {
|
||||
t.Fatalf("Shutdown: %v", err)
|
||||
}
|
||||
|
||||
client := &http.Client{Timeout: 300 * time.Millisecond}
|
||||
_, gerr := client.Get("http://" + addr + "/debug/pprof/")
|
||||
if gerr == nil {
|
||||
t.Error("expected GET to fail after Shutdown, but it succeeded")
|
||||
}
|
||||
}
|
||||
|
||||
func TestStartPprof_MuxIsolated(t *testing.T) {
|
||||
log := slog.New(slog.NewTextHandler(io.Discard, nil))
|
||||
|
||||
ln, err := net.Listen("tcp", "127.0.0.1:0")
|
||||
if err != nil {
|
||||
t.Fatalf("listen: %v", err)
|
||||
}
|
||||
addr := ln.Addr().String()
|
||||
_ = ln.Close()
|
||||
|
||||
srv, err := StartPprof(addr, log)
|
||||
if err != nil {
|
||||
t.Fatalf("StartPprof returned err: %v", err)
|
||||
}
|
||||
if srv == nil {
|
||||
t.Fatal("StartPprof returned nil server")
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
|
||||
defer cancel()
|
||||
_ = srv.Shutdown(ctx)
|
||||
})
|
||||
|
||||
deadline := time.Now().Add(2 * time.Second)
|
||||
for time.Now().Before(deadline) {
|
||||
conn, derr := net.DialTimeout("tcp", addr, 50*time.Millisecond)
|
||||
if derr == nil {
|
||||
_ = conn.Close()
|
||||
break
|
||||
}
|
||||
time.Sleep(20 * time.Millisecond)
|
||||
}
|
||||
|
||||
client := &http.Client{Timeout: 500 * time.Millisecond}
|
||||
resp, err := client.Get("http://" + addr + "/healthz")
|
||||
if err != nil {
|
||||
t.Fatalf("GET /healthz: %v", err)
|
||||
}
|
||||
_, _ = io.Copy(io.Discard, resp.Body)
|
||||
_ = resp.Body.Close()
|
||||
if resp.StatusCode != 404 {
|
||||
t.Errorf("expected /healthz to 404 on pprof-only mux, got %d", resp.StatusCode)
|
||||
}
|
||||
}
|
||||
|
||||
func TestServer_WithPprof(t *testing.T) {
|
||||
db, err := store.Open(filepath.Join(t.TempDir(), "pprof.db"))
|
||||
if err != nil {
|
||||
t.Fatalf("open db: %v", err)
|
||||
}
|
||||
defer db.Close()
|
||||
|
||||
log := slog.New(slog.NewTextHandler(io.Discard, nil))
|
||||
|
||||
ln, err := net.Listen("tcp", "127.0.0.1:0")
|
||||
if err != nil {
|
||||
t.Fatalf("listen main: %v", err)
|
||||
}
|
||||
mainAddr := ln.Addr().String()
|
||||
|
||||
pln, err := net.Listen("tcp", "127.0.0.1:0")
|
||||
if err != nil {
|
||||
t.Fatalf("listen pprof: %v", err)
|
||||
}
|
||||
pprofAddr := pln.Addr().String()
|
||||
_ = pln.Close()
|
||||
|
||||
s := NewServer(Options{
|
||||
DB: db,
|
||||
Log: log,
|
||||
Addr: mainAddr,
|
||||
PprofAddr: pprofAddr,
|
||||
})
|
||||
s.MarkReady()
|
||||
|
||||
if s.pprofServer == nil {
|
||||
t.Fatal("expected pprofServer to be non-nil after NewServer with PprofAddr")
|
||||
}
|
||||
|
||||
errCh := make(chan error, 2)
|
||||
go func() {
|
||||
err := s.httpServer.Serve(ln)
|
||||
if err != nil && err != http.ErrServerClosed {
|
||||
errCh <- err
|
||||
}
|
||||
}()
|
||||
|
||||
deadline := time.Now().Add(2 * time.Second)
|
||||
for time.Now().Before(deadline) {
|
||||
conn, derr := net.DialTimeout("tcp", pprofAddr, 50*time.Millisecond)
|
||||
if derr == nil {
|
||||
_ = conn.Close()
|
||||
break
|
||||
}
|
||||
time.Sleep(20 * time.Millisecond)
|
||||
}
|
||||
|
||||
client := &http.Client{Timeout: 500 * time.Millisecond}
|
||||
resp, err := client.Get("http://" + mainAddr + "/healthz")
|
||||
if err != nil {
|
||||
t.Fatalf("GET main /healthz: %v", err)
|
||||
}
|
||||
if resp.StatusCode != 200 {
|
||||
t.Errorf("main /healthz: expected 200, got %d", resp.StatusCode)
|
||||
}
|
||||
_, _ = io.Copy(io.Discard, resp.Body)
|
||||
_ = resp.Body.Close()
|
||||
|
||||
presp, err := client.Get("http://" + pprofAddr + "/debug/pprof/")
|
||||
if err != nil {
|
||||
t.Fatalf("GET pprof /debug/pprof/: %v", err)
|
||||
}
|
||||
if presp.StatusCode != 200 {
|
||||
t.Errorf("pprof /debug/pprof/: expected 200, got %d", presp.StatusCode)
|
||||
}
|
||||
_, _ = io.Copy(io.Discard, presp.Body)
|
||||
_ = presp.Body.Close()
|
||||
|
||||
presp, err = client.Get("http://" + pprofAddr + "/healthz")
|
||||
if err != nil {
|
||||
t.Fatalf("GET pprof /healthz: %v", err)
|
||||
}
|
||||
_, _ = io.Copy(io.Discard, presp.Body)
|
||||
_ = presp.Body.Close()
|
||||
if presp.StatusCode != 404 {
|
||||
t.Errorf("expected /healthz 404 on pprof mux, got %d", presp.StatusCode)
|
||||
}
|
||||
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Second)
|
||||
defer cancel()
|
||||
if err := s.Shutdown(ctx); err != nil {
|
||||
t.Errorf("Shutdown: %v", err)
|
||||
}
|
||||
|
||||
client = &http.Client{Timeout: 300 * time.Millisecond}
|
||||
_, gerr := client.Get("http://" + pprofAddr + "/debug/pprof/")
|
||||
if gerr == nil {
|
||||
t.Error("expected pprof GET to fail after Shutdown")
|
||||
}
|
||||
_, merr := client.Get("http://" + mainAddr + "/healthz")
|
||||
if merr == nil {
|
||||
t.Error("expected main GET to fail after Shutdown")
|
||||
}
|
||||
}
|
||||
@@ -9,6 +9,12 @@
|
||||
// - structured JSON via writeJSON
|
||||
// - no secrets in logs
|
||||
// - input validation on path/query/body
|
||||
//
|
||||
// Deprecated: v0.9 re-architecture replaces this with SSH-push to bare
|
||||
// servers (no orca binary on servers) per R-001. The orca daemon is
|
||||
// repurposed to drain-and-stop in v0.10-P05 and scheduled for deletion
|
||||
// in v0.10-P14. See .ciagent/PRD_v0.9.md R-001/R-006. The dual-write
|
||||
// window (REQ-090/REQ-085) keeps this package compiling until v0.10-P14.
|
||||
package daemon
|
||||
|
||||
import (
|
||||
@@ -29,7 +35,8 @@ type Server struct {
|
||||
addr string
|
||||
ready atomic.Bool
|
||||
|
||||
httpServer *http.Server
|
||||
httpServer *http.Server
|
||||
pprofServer *http.Server
|
||||
|
||||
// mtls is non-nil after StartMTLS has been called; nil otherwise.
|
||||
// Plaintext HTTP and mTLS are mutually exclusive — a Server is
|
||||
@@ -49,6 +56,12 @@ type Options struct {
|
||||
Log *slog.Logger
|
||||
Addr string
|
||||
Actor string // used for audit logging from API requests
|
||||
|
||||
// PprofAddr enables the pprof endpoint on a separate listener
|
||||
// when non-empty (e.g. "127.0.0.1:6060"). Default "" disables it.
|
||||
// The pprof listener is unauthenticated and operator-only; never
|
||||
// expose it publicly (AD-024).
|
||||
PprofAddr string
|
||||
}
|
||||
|
||||
// NewServer constructs a Server with the default mux and route table.
|
||||
@@ -75,6 +88,14 @@ func NewServer(opts Options) *Server {
|
||||
WriteTimeout: 30 * time.Second,
|
||||
IdleTimeout: 60 * time.Second,
|
||||
}
|
||||
if opts.PprofAddr != "" {
|
||||
ps, perr := StartPprof(opts.PprofAddr, opts.Log)
|
||||
if perr != nil {
|
||||
s.log.Error("pprof start failed", slog.String("component", "daemon"), slog.Any("err", perr))
|
||||
} else {
|
||||
s.pprofServer = ps
|
||||
}
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
@@ -142,6 +163,11 @@ func (s *Server) Start() error {
|
||||
func (s *Server) Shutdown(ctx context.Context) error {
|
||||
s.MarkNotReady()
|
||||
s.log.Info("daemon shutting down", slog.String("component", "daemon"))
|
||||
if s.pprofServer != nil {
|
||||
if perr := s.pprofServer.Shutdown(ctx); perr != nil {
|
||||
s.log.Error("pprof shutdown failed", slog.String("component", "daemon"), slog.Any("err", perr))
|
||||
}
|
||||
}
|
||||
return s.httpServer.Shutdown(ctx)
|
||||
}
|
||||
|
||||
|
||||
+14
-10
@@ -26,11 +26,11 @@ import (
|
||||
"time"
|
||||
|
||||
"golang.org/x/crypto/ssh"
|
||||
"golang.org/x/crypto/ssh/knownhosts"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/certpaths"
|
||||
"git.cloudinit.dev/coreci/orca/internal/model"
|
||||
"git.cloudinit.dev/coreci/orca/internal/osdetect"
|
||||
"git.cloudinit.dev/coreci/orca/internal/proxmox"
|
||||
"git.cloudinit.dev/coreci/orca/internal/security"
|
||||
"git.cloudinit.dev/coreci/orca/internal/store"
|
||||
"git.cloudinit.dev/coreci/orca/internal/transport"
|
||||
@@ -409,7 +409,19 @@ func probeProxmoxPVEVersion(ctx context.Context, host string) error {
|
||||
return fmt.Errorf("parse SSH key: %w", err)
|
||||
}
|
||||
|
||||
hostKeyCallback, err := knownhosts.New(certpaths.KnownHostsPath())
|
||||
// Extract host from the node address (orca stores host:8443;
|
||||
// SSH needs host:22). We dial the SSH port, not the orca daemon port.
|
||||
sshHost := host
|
||||
if strings.Contains(host, ":") {
|
||||
sshHost = strings.SplitN(host, ":", 2)[0]
|
||||
}
|
||||
sshAddr := sshHost + ":22"
|
||||
|
||||
// Use the shared TOFU capture-fix wrapper (T02.9 — GRILL condition
|
||||
// #2: doctor parity with bootstrap). Without this, a first-connect
|
||||
// proxmox node (entry missing from known_hosts) fails the doctor
|
||||
// probe even though it joined fine — the v0.6 ship-defect.
|
||||
hostKeyCallback, err := proxmox.TOFUHostKeyCallback(sshAddr, nil)
|
||||
if err != nil {
|
||||
return fmt.Errorf("known_hosts: %w", err)
|
||||
}
|
||||
@@ -421,14 +433,6 @@ func probeProxmoxPVEVersion(ctx context.Context, host string) error {
|
||||
Timeout: 3 * time.Second,
|
||||
}
|
||||
|
||||
// Extract host from the node address (orca stores host:8443;
|
||||
// SSH needs host:22). We dial the SSH port, not the orca daemon port.
|
||||
sshHost := host
|
||||
if strings.Contains(host, ":") {
|
||||
sshHost = strings.SplitN(host, ":", 2)[0]
|
||||
}
|
||||
sshAddr := sshHost + ":22"
|
||||
|
||||
dialer := &netDialer{}
|
||||
conn, err := dialer.DialContext(ctx, "tcp", sshAddr, config)
|
||||
if err != nil {
|
||||
|
||||
@@ -2,14 +2,21 @@ package doctor
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/ed25519"
|
||||
"crypto/rand"
|
||||
"net"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"golang.org/x/crypto/ssh"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/certpaths"
|
||||
"git.cloudinit.dev/coreci/orca/internal/model"
|
||||
"git.cloudinit.dev/coreci/orca/internal/osdetect"
|
||||
"git.cloudinit.dev/coreci/orca/internal/proxmox"
|
||||
"git.cloudinit.dev/coreci/orca/internal/security"
|
||||
"git.cloudinit.dev/coreci/orca/internal/store"
|
||||
)
|
||||
@@ -135,7 +142,7 @@ func TestDBCheck_IntegrityOK(t *testing.T) {
|
||||
if r != ResultPass {
|
||||
t.Errorf("DB check: got %s, want PASS — %s", r, msg)
|
||||
}
|
||||
if !strings.Contains(msg, "0006") {
|
||||
if !strings.Contains(msg, "migrations up to") {
|
||||
t.Errorf("DB check message should contain migration version, got: %s", msg)
|
||||
}
|
||||
}
|
||||
@@ -396,3 +403,90 @@ func init() {
|
||||
// Suppress slog noise during tests.
|
||||
_ = os.Setenv("ORCA_LOG_LEVEL", "error")
|
||||
}
|
||||
|
||||
// TestProxmoxCheck_FirstConnectCapturesKey verifies that the doctor
|
||||
// proxmox probe uses the shared TOFU capture-fix wrapper
|
||||
// (proxmox.TOFUHostKeyCallback), which captures the host key on first
|
||||
// connect instead of failing with KeyError{Want:[]} (T02.9 — GRILL
|
||||
// condition #2: doctor parity with bootstrap). Before T02.9, the bare
|
||||
// knownhosts.New callback returned KeyError{Want:[]} on a missing
|
||||
// entry and the doctor probe reported FAIL even though the node had
|
||||
// joined successfully — the v0.6 ship-defect.
|
||||
//
|
||||
// We exercise the exact wrapper doctor.go calls against a real SSH
|
||||
// server on an ephemeral port (the probe hardcodes :22, which we
|
||||
// cannot bind in CI). This proves the doctor's chosen callback captures
|
||||
// on first connect rather than failing — the parity guarantee.
|
||||
func TestProxmoxCheck_FirstConnectCapturesKey(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
t.Setenv("ORCA_HOME", dir)
|
||||
|
||||
// Empty known_hosts (first-connect scenario).
|
||||
if err := os.WriteFile(certpaths.KnownHostsPath(), []byte{}, 0o600); err != nil {
|
||||
t.Fatalf("create known_hosts: %v", err)
|
||||
}
|
||||
|
||||
// Start a fake SSH server on an ephemeral port whose host key is
|
||||
// NOT yet in known_hosts.
|
||||
ln, err := net.Listen("tcp", "127.0.0.1:0")
|
||||
if err != nil {
|
||||
t.Fatalf("listen: %v", err)
|
||||
}
|
||||
defer ln.Close()
|
||||
_, srvPriv, err := ed25519.GenerateKey(rand.Reader)
|
||||
if err != nil {
|
||||
t.Fatalf("ed25519 gen: %v", err)
|
||||
}
|
||||
hostSigner, err := ssh.NewSignerFromKey(srvPriv)
|
||||
if err != nil {
|
||||
t.Fatalf("ssh signer: %v", err)
|
||||
}
|
||||
srvConfig := &ssh.ServerConfig{NoClientAuth: true}
|
||||
srvConfig.AddHostKey(hostSigner)
|
||||
go func() {
|
||||
for {
|
||||
nconn, err := ln.Accept()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
go func(c net.Conn) {
|
||||
defer c.Close()
|
||||
_, chans, reqs, err := ssh.NewServerConn(c, srvConfig)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
go ssh.DiscardRequests(reqs)
|
||||
for nc := range chans {
|
||||
nc.Reject(ssh.UnknownChannelType, "none")
|
||||
}
|
||||
}(nconn)
|
||||
}
|
||||
}()
|
||||
|
||||
sshAddr := ln.Addr().String()
|
||||
host, _, _ := net.SplitHostPort(sshAddr)
|
||||
|
||||
// The doctor probe now builds its HostKeyCallback via
|
||||
// proxmox.TOFUHostKeyCallback(sshAddr, nil). On first connect
|
||||
// (empty known_hosts) this must capture + write the key and return
|
||||
// nil, NOT a KeyError — the v0.6 ship-defect fix.
|
||||
cb, err := proxmox.TOFUHostKeyCallback(sshAddr, nil)
|
||||
if err != nil {
|
||||
t.Fatalf("TOFUHostKeyCallback: %v", err)
|
||||
}
|
||||
if err := cb(sshAddr, &net.TCPAddr{IP: net.ParseIP(host), Port: 22}, hostSigner.PublicKey()); err != nil {
|
||||
t.Fatalf("first-connect doctor callback should capture (not fail): %v", err)
|
||||
}
|
||||
|
||||
// The captured key must now be in known_hosts.
|
||||
data, err := os.ReadFile(certpaths.KnownHostsPath())
|
||||
if err != nil {
|
||||
t.Fatalf("read known_hosts: %v", err)
|
||||
}
|
||||
if len(data) == 0 {
|
||||
t.Error("known_hosts is empty — doctor capture-fix did not write the key (T02.9)")
|
||||
}
|
||||
if !strings.Contains(string(data), hostSigner.PublicKey().Type()) {
|
||||
t.Errorf("known_hosts missing the captured host key type: %s", data)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,80 @@
|
||||
// Package emit defines the render-format contract between Go-side emitters
|
||||
// and bash-side appliers (grill C-16). Every rendered artifact is a JSON
|
||||
// object with a versioned schema; both sides validate against it to prevent
|
||||
// emitter/applier drift.
|
||||
package emit
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// SchemaVersion is the canonical versioned schema identifier for render
|
||||
// contracts. Bump the suffix when the contract shape changes.
|
||||
const SchemaVersion = "orca.emit/v1"
|
||||
|
||||
// Kind enumerates the rendered-artifact kinds. Each maps to an emitter
|
||||
// implementation and a matching bash-side applier.
|
||||
type Kind string
|
||||
|
||||
const (
|
||||
KindSystemd Kind = "systemd"
|
||||
KindTraefik Kind = "traefik"
|
||||
KindSyncthing Kind = "syncthing"
|
||||
KindSudoers Kind = "sudoers"
|
||||
KindSSHD Kind = "sshd"
|
||||
KindEnvFile Kind = "envfile"
|
||||
KindCredential Kind = "credential"
|
||||
)
|
||||
|
||||
// Artifact is a single rendered file destined for a peer. The bash-side
|
||||
// applier reads this JSON and writes Content to Path with the given Mode.
|
||||
type Artifact struct {
|
||||
SchemaVersion string `json:"schema_version"`
|
||||
Kind Kind `json:"kind"`
|
||||
Path string `json:"path"`
|
||||
Content string `json:"content"`
|
||||
Mode string `json:"mode"`
|
||||
}
|
||||
|
||||
// Validate checks that an Artifact conforms to the render contract.
|
||||
// Returns a structured error if any field is missing or invalid.
|
||||
func (a *Artifact) Validate() error {
|
||||
if a.SchemaVersion != SchemaVersion {
|
||||
return fmt.Errorf("emit: schema_version mismatch: got %q want %q", a.SchemaVersion, SchemaVersion)
|
||||
}
|
||||
if a.Kind == "" {
|
||||
return errors.New("emit: kind is required")
|
||||
}
|
||||
if a.Path == "" {
|
||||
return errors.New("emit: path is required")
|
||||
}
|
||||
if a.Mode == "" {
|
||||
return errors.New("emit: mode is required")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Marshal serializes an Artifact to JSON for transport to the bash applier.
|
||||
func (a *Artifact) Marshal() ([]byte, error) {
|
||||
if err := a.Validate(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return json.Marshal(a)
|
||||
}
|
||||
|
||||
// UnmarshalArtifact parses a JSON byte slice into an Artifact and validates
|
||||
// it against the contract. The bash-side applier (via orca-verify-render.sh)
|
||||
// uses this same validation; the bash side rejects unparseable input with a
|
||||
// structured error, never silently (grill C-16).
|
||||
func UnmarshalArtifact(data []byte) (*Artifact, error) {
|
||||
var a Artifact
|
||||
if err := json.Unmarshal(data, &a); err != nil {
|
||||
return nil, fmt.Errorf("emit: unmarshal: %w", err)
|
||||
}
|
||||
if err := a.Validate(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &a, nil
|
||||
}
|
||||
@@ -0,0 +1,120 @@
|
||||
package emit
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestArtifactValidate_valid(t *testing.T) {
|
||||
a := &Artifact{
|
||||
SchemaVersion: SchemaVersion,
|
||||
Kind: KindSystemd,
|
||||
Path: "/etc/systemd/system/orca-alloc.service",
|
||||
Content: "[Service]\nExecStart=/bin/true\n",
|
||||
Mode: "0644",
|
||||
}
|
||||
if err := a.Validate(); err != nil {
|
||||
t.Fatalf("expected valid, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestArtifactValidate_schemaVersionMismatch(t *testing.T) {
|
||||
a := &Artifact{SchemaVersion: "orca.emit/v0", Kind: KindSystemd, Path: "/x", Mode: "0644"}
|
||||
err := a.Validate()
|
||||
if err == nil {
|
||||
t.Fatal("expected error for mismatched schema_version")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "schema_version mismatch") {
|
||||
t.Fatalf("expected schema_version error, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestArtifactValidate_missingKind(t *testing.T) {
|
||||
a := &Artifact{SchemaVersion: SchemaVersion, Path: "/x", Mode: "0644"}
|
||||
err := a.Validate()
|
||||
if err == nil || !strings.Contains(err.Error(), "kind is required") {
|
||||
t.Fatalf("expected kind-required error, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestArtifactValidate_missingPath(t *testing.T) {
|
||||
a := &Artifact{SchemaVersion: SchemaVersion, Kind: KindTraefik, Mode: "0644"}
|
||||
err := a.Validate()
|
||||
if err == nil || !strings.Contains(err.Error(), "path is required") {
|
||||
t.Fatalf("expected path-required error, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestArtifactValidate_missingMode(t *testing.T) {
|
||||
a := &Artifact{SchemaVersion: SchemaVersion, Kind: KindSudoers, Path: "/x"}
|
||||
err := a.Validate()
|
||||
if err == nil || !strings.Contains(err.Error(), "mode is required") {
|
||||
t.Fatalf("expected mode-required error, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMarshalValidate_rejectsInvalid(t *testing.T) {
|
||||
a := &Artifact{SchemaVersion: "bad", Kind: "", Path: "", Mode: ""}
|
||||
if _, err := a.Marshal(); err == nil {
|
||||
t.Fatal("expected Marshal to reject invalid artifact")
|
||||
}
|
||||
}
|
||||
|
||||
func TestUnmarshalArtifact_valid(t *testing.T) {
|
||||
raw := `{"schema_version":"orca.emit/v1","kind":"systemd","path":"/x","content":"c","mode":"0644"}`
|
||||
a, err := UnmarshalArtifact([]byte(raw))
|
||||
if err != nil {
|
||||
t.Fatalf("expected valid, got %v", err)
|
||||
}
|
||||
if a.Kind != KindSystemd {
|
||||
t.Fatalf("expected kind systemd, got %s", a.Kind)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUnmarshalArtifact_rejectsBadJSON(t *testing.T) {
|
||||
if _, err := UnmarshalArtifact([]byte("not json")); err == nil {
|
||||
t.Fatal("expected error for bad JSON")
|
||||
}
|
||||
}
|
||||
|
||||
func TestUnmarshalArtifact_rejectsSchemaMismatch(t *testing.T) {
|
||||
raw := `{"schema_version":"orca.emit/v2","kind":"x","path":"/x","mode":"0644"}`
|
||||
if _, err := UnmarshalArtifact([]byte(raw)); err == nil {
|
||||
t.Fatal("expected error for schema mismatch")
|
||||
}
|
||||
}
|
||||
|
||||
func TestRoundTrip(t *testing.T) {
|
||||
orig := &Artifact{
|
||||
SchemaVersion: SchemaVersion,
|
||||
Kind: KindSyncthing,
|
||||
Path: "/etc/syncthing/config.xml",
|
||||
Content: "<config/>",
|
||||
Mode: "0600",
|
||||
}
|
||||
data, err := orig.Marshal()
|
||||
if err != nil {
|
||||
t.Fatalf("Marshal: %v", err)
|
||||
}
|
||||
back, err := UnmarshalArtifact(data)
|
||||
if err != nil {
|
||||
t.Fatalf("Unmarshal: %v", err)
|
||||
}
|
||||
if back.Path != orig.Path || back.Kind != orig.Kind || back.Mode != orig.Mode {
|
||||
t.Fatalf("round-trip mismatch: %+v vs %+v", orig, back)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAllKinds(t *testing.T) {
|
||||
for _, k := range []Kind{KindSystemd, KindTraefik, KindSyncthing, KindSudoers, KindSSHD, KindEnvFile, KindCredential} {
|
||||
a := &Artifact{SchemaVersion: SchemaVersion, Kind: k, Path: "/x", Mode: "0644"}
|
||||
if err := a.Validate(); err != nil {
|
||||
t.Errorf("kind %s: %v", k, err)
|
||||
}
|
||||
// verify it marshals
|
||||
if _, err := json.Marshal(a); err != nil {
|
||||
t.Errorf("marshal kind %s: %v", k, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,94 @@
|
||||
// Package emitter defines the Layer-4 emitter interface (REQ-074,
|
||||
// I-B-002): the bridge between the declarative *jobspec.WorkloadSpec
|
||||
// and the server-side files. An Emitter renders a *WorkloadSpec into a
|
||||
// slice of File artifacts that the SSH-push transport SCPs to peers.
|
||||
//
|
||||
// Emitters are registered per workload kind + runtime (e.g.
|
||||
// "service:wasm", "job:process", "daemonset:wasm"). The Registry looks
|
||||
// up the right emitter by "<kind>:<runtime>" and delegates. Unknown
|
||||
// combinations return an error so the caller can fail fast before any
|
||||
// file is written.
|
||||
//
|
||||
// P0c only ships the interface, the Registry, a stub SystemdEmitter
|
||||
// (process runtime), and the File/Node value types. The full emitter
|
||||
// implementations (systemd lifecycle hooks, Traefik, Syncthing,
|
||||
// sockets) land in later phases (P02 Traefik, P04 lifecycle, P08
|
||||
// sockets, P09 Syncthing, v0.10-P03 secrets).
|
||||
package emitter
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/jobspec"
|
||||
)
|
||||
|
||||
// File is a single rendered artifact destined for a peer. The SSH-push
|
||||
// transport writes Content to Path atomically (write-to-tmp + rename)
|
||||
// with the given Mode (an octal string like "0644").
|
||||
type File struct {
|
||||
Path string
|
||||
Content string
|
||||
Mode string
|
||||
}
|
||||
|
||||
// Node is the minimal peer description an emitter needs to render
|
||||
// node-specific paths. It carries the hostname, the runtimes available
|
||||
// on the node (so emitters can branch), and the node tags (used by
|
||||
// DaemonSet matching and affinity in P05).
|
||||
type Node struct {
|
||||
Hostname string
|
||||
Runtime []string
|
||||
Tags []string
|
||||
}
|
||||
|
||||
// Emitter renders a *jobspec.WorkloadSpec for a given Node into a slice
|
||||
// of File artifacts. Implementations are registered with a Registry
|
||||
// keyed by "<kind>:<runtime>".
|
||||
type Emitter interface {
|
||||
Render(spec *jobspec.WorkloadSpec, node *Node) ([]File, error)
|
||||
}
|
||||
|
||||
// Registry holds emitters keyed by "<kind>:<runtime>" (e.g.
|
||||
// "service:process", "job:wasm"). The zero-value Registry is not
|
||||
// usable; construct one with NewRegistry.
|
||||
type Registry struct {
|
||||
emitters map[string]Emitter
|
||||
}
|
||||
|
||||
// NewRegistry returns an empty Registry ready for Register calls.
|
||||
func NewRegistry() *Registry {
|
||||
return &Registry{emitters: make(map[string]Emitter)}
|
||||
}
|
||||
|
||||
// Register registers an Emitter under the given key. The key is
|
||||
// "<kind>:<runtime>" (e.g. "job:process"). Registering twice under the
|
||||
// same key overwrites the prior registration (last-wins) to keep the
|
||||
// surface simple; callers are responsible for not double-registering.
|
||||
func (r *Registry) Register(key string, e Emitter) {
|
||||
r.emitters[key] = e
|
||||
}
|
||||
|
||||
// Render looks up the emitter for "<kind>:<runtime>" in the registry and
|
||||
// delegates to it. The kind is lowercased so the canonical spec kinds
|
||||
// (Job, Service, DaemonSet) map to the lowercase registry keys
|
||||
// ("job:process", "service:wasm", "daemonset:process"). Returns an error
|
||||
// if the spec is nil, the spec is missing its Kind, the runtime is
|
||||
// missing, or no emitter is registered for the combination.
|
||||
func (r *Registry) Render(spec *jobspec.WorkloadSpec, node *Node) ([]File, error) {
|
||||
if spec == nil {
|
||||
return nil, fmt.Errorf("emitter: spec is nil")
|
||||
}
|
||||
if strings.TrimSpace(spec.Kind) == "" {
|
||||
return nil, fmt.Errorf("emitter: spec kind is empty")
|
||||
}
|
||||
if spec.Runtime == nil {
|
||||
return nil, fmt.Errorf("emitter: spec runtime is nil")
|
||||
}
|
||||
key := strings.ToLower(spec.Kind) + ":" + spec.Runtime.OneOf
|
||||
e, ok := r.emitters[key]
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("emitter: no emitter registered for %q (kind:runtime)", key)
|
||||
}
|
||||
return e.Render(spec, node)
|
||||
}
|
||||
@@ -0,0 +1,163 @@
|
||||
package emitter
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/jobspec"
|
||||
)
|
||||
|
||||
// mockEmitter is a test-only Emitter that returns a fixed File slice
|
||||
// (or an error) so the Registry tests do not depend on the
|
||||
// SystemdEmitter. Implements Emitter via value receiver.
|
||||
type mockEmitter struct {
|
||||
files []File
|
||||
err error
|
||||
}
|
||||
|
||||
func (m mockEmitter) Render(spec *jobspec.WorkloadSpec, node *Node) ([]File, error) {
|
||||
if m.err != nil {
|
||||
return nil, m.err
|
||||
}
|
||||
out := make([]File, len(m.files))
|
||||
copy(out, m.files)
|
||||
return out, nil
|
||||
}
|
||||
|
||||
func TestRegistry_RegisterAndRender(t *testing.T) {
|
||||
r := NewRegistry()
|
||||
want := []File{{Path: "/tmp/a", Content: "alpha", Mode: "0644"}}
|
||||
r.Register("job:process", mockEmitter{files: want})
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Job",
|
||||
Name: "demo",
|
||||
Runtime: &jobspec.RuntimeBlock{OneOf: "process", Command: "/bin/true"},
|
||||
}
|
||||
node := &Node{Hostname: "node-1", Runtime: []string{"process"}}
|
||||
got, err := r.Render(spec, node)
|
||||
if err != nil {
|
||||
t.Fatalf("Render: %v", err)
|
||||
}
|
||||
if len(got) != 1 {
|
||||
t.Fatalf("got %d files, want 1", len(got))
|
||||
}
|
||||
if got[0] != want[0] {
|
||||
t.Errorf("file = %+v, want %+v", got[0], want[0])
|
||||
}
|
||||
}
|
||||
|
||||
func TestRegistry_UnknownKindRuntime(t *testing.T) {
|
||||
r := NewRegistry()
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "web",
|
||||
Runtime: &jobspec.RuntimeBlock{OneOf: "wasm"},
|
||||
}
|
||||
_, err := r.Render(spec, &Node{})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for unknown kind:runtime, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "no emitter registered") {
|
||||
t.Errorf("error = %q, want 'no emitter registered'", err.Error())
|
||||
}
|
||||
if !strings.Contains(err.Error(), "service:wasm") {
|
||||
t.Errorf("error = %q, want it to mention 'service:wasm'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestRegistry_MultipleEmittersCorrectSelected(t *testing.T) {
|
||||
r := NewRegistry()
|
||||
jobFiles := []File{{Path: "/tmp/job", Content: "job", Mode: "0644"}}
|
||||
svcFiles := []File{{Path: "/tmp/svc", Content: "svc", Mode: "0644"}}
|
||||
dsFiles := []File{{Path: "/tmp/ds", Content: "ds", Mode: "0644"}}
|
||||
r.Register("job:process", mockEmitter{files: jobFiles})
|
||||
r.Register("service:process", mockEmitter{files: svcFiles})
|
||||
r.Register("daemonset:process", mockEmitter{files: dsFiles})
|
||||
|
||||
cases := []struct {
|
||||
kind string
|
||||
runtime string
|
||||
wantPath string
|
||||
}{
|
||||
{"Job", "process", "/tmp/job"},
|
||||
{"Service", "process", "/tmp/svc"},
|
||||
{"DaemonSet", "process", "/tmp/ds"},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.kind+":"+tc.runtime, func(t *testing.T) {
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: tc.kind,
|
||||
Name: "x",
|
||||
Runtime: &jobspec.RuntimeBlock{OneOf: tc.runtime, Command: "/bin/x"},
|
||||
}
|
||||
got, err := r.Render(spec, &Node{Hostname: "n"})
|
||||
if err != nil {
|
||||
t.Fatalf("Render: %v", err)
|
||||
}
|
||||
if len(got) != 1 {
|
||||
t.Fatalf("got %d files, want 1", len(got))
|
||||
}
|
||||
if got[0].Path != tc.wantPath {
|
||||
t.Errorf("path = %q, want %q", got[0].Path, tc.wantPath)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestRegistry_NilSpec(t *testing.T) {
|
||||
r := NewRegistry()
|
||||
_, err := r.Render(nil, &Node{})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for nil spec")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "spec is nil") {
|
||||
t.Errorf("error = %q, want 'spec is nil'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestRegistry_EmptyKind(t *testing.T) {
|
||||
r := NewRegistry()
|
||||
spec := &jobspec.WorkloadSpec{Runtime: &jobspec.RuntimeBlock{OneOf: "process"}}
|
||||
_, err := r.Render(spec, &Node{})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for empty kind")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "kind is empty") {
|
||||
t.Errorf("error = %q, want 'kind is empty'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestRegistry_NilRuntime(t *testing.T) {
|
||||
r := NewRegistry()
|
||||
spec := &jobspec.WorkloadSpec{Kind: "Job", Name: "x"}
|
||||
_, err := r.Render(spec, &Node{})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for nil runtime")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "runtime is nil") {
|
||||
t.Errorf("error = %q, want 'runtime is nil'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestRegistry_EmitterErrorPropagates(t *testing.T) {
|
||||
r := NewRegistry()
|
||||
wantErr := errors.New("boom")
|
||||
r.Register("job:process", mockEmitter{err: wantErr})
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Job",
|
||||
Name: "x",
|
||||
Runtime: &jobspec.RuntimeBlock{OneOf: "process", Command: "/bin/x"},
|
||||
}
|
||||
_, err := r.Render(spec, &Node{})
|
||||
if !errors.Is(err, wantErr) {
|
||||
t.Errorf("err = %v, want %v", err, wantErr)
|
||||
}
|
||||
}
|
||||
|
||||
// Compile-time assertion that mockEmitter and SystemdEmitter implement
|
||||
// Emitter.
|
||||
var (
|
||||
_ Emitter = mockEmitter{}
|
||||
_ Emitter = SystemdEmitter{}
|
||||
)
|
||||
@@ -0,0 +1,60 @@
|
||||
package emitter
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/jobspec"
|
||||
)
|
||||
|
||||
// SystemdEmitter is a stub Emitter implementation for the "process"
|
||||
// runtime. It renders a minimal systemd unit file for the workload.
|
||||
//
|
||||
// This is a STUB — the full systemd emitter (with lifecycle hooks,
|
||||
// sockets, EnvironmentFile, LoadCredential) lands in later phases:
|
||||
//
|
||||
// - P04: lifecycle hooks (ExecStop, ExecStartPre/Post, timeouts)
|
||||
// - P08: socket plumbing (R-007)
|
||||
// - v0.10-P03: secrets via EnvironmentFile= + LoadCredential=
|
||||
//
|
||||
// P0c ships only the minimal [Service]\nExecStart=... shape to prove
|
||||
// the Emitter interface end-to-end. The unit name carries the
|
||||
// `orca-v1-` prefix per the dual-write window (REQ-090) so the v0.9
|
||||
// SSH-push path does not collide with the v0.8 daemon's
|
||||
// `orca-<job>.service` units during the migration window.
|
||||
type SystemdEmitter struct{}
|
||||
|
||||
// unitNamePrefix is the v0.9 SSH-push unit-name prefix. The v0.8
|
||||
// daemon uses `orca-<job>.service`; the v0.9 path uses
|
||||
// `orca-v1-<spec.Name>.service` so the two never overlap (REQ-090,
|
||||
// I-C-006). The prefix is load-bearing — do not change it without
|
||||
// updating the dual-write window contract.
|
||||
const unitNamePrefix = "orca-v1-"
|
||||
|
||||
// Render renders a minimal systemd unit file for a process-runtime
|
||||
// workload. The unit name is `/etc/systemd/system/<unitNamePrefix><spec.Name>.service`
|
||||
// and the content is a minimal `[Service]` block with the runtime
|
||||
// command as ExecStart. Mode is 0644 (the lead applier chmods after
|
||||
// atomic rename).
|
||||
//
|
||||
// Returns an error if the spec is nil, the spec is missing its name,
|
||||
// or the runtime command is empty (a workload with no command has
|
||||
// nothing to ExecStart).
|
||||
func (SystemdEmitter) Render(spec *jobspec.WorkloadSpec, node *Node) ([]File, error) {
|
||||
if spec == nil {
|
||||
return nil, errors.New("emitter/systemd: spec is nil")
|
||||
}
|
||||
if strings.TrimSpace(spec.Name) == "" {
|
||||
return nil, errors.New("emitter/systemd: spec name is empty")
|
||||
}
|
||||
if spec.Runtime == nil {
|
||||
return nil, errors.New("emitter/systemd: runtime block is nil")
|
||||
}
|
||||
if strings.TrimSpace(spec.Runtime.Command) == "" {
|
||||
return nil, errors.New("emitter/systemd: runtime command is empty")
|
||||
}
|
||||
path := fmt.Sprintf("/etc/systemd/system/%s%s.service", unitNamePrefix, spec.Name)
|
||||
content := fmt.Sprintf("[Service]\nExecStart=%s\n", spec.Runtime.Command)
|
||||
return []File{{Path: path, Content: content, Mode: "0644"}}, nil
|
||||
}
|
||||
@@ -0,0 +1,156 @@
|
||||
package emitter
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/jobspec"
|
||||
)
|
||||
|
||||
func TestSystemdEmitter_RenderJob(t *testing.T) {
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Job",
|
||||
Name: "backup",
|
||||
Runtime: &jobspec.RuntimeBlock{OneOf: "process", Command: "/usr/bin/rsync -a /src /dst"},
|
||||
}
|
||||
node := &Node{Hostname: "node-1", Runtime: []string{"process"}}
|
||||
files, err := SystemdEmitter{}.Render(spec, node)
|
||||
if err != nil {
|
||||
t.Fatalf("Render: %v", err)
|
||||
}
|
||||
if len(files) != 1 {
|
||||
t.Fatalf("got %d files, want 1", len(files))
|
||||
}
|
||||
f := files[0]
|
||||
wantPath := "/etc/systemd/system/orca-v1-backup.service"
|
||||
if f.Path != wantPath {
|
||||
t.Errorf("Path = %q, want %q", f.Path, wantPath)
|
||||
}
|
||||
wantContent := "[Service]\nExecStart=/usr/bin/rsync -a /src /dst\n"
|
||||
if f.Content != wantContent {
|
||||
t.Errorf("Content = %q, want %q", f.Content, wantContent)
|
||||
}
|
||||
if f.Mode != "0644" {
|
||||
t.Errorf("Mode = %q, want 0644", f.Mode)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSystemdEmitter_RenderService(t *testing.T) {
|
||||
// The full service emitter (Traefik route + health checks) lands in
|
||||
// P02; here we only prove the systemd side renders for a Service
|
||||
// kind with a process runtime.
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "web",
|
||||
Runtime: &jobspec.RuntimeBlock{OneOf: "process", Command: "/usr/local/bin/httpd -f"},
|
||||
}
|
||||
node := &Node{Hostname: "node-1", Runtime: []string{"process"}}
|
||||
files, err := SystemdEmitter{}.Render(spec, node)
|
||||
if err != nil {
|
||||
t.Fatalf("Render: %v", err)
|
||||
}
|
||||
if len(files) != 1 {
|
||||
t.Fatalf("got %d files, want 1", len(files))
|
||||
}
|
||||
if files[0].Path != "/etc/systemd/system/orca-v1-web.service" {
|
||||
t.Errorf("Path = %q, want /etc/systemd/system/orca-v1-web.service", files[0].Path)
|
||||
}
|
||||
if !strings.Contains(files[0].Content, "ExecStart=/usr/local/bin/httpd -f") {
|
||||
t.Errorf("Content = %q, want it to contain the ExecStart line", files[0].Content)
|
||||
}
|
||||
}
|
||||
|
||||
func TestSystemdEmitter_EmptyCommandError(t *testing.T) {
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Job",
|
||||
Name: "x",
|
||||
Runtime: &jobspec.RuntimeBlock{OneOf: "process", Command: ""},
|
||||
}
|
||||
_, err := SystemdEmitter{}.Render(spec, &Node{})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for empty command, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "command is empty") {
|
||||
t.Errorf("error = %q, want 'command is empty'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestSystemdEmitter_WhitespaceCommandError(t *testing.T) {
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Job",
|
||||
Name: "x",
|
||||
Runtime: &jobspec.RuntimeBlock{OneOf: "process", Command: " "},
|
||||
}
|
||||
_, err := SystemdEmitter{}.Render(spec, &Node{})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for whitespace-only command, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "command is empty") {
|
||||
t.Errorf("error = %q, want 'command is empty'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestSystemdEmitter_NilSpec(t *testing.T) {
|
||||
v := SystemdEmitter{}
|
||||
if _, err := v.Render(nil, &Node{}); err == nil {
|
||||
t.Fatal("expected error for nil spec")
|
||||
}
|
||||
}
|
||||
|
||||
func TestSystemdEmitter_EmptyName(t *testing.T) {
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Job",
|
||||
Name: " ",
|
||||
Runtime: &jobspec.RuntimeBlock{OneOf: "process", Command: "/bin/x"},
|
||||
}
|
||||
_, err := SystemdEmitter{}.Render(spec, &Node{})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for empty name")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "name is empty") {
|
||||
t.Errorf("error = %q, want 'name is empty'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestSystemdEmitter_NilRuntime(t *testing.T) {
|
||||
spec := &jobspec.WorkloadSpec{Kind: "Job", Name: "x"}
|
||||
_, err := SystemdEmitter{}.Render(spec, &Node{})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for nil runtime")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "runtime block is nil") {
|
||||
t.Errorf("error = %q, want 'runtime block is nil'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestSystemdEmitter_UnitNamePrefix(t *testing.T) {
|
||||
// The orca-v1- prefix is load-bearing for the dual-write window
|
||||
// (REQ-090, I-C-006): the v0.8 daemon writes `orca-<job>.service`
|
||||
// and the v0.9 SSH-push path writes `orca-v1-<spec.Name>.service`,
|
||||
// so the two never collide. This test guards against accidental
|
||||
// removal of the prefix.
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Job",
|
||||
Name: "dual-write-safety",
|
||||
Runtime: &jobspec.RuntimeBlock{OneOf: "process", Command: "/bin/true"},
|
||||
}
|
||||
files, err := SystemdEmitter{}.Render(spec, &Node{Hostname: "n"})
|
||||
if err != nil {
|
||||
t.Fatalf("Render: %v", err)
|
||||
}
|
||||
if !strings.HasPrefix(files[0].Path, "/etc/systemd/system/orca-v1-") {
|
||||
t.Errorf("Path = %q, want it to start with /etc/systemd/system/orca-v1- (REQ-090)", files[0].Path)
|
||||
}
|
||||
if !strings.HasSuffix(files[0].Path, ".service") {
|
||||
t.Errorf("Path = %q, want it to end with .service", files[0].Path)
|
||||
}
|
||||
// Explicitly assert the full expected unit name to lock the contract.
|
||||
want := "/etc/systemd/system/orca-v1-dual-write-safety.service"
|
||||
if files[0].Path != want {
|
||||
t.Errorf("Path = %q, want %q", files[0].Path, want)
|
||||
}
|
||||
// Sanity: the prefix is exactly "orca-v1-", not "orca-v0" or "orca".
|
||||
if unitNamePrefix != "orca-v1-" {
|
||||
t.Errorf("unitNamePrefix = %q, want orca-v1-", unitNamePrefix)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,225 @@
|
||||
package emitter
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"net"
|
||||
"strings"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/jobspec"
|
||||
)
|
||||
|
||||
// TraefikEmitter is the Layer-4 emitter for the Traefik dynamic-config
|
||||
// file (REQ-077). It renders /etc/traefik/dynamic/orca-<spec.Name>.yaml
|
||||
// — a single Traefik dynamic-config file describing the routers,
|
||||
// services (servers = the R-007 socket paths), TLS config pointing at
|
||||
// the step-ca root CA, and the service health check.
|
||||
//
|
||||
// Registered on the emitter.Registry under the service-kind keys:
|
||||
//
|
||||
// - service:process
|
||||
// - service:podman
|
||||
// - service:wasm
|
||||
//
|
||||
// RegisterTraefik wires all three; callers can also call Register
|
||||
// directly with TraefikEmitter{} for a single runtime.
|
||||
//
|
||||
// Atomic reload (gate C-10): the Traefik dynamic-config file is written
|
||||
// atomically via the SSH-push transport (sshpush.WriteFileIdempotent
|
||||
// performs temp-file + fsync + rename, and WriteTraefikDynamic wraps
|
||||
// it with an explicit tmp+mv so fsnotify sees a single rename event).
|
||||
// Traefik watches the dynamic dir with fsnotify; the rename triggers a
|
||||
// reload. On a malformed config Traefik logs an error and holds the
|
||||
// last-good config (documented Traefik behavior; the C-10 test
|
||||
// verifies the tmp+rename sequence so a half-written file is never
|
||||
// observed by Traefik). Drain is rendered by setting the backend
|
||||
// server's weight to 0 (or removing it) — see RenderDrain.
|
||||
//
|
||||
// The orca-v1- prefix is NOT applied to Traefik dynamic-config paths
|
||||
// (the prefix is only for systemd unit names; the Traefik file is named
|
||||
// orca-<spec.Name>.yaml and is the single source of truth for the
|
||||
// service route — there is no dual-write window for Traefik configs).
|
||||
type TraefikEmitter struct{}
|
||||
|
||||
// traefikDynamicDir is the canonical Traefik dynamic-config directory
|
||||
// (R-006). The emitter writes one file per service at
|
||||
// /etc/traefik/dynamic/orca-<spec.Name>.yaml.
|
||||
const traefikDynamicDir = "/etc/traefik/dynamic"
|
||||
|
||||
// traefikRouterTLSCertResolver is the Traefik cert-resolver name that
|
||||
// the orca step-ca integration configures on the Traefik static config
|
||||
// (P10 / v0.10 wires the step-ca root into this resolver). The
|
||||
// dynamic-config file references it by name.
|
||||
const traefikRouterTLSCertResolver = "orca"
|
||||
|
||||
// defaultTrustDomain is the SPIFFE trust domain used in the rendered
|
||||
// TLS stanza when the spec does not carry an explicit trust domain.
|
||||
// The step-ca provisioner (P10) overrides this at render time via the
|
||||
// node argument; for P02 the emitter renders the placeholder.
|
||||
const defaultTrustDomain = "cluster.orca.local"
|
||||
|
||||
// Render renders the Traefik dynamic-config YAML for a Service
|
||||
// workload. The output is a single File whose Path is
|
||||
// /etc/traefik/dynamic/orca-<spec.Name>.yaml, Content is the rendered
|
||||
// YAML, and Mode is 0644.
|
||||
//
|
||||
// Returns an error if the spec is nil, the name is empty, the spec has
|
||||
// no ports (a Service with no ports has no backends to route to), or a
|
||||
// service.bind value (when present) is not a valid IP address (R-007).
|
||||
func (TraefikEmitter) Render(spec *jobspec.WorkloadSpec, node *Node) ([]File, error) {
|
||||
if spec == nil {
|
||||
return nil, errors.New("emitter/traefik: spec is nil")
|
||||
}
|
||||
if strings.TrimSpace(spec.Name) == "" {
|
||||
return nil, errors.New("emitter/traefik: spec name is empty")
|
||||
}
|
||||
if len(spec.Ports) == 0 {
|
||||
return nil, errors.New("emitter/traefik: service has no ports (no backends to route to)")
|
||||
}
|
||||
if spec.Service != nil {
|
||||
if b := strings.TrimSpace(spec.Service.Bind); b != "" && net.ParseIP(b) == nil {
|
||||
return nil, fmt.Errorf("emitter/traefik: service.bind %q is not a valid IP (R-007)", b)
|
||||
}
|
||||
}
|
||||
content, err := renderTraefikYAML(spec, node)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
path := fmt.Sprintf("%s/orca-%s.yaml", traefikDynamicDir, spec.Name)
|
||||
return []File{{Path: path, Content: content, Mode: "0644"}}, nil
|
||||
}
|
||||
|
||||
// RenderDrain renders a Traefik dynamic-config that drains the service
|
||||
// by setting every backend server's weight to 0 (I-B-005 drain). The
|
||||
// path matches the live config so the atomic rename overwrites the
|
||||
// routing config with the drained config (Traefik reloads and stops
|
||||
// sending traffic). The caller writes the result via
|
||||
// WriteTraefikDynamic for the C-10 atomicity protocol.
|
||||
func (e TraefikEmitter) RenderDrain(spec *jobspec.WorkloadSpec, node *Node) ([]File, error) {
|
||||
if spec == nil {
|
||||
return nil, errors.New("emitter/traefik: spec is nil")
|
||||
}
|
||||
if strings.TrimSpace(spec.Name) == "" {
|
||||
return nil, errors.New("emitter/traefik: spec name is empty")
|
||||
}
|
||||
if len(spec.Ports) == 0 {
|
||||
return nil, errors.New("emitter/traefik: service has no ports (no backends to drain)")
|
||||
}
|
||||
content, err := renderTraefikYAMLDrain(spec, node)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
path := fmt.Sprintf("%s/orca-%s.yaml", traefikDynamicDir, spec.Name)
|
||||
return []File{{Path: path, Content: content, Mode: "0644"}}, nil
|
||||
}
|
||||
|
||||
// RegisterTraefik registers the TraefikEmitter on the given Registry
|
||||
// under the three service-kind runtime keys (service:process,
|
||||
// service:podman, service:wasm). The emitter is the same instance for
|
||||
// all three runtimes — the rendered Traefik config is runtime-agnostic
|
||||
// (the backend server URL is the R-007 socket path, which the runtime
|
||||
// layer binds regardless of process/wasm/podman).
|
||||
func RegisterTraefik(reg *Registry) {
|
||||
e := TraefikEmitter{}
|
||||
reg.Register("service:process", e)
|
||||
reg.Register("service:podman", e)
|
||||
reg.Register("service:wasm", e)
|
||||
}
|
||||
|
||||
// renderTraefikYAML renders the Traefik dynamic-config YAML for the
|
||||
// given spec + node. The shape (verified by the Traefik docs) is:
|
||||
//
|
||||
// http:
|
||||
// routers:
|
||||
// orca-<name>:
|
||||
// rule: PathPrefix("/<name>")
|
||||
// service: orca-<name>
|
||||
// tls:
|
||||
// certResolver: orca
|
||||
// domains:
|
||||
// - main: "<trust-domain>"
|
||||
// services:
|
||||
// orca-<name>:
|
||||
// loadBalancer:
|
||||
// servers:
|
||||
// - url: "unix:///run/orca/alloc-<allocID>/port-<portName>.sock"
|
||||
// healthCheck:
|
||||
// path: /healthz
|
||||
// interval: <interval>
|
||||
// timeout: <timeout>
|
||||
//
|
||||
// The alloc-id placeholder is "<allocID>" pending the P08 socket
|
||||
// layer; Traefik will reject the URL until a real alloc-id is
|
||||
// substituted. For P02 the emitter renders the placeholder so the
|
||||
// C-10 atomicity protocol is testable end-to-end; the socket layer
|
||||
// (P08) replaces the placeholder with the live alloc-id.
|
||||
func renderTraefikYAML(spec *jobspec.WorkloadSpec, node *Node) (string, error) {
|
||||
return renderTraefikYAMLWeighted(spec, node, false)
|
||||
}
|
||||
|
||||
// renderTraefikYAMLDrain renders the drained Traefik dynamic-config
|
||||
// (every backend server has weight: 0). The shape mirrors the live
|
||||
// config so the rename overwrites the live route with the drain.
|
||||
func renderTraefikYAMLDrain(spec *jobspec.WorkloadSpec, node *Node) (string, error) {
|
||||
return renderTraefikYAMLWeighted(spec, node, true)
|
||||
}
|
||||
|
||||
// renderTraefikYAMLWeighted renders the Traefik dynamic-config YAML.
|
||||
// When drain is true, every server entry is emitted with `weight: 0`
|
||||
// (I-B-005). When drain is false, no weight is emitted (Traefik
|
||||
// defaults to 1 — equal weighting across servers).
|
||||
func renderTraefikYAMLWeighted(spec *jobspec.WorkloadSpec, node *Node, drain bool) (string, error) {
|
||||
var b strings.Builder
|
||||
routerName := "orca-" + spec.Name
|
||||
serviceName := "orca-" + spec.Name
|
||||
rule := fmt.Sprintf("PathPrefix(\"/%s\")", spec.Name)
|
||||
trustDomain := defaultTrustDomain
|
||||
|
||||
b.WriteString("http:\n")
|
||||
b.WriteString(" routers:\n")
|
||||
b.WriteString(fmt.Sprintf(" %s:\n", routerName))
|
||||
b.WriteString(fmt.Sprintf(" rule: %s\n", rule))
|
||||
b.WriteString(fmt.Sprintf(" service: %s\n", serviceName))
|
||||
b.WriteString(" tls:\n")
|
||||
b.WriteString(fmt.Sprintf(" certResolver: %s\n", traefikRouterTLSCertResolver))
|
||||
b.WriteString(" domains:\n")
|
||||
b.WriteString(fmt.Sprintf(" - main: %q\n", trustDomain))
|
||||
b.WriteString(" services:\n")
|
||||
b.WriteString(fmt.Sprintf(" %s:\n", serviceName))
|
||||
b.WriteString(" loadBalancer:\n")
|
||||
b.WriteString(" servers:\n")
|
||||
allocID := allocIDFor(node)
|
||||
for _, p := range spec.Ports {
|
||||
sock := fmt.Sprintf("unix:///run/orca/alloc-%s/port-%s.sock", allocID, p.Name)
|
||||
b.WriteString(" - url: ")
|
||||
b.WriteString(fmt.Sprintf("%q\n", sock))
|
||||
if drain {
|
||||
b.WriteString(" weight: 0\n")
|
||||
}
|
||||
}
|
||||
if spec.Health != nil {
|
||||
b.WriteString(" healthCheck:\n")
|
||||
path := "/healthz"
|
||||
b.WriteString(fmt.Sprintf(" path: %s\n", path))
|
||||
if spec.Health.Interval != "" {
|
||||
b.WriteString(fmt.Sprintf(" interval: %s\n", spec.Health.Interval))
|
||||
}
|
||||
if spec.Health.Timeout != "" {
|
||||
b.WriteString(fmt.Sprintf(" timeout: %s\n", spec.Health.Timeout))
|
||||
}
|
||||
}
|
||||
return b.String(), nil
|
||||
}
|
||||
|
||||
// allocIDFor returns the alloc-id placeholder for the node. P08 will
|
||||
// substitute the live alloc-id from the socket layer; for P02 we use a
|
||||
// deterministic placeholder derived from the node hostname so the
|
||||
// rendered config is stable across re-renders (the C-10 idempotency
|
||||
// check depends on a stable hash). When the node is nil or has no
|
||||
// hostname, the literal placeholder "<allocID>" is emitted.
|
||||
func allocIDFor(node *Node) string {
|
||||
if node == nil || strings.TrimSpace(node.Hostname) == "" {
|
||||
return "<allocID>"
|
||||
}
|
||||
return node.Hostname
|
||||
}
|
||||
@@ -0,0 +1,93 @@
|
||||
package emitter
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
)
|
||||
|
||||
// AtomicWriter is the SSH-push transport surface that
|
||||
// WriteTraefikDynamic uses to write the Traefik dynamic-config file
|
||||
// atomically. It is the subset of *sshpush.Transport that the
|
||||
// atomicity protocol depends on. Tests substitute a mock to assert
|
||||
// the tmp+rename sequence (gate C-10) without a real SSH server.
|
||||
//
|
||||
// *sshpush.Transport satisfies this interface (the compile-time
|
||||
// assertion lives in internal/sshpush to avoid an import cycle — the
|
||||
// sshpush package imports emitter for fan-out, so this package cannot
|
||||
// import sshpush).
|
||||
type AtomicWriter interface {
|
||||
// WriteFileIdempotent writes content to peer:path atomically with
|
||||
// mode, returning written=true if the file was actually written
|
||||
// (content hash differed). Used by WriteTraefikDynamic to write
|
||||
// the .tmp sibling.
|
||||
WriteFileIdempotent(ctx context.Context, peer string, path string, content []byte, mode os.FileMode) (bool, error)
|
||||
// Exec runs a command on peer and returns its combined output.
|
||||
// Used by WriteTraefikDynamic to perform the atomic `mv -f
|
||||
// path.tmp path`.
|
||||
Exec(ctx context.Context, peer string, cmd string) ([]byte, error)
|
||||
}
|
||||
|
||||
// WriteTraefikDynamic writes a Traefik dynamic-config file atomically
|
||||
// (gate C-10: tmpfile + fsync + rename). The protocol is:
|
||||
//
|
||||
// 1. Write content to <path>.tmp via WriteFileIdempotent. The
|
||||
// underlying sshpush transport writes the tmp file in the same
|
||||
// directory as the target with mode-appended naming, fsyncs, and
|
||||
// renames — but we add an extra hop here so the *Traefik* file is
|
||||
// only ever observed at its final path after a single atomic
|
||||
// rename event that Traefik's fsnotify watcher sees.
|
||||
// 2. `mv -f <path>.tmp <path>` on the peer (atomic rename on POSIX).
|
||||
// Traefik's fsnotify watcher picks up the rename → reload.
|
||||
//
|
||||
// On a malformed config Traefik logs an error and holds the
|
||||
// last-good config (documented Traefik behavior; the C-10 test
|
||||
// verifies the tmp+rename sequence so a half-written file is never
|
||||
// observed by Traefik — the only window where Traefik can read the
|
||||
// file is after the rename, which is atomic on POSIX).
|
||||
//
|
||||
// The mode is 0644 (Traefik reads the dynamic dir as root; the lead
|
||||
// applier chmods after the rename).
|
||||
func WriteTraefikDynamic(ctx context.Context, t AtomicWriter, peer string, path string, content []byte) error {
|
||||
if t == nil {
|
||||
return fmt.Errorf("traefik: atomic writer is nil")
|
||||
}
|
||||
if path == "" {
|
||||
return fmt.Errorf("traefik: path is empty")
|
||||
}
|
||||
tmpPath := path + ".tmp"
|
||||
if _, err := t.WriteFileIdempotent(ctx, peer, tmpPath, content, 0o644); err != nil {
|
||||
return fmt.Errorf("traefik: write tmp %s: %w", tmpPath, err)
|
||||
}
|
||||
// Atomic rename on POSIX. `mv -f` overwrites an existing target
|
||||
// without prompting. The rename is atomic; Traefik's fsnotify
|
||||
// watcher observes a single IN_MOVED_TO event.
|
||||
renameCmd := fmt.Sprintf("mv -f %s %s", shellQuoteLocal(tmpPath), shellQuoteLocal(path))
|
||||
if _, err := t.Exec(ctx, peer, renameCmd); err != nil {
|
||||
return fmt.Errorf("traefik: rename %s -> %s: %w", tmpPath, path, err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// shellQuoteLocal single-quotes a path for safe shell interpolation on
|
||||
// the peer. It escapes embedded single-quotes via the standard '\”
|
||||
// idiom (close the single-quoted string, escape the literal single
|
||||
// quote, reopen the single-quoted string). This is a local
|
||||
// re-implementation (the sshpush package has its own) so the emitter
|
||||
// layer does not depend on the transport package's private helpers —
|
||||
// the AtomicWriter interface keeps the boundary clean for testing.
|
||||
func shellQuoteLocal(s string) string {
|
||||
var b []byte
|
||||
b = append(b, '\'')
|
||||
for i := 0; i < len(s); i++ {
|
||||
c := s[i]
|
||||
if c == '\'' {
|
||||
// close quote, escape the literal single-quote, reopen.
|
||||
b = append(b, '\'', '\\', '\'', '\'')
|
||||
continue
|
||||
}
|
||||
b = append(b, c)
|
||||
}
|
||||
b = append(b, '\'')
|
||||
return string(b)
|
||||
}
|
||||
@@ -0,0 +1,190 @@
|
||||
package emitter
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// mockAtomicWriter is a test-only AtomicWriter that records calls so
|
||||
// the C-10 atomicity protocol (tmp + rename) can be asserted.
|
||||
type mockAtomicWriter struct {
|
||||
written []writeCall
|
||||
execed []execCall
|
||||
writeErr error
|
||||
writeWrote bool
|
||||
execErr error
|
||||
}
|
||||
|
||||
type writeCall struct {
|
||||
peer string
|
||||
path string
|
||||
mode os.FileMode
|
||||
bytes []byte
|
||||
}
|
||||
|
||||
type execCall struct {
|
||||
peer string
|
||||
cmd string
|
||||
}
|
||||
|
||||
func (m *mockAtomicWriter) WriteFileIdempotent(ctx context.Context, peer string, path string, content []byte, mode os.FileMode) (bool, error) {
|
||||
m.written = append(m.written, writeCall{peer: peer, path: path, mode: mode, bytes: append([]byte(nil), content...)})
|
||||
if m.writeErr != nil {
|
||||
return false, m.writeErr
|
||||
}
|
||||
return m.writeWrote, nil
|
||||
}
|
||||
|
||||
func (m *mockAtomicWriter) Exec(ctx context.Context, peer string, cmd string) ([]byte, error) {
|
||||
m.execed = append(m.execed, execCall{peer: peer, cmd: cmd})
|
||||
if m.execErr != nil {
|
||||
return nil, m.execErr
|
||||
}
|
||||
return []byte("ok"), nil
|
||||
}
|
||||
|
||||
func TestWriteTraefikDynamic_TmpThenRename(t *testing.T) {
|
||||
// Gate C-10: the Traefik dynamic-config write must be a tmp +
|
||||
// rename sequence so Traefik's fsnotify watcher never observes a
|
||||
// half-written file.
|
||||
mock := &mockAtomicWriter{writeWrote: true}
|
||||
path := "/etc/traefik/dynamic/orca-web.yaml"
|
||||
peer := "node-1:22"
|
||||
content := []byte("http:\n routers: {}\n")
|
||||
|
||||
if err := WriteTraefikDynamic(context.Background(), mock, peer, path, content); err != nil {
|
||||
t.Fatalf("WriteTraefikDynamic: %v", err)
|
||||
}
|
||||
|
||||
if len(mock.written) != 1 {
|
||||
t.Fatalf("WriteFileIdempotent calls = %d, want 1", len(mock.written))
|
||||
}
|
||||
w := mock.written[0]
|
||||
if w.peer != peer {
|
||||
t.Errorf("write peer = %q, want %q", w.peer, peer)
|
||||
}
|
||||
// The tmp path is the target path + ".tmp".
|
||||
if w.path != path+".tmp" {
|
||||
t.Errorf("write path = %q, want %q (.tmp suffix is the C-10 atomicity protocol)", w.path, path+".tmp")
|
||||
}
|
||||
if string(w.bytes) != string(content) {
|
||||
t.Errorf("write content = %q, want %q", string(w.bytes), string(content))
|
||||
}
|
||||
if w.mode != 0o644 {
|
||||
t.Errorf("write mode = %o, want 0644", w.mode)
|
||||
}
|
||||
|
||||
if len(mock.execed) != 1 {
|
||||
t.Fatalf("Exec calls = %d, want 1 (the rename)", len(mock.execed))
|
||||
}
|
||||
e := mock.execed[0]
|
||||
if e.peer != peer {
|
||||
t.Errorf("exec peer = %q, want %q", e.peer, peer)
|
||||
}
|
||||
// The rename command must `mv -f` the .tmp file to the final path.
|
||||
if !strings.Contains(e.cmd, "mv -f") {
|
||||
t.Errorf("exec cmd = %q, want it to contain 'mv -f' (atomic rename)", e.cmd)
|
||||
}
|
||||
if !strings.Contains(e.cmd, path+".tmp") {
|
||||
t.Errorf("exec cmd = %q, want it to contain the .tmp path as source", e.cmd)
|
||||
}
|
||||
if !strings.Contains(e.cmd, path) {
|
||||
t.Errorf("exec cmd = %q, want it to contain the final path as destination", e.cmd)
|
||||
}
|
||||
// Sanity: the source must come before the destination in the
|
||||
// mv command.
|
||||
srcIdx := strings.Index(e.cmd, path+".tmp")
|
||||
dstIdx := strings.Index(e.cmd, "'"+path+"'")
|
||||
if srcIdx < 0 || dstIdx < 0 || srcIdx > dstIdx {
|
||||
t.Errorf("exec cmd %q: source .tmp must come before destination %s", e.cmd, path)
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriteTraefikDynamic_WriteTmpError(t *testing.T) {
|
||||
mock := &mockAtomicWriter{writeErr: errors.New("disk full")}
|
||||
err := WriteTraefikDynamic(context.Background(), mock, "p", "/etc/traefik/dynamic/orca-x.yaml", []byte("x"))
|
||||
if err == nil {
|
||||
t.Fatal("expected error from WriteFileIdempotent, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "write tmp") {
|
||||
t.Errorf("error = %q, want 'write tmp'", err.Error())
|
||||
}
|
||||
if !strings.Contains(err.Error(), "disk full") {
|
||||
t.Errorf("error = %q, want underlying 'disk full'", err.Error())
|
||||
}
|
||||
if len(mock.execed) != 0 {
|
||||
t.Errorf("on tmp write failure, no rename should happen; execed = %v", mock.execed)
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriteTraefikDynamic_RenameError(t *testing.T) {
|
||||
mock := &mockAtomicWriter{writeWrote: true, execErr: errors.New("permission denied")}
|
||||
err := WriteTraefikDynamic(context.Background(), mock, "p", "/etc/traefik/dynamic/orca-x.yaml", []byte("x"))
|
||||
if err == nil {
|
||||
t.Fatal("expected error from rename, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "rename") {
|
||||
t.Errorf("error = %q, want 'rename'", err.Error())
|
||||
}
|
||||
if !strings.Contains(err.Error(), "permission denied") {
|
||||
t.Errorf("error = %q, want underlying 'permission denied'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriteTraefikDynamic_NilWriter(t *testing.T) {
|
||||
err := WriteTraefikDynamic(context.Background(), nil, "p", "/x", []byte("x"))
|
||||
if err == nil {
|
||||
t.Fatal("expected error for nil writer")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "nil") {
|
||||
t.Errorf("error = %q, want 'nil'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriteTraefikDynamic_EmptyPath(t *testing.T) {
|
||||
mock := &mockAtomicWriter{writeWrote: true}
|
||||
err := WriteTraefikDynamic(context.Background(), mock, "p", "", []byte("x"))
|
||||
if err == nil {
|
||||
t.Fatal("expected error for empty path")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "path is empty") {
|
||||
t.Errorf("error = %q, want 'path is empty'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriteTraefikDynamic_SkipWhenContentMatches(t *testing.T) {
|
||||
// When the .tmp file already matches (writeWrote=false), the
|
||||
// protocol still proceeds with the rename — the idempotency
|
||||
// check is per-file, not per-protocol. The rename still happens
|
||||
// so the final path reflects the (unchanged) content.
|
||||
mock := &mockAtomicWriter{writeWrote: false}
|
||||
err := WriteTraefikDynamic(context.Background(), mock, "p", "/etc/traefik/dynamic/orca-x.yaml", []byte("x"))
|
||||
if err != nil {
|
||||
t.Fatalf("WriteTraefikDynamic: %v", err)
|
||||
}
|
||||
if len(mock.execed) != 1 {
|
||||
t.Errorf("rename should still happen on idempotent skip; execed = %v", mock.execed)
|
||||
}
|
||||
}
|
||||
|
||||
func TestShellQuoteLocal(t *testing.T) {
|
||||
cases := []struct {
|
||||
in, want string
|
||||
}{
|
||||
{"/etc/traefik/dynamic/orca-web.yaml", "'/etc/traefik/dynamic/orca-web.yaml'"},
|
||||
{"", "''"},
|
||||
{"/path with space/x", "'/path with space/x'"},
|
||||
{"a'b", "'a'\\''b'"},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.in, func(t *testing.T) {
|
||||
got := shellQuoteLocal(tc.in)
|
||||
if got != tc.want {
|
||||
t.Errorf("shellQuoteLocal(%q) = %q, want %q", tc.in, got, tc.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,353 @@
|
||||
package emitter
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/jobspec"
|
||||
)
|
||||
|
||||
func TestTraefikEmitter_RenderBasic(t *testing.T) {
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "web",
|
||||
Runtime: &jobspec.RuntimeBlock{OneOf: "process"},
|
||||
Ports: []jobspec.PortSpec{{Name: "http", Port: 8080}},
|
||||
Health: &jobspec.HealthBlock{CheckType: "http", Interval: "5s", Timeout: "1s"},
|
||||
}
|
||||
node := &Node{Hostname: "node-1", Runtime: []string{"process"}}
|
||||
files, err := TraefikEmitter{}.Render(spec, node)
|
||||
if err != nil {
|
||||
t.Fatalf("Render: %v", err)
|
||||
}
|
||||
if len(files) != 1 {
|
||||
t.Fatalf("got %d files, want 1", len(files))
|
||||
}
|
||||
f := files[0]
|
||||
wantPath := "/etc/traefik/dynamic/orca-web.yaml"
|
||||
if f.Path != wantPath {
|
||||
t.Errorf("Path = %q, want %q", f.Path, wantPath)
|
||||
}
|
||||
if f.Mode != "0644" {
|
||||
t.Errorf("Mode = %q, want 0644", f.Mode)
|
||||
}
|
||||
c := f.Content
|
||||
if !strings.Contains(c, "http:") {
|
||||
t.Errorf("content missing 'http:'\n%s", c)
|
||||
}
|
||||
if !strings.Contains(c, "routers:") {
|
||||
t.Errorf("content missing 'routers:'\n%s", c)
|
||||
}
|
||||
if !strings.Contains(c, "orca-web:") {
|
||||
t.Errorf("content missing 'orca-web:' router/service key\n%s", c)
|
||||
}
|
||||
if !strings.Contains(c, `rule: PathPrefix("/web")`) {
|
||||
t.Errorf("content missing PathPrefix rule\n%s", c)
|
||||
}
|
||||
if !strings.Contains(c, "services:") {
|
||||
t.Errorf("content missing 'services:'\n%s", c)
|
||||
}
|
||||
if !strings.Contains(c, "loadBalancer:") {
|
||||
t.Errorf("content missing 'loadBalancer:'\n%s", c)
|
||||
}
|
||||
if !strings.Contains(c, "unix:///run/orca/alloc-node-1/port-http.sock") {
|
||||
t.Errorf("content missing socket server URL\n%s", c)
|
||||
}
|
||||
if !strings.Contains(c, "certResolver: orca") {
|
||||
t.Errorf("content missing 'certResolver: orca'\n%s", c)
|
||||
}
|
||||
if !strings.Contains(c, "domains:") {
|
||||
t.Errorf("content missing TLS domains\n%s", c)
|
||||
}
|
||||
if !strings.Contains(c, "healthCheck:") {
|
||||
t.Errorf("content missing 'healthCheck:'\n%s", c)
|
||||
}
|
||||
if !strings.Contains(c, "interval: 5s") {
|
||||
t.Errorf("content missing 'interval: 5s'\n%s", c)
|
||||
}
|
||||
if !strings.Contains(c, "timeout: 1s") {
|
||||
t.Errorf("content missing 'timeout: 1s'\n%s", c)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTraefikEmitter_RenderMultiplePorts(t *testing.T) {
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "api",
|
||||
Runtime: &jobspec.RuntimeBlock{OneOf: "process"},
|
||||
Ports: []jobspec.PortSpec{
|
||||
{Name: "http", Port: 8080},
|
||||
{Name: "grpc", Port: 9090},
|
||||
},
|
||||
}
|
||||
node := &Node{Hostname: "n1"}
|
||||
files, err := TraefikEmitter{}.Render(spec, node)
|
||||
if err != nil {
|
||||
t.Fatalf("Render: %v", err)
|
||||
}
|
||||
c := files[0].Content
|
||||
if !strings.Contains(c, "port-http.sock") {
|
||||
t.Errorf("missing http socket: %s", c)
|
||||
}
|
||||
if !strings.Contains(c, "port-grpc.sock") {
|
||||
t.Errorf("missing grpc socket: %s", c)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTraefikEmitter_RenderDrain(t *testing.T) {
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "web",
|
||||
Ports: []jobspec.PortSpec{{Name: "http", Port: 8080}},
|
||||
}
|
||||
node := &Node{Hostname: "n1"}
|
||||
files, err := TraefikEmitter{}.RenderDrain(spec, node)
|
||||
if err != nil {
|
||||
t.Fatalf("RenderDrain: %v", err)
|
||||
}
|
||||
if len(files) != 1 {
|
||||
t.Fatalf("got %d files, want 1", len(files))
|
||||
}
|
||||
c := files[0].Content
|
||||
if !strings.Contains(c, "weight: 0") {
|
||||
t.Errorf("drain config missing 'weight: 0'\n%s", c)
|
||||
}
|
||||
if !strings.Contains(c, "unix:///run/orca/alloc-n1/port-http.sock") {
|
||||
t.Errorf("drain config missing socket URL\n%s", c)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTraefikEmitter_RenderLiveHasNoWeightZero(t *testing.T) {
|
||||
// Sanity: the live (non-drain) render must NOT emit `weight: 0`.
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "web",
|
||||
Ports: []jobspec.PortSpec{{Name: "http", Port: 8080}},
|
||||
}
|
||||
node := &Node{Hostname: "n1"}
|
||||
files, err := TraefikEmitter{}.Render(spec, node)
|
||||
if err != nil {
|
||||
t.Fatalf("Render: %v", err)
|
||||
}
|
||||
if strings.Contains(files[0].Content, "weight: 0") {
|
||||
t.Errorf("live config should not contain 'weight: 0'\n%s", files[0].Content)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTraefikEmitter_RenderNoHealthOmitsHealthCheck(t *testing.T) {
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "web",
|
||||
Ports: []jobspec.PortSpec{{Name: "http", Port: 8080}},
|
||||
}
|
||||
node := &Node{Hostname: "n1"}
|
||||
files, err := TraefikEmitter{}.Render(spec, node)
|
||||
if err != nil {
|
||||
t.Fatalf("Render: %v", err)
|
||||
}
|
||||
if strings.Contains(files[0].Content, "healthCheck:") {
|
||||
t.Errorf("config without Health should omit 'healthCheck:'\n%s", files[0].Content)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTraefikEmitter_NilSpec(t *testing.T) {
|
||||
_, err := TraefikEmitter{}.Render(nil, &Node{})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for nil spec")
|
||||
}
|
||||
}
|
||||
|
||||
func TestTraefikEmitter_EmptyName(t *testing.T) {
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: " ",
|
||||
Ports: []jobspec.PortSpec{{Name: "http", Port: 8080}},
|
||||
}
|
||||
_, err := TraefikEmitter{}.Render(spec, &Node{})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for empty name")
|
||||
}
|
||||
}
|
||||
|
||||
func TestTraefikEmitter_NoPorts(t *testing.T) {
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "web",
|
||||
}
|
||||
_, err := TraefikEmitter{}.Render(spec, &Node{})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for missing ports")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "no ports") {
|
||||
t.Errorf("error = %q, want 'no ports'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestTraefikEmitter_NoPortsDrain(t *testing.T) {
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "web",
|
||||
}
|
||||
_, err := TraefikEmitter{}.RenderDrain(spec, &Node{})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for missing ports on drain")
|
||||
}
|
||||
}
|
||||
|
||||
func TestTraefikEmitter_InvalidBind(t *testing.T) {
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "web",
|
||||
Ports: []jobspec.PortSpec{{Name: "http", Port: 8080}},
|
||||
Service: &jobspec.ServiceBlock{Bind: "not-an-ip"},
|
||||
}
|
||||
_, err := TraefikEmitter{}.Render(spec, &Node{})
|
||||
if err == nil {
|
||||
t.Fatal("expected error for invalid service.bind")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "valid IP") {
|
||||
t.Errorf("error = %q, want 'valid IP'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestTraefikEmitter_ValidBindLoopback(t *testing.T) {
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "web",
|
||||
Ports: []jobspec.PortSpec{{Name: "http", Port: 8080}},
|
||||
Service: &jobspec.ServiceBlock{Bind: "127.0.0.1"},
|
||||
}
|
||||
_, err := TraefikEmitter{}.Render(spec, &Node{})
|
||||
if err != nil {
|
||||
t.Fatalf("127.0.0.1 should be accepted, got %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTraefikEmitter_NilNodeAllocPlaceholder(t *testing.T) {
|
||||
// With a nil node, the alloc-id placeholder is the literal
|
||||
// "<allocID>" sentinel so the rendered config is still valid YAML
|
||||
// (the P08 socket layer substitutes the real alloc-id).
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "web",
|
||||
Ports: []jobspec.PortSpec{{Name: "http", Port: 8080}},
|
||||
}
|
||||
files, err := TraefikEmitter{}.Render(spec, nil)
|
||||
if err != nil {
|
||||
t.Fatalf("Render: %v", err)
|
||||
}
|
||||
if !strings.Contains(files[0].Content, "alloc-<allocID>") {
|
||||
t.Errorf("nil node should render alloc-<allocID> placeholder\n%s", files[0].Content)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTraefikEmitter_EmptyHostnameAllocPlaceholder(t *testing.T) {
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "web",
|
||||
Ports: []jobspec.PortSpec{{Name: "http", Port: 8080}},
|
||||
}
|
||||
files, err := TraefikEmitter{}.Render(spec, &Node{Hostname: " "})
|
||||
if err != nil {
|
||||
t.Fatalf("Render: %v", err)
|
||||
}
|
||||
if !strings.Contains(files[0].Content, "alloc-<allocID>") {
|
||||
t.Errorf("empty hostname should render alloc-<allocID> placeholder\n%s", files[0].Content)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTraefikEmitter_PathNotOrcaV1Prefixed(t *testing.T) {
|
||||
// REQ-090: the orca-v1- prefix is only for systemd units; Traefik
|
||||
// dynamic-config paths are named orca-<spec.Name>.yaml (single
|
||||
// source of truth — no dual-write window for Traefik configs).
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "web",
|
||||
Ports: []jobspec.PortSpec{{Name: "http", Port: 8080}},
|
||||
}
|
||||
files, err := TraefikEmitter{}.Render(spec, &Node{Hostname: "n1"})
|
||||
if err != nil {
|
||||
t.Fatalf("Render: %v", err)
|
||||
}
|
||||
if strings.Contains(files[0].Path, "orca-v1-") {
|
||||
t.Errorf("Path %q should NOT contain the orca-v1- prefix (systemd-only)", files[0].Path)
|
||||
}
|
||||
if !strings.HasPrefix(files[0].Path, "/etc/traefik/dynamic/orca-") {
|
||||
t.Errorf("Path %q should start with /etc/traefik/dynamic/orca-", files[0].Path)
|
||||
}
|
||||
if !strings.HasSuffix(files[0].Path, ".yaml") {
|
||||
t.Errorf("Path %q should end with .yaml", files[0].Path)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTraefikEmitter_RenderYAMLHasRoutersServicesTLS(t *testing.T) {
|
||||
// Aggregate structural assertion: the rendered YAML has the four
|
||||
// top-level Traefik concepts (routers, services, tls, servers).
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "web",
|
||||
Ports: []jobspec.PortSpec{{Name: "http", Port: 8080}},
|
||||
Health: &jobspec.HealthBlock{CheckType: "http"},
|
||||
}
|
||||
files, err := TraefikEmitter{}.Render(spec, &Node{Hostname: "n1"})
|
||||
if err != nil {
|
||||
t.Fatalf("Render: %v", err)
|
||||
}
|
||||
c := files[0].Content
|
||||
for _, want := range []string{"routers:", "services:", "tls:", "servers:", "url:"} {
|
||||
if !strings.Contains(c, want) {
|
||||
t.Errorf("rendered YAML missing %q\n%s", want, c)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestRegisterTraefik_AllServiceRuntimes(t *testing.T) {
|
||||
r := NewRegistry()
|
||||
RegisterTraefik(r)
|
||||
spec := func(runtime string) *jobspec.WorkloadSpec {
|
||||
return &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "web",
|
||||
Runtime: &jobspec.RuntimeBlock{OneOf: runtime},
|
||||
Ports: []jobspec.PortSpec{{Name: "http", Port: 8080}},
|
||||
}
|
||||
}
|
||||
for _, runtime := range []string{"process", "podman", "wasm"} {
|
||||
t.Run(runtime, func(t *testing.T) {
|
||||
files, err := r.Render(spec(runtime), &Node{Hostname: "n1"})
|
||||
if err != nil {
|
||||
t.Fatalf("Render(service:%s): %v", runtime, err)
|
||||
}
|
||||
if len(files) != 1 {
|
||||
t.Fatalf("got %d files, want 1", len(files))
|
||||
}
|
||||
if !strings.Contains(files[0].Path, "/etc/traefik/dynamic/orca-web.yaml") {
|
||||
t.Errorf("Path = %q", files[0].Path)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestRegisterTraefik_OverwritesExisting(t *testing.T) {
|
||||
// RegisterTraefik should overwrite any prior registration (the
|
||||
// Registry documents last-wins).
|
||||
r := NewRegistry()
|
||||
r.Register("service:process", mockEmitter{files: []File{{Path: "/old"}}})
|
||||
RegisterTraefik(r)
|
||||
spec := &jobspec.WorkloadSpec{
|
||||
Kind: "Service",
|
||||
Name: "web",
|
||||
Runtime: &jobspec.RuntimeBlock{OneOf: "process"},
|
||||
Ports: []jobspec.PortSpec{{Name: "http", Port: 8080}},
|
||||
}
|
||||
files, err := r.Render(spec, &Node{Hostname: "n1"})
|
||||
if err != nil {
|
||||
t.Fatalf("Render: %v", err)
|
||||
}
|
||||
if files[0].Path == "/old" {
|
||||
t.Errorf("RegisterTraefik did not overwrite the prior registration")
|
||||
}
|
||||
}
|
||||
|
||||
// Compile-time assertion that TraefikEmitter implements Emitter.
|
||||
var _ Emitter = TraefikEmitter{}
|
||||
@@ -25,6 +25,11 @@ import (
|
||||
)
|
||||
|
||||
// Dispatcher is the public surface; constructed via NewDispatcher.
|
||||
//
|
||||
// Deprecated: v0.9 re-architecture replaces peer dispatch with a CLI-side
|
||||
// scheduler + SSH-push (no orca binary on servers per R-001). The
|
||||
// Dispatcher is retained for the dual-write window and scheduled for
|
||||
// deletion in v0.10-P14. See .ciagent/PRD_v0.9.md R-001/R-006.
|
||||
type Dispatcher struct {
|
||||
log *slog.Logger
|
||||
capacity *store.CapacityRepo
|
||||
|
||||
@@ -0,0 +1,304 @@
|
||||
package engine
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/store"
|
||||
)
|
||||
|
||||
type mockExecutor struct {
|
||||
submitFn func(ctx context.Context, spec []byte) (string, error)
|
||||
statusFn func(ctx context.Context, jobID string) (string, error)
|
||||
submitted bool
|
||||
}
|
||||
|
||||
func (m *mockExecutor) Submit(ctx context.Context, spec []byte) (string, error) {
|
||||
m.submitted = true
|
||||
if m.submitFn != nil {
|
||||
return m.submitFn(ctx, spec)
|
||||
}
|
||||
return "mock-job-id", nil
|
||||
}
|
||||
|
||||
func (m *mockExecutor) Status(ctx context.Context, jobID string) (string, error) {
|
||||
if m.statusFn != nil {
|
||||
return m.statusFn(ctx, jobID)
|
||||
}
|
||||
return "complete", nil
|
||||
}
|
||||
|
||||
func newTestDispatcher(t *testing.T, exec LocalExecutor) (*Dispatcher, *store.CapacityRepo, func()) {
|
||||
t.Helper()
|
||||
path := filepath.Join(t.TempDir(), "test.db")
|
||||
db, err := store.Open(path)
|
||||
if err != nil {
|
||||
t.Fatalf("open db: %v", err)
|
||||
}
|
||||
capRepo := store.NewCapacityRepo(db)
|
||||
peers := NewPeerRegistry()
|
||||
d := NewDispatcher(nil, capRepo, peers, exec)
|
||||
return d, capRepo, func() { _ = db.Close() }
|
||||
}
|
||||
|
||||
func TestDispatcher_Submit_EmptySpec(t *testing.T) {
|
||||
d, _, cleanup := newTestDispatcher(t, &mockExecutor{})
|
||||
defer cleanup()
|
||||
_, _, err := d.Submit(context.Background(), "", nil, "")
|
||||
if err == nil {
|
||||
t.Fatal("Submit: expected error for empty spec, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatcher_Submit_IdempotencyHit(t *testing.T) {
|
||||
exec := &mockExecutor{}
|
||||
d, _, cleanup := newTestDispatcher(t, exec)
|
||||
defer cleanup()
|
||||
|
||||
d.Dedupe().Put("key-1", "cached-job-id")
|
||||
spec := []byte(`{"cpu_millicores":100,"memory_mib":64,"disk_mib":64}`)
|
||||
jobID, nodeID, err := d.Submit(context.Background(), "", spec, "key-1")
|
||||
if err != nil {
|
||||
t.Fatalf("Submit: %v", err)
|
||||
}
|
||||
if jobID != "cached-job-id" {
|
||||
t.Errorf("jobID: got %q, want cached-job-id", jobID)
|
||||
}
|
||||
if nodeID != "self" {
|
||||
t.Errorf("nodeID: got %q, want self", nodeID)
|
||||
}
|
||||
if exec.submitted {
|
||||
t.Error("executor was called on idempotency hit; should have been short-circuited")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatcher_Submit_LocalCapacity(t *testing.T) {
|
||||
exec := &mockExecutor{
|
||||
submitFn: func(ctx context.Context, spec []byte) (string, error) {
|
||||
return "local-job-id", nil
|
||||
},
|
||||
}
|
||||
d, capRepo, cleanup := newTestDispatcher(t, exec)
|
||||
defer cleanup()
|
||||
ctx := context.Background()
|
||||
if err := capRepo.Upsert(ctx, &store.NodeCapacity{
|
||||
NodeID: "self",
|
||||
CPUMillicores: 4000,
|
||||
MemoryMiB: 4096,
|
||||
DiskMiB: 4096,
|
||||
}); err != nil {
|
||||
t.Fatalf("Upsert capacity: %v", err)
|
||||
}
|
||||
spec := []byte(`{"cpu_millicores":100,"memory_mib":64,"disk_mib":64}`)
|
||||
jobID, nodeID, err := d.Submit(ctx, "", spec, "")
|
||||
if err != nil {
|
||||
t.Fatalf("Submit: %v", err)
|
||||
}
|
||||
if jobID != "local-job-id" {
|
||||
t.Errorf("jobID: got %q, want local-job-id", jobID)
|
||||
}
|
||||
if nodeID != "self" {
|
||||
t.Errorf("nodeID: got %q, want self", nodeID)
|
||||
}
|
||||
if !exec.submitted {
|
||||
t.Error("executor was not called for local-capacity path")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatcher_Submit_ExplicitTarget(t *testing.T) {
|
||||
exec := &mockExecutor{}
|
||||
d, _, cleanup := newTestDispatcher(t, exec)
|
||||
defer cleanup()
|
||||
spec := []byte(`{"cpu_millicores":100,"memory_mib":64,"disk_mib":64}`)
|
||||
_, _, err := d.Submit(context.Background(), "nodeA", spec, "")
|
||||
if err == nil {
|
||||
t.Fatal("Submit with explicit target nodeA (no peer): expected error, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatcher_Submit_NoPeers(t *testing.T) {
|
||||
exec := &mockExecutor{}
|
||||
d, capRepo, cleanup := newTestDispatcher(t, exec)
|
||||
defer cleanup()
|
||||
ctx := context.Background()
|
||||
if err := capRepo.Upsert(ctx, &store.NodeCapacity{
|
||||
NodeID: "self",
|
||||
CPUMillicores: 0,
|
||||
MemoryMiB: 0,
|
||||
DiskMiB: 0,
|
||||
}); err != nil {
|
||||
t.Fatalf("Upsert: %v", err)
|
||||
}
|
||||
spec := []byte(`{"cpu_millicores":1000,"memory_mib":1024,"disk_mib":1024}`)
|
||||
_, _, err := d.Submit(ctx, "", spec, "")
|
||||
if err == nil {
|
||||
t.Fatal("Submit: expected error when no peers and no local capacity, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatcher_LocalSubmit(t *testing.T) {
|
||||
exec := &mockExecutor{
|
||||
submitFn: func(ctx context.Context, spec []byte) (string, error) {
|
||||
return "ls-job", nil
|
||||
},
|
||||
}
|
||||
d, _, cleanup := newTestDispatcher(t, exec)
|
||||
defer cleanup()
|
||||
jobID, err := d.LocalSubmit(context.Background(), []byte(`{"command":"/bin/true"}`))
|
||||
if err != nil {
|
||||
t.Fatalf("LocalSubmit: %v", err)
|
||||
}
|
||||
if jobID != "ls-job" {
|
||||
t.Errorf("LocalSubmit: got %q, want ls-job", jobID)
|
||||
}
|
||||
if !exec.submitted {
|
||||
t.Error("LocalSubmit: executor.Submit not called")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatcher_LocalStatus(t *testing.T) {
|
||||
exec := &mockExecutor{
|
||||
statusFn: func(ctx context.Context, jobID string) (string, error) {
|
||||
if jobID == "known" {
|
||||
return "running", nil
|
||||
}
|
||||
return "", errors.New("not found")
|
||||
},
|
||||
}
|
||||
d, _, cleanup := newTestDispatcher(t, exec)
|
||||
defer cleanup()
|
||||
st, err := d.LocalStatus(context.Background(), "known")
|
||||
if err != nil {
|
||||
t.Fatalf("LocalStatus: %v", err)
|
||||
}
|
||||
if st != "running" {
|
||||
t.Errorf("LocalStatus: got %q, want running", st)
|
||||
}
|
||||
if _, err := d.LocalStatus(context.Background(), "missing"); err == nil {
|
||||
t.Error("LocalStatus: expected error for missing job, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatcher_LocalSubmit_NilExecutor(t *testing.T) {
|
||||
d := NewDispatcher(nil, nil, NewPeerRegistry(), nil)
|
||||
if _, err := d.LocalSubmit(context.Background(), []byte(`{}`)); err == nil {
|
||||
t.Error("LocalSubmit with nil executor: expected error, got nil")
|
||||
}
|
||||
if _, err := d.LocalStatus(context.Background(), "x"); err == nil {
|
||||
t.Error("LocalStatus with nil executor: expected error, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseInlineSpec(t *testing.T) {
|
||||
spec, err := parseInlineSpec([]byte(`{"cpu_millicores":500,"memory_mib":256,"disk_mib":128}`))
|
||||
if err != nil {
|
||||
t.Fatalf("parseInlineSpec: %v", err)
|
||||
}
|
||||
if spec.CPUMillicores != 500 || spec.MemoryMiB != 256 || spec.DiskMiB != 128 {
|
||||
t.Errorf("parseInlineSpec: got %+v, want cpu=500 mem=256 disk=128", spec)
|
||||
}
|
||||
if _, err := parseInlineSpec([]byte(`{bad json`)); err == nil {
|
||||
t.Fatal("parseInlineSpec: expected error for malformed JSON, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatcher_Submit_BadSpec(t *testing.T) {
|
||||
d, _, cleanup := newTestDispatcher(t, &mockExecutor{})
|
||||
defer cleanup()
|
||||
_, _, err := d.Submit(context.Background(), "", []byte(`{bad json`), "")
|
||||
if err == nil {
|
||||
t.Fatal("expected error for malformed spec")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatcher_Submit_ExplicitTargetNoPeerRegistry(t *testing.T) {
|
||||
d := NewDispatcher(nil, nil, nil, &mockExecutor{})
|
||||
_, _, err := d.Submit(context.Background(), "nodeX", []byte(`{"cpu_millicores":100,"memory_mib":64,"disk_mib":64}`), "")
|
||||
if err == nil {
|
||||
t.Fatal("expected error for explicit target with no peer registry")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatcher_Submit_ExplicitTargetPeerNotFound(t *testing.T) {
|
||||
d, _, cleanup := newTestDispatcher(t, &mockExecutor{})
|
||||
defer cleanup()
|
||||
_, _, err := d.Submit(context.Background(), "ghost", []byte(`{"cpu_millicores":100,"memory_mib":64,"disk_mib":64}`), "")
|
||||
if err == nil {
|
||||
t.Fatal("expected error for target not in registry")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatcher_Submit_PickPeerMissingCA(t *testing.T) {
|
||||
exec := &mockExecutor{}
|
||||
d, capRepo, cleanup := newTestDispatcher(t, exec)
|
||||
defer cleanup()
|
||||
ctx := context.Background()
|
||||
if err := capRepo.Upsert(ctx, &store.NodeCapacity{
|
||||
NodeID: "self",
|
||||
CPUMillicores: 0,
|
||||
MemoryMiB: 0,
|
||||
DiskMiB: 0,
|
||||
}); err != nil {
|
||||
t.Fatalf("Upsert: %v", err)
|
||||
}
|
||||
if err := d.peers.Add(&Peer{
|
||||
NodeID: "peer-1",
|
||||
Address: "127.0.0.1:1",
|
||||
Capacity: &store.NodeCapacity{NodeID: "peer-1", CPUMillicores: 4000, MemoryMiB: 4096, DiskMiB: 4096},
|
||||
}); err != nil {
|
||||
t.Fatalf("Add peer: %v", err)
|
||||
}
|
||||
spec := []byte(`{"cpu_millicores":100,"memory_mib":64,"disk_mib":64}`)
|
||||
_, _, err := d.Submit(ctx, "", spec, "idem-peer-1")
|
||||
if err == nil {
|
||||
t.Fatal("expected error (peer missing CA/servername)")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatcher_Submit_NoPeerRegistry(t *testing.T) {
|
||||
d := NewDispatcher(nil, nil, nil, &mockExecutor{})
|
||||
spec := []byte(`{"cpu_millicores":1000,"memory_mib":1024,"disk_mib":1024}`)
|
||||
_, _, err := d.Submit(context.Background(), "", spec, "")
|
||||
if err == nil {
|
||||
t.Fatal("expected error for no peer registry and no capacity repo")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatcher_Submit_NilCapacityFallsThrough(t *testing.T) {
|
||||
exec := &mockExecutor{}
|
||||
d := NewDispatcher(nil, nil, NewPeerRegistry(), exec)
|
||||
spec := []byte(`{"cpu_millicores":1000,"memory_mib":1024,"disk_mib":1024}`)
|
||||
_, _, err := d.Submit(context.Background(), "", spec, "")
|
||||
if err == nil {
|
||||
t.Fatal("expected error when capacity repo is nil and no peers")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatcher_Submit_AllPeersFailsPickNode(t *testing.T) {
|
||||
exec := &mockExecutor{}
|
||||
d, capRepo, cleanup := newTestDispatcher(t, exec)
|
||||
defer cleanup()
|
||||
ctx := context.Background()
|
||||
if err := capRepo.Upsert(ctx, &store.NodeCapacity{
|
||||
NodeID: "self",
|
||||
CPUMillicores: 0,
|
||||
MemoryMiB: 0,
|
||||
DiskMiB: 0,
|
||||
}); err != nil {
|
||||
t.Fatalf("Upsert: %v", err)
|
||||
}
|
||||
if err := d.peers.Add(&Peer{
|
||||
NodeID: "peer-tiny",
|
||||
Address: "127.0.0.1:1",
|
||||
Capacity: &store.NodeCapacity{NodeID: "peer-tiny", CPUMillicores: 10, MemoryMiB: 10, DiskMiB: 10},
|
||||
}); err != nil {
|
||||
t.Fatalf("Add peer: %v", err)
|
||||
}
|
||||
spec := []byte(`{"cpu_millicores":1000,"memory_mib":1024,"disk_mib":1024}`)
|
||||
_, _, err := d.Submit(ctx, "", spec, "")
|
||||
if err == nil {
|
||||
t.Fatal("expected error when no peer can fit")
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,145 @@
|
||||
package engine
|
||||
|
||||
import (
|
||||
"context"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/google/uuid"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/model"
|
||||
"git.cloudinit.dev/coreci/orca/internal/store"
|
||||
)
|
||||
|
||||
func newTestExecutor(t *testing.T) (*Executor, func()) {
|
||||
t.Helper()
|
||||
path := filepath.Join(t.TempDir(), "test.db")
|
||||
db, err := store.Open(path)
|
||||
if err != nil {
|
||||
t.Fatalf("open db: %v", err)
|
||||
}
|
||||
ex := NewExecutor(store.NewJobRepo(db), store.NewTaskRepo(db), nil)
|
||||
return ex, func() { _ = db.Close() }
|
||||
}
|
||||
|
||||
func TestExecutor_Submit_Success(t *testing.T) {
|
||||
ex, cleanup := newTestExecutor(t)
|
||||
defer cleanup()
|
||||
ctx := context.Background()
|
||||
spec := []byte(`{"command":"/bin/echo","args":["hello"]}`)
|
||||
jobID, err := ex.Submit(ctx, spec)
|
||||
if err != nil {
|
||||
t.Fatalf("Submit: %v", err)
|
||||
}
|
||||
if jobID == "" {
|
||||
t.Fatal("Submit: empty jobID")
|
||||
}
|
||||
status, err := ex.Status(ctx, jobID)
|
||||
if err != nil {
|
||||
t.Fatalf("Status: %v", err)
|
||||
}
|
||||
if status != string(model.JobStatusComplete) {
|
||||
t.Errorf("Status: got %q, want %q", status, model.JobStatusComplete)
|
||||
}
|
||||
}
|
||||
|
||||
func TestExecutor_Submit_MissingCommand(t *testing.T) {
|
||||
ex, cleanup := newTestExecutor(t)
|
||||
defer cleanup()
|
||||
_, err := ex.Submit(context.Background(), []byte(`{"name":"x"}`))
|
||||
if err == nil {
|
||||
t.Fatal("Submit: expected error for missing command, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestExecutor_Submit_MalformedJSON(t *testing.T) {
|
||||
ex, cleanup := newTestExecutor(t)
|
||||
defer cleanup()
|
||||
_, err := ex.Submit(context.Background(), []byte(`{bad json`))
|
||||
if err == nil {
|
||||
t.Fatal("Submit: expected error for malformed JSON, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestExecutor_Submit_FailingCommand(t *testing.T) {
|
||||
ex, cleanup := newTestExecutor(t)
|
||||
defer cleanup()
|
||||
ctx := context.Background()
|
||||
jobID, err := ex.Submit(ctx, []byte(`{"command":"/bin/false"}`))
|
||||
if err == nil {
|
||||
t.Fatal("Submit failing command: expected error, got nil")
|
||||
}
|
||||
if jobID == "" {
|
||||
t.Fatal("Submit failing command: empty jobID")
|
||||
}
|
||||
status, err := ex.Status(ctx, jobID)
|
||||
if err != nil {
|
||||
t.Fatalf("Status: %v", err)
|
||||
}
|
||||
if status != string(model.JobStatusFailed) {
|
||||
t.Errorf("Status: got %q, want %q", status, model.JobStatusFailed)
|
||||
}
|
||||
}
|
||||
|
||||
func TestExecutor_Status_NotFound(t *testing.T) {
|
||||
ex, cleanup := newTestExecutor(t)
|
||||
defer cleanup()
|
||||
_, err := ex.Status(context.Background(), "nonexistent-job-id")
|
||||
if err == nil {
|
||||
t.Fatal("Status: expected error for missing job, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestExecutor_Run_Success(t *testing.T) {
|
||||
ex, cleanup := newTestExecutor(t)
|
||||
defer cleanup()
|
||||
ctx := context.Background()
|
||||
job := &model.Job{
|
||||
ID: uuid.NewString(),
|
||||
Name: "run-success",
|
||||
Spec: "{}",
|
||||
Status: model.JobStatusPending,
|
||||
}
|
||||
specs := []TaskSpec{{Name: "echo", Command: "/bin/echo", Args: []string{"hi"}}}
|
||||
if err := ex.Run(ctx, job, specs); err != nil {
|
||||
t.Fatalf("Run: %v", err)
|
||||
}
|
||||
got, err := ex.Status(ctx, job.ID)
|
||||
if err != nil {
|
||||
t.Fatalf("Status: %v", err)
|
||||
}
|
||||
if got != string(model.JobStatusComplete) {
|
||||
t.Errorf("Status: got %q, want %q", got, model.JobStatusComplete)
|
||||
}
|
||||
}
|
||||
|
||||
func TestExecutor_Run_ContextCancel(t *testing.T) {
|
||||
ex, cleanup := newTestExecutor(t)
|
||||
defer cleanup()
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
job := &model.Job{
|
||||
ID: uuid.NewString(),
|
||||
Name: "run-cancel",
|
||||
Spec: "{}",
|
||||
Status: model.JobStatusPending,
|
||||
}
|
||||
specs := []TaskSpec{{Name: "sleep", Command: "/bin/sleep", Args: []string{"10"}}}
|
||||
|
||||
go func() {
|
||||
time.Sleep(100 * time.Millisecond)
|
||||
cancel()
|
||||
}()
|
||||
|
||||
err := ex.Run(ctx, job, specs)
|
||||
if err == nil {
|
||||
t.Fatal("Run: expected error after context cancel, got nil")
|
||||
}
|
||||
status, sErr := ex.Status(context.Background(), job.ID)
|
||||
if sErr != nil {
|
||||
t.Fatalf("Status after cancel: %v", sErr)
|
||||
}
|
||||
if status == string(model.JobStatusComplete) {
|
||||
t.Errorf("Status: got %q, want not complete (task should have been killed)", status)
|
||||
}
|
||||
}
|
||||
@@ -16,6 +16,11 @@ import (
|
||||
)
|
||||
|
||||
// Peer is a remote orca node reachable over mTLS.
|
||||
//
|
||||
// Deprecated: v0.9 re-architecture replaces peer dispatch with a CLI-side
|
||||
// scheduler + SSH-push (no orca binary on servers per R-001). The Peer
|
||||
// type is retained for the dual-write window and scheduled for deletion
|
||||
// in v0.10-P14. See .ciagent/PRD_v0.9.md R-001/R-006.
|
||||
type Peer struct {
|
||||
NodeID string
|
||||
Address string // host:port (the peer's daemon listener)
|
||||
@@ -27,6 +32,11 @@ type Peer struct {
|
||||
|
||||
// PeerRegistry tracks known peers. Methods are safe for concurrent
|
||||
// use; the underlying map is guarded by a sync.RWMutex.
|
||||
//
|
||||
// Deprecated: v0.9 re-architecture replaces peer dispatch with a CLI-side
|
||||
// scheduler + SSH-push (no orca binary on servers per R-001). The
|
||||
// PeerRegistry is retained for the dual-write window and scheduled for
|
||||
// deletion in v0.10-P14. See .ciagent/PRD_v0.9.md R-001/R-006.
|
||||
type PeerRegistry struct {
|
||||
mu sync.RWMutex
|
||||
peers map[string]*Peer
|
||||
|
||||
@@ -0,0 +1,136 @@
|
||||
package engine
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/store"
|
||||
)
|
||||
|
||||
func TestPeerRegistry_AddAndGet(t *testing.T) {
|
||||
r := NewPeerRegistry()
|
||||
p := &Peer{
|
||||
NodeID: "node-1",
|
||||
Address: "localhost:8443",
|
||||
ServerName: "node-1.orca",
|
||||
CAPath: "/etc/orca/ca.pem",
|
||||
}
|
||||
if err := r.Add(p); err != nil {
|
||||
t.Fatalf("Add: %v", err)
|
||||
}
|
||||
got := r.Get("node-1")
|
||||
if got == nil {
|
||||
t.Fatal("Get: returned nil after Add")
|
||||
}
|
||||
if got.NodeID != "node-1" || got.Address != "localhost:8443" ||
|
||||
got.ServerName != "node-1.orca" || got.CAPath != "/etc/orca/ca.pem" {
|
||||
t.Errorf("Get: fields mismatch: %+v", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestPeerRegistry_AddNil(t *testing.T) {
|
||||
r := NewPeerRegistry()
|
||||
if err := r.Add(nil); err == nil {
|
||||
t.Fatal("Add(nil): expected error, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestPeerRegistry_AddMissingID(t *testing.T) {
|
||||
r := NewPeerRegistry()
|
||||
if err := r.Add(&Peer{Address: "a"}); err == nil {
|
||||
t.Fatal("Add(empty NodeID): expected error, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestPeerRegistry_Remove(t *testing.T) {
|
||||
r := NewPeerRegistry()
|
||||
p := &Peer{NodeID: "node-r", Address: "a"}
|
||||
if err := r.Add(p); err != nil {
|
||||
t.Fatalf("Add: %v", err)
|
||||
}
|
||||
if !r.Remove("node-r") {
|
||||
t.Fatal("Remove: returned false for existing peer")
|
||||
}
|
||||
if got := r.Get("node-r"); got != nil {
|
||||
t.Errorf("Get after Remove: want nil, got %+v", got)
|
||||
}
|
||||
if r.Remove("node-r") {
|
||||
t.Error("Remove second time: want false, got true")
|
||||
}
|
||||
}
|
||||
|
||||
func TestPeerRegistry_All(t *testing.T) {
|
||||
r := NewPeerRegistry()
|
||||
for _, id := range []string{"node-c", "node-a", "node-b"} {
|
||||
if err := r.Add(&Peer{NodeID: id, Address: "a"}); err != nil {
|
||||
t.Fatalf("Add %s: %v", id, err)
|
||||
}
|
||||
}
|
||||
got, err := r.All(context.Background())
|
||||
if err != nil {
|
||||
t.Fatalf("All: %v", err)
|
||||
}
|
||||
if len(got) != 3 {
|
||||
t.Fatalf("All: got %d, want 3", len(got))
|
||||
}
|
||||
want := []string{"node-a", "node-b", "node-c"}
|
||||
for i, w := range want {
|
||||
if got[i].NodeID != w {
|
||||
t.Errorf("All[%d]: got %s, want %s (not sorted by NodeID)", i, got[i].NodeID, w)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestPeerRegistry_All_Empty(t *testing.T) {
|
||||
r := NewPeerRegistry()
|
||||
got, err := r.All(context.Background())
|
||||
if err != nil {
|
||||
t.Fatalf("All on empty: %v", err)
|
||||
}
|
||||
if len(got) != 0 {
|
||||
t.Errorf("All on empty: got %d, want 0", len(got))
|
||||
}
|
||||
}
|
||||
|
||||
func TestPeerRegistry_Len(t *testing.T) {
|
||||
r := NewPeerRegistry()
|
||||
if r.Len() != 0 {
|
||||
t.Errorf("Len on empty: got %d, want 0", r.Len())
|
||||
}
|
||||
if err := r.Add(&Peer{NodeID: "n1", Address: "a"}); err != nil {
|
||||
t.Fatalf("Add n1: %v", err)
|
||||
}
|
||||
if err := r.Add(&Peer{NodeID: "n2", Address: "a"}); err != nil {
|
||||
t.Fatalf("Add n2: %v", err)
|
||||
}
|
||||
if r.Len() != 2 {
|
||||
t.Errorf("Len: got %d, want 2", r.Len())
|
||||
}
|
||||
}
|
||||
|
||||
func TestPeerRegistry_UpdateLastSeen(t *testing.T) {
|
||||
r := NewPeerRegistry()
|
||||
old := time.Now().Add(-1 * time.Hour).UTC()
|
||||
p := &Peer{
|
||||
NodeID: "node-u",
|
||||
Address: "a",
|
||||
LastSeen: old,
|
||||
Capacity: &store.NodeCapacity{NodeID: "node-u", CPUMillicores: 1000, MemoryMiB: 1024, DiskMiB: 1024},
|
||||
}
|
||||
if err := r.Add(p); err != nil {
|
||||
t.Fatalf("Add: %v", err)
|
||||
}
|
||||
r.UpdateLastSeen("node-u")
|
||||
got := r.Get("node-u")
|
||||
if got == nil {
|
||||
t.Fatal("Get: nil after UpdateLastSeen")
|
||||
}
|
||||
if !got.LastSeen.After(old) {
|
||||
t.Errorf("UpdateLastSeen: LastSeen not bumped; old=%v now=%v", old, got.LastSeen)
|
||||
}
|
||||
if time.Since(got.LastSeen) > 5*time.Second {
|
||||
t.Errorf("UpdateLastSeen: LastSeen not recent: %v", got.LastSeen)
|
||||
}
|
||||
r.UpdateLastSeen("nonexistent")
|
||||
}
|
||||
@@ -0,0 +1,229 @@
|
||||
package engine
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"errors"
|
||||
"log/slog"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/model"
|
||||
"git.cloudinit.dev/coreci/orca/internal/store"
|
||||
)
|
||||
|
||||
func newRegistryTestDB(t *testing.T) (*store.NodeRepo, *store.AuditRepo, *store.AuditRepo, func()) {
|
||||
t.Helper()
|
||||
path := filepath.Join(t.TempDir(), "test.db")
|
||||
db, err := store.Open(path)
|
||||
if err != nil {
|
||||
t.Fatalf("open db: %v", err)
|
||||
}
|
||||
return store.NewNodeRepo(db), store.NewAuditRepo(db), store.NewAuditRepo(db), func() { _ = db.Close() }
|
||||
}
|
||||
|
||||
func TestNewNodeRegistry_NilLogger(t *testing.T) {
|
||||
nodeRepo, auditRepo, _, cleanup := newRegistryTestDB(t)
|
||||
defer cleanup()
|
||||
audit := NewAudit(auditRepo, nil)
|
||||
r := NewNodeRegistry(nodeRepo, audit, nil)
|
||||
if r == nil {
|
||||
t.Fatal("NewNodeRegistry returned nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeRegistry_Join_Success(t *testing.T) {
|
||||
nodeRepo, auditRepo, _, cleanup := newRegistryTestDB(t)
|
||||
defer cleanup()
|
||||
var buf bytes.Buffer
|
||||
audit := NewAudit(auditRepo, slog.New(slog.NewTextHandler(&buf, nil)))
|
||||
r := NewNodeRegistry(nodeRepo, audit, slog.New(slog.NewTextHandler(&buf, nil)))
|
||||
|
||||
ctx := context.Background()
|
||||
n := &model.Node{
|
||||
ID: "node-join-1",
|
||||
Name: "pve-1",
|
||||
Address: "10.0.0.1:8443",
|
||||
State: model.NodeStateReady,
|
||||
}
|
||||
if err := r.Join(ctx, n); err != nil {
|
||||
t.Fatalf("Join: %v", err)
|
||||
}
|
||||
got, err := r.Get(ctx, "node-join-1")
|
||||
if err != nil {
|
||||
t.Fatalf("Get after Join: %v", err)
|
||||
}
|
||||
if got.Name != "pve-1" {
|
||||
t.Errorf("Get: Name = %q, want pve-1", got.Name)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeRegistry_Join_Duplicate(t *testing.T) {
|
||||
nodeRepo, auditRepo, _, cleanup := newRegistryTestDB(t)
|
||||
defer cleanup()
|
||||
audit := NewAudit(auditRepo, nil)
|
||||
r := NewNodeRegistry(nodeRepo, audit, nil)
|
||||
|
||||
ctx := context.Background()
|
||||
n := &model.Node{ID: "dup-1", Name: "n1", Address: "a:1", State: model.NodeStateReady}
|
||||
if err := r.Join(ctx, n); err != nil {
|
||||
t.Fatalf("first Join: %v", err)
|
||||
}
|
||||
err := r.Join(ctx, n)
|
||||
if err == nil {
|
||||
t.Fatal("expected error for duplicate Join")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeRegistry_Leave_Success(t *testing.T) {
|
||||
nodeRepo, auditRepo, _, cleanup := newRegistryTestDB(t)
|
||||
defer cleanup()
|
||||
audit := NewAudit(auditRepo, nil)
|
||||
r := NewNodeRegistry(nodeRepo, audit, nil)
|
||||
|
||||
ctx := context.Background()
|
||||
n := &model.Node{ID: "leave-1", Name: "n1", Address: "a:1", State: model.NodeStateReady}
|
||||
if err := r.Join(ctx, n); err != nil {
|
||||
t.Fatalf("Join: %v", err)
|
||||
}
|
||||
if err := r.Leave(ctx, "leave-1"); err != nil {
|
||||
t.Fatalf("Leave: %v", err)
|
||||
}
|
||||
got, err := r.Get(ctx, "leave-1")
|
||||
if err != nil {
|
||||
t.Fatalf("Get after Leave: %v", err)
|
||||
}
|
||||
if got.State != model.NodeStateLeft {
|
||||
t.Errorf("State = %q, want %q", got.State, model.NodeStateLeft)
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeRegistry_Leave_NotFound(t *testing.T) {
|
||||
nodeRepo, auditRepo, _, cleanup := newRegistryTestDB(t)
|
||||
defer cleanup()
|
||||
audit := NewAudit(auditRepo, nil)
|
||||
r := NewNodeRegistry(nodeRepo, audit, nil)
|
||||
err := r.Leave(context.Background(), "nonexistent")
|
||||
if err == nil {
|
||||
t.Fatal("expected error for Leave on missing node")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeRegistry_Forget_Success(t *testing.T) {
|
||||
nodeRepo, auditRepo, _, cleanup := newRegistryTestDB(t)
|
||||
defer cleanup()
|
||||
audit := NewAudit(auditRepo, nil)
|
||||
r := NewNodeRegistry(nodeRepo, audit, nil)
|
||||
|
||||
ctx := context.Background()
|
||||
n := &model.Node{ID: "forget-1", Name: "n1", Address: "a:1", State: model.NodeStateReady}
|
||||
if err := r.Join(ctx, n); err != nil {
|
||||
t.Fatalf("Join: %v", err)
|
||||
}
|
||||
if err := r.Forget(ctx, "forget-1"); err != nil {
|
||||
t.Fatalf("Forget: %v", err)
|
||||
}
|
||||
if _, err := r.Get(ctx, "forget-1"); err == nil {
|
||||
t.Error("expected error after Forget")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeRegistry_Forget_NotFound(t *testing.T) {
|
||||
nodeRepo, auditRepo, _, cleanup := newRegistryTestDB(t)
|
||||
defer cleanup()
|
||||
audit := NewAudit(auditRepo, nil)
|
||||
r := NewNodeRegistry(nodeRepo, audit, nil)
|
||||
err := r.Forget(context.Background(), "nonexistent")
|
||||
if err == nil {
|
||||
t.Fatal("expected error for Forget on missing node")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeRegistry_List(t *testing.T) {
|
||||
nodeRepo, auditRepo, _, cleanup := newRegistryTestDB(t)
|
||||
defer cleanup()
|
||||
audit := NewAudit(auditRepo, nil)
|
||||
r := NewNodeRegistry(nodeRepo, audit, nil)
|
||||
|
||||
ctx := context.Background()
|
||||
if got, err := r.List(ctx); err != nil {
|
||||
t.Fatalf("List empty: %v", err)
|
||||
} else if len(got) != 0 {
|
||||
t.Errorf("List empty: got %d, want 0", len(got))
|
||||
}
|
||||
for _, id := range []string{"n3", "n1", "n2"} {
|
||||
if err := r.Join(ctx, &model.Node{ID: id, Name: id, Address: "a:1", State: model.NodeStateReady}); err != nil {
|
||||
t.Fatalf("Join %s: %v", id, err)
|
||||
}
|
||||
}
|
||||
got, err := r.List(ctx)
|
||||
if err != nil {
|
||||
t.Fatalf("List: %v", err)
|
||||
}
|
||||
if len(got) != 3 {
|
||||
t.Errorf("List: got %d, want 3", len(got))
|
||||
}
|
||||
}
|
||||
|
||||
func TestNodeRegistry_Get_NotFound(t *testing.T) {
|
||||
nodeRepo, auditRepo, _, cleanup := newRegistryTestDB(t)
|
||||
defer cleanup()
|
||||
audit := NewAudit(auditRepo, nil)
|
||||
r := NewNodeRegistry(nodeRepo, audit, nil)
|
||||
_, err := r.Get(context.Background(), "missing")
|
||||
if err == nil {
|
||||
t.Fatal("expected error for Get missing")
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewAudit_NilLogger(t *testing.T) {
|
||||
_, auditRepo, _, cleanup := newRegistryTestDB(t)
|
||||
defer cleanup()
|
||||
a := NewAudit(auditRepo, nil)
|
||||
if a == nil {
|
||||
t.Fatal("NewAudit returned nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestAudit_Record_Success(t *testing.T) {
|
||||
_, auditRepo, _, cleanup := newRegistryTestDB(t)
|
||||
defer cleanup()
|
||||
var buf bytes.Buffer
|
||||
a := NewAudit(auditRepo, slog.New(slog.NewTextHandler(&buf, nil)))
|
||||
a.Record(context.Background(), "cli", "node.join", "node-1", "success", nil, map[string]any{"host": "10.0.0.1"})
|
||||
entries, err := auditRepo.List(context.Background(), 10)
|
||||
if err != nil {
|
||||
t.Fatalf("List: %v", err)
|
||||
}
|
||||
if len(entries) != 1 {
|
||||
t.Fatalf("entries = %d, want 1", len(entries))
|
||||
}
|
||||
if entries[0].Action != "node.join" || entries[0].Result != "success" {
|
||||
t.Errorf("entry = %+v", entries[0])
|
||||
}
|
||||
}
|
||||
|
||||
func TestAudit_Record_WithError(t *testing.T) {
|
||||
_, auditRepo, _, cleanup := newRegistryTestDB(t)
|
||||
defer cleanup()
|
||||
var buf bytes.Buffer
|
||||
a := NewAudit(auditRepo, slog.New(slog.NewTextHandler(&buf, nil)))
|
||||
a.Record(context.Background(), "cli", "node.join", "node-1", "failure", errors.New("boom"), nil)
|
||||
entries, err := auditRepo.List(context.Background(), 10)
|
||||
if err != nil {
|
||||
t.Fatalf("List: %v", err)
|
||||
}
|
||||
if len(entries) != 1 {
|
||||
t.Fatalf("entries = %d, want 1", len(entries))
|
||||
}
|
||||
if entries[0].Error != "boom" {
|
||||
t.Errorf("Error = %q, want boom", entries[0].Error)
|
||||
}
|
||||
if !containsStr(buf.String(), "level=WARN") {
|
||||
t.Errorf("expected WARN level for error result, got: %s", buf.String())
|
||||
}
|
||||
}
|
||||
|
||||
func containsStr(s, sub string) bool {
|
||||
return len(sub) == 0 || (len(s) >= len(sub) && (s[0:len(sub)] == sub || containsStr(s[1:], sub)))
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
package engine
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"git.cloudinit.dev/coreci/orca/internal/store"
|
||||
@@ -64,3 +65,66 @@ func TestJobSpecFits(t *testing.T) {
|
||||
t.Error("Fits: should not fit (CPU too low)")
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobSpecFits_NilCapacity(t *testing.T) {
|
||||
spec := JobSpec{CPUMillicores: 1000}
|
||||
if spec.Fits(nil) {
|
||||
t.Error("Fits(nil): should be false")
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobSpecScore_NilCapacity(t *testing.T) {
|
||||
spec := JobSpec{CPUMillicores: 1000, MemoryMiB: 1024}
|
||||
if got := spec.Score(nil); got != -1 {
|
||||
t.Errorf("Score(nil) = %d, want -1", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobSpecScore_OverCapacity(t *testing.T) {
|
||||
spec := JobSpec{CPUMillicores: 2000, MemoryMiB: 1024}
|
||||
c := &store.NodeCapacity{CPUMillicores: 1000, MemoryMiB: 2048}
|
||||
if got := spec.Score(c); got != -1 {
|
||||
t.Errorf("Score over CPU = %d, want -1", got)
|
||||
}
|
||||
c2 := &store.NodeCapacity{CPUMillicores: 4000, MemoryMiB: 512}
|
||||
if got := spec.Score(c2); got != -1 {
|
||||
t.Errorf("Score over Mem = %d, want -1", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestJobSpecScore_Fits(t *testing.T) {
|
||||
spec := JobSpec{CPUMillicores: 1000, MemoryMiB: 1024}
|
||||
c := &store.NodeCapacity{CPUMillicores: 4000, MemoryMiB: 4096}
|
||||
got := spec.Score(c)
|
||||
want := int64((4000 - 1000) + (4096 - 1024))
|
||||
if got != want {
|
||||
t.Errorf("Score = %d, want %d", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestPickNode_Empty(t *testing.T) {
|
||||
_, _, err := PickNode(JobSpec{}, nil)
|
||||
if err == nil {
|
||||
t.Fatal("expected error for empty capacities")
|
||||
}
|
||||
}
|
||||
|
||||
func TestMemLocalNode_Capacity(t *testing.T) {
|
||||
c := &store.NodeCapacity{NodeID: "self", CPUMillicores: 1000, MemoryMiB: 1024}
|
||||
ln := MemLocalNode(c)
|
||||
got, err := ln.Capacity(context.Background())
|
||||
if err != nil {
|
||||
t.Fatalf("Capacity: %v", err)
|
||||
}
|
||||
if got != c {
|
||||
t.Errorf("Capacity: got %+v, want %+v", got, c)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMemLocalNode_NilCapacity(t *testing.T) {
|
||||
ln := MemLocalNode(nil)
|
||||
_, err := ln.Capacity(context.Background())
|
||||
if err == nil {
|
||||
t.Fatal("expected error for nil capacity")
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,147 @@
|
||||
package jobspec
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// ParseFile reads a jobspec file from disk and dispatches on file
|
||||
// extension (R-013, REQ-064):
|
||||
//
|
||||
// - .md → ParseMarkdown (canonical Markdown+frontmatter, R-014/R-015)
|
||||
// - .yaml/.yml → ParseMarkdown with the whole file treated as
|
||||
// frontmatter and Body = "" (pure YAML, no Markdown body)
|
||||
// - .hcl → ParseHCL (legacy adapter; wraps the existing HCL parser
|
||||
// and converts Spec{Job, Tasks} into *WorkloadSpec with Kind="Job",
|
||||
// REQ-090 migration window)
|
||||
//
|
||||
// Unknown extensions return an error. The dispatcher preserves
|
||||
// `orca job run old-spec.hcl` during the v0.9→v0.10 migration window
|
||||
// (REQ-090).
|
||||
func ParseFile(path string) (*WorkloadSpec, error) {
|
||||
data, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("read spec file: %w", err)
|
||||
}
|
||||
return Dispatch(data, filepath.Base(path))
|
||||
}
|
||||
|
||||
// ParseHCLFile reads an HCL file and parses it via the legacy HCL parser,
|
||||
// returning the legacy *Spec. It is a convenience wrapper retained for
|
||||
// tests and direct HCL consumers that need the raw Spec{Job, Tasks}
|
||||
// shape during the v0.9→v0.10 migration window (REQ-090).
|
||||
//
|
||||
// Deprecated: use ParseFile (dispatcher) for new code. HCL is legacy per
|
||||
// R-013.
|
||||
func ParseHCLFile(path string) (*Spec, error) {
|
||||
data, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("read spec file: %w", err)
|
||||
}
|
||||
return ParseHCLLegacy(data, filepath.Base(path))
|
||||
}
|
||||
|
||||
// Dispatch routes raw jobspec bytes on file extension to the
|
||||
// appropriate parser. filename is used only for HCL (the HCL decoder
|
||||
// needs a filename for error messages and syntax sniffing).
|
||||
func Dispatch(data []byte, filename string) (*WorkloadSpec, error) {
|
||||
ext := strings.ToLower(filepath.Ext(filename))
|
||||
switch ext {
|
||||
case ".md":
|
||||
return ParseMarkdown(data)
|
||||
case ".yaml", ".yml":
|
||||
// Pure YAML file: no Markdown body. Treat the whole file as
|
||||
// the frontmatter block. Body is empty (R-015: no body to
|
||||
// preserve).
|
||||
spec, err := parseYAMLFile(data)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return spec, nil
|
||||
case ".hcl":
|
||||
return ParseHCL(data, filename)
|
||||
default:
|
||||
return nil, fmt.Errorf("parse jobspec: unknown extension %q (want .md, .yaml, .yml, or .hcl)", ext)
|
||||
}
|
||||
}
|
||||
|
||||
// parseYAMLFile treats the whole file as a frontmatter block (no
|
||||
// surrounding `---` delimiters, no Markdown body). This routes .yaml
|
||||
// and .yml files through the same hand-rolled parser as .md.
|
||||
func parseYAMLFile(data []byte) (*WorkloadSpec, error) {
|
||||
block := string(data)
|
||||
if strings.TrimSpace(block) == "" {
|
||||
return nil, fmt.Errorf("parse yaml: empty file")
|
||||
}
|
||||
spec, err := parseFrontmatterBlock(block)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
spec.Body = ""
|
||||
if err := validateWorkload(spec); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return spec, nil
|
||||
}
|
||||
|
||||
// ParseHCL parses a legacy HCL jobspec and adapts it into a *WorkloadSpec
|
||||
// (REQ-064 adapter, REQ-090 migration window). The existing HCL
|
||||
// Spec{Job, Tasks} shape is converted to:
|
||||
//
|
||||
// Kind: "Job"
|
||||
// Name: spec.Job.Name
|
||||
// Runtime: {one_of: "process", command: tasks[0].Command}
|
||||
//
|
||||
// Body is empty (HCL has no Markdown body). The legacy Spec struct and
|
||||
// ParseHCLLegacy are retained for direct HCL consumers that have not yet
|
||||
// migrated.
|
||||
//
|
||||
// Deprecated: use the dispatcher (ParseFile/Dispatch). HCL is legacy
|
||||
// per R-013; the HCL path is retained only for the v0.9→v0.10 migration
|
||||
// window (REQ-090) and will be removed in v1.0.
|
||||
func ParseHCL(data []byte, filename string) (*WorkloadSpec, error) {
|
||||
spec, err := ParseHCLLegacy(data, filename)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
ws := &WorkloadSpec{
|
||||
SpecVersion: "",
|
||||
Kind: "Job",
|
||||
Name: spec.Job.Name,
|
||||
Count: 1,
|
||||
Body: "",
|
||||
}
|
||||
if len(spec.Tasks) > 0 {
|
||||
ws.Runtime = &RuntimeBlock{
|
||||
OneOf: "process",
|
||||
Command: spec.Tasks[0].Command,
|
||||
}
|
||||
}
|
||||
return ws, nil
|
||||
}
|
||||
|
||||
// ParseHCLLegacy is the original HCL-only parser retained for direct
|
||||
// HCL consumers (e.g. the cli/job.go toTaskSpecs path during the
|
||||
// migration window). New code should call ParseHCL (which returns a
|
||||
// *WorkloadSpec) or the dispatcher. Deprecated: HCL is legacy per
|
||||
// R-013; see ParseHCL.
|
||||
func ParseHCLLegacy(data []byte, filename string) (*Spec, error) {
|
||||
var spec Spec
|
||||
if err := hclDecode(filename, data, &spec); err != nil {
|
||||
return nil, fmt.Errorf("decode hcl: %w", err)
|
||||
}
|
||||
if spec.Job.Name == "" {
|
||||
return nil, fmt.Errorf("spec missing job name")
|
||||
}
|
||||
if len(spec.Tasks) == 0 {
|
||||
return nil, fmt.Errorf("spec must have at least one task")
|
||||
}
|
||||
for i, t := range spec.Tasks {
|
||||
if t.Command == "" {
|
||||
return nil, fmt.Errorf("task[%d] (%s) missing command", i, t.Name)
|
||||
}
|
||||
}
|
||||
return &spec, nil
|
||||
}
|
||||
@@ -0,0 +1,222 @@
|
||||
package jobspec
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestDispatch_Markdown(t *testing.T) {
|
||||
input := "---\nkind: Job\nname: md-job\n---\nbody content\n"
|
||||
ws, err := Dispatch([]byte(input), "spec.md")
|
||||
if err != nil {
|
||||
t.Fatalf("Dispatch .md: %v", err)
|
||||
}
|
||||
if ws.Kind != "Job" {
|
||||
t.Errorf("Kind = %q, want Job", ws.Kind)
|
||||
}
|
||||
if ws.Name != "md-job" {
|
||||
t.Errorf("Name = %q, want md-job", ws.Name)
|
||||
}
|
||||
if ws.Body != "body content\n" {
|
||||
t.Errorf("Body = %q, want %q (R-015)", ws.Body, "body content\n")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatch_YAML(t *testing.T) {
|
||||
input := "kind: Service\nname: yaml-svc\nports:\n - name: http\n port: 80\n"
|
||||
ws, err := Dispatch([]byte(input), "spec.yaml")
|
||||
if err != nil {
|
||||
t.Fatalf("Dispatch .yaml: %v", err)
|
||||
}
|
||||
if ws.Kind != "Service" {
|
||||
t.Errorf("Kind = %q, want Service", ws.Kind)
|
||||
}
|
||||
if ws.Name != "yaml-svc" {
|
||||
t.Errorf("Name = %q, want yaml-svc", ws.Name)
|
||||
}
|
||||
if ws.Body != "" {
|
||||
t.Errorf("Body = %q, want empty (YAML has no body)", ws.Body)
|
||||
}
|
||||
if len(ws.Ports) != 1 || ws.Ports[0].Name != "http" || ws.Ports[0].Port != 80 {
|
||||
t.Errorf("Ports = %+v, want one http:80", ws.Ports)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatch_YML(t *testing.T) {
|
||||
input := "kind: DaemonSet\nname: yml-ds\n"
|
||||
ws, err := Dispatch([]byte(input), "spec.yml")
|
||||
if err != nil {
|
||||
t.Fatalf("Dispatch .yml: %v", err)
|
||||
}
|
||||
if ws.Kind != "DaemonSet" {
|
||||
t.Errorf("Kind = %q, want DaemonSet", ws.Kind)
|
||||
}
|
||||
if ws.Body != "" {
|
||||
t.Errorf("Body = %q, want empty", ws.Body)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatch_HCLAdapter(t *testing.T) {
|
||||
hcl := `job "demo" {}
|
||||
task "build" {
|
||||
command = "/bin/echo"
|
||||
args = ["hello"]
|
||||
}
|
||||
`
|
||||
ws, err := Dispatch([]byte(hcl), "spec.hcl")
|
||||
if err != nil {
|
||||
t.Fatalf("Dispatch .hcl: %v", err)
|
||||
}
|
||||
if ws.Kind != "Job" {
|
||||
t.Errorf("Kind = %q, want Job (adapter always sets Job)", ws.Kind)
|
||||
}
|
||||
if ws.Name != "demo" {
|
||||
t.Errorf("Name = %q, want demo (from spec.Job.Name)", ws.Name)
|
||||
}
|
||||
if ws.Runtime == nil {
|
||||
t.Fatal("Runtime is nil; adapter should populate from tasks[0]")
|
||||
}
|
||||
if ws.Runtime.OneOf != "process" {
|
||||
t.Errorf("Runtime.OneOf = %q, want process", ws.Runtime.OneOf)
|
||||
}
|
||||
if ws.Runtime.Command != "/bin/echo" {
|
||||
t.Errorf("Runtime.Command = %q, want /bin/echo (from tasks[0].Command)", ws.Runtime.Command)
|
||||
}
|
||||
if ws.Body != "" {
|
||||
t.Errorf("Body = %q, want empty (HCL has no body)", ws.Body)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatch_HCLAdapterNoTasks(t *testing.T) {
|
||||
hcl := `job "x" {}`
|
||||
_, err := Dispatch([]byte(hcl), "spec.hcl")
|
||||
if err == nil {
|
||||
t.Fatal("expected error for HCL with no tasks")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "at least one task") {
|
||||
t.Errorf("error = %q, want it to contain 'at least one task'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatch_UnknownExtension(t *testing.T) {
|
||||
_, err := Dispatch([]byte("kind: Job\nname: x\n"), "spec.json")
|
||||
if err == nil {
|
||||
t.Fatal("expected error for unknown extension, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "unknown extension") {
|
||||
t.Errorf("error = %q, want it to contain 'unknown extension'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatch_NoExtension(t *testing.T) {
|
||||
_, err := Dispatch([]byte("kind: Job\nname: x\n"), "spec")
|
||||
if err == nil {
|
||||
t.Fatal("expected error for no extension, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestDispatch_EmptyYAML(t *testing.T) {
|
||||
_, err := Dispatch([]byte(""), "spec.yaml")
|
||||
if err == nil {
|
||||
t.Fatal("expected error for empty YAML, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseFile_Markdown(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
path := filepath.Join(dir, "spec.md")
|
||||
content := "---\nkind: Job\nname: file-md\n---\nbody\n"
|
||||
if err := os.WriteFile(path, []byte(content), 0o644); err != nil {
|
||||
t.Fatalf("write: %v", err)
|
||||
}
|
||||
ws, err := ParseFile(path)
|
||||
if err != nil {
|
||||
t.Fatalf("ParseFile .md: %v", err)
|
||||
}
|
||||
if ws.Kind != "Job" || ws.Name != "file-md" {
|
||||
t.Errorf("got Kind=%q Name=%q", ws.Kind, ws.Name)
|
||||
}
|
||||
if ws.Body != "body\n" {
|
||||
t.Errorf("Body = %q, want %q", ws.Body, "body\n")
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseFile_YAML(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
path := filepath.Join(dir, "spec.yaml")
|
||||
content := "kind: Service\nname: file-yaml\n"
|
||||
if err := os.WriteFile(path, []byte(content), 0o644); err != nil {
|
||||
t.Fatalf("write: %v", err)
|
||||
}
|
||||
ws, err := ParseFile(path)
|
||||
if err != nil {
|
||||
t.Fatalf("ParseFile .yaml: %v", err)
|
||||
}
|
||||
if ws.Kind != "Service" || ws.Name != "file-yaml" {
|
||||
t.Errorf("got Kind=%q Name=%q", ws.Kind, ws.Name)
|
||||
}
|
||||
if ws.Body != "" {
|
||||
t.Errorf("Body = %q, want empty", ws.Body)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseFile_HCL(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
path := filepath.Join(dir, "spec.hcl")
|
||||
content := `job "file-hcl" {}
|
||||
task "t" { command = "/bin/true" }
|
||||
`
|
||||
if err := os.WriteFile(path, []byte(content), 0o644); err != nil {
|
||||
t.Fatalf("write: %v", err)
|
||||
}
|
||||
ws, err := ParseFile(path)
|
||||
if err != nil {
|
||||
t.Fatalf("ParseFile .hcl: %v", err)
|
||||
}
|
||||
if ws.Kind != "Job" || ws.Name != "file-hcl" {
|
||||
t.Errorf("got Kind=%q Name=%q", ws.Kind, ws.Name)
|
||||
}
|
||||
if ws.Runtime == nil || ws.Runtime.Command != "/bin/true" {
|
||||
t.Errorf("Runtime.Command = %v, want /bin/true", ws.Runtime)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseFile_MissingFile(t *testing.T) {
|
||||
_, err := ParseFile(filepath.Join(t.TempDir(), "nope.md"))
|
||||
if err == nil {
|
||||
t.Fatal("expected error for missing file, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "read spec file") {
|
||||
t.Errorf("error = %q, want it to contain 'read spec file'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseFile_UnknownExtension(t *testing.T) {
|
||||
dir := t.TempDir()
|
||||
path := filepath.Join(dir, "spec.txt")
|
||||
if err := os.WriteFile(path, []byte("kind: Job\nname: x\n"), 0o644); err != nil {
|
||||
t.Fatalf("write: %v", err)
|
||||
}
|
||||
_, err := ParseFile(path)
|
||||
if err == nil {
|
||||
t.Fatal("expected error for unknown extension, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "unknown extension") {
|
||||
t.Errorf("error = %q, want 'unknown extension'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseHCL_LegacySpec(t *testing.T) {
|
||||
hcl := `job "legacy" {}
|
||||
task "t" { command = "/bin/echo" }
|
||||
`
|
||||
ws, err := ParseHCL([]byte(hcl), "spec.hcl")
|
||||
if err != nil {
|
||||
t.Fatalf("ParseHCL: %v", err)
|
||||
}
|
||||
if ws.Kind != "Job" || ws.Name != "legacy" {
|
||||
t.Errorf("adapter got Kind=%q Name=%q", ws.Kind, ws.Name)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,946 @@
|
||||
package jobspec
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strconv"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// WorkloadSpec is the unified canonical jobspec populated by both the
|
||||
// Markdown frontmatter parser (canonical path, R-013/R-014) and the HCL
|
||||
// legacy adapter (REQ-064, REQ-090). It is the single shape consumed by
|
||||
// downstream phases (P0c schemas, P01 transport). The Markdown body
|
||||
// after the closing `---` is preserved verbatim in Body (R-015
|
||||
// byte-exact preservation is a load-bearing invariant enforced by the
|
||||
// fuzz harness in markdown_fuzz_test.go).
|
||||
type WorkloadSpec struct {
|
||||
SpecVersion string
|
||||
Kind string
|
||||
Name string
|
||||
Runtime *RuntimeBlock
|
||||
Count int
|
||||
Ports []PortSpec
|
||||
Env map[string]string
|
||||
Secrets []string
|
||||
Volumes []VolumeSpec
|
||||
Body string
|
||||
|
||||
// Kind-specific blocks consumed by the P0c schema validators
|
||||
// (internal/spec/schema). P02 populates Restart, Update, Service,
|
||||
// Health, Constraints, Affinity, Lifecycle from the Markdown
|
||||
// frontmatter (the rest are still populated by later phases).
|
||||
|
||||
// Restart is the restart policy block. Required for Service and
|
||||
// DaemonSet; optional for Job (defaults to never/on-failure).
|
||||
// P02 populates it from the `restart:` frontmatter block.
|
||||
Restart *RestartBlock
|
||||
|
||||
// Schedule is the schedule block. For Job it carries an optional
|
||||
// cron string; for DaemonSet it carries the placement mode
|
||||
// (every-node/matching/mandatory). Populated by P05 (scheduler
|
||||
// skeleton) and the DaemonSet phase.
|
||||
Schedule *ScheduleBlock
|
||||
|
||||
// Update is the rolling/canary update stanza. Required for
|
||||
// Service. P02 populates it from the `update:` frontmatter block;
|
||||
// the rolling/canary semantics land in P03.
|
||||
Update *UpdateBlock
|
||||
|
||||
// Service is the service block (Traefik route definition). For
|
||||
// Service kind it is implied; Job and DaemonSet do not carry a
|
||||
// Traefik route by default (D-175). P02 populates it from the
|
||||
// `service:` frontmatter block.
|
||||
Service *ServiceBlock
|
||||
|
||||
// Health is the health-check block. Required for Service (Traefik
|
||||
// routing depends on it). P02 populates it from the `health:`
|
||||
// frontmatter block (R-012).
|
||||
Health *HealthBlock
|
||||
|
||||
// Constraints is the CEL expression list for placement. P02
|
||||
// populates it from the `constraints:` frontmatter array; P05
|
||||
// consumes it for the CLI-side scheduler (REQ-083).
|
||||
Constraints []string
|
||||
|
||||
// Affinity is the affinity rule list for placement. P02 populates
|
||||
// it from the `affinity:` frontmatter array; P05 consumes it.
|
||||
Affinity []AffinityRule
|
||||
|
||||
// Lifecycle is the lifecycle hook block (pre_stop, post_start).
|
||||
// P02 populates it from the `lifecycle:` frontmatter block; P04
|
||||
// wires it into the systemd unit (ExecStop / ExecStartPost).
|
||||
Lifecycle *LifecycleBlock
|
||||
|
||||
// Timeout is an optional execution timeout (duration string) for
|
||||
// Job. Populated by P04.
|
||||
Timeout string
|
||||
}
|
||||
|
||||
// RuntimeBlock is a minimal runtime abstraction surface populated by the
|
||||
// Markdown parser. The full runtime abstraction lands in P07; for now
|
||||
// only the one_of/image/command fields are parsed and stored (REQ-064).
|
||||
type RuntimeBlock struct {
|
||||
OneOf string
|
||||
Image string
|
||||
Command string
|
||||
}
|
||||
|
||||
// RestartBlock is the restart policy block. Mode is one of never,
|
||||
// on-failure, service (REQ-074 schema validators). P02 populates it from
|
||||
// the frontmatter `restart:` block.
|
||||
type RestartBlock struct {
|
||||
Mode string
|
||||
MaxRetries int
|
||||
Delay string
|
||||
}
|
||||
|
||||
// ScheduleBlock is the scheduling block. For Job, Cron is an optional
|
||||
// cron expression. For DaemonSet, Mode is one of every-node, matching,
|
||||
// mandatory (REQ-074). Populated by P05 and the DaemonSet phase.
|
||||
type ScheduleBlock struct {
|
||||
Mode string
|
||||
Cron string
|
||||
}
|
||||
|
||||
// UpdateBlock is the rolling/canary update stanza. Required for Service.
|
||||
// P02 populates it from the frontmatter `update:` block; the
|
||||
// rolling/canary/blue-green semantics land in P03.
|
||||
type UpdateBlock struct {
|
||||
Strategy string
|
||||
MaxSurge int
|
||||
MaxParallel int
|
||||
MinHealthyTime string
|
||||
HealthyDeadline string
|
||||
Canary string
|
||||
AutoPromote bool
|
||||
}
|
||||
|
||||
// ServiceBlock is the Traefik route definition. For Service it is
|
||||
// implied (Traefik route YES); Job and DaemonSet do not carry one by
|
||||
// default (D-175). P02 populates it from the frontmatter `service:`
|
||||
// block.
|
||||
type ServiceBlock struct {
|
||||
Host string
|
||||
RouteID string
|
||||
Name string
|
||||
Port int
|
||||
Bind string
|
||||
}
|
||||
|
||||
// HealthBlock is the health-check block. P02 populates it from the
|
||||
// frontmatter `health:` block (R-012). The Traefik emitter (REQ-077)
|
||||
// renders it as the service's health-check stanza; ServiceValidator
|
||||
// requires it for Traefik routing.
|
||||
type HealthBlock struct {
|
||||
CheckType string
|
||||
Interval string
|
||||
Timeout string
|
||||
UnhealthyThreshold int
|
||||
}
|
||||
|
||||
// AffinityRule is a single affinity entry: target CEL expression +
|
||||
// integer weight. P02 populates it from the `affinity:` frontmatter
|
||||
// array; P05 consumes it for the CLI-side scheduler (REQ-083).
|
||||
type AffinityRule struct {
|
||||
Target string
|
||||
Weight int
|
||||
}
|
||||
|
||||
// LifecycleBlock is the lifecycle hook block. PreStop and PostStart
|
||||
// are command lists run before stop / after start. P02 populates it
|
||||
// from the `lifecycle:` frontmatter block; P04 wires it into the
|
||||
// systemd unit (ExecStop / ExecStartPost).
|
||||
type LifecycleBlock struct {
|
||||
PreStop []string
|
||||
PostStart []string
|
||||
}
|
||||
|
||||
// PortSpec is a minimal port binding entry. HostIP is optional.
|
||||
type PortSpec struct {
|
||||
Name string
|
||||
HostPort int
|
||||
Port int
|
||||
Protocol string
|
||||
HostIP string
|
||||
}
|
||||
|
||||
// VolumeSpec is a minimal volume mount entry. Fields are stored raw
|
||||
// pending the P0c schema work (REQ-074).
|
||||
type VolumeSpec struct {
|
||||
Name string
|
||||
Type string
|
||||
Source string
|
||||
Target string
|
||||
ReadOnly bool
|
||||
}
|
||||
|
||||
// validKinds is the set of workload kinds accepted by the parser per
|
||||
// R-012. Unknown kinds are rejected.
|
||||
var validKinds = map[string]bool{
|
||||
"Job": true,
|
||||
"Service": true,
|
||||
"DaemonSet": true,
|
||||
}
|
||||
|
||||
// ParseMarkdown parses a Markdown jobspec with YAML frontmatter into a
|
||||
// *WorkloadSpec (R-013 canonical format, R-014 frontmatter). The body
|
||||
// after the closing `---` is preserved verbatim in result.Body
|
||||
// (R-015 byte-exact, including trailing newlines, CRLF, and BOM in the
|
||||
// body). The frontmatter parser is a minimal hand-rolled YAML-ish
|
||||
// key:value reader — gopkg.in/yaml.v3 is intentionally not added (same
|
||||
// approach as internal/config/markdown.go and internal/ns/parse.go).
|
||||
//
|
||||
// For .yaml/.yml files (no Markdown body), the dispatcher calls this
|
||||
// with the whole file treated as frontmatter and Body left empty (see
|
||||
// dispatch.go).
|
||||
func ParseMarkdown(data []byte) (*WorkloadSpec, error) {
|
||||
content := string(data)
|
||||
block, body, ok := splitFrontmatter(content)
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("parse markdown: missing frontmatter delimiters")
|
||||
}
|
||||
if strings.TrimSpace(block) == "" {
|
||||
return nil, fmt.Errorf("parse markdown: empty frontmatter")
|
||||
}
|
||||
spec, err := parseFrontmatterBlock(block)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
spec.Body = body
|
||||
if err := validateWorkload(spec); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return spec, nil
|
||||
}
|
||||
|
||||
// splitFrontmatter splits the file content into the YAML frontmatter
|
||||
// block and the verbatim body that follows the closing `---`. A leading
|
||||
// UTF-8 BOM is stripped from the frontmatter scan (R-015: BOM is not
|
||||
// preserved in the frontmatter, but a BOM inside the body would be
|
||||
// preserved because the body is verbatim). Returns (block, body, ok).
|
||||
// ok is false when no opening `---` delimiter is present, or no closing
|
||||
// `---` delimiter is found, or the block is empty after the opening
|
||||
// delimiter (handled by caller).
|
||||
func splitFrontmatter(content string) (block, body string, ok bool) {
|
||||
// Strip a leading UTF-8 BOM if present (EF BB BF). Only the
|
||||
// frontmatter scan is BOM-stripped; the body is byte-exact, so a BOM
|
||||
// appearing inside the body is preserved verbatim.
|
||||
stripped := content
|
||||
if strings.HasPrefix(stripped, "\uFEFF") {
|
||||
stripped = stripped[len("\uFEFF"):]
|
||||
}
|
||||
// Trim leading horizontal whitespace and newlines before the
|
||||
// opening delimiter. We do NOT trim trailing — body must be exact.
|
||||
trimmed := strings.TrimLeft(stripped, "\r\n\t ")
|
||||
if !strings.HasPrefix(trimmed, "---") {
|
||||
return "", "", false
|
||||
}
|
||||
// The opening delimiter must be on its own line: `---` optionally
|
||||
// followed by a line terminator.
|
||||
rest := trimmed[3:]
|
||||
// The opening `---` must be followed by a newline or end-of-file
|
||||
// (a `---foo` prefix is not a valid delimiter).
|
||||
if len(rest) > 0 && rest[0] != '\n' && rest[0] != '\r' {
|
||||
return "", "", false
|
||||
}
|
||||
rest = strings.TrimLeft(rest, "\r\n")
|
||||
|
||||
// Find the closing delimiter line. The closing `---` must be on its
|
||||
// own line: preceded by a newline (or at the start of `rest`) and
|
||||
// followed by a newline or end-of-file.
|
||||
idx := findClosingDelimiter(rest)
|
||||
if idx < 0 {
|
||||
return "", "", false
|
||||
}
|
||||
block = rest[:idx]
|
||||
// Body is everything after the closing `---` line. The closing
|
||||
// delimiter line itself (including its trailing newline) is NOT
|
||||
// part of the body. We compute the byte offset in the original
|
||||
// `content` so the body is byte-exact (R-015).
|
||||
afterClose := rest[idx:]
|
||||
// afterClose starts with `---`. Strip the delimiter line.
|
||||
delimLen := 3
|
||||
// Account for an optional trailing `...` or spaces on the delimiter
|
||||
// line — the delimiter is `---` followed by anything up to and
|
||||
// including the line terminator. Body starts after the newline.
|
||||
// Find the end of the delimiter line.
|
||||
newlineIdx := strings.IndexAny(afterClose, "\r\n")
|
||||
var bodyStart int
|
||||
if newlineIdx < 0 {
|
||||
// Closing `---` is the last line: body is empty.
|
||||
bodyStart = len(afterClose)
|
||||
} else {
|
||||
// Consume the delimiter line and its line terminator(s).
|
||||
bodyStart = newlineIdx
|
||||
// Strip a single CRLF or LF.
|
||||
if strings.HasPrefix(afterClose[bodyStart:], "\r\n") {
|
||||
bodyStart += 2
|
||||
} else {
|
||||
bodyStart += 1
|
||||
}
|
||||
}
|
||||
body = afterClose[bodyStart:]
|
||||
_ = delimLen
|
||||
return block, body, true
|
||||
}
|
||||
|
||||
// findClosingDelimiter returns the byte index in `rest` where the
|
||||
// closing `---` delimiter line begins, or -1 if none is found. The
|
||||
// delimiter must be on its own line: either at the start of `rest` or
|
||||
// preceded by a newline, and followed by a newline or end-of-file.
|
||||
func findClosingDelimiter(rest string) int {
|
||||
// Special case: closing delimiter at the very start (frontmatter
|
||||
// block is empty). The opening `---` is immediately followed by the
|
||||
// closing `---`. We require the opening to be its own line, so the
|
||||
// closing at index 0 means the opening had no body — invalid (empty
|
||||
// frontmatter handled by caller). We still report it; caller
|
||||
// rejects empty block.
|
||||
for i := 0; i < len(rest); i++ {
|
||||
if rest[i] != '\n' {
|
||||
continue
|
||||
}
|
||||
// Candidate: line after this newline starts with `---`.
|
||||
j := i + 1
|
||||
if j+3 <= len(rest) && rest[j] == '-' && rest[j+1] == '-' && rest[j+2] == '-' {
|
||||
// Must be followed by newline, CRLF, or end-of-file.
|
||||
end := j + 3
|
||||
if end == len(rest) {
|
||||
return j
|
||||
}
|
||||
if rest[end] == '\n' || rest[end] == '\r' {
|
||||
return j
|
||||
}
|
||||
}
|
||||
}
|
||||
// Final candidate: closing delimiter at the very start of rest
|
||||
// (immediately after the opening delimiter + its newline). This
|
||||
// happens when frontmatter is empty: `---\n---\n`. We already trim
|
||||
// leading newlines off `rest`, so if rest itself starts with `---`
|
||||
// AND it's a closing delimiter (followed by newline/EOF), it is the
|
||||
// empty-frontmatter case.
|
||||
if strings.HasPrefix(rest, "---") {
|
||||
end := 3
|
||||
if end == len(rest) {
|
||||
return 0
|
||||
}
|
||||
if rest[end] == '\n' || rest[end] == '\r' {
|
||||
return 0
|
||||
}
|
||||
}
|
||||
return -1
|
||||
}
|
||||
|
||||
// parseFrontmatterBlock parses a minimal YAML-ish frontmatter block into
|
||||
// a *WorkloadSpec (without Body, which is filled by the caller).
|
||||
//
|
||||
// Supported shapes:
|
||||
//
|
||||
// kind: Job
|
||||
// name: my-job
|
||||
// count: 3
|
||||
// runtime:
|
||||
// one_of: process
|
||||
// image: docker.io/nginx:latest
|
||||
// command: /bin/sh -c
|
||||
// ports:
|
||||
// - name: http
|
||||
// port: 8080
|
||||
// host_port: 80
|
||||
// protocol: tcp
|
||||
// env:
|
||||
// FOO: bar
|
||||
// BAR:
|
||||
// from: secret:my-secret
|
||||
// secrets:
|
||||
// - db-password
|
||||
// volumes:
|
||||
// - name: data
|
||||
// type: host
|
||||
// source: /data
|
||||
// target: /data
|
||||
// read_only: true
|
||||
//
|
||||
// Comments (# ...) and blank lines are ignored. Quoted scalar values
|
||||
// ("..." or '...') are unwrapped. No flow collections except the
|
||||
// inline-array form for `secrets`. Multi-line block scalars (|, >) are
|
||||
// not supported — by design, to avoid adding a YAML dependency for this
|
||||
// small surface.
|
||||
func parseFrontmatterBlock(block string) (*WorkloadSpec, error) {
|
||||
spec := &WorkloadSpec{Count: 1}
|
||||
lines := strings.Split(block, "\n")
|
||||
|
||||
type section int
|
||||
const (
|
||||
secNone section = iota
|
||||
secRuntime
|
||||
secPorts
|
||||
secEnv
|
||||
secSecrets
|
||||
secVolumes
|
||||
secRestart
|
||||
secUpdate
|
||||
secService
|
||||
secHealth
|
||||
secLifecycle
|
||||
secAffinity
|
||||
secConstraints
|
||||
)
|
||||
cur := secNone
|
||||
var curPort *PortSpec
|
||||
var curVol *VolumeSpec
|
||||
var curAffinity *AffinityRule
|
||||
var lifecycleCur string
|
||||
|
||||
flushPort := func() {
|
||||
if curPort != nil {
|
||||
spec.Ports = append(spec.Ports, *curPort)
|
||||
curPort = nil
|
||||
}
|
||||
}
|
||||
flushVol := func() {
|
||||
if curVol != nil {
|
||||
spec.Volumes = append(spec.Volumes, *curVol)
|
||||
curVol = nil
|
||||
}
|
||||
}
|
||||
flushAffinity := func() {
|
||||
if curAffinity != nil {
|
||||
spec.Affinity = append(spec.Affinity, *curAffinity)
|
||||
curAffinity = nil
|
||||
}
|
||||
}
|
||||
|
||||
for lineNo, raw := range lines {
|
||||
line := stripComment(raw)
|
||||
if strings.TrimSpace(line) == "" {
|
||||
continue
|
||||
}
|
||||
indent := countIndent(line)
|
||||
trimmed := strings.TrimSpace(line)
|
||||
|
||||
if indent == 0 {
|
||||
// Flush any pending nested entry before switching sections.
|
||||
flushPort()
|
||||
flushVol()
|
||||
flushAffinity()
|
||||
cur = secNone
|
||||
|
||||
key, val, ok := splitKV(trimmed)
|
||||
if !ok {
|
||||
return nil, fmt.Errorf("parse markdown: line %d: malformed key:value", lineNo+1)
|
||||
}
|
||||
switch key {
|
||||
case "orca-spec-version":
|
||||
spec.SpecVersion = unquote(val)
|
||||
case "kind":
|
||||
spec.Kind = unquote(val)
|
||||
case "name":
|
||||
spec.Name = unquote(val)
|
||||
case "count":
|
||||
if n, err := strconv.Atoi(strings.TrimSpace(unquote(val))); err == nil {
|
||||
spec.Count = n
|
||||
} else {
|
||||
return nil, fmt.Errorf("parse markdown: line %d: count: %v", lineNo+1, err)
|
||||
}
|
||||
case "runtime":
|
||||
spec.Runtime = &RuntimeBlock{}
|
||||
if strings.TrimSpace(val) != "" {
|
||||
// Inline value (unusual); ignore — runtime is a block.
|
||||
}
|
||||
cur = secRuntime
|
||||
case "ports":
|
||||
cur = secPorts
|
||||
case "env":
|
||||
spec.Env = map[string]string{}
|
||||
cur = secEnv
|
||||
case "secrets":
|
||||
if strings.TrimSpace(val) != "" {
|
||||
arr, err := parseStringArray(val)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("parse markdown: line %d: secrets: %w", lineNo+1, err)
|
||||
}
|
||||
spec.Secrets = append(spec.Secrets, arr...)
|
||||
cur = secNone
|
||||
} else {
|
||||
cur = secSecrets
|
||||
}
|
||||
case "volumes":
|
||||
cur = secVolumes
|
||||
case "restart":
|
||||
spec.Restart = &RestartBlock{}
|
||||
cur = secRestart
|
||||
case "update":
|
||||
spec.Update = &UpdateBlock{}
|
||||
cur = secUpdate
|
||||
case "service":
|
||||
spec.Service = &ServiceBlock{}
|
||||
cur = secService
|
||||
case "health":
|
||||
spec.Health = &HealthBlock{}
|
||||
cur = secHealth
|
||||
case "lifecycle":
|
||||
spec.Lifecycle = &LifecycleBlock{}
|
||||
cur = secLifecycle
|
||||
case "constraints":
|
||||
if strings.TrimSpace(val) != "" {
|
||||
arr, err := parseStringArray(val)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("parse markdown: line %d: constraints: %w", lineNo+1, err)
|
||||
}
|
||||
spec.Constraints = append(spec.Constraints, arr...)
|
||||
cur = secNone
|
||||
} else {
|
||||
cur = secConstraints
|
||||
}
|
||||
case "affinity":
|
||||
if strings.TrimSpace(val) != "" {
|
||||
// Inline form not supported for affinity objects;
|
||||
// require the block form. Ignore inline values.
|
||||
cur = secNone
|
||||
} else {
|
||||
cur = secAffinity
|
||||
}
|
||||
default:
|
||||
// Unknown top-level key are ignored (forward-compat).
|
||||
cur = secNone
|
||||
}
|
||||
continue
|
||||
}
|
||||
|
||||
// Indented line: a nested entry under the current section.
|
||||
switch cur {
|
||||
case secRuntime:
|
||||
if spec.Runtime == nil {
|
||||
spec.Runtime = &RuntimeBlock{}
|
||||
}
|
||||
key, val, ok := splitKV(trimmed)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
switch key {
|
||||
case "one_of":
|
||||
spec.Runtime.OneOf = unquote(val)
|
||||
case "image":
|
||||
spec.Runtime.Image = unquote(val)
|
||||
case "command":
|
||||
spec.Runtime.Command = unquote(val)
|
||||
}
|
||||
case secPorts:
|
||||
if strings.HasPrefix(trimmed, "- ") || trimmed == "-" {
|
||||
flushPort()
|
||||
p := PortSpec{}
|
||||
curPort = &p
|
||||
rest := strings.TrimSpace(strings.TrimPrefix(trimmed, "-"))
|
||||
if rest != "" {
|
||||
applyPortKV(curPort, rest)
|
||||
}
|
||||
} else if curPort != nil {
|
||||
applyPortKV(curPort, trimmed)
|
||||
}
|
||||
case secEnv:
|
||||
key, val, ok := splitKV(trimmed)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
if val == "" {
|
||||
// Nested mapping under env (e.g. `BAR:\n from: ...`).
|
||||
// Store the raw string for now (REQ-064: store raw).
|
||||
spec.Env[key] = ""
|
||||
} else if strings.HasPrefix(val, "{") && strings.HasSuffix(val, "}") {
|
||||
// Inline object form: `BAR: {from: "secret:..."}`.
|
||||
// Store the raw object string for now.
|
||||
spec.Env[key] = val
|
||||
} else {
|
||||
spec.Env[key] = unquote(val)
|
||||
}
|
||||
case secSecrets:
|
||||
if strings.HasPrefix(trimmed, "- ") || trimmed == "-" {
|
||||
item := strings.TrimSpace(strings.TrimPrefix(trimmed, "-"))
|
||||
if item != "" {
|
||||
spec.Secrets = append(spec.Secrets, unquote(item))
|
||||
}
|
||||
}
|
||||
case secVolumes:
|
||||
if strings.HasPrefix(trimmed, "- ") || trimmed == "-" {
|
||||
flushVol()
|
||||
v := VolumeSpec{}
|
||||
curVol = &v
|
||||
rest := strings.TrimSpace(strings.TrimPrefix(trimmed, "-"))
|
||||
if rest != "" {
|
||||
applyVolumeKV(curVol, rest)
|
||||
}
|
||||
} else if curVol != nil {
|
||||
applyVolumeKV(curVol, trimmed)
|
||||
}
|
||||
case secRestart:
|
||||
if spec.Restart == nil {
|
||||
spec.Restart = &RestartBlock{}
|
||||
}
|
||||
key, val, ok := splitKV(trimmed)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
switch key {
|
||||
case "mode":
|
||||
spec.Restart.Mode = unquote(val)
|
||||
case "attempts", "max_retries":
|
||||
if n, err := strconv.Atoi(strings.TrimSpace(unquote(val))); err == nil {
|
||||
spec.Restart.MaxRetries = n
|
||||
}
|
||||
case "delay":
|
||||
spec.Restart.Delay = unquote(val)
|
||||
}
|
||||
case secUpdate:
|
||||
if spec.Update == nil {
|
||||
spec.Update = &UpdateBlock{}
|
||||
}
|
||||
key, val, ok := splitKV(trimmed)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
switch key {
|
||||
case "strategy":
|
||||
spec.Update.Strategy = unquote(val)
|
||||
case "max_parallel":
|
||||
if n, err := strconv.Atoi(strings.TrimSpace(unquote(val))); err == nil {
|
||||
spec.Update.MaxParallel = n
|
||||
}
|
||||
case "max_surge":
|
||||
if n, err := strconv.Atoi(strings.TrimSpace(unquote(val))); err == nil {
|
||||
spec.Update.MaxSurge = n
|
||||
}
|
||||
case "min_healthy_time":
|
||||
spec.Update.MinHealthyTime = unquote(val)
|
||||
case "healthy_deadline":
|
||||
spec.Update.HealthyDeadline = unquote(val)
|
||||
case "canary":
|
||||
spec.Update.Canary = unquote(val)
|
||||
case "auto_promote":
|
||||
spec.Update.AutoPromote = parseBool(val)
|
||||
}
|
||||
case secService:
|
||||
if spec.Service == nil {
|
||||
spec.Service = &ServiceBlock{}
|
||||
}
|
||||
key, val, ok := splitKV(trimmed)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
switch key {
|
||||
case "name":
|
||||
spec.Service.Name = unquote(val)
|
||||
case "port":
|
||||
if n, err := strconv.Atoi(strings.TrimSpace(unquote(val))); err == nil {
|
||||
spec.Service.Port = n
|
||||
}
|
||||
case "bind":
|
||||
spec.Service.Bind = unquote(val)
|
||||
case "host":
|
||||
spec.Service.Host = unquote(val)
|
||||
case "route_id":
|
||||
spec.Service.RouteID = unquote(val)
|
||||
}
|
||||
case secHealth:
|
||||
if spec.Health == nil {
|
||||
spec.Health = &HealthBlock{}
|
||||
}
|
||||
key, val, ok := splitKV(trimmed)
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
switch key {
|
||||
case "check_type":
|
||||
spec.Health.CheckType = unquote(val)
|
||||
case "interval":
|
||||
spec.Health.Interval = unquote(val)
|
||||
case "timeout":
|
||||
spec.Health.Timeout = unquote(val)
|
||||
case "unhealthy_threshold":
|
||||
if n, err := strconv.Atoi(strings.TrimSpace(unquote(val))); err == nil {
|
||||
spec.Health.UnhealthyThreshold = n
|
||||
}
|
||||
}
|
||||
case secLifecycle:
|
||||
if spec.Lifecycle == nil {
|
||||
spec.Lifecycle = &LifecycleBlock{}
|
||||
}
|
||||
// pre_stop / post_start are string arrays. The block form
|
||||
// is:
|
||||
// lifecycle:
|
||||
// pre_stop:
|
||||
// - cmd1
|
||||
// - cmd2
|
||||
// post_start:
|
||||
// - cmd3
|
||||
// We track which sub-list we are appending to via a local
|
||||
// cursor that is reset on every top-level section change.
|
||||
key, val, ok := splitKV(trimmed)
|
||||
if !ok {
|
||||
// Could be a list item under pre_stop/post_start.
|
||||
if strings.HasPrefix(trimmed, "- ") || trimmed == "-" {
|
||||
item := strings.TrimSpace(strings.TrimPrefix(trimmed, "-"))
|
||||
if item != "" && lifecycleCur != "" {
|
||||
appendLifecycleCmd(spec.Lifecycle, lifecycleCur, unquote(item))
|
||||
}
|
||||
}
|
||||
continue
|
||||
}
|
||||
switch key {
|
||||
case "pre_stop", "post_start":
|
||||
lifecycleCur = key
|
||||
if strings.TrimSpace(val) != "" {
|
||||
// Inline list form: `pre_stop: [cmd1, cmd2]`.
|
||||
arr, err := parseStringArray(val)
|
||||
if err == nil {
|
||||
for _, s := range arr {
|
||||
appendLifecycleCmd(spec.Lifecycle, key, s)
|
||||
}
|
||||
}
|
||||
lifecycleCur = ""
|
||||
}
|
||||
default:
|
||||
lifecycleCur = ""
|
||||
}
|
||||
case secAffinity:
|
||||
if strings.HasPrefix(trimmed, "- ") || trimmed == "-" {
|
||||
flushAffinity()
|
||||
r := AffinityRule{}
|
||||
curAffinity = &r
|
||||
rest := strings.TrimSpace(strings.TrimPrefix(trimmed, "-"))
|
||||
if rest != "" {
|
||||
applyAffinityKV(curAffinity, rest)
|
||||
}
|
||||
} else if curAffinity != nil {
|
||||
applyAffinityKV(curAffinity, trimmed)
|
||||
}
|
||||
case secConstraints:
|
||||
if strings.HasPrefix(trimmed, "- ") || trimmed == "-" {
|
||||
item := strings.TrimSpace(strings.TrimPrefix(trimmed, "-"))
|
||||
if item != "" {
|
||||
spec.Constraints = append(spec.Constraints, unquote(item))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
flushPort()
|
||||
flushVol()
|
||||
flushAffinity()
|
||||
return spec, nil
|
||||
}
|
||||
|
||||
// applyPortKV applies a `key: value` pair to a PortSpec entry.
|
||||
func applyPortKV(p *PortSpec, s string) {
|
||||
key, val, ok := splitKV(s)
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
switch key {
|
||||
case "name":
|
||||
p.Name = unquote(val)
|
||||
case "host_port":
|
||||
if n, err := strconv.Atoi(strings.TrimSpace(unquote(val))); err == nil {
|
||||
p.HostPort = n
|
||||
}
|
||||
case "port":
|
||||
if n, err := strconv.Atoi(strings.TrimSpace(unquote(val))); err == nil {
|
||||
p.Port = n
|
||||
}
|
||||
case "protocol":
|
||||
p.Protocol = unquote(val)
|
||||
case "host_ip":
|
||||
p.HostIP = unquote(val)
|
||||
}
|
||||
}
|
||||
|
||||
// applyVolumeKV applies a `key: value` pair to a VolumeSpec entry.
|
||||
func applyVolumeKV(v *VolumeSpec, s string) {
|
||||
key, val, ok := splitKV(s)
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
switch key {
|
||||
case "name":
|
||||
v.Name = unquote(val)
|
||||
case "type":
|
||||
v.Type = unquote(val)
|
||||
case "source":
|
||||
v.Source = unquote(val)
|
||||
case "target":
|
||||
v.Target = unquote(val)
|
||||
case "read_only":
|
||||
switch strings.ToLower(strings.TrimSpace(unquote(val))) {
|
||||
case "true", "yes", "on", "1":
|
||||
v.ReadOnly = true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// applyAffinityKV applies a `key: value` pair to an AffinityRule entry.
|
||||
func applyAffinityKV(r *AffinityRule, s string) {
|
||||
key, val, ok := splitKV(s)
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
switch key {
|
||||
case "target":
|
||||
r.Target = unquote(val)
|
||||
case "weight":
|
||||
if n, err := strconv.Atoi(strings.TrimSpace(unquote(val))); err == nil {
|
||||
r.Weight = n
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// appendLifecycleCmd appends a command to the named lifecycle hook list
|
||||
// (pre_stop or post_start) on the given LifecycleBlock.
|
||||
func appendLifecycleCmd(lb *LifecycleBlock, name, cmd string) {
|
||||
if lb == nil || cmd == "" {
|
||||
return
|
||||
}
|
||||
switch name {
|
||||
case "pre_stop":
|
||||
lb.PreStop = append(lb.PreStop, cmd)
|
||||
case "post_start":
|
||||
lb.PostStart = append(lb.PostStart, cmd)
|
||||
}
|
||||
}
|
||||
|
||||
// parseBool parses a YAML-ish boolean value (true/yes/on/1 → true). The
|
||||
// comparison is case-insensitive. Empty and unrecognized values return
|
||||
// false (forward-compatible with future strict-mode validation).
|
||||
func parseBool(s string) bool {
|
||||
switch strings.ToLower(strings.TrimSpace(unquote(s))) {
|
||||
case "true", "yes", "on", "1":
|
||||
return true
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// validateWorkload enforces required fields and kind validity (R-012).
|
||||
func validateWorkload(spec *WorkloadSpec) error {
|
||||
if spec.Kind == "" {
|
||||
return fmt.Errorf("parse markdown: missing kind")
|
||||
}
|
||||
if !validKinds[spec.Kind] {
|
||||
return fmt.Errorf("parse markdown: kind %q is not one of Job, Service, DaemonSet", spec.Kind)
|
||||
}
|
||||
if strings.TrimSpace(spec.Name) == "" {
|
||||
return fmt.Errorf("parse markdown: missing name")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// parseStringArray parses an inline YAML flow-array of scalars, e.g.
|
||||
// `["a", "b"]` or `['a', 'b']` or `[a, b]`. Empty array `[]` returns nil.
|
||||
func parseStringArray(val string) ([]string, error) {
|
||||
val = strings.TrimSpace(val)
|
||||
if val == "" {
|
||||
return nil, nil
|
||||
}
|
||||
if !strings.HasPrefix(val, "[") || !strings.HasSuffix(val, "]") {
|
||||
return nil, fmt.Errorf("expected [..] array, got %q", val)
|
||||
}
|
||||
inner := strings.TrimSpace(val[1 : len(val)-1])
|
||||
if inner == "" {
|
||||
return nil, nil
|
||||
}
|
||||
parts := splitFlowItems(inner)
|
||||
out := make([]string, 0, len(parts))
|
||||
for _, p := range parts {
|
||||
p = strings.TrimSpace(p)
|
||||
if p == "" {
|
||||
continue
|
||||
}
|
||||
out = append(out, unquote(p))
|
||||
}
|
||||
return out, nil
|
||||
}
|
||||
|
||||
// splitFlowItems splits a comma-separated flow-array body, respecting
|
||||
// single and double quotes.
|
||||
func splitFlowItems(s string) []string {
|
||||
var out []string
|
||||
inSingle := false
|
||||
inDouble := false
|
||||
start := 0
|
||||
for i := 0; i < len(s); i++ {
|
||||
c := s[i]
|
||||
switch c {
|
||||
case '\'':
|
||||
if !inDouble {
|
||||
inSingle = !inSingle
|
||||
}
|
||||
case '"':
|
||||
if !inSingle {
|
||||
inDouble = !inDouble
|
||||
}
|
||||
case ',':
|
||||
if !inSingle && !inDouble {
|
||||
out = append(out, s[start:i])
|
||||
start = i + 1
|
||||
}
|
||||
}
|
||||
}
|
||||
out = append(out, s[start:])
|
||||
return out
|
||||
}
|
||||
|
||||
func countIndent(s string) int {
|
||||
n := 0
|
||||
for _, r := range s {
|
||||
if r == ' ' || r == '\t' {
|
||||
n++
|
||||
continue
|
||||
}
|
||||
break
|
||||
}
|
||||
return n
|
||||
}
|
||||
|
||||
func splitKV(s string) (key, val string, ok bool) {
|
||||
idx := strings.Index(s, ":")
|
||||
if idx < 0 {
|
||||
return "", "", false
|
||||
}
|
||||
key = strings.TrimSpace(s[:idx])
|
||||
val = strings.TrimSpace(s[idx+1:])
|
||||
if key == "" {
|
||||
return "", "", false
|
||||
}
|
||||
return key, val, true
|
||||
}
|
||||
|
||||
func stripComment(s string) string {
|
||||
inSingle := false
|
||||
inDouble := false
|
||||
for i := 0; i < len(s); i++ {
|
||||
c := s[i]
|
||||
switch c {
|
||||
case '\'':
|
||||
if !inDouble {
|
||||
inSingle = !inSingle
|
||||
}
|
||||
case '"':
|
||||
if !inSingle {
|
||||
inDouble = !inDouble
|
||||
}
|
||||
case '#':
|
||||
if !inSingle && !inDouble {
|
||||
if i == 0 || s[i-1] == ' ' || s[i-1] == '\t' {
|
||||
return s[:i]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return s
|
||||
}
|
||||
|
||||
func unquote(s string) string {
|
||||
s = strings.TrimSpace(s)
|
||||
if len(s) >= 2 {
|
||||
if (s[0] == '"' && s[len(s)-1] == '"') || (s[0] == '\'' && s[len(s)-1] == '\'') {
|
||||
return s[1 : len(s)-1]
|
||||
}
|
||||
}
|
||||
return s
|
||||
}
|
||||
@@ -0,0 +1,109 @@
|
||||
package jobspec
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// FuzzParseMarkdownRoundTrip is the REQ-067 fuzz harness for R-015
|
||||
// byte-exact body preservation. It generates random frontmatter + body
|
||||
// combinations, runs ParseMarkdown, and asserts that the parsed Body
|
||||
// equals the original body byte-for-byte whenever parsing succeeds.
|
||||
// When parsing fails (bad frontmatter), the iteration passes — the
|
||||
// parser is allowed to reject malformed input.
|
||||
//
|
||||
// The seed corpus (added via f.Add) covers adversarial fixtures: CRLF
|
||||
// body, BOM prefix, no frontmatter, only-closing-separator, body with
|
||||
// `---` inside a code fence, trailing whitespace, empty body. The seed
|
||||
// corpus runs as regular tests under `go test` (CI); random input runs
|
||||
// only under `go test -fuzz=FuzzParseMarkdownRoundTrip` in a dedicated
|
||||
// process.
|
||||
func FuzzParseMarkdownRoundTrip(f *testing.F) {
|
||||
// Seed 1: valid frontmatter + simple body.
|
||||
f.Add([]byte("---\nkind: Job\nname: seed1\n---\n# body\n"))
|
||||
|
||||
// Seed 2: CRLF body.
|
||||
f.Add([]byte("---\r\nkind: Job\r\nname: seed2\r\n---\r\n# body\r\nCRLF\r\n"))
|
||||
|
||||
// Seed 3: BOM prefix.
|
||||
f.Add([]byte("\uFEFF---\nkind: Job\nname: seed3\n---\nbody\n"))
|
||||
|
||||
// Seed 4: no frontmatter (just body) — should fail to parse.
|
||||
f.Add([]byte("# just a body\nno frontmatter\n"))
|
||||
|
||||
// Seed 5: frontmatter with only the closing `---` (no opening).
|
||||
f.Add([]byte("body\n---\nmore body\n"))
|
||||
|
||||
// Seed 6: body containing `---` in a code fence.
|
||||
f.Add([]byte("---\nkind: Job\nname: seed6\n---\n```bash\necho '---'\n```\n"))
|
||||
|
||||
// Seed 7: body with trailing whitespace.
|
||||
f.Add([]byte("---\nkind: Job\nname: seed7\n---\nbody with trailing spaces \n"))
|
||||
|
||||
// Seed 8: empty body.
|
||||
f.Add([]byte("---\nkind: Job\nname: seed8\n---\n"))
|
||||
|
||||
// Seed 9: empty frontmatter (should fail).
|
||||
f.Add([]byte("---\n---\nbody\n"))
|
||||
|
||||
// Seed 10: body with no trailing newline.
|
||||
f.Add([]byte("---\nkind: Job\nname: seed10\n---\nno trailing newline"))
|
||||
|
||||
f.Fuzz(func(t *testing.T, data []byte) {
|
||||
// Reconstruct the body from the input so we can assert
|
||||
// byte-exact round-trip. We do this by re-splitting the
|
||||
// frontmatter using the same logic the parser uses, but only
|
||||
// to extract the expected body. If the input has no valid
|
||||
// frontmatter delimiter pair, ParseMarkdown will return an
|
||||
// error and we pass the iteration.
|
||||
expectedBody := extractExpectedBody(string(data))
|
||||
|
||||
spec, err := ParseMarkdown(data)
|
||||
if err != nil {
|
||||
// Parser rejected the input — acceptable for a fuzz
|
||||
// iteration (the input may be malformed). Pass.
|
||||
return
|
||||
}
|
||||
// R-015: body must be byte-exact.
|
||||
if spec.Body != expectedBody {
|
||||
t.Errorf("R-015 body round-trip mismatch:\n got = %q\nwant = %q", spec.Body, expectedBody)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// extractExpectedBody returns the body portion of a Markdown jobspec
|
||||
// input using the same delimiter-splitting logic as splitFrontmatter,
|
||||
// so the fuzz harness can assert byte-exact preservation independently
|
||||
// of the parser's internal extraction. If the input has no valid
|
||||
// frontmatter, the result is "" (and ParseMarkdown will error).
|
||||
func extractExpectedBody(content string) string {
|
||||
stripped := content
|
||||
if strings.HasPrefix(stripped, "\uFEFF") {
|
||||
stripped = stripped[len("\uFEFF"):]
|
||||
}
|
||||
trimmed := strings.TrimLeft(stripped, "\r\n\t ")
|
||||
if !strings.HasPrefix(trimmed, "---") {
|
||||
return ""
|
||||
}
|
||||
rest := trimmed[3:]
|
||||
if len(rest) > 0 && rest[0] != '\n' && rest[0] != '\r' {
|
||||
return ""
|
||||
}
|
||||
rest = strings.TrimLeft(rest, "\r\n")
|
||||
idx := findClosingDelimiter(rest)
|
||||
if idx < 0 {
|
||||
return ""
|
||||
}
|
||||
afterClose := rest[idx:]
|
||||
newlineIdx := strings.IndexAny(afterClose, "\r\n")
|
||||
if newlineIdx < 0 {
|
||||
return ""
|
||||
}
|
||||
bodyStart := newlineIdx
|
||||
if strings.HasPrefix(afterClose[bodyStart:], "\r\n") {
|
||||
bodyStart += 2
|
||||
} else {
|
||||
bodyStart += 1
|
||||
}
|
||||
return afterClose[bodyStart:]
|
||||
}
|
||||
@@ -0,0 +1,703 @@
|
||||
package jobspec
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestParseMarkdown_FullFrontmatter(t *testing.T) {
|
||||
body := "# Hello\n\nThis is the body.\n\nTrailing newline preserved.\n"
|
||||
input := "---\n" +
|
||||
"orca-spec-version: \"1\"\n" +
|
||||
"kind: Job\n" +
|
||||
"name: my-job\n" +
|
||||
"count: 3\n" +
|
||||
"---\n" +
|
||||
body
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.SpecVersion != "1" {
|
||||
t.Errorf("SpecVersion = %q, want %q", spec.SpecVersion, "1")
|
||||
}
|
||||
if spec.Kind != "Job" {
|
||||
t.Errorf("Kind = %q, want %q", spec.Kind, "Job")
|
||||
}
|
||||
if spec.Name != "my-job" {
|
||||
t.Errorf("Name = %q, want %q", spec.Name, "my-job")
|
||||
}
|
||||
if spec.Count != 3 {
|
||||
t.Errorf("Count = %d, want 3", spec.Count)
|
||||
}
|
||||
if spec.Body != body {
|
||||
t.Errorf("Body = %q, want %q (byte-exact, R-015)", spec.Body, body)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_BodyByteExactTrailingNewline(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
body string
|
||||
}{
|
||||
{"with_trailing_newline", "# Title\n\nbody\n"},
|
||||
{"with_double_trailing_newline", "# Title\n\nbody\n\n"},
|
||||
{"no_trailing_newline", "# Title\n\nbody"},
|
||||
{"empty_body_with_newline", "\n"},
|
||||
{"only_newlines", "\n\n\n"},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
input := "---\nkind: Job\nname: x\n---\n" + tc.body
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.Body != tc.body {
|
||||
t.Errorf("Body byte-exact mismatch (R-015):\n got = %q\nwant = %q", spec.Body, tc.body)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_NoFrontmatter(t *testing.T) {
|
||||
input := "# Just a body\n\nNo frontmatter here."
|
||||
_, err := ParseMarkdown([]byte(input))
|
||||
if err == nil {
|
||||
t.Fatal("expected error for missing frontmatter, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "frontmatter") {
|
||||
t.Errorf("error = %q, want it to contain 'frontmatter'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_EmptyFrontmatter(t *testing.T) {
|
||||
input := "---\n---\n\nbody"
|
||||
_, err := ParseMarkdown([]byte(input))
|
||||
if err == nil {
|
||||
t.Fatal("expected error for empty frontmatter, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "empty frontmatter") {
|
||||
t.Errorf("error = %q, want it to contain 'empty frontmatter'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_UnknownKind(t *testing.T) {
|
||||
input := "---\nkind: CronJob\nname: x\n---\nbody\n"
|
||||
_, err := ParseMarkdown([]byte(input))
|
||||
if err == nil {
|
||||
t.Fatal("expected error for unknown kind, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "not one of") {
|
||||
t.Errorf("error = %q, want it to contain 'not one of'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_MissingName(t *testing.T) {
|
||||
input := "---\nkind: Job\n---\nbody\n"
|
||||
_, err := ParseMarkdown([]byte(input))
|
||||
if err == nil {
|
||||
t.Fatal("expected error for missing name, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "missing name") {
|
||||
t.Errorf("error = %q, want it to contain 'missing name'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_MissingKind(t *testing.T) {
|
||||
input := "---\nname: x\n---\nbody\n"
|
||||
_, err := ParseMarkdown([]byte(input))
|
||||
if err == nil {
|
||||
t.Fatal("expected error for missing kind, got nil")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "missing kind") {
|
||||
t.Errorf("error = %q, want it to contain 'missing kind'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_EachValidKind(t *testing.T) {
|
||||
cases := []string{"Job", "Service", "DaemonSet"}
|
||||
for _, kind := range cases {
|
||||
t.Run(kind, func(t *testing.T) {
|
||||
input := "---\nkind: " + kind + "\nname: x\n---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.Kind != kind {
|
||||
t.Errorf("Kind = %q, want %q", spec.Kind, kind)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_EnvScalarAndObject(t *testing.T) {
|
||||
input := "---\n" +
|
||||
"kind: Job\n" +
|
||||
"name: x\n" +
|
||||
"env:\n" +
|
||||
" FOO: bar\n" +
|
||||
" BAZ: \"qux\"\n" +
|
||||
" SECRET_REF:\n" +
|
||||
" from: \"secret:db-password\"\n" +
|
||||
" INLINE: {from: \"secret:token\"}\n" +
|
||||
"---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if got := spec.Env["FOO"]; got != "bar" {
|
||||
t.Errorf("env[FOO] = %q, want %q", got, "bar")
|
||||
}
|
||||
if got := spec.Env["BAZ"]; got != "qux" {
|
||||
t.Errorf("env[BAZ] = %q, want %q", got, "qux")
|
||||
}
|
||||
if got := spec.Env["INLINE"]; got != `{from: "secret:token"}` {
|
||||
t.Errorf("env[INLINE] = %q, want the raw object string", got)
|
||||
}
|
||||
if _, ok := spec.Env["SECRET_REF"]; !ok {
|
||||
t.Errorf("env[SECRET_REF] missing; nested from: stored as empty string")
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_PortsArray(t *testing.T) {
|
||||
input := "---\n" +
|
||||
"kind: Service\n" +
|
||||
"name: web\n" +
|
||||
"ports:\n" +
|
||||
" - name: http\n" +
|
||||
" port: 8080\n" +
|
||||
" host_port: 80\n" +
|
||||
" protocol: tcp\n" +
|
||||
" - name: https\n" +
|
||||
" port: 8443\n" +
|
||||
" host_port: 443\n" +
|
||||
"---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if len(spec.Ports) != 2 {
|
||||
t.Fatalf("Ports = %d, want 2", len(spec.Ports))
|
||||
}
|
||||
if spec.Ports[0].Name != "http" || spec.Ports[0].Port != 8080 || spec.Ports[0].HostPort != 80 || spec.Ports[0].Protocol != "tcp" {
|
||||
t.Errorf("Ports[0] = %+v", spec.Ports[0])
|
||||
}
|
||||
if spec.Ports[1].Name != "https" || spec.Ports[1].Port != 8443 || spec.Ports[1].HostPort != 443 {
|
||||
t.Errorf("Ports[1] = %+v", spec.Ports[1])
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_VolumesArray(t *testing.T) {
|
||||
input := "---\n" +
|
||||
"kind: Job\n" +
|
||||
"name: x\n" +
|
||||
"volumes:\n" +
|
||||
" - name: data\n" +
|
||||
" type: host\n" +
|
||||
" source: /data\n" +
|
||||
" target: /data\n" +
|
||||
" read_only: true\n" +
|
||||
"---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if len(spec.Volumes) != 1 {
|
||||
t.Fatalf("Volumes = %d, want 1", len(spec.Volumes))
|
||||
}
|
||||
v := spec.Volumes[0]
|
||||
if v.Name != "data" || v.Type != "host" || v.Source != "/data" || v.Target != "/data" || !v.ReadOnly {
|
||||
t.Errorf("Volumes[0] = %+v", v)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_RuntimeBlock(t *testing.T) {
|
||||
input := "---\n" +
|
||||
"kind: Job\n" +
|
||||
"name: x\n" +
|
||||
"runtime:\n" +
|
||||
" one_of: process\n" +
|
||||
" image: docker.io/nginx:latest\n" +
|
||||
" command: /bin/sh -c 'echo hi'\n" +
|
||||
"---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.Runtime == nil {
|
||||
t.Fatal("Runtime is nil")
|
||||
}
|
||||
if spec.Runtime.OneOf != "process" {
|
||||
t.Errorf("Runtime.OneOf = %q, want %q", spec.Runtime.OneOf, "process")
|
||||
}
|
||||
if spec.Runtime.Image != "docker.io/nginx:latest" {
|
||||
t.Errorf("Runtime.Image = %q, want %q", spec.Runtime.Image, "docker.io/nginx:latest")
|
||||
}
|
||||
if spec.Runtime.Command != "/bin/sh -c 'echo hi'" {
|
||||
t.Errorf("Runtime.Command = %q, want %q", spec.Runtime.Command, "/bin/sh -c 'echo hi'")
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_SecretsInlineArray(t *testing.T) {
|
||||
input := "---\nkind: Job\nname: x\nsecrets: [\"db-password\", \"api-token\"]\n---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if len(spec.Secrets) != 2 {
|
||||
t.Fatalf("Secrets = %d, want 2", len(spec.Secrets))
|
||||
}
|
||||
if spec.Secrets[0] != "db-password" || spec.Secrets[1] != "api-token" {
|
||||
t.Errorf("Secrets = %v, want [db-password api-token]", spec.Secrets)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_SecretsBlockArray(t *testing.T) {
|
||||
input := "---\n" +
|
||||
"kind: Job\n" +
|
||||
"name: x\n" +
|
||||
"secrets:\n" +
|
||||
" - db-password\n" +
|
||||
" - api-token\n" +
|
||||
"---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if len(spec.Secrets) != 2 {
|
||||
t.Fatalf("Secrets = %d, want 2", len(spec.Secrets))
|
||||
}
|
||||
if spec.Secrets[0] != "db-password" || spec.Secrets[1] != "api-token" {
|
||||
t.Errorf("Secrets = %v, want [db-password api-token]", spec.Secrets)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_CRLFBodyPreserved(t *testing.T) {
|
||||
body := "# Title\r\n\r\nCRLF body.\r\n"
|
||||
input := "---\r\nkind: Job\r\nname: x\r\n---\r\n" + body
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.Body != body {
|
||||
t.Errorf("CRLF body not preserved (R-015):\n got = %q\nwant = %q", spec.Body, body)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_BOMStrippedFromFrontmatter(t *testing.T) {
|
||||
body := "# body\n"
|
||||
input := "\uFEFF" + "---\nkind: Job\nname: x\n---\n" + body
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.Kind != "Job" {
|
||||
t.Errorf("Kind = %q, want Job (BOM should be stripped from frontmatter scan)", spec.Kind)
|
||||
}
|
||||
if spec.Body != body {
|
||||
t.Errorf("Body = %q, want %q", spec.Body, body)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_BodyWithCodeFenceContainingDashes(t *testing.T) {
|
||||
body := "```bash\n" +
|
||||
"echo '---'\n" +
|
||||
"echo '--- end ---'\n" +
|
||||
"```\n"
|
||||
input := "---\nkind: Job\nname: x\n---\n" + body
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.Body != body {
|
||||
t.Errorf("Body with code-fence --- not preserved (R-015):\n got = %q\nwant = %q", spec.Body, body)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_OnlyClosingSeparator(t *testing.T) {
|
||||
input := "no opening\n---\nbody\n"
|
||||
_, err := ParseMarkdown([]byte(input))
|
||||
if err == nil {
|
||||
t.Fatal("expected error for input with only closing separator, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_QuotedValues(t *testing.T) {
|
||||
input := "---\nkind: \"Job\"\nname: 'my-job'\n---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.Kind != "Job" {
|
||||
t.Errorf("Kind = %q, want Job (double-quoted)", spec.Kind)
|
||||
}
|
||||
if spec.Name != "my-job" {
|
||||
t.Errorf("Name = %q, want my-job (single-quoted)", spec.Name)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_CountDefault(t *testing.T) {
|
||||
input := "---\nkind: Job\nname: x\n---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.Count != 1 {
|
||||
t.Errorf("Count default = %d, want 1", spec.Count)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_UnknownKeyIgnored(t *testing.T) {
|
||||
input := "---\nkind: Job\nname: x\nfuture_field: value\n---\nbody\n"
|
||||
_, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown should ignore unknown keys: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_RestartBlock(t *testing.T) {
|
||||
input := "---\n" +
|
||||
"kind: Service\n" +
|
||||
"name: web\n" +
|
||||
"restart:\n" +
|
||||
" mode: service\n" +
|
||||
" attempts: 5\n" +
|
||||
" delay: 3s\n" +
|
||||
"---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.Restart == nil {
|
||||
t.Fatal("Restart is nil")
|
||||
}
|
||||
if spec.Restart.Mode != "service" {
|
||||
t.Errorf("Restart.Mode = %q, want service", spec.Restart.Mode)
|
||||
}
|
||||
if spec.Restart.MaxRetries != 5 {
|
||||
t.Errorf("Restart.MaxRetries = %d, want 5", spec.Restart.MaxRetries)
|
||||
}
|
||||
if spec.Restart.Delay != "3s" {
|
||||
t.Errorf("Restart.Delay = %q, want 3s", spec.Restart.Delay)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_RestartBlockMaxRetriesAlias(t *testing.T) {
|
||||
// max_retries is the canonical key; attempts is an accepted alias.
|
||||
input := "---\n" +
|
||||
"kind: Service\n" +
|
||||
"name: web\n" +
|
||||
"restart:\n" +
|
||||
" mode: on-failure\n" +
|
||||
" max_retries: 3\n" +
|
||||
" delay: 1s\n" +
|
||||
"---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.Restart == nil || spec.Restart.MaxRetries != 3 {
|
||||
t.Fatalf("Restart.MaxRetries = %d, want 3 (max_retries alias)", spec.Restart.MaxRetries)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_UpdateBlock(t *testing.T) {
|
||||
input := "---\n" +
|
||||
"kind: Service\n" +
|
||||
"name: web\n" +
|
||||
"update:\n" +
|
||||
" strategy: canary\n" +
|
||||
" max_parallel: 2\n" +
|
||||
" min_healthy_time: 30s\n" +
|
||||
" healthy_deadline: 5m\n" +
|
||||
" canary: 10%\n" +
|
||||
" auto_promote: true\n" +
|
||||
"---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.Update == nil {
|
||||
t.Fatal("Update is nil")
|
||||
}
|
||||
if spec.Update.Strategy != "canary" {
|
||||
t.Errorf("Update.Strategy = %q, want canary", spec.Update.Strategy)
|
||||
}
|
||||
if spec.Update.MaxParallel != 2 {
|
||||
t.Errorf("Update.MaxParallel = %d, want 2", spec.Update.MaxParallel)
|
||||
}
|
||||
if spec.Update.MinHealthyTime != "30s" {
|
||||
t.Errorf("Update.MinHealthyTime = %q, want 30s", spec.Update.MinHealthyTime)
|
||||
}
|
||||
if spec.Update.HealthyDeadline != "5m" {
|
||||
t.Errorf("Update.HealthyDeadline = %q, want 5m", spec.Update.HealthyDeadline)
|
||||
}
|
||||
if spec.Update.Canary != "10%" {
|
||||
t.Errorf("Update.Canary = %q, want 10%%", spec.Update.Canary)
|
||||
}
|
||||
if !spec.Update.AutoPromote {
|
||||
t.Errorf("Update.AutoPromote = false, want true")
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_ServiceBlock(t *testing.T) {
|
||||
input := "---\n" +
|
||||
"kind: Service\n" +
|
||||
"name: web\n" +
|
||||
"service:\n" +
|
||||
" name: web\n" +
|
||||
" port: 8080\n" +
|
||||
" bind: 127.0.0.1\n" +
|
||||
"---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.Service == nil {
|
||||
t.Fatal("Service is nil")
|
||||
}
|
||||
if spec.Service.Name != "web" {
|
||||
t.Errorf("Service.Name = %q, want web", spec.Service.Name)
|
||||
}
|
||||
if spec.Service.Port != 8080 {
|
||||
t.Errorf("Service.Port = %d, want 8080", spec.Service.Port)
|
||||
}
|
||||
if spec.Service.Bind != "127.0.0.1" {
|
||||
t.Errorf("Service.Bind = %q, want 127.0.0.1", spec.Service.Bind)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_HealthBlock(t *testing.T) {
|
||||
input := "---\n" +
|
||||
"kind: Service\n" +
|
||||
"name: web\n" +
|
||||
"health:\n" +
|
||||
" check_type: http\n" +
|
||||
" interval: 10s\n" +
|
||||
" timeout: 2s\n" +
|
||||
" unhealthy_threshold: 3\n" +
|
||||
"---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.Health == nil {
|
||||
t.Fatal("Health is nil")
|
||||
}
|
||||
if spec.Health.CheckType != "http" {
|
||||
t.Errorf("Health.CheckType = %q, want http", spec.Health.CheckType)
|
||||
}
|
||||
if spec.Health.Interval != "10s" {
|
||||
t.Errorf("Health.Interval = %q, want 10s", spec.Health.Interval)
|
||||
}
|
||||
if spec.Health.Timeout != "2s" {
|
||||
t.Errorf("Health.Timeout = %q, want 2s", spec.Health.Timeout)
|
||||
}
|
||||
if spec.Health.UnhealthyThreshold != 3 {
|
||||
t.Errorf("Health.UnhealthyThreshold = %d, want 3", spec.Health.UnhealthyThreshold)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_ConstraintsInlineArray(t *testing.T) {
|
||||
// Inline flow-array form: the parser does NOT unescape YAML
|
||||
// escapes (consistent with the secrets inline parser). Use
|
||||
// single-quoted scalars inside the flow array so the CEL strings
|
||||
// are preserved verbatim.
|
||||
input := "---\nkind: Service\nname: web\nconstraints: ['node.role == \"web\"', 'region == \"us\"']\n---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if len(spec.Constraints) != 2 {
|
||||
t.Fatalf("Constraints = %d, want 2", len(spec.Constraints))
|
||||
}
|
||||
if spec.Constraints[0] != `node.role == "web"` {
|
||||
t.Errorf("Constraints[0] = %q", spec.Constraints[0])
|
||||
}
|
||||
if spec.Constraints[1] != `region == "us"` {
|
||||
t.Errorf("Constraints[1] = %q", spec.Constraints[1])
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_ConstraintsBlockArray(t *testing.T) {
|
||||
input := "---\n" +
|
||||
"kind: Service\n" +
|
||||
"name: web\n" +
|
||||
"constraints:\n" +
|
||||
" - node.role == \"web\"\n" +
|
||||
" - region == \"us\"\n" +
|
||||
"---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if len(spec.Constraints) != 2 {
|
||||
t.Fatalf("Constraints = %d, want 2", len(spec.Constraints))
|
||||
}
|
||||
if spec.Constraints[0] != `node.role == "web"` {
|
||||
t.Errorf("Constraints[0] = %q", spec.Constraints[0])
|
||||
}
|
||||
if spec.Constraints[1] != `region == "us"` {
|
||||
t.Errorf("Constraints[1] = %q", spec.Constraints[1])
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_AffinityBlock(t *testing.T) {
|
||||
input := "---\n" +
|
||||
"kind: Service\n" +
|
||||
"name: web\n" +
|
||||
"affinity:\n" +
|
||||
" - target: node.role == \"web\"\n" +
|
||||
" weight: 100\n" +
|
||||
" - target: region == \"us\"\n" +
|
||||
" weight: 50\n" +
|
||||
"---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if len(spec.Affinity) != 2 {
|
||||
t.Fatalf("Affinity = %d, want 2", len(spec.Affinity))
|
||||
}
|
||||
if spec.Affinity[0].Target != `node.role == "web"` {
|
||||
t.Errorf("Affinity[0].Target = %q", spec.Affinity[0].Target)
|
||||
}
|
||||
if spec.Affinity[0].Weight != 100 {
|
||||
t.Errorf("Affinity[0].Weight = %d, want 100", spec.Affinity[0].Weight)
|
||||
}
|
||||
if spec.Affinity[1].Target != `region == "us"` {
|
||||
t.Errorf("Affinity[1].Target = %q", spec.Affinity[1].Target)
|
||||
}
|
||||
if spec.Affinity[1].Weight != 50 {
|
||||
t.Errorf("Affinity[1].Weight = %d, want 50", spec.Affinity[1].Weight)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_LifecycleBlock(t *testing.T) {
|
||||
input := "---\n" +
|
||||
"kind: Service\n" +
|
||||
"name: web\n" +
|
||||
"lifecycle:\n" +
|
||||
" pre_stop:\n" +
|
||||
" - /bin/sh -c 'sleep 5'\n" +
|
||||
" - /usr/local/bin/drain.sh\n" +
|
||||
" post_start:\n" +
|
||||
" - /usr/local/bin/warm-cache.sh\n" +
|
||||
"---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.Lifecycle == nil {
|
||||
t.Fatal("Lifecycle is nil")
|
||||
}
|
||||
if len(spec.Lifecycle.PreStop) != 2 {
|
||||
t.Fatalf("PreStop = %d, want 2", len(spec.Lifecycle.PreStop))
|
||||
}
|
||||
if spec.Lifecycle.PreStop[0] != "/bin/sh -c 'sleep 5'" {
|
||||
t.Errorf("PreStop[0] = %q", spec.Lifecycle.PreStop[0])
|
||||
}
|
||||
if spec.Lifecycle.PreStop[1] != "/usr/local/bin/drain.sh" {
|
||||
t.Errorf("PreStop[1] = %q", spec.Lifecycle.PreStop[1])
|
||||
}
|
||||
if len(spec.Lifecycle.PostStart) != 1 {
|
||||
t.Fatalf("PostStart = %d, want 1", len(spec.Lifecycle.PostStart))
|
||||
}
|
||||
if spec.Lifecycle.PostStart[0] != "/usr/local/bin/warm-cache.sh" {
|
||||
t.Errorf("PostStart[0] = %q", spec.Lifecycle.PostStart[0])
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_LifecycleInlineArray(t *testing.T) {
|
||||
input := "---\n" +
|
||||
"kind: Service\n" +
|
||||
"name: web\n" +
|
||||
"lifecycle:\n" +
|
||||
" pre_stop: [\"/bin/true\"]\n" +
|
||||
" post_start: [\"/bin/warmup\", \"/bin/check\"]\n" +
|
||||
"---\nbody\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.Lifecycle == nil {
|
||||
t.Fatal("Lifecycle is nil")
|
||||
}
|
||||
if len(spec.Lifecycle.PreStop) != 1 || spec.Lifecycle.PreStop[0] != "/bin/true" {
|
||||
t.Errorf("PreStop = %v, want [/bin/true]", spec.Lifecycle.PreStop)
|
||||
}
|
||||
if len(spec.Lifecycle.PostStart) != 2 {
|
||||
t.Fatalf("PostStart = %v, want 2 entries", spec.Lifecycle.PostStart)
|
||||
}
|
||||
if spec.Lifecycle.PostStart[0] != "/bin/warmup" || spec.Lifecycle.PostStart[1] != "/bin/check" {
|
||||
t.Errorf("PostStart = %v, want [/bin/warmup /bin/check]", spec.Lifecycle.PostStart)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseMarkdown_FullServiceSpec(t *testing.T) {
|
||||
// A complete Service spec exercising every P02-parsed block together.
|
||||
input := "---\n" +
|
||||
"kind: Service\n" +
|
||||
"name: web\n" +
|
||||
"count: 3\n" +
|
||||
"runtime:\n" +
|
||||
" one_of: process\n" +
|
||||
" command: /usr/bin/httpd\n" +
|
||||
"ports:\n" +
|
||||
" - name: http\n" +
|
||||
" port: 8080\n" +
|
||||
"restart:\n" +
|
||||
" mode: service\n" +
|
||||
" attempts: 5\n" +
|
||||
" delay: 2s\n" +
|
||||
"update:\n" +
|
||||
" strategy: rolling\n" +
|
||||
" max_parallel: 1\n" +
|
||||
" auto_promote: false\n" +
|
||||
"service:\n" +
|
||||
" name: web\n" +
|
||||
" port: 8080\n" +
|
||||
"health:\n" +
|
||||
" check_type: http\n" +
|
||||
" interval: 5s\n" +
|
||||
" timeout: 1s\n" +
|
||||
" unhealthy_threshold: 2\n" +
|
||||
"constraints:\n" +
|
||||
" - node.role == \"web\"\n" +
|
||||
"affinity:\n" +
|
||||
" - target: zone == \"a\"\n" +
|
||||
" weight: 80\n" +
|
||||
"lifecycle:\n" +
|
||||
" post_start:\n" +
|
||||
" - /bin/ready.sh\n" +
|
||||
"---\n# body\n"
|
||||
spec, err := ParseMarkdown([]byte(input))
|
||||
if err != nil {
|
||||
t.Fatalf("ParseMarkdown: %v", err)
|
||||
}
|
||||
if spec.Restart == nil || spec.Restart.Mode != "service" {
|
||||
t.Errorf("Restart not parsed: %+v", spec.Restart)
|
||||
}
|
||||
if spec.Update == nil || spec.Update.Strategy != "rolling" {
|
||||
t.Errorf("Update not parsed: %+v", spec.Update)
|
||||
}
|
||||
if spec.Service == nil || spec.Service.Port != 8080 {
|
||||
t.Errorf("Service not parsed: %+v", spec.Service)
|
||||
}
|
||||
if spec.Health == nil || spec.Health.CheckType != "http" {
|
||||
t.Errorf("Health not parsed: %+v", spec.Health)
|
||||
}
|
||||
if len(spec.Constraints) != 1 {
|
||||
t.Errorf("Constraints = %v", spec.Constraints)
|
||||
}
|
||||
if len(spec.Affinity) != 1 || spec.Affinity[0].Weight != 80 {
|
||||
t.Errorf("Affinity = %v", spec.Affinity)
|
||||
}
|
||||
if spec.Lifecycle == nil || len(spec.Lifecycle.PostStart) != 1 {
|
||||
t.Errorf("Lifecycle not parsed: %+v", spec.Lifecycle)
|
||||
}
|
||||
if spec.Body != "# body\n" {
|
||||
t.Errorf("Body = %q, want %q (R-015)", spec.Body, "# body\n")
|
||||
}
|
||||
}
|
||||
+26
-27
@@ -2,7 +2,6 @@ package jobspec
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"strings"
|
||||
|
||||
"github.com/hashicorp/hcl/v2"
|
||||
@@ -10,16 +9,24 @@ import (
|
||||
"github.com/hashicorp/hcl/v2/hclsimple"
|
||||
)
|
||||
|
||||
// Spec is the legacy HCL-only jobspec shape. It is retained for the
|
||||
// v0.9→v0.10 migration window (REQ-090) and is populated by ParseHCLLegacy.
|
||||
//
|
||||
// Deprecated: HCL is legacy per R-013; new code should consume the
|
||||
// unified *WorkloadSpec returned by ParseFile/Dispatch (see
|
||||
// dispatch.go and markdown.go).
|
||||
type Spec struct {
|
||||
Job JobSpec `hcl:"job,block"`
|
||||
Tasks []TaskSpec `hcl:"task,block"`
|
||||
}
|
||||
|
||||
// JobSpec is the legacy HCL job block.
|
||||
type JobSpec struct {
|
||||
Name string `hcl:"name,label"`
|
||||
Type string `hcl:"type,optional"`
|
||||
}
|
||||
|
||||
// TaskSpec is the legacy HCL task block.
|
||||
type TaskSpec struct {
|
||||
Name string `hcl:"name,label"`
|
||||
Command string `hcl:"command"`
|
||||
@@ -27,34 +34,14 @@ type TaskSpec struct {
|
||||
Env []string `hcl:"env,optional"`
|
||||
}
|
||||
|
||||
func ParseFile(path string) (*Spec, error) {
|
||||
data, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("read spec file: %w", err)
|
||||
}
|
||||
return Parse(data, path)
|
||||
}
|
||||
|
||||
func Parse(data []byte, filename string) (*Spec, error) {
|
||||
var spec Spec
|
||||
err := hclsimple.Decode(filename, data, nil, &spec)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("decode hcl: %w", err)
|
||||
}
|
||||
if spec.Job.Name == "" {
|
||||
return nil, fmt.Errorf("spec missing job name")
|
||||
}
|
||||
if len(spec.Tasks) == 0 {
|
||||
return nil, fmt.Errorf("spec must have at least one task")
|
||||
}
|
||||
for i, t := range spec.Tasks {
|
||||
if t.Command == "" {
|
||||
return nil, fmt.Errorf("task[%d] (%s) missing command", i, t.Name)
|
||||
}
|
||||
}
|
||||
return &spec, nil
|
||||
// hclDecode wraps hclsimple.Decode for testability.
|
||||
func hclDecode(filename string, data []byte, spec *Spec) error {
|
||||
return hclsimple.Decode(filename, data, nil, spec)
|
||||
}
|
||||
|
||||
// Validate is the legacy HCL Spec validator retained for the migration
|
||||
// window (REQ-090). New code should use validateWorkload on a
|
||||
// *WorkloadSpec.
|
||||
func (s *Spec) Validate() error {
|
||||
if strings.TrimSpace(s.Job.Name) == "" {
|
||||
return fmt.Errorf("job name is required")
|
||||
@@ -65,5 +52,17 @@ func (s *Spec) Validate() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// Parse is the original HCL-only entry point retained for backward
|
||||
// compatibility with direct HCL callers during the v0.9→v0.10 migration
|
||||
// window (REQ-090). New code should call the dispatcher ParseFile (which
|
||||
// returns *WorkloadSpec) or ParseHCL (which adapts HCL into
|
||||
// *WorkloadSpec).
|
||||
//
|
||||
// Deprecated: use ParseFile (dispatcher) or ParseHCL (adapter). HCL is
|
||||
// legacy per R-013.
|
||||
func Parse(data []byte, filename string) (*Spec, error) {
|
||||
return ParseHCLLegacy(data, filename)
|
||||
}
|
||||
|
||||
var _ = hcl.Diagnostics{}
|
||||
var _ = gohcl.DecodeBody
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
package jobspec
|
||||
|
||||
import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
@@ -58,3 +61,223 @@ task "no-cmd" {}
|
||||
t.Fatal("expected error for missing command")
|
||||
}
|
||||
}
|
||||
|
||||
func TestParse_GoldenFiles(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
file string
|
||||
wantJob string
|
||||
wantJobType string
|
||||
wantTasks int
|
||||
checkTask func(t *testing.T, s *Spec)
|
||||
}{
|
||||
{
|
||||
name: "single_task",
|
||||
file: "valid_single_task.hcl",
|
||||
wantJob: "single",
|
||||
wantTasks: 1,
|
||||
wantJobType: "",
|
||||
checkTask: func(t *testing.T, s *Spec) {
|
||||
if s.Tasks[0].Name != "solo" {
|
||||
t.Errorf("task name = %q, want solo", s.Tasks[0].Name)
|
||||
}
|
||||
if s.Tasks[0].Command != "/bin/true" {
|
||||
t.Errorf("command = %q, want /bin/true", s.Tasks[0].Command)
|
||||
}
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "multi_task",
|
||||
file: "valid_multi_task.hcl",
|
||||
wantJob: "multi",
|
||||
wantJobType: "batch",
|
||||
wantTasks: 3,
|
||||
checkTask: func(t *testing.T, s *Spec) {
|
||||
byName := map[string]TaskSpec{}
|
||||
for _, tk := range s.Tasks {
|
||||
byName[tk.Name] = tk
|
||||
}
|
||||
if _, ok := byName["build"]; !ok {
|
||||
t.Errorf("missing task 'build'")
|
||||
}
|
||||
if _, ok := byName["test"]; !ok {
|
||||
t.Errorf("missing task 'test'")
|
||||
}
|
||||
if len(byName["test"].Env) != 2 {
|
||||
t.Errorf("test env count = %d, want 2", len(byName["test"].Env))
|
||||
}
|
||||
if _, ok := byName["deploy"]; !ok {
|
||||
t.Errorf("missing task 'deploy'")
|
||||
}
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "env_vars",
|
||||
file: "valid_env_vars.hcl",
|
||||
wantJob: "envvars",
|
||||
wantTasks: 1,
|
||||
checkTask: func(t *testing.T, s *Spec) {
|
||||
if len(s.Tasks[0].Env) != 3 {
|
||||
t.Errorf("env count = %d, want 3", len(s.Tasks[0].Env))
|
||||
}
|
||||
want := "FOO=bar"
|
||||
if s.Tasks[0].Env[0] != want {
|
||||
t.Errorf("env[0] = %q, want %q", s.Tasks[0].Env[0], want)
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
path := filepath.Join("testdata", tc.file)
|
||||
spec, err := ParseHCLFile(path)
|
||||
if err != nil {
|
||||
t.Fatalf("ParseHCLFile(%s): %v", tc.file, err)
|
||||
}
|
||||
if spec.Job.Name != tc.wantJob {
|
||||
t.Errorf("job name = %q, want %q", spec.Job.Name, tc.wantJob)
|
||||
}
|
||||
if tc.wantJobType != "" && spec.Job.Type != tc.wantJobType {
|
||||
t.Errorf("job type = %q, want %q", spec.Job.Type, tc.wantJobType)
|
||||
}
|
||||
if len(spec.Tasks) != tc.wantTasks {
|
||||
t.Fatalf("tasks = %d, want %d", len(spec.Tasks), tc.wantTasks)
|
||||
}
|
||||
if tc.checkTask != nil {
|
||||
tc.checkTask(t, spec)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestParse_ErrorPaths(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
file string
|
||||
wantErr string
|
||||
useParse bool
|
||||
hcl string
|
||||
}{
|
||||
{name: "no_tasks", file: "err_no_tasks.hcl", wantErr: "at least one task"},
|
||||
{name: "missing_command", file: "err_missing_command.hcl", wantErr: "required"},
|
||||
{name: "malformed", file: "err_malformed.hcl", wantErr: "decode hcl"},
|
||||
{name: "missing_job", file: "err_missing_job.hcl", wantErr: "Missing job block"},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
path := filepath.Join("testdata", tc.file)
|
||||
_, err := ParseFile(path)
|
||||
if err == nil {
|
||||
t.Fatalf("expected error containing %q, got nil", tc.wantErr)
|
||||
}
|
||||
if !strings.Contains(err.Error(), tc.wantErr) {
|
||||
t.Errorf("error = %q, want it to contain %q", err.Error(), tc.wantErr)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestParse_EmptyFile(t *testing.T) {
|
||||
_, err := Parse([]byte(""), "empty.hcl")
|
||||
if err == nil {
|
||||
t.Fatal("expected error for empty file")
|
||||
}
|
||||
}
|
||||
|
||||
func TestParse_MalformedHCL(t *testing.T) {
|
||||
_, err := Parse([]byte("job = "), "bad.hcl")
|
||||
if err == nil {
|
||||
t.Fatal("expected error for malformed HCL")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "decode hcl") {
|
||||
t.Errorf("error = %q, want it to contain 'decode hcl'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseFile_Nonexistent(t *testing.T) {
|
||||
_, err := ParseFile(filepath.Join("testdata", "does_not_exist.hcl"))
|
||||
if err == nil {
|
||||
t.Fatal("expected error for nonexistent file")
|
||||
}
|
||||
if !strings.Contains(err.Error(), "read spec file") {
|
||||
t.Errorf("error = %q, want it to contain 'read spec file'", err.Error())
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseFile_ReadError(t *testing.T) {
|
||||
// Directory exists but is not readable as a file.
|
||||
_, err := ParseFile("testdata")
|
||||
if err == nil {
|
||||
t.Fatal("expected error when ParseFile target is a directory")
|
||||
}
|
||||
}
|
||||
|
||||
func TestSpec_Validate(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
spec *Spec
|
||||
wantErr string
|
||||
}{
|
||||
{
|
||||
name: "empty_job_name",
|
||||
spec: &Spec{Job: JobSpec{Name: " "}, Tasks: []TaskSpec{{Name: "t", Command: "/bin/echo"}}},
|
||||
wantErr: "job name is required",
|
||||
},
|
||||
{
|
||||
name: "no_tasks",
|
||||
spec: &Spec{Job: JobSpec{Name: "x"}},
|
||||
wantErr: "at least one task is required",
|
||||
},
|
||||
{
|
||||
name: "valid",
|
||||
spec: &Spec{Job: JobSpec{Name: "x"}, Tasks: []TaskSpec{{Name: "t", Command: "/bin/echo"}}},
|
||||
},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
err := tc.spec.Validate()
|
||||
if tc.wantErr == "" {
|
||||
if err != nil {
|
||||
t.Errorf("Validate: got %v, want nil", err)
|
||||
}
|
||||
return
|
||||
}
|
||||
if err == nil {
|
||||
t.Fatalf("expected error containing %q, got nil", tc.wantErr)
|
||||
}
|
||||
if !strings.Contains(err.Error(), tc.wantErr) {
|
||||
t.Errorf("error = %q, want it to contain %q", err.Error(), tc.wantErr)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestSpec_Validate_RoundTripFromParse(t *testing.T) {
|
||||
path := filepath.Join("testdata", "valid_single_task.hcl")
|
||||
spec, err := ParseHCLFile(path)
|
||||
if err != nil {
|
||||
t.Fatalf("ParseHCLFile: %v", err)
|
||||
}
|
||||
if err := spec.Validate(); err != nil {
|
||||
t.Errorf("Validate on parsed spec: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseFile_GoldenFilesExist(t *testing.T) {
|
||||
// Guard against accidentally removing testdata fixtures.
|
||||
files := []string{
|
||||
"valid_single_task.hcl",
|
||||
"valid_multi_task.hcl",
|
||||
"valid_env_vars.hcl",
|
||||
"err_no_tasks.hcl",
|
||||
"err_missing_command.hcl",
|
||||
"err_malformed.hcl",
|
||||
"err_missing_job.hcl",
|
||||
}
|
||||
for _, f := range files {
|
||||
path := filepath.Join("testdata", f)
|
||||
if _, err := os.Stat(path); err != nil {
|
||||
t.Errorf("missing testdata fixture %s: %v", f, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+1
@@ -0,0 +1 @@
|
||||
job "x" { command = invalid }
|
||||
@@ -0,0 +1,3 @@
|
||||
job "x" {}
|
||||
|
||||
task "nocmd" {}
|
||||
@@ -0,0 +1 @@
|
||||
task "x" { command = "/bin/echo" }
|
||||
+1
@@ -0,0 +1 @@
|
||||
job "empty" {}
|
||||
@@ -0,0 +1,6 @@
|
||||
job "envvars" {}
|
||||
|
||||
task "runner" {
|
||||
command = "/bin/printenv"
|
||||
env = ["FOO=bar", "BAZ=qux", "EMPTY="]
|
||||
}
|
||||
+19
@@ -0,0 +1,19 @@
|
||||
job "multi" {
|
||||
type = "batch"
|
||||
}
|
||||
|
||||
task "build" {
|
||||
command = "/bin/echo"
|
||||
args = ["build", "done"]
|
||||
}
|
||||
|
||||
task "test" {
|
||||
command = "/usr/bin/go"
|
||||
args = ["test", "./..."]
|
||||
env = ["GOCACHE=/tmp/gocache", "GOFLAGS=-v"]
|
||||
}
|
||||
|
||||
task "deploy" {
|
||||
command = "/bin/sh"
|
||||
args = ["-c", "echo deploying"]
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user