mirror of
https://github.com/hashicorp/packer.git
synced 2026-10-14 18:22:07 -04:00
* hcl2template: pass user variable values to plugins as packer_user_variables (#13686) HCL2 builds do not send the packer_user_variables config key to the builder, provisioner and post-processor plugins. Legacy JSON builds send this key (through CoreBuild.packerConfig()). Without the key, the plugin SDK keeps interpolate.Context.UserVariables nil. Then the template function {{ user "name" }} fails with 'error calling user: test'. This failure occurs in each string that a plugin interpolates at run time, for example the contents of the vagrant post-processor's vagrantfile_template. Add the function PackerConfig.userVariableValues(). This function converts the input variable values to strings, equivalent to the legacy user variables. The core sends the map at each plugin handoff point: builder, provisioner, post-processor, and enforced provisioner. The map does not contain the sensitive variables. A sensitive value goes to a plugin only if the template refers to it explicitly. The map does not contain values that are not primitive (lists, maps, objects). Legacy user variables were always strings. Co-authored-by: Claude Fable 5 <[email protected]> * Dependency upgrade (#13689) * go.mod version upgrade * actions upgrade * plugin-getter: install plugins from non-GitHub HTTP sources (#13691) Packer can only install plugins from github.com, with releases.hashicorp.com consulted first for HashiCorp-published plugins. This has been a long-standing gap for air-gapped and policy-restricted environments (#11164): the source address parser already accepts any hostname, but both existing getters reject non-github.com sources at install time. Add a remote plugin getter that installs plugins from the host named in a required_plugins source address. The host serves the directory structure of releases.hashicorp.com under the source's path: an index.json listing versions, and per version a SHA256SUMS file, the zips it lists, and - when the zip names carry no plugin protocol version - the version's manifest.json. A plugin published on releases.hashicorp.com is therefore mirrored as a verbatim copy of its tree, with every checksum file and signature upstream-authored. A plugin published as GitHub release assets is mirrored by copying each release's assets into a version directory, renaming their SHA256SUMS file to the unprefixed convention with content unchanged, and writing an index.json listing the versions. Both kinds of content can be served side by side by one host. Getter selection happens per source address: github.com sources keep the release and github getters unchanged, while any other host is served by the remote getter over HTTPS. Sources with three or more components are supported, up to the existing 16-component limit, so nested artifact-repository paths and hosts that embed the upstream origin in their path all resolve. Version discovery, constraint solving, checksum verification, and the binary naming rules match the existing getters. The installed filename is rebuilt from validated checksum-file fields and never taken from the server's response, checksum entries matching neither known naming shape are rejected rather than guessed at, and nothing the remote metadata supplies is used to fetch from another origin or path. index.json parsing is covered by fixtures captured from the live releases API, so a format change there fails tests rather than user installs. Closes #11164 * fix: update link to CONTRIBUTING.md for consistency with main branch * Merge pull request #13701 from hashicorp/sanya-hashicorp/fix-vuln Module Dependency update * build(deps): bump google.golang.org/grpc (#13704) Bumps [google.golang.org/grpc](https://github.com/grpc/grpc-go) from 1.83.1 to 1.83.2. - [Release notes](https://github.com/grpc/grpc-go/releases) - [Commits](https://github.com/grpc/grpc-go/compare/v1.83.1...v1.83.2) --- updated-dependencies: - dependency-name: google.golang.org/grpc dependency-version: 1.83.2 dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * [COMPLIANCE] Add/Update Copyright Headers (#13699) * [COMPLIANCE] Add/Update Copyright Headers * make generate update * make generate --------- Co-authored-by: hashicorp-copywrite[bot] <110428419+hashicorp-copywrite[bot]@users.noreply.github.com> Co-authored-by: sanya <[email protected]> Co-authored-by: Sanya <[email protected]> * Packer release 1.16.1 (#13705) * Module upgrade (#13707) --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Erik Berg <[email protected]> Co-authored-by: Claude Fable 5 <[email protected]> Co-authored-by: Benjamin Holmes <[email protected]> Co-authored-by: elomito <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: hashicorp-copywrite[bot] <110428419+hashicorp-copywrite[bot]@users.noreply.github.com>
940 lines
22 KiB
Go
940 lines
22 KiB
Go
// Copyright IBM Corp. 2024, 2026
|
|
// SPDX-License-Identifier: BUSL-1.1
|
|
|
|
package packer
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"os"
|
|
"path/filepath"
|
|
"reflect"
|
|
"testing"
|
|
|
|
packersdk "github.com/hashicorp/packer-plugin-sdk/packer"
|
|
"github.com/hashicorp/packer-plugin-sdk/template"
|
|
configHelper "github.com/hashicorp/packer-plugin-sdk/template/config"
|
|
"github.com/hashicorp/packer/version"
|
|
)
|
|
|
|
func TestCoreBuildNames(t *testing.T) {
|
|
cases := []struct {
|
|
File string
|
|
Vars map[string]string
|
|
Result []string
|
|
}{
|
|
{
|
|
"build-names-basic.json",
|
|
nil,
|
|
[]string{"something"},
|
|
},
|
|
|
|
{
|
|
"build-names-func.json",
|
|
nil,
|
|
[]string{"TUBES"},
|
|
},
|
|
}
|
|
|
|
for _, tc := range cases {
|
|
tpl, err := template.ParseFile(fixtureDir(tc.File))
|
|
if err != nil {
|
|
t.Fatalf("err: %s\n\n%s", tc.File, err)
|
|
}
|
|
|
|
core := NewCore(&CoreConfig{
|
|
Template: tpl,
|
|
Variables: tc.Vars,
|
|
})
|
|
diags := core.Initialize(InitializeOptions{})
|
|
if diags.HasErrors() {
|
|
t.Fatalf("err: %s\n\n%s", tc.File, diags)
|
|
}
|
|
|
|
names := core.BuildNames(nil, nil)
|
|
if !reflect.DeepEqual(names, tc.Result) {
|
|
t.Fatalf("err: %s\n\n%#v", tc.File, names)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestCoreBuild_basic(t *testing.T) {
|
|
config := TestCoreConfig(t)
|
|
testCoreTemplate(t, config, fixtureDir("build-basic.json"))
|
|
b := TestBuilder(t, config, "test")
|
|
core := TestCore(t, config)
|
|
|
|
b.ArtifactId = "hello"
|
|
|
|
build, err := core.Build("test")
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if build.Name() != "test" {
|
|
t.Fatalf("bad: build name does not match expected: %q, got: %q", "test", build.Name())
|
|
}
|
|
|
|
if _, err := build.Prepare(); err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
artifact, err := build.Run(context.Background(), nil)
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
if len(artifact) != 1 {
|
|
t.Fatalf("bad: %#v", artifact)
|
|
}
|
|
|
|
if artifact[0].Id() != b.ArtifactId {
|
|
t.Fatalf("bad: %s", artifact[0].Id())
|
|
}
|
|
}
|
|
|
|
func TestCoreBuild_basicInterpolated(t *testing.T) {
|
|
config := TestCoreConfig(t)
|
|
testCoreTemplate(t, config, fixtureDir("build-basic-interpolated.json"))
|
|
b := TestBuilder(t, config, "test")
|
|
core := TestCore(t, config)
|
|
|
|
b.ArtifactId = "hello"
|
|
|
|
build, err := core.Build("NAME")
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if build.Name() != "test.NAME" {
|
|
t.Fatalf("bad: build name does not match expected: %q, got: %q", "NAME", build.Name())
|
|
}
|
|
|
|
if _, err := build.Prepare(); err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
artifact, err := build.Run(context.Background(), nil)
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
if len(artifact) != 1 {
|
|
t.Fatalf("bad: %#v", artifact)
|
|
}
|
|
|
|
if artifact[0].Id() != b.ArtifactId {
|
|
t.Fatalf("bad: %s", artifact[0].Id())
|
|
}
|
|
}
|
|
|
|
func TestCoreBuild_env(t *testing.T) {
|
|
t.Setenv("PACKER_TEST_ENV", "test")
|
|
|
|
config := TestCoreConfig(t)
|
|
testCoreTemplate(t, config, fixtureDir("build-env.json"))
|
|
b := TestBuilder(t, config, "test")
|
|
core := TestCore(t, config)
|
|
|
|
b.ArtifactId = "hello"
|
|
|
|
build, err := core.Build("test")
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if _, err := build.Prepare(); err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
// Interpolate the config
|
|
var result map[string]interface{}
|
|
err = configHelper.Decode(&result, nil, b.PrepareConfig...)
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if result["value"] != "test" {
|
|
t.Fatalf("bad: %#v", result)
|
|
}
|
|
}
|
|
|
|
func TestCoreBuild_IgnoreTemplateVariables(t *testing.T) {
|
|
t.Setenv("PACKER_TEST_ENV", "test")
|
|
|
|
config := TestCoreConfig(t)
|
|
testCoreTemplate(t, config, fixtureDir("build-ignore-template-variable.json"))
|
|
core := TestCore(t, config)
|
|
|
|
if core.variables["http_ip"] != "{{ .HTTPIP }}" {
|
|
t.Fatalf("bad: User variable http_ip={{ .HTTPIP }} should not be interpolated")
|
|
}
|
|
|
|
if core.variables["var"] != "test_{{ .PACKER_TEST_TEMP }}" {
|
|
t.Fatalf("bad: User variable var should be half interpolated to var=test_{{ .PACKER_TEST_TEMP }} but was var=%s", core.variables["var"])
|
|
}
|
|
|
|
if core.variables["array_var"] != "us-west-1,us-west-2" {
|
|
t.Fatalf("bad: User variable array_var should be \"us-west-1,us-west-2\" but was %s", core.variables["var"])
|
|
}
|
|
|
|
build, err := core.Build("test")
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if _, err := build.Prepare(); err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
}
|
|
|
|
func TestCoreBuild_buildNameVar(t *testing.T) {
|
|
config := TestCoreConfig(t)
|
|
testCoreTemplate(t, config, fixtureDir("build-var-build-name.json"))
|
|
b := TestBuilder(t, config, "test")
|
|
core := TestCore(t, config)
|
|
|
|
b.ArtifactId = "hello"
|
|
|
|
build, err := core.Build("test")
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if _, err := build.Prepare(); err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
// Interpolate the config
|
|
var result map[string]interface{}
|
|
err = configHelper.Decode(&result, nil, b.PrepareConfig...)
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if result["value"] != "test" {
|
|
t.Fatalf("bad: %#v", result)
|
|
}
|
|
}
|
|
|
|
func TestCoreBuild_buildTypeVar(t *testing.T) {
|
|
config := TestCoreConfig(t)
|
|
testCoreTemplate(t, config, fixtureDir("build-var-build-type.json"))
|
|
b := TestBuilder(t, config, "test")
|
|
core := TestCore(t, config)
|
|
|
|
b.ArtifactId = "hello"
|
|
|
|
build, err := core.Build("test")
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if _, err := build.Prepare(); err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
// Interpolate the config
|
|
var result map[string]interface{}
|
|
err = configHelper.Decode(&result, nil, b.PrepareConfig...)
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if result["value"] != "test" {
|
|
t.Fatalf("bad: %#v", result)
|
|
}
|
|
}
|
|
|
|
func TestCoreBuild_nonExist(t *testing.T) {
|
|
config := TestCoreConfig(t)
|
|
testCoreTemplate(t, config, fixtureDir("build-basic.json"))
|
|
TestBuilder(t, config, "test")
|
|
core := TestCore(t, config)
|
|
|
|
_, err := core.Build("nope")
|
|
if err == nil {
|
|
t.Fatal("should error")
|
|
}
|
|
}
|
|
|
|
func TestCoreBuild_prov(t *testing.T) {
|
|
config := TestCoreConfig(t)
|
|
testCoreTemplate(t, config, fixtureDir("build-prov.json"))
|
|
b := TestBuilder(t, config, "test")
|
|
p := TestProvisioner(t, config, "test")
|
|
core := TestCore(t, config)
|
|
|
|
b.ArtifactId = "hello"
|
|
|
|
build, err := core.Build("test")
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if _, err := build.Prepare(); err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
artifact, err := build.Run(context.Background(), nil)
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
if len(artifact) != 1 {
|
|
t.Fatalf("bad: %#v", artifact)
|
|
}
|
|
|
|
if artifact[0].Id() != b.ArtifactId {
|
|
t.Fatalf("bad: %s", artifact[0].Id())
|
|
}
|
|
if !p.ProvCalled {
|
|
t.Fatal("provisioner not called")
|
|
}
|
|
}
|
|
|
|
func TestCoreBuild_provSkip(t *testing.T) {
|
|
config := TestCoreConfig(t)
|
|
testCoreTemplate(t, config, fixtureDir("build-prov-skip.json"))
|
|
b := TestBuilder(t, config, "test")
|
|
p := TestProvisioner(t, config, "test")
|
|
core := TestCore(t, config)
|
|
|
|
b.ArtifactId = "hello"
|
|
|
|
build, err := core.Build("test")
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if _, err := build.Prepare(); err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
artifact, err := build.Run(context.Background(), nil)
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
if len(artifact) != 1 {
|
|
t.Fatalf("bad: %#v", artifact)
|
|
}
|
|
|
|
if artifact[0].Id() != b.ArtifactId {
|
|
t.Fatalf("bad: %s", artifact[0].Id())
|
|
}
|
|
if p.ProvCalled {
|
|
t.Fatal("provisioner should not be called")
|
|
}
|
|
}
|
|
|
|
func TestCoreBuild_provSkipInclude(t *testing.T) {
|
|
config := TestCoreConfig(t)
|
|
testCoreTemplate(t, config, fixtureDir("build-prov-skip-include.json"))
|
|
b := TestBuilder(t, config, "test")
|
|
p := TestProvisioner(t, config, "test")
|
|
core := TestCore(t, config)
|
|
|
|
b.ArtifactId = "hello"
|
|
|
|
build, err := core.Build("test")
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if _, err := build.Prepare(); err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
artifact, err := build.Run(context.Background(), nil)
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
if len(artifact) != 1 {
|
|
t.Fatalf("bad: %#v", artifact)
|
|
}
|
|
|
|
if artifact[0].Id() != b.ArtifactId {
|
|
t.Fatalf("bad: %s", artifact[0].Id())
|
|
}
|
|
if !p.ProvCalled {
|
|
t.Fatal("provisioner should be called")
|
|
}
|
|
}
|
|
|
|
func TestCoreBuild_provOverride(t *testing.T) {
|
|
config := TestCoreConfig(t)
|
|
testCoreTemplate(t, config, fixtureDir("build-prov-override.json"))
|
|
b := TestBuilder(t, config, "test")
|
|
p := TestProvisioner(t, config, "test")
|
|
core := TestCore(t, config)
|
|
|
|
b.ArtifactId = "hello"
|
|
|
|
build, err := core.Build("test")
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if _, err := build.Prepare(); err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
artifact, err := build.Run(context.Background(), nil)
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
if len(artifact) != 1 {
|
|
t.Fatalf("bad: %#v", artifact)
|
|
}
|
|
|
|
if artifact[0].Id() != b.ArtifactId {
|
|
t.Fatalf("bad: %s", artifact[0].Id())
|
|
}
|
|
if !p.ProvCalled {
|
|
t.Fatal("provisioner not called")
|
|
}
|
|
|
|
found := false
|
|
for _, raw := range p.PrepConfigs {
|
|
if m, ok := raw.(map[string]interface{}); ok {
|
|
if _, ok := m["foo"]; ok {
|
|
found = true
|
|
break
|
|
}
|
|
}
|
|
}
|
|
if !found {
|
|
t.Fatal("override not called")
|
|
}
|
|
}
|
|
|
|
func TestCoreBuild_postProcess(t *testing.T) {
|
|
config := TestCoreConfig(t)
|
|
testCoreTemplate(t, config, fixtureDir("build-pp.json"))
|
|
b := TestBuilder(t, config, "test")
|
|
p := TestPostProcessor(t, config, "test")
|
|
core := TestCore(t, config)
|
|
ui := TestUi(t)
|
|
|
|
b.ArtifactId = "hello"
|
|
p.ArtifactId = "goodbye"
|
|
|
|
build, err := core.Build("test")
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if _, err := build.Prepare(); err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
artifact, err := build.Run(context.Background(), ui)
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
if len(artifact) != 1 {
|
|
t.Fatalf("bad: %#v", artifact)
|
|
}
|
|
|
|
if artifact[0].Id() != p.ArtifactId {
|
|
t.Fatalf("bad: %s", artifact[0].Id())
|
|
}
|
|
if p.PostProcessArtifact.Id() != b.ArtifactId {
|
|
t.Fatalf("bad: %s", p.PostProcessArtifact.Id())
|
|
}
|
|
}
|
|
|
|
func TestCoreBuild_templatePath(t *testing.T) {
|
|
config := TestCoreConfig(t)
|
|
testCoreTemplate(t, config, fixtureDir("build-template-path.json"))
|
|
b := TestBuilder(t, config, "test")
|
|
core := TestCore(t, config)
|
|
|
|
expected, _ := filepath.Abs("./test-fixtures")
|
|
|
|
build, err := core.Build("test")
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if _, err := build.Prepare(); err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
// Interpolate the config
|
|
var result map[string]interface{}
|
|
err = configHelper.Decode(&result, nil, b.PrepareConfig...)
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if result["value"] != expected {
|
|
t.Fatalf("bad: %#v", result)
|
|
}
|
|
}
|
|
|
|
func TestCoreValidate(t *testing.T) {
|
|
cases := []struct {
|
|
File string
|
|
Vars map[string]string
|
|
Err bool
|
|
}{
|
|
{"validate-dup-builder.json", nil, true},
|
|
|
|
// Required variable not set
|
|
{"validate-req-variable.json", nil, true},
|
|
{"validate-req-variable.json", map[string]string{"foo": "bar"}, false},
|
|
|
|
// Min version good
|
|
{"validate-min-version.json", map[string]string{"foo": "bar"}, false},
|
|
{"validate-min-version-high.json", map[string]string{"foo": "bar"}, true},
|
|
}
|
|
|
|
for _, tc := range cases {
|
|
f, err := os.Open(fixtureDir(tc.File))
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
tpl, err := template.Parse(f)
|
|
f.Close()
|
|
if err != nil {
|
|
t.Fatalf("err: %s\n\n%s", tc.File, err)
|
|
}
|
|
|
|
core := NewCore(&CoreConfig{
|
|
Template: tpl,
|
|
Variables: tc.Vars,
|
|
Version: "1.0.0",
|
|
})
|
|
diags := core.Initialize(InitializeOptions{})
|
|
|
|
if diags.HasErrors() != tc.Err {
|
|
t.Fatalf("err: %s\n\n%s", tc.File, err)
|
|
}
|
|
}
|
|
}
|
|
|
|
// Tests that we can properly interpolate user variables defined within the
|
|
// packer template
|
|
func TestCore_InterpolateUserVars(t *testing.T) {
|
|
cases := []struct {
|
|
File string
|
|
Expected map[string]string
|
|
Err bool
|
|
}{
|
|
{
|
|
"build-variables-interpolate.json",
|
|
map[string]string{
|
|
"foo": "bar",
|
|
"bar": "bar",
|
|
"baz": "barbaz",
|
|
"bang": "bangbarbaz",
|
|
},
|
|
false,
|
|
},
|
|
{
|
|
"build-variables-interpolate2.json",
|
|
map[string]string{},
|
|
true,
|
|
},
|
|
}
|
|
for _, tc := range cases {
|
|
f, err := os.Open(fixtureDir(tc.File))
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
tpl, err := template.Parse(f)
|
|
f.Close()
|
|
if err != nil {
|
|
t.Fatalf("err: %s\n\n%s", tc.File, err)
|
|
}
|
|
|
|
ccf := NewCore(&CoreConfig{
|
|
Template: tpl,
|
|
Version: "1.0.0",
|
|
})
|
|
diags := ccf.Initialize(InitializeOptions{})
|
|
|
|
if diags.HasErrors() != tc.Err {
|
|
if tc.Err == false {
|
|
t.Fatalf("Error interpolating %s: Expected no error, but got: %s", tc.File, diags)
|
|
} else {
|
|
t.Fatalf("Error interpolating %s: Expected an error, but got: %s", tc.File, diags)
|
|
}
|
|
|
|
}
|
|
if !tc.Err {
|
|
for k, v := range ccf.variables {
|
|
if tc.Expected[k] != v {
|
|
t.Fatalf("Expected %s but got %s", tc.Expected[k], v)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Tests that we can properly interpolate user variables defined within a
|
|
// var-file provided alongside the Packer template
|
|
func TestCore_InterpolateUserVars_VarFile(t *testing.T) {
|
|
cases := []struct {
|
|
File string
|
|
Variables map[string]string
|
|
Expected map[string]string
|
|
Err bool
|
|
}{
|
|
{
|
|
// tests that we can interpolate from var files when var isn't set in
|
|
// originating template
|
|
"build-basic-interpolated.json",
|
|
map[string]string{
|
|
"name": "gotta-{{user `my_var`}}",
|
|
"my_var": "interpolate-em-all",
|
|
},
|
|
map[string]string{
|
|
"name": "gotta-interpolate-em-all",
|
|
"my_var": "interpolate-em-all"},
|
|
false,
|
|
},
|
|
{
|
|
// tests that we can interpolate from var files when var is set in
|
|
// originating template as required
|
|
"build-basic-interpolated-required.json",
|
|
map[string]string{
|
|
"name": "gotta-{{user `my_var`}}",
|
|
"my_var": "interpolate-em-all",
|
|
},
|
|
map[string]string{
|
|
"name": "gotta-interpolate-em-all",
|
|
"my_var": "interpolate-em-all"},
|
|
false,
|
|
},
|
|
}
|
|
for _, tc := range cases {
|
|
f, err := os.Open(fixtureDir(tc.File))
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
tpl, err := template.Parse(f)
|
|
f.Close()
|
|
if err != nil {
|
|
t.Fatalf("err: %s\n\n%s", tc.File, err)
|
|
}
|
|
|
|
ccf := NewCore(&CoreConfig{
|
|
Template: tpl,
|
|
Version: "1.0.0",
|
|
Variables: tc.Variables,
|
|
})
|
|
diags := ccf.Initialize(InitializeOptions{})
|
|
|
|
if diags.HasErrors() != tc.Err {
|
|
t.Fatalf("err: %s\n\n%s", tc.File, diags)
|
|
}
|
|
if !tc.Err {
|
|
for k, v := range ccf.variables {
|
|
if tc.Expected[k] != v {
|
|
t.Fatalf("Expected value %s for key %s but got %s",
|
|
tc.Expected[k], k, v)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestSensitiveVars(t *testing.T) {
|
|
cases := []struct {
|
|
File string
|
|
Vars map[string]string
|
|
SensitiveVars []string
|
|
Expected string
|
|
Err bool
|
|
}{
|
|
// hardcoded
|
|
{
|
|
"sensitive-variables.json",
|
|
map[string]string{"foo": "bar_extra_sensitive_probably_a_password"},
|
|
[]string{"foo"},
|
|
"the foo jumped over the <sensitive>",
|
|
false,
|
|
},
|
|
// interpolated
|
|
{
|
|
"sensitive-variables.json",
|
|
map[string]string{"foo": "bar_extra_sensitive_probably_a_password",
|
|
"bang": "{{ user `foo`}}"},
|
|
[]string{"bang"},
|
|
"the foo jumped over the <sensitive>",
|
|
false,
|
|
},
|
|
}
|
|
|
|
for _, tc := range cases {
|
|
f, err := os.Open(fixtureDir(tc.File))
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
tpl, err := template.Parse(f)
|
|
f.Close()
|
|
if err != nil {
|
|
t.Fatalf("err: %s\n\n%s", tc.File, err)
|
|
}
|
|
|
|
ccf := NewCore(&CoreConfig{
|
|
Template: tpl,
|
|
Variables: tc.Vars,
|
|
Version: "1.0.0",
|
|
})
|
|
diags := ccf.Initialize(InitializeOptions{})
|
|
|
|
if diags.HasErrors() != tc.Err {
|
|
t.Fatalf("err: %s\n\n%s", tc.File, diags)
|
|
}
|
|
// Check that filter correctly manipulates strings:
|
|
filtered := packersdk.LogSecretFilter.FilterString("the foo jumped over the bar_extra_sensitive_probably_a_password")
|
|
if filtered != tc.Expected {
|
|
t.Fatalf("not filtering sensitive vars; filtered is %#v", filtered)
|
|
}
|
|
}
|
|
}
|
|
|
|
// Normally I wouldn't test a little helper function, but it's regex.
|
|
func TestIsDoneInterpolating(t *testing.T) {
|
|
cases := []struct {
|
|
inputString string
|
|
expectedBool bool
|
|
expectedErr bool
|
|
}{
|
|
// Many of these tests are just exercising the regex to make sure it
|
|
// doesn't get confused by different kinds of whitespace
|
|
{"charmander-{{ user `spacesaroundticks` }}", false, false},
|
|
{"pidgey-{{ user `partyparrot`}}", false, false},
|
|
{"jigglypuff-{{ user`notickspaaces`}}", false, false},
|
|
{"eevee-{{user`nospaces`}}", false, false},
|
|
{"staryu-{{ user `somanyspaces` }}", false, false},
|
|
{"{{ user `somanyspaces` }}-{{isotime}}", false, false},
|
|
// Make sure that we only flag on "user" when it's in the right set of
|
|
// brackets, in a properly declared template engine format
|
|
{"missingno-{{ user `missingbracket` }", true, false},
|
|
{"missing2-{user ``missingopenbrackets }}", true, false},
|
|
{"wat-userjustinname", true, false},
|
|
// Any functions that aren't "user" should have already been properly
|
|
// interpolated by the time this is called, so these cases aren't
|
|
// realistic. That said, this makes it clear that this function doesn't
|
|
// care about anything but the user function
|
|
{"pokemon-{{ isotime }}", true, false},
|
|
{"squirtle-{{ env `water`}}", true, false},
|
|
{"bulbasaur-notinterpolated", true, false},
|
|
{"extra-{{thisfunc `user`}}", true, false},
|
|
}
|
|
for _, tc := range cases {
|
|
done, err := isDoneInterpolating(tc.inputString)
|
|
if (err != nil) != tc.expectedErr {
|
|
t.Fatalf("Test case failed. Error: %s expected error: "+
|
|
"%t test string: %s", err, tc.expectedErr, tc.inputString)
|
|
}
|
|
if done != tc.expectedBool {
|
|
t.Fatalf("Test case failed. inputString: %s. "+
|
|
"Expected done = %t but got done = %t", tc.inputString,
|
|
tc.expectedBool, done)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestEnvAndFileVars(t *testing.T) {
|
|
t.Setenv("INTERPOLATE_TEST_ENV_1", "bulbasaur")
|
|
t.Setenv("INTERPOLATE_TEST_ENV_3", "/path/to/nowhere")
|
|
t.Setenv("INTERPOLATE_TEST_ENV_2", "5")
|
|
t.Setenv("INTERPOLATE_TEST_ENV_4", "bananas")
|
|
|
|
f, err := os.Open(fixtureDir("complex-recursed-env-user-var-file.json"))
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
tpl, err := template.Parse(f)
|
|
f.Close()
|
|
if err != nil {
|
|
t.Fatalf("err: %s\n\n%s", "complex-recursed-env-user-var-file.json", err)
|
|
}
|
|
|
|
ccf := NewCore(&CoreConfig{
|
|
Template: tpl,
|
|
Version: "1.0.0",
|
|
Variables: map[string]string{
|
|
"var_1": "partyparrot",
|
|
"var_2": "{{user `env_1`}}-{{user `env_2`}}{{user `env_3`}}-{{user `var_1`}}",
|
|
"final_var": "{{user `env_1`}}/{{user `env_2`}}/{{user `env_4`}}{{user `env_3`}}-{{user `var_1`}}/vmware/{{user `var_2`}}.vmx",
|
|
},
|
|
})
|
|
diags := ccf.Initialize(InitializeOptions{})
|
|
|
|
expected := map[string]string{
|
|
"var_1": "partyparrot",
|
|
"var_2": "bulbasaur-5/path/to/nowhere-partyparrot",
|
|
"final_var": "bulbasaur/5/bananas/path/to/nowhere-partyparrot/vmware/bulbasaur-5/path/to/nowhere-partyparrot.vmx",
|
|
"env_1": "bulbasaur",
|
|
"env_2": "5",
|
|
"env_3": "/path/to/nowhere",
|
|
"env_4": "bananas",
|
|
}
|
|
if diags.HasErrors() {
|
|
t.Fatalf("err: %s\n\n%s", "complex-recursed-env-user-var-file.json", diags)
|
|
}
|
|
for k, v := range ccf.variables {
|
|
if expected[k] != v {
|
|
t.Fatalf("Expected value %s for key %s but got %s",
|
|
expected[k], k, v)
|
|
}
|
|
}
|
|
}
|
|
|
|
func testCoreTemplate(t *testing.T, c *CoreConfig, p string) {
|
|
tpl, err := template.ParseFile(p)
|
|
if err != nil {
|
|
t.Fatalf("err: %s\n\n%s", p, err)
|
|
}
|
|
|
|
c.Template = tpl
|
|
}
|
|
|
|
func TestCoreBuild_provRetry(t *testing.T) {
|
|
config := TestCoreConfig(t)
|
|
testCoreTemplate(t, config, fixtureDir("build-prov-retry.json"))
|
|
b := TestBuilder(t, config, "test")
|
|
pString := new(packersdk.MockProvisioner)
|
|
pInt := new(packersdk.MockProvisioner)
|
|
config.Components.PluginConfig.Provisioners = MapOfProvisioner{
|
|
"test-string": func() (packersdk.Provisioner, error) { return pString, nil },
|
|
// backwards compatibility
|
|
"test-integer": func() (packersdk.Provisioner, error) { return pInt, nil },
|
|
}
|
|
core := TestCore(t, config)
|
|
|
|
b.ArtifactId = "hello"
|
|
|
|
build, err := core.Build("test")
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if _, err := build.Prepare(); err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
ui := testUi()
|
|
pInt.ProvFunc = func(ctx context.Context) error {
|
|
return errors.New("failed")
|
|
}
|
|
pString.ProvFunc = func(ctx context.Context) error {
|
|
return errors.New("failed")
|
|
}
|
|
|
|
artifact, err := build.Run(context.Background(), ui)
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
if len(artifact) != 1 {
|
|
t.Fatalf("bad: %#v", artifact)
|
|
}
|
|
|
|
if artifact[0].Id() != b.ArtifactId {
|
|
t.Fatalf("bad: %s", artifact[0].Id())
|
|
}
|
|
if !pString.ProvRetried {
|
|
t.Fatal("provisioner should retry for max_retries string value")
|
|
}
|
|
// backwards compatibility
|
|
if !pInt.ProvRetried {
|
|
t.Fatal("provisioner should retry for max_retries integer value")
|
|
}
|
|
}
|
|
|
|
func TestCoreBuild_packerVersion(t *testing.T) {
|
|
config := TestCoreConfig(t)
|
|
testCoreTemplate(t, config, fixtureDir("build-var-packer-version.json"))
|
|
b := TestBuilder(t, config, "test")
|
|
core := TestCore(t, config)
|
|
|
|
expected := version.FormattedVersion()
|
|
build, err := core.Build("test")
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if _, err := build.Prepare(); err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
// Interpolate the config
|
|
var result map[string]interface{}
|
|
err = configHelper.Decode(&result, nil, b.PrepareConfig...)
|
|
if err != nil {
|
|
t.Fatalf("err: %s", err)
|
|
}
|
|
|
|
if result["value"] != expected {
|
|
t.Fatalf("bad: %#v", result)
|
|
}
|
|
}
|
|
|
|
func TestCoreBuild_buildNameIntepolation(t *testing.T) {
|
|
config := TestCoreConfig(t)
|
|
cases := []struct {
|
|
File string
|
|
InterpolatedName, Expected string
|
|
Vars map[string]string
|
|
}{
|
|
{
|
|
File: "build-interpolated-name.json",
|
|
InterpolatedName: "mybuild-RandomToken",
|
|
Expected: "test.mybuild-RandomToken",
|
|
Vars: map[string]string{
|
|
"build_name": "mybuild-RandomToken",
|
|
},
|
|
},
|
|
{
|
|
File: "build-interpolated-name.json",
|
|
InterpolatedName: "build-vardata",
|
|
Expected: "test.build-vardata",
|
|
Vars: map[string]string{
|
|
"build_name": "build-vardata",
|
|
},
|
|
},
|
|
{
|
|
File: "build-interpolated-name.json",
|
|
InterpolatedName: "build-12345",
|
|
Expected: "test.build-12345",
|
|
Vars: map[string]string{
|
|
"something": "build-12345",
|
|
"build_name": "{{user `something`}}",
|
|
},
|
|
},
|
|
{
|
|
// When no name attribute is provided in the config the builder type is the default name.
|
|
File: "build-basic.json",
|
|
InterpolatedName: "test",
|
|
Expected: "test",
|
|
},
|
|
}
|
|
|
|
for _, tc := range cases {
|
|
config.Variables = tc.Vars
|
|
testCoreTemplate(t, config, fixtureDir(tc.File))
|
|
core := TestCore(t, config)
|
|
diags := core.Initialize(InitializeOptions{})
|
|
if diags.HasErrors() {
|
|
t.Fatalf("err: %s\n\n%s", tc.File, diags)
|
|
}
|
|
|
|
build, err := core.Build(tc.InterpolatedName)
|
|
if err != nil {
|
|
t.Fatalf("err for InterpolatedName(%q): %s", tc.InterpolatedName, err)
|
|
}
|
|
|
|
if build.Name() != tc.Expected {
|
|
t.Errorf("build type interpolation failed; expected %q, got %q", tc.Expected, build.Name())
|
|
}
|
|
|
|
}
|
|
}
|