Merge pull request #554 from sergenyalcin/backport-544-to-release-1.11

[Backport release-1.11] Backport 544 to release 1.11

Author: sergenyalcin

pkg/config/conversion/conversions.go

@@ -261,7 +261,9 @@ func (i *identityConversion) ConvertManaged(src, target resource.Managed) (bool,
 		pv := fieldpath.Pave(srcRaw)
 		for _, ex := range i.excludePaths {
 			exPaths, err := pv.ExpandWildcards(ex)
-			if err != nil {
+			if fieldpath.IsNotFound(err) {
+				continue
+			} else if err != nil {
 				return false, errors.Wrapf(err, "cannot expand wildcards in the fieldpath expression %s", ex)
 			}
 			for _, p := range exPaths {

pkg/config/resource.go

@@ -27,6 +27,8 @@ import (
 
 	"github.com/crossplane/upjet/pkg/config/conversion"
 	"github.com/crossplane/upjet/pkg/registry"
+	"github.com/crossplane/upjet/pkg/types/markers/kubebuilder"
+	"github.com/crossplane/upjet/pkg/types/structtag"
 )
 
 // A ListType is a type of list.
@@ -685,6 +687,7 @@ func (m SchemaElementOptions) SetAddToObservation(el string) {
 
 // AddToObservation returns true if the schema element at the specified path
 // should be added to the CRD type's Observation type.
+// Deprecated: Use SchemaElementOptions.AddToObservation instead.
 func (m SchemaElementOptions) AddToObservation(el string) bool {
 	return m[el] != nil && m[el].AddToObservation
 }
@@ -799,6 +802,48 @@ func (m SchemaElementOptions) EmbeddedObject(el string) bool {
 	return m[el] != nil && m[el].EmbeddedObject
 }
 
+// SetInitProviderOverrides sets the InitProviderOverrides
+// for the specified key.
+// The key is a Terraform field path without the wildcard segments, like
+// a.b.c.
+func (m SchemaElementOptions) SetInitProviderOverrides(el string, o *InitProviderOverrides) {
+	if m[el] == nil {
+		m[el] = &SchemaElementOption{}
+	}
+	m[el].InitProviderOverrides = o
+}
+
+// TagOverrides can be used to override the generated struct tags in
+// the generated InitProvider, ForProvider or Observation APIs for
+// the Terraform schema element.
+type TagOverrides struct {
+	// TFTag can be set to override the generated tf struct tag
+	// for the schema element. Tag's key cannot be overridden and if you specify
+	// a key here, it will be ignored. Tag's name is only overridden
+	// if you specify a non-empty name. Tag's omit policy and inline are always
+	// overridden with what you specify here.
+	TFTag *structtag.Value
+	// JSONTag can be set to override the generated json struct tag
+	// for the schema element. Tag's key cannot be overridden and if you specify
+	// a key here, it will be ignored. Tag's name is only overridden
+	// if you specify a non-empty name. Tag's omit policy and inline are always
+	// overridden with what you specify here.
+	JSONTag *structtag.Value
+}
+
+// InitProviderOverrides is a set of overrides for the generated InitProvider
+// field corresponding to a Terraform schema element.
+type InitProviderOverrides struct {
+	// TagOverrides sets tag overrides for the generated struct tags
+	// in the InitProvider API.
+	TagOverrides
+	// Options sets the override for the kubebuilder marker options
+	// to be used for the generated InitProvider field corresponding to a
+	// Terraform schema element. A kubebuilder marker option is only overridden
+	// if it's not nil.
+	KubebuilderOptions *kubebuilder.Options
+}
+
 // SchemaElementOption represents configuration options on a schema element.
 type SchemaElementOption struct {
 	// AddToObservation is set to true if the field represented by
@@ -809,4 +854,7 @@ type SchemaElementOption struct {
 	// a schema element is to be embedded into its parent instead of being
 	// generated as a single element list.
 	EmbeddedObject bool
+	// InitProviderOverrides is set to override the generated InitProvider field
+	// corresponding to a schema element.
+	InitProviderOverrides *InitProviderOverrides
 }

pkg/controller/ignored_tfpluginsdk.go

@@ -22,7 +22,11 @@ func getTerraformIgnoreChanges(forProvider, initProvider map[string]any) []strin
 func getIgnoredFieldsMap(format string, forProvider, initProvider map[string]any) []string {
 	ignored := []string{}
 
-	for k := range initProvider {
+	for k, v := range initProvider {
+		if v == nil {
+			continue
+		}
+
 		if _, ok := forProvider[k]; !ok {
 			ignored = append(ignored, fmt.Sprintf(format, k))
 		} else {

pkg/types/builder.go

@@ -9,7 +9,6 @@ import (
 	"go/token"
 	"go/types"
 	"sort"
-	"strings"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	twtypes "github.com/muvaf/typewriter/pkg/types"
@@ -168,7 +167,7 @@ func (g *Builder) buildResource(res *schema.Resource, cfg *config.Resource, tfPa
 				return nil, nil, nil, err
 			}
 		}
-		f.AddToResource(g, r, typeNames, cfg.SchemaElementOptions.AddToObservation(cPath))
+		f.AddToResource(g, r, typeNames, ptr.Deref(cfg.SchemaElementOptions[cPath], config.SchemaElementOption{}))
 	}
 
 	paramType, obsType, initType := g.AddToBuilder(typeNames, r)
@@ -282,8 +281,10 @@ func (g *Builder) buildSchema(f *Field, cfg *config.Resource, names []string, cp
 						tParam = types.NewSlice(paramType)
 						tInit = types.NewSlice(initType)
 					}
+					opt := ptr.Deref(cfg.SchemaElementOptions[cpath], config.SchemaElementOption{})
+					initProviderOverrides := ptr.Deref(opt.InitProviderOverrides, config.InitProviderOverrides{})
 					r.addParameterField(f, types.NewField(token.NoPos, g.Package, f.Name.Camel, tParam, false))
-					r.addInitField(f, types.NewField(token.NoPos, g.Package, f.Name.Camel, tInit, false), g, nil)
+					r.addInitField(f, types.NewField(token.NoPos, g.Package, f.Name.Camel, tInit, false), g, nil, initProviderOverrides.TagOverrides)
 				}
 			default:
 				if paramType == nil {
@@ -400,32 +401,30 @@ func (r *resource) addParameterField(f *Field, field *types.Var) {
 		requiredBySchema = false
 		// If the field is not a terraform field, we should not require it in init,
 		// as it is not an initProvider field.
-		r.topLevelRequiredParams = append(r.topLevelRequiredParams, newTopLevelRequiredParam(f.TransformedName, f.TFTag != "-"))
+		r.topLevelRequiredParams = append(r.topLevelRequiredParams, newTopLevelRequiredParam(f.TransformedName, !f.TFTag.AlwaysOmitted()))
 	}
 
 	// Note(lsviben): Only fields which are not also initProvider fields should have a required kubebuilder comment.
-	f.Comment.Required = ptr.To(requiredBySchema && !f.isInit())
+	f.Comment.KubebuilderOptions.Required = ptr.To(requiredBySchema && !f.isInit())
 
 	// For removing omitempty tag from json tag, we are just checking if the field is required by the schema.
 	if requiredBySchema {
 		// Required fields should not have omitempty tag in json tag.
-		// TODO(muvaf): This overrides user intent if they provided custom
-		// JSON tag.
-		r.paramTags = append(r.paramTags, fmt.Sprintf(`json:"%s" tf:"%s"`, strings.TrimSuffix(f.JSONTag, ",omitempty"), f.TFTag))
+		r.paramTags = append(r.paramTags, fmt.Sprintf("%s %s", f.JSONTag.NoOmit(), f.TFTag))
 	} else {
-		r.paramTags = append(r.paramTags, fmt.Sprintf(`json:"%s" tf:"%s"`, f.JSONTag, f.TFTag))
+		r.paramTags = append(r.paramTags, fmt.Sprintf("%s %s", f.JSONTag, f.TFTag))
 	}
 
 	r.paramFields = append(r.paramFields, field)
 }
 
-func (r *resource) addInitField(f *Field, field *types.Var, g *Builder, typeNames *types.TypeName) {
+func (r *resource) addInitField(f *Field, field *types.Var, g *Builder, typeNames *types.TypeName, o config.TagOverrides) {
 	// If the field is not an init field, we don't add it.
 	if !f.isInit() {
 		return
 	}
 
-	r.initTags = append(r.initTags, fmt.Sprintf(`json:"%s" tf:"%s"`, f.JSONTag, f.TFTag))
+	r.initTags = append(r.initTags, fmt.Sprintf("%s %s", f.JSONTag.OverrideFrom(o.JSONTag), f.TFTag.OverrideFrom(o.TFTag)))
 
 	// If the field is a nested type, we need to add it as the init type.
 	if f.InitType != nil {
@@ -449,7 +448,7 @@ func (r *resource) addObservationField(f *Field, field *types.Var) {
 		}
 	}
 	r.obsFields = append(r.obsFields, field)
-	r.obsTags = append(r.obsTags, fmt.Sprintf(`json:"%s" tf:"%s"`, f.JSONTag, f.TFTag))
+	r.obsTags = append(r.obsTags, fmt.Sprintf("%s %s", f.JSONTag, f.TFTag))
 }
 
 func (r *resource) addReferenceFields(g *Builder, paramName *types.TypeName, field *Field, isInit bool) {

pkg/types/comments/comment.go

@@ -9,6 +9,7 @@ import (
 
 	"github.com/crossplane/upjet/pkg/config"
 	"github.com/crossplane/upjet/pkg/types/markers"
+	"github.com/crossplane/upjet/pkg/types/structtag"
 )
 
 // Option is a comment option
@@ -21,10 +22,10 @@ func WithReferenceConfig(cfg config.Reference) Option {
 	}
 }
 
-// WithTFTag returns a comment options with input tf tag
-func WithTFTag(s string) Option {
+// WithTFTag returns a comment options with input tf tag.
+func WithTFTag(t string) Option {
 	return func(c *Comment) {
-		c.FieldTFTag = &s
+		c.FieldTFTag = structtag.MustParseTF(t)
 	}
 }
 

pkg/types/comments/comment_test.go

@@ -8,16 +8,17 @@ import (
 	"reflect"
 	"testing"
 
+	"github.com/crossplane/crossplane-runtime/pkg/errors"
 	"github.com/crossplane/crossplane-runtime/pkg/test"
 	"github.com/google/go-cmp/cmp"
-	"github.com/pkg/errors"
 
 	"github.com/crossplane/upjet/pkg/config"
 	"github.com/crossplane/upjet/pkg/types/markers"
+	"github.com/crossplane/upjet/pkg/types/structtag"
 )
 
-func TestComment_Build(t *testing.T) {
-	tftag := "-"
+func TestCommentBuild(t *testing.T) {
+	tftag := structtag.NewTF(structtag.WithOmit(structtag.OmitAlways))
 	type args struct {
 		text string
 		opts []Option
@@ -67,7 +68,7 @@ yes, this is a test`,
 `,
 				mopts: markers.Options{
 					UpjetOptions: markers.UpjetOptions{
-						FieldTFTag: &tftag,
+						FieldTFTag: tftag,
 					},
 				},
 			},
@@ -98,7 +99,7 @@ yes, this is a test`,
 `,
 				mopts: markers.Options{
 					UpjetOptions: markers.UpjetOptions{
-						FieldTFTag: &tftag,
+						FieldTFTag: tftag,
 					},
 				},
 			},
@@ -120,7 +121,7 @@ yes, this is a test`,
 `,
 				mopts: markers.Options{
 					UpjetOptions: markers.UpjetOptions{
-						FieldTFTag: &tftag,
+						FieldTFTag: tftag,
 					},
 					CrossplaneOptions: markers.CrossplaneOptions{
 						Reference: config.Reference{
@@ -138,7 +139,7 @@ yes, this is a test`,
 `,
 			},
 			want: want{
-				err: errors.New("cannot parse as a upjet prefix: +upjet:unsupported:key=value"),
+				err: errors.New("cannot parse as an upjet prefix: +upjet:unsupported:key=value"),
 			},
 		},
 	}
@@ -151,7 +152,9 @@ yes, this is a test`,
 			if gotErr != nil {
 				return
 			}
-			if diff := cmp.Diff(tc.want.mopts, c.Options); diff != "" {
+			if diff := cmp.Diff(tc.want.mopts, c.Options, cmp.Comparer(func(v1, v2 structtag.Value) bool {
+				return v1.String() == v2.String()
+			})); diff != "" {
 				t.Errorf("comment.New(...) opts = %v, want %v", c.Options, tc.want.mopts)
 			}
 			got := c.Build()