cmd

Documentation

Overview

Package cmd provides all CLI commands. NOTE: These are different from the commands that get run via pull request comments.

Index

• Constants
• Variables
• func Execute()
• type BootstrapCmd
  • func (b *BootstrapCmd) Init() *cobra.Command
• type DefaultServerCreator
  • func (d *DefaultServerCreator) NewServer(config server.Config) (ServerStarter, error)
• type ServerCmd
  • func (s *ServerCmd) Init() *cobra.Command
• type ServerCreator
• type ServerStarter
• type VersionCmd
  • func (v *VersionCmd) Init() *cobra.Command

Constants

const (
	AtlantisURLFlag     = "atlantis-url"
	ConfigFlag          = "config"
	DataDirFlag         = "data-dir"
	GHHostnameFlag      = "gh-hostname"
	GHTokenFlag         = "gh-token"
	GHUserFlag          = "gh-user"
	GHWebHookSecret     = "gh-webhook-secret" // nolint: gas
	GitlabHostnameFlag  = "gitlab-hostname"
	GitlabTokenFlag     = "gitlab-token"
	GitlabUserFlag      = "gitlab-user"
	GitlabWebHookSecret = "gitlab-webhook-secret"
	LogLevelFlag        = "log-level"
	PortFlag            = "port"
	RequireApprovalFlag = "require-approval"
	SSLCertFileFlag     = "ssl-cert-file"
	SSLKeyFileFlag      = "ssl-key-file"
)

To add a new flag you must: 1. Add a const with the flag name (in alphabetic order). 2. Add a new field to server.Config and set the mapstructure tag equal to the flag name. 3. Add your flag's description etc. to the stringFlags, intFlags, or boolFlags slices.

Variables

var RootCmd = &cobra.Command{
	Use:   "atlantis",
	Short: "A unified workflow for collaborating on Terraform through GitHub and GitLab",
}

RootCmd is the base command onto which all other commands are added.

Functions

func Execute

func Execute()

Execute starts RootCmd.

Types

type BootstrapCmd

type BootstrapCmd struct{}

BootstrapCmd starts the bootstrap process for testing out Atlantis.

func (*BootstrapCmd) Init

func (b *BootstrapCmd) Init() *cobra.Command

Init returns the runnable cobra command.

type DefaultServerCreator

type DefaultServerCreator struct{}

DefaultServerCreator is the concrete implementation of ServerCreator.

func (*DefaultServerCreator) NewServer

func (d *DefaultServerCreator) NewServer(config server.Config) (ServerStarter, error)

NewServer returns the real Atlantis server object.

type ServerCmd

type ServerCmd struct {
	ServerCreator ServerCreator
	Viper         *viper.Viper
	// SilenceOutput set to true means nothing gets printed.
	// Useful for testing to keep the logs clean.
	SilenceOutput bool
}

ServerCmd is an abstraction that helps us test. It allows us to mock out starting the actual server.

func (*ServerCmd) Init

func (s *ServerCmd) Init() *cobra.Command

Init returns the runnable cobra command.

type ServerCreator

type ServerCreator interface {
	NewServer(config server.Config) (ServerStarter, error)
}

ServerCreator creates servers. It's an abstraction to help us test.

type ServerStarter

type ServerStarter interface {
	Start() error
}

ServerStarter is for starting up a server. It's an abstraction to help us test.

type VersionCmd

type VersionCmd struct {
	Viper *viper.Viper
}

VersionCmd prints the current version.

func (*VersionCmd) Init

func (v *VersionCmd) Init() *cobra.Command

Init returns the runnable cobra command.