package command import ( "fmt" "io" "os" "os/signal" "path/filepath" "regexp" "strings" "syscall" "github.com/hashicorp/atlas-go/archive" "github.com/hashicorp/atlas-go/v1" "github.com/hashicorp/packer/helper/flag-kv" "github.com/hashicorp/packer/helper/flag-slice" "github.com/hashicorp/packer/template" "github.com/posener/complete" ) // archiveTemplateEntry is the name the template always takes within the slug. const archiveTemplateEntry = ".packer-template" var ( reName = regexp.MustCompile("^[a-zA-Z0-9-_./]+$") errInvalidName = fmt.Errorf("Your build name can only contain these characters: %s", reName.String()) ) type PushCommand struct { Meta client *atlas.Client // For tests: uploadFn pushUploadFn } // pushUploadFn is the callback type used for tests to stub out the uploading // logic of the push command. type pushUploadFn func( io.Reader, *uploadOpts) (<-chan struct{}, <-chan error, error) func (c *PushCommand) Run(args []string) int { var token string var message string var name string var create bool var sensitiveVars []string flags := c.Meta.FlagSet("push", FlagSetVars) flags.Usage = func() { c.Ui.Error(c.Help()) } flags.StringVar(&token, "token", "", "token") flags.StringVar(&message, "m", "", "message") flags.StringVar(&message, "message", "", "message") flags.StringVar(&name, "name", "", "name") flags.BoolVar(&create, "create", false, "create (deprecated)") flags.Var((*sliceflag.StringFlag)(&sensitiveVars), "sensitive", "") if err := flags.Parse(args); err != nil { return 1 } if message != "" { c.Ui.Say("[DEPRECATED] -m/-message is deprecated and will be removed in a future Packer release") } args = flags.Args() if len(args) != 1 { flags.Usage() return 1 } // Print deprecations if create { c.Ui.Error(fmt.Sprintf("The '-create' option is now the default and is\n" + "longer used. It will be removed in the next version.")) } // Parse the template tpl, err := template.ParseFile(args[0]) if err != nil { c.Ui.Error(fmt.Sprintf("Failed to parse template: %s", err)) return 1 } // Get the core core, err := c.Meta.Core(tpl) if err != nil { c.Ui.Error(err.Error()) return 1 } push := core.Template.Push // If we didn't pass name from the CLI, use the template if name == "" { name = push.Name } // Validate some things if name == "" { c.Ui.Error(fmt.Sprintf( "The 'push' section must be specified in the template with\n" + "at least the 'name' option set. Alternatively, you can pass the\n" + "name parameter from the CLI.")) return 1 } if !reName.MatchString(name) { c.Ui.Error(errInvalidName.Error()) return 1 } // Determine our token if token == "" { token = push.Token } // Build our client defer func() { c.client = nil }() c.client = atlas.DefaultClient() if push.Address != "" { c.client, err = atlas.NewClient(push.Address) if err != nil { c.Ui.Error(fmt.Sprintf( "Error setting up API client: %s", err)) return 1 } } if token != "" { c.client.Token = token } // Build the archiving options var opts archive.ArchiveOpts opts.Include = push.Include opts.Exclude = push.Exclude opts.VCS = push.VCS opts.Extra = map[string]string{ archiveTemplateEntry: args[0], } // Determine the path we're archiving. This logic is a bit complicated // as there are three possibilities: // // 1.) BaseDir is an absolute path, just use that. // // 2.) BaseDir is empty, so we use the directory of the template. // // 3.) BaseDir is relative, so we use the path relative to the directory // of the template. // path := push.BaseDir if path == "" || !filepath.IsAbs(path) { tplPath, err := filepath.Abs(args[0]) if err != nil { c.Ui.Error(fmt.Sprintf("Error determining path to archive: %s", err)) return 1 } tplPath = filepath.Dir(tplPath) if path != "" { tplPath = filepath.Join(tplPath, path) } path, err = filepath.Abs(tplPath) if err != nil { c.Ui.Error(fmt.Sprintf("Error determining path to archive: %s", err)) return 1 } } // Find the Atlas post-processors, if possible var atlasPPs []*template.PostProcessor for _, list := range tpl.PostProcessors { for _, pp := range list { if pp.Type == "atlas" { atlasPPs = append(atlasPPs, pp) } } } // Build the upload options var uploadOpts uploadOpts uploadOpts.Slug = name uploadOpts.Builds = make(map[string]*uploadBuildInfo) for _, b := range tpl.Builders { info := &uploadBuildInfo{Type: b.Type} // todo: remove post-migration if b.Type == "vagrant" { c.Ui.Error("\n-----------------------------------------------------------------------------------\n" + "Vagrant-related functionality has been moved from Terraform Enterprise into \n" + "its own product, Vagrant Cloud. For more information see " + "https://www.vagrantup.com/docs/vagrant-cloud/vagrant-cloud-migration.html\n" + "Please replace the Atlas post-processor with the Vagrant Cloud post-processor,\n" + "and see https://www.packer.io/docs/post-processors/vagrant-cloud.html for\n" + "more detail.\n" + "-----------------------------------------------------------------------------------\n") return 1 } // Determine if we're artifacting this build for _, pp := range atlasPPs { if !pp.Skip(b.Name) { info.Artifact = true break } } uploadOpts.Builds[b.Name] = info } // Collect the variables from CLI args and any var files if sf := flags.Lookup("sensitive"); sf != nil { sfv := sf.Value.(*sliceflag.StringFlag) svars := []string(*sfv) uploadOpts.SensitiveVars = svars } uploadOpts.Vars = make(map[string]string) if vs := flags.Lookup("var"); vs != nil { f := vs.Value.(*kvflag.Flag) vars := map[string]string(*f) for k, v := range vars { uploadOpts.Vars[k] = v } } // Add the upload metadata metadata := make(map[string]interface{}) if message != "" { metadata["message"] = message } metadata["template"] = tpl.RawContents metadata["template_name"] = filepath.Base(args[0]) uploadOpts.Metadata = metadata // Warn about builds not having post-processors. var badBuilds []string for name, b := range uploadOpts.Builds { if b.Artifact { continue } badBuilds = append(badBuilds, name) } if len(badBuilds) > 0 { c.Ui.Error(fmt.Sprintf( "Warning! One or more of the builds in this template does not\n"+ "have an Atlas post-processor. Artifacts from this template will\n"+ "not appear in the Atlas artifact registry.\n\n"+ "This is just a warning. Atlas will still build your template\n"+ "and assume other post-processors are sending the artifacts where\n"+ "they need to go.\n\n"+ "Builds: %s\n\n", strings.Join(badBuilds, ", "))) } c.Ui.Message("\n-----------------------------------------------------------------------\n" + "Deprecation warning: The Packer and Artifact Registry features of Atlas\n" + "will no longer be actively developed or maintained and will be fully\n" + "decommissioned. Please see our guide on building immutable\n" + "infrastructure with Packer on CI/CD for ideas on implementing\n" + "these features yourself: https://www.packer.io/guides/packer-on-cicd/\n" + "-----------------------------------------------------------------------\n", ) // Start the archiving process r, err := archive.CreateArchive(path, &opts) if err != nil { c.Ui.Error(fmt.Sprintf("Error archiving: %s", err)) return 1 } defer r.Close() // Start the upload process doneCh, uploadErrCh, err := c.upload(r, &uploadOpts) if err != nil { c.Ui.Error(fmt.Sprintf("Error starting upload: %s", err)) return 1 } // Make a ctrl-C channel sigCh := make(chan os.Signal, 1) signal.Notify(sigCh, os.Interrupt, syscall.SIGTERM) defer signal.Stop(sigCh) err = nil select { case err = <-uploadErrCh: err = fmt.Errorf("Error uploading: %s", err) case <-sigCh: err = fmt.Errorf("Push cancelled from Ctrl-C") case <-doneCh: } if err != nil { c.Ui.Error(err.Error()) return 1 } c.Ui.Say(fmt.Sprintf("Push successful to '%s'", name)) return 0 } func (*PushCommand) Help() string { helpText := ` Usage: packer push [options] TEMPLATE Push the given template and supporting files to a Packer build service such as Atlas. If a build configuration for the given template does not exist, it will be created automatically. If the build configuration already exists, a new version will be created with this template and the supporting files. Additional configuration options (such as the Atlas server URL and files to include) may be specified in the "push" section of the Packer template. Please see the online documentation for more information about these configurables. Options: -name= The destination build in Atlas. This is in a format "username/name". -token= The access token to use to when uploading -sensitive='var1,var2' List of variables to mark as sensitive in Atlas UI. -var 'key=value' Variable for templates, can be used multiple times. -var-file=path JSON file containing user variables. ` return strings.TrimSpace(helpText) } func (*PushCommand) Synopsis() string { return "push a template and supporting files to a Packer build service" } func (*PushCommand) AutocompleteArgs() complete.Predictor { return complete.PredictNothing } func (*PushCommand) AutocompleteFlags() complete.Flags { return complete.Flags{ "-name": complete.PredictNothing, "-token": complete.PredictNothing, "-sensitive": complete.PredictNothing, "-var": complete.PredictNothing, "-var-file": complete.PredictNothing, } } func (c *PushCommand) upload( r *archive.Archive, opts *uploadOpts) (<-chan struct{}, <-chan error, error) { if c.uploadFn != nil { return c.uploadFn(r, opts) } // Separate the slug into the user and name components user, name, err := atlas.ParseSlug(opts.Slug) if err != nil { return nil, nil, fmt.Errorf("upload: %s", err) } // Get the build configuration bc, err := c.client.BuildConfig(user, name) if err != nil { if err == atlas.ErrNotFound { // Build configuration doesn't exist, attempt to create it bc, err = c.client.CreateBuildConfig(user, name) } if err != nil { return nil, nil, fmt.Errorf("upload: %s", err) } } // Build the version to send up version := atlas.BuildConfigVersion{ User: bc.User, Name: bc.Name, Builds: make([]atlas.BuildConfigBuild, 0, len(opts.Builds)), } // Build the BuildVars struct buildVars := atlas.BuildVars{} for k, v := range opts.Vars { isSensitive := false for _, sensitiveVar := range opts.SensitiveVars { if sensitiveVar == k { isSensitive = true break } } buildVars = append(buildVars, atlas.BuildVar{ Key: k, Value: v, Sensitive: isSensitive, }) } for name, info := range opts.Builds { version.Builds = append(version.Builds, atlas.BuildConfigBuild{ Name: name, Type: info.Type, Artifact: info.Artifact, }) } // Start the upload doneCh, errCh := make(chan struct{}), make(chan error) go func() { err := c.client.UploadBuildConfigVersion(&version, opts.Metadata, buildVars, r, r.Size) if err != nil { errCh <- err return } close(doneCh) }() return doneCh, errCh, nil } type uploadOpts struct { URL string Slug string Builds map[string]*uploadBuildInfo Metadata map[string]interface{} Vars map[string]string SensitiveVars []string } type uploadBuildInfo struct { Type string Artifact bool }