-
Notifications
You must be signed in to change notification settings - Fork 360
/
reflect_resource.go
894 lines (846 loc) · 26.3 KB
/
reflect_resource.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
package common
import (
"fmt"
"log"
"reflect"
"strconv"
"strings"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
)
var kindMap = map[reflect.Kind]string{
reflect.Bool: "Bool",
reflect.Int: "Int",
reflect.Int8: "Int8",
reflect.Int16: "Int16",
reflect.Int32: "Int32",
reflect.Int64: "Int64",
reflect.Uint: "Uint",
reflect.Uint8: "Uint8",
reflect.Uint16: "Uint16",
reflect.Uint32: "Uint32",
reflect.Uint64: "Uint64",
reflect.Uintptr: "Uintptr",
reflect.Float32: "Float32",
reflect.Float64: "Float64",
reflect.Complex64: "Complex64",
reflect.Complex128: "Complex128",
reflect.Array: "Array",
reflect.Chan: "Chan",
reflect.Func: "Func",
reflect.Interface: "Interface",
reflect.Ptr: "Ptr",
reflect.Slice: "Slice",
reflect.String: "String",
reflect.Struct: "Struct",
reflect.UnsafePointer: "UnsafePointer",
}
// Generic interface for ResourceProvider. Using CustomizeSchema and Aliases functions to keep track of additional information
// on top of the generated go-sdk struct. This is used to replace manually maintained structs with `tf` tags.
type ResourceProvider interface {
Aliases() map[string]string
CustomizeSchema(map[string]*schema.Schema) map[string]*schema.Schema
}
// Takes in a ResourceProvider and converts that into a map from string to schema.
func resourceProviderStructToSchema(v ResourceProvider) map[string]*schema.Schema {
rv := reflect.ValueOf(v)
scm := typeToSchema(rv, v.Aliases())
scm = v.CustomizeSchema(scm)
return scm
}
func reflectKind(k reflect.Kind) string {
n, ok := kindMap[k]
if !ok {
return "other"
}
return n
}
func chooseFieldNameWithAliases(typeField reflect.StructField, aliases map[string]string) string {
// If nothing in the aliases map, return the field name from plain chooseFieldName method.
if len(aliases) == 0 {
return chooseFieldName(typeField)
}
jsonFieldName := getJsonFieldName(typeField)
if jsonFieldName == "-" {
return "-"
}
if value, ok := aliases[jsonFieldName]; ok {
return value
}
return jsonFieldName
}
func getJsonFieldName(typeField reflect.StructField) string {
jsonTag := typeField.Tag.Get("json")
// fields without JSON tags would be treated as if ignored,
// but keeping linters happy
if jsonTag == "" {
return "-"
}
return strings.Split(jsonTag, ",")[0]
}
// SchemaPath helps to navigate
func SchemaPath(s map[string]*schema.Schema, path ...string) (*schema.Schema, error) {
cs := s
for _, p := range path {
v, ok := cs[p]
if !ok {
return nil, fmt.Errorf("missing key %s", p)
}
if p == path[len(path)-1] {
return v, nil
}
cv, ok := v.Elem.(*schema.Resource)
if !ok {
return nil, fmt.Errorf("%s is not nested resource", p)
}
cs = cv.Schema
}
return nil, fmt.Errorf("%v does not compute", path)
}
func MustSchemaPath(s map[string]*schema.Schema, path ...string) *schema.Schema {
sch, err := SchemaPath(s, path...)
if err != nil {
panic(err)
}
return sch
}
// StructToSchema makes schema from a struct type & applies customizations from callback given
func StructToSchema(v any, customize func(map[string]*schema.Schema) map[string]*schema.Schema) map[string]*schema.Schema {
// If the input 'v' is an instance of ResourceProvider, call resourceProviderStructToSchema instead.
if rp, ok := v.(ResourceProvider); ok {
if customize != nil {
panic("customize should be nil if the input implements the ResourceProvider interface; use CustomizeSchema of ResourceProvider instead")
}
return resourceProviderStructToSchema(rp)
}
rv := reflect.ValueOf(v)
scm := typeToSchema(rv, map[string]string{})
if customize != nil {
scm = customize(scm)
}
return scm
}
// SetSuppressDiff adds diff suppression to a schema. This is necessary for non-computed
// fields for which the platform returns a value, but the user has not configured any value.
// For example: the REST API returns `{"tags": {}}` for a resource with no tags.
func SetSuppressDiff(v *schema.Schema) {
v.DiffSuppressFunc = diffSuppressor(v)
}
// SetDefault sets the default value for a schema.
func SetDefault(v *schema.Schema, value any) {
v.Default = value
v.Optional = true
v.Required = false
}
// SetReadOnly sets the schema to be read-only (i.e. computed, non-optional).
// This should be used for fields that are not user-configurable but are returned
// by the platform.
func SetReadOnly(v *schema.Schema) {
v.Optional = false
v.Required = false
v.MaxItems = 0
v.Computed = true
}
// SetRequired sets the schema to be required.
func SetRequired(v *schema.Schema) {
v.Optional = false
v.Required = true
v.Computed = false
}
func isOptional(typeField reflect.StructField) bool {
if strings.Contains(typeField.Tag.Get("json"), "omitempty") {
return true
}
tfTags := strings.Split(typeField.Tag.Get("tf"), ",")
for _, tag := range tfTags {
if tag == "optional" {
return true
}
}
return false
}
func handleOptional(typeField reflect.StructField, schema *schema.Schema) {
if isOptional(typeField) {
schema.Optional = true
} else {
schema.Required = true
}
}
func handleComputed(typeField reflect.StructField, schema *schema.Schema) {
tfTags := strings.Split(typeField.Tag.Get("tf"), ",")
for _, tag := range tfTags {
if tag == "computed" {
schema.Computed = true
schema.Required = false
break
}
}
}
func handleForceNew(typeField reflect.StructField, schema *schema.Schema) {
tfTags := strings.Split(typeField.Tag.Get("tf"), ",")
for _, tag := range tfTags {
if tag == "force_new" {
schema.ForceNew = true
break
}
}
}
func handleSensitive(typeField reflect.StructField, schema *schema.Schema) {
tfTags := strings.Split(typeField.Tag.Get("tf"), ",")
for _, tag := range tfTags {
if tag == "sensitive" {
schema.Sensitive = true
break
}
}
}
func handleSuppressDiff(typeField reflect.StructField, v *schema.Schema) {
tfTags := strings.Split(typeField.Tag.Get("tf"), ",")
for _, tag := range tfTags {
if tag == "suppress_diff" {
v.DiffSuppressFunc = diffSuppressor(v)
break
}
}
}
func getAlias(typeField reflect.StructField) string {
tfTags := strings.Split(typeField.Tag.Get("tf"), ",")
for _, tag := range tfTags {
if strings.HasPrefix(tag, "alias:") {
return strings.TrimPrefix(tag, "alias:")
}
}
return ""
}
func chooseFieldName(typeField reflect.StructField) string {
alias := getAlias(typeField)
if alias != "" {
return alias
}
return getJsonFieldName(typeField)
}
func diffSuppressor(v *schema.Schema) func(k, old, new string, d *schema.ResourceData) bool {
zero := fmt.Sprintf("%v", v.Type.Zero())
return func(k, old, new string, d *schema.ResourceData) bool {
if new == zero && old != zero {
log.Printf("[DEBUG] Suppressing diff for %v: platform=%#v config=%#v", k, old, new)
return true
}
if strings.HasSuffix(k, ".#") && new == "0" && old != "0" {
field := strings.TrimSuffix(k, ".#")
log.Printf("[DEBUG] Suppressing diff for list or set %v: no value configured but platform returned some value (likely {})", field)
return true
}
return false
}
}
type field struct {
sf reflect.StructField
v reflect.Value
}
func listAllFields(v reflect.Value) []field {
t := v.Type()
fields := make([]field, 0, v.NumField())
for i := 0; i < v.NumField(); i++ {
f := t.Field(i)
if f.Anonymous {
fields = append(fields, listAllFields(v.Field(i))...)
} else {
fields = append(fields, field{
sf: f,
v: v.Field(i),
})
}
}
return fields
}
func typeToSchema(v reflect.Value, aliases map[string]string) map[string]*schema.Schema {
scm := map[string]*schema.Schema{}
rk := v.Kind()
if rk == reflect.Ptr {
v = v.Elem()
rk = v.Kind()
}
if rk != reflect.Struct {
panic(fmt.Errorf("Schema value of Struct is expected, but got %s: %#v", reflectKind(rk), v))
}
fields := listAllFields(v)
for _, field := range fields {
typeField := field.sf
tfTag := typeField.Tag.Get("tf")
fieldName := chooseFieldNameWithAliases(typeField, aliases)
unwrappedAliases := unwrapAliasesMap(fieldName, aliases)
if fieldName == "-" {
continue
}
scm[fieldName] = &schema.Schema{}
for _, token := range strings.Split(tfTag, ",") {
colonSplit := strings.Split(token, ":")
if len(colonSplit) == 2 {
tfKey := colonSplit[0]
tfValue := colonSplit[1]
switch tfKey {
case "default":
scm[fieldName].Default = tfValue
case "max_items":
maxItems, err := strconv.Atoi(tfValue)
if err != nil {
continue
}
scm[fieldName].MaxItems = maxItems
case "min_items":
minItems, err := strconv.Atoi(tfValue)
if err != nil {
continue
}
scm[fieldName].MinItems = minItems
}
}
}
handleOptional(typeField, scm[fieldName])
handleComputed(typeField, scm[fieldName])
handleForceNew(typeField, scm[fieldName])
handleSensitive(typeField, scm[fieldName])
switch typeField.Type.Kind() {
case reflect.Int, reflect.Int32, reflect.Int64:
scm[fieldName].Type = schema.TypeInt
// diff suppression needs type for zero value
handleSuppressDiff(typeField, scm[fieldName])
case reflect.Float64:
scm[fieldName].Type = schema.TypeFloat
// diff suppression needs type for zero value
handleSuppressDiff(typeField, scm[fieldName])
case reflect.Bool:
scm[fieldName].Type = schema.TypeBool
case reflect.String:
scm[fieldName].Type = schema.TypeString
// diff suppression needs type for zero value
handleSuppressDiff(typeField, scm[fieldName])
case reflect.Map:
scm[fieldName].Type = schema.TypeMap
elem := typeField.Type.Elem()
switch elem.Kind() {
case reflect.String:
scm[fieldName].Elem = schema.TypeString
case reflect.Int64:
scm[fieldName].Elem = schema.TypeInt
default:
panic(fmt.Errorf("unsupported map value for %s: %s", fieldName, reflectKind(elem.Kind())))
}
case reflect.Ptr:
scm[fieldName].MaxItems = 1
scm[fieldName].Type = schema.TypeList
elem := typeField.Type.Elem()
sv := reflect.New(elem).Elem()
nestedSchema := typeToSchema(sv, unwrappedAliases)
if strings.Contains(tfTag, "suppress_diff") {
scm[fieldName].DiffSuppressFunc = diffSuppressor(scm[fieldName])
for _, v := range nestedSchema {
// to those relatively new to GoLang: we must explicitly pass down v by copy
v.DiffSuppressFunc = diffSuppressor(v)
}
}
scm[fieldName].Elem = &schema.Resource{
Schema: nestedSchema,
}
case reflect.Struct:
scm[fieldName].MaxItems = 1
scm[fieldName].Type = schema.TypeList
elem := typeField.Type // changed from ptr
sv := reflect.New(elem) // changed from ptr
nestedSchema := typeToSchema(sv, unwrappedAliases)
if strings.Contains(tfTag, "suppress_diff") {
scm[fieldName].DiffSuppressFunc = diffSuppressor(scm[fieldName])
for _, v := range nestedSchema {
// to those relatively new to GoLang: we must explicitly pass down v by copy
v.DiffSuppressFunc = diffSuppressor(v)
}
}
scm[fieldName].Elem = &schema.Resource{
Schema: nestedSchema,
}
case reflect.Slice:
ft := schema.TypeList
if strings.Contains(tfTag, "slice_set") {
ft = schema.TypeSet
}
scm[fieldName].Type = ft
elem := typeField.Type.Elem()
switch elem.Kind() {
case reflect.Int, reflect.Int32, reflect.Int64:
scm[fieldName].Elem = &schema.Schema{Type: schema.TypeInt}
case reflect.Float64:
scm[fieldName].Elem = &schema.Schema{Type: schema.TypeFloat}
case reflect.Bool:
scm[fieldName].Elem = &schema.Schema{Type: schema.TypeBool}
case reflect.String:
scm[fieldName].Elem = &schema.Schema{Type: schema.TypeString}
case reflect.Struct:
sv := reflect.New(elem).Elem()
scm[fieldName].Elem = &schema.Resource{
Schema: typeToSchema(sv, unwrappedAliases),
}
}
default:
panic(fmt.Errorf("unknown type for %s: %s", fieldName, reflectKind(typeField.Type.Kind())))
}
}
return scm
}
func IsRequestEmpty(v any) (bool, error) {
rv := reflect.ValueOf(v)
if rv.Kind() == reflect.Ptr {
rv = rv.Elem()
}
if rv.Kind() != reflect.Struct {
return false, fmt.Errorf("value of Struct is expected, but got %s: %#v", reflectKind(rv.Kind()), rv)
}
var isNotEmpty bool
err := iterFields(rv, []string{}, StructToSchema(v, nil), map[string]string{}, func(fieldSchema *schema.Schema, path []string, valueField *reflect.Value) error {
if isNotEmpty {
return nil
}
if !valueField.IsZero() {
isNotEmpty = true
}
return nil
})
return !isNotEmpty, err
}
// isGoSdk returns true if the struct is from databricks-sdk-go or embeds a struct from databricks-sdk-go.
func isGoSdk(v reflect.Value) bool {
if strings.Contains(v.Type().PkgPath(), "databricks-sdk-go") {
return true
}
for i := 0; i < v.NumField(); i++ {
f := v.Type().Field(i)
if f.Anonymous && isGoSdk(v.Field(i)) {
return true
}
}
return false
}
// Unwraps aliases map given a fieldname. Should be called everytime we recursively call iterFields.
//
// NOTE: If the target field has an alias, we expect `fieldname` argument to be the alias.
// For example
//
// fieldName = "cluster"
// aliases = {"cluster.clusterName": "name", "libraries": "library"}
// would return: {"clusterName": "name"}
func unwrapAliasesMap(fieldName string, aliases map[string]string) map[string]string {
result := make(map[string]string)
prefix := fieldName + "."
for key, value := range aliases {
// Only keep the keys that have the prefix.
if strings.HasPrefix(key, prefix) && key != prefix {
result[key] = value
}
}
return result
}
// Iterate through each field of the given reflect.Value object and execute a callback function with the corresponding
// terraform schema object as the input.
func iterFields(rv reflect.Value, path []string, s map[string]*schema.Schema, aliases map[string]string,
cb func(fieldSchema *schema.Schema, path []string, valueField *reflect.Value) error) error {
rk := rv.Kind()
if rk != reflect.Struct {
return fmt.Errorf("value of Struct is expected, but got %s: %#v", reflectKind(rk), rv)
}
if !rv.IsValid() {
return fmt.Errorf("%s: got invalid reflect value %#v", path, rv)
}
isGoSDK := isGoSdk(rv)
fields := listAllFields(rv)
for _, field := range fields {
typeField := field.sf
fieldName := chooseFieldNameWithAliases(typeField, aliases)
if fieldName == "-" {
continue
}
fieldSchema, ok := s[fieldName]
if !ok {
continue
}
omitEmpty := isOptional(typeField)
// TODO: fix in https://github.com/databricks/databricks-sdk-go/issues/268
if !isGoSDK && omitEmpty && !fieldSchema.Optional {
return fmt.Errorf("inconsistency: %s has omitempty, but is not optional", fieldName)
}
defaultEmpty := reflect.ValueOf(fieldSchema.Default).Kind() == reflect.Invalid
if fieldSchema.Optional && defaultEmpty && !omitEmpty {
return fmt.Errorf("inconsistency: %s is optional, default is empty, but has no omitempty", fieldName)
}
valueField := field.v
err := cb(fieldSchema, append(path, fieldName), &valueField)
if err != nil {
return fmt.Errorf("%s: %s", fieldName, err)
}
}
return nil
}
func collectionToMaps(v any, s *schema.Schema, aliases map[string]string) ([]any, error) {
resultList := []any{}
if sl, ok := v.([]string); ok {
// most likely list of parameters to job task
for _, str := range sl {
resultList = append(resultList, str)
}
return resultList, nil
}
r, ok := s.Elem.(*schema.Resource)
if !ok {
return nil, fmt.Errorf("not resource")
}
var allItems []reflect.Value
rv := reflect.ValueOf(v)
rvType := rv.Type().Kind()
isList := rvType == reflect.Array || rvType == reflect.Slice
if isList {
for i := 0; i < rv.Len(); i++ {
allItems = append(allItems, rv.Index(i))
}
} else {
allItems = append(allItems, rv)
}
for _, v := range allItems {
data := map[string]any{}
if v.Kind() == reflect.Ptr {
if v.IsNil() {
continue
}
v = v.Elem()
}
err := iterFields(v, []string{}, r.Schema, aliases, func(fieldSchema *schema.Schema,
path []string, valueField *reflect.Value) error {
fieldName := path[len(path)-1]
newAliases := unwrapAliasesMap(fieldName, aliases)
fieldValue := valueField.Interface()
fieldPath := strings.Join(path, ".")
switch fieldSchema.Type {
case schema.TypeList, schema.TypeSet:
nv, err := collectionToMaps(fieldValue, fieldSchema, newAliases)
if err != nil {
return fmt.Errorf("%s: %v", path, err)
}
data[fieldName] = nv
default:
if fieldSchema.Optional && isValueNilOrEmpty(valueField, fieldPath) {
return nil
}
data[fieldName] = fieldValue
}
return nil
})
if err != nil {
return nil, err
}
if len(data) == 0 {
continue
}
resultList = append(resultList, data)
}
return resultList, nil
}
func isValueNilOrEmpty(valueField *reflect.Value, fieldPath string) bool {
switch valueField.Kind() {
case reflect.Ptr:
if valueField.IsNil() {
log.Printf("[TRACE] skipping empty %s %#v", fieldPath, valueField)
return true
}
case reflect.Array, reflect.Map, reflect.String, reflect.Slice:
if valueField.Len() == 0 {
log.Printf("[TRACE] skipping empty %s %#v", fieldPath, valueField)
return true
}
}
return false
}
// StructToData reads result using schema onto resource data
func StructToData(result any, s map[string]*schema.Schema, d *schema.ResourceData) error {
aliases := getAliasesMapFromStruct(result)
v := reflect.ValueOf(result)
if v.Kind() == reflect.Ptr {
v = v.Elem()
}
return iterFields(v, []string{}, s, aliases, func(
fieldSchema *schema.Schema, path []string, valueField *reflect.Value) error {
fieldValue := valueField.Interface()
if fieldValue == nil {
return nil
}
fieldPath := strings.Join(path, ".")
if fieldSchema.Optional && isValueNilOrEmpty(valueField, fieldPath) {
return nil
}
_, configured := d.GetOk(fieldPath)
if !d.IsNewResource() && !fieldSchema.Computed && !configured {
log.Printf("[TRACE] Removing default fields sent back by server: %s - %#v",
fieldPath, fieldValue)
return nil
}
switch fieldSchema.Type {
case schema.TypeList, schema.TypeSet:
es, ok := fieldSchema.Elem.(*schema.Schema)
if ok {
log.Printf("[TRACE] Set %s %s %v", es.Type, fieldPath, fieldValue)
// here we rely on Terraform SDK to perform
// validation, so we don't to it twice
return d.Set(fieldPath, fieldValue)
}
nv, err := collectionToMaps(fieldValue, fieldSchema, aliases)
if err != nil {
return fmt.Errorf("%s: %v", fieldPath, err)
}
if len(nv) == 0 {
return nil
}
log.Printf("[TRACE] set %s %#v", fieldPath, nv)
return d.Set(fieldPath, nv)
default:
log.Printf("[TRACE] set %s %#v", fieldPath, fieldValue)
return d.Set(fieldPath, fieldValue)
}
})
}
// attributeGetter is a generalization between schema.ResourceDiff & schema.ResourceData
// to those who'll be reading this code and would know public equivalent interface from
// TF SDK - feel free to replace the usages of this interface in a PR.
type attributeGetter interface {
GetOk(key string) (any, bool)
// This method should only be used for optional boolean parameters according to the Terraform docs:
// https://pkg.go.dev/github.com/hashicorp/terraform-plugin-sdk/helper/schema#ResourceData.GetOkExists
GetOkExists(key string) (any, bool)
}
// DiffToStructPointer reads resource diff with given schema onto result pointer. Panics.
func DiffToStructPointer(d attributeGetter, scm map[string]*schema.Schema, result any) {
rv := reflect.ValueOf(result)
rk := rv.Kind()
if rk != reflect.Ptr {
panic(fmt.Errorf("pointer is expected, but got %s: %#v", reflectKind(rk), result))
}
rv = rv.Elem()
aliases := getAliasesMapFromStruct(result)
err := readReflectValueFromData([]string{}, d, rv, scm, aliases)
if err != nil {
panic(err)
}
}
// DataToStructPointer reads resource data with given schema onto result pointer. Panics.
func DataToStructPointer(d *schema.ResourceData, scm map[string]*schema.Schema, result any) {
aliases := getAliasesMapFromStruct(result)
rv := reflect.ValueOf(result)
rk := rv.Kind()
if rk != reflect.Ptr {
panic(fmt.Errorf("pointer is expected, but got %s: %#v", reflectKind(rk), result))
}
rv = rv.Elem()
err := readReflectValueFromData([]string{}, d, rv, scm, aliases)
if err != nil {
panic(err)
}
}
// DataToReflectValue reads reflect value from data
func DataToReflectValue(d *schema.ResourceData, s map[string]*schema.Schema, rv reflect.Value) error {
// TODO: Pass in the right aliases map.
return readReflectValueFromData([]string{}, d, rv, s, map[string]string{})
}
// Get the aliases map from the given struct if it is an instance of ResourceProvider.
// NOTE: This does not return aliases defined on `tf` tags.
func getAliasesMapFromStruct(s any) map[string]string {
if v, ok := s.(ResourceProvider); ok {
return v.Aliases()
}
return map[string]string{}
}
func readReflectValueFromData(path []string, d attributeGetter,
rv reflect.Value, s map[string]*schema.Schema, aliases map[string]string) error {
return iterFields(rv, path, s, aliases, func(fieldSchema *schema.Schema,
path []string, valueField *reflect.Value) error {
fieldPath := strings.Join(path, ".")
fieldName := path[len(path)-1]
newAliases := unwrapAliasesMap(fieldName, aliases)
raw, ok := d.GetOk(fieldPath)
if !ok {
return nil
}
switch fieldSchema.Type {
case schema.TypeInt:
if v, ok := raw.(int); ok {
valueField.SetInt(int64(v))
}
case schema.TypeString:
if v, ok := raw.(string); ok {
valueField.SetString(v)
}
case schema.TypeBool:
if v, ok := raw.(bool); ok {
valueField.SetBool(v)
}
case schema.TypeFloat:
if v, ok := raw.(float64); ok {
valueField.SetFloat(v)
}
case schema.TypeMap:
mapValueKind := valueField.Type().Elem().Kind()
valueField.Set(reflect.MakeMap(valueField.Type()))
for key, ivalue := range raw.(map[string]any) {
vrv, err := primitiveReflectValueFromInterface(mapValueKind, ivalue, fieldPath, key)
if err != nil {
return err
}
valueField.SetMapIndex(reflect.ValueOf(key), vrv)
}
case schema.TypeSet:
// here we rely on Terraform SDK to perform validation, so we don't to it twice
rawSet := raw.(*schema.Set)
rawList := rawSet.List()
return readListFromData(path, d, rawList, valueField,
fieldSchema, newAliases, func(i int) string {
return strconv.Itoa(rawSet.F(rawList[i]))
})
case schema.TypeList:
// here we rely on Terraform SDK to perform validation, so we don't to it twice
rawList := raw.([]any)
return readListFromData(path, d, rawList, valueField, fieldSchema, newAliases, strconv.Itoa)
default:
return fmt.Errorf("%s[%v] unsupported field type", fieldPath, raw)
}
return nil
})
}
func primitiveReflectValueFromInterface(rk reflect.Kind,
ivalue any, fieldPath, key string) (rv reflect.Value, err error) {
switch rk {
case reflect.String:
return reflect.ValueOf(fmt.Sprintf("%v", ivalue)), nil
case reflect.Float32:
v, ok := ivalue.(float32)
if !ok {
err = fmt.Errorf("%s[%s] '%v' is not %s",
fieldPath, key, ivalue, reflectKind(rk))
return
}
rv = reflect.ValueOf(v)
case reflect.Float64:
v, ok := ivalue.(float64)
if !ok {
err = fmt.Errorf("%s[%s] '%v' is not %s",
fieldPath, key, ivalue, reflectKind(rk))
return
}
rv = reflect.ValueOf(v)
case reflect.Int:
v, ok := ivalue.(int)
if !ok {
err = fmt.Errorf("%s[%s] '%v' is not %s",
fieldPath, key, ivalue, reflectKind(rk))
return
}
rv = reflect.ValueOf(v)
case reflect.Bool:
v, ok := ivalue.(bool)
if !ok {
err = fmt.Errorf("%s[%s] '%v' is not %s",
fieldPath, key, ivalue, reflectKind(rk))
return
}
rv = reflect.ValueOf(v)
default:
err = fmt.Errorf("%s[%s] '%v' is not valid primitive",
fieldPath, key, ivalue)
}
return rv, err
}
func readListFromData(path []string, d attributeGetter,
rawList []any, valueField *reflect.Value, fieldSchema *schema.Schema, aliases map[string]string,
offsetConverter func(i int) string) error {
if len(rawList) == 0 {
return nil
}
fieldPath := strings.Join(path, ".")
switch valueField.Type().Kind() {
case reflect.Ptr:
vpointer := reflect.New(valueField.Type().Elem())
valueField.Set(vpointer)
ve := vpointer.Elem()
// here we rely on Terraform SDK to perform validation, so we don't to it twice
nestedResource := fieldSchema.Elem.(*schema.Resource)
nestedPath := append(path, offsetConverter(0))
return readReflectValueFromData(nestedPath, d, ve, nestedResource.Schema, aliases)
case reflect.Struct:
// code path for setting the struct value is different from pointer value
// in a single way: we set the field only after readReflectValueFromData
// traversed the graph.
vstruct := reflect.New(valueField.Type())
ve := vstruct.Elem()
nestedResource := fieldSchema.Elem.(*schema.Resource)
nestedPath := append(path, offsetConverter(0))
err := readReflectValueFromData(nestedPath, d, ve, nestedResource.Schema, aliases)
if err != nil {
return err
}
valueField.Set(ve)
return nil
case reflect.Slice:
k := valueField.Type().Elem().Kind()
newSlice := reflect.MakeSlice(valueField.Type(), len(rawList), len(rawList))
valueField.Set(newSlice)
for i, elem := range rawList {
item := newSlice.Index(i)
switch k {
case reflect.Struct:
// here we rely on Terraform SDK to perform validation, so we don't to it twice
nestedResource := fieldSchema.Elem.(*schema.Resource)
nestedPath := append(path, offsetConverter(i))
vpointer := reflect.New(valueField.Type().Elem())
ve := vpointer.Elem()
err := readReflectValueFromData(nestedPath, d, ve, nestedResource.Schema, aliases)
if err != nil {
return err
}
item.Set(ve)
default:
err := setPrimitiveValueOfKind(fieldPath, k, item, elem)
if err != nil {
return err
}
}
}
default:
return fmt.Errorf("%s[%v] unknown collection field", fieldPath, rawList)
}
return nil
}
func setPrimitiveValueOfKind(
fieldPath string, k reflect.Kind, item reflect.Value, elem any) error {
switch k {
case reflect.String:
v, ok := elem.(string)
if !ok {
return fmt.Errorf("%s[%v] is not a string", fieldPath, elem)
}
item.SetString(v)
case reflect.Int, reflect.Int64:
v, ok := elem.(int)
if !ok {
return fmt.Errorf("%s[%v] is not an int", fieldPath, elem)
}
item.SetInt(int64(v))
case reflect.Float64:
v, ok := elem.(float64)
if !ok {
return fmt.Errorf("%s[%v] is not a float64", fieldPath, elem)
}
item.SetFloat(v)
case reflect.Bool:
v, ok := elem.(bool)
if !ok {
return fmt.Errorf("%s[%v] is not a bool", fieldPath, elem)
}
item.SetBool(v)
default:
return fmt.Errorf("%s[%v] is not a valid primitive", fieldPath, elem)
}
return nil
}