package puppetmasterless import ( "context" "fmt" "io/ioutil" "log" "os" "path/filepath" "strings" "testing" packersdk "github.com/hashicorp/packer-plugin-sdk/packer" "github.com/hashicorp/packer-plugin-sdk/template/interpolate" "github.com/hashicorp/packer/packer" "github.com/stretchr/testify/assert" ) func testConfig() (config map[string]interface{}, tf *os.File) { tf, err := ioutil.TempFile("", "packer") if err != nil { panic(err) } config = map[string]interface{}{ "manifest_file": tf.Name(), } return config, tf } func TestProvisioner_Impl(t *testing.T) { var raw interface{} raw = &Provisioner{} if _, ok := raw.(packersdk.Provisioner); !ok { t.Fatalf("must be a Provisioner") } } func TestGuestOSConfig_empty_unix(t *testing.T) { config, tempfile := testConfig() defer os.Remove(tempfile.Name()) defer tempfile.Close() p := new(Provisioner) err := p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } // Execute Puppet p.config.ctx.Data = &ExecuteTemplate{ ManifestFile: "/r/m/f", PuppetBinDir: p.config.PuppetBinDir, Sudo: !p.config.PreventSudo, WorkingDir: p.config.WorkingDir, } log.Println(p.config.ExecuteCommand) command, err := interpolate.Render(p.config.ExecuteCommand, &p.config.ctx) if err != nil { t.Fatalf("err: %s", err) } expected := "cd /tmp/packer-puppet-masterless && " + "sudo -E puppet apply --detailed-exitcodes /r/m/f" assert.Equal(t, expected, command) } func TestGuestOSConfig_full_unix(t *testing.T) { config, tempfile := testConfig() defer os.Remove(tempfile.Name()) defer tempfile.Close() p := new(Provisioner) err := p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } facterVars := []string{ fmt.Sprintf(p.guestOSTypeConfig.facterVarsFmt, "lhs", "rhs"), fmt.Sprintf(p.guestOSTypeConfig.facterVarsFmt, "foo", "bar"), } modulePaths := []string{"/m/p", "/a/b"} // Execute Puppet p.config.ctx.Data = &ExecuteTemplate{ FacterVars: strings.Join(facterVars, p.guestOSTypeConfig.facterVarsJoiner), HieraConfigPath: "/h/c/p", ManifestDir: "/r/m/d", ManifestFile: "/r/m/f", ModulePath: strings.Join(modulePaths, p.guestOSTypeConfig.modulePathJoiner), PuppetBinDir: p.config.PuppetBinDir, Sudo: !p.config.PreventSudo, WorkingDir: p.config.WorkingDir, ExtraArguments: strings.Join(p.config.ExtraArguments, " "), } command, err := interpolate.Render(p.config.ExecuteCommand, &p.config.ctx) if err != nil { t.Fatalf("err: %s", err) } expected := "cd /tmp/packer-puppet-masterless && FACTER_lhs='rhs' FACTER_foo='bar' " + "sudo -E puppet apply " + "--detailed-exitcodes --modulepath='/m/p:/a/b' --hiera_config='/h/c/p' " + "--manifestdir='/r/m/d' /r/m/f" assert.Equal(t, expected, command) } func TestGuestOSConfig_empty_windows(t *testing.T) { config, tempfile := testConfig() defer os.Remove(tempfile.Name()) defer tempfile.Close() config["guest_os_type"] = "windows" p := new(Provisioner) err := p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } // Execute Puppet p.config.ctx.Data = &ExecuteTemplate{ ManifestFile: "/r/m/f", PuppetBinDir: p.config.PuppetBinDir, Sudo: !p.config.PreventSudo, WorkingDir: p.config.WorkingDir, } log.Println(p.config.ExecuteCommand) command, err := interpolate.Render(p.config.ExecuteCommand, &p.config.ctx) if err != nil { t.Fatalf("err: %s", err) } expected := "cd " + filepath.ToSlash(os.Getenv("SYSTEMROOT")) + "/Temp/packer-puppet-masterless && puppet apply --detailed-exitcodes /r/m/f" assert.Equal(t, expected, command) } func TestGuestOSConfig_full_windows(t *testing.T) { config, tempfile := testConfig() defer os.Remove(tempfile.Name()) defer tempfile.Close() config["guest_os_type"] = "windows" p := new(Provisioner) err := p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } facterVars := []string{ fmt.Sprintf(p.guestOSTypeConfig.facterVarsFmt, "lhs", "rhs"), fmt.Sprintf(p.guestOSTypeConfig.facterVarsFmt, "foo", "bar"), } modulePaths := []string{"/m/p", "/a/b"} // Execute Puppet p.config.ctx.Data = &ExecuteTemplate{ FacterVars: strings.Join(facterVars, p.guestOSTypeConfig.facterVarsJoiner), HieraConfigPath: "/h/c/p", ManifestDir: "/r/m/d", ManifestFile: "/r/m/f", ModulePath: strings.Join(modulePaths, p.guestOSTypeConfig.modulePathJoiner), PuppetBinDir: p.config.PuppetBinDir, Sudo: !p.config.PreventSudo, WorkingDir: p.config.WorkingDir, ExtraArguments: strings.Join(p.config.ExtraArguments, " "), } command, err := interpolate.Render(p.config.ExecuteCommand, &p.config.ctx) if err != nil { t.Fatalf("err: %s", err) } expected := "cd " + filepath.ToSlash(os.Getenv("SYSTEMROOT")) + "/Temp/packer-puppet-masterless && " + "SET \"FACTER_lhs=rhs\" & SET \"FACTER_foo=bar\" && " + "puppet apply --detailed-exitcodes --modulepath='/m/p;/a/b' --hiera_config='/h/c/p' " + "--manifestdir='/r/m/d' /r/m/f" assert.Equal(t, expected, command) } func TestProvisionerPrepare_puppetBinDir(t *testing.T) { config, tempfile := testConfig() defer os.Remove(tempfile.Name()) defer tempfile.Close() delete(config, "puppet_bin_dir") p := new(Provisioner) err := p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } // Test with a good one tf, err := ioutil.TempFile("", "packer") if err != nil { t.Fatalf("error tempfile: %s", err) } defer os.Remove(tf.Name()) config["puppet_bin_dir"] = tf.Name() p = new(Provisioner) err = p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } } func TestProvisionerPrepare_hieraConfigPath(t *testing.T) { config, tempfile := testConfig() defer os.Remove(tempfile.Name()) defer tempfile.Close() delete(config, "hiera_config_path") p := new(Provisioner) err := p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } // Test with a good one tf, err := ioutil.TempFile("", "packer") if err != nil { t.Fatalf("error tempfile: %s", err) } defer os.Remove(tf.Name()) config["hiera_config_path"] = tf.Name() p = new(Provisioner) err = p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } } func TestProvisionerPrepare_manifestFile(t *testing.T) { config, tempfile := testConfig() defer os.Remove(tempfile.Name()) defer tempfile.Close() delete(config, "manifest_file") p := new(Provisioner) err := p.Prepare(config) if err == nil { t.Fatal("should be an error") } // Test with a good one tf, err := ioutil.TempFile("", "packer") if err != nil { t.Fatalf("error tempfile: %s", err) } defer os.Remove(tf.Name()) config["manifest_file"] = tf.Name() p = new(Provisioner) err = p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } } func TestProvisionerPrepare_manifestDir(t *testing.T) { config, tempfile := testConfig() defer os.Remove(tempfile.Name()) defer tempfile.Close() delete(config, "manifestdir") p := new(Provisioner) err := p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } // Test with a good one td, err := ioutil.TempDir("", "packer") if err != nil { t.Fatalf("error: %s", err) } defer os.RemoveAll(td) config["manifest_dir"] = td p = new(Provisioner) err = p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } } func TestProvisionerPrepare_modulePaths(t *testing.T) { config, tempfile := testConfig() defer os.Remove(tempfile.Name()) defer tempfile.Close() delete(config, "module_paths") p := new(Provisioner) err := p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } // Test with bad paths config["module_paths"] = []string{"i-should-not-exist"} p = new(Provisioner) err = p.Prepare(config) if err == nil { t.Fatal("should be an error") } // Test with a good one td, err := ioutil.TempDir("", "packer") if err != nil { t.Fatalf("error: %s", err) } defer os.RemoveAll(td) config["module_paths"] = []string{td} p = new(Provisioner) err = p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } } func TestProvisionerPrepare_facterFacts(t *testing.T) { config, tempfile := testConfig() defer os.Remove(tempfile.Name()) defer tempfile.Close() delete(config, "facter") p := new(Provisioner) err := p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } // Test with malformed fact config["facter"] = "fact=stringified" p = new(Provisioner) err = p.Prepare(config) if err == nil { t.Fatal("should be an error") } // Test with a good one td, err := ioutil.TempDir("", "packer") if err != nil { t.Fatalf("error: %s", err) } defer os.RemoveAll(td) facts := make(map[string]string) facts["fact_name"] = "fact_value" config["facter"] = facts p = new(Provisioner) err = p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } // Make sure the default facts are present delete(config, "facter") p = new(Provisioner) err = p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } if p.config.Facter == nil { t.Fatalf("err: Default facts are not set in the Puppet provisioner!") } if _, ok := p.config.Facter["packer_build_name"]; !ok { t.Fatalf("err: packer_build_name fact not set in the Puppet provisioner!") } if _, ok := p.config.Facter["packer_builder_type"]; !ok { t.Fatalf("err: packer_builder_type fact not set in the Puppet provisioner!") } } func TestProvisionerPrepare_extraArguments(t *testing.T) { config, tempfile := testConfig() defer os.Remove(tempfile.Name()) defer tempfile.Close() // Test with missing parameter delete(config, "extra_arguments") p := new(Provisioner) err := p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } // Test with malformed value config["extra_arguments"] = "{{}}" p = new(Provisioner) err = p.Prepare(config) if err == nil { t.Fatal("should be an error") } // Test with valid values config["extra_arguments"] = []string{ "arg", } p = new(Provisioner) err = p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } } func TestProvisionerPrepare_stagingDir(t *testing.T) { config, tempfile := testConfig() defer os.Remove(tempfile.Name()) defer tempfile.Close() delete(config, "staging_directory") p := new(Provisioner) err := p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } // Make sure the default staging directory is correct if p.config.StagingDir != "/tmp/packer-puppet-masterless" { t.Fatalf("err: Default staging_directory is not set in the Puppet provisioner!") } // Make sure default staging directory can be overridden config["staging_directory"] = "/tmp/override" p = new(Provisioner) err = p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } if p.config.StagingDir != "/tmp/override" { t.Fatalf("err: Overridden staging_directory is not set correctly in the Puppet provisioner!") } } func TestProvisionerPrepare_workingDir(t *testing.T) { config, tempfile := testConfig() defer os.Remove(tempfile.Name()) defer tempfile.Close() delete(config, "working_directory") p := new(Provisioner) err := p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } // Make sure default working dir and staging dir are the same if p.config.WorkingDir != p.config.StagingDir { t.Fatalf("err: Default working_directory is not set to the same value as default staging_directory in the Puppet provisioner!") } // Make sure the default working directory is correct if p.config.WorkingDir != "/tmp/packer-puppet-masterless" { t.Fatalf("err: Default working_directory is not set in the Puppet provisioner!") } // Make sure default working directory can be overridden config["working_directory"] = "/tmp/override" p = new(Provisioner) err = p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } if p.config.WorkingDir != "/tmp/override" { t.Fatalf("err: Overridden working_directory is not set correctly in the Puppet provisioner!") } } func TestProvisionerProvision_extraArguments(t *testing.T) { config, tempfile := testConfig() defer os.Remove(tempfile.Name()) defer tempfile.Close() ui := &packer.MachineReadableUi{ Writer: ioutil.Discard, } comm := new(packersdk.MockCommunicator) extraArguments := []string{ "--some-arg=yup", "--some-other-arg", } config["extra_arguments"] = extraArguments // Test with valid values p := new(Provisioner) err := p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } err = p.Provision(context.Background(), ui, comm, make(map[string]interface{})) if err != nil { t.Fatalf("err: %s", err) } expectedArgs := strings.Join(extraArguments, " ") if !strings.Contains(comm.StartCmd.Command, expectedArgs) { t.Fatalf("Command %q doesn't contain the expected arguments %q", comm.StartCmd.Command, expectedArgs) } // Test with missing parameter delete(config, "extra_arguments") p = new(Provisioner) err = p.Prepare(config) if err != nil { t.Fatalf("err: %s", err) } err = p.Provision(context.Background(), ui, comm, make(map[string]interface{})) if err != nil { t.Fatalf("err: %s", err) } // Check the expected `extra_arguments` position for an empty value splitCommand := strings.Split(comm.StartCmd.Command, " ") if "" == splitCommand[len(splitCommand)-2] { t.Fatalf("Command %q contains an extra-space which may cause arg parsing issues", comm.StartCmd.Command) } }