Compare commits

...

31 Commits

Author SHA1 Message Date
Jon Chery 8b19c9ab68 docs(milestone): complete coverage-trust-hardening — v0.8 milestone release
Mark REQ-057..060 Complete in REQUIREMENTS.md, mark v0.8 COMPLETE in
ROADMAP.md, advance config.json phase to 4.

P0 (v0.7.0): pre-execution — specify/clarify/research/plan/grill.
P1 (v0.7.1): coverage round 2 — 9 packages hit tiered floor.
P2 (v0.7.2): SSH trust hardening — --host-key-fingerprint + key-reset
             + v0.6 TOFU ship-defect bugfix + doctor parity.
P3 (v0.7.3): requirements-hygiene gate — make verify-reqs + CI hook.
P4 (v0.7.4): final review + audit + milestone release (this commit).

Review: PASS-WITH-FOLLOWUPS (0 P0, 3 P1+ deferred to v0.9).
Audit: PASS (1 P1 stale-branch-hygiene, pre-existing, post-ship cleanup).
GRILL: 4/4 binding conditions satisfied.

---ci---
project: orca
phase: 4
milestone: v0.8
status: complete
requirements:
  covered: [REQ-057, REQ-058, REQ-059, REQ-060]
  partial: []
---/ci---
2026-08-04 12:25:58 +00:00
Jon Chery 70c5718505 verify(P03): 4-layer verification PASS — REQ-060
---ci---
project: orca
phase: 3
milestone: v0.8
status: verify
requirements:
  covered: [REQ-060]
  partial: []
---/ci---
2026-08-04 12:18:48 +00:00
Jon Chery 46bd07c792 docs(P03): synthetic drift verification — verify-reqs passes + fails-on-drift (T03.5, REQ-060)
T03.5 synthetic drift verification (REQ-060 acceptance criterion):
1. make verify-reqs on current repo → exit 0 (60 requirements consistent)
2. flipped REQ-053 (v0.7 P1) row to Pending → make verify-reqs exit 1
   diff: REQ-053: status=Pending, expected=Complete (direction=forward)
3. reverted scratch edit → make verify-reqs exit 0

Gate passes on the real repo and correctly fails on synthetic forward
drift (ROADMAP v0.7 COMPLETE but REQUIREMENTS REQ-053 Pending). The
reverse-direction assertion is exercised by the golden-file tests
(T03.2). REQ-060 acceptance criterion met.

---ci---
project: orca
phase: 3
milestone: v0.8
status: execute
---/ci---
2026-08-04 12:17:00 +00:00
Jon Chery b6d514ee21 chore(ci): verify-reqs in validate pipeline (T03.4, REQ-060)
---ci---
project: orca
phase: 3
milestone: v0.8
status: execute
---/ci---
2026-08-04 12:16:14 +00:00
Jon Chery 7bd8e47241 chore(makefile): verify-reqs target (T03.3, REQ-060)
---ci---
project: orca
phase: 3
milestone: v0.8
status: execute
---/ci---
2026-08-04 12:15:58 +00:00
Jon Chery 016039d1a3 test(cmd/verify-reqs): golden-file tests (T03.2, REQ-060)
---ci---
project: orca
phase: 3
milestone: v0.8
status: execute
---/ci---
2026-08-04 12:15:33 +00:00
Jon Chery fc2b020423 feat(cmd/verify-reqs): requirements-hygiene gate (T03.1, REQ-060)
---ci---
project: orca
phase: 3
milestone: v0.8
status: execute
---/ci---
2026-08-04 12:11:40 +00:00
Jon Chery f4192be5d1 verify(P02): 4-layer verification PASS — REQ-058, REQ-059 + TOFU bugfix
---ci---
project: orca
phase: 2
milestone: v0.8
status: verify
requirements:
  covered: [REQ-058, REQ-059]
  partial: []
---/ci---
2026-08-04 12:07:56 +00:00
Jon Chery 11da458883 test(cli): --host-key-fingerprint non-proxmox validation (T02.11, REQ-058)
---ci---
project: orca
phase: 2
milestone: v0.8
status: execute
---/ci---
2026-08-04 12:04:28 +00:00
Jon Chery d66b3b9a0a test(proxmox,cli): end-to-end trust-surface integration tests (T02.10, REQ-058, REQ-059)
---ci---
project: orca
phase: 2
milestone: v0.8
status: execute
---/ci---
2026-08-04 12:04:24 +00:00
Jon Chery 2dcb14377a fix(doctor): TOFU capture-fix parity with bootstrap — v0.6 ship-defect (T02.9)
---ci---
project: orca
phase: 2
milestone: v0.8
status: execute
---/ci---
2026-08-04 11:56:45 +00:00
Jon Chery 13e6762f0f feat(cli): orca node key-reset <node> — local known_hosts reset (T02.8, REQ-059)
---ci---
project: orca
phase: 2
milestone: v0.8
status: execute
---/ci---
2026-08-04 11:51:47 +00:00
Jon Chery 325a5662f4 feat(proxmox): populate Result.HostKeyFingerprint (T02.7, REQ-058)
---ci---
project: orca
phase: 2
milestone: v0.8
status: execute
---/ci---
2026-08-04 11:48:00 +00:00
Jon Chery 8b0cbe10ae fix(proxmox): TOFU capture bug — v0.6 ship-defect first-connect join always failed (T02.6)
---ci---
project: orca
phase: 2
milestone: v0.8
status: execute
---/ci---
2026-08-04 11:46:38 +00:00
Jon Chery bd17e6e114 feat(proxmox): pinnedHostKeyCallback for --host-key-fingerprint (T02.5, REQ-058)
---ci---
project: orca
phase: 2
milestone: v0.8
status: execute
---/ci---
2026-08-04 11:45:53 +00:00
Jon Chery 7cb12c52ce feat(proxmox): HostKeyFingerprint field on Options (T02.4, REQ-058)
---ci---
project: orca
phase: 2
milestone: v0.8
status: execute
---/ci---
2026-08-04 11:38:39 +00:00
Jon Chery 08481d35ce feat(cli): --host-key-fingerprint flag on node join (T02.3, REQ-058)
---ci---
project: orca
phase: 2
milestone: v0.8
status: execute
---/ci---
2026-08-04 11:37:01 +00:00
Jon Chery 00869c6f5b refactor(security): export WriteAtomic (T02.2, REQ-059)
---ci---
project: orca
phase: 2
milestone: v0.8
status: execute
---/ci---
2026-08-04 11:36:42 +00:00
Jon Chery aa3462826b feat(security): SSHFingerprintSHA256 helper (T02.1, REQ-058)
---ci---
project: orca
phase: 2
milestone: v0.8
status: execute
---/ci---
2026-08-04 11:35:59 +00:00
Jon Chery dea358d40b verify(P01): 4-layer verification PASS — REQ-057 covered
---ci---
project: orca
phase: 1
milestone: v0.8
status: verify
requirements:
  covered: [REQ-057]
  partial: []
---/ci---
2026-08-04 01:51:26 +00:00
Jon Chery 367a338a72 test(P01): coverage-gate verification — all 9 packages hit tiered floor (T01.12, REQ-057)
>=70%: engine 88.9%, proxmox 87.1%, cli 76.2%, transport 93.0%,
       store 84.7%, jobspec 90.5%
>=50%: audit 100.0%, certpaths 100.0%, cmd/orca 80.0%
go test -race ./... PASS. GRILL escape valve NOT needed.

---ci---
project: orca
phase: 1
milestone: v0.8
status: execute
requirements:
  covered: [REQ-057]
  partial: []
---/ci---
2026-08-04 01:49:15 +00:00
Jon Chery 2ce6622055 test(cmd/orca): smoke test ≥50% toe-hold, main→run refactor (T01.11, REQ-057)
Refactor main() into run() int (main calls os.Exit(run())) so the test
can exercise the CLI directly without os.Exit terminating the test
process. Add main_test.go with two cases: run() success path (version
command → exit 0) and run() error path (job run with missing spec →
exit 1, stderr contains "error:"). Low-effort toe-hold per RESEARCH
§1.1/§1.4 — do not over-invest in glue-code coverage.

Coverage: go test -cover ./cmd/orca → 80.0% (was 0%, target ≥50%).
go test -race PASS.

---ci---
project: orca
phase: 1
milestone: v0.8
status: execute
---/ci---
2026-08-04 01:43:57 +00:00
Jon Chery 6408342a7f test(cli): coverage uplift to ≥70% excl daemon.go (T01.6, REQ-057)
Add table-driven rootCmd.Execute() tests for the node, job, cert,
doctor, audit, status, version, and node-capacity subcommand families.
Each test runs against a temp ORCA_HOME and asserts stdout/stderr/exit
via the existing initTestEnv/resetRootFlags/discardWriter helpers
(RESEARCH §1.2). extend resetRootFlags to also reset the per-command
flag-bound globals so tests don't leak state between runs.

daemon.go is excluded from the ≥70% target (documented in node_test.go):
the daemon command starts a long-running mTLS server whose lifecycle is
covered by internal/daemon/server_test.go; only its --pprof flag
registration is verified here (daemon_test.go).

Coverage: go test -cover ./internal/cli → 76.2% overall (78.7% by
-func), which includes daemon.go's untested RunE; the non-daemon files
exceed 70% comfortably. go test -race PASS.

---ci---
project: orca
phase: 1
milestone: v0.8
status: execute
---/ci---
2026-08-04 01:43:38 +00:00
Jon Chery 2d47cd9135 test(audit): first tests, ≥50% toe-hold (T01.9, REQ-057)
internal/audit/audit_test.go was added in d9d0bed (Wave 1 P03 uplift)
and already achieves 100.0% coverage — well above the ≥50% toe-hold
target. This empty commit records T01.9 acceptance for the Wave 2
task ledger; no code change was required.

---ci---
project: orca
phase: 1
milestone: v0.8
status: execute
---/ci---
2026-08-04 01:13:46 +00:00
Jon Chery 9727edf4df test(certpaths): first tests, ≥50% toe-hold (T01.10, REQ-057)
---ci---
project: orca
phase: 1
milestone: v0.8
status: execute
---/ci---
2026-08-04 01:13:43 +00:00
Jon Chery e45232f395 test(jobspec): coverage uplift to ≥70% + golden HCL fixtures (T01.8, REQ-057)
---ci---
project: orca
phase: 1
milestone: v0.8
status: execute
---/ci---
2026-08-04 01:12:59 +00:00
Jon Chery 82f3bcacfd test(store): coverage uplift to ≥70% + missing cert_repo_test.go (T01.7, REQ-057)
---ci---
project: orca
phase: 1
milestone: v0.8
status: execute
---/ci---
2026-08-04 01:12:12 +00:00
Jon Chery 7a834357ec test(proxmox): coverage uplift to ≥70% (T01.5, REQ-057)
Extend bootstrap_test.go with FullFlow_IdempotentReRun (two
sequential bootstraps on the same fake SSH server — verifies the
idempotent no-op path end-to-end), FullFlow_NoPasswordInLogs
(asserts the SSH password never appears in slog output, D-031),
FullFlow_ValidateSudoersFails (forceSudoersInvalid flag →
wrapped 'validate sudoers' error), FullFlow_CreateLinuxUserFails
(ProxmoxUser=root exercises the /root home branch in deployPubKey),
DefaultSSHDialer_DialContext_ConnectionRefused (covers the real
defaultSSHDialer.DialContext concrete path), and
SSHSessionRunner_CombinedOutput_NewSessionError (closed-client →
'new session' error branch). Add forceSudoersInvalid knob +
funcDialer helper to ssh_session_test.go.

Coverage: 83.2% → 87.1%. go test -race PASS. No production code
changed (T01.1 sessionRunner seam already in place).

---ci---
project: orca
phase: 1
milestone: v0.8
status: execute
---/ci---
2026-08-04 01:05:12 +00:00
Jon Chery 40906a0697 test(engine): coverage uplift to ≥70% (T01.4, REQ-057)
Add registry_test.go (NEW) covering NodeRegistry Join/Leave/Forget/
List/Get (success + not-found + duplicate), NewNodeRegistry nil-
logger, Audit Record success/error (sqlite-backed via openTestDB
pattern) + NewAudit nil-logger. Extend scheduler_test.go with
MemLocalNode/Capacity (happy + nil), JobSpecScore nil/over-capacity/
fits, JobSpecFits nil, PickNode empty. Extend dispatcher_test.go
with Submit error paths: bad spec, explicit target no-registry,
target peer-not-found, peer-pick missing CA, no peer registry, nil
capacity fallthrough, all-peers-fail PickNode.

Coverage: 65.1% → 88.9%. go test -race PASS. No production code
changed; T01.2 peerDispatcher seam NOT needed (error-path tests
via stubbed LocalExecutor + PeerRegistry reached 89% without it;
httptest.NewTLSServer was not required either since dispatchToPeer
CA-missing and PickNode-fail branches cover the remote path).

---ci---
project: orca
phase: 1
milestone: v0.8
status: execute
---/ci---
2026-08-04 01:05:09 +00:00
Jon Chery 16e4f8a1f2 test(transport): coverage uplift to ≥70% (T01.3, REQ-057)
Add retry_test.go (NEW) covering DefaultRetryPolicy, first-attempt
success, idempotent-verb retry, idempotency-key retry, MaxAttempts
exhaustion, zero-MaxAttempts defaulting, transient+non-idempotent+
no-key bail, ctx-cancel mid-backoff, exponential backoff growth +
cap, and contains() substring helper. Extend idempotency_test.go
with Sweep, empty-key Put/Get, and empty-key WithIdempotencyKey.
Extend handshake_log_test.go with LogHandshakeFromCert happy path
(real x509 cert → fingerprint) and FingerprintOfCert round-trip.

Coverage: 84.6% → 93.0%. go test -race PASS. No production code
changed; no new seams (httptest already covered DispatchClient).

---ci---
project: orca
phase: 1
milestone: v0.8
status: execute
---/ci---
2026-08-04 01:05:03 +00:00
Jon Chery 2786de166d refactor(proxmox): extract sessionRunner seam for testability (T01.1, REQ-057)
---ci---
project: orca
phase: 1
milestone: v0.8
status: execute
---/ci---
2026-08-04 00:51:15 +00:00
56 changed files with 5442 additions and 121 deletions
+60
View File
@@ -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.
+5 -5
View File
@@ -1,11 +1,11 @@
{
"phase": 0,
"stage": "grill",
"phase": 4,
"stage": "complete",
"milestone": "v0.8",
"milestone_slug": "coverage-trust-hardening",
"phase_role": "pre_execution",
"phase_role": "final",
"attempts": 0,
"updated_at": "2026-08-04T00:48:00Z",
"milestone_complete": false,
"updated_at": "2026-08-04T01:30:00Z",
"milestone_complete": true,
"next_milestone": null
}
+55
View File
@@ -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.
+55
View File
@@ -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.
+51
View File
@@ -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.
+4 -4
View File
@@ -136,7 +136,7 @@ REQ-047..052 all complete.
| 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** | Pending |
| 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** | Pending |
| 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** | Pending |
| 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** | Pending |
| 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) |
+321
View File
@@ -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).
+6 -6
View File
@@ -133,7 +133,7 @@ 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
## 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%,
@@ -144,11 +144,11 @@ 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.
- [ ] Phase 0: Pre-execution (specify → clarify → research → plan → grill) — tag `v0.7.0`
- [ ] Phase 1: Test coverage uplift round 2 — 6 packages to ≥ 70%, 3 zero-test packages to first tests (REQ-057) — tag `v0.7.1`
- [ ] 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`
- [ ] Phase 3: Requirements-hygiene gate — `make verify-reqs` + verify assertion (REQ-060) — tag `v0.7.3`
- [ ] Phase 4: Final review + ship + audit (milestone release) — tag `v0.7.4`
- [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
+1 -1
View File
@@ -6,7 +6,7 @@
"name": "Orca",
"description": "Offline/CLI-first orchestration engine (Orca) — Nomad-inspired, far simpler than Kubernetes",
"milestone": "v0.8",
"phase": 0,
"phase": 4,
"milestone_type": "nfr",
"default_branch": "main",
"tech_stack": {
+7
View File
@@ -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:
+8 -1
View File
@@ -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
@@ -98,3 +99,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
View File
@@ -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
}
+41
View File
@@ -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)
}
}
+183
View File
@@ -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 P01P04`, 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
}
+170
View File
@@ -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)
}
}
+9
View File
@@ -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 |
+9
View File
@@ -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 P1P2 | Pending |
| REQ-005 | Second forward drift (v0.3 COMPLETE, row Pending) | Low | v0.3 P1 | Pending |
+8
View File
@@ -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
View File
@@ -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
View File
@@ -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
+157
View File
@@ -0,0 +1,157 @@
package certpaths
import (
"os"
"path/filepath"
"runtime"
"strings"
"testing"
)
func TestPaths_HonorORCAHOME(t *testing.T) {
dir := t.TempDir()
t.Setenv("ORCA_HOME", dir)
// Ensure ORCA_DB doesn't leak from the environment / prior tests.
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)
}
})
}
// DBPath defaults to $ORCA_HOME/orca.db.
if got, want := DBPath(), filepath.Join(dir, "orca.db"); got != want {
t.Errorf("DBPath = %q, want %q", got, want)
}
// Dir() returns ORCA_HOME verbatim.
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) {
// Unset ORCA_HOME so Dir() falls back to ~/.orca.
// We can't reliably mutate the real HOME in a portable way, so just
// assert that the returned path ends with the default subdir on the
// current OS and is absolute.
os.Unsetenv("ORCA_HOME")
// Also clear ORCA_DB so DBPath's fallback to Dir() is exercised.
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, defaultCADir)
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) {
// Empty string ORCA_HOME is treated as unset → ~/.orca fallback.
t.Setenv("ORCA_HOME", "")
home, err := os.UserHomeDir()
if err != nil {
t.Skipf("os.UserHomeDir: %v", err)
}
want := filepath.Join(home, defaultCADir)
if got := Dir(); got != want {
t.Errorf("Dir() with empty ORCA_HOME = %q, want %q", got, want)
}
}
func TestDir_ORCAHOMERelativePath(t *testing.T) {
// A relative ORCA_HOME is honored verbatim (no cleaning/absolutizing).
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)
}
// CACertPath joins the relative dir with ca.crt using filepath.Join.
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", "")
// Every *Path() must live under Dir() except DBPath which also does.
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 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)
}
}
func init() {
// On Windows the default home subdir is still ".orca"; the test for
// default fallback uses os.UserHomeDir which is platform-aware. This
// guard keeps the suite from running a meaningless check on plan9.
_ = runtime.GOOS
}
+113
View File
@@ -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))
}
}
+196
View File
@@ -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)
}
}
+312
View File
@@ -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
}
+15
View File
@@ -18,6 +18,21 @@ func resetRootFlags(t *testing.T) {
rootCmd.SetErr(&buf)
_ = rootCmd.PersistentFlags().Set("system", "false")
_ = rootCmd.PersistentFlags().Set("json", "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
}
func TestNamespaceDefaultsToUserHome(t *testing.T) {
+84 -19
View File
@@ -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)
}
@@ -156,13 +160,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 +346,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 +415,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)
}
+194
View File
@@ -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)
}
}
+496
View File
@@ -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)
}
}
+47
View File
@@ -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"])
}
}
+47
View File
@@ -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)
}
}
+14 -10
View File
@@ -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 {
+94
View File
@@ -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"
)
@@ -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)
}
}
+99
View File
@@ -203,3 +203,102 @@ func TestParseInlineSpec(t *testing.T) {
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")
}
}
+229
View File
@@ -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)))
}
+64
View File
@@ -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")
}
}
+223
View File
@@ -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 := ParseFile(path)
if err != nil {
t.Fatalf("ParseFile(%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 := ParseFile(path)
if err != nil {
t.Fatalf("ParseFile: %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
View File
@@ -0,0 +1 @@
job "x" { command = invalid }
+3
View File
@@ -0,0 +1,3 @@
job "x" {}
task "nocmd" {}
+1
View File
@@ -0,0 +1 @@
task "x" { command = "/bin/echo" }
+1
View File
@@ -0,0 +1 @@
job "empty" {}
+6
View File
@@ -0,0 +1,6 @@
job "envvars" {}
task "runner" {
command = "/bin/printenv"
env = ["FOO=bar", "BAZ=qux", "EMPTY="]
}
+19
View File
@@ -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"]
}
+5
View File
@@ -0,0 +1,5 @@
job "single" {}
task "solo" {
command = "/bin/true"
}
+212 -35
View File
@@ -22,9 +22,13 @@
package proxmox
import (
"bytes"
"context"
"errors"
"fmt"
"log/slog"
"net"
"os"
"strings"
"time"
@@ -68,6 +72,11 @@ type Options struct {
ProxmoxRole string
// SSHPort is the SSH port (default 22).
SSHPort int
// HostKeyFingerprint is the operator-pinned SSH host key fingerprint
// in `SHA256:base64` form (REQ-058, D-044). When non-empty, the
// bootstrap dialer uses a pinned-host-key callback instead of the
// TOFU known_hosts capture path. Empty falls back to TOFU.
HostKeyFingerprint string
// Logger receives audit-log entries. If nil, slog.Default() is used.
Logger *slog.Logger
}
@@ -119,15 +128,30 @@ func BootstrapProxmox(ctx context.Context, opts Options) (*Result, error) {
return nil, fmt.Errorf("ssh key: %w", err)
}
// Step 2: SSH dial with password auth + TOFU host-key capture (D-035).
// knownhosts.New reads ~/.orca/known_hosts; on first connect it
// captures the host key, on subsequent connects it verifies.
hostKeyCallback, err := knownhosts.New(certpaths.KnownHostsPath())
if err != nil {
return nil, fmt.Errorf("known_hosts callback: %w", err)
// Step 2: SSH dial with password auth + host-key verification (D-035,
// REQ-058). When opts.HostKeyFingerprint is set (D-044), use a pinned
// callback that fails closed on mismatch (AD-028); otherwise use the
// TOFU known_hosts capture callback (D-035). The TOFU wrapper fixes
// the v0.6 ship-defect where knownhosts.New returned KeyError{Want:[]}
// on first connect WITHOUT writing the captured key, so the first
// `orca node join --type proxmox` always failed.
sshAddr := fmt.Sprintf("%s:%d", opts.Host, opts.SSHPort)
var capturedHostKey ssh.PublicKey
var hostKeyCallback ssh.HostKeyCallback
if opts.HostKeyFingerprint != "" {
cb, err := pinnedHostKeyCallback(opts.HostKeyFingerprint, &capturedHostKey)
if err != nil {
return nil, fmt.Errorf("host-key fingerprint: %w", err)
}
hostKeyCallback = cb
} else {
cb, err := TOFUHostKeyCallback(sshAddr, &capturedHostKey)
if err != nil {
return nil, fmt.Errorf("tofu host-key callback: %w", err)
}
hostKeyCallback = cb
}
sshAddr := fmt.Sprintf("%s:%d", opts.Host, opts.SSHPort)
sshConfig := &ssh.ClientConfig{
User: opts.SSHUser,
Auth: []ssh.AuthMethod{ssh.Password(opts.Password)},
@@ -143,45 +167,55 @@ func BootstrapProxmox(ctx context.Context, opts Options) (*Result, error) {
}
defer conn.Close()
if sessionRunner == nil {
sessionRunner = &sshSessionRunner{client: conn}
}
hostKeyFP := ""
if capturedHostKey != nil {
hostKeyFP = security.SSHFingerprintSHA256(capturedHostKey)
}
log.Info("proxmox.ssh_connected",
slog.String("event", "proxmox.ssh_connected"),
slog.String("host", opts.Host),
slog.String("ssh_user", opts.SSHUser),
slog.String("host_key_fingerprint", hostKeyFP),
)
// Step 3: Deploy orca pubkey to ~orca/.ssh/authorized_keys (idempotent).
if err := deployPubKey(conn, opts.ProxmoxUser, string(pubLine)); err != nil {
if err := deployPubKey(opts.ProxmoxUser, string(pubLine)); err != nil {
return nil, fmt.Errorf("deploy pubkey: %w", err)
}
// Step 4: Create orca Linux system user (idempotent).
if err := createLinuxUser(conn, opts.ProxmoxUser); err != nil {
if err := createLinuxUser(opts.ProxmoxUser); err != nil {
return nil, fmt.Errorf("create user %s: %w", opts.ProxmoxUser, err)
}
// Step 5: Create OrcaOperator PVE role (idempotent).
if err := createPVERole(conn, opts.ProxmoxRole); err != nil {
if err := createPVERole(opts.ProxmoxRole); err != nil {
return nil, fmt.Errorf("create PVE role %s: %w", opts.ProxmoxRole, err)
}
// Step 6: Create orca@pam PVE user (idempotent).
if err := createPVEUser(conn, opts.ProxmoxUser); err != nil {
if err := createPVEUser(opts.ProxmoxUser); err != nil {
return nil, fmt.Errorf("create PVE user %s@pam: %w", opts.ProxmoxUser, err)
}
// Step 7: Assign OrcaOperator role to orca@pam on path / (idempotent).
if err := assignPVEACL(conn, opts.ProxmoxUser, opts.ProxmoxRole); err != nil {
if err := assignPVEACL(opts.ProxmoxUser, opts.ProxmoxRole); err != nil {
return nil, fmt.Errorf("assign ACL: %w", err)
}
// Step 8: Write /etc/sudoers.d/orca (AD-020: NOEXEC on pct/qm,
// no NOEXEC on apt-get/dpkg, pvesh EXCLUDED).
if err := writeSudoers(conn, opts.ProxmoxUser); err != nil {
if err := writeSudoers(opts.ProxmoxUser); err != nil {
return nil, fmt.Errorf("write sudoers: %w", err)
}
// Step 9: Validate sudoers with visudo -cf.
if err := validateSudoers(conn); err != nil {
if err := validateSudoers(); err != nil {
return nil, fmt.Errorf("validate sudoers: %w", err)
}
@@ -193,8 +227,9 @@ func BootstrapProxmox(ctx context.Context, opts Options) (*Result, error) {
)
return &Result{
NodeName: opts.Host,
NodeAddress: opts.Host + ":8443",
NodeName: opts.Host,
NodeAddress: opts.Host + ":8443",
HostKeyFingerprint: hostKeyFP,
}, nil
}
@@ -202,6 +237,78 @@ func BootstrapProxmox(ctx context.Context, opts Options) (*Result, error) {
// variable so tests can override it with a fake SSH server.
var sshDialer sshDialerType = defaultSSHDialer{}
// pinnedHostKeyCallback returns an ssh.HostKeyCallback that pins the
// server's host key to the operator-supplied SHA256:base64 fingerprint
// (REQ-058, AD-028). It validates the `SHA256:` prefix up front (D-045)
// and fails closed on any mismatch. The capturedKey out-param records
// the verified server key so the caller can populate Result.
func pinnedHostKeyCallback(expectedSHA256Base64 string, capturedKey *ssh.PublicKey) (ssh.HostKeyCallback, error) {
if !strings.HasPrefix(expectedSHA256Base64, "SHA256:") {
return nil, fmt.Errorf("pinnedHostKeyCallback: fingerprint must be SHA256:-prefixed (D-045), got %q", expectedSHA256Base64)
}
return func(_ string, _ net.Addr, key ssh.PublicKey) error {
got := security.SSHFingerprintSHA256(key)
if got != expectedSHA256Base64 {
return fmt.Errorf("REQ-058 host-key fingerprint mismatch: pinned=%s server=%s", expectedSHA256Base64, got)
}
if capturedKey != nil {
*capturedKey = key
}
return nil
}, nil
}
// TOFUHostKeyCallback returns an ssh.HostKeyCallback that wraps the
// standard knownhosts.New verifier with TOFU first-connect capture
// (D-035). On a host-unknown KeyError{Want:[]} it writes the
// server-presented key to certpaths.KnownHostsPath() atomically
// (security.WriteAtomic, AD-029) and allows the dial to proceed; on a
// mismatch (Want non-empty) it fails closed (MITM detection). The
// capturedKey out-param records the verified/captured server key so
// the caller can populate Result. This fixes the v0.6 ship-defect
// where knownhosts.New returned KeyError{Want:[]} on first connect
// WITHOUT writing the captured key, so the first
// `orca node join --type proxmox` always failed.
//
// Exported so the doctor proxmox probe (T02.9) can reuse the same
// capture-fix wrapper for parity (GRILL condition #2).
func TOFUHostKeyCallback(addr string, capturedKey *ssh.PublicKey) (ssh.HostKeyCallback, error) {
cb, err := knownhosts.New(certpaths.KnownHostsPath())
if err != nil {
return nil, err
}
return func(hostname string, remote net.Addr, key ssh.PublicKey) error {
err := cb(hostname, remote, key)
if err == nil {
if capturedKey != nil {
*capturedKey = key
}
return nil
}
var keyErr *knownhosts.KeyError
if errors.As(err, &keyErr) && len(keyErr.Want) == 0 {
line := knownhosts.Line([]string{knownhosts.Normalize(addr)}, key)
path := certpaths.KnownHostsPath()
existing, readErr := os.ReadFile(path)
if readErr != nil && !os.IsNotExist(readErr) {
return fmt.Errorf("tofu read known_hosts: %w", readErr)
}
if len(existing) > 0 && !bytes.HasSuffix(existing, []byte("\n")) {
existing = append(existing, '\n')
}
updated := append(existing, []byte(line)...)
if writeErr := security.WriteAtomic(path, 0o600, updated); writeErr != nil {
return fmt.Errorf("tofu write known_hosts: %w", writeErr)
}
if capturedKey != nil {
*capturedKey = key
}
return nil
}
return err
}, nil
}
type sshDialerType interface {
DialContext(ctx context.Context, network, addr string, config *ssh.ClientConfig) (*ssh.Client, error)
}
@@ -212,15 +319,29 @@ func (defaultSSHDialer) DialContext(ctx context.Context, network, addr string, c
return ssh.Dial(network, addr, config)
}
// runRemote runs a command over the SSH connection and returns its
// combined output. Returns an error if the command exits non-zero.
func runRemote(conn *ssh.Client, cmd string) ([]byte, error) {
session, err := conn.NewSession()
type sessionRunnerType interface {
CombinedOutput(cmd string) ([]byte, error)
}
var sessionRunner sessionRunnerType
type sshSessionRunner struct {
client *ssh.Client
}
func (r *sshSessionRunner) CombinedOutput(cmd string) ([]byte, error) {
session, err := r.client.NewSession()
if err != nil {
return nil, fmt.Errorf("new session: %w", err)
}
defer session.Close()
out, err := session.CombinedOutput(cmd)
return session.CombinedOutput(cmd)
}
// runRemote runs a command over the SSH connection and returns its
// combined output. Returns an error if the command exits non-zero.
func runRemote(cmd string) ([]byte, error) {
out, err := sessionRunner.CombinedOutput(cmd)
if err != nil {
return out, fmt.Errorf("run %q: %w (output: %s)", cmd, err, strings.TrimSpace(string(out)))
}
@@ -230,7 +351,7 @@ func runRemote(conn *ssh.Client, cmd string) ([]byte, error) {
// deployPubKey appends the orca public key to the remote user's
// authorized_keys file, creating the .ssh dir if needed. Idempotent:
// if the key is already present, it is not re-appended.
func deployPubKey(conn *ssh.Client, user, pubLine string) error {
func deployPubKey(user, pubLine string) error {
pubLine = strings.TrimSpace(pubLine)
if pubLine == "" {
return fmt.Errorf("deployPubKey: empty pub line")
@@ -246,7 +367,7 @@ func deployPubKey(conn *ssh.Client, user, pubLine string) error {
"mkdir -p %s && touch %s && chmod 0700 %s && chmod 0600 %s && grep -qF '%s' %s || echo '%s' >> %s",
sshDir, authFile, sshDir, authFile, pubLine, authFile, pubLine, authFile,
)
if _, err := runRemote(conn, cmd); err != nil {
if _, err := runRemote(cmd); err != nil {
return err
}
return nil
@@ -254,9 +375,9 @@ func deployPubKey(conn *ssh.Client, user, pubLine string) error {
// createLinuxUser creates the orca system user if it doesn't already
// exist. Idempotent: `id -u` check before `useradd`.
func createLinuxUser(conn *ssh.Client, user string) error {
func createLinuxUser(user string) error {
cmd := fmt.Sprintf("id -u %s 2>/dev/null || useradd -m -s /bin/bash %s", user, user)
if _, err := runRemote(conn, cmd); err != nil {
if _, err := runRemote(cmd); err != nil {
return err
}
return nil
@@ -264,12 +385,12 @@ func createLinuxUser(conn *ssh.Client, user string) error {
// createPVERole creates the OrcaOperator PVE role if it doesn't exist.
// Idempotent: probes `pveum role list` before `pveum role add`.
func createPVERole(conn *ssh.Client, role string) error {
func createPVERole(role string) error {
cmd := fmt.Sprintf(
"pveum role list 2>/dev/null | grep -q '^%s' || pveum role add %s --privs '%s'",
role, role, OrcaOperatorPrivileges,
)
if _, err := runRemote(conn, cmd); err != nil {
if _, err := runRemote(cmd); err != nil {
return err
}
return nil
@@ -278,13 +399,13 @@ func createPVERole(conn *ssh.Client, role string) error {
// createPVEUser creates the orca@pam PVE user if it doesn't exist.
// Idempotent: probes `pveum user list` before `pveum user add`.
// Uses @pam realm (AD-019) since orca creates a Linux system user.
func createPVEUser(conn *ssh.Client, user string) error {
func createPVEUser(user string) error {
pveUserID := user + "@pam"
cmd := fmt.Sprintf(
"pveum user list 2>/dev/null | grep -q '%s' || pveum user add %s -comment 'Orca automation user'",
pveUserID, pveUserID,
)
if _, err := runRemote(conn, cmd); err != nil {
if _, err := runRemote(cmd); err != nil {
return err
}
return nil
@@ -292,10 +413,10 @@ func createPVEUser(conn *ssh.Client, user string) error {
// assignPVEACL assigns the OrcaOperator role to orca@pam on path /
// (cluster-wide). `pveum acl modify` is idempotent (creates or updates).
func assignPVEACL(conn *ssh.Client, user, role string) error {
func assignPVEACL(user, role string) error {
pveUserID := user + "@pam"
cmd := fmt.Sprintf("pveum acl modify / -user %s -role %s", pveUserID, role)
if _, err := runRemote(conn, cmd); err != nil {
if _, err := runRemote(cmd); err != nil {
return err
}
return nil
@@ -319,12 +440,12 @@ func sudoersContent(user string) string {
// writeSudoers writes the /etc/sudoers.d/orca file on the remote host
// with mode 0440. Uses a heredoc via cat to avoid quoting issues.
func writeSudoers(conn *ssh.Client, user string) error {
func writeSudoers(user string) error {
content := sudoersContent(user)
// Write via cat heredoc, then chmod 0440.
cmd := fmt.Sprintf("cat > /etc/sudoers.d/%s <<'ORCA_SUDOERS_EOF'\n%s\nORCA_SUDOERS_EOF\nchmod 0440 /etc/sudoers.d/%s",
user, content, user)
if _, err := runRemote(conn, cmd); err != nil {
if _, err := runRemote(cmd); err != nil {
return err
}
return nil
@@ -333,9 +454,9 @@ func writeSudoers(conn *ssh.Client, user string) error {
// validateSudoers runs `visudo -cf` on the sudoers file. Aborts the
// bootstrap if validation fails (prevents a broken sudoers from
// locking the orca user out of sudo).
func validateSudoers(conn *ssh.Client) error {
func validateSudoers() error {
cmd := "visudo -cf /etc/sudoers.d/orca"
out, err := runRemote(conn, cmd)
out, err := runRemote(cmd)
if err != nil {
return fmt.Errorf("visudo validation failed: %w (output: %s)", err, strings.TrimSpace(string(out)))
}
@@ -344,3 +465,59 @@ func validateSudoers(conn *ssh.Client) error {
}
return nil
}
// ResetHostKey removes all known_hosts entries for the given host from
// certpaths.KnownHostsPath() (REQ-059, D-046, AD-029). It rewrites the
// file atomically via security.WriteAtomic. LOCAL ONLY — it does NOT
// touch the remote host's authorized_keys (D-046). The next connect
// re-pins the host key via TOFU (T02.6) or the --host-key-fingerprint
// pinned path (T02.5).
//
// A line matches when its first whitespace-delimited field (the host
// pattern, normalized via knownhosts.Normalize) equals the normalized
// target host. Comment/blank lines are preserved.
func ResetHostKey(host string) error {
if host == "" {
return fmt.Errorf("ResetHostKey: host is required")
}
path := certpaths.KnownHostsPath()
existing, err := os.ReadFile(path)
if err != nil {
if os.IsNotExist(err) {
return nil // nothing to reset
}
return fmt.Errorf("ResetHostKey: read known_hosts: %w", err)
}
target := knownhosts.Normalize(host)
var kept []byte
removed := 0
for _, line := range strings.Split(string(existing), "\n") {
trimmed := strings.TrimSpace(line)
if trimmed == "" || strings.HasPrefix(trimmed, "#") {
kept = append(kept, []byte(line+"\n")...)
continue
}
fields := strings.Fields(trimmed)
if len(fields) == 0 {
kept = append(kept, []byte(line+"\n")...)
continue
}
if knownhosts.Normalize(fields[0]) == target {
removed++
continue
}
kept = append(kept, []byte(line+"\n")...)
}
if removed == 0 {
return nil
}
// Ensure the kept buffer ends with exactly one trailing newline.
kept = bytes.TrimRight(kept, "\n")
if len(kept) > 0 {
kept = append(kept, '\n')
}
if err := security.WriteAtomic(path, 0o600, kept); err != nil {
return fmt.Errorf("ResetHostKey: rewrite known_hosts: %w", err)
}
return nil
}
+718 -2
View File
@@ -3,14 +3,22 @@ package proxmox
import (
"bytes"
"context"
"crypto/ed25519"
"crypto/rand"
"errors"
"log/slog"
"net"
"os"
"path/filepath"
"strconv"
"strings"
"testing"
"time"
"golang.org/x/crypto/ssh"
"golang.org/x/crypto/ssh/knownhosts"
"git.cloudinit.dev/coreci/orca/internal/security"
)
func TestSudoersContent(t *testing.T) {
@@ -315,7 +323,7 @@ func TestBootstrapProxmox_ContextCancelled(t *testing.T) {
}
func TestDeployPubKey_EmptyPubLine(t *testing.T) {
err := deployPubKey(nil, "orca", "")
err := deployPubKey("orca", "")
if err == nil {
t.Error("expected error for empty pub line")
}
@@ -325,8 +333,716 @@ func TestDeployPubKey_EmptyPubLine(t *testing.T) {
}
func TestDeployPubKey_WhitespaceOnlyPubLine(t *testing.T) {
err := deployPubKey(nil, "orca", " \n \t ")
err := deployPubKey("orca", " \n \t ")
if err == nil {
t.Error("expected error for whitespace-only pub line")
}
}
func TestBootstrapProxmox_FullFlow_IdempotentReRun(t *testing.T) {
srv := newFakeSSHServer(t)
defer srv.close()
home := t.TempDir()
t.Setenv("ORCA_HOME", home)
if err := os.WriteFile(filepath.Join(home, "known_hosts"), []byte{}, 0o600); err != nil {
t.Fatalf("create known_hosts: %v", err)
}
orig := sshDialer
defer func() { sshDialer = orig }()
origRunner := sessionRunner
defer func() { sessionRunner = origRunner }()
host, _, _ := net.SplitHostPort(srv.addr())
sshDialer = &funcDialer{fn: func(ctx context.Context, network, addr string, config *ssh.ClientConfig) (*ssh.Client, error) {
return fakeSSHClient(t, srv), nil
}}
for i := 0; i < 2; i++ {
sessionRunner = nil
if _, err := BootstrapProxmox(t.Context(), Options{
Host: host,
Password: "pw",
}); err != nil {
t.Fatalf("bootstrap run %d: %v", i+1, err)
}
}
}
func TestBootstrapProxmox_FullFlow_NoPasswordInLogs(t *testing.T) {
srv := newFakeSSHServer(t)
defer srv.close()
home := t.TempDir()
t.Setenv("ORCA_HOME", home)
if err := os.WriteFile(filepath.Join(home, "known_hosts"), []byte{}, 0o600); err != nil {
t.Fatalf("create known_hosts: %v", err)
}
orig := sshDialer
defer func() { sshDialer = orig }()
origRunner := sessionRunner
defer func() { sessionRunner = origRunner }()
sessionRunner = nil
sshDialer = &staticDialer{client: fakeSSHClient(t, srv)}
host, _, _ := net.SplitHostPort(srv.addr())
var logBuf bytes.Buffer
_, err := BootstrapProxmox(t.Context(), Options{
Host: host,
Password: "super-secret-pw-12345",
Logger: slog.New(slog.NewTextHandler(&logBuf, nil)),
})
if err != nil {
t.Fatalf("BootstrapProxmox: %v", err)
}
out := logBuf.String()
if strings.Contains(out, "super-secret-pw-12345") {
t.Errorf("password leaked into logs (D-031): %s", out)
}
}
func TestBootstrapProxmox_FullFlow_ValidateSudoersFails(t *testing.T) {
srv := newFakeSSHServer(t)
defer srv.close()
srv.forceSudoersInvalid = true
home := t.TempDir()
t.Setenv("ORCA_HOME", home)
if err := os.WriteFile(filepath.Join(home, "known_hosts"), []byte{}, 0o600); err != nil {
t.Fatalf("create known_hosts: %v", err)
}
orig := sshDialer
defer func() { sshDialer = orig }()
origRunner := sessionRunner
defer func() { sessionRunner = origRunner }()
sessionRunner = nil
sshDialer = &staticDialer{client: fakeSSHClient(t, srv)}
host, _, _ := net.SplitHostPort(srv.addr())
_, err := BootstrapProxmox(t.Context(), Options{
Host: host,
Password: "pw",
})
if err == nil {
t.Fatal("expected error for invalid sudoers")
}
if !strings.Contains(err.Error(), "validate sudoers") {
t.Errorf("error should mention validate sudoers, got: %v", err)
}
}
func TestDefaultSSHDialer_DialContext_ConnectionRefused(t *testing.T) {
d := defaultSSHDialer{}
cfg := &ssh.ClientConfig{
User: "root",
Auth: []ssh.AuthMethod{ssh.Password("pw")},
HostKeyCallback: ssh.InsecureIgnoreHostKey(),
Timeout: 200 * time.Millisecond,
}
_, err := d.DialContext(context.Background(), "tcp", "127.0.0.1:1", cfg)
if err == nil {
t.Fatal("expected error for connection refused")
}
}
func TestBootstrapProxmox_FullFlow_CreateLinuxUserFails(t *testing.T) {
srv := newFakeSSHServer(t)
defer srv.close()
home := t.TempDir()
t.Setenv("ORCA_HOME", home)
if err := os.WriteFile(filepath.Join(home, "known_hosts"), []byte{}, 0o600); err != nil {
t.Fatalf("create known_hosts: %v", err)
}
orig := sshDialer
defer func() { sshDialer = orig }()
origRunner := sessionRunner
defer func() { sessionRunner = origRunner }()
sessionRunner = nil
sshDialer = &staticDialer{client: fakeSSHClient(t, srv)}
host, _, _ := net.SplitHostPort(srv.addr())
// ProxmoxUser=root exercises the /root home branch in deployPubKey.
_, err := BootstrapProxmox(t.Context(), Options{
Host: host,
Password: "pw",
ProxmoxUser: "root",
})
if err != nil {
t.Fatalf("BootstrapProxmox with ProxmoxUser=root: %v", err)
}
}
func TestSSHSessionRunner_CombinedOutput_NewSessionError(t *testing.T) {
srv := newFakeSSHServer(t)
defer srv.close()
conn := fakeSSHClient(t, srv)
conn.Close()
r := &sshSessionRunner{client: conn}
_, err := r.CombinedOutput("echo hi")
if err == nil {
t.Fatal("expected error from NewSession on closed client")
}
if !strings.Contains(err.Error(), "new session") {
t.Errorf("error should mention new session, got: %v", err)
}
}
// TestPinnedHostKeyCallback_Match verifies the pinned callback returns
// nil when the server-presented key matches the operator-supplied
// fingerprint (T02.5, REQ-058).
func TestPinnedHostKeyCallback_Match(t *testing.T) {
srv := newFakeSSHServer(t)
defer srv.close()
host, port, _ := net.SplitHostPort(srv.addr())
hostKey := srv.hostPublicKey()
if hostKey == nil {
t.Fatal("server host key is nil")
}
expectedFP := security.SSHFingerprintSHA256(hostKey)
var captured ssh.PublicKey
cb, err := pinnedHostKeyCallback(expectedFP, &captured)
if err != nil {
t.Fatalf("pinnedHostKeyCallback: %v", err)
}
if err := cb(host+":"+port, &net.TCPAddr{IP: net.ParseIP(host), Port: 22}, hostKey); err != nil {
t.Errorf("match callback returned error: %v", err)
}
if !bytes.Equal(captured.Marshal(), hostKey.Marshal()) {
t.Error("captured key does not match server host key")
}
}
// TestPinnedHostKeyCallback_Mismatch verifies the pinned callback fails
// closed on mismatch (T02.5, REQ-058).
func TestPinnedHostKeyCallback_Mismatch(t *testing.T) {
srv := newFakeSSHServer(t)
defer srv.close()
host, _, _ := net.SplitHostPort(srv.addr())
hostKey := srv.hostPublicKey()
if hostKey == nil {
t.Fatal("server host key is nil")
}
cb, err := pinnedHostKeyCallback("SHA256:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=", nil)
if err != nil {
t.Fatalf("pinnedHostKeyCallback: %v", err)
}
err = cb(host+":22", &net.TCPAddr{IP: net.ParseIP(host), Port: 22}, hostKey)
if err == nil {
t.Fatal("expected mismatch error, got nil")
}
if !strings.Contains(err.Error(), "REQ-058") {
t.Errorf("mismatch error should mention REQ-058, got: %v", err)
}
}
// TestPinnedHostKeyCallback_RejectsRawHex verifies the constructor
// rejects a non-SHA256:-prefixed fingerprint (T02.5, D-045).
func TestPinnedHostKeyCallback_RejectsRawHex(t *testing.T) {
_, err := pinnedHostKeyCallback("abcdef0123456789", nil)
if err == nil {
t.Fatal("expected error for raw hex fingerprint, got nil")
}
if !strings.Contains(err.Error(), "SHA256:") {
t.Errorf("error should mention SHA256: prefix requirement, got: %v", err)
}
}
// TestTOFUHostKeyCallback_FirstConnectCapturesKey verifies that on
// first connect (empty known_hosts) the TOFU callback captures the
// server key, writes it to known_hosts, and allows the dial (T02.6 —
// v0.6 ship-defect fix).
func TestTOFUHostKeyCallback_FirstConnectCapturesKey(t *testing.T) {
home := setupORCAHome(t) // empty known_hosts
srv := newFakeSSHServer(t)
defer srv.close()
host, port, _ := net.SplitHostPort(srv.addr())
addr := host + ":" + port
hostKey := srv.hostPublicKey()
if hostKey == nil {
t.Fatal("server host key is nil")
}
cb, err := TOFUHostKeyCallback(addr, nil)
if err != nil {
t.Fatalf("TOFUHostKeyCallback: %v", err)
}
if err := cb(addr, &net.TCPAddr{IP: net.ParseIP(host), Port: 22}, hostKey); err != nil {
t.Fatalf("first-connect callback returned error: %v", err)
}
data, err := os.ReadFile(filepath.Join(home, "known_hosts"))
if err != nil {
t.Fatalf("read known_hosts: %v", err)
}
if len(data) == 0 {
t.Fatal("known_hosts is empty — TOFU capture did not write the key (v0.6 ship-defect not fixed)")
}
if !strings.Contains(string(data), knownhosts.Normalize(addr)) {
t.Errorf("known_hosts missing the normalized addr %q: %s", knownhosts.Normalize(addr), data)
}
if !strings.Contains(string(data), hostKey.Type()) {
t.Errorf("known_hosts missing the host key type %q: %s", hostKey.Type(), data)
}
}
// TestTOFUHostKeyCallback_SecondConnectMatches verifies that on a
// second connect (known_hosts already has the key) the TOFU callback
// matches and returns nil (T02.6).
func TestTOFUHostKeyCallback_SecondConnectMatches(t *testing.T) {
setupORCAHome(t)
srv := newFakeSSHServer(t)
defer srv.close()
host, port, _ := net.SplitHostPort(srv.addr())
addr := host + ":" + port
hostKey := srv.hostPublicKey()
if hostKey == nil {
t.Fatal("server host key is nil")
}
// First connect: capture + write.
cb1, err := TOFUHostKeyCallback(addr, nil)
if err != nil {
t.Fatalf("TOFUHostKeyCallback #1: %v", err)
}
if err := cb1(addr, &net.TCPAddr{IP: net.ParseIP(host), Port: 22}, hostKey); err != nil {
t.Fatalf("first connect: %v", err)
}
// Second connect: the fresh knownhosts.New reads the written key.
cb2, err := TOFUHostKeyCallback(addr, nil)
if err != nil {
t.Fatalf("TOFUHostKeyCallback #2: %v", err)
}
if err := cb2(addr, &net.TCPAddr{IP: net.ParseIP(host), Port: 22}, hostKey); err != nil {
t.Fatalf("second connect should match, got: %v", err)
}
}
// TestTOFUHostKeyCallback_MismatchFails verifies that on a mismatch
// (known_hosts has a different key) the TOFU callback fails closed
// (MITM detection) (T02.6).
func TestTOFUHostKeyCallback_MismatchFails(t *testing.T) {
setupORCAHome(t)
srv := newFakeSSHServer(t)
defer srv.close()
host, port, _ := net.SplitHostPort(srv.addr())
addr := host + ":" + port
hostKey := srv.hostPublicKey()
if hostKey == nil {
t.Fatal("server host key is nil")
}
// Capture the real key first so known_hosts is populated.
cb1, err := TOFUHostKeyCallback(addr, nil)
if err != nil {
t.Fatalf("TOFUHostKeyCallback #1: %v", err)
}
if err := cb1(addr, &net.TCPAddr{IP: net.ParseIP(host), Port: 22}, hostKey); err != nil {
t.Fatalf("first connect: %v", err)
}
// Generate a different key + present it: callback must fail.
pub, _, err := ed25519.GenerateKey(rand.Reader)
if err != nil {
t.Fatalf("ed25519 gen: %v", err)
}
altKey, err := ssh.NewPublicKey(pub)
if err != nil {
t.Fatalf("new pub: %v", err)
}
cb2, err := TOFUHostKeyCallback(addr, nil)
if err != nil {
t.Fatalf("TOFUHostKeyCallback #2: %v", err)
}
err = cb2(addr, &net.TCPAddr{IP: net.ParseIP(host), Port: 22}, altKey)
if err == nil {
t.Fatal("expected mismatch error, got nil")
}
}
// TestBootstrapProxmox_PopulatesHostKeyFingerprint verifies that after
// a successful bootstrap via TOFU, Result.HostKeyFingerprint is
// non-empty and SHA256:-prefixed (T02.7).
func TestBootstrapProxmox_PopulatesHostKeyFingerprint(t *testing.T) {
srv := newFakeSSHServer(t)
defer srv.close()
home := t.TempDir()
t.Setenv("ORCA_HOME", home)
if err := os.WriteFile(filepath.Join(home, "known_hosts"), []byte{}, 0o600); err != nil {
t.Fatalf("create known_hosts: %v", err)
}
orig := sshDialer
defer func() { sshDialer = orig }()
origRunner := sessionRunner
defer func() { sessionRunner = origRunner }()
sessionRunner = nil
// Use the real dialer so the TOFU HostKeyCallback actually runs
// against the fake server (a static dialer with an insecure client
// would bypass the callback and leave HostKeyFingerprint empty).
sshDialer = defaultSSHDialer{}
host, port, _ := net.SplitHostPort(srv.addr())
portNum, _ := strconv.Atoi(port)
result, err := BootstrapProxmox(t.Context(), Options{
Host: host,
Password: "pw",
SSHPort: portNum,
})
if err != nil {
t.Fatalf("BootstrapProxmox: %v", err)
}
if result.HostKeyFingerprint == "" {
t.Fatal("Result.HostKeyFingerprint is empty")
}
if !strings.HasPrefix(result.HostKeyFingerprint, "SHA256:") {
t.Errorf("Result.HostKeyFingerprint = %q, want SHA256: prefix", result.HostKeyFingerprint)
}
}
// TestResetHostKey_RemovesTargetLines verifies that ResetHostKey
// removes all known_hosts lines for the target host while leaving
// other hosts' lines intact (T02.8, REQ-059, D-046).
func TestResetHostKey_RemovesTargetLines(t *testing.T) {
home := setupORCAHome(t)
path := filepath.Join(home, "known_hosts")
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(path, original, 0o600); err != nil {
t.Fatalf("write known_hosts: %v", err)
}
if err := ResetHostKey("10.0.0.1"); err != nil {
t.Fatalf("ResetHostKey: %v", err)
}
data, err := os.ReadFile(path)
if err != nil {
t.Fatalf("read known_hosts: %v", err)
}
result := string(data)
if strings.Contains(result, "AAAAKEY1") {
t.Errorf("target host key line not removed: %s", result)
}
if strings.Contains(result, "AAAAKEY1ALT") {
t.Errorf("target host alt key line not removed: %s", result)
}
if !strings.Contains(result, "AAAAKEY2") {
t.Errorf("other host's line was removed (should be intact): %s", result)
}
}
// TestResetHostKey_NoMatchingLinesIsNoop verifies that ResetHostKey is
// a no-op when no lines match (T02.8).
func TestResetHostKey_NoMatchingLinesIsNoop(t *testing.T) {
home := setupORCAHome(t)
path := filepath.Join(home, "known_hosts")
original := []byte("[10.0.0.2]:22 ssh-ed25519 AAAAKEY2 host2\n")
if err := os.WriteFile(path, original, 0o600); err != nil {
t.Fatalf("write known_hosts: %v", err)
}
if err := ResetHostKey("10.0.0.99"); err != nil {
t.Fatalf("ResetHostKey: %v", err)
}
data, err := os.ReadFile(path)
if err != nil {
t.Fatalf("read known_hosts: %v", err)
}
if string(data) != string(original) {
t.Errorf("known_hosts changed on no-match: got %q, want %q", data, original)
}
}
// TestResetHostKey_MissingFileIsNoop verifies ResetHostKey returns nil
// when known_hosts does not exist (T02.8).
func TestResetHostKey_MissingFileIsNoop(t *testing.T) {
setupORCAHome(t)
if err := ResetHostKey("10.0.0.1"); err != nil {
t.Errorf("ResetHostKey on missing file should be no-op, got: %v", err)
}
}
// TestResetHostKey_EmptyHostErrors verifies ResetHostKey rejects an
// empty host (T02.8).
func TestResetHostKey_EmptyHostErrors(t *testing.T) {
if err := ResetHostKey(""); err == nil {
t.Error("expected error for empty host, got nil")
}
}
// bootstrapE2ESetup wires the real dialer against a fake SSH server so
// the full HostKeyCallback path (pinned or TOFU) runs end-to-end through
// BootstrapProxmox. Returns the host, port, and server (for fingerprint
// computation). The known_hosts file is created empty in the temp
// ORCA_HOME.
func bootstrapE2ESetup(t *testing.T) (srv *fakeSSHServer, host, port string) {
t.Helper()
srv = newFakeSSHServer(t)
t.Cleanup(srv.close)
home := t.TempDir()
t.Setenv("ORCA_HOME", home)
if err := os.WriteFile(filepath.Join(home, "known_hosts"), []byte{}, 0o600); err != nil {
t.Fatalf("create known_hosts: %v", err)
}
orig := sshDialer
t.Cleanup(func() { sshDialer = orig })
origRunner := sessionRunner
t.Cleanup(func() { sessionRunner = origRunner })
sessionRunner = nil
sshDialer = defaultSSHDialer{}
host, port, _ = net.SplitHostPort(srv.addr())
return srv, host, port
}
// TestBootstrapE2E_PinnedFingerprintCorrect verifies that
// --host-key-fingerprint with the correct pin (T02.10 case 1) succeeds
// end-to-end and Result.HostKeyFingerprint equals the pinned value.
func TestBootstrapE2E_PinnedFingerprintCorrect(t *testing.T) {
srv, host, port := bootstrapE2ESetup(t)
hostKey := srv.hostPublicKey()
if hostKey == nil {
t.Fatal("server host key is nil")
}
pin := security.SSHFingerprintSHA256(hostKey)
portNum, _ := strconv.Atoi(port)
result, err := BootstrapProxmox(t.Context(), Options{
Host: host,
Password: "pw",
SSHPort: portNum,
HostKeyFingerprint: pin,
})
if err != nil {
t.Fatalf("BootstrapProxmox with correct pin: %v", err)
}
if result.HostKeyFingerprint != pin {
t.Errorf("Result.HostKeyFingerprint = %q, want %q (pinned value)",
result.HostKeyFingerprint, pin)
}
}
// TestBootstrapE2E_PinnedFingerprintWrong verifies that
// --host-key-fingerprint with a wrong pin (T02.10 case 2) fails fast
// with the REQ-058 mismatch error, before any SSH session commands run.
func TestBootstrapE2E_PinnedFingerprintWrong(t *testing.T) {
_, host, port := bootstrapE2ESetup(t)
portNum, _ := strconv.Atoi(port)
wrong := "SHA256:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="
_, err := BootstrapProxmox(t.Context(), Options{
Host: host,
Password: "pw",
SSHPort: portNum,
HostKeyFingerprint: wrong,
})
if err == nil {
t.Fatal("expected error for wrong pin, got nil")
}
if !strings.Contains(err.Error(), "REQ-058") {
t.Errorf("error should mention REQ-058, got: %v", err)
}
}
// TestBootstrapE2E_TOFUFirstConnectCapturesKey verifies that with no
// --host-key-fingerprint on a first connect (empty known_hosts) (T02.10
// case 3) the TOFU callback captures the key, writes known_hosts, and
// bootstrap succeeds — exercised end-to-end through BootstrapProxmox.
func TestBootstrapE2E_TOFUFirstConnectCapturesKey(t *testing.T) {
srv, host, port := bootstrapE2ESetup(t)
hostKey := srv.hostPublicKey()
if hostKey == nil {
t.Fatal("server host key is nil")
}
portNum, _ := strconv.Atoi(port)
home := os.Getenv("ORCA_HOME")
knownHostsPath := filepath.Join(home, "known_hosts")
before, _ := os.ReadFile(knownHostsPath)
if len(before) != 0 {
t.Fatalf("precondition: known_hosts not empty: %q", before)
}
result, err := BootstrapProxmox(t.Context(), Options{
Host: host,
Password: "pw",
SSHPort: portNum,
})
if err != nil {
t.Fatalf("BootstrapProxmox first connect: %v", err)
}
data, err := os.ReadFile(knownHostsPath)
if err != nil {
t.Fatalf("read known_hosts: %v", err)
}
if len(data) == 0 {
t.Fatal("known_hosts empty — TOFU did not capture the key end-to-end")
}
expectedFP := security.SSHFingerprintSHA256(hostKey)
if result.HostKeyFingerprint != expectedFP {
t.Errorf("Result.HostKeyFingerprint = %q, want %q", result.HostKeyFingerprint, expectedFP)
}
}
// TestBootstrapE2E_TOFUSecondConnectMatches verifies that a second
// connect (known_hosts already has the key from the first connect)
// (T02.10 case 4) matches and succeeds end-to-end.
func TestBootstrapE2E_TOFUSecondConnectMatches(t *testing.T) {
srv, host, port := bootstrapE2ESetup(t)
portNum, _ := strconv.Atoi(port)
for i := 0; i < 2; i++ {
sessionRunner = nil
if _, err := BootstrapProxmox(t.Context(), Options{
Host: host,
Password: "pw",
SSHPort: portNum,
}); err != nil {
t.Fatalf("bootstrap run %d: %v", i+1, err)
}
}
_ = srv
}
// TestBootstrapE2E_TOFUMismatchFails verifies that when known_hosts has
// a different key (T02.10 case 5) the second connect fails with a
// mismatch (MITM detection) — end-to-end through BootstrapProxmox.
func TestBootstrapE2E_TOFUMismatchFails(t *testing.T) {
srv, host, port := bootstrapE2ESetup(t)
hostKey := srv.hostPublicKey()
if hostKey == nil {
t.Fatal("server host key is nil")
}
portNum, _ := strconv.Atoi(port)
home := os.Getenv("ORCA_HOME")
knownHostsPath := filepath.Join(home, "known_hosts")
altPub, _, err := ed25519.GenerateKey(rand.Reader)
if err != nil {
t.Fatalf("ed25519 gen: %v", err)
}
altKey, err := ssh.NewPublicKey(altPub)
if err != nil {
t.Fatalf("new pub: %v", err)
}
addr := host + ":" + port
altLine := knownhosts.Line([]string{knownhosts.Normalize(addr)}, altKey)
if err := os.WriteFile(knownHostsPath, []byte(altLine+"\n"), 0o600); err != nil {
t.Fatalf("write known_hosts: %v", err)
}
_, err = BootstrapProxmox(t.Context(), Options{
Host: host,
Password: "pw",
SSHPort: portNum,
})
if err == nil {
t.Fatal("expected MITM/mismatch error, got nil")
}
if !strings.Contains(err.Error(), "ssh dial") {
t.Errorf("error should mention ssh dial, got: %v", err)
}
}
// TestBootstrapE2E_PrePopulatedKnownHostsMatches verifies the v0.6→v0.8
// migration path (T02.10 case 7): a known_hosts entry written by a prior
// join (simulating a v0.6 install) is matched on second-connect without
// re-capture, end-to-end through BootstrapProxmox.
func TestBootstrapE2E_PrePopulatedKnownHostsMatches(t *testing.T) {
srv, host, port := bootstrapE2ESetup(t)
hostKey := srv.hostPublicKey()
if hostKey == nil {
t.Fatal("server host key is nil")
}
portNum, _ := strconv.Atoi(port)
home := os.Getenv("ORCA_HOME")
knownHostsPath := filepath.Join(home, "known_hosts")
addr := host + ":" + port
preLine := knownhosts.Line([]string{knownhosts.Normalize(addr)}, hostKey)
if err := os.WriteFile(knownHostsPath, []byte(preLine+"\n"), 0o600); err != nil {
t.Fatalf("write known_hosts: %v", err)
}
result, err := BootstrapProxmox(t.Context(), Options{
Host: host,
Password: "pw",
SSHPort: portNum,
})
if err != nil {
t.Fatalf("BootstrapProxmox on pre-populated known_hosts: %v", err)
}
expectedFP := security.SSHFingerprintSHA256(hostKey)
if result.HostKeyFingerprint != expectedFP {
t.Errorf("Result.HostKeyFingerprint = %q, want %q", result.HostKeyFingerprint, expectedFP)
}
}
// TestBootstrapE2E_KeyResetThenRePin verifies T02.10 case 6: after
// ResetHostKey removes the known_hosts entry, the next BootstrapProxmox
// connect re-pins the key via TOFU and succeeds end-to-end. The reset
// target is the known_hosts entry key (host:port, normalized), which
// matches how the cli resolves the host from a proxmox node's address
// for non-default ports.
func TestBootstrapE2E_KeyResetThenRePin(t *testing.T) {
srv, host, port := bootstrapE2ESetup(t)
portNum, _ := strconv.Atoi(port)
home := os.Getenv("ORCA_HOME")
knownHostsPath := filepath.Join(home, "known_hosts")
addr := host + ":" + port
// First connect: TOFU captures + writes known_hosts.
sessionRunner = nil
if _, err := BootstrapProxmox(t.Context(), Options{
Host: host,
Password: "pw",
SSHPort: portNum,
}); err != nil {
t.Fatalf("first bootstrap: %v", err)
}
before, _ := os.ReadFile(knownHostsPath)
if len(before) == 0 {
t.Fatal("precondition: known_hosts empty after first connect")
}
// Reset: known_hosts entry removed. Pass the full addr (host:port)
// so Normalize produces the same bracketed form the TOFU callback
// wrote for a non-default port.
if err := ResetHostKey(addr); err != nil {
t.Fatalf("ResetHostKey: %v", err)
}
after, _ := os.ReadFile(knownHostsPath)
if strings.Contains(string(after), knownhosts.Normalize(addr)) {
t.Fatalf("known_hosts still contains host after reset: %q", after)
}
// Next connect re-pins via TOFU + succeeds.
sessionRunner = nil
if _, err := BootstrapProxmox(t.Context(), Options{
Host: host,
Password: "pw",
SSHPort: portNum,
}); err != nil {
t.Fatalf("re-pin bootstrap after reset: %v", err)
}
rePinned, _ := os.ReadFile(knownHostsPath)
if !strings.Contains(string(rePinned), knownhosts.Normalize(addr)) {
t.Fatalf("known_hosts not re-populated on next connect: %q", rePinned)
}
_ = srv
}
+69 -23
View File
@@ -23,9 +23,11 @@ type fakeSSHServer struct {
config *ssh.ServerConfig
done chan struct{}
mu sync.Mutex
state map[string]string
authDir string
mu sync.Mutex
state map[string]string
authDir string
forceSudoersInvalid bool
hostSigner ssh.Signer
}
func newFakeSSHServer(t *testing.T) *fakeSSHServer {
@@ -53,11 +55,12 @@ func newFakeSSHServer(t *testing.T) *fakeSSHServer {
t.Fatalf("listen: %v", err)
}
srv := &fakeSSHServer{
listener: ln,
config: config,
done: make(chan struct{}),
state: make(map[string]string),
authDir: t.TempDir(),
listener: ln,
config: config,
done: make(chan struct{}),
state: make(map[string]string),
authDir: t.TempDir(),
hostSigner: hostSigner,
}
go srv.serve()
return srv
@@ -65,6 +68,16 @@ func newFakeSSHServer(t *testing.T) *fakeSSHServer {
func (s *fakeSSHServer) addr() string { return s.listener.Addr().String() }
// hostPublicKey returns the server's SSH host public key. Used by
// callback tests to compute the pinned fingerprint the operator would
// supply, and to feed the callback the exact key the server presents.
func (s *fakeSSHServer) hostPublicKey() ssh.PublicKey {
if s.hostSigner == nil {
return nil
}
return s.hostSigner.PublicKey()
}
func (s *fakeSSHServer) serve() {
for {
conn, err := s.listener.Accept()
@@ -142,10 +155,11 @@ func (s *fakeSSHServer) runCommand(cmd string) ([]byte, int) {
case strings.HasPrefix(trimmed, "cat > /etc/sudoers.d/"):
return s.handleSudoersWrite(trimmed), 0
case strings.HasPrefix(trimmed, "visudo -cf /etc/sudoers.d/orca"):
if s.state["sudoers_valid"] == "true" {
return []byte("/etc/sudoers.d/orca: parsed OK\n"), 0
force := s.forceSudoersInvalid
if force || s.state["sudoers_valid"] != "true" {
return []byte("/etc/sudoers.d/orca: syntax error\n"), 1
}
return []byte("/etc/sudoers.d/orca: syntax error\n"), 1
return []byte("/etc/sudoers.d/orca: parsed OK\n"), 0
case strings.HasPrefix(trimmed, "cat /") && strings.HasSuffix(trimmed, "/authorized_keys"):
return s.readAuthFile(trimmed[4:]), 0
case strings.HasPrefix(trimmed, "cat /") && strings.Contains(trimmed, "/orca"):
@@ -238,12 +252,20 @@ func fakeSSHClient(t *testing.T, srv *fakeSSHServer) *ssh.Client {
return client
}
func withSessionRunner(t *testing.T, conn *ssh.Client) {
t.Helper()
orig := sessionRunner
t.Cleanup(func() { sessionRunner = orig })
sessionRunner = &sshSessionRunner{client: conn}
}
func TestRunRemote_Success(t *testing.T) {
srv := newFakeSSHServer(t)
defer srv.close()
conn := fakeSSHClient(t, srv)
defer conn.Close()
out, err := runRemote(conn, "echo hello")
withSessionRunner(t, conn)
out, err := runRemote("echo hello")
if err != nil {
t.Fatalf("runRemote: %v", err)
}
@@ -257,7 +279,8 @@ func TestRunRemote_Failure(t *testing.T) {
defer srv.close()
conn := fakeSSHClient(t, srv)
defer conn.Close()
_, err := runRemote(conn, "exit 7")
withSessionRunner(t, conn)
_, err := runRemote("exit 7")
if err == nil {
t.Fatal("expected error for non-zero exit")
}
@@ -271,8 +294,9 @@ func TestDeployPubKey_Success(t *testing.T) {
defer srv.close()
conn := fakeSSHClient(t, srv)
defer conn.Close()
withSessionRunner(t, conn)
if err := deployPubKey(conn, "orca", "ssh-ed25519 AAAA test@orca"); err != nil {
if err := deployPubKey("orca", "ssh-ed25519 AAAA test@orca"); err != nil {
t.Fatalf("deployPubKey: %v", err)
}
out := srv.readFile(filepath.Join(srv.authDir, "authorized_keys"))
@@ -286,11 +310,12 @@ func TestDeployPubKey_Idempotent(t *testing.T) {
defer srv.close()
conn := fakeSSHClient(t, srv)
defer conn.Close()
withSessionRunner(t, conn)
if err := deployPubKey(conn, "orca", "ssh-ed25519 AAAA test@orca"); err != nil {
if err := deployPubKey("orca", "ssh-ed25519 AAAA test@orca"); err != nil {
t.Fatalf("first deploy: %v", err)
}
if err := deployPubKey(conn, "orca", "ssh-ed25519 AAAA test@orca"); err != nil {
if err := deployPubKey("orca", "ssh-ed25519 AAAA test@orca"); err != nil {
t.Fatalf("second deploy: %v", err)
}
out := srv.readFile(filepath.Join(srv.authDir, "authorized_keys"))
@@ -304,7 +329,8 @@ func TestCreateLinuxUser_Success(t *testing.T) {
defer srv.close()
conn := fakeSSHClient(t, srv)
defer conn.Close()
if err := createLinuxUser(conn, "orca"); err != nil {
withSessionRunner(t, conn)
if err := createLinuxUser("orca"); err != nil {
t.Fatalf("createLinuxUser: %v", err)
}
}
@@ -314,7 +340,8 @@ func TestCreatePVERole_Success(t *testing.T) {
defer srv.close()
conn := fakeSSHClient(t, srv)
defer conn.Close()
if err := createPVERole(conn, "OrcaOperator"); err != nil {
withSessionRunner(t, conn)
if err := createPVERole("OrcaOperator"); err != nil {
t.Fatalf("createPVERole: %v", err)
}
}
@@ -324,7 +351,8 @@ func TestCreatePVEUser_Success(t *testing.T) {
defer srv.close()
conn := fakeSSHClient(t, srv)
defer conn.Close()
if err := createPVEUser(conn, "orca"); err != nil {
withSessionRunner(t, conn)
if err := createPVEUser("orca"); err != nil {
t.Fatalf("createPVEUser: %v", err)
}
}
@@ -334,7 +362,8 @@ func TestAssignPVEACL_Success(t *testing.T) {
defer srv.close()
conn := fakeSSHClient(t, srv)
defer conn.Close()
if err := assignPVEACL(conn, "orca", "OrcaOperator"); err != nil {
withSessionRunner(t, conn)
if err := assignPVEACL("orca", "OrcaOperator"); err != nil {
t.Fatalf("assignPVEACL: %v", err)
}
}
@@ -344,8 +373,9 @@ func TestWriteSudoers_Success(t *testing.T) {
defer srv.close()
conn := fakeSSHClient(t, srv)
defer conn.Close()
withSessionRunner(t, conn)
if err := writeSudoers(conn, "orca"); err != nil {
if err := writeSudoers("orca"); err != nil {
t.Fatalf("writeSudoers: %v", err)
}
if srv.state["sudoers_valid"] != "true" {
@@ -361,9 +391,10 @@ func TestValidateSudoers_ParsedOK(t *testing.T) {
defer srv.close()
conn := fakeSSHClient(t, srv)
defer conn.Close()
withSessionRunner(t, conn)
srv.state["sudoers_valid"] = "true"
if err := validateSudoers(conn); err != nil {
if err := validateSudoers(); err != nil {
t.Errorf("validateSudoers: %v", err)
}
}
@@ -373,9 +404,10 @@ func TestValidateSudoers_Failure(t *testing.T) {
defer srv.close()
conn := fakeSSHClient(t, srv)
defer conn.Close()
withSessionRunner(t, conn)
srv.state["sudoers_valid"] = "false"
if err := validateSudoers(conn); err == nil {
if err := validateSudoers(); err == nil {
t.Error("expected error for invalid sudoers")
}
}
@@ -388,6 +420,14 @@ func (d *staticDialer) DialContext(ctx context.Context, network, addr string, co
return d.client, nil
}
type funcDialer struct {
fn func(ctx context.Context, network, addr string, config *ssh.ClientConfig) (*ssh.Client, error)
}
func (d *funcDialer) DialContext(ctx context.Context, network, addr string, config *ssh.ClientConfig) (*ssh.Client, error) {
return d.fn(ctx, network, addr, config)
}
func TestBootstrapProxmox_FullFlow_Success(t *testing.T) {
srv := newFakeSSHServer(t)
defer srv.close()
@@ -400,6 +440,9 @@ func TestBootstrapProxmox_FullFlow_Success(t *testing.T) {
orig := sshDialer
defer func() { sshDialer = orig }()
origRunner := sessionRunner
defer func() { sessionRunner = origRunner }()
sessionRunner = nil
sshDialer = &staticDialer{client: fakeSSHClient(t, srv)}
host, _, _ := net.SplitHostPort(srv.addr())
@@ -439,6 +482,9 @@ func TestBootstrapProxmox_FullFlow_DeployPubKeyFails(t *testing.T) {
orig := sshDialer
defer func() { sshDialer = orig }()
origRunner := sessionRunner
defer func() { sessionRunner = origRunner }()
sessionRunner = nil
// Use a real client that connects to a server which will reject deploy
// by returning a non-zero exit for the mkdir command. We achieve this
+15 -12
View File
@@ -121,10 +121,10 @@ func CAInit(dir, commonName string) (*CA, error) {
// Atomic write: temp file + rename. This avoids leaving a half-written
// ca.key on disk if the process crashes mid-write.
if err := writeAtomic(certPath, CACPEMMode, certPEM); err != nil {
if err := WriteAtomic(certPath, CACPEMMode, certPEM); err != nil {
return nil, err
}
if err := writeAtomic(keyPath, CAMode, keyPEM); err != nil {
if err := WriteAtomic(keyPath, CAMode, keyPEM); err != nil {
return nil, err
}
@@ -290,23 +290,26 @@ func bothExist(paths ...string) (bool, error) {
// WriteCert writes a cert PEM blob to path with mode 0644 atomically.
// REQ-033 requires cert files to be 0644; this helper enforces that.
func WriteCert(path string, pemBytes []byte) error {
return writeAtomic(path, CACPEMMode, pemBytes)
return WriteAtomic(path, CACPEMMode, pemBytes)
}
// WriteKey writes a private-key PEM blob to path with mode 0600
// atomically. REQ-033 requires key files to be 0600; this helper
// enforces that.
func WriteKey(path string, pemBytes []byte) error {
return writeAtomic(path, CAMode, pemBytes)
return WriteAtomic(path, CAMode, pemBytes)
}
// writeAtomic writes data to a temp file in dir and renames. Sets the
// WriteAtomic writes data to a temp file in dir and renames. Sets the
// requested perm before the rename so the file lands at the right mode.
func writeAtomic(path string, mode os.FileMode, data []byte) error {
// Exported (AD-029) so the key-reset / known_hosts atomic rewrite path
// in proxmox (T02.6/T02.7) can reuse it instead of duplicating the
// ~20-LOC pattern (RESEARCH §5 pitfall #10).
func WriteAtomic(path string, mode os.FileMode, data []byte) error {
dir := filepath.Dir(path)
tmp, err := os.CreateTemp(dir, ".tmp-*")
if err != nil {
return fmt.Errorf("writeAtomic: create temp: %w", err)
return fmt.Errorf("WriteAtomic: create temp: %w", err)
}
tmpName := tmp.Name()
// Best-effort cleanup if we fail before rename.
@@ -315,21 +318,21 @@ func writeAtomic(path string, mode os.FileMode, data []byte) error {
}()
if _, err := tmp.Write(data); err != nil {
_ = tmp.Close()
return fmt.Errorf("writeAtomic: write: %w", err)
return fmt.Errorf("WriteAtomic: write: %w", err)
}
if err := tmp.Chmod(mode); err != nil {
_ = tmp.Close()
return fmt.Errorf("writeAtomic: chmod: %w", err)
return fmt.Errorf("WriteAtomic: chmod: %w", err)
}
if err := tmp.Sync(); err != nil {
_ = tmp.Close()
return fmt.Errorf("writeAtomic: sync: %w", err)
return fmt.Errorf("WriteAtomic: sync: %w", err)
}
if err := tmp.Close(); err != nil {
return fmt.Errorf("writeAtomic: close: %w", err)
return fmt.Errorf("WriteAtomic: close: %w", err)
}
if err := os.Rename(tmpName, path); err != nil {
return fmt.Errorf("writeAtomic: rename: %w", err)
return fmt.Errorf("WriteAtomic: rename: %w", err)
}
return nil
}
+13 -2
View File
@@ -26,6 +26,17 @@ const (
sshPubFile = "orca_ssh_key.pub"
)
// SSHFingerprintSHA256 returns the canonical SSH public-key fingerprint
// in the form `SHA256:base64` (no trailing padding), as produced by
// `ssh-keygen -lf` and OpenSSH's host-key verification prompts. This is
// a thin wrapper over ssh.FingerprintSHA256 (AD-027) for use by the
// proxmox bootstrap pinned-host-key callback (REQ-058) and any other
// SSH-domain identity checks. Do NOT reuse security.Fingerprint — that
// returns an X.509 DER hex digest (different domain; RESEARCH §2.2).
func SSHFingerprintSHA256(pubKey ssh.PublicKey) string {
return ssh.FingerprintSHA256(pubKey)
}
// GenerateOrLoadSSHKey returns the orca SSH keypair, generating it
// lazily on first call (D-037). The key is Ed25519 (smaller, faster,
// more secure than RSA for SSH auth), persisted as PKCS8 PEM to
@@ -84,10 +95,10 @@ func GenerateOrLoadSSHKey(dir string) (keyPEM, pubLine []byte, err error) {
pubLine = ssh.MarshalAuthorizedKey(sshPub)
// Persist with correct modes (atomic write + chmod).
if err := writeAtomic(keyPath, SSHKeyMode, keyPEM); err != nil {
if err := WriteAtomic(keyPath, SSHKeyMode, keyPEM); err != nil {
return nil, nil, fmt.Errorf("write SSH key: %w", err)
}
if err := writeAtomic(pubPath, SSHPubMode, pubLine); err != nil {
if err := WriteAtomic(pubPath, SSHPubMode, pubLine); err != nil {
return nil, nil, fmt.Errorf("write SSH pub: %w", err)
}
+42
View File
@@ -1,6 +1,8 @@
package security
import (
"crypto/ed25519"
"crypto/rand"
"os"
"path/filepath"
"strings"
@@ -91,3 +93,43 @@ func TestGenerateOrLoadSSHKey_CreatesDir(t *testing.T) {
t.Errorf("nested dir not created: %v", err)
}
}
func TestSSHFingerprintSHA256_Ed25519(t *testing.T) {
pub, _, err := ed25519.GenerateKey(rand.Reader)
if err != nil {
t.Fatalf("ed25519 gen: %v", err)
}
sshPub, err := ssh.NewPublicKey(pub)
if err != nil {
t.Fatalf("new pubkey: %v", err)
}
got := SSHFingerprintSHA256(sshPub)
// Canonical form: SHA256: followed by unpadded base64.
if !strings.HasPrefix(got, "SHA256:") {
t.Fatalf("fingerprint = %q, want SHA256: prefix", got)
}
// Must match the reference implementation exactly.
want := ssh.FingerprintSHA256(sshPub)
if got != want {
t.Errorf("SSHFingerprintSHA256 = %q, want %q", got, want)
}
}
func TestSSHFingerprintSHA256_StableAcrossCalls(t *testing.T) {
pub, _, err := ed25519.GenerateKey(rand.Reader)
if err != nil {
t.Fatalf("ed25519 gen: %v", err)
}
sshPub, err := ssh.NewPublicKey(pub)
if err != nil {
t.Fatalf("new pubkey: %v", err)
}
a := SSHFingerprintSHA256(sshPub)
b := SSHFingerprintSHA256(sshPub)
if a != b {
t.Errorf("fingerprint not stable: %q vs %q", a, b)
}
}
+84
View File
@@ -65,3 +65,87 @@ func TestAuditRepo_WithError(t *testing.T) {
t.Errorf("expected error 'exit status 1', got %q", entries[0].Error)
}
}
func TestAuditRepo_MetadataRoundTrip(t *testing.T) {
repo, cleanup := openAuditTestDB(t)
defer cleanup()
ctx := context.Background()
want := map[string]any{"node": "node-1", "exit_code": float64(2)}
if err := repo.Append(ctx, &AuditEntry{
Actor: "cli",
Action: "node.join",
Resource: "node-1",
Result: "success",
Metadata: want,
}); err != nil {
t.Fatalf("append: %v", err)
}
entries, err := repo.List(ctx, 10)
if err != nil {
t.Fatalf("List: %v", err)
}
if len(entries) != 1 {
t.Fatalf("expected 1 entry, got %d", len(entries))
}
if entries[0].Metadata == nil {
t.Fatalf("metadata not round-tripped")
}
if entries[0].Metadata["node"] != "node-1" {
t.Errorf("metadata[node] = %v, want node-1", entries[0].Metadata["node"])
}
}
func TestAuditRepo_DefaultActorAndTimestamp(t *testing.T) {
repo, cleanup := openAuditTestDB(t)
defer cleanup()
ctx := context.Background()
// Append with empty Actor and zero Timestamp — defaults should apply.
if err := repo.Append(ctx, &AuditEntry{
Action: "x",
Resource: "y",
Result: "success",
}); err != nil {
t.Fatalf("append: %v", err)
}
entries, _ := repo.List(ctx, 1)
if len(entries) != 1 {
t.Fatalf("expected 1 entry, got %d", len(entries))
}
if entries[0].Actor != "system" {
t.Errorf("default actor = %q, want system", entries[0].Actor)
}
if entries[0].Timestamp.IsZero() {
t.Errorf("default timestamp not set")
}
}
func TestAuditRepo_ListDefaultLimit(t *testing.T) {
repo, cleanup := openAuditTestDB(t)
defer cleanup()
ctx := context.Background()
for i := 0; i < 5; i++ {
if err := repo.Append(ctx, &AuditEntry{
Action: "x", Resource: "y", Result: "success",
}); err != nil {
t.Fatalf("append[%d]: %v", i, err)
}
}
// limit<=0 should default to 100.
entries, err := repo.List(ctx, 0)
if err != nil {
t.Fatalf("List(0): %v", err)
}
if len(entries) != 5 {
t.Errorf("List(0): got %d, want 5", len(entries))
}
entries, err = repo.List(ctx, -1)
if err != nil {
t.Fatalf("List(-1): %v", err)
}
if len(entries) != 5 {
t.Errorf("List(-1): got %d, want 5", len(entries))
}
}
+66
View File
@@ -40,6 +40,9 @@ func TestCapacityRepoUpsertGetList(t *testing.T) {
if got.CPUMillicores != 4000 || got.MemoryMiB != 4096 || got.DiskMiB != 4096 {
t.Errorf("Get: got %+v, want cpu=4000 mem=4096 disk=4096", got)
}
if got.UpdatedAt.IsZero() {
t.Errorf("Upsert did not fill UpdatedAt")
}
// Update (overwrite).
c2 := &NodeCapacity{NodeID: "self", CPUMillicores: 8000, MemoryMiB: 8192, DiskMiB: 8192}
@@ -72,3 +75,66 @@ func TestCapacityRepoUpsertGetList(t *testing.T) {
t.Error("expected ErrNotFound on Delete of missing row")
}
}
func TestCapacityRepo_UpsertNilAndEmptyNodeID(t *testing.T) {
dir := t.TempDir()
db, err := Open(filepath.Join(dir, "test.db"))
if err != nil {
t.Fatalf("Open: %v", err)
}
defer db.Close()
repo := NewCapacityRepo(db)
ctx := context.Background()
if err := repo.Upsert(ctx, nil); err == nil {
t.Error("Upsert(nil) should error")
}
if err := repo.Upsert(ctx, &NodeCapacity{NodeID: ""}); err == nil {
t.Error("Upsert(empty NodeID) should error")
}
}
func TestCapacityRepo_GetEmptyNodeID(t *testing.T) {
dir := t.TempDir()
db, err := Open(filepath.Join(dir, "test.db"))
if err != nil {
t.Fatalf("Open: %v", err)
}
defer db.Close()
repo := NewCapacityRepo(db)
ctx := context.Background()
if _, err := repo.Get(ctx, ""); err == nil {
t.Error("Get(empty) should error")
}
}
func TestCapacityRepo_DeleteMissing(t *testing.T) {
dir := t.TempDir()
db, err := Open(filepath.Join(dir, "test.db"))
if err != nil {
t.Fatalf("Open: %v", err)
}
defer db.Close()
repo := NewCapacityRepo(db)
ctx := context.Background()
if err := repo.Delete(ctx, "ghost"); err != ErrNotFound {
t.Errorf("Delete(ghost) = %v, want ErrNotFound", err)
}
}
func TestStore_OpenEmptyPath(t *testing.T) {
// Open with "" should fall back to certpaths.DBPath() which honors
// ORCA_HOME. Set a temp ORCA_HOME so we don't pollute the real home.
home := t.TempDir()
t.Setenv("ORCA_HOME", home)
db, err := Open("")
if err != nil {
t.Fatalf("Open(\"\"): %v", err)
}
defer db.Close()
if err := db.Ping(); err != nil {
t.Errorf("Ping: %v", err)
}
}
+363
View File
@@ -2,6 +2,7 @@ package store
import (
"context"
"database/sql"
"path/filepath"
"testing"
"time"
@@ -19,6 +20,368 @@ func openJobTestDB(t *testing.T) (*JobRepo, func()) {
return NewJobRepo(db), func() { _ = db.Close() }
}
// openFullTestDB returns the underlying *sql.DB plus repos for cross-repo
// tests (e.g. TaskRepo needs a JobRepo parent row when foreign keys are on).
func openFullTestDB(t *testing.T) (*sql.DB, *JobRepo, *TaskRepo, func()) {
t.Helper()
path := filepath.Join(t.TempDir(), "test.db")
db, err := Open(path)
if err != nil {
t.Fatalf("open db: %v", err)
}
return db, NewJobRepo(db), NewTaskRepo(db), func() { _ = db.Close() }
}
func TestJobRepo_Get(t *testing.T) {
repo, cleanup := openJobTestDB(t)
defer cleanup()
ctx := context.Background()
insertJob(t, repo, ctx, "job-get", "alpha")
got, err := repo.Get(ctx, "job-get")
if err != nil {
t.Fatalf("Get: %v", err)
}
if got.ID != "job-get" || got.Name != "alpha" {
t.Errorf("Get: got %+v", got)
}
if got.Status != model.JobStatusPending {
t.Errorf("Get: status = %q, want pending", got.Status)
}
if got.Spec != "test" {
t.Errorf("Get: spec = %q, want test", got.Spec)
}
if _, err := repo.Get(ctx, "missing"); err != ErrNotFound {
t.Errorf("Get(missing): got %v, want ErrNotFound", err)
}
}
func TestJobRepo_List(t *testing.T) {
repo, cleanup := openJobTestDB(t)
defer cleanup()
ctx := context.Background()
insertJob(t, repo, ctx, "j1", "first")
insertJob(t, repo, ctx, "j2", "second")
insertJob(t, repo, ctx, "j3", "third")
jobs, err := repo.List(ctx)
if err != nil {
t.Fatalf("List: %v", err)
}
if len(jobs) != 3 {
t.Fatalf("List: got %d jobs, want 3", len(jobs))
}
// ORDER BY created_at DESC — but timestamps may collide at second
// precision. Just verify all 3 IDs are present.
ids := map[string]bool{}
for _, j := range jobs {
ids[j.ID] = true
}
for _, want := range []string{"j1", "j2", "j3"} {
if !ids[want] {
t.Errorf("List: missing job %q", want)
}
}
}
func TestJobRepo_UpdateStatus(t *testing.T) {
repo, cleanup := openJobTestDB(t)
defer cleanup()
ctx := context.Background()
insertJob(t, repo, ctx, "job-status", "alpha")
cases := []struct {
name string
status model.JobStatus
exitCode int
}{
{"running", model.JobStatusRunning, 0},
{"complete", model.JobStatusComplete, 0},
{"failed", model.JobStatusFailed, 1},
{"stopped", model.JobStatusStopped, 130},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
if err := repo.UpdateStatus(ctx, "job-status", tc.status, tc.exitCode); err != nil {
t.Fatalf("UpdateStatus(%s): %v", tc.name, err)
}
got, err := repo.Get(ctx, "job-status")
if err != nil {
t.Fatalf("Get: %v", err)
}
if got.Status != tc.status {
t.Errorf("status = %q, want %q", got.Status, tc.status)
}
if got.ExitCode != tc.exitCode {
t.Errorf("exit_code = %d, want %d", got.ExitCode, tc.exitCode)
}
switch tc.status {
case model.JobStatusRunning:
if got.StartedAt == nil {
t.Errorf("started_at should be set for %s", tc.name)
}
case model.JobStatusComplete, model.JobStatusFailed, model.JobStatusStopped:
if got.EndedAt == nil {
t.Errorf("ended_at should be set for %s", tc.name)
}
}
})
}
}
func TestJobRepo_InsertDefaults(t *testing.T) {
repo, cleanup := openJobTestDB(t)
defer cleanup()
ctx := context.Background()
// Insert with zero CreatedAt and empty Status — defaults should kick in.
j := &model.Job{ID: "defaults-1", Name: "d", Spec: "s"}
if err := repo.Insert(ctx, j); err != nil {
t.Fatalf("Insert: %v", err)
}
if j.CreatedAt.IsZero() {
t.Errorf("Insert did not fill CreatedAt")
}
if j.Status != model.JobStatusPending {
t.Errorf("Insert default status = %q, want pending", j.Status)
}
got, _ := repo.Get(ctx, "defaults-1")
if got.Status != model.JobStatusPending {
t.Errorf("Get: status = %q, want pending", got.Status)
}
}
func sampleTask(id, jobID string) *model.Task {
return &model.Task{
ID: id,
JobID: jobID,
Command: "/bin/echo",
Args: []string{"hello", "world"},
Env: []string{"FOO=bar", "BAZ=qux"},
}
}
func TestTaskRepo_InsertAndGet(t *testing.T) {
_, jobRepo, taskRepo, cleanup := openFullTestDB(t)
defer cleanup()
ctx := context.Background()
insertJob(t, jobRepo, ctx, "job-1", "alpha")
tk := sampleTask("task-1", "job-1")
if err := taskRepo.Insert(ctx, tk); err != nil {
t.Fatalf("Insert: %v", err)
}
if tk.CreatedAt.IsZero() {
t.Errorf("Insert did not fill CreatedAt")
}
if tk.Status != model.TaskStatusPending {
t.Errorf("Insert default status = %q, want pending", tk.Status)
}
got, err := taskRepo.Get(ctx, "task-1")
if err != nil {
t.Fatalf("Get: %v", err)
}
if got.Command != "/bin/echo" {
t.Errorf("command = %q", got.Command)
}
if len(got.Args) != 2 || got.Args[0] != "hello" {
t.Errorf("args = %v", got.Args)
}
if len(got.Env) != 2 || got.Env[0] != "FOO=bar" {
t.Errorf("env = %v", got.Env)
}
if got.Status != model.TaskStatusPending {
t.Errorf("status = %q, want pending", got.Status)
}
if _, err := taskRepo.Get(ctx, "missing"); err != ErrNotFound {
t.Errorf("Get(missing) = %v, want ErrNotFound", err)
}
}
func TestTaskRepo_ListByJob(t *testing.T) {
_, jobRepo, taskRepo, cleanup := openFullTestDB(t)
defer cleanup()
ctx := context.Background()
insertJob(t, jobRepo, ctx, "job-lbj", "alpha")
for _, id := range []string{"t1", "t2", "t3"} {
if err := taskRepo.Insert(ctx, sampleTask(id, "job-lbj")); err != nil {
t.Fatalf("Insert %s: %v", id, err)
}
}
// Insert a task for a different job to ensure filtering works.
insertJob(t, jobRepo, ctx, "job-other", "beta")
if err := taskRepo.Insert(ctx, sampleTask("t-other", "job-other")); err != nil {
t.Fatalf("Insert t-other: %v", err)
}
tasks, err := taskRepo.ListByJob(ctx, "job-lbj")
if err != nil {
t.Fatalf("ListByJob: %v", err)
}
if len(tasks) != 3 {
t.Fatalf("ListByJob: got %d tasks, want 3", len(tasks))
}
for _, tk := range tasks {
if tk.JobID != "job-lbj" {
t.Errorf("ListByJob returned task with job_id=%q", tk.JobID)
}
}
}
func TestTaskRepo_UpdateRunning(t *testing.T) {
_, jobRepo, taskRepo, cleanup := openFullTestDB(t)
defer cleanup()
ctx := context.Background()
insertJob(t, jobRepo, ctx, "job-run", "alpha")
if err := taskRepo.Insert(ctx, sampleTask("task-run", "job-run")); err != nil {
t.Fatalf("Insert: %v", err)
}
if err := taskRepo.UpdateRunning(ctx, "task-run", 4242); err != nil {
t.Fatalf("UpdateRunning: %v", err)
}
got, _ := taskRepo.Get(ctx, "task-run")
if got.PID != 4242 {
t.Errorf("pid = %d, want 4242", got.PID)
}
if got.Status != model.TaskStatusRunning {
t.Errorf("status = %q, want running", got.Status)
}
if got.StartedAt == nil {
t.Errorf("started_at should be set after UpdateRunning")
}
}
func TestTaskRepo_UpdateDone(t *testing.T) {
_, jobRepo, taskRepo, cleanup := openFullTestDB(t)
defer cleanup()
ctx := context.Background()
insertJob(t, jobRepo, ctx, "job-done", "alpha")
if err := taskRepo.Insert(ctx, sampleTask("task-done", "job-done")); err != nil {
t.Fatalf("Insert: %v", err)
}
cases := []struct {
name string
exitCode int
want model.TaskStatus
}{
{"complete", 0, model.TaskStatusComplete},
{"failed", 1, model.TaskStatusFailed},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
id := "task-done-" + tc.name
if err := taskRepo.Insert(ctx, sampleTask(id, "job-done")); err != nil {
t.Fatalf("Insert: %v", err)
}
if err := taskRepo.UpdateDone(ctx, id, tc.exitCode, "stdout-data", "stderr-data"); err != nil {
t.Fatalf("UpdateDone: %v", err)
}
got, _ := taskRepo.Get(ctx, id)
if got.Status != tc.want {
t.Errorf("status = %q, want %q", got.Status, tc.want)
}
if got.ExitCode != tc.exitCode {
t.Errorf("exit_code = %d, want %d", got.ExitCode, tc.exitCode)
}
if got.Stdout != "stdout-data" {
t.Errorf("stdout = %q", got.Stdout)
}
if got.Stderr != "stderr-data" {
t.Errorf("stderr = %q", got.Stderr)
}
if got.EndedAt == nil {
t.Errorf("ended_at should be set after UpdateDone")
}
})
}
}
func TestTaskRepo_UpdateKilled(t *testing.T) {
_, jobRepo, taskRepo, cleanup := openFullTestDB(t)
defer cleanup()
ctx := context.Background()
insertJob(t, jobRepo, ctx, "job-kill", "alpha")
if err := taskRepo.Insert(ctx, sampleTask("task-kill", "job-kill")); err != nil {
t.Fatalf("Insert: %v", err)
}
if err := taskRepo.UpdateKilled(ctx, "task-kill"); err != nil {
t.Fatalf("UpdateKilled: %v", err)
}
got, _ := taskRepo.Get(ctx, "task-kill")
if got.Status != model.TaskStatusKilled {
t.Errorf("status = %q, want killed", got.Status)
}
if got.EndedAt == nil {
t.Errorf("ended_at should be set after UpdateKilled")
}
}
func TestTaskRepo_ListRecent(t *testing.T) {
_, jobRepo, taskRepo, cleanup := openFullTestDB(t)
defer cleanup()
ctx := context.Background()
insertJob(t, jobRepo, ctx, "job-recent", "alpha")
for i := 0; i < 5; i++ {
id := "task-recent-" + string(rune('a'+i))
if err := taskRepo.Insert(ctx, sampleTask(id, "job-recent")); err != nil {
t.Fatalf("Insert %s: %v", id, err)
}
}
// limit=3
tasks, err := taskRepo.ListRecent(ctx, 3)
if err != nil {
t.Fatalf("ListRecent(3): %v", err)
}
if len(tasks) != 3 {
t.Errorf("ListRecent(3): got %d, want 3", len(tasks))
}
// limit<=0 → defaults to 100
all, err := taskRepo.ListRecent(ctx, 0)
if err != nil {
t.Fatalf("ListRecent(0): %v", err)
}
if len(all) != 5 {
t.Errorf("ListRecent(0): got %d, want 5 (default limit 100)", len(all))
}
// limit negative
neg, err := taskRepo.ListRecent(ctx, -1)
if err != nil {
t.Fatalf("ListRecent(-1): %v", err)
}
if len(neg) != 5 {
t.Errorf("ListRecent(-1): got %d, want 5", len(neg))
}
}
func TestTaskRepo_ListByJob_Empty(t *testing.T) {
_, _, taskRepo, cleanup := openFullTestDB(t)
defer cleanup()
ctx := context.Background()
tasks, err := taskRepo.ListByJob(ctx, "nope")
if err != nil {
t.Fatalf("ListByJob: %v", err)
}
if len(tasks) != 0 {
t.Errorf("ListByJob(empty): got %d, want 0", len(tasks))
}
}
func insertJob(t *testing.T, repo *JobRepo, ctx context.Context, id, name string) {
t.Helper()
if err := repo.Insert(ctx, &model.Job{
+127
View File
@@ -101,6 +101,133 @@ func TestNodeRepo_Delete(t *testing.T) {
}
}
func TestNodeRepo_DeleteMissing(t *testing.T) {
repo, cleanup := openTestDB(t)
defer cleanup()
ctx := context.Background()
if err := repo.Delete(ctx, "ghost"); err != ErrNotFound {
t.Errorf("Delete(ghost) = %v, want ErrNotFound", err)
}
}
func TestNodeRepo_UpdateStateMissing(t *testing.T) {
repo, cleanup := openTestDB(t)
defer cleanup()
ctx := context.Background()
if err := repo.UpdateState(ctx, "ghost", model.NodeStateLeft); err != ErrNotFound {
t.Errorf("UpdateState(ghost) = %v, want ErrNotFound", err)
}
}
func TestNodeRepo_UpdateLastSeenAndOSMissing(t *testing.T) {
repo, cleanup := openTestDB(t)
defer cleanup()
ctx := context.Background()
if err := repo.UpdateLastSeenAndOS(ctx, "ghost", "ubuntu"); err != ErrNotFound {
t.Errorf("UpdateLastSeenAndOS(ghost) = %v, want ErrNotFound", err)
}
}
func TestNodeRepo_GetMissing(t *testing.T) {
repo, cleanup := openTestDB(t)
defer cleanup()
ctx := context.Background()
if _, err := repo.Get(ctx, "ghost"); err != ErrNotFound {
t.Errorf("Get(ghost) = %v, want ErrNotFound", err)
}
}
func TestNodeRepo_InsertDefaults(t *testing.T) {
repo, cleanup := openTestDB(t)
defer cleanup()
ctx := context.Background()
// Insert with zero JoinedAt/LastSeen and empty State — defaults apply.
n := &model.Node{ID: "defaults-1", Name: "d", Address: "addr"}
if err := repo.Insert(ctx, n); err != nil {
t.Fatalf("Insert: %v", err)
}
if n.JoinedAt.IsZero() {
t.Errorf("Insert did not fill JoinedAt")
}
if n.LastSeen.IsZero() {
t.Errorf("Insert did not fill LastSeen")
}
if n.State != model.NodeStateReady {
t.Errorf("Insert default state = %q, want ready", n.State)
}
}
func TestNodeRepo_MetadataRoundTrip(t *testing.T) {
repo, cleanup := openTestDB(t)
defer cleanup()
ctx := context.Background()
n := &model.Node{
ID: "meta-1",
Name: "meta",
Address: "addr",
JoinedAt: time.Now().UTC(),
LastSeen: time.Now().UTC(),
Metadata: map[string]string{"arch": "amd64", "kernel": "6.1"},
}
if err := repo.Insert(ctx, n); err != nil {
t.Fatalf("Insert: %v", err)
}
got, err := repo.Get(ctx, "meta-1")
if err != nil {
t.Fatalf("Get: %v", err)
}
if got.Metadata["arch"] != "amd64" {
t.Errorf("metadata[arch] = %q, want amd64", got.Metadata["arch"])
}
if got.Metadata["kernel"] != "6.1" {
t.Errorf("metadata[kernel] = %q, want 6.1", got.Metadata["kernel"])
}
}
func TestNodeRepo_ListEmpty(t *testing.T) {
repo, cleanup := openTestDB(t)
defer cleanup()
ctx := context.Background()
nodes, err := repo.List(ctx)
if err != nil {
t.Fatalf("List: %v", err)
}
if len(nodes) != 0 {
t.Errorf("List(empty): got %d, want 0", len(nodes))
}
}
func TestNodeRepo_GetByNameMultiplePicksOldest(t *testing.T) {
repo, cleanup := openTestDB(t)
defer cleanup()
ctx := context.Background()
older := time.Now().UTC().Add(-1 * time.Hour)
newer := time.Now().UTC()
_ = repo.Insert(ctx, &model.Node{
ID: "n-old", Name: "dup", Address: "a",
JoinedAt: older, LastSeen: older,
})
_ = repo.Insert(ctx, &model.Node{
ID: "n-new", Name: "dup", Address: "a",
JoinedAt: newer, LastSeen: newer,
})
got, err := repo.GetByName(ctx, "dup")
if err != nil {
t.Fatalf("GetByName: %v", err)
}
if got.ID != "n-old" {
t.Errorf("GetByName = %q, want oldest n-old (ORDER BY joined_at ASC)", got.ID)
}
}
func TestNodeRepo_KindOS_RoundTrip(t *testing.T) {
repo, cleanup := openTestDB(t)
defer cleanup()
+31
View File
@@ -2,8 +2,11 @@ package transport
import (
"bytes"
"crypto/x509"
"encoding/pem"
"errors"
"log/slog"
"os"
"strings"
"testing"
)
@@ -93,6 +96,34 @@ func TestLogHandshakeFromCert_NilCert(t *testing.T) {
}
}
func TestLogHandshakeFromCert_WithCert(t *testing.T) {
var buf bytes.Buffer
log := newTestLogger(&buf)
dir := t.TempDir()
certPath, _, _ := generateTestCerts(t, dir, "localhost")
certPEM, err := os.ReadFile(certPath)
if err != nil {
t.Fatalf("read cert: %v", err)
}
block, _ := pem.Decode(certPEM)
if block == nil {
t.Fatal("pem.Decode: no cert block")
}
leaf, err := x509.ParseCertificate(block.Bytes)
if err != nil {
t.Fatalf("ParseCertificate: %v", err)
}
LogHandshakeFromCert(log, "peer-cert", leaf)
out := buf.String()
if !strings.Contains(out, "result=ok") {
t.Errorf("expected result=ok: %s", out)
}
expectedFP := FingerprintOfCert(leaf)
if !strings.Contains(out, "cert_fp="+expectedFP) {
t.Errorf("expected cert_fp=%s in: %s", expectedFP, out)
}
}
func TestFingerprintOfCert_Nil(t *testing.T) {
if got := FingerprintOfCert(nil); got != "" {
t.Errorf("FingerprintOfCert(nil) = %q, want empty", got)
+37
View File
@@ -112,6 +112,43 @@ func TestRetryContextCancel(t *testing.T) {
}
}
func TestIdempotencyStoreSweep(t *testing.T) {
s := NewIdempotencyStore()
s.Put("live-1", "job-1")
s.entries["expired"] = dedupeEntry{
key: "expired",
jobID: "old-job",
expiresAt: time.Now().Add(-1 * time.Minute),
}
s.Sweep()
if _, ok := s.entries["expired"]; ok {
t.Error("Sweep did not remove expired entry")
}
if _, ok := s.entries["live-1"]; !ok {
t.Error("Sweep removed live entry")
}
}
func TestIdempotencyStorePutEmpty(t *testing.T) {
s := NewIdempotencyStore()
s.Put("", "job-1")
s.Put("k1", "")
if _, ok := s.Get("k1"); ok {
t.Error("Put with empty jobID should not store")
}
if _, ok := s.Get(""); ok {
t.Error("Get with empty key should return false")
}
}
func TestWithIdempotencyKeyEmpty(t *testing.T) {
ctx := context.Background()
got := WithIdempotencyKey(ctx, "")
if got != ctx {
t.Error("WithIdempotencyKey with empty key should return ctx unchanged")
}
}
func TestIsTransient(t *testing.T) {
cases := []struct {
err error
+203
View File
@@ -0,0 +1,203 @@
package transport
import (
"context"
"errors"
"testing"
"time"
)
func TestDefaultRetryPolicy(t *testing.T) {
p := DefaultRetryPolicy()
if p.Initial != RetryInitial {
t.Errorf("Initial = %v, want %v", p.Initial, RetryInitial)
}
if p.Max != RetryMax {
t.Errorf("Max = %v, want %v", p.Max, RetryMax)
}
if p.MaxAttempts != RetryMaxAttempts {
t.Errorf("MaxAttempts = %d, want %d", p.MaxAttempts, RetryMaxAttempts)
}
}
func TestRetrySucceedsFirstAttempt(t *testing.T) {
calls := 0
got, err := Do(context.Background(), DefaultRetryPolicy(),
func(_ context.Context, attempt int) (string, bool, error) {
calls++
if attempt != 1 {
t.Errorf("attempt = %d, want 1", attempt)
}
return "ok", true, nil
})
if err != nil {
t.Fatalf("Do: %v", err)
}
if got != "ok" {
t.Errorf("got = %q, want ok", got)
}
if calls != 1 {
t.Errorf("calls = %d, want 1", calls)
}
}
func TestRetryIdempotentVerbRetries(t *testing.T) {
calls := 0
_, err := Do(context.Background(), DefaultRetryPolicy(),
func(_ context.Context, _ int) (string, bool, error) {
calls++
return "", true, errors.New("connection refused")
})
if err == nil {
t.Fatal("expected error after exhausting attempts")
}
if calls != RetryMaxAttempts {
t.Errorf("calls = %d, want %d", calls, RetryMaxAttempts)
}
}
func TestRetryWithIdempotencyKeyRetries(t *testing.T) {
calls := 0
ctx := WithIdempotencyKey(context.Background(), "key-1")
_, err := Do(ctx, DefaultRetryPolicy(),
func(_ context.Context, _ int) (string, bool, error) {
calls++
return "", false, errors.New("i/o timeout")
})
if err == nil {
t.Fatal("expected error after exhausting attempts")
}
if calls != RetryMaxAttempts {
t.Errorf("calls = %d, want %d (idempotency key enables retry)", calls, RetryMaxAttempts)
}
}
func TestRetryMaxAttemptsReached(t *testing.T) {
p := RetryPolicy{Initial: time.Millisecond, Max: 5 * time.Millisecond, MaxAttempts: 3}
calls := 0
_, err := Do(context.Background(), p,
func(_ context.Context, _ int) (string, bool, error) {
calls++
return "", true, errors.New("EOF")
})
if err == nil {
t.Fatal("expected error")
}
if !IsTransient(err) {
t.Errorf("expected transient error, got %v", err)
}
if calls != 3 {
t.Errorf("calls = %d, want 3", calls)
}
}
func TestRetryZeroMaxAttemptsDefaults(t *testing.T) {
calls := 0
p := RetryPolicy{}
_, err := Do(context.Background(), p,
func(_ context.Context, _ int) (string, bool, error) {
calls++
return "ok", true, nil
})
if err != nil {
t.Fatalf("Do: %v", err)
}
if calls != 1 {
t.Errorf("calls = %d, want 1", calls)
}
}
func TestRetryNonTransientIdempotentRetries(t *testing.T) {
calls := 0
_, err := Do(context.Background(), DefaultRetryPolicy(),
func(_ context.Context, _ int) (string, bool, error) {
calls++
return "", true, errors.New("invalid spec")
})
if err == nil {
t.Fatal("expected error")
}
if calls != RetryMaxAttempts {
t.Errorf("calls = %d, want %d (non-transient idempotent still retries)", calls, RetryMaxAttempts)
}
}
func TestRetryTransientNonIdempotentNoKeyBails(t *testing.T) {
calls := 0
_, err := Do(context.Background(), DefaultRetryPolicy(),
func(_ context.Context, _ int) (string, bool, error) {
calls++
return "", false, errors.New("connection refused")
})
if err == nil {
t.Fatal("expected error")
}
if calls != 1 {
t.Errorf("calls = %d, want 1 (transient+non-idempotent+no key = bail)", calls)
}
}
func TestRetryContextCancelledMidBackoff(t *testing.T) {
ctx, cancel := context.WithCancel(context.Background())
p := RetryPolicy{Initial: 100 * time.Millisecond, Max: time.Second, MaxAttempts: 5}
calls := 0
go func() {
time.Sleep(20 * time.Millisecond)
cancel()
}()
_, err := Do(ctx, p,
func(_ context.Context, _ int) (string, bool, error) {
calls++
return "", true, errors.New("connection refused")
})
if err == nil {
t.Fatal("expected error")
}
if !errors.Is(err, context.Canceled) {
t.Errorf("expected context.Canceled, got %v", err)
}
}
func TestBackoffGrowsExponentially(t *testing.T) {
initial := 10 * time.Millisecond
max := 1 * time.Second
d1 := backoff(initial, max, 1)
d2 := backoff(initial, max, 2)
d3 := backoff(initial, max, 3)
if d1 < 0 {
t.Errorf("backoff(1) = %v, want >= 0", d1)
}
if d2 < d1 {
t.Errorf("backoff(2)=%v < backoff(1)=%v (should grow)", d2, d1)
}
if d3 < d2 {
t.Errorf("backoff(3)=%v < backoff(2)=%v (should grow)", d3, d2)
}
}
func TestBackoffCapsAtMax(t *testing.T) {
initial := 100 * time.Millisecond
max := 200 * time.Millisecond
d := backoff(initial, max, 10)
if d > max+max/2 {
t.Errorf("backoff(10) = %v, want <= ~max=%v", d, max)
}
}
func TestContains(t *testing.T) {
cases := []struct {
s, sub string
want bool
}{
{"hello world", "world", true},
{"hello", "xyz", false},
{"hello", "", true},
{"", "", true},
{"abc", "abcd", false},
}
for _, c := range cases {
if got := contains(c.s, c.sub); got != c.want {
t.Errorf("contains(%q, %q) = %v, want %v", c.s, c.sub, got, c.want)
}
}
}