mirror of
https://github.com/hanzoai/o11y-foundry.git
synced 2026-11-02 14:03:05 +00:00
## 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
62 lines
2.1 KiB
Go
62 lines
2.1 KiB
Go
package infrastructure
|
|
|
|
import (
|
|
"github.com/signoz/foundry/api/v1alpha1"
|
|
"github.com/signoz/foundry/internal/errors"
|
|
)
|
|
|
|
// ResolveProvider normalizes a deployment platform to the cloud platform that
|
|
// hosts it. Only the cloud platforms (aws, gcp, azure) and ECS resolve;
|
|
// managed platforms (render, coolify, railway) have no IaC backing.
|
|
func ResolveProvider(platform v1alpha1.Platform) (v1alpha1.Platform, error) {
|
|
switch platform {
|
|
case v1alpha1.PlatformAWS, v1alpha1.PlatformECS:
|
|
return v1alpha1.PlatformAWS, nil
|
|
case v1alpha1.PlatformGCP:
|
|
return v1alpha1.PlatformGCP, nil
|
|
case v1alpha1.PlatformAzure:
|
|
return v1alpha1.PlatformAzure, nil
|
|
case v1alpha1.Platform{}:
|
|
return v1alpha1.Platform{}, errors.Newf(errors.TypeInvalidInput, "no platform specified in deployment.platform: infrastructure generation requires aws, gcp, or azure")
|
|
default:
|
|
return v1alpha1.Platform{}, errors.Newf(errors.TypeUnsupported, "unsupported platform for infrastructure generation: %q (must be aws, gcp, azure, or ecs)", platform)
|
|
}
|
|
}
|
|
|
|
// ResolveComputeType derives the appropriate ComputeType from a cloud platform
|
|
// and deployment configuration. Users do not specify the compute type directly
|
|
// — foundry resolves it automatically using this matrix:
|
|
//
|
|
// AWS + kubernetes (any flavor) → EKS
|
|
// AWS + anything else → EC2
|
|
// GCP + kubernetes (any flavor) → GKE
|
|
// GCP + anything else → GCE
|
|
// Azure + kubernetes (any flavor) → AKS
|
|
// Azure + anything else → VM
|
|
func ResolveComputeType(provider v1alpha1.Platform, deployment v1alpha1.TypeDeployment) (ComputeType, error) {
|
|
isKubernetes := deployment.Mode == v1alpha1.ModeKubernetes
|
|
|
|
switch provider {
|
|
case v1alpha1.PlatformAWS:
|
|
if isKubernetes {
|
|
return ComputeTypeEKS, nil
|
|
}
|
|
return ComputeTypeEC2, nil
|
|
|
|
case v1alpha1.PlatformGCP:
|
|
if isKubernetes {
|
|
return ComputeTypeGKE, nil
|
|
}
|
|
return ComputeTypeGCE, nil
|
|
|
|
case v1alpha1.PlatformAzure:
|
|
if isKubernetes {
|
|
return ComputeTypeAKS, nil
|
|
}
|
|
return ComputeTypeVM, nil
|
|
|
|
default:
|
|
return ComputeType{}, errors.Newf(errors.TypeUnsupported, "unsupported infrastructure platform: %s", provider)
|
|
}
|
|
}
|