packer-cn/provisioner/converge/provisioner.go

// This package implements a provisioner for Packer that executes
// Converge to provision a remote machine

package converge

import (
	"bytes"
	"errors"
	"fmt"
	"log"
	"net/http"

	"strings"

	"encoding/json"

	"regexp"

	"github.com/mitchellh/packer/common"
	"github.com/mitchellh/packer/helper/config"
	"github.com/mitchellh/packer/packer"
	"github.com/mitchellh/packer/template/interpolate"
)

var versionRegex = regexp.MustCompile(`[\.\-\d\w]*`)

// Config for Converge provisioner
type Config struct {
	common.PackerConfig `mapstructure:",squash"`

	// Bootstrapping
	Bootstrap bool   `mapstructure:"bootstrap"`
	Version   string `mapstructure:"version"`

	// Modules
	ModuleDirs []ModuleDir `mapstructure:"module_dirs"`
	Modules    []Module    `mapstructure:"modules"`

	ctx interpolate.Context
}

// ModuleDir is a directory to transfer to the remote system
type ModuleDir struct {
	Source      string   `mapstructure:"source"`
	Destination string   `mapstructure:"destination"`
	Exclude     []string `mapstructure:"exclude"`
}

// Module contains information needed to run a module
type Module struct {
	Module    string            `mapstructure:"module"`
	Directory string            `mapstructure:"directory"`
	Params    map[string]string `mapstucture:"params"`
}

// Provisioner for Converge
type Provisioner struct {
	config Config
}

// Prepare provisioner somehow. TODO: actual docs
func (p *Provisioner) Prepare(raws ...interface{}) error {
	err := config.Decode(
		&p.config,
		&config.DecodeOpts{
			Interpolate:        true,
			InterpolateContext: &p.config.ctx,
		},
		raws...,
	)
	if err != nil {
		return err
	}

	// validate version
	if !versionRegex.Match([]byte(p.config.Version)) {
		return fmt.Errorf("Invalid Converge version %q specified. Valid versions include only letters, numbers, dots, and dashes", p.config.Version)
	}

	// validate sources and destinations
	for i, dir := range p.config.ModuleDirs {
		if dir.Source == "" {
			return fmt.Errorf("Source (\"source\" key) is required in Converge module dir #%d", i)
		}
		if dir.Destination == "" {
			return fmt.Errorf("Destination (\"destination\" key) is required in Converge module dir #%d", i)
		}
	}

	// validate modules
	if len(p.config.Modules) == 0 {
		return errors.New("Converge requires at least one module (\"modules\" key) to provision the system")
	}
	for i, module := range p.config.Modules {
		if module.Module == "" {
			return fmt.Errorf("Module (\"module\" key) is required in Converge module #%d", i)
		}
		if module.Directory == "" {
			module.Directory = "/tmp"
		}
	}

	return err
}

// Provision node somehow. TODO: actual docs
func (p *Provisioner) Provision(ui packer.Ui, comm packer.Communicator) error {
	ui.Say("Provisioning with Converge")

	// bootstrapping
	if err := p.maybeBootstrap(ui, comm); err != nil {
		return err // error messages are already user-friendly
	}

	// check version (really, this make sure that Converge is installed before we try to run it)
	if err := p.checkVersion(ui, comm); err != nil {
		return err // error messages are already user-friendly
	}

	// send module directories to the remote host
	if err := p.sendModuleDirectories(ui, comm); err != nil {
		return err // error messages are already user-friendly
	}

	// apply all the modules
	if err := p.applyModules(ui, comm); err != nil {
		return err // error messages are already user-friendly
	}

	return nil
}

func (p *Provisioner) maybeBootstrap(ui packer.Ui, comm packer.Communicator) error {
	if !p.config.Bootstrap {
		return nil
	}
	ui.Message("bootstrapping converge")

	bootstrap, err := http.Get("https://get.converge.sh")
	defer bootstrap.Body.Close()
	if err != nil {
		return fmt.Errorf("Error downloading bootstrap script: %s", err) // TODO: is github.com/pkg/error allowed?
	}
	if err := comm.Upload("/tmp/install-converge.sh", bootstrap.Body, nil); err != nil {
		return fmt.Errorf("Error uploading script: %s", err)
	}

	// construct command
	command := "/bin/sh /tmp/install-converge.sh"
	if p.config.Version != "" {
		command += " -v " + p.config.Version
	}

	var out bytes.Buffer
	cmd := &packer.RemoteCmd{
		Command: command,
		Stdin:   nil,
		Stdout:  &out,
		Stderr:  &out,
	}

	if err = comm.Start(cmd); err != nil {
		return fmt.Errorf("Error bootstrapping converge: %s", err)
	}

	cmd.Wait()
	if cmd.ExitStatus != 0 {
		ui.Error(out.String())
		return errors.New("Error bootstrapping converge")
	}

	ui.Message(strings.TrimSpace(out.String()))
	return nil
}

func (p *Provisioner) checkVersion(ui packer.Ui, comm packer.Communicator) error {
	var versionOut bytes.Buffer
	cmd := &packer.RemoteCmd{
		Command: "converge version",
		Stdin:   nil,
		Stdout:  &versionOut,
		Stderr:  &versionOut,
	}
	if err := comm.Start(cmd); err != nil {
		return fmt.Errorf("Error running `converge version`: %s", err)
	}

	cmd.Wait()
	if cmd.ExitStatus == 127 {
		ui.Error("Could not determine Converge version. Is it installed and in PATH?")
		if !p.config.Bootstrap {
			ui.Error("Bootstrapping was disabled for this run. That might be why Converge isn't present.")
		}

		return errors.New("could not determine Converge version")

	} else if cmd.ExitStatus != 0 {
		ui.Error(versionOut.String())
		ui.Error(fmt.Sprintf("exited with error code %d", cmd.ExitStatus))
		return errors.New("Error running `converge version`")
	}

	ui.Say(fmt.Sprintf("Provisioning with %s", strings.TrimSpace(versionOut.String())))

	return nil
}

func (p *Provisioner) sendModuleDirectories(ui packer.Ui, comm packer.Communicator) error {
	for _, dir := range p.config.ModuleDirs {
		if err := comm.UploadDir(dir.Destination, dir.Source, dir.Exclude); err != nil {
			return fmt.Errorf("Could not upload %q: %s", dir.Source, err)
		}
		ui.Message(fmt.Sprintf("transferred %q to %q", dir.Source, dir.Destination))
	}

	return nil
}

func (p *Provisioner) applyModules(ui packer.Ui, comm packer.Communicator) error {
	for _, module := range p.config.Modules {
		// create params JSON file
		params, err := json.Marshal(module.Params)
		if err != nil {
			return fmt.Errorf("Could not marshal parameters as JSON: %s", err)
		}

		// run Converge in the specified directory
		var runOut bytes.Buffer
		cmd := &packer.RemoteCmd{
			Command: fmt.Sprintf(
				"cd %s && converge apply --local --log-level=WARNING --paramsJSON '%s' %s",
				module.Directory,
				string(params),
				module.Module,
			),
			Stdin:  nil,
			Stdout: &runOut,
			Stderr: &runOut,
		}
		if err := comm.Start(cmd); err != nil {
			return fmt.Errorf("Error applying %q: %s", module.Module, err)
		}

		cmd.Wait()
		if cmd.ExitStatus != 0 {
			ui.Error(strings.TrimSpace(runOut.String()))
			ui.Error(fmt.Sprintf("exited with error code %d", cmd.ExitStatus))
			return fmt.Errorf("Error applying %q", module.Module)
		}

		ui.Message(strings.TrimSpace(runOut.String()))
	}

	return nil
}

// Cancel the provisioning process
func (p *Provisioner) Cancel() {
	log.Println("cancel called in Converge provisioner")
}