Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 77 additions & 7 deletions internal/schemas/generator/json.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"io/fs"
"maps"
"path/filepath"
"slices"
"strings"

"github.com/invopop/jsonschema"
Expand All @@ -35,6 +36,7 @@ import (
"github.com/crossplane/crossplane-runtime/v2/pkg/errors"

devv1alpha1 "github.com/crossplane/cli/v2/apis/dev/v1alpha1"
"github.com/crossplane/cli/v2/internal/crd"
"github.com/crossplane/cli/v2/internal/schemas/runner"
)

Expand Down Expand Up @@ -126,24 +128,58 @@ func ToJSONSchema(s any, gvk runtimeSchema.GroupVersionKind) (*jsonschema.Schema
}

// CRDsToJSONSchemas converts CRD OpenAPI v3 schemas to marshaled JSON Schemas.
// Referenced component schemas are embedded as $defs so each output is a self-contained document.
func CRDsToJSONSchemas(crds []*extv1.CustomResourceDefinition) ([]CRDJSONSchema, error) {
var results []CRDJSONSchema

for _, crd := range crds {
group := crd.Spec.Group
kind := crd.Spec.Names.Kind
for _, c := range crds {
oapis, err := crd.ToOpenAPI(c)
if err != nil {
return nil, errors.Wrapf(err, "cannot convert CRD %q to OpenAPI", c.GetName())
Comment thread
adamwg marked this conversation as resolved.
}

group := c.Spec.Group
kind := c.Spec.Names.Kind
groupParts := strings.Split(group, ".")
slices.Reverse(groupParts)
reverseGroup := strings.Join(groupParts, ".")

for _, ver := range c.Spec.Versions {
oapi, ok := oapis[ver.Name]
if !ok {
continue
}

for _, ver := range crd.Spec.Versions {
if ver.Schema == nil || ver.Schema.OpenAPIV3Schema == nil {
resourceName := reverseGroup + "." + ver.Name + "." + kind
schema, ok := oapi.Components.Schemas[resourceName]
if !ok {
continue
}

rewriteComponentRefs(schema)

gvk := runtimeSchema.GroupVersionKind{Group: group, Version: ver.Name, Kind: kind}
s, err := ToJSONSchema(ver.Schema.OpenAPIV3Schema, gvk)
s, err := ToJSONSchema(schema, gvk)
if err != nil {
return nil, errors.Wrapf(err, "cannot convert schema for %s/%s %s", group, ver.Name, kind)
}

s.Definitions = make(jsonschema.Definitions)
for name, comp := range oapi.Components.Schemas {
// Skip the resource itself (already root) and List schemas
// generated by BuildOpenAPIV3 that $ref the root resource,
// which would create unresolvable references in $defs.
if name == resourceName || strings.HasSuffix(name, "List") {
continue
}
rewriteComponentRefs(comp)
defSchema, err := ToJSONSchema(comp, runtimeSchema.GroupVersionKind{})
if err != nil {
return nil, errors.Wrapf(err, "cannot convert $defs schema %s", name)
}
s.Definitions[name] = defSchema
}

data, err := json.MarshalIndent(s, "", " ")
if err != nil {
return nil, errors.Wrapf(err, "cannot marshal JSON Schema for %s/%s %s", group, ver.Name, kind)
Expand All @@ -162,11 +198,45 @@ func CRDsToJSONSchemas(crds []*extv1.CustomResourceDefinition) ([]CRDJSONSchema,
return results, nil
}

// rewriteComponentRefs rewrites $ref paths from #/components/schemas/X to
// #/$defs/X so they resolve within the same JSON Schema document.
func rewriteComponentRefs(s *spec.Schema) {
if ref := s.Ref.String(); ref != "" {
if after, ok := strings.CutPrefix(ref, "#/components/schemas/"); ok {
s.Ref = spec.MustCreateRef("#/$defs/" + after)
}
return
}

for name, prop := range s.Properties {
rewriteComponentRefs(&prop)
s.Properties[name] = prop
}
if s.Items != nil && s.Items.Schema != nil {
rewriteComponentRefs(s.Items.Schema)
}
if s.AdditionalProperties != nil && s.AdditionalProperties.Schema != nil {
rewriteComponentRefs(s.AdditionalProperties.Schema)
}
for i := range s.AllOf {
rewriteComponentRefs(&s.AllOf[i])
}
for i := range s.AnyOf {
rewriteComponentRefs(&s.AnyOf[i])
}
for i := range s.OneOf {
rewriteComponentRefs(&s.OneOf[i])
}
if s.Not != nil {
rewriteComponentRefs(s.Not)
}
}

// mutateJSONSchema applies YAML language server compatibility fixes to a JSON
// Schema: sets additionalProperties to false on object types and rewrites
// component $ref paths to file references.
func mutateJSONSchema(s *jsonschema.Schema) *jsonschema.Schema {
if s.Type == "object" && s.AdditionalProperties == nil {
if s.Type == "object" && s.AdditionalProperties == nil && s.Properties.Len() > 0 {
s.AdditionalProperties = jsonschema.FalseSchema
}

Expand Down
28 changes: 28 additions & 0 deletions internal/schemas/generator/json_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,34 @@ func TestGenerateFromCRD(t *testing.T) {
}
}

func TestMutateJSONSchema(t *testing.T) {
t.Run("ObjectWithProperties", func(t *testing.T) {
s := &jsonschema.Schema{
Type: "object",
}
s.Properties = jsonschema.NewProperties()
s.Properties.Set("name", &jsonschema.Schema{Type: "string"})

mutateJSONSchema(s)

if s.AdditionalProperties != jsonschema.FalseSchema {
t.Error("expected additionalProperties to be false for object with properties")
}
})

t.Run("EmptyObject", func(t *testing.T) {
s := &jsonschema.Schema{
Type: "object",
}

mutateJSONSchema(s)

if s.AdditionalProperties != nil {
t.Error("expected additionalProperties to remain nil for empty object")
}
})
}

func TestGenerateFromOpenAPI(t *testing.T) {
inputFS := afero.NewBasePathFs(afero.FromIOFS{FS: testdataJSONFS}, "testdata")
schemaFS, err := jsonGenerator{}.GenerateFromOpenAPI(t.Context(), inputFS, nil)
Expand Down
Loading