Add configuration API parameter for overriding the field names #335
Conversation
Signed-off-by: Sergen Yalçın <[email protected]>
There was a problem hiding this comment.
Thanks @sergenyalcin, lgtm.
I think there's need to make some architectural changes in upjet's code generation pipelines. We will need to aim generators that can analyze the existing code and generate code accordingly. This should result in more powerful generators that can be run independently from the other generators. Some of the current generators depend on the running of some previous generators and passing context (type & parameter information, etc.) in memory. We should consider isolating these generators so that we can independently run them in our code generation pipelines.
pkg/types/builder.go
Outdated
| if v, ok := overrideFieldNames[n]; ok { | ||
| return v, nil | ||
| } |
There was a problem hiding this comment.
nit: So, my understanding is that we would like to override any auto-generated name that we calculate here with the manually configured (overridden) name. If this is the case, then shouldn't we override what's calculated at the end of this function because there are some further modifications down the path in this function. The idea is:
- We bump an API version
- Run
make generateand observe a parameter name conflict - At this point, it would be easier for us to use the exact conflicting name as the key.
If we do the look up early here, then the override key may not match the actual conflicting name. What do you think?
There was a problem hiding this comment.
Makes sense. This implementation resolves the problems until we observed. However, your suggestion is more powerful and generic. Thanks @ulucinar!
There was a problem hiding this comment.
Thank you @sergenyalcin.
pkg/types/builder_test.go
Outdated
| @@ -180,7 +180,7 @@ func TestBuilder_generateTypeName(t *testing.T) { | |||
| g := &Builder{ | |||
| Package: p, | |||
| } | |||
| got, gotErr := generateTypeName(tc.args.suffix, g.Package, tc.args.names...) | |||
| got, gotErr := generateTypeName(tc.args.suffix, g.Package, map[string]string{}, tc.args.names...) | |||
There was a problem hiding this comment.
Could you please add a test case checking the override functionality?
Signed-off-by: Sergen Yalçın <[email protected]>
Description of your changes
This PR adds configuration API parameter for overriding the field names.
OverrideFieldNames allows to manually override the relevant field name to avoid possible Go struct name conflicts that may occur after Multiversion CRDs support. During field generation, there may be fields with the same struct name calculated in the same group. For example, let X and Y resources in the same API group have a field named Tag. This field is an object type and the name calculated for the struct to be generated is TagParameters (for spec) for both resources. To avoid this conflict, upjet looks at all previously created structs in the package during generation and if there is a conflict, it puts the Kind name of the related resource in front of the next one: YTagParameters. With Multiversion CRDs support, the above conflict scenario cannot be solved in the generator when the old API group is preserved and not regenerated, because the generator does not know the object names in the old version. For example, a new API version is generated for resource X. In this case, no generation is done for the old version of X and when Y is generated, the generator is not aware of the TagParameters in X and generates TagParameters instead of YTagParameters. Thus, two object types with the same name are generated in the same package. This can be overcome by using this configuration API. The key of the map indicates the name of the field that is generated and causes the conflict, while the value indicates the name used to avoid the conflict. By convention, also used in upjet, the field name is preceded by the value of the generated Kind, for example: "TagParameters": "ClusterTagParameters"
I have:
make reviewableto ensure this PR is ready for review.backport release-x.ylabels to auto-backport this PR if necessary.How has this code been tested
Tested against provider-aws autoscaling.AutoscalingGroup and autoscaling.GroupTag resources