Skip to content

replace nested field SecretKeyReference GoType #49

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
merged 4 commits into from
May 3, 2021
Merged

replace nested field SecretKeyReference GoType #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6b6f1c2
replace nested field SecretKeyReference GoType
jaypipes Apr 29, 2021
e8be3ca
remove import tracking from TypeDef collection
jaypipes May 1, 2021
06e0102
encapsulate SetSDK for Secret fields
jaypipes May 1, 2021
eef7ca5
implement SetSDK for Secret nested fields
jaypipes May 1, 2021
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
4 changes: 1 addition & 3 deletions pkg/generate/ack/apis.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ func APIs(
if err != nil {
return nil, err
}
typeDefs, typeImports, err := g.GetTypeDefs()
typeDefs, err := g.GetTypeDefs()
if err != nil {
return nil, err
}
Expand All @@ -73,7 +73,6 @@ func APIs(
metaVars,
enumDefs,
typeDefs,
typeImports,
}
for _, path := range apisTemplatePaths {
outPath := strings.TrimSuffix(filepath.Base(path), ".tpl")
Expand Down Expand Up @@ -101,7 +100,6 @@ type templateAPIVars struct {
templateset.MetaVars
EnumDefs []*ackmodel.EnumDef
TypeDefs []*ackmodel.TypeDef
Imports map[string]string
}

// templateCRDVars contains template variables for the template that outputs Go
Expand Down
11 changes: 1 addition & 10 deletions pkg/generate/apigwv2_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,12 @@ func TestAPIGatewayV2_GetTypeDefs(t *testing.T) {

g := testutil.NewGeneratorForService(t, "apigatewayv2")

tdefs, timports, err := g.GetTypeDefs()
require.Nil(err)

// APIGatewayV2 shapes have time.Time ("timestamp") types and so
// GetTypeDefs() should return the special-cased with apimachinery/metav1
// import, aliased as "metav1"
expImports := map[string]string{"k8s.io/apimachinery/pkg/apis/meta/v1": "metav1"}
assert.Equal(expImports, timports)

// There is an "Api" Shape that is a struct that is an element of the
// GetApis Operation. Its name conflicts with the CRD called API and thus
// we need to check that its cleaned name is set to API_SDK (the _SDK
// suffix is appended to the type name to avoid the conflict with
// CRD-specific structs.
tdef := getTypeDefByName("Api", tdefs)
tdef := testutil.GetTypeDefByName(t, g, "Api")
require.NotNil(tdef)

assert.Equal("API_SDK", tdef.Names.Camel)
Expand Down
131 changes: 112 additions & 19 deletions pkg/generate/code/set_sdk.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,6 @@ func SetSDK(
}

opConfig, override := cfg.OverrideValues(op.Name)
fieldConfigs := cfg.ResourceFields(r.Names.Original)
for memberIndex, memberName := range inputShape.MemberNames() {
if r.UnpacksAttributesMap() && memberName == "Attributes" {
continue
Expand All @@ -190,22 +189,6 @@ func SetSDK(
}
}

fc, ok := fieldConfigs[memberName]
if ok && fc.IsSecret {
out += fmt.Sprintf("%sif %s.Spec.%s != nil {\n", indent, sourceVarName, memberName)
out += fmt.Sprintf("%s%stmpSecret, err := rm.rr.SecretValueFromReference(ctx, %s.Spec.%s)\n", indent,
indent, sourceVarName, memberName)
out += fmt.Sprintf("%s%sif err != nil {\n", indent, indent)
out += fmt.Sprintf("%s%s%sreturn nil, err\n", indent, indent, indent)
out += fmt.Sprintf("%s%s}\n", indent, indent)
out += fmt.Sprintf("%s%sif tmpSecret != \"\" {\n", indent, indent)
out += fmt.Sprintf("%s%s%s%s.Set%s(%s)\n", indent, indent, indent,
targetVarName, memberName, "tmpSecret")
out += fmt.Sprintf("%s%s}\n", indent, indent)
out += fmt.Sprintf("%s}\n", indent)
continue
}

if r.IsPrimaryARNField(memberName) {
// if ko.Status.ACKResourceMetadata != nil && ko.Status.ACKResourceMetadata.ARN != nil {
// res.SetTopicArn(string(*ko.Status.ACKResourceMetadata.ARN))
Expand Down Expand Up @@ -243,14 +226,26 @@ func SetSDK(
if found {
sourceAdaptedVarName += cfg.PrefixConfig.SpecField
} else {
f, found = r.StatusFields[memberName]
f, found = r.StatusFields[renamedName]
if !found {
// TODO(jaypipes): check generator config for exceptions?
continue
}
sourceAdaptedVarName += cfg.PrefixConfig.StatusField
}
sourceAdaptedVarName += "." + f.Names.Camel
sourceFieldPath := f.Names.Camel

if r.IsSecretField(memberName) {
out += setSDKForSecret(
cfg, r,
memberName,
targetVarName,
sourceAdaptedVarName,
indentLevel,
)
continue
}

memberShapeRef, _ := inputShape.MemberRefs[memberName]
memberShape := memberShapeRef.Shape
Expand Down Expand Up @@ -327,6 +322,7 @@ func SetSDK(
cfg, r,
memberName,
memberVarName,
sourceFieldPath,
sourceAdaptedVarName,
memberShapeRef,
indentLevel+1,
Expand All @@ -336,6 +332,7 @@ func SetSDK(
memberName,
targetVarName,
inputShape.Type,
sourceFieldPath,
memberVarName,
memberShapeRef,
indentLevel+1,
Expand All @@ -347,6 +344,7 @@ func SetSDK(
memberName,
targetVarName,
inputShape.Type,
sourceFieldPath,
sourceAdaptedVarName,
memberShapeRef,
indentLevel+1,
Expand Down Expand Up @@ -514,6 +512,7 @@ func SetSDKGetAttributes(
memberName,
targetVarName,
inputShape.Type,
cleanMemberName,
sourceVarPath,
field.ShapeRef,
indentLevel+1,
Expand Down Expand Up @@ -708,6 +707,7 @@ func SetSDKSetAttributes(
memberName,
targetVarName,
inputShape.Type,
cleanMemberName,
sourceVarPath,
field.ShapeRef,
indentLevel+1,
Expand All @@ -730,6 +730,8 @@ func setSDKForContainer(
targetFieldName string,
// The variable name that we want to set a value to
targetVarName string,
// The path to the field that we access our source value from
sourceFieldPath string,
// The struct or struct field that we access our source value from
sourceVarName string,
// ShapeRef of the target struct field
Expand All @@ -743,6 +745,7 @@ func setSDKForContainer(
targetFieldName,
targetVarName,
targetShapeRef,
sourceFieldPath,
sourceVarName,
indentLevel,
)
Expand All @@ -752,6 +755,7 @@ func setSDKForContainer(
targetFieldName,
targetVarName,
targetShapeRef,
sourceFieldPath,
sourceVarName,
indentLevel,
)
Expand All @@ -761,6 +765,7 @@ func setSDKForContainer(
targetFieldName,
targetVarName,
targetShapeRef,
sourceFieldPath,
sourceVarName,
indentLevel,
)
Expand All @@ -770,13 +775,74 @@ func setSDKForContainer(
targetFieldName,
targetVarName,
targetShapeRef.Shape.Type,
sourceFieldPath,
sourceVarName,
targetShapeRef,
indentLevel,
)
}
}

// setSDKForSecret returns a string of Go code that sets a target variable to
// the value of a Secret when the type of the source variable is a
// SecretKeyReference.
//
// The Go code output from this function looks like this:
//
// if ko.Spec.MasterUserPassword != nil {
// tmpSecret, err := rm.rr.SecretValueFromReference(ctx, ko.Spec.MasterUserPassword)
// if err != nil {
// return nil, err
// }
// if tmpSecret != "" {
// res.SetMasterUserPassword(tmpSecret)
// }
// }
func setSDKForSecret(
cfg *ackgenconfig.Config,
r *model.CRD,
// The name of the SDK Shape field we're setting
targetFieldName string,
// The variable name that we want to set a value on
targetVarName string,
// The CR field that we access our source value from
sourceVarName string,
indentLevel int,
) string {
out := ""
indent := strings.Repeat("\t", indentLevel)
secVar := "tmpSecret"

// if ko.Spec.MasterUserPassword != nil {
out += fmt.Sprintf(
"%sif %s != nil {\n",
indent, sourceVarName,
)
// tmpSecret, err := rm.rr.SecretValueFromReference(ctx, ko.Spec.MasterUserPassword)
out += fmt.Sprintf(
"%s\t%s, err := rm.rr.SecretValueFromReference(ctx, %s)\n",
indent, secVar, sourceVarName,
)
// if err != nil {
// return nil, err
// }
out += fmt.Sprintf("%s\tif err != nil {\n", indent)
out += fmt.Sprintf("%s\t\treturn nil, err\n", indent)
out += fmt.Sprintf("%s\t}\n", indent)
// if tmpSecret != "" {
// res.SetMasterUserPassword(tmpSecret)
// }
out += fmt.Sprintf("%s\tif tmpSecret != \"\" {\n", indent)
out += fmt.Sprintf(
"%s\t\t%s.Set%s(%s)\n",
indent, targetVarName, targetFieldName, secVar,
)
out += fmt.Sprintf("%s\t}\n", indent)
// }
out += fmt.Sprintf("%s}\n", indent)
return out
}

// setSDKForStruct returns a string of Go code that sets a target variable
// value to a source variable when the type of the source variable is a struct.
func setSDKForStruct(
Expand All @@ -788,6 +854,8 @@ func setSDKForStruct(
targetVarName string,
// Shape Ref of the target struct field
targetShapeRef *awssdkmodel.ShapeRef,
// The path to the field that we access our source value from
sourceFieldPath string,
// The struct or struct field that we access our source value from
sourceVarName string,
indentLevel int,
Expand All @@ -801,14 +869,28 @@ func setSDKForStruct(
memberShape := memberShapeRef.Shape
cleanMemberNames := names.New(memberName)
cleanMemberName := cleanMemberNames.Camel
memberVarName := fmt.Sprintf("%sf%d", targetVarName, memberIndex)
sourceAdaptedVarName := sourceVarName + "." + cleanMemberName
memberFieldPath := sourceFieldPath + "." + cleanMemberName
if r.IsSecretField(memberFieldPath) {
out += setSDKForSecret(
cfg, r,
memberName,
targetVarName,
sourceAdaptedVarName,
indentLevel,
)
continue
}
out += fmt.Sprintf(
"%sif %s != nil {\n", indent, sourceAdaptedVarName,
)
switch memberShape.Type {
case "list", "structure", "map":
{
memberVarName := fmt.Sprintf(
"%sf%d",
targetVarName, memberIndex,
)
out += varEmptyConstructorSDKType(
cfg, r,
memberVarName,
Expand All @@ -819,6 +901,7 @@ func setSDKForStruct(
cfg, r,
memberName,
memberVarName,
memberFieldPath,
sourceAdaptedVarName,
memberShapeRef,
indentLevel+1,
Expand All @@ -828,6 +911,7 @@ func setSDKForStruct(
memberName,
targetVarName,
targetShape.Type,
memberFieldPath,
memberVarName,
memberShapeRef,
indentLevel+1,
Expand All @@ -839,6 +923,7 @@ func setSDKForStruct(
memberName,
targetVarName,
targetShape.Type,
memberFieldPath,
sourceAdaptedVarName,
memberShapeRef,
indentLevel+1,
Expand All @@ -862,6 +947,8 @@ func setSDKForSlice(
targetVarName string,
// Shape Ref of the target struct field
targetShapeRef *awssdkmodel.ShapeRef,
// The path to the field that we access our source value from
sourceFieldPath string,
// The struct or struct field that we access our source value from
sourceVarName string,
indentLevel int,
Expand Down Expand Up @@ -894,6 +981,7 @@ func setSDKForSlice(
cfg, r,
containerFieldName,
elemVarName,
sourceFieldPath+".",
iterVarName,
&targetShape.MemberRef,
indentLevel+1,
Expand Down Expand Up @@ -922,6 +1010,8 @@ func setSDKForMap(
targetVarName string,
// Shape Ref of the target struct field
targetShapeRef *awssdkmodel.ShapeRef,
// The path to the field that we access our source value from
sourceFieldPath string,
// The struct or struct field that we access our source value from
sourceVarName string,
indentLevel int,
Expand Down Expand Up @@ -955,6 +1045,7 @@ func setSDKForMap(
cfg, r,
containerFieldName,
valVarName,
sourceFieldPath+".",
valIterVarName,
&targetShape.ValueRef,
indentLevel+1,
Expand Down Expand Up @@ -1063,6 +1154,8 @@ func setSDKForScalar(
targetVarName string,
// The type of shape of the target variable
targetVarType string,
// The path to the field that we access our source value from
sourceFieldPath string,
// The struct or struct field that we access our source value from
sourceVarName string,
shapeRef *awssdkmodel.ShapeRef,
Expand Down
Loading