buildflags: handle unknown values from cty #2965
Open
+79
−43
Conversation
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
Update the buildflags cty code to handle unknown values. When hcl decodes a value with an invalid variable name, it appends a diagnostic for the error and then returns an unknown value so it can continue processing the file and finding more errors. The iteration code has now been changed to use a rangefunc from go 1.23 and it skips empty or unknown values. Empty values are valid when they are skipped and unknown values will have a diagnostic for itself. Signed-off-by: Jonathan A. Sternberg <[email protected]>
jsternberg
force-pushed
the
handle-unknown-values
branch
from
9cc2231 to
3e1da26
Compare
crazy-max
reviewed
Feb 4, 2025
Comment on lines
+722
to
+747
| target "app" { | ||
| attest = [ | ||
| "type=sbom,disabled=${SBOM}", | ||
| ] | ||
|
|
||
| cache-from = [ | ||
| { type = "registry", ref = "user/app:${FOO1}" }, | ||
| "type=local,src=path/to/cache:${FOO2}", | ||
| ] | ||
|
|
||
| cache-to = [ | ||
| { type = "local", dest = "path/to/${BAR}" }, | ||
| ] | ||
|
|
||
| output = [ | ||
| { type = "oci", dest = "../${OUTPUT}.tar" }, | ||
| ] | ||
|
|
||
| secret = [ | ||
| { id = "mysecret", src = "/local/${SECRET}" }, | ||
| ] | ||
|
|
||
| ssh = [ | ||
| { id = "key", paths = ["path/to/${SSH_KEY}"] }, | ||
| ] | ||
| } |
There was a problem hiding this comment.
Was looking at how this example behaves in Buildx 0.19 and I got 13 diagnostics:
docker buildx bake --print
#1 [internal] load local bake definitions
#1 reading docker-bake.hcl 451B / 451B done
#1 DONE 0.0s
docker-bake.hcl:6
--------------------
4 | ]
5 | cache-from = [
6 | >>> { type = "registry", ref = "user/app:${FOO1}" },
7 | "type=local,src=path/to/cache:${FOO2}",
8 | ]
--------------------
ERROR: docker-bake.hcl:6,43-47: Unknown variable; There is no variable named "FOO1"., and 12 other diagnostic(s)
But here I got 8 diagnostics:
docker buildx bake --print
#1 [internal] load local bake definitions
#1 reading docker-bake.hcl 451B / 451B done
#1 DONE 0.0s
docker-bake.hcl:13
--------------------
11 | ]
12 | output = [
13 | >>> { type = "oci", dest = "../${OUTPUT}.tar" },
14 | ]
15 | secret = [
--------------------
ERROR: docker-bake.hcl:13,33-39: Unknown variable; There is no variable named "OUTPUT"., and 7 other diagnostic(s)
Not for this PR but wonder if we could show all diags when --debug is set?
nit: Also seems to return OUTPUT as first diag with this PR but in older release returns what seems to be the first one FOO1
crazy-max
approved these changes
Feb 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the buildflags cty code to handle unknown values. When hcl decodes a value with an invalid variable name, it appends a diagnostic for the error and then returns an unknown value so it can continue processing the file and finding more errors.
The iteration code has now been changed to use a rangefunc from go 1.23 and it skips empty or unknown values. Empty values are valid when they are skipped and unknown values will have a diagnostic for itself.
Fixes #2960.