post-processor/vagrant: make output contain build name by default

[GH-92]

packer/template.go

@@ -76,14 +76,14 @@ func ParseTemplate(data []byte) (t *Template, err error) {
 		newline := []byte{'\x0a'}
 
 		// Calculate the start/end position of the line where the error is
-		start := bytes.LastIndex(data[:syntaxErr.Offset], newline)+1
+		start := bytes.LastIndex(data[:syntaxErr.Offset], newline) + 1
 		end := len(data)
 		if idx := bytes.Index(data[start:], newline); idx >= 0 {
 			end = start + idx
 		}
 
 		// Count the line number we're on plus the offset in the line
-		line := bytes.Count(data[:start], newline)+1
+		line := bytes.Count(data[:start], newline) + 1
 		pos := int(syntaxErr.Offset) - start - 1
 
 		err = fmt.Errorf("Error in line %d, char %d: %s\n%s",
@@ -230,151 +230,151 @@ func parsePostProvisioner(i int, rawV interface{}) (result []map[string]interfac
 				errors = append(
 					errors,
 					fmt.Errorf("Post-processor %d.%d: sequences not allowed to be nested in sequences", i+1, j+1))
-				default:
-					errors = append(errors, fmt.Errorf("Post-processor %d.%d is in a bad format.", i+1, j+1))
-				}
-			}
-
-			if len(errors) == 0 {
-				errors = nil
+			default:
+				errors = append(errors, fmt.Errorf("Post-processor %d.%d is in a bad format.", i+1, j+1))
 			}
-		default:
-			result = nil
-			errors = []error{fmt.Errorf("Post-processor %d is in a bad format.", i+1)}
 		}
 
-		return
+		if len(errors) == 0 {
+			errors = nil
+		}
+	default:
+		result = nil
+		errors = []error{fmt.Errorf("Post-processor %d is in a bad format.", i+1)}
 	}
 
-	// BuildNames returns a slice of the available names of builds that
-	// this template represents.
-	func (t *Template) BuildNames() []string {
-		names := make([]string, 0, len(t.Builders))
-		for name, _ := range t.Builders {
-			names = append(names, name)
-		}
+	return
+}
 
-		return names
+// BuildNames returns a slice of the available names of builds that
+// this template represents.
+func (t *Template) BuildNames() []string {
+	names := make([]string, 0, len(t.Builders))
+	for name, _ := range t.Builders {
+		names = append(names, name)
 	}
 
-	// Build returns a Build for the given name.
-	//
-	// If the build does not exist as part of this template, an error is
-	// returned.
-	func (t *Template) Build(name string, components *ComponentFinder) (b Build, err error) {
-		// Setup the Builder
-		builderConfig, ok := t.Builders[name]
-		if !ok {
-			err = fmt.Errorf("No such build found in template: %s", name)
-			return
-		}
+	return names
+}
 
-		// We panic if there is no builder function because this is really
-		// an internal bug that always needs to be fixed, not an error.
-		if components.Builder == nil {
-			panic("no builder function")
-		}
+// Build returns a Build for the given name.
+//
+// If the build does not exist as part of this template, an error is
+// returned.
+func (t *Template) Build(name string, components *ComponentFinder) (b Build, err error) {
+	// Setup the Builder
+	builderConfig, ok := t.Builders[name]
+	if !ok {
+		err = fmt.Errorf("No such build found in template: %s", name)
+		return
+	}
 
-		// Panic if there are provisioners on the template but no provisioner
-		// component finder. This is always an internal error, so we panic.
-		if len(t.Provisioners) > 0 && components.Provisioner == nil {
-			panic("no provisioner function")
-		}
+	// We panic if there is no builder function because this is really
+	// an internal bug that always needs to be fixed, not an error.
+	if components.Builder == nil {
+		panic("no builder function")
+	}
 
-		builder, err := components.Builder(builderConfig.Type)
-		if err != nil {
-			return
-		}
+	// Panic if there are provisioners on the template but no provisioner
+	// component finder. This is always an internal error, so we panic.
+	if len(t.Provisioners) > 0 && components.Provisioner == nil {
+		panic("no provisioner function")
+	}
 
-		if builder == nil {
-			err = fmt.Errorf("Builder type not found: %s", builderConfig.Type)
-			return
-		}
+	builder, err := components.Builder(builderConfig.Type)
+	if err != nil {
+		return
+	}
 
-		// Gather the Hooks
-		hooks := make(map[string][]Hook)
-		for tplEvent, tplHooks := range t.Hooks {
-			curHooks := make([]Hook, 0, len(tplHooks))
+	if builder == nil {
+		err = fmt.Errorf("Builder type not found: %s", builderConfig.Type)
+		return
+	}
 
-			for _, hookName := range tplHooks {
-				var hook Hook
-				hook, err = components.Hook(hookName)
-				if err != nil {
-					return
-				}
+	// Gather the Hooks
+	hooks := make(map[string][]Hook)
+	for tplEvent, tplHooks := range t.Hooks {
+		curHooks := make([]Hook, 0, len(tplHooks))
 
-				if hook == nil {
-					err = fmt.Errorf("Hook not found: %s", hookName)
-					return
-				}
+		for _, hookName := range tplHooks {
+			var hook Hook
+			hook, err = components.Hook(hookName)
+			if err != nil {
+				return
+			}
 
-				curHooks = append(curHooks, hook)
+			if hook == nil {
+				err = fmt.Errorf("Hook not found: %s", hookName)
+				return
 			}
 
-			hooks[tplEvent] = curHooks
+			curHooks = append(curHooks, hook)
 		}
 
-		// Prepare the post-processors
-		postProcessors := make([][]coreBuildPostProcessor, 0, len(t.PostProcessors))
-		for _, rawPPs := range t.PostProcessors {
-			current := make([]coreBuildPostProcessor, len(rawPPs))
-			for i, rawPP := range rawPPs {
-				pp, err := components.PostProcessor(rawPP.Type)
-				if err != nil {
-					return nil, err
-				}
-
-				if pp == nil {
-					return nil, fmt.Errorf("PostProcessor type not found: %s", rawPP.Type)
-				}
+		hooks[tplEvent] = curHooks
+	}
 
-				current[i] = coreBuildPostProcessor{
-					processor:         pp,
-					processorType:     rawPP.Type,
-					config:            rawPP.rawConfig,
-					keepInputArtifact: rawPP.KeepInputArtifact,
-				}
+	// Prepare the post-processors
+	postProcessors := make([][]coreBuildPostProcessor, 0, len(t.PostProcessors))
+	for _, rawPPs := range t.PostProcessors {
+		current := make([]coreBuildPostProcessor, len(rawPPs))
+		for i, rawPP := range rawPPs {
+			pp, err := components.PostProcessor(rawPP.Type)
+			if err != nil {
+				return nil, err
 			}
 
-			postProcessors = append(postProcessors, current)
-		}
-
-		// Prepare the provisioners
-		provisioners := make([]coreBuildProvisioner, 0, len(t.Provisioners))
-		for _, rawProvisioner := range t.Provisioners {
-			var provisioner Provisioner
-			provisioner, err = components.Provisioner(rawProvisioner.Type)
-			if err != nil {
-				return
+			if pp == nil {
+				return nil, fmt.Errorf("PostProcessor type not found: %s", rawPP.Type)
 			}
 
-			if provisioner == nil {
-				err = fmt.Errorf("Provisioner type not found: %s", rawProvisioner.Type)
-				return
+			current[i] = coreBuildPostProcessor{
+				processor:         pp,
+				processorType:     rawPP.Type,
+				config:            rawPP.rawConfig,
+				keepInputArtifact: rawPP.KeepInputArtifact,
 			}
+		}
 
-			configs := make([]interface{}, 1, 2)
-			configs[0] = rawProvisioner.rawConfig
+		postProcessors = append(postProcessors, current)
+	}
 
-			if rawProvisioner.Override != nil {
-				if override, ok := rawProvisioner.Override[name]; ok {
-					configs = append(configs, override)
-				}
-			}
+	// Prepare the provisioners
+	provisioners := make([]coreBuildProvisioner, 0, len(t.Provisioners))
+	for _, rawProvisioner := range t.Provisioners {
+		var provisioner Provisioner
+		provisioner, err = components.Provisioner(rawProvisioner.Type)
+		if err != nil {
+			return
+		}
 
-			coreProv := coreBuildProvisioner{provisioner, configs}
-			provisioners = append(provisioners, coreProv)
+		if provisioner == nil {
+			err = fmt.Errorf("Provisioner type not found: %s", rawProvisioner.Type)
+			return
 		}
 
-		b = &coreBuild{
-			name:           name,
-			builder:        builder,
-			builderConfig:  builderConfig.rawConfig,
-			builderType:    builderConfig.Type,
-			hooks:          hooks,
-			postProcessors: postProcessors,
-			provisioners:   provisioners,
+		configs := make([]interface{}, 1, 2)
+		configs[0] = rawProvisioner.rawConfig
+
+		if rawProvisioner.Override != nil {
+			if override, ok := rawProvisioner.Override[name]; ok {
+				configs = append(configs, override)
+			}
 		}
 
-		return
+		coreProv := coreBuildProvisioner{provisioner, configs}
+		provisioners = append(provisioners, coreProv)
+	}
+
+	b = &coreBuild{
+		name:           name,
+		builder:        builder,
+		builderConfig:  builderConfig.rawConfig,
+		builderType:    builderConfig.Type,
+		hooks:          hooks,
+		postProcessors: postProcessors,
+		provisioners:   provisioners,
 	}
+
+	return
+}

post-processor/vagrant/aws.go

@@ -14,6 +14,8 @@ import (
 type AWSBoxConfig struct {
 	OutputPath          string `mapstructure:"output"`
 	VagrantfileTemplate string `mapstructure:"vagrantfile_template"`
+
+	PackerBuildName string `mapstructure:"packer_build_name"`
 }
 
 type AWSVagrantfileTemplate struct {
@@ -51,7 +53,8 @@ func (p *AWSBoxPostProcessor) PostProcess(ui packer.Ui, artifact packer.Artifact
 	}
 
 	// Compile the output path
-	outputPath, err := ProcessOutputPath(p.config.OutputPath, "aws", artifact)
+	outputPath, err := ProcessOutputPath(p.config.OutputPath,
+		p.config.PackerBuildName, "aws", artifact)
 	if err != nil {
 		return nil, false, err
 	}

post-processor/vagrant/post-processor.go

@@ -19,6 +19,8 @@ var builtins = map[string]string{
 
 type Config struct {
 	OutputPath string `mapstructure:"output"`
+
+	PackerBuildName string `mapstructure:"packer_build_name"`
 }
 
 type PostProcessor struct {
@@ -35,7 +37,7 @@ func (p *PostProcessor) Configure(raws ...interface{}) error {
 	}
 
 	if p.config.OutputPath == "" {
-		p.config.OutputPath = "packer_{{.Provider}}.box"
+		p.config.OutputPath = "packer_{{ .BuildName }}_{{.Provider}}.box"
 	}
 
 	_, err := template.New("output").Parse(p.config.OutputPath)
@@ -49,6 +51,10 @@ func (p *PostProcessor) Configure(raws ...interface{}) error {
 		return err
 	}
 
+	packerConfig := map[string]interface{}{
+		packer.BuildNameConfigKey: p.config.PackerBuildName,
+	}
+
 	p.premade = make(map[string]packer.PostProcessor)
 	errors := make([]error, 0)
 	for k, raw := range mapConfig {
@@ -57,7 +63,7 @@ func (p *PostProcessor) Configure(raws ...interface{}) error {
 			continue
 		}
 
-		if err := pp.Configure(raw); err != nil {
+		if err := pp.Configure(raw, packerConfig); err != nil {
 			errors = append(errors, err)
 		}
 

post-processor/vagrant/util.go

@@ -17,6 +17,7 @@ import (
 // OutputPath variables.
 type OutputPathTemplate struct {
 	ArtifactId string
+	BuildName  string
 	Provider   string
 }
 
@@ -83,11 +84,12 @@ func DirToBox(dst, dir string) error {
 
 // ProcessOutputPath takes an output path template and executes it,
 // replacing variables with their respective values.
-func ProcessOutputPath(path string, provider string, artifact packer.Artifact) (string, error) {
+func ProcessOutputPath(path string, buildName string, provider string, artifact packer.Artifact) (string, error) {
 	var buf bytes.Buffer
 
 	tplData := &OutputPathTemplate{
 		ArtifactId: artifact.Id(),
+		BuildName: buildName,
 		Provider:   provider,
 	}
 

post-processor/vagrant/virtualbox.go

@@ -18,6 +18,8 @@ import (
 type VBoxBoxConfig struct {
 	OutputPath          string `mapstructure:"output"`
 	VagrantfileTemplate string `mapstructure:"vagrantfile_template"`
+
+	PackerBuildName string `mapstructure:"packer_build_name"`
 }
 
 type VBoxVagrantfileTemplate struct {
@@ -48,7 +50,8 @@ func (p *VBoxBoxPostProcessor) PostProcess(ui packer.Ui, artifact packer.Artifac
 	}
 
 	// Compile the output path
-	outputPath, err := ProcessOutputPath(p.config.OutputPath, "virtualbox", artifact)
+	outputPath, err := ProcessOutputPath(p.config.OutputPath,
+		p.config.PackerBuildName, "virtualbox", artifact)
 	if err != nil {
 		return nil, false, err
 	}

post-processor/vagrant/vmware.go

@@ -14,6 +14,8 @@ import (
 type VMwareBoxConfig struct {
 	OutputPath          string `mapstructure:"output"`
 	VagrantfileTemplate string `mapstructure:"vagrantfile_template"`
+
+	PackerBuildName string `mapstructure:"packer_build_name"`
 }
 
 type VMwareBoxPostProcessor struct {
@@ -28,13 +30,13 @@ func (p *VMwareBoxPostProcessor) Configure(raws ...interface{}) error {
 		}
 	}
 
-
 	return nil
 }
 
 func (p *VMwareBoxPostProcessor) PostProcess(ui packer.Ui, artifact packer.Artifact) (packer.Artifact, bool, error) {
 	// Compile the output path
-	outputPath, err := ProcessOutputPath(p.config.OutputPath, "vmware", artifact)
+	outputPath, err := ProcessOutputPath(p.config.OutputPath,
+		p.config.PackerBuildName, "vmware", artifact)
 	if err != nil {
 		return nil, false, err
 	}