Files
o11y-foundry/api/v1alpha1/deployment_platform.go
PandeyandGitHub 383bc9d2de feat(v1alpha1): jsonschema validation for casting (#107)
## Summary
- Wires schema-based validation of `casting.yaml` at config load time.
Schema is generated from the Go types via `swaggest/jsonschema-go`,
embedded as `api/v1alpha1/schema.json`, and validated post-merge with
`google/jsonschema-go`.
- Adds field-level rules: `required`, `enum`, `pattern` (DNS-1123 name,
JSON Pointer paths, OCI image), `minimum`/`minLength`/`minItems` on the
relevant fields. `additionalProperties:false` is set on every nested
type for the published schema.
- Replaces the loose string `Platform` / `Mode` / `Flavor` on
`TypeDeployment` with typed enums following the existing `*Kind`
pattern. Bad values now fail at unmarshal with a clear "invalid
deployment …" message.
- Drops `InfrastructureProvider` in favor of `Platform` — the cloud
subset (aws, gcp, azure) drives the Terraform IaC pipeline directly.
`ResolveProvider` collapses `PlatformECS → PlatformAWS`.
- Side cleanups bundled here: typed errors in `internal/errors` with
stacktrace capture (used by yamlconfig to wrap validation failures as
`TypeInvalidInput`), and removal of the custom pretty slog handler in
`internal/instrumentation` in favor of `slog.NewJSONHandler`.

## Test plan
- [ ] `make gen-schemas` is idempotent (CI's `schemas` job stays green).
- [ ] `go test ./...` passes locally.
- [ ] Every committed example casting (`docs/examples/**/casting.yaml`,
`docs/standalone/casting.yaml`) loads without error.
- [ ] Negative cases at config load: bad `apiVersion`, missing required
fields, unknown enum values for `kind` / `mode` / `flavor` / `platform`
/ patch `op`, non-JSON-Pointer patch paths, negative `replicas`,
`shards: 0`, malformed image refs — each fails with a `TypeInvalidInput`
error pointing at the offending location.
- [ ] `foundryctl forge` against
`docs/examples/docker/compose/casting.yaml` still produces the expected
pours.
2026-05-01 09:04:53 +05:30

98 lines
2.0 KiB
Go

package v1alpha1
import (
"encoding/json"
"errors"
"fmt"
"github.com/swaggest/jsonschema-go"
"go.yaml.in/yaml/v3"
)
var _ yaml.Marshaler = (*Platform)(nil)
var _ yaml.Unmarshaler = (*Platform)(nil)
var _ json.Marshaler = (*Platform)(nil)
var _ json.Unmarshaler = (*Platform)(nil)
var _ fmt.Stringer = (*Platform)(nil)
var _ jsonschema.Enum = (*Platform)(nil)
var (
PlatformRender Platform = Platform{s: "render"}
PlatformCoolify Platform = Platform{s: "coolify"}
PlatformRailway Platform = Platform{s: "railway"}
PlatformECS Platform = Platform{s: "ecs"}
PlatformAWS Platform = Platform{s: "aws"}
PlatformGCP Platform = Platform{s: "gcp"}
PlatformAzure Platform = Platform{s: "azure"}
)
type Platform struct {
s string
}
func (platform Platform) String() string {
return platform.s
}
func Platforms() []Platform {
return []Platform{
PlatformRender,
PlatformCoolify,
PlatformRailway,
PlatformECS,
PlatformAWS,
PlatformGCP,
PlatformAzure,
}
}
func (platform Platform) MarshalJSON() ([]byte, error) {
return json.Marshal(platform.String())
}
func (platform *Platform) UnmarshalJSON(text []byte) error {
var str string
if err := json.Unmarshal(text, &str); err != nil {
return err
}
return platform.UnmarshalText([]byte(str))
}
func (platform *Platform) UnmarshalText(text []byte) error {
for _, available := range Platforms() {
if available.String() == string(text) {
*platform = available
return nil
}
}
if len(text) == 0 {
*platform = Platform{s: ""}
return nil
}
return errors.New("invalid deployment platform: " + string(text))
}
func (platform Platform) MarshalText() ([]byte, error) {
return []byte(platform.String()), nil
}
func (platform *Platform) UnmarshalYAML(node *yaml.Node) error {
return platform.UnmarshalText([]byte(node.Value))
}
func (platform Platform) MarshalYAML() (any, error) {
return platform.String(), nil
}
func (platform Platform) Enum() []any {
platforms := []any{}
for _, platform := range Platforms() {
platforms = append(platforms, platform.String())
}
return platforms
}