PandeyandGitHub
998092f8cd
## 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
78 lines
1.4 KiB
Go
78 lines
1.4 KiB
Go
package errors
|
|
|
|
import (
|
|
goerrors "errors"
|
|
"fmt"
|
|
"log/slog"
|
|
)
|
|
|
|
type base struct {
|
|
// t denotes the custom type of the error.
|
|
t typ
|
|
|
|
// info contains the error message
|
|
info string
|
|
|
|
// cause is the actual error which is being wrapped with a stacktrace and message information.
|
|
cause error
|
|
|
|
// s contains the stacktrace captured at error creation time.
|
|
stacktrace fmt.Stringer
|
|
}
|
|
|
|
func (b *base) Error() string {
|
|
if b.cause != nil {
|
|
return fmt.Sprintf("%s: %s", b.info, b.cause.Error())
|
|
}
|
|
|
|
return b.info
|
|
}
|
|
|
|
func (b *base) Unwrap() error {
|
|
return b.cause
|
|
}
|
|
|
|
func (b *base) WithStacktrace(stacktrace string) *base {
|
|
b.stacktrace = rawStacktrace(stacktrace)
|
|
return b
|
|
}
|
|
|
|
func (b *base) Stacktrace() string {
|
|
return b.stacktrace.String()
|
|
}
|
|
|
|
func Newf(t typ, info string, args ...any) *base {
|
|
return &base{
|
|
t: t,
|
|
info: fmt.Sprintf(info, args...),
|
|
cause: nil,
|
|
stacktrace: newStackTrace(),
|
|
}
|
|
}
|
|
|
|
func Wrapf(cause error, t typ, format string, args ...any) error {
|
|
return &base{
|
|
t: t,
|
|
info: fmt.Sprintf(format, args...),
|
|
cause: cause,
|
|
stacktrace: newStackTrace(),
|
|
}
|
|
}
|
|
|
|
func ExitCode(err error) int {
|
|
if err == nil {
|
|
return 0
|
|
}
|
|
|
|
var b *base
|
|
if goerrors.As(err, &b) {
|
|
return b.t.ExitCode()
|
|
}
|
|
|
|
return 1
|
|
}
|
|
|
|
func LogAttr(err error) slog.Attr {
|
|
return slog.GroupAttrs("exception", exceptionAttrs(ExceptionOf(err))...)
|
|
}
|