rename creatonly tag to omitjsonupdate

Author: lantoli

internal/common/autogeneration/marshal.go

@@ -4,21 +4,20 @@ import (
 	"encoding/json"
 	"fmt"
 	"reflect"
-	"strings"
 
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/huandu/xstrings"
 )
 
 const (
-	tagKey           = "autogeneration"
-	tagValOmitJSON   = "omitjson"
-	tagValCreateOnly = "createonly"
+	tagKey               = "autogeneration"
+	tagValOmitJSON       = "omitjson"
+	tagValOmitJSONUpdate = "omitjsonupdate"
 )
 
 // Marshal gets a Terraform model and marshals it into JSON (e.g. for an Atlas request).
-func Marshal(model any, isCreate bool) ([]byte, error) {
+func Marshal(model any, isUpdate bool) ([]byte, error) {
 	valModel := reflect.ValueOf(model)
 	if valModel.Kind() != reflect.Ptr {
 		panic("model must be pointer")
@@ -27,7 +26,7 @@ func Marshal(model any, isCreate bool) ([]byte, error) {
 	if valModel.Kind() != reflect.Struct {
 		panic("model must be pointer to struct")
 	}
-	objJSON, err := marshalAttrs(valModel, isCreate)
+	objJSON, err := marshalAttrs(valModel, isUpdate)
 	if err != nil {
 		return nil, err
 	}
@@ -44,16 +43,16 @@ func Unmarshal(raw []byte, model any) error {
 	return unmarshalAttrs(objJSON, model)
 }
 
-func marshalAttrs(valModel reflect.Value, isCreate bool) (map[string]any, error) {
+func marshalAttrs(valModel reflect.Value, isUpdate bool) (map[string]any, error) {
 	objJSON := make(map[string]any)
 	for i := 0; i < valModel.NumField(); i++ {
 		attrTypeModel := valModel.Type().Field(i)
 		tag := attrTypeModel.Tag.Get(tagKey)
-		if strings.Contains(tag, tagValOmitJSON) {
+		if tag == tagValOmitJSON {
 			continue // skip fields with tag `omitjson`
 		}
-		if !isCreate && strings.Contains(tag, tagValCreateOnly) {
-			continue // skip fields with tag `createonly` if not in create
+		if isUpdate && tag == tagValOmitJSONUpdate {
+			continue // skip fields with tag `omitjsonupdate` if in update mode
 		}
 		attrNameModel := attrTypeModel.Name
 		attrValModel := valModel.Field(i)

internal/common/autogeneration/marshal_test.go

@@ -35,27 +35,27 @@ func TestMarshalBasic(t *testing.T) {
 	assert.JSONEq(t, expectedJSON, string(raw))
 }
 
-func TestMarshalCreateOnly(t *testing.T) {
+func TestMarshalOmitJSONUpdate(t *testing.T) {
 	const (
-		expectedCreate   = `{ "attr": "val1", "attr_create_only": "val2" }`
-		expectedNoCreate = `{ "attr": "val1" }`
+		expectedCreate = `{ "attr": "val1", "attr_omit_update": "val2" }`
+		expectedUpdate = `{ "attr": "val1" }`
 	)
 	model := struct {
 		Attr           types.String `tfsdk:"attr"`
-		AttrCreateOnly types.String `tfsdk:"attr_create_only" autogeneration:"createonly"`
+		AttrOmitUpdate types.String `tfsdk:"attr_create_only" autogeneration:"omitjsonupdate"`
 		AttrOmit       types.String `tfsdk:"attr_omit" autogeneration:"omitjson"`
 	}{
 		Attr:           types.StringValue("val1"),
-		AttrCreateOnly: types.StringValue("val2"),
+		AttrOmitUpdate: types.StringValue("val2"),
 		AttrOmit:       types.StringValue("omit"),
 	}
-	noCreate, errNoCreate := autogeneration.Marshal(&model, false)
-	require.NoError(t, errNoCreate)
-	assert.JSONEq(t, expectedNoCreate, string(noCreate))
-
-	create, errCreate := autogeneration.Marshal(&model, true)
+	create, errCreate := autogeneration.Marshal(&model, false)
 	require.NoError(t, errCreate)
 	assert.JSONEq(t, expectedCreate, string(create))
+
+	update, errUpdate := autogeneration.Marshal(&model, true)
+	require.NoError(t, errUpdate)
+	assert.JSONEq(t, expectedUpdate, string(update))
 }
 
 func TestMarshalUnsupported(t *testing.T) {