Skip to content

Commit 0a52475

Browse files
committed
pkg/crd: fix type casting panic with new default *types.Alias
In the latest version of go, a change was made to the generation of Alias types by default. From the release notes: > By default, go/types now produces Alias type nodes for type aliases. > This behavior can be controlled by the GODEBUG gotypesalias flag. Its > default has changed from 0 in Go 1.22 to 1 in Go 1.23. This provoked a panic in the localNamedToSchema function when processing any type alias becaused it was expecting only a *types.Named and not a *types.Alias. This can be fixed by using an anonymous interface to more broadly "ask" if the object supports the Obj() function instead of asking it to be a specific type. Types *types.Named and *types.Alias share this method so it can be used directly. Note that it would be better (and would have made this easier to debug) to retrieve the "ok" second return value and print some error on failure to cast but this is a minimal working patch. For example you can reproduce a panic, switching the project to use Go 1.23 (and thus gotypesalias to 1), putting the following file in repro/repro.go: // +groupName=repro.io package repro import ( metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" ) type Repro struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata"` Reproducer StringAlias `json:"reproducer"` } type StringAlias = string Then run: go run ./cmd/controller-gen/ crd paths=./repro You should see something similar to: panic: interface conversion: types.Type is *types.Alias, not *types.Named goroutine 1 [running]: sigs.k8s.io/controller-tools/pkg/crd.localNamedToSchema(0x4001315f50, 0x40003918e0) /home/mtardy.linux/controller-tools/pkg/crd/schema.go:258 +0x3bc sigs.k8s.io/controller-tools/pkg/crd.typeToSchema(0x4001315f50, {0xa391e8, 0x40003918e0}) /home/mtardy.linux/controller-tools/pkg/crd/schema.go:197 +0xd0 sigs.k8s.io/controller-tools/pkg/crd.structToSchema(0x40009ee5f8, 0x400000e300) /home/mtardy.linux/controller-tools/pkg/crd/schema.go:436 +0x7d8 sigs.k8s.io/controller-tools/pkg/crd.typeToSchema(0x40009ee5f8, {0xa391b8, 0x400000e300}) /home/mtardy.linux/controller-tools/pkg/crd/schema.go:207 +0x90 sigs.k8s.io/controller-tools/pkg/crd.infoToSchema(0x40000505f8) /home/mtardy.linux/controller-tools/pkg/crd/schema.go:125 +0xcc sigs.k8s.io/controller-tools/pkg/crd.(*Parser).NeedSchemaFor(0x400009a120, {0x4000207b80, {0x40002c2540, 0x5}}) /home/mtardy.linux/controller-tools/pkg/crd/parser.go:193 +0x1e8 sigs.k8s.io/controller-tools/pkg/crd.(*Parser).NeedFlattenedSchemaFor(0x400009a120, {0x4000207b80, {0x40002c2540, 0x5}}) /home/mtardy.linux/controller-tools/pkg/crd/parser.go:205 +0x9c sigs.k8s.io/controller-tools/pkg/crd.(*Parser).NeedCRDFor(0x400009a120, {{0x4000185a06, 0x8}, {0x40002c2540, 0x5}}, 0x0) /home/mtardy.linux/controller-tools/pkg/crd/spec.go:93 +0x3d8 sigs.k8s.io/controller-tools/pkg/crd.Generator.Generate({0x0, 0x0, 0x0, {0x0, 0x0, 0x0}, 0x0, {0x0, 0x0}, {0x0, ...}, ...}, ...) /home/mtardy.linux/controller-tools/pkg/crd/gen.go:182 +0x464 sigs.k8s.io/controller-tools/pkg/genall.(*Runtime).Run(0x400015cbd0) /home/mtardy.linux/controller-tools/pkg/genall/genall.go:272 +0x21c main.main.func1(0x40002a2200?, {0x40002d9ad0?, 0x4?, 0x8e519c?}) /home/mtardy.linux/controller-tools/cmd/controller-gen/main.go:176 +0x64 github.com/spf13/cobra.(*Command).execute(0x40002aec08, {0x4000136090, 0x3, 0x3}) /home/mtardy.linux/go/pkg/mod/github.com/spf13/[email protected]/command.go:985 +0x834 github.com/spf13/cobra.(*Command).ExecuteC(0x40002aec08) /home/mtardy.linux/go/pkg/mod/github.com/spf13/[email protected]/command.go:1117 +0x344 github.com/spf13/cobra.(*Command).Execute(...) /home/mtardy.linux/go/pkg/mod/github.com/spf13/[email protected]/command.go:1041 main.main() /home/mtardy.linux/controller-tools/cmd/controller-gen/main.go:200 +0x290 exit status 2 Also added a test case to reproduce the error thanks to sbueringer. Signed-off-by: Mahe Tardy <[email protected]>
1 parent 0035369 commit 0a52475

File tree

3 files changed

+9
-1
lines changed

3 files changed

+9
-1
lines changed

pkg/crd/schema.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ func localNamedToSchema(ctx *schemaContext, ident *ast.Ident) *apiext.JSONSchema
254254
}
255255
// NB(directxman12): if there are dot imports, this might be an external reference,
256256
// so use typechecking info to get the actual object
257-
typeNameInfo := typeInfo.(*types.Named).Obj()
257+
typeNameInfo := typeInfo.(interface{ Obj() *types.TypeName }).Obj()
258258
pkg := typeNameInfo.Pkg()
259259
pkgPath := loader.NonVendorPath(pkg.Path())
260260
if pkg == ctx.pkg.Types {

pkg/crd/testdata/cronjob_types.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,9 @@ type CronJobSpec struct {
327327

328328
HostsAlias Hosts `json:"hostsAlias,omitempty"`
329329

330+
// This tests that string alias is handled correctly.
331+
StringAlias StringAlias `json:"stringAlias,omitempty"`
332+
330333
// This tests string slice validation.
331334
// +kubebuilder:validation:MinItems=2
332335
// +kubebuilder:validation:MaxItems=2
@@ -351,6 +354,8 @@ type CronJobSpec struct {
351354
Protocol corev1.Protocol `json:"protocol,omitempty" protobuf:"bytes,4,opt,name=protocol,casttype=Protocol"`
352355
}
353356

357+
type StringAlias = string
358+
354359
type ContainsNestedMap struct {
355360
InnerMap map[string]string `json:"innerMap,omitempty"`
356361
}

pkg/crd/testdata/testdata.kubebuilder.io_cronjobs.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8972,6 +8972,9 @@ spec:
89728972
time for any reason. Missed jobs executions will be counted as failed ones.
89738973
format: int64
89748974
type: integer
8975+
stringAlias:
8976+
description: This tests that string alias is handled correctly.
8977+
type: string
89758978
stringPair:
89768979
description: This tests string slice validation.
89778980
items:

0 commit comments

Comments
 (0)