Jon Chery
fc94326b0e
P00 — Re-architecture Foundation (deprecation/migration/test-infra/persona/docs). Deprecation sweep (REQ-068, REQ-072, REQ-089): - Add // Deprecated: doc comments to internal/daemon (R-001), internal/transport (REQ-073), internal/security/ca.go+csr.go (D-101/REQ-076), internal/engine/ dispatcher.go+peer.go (CLI-side scheduler), internal/cli/daemon.go. - orca daemon emits slog.Warn deprecation banner on every run (ungated); fires R-001 + v0.10-P05 drain-and-stop + v0.10-P14 deletion. - orca cert and orca node join (mTLS path) emit deprecation warnings; proxmox SSH path (the v0.9 replacement) does not warn. - Add --no-deprecation-warnings global flag on root command (PersistentPreRunE) for orca upgrade migrations. - 12 new daemon/cert/node deprecation tests in internal/cli/daemon_test.go (cli coverage 81.9%, warnDeprecated 100%). - Add DEPRECATED banners to v0.8 sections of ARCHITECTURE.md (verified the v0.9 supersession section + Supersession Table from prior turn are present). Bash tooling gate (grill C-06, C-15, C-16, C-17, C-18): - scripts/tests/test_helper.bash + example_test.bash — bats framework + helpers. - scripts/lib/orca-log.sh — slog-compatible JSON logging to syslog (C-17). - scripts/orca-verify-render.sh — render-contract validator skeleton (C-16). - scripts/tests/orca-log_test.bash + orca-verify-render_test.bash — 20 bats tests total (happy + failure paths per C-15). - .shellcheckrc — project shellcheck config. - Makefile: test-bash + lint-bash targets (graceful skip if tools missing); wired into test + lint targets. - internal/emit/contract.go + contract_test.go — versioned JSON render contract (orca.emit/v1) between Go emitters and bash appliers (C-16). - .ciagent/BASH_CAPABILITY_MAP_v0.9.md — maps shipped internal/transport capabilities to bash-side equivalents or accepted drops (C-18). - D-186 recorded in PROJECT.md: bash exempt from Go coverage gate; compensating control is bats + shellcheck + shfmt (C-06). verify-reqs: 90 requirements consistent. Build/test/lint/fmt all green. 20 bats tests pass. Go tests pass. No v0.8 code deleted — only marked deprecated (deletion deferred to v0.10-P14 per REQ-090 dual-write window). ---ci--- project: orca phase: P00 milestone: v0.9 status: execute ---/ci---
39 lines
1.4 KiB
Markdown
39 lines
1.4 KiB
Markdown
# Bash Testing Policy (grill C-15)
|
|
|
|
Every bash script under `scripts/` MUST have at least one bats test covering
|
|
the happy path and one covering the failure path. This is the compensating
|
|
control for bash being exempt from the Go coverage gate (D-186).
|
|
|
|
## Framework
|
|
|
|
- **bats** — `bats scripts/tests/*.bash` runs all bash tests.
|
|
- **shellcheck** — `shellcheck scripts/*.sh scripts/lib/*.sh scripts/tests/*.bash` static analysis.
|
|
- **shfmt** — `shfmt -d scripts/` formatting check (optional; skip if not installed).
|
|
|
|
## Install (if missing)
|
|
|
|
```bash
|
|
# bats
|
|
npm install -g bats # or: git clone https://github.com/bats-core/bats-core.git && ./bats-core/install.sh /usr/local
|
|
# shellcheck
|
|
apt-get install -y shellcheck
|
|
# shfmt (optional)
|
|
mvdan.cc/sh (go install mvdan.cc/sh/v3/cmd/shfmt@latest)
|
|
```
|
|
|
|
## Running
|
|
|
|
```bash
|
|
make test-bash # runs bats (skips gracefully if bats missing)
|
|
make lint-bash # runs shellcheck + shfmt (skips gracefully if missing)
|
|
make test # runs both Go + bash tests
|
|
make lint # runs both Go + bash lint
|
|
```
|
|
|
|
## Test file convention
|
|
|
|
- Test files live in `scripts/tests/<script-name>_test.bash`.
|
|
- Source `load test_helper` at the top of every test file.
|
|
- Happy path: `@test "<script> happy path" { ... }`
|
|
- Failure path: `@test "<script> failure path" { ... }`
|
|
- Use `run <command>` + `assert_status`/`assert_contains`/`assert_not_contains` from test_helper. |