You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Wilken Rivera 57cbe4e203 core: Update validation options for undeclared variables (#12104) ... * Update validation options for undeclared variables In an effort to help users move from JSON to HCL2 templates the support for variable definitions files are being updated to ignore undeclared variable warnings on build execution. For legacy JSON templates builds no warnings are displayed when var-files contain undeclared variables. Since preferred mode HCL2 templates is to be explicit with variable declarations - they must be declared to be used - validation for undeclared variables still warns when running `packer validate`. A new flag has been added to the validate command that can be used to disable undeclared variable warnings. * Update validation test for unused variables Example Run ``` ~> go run . validate -no-warn-undeclared-var -var-file command/test-fixtures/validate/var-file-tests/undeclared.pkrvars.hcl command/test-fixtures/validate/var-file-tests/basic.pkr.hcl The configuration is valid. ~> go run . validate -var-file command/test-fixtures/validate/var-file-tests/undeclared.pkrvars.hcl command/test-fixtures/validate/var-file-tests/basic.pkr.hcl Warning: Undefined variable The variable "unused" was set but was not declared as an input variable. To declare variable "unused" place this block in one of your .pkr.hcl files, such as variables.pkr.hcl variable "unused" { type = string default = null } The configuration is valid. ~> go run . build -var-file command/test-fixtures/validate/var-file-tests/undeclared.pkrvars.hcl command/test-fixtures/validate/var-file-tests/basic.pkr.hcl file.chocolate: output will be in this color. Build 'file.chocolate' finished after 744 microseconds. ==> Wait completed after 798 microseconds ==> Builds finished. The artifacts of successful builds are: --> file.chocolate: Stored file: chocolate.txt ``` * Rename Strict field to WarnOnUndeclaredVar The field name Strict is a bit vague since it is only used for checking against undeclared variables within a var-file definition. To mitigate against potential overloading of this field it is being renamed to be more explicit on its usage. * command/build: Add warn-on-undeclared-var flag Now that the default behaviour is to not display warnings for undeclared variables an optional flag has been added to toggle the old behaviour. ``` ~> go run . build -warn-on-undeclared-var -var-file command/test-fixtures/validate/var-file-tests/undeclared.pkrvars.hcl command/test-fixtures/validate/var-file-tests/basic.pkr.hcl Warning: Undefined variable The variable "unused" was set but was not declared as an input variable. To declare variable "unused" place this block in one of your .pkr.hcl files, such as variables.pkr.hcl variable "unused" { type = string default = null } file.chocolate: output will be in this color. Build 'file.chocolate' finished after 762 microseconds. ==> Wait completed after 799 microseconds ==> Builds finished. The artifacts of successful builds are: --> file.chocolate: Stored file: chocolate.txt ```		3 years ago
..
var-file-tests	core: Update validation options for undeclared variables (#12104)	3 years ago
build.json	command/validate: Add support for HCL2 configuration files	6 years ago
build.pkr.hcl	HCL2: version block: test validation & document version/availability (#10298)	5 years ago
build_with_vars.pkr.hcl	command/validate: Add support for HCL2 configuration files	6 years ago
circular_error.pkr.hcl	feat: print all locals errors when there is a circular error (#11527)	4 years ago
datasource.pkr.hcl	(2) Implement datasources (#10440)	5 years ago
invalid_packer_block.pkr.hcl	HCL2: version block: test validation & document version/availability (#10298)	5 years ago
null_var.json	refactor initialization out from packer configs + tests (#9627)	6 years ago
template.json	Updated test to verify expected behavior	11 years ago
validate_except.json	Skip consecutives post-processors	6 years ago
validate_except.pkr.hcl	HCL2: add post-processors block to run multiple post-processor after a build (#9638)	6 years ago
var_foo_with_no_default.pkr.hcl	refactor initialization out from packer configs + tests (#9627)	6 years ago