Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 Fix panic when using embedded type aliases #1089

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
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
11 changes: 11 additions & 0 deletions pkg/crd/schema.go
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,17 @@ func localNamedToSchema(ctx *schemaContext, ident *ast.Ident) *apiext.JSONSchema
Format: fmt,
}
}
// Handle embedded structs, they do not have a type name.
if _, isNamed := typeInfo.(*types.Named); !isNamed {
// TODO: Following uses deprecated "ident.Obj" so alternative solution is needed.
typeSpec, ok := ident.Obj.Decl.(*ast.TypeSpec)
if !ok {
ctx.pkg.AddError(loader.ErrFromNode(fmt.Errorf("unknown error"), ident))
return &apiext.JSONSchemaProps{}
}
return typeToSchema(ctx.ForInfo(&markers.TypeInfo{}), typeSpec.Type)
}

// NB(directxman12): if there are dot imports, this might be an external reference,
// so use typechecking info to get the actual object
typeNameInfo := typeInfo.(interface{ Obj() *types.TypeName }).Obj()
Expand Down
11 changes: 11 additions & 0 deletions pkg/crd/testdata/cronjob_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -372,6 +372,9 @@ type CronJobSpec struct {

// This tests that selectable field.
SelectableFieldString string `json:"selectableFieldString,omitempty"`

// This tests that embedded struct, which is an alias type, is handled correctly.
InlineAlias `json:",inline"`
}

type StringAlias = string
Expand All @@ -380,6 +383,14 @@ type StringAlias = string
// +kubebuilder:validation:MaxLength=255
type StringAliasWithValidation = string

type InlineAlias = EmbeddedStruct

// EmbeddedStruct is for testing that embedded struct is handled correctly when it is used through an alias type.
type EmbeddedStruct struct {
// FromEmbedded is a field from the embedded struct that was used through an alias type.
FromEmbedded string `json:"fromEmbedded,omitempty"`
}

type ContainsNestedMap struct {
InnerMap map[string]string `json:"innerMap,omitempty"`
}
Expand Down
26 changes: 16 additions & 10 deletions pkg/crd/testdata/testdata.kubebuilder.io_cronjobs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ spec:
spec:
description: CronJobSpec defines the desired state of CronJob
properties:
aliasFromPackage:
description: |-
This tests that alias imported from a package is handled correctly. The
corev1.IPFamilyPolicyType is just reused since it's available from
imported package. We can create our own in a separate package if needed.
type: string
array:
description: Checks that fixed-length arrays work
items:
Expand Down Expand Up @@ -184,13 +190,13 @@ spec:
x-kubernetes-preserve-unknown-fields: true
enumSlice:
description: This tests slice item validation with enum
type: array
items:
type: integer
enum:
- 0
- 1
- 3
type: integer
type: array
explicitlyOptionalKubebuilder:
description: This tests explicitly optional kubebuilder fields
type: string
Expand Down Expand Up @@ -228,6 +234,10 @@ spec:
Test that we can add a forbidden field using XValidation Reason and FieldPath.
The validation is applied to the spec struct itself and not the field.
type: integer
fromEmbedded:
description: FromEmbedded is a field from the embedded struct that
was used through an alias type.
type: string
hosts:
description: This tests string slice item validation.
items:
Expand Down Expand Up @@ -8984,22 +8994,18 @@ spec:
time for any reason. Missed jobs executions will be counted as failed ones.
format: int64
type: integer
aliasFromPackage:
description: |-
This tests that alias imported from a package is handled correctly. The
corev1.IPFamilyPolicyType is just reused since it's available from
imported package. We can create our own in a separate package if needed.
type: string
stringAlias:
description: This tests that string alias is handled correctly.
type: string
stringAliasAddedValidation:
description: This tests that validation on a string alias type is handled correctly.
description: This tests that validation on a string alias type is
handled correctly.
maxLength: 255
minLength: 1
type: string
stringAliasAlreadyValidated:
description: This tests that validation on a the string alias type itself is handled correctly.
description: This tests that validation on a the string alias type
itself is handled correctly.
maxLength: 255
minLength: 1
type: string
Expand Down