Skip to content

Return error when the template's single interpolation results in null value #736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+35 −1
Open

Return error when the template's single interpolation results in null value #736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion hclsyntax/expression_template.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,21 @@ func (e *TemplateWrapExpr) walkChildNodes(w internalWalkFunc) {
}

func (e *TemplateWrapExpr) Value(ctx *hcl.EvalContext) (cty.Value, hcl.Diagnostics) {
return e.Wrapped.Value(ctx)
val, diags := e.Wrapped.Value(ctx)

// If the single interpolation result is null, we need to return the same
// error as we would for a TemplateExpr with a null part.
if val.IsNull() {
diags = append(diags, &hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Invalid template interpolation value",
Detail: "The expression result is null. Cannot include a null value in a string template.",
Subject: e.Range().Ptr(),
Expression: e.Wrapped,
EvalContext: ctx,
})
}
return val, diags
}

func (e *TemplateWrapExpr) Range() hcl.Range {
Expand Down
20 changes: 20 additions & 0 deletions hclsyntax/expression_template_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,26 @@ trim`,
cty.UnknownVal(cty.String).Mark("sensitive").Refine().NotNull().StringPrefixFull("test_").NewValue(),
0,
},
{ // template with a single wrapped expr that is null
`${hello}`,
&hcl.EvalContext{
Variables: map[string]cty.Value{
"hello": cty.NullVal(cty.String),
},
},
cty.NullVal(cty.String),
1, // error about null value
},
{
`foo ${hello}`,
&hcl.EvalContext{
Variables: map[string]cty.Value{
"hello": cty.NullVal(cty.String),
},
},
cty.StringVal("foo "),
1, // error about null value
},
}

for _, test := range tests {
Expand Down
Loading