Files
orca/scripts/lib/orca-log.sh
T
Jon Chery fc94326b0e feat(P00): deprecation sweep + bash tooling gate + render contract + doc banners (v0.9 P00)
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---
2026-08-05 16:26:26 +00:00

32 lines
1.3 KiB
Bash

# orca-log.sh — structured slog-compatible JSON logging for bash scripts (C-17).
# Source this library from any orca bash script: `source scripts/lib/orca-log.sh`.
# Emits JSON to syslog via `logger`; falls back to stderr if `logger` is missing.
# Field set matches the Go audit log (REQ-006): ts, level, actor, action, resource, result, error.
ORCA_LOG_ACTOR="${ORCA_LOG_ACTOR:-spiffe://orca/cli/operator}"
# _orca_log_emit <level> <action> <resource> <result> [error]
_orca_log_emit() {
local level="$1" action="$2" resource="$3" result="$4" error="${5:-}"
local ts
ts="$(date -u +%Y-%m-%dT%H:%M:%S.%3NZ)"
# Build JSON with proper escaping of error field (escape backslash and quote).
local err_json=""
if [ -n "$error" ]; then
local esc_error
esc_error="${error//\\/\\\\}"
esc_error="${esc_error//\"/\\\"}"
err_json=",\"error\":\"$esc_error\""
fi
local line
line="{\"ts\":\"$ts\",\"level\":\"$level\",\"actor\":\"$ORCA_LOG_ACTOR\",\"action\":\"$action\",\"resource\":\"$resource\",\"result\":\"$result\"$err_json}"
if command -v logger >/dev/null 2>&1; then
logger -t orca "$line"
else
echo "$line" >&2
fi
}
orca_log_info() { _orca_log_emit "info" "$1" "$2" "$3" "${4:-}"; }
orca_log_warn() { _orca_log_emit "warn" "$1" "$2" "$3" "${4:-}"; }
orca_log_error() { _orca_log_emit "error" "$1" "$2" "$3" "${4:-}"; }