/
list.go
550 lines (476 loc) · 16 KB
/
list.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
package types
import (
"context"
"fmt"
"strings"
"github.com/hashicorp/terraform-plugin-go/tftypes"
"github.com/hashicorp/terraform-plugin-framework/attr"
"github.com/hashicorp/terraform-plugin-framework/attr/xattr"
"github.com/hashicorp/terraform-plugin-framework/diag"
"github.com/hashicorp/terraform-plugin-framework/internal/reflect"
"github.com/hashicorp/terraform-plugin-framework/path"
)
var (
_ attr.Type = ListType{}
_ attr.Value = &List{}
)
// ListType is an AttributeType representing a list of values. All values must
// be of the same type, which the provider must specify as the ElemType
// property.
type ListType struct {
ElemType attr.Type
}
// ElementType returns the attr.Type elements will be created from.
func (l ListType) ElementType() attr.Type {
return l.ElemType
}
// WithElementType returns a ListType that is identical to `l`, but with the
// element type set to `typ`.
func (l ListType) WithElementType(typ attr.Type) attr.TypeWithElementType {
return ListType{ElemType: typ}
}
// TerraformType returns the tftypes.Type that should be used to
// represent this type. This constrains what user input will be
// accepted and what kind of data can be set in state. The framework
// will use this to translate the AttributeType to something Terraform
// can understand.
func (l ListType) TerraformType(ctx context.Context) tftypes.Type {
return tftypes.List{
ElementType: l.ElemType.TerraformType(ctx),
}
}
// ValueFromTerraform returns an attr.Value given a tftypes.Value.
// This is meant to convert the tftypes.Value into a more convenient Go
// type for the provider to consume the data with.
func (l ListType) ValueFromTerraform(ctx context.Context, in tftypes.Value) (attr.Value, error) {
list := List{
ElemType: l.ElemType,
state: valueStateDeprecated,
}
if in.Type() == nil {
list.Null = true
return list, nil
}
if !in.Type().Equal(l.TerraformType(ctx)) {
return nil, fmt.Errorf("can't use %s as value of List with ElementType %T, can only use %s values", in.String(), l.ElemType, l.ElemType.TerraformType(ctx).String())
}
if !in.IsKnown() {
list.Unknown = true
return list, nil
}
if in.IsNull() {
list.Null = true
return list, nil
}
val := []tftypes.Value{}
err := in.As(&val)
if err != nil {
return nil, err
}
elems := make([]attr.Value, 0, len(val))
for _, elem := range val {
av, err := l.ElemType.ValueFromTerraform(ctx, elem)
if err != nil {
return nil, err
}
elems = append(elems, av)
}
list.Elems = elems
return list, nil
}
// Equal returns true if `o` is also a ListType and has the same ElemType.
func (l ListType) Equal(o attr.Type) bool {
if l.ElemType == nil {
return false
}
other, ok := o.(ListType)
if !ok {
return false
}
return l.ElemType.Equal(other.ElemType)
}
// ApplyTerraform5AttributePathStep applies the given AttributePathStep to the
// list.
func (l ListType) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (interface{}, error) {
if _, ok := step.(tftypes.ElementKeyInt); !ok {
return nil, fmt.Errorf("cannot apply step %T to ListType", step)
}
return l.ElemType, nil
}
// String returns a human-friendly description of the ListType.
func (l ListType) String() string {
return "types.ListType[" + l.ElemType.String() + "]"
}
// Validate validates all elements of the list that are of type
// xattr.TypeWithValidate.
func (l ListType) Validate(ctx context.Context, in tftypes.Value, path path.Path) diag.Diagnostics {
var diags diag.Diagnostics
if in.Type() == nil {
return diags
}
if !in.Type().Is(tftypes.List{}) {
err := fmt.Errorf("expected List value, received %T with value: %v", in, in)
diags.AddAttributeError(
path,
"List Type Validation Error",
"An unexpected error was encountered trying to validate an attribute value. This is always an error in the provider. Please report the following to the provider developer:\n\n"+err.Error(),
)
return diags
}
if !in.IsKnown() || in.IsNull() {
return diags
}
var elems []tftypes.Value
if err := in.As(&elems); err != nil {
diags.AddAttributeError(
path,
"List Type Validation Error",
"An unexpected error was encountered trying to validate an attribute value. This is always an error in the provider. Please report the following to the provider developer:\n\n"+err.Error(),
)
return diags
}
validatableType, isValidatable := l.ElemType.(xattr.TypeWithValidate)
if !isValidatable {
return diags
}
for index, elem := range elems {
if !elem.IsFullyKnown() {
continue
}
diags = append(diags, validatableType.Validate(ctx, elem, path.AtListIndex(index))...)
}
return diags
}
// ValueType returns the Value type.
func (t ListType) ValueType(_ context.Context) attr.Value {
return List{
ElemType: t.ElemType,
}
}
// ListNull creates a List with a null value. Determine whether the value is
// null via the List type IsNull method.
//
// Setting the deprecated List type ElemType, Elems, Null, or Unknown fields
// after creating a List with this function has no effect.
func ListNull(elementType attr.Type) List {
return List{
elementType: elementType,
state: valueStateNull,
}
}
// ListUnknown creates a List with an unknown value. Determine whether the
// value is unknown via the List type IsUnknown method.
//
// Setting the deprecated List type ElemType, Elems, Null, or Unknown fields
// after creating a List with this function has no effect.
func ListUnknown(elementType attr.Type) List {
return List{
elementType: elementType,
state: valueStateUnknown,
}
}
// ListValue creates a List with a known value. Access the value via the List
// type Elements or ElementsAs methods.
//
// Setting the deprecated List type ElemType, Elems, Null, or Unknown fields
// after creating a List with this function has no effect.
func ListValue(elementType attr.Type, elements []attr.Value) (List, diag.Diagnostics) {
var diags diag.Diagnostics
// Reference: https://github.com/hashicorp/terraform-plugin-framework/issues/521
ctx := context.Background()
for idx, element := range elements {
if !elementType.Equal(element.Type(ctx)) {
diags.AddError(
"Invalid List Element Type",
"While creating a List value, an invalid element was detected. "+
"A List must use the single, given element type. "+
"This is always an issue with the provider and should be reported to the provider developers.\n\n"+
fmt.Sprintf("List Element Type: %s\n", elementType.String())+
fmt.Sprintf("List Index (%d) Element Type: %s", idx, element.Type(ctx)),
)
}
}
if diags.HasError() {
return ListUnknown(elementType), diags
}
return List{
elementType: elementType,
elements: elements,
state: valueStateKnown,
}, nil
}
// ListValueFrom creates a List with a known value, using reflection rules.
// The elements must be a slice which can convert into the given element type.
// Access the value via the List type Elements or ElementsAs methods.
func ListValueFrom(ctx context.Context, elementType attr.Type, elements any) (List, diag.Diagnostics) {
attrValue, diags := reflect.FromValue(
ctx,
ListType{ElemType: elementType},
elements,
path.Empty(),
)
if diags.HasError() {
return ListUnknown(elementType), diags
}
list, ok := attrValue.(List)
// This should not happen, but ensure there is an error if it does.
if !ok {
diags.AddError(
"Unable to Convert List Value",
"An unexpected result occurred when creating a List using ListValueFrom. "+
"This is an issue with terraform-plugin-framework and should be reported to the provider developers.",
)
}
return list, diags
}
// ListValueMust creates a List with a known value, converting any diagnostics
// into a panic at runtime. Access the value via the List
// type Elements or ElementsAs methods.
//
// This creation function is only recommended to create List values which will
// not potentially effect practitioners, such as testing, or exhaustively
// tested provider logic.
//
// Setting the deprecated List type ElemType, Elems, Null, or Unknown fields
// after creating a List with this function has no effect.
func ListValueMust(elementType attr.Type, elements []attr.Value) List {
list, diags := ListValue(elementType, elements)
if diags.HasError() {
// This could potentially be added to the diag package.
diagsStrings := make([]string, 0, len(diags))
for _, diagnostic := range diags {
diagsStrings = append(diagsStrings, fmt.Sprintf(
"%s | %s | %s",
diagnostic.Severity(),
diagnostic.Summary(),
diagnostic.Detail()))
}
panic("ListValueMust received error(s): " + strings.Join(diagsStrings, "\n"))
}
return list
}
// List represents a list of attr.Values, all of the same type, indicated
// by ElemType.
type List struct {
// Unknown will be set to true if the entire list is an unknown value.
// If only some of the elements in the list are unknown, their known or
// unknown status will be represented however that attr.Value
// surfaces that information. The List's Unknown property only tracks
// if the number of elements in a List is known, not whether the
// elements that are in the list are known.
//
// If the List was created with the ListValue, ListNull, or ListUnknown
// functions, changing this field has no effect.
//
// Deprecated: Use the ListUnknown function to create an unknown List
// value or use the IsUnknown method to determine whether the List value
// is unknown instead.
Unknown bool
// Null will be set to true if the list is null, either because it was
// omitted from the configuration, state, or plan, or because it was
// explicitly set to null.
//
// If the List was created with the ListValue, ListNull, or ListUnknown
// functions, changing this field has no effect.
//
// Deprecated: Use the ListNull function to create a null List value or
// use the IsNull method to determine whether the List value is null
// instead.
Null bool
// Elems are the elements in the list.
//
// If the List was created with the ListValue, ListNull, or ListUnknown
// functions, changing this field has no effect.
//
// Deprecated: Use the ListValue function to create a known List value or
// use the Elements or ElementsAs methods to retrieve the List elements
// instead.
Elems []attr.Value
// ElemType is the tftypes.Type of the elements in the list. All
// elements in the list must be of this type.
//
// Deprecated: Use the ListValue, ListNull, or ListUnknown functions
// to create a List or use the ElementType method to retrieve the
// List element type instead.
ElemType attr.Type
// elements is the collection of known values in the List.
elements []attr.Value
// elementType is the type of the elements in the List.
elementType attr.Type
// state represents whether the List is null, unknown, or known. During the
// exported field deprecation period, this state can also be "deprecated",
// which remains the zero-value for compatibility to ensure exported field
// updates take effect. The zero-value will be changed to null in a future
// version.
state valueState
}
// Elements returns the collection of elements for the List. Returns nil if the
// List is null or unknown.
func (l List) Elements() []attr.Value {
if l.state == valueStateDeprecated {
return l.Elems
}
return l.elements
}
// ElementsAs populates `target` with the elements of the List, throwing an
// error if the elements cannot be stored in `target`.
func (l List) ElementsAs(ctx context.Context, target interface{}, allowUnhandled bool) diag.Diagnostics {
// we need a tftypes.Value for this List to be able to use it with our
// reflection code
values, err := l.ToTerraformValue(ctx)
if err != nil {
return diag.Diagnostics{
diag.NewErrorDiagnostic(
"List Element Conversion Error",
"An unexpected error was encountered trying to convert list elements. This is always an error in the provider. Please report the following to the provider developer:\n\n"+err.Error(),
),
}
}
return reflect.Into(ctx, ListType{ElemType: l.ElemType}, values, target, reflect.Options{
UnhandledNullAsEmpty: allowUnhandled,
UnhandledUnknownAsEmpty: allowUnhandled,
}, path.Empty())
}
// ElementType returns the element type for the List.
func (l List) ElementType(_ context.Context) attr.Type {
if l.state == valueStateDeprecated {
return l.ElemType
}
return l.elementType
}
// Type returns a ListType with the same element type as `l`.
func (l List) Type(ctx context.Context) attr.Type {
return ListType{ElemType: l.ElementType(ctx)}
}
// ToTerraformValue returns the data contained in the List as a tftypes.Value.
func (l List) ToTerraformValue(ctx context.Context) (tftypes.Value, error) {
if l.state == valueStateDeprecated && l.ElemType == nil {
return tftypes.Value{}, fmt.Errorf("cannot convert List to tftypes.Value if ElemType field is not set")
}
listType := tftypes.List{ElementType: l.ElementType(ctx).TerraformType(ctx)}
switch l.state {
case valueStateDeprecated:
if l.Unknown {
return tftypes.NewValue(listType, tftypes.UnknownValue), nil
}
if l.Null {
return tftypes.NewValue(listType, nil), nil
}
vals := make([]tftypes.Value, 0, len(l.Elems))
for _, elem := range l.Elems {
val, err := elem.ToTerraformValue(ctx)
if err != nil {
return tftypes.NewValue(listType, tftypes.UnknownValue), err
}
vals = append(vals, val)
}
if err := tftypes.ValidateValue(listType, vals); err != nil {
return tftypes.NewValue(listType, tftypes.UnknownValue), err
}
return tftypes.NewValue(listType, vals), nil
case valueStateKnown:
vals := make([]tftypes.Value, 0, len(l.elements))
for _, elem := range l.elements {
val, err := elem.ToTerraformValue(ctx)
if err != nil {
return tftypes.NewValue(listType, tftypes.UnknownValue), err
}
vals = append(vals, val)
}
if err := tftypes.ValidateValue(listType, vals); err != nil {
return tftypes.NewValue(listType, tftypes.UnknownValue), err
}
return tftypes.NewValue(listType, vals), nil
case valueStateNull:
return tftypes.NewValue(listType, nil), nil
case valueStateUnknown:
return tftypes.NewValue(listType, tftypes.UnknownValue), nil
default:
panic(fmt.Sprintf("unhandled List state in ToTerraformValue: %s", l.state))
}
}
// Equal returns true if the List is considered semantically equal
// (same type and same value) to the attr.Value passed as an argument.
func (l List) Equal(o attr.Value) bool {
other, ok := o.(List)
if !ok {
return false
}
if l.state != other.state {
return false
}
if l.state == valueStateKnown {
if !l.elementType.Equal(other.elementType) {
return false
}
if len(l.elements) != len(other.elements) {
return false
}
for idx, lElem := range l.elements {
otherElem := other.elements[idx]
if !lElem.Equal(otherElem) {
return false
}
}
return true
}
if l.Unknown != other.Unknown {
return false
}
if l.Null != other.Null {
return false
}
if l.ElemType == nil && other.ElemType != nil {
return false
}
if l.ElemType != nil && !l.ElemType.Equal(other.ElemType) {
return false
}
if len(l.Elems) != len(other.Elems) {
return false
}
for pos, lElem := range l.Elems {
oElem := other.Elems[pos]
if !lElem.Equal(oElem) {
return false
}
}
return true
}
// IsNull returns true if the List represents a null value.
func (l List) IsNull() bool {
if l.state == valueStateNull {
return true
}
return l.state == valueStateDeprecated && l.Null
}
// IsUnknown returns true if the List represents a currently unknown value.
// Returns false if the List has a known number of elements, even if all are
// unknown values.
func (l List) IsUnknown() bool {
if l.state == valueStateUnknown {
return true
}
return l.state == valueStateDeprecated && l.Unknown
}
// String returns a human-readable representation of the List value.
// The string returned here is not protected by any compatibility guarantees,
// and is intended for logging and error reporting.
func (l List) String() string {
if l.IsUnknown() {
return attr.UnknownValueString
}
if l.IsNull() {
return attr.NullValueString
}
var res strings.Builder
res.WriteString("[")
for i, e := range l.Elements() {
if i != 0 {
res.WriteString(",")
}
res.WriteString(e.String())
}
res.WriteString("]")
return res.String()
}