mirror of
https://github.com/opentofu/opentofu.git
synced 2025-02-25 18:45:20 -06:00
eac85b506b
We have an existing warning message to encourage moving away from the old 0.11-and-earlier style of redundantly wrapping standalone expressions in templates, but due to the special rules for object keys the warning message was giving misleading advice in that context: a user following the advice as given would then encounter an error about the object key being ambiguous. To account for that, this introduces a special alternative version of the warning just for that particular position, directing the user to replace the template interpolation markers with parenthesis instead. That will then get the same result as the former interpolation sequence, rather than producing the ambiguity error.
62 lines
1.5 KiB
Go
62 lines
1.5 KiB
Go
package configs
|
|
|
|
import (
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/hashicorp/hcl/v2"
|
|
"github.com/hashicorp/hcl/v2/hclsyntax"
|
|
)
|
|
|
|
func TestWarnForDeprecatedInterpolationsInExpr(t *testing.T) {
|
|
tests := []struct {
|
|
Expr string
|
|
WantSubstr string
|
|
}{
|
|
{
|
|
`"${foo}"`,
|
|
"leaving just the inner expression",
|
|
},
|
|
{
|
|
`{"${foo}" = 1}`,
|
|
// Special message for object key expressions, because just
|
|
// removing the interpolation markers would change the meaning
|
|
// in that context.
|
|
"opening and closing parentheses respectively",
|
|
},
|
|
{
|
|
`{upper("${foo}") = 1}`,
|
|
// But no special message if the template is just descended from an
|
|
// object key, because the special interpretation applies only to
|
|
// a naked reference in te object key position.
|
|
"leaving just the inner expression",
|
|
},
|
|
}
|
|
|
|
for _, test := range tests {
|
|
t.Run(test.Expr, func(t *testing.T) {
|
|
expr, diags := hclsyntax.ParseExpression([]byte(test.Expr), "", hcl.InitialPos)
|
|
if diags.HasErrors() {
|
|
t.Fatalf("parse error: %s", diags.Error())
|
|
}
|
|
|
|
diags = warnForDeprecatedInterpolationsInExpr(expr)
|
|
if !diagWarningsContainSubstring(diags, test.WantSubstr) {
|
|
t.Errorf("wrong warning message\nwant detail substring: %s\ngot: %s", test.WantSubstr, diags.Error())
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func diagWarningsContainSubstring(diags hcl.Diagnostics, want string) bool {
|
|
for _, diag := range diags {
|
|
if diag.Severity != hcl.DiagWarning {
|
|
continue
|
|
}
|
|
if strings.Contains(diag.Detail, want) {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|