Skip to content

Revamp schemagen logic #143

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.

Sign up for GitHub

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

Merged
rquitales merged 11 commits into from
Sep 13, 2024
Merged

Revamp schemagen logic #143

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
466e0cd
fix: use pulumi-kubernetes schemagen logic
rquitales Sep 11, 2024
74d22b8
recursively flatten nested OpenAPI objects and arrays
rquitales Sep 12, 2024
01c3a41
remove hyphens and underscores in references
rquitales Sep 12, 2024
fe1a266
fix edge case where a "-" property exists as a field name
rquitales Sep 12, 2024
e552c1a
do not override language settings in pkgSpec
rquitales Sep 12, 2024
ab00962
fix: golang code now generate in provided folder, not its parent
rquitales Sep 12, 2024
5ff3ade
tests: fix mocked CRDs to be valid
rquitales Sep 12, 2024
cdd61be
Add more regression testing and compilation steps
rquitales Sep 12, 2024
e39f910
chore: add changelog entry
rquitales Sep 12, 2024
c80d232
address feedback
rquitales Sep 13, 2024
ff0ef1b
Prepare for v1.5.0 release
rquitales Sep 13, 2024
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
Prev Previous commit
Next Next commit
remove hyphens and underscores in references
  • Loading branch information
@rquitales
rquitales committed Sep 13, 2024
commit 01c3a410b4fe908d4788c70f61d1662a3b5aca7c
9 changes: 7 additions & 2 deletions pkg/codegen/customresourcegenerator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ func flattenRecursively(sw *spec.Swagger, parentName string, currSpec spec.Schem
for nestedPropertyName, nestedProperty := range currSpec.Properties {
// Create a new definition for the nested object by joining the parent definition name and the property name.
// This is to ensure that the nested object is unique and does not conflict with other definitions.
nestedDefinitionName := parentName + sanitizeFieldName(nestedPropertyName)
nestedDefinitionName := parentName + sanitizeReferenceName(nestedPropertyName)

s, err := flattenRecursively(sw, nestedDefinitionName, nestedProperty)
if err != nil {
Expand Down Expand Up @@ -164,11 +164,16 @@ func flattenRecursively(sw *spec.Swagger, parentName string, currSpec spec.Schem
return currSpec, nil
}

func sanitizeFieldName(fieldName string) string {
func sanitizeReferenceName(fieldName string) string {
Copy link
Contributor

@blampe blampe Sep 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this basically responsible for ensuring the ref name is a valid token in all of our target languages?

Copy link
Contributor Author

@rquitales rquitales Sep 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! Previously, in crd2pulumi, we need to do this in a number of locations which resulted in harder to maintain code, and the bugs we saw. For package name sanitization, that resides in the p-k schemagen logic.

// If the field name is "arg" or "args", we need to change it to "Arguments" to avoid conflicts with Go reserved words.
if s := strings.ToLower(fieldName); s == "arg" || s == "args" {
return "Arguments"
}

//We need to strip out any hyphens and underscores in the reference.
fieldName = cgstrings.Unhyphenate(fieldName)
fieldName = cgstrings.ModifyStringAroundDelimeter(fieldName, "_", cgstrings.UppercaseFirst)

return cgstrings.UppercaseFirst(fieldName)
}

Expand Down