mirror of
https://github.com/hanzoai/o11y-foundry.git
synced 2026-10-30 18:26:45 +00:00
PandeyandGitHub
08b249183f
## Summary Reshape foundryctl's output contract so it composes with agents and shell pipelines. Three changes that fall out of the same observation: **stdout, stderr, and exit codes should be a stable contract — today they're conflated.** - **Logger to stderr, silent by default.** `instrumentation.NewLogger` writes to `os.Stderr` (was `os.Stdout`) and uses `slog.DiscardHandler` unless `--debug` is set. Matches helm/aws CLI convention. stdout is now reserved for command results. - **Typed exit codes.** `internal/errors.typ` carries a `code int` field; `errors.ExitCode(err)` walks the wrap chain via `errors.As` and returns a deterministic code: `InvalidInput=2, NotFound=3, Unsupported=4, Internal=5, Fatal=6`, untyped=1, nil=0. Compact 1-6 scheme rather than sysexits.h because sysexits would collapse `Internal` and `Fatal` into the same `EX_SOFTWARE (70)`, losing a distinction we care about (Fatal = recovered panic; Internal = expected-but-failed path). `cmd/foundryctl/main.go` now exits with `errors.ExitCode(err)`. - **`fmt.Errorf` forbidden by lint.** New forbidigo rules in `.golangci.yml` ban `fmt.Errorf` and `fmt.Print*` / `print` / `println`. 168 call sites across 38 files converted to `errors.Newf` / `errors.Wrapf` with contextually-chosen types. Narrow exception for `internal/errors/error_test.go` so the ExitCode wrap-chain test stays authentic. Sites of note for review: - `internal/errors/type.go` — exit code mapping table (one source of truth) - `internal/errors/error.go` — `ExitCode(err)` helper - `internal/instrumentation/logger.go` — `slog.DiscardHandler` default - `.golangci.yml` — forbidigo config + the single narrow test exclusion ## Test plan - [x] `go build ./...` - [x] `go test ./...` (all packages pass; new `TestExitCode` covers 9 cases: nil, untyped, each typed, fmt.Errorf-wrapped, foundry-Wrapf-wrapped) - [x] `golangci-lint run ./...` — 0 issues - [x] Manual: `foundryctl forge` on a missing file exits non-zero and emits nothing on stdout (logs hidden); `--debug` emits JSON on stderr only - [x] Manual: end-to-end forge + cast against the docker/compose flavor still produces a healthy stack
41 lines
1.1 KiB
Go
41 lines
1.1 KiB
Go
package errors
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
)
|
|
|
|
func TestExitCode(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
err error
|
|
expected int
|
|
}{
|
|
{name: "Nil_Zero", err: nil, expected: 0},
|
|
{name: "Untyped_One", err: fmt.Errorf("plain error"), expected: 1},
|
|
{name: "InvalidInput_Two", err: Newf(TypeInvalidInput, "bad input"), expected: 2},
|
|
{name: "NotFound_Three", err: Newf(TypeNotFound, "missing"), expected: 3},
|
|
{name: "Unsupported_Four", err: Newf(TypeUnsupported, "no support"), expected: 4},
|
|
{name: "Internal_Five", err: Newf(TypeInternal, "internal"), expected: 5},
|
|
{name: "Fatal_Six", err: Newf(TypeFatal, "fatal"), expected: 6},
|
|
{
|
|
name: "WrappedWithFmtErrorf_WalksChain",
|
|
err: fmt.Errorf("outer: %w", Newf(TypeNotFound, "inner")),
|
|
expected: 3,
|
|
},
|
|
{
|
|
name: "WrappedWithFoundryWrapf_PreservesOuterType",
|
|
err: Wrapf(Newf(TypeNotFound, "inner"), TypeUnsupported, "outer"),
|
|
expected: 4,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
if got := ExitCode(tt.err); got != tt.expected {
|
|
t.Errorf("ExitCode() = %d, want %d", got, tt.expected)
|
|
}
|
|
})
|
|
}
|
|
}
|