replace nested field SecretKeyReference GoType #49
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jaypipes
requested review from
RedbackThomson,
a-hilaly,
nmvk,
surajkota and
vijtrip2
|
/approve |
|
/lgtm |
In this patch, we post-process the `pkg/model.TypeDef` objects that are constructed by the code generator for nested fields of type "structure". This post-processing is used to replace the GoType of an Attr representing a Secret field in a nested parent field. For example, the AmazonMQ `Broker` resource has a `Spec.Users` top-level field. This top-level field is of type `[]*User`. The `User` Go struct type is constructed from a `pkg/model.TypeDef` object that describes the struct's attributes. One of those struct attributes is called `Password`, and we want to replace the Go type for this `Attr` from `string` to `*ackv1alpha1.SecretKeyReference`. In order to do this Go type replacement, we need to search through the TypeDef objects, looking for the parent field TypeDef, then look through that TypeDef's Attr collection for the Attr with the same name as our Field that has a FieldConfig.IsSecret setting of `true`. Issue aws-controllers-k8s/community#743
jaypipes
force-pushed
the
field-config-nested
branch
from
f2591ca to
6b6f1c2
Compare
|
New changes are detected. LGTM label has been removed. |
|
I was trying to regenerate ecr with a fake secret field - I have two comments regarding the sdk and crd templates:
|
Yes, good callout. I will update in the morning.
Yep. ++ |
jaypipes
changed the title
jaypipes
changed the title
|
@a-hilaly great callouts on your review. I've addressed both of them in the latest commits on this PR. Thanks for your review again! |
a-hilaly
reviewed
May 2, 2021
| @@ -330,22 +326,6 @@ func (g *Generator) GetTypeDefs() ([]*ackmodel.TypeDef, map[string]string, error | |||
| // pointer to a struct... | |||
| goPkgType = goPkgType[1:] | |||
| } | |||
| pkg := strings.Split(goPkgType, ".")[0] | |||
There was a problem hiding this comment.
goPkgType is not used anymore - we can remove the block above
pkg/generate/code/set_sdk.go
Outdated
Comment on lines
239
to
259
| if r.IsSecretField(memberName) { | ||
| out += setSDKForSecret( | ||
| cfg, r, | ||
| memberName, | ||
| targetVarName, | ||
| sourceAdaptedVarName, | ||
| indentLevel, | ||
| ) | ||
| continue | ||
| } | ||
|
|
||
| if r.IsSecretField(memberName) { | ||
| out += setSDKForSecret( | ||
| cfg, r, | ||
| memberName, | ||
| targetVarName, | ||
| sourceAdaptedVarName, | ||
| indentLevel, | ||
| ) | ||
| continue | ||
| } |
There was a problem hiding this comment.
oh, wow... copy pasta. Will fix ASAP. thank you!
This commit replaces the tracking of unique imported packages from the
processing of TypeDef structs by the code generator. Instead, we now
use the same technique to avoid import errors that we do in the `sdk.go`
code:
```go
import (
ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1"
"github.com/aws/aws-sdk-go/aws"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
// Hack to avoid import errors during build...
var (
_ = &metav1.Time{}
_ = &aws.JSONValue{}
_ = ackv1alpha1.AWSAccountID("")
)
```
The above is all the packages that are referenced by any type
definition's attribute fields that is collected by the code generator
during API inference.
Encapsulates the code that generates Go code for setting an SDK Input shape from the value of a SecretKeyReference in a separate `setSDKForSecret` function in `pkg/generate/code` and creates a `CRD.IsSecretField` that accepts a field path and returns whether the field at that field path is a SecretKeyReference.
Implements the `pkg/generate/code.SetSDK()` function for all nested fields that are SecretKeyReference types. This involved passing a field path down into the recursive `setSDKForXXX()` functions to keep track of where we were in the processing of nested fields. We look up whether a field is a SecretKeyReference by calling the `pkg/model.CRD:IsSecretField()` method, which accepts a field path, which is why we needed to pass this field path down into the recursive code generators. Issue aws-controllers-k8s/community#743
jaypipes
force-pushed
the
field-config-nested
branch
from
7fa1166 to
eef7ca5
Compare
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: A-Hilaly, jaypipes, RedbackThomson, vijtrip2 The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this patch, we post-process the
pkg/model.TypeDefobjects that areconstructed by the code generator for nested fields of type "structure".
This post-processing is used to replace the GoType of an Attr
representing a Secret field in a nested parent field.
For example, the AmazonMQ
Brokerresource has aSpec.Userstop-levelfield. This top-level field is of type
[]*User. TheUserGo structtype is constructed from a
pkg/model.TypeDefobject that describes thestruct's attributes. One of those struct attributes is called
Password, and we want to replace the Go type for thisAttrfromstringto*ackv1alpha1.SecretKeyReference. In order to do this Gotype replacement, we need to search through the TypeDef objects, looking
for the parent field TypeDef, then look through that TypeDef's Attr
collection for the Attr with the same name as our Field that has a
FieldConfig.IsSecret setting of
true.Issue aws-controllers-k8s/community#743
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.