command

Documentation

Index

• Variables
• type ArgCount
  • func (a ArgCount) IsMatchCount(count int) bool
• type Context
• type Lock
  • func (l *Lock) IsLocked() bool
  • func (l *Lock) LockTime() time.Time
• type LockMetadata
• type Name
  • func ParseCommandName(name string) (Name, error)
  • func (c Name) CommandArgCount(subCommand string) (*ArgCount, error)
  • func (c Name) DefaultUsage() string
  • func (c Name) String() string
  • func (c Name) SubCommands() []string
  • func (c Name) TitleString() string
• type ProjectContext
  • func (p ProjectContext) GetPolicyCheckResultFileName() string
  • func (p ProjectContext) GetShowResultFileName() string
  • func (p ProjectContext) PolicyCleared() bool
  • func (p ProjectContext) PullInfo() string
  • func (p ProjectContext) SetProjectScopeTags(scope tally.Scope) tally.Scope
• type ProjectResult
  • func (p ProjectResult) CommitStatus() models.CommitStatus
  • func (p ProjectResult) IsSuccessful() bool
  • func (p ProjectResult) PlanStatus() models.ProjectPlanStatus
  • func (p ProjectResult) PolicyStatus() []models.PolicySetStatus
• type ProjectScopeTags
  • func (s ProjectScopeTags) Loadtags() map[string]string
• type Result
  • func (c Result) HasErrors() bool
• type Trigger

Variables

var AllCommentCommands = []Name{
	Version,
	Plan,
	Apply,
	Unlock,
	ApprovePolicies,
	Import,
	State,
}

AllCommentCommands are list of commands that can be run from a comment.

Types

type ArgCount

type ArgCount struct {
	Min int
	Max int
}

func (ArgCount) IsMatchCount

func (a ArgCount) IsMatchCount(count int) bool

IsMatchCount returns true if the number of arguments matches the requirement

type Context

type Context struct {
	// HeadRepo is the repository that is getting merged into the BaseRepo.
	// If the pull request branch is from the same repository then HeadRepo will
	// be the same as BaseRepo.
	// See https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges
	HeadRepo models.Repo
	Pull     models.PullRequest
	Scope    tally.Scope
	// User is the user that triggered this command.
	User models.User
	Log  logging.SimpleLogging

	// Current PR state
	PullRequestStatus models.PullReqStatus

	PullStatus *models.PullStatus

	// PolicySet is the policy set to target (if specified) for the approve_policies command.
	PolicySet string

	// ClearPolicyApproval is true if approval should be cleared on specified policies.
	ClearPolicyApproval bool

	Trigger Trigger
}

Context represents the context of a command that should be executed for a pull request.

type Lock

type Lock struct {
	// Time is the time at which the lock was first created.
	LockMetadata LockMetadata
	CommandName  Name
}

Lock represents a global lock for an atlantis command (plan, apply, policy_check). It is used to prevent commands from being executed

func (*Lock) IsLocked

func (l *Lock) IsLocked() bool

func (*Lock) LockTime

func (l *Lock) LockTime() time.Time

type LockMetadata

type LockMetadata struct {
	UnixTime int64
}

LockMetadata contains additional data provided to the lock

type Name

type Name int

Name is which command to run.

const (
	// Apply is a command to run terraform apply.
	Apply Name = iota
	// Plan is a command to run terraform plan.
	Plan
	// Unlock is a command to discard previous plans as well as the atlantis locks.
	Unlock
	// PolicyCheck is a command to run conftest test.
	PolicyCheck
	// ApprovePolicies is a command to approve policies with owner check
	ApprovePolicies
	// Autoplan is a command to run terraform plan on PR open/update if autoplan is enabled
	Autoplan
	// Version is a command to run terraform version.
	Version
	// Import is a command to run terraform import
	Import
	// State is a command to run terraform state rm
	State
)

func ParseCommandName

func ParseCommandName(name string) (Name, error)

ParseCommandName parses raw name into a command name.

func (Name) CommandArgCount

func (c Name) CommandArgCount(subCommand string) (*ArgCount, error)

CommandArgCount returns the number of required arguments for the command

func (Name) DefaultUsage

func (c Name) DefaultUsage() string

DefaultUsage returns the command default usage

func (Name) String

func (c Name) String() string

String returns the string representation of c.

func (Name) SubCommands

func (c Name) SubCommands() []string

SubCommands returns the list of sub commands for the command

func (Name) TitleString

func (c Name) TitleString() string

TitleString returns the string representation in title form. ie. policy_check becomes Policy Check

type ProjectContext

type ProjectContext struct {
	CommandName Name
	// ApplyCmd is the command that users should run to apply this plan. If
	// this is an apply then this will be empty.
	ApplyCmd string
	// ApprovePoliciesCmd is the command that users should run to approve policies for this plan. If
	// this is an apply then this will be empty.
	ApprovePoliciesCmd string
	// PlanRequirements is the list of requirements that must be satisfied
	// before we will run the plan stage.
	PlanRequirements []string
	// ApplyRequirements is the list of requirements that must be satisfied
	// before we will run the apply stage.
	ApplyRequirements []string
	// ImportRequirements is the list of requirements that must be satisfied
	// before we will run the import stage.
	ImportRequirements []string
	// AutomergeEnabled is true if automerge is enabled for the repo that this
	// project is in.
	AutomergeEnabled bool
	// ParallelApplyEnabled is true if parallel apply is enabled for this project.
	ParallelApplyEnabled bool
	// ParallelPlanEnabled is true if parallel plan is enabled for this project.
	ParallelPlanEnabled bool
	// ParallelPolicyCheckEnabled is true if parallel policy_check is enabled for this project.
	ParallelPolicyCheckEnabled bool
	// AutoplanEnabled is true if autoplanning is enabled for this project.
	AutoplanEnabled bool
	// BaseRepo is the repository that the pull request will be merged into.
	BaseRepo models.Repo
	// EscapedCommentArgs are the extra arguments that were added to the atlantis
	// command, ex. atlantis plan -- -target=resource. We then escape them
	// by adding a \ before each character so that they can be used within
	// sh -c safely, i.e. sh -c "terraform plan $(touch bad)".
	EscapedCommentArgs []string
	// HeadRepo is the repository that is getting merged into the BaseRepo.
	// If the pull request branch is from the same repository then HeadRepo will
	// be the same as BaseRepo.
	HeadRepo models.Repo
	// Dependencies are a list of project that this project relies on
	// their apply status. These projects must be applied first.
	//
	// Atlantis uses this information to valid the apply
	// orders and to warn the user if they're applying a project that
	// depends on other projects.
	DependsOn []string
	// Log is a logger that's been set up for this context.
	Log logging.SimpleLogging
	// Scope is the scope for reporting stats setup for this context
	Scope tally.Scope
	// PullReqStatus holds state about the PR that requires additional computation outside models.PullRequest
	PullReqStatus models.PullReqStatus
	// CurrentProjectPlanStatus is the status of the current project prior to this command.
	ProjectPlanStatus models.ProjectPlanStatus
	//PullStatus is the status of the current pull request prior to this command.
	PullStatus *models.PullStatus
	// ProjectPolicyStatus is the status of policy sets of the current project prior to this command.
	ProjectPolicyStatus []models.PolicySetStatus

	// Pull is the pull request we're responding to.
	Pull models.PullRequest
	// ProjectName is the name of the project set in atlantis.yaml. If there was
	// no name this will be an empty string.
	ProjectName string
	// RepoConfigVersion is the version of the repo's atlantis.yaml file. If
	// there was no file, this will be 0.
	RepoConfigVersion int
	// RePlanCmd is the command that users should run to re-plan this project.
	// If this is an apply then this will be empty.
	RePlanCmd string
	// RepoRelDir is the directory of this project relative to the repo root.
	RepoRelDir string
	// Steps are the sequence of commands we need to run for this project and this
	// stage.
	Steps []valid.Step
	// TerraformVersion is the version of terraform we should use when executing
	// commands for this project. This can be set to nil in which case we will
	// use the default Atlantis terraform version.
	TerraformVersion *version.Version
	// Configuration metadata for a given project.
	User models.User
	// Verbose is true when the user would like verbose output.
	Verbose bool
	// Workspace is the Terraform workspace this project is in. It will always
	// be set.
	Workspace string
	// PolicySets represent the policies that are run on the plan as part of the
	// policy check stage
	PolicySets valid.PolicySets
	// PolicySetTarget describes which policy sets to target on the approve_policies step.
	PolicySetTarget string
	// ClearPolicyApproval determines whether policy counts will be incremented or cleared.
	ClearPolicyApproval bool
	// DeleteSourceBranchOnMerge will attempt to allow a branch to be deleted when merged (AzureDevOps & GitLab Support Only)
	DeleteSourceBranchOnMerge bool
	// RepoLocking will get a lock when plan
	RepoLocking bool
	// RepoConfigFile
	RepoConfigFile string
	// UUID for atlantis logs
	JobID string
	// The index of order group. Before planning/applying it will use to sort projects. Default is 0.
	ExecutionOrderGroup int
	// If plans/applies should be aborted if any prior plan/apply fails
	AbortOnExcecutionOrderFail bool
	// Allows custom policy check tools outside of Conftest to run in checks
	CustomPolicyCheck bool
}

ProjectContext defines the context for a plan or apply stage that will be executed for a project.

func (ProjectContext) GetPolicyCheckResultFileName

func (p ProjectContext) GetPolicyCheckResultFileName() string

GetPolicyCheckResultFileName returns the filename (not the path) to store the result from conftest_client.

func (ProjectContext) GetShowResultFileName

func (p ProjectContext) GetShowResultFileName() string

GetShowResultFileName returns the filename (not the path) to store the tf show result

func (ProjectContext) PolicyCleared

func (p ProjectContext) PolicyCleared() bool

PolicyCleared returns whether all policies are passing or not.

func (ProjectContext) PullInfo

func (p ProjectContext) PullInfo() string

Gets a unique identifier for the current pull request as a single string

func (ProjectContext) SetProjectScopeTags

func (p ProjectContext) SetProjectScopeTags(scope tally.Scope) tally.Scope

SetProjectScopeTags adds ProjectContext tags to a new returned scope.

type ProjectResult

type ProjectResult struct {
	Command            Name
	SubCommand         string
	RepoRelDir         string
	Workspace          string
	Error              error
	Failure            string
	PlanSuccess        *models.PlanSuccess
	PolicyCheckResults *models.PolicyCheckResults
	ApplySuccess       string
	VersionSuccess     string
	ImportSuccess      *models.ImportSuccess
	StateRmSuccess     *models.StateRmSuccess
	ProjectName        string
}

ProjectResult is the result of executing a plan/policy_check/apply for a specific project.

func (ProjectResult) CommitStatus

func (p ProjectResult) CommitStatus() models.CommitStatus

CommitStatus returns the vcs commit status of this project result.

func (ProjectResult) IsSuccessful

func (p ProjectResult) IsSuccessful() bool

IsSuccessful returns true if this project result had no errors.

func (ProjectResult) PlanStatus

func (p ProjectResult) PlanStatus() models.ProjectPlanStatus

PlanStatus returns the plan status.

func (ProjectResult) PolicyStatus

func (p ProjectResult) PolicyStatus() []models.PolicySetStatus

PolicyStatus returns the approval status of policy sets of this project result.

type ProjectScopeTags

type ProjectScopeTags struct {
	BaseRepo         string
	PrNumber         string
	Project          string
	ProjectPath      string
	TerraformVersion string
	Workspace        string
}

func (ProjectScopeTags) Loadtags

func (s ProjectScopeTags) Loadtags() map[string]string

type Result

type Result struct {
	Error          error
	Failure        string
	ProjectResults []ProjectResult
	// PlansDeleted is true if all plans created during this command were
	// deleted. This happens if automerging is enabled and one project has an
	// error since automerging requires all plans to succeed.
	PlansDeleted bool
}

Result is the result of running a Command.

func (Result) HasErrors

func (c Result) HasErrors() bool

HasErrors returns true if there were any errors during the execution, even if it was only in one project.

type Trigger

type Trigger int

Trigger represents the how the command was triggered

const (
	// Commands that are automatically triggered (ie. automatic plans)
	AutoTrigger Trigger = iota

	// Commands that are triggered by comments (ie. atlantis plan)
	CommentTrigger
)