//go:generate mapstructure-to-hcl2 -type Config //go:generate struct-markdown package file import ( "context" "errors" "fmt" "io" "os" "path/filepath" "strings" "github.com/hashicorp/hcl/v2/hcldec" "github.com/hashicorp/packer-plugin-sdk/common" packersdk "github.com/hashicorp/packer-plugin-sdk/packer" "github.com/hashicorp/packer-plugin-sdk/template/config" "github.com/hashicorp/packer-plugin-sdk/template/interpolate" ) type Config struct { common.PackerConfig `mapstructure:",squash"` // The path to a local file or directory to upload to the // machine. The path can be absolute or relative. If it is relative, it is // relative to the working directory when Packer is executed. If this is a // directory, the existence of a trailing slash is important. Read below on // uploading directories. Mandatory unless `sources` is set. Source string `mapstructure:"source" required:"true"` // A list of sources to upload. This can be used in place of the `source` // option if you have several files that you want to upload to the same // place. Note that the destination must be a directory with a trailing // slash, and that all files listed in `sources` will be uploaded to the // same directory with their file names preserved. Sources []string `mapstructure:"sources" required:"false"` // The path where the file will be uploaded to in the machine. This value // must be a writable location and any parent directories // must already exist. If the provisioning user (generally not root) cannot // write to this directory, you will receive a "Permission Denied" error. // If the source is a file, it's a good idea to make the destination a file // as well, but if you set your destination as a directory, at least make // sure that the destination ends in a trailing slash so that Packer knows // to use the source's basename in the final upload path. Failure to do so // may cause Packer to fail on file uploads. If the destination file // already exists, it will be overwritten. Destination string `mapstructure:"destination" required:"true"` // The direction of the file transfer. This defaults to "upload". If it is // set to "download" then the file "source" in the machine will be // downloaded locally to "destination" Direction string `mapstructure:"direction" required:"false"` // For advanced users only. If true, check the file existence only before // uploading, rather than upon pre-build validation. This allows users to // upload files created on-the-fly. This defaults to false. We // don't recommend using this feature, since it can cause Packer to become // dependent on system state. We would prefer you generate your files before // the Packer run, but realize that there are situations where this may be // unavoidable. Generated bool `mapstructure:"generated" required:"false"` ctx interpolate.Context } type Provisioner struct { config Config } func (p *Provisioner) ConfigSpec() hcldec.ObjectSpec { return p.config.FlatMapstructure().HCL2Spec() } func (p *Provisioner) Prepare(raws ...interface{}) error { err := config.Decode(&p.config, &config.DecodeOpts{ PluginType: "file", Interpolate: true, InterpolateContext: &p.config.ctx, InterpolateFilter: &interpolate.RenderFilter{ Exclude: []string{}, }, }, raws...) if err != nil { return err } if p.config.Direction == "" { p.config.Direction = "upload" } var errs *packersdk.MultiError if p.config.Direction != "download" && p.config.Direction != "upload" { errs = packersdk.MultiErrorAppend(errs, errors.New("Direction must be one of: download, upload.")) } if p.config.Source != "" { p.config.Sources = append(p.config.Sources, p.config.Source) } if p.config.Direction == "upload" { for _, src := range p.config.Sources { if _, err := os.Stat(src); p.config.Generated == false && err != nil { errs = packersdk.MultiErrorAppend(errs, fmt.Errorf("Bad source '%s': %s", src, err)) } } } if len(p.config.Sources) < 1 { errs = packersdk.MultiErrorAppend(errs, errors.New("Source must be specified.")) } if p.config.Destination == "" { errs = packersdk.MultiErrorAppend(errs, errors.New("Destination must be specified.")) } if errs != nil && len(errs.Errors) > 0 { return errs } return nil } func (p *Provisioner) Provision(ctx context.Context, ui packersdk.Ui, comm packersdk.Communicator, generatedData map[string]interface{}) error { if generatedData == nil { generatedData = make(map[string]interface{}) } p.config.ctx.Data = generatedData if p.config.Direction == "download" { return p.ProvisionDownload(ui, comm) } else { return p.ProvisionUpload(ui, comm) } } func (p *Provisioner) ProvisionDownload(ui packersdk.Ui, comm packersdk.Communicator) error { dst, err := interpolate.Render(p.config.Destination, &p.config.ctx) if err != nil { return fmt.Errorf("Error interpolating destination: %s", err) } for _, src := range p.config.Sources { src, err := interpolate.Render(src, &p.config.ctx) if err != nil { return fmt.Errorf("Error interpolating source: %s", err) } ui.Say(fmt.Sprintf("Downloading %s => %s", src, dst)) // ensure destination dir exists. p.config.Destination may either be a file or a dir. dir := dst // if it doesn't end with a /, set dir as the parent dir if !strings.HasSuffix(dst, "/") { dir = filepath.Dir(dir) } else if !strings.HasSuffix(src, "/") && !strings.HasSuffix(src, "*") { dst = filepath.Join(dst, filepath.Base(src)) } if dir != "" { err := os.MkdirAll(dir, os.FileMode(0755)) if err != nil { return err } } // if the src was a dir, download the dir if strings.HasSuffix(src, "/") || strings.ContainsAny(src, "*?[") { return comm.DownloadDir(src, dst, nil) } f, err := os.OpenFile(dst, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0644) if err != nil { return err } defer f.Close() // Create MultiWriter for the current progress pf := io.MultiWriter(f) // Download the file if err = comm.Download(src, pf); err != nil { ui.Error(fmt.Sprintf("Download failed: %s", err)) return err } } return nil } func (p *Provisioner) ProvisionUpload(ui packersdk.Ui, comm packersdk.Communicator) error { dst, err := interpolate.Render(p.config.Destination, &p.config.ctx) if err != nil { return fmt.Errorf("Error interpolating destination: %s", err) } for _, src := range p.config.Sources { src, err := interpolate.Render(src, &p.config.ctx) if err != nil { return fmt.Errorf("Error interpolating source: %s", err) } ui.Say(fmt.Sprintf("Uploading %s => %s", src, dst)) info, err := os.Stat(src) if err != nil { return err } // If we're uploading a directory, short circuit and do that if info.IsDir() { if err = comm.UploadDir(dst, src, nil); err != nil { ui.Error(fmt.Sprintf("Upload failed: %s", err)) return err } continue } // We're uploading a file... f, err := os.Open(src) if err != nil { return err } defer f.Close() fi, err := f.Stat() if err != nil { return err } filedst := dst if strings.HasSuffix(dst, "/") { filedst = dst + filepath.Base(src) } pf := ui.TrackProgress(filepath.Base(src), 0, info.Size(), f) defer pf.Close() // Upload the file if err = comm.Upload(filedst, pf, &fi); err != nil { if strings.Contains(err.Error(), "Error restoring file") { ui.Error(fmt.Sprintf("Upload failed: %s; this can occur when "+ "your file destination is a folder without a trailing "+ "slash.", err)) } ui.Error(fmt.Sprintf("Upload failed: %s", err)) return err } } return nil }