common

package
v0.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 15, 2016 License: MPL-2.0 Imports: 30 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var RetryExhaustedError error = fmt.Errorf("Function never succeeded in Retry")

Functions

func ChooseString added in v0.6.0 

func ChooseString(vals ...string) string

ChooseString returns the first non-empty value.

func DownloadableURL 

func DownloadableURL(original string) (string, error)

DownloadableURL processes a URL that may also be a file path and returns a completely valid URL. For example, the original URL might be "local/file.iso" which isn't a valid URL. DownloadableURL will return "file:///local/file.iso"

func HashForType 

func HashForType(t string) hash.Hash

HashForType returns the Hash implementation for the given string type, or nil if the type is not supported.

func MultistepDebugFn 

func MultistepDebugFn(ui packer.Ui) multistep.DebugPauseFn

MultistepDebugFn will return a proper multistep.DebugPauseFn to use for debugging if you're using multistep in your builder.

func NewRunner added in v0.11.0 

func NewRunner(steps []multistep.Step, config PackerConfig, ui packer.Ui) multistep.Runner

NewRunner returns a multistep.Runner that runs steps augmented with support for -debug and -on-error command line arguments.

func NewRunnerWithPauseFn added in v0.11.0 

func NewRunnerWithPauseFn(steps []multistep.Step, config PackerConfig, ui packer.Ui, state multistep.StateBag) multistep.Runner

NewRunnerWithPauseFn returns a multistep.Runner that runs steps augmented with support for -debug and -on-error command line arguments. With -debug it puts the multistep.DebugPauseFn that will pause execution between steps into the state under the key "pauseFn".

func Retry added in v0.11.0 

func Retry(initialInterval float64, maxInterval float64, numTries uint, function func() (bool, error)) error

Retry retries a function up to numTries times with exponential backoff. If numTries == 0, retry indefinitely. If interval == 0, Retry will not delay retrying and there will be no exponential backoff. If maxInterval == 0, maxInterval is set to +Infinity. Intervals are in seconds. Returns an error if initial > max intervals, if retries are exhausted, or if the passed function returns an error.

func ScrubConfig added in v0.3.10 

func ScrubConfig(target interface{}, values ...string) string

ScrubConfig is a helper that returns a string representation of any struct with the given values stripped out.

Types

type DownloadClient 

type DownloadClient struct {
	// contains filtered or unexported fields
}

A DownloadClient helps download, verify checksums, etc.

func NewDownloadClient 

func NewDownloadClient(c *DownloadConfig) *DownloadClient

NewDownloadClient returns a new DownloadClient for the given configuration.

func (*DownloadClient) Cancel 

func (d *DownloadClient) Cancel()

func (*DownloadClient) Get 

func (d *DownloadClient) Get() (string, error)

func (*DownloadClient) PercentProgress 

func (d *DownloadClient) PercentProgress() int

PercentProgress returns the download progress as a percentage.

func (*DownloadClient) VerifyChecksum 

func (d *DownloadClient) VerifyChecksum(path string) (bool, error)

VerifyChecksum tests that the path matches the checksum for the download.

type DownloadConfig 

type DownloadConfig struct {
	// The source URL in the form of a string.
	Url string

	// This is the path to download the file to.
	TargetPath string

	// DownloaderMap maps a schema to a Download.
	DownloaderMap map[string]Downloader

	// If true, this will copy even a local file to the target
	// location. If false, then it will "download" the file by just
	// returning the local path to the file.
	CopyFile bool

	// The hashing implementation to use to checksum the downloaded file.
	Hash hash.Hash

	// The checksum for the downloaded file. The hash implementation configuration
	// for the downloader will be used to verify with this checksum after
	// it is downloaded.
	Checksum []byte

	// What to use for the user agent for HTTP requests. If set to "", use the
	// default user agent provided by Go.
	UserAgent string
}

DownloadConfig is the configuration given to instantiate a new download instance. Once a configuration is used to instantiate a download client, it must not be modified.

type Downloader 

type Downloader interface {
	Cancel()
	Download(*os.File, *url.URL) error
	Progress() uint
	Total() uint
}

A downloader is responsible for actually taking a remote URL and downloading it.

type FloppyConfig added in v0.11.0 

type FloppyConfig struct {
	FloppyFiles       []string `mapstructure:"floppy_files"`
	FloppyDirectories []string `mapstructure:"floppy_dirs"`
}

func (*FloppyConfig) Prepare added in v0.11.0 

func (c *FloppyConfig) Prepare(ctx *interpolate.Context) []error

type HTTPConfig added in v0.9.0 

type HTTPConfig struct {
	HTTPDir     string `mapstructure:"http_directory"`
	HTTPPortMin uint   `mapstructure:"http_port_min"`
	HTTPPortMax uint   `mapstructure:"http_port_max"`
}

HTTPConfig contains configuration for the local HTTP Server

func (*HTTPConfig) Prepare added in v0.9.0 

func (c *HTTPConfig) Prepare(ctx *interpolate.Context) []error

type HTTPDownloader 

type HTTPDownloader struct {
	// contains filtered or unexported fields
}

HTTPDownloader is an implementation of Downloader that downloads files over HTTP.

func (*HTTPDownloader) Cancel 

func (*HTTPDownloader) Cancel()

func (*HTTPDownloader) Download 

func (d *HTTPDownloader) Download(dst *os.File, src *url.URL) error

func (*HTTPDownloader) Progress 

func (d *HTTPDownloader) Progress() uint

func (*HTTPDownloader) Total 

func (d *HTTPDownloader) Total() uint

type ISOConfig added in v0.9.0 

type ISOConfig struct {
	ISOChecksum     string   `mapstructure:"iso_checksum"`
	ISOChecksumURL  string   `mapstructure:"iso_checksum_url"`
	ISOChecksumType string   `mapstructure:"iso_checksum_type"`
	ISOUrls         []string `mapstructure:"iso_urls"`
	TargetPath      string   `mapstructure:"iso_target_path"`
	RawSingleISOUrl string   `mapstructure:"iso_url"`
}

ISOConfig contains configuration for downloading ISO images.

func (*ISOConfig) Prepare added in v0.9.0 

func (c *ISOConfig) Prepare(ctx *interpolate.Context) (warnings []string, errs []error)

type PackerConfig 

type PackerConfig struct {
	PackerBuildName   string            `mapstructure:"packer_build_name"`
	PackerBuilderType string            `mapstructure:"packer_builder_type"`
	PackerDebug       bool              `mapstructure:"packer_debug"`
	PackerForce       bool              `mapstructure:"packer_force"`
	PackerOnError     string            `mapstructure:"packer_on_error"`
	PackerUserVars    map[string]string `mapstructure:"packer_user_variables"`
}

PackerConfig is a struct that contains the configuration keys that are sent by packer, properly tagged already so mapstructure can load them. Embed this structure into your configuration class to get it.

type StepCreateFloppy 

type StepCreateFloppy struct {
	Files       []string
	Directories []string

	FilesAdded map[string]bool
	// contains filtered or unexported fields
}

StepCreateFloppy will create a floppy disk with the given files.

func (*StepCreateFloppy) Add added in v0.11.0 

func (s *StepCreateFloppy) Add(dircache directoryCache, src string) error

func (*StepCreateFloppy) Cleanup 

func (s *StepCreateFloppy) Cleanup(multistep.StateBag)

func (*StepCreateFloppy) Run 

func (s *StepCreateFloppy) Run(state multistep.StateBag) multistep.StepAction

type StepDownload added in v0.3.2 

type StepDownload struct {
	// The checksum and the type of the checksum for the download
	Checksum     string
	ChecksumType string

	// A short description of the type of download being done. Example:
	// "ISO" or "Guest Additions"
	Description string

	// The name of the key where the final path of the ISO will be put
	// into the state.
	ResultKey string

	// The path where the result should go, otherwise it goes to the
	// cache directory.
	TargetPath string

	// A list of URLs to attempt to download this thing.
	Url []string

	// Extension is the extension to force for the file that is downloaded.
	// Some systems require a certain extension. If this isn't set, the
	// extension on the URL is used. Otherwise, this will be forced
	// on the downloaded file for every URL.
	Extension string
}

StepDownload downloads a remote file using the download client within this package. This step handles setting up the download configuration, progress reporting, interrupt handling, etc.

Uses: 

cache packer.Cache
ui    packer.Ui

func (*StepDownload) Cleanup added in v0.3.2 

func (s *StepDownload) Cleanup(multistep.StateBag)

func (*StepDownload) Run added in v0.3.2 

func (s *StepDownload) Run(state multistep.StateBag) multistep.StepAction

type StepHTTPServer added in v0.9.0 

type StepHTTPServer struct {
	HTTPDir     string
	HTTPPortMin uint
	HTTPPortMax uint
	// contains filtered or unexported fields
}

This step creates and runs the HTTP server that is serving files from the directory specified by the 'http_directory` configuration parameter in the template.

Uses: 

ui     packer.Ui

Produces: 

http_port int - The port the HTTP server started on.

func (*StepHTTPServer) Cleanup added in v0.9.0 

func (s *StepHTTPServer) Cleanup(multistep.StateBag)

func (*StepHTTPServer) Run added in v0.9.0 

func (s *StepHTTPServer) Run(state multistep.StateBag) multistep.StepAction

type StepProvision 

type StepProvision struct {
	Comm packer.Communicator
}

StepProvision runs the provisioners.

Uses: 

communicator packer.Communicator
hook         packer.Hook
ui           packer.Ui

Produces: 

<nothing>

func (*StepProvision) Cleanup 

func (*StepProvision) Cleanup(multistep.StateBag)

func (*StepProvision) Run 

func (s *StepProvision) Run(state multistep.StateBag) multistep.StepAction

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.