-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add an hcl2 function that return true if all the value in a collection are true, this function was derived from terraform codebase
- Loading branch information
Showing
5 changed files
with
155 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
package function | ||
|
||
import ( | ||
"github.com/zclconf/go-cty/cty" | ||
"github.com/zclconf/go-cty/cty/function" | ||
) | ||
|
||
// AllTrueFunc constructs a function that returns true if all elements of the | ||
// list are true. If the list is empty, return true. | ||
var AllTrue = function.New(&function.Spec{ | ||
Params: []function.Parameter{ | ||
{ | ||
Name: "list", | ||
Type: cty.List(cty.Bool), | ||
}, | ||
}, | ||
Type: function.StaticReturnType(cty.Bool), | ||
RefineResult: refineNotNull, | ||
Impl: func(args []cty.Value, retType cty.Type) (ret cty.Value, err error) { | ||
result := cty.True | ||
for it := args[0].ElementIterator(); it.Next(); { | ||
_, v := it.Element() | ||
if !v.IsKnown() { | ||
return cty.UnknownVal(cty.Bool), nil | ||
} | ||
if v.IsNull() { | ||
return cty.False, nil | ||
} | ||
result = result.And(v) | ||
if result.False() { | ||
return cty.False, nil | ||
} | ||
} | ||
return result, nil | ||
}, | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
// Copyright (c) HashiCorp, Inc. | ||
// SPDX-License-Identifier: BUSL-1.1 | ||
|
||
package function | ||
|
||
import ( | ||
"fmt" | ||
"testing" | ||
|
||
"github.com/zclconf/go-cty/cty" | ||
) | ||
|
||
func TestAllTrue(t *testing.T) { | ||
tests := []struct { | ||
Collection cty.Value | ||
Want cty.Value | ||
Err bool | ||
}{ | ||
{ | ||
cty.ListValEmpty(cty.Bool), | ||
cty.True, | ||
false, | ||
}, | ||
{ | ||
cty.ListVal([]cty.Value{cty.True}), | ||
cty.True, | ||
false, | ||
}, | ||
{ | ||
cty.ListVal([]cty.Value{cty.False}), | ||
cty.False, | ||
false, | ||
}, | ||
{ | ||
cty.ListVal([]cty.Value{cty.True, cty.False}), | ||
cty.False, | ||
false, | ||
}, | ||
{ | ||
cty.ListVal([]cty.Value{cty.False, cty.True}), | ||
cty.False, | ||
false, | ||
}, | ||
{ | ||
cty.ListVal([]cty.Value{cty.True, cty.NullVal(cty.Bool)}), | ||
cty.False, | ||
false, | ||
}, | ||
{ | ||
cty.ListVal([]cty.Value{cty.UnknownVal(cty.Bool)}), | ||
cty.UnknownVal(cty.Bool).RefineNotNull(), | ||
false, | ||
}, | ||
{ | ||
cty.ListVal([]cty.Value{ | ||
cty.UnknownVal(cty.Bool), | ||
cty.UnknownVal(cty.Bool), | ||
}), | ||
cty.UnknownVal(cty.Bool).RefineNotNull(), | ||
false, | ||
}, | ||
{ | ||
cty.UnknownVal(cty.List(cty.Bool)), | ||
cty.UnknownVal(cty.Bool).RefineNotNull(), | ||
false, | ||
}, | ||
{ | ||
cty.NullVal(cty.List(cty.Bool)), | ||
cty.NilVal, | ||
true, | ||
}, | ||
} | ||
|
||
for _, tc := range tests { | ||
t.Run(fmt.Sprintf("alltrue(%#v)", tc.Collection), func(t *testing.T) { | ||
got, err := AllTrue.Call([]cty.Value{tc.Collection}) | ||
|
||
if tc.Err && err == nil { | ||
t.Fatal("succeeded; want error") | ||
} | ||
if !tc.Err && err != nil { | ||
t.Fatalf("unexpected error: %s", err) | ||
} | ||
if !got.RawEquals(tc.Want) { | ||
t.Errorf("wrong result\ngot: %#v\nwant: %#v", got, tc.Want) | ||
} | ||
}) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
25 changes: 25 additions & 0 deletions
25
website/content/docs/templates/hcl_templates/functions/collection/alltrue.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
page_title: alltrue - Functions - Configuration Language | ||
description: |- | ||
The alltrue function determines whether all elements of a collection | ||
are true or "true". If the collection is empty, it returns true. | ||
--- | ||
|
||
# `alltrue` Function | ||
|
||
`alltrue` returns `true` if all elements in a given collection are `true` | ||
or `"true"`. It also returns `true` if the collection is empty. | ||
|
||
```hcl | ||
alltrue(list) | ||
``` | ||
|
||
## Examples | ||
|
||
```command | ||
> alltrue(["true", true]) | ||
true | ||
> alltrue([true, false]) | ||
false | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters