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

Make apiVersion and kind typing more precise #341

Merged
merged 3 commits into from
Jan 8, 2019
Merged
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
70 changes: 55 additions & 15 deletions pkg/gen/typegen.go
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,41 @@ func makeType(prop map[string]interface{}, opts groupOpts) string {
}
}

func isTopLevel(d *definition) bool {
gvks, gvkExists :=
d.data["x-kubernetes-group-version-kind"].([]interface{})
hasGVK := gvkExists && len(gvks) > 0
if !hasGVK {
return false
}

// Return `false` for the handful of top-level imperative resource types that can't be managed
// by Pulumi.
switch fmt.Sprintf("%s/%s", d.gvk.GroupVersion().String(), d.gvk.Kind) {
case "policy/v1beta1/Eviction", "v1/Status", "apps/v1beta1/Scale", "apps/v1beta2/Scale",
"autoscaling/v1/Scale", "extensions/v1beta1/Scale":
return false
}

properties, hasProperties := d.data["properties"].(map[string]interface{})
if !hasProperties {
return false
}

meta, hasMetadata := properties["metadata"].(map[string]interface{})
if !hasMetadata {
return false
}

ref, hasRef := meta["$ref"]
if !hasRef {
return false
}

return ref == "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" ||
ref == "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
}

// --------------------------------------------------------------------------

// Core grouping logic.
Expand Down Expand Up @@ -424,8 +459,8 @@ func createGroups(definitionsJSON map[string]interface{}, opts groupOpts) []*Gro
// `admissionregistration.k8s.io/v1alpha1` instead of `admissionregistration/v1alpha1`).
defaultGroupVersion := d.gvk.Group
var fqGroupVersion string
if gvks, gvkExists :=
d.data["x-kubernetes-group-version-kind"].([]interface{}); gvkExists && len(gvks) > 0 {
isTopLevel := isTopLevel(d)
if gvks, gvkExists := d.data["x-kubernetes-group-version-kind"].([]interface{}); gvkExists && len(gvks) > 0 {
gvk := gvks[0].(map[string]interface{})
group := gvk["group"].(string)
version := gvk["version"].(string)
Expand Down Expand Up @@ -460,15 +495,6 @@ func createGroups(definitionsJSON map[string]interface{}, opts groupOpts) []*Gro
propName := kv.Key.(string)
prop := d.data["properties"].(map[string]interface{})[propName].(map[string]interface{})

// Create a default value for the field.
defaultValue := fmt.Sprintf("args && args.%s || undefined", propName)
switch propName {
case "apiVersion":
defaultValue = fmt.Sprintf(`"%s"`, defaultGroupVersion)
case "kind":
defaultValue = fmt.Sprintf(`"%s"`, d.gvk.Kind)
}

var prefix string
var t string
switch opts.language {
Expand All @@ -480,6 +506,21 @@ func createGroups(definitionsJSON map[string]interface{}, opts groupOpts) []*Gro
// Python currently does not emit types for use.
}

// Create a default value for the field.
defaultValue := fmt.Sprintf("args && args.%s || undefined", propName)
switch propName {
case "apiVersion":
defaultValue = fmt.Sprintf(`"%s"`, defaultGroupVersion)
hausdorff marked this conversation as resolved.
Show resolved Hide resolved
if isTopLevel {
t = fmt.Sprintf(`"%s"`, defaultGroupVersion)
hausdorff marked this conversation as resolved.
Show resolved Hide resolved
}
case "kind":
defaultValue = fmt.Sprintf(`"%s"`, d.gvk.Kind)
hausdorff marked this conversation as resolved.
Show resolved Hide resolved
if isTopLevel {
t = fmt.Sprintf(`"%s"`, d.gvk.Kind)
hausdorff marked this conversation as resolved.
Show resolved Hide resolved
}
}

return &Property{
comment: fmtComment(prop["description"], prefix, opts),
propType: t,
Expand Down Expand Up @@ -519,14 +560,13 @@ func createGroups(definitionsJSON map[string]interface{}, opts groupOpts) []*Gro
return linq.From([]*KindConfig{})
}

props := d.data["properties"].(map[string]interface{})
_, kindExists := props["kind"]
_, apiVersionExists := props["apiVersion"]
if opts.generatorType == provider && (!kindExists || !apiVersionExists) {
if opts.generatorType == provider && (!isTopLevel) {
return linq.From([]*KindConfig{})
}

var typeGuard string
props := d.data["properties"].(map[string]interface{})
_, apiVersionExists := props["apiVersion"]
if apiVersionExists {
typeGuard = fmt.Sprintf(`
export function is%s(o: any): o is %s {
Expand Down
3,917 changes: 1,143 additions & 2,774 deletions sdk/nodejs/provider.ts

Large diffs are not rendered by default.

Loading