-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathtypes.go
682 lines (620 loc) · 24.6 KB
/
types.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
// Copyright © 2024. Citrix Systems, Inc.
package util
import (
"context"
"fmt"
"reflect"
"strconv"
"sync"
"github.com/hashicorp/terraform-plugin-framework/attr"
datasourceSchema "github.com/hashicorp/terraform-plugin-framework/datasource/schema"
"github.com/hashicorp/terraform-plugin-framework/diag"
resourceSchema "github.com/hashicorp/terraform-plugin-framework/resource/schema"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
)
type ResourceModelWithAttributes interface {
GetAttributes() map[string]resourceSchema.Attribute // workaround because NestedAttributeObject and SingleNestedAttribute do not share a base type
}
type DataSourceModelWithAttributes interface {
GetDataSourceAttributes() map[string]datasourceSchema.Attribute // workaround because NestedAttributeObject and SingleNestedAttribute do not share a base type
}
// Store the attribute map for each model type so we don't have to regenerate it every time
var attributeMapCache sync.Map
// Store the default object for each object type so we don't have to regenerate it every time
var defaultObjectCache sync.Map
// <summary>
// Helper function to convert a resource model to a map of attribute types. Used when converting back to a types.Object
// </summary>
// <param name="m">Model to convert, must implement the ResourceModelWithSchema interface</param>
// <returns>Map of attribute types</returns>
func ResourceAttributeMapFromObject(m ResourceModelWithAttributes) (map[string]attr.Type, error) {
keyName := reflect.TypeOf(m).String()
if attributes, ok := attributeMapCache.Load(keyName); ok {
return attributes.(map[string]attr.Type), nil
}
// not doing an extra sync/double checked lock because generating the attribute map is pretty quick
attributeMap, err := resourceAttributeMapFromSchema(m.GetAttributes())
if err != nil {
return nil, err
}
attributeMapCache.Store(keyName, attributeMap)
return attributeMap, nil
}
// <summary>
// Helper function to convert a data source model to a map of attribute types. Used when converting back to a types.Object
// </summary>
// <param name="m">Model to convert, must implement the DataSourceModelWithSchema interface</param>
// <returns>Map of attribute types</returns>
func DataSourceAttributeMapFromObject(m DataSourceModelWithAttributes) (map[string]attr.Type, error) {
keyName := reflect.TypeOf(m).String()
if attributes, ok := attributeMapCache.Load(keyName); ok {
return attributes.(map[string]attr.Type), nil
}
// not doing an extra sync/double checked lock because generating the attribute map is pretty quick
attributeMap, err := dataSourceAttributeMapFromSchema(m.GetDataSourceAttributes())
if err != nil {
return nil, err
}
attributeMapCache.Store(keyName, attributeMap)
return attributeMap, nil
}
// <summary>
// Helper function to convert a resource schema map to a map of attribute types. Used when converting back to a types.Object
// </summary>
// <param name="s">Schema map of the object</param>
// <returns>Map of attribute types</returns>
func resourceAttributeMapFromSchema(s map[string]resourceSchema.Attribute) (map[string]attr.Type, error) {
var attributeTypes = map[string]attr.Type{}
for attributeName, attribute := range s {
attrib, err := resourceAttributeToTerraformType(attribute)
if err != nil {
return nil, err
}
attributeTypes[attributeName] = attrib
}
return attributeTypes, nil
}
// <summary>
// Helper function to convert a data source schema map to a map of attribute types. Used when converting back to a types.Object
// </summary>
// <param name="s">Schema map of the object</param>
// <returns>Map of attribute types</returns>
func dataSourceAttributeMapFromSchema(s map[string]datasourceSchema.Attribute) (map[string]attr.Type, error) {
var attributeTypes = map[string]attr.Type{}
for attributeName, attribute := range s {
attrib, err := dataSourceAttributeToTerraformType(attribute)
if err != nil {
return nil, err
}
attributeTypes[attributeName] = attrib
}
return attributeTypes, nil
}
// Converts a resource schema.Attribute to a terraform attr.Type. Will recurse if the attribute contains a nested object or list of nested objects.
func resourceAttributeToTerraformType(attribute resourceSchema.Attribute) (attr.Type, error) {
switch attrib := attribute.(type) {
case resourceSchema.StringAttribute:
return types.StringType, nil
case resourceSchema.BoolAttribute:
return types.BoolType, nil
case resourceSchema.NumberAttribute:
return types.NumberType, nil
case resourceSchema.Int64Attribute:
return types.Int64Type, nil
case resourceSchema.Int32Attribute:
return types.Int32Type, nil
case resourceSchema.Float64Attribute:
return types.Float64Type, nil
case resourceSchema.Float32Attribute:
return types.Float32Type, nil
case resourceSchema.ListAttribute:
return types.ListType{ElemType: attrib.ElementType}, nil
case resourceSchema.ListNestedAttribute:
// list of object, recurse
nestedAttributes, err := resourceAttributeMapFromSchema(attrib.NestedObject.Attributes)
if err != nil {
return nil, err
}
return types.ListType{ElemType: types.ObjectType{AttrTypes: nestedAttributes}}, nil
case resourceSchema.ObjectAttribute:
return attrib.GetType(), nil
case resourceSchema.SingleNestedAttribute:
// object, recurse
nestedAttributes, err := resourceAttributeMapFromSchema(attrib.Attributes)
if err != nil {
return nil, err
}
return types.ObjectType{AttrTypes: nestedAttributes}, nil
case resourceSchema.SetAttribute:
return types.SetType{ElemType: attrib.ElementType}, nil
case resourceSchema.SetNestedAttribute:
// set of object, recurse
nestedAttributes, err := resourceAttributeMapFromSchema(attrib.NestedObject.Attributes)
if err != nil {
return nil, err
}
return types.SetType{ElemType: types.ObjectType{AttrTypes: nestedAttributes}}, nil
case resourceSchema.MapAttribute:
return types.MapType{ElemType: attrib.ElementType}, nil
case resourceSchema.MapNestedAttribute:
// map of object, recurse
nestedAttributes, err := resourceAttributeMapFromSchema(attrib.NestedObject.Attributes)
if err != nil {
return nil, err
}
return types.MapType{ElemType: types.ObjectType{AttrTypes: nestedAttributes}}, nil
}
return nil, fmt.Errorf("unsupported attribute type: %s", attribute)
}
// Converts a data source schema.Attribute to a terraform attr.Type. Will recurse if the attribute contains a nested object or list of nested objects.
func dataSourceAttributeToTerraformType(attribute datasourceSchema.Attribute) (attr.Type, error) {
switch attrib := attribute.(type) {
case datasourceSchema.StringAttribute:
return types.StringType, nil
case datasourceSchema.BoolAttribute:
return types.BoolType, nil
case datasourceSchema.NumberAttribute:
return types.NumberType, nil
case datasourceSchema.Int64Attribute:
return types.Int64Type, nil
case datasourceSchema.Int32Attribute:
return types.Int32Type, nil
case datasourceSchema.Float64Attribute:
return types.Float64Type, nil
case datasourceSchema.Float32Attribute:
return types.Float32Type, nil
case datasourceSchema.ListAttribute:
return types.ListType{ElemType: attrib.ElementType}, nil
case datasourceSchema.ListNestedAttribute:
// list of object, recurse
nestedAttributes, err := dataSourceAttributeMapFromSchema(attrib.NestedObject.Attributes)
if err != nil {
return nil, err
}
return types.ListType{ElemType: types.ObjectType{AttrTypes: nestedAttributes}}, nil
case datasourceSchema.ObjectAttribute:
return attrib.GetType(), nil
case datasourceSchema.SingleNestedAttribute:
// object, recurse
nestedAttributes, err := dataSourceAttributeMapFromSchema(attrib.Attributes)
if err != nil {
return nil, err
}
return types.ObjectType{AttrTypes: nestedAttributes}, nil
case datasourceSchema.SetAttribute:
return types.SetType{ElemType: attrib.ElementType}, nil
case datasourceSchema.SetNestedAttribute:
// set of object, recurse
nestedAttributes, err := dataSourceAttributeMapFromSchema(attrib.NestedObject.Attributes)
if err != nil {
return nil, err
}
return types.SetType{ElemType: types.ObjectType{AttrTypes: nestedAttributes}}, nil
case datasourceSchema.MapAttribute:
return types.MapType{ElemType: attrib.ElementType}, nil
case datasourceSchema.MapNestedAttribute:
// map of object, recurse
nestedAttributes, err := dataSourceAttributeMapFromSchema(attrib.NestedObject.Attributes)
if err != nil {
return nil, err
}
return types.MapType{ElemType: types.ObjectType{AttrTypes: nestedAttributes}}, nil
}
return nil, fmt.Errorf("unsupported attribute type: %s", attribute)
}
// Helper function to get and cache the default object including populating nested types.List and types.Object so they aren't nil
func defaultObjectFromObjectValue[objTyp any](ctx context.Context, v types.Object) objTyp {
var temp objTyp
keyName := reflect.TypeOf(temp).String()
if defaultObject, ok := defaultObjectCache.Load(keyName); ok {
return defaultObject.(objTyp)
}
// not doing an extra sync/double checked lock because generating the default object is pretty quick
// Use reflect to build a top level map from tfsdk:field_name to the reflect field value
attributeByTag := map[string]reflect.Value{}
val := reflect.ValueOf(&temp).Elem()
for i := 0; i < val.NumField(); i++ {
field := val.Type().Field(i)
if tag, ok := field.Tag.Lookup("tfsdk"); ok {
attributeByTag[tag] = val.Field(i)
}
}
m := v.AttributeTypes(ctx)
for attributeName, attributeVal := range m {
if reflectAttribute, ok := attributeByTag[attributeName]; ok {
// If this attribute is a nested attribute, use the reflect field to create a new null/unknown with the proper attributeMap
// If this isn't done the framework will return errors like "Value Conversion Error, Expected framework type from provider logic ... Received framework type from provider logic: types._____[]"
if attributeVal, ok := attributeVal.(types.ObjectType); ok {
attributeMap := attributeVal.AttributeTypes()
reflectAttribute.Set(reflect.ValueOf(types.ObjectNull(attributeMap)))
}
if attributeVal, ok := attributeVal.(types.ListType); ok {
elemType := attributeVal.ElementType()
reflectAttribute.Set(reflect.ValueOf(types.ListNull(elemType)))
}
if attributeVal, ok := attributeVal.(types.SetType); ok {
elemType := attributeVal.ElementType()
reflectAttribute.Set(reflect.ValueOf(types.SetNull(elemType)))
}
if attributeVal, ok := attributeVal.(types.MapType); ok {
elemType := attributeVal.ElementType()
reflectAttribute.Set(reflect.ValueOf(types.MapNull(elemType)))
}
}
}
defaultObjectCache.Store(keyName, temp)
return temp
}
// <summary>
// Helper function to convert a native terraform object to a golang object of the specified type.
// Use TypedObjectToObjectValue to go the other way.
// </summary>
// <param name="ctx">context</param>
// <param name="diagnostics">Any issues will be appended to these diagnostics</param>
// <param name="v">Object in the native terraform types.Object wrapper</param>
// <returns>Object of the specified type</returns>
func ObjectValueToTypedObject[objTyp any](ctx context.Context, diagnostics *diag.Diagnostics, v types.Object) objTyp {
temp := defaultObjectFromObjectValue[objTyp](ctx, v)
if v.IsNull() || v.IsUnknown() {
return temp
}
diags := v.As(ctx, &temp, basetypes.ObjectAsOptions{})
if diags != nil {
diagnostics.Append(diags...)
}
return temp
}
// <summary>
// Helper function to convert a golang object to a native terraform object.
// Use ObjectValueToTypedObject to go the other way.
// </summary>
// <param name="ctx">"context</param>
// <param name="diagnostics">Any issues will be appended to these diagnostics</param>
// <param name="v">Object of the specified type</param>
// <param name="s">Schema map of the object</param>
// <returns>Object in the native terraform types.Object wrapper</returns>
func TypedObjectToObjectValue(ctx context.Context, diagnostics *diag.Diagnostics, v ResourceModelWithAttributes) types.Object {
attributesMap, err := ResourceAttributeMapFromObject(v)
if err != nil {
diagnostics.AddError("Error converting schema to attribute map", err.Error())
}
if v == nil {
return types.ObjectNull(attributesMap)
}
obj, diags := types.ObjectValueFrom(ctx, attributesMap, v)
if diags != nil {
diagnostics.Append(diags...)
return types.ObjectUnknown(attributesMap)
}
return obj
}
// <summary>
// Helper function to convert a golang object to a native terraform object.
// Use ObjectValueToTypedObject to go the other way.
// </summary>
// <param name="ctx">"context</param>
// <param name="diagnostics">Any issues will be appended to these diagnostics</param>
// <param name="v">Object of the specified type</param>
// <param name="s">Schema map of the object</param>
// <returns>Object in the native terraform types.Object wrapper</returns>
func DataSourceTypedObjectToObjectValue(ctx context.Context, diagnostics *diag.Diagnostics, v DataSourceModelWithAttributes) types.Object {
attributesMap, err := DataSourceAttributeMapFromObject(v)
if err != nil {
diagnostics.AddError("Error converting schema to attribute map", err.Error())
}
if v == nil {
return types.ObjectNull(attributesMap)
}
obj, diags := types.ObjectValueFrom(ctx, attributesMap, v)
if diags != nil {
diagnostics.Append(diags...)
return types.ObjectUnknown(attributesMap)
}
return obj
}
// <summary>
// Helper function to convert a native terraform list of objects to a golang slice of the specified type
// Use TypedArrayToObjectList to go the other way.
// </summary>
// <param name="ctx">context</param>
// <param name="diagnostics">Any issues will be appended to these diagnostics</param>
// <param name="v">List of object in the native terraform types.List wrapper</param>
// <returns>Array of the specified type</returns>
func ObjectListToTypedArray[objTyp any](ctx context.Context, diagnostics *diag.Diagnostics, v types.List) []objTyp {
res := make([]types.Object, 0, len(v.Elements()))
if v.IsNull() || v.IsUnknown() {
return nil
}
// convert to slice of TF type
diags := v.ElementsAs(ctx, &res, false)
if diags != nil {
diagnostics.Append(diags...)
return nil
}
// convert to slice of real objects
arr := make([]objTyp, 0, len(res))
for _, val := range res {
arr = append(arr, ObjectValueToTypedObject[objTyp](ctx, diagnostics, val))
}
return arr
}
// <summary>
// Helper function to convert a golang slice to a native terraform list of objects.
// Use ObjectListToTypedArray to go the other way.
// </summary>
// <param name="diagnostics">Any issues will be appended to these diagnostics</param>
// <param name="v">Slice of objects</param>
// <returns>types.List</returns>
func TypedArrayToObjectList[objTyp ResourceModelWithAttributes](ctx context.Context, diagnostics *diag.Diagnostics, v []objTyp) types.List {
var t objTyp
attributesMap, err := ResourceAttributeMapFromObject(t)
if err != nil {
diagnostics.AddError("Error converting schema to attribute map", err.Error())
}
if v == nil {
return types.ListNull(types.ObjectType{AttrTypes: attributesMap})
}
res := make([]types.Object, 0, len(v))
for _, val := range v {
res = append(res, TypedObjectToObjectValue(ctx, diagnostics, val))
}
list, diags := types.ListValueFrom(ctx, types.ObjectType{AttrTypes: attributesMap}, res)
if diags != nil {
diagnostics.Append(diags...)
return types.ListNull(types.ObjectType{AttrTypes: attributesMap})
}
return list
}
// <summary>
// Helper function to convert a golang slice to a native terraform list of objects.
// Use ObjectListToTypedArray to go the other way.
// </summary>
// <param name="diagnostics">Any issues will be appended to these diagnostics</param>
// <param name="v">Slice of objects</param>
// <returns>types.List</returns>
func DataSourceTypedArrayToObjectList[objTyp DataSourceModelWithAttributes](ctx context.Context, diagnostics *diag.Diagnostics, v []objTyp) types.List {
var t objTyp
attributesMap, err := DataSourceAttributeMapFromObject(t)
if err != nil {
diagnostics.AddError("Error converting schema to attribute map", err.Error())
}
if v == nil {
return types.ListNull(types.ObjectType{AttrTypes: attributesMap})
}
res := make([]types.Object, 0, len(v))
for _, val := range v {
res = append(res, DataSourceTypedObjectToObjectValue(ctx, diagnostics, val))
}
list, diags := types.ListValueFrom(ctx, types.ObjectType{AttrTypes: attributesMap}, res)
if diags != nil {
diagnostics.Append(diags...)
return types.ListNull(types.ObjectType{AttrTypes: attributesMap})
}
return list
}
// <summary>
// Helper function to convert a native terraform list of objects to a golang slice of the specified type
// Use TypedArrayToObjectSet to go the other way.
// </summary>
// <param name="ctx">context</param>
// <param name="diagnostics">Any issues will be appended to these diagnostics</param>
// <param name="v">Set of object in the native terraform types.Set wrapper</param>
// <returns>Array of the specified type</returns>
func ObjectSetToTypedArray[objTyp any](ctx context.Context, diagnostics *diag.Diagnostics, v types.Set) []objTyp {
res := make([]types.Object, 0, len(v.Elements()))
if v.IsNull() || v.IsUnknown() {
return nil
}
// convert to slice of TF type
diags := v.ElementsAs(ctx, &res, false)
if diags != nil {
diagnostics.Append(diags...)
return nil
}
// convert to slice of real objects
arr := make([]objTyp, 0, len(res))
for _, val := range res {
arr = append(arr, ObjectValueToTypedObject[objTyp](ctx, diagnostics, val))
}
return arr
}
// <summary>
// Helper function to convert a golang slice to a native terraform list of objects.
// Use ObjectSetToTypedArray to go the other way.
// </summary>
// <param name="diagnostics">Any issues will be appended to these diagnostics</param>
// <param name="v">Slice of objects</param>
// <returns>types.Set</returns>
func TypedArrayToObjectSet[objTyp ResourceModelWithAttributes](ctx context.Context, diagnostics *diag.Diagnostics, v []objTyp) types.Set {
var t objTyp
attributesMap, err := ResourceAttributeMapFromObject(t)
if err != nil {
diagnostics.AddError("Error converting schema to attribute map", err.Error())
}
if v == nil {
return types.SetNull(types.ObjectType{AttrTypes: attributesMap})
}
res := make([]types.Object, 0, len(v))
for _, val := range v {
res = append(res, TypedObjectToObjectValue(ctx, diagnostics, val))
}
set, diags := types.SetValueFrom(ctx, types.ObjectType{AttrTypes: attributesMap}, res)
if diags != nil {
diagnostics.Append(diags...)
return types.SetNull(types.ObjectType{AttrTypes: attributesMap})
}
return set
}
// <summary>
// Helper function to convert a golang slice to a native terraform list of objects.
// Use ObjectSetToTypedArray to go the other way.
// </summary>
// <param name="diagnostics">Any issues will be appended to these diagnostics</param>
// <param name="v">Slice of objects</param>
// <returns>types.Set</returns>
func DataSourceTypedArrayToObjectSet[objTyp DataSourceModelWithAttributes](ctx context.Context, diagnostics *diag.Diagnostics, v []objTyp) types.Set {
var t objTyp
attributesMap, err := DataSourceAttributeMapFromObject(t)
if err != nil {
diagnostics.AddError("Error converting schema to attribute map", err.Error())
}
if v == nil {
return types.SetNull(types.ObjectType{AttrTypes: attributesMap})
}
res := make([]types.Object, 0, len(v))
for _, val := range v {
res = append(res, DataSourceTypedObjectToObjectValue(ctx, diagnostics, val))
}
set, diags := types.SetValueFrom(ctx, types.ObjectType{AttrTypes: attributesMap}, res)
if diags != nil {
diagnostics.Append(diags...)
return types.SetNull(types.ObjectType{AttrTypes: attributesMap})
}
return set
}
// <summary>
// Helper function to convert a terraform list of terraform strings to array of golang primitive strings.
// Use StringArrayToStringList to go the other way.
// </summary>
// <param name="v">List of terraform strings</param>
// <returns>Array of golang primitive strings</returns>
func StringListToStringArray(ctx context.Context, diagnostics *diag.Diagnostics, v types.List) []string {
res := make([]types.String, 0, len(v.Elements()))
if v.IsNull() || v.IsUnknown() {
return nil
}
// convert to slice of TF type
diags := v.ElementsAs(ctx, &res, false)
if diags != nil {
diagnostics.Append(diags...)
return nil
}
arr := []string{}
for _, stringVal := range res {
arr = append(arr, stringVal.ValueString())
}
return arr
}
// <summary>
// Helper function to convert a golang slice of string to a native terraform list of strings.
// Use StringListToStringArray to go the other way.
// </summary>
// <param name="diagnostics">Any issues will be appended to these diagnostics</param>
// <param name="v">Slice of strings</param>
// <returns>types.List</returns>
func StringArrayToStringList(ctx context.Context, diagnostics *diag.Diagnostics, v []string) types.List {
if v == nil {
return types.ListNull(types.StringType)
}
res := make([]types.String, 0, len(v))
for _, val := range v {
res = append(res, basetypes.NewStringValue(val))
}
list, diags := types.ListValueFrom(ctx, types.StringType, res)
if diags != nil {
diagnostics.Append(diags...)
return types.ListNull(types.StringType)
}
return list
}
// <summary>
// Helper function to convert a terraform set of terraform strings to array of golang primitive strings.
// Use StringArrayToStringSet to go the other way.
// </summary>
// <param name="v">Set of terraform strings</param>
// <returns>Array of golang primitive strings</returns>
func StringSetToStringArray(ctx context.Context, diagnostics *diag.Diagnostics, v types.Set) []string {
res := make([]types.String, 0, len(v.Elements()))
if v.IsNull() || v.IsUnknown() {
return nil
}
// convert to slice of TF type
diags := v.ElementsAs(ctx, &res, false)
if diags != nil {
diagnostics.Append(diags...)
return nil
}
arr := []string{}
for _, stringVal := range res {
arr = append(arr, stringVal.ValueString())
}
return arr
}
// <summary>
// Helper function to convert a golang slice of string to a native terraform set of strings.
// Use StringSetToStringArray to go the other way.
// </summary>
// <param name="diagnostics">Any issues will be appended to these diagnostics</param>
// <param name="v">Slice of strings</param>
// <returns>types.Set</returns>
func StringArrayToStringSet(ctx context.Context, diagnostics *diag.Diagnostics, v []string) types.Set {
if v == nil {
return types.SetNull(types.StringType)
}
res := make([]types.String, 0, len(v))
for _, val := range v {
res = append(res, basetypes.NewStringValue(val))
}
set, diags := types.SetValueFrom(ctx, types.StringType, res)
if diags != nil {
diagnostics.Append(diags...)
return types.SetNull(types.StringType)
}
return set
}
// <summary>
// Helper function to convert array of terraform strings to array of golang primitive strings
// Deprecated: Remove after we fully move to types.List
// </summary>
// <param name="v">Array of terraform stringsArray of golang primitive strings</param>
// <returns>Array of golang primitive strings</returns>
func ConvertBaseStringArrayToPrimitiveStringArray(v []types.String) []string {
res := []string{}
for _, stringVal := range v {
res = append(res, stringVal.ValueString())
}
return res
}
// <summary>
// Helper function to convert array of golang primitive interface to native terraform list of strings
// </summary>
// <param name="v">Array of golang primitive interface</param>
// <returns>Terraform list of strings</returns>
func ConvertPrimitiveInterfaceArrayToStringList(ctx context.Context, diagnostics *diag.Diagnostics, v []interface{}) (types.List, string) {
if v == nil {
return types.ListNull(types.StringType), ""
}
res := make([]types.String, 0, len(v))
for _, val := range v {
switch stringVal := val.(type) {
case string:
res = append(res, basetypes.NewStringValue(stringVal))
default:
return types.ListNull(types.StringType), "At this time, only string values are supported in arrays."
}
}
resList, diags := types.ListValueFrom(ctx, types.StringType, res)
if diags != nil {
diagnostics.Append(diags...)
return types.ListNull(types.StringType), "An error occurred when converting base string array to list of strings"
}
return resList, ""
}
// <summary>
// Helper function to convert terraform bool value to string
// </summary>
// <param name="from">Boolean value in terraform bool</param>
// <returns>Boolean value in string</returns>
func TypeBoolToString(from types.Bool) string {
return strconv.FormatBool(from.ValueBool())
}
// <summary>
// Helper function to convert string to terraform boolean value
// </summary>
// <param name="from">Boolean value in string</param>
// <returns>Boolean value in terraform types.Bool</returns>
func StringToTypeBool(from string) types.Bool {
result, _ := strconv.ParseBool(from)
return types.BoolValue(result)
}