support list and set of strings at root level

Author: lantoli

internal/common/autogeneration/marshal.go

@@ -39,7 +39,8 @@ func Marshal(model any, isUpdate bool) ([]byte, error) {
 }
 
 // Unmarshal gets a JSON (e.g. from an Atlas response) and unmarshals it into a Terraform model.
-// It supports the following Terraform model types: String, Bool, Int64, Float64.
+// It supports the following Terraform model types: String, Bool, Int64, Float64, Object, List, Set.
+// Map is not supported yet as it is not used in the Atlas API.
 // Attributes that are in JSON but not in the model are ignored, no error is returned.
 // Object attributes that are unknown are converted to null as all values must be known in the response state.
 func Unmarshal(raw []byte, model any) error {
@@ -192,6 +193,22 @@ func unmarshalAttr(attrNameJSON string, attrObjJSON any, valModel reflect.Value)
 			return err
 		}
 		return setAttrTfModel(attrNameModel, fieldModel, objNew)
+	case []any:
+		switch collection := fieldModel.Interface().(type) {
+		case types.List:
+			list, err := setListAttrModel(collection, v)
+			if err != nil {
+				return err
+			}
+			return setAttrTfModel(attrNameModel, fieldModel, list)
+		case types.Set:
+			set, err := setSetAttrModel(collection, v)
+			if err != nil {
+				return err
+			}
+			return setAttrTfModel(attrNameModel, fieldModel, set)
+		}
+		return fmt.Errorf("unmarshal expects collection for field %s", attrNameJSON)
 	default:
 		return fmt.Errorf("unmarshal not supported yet for type %T for field %s", v, attrNameJSON)
 	}
@@ -270,6 +287,45 @@ func setObjAttrModel(obj types.Object, objJSON map[string]any) (attr.Value, erro
 	return objNew, nil
 }
 
+func setListAttrModel(list types.List, arrayJSON []any) (attr.Value, error) {
+	elmType := list.ElementType(context.Background())
+	elms, err := getCollectionElements(arrayJSON, elmType)
+	if err != nil {
+		return nil, err
+	}
+	listNew, diags := types.ListValue(elmType, elms)
+	if diags.HasError() {
+		return nil, fmt.Errorf("unmarshal failed to convert list to object: %v", diags)
+	}
+	return listNew, nil
+}
+
+func setSetAttrModel(set types.Set, arrayJSON []any) (attr.Value, error) {
+	elmType := set.ElementType(context.Background())
+	elms, err := getCollectionElements(arrayJSON, elmType)
+	if err != nil {
+		return nil, err
+	}
+	setNew, diags := types.SetValue(elmType, elms)
+	if diags.HasError() {
+		return nil, fmt.Errorf("unmarshal failed to convert set to object: %v", diags)
+	}
+	return setNew, nil
+}
+
+func getCollectionElements(arrayJSON []any, _ attr.Type) ([]attr.Value, error) {
+	elms := make([]attr.Value, len(arrayJSON))
+	for i, item := range arrayJSON {
+		switch v := item.(type) {
+		case string:
+			elms[i] = types.StringValue(v)
+		default:
+			return nil, fmt.Errorf("unmarshal not supported yet for type %T in list", v)
+		}
+	}
+	return elms, nil
+}
+
 func getObjAttrsAndTypes(obj types.Object) (mapAttrs map[string]attr.Value, mapTypes map[string]attr.Type, err error) {
 	// mapTypes has all attributes, mapAttrs might not have them, e.g. in null or unknown objects
 	mapAttrs = obj.Attributes()

internal/common/autogeneration/marshal_test.go

@@ -333,6 +333,8 @@ func TestUnmarshalNestedAllTypes(t *testing.T) {
 		AttrObjUnknownNotSent types.Object `tfsdk:"attr_obj_unknown_not_sent"`
 		AttrObjUnknownSent    types.Object `tfsdk:"attr_obj_unknown_sent"`
 		AttrObjParent         types.Object `tfsdk:"attr_obj_parent"`
+		AttrListString        types.List   `tfsdk:"attr_list_string"`
+		AttrSetString         types.Set    `tfsdk:"attr_set_string"`
 	}
 	model := modelst{
 		AttrObj: types.ObjectValueMust(objTypeTest.AttrTypes, map[string]attr.Value{
@@ -347,6 +349,8 @@ func TestUnmarshalNestedAllTypes(t *testing.T) {
 		AttrObjUnknownNotSent: types.ObjectUnknown(objTypeTest.AttrTypes), // unknown values are changed to null
 		AttrObjUnknownSent:    types.ObjectUnknown(objTypeTest.AttrTypes),
 		AttrObjParent:         types.ObjectNull(objTypeParentTest.AttrTypes),
+		AttrListString:        types.ListUnknown(types.StringType),
+		AttrSetString:         types.SetUnknown(types.StringType),
 	}
 	// attrUnexisting is ignored because it is in JSON but not in the model, no error is returned
 	const (
@@ -372,7 +376,15 @@ func TestUnmarshalNestedAllTypes(t *testing.T) {
 					"attrParentObj": {
 						"attrString": "inside parent string"
 					}
-				}
+				},
+				"attrListString": [
+					"list1",
+					"list2"
+				],
+				"attrSetString": [
+					"set1",
+					"set2"
+				]
 			}
 		`
 	)
@@ -407,6 +419,14 @@ func TestUnmarshalNestedAllTypes(t *testing.T) {
 				"attr_bool":   types.BoolNull(),
 			}),
 		}),
+		AttrListString: types.ListValueMust(types.StringType, []attr.Value{
+			types.StringValue("list1"),
+			types.StringValue("list2"),
+		}),
+		AttrSetString: types.SetValueMust(types.StringType, []attr.Value{
+			types.StringValue("set1"),
+			types.StringValue("set2"),
+		}),
 	}
 	require.NoError(t, autogeneration.Unmarshal([]byte(jsonResp), &model))
 	assert.Equal(t, modelExpected, model)
@@ -537,7 +557,7 @@ func TestUnmarshalUnsupportedResponse(t *testing.T) {
 				AttrList types.List `tfsdk:"attr_list"`
 			}{},
 			responseJSON: `{"attrList": [{"key": "value"}]}`,
-			errorStr:     "unmarshal not supported yet for type []interface {} for field attrList",
+			errorStr:     "unmarshal not supported yet for type map[string]interface {} in list",
 		},
 		"JSON maps not supported yet": {
 			model: &struct {