events

package
v0.17.0-beta Latest Latest
Warning

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

 Go to latest Published: Feb 23, 2021 License: Apache-2.0 Imports: 41 Imported by: 60

Documentation

Overview

Copyright 2017 HootSuite Media Inc.

Licensed under the Apache License, Version 2.0 (the License); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Modified hereafter by contributors to runatlantis/atlantis.

Index

Constants

View Source 
const (
	// DefaultRepoRelDir is the default directory we run commands in, relative
	// to the root of the repo.
	DefaultRepoRelDir = "."
	// DefaultWorkspace is the default Terraform workspace we run commands in.
	// This is also Terraform's default workspace.
	DefaultWorkspace = "default"
	// DefaultAutomergeEnabled is the default for the automerge setting.
	DefaultAutomergeEnabled = false
	// DefaultParallelApplyEnabled is the default for the parallel apply setting.
	DefaultParallelApplyEnabled = false
	// DefaultParallelPlanEnabled is the default for the parallel plan setting.
	DefaultParallelPlanEnabled = false
)
View Source 
const (
	ShutdownComment = "Atlantis server is shutting down, please try again later."
)
View Source 
const Wildcard = "*"

Wildcard matches 0-n of all characters except commas.

Variables

View Source 
var DidYouMeanAtlantisComment = "Did you mean to use `atlantis` instead of `terraform`?"

DidYouMeanAtlantisComment is the comment we add to the pull request when someone runs a command with terraform instead of atlantis.

View Source 
var UnlockUsage = "`Usage of unlock:`\n\n ```cmake\n" +
	`atlantis unlock	

  Unlocks the entire PR and discards all plans in this PR.
  Arguments or flags are not supported at the moment.
  If you need to unlock a specific project please use the atlantis UI.` +
	"\n```"

Functions

func WriteGitCreds added in v0.9.0 

func WriteGitCreds(gitUser string, gitToken string, gitHostname string, home string, logger *logging.SimpleLogger, ghAccessToken bool) error

WriteGitCreds generates a .git-credentials file containing the username and token used for authenticating with git over HTTPS It will create the file in home/.git-credentials If ghAccessToken is true we will look for a line starting with https://x-access-token and ending with gitHostname and replace it.

Types

type ApplyCommandRunner added in v0.17.0 

type ApplyCommandRunner struct {
	DisableApplyAll bool
	DisableApply    bool
	DB              *db.BoltDB
	// contains filtered or unexported fields
}

func NewApplyCommandRunner added in v0.17.0 

func NewApplyCommandRunner(
	vcsClient vcs.Client,
	disableApplyAll bool,
	disableApply bool,
	commitStatusUpdater CommitStatusUpdater,
	prjCommandBuilder ProjectApplyCommandBuilder,
	prjCmdRunner ProjectApplyCommandRunner,
	autoMerger *AutoMerger,
	pullUpdater *PullUpdater,
	dbUpdater *DBUpdater,
	db *db.BoltDB,
	parallelPoolSize int,
) *ApplyCommandRunner

func (*ApplyCommandRunner) Run added in v0.17.0 

func (a *ApplyCommandRunner) Run(ctx *CommandContext, cmd *CommentCommand)

type ApprovePoliciesCommandRunner added in v0.17.0 

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

func NewApprovePoliciesCommandRunner added in v0.17.0 

func NewApprovePoliciesCommandRunner(
	commitStatusUpdater CommitStatusUpdater,
	prjCommandBuilder ProjectApprovePoliciesCommandBuilder,
	prjCommandRunner ProjectApprovePoliciesCommandRunner,
	pullUpdater *PullUpdater,
	dbUpdater *DBUpdater,
) *ApprovePoliciesCommandRunner

func (*ApprovePoliciesCommandRunner) Run added in v0.17.0 

func (a *ApprovePoliciesCommandRunner) Run(ctx *CommandContext, cmd *CommentCommand)

type AutoMerger added in v0.17.0 

type AutoMerger struct {
	VCSClient       vcs.Client
	GlobalAutomerge bool
}

type AutoplanCommand added in v0.4.0 

type AutoplanCommand struct{}

AutoplanCommand is a plan command that is automatically triggered when a pull request is opened or updated.

func (AutoplanCommand) CommandName added in v0.4.0 

func (c AutoplanCommand) CommandName() models.CommandName

CommandName is plan.

func (AutoplanCommand) IsAutoplan added in v0.4.0 

func (c AutoplanCommand) IsAutoplan() bool

IsAutoplan is true for autoplan commands (obviously).

func (AutoplanCommand) IsVerbose added in v0.4.0 

func (c AutoplanCommand) IsVerbose() bool

IsVerbose is false for autoplan commands.

type AzureDevopsPullGetter added in v0.10.0 

type AzureDevopsPullGetter interface {
	// GetPullRequest gets the pull request with id pullNum for the repo.
	GetPullRequest(repo models.Repo, pullNum int) (*azuredevops.GitPullRequest, error)
}

AzureDevopsPullGetter makes API calls to get pull requests.

type CommandContext 

type CommandContext 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://help.github.com/articles/about-pull-request-merges/.
	HeadRepo models.Repo
	Pull     models.PullRequest
	// User is the user that triggered this command.
	User models.User
	Log  *logging.SimpleLogger
	// PullMergeable is true if Pull is able to be merged. This is available in
	// the CommandContext because we want to collect this information before we
	// set our own build statuses which can affect mergeability if users have
	// required the Atlantis status to be successful prior to merging.
	PullMergeable bool

	Trigger CommandTrigger
}

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

type CommandResult added in v0.4.0 

type CommandResult struct {
	Error          error
	Failure        string
	ProjectResults []models.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
}

CommandResult is the result of running a Command.

func (CommandResult) HasErrors added in v0.4.14 

func (c CommandResult) HasErrors() bool

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

type CommandRunner 

type CommandRunner interface {
	// RunCommentCommand is the first step after a command request has been parsed.
	// It handles gathering additional information needed to execute the command
	// and then calling the appropriate services to finish executing the command.
	RunCommentCommand(baseRepo models.Repo, maybeHeadRepo *models.Repo, maybePull *models.PullRequest, user models.User, pullNum int, cmd *CommentCommand)
	RunAutoplanCommand(baseRepo models.Repo, headRepo models.Repo, pull models.PullRequest, user models.User)
}

CommandRunner is the first step after a command request has been parsed.

type CommandTrigger added in v0.17.0 

type CommandTrigger int

CommandTrigger represents the how the command was triggered 

const (
	// Commands that are automatically triggered (ie. automatic plans)
	Auto CommandTrigger = iota

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

type CommentBuilder added in v0.4.5 

type CommentBuilder interface {
	// BuildPlanComment builds a plan comment for the specified args.
	BuildPlanComment(repoRelDir string, workspace string, project string, commentArgs []string) string
	// BuildApplyComment builds an apply comment for the specified args.
	BuildApplyComment(repoRelDir string, workspace string, project string) string
}

CommentBuilder builds comment commands that can be used on pull requests.

type CommentCommand added in v0.4.0 

type CommentCommand struct {
	// RepoRelDir is the path relative to the repo root to run the command in.
	// Will never end in "/". If empty then the comment specified no directory.
	RepoRelDir string
	// Flags are the extra arguments appended to the comment,
	// ex. atlantis plan -- -target=resource
	Flags []string
	// Name is the name of the command the comment specified.
	Name models.CommandName
	// Verbose is true if the command should output verbosely.
	Verbose bool
	// Workspace is the name of the Terraform workspace to run the command in.
	// If empty then the comment specified no workspace.
	Workspace string
	// ProjectName is the name of a project to run the command on. It refers to a
	// project specified in an atlantis.yaml file.
	// If empty then the comment specified no project.
	ProjectName string
}

CommentCommand is a command that was triggered by a pull request comment.

func NewCommentCommand added in v0.4.0 

func NewCommentCommand(repoRelDir string, flags []string, name models.CommandName, verbose bool, workspace string, project string) *CommentCommand

NewCommentCommand constructs a CommentCommand, setting all missing fields to defaults.

func (CommentCommand) CommandName added in v0.4.0 

func (c CommentCommand) CommandName() models.CommandName

CommandName returns the name of this command.

func (CommentCommand) IsAutoplan added in v0.4.0 

func (c CommentCommand) IsAutoplan() bool

IsAutoplan will be false for comment commands.

func (CommentCommand) IsForSpecificProject added in v0.4.5 

func (c CommentCommand) IsForSpecificProject() bool

IsForSpecificProject returns true if the command is for a specific dir, workspace or project name. Otherwise it's a command like "atlantis plan" or "atlantis apply".

func (CommentCommand) IsVerbose added in v0.4.0 

func (c CommentCommand) IsVerbose() bool

IsVerbose is true if the command should give verbose output.

func (CommentCommand) String added in v0.4.0 

func (c CommentCommand) String() string

String returns a string representation of the command.

type CommentCommandRunner added in v0.17.0 

type CommentCommandRunner interface {
	Run(*CommandContext, *CommentCommand)
}

CommentCommandRunner runs individual command workflows.

type CommentParseResult added in v0.3.0 

type CommentParseResult struct {
	// Command is the successfully parsed command. Will be nil if
	// CommentResponse or Ignore is set.
	Command *CommentCommand
	// CommentResponse is set when we should respond immediately to the command
	// for example for atlantis help.
	CommentResponse string
	// Ignore is set to true when we should just ignore this comment.
	Ignore bool
}

CommentParseResult describes the result of parsing a comment as a command.

type CommentParser added in v0.3.0 

type CommentParser struct {
	GithubUser      string
	GitlabUser      string
	BitbucketUser   string
	AzureDevopsUser string
	ApplyDisabled   bool
}

CommentParser implements CommentParsing

func (*CommentParser) BuildApplyComment added in v0.4.5 

func (e *CommentParser) BuildApplyComment(repoRelDir string, workspace string, project string) string

BuildApplyComment builds an apply comment for the specified args.

func (*CommentParser) BuildPlanComment added in v0.4.5 

func (e *CommentParser) BuildPlanComment(repoRelDir string, workspace string, project string, commentArgs []string) string

BuildPlanComment builds a plan comment for the specified args.

func (*CommentParser) HelpComment added in v0.16.0 

func (e *CommentParser) HelpComment(applyDisabled bool) string

func (*CommentParser) Parse added in v0.3.0 

func (e *CommentParser) Parse(comment string, vcsHost models.VCSHostType) CommentParseResult

Parse parses the comment as an Atlantis command.

Valid commands contain:

  • The initial "executable" name, 'run' or 'atlantis' or '@GithubUser' where GithubUser is the API user Atlantis is running as.
  • Then a command, either 'plan', 'apply', 'approve_policies', or 'help'.
  • Then optional flags, then an optional separator '--' followed by optional extra flags to be appended to the terraform plan/apply command.

Examples: - atlantis help - run plan - @GithubUser plan -w staging - atlantis plan -w staging -d dir --verbose - atlantis plan --verbose -- -key=value -key2 value2 - atlantis approve_policies

type CommentParsing added in v0.3.0 

type CommentParsing interface {
	// Parse attempts to parse a pull request comment to see if it's an Atlantis
	// command.
	Parse(comment string, vcsHost models.VCSHostType) CommentParseResult
}

CommentParsing handles parsing pull request comments.

type CommitStatusUpdater added in v0.2.0 

type CommitStatusUpdater interface {
	// UpdateCombined updates the combined status of the head commit of pull.
	// A combined status represents all the projects modified in the pull.
	UpdateCombined(repo models.Repo, pull models.PullRequest, status models.CommitStatus, command models.CommandName) error
	// UpdateCombinedCount updates the combined status to reflect the
	// numSuccess out of numTotal.
	UpdateCombinedCount(repo models.Repo, pull models.PullRequest, status models.CommitStatus, command models.CommandName, numSuccess int, numTotal int) error
	// UpdateProject sets the commit status for the project represented by
	// ctx.
	UpdateProject(ctx models.ProjectCommandContext, cmdName models.CommandName, status models.CommitStatus, url string) error
}

CommitStatusUpdater updates the status of a commit with the VCS host. We set the status to signify whether the plan/apply succeeds.

type CustomStepRunner added in v0.7.0 

type CustomStepRunner interface {
	// Run cmd in path.
	Run(ctx models.ProjectCommandContext, cmd string, path string, envs map[string]string) (string, error)
}

CustomStepRunner runs custom run steps.

type DBUpdater added in v0.17.0 

type DBUpdater struct {
	DB *db.BoltDB
}

type DefaultCommandRunner added in v0.4.0 

type DefaultCommandRunner struct {
	VCSClient                vcs.Client
	GithubPullGetter         GithubPullGetter
	AzureDevopsPullGetter    AzureDevopsPullGetter
	GitlabMergeRequestGetter GitlabMergeRequestGetter
	DisableAutoplan          bool
	EventParser              EventParsing
	Logger                   logging.SimpleLogging
	// AllowForkPRs controls whether we operate on pull requests from forks.
	AllowForkPRs bool
	// ParallelPoolSize controls the size of the wait group used to run
	// parallel plans and applies (if enabled).
	ParallelPoolSize int
	// AllowForkPRsFlag is the name of the flag that controls fork PR's. We use
	// this in our error message back to the user on a forked PR so they know
	// how to enable this functionality.
	AllowForkPRsFlag string
	// SilenceForkPRErrors controls whether to comment on Fork PRs when AllowForkPRs = False
	SilenceForkPRErrors bool
	// SilenceForkPRErrorsFlag is the name of the flag that controls fork PR's. We use
	// this in our error message back to the user on a forked PR so they know
	// how to disable error comment
	SilenceForkPRErrorsFlag       string
	CommentCommandRunnerByCmd     map[models.CommandName]CommentCommandRunner
	Drainer                       *Drainer
	PreWorkflowHooksCommandRunner PreWorkflowHooksCommandRunner
}

DefaultCommandRunner is the first step when processing a comment command.

func (*DefaultCommandRunner) RunAutoplanCommand added in v0.4.0 

func (c *DefaultCommandRunner) RunAutoplanCommand(baseRepo models.Repo, headRepo models.Repo, pull models.PullRequest, user models.User)

RunAutoplanCommand runs plan and policy_checks when a pull request is opened or updated.

func (*DefaultCommandRunner) RunCommentCommand added in v0.4.0 

func (c *DefaultCommandRunner) RunCommentCommand(baseRepo models.Repo, maybeHeadRepo *models.Repo, maybePull *models.PullRequest, user models.User, pullNum int, cmd *CommentCommand)

RunCommentCommand executes the command. We take in a pointer for maybeHeadRepo because for some events there isn't enough data to construct the Repo model and callers might want to wait until the event is further validated before making an additional (potentially wasteful) call to get the necessary data.

type DefaultCommitStatusUpdater added in v0.2.0 

type DefaultCommitStatusUpdater struct {
	Client vcs.Client
	// StatusName is the name used to identify Atlantis when creating PR statuses.
	StatusName string
}

DefaultCommitStatusUpdater implements CommitStatusUpdater.

func (*DefaultCommitStatusUpdater) UpdateCombined added in v0.5.0 

func (d *DefaultCommitStatusUpdater) UpdateCombined(repo models.Repo, pull models.PullRequest, status models.CommitStatus, command models.CommandName) error

func (*DefaultCommitStatusUpdater) UpdateCombinedCount added in v0.5.0 

func (d *DefaultCommitStatusUpdater) UpdateCombinedCount(repo models.Repo, pull models.PullRequest, status models.CommitStatus, command models.CommandName, numSuccess int, numTotal int) error

func (*DefaultCommitStatusUpdater) UpdateProject added in v0.5.0 

func (d *DefaultCommitStatusUpdater) UpdateProject(ctx models.ProjectCommandContext, cmdName models.CommandName, status models.CommitStatus, url string) error

type DefaultDeleteLockCommand added in v0.14.0 

type DefaultDeleteLockCommand struct {
	Locker           locking.Locker
	Logger           *logging.SimpleLogger
	WorkingDir       WorkingDir
	WorkingDirLocker WorkingDirLocker
	DB               *db.BoltDB
}

DefaultDeleteLockCommand deletes a specific lock after a request from the LocksController.

func (*DefaultDeleteLockCommand) DeleteLock added in v0.14.0 

func (l *DefaultDeleteLockCommand) DeleteLock(id string) (*models.ProjectLock, error)

DeleteLock handles deleting the lock at id

func (*DefaultDeleteLockCommand) DeleteLocksByPull added in v0.14.0 

func (l *DefaultDeleteLockCommand) DeleteLocksByPull(repoFullName string, pullNum int) error

DeleteLocksByPull handles deleting all locks for the pull request

type DefaultPendingPlanFinder added in v0.4.14 

type DefaultPendingPlanFinder struct{}

DefaultPendingPlanFinder finds unapplied plans.

func (*DefaultPendingPlanFinder) DeletePlans added in v0.4.14 

func (p *DefaultPendingPlanFinder) DeletePlans(pullDir string) error

deletePlans deletes all plans in pullDir.

func (*DefaultPendingPlanFinder) Find added in v0.4.14 

func (p *DefaultPendingPlanFinder) Find(pullDir string) ([]PendingPlan, error)

Find finds all pending plans in pullDir. pullDir should be the working directory where Atlantis will operate on this pull request. It's one level up from where Atlantis clones the repo for each workspace.

type DefaultPreWorkflowHooksCommandRunner added in v0.16.0 

type DefaultPreWorkflowHooksCommandRunner struct {
	VCSClient             vcs.Client
	WorkingDirLocker      WorkingDirLocker
	WorkingDir            WorkingDir
	GlobalCfg             valid.GlobalCfg
	PreWorkflowHookRunner runtime.PreWorkflowHookRunner
}

DefaultPreWorkflowHooksCommandRunner is the first step when processing a workflow hook commands.

func (*DefaultPreWorkflowHooksCommandRunner) RunPreHooks added in v0.16.0 

func (w *DefaultPreWorkflowHooksCommandRunner) RunPreHooks(
	ctx *CommandContext,
) error

RunPreHooks runs pre_workflow_hooks when PR is opened or updated.

type DefaultProjectCommandBuilder added in v0.4.0 

type DefaultProjectCommandBuilder struct {
	ParserValidator              *yaml.ParserValidator
	ProjectFinder                ProjectFinder
	VCSClient                    vcs.Client
	WorkingDir                   WorkingDir
	WorkingDirLocker             WorkingDirLocker
	GlobalCfg                    valid.GlobalCfg
	PendingPlanFinder            *DefaultPendingPlanFinder
	ProjectCommandContextBuilder ProjectCommandContextBuilder
	SkipCloneNoChanges           bool
}

DefaultProjectCommandBuilder implements ProjectCommandBuilder. This class combines the data from the comment and any atlantis.yaml file or Atlantis server config and then generates a set of contexts.

func NewProjectCommandBuilder added in v0.17.0 

func NewProjectCommandBuilder(
	policyChecksSupported bool,
	parserValidator *yaml.ParserValidator,
	projectFinder ProjectFinder,
	vcsClient vcs.Client,
	workingDir WorkingDir,
	workingDirLocker WorkingDirLocker,
	globalCfg valid.GlobalCfg,
	pendingPlanFinder *DefaultPendingPlanFinder,
	commentBuilder CommentBuilder,
	skipCloneNoChanges bool,
) *DefaultProjectCommandBuilder

func (*DefaultProjectCommandBuilder) BuildApplyCommands added in v0.4.5 

func (p *DefaultProjectCommandBuilder) BuildApplyCommands(ctx *CommandContext, cmd *CommentCommand) ([]models.ProjectCommandContext, error)

See ProjectCommandBuilder.BuildApplyCommands.

func (*DefaultProjectCommandBuilder) BuildApprovePoliciesCommands added in v0.17.0 

func (p *DefaultProjectCommandBuilder) BuildApprovePoliciesCommands(ctx *CommandContext, cmd *CommentCommand) ([]models.ProjectCommandContext, error)

func (*DefaultProjectCommandBuilder) BuildAutoplanCommands added in v0.4.0 

func (p *DefaultProjectCommandBuilder) BuildAutoplanCommands(ctx *CommandContext) ([]models.ProjectCommandContext, error)

See ProjectCommandBuilder.BuildAutoplanCommands.

func (*DefaultProjectCommandBuilder) BuildPlanCommands added in v0.4.5 

func (p *DefaultProjectCommandBuilder) BuildPlanCommands(ctx *CommandContext, cmd *CommentCommand) ([]models.ProjectCommandContext, error)

See ProjectCommandBuilder.BuildPlanCommands.

type DefaultProjectCommandContextBuilder added in v0.17.0 

type DefaultProjectCommandContextBuilder struct {
	CommentBuilder CommentBuilder
}

func (*DefaultProjectCommandContextBuilder) BuildProjectContext added in v0.17.0 

func (cb *DefaultProjectCommandContextBuilder) BuildProjectContext(
	ctx *CommandContext,
	cmdName models.CommandName,
	prjCfg valid.MergedProjectCfg,
	commentFlags []string,
	repoDir string,
	automerge, parallelApply, parallelPlan, verbose bool,
) (projectCmds []models.ProjectCommandContext)

type DefaultProjectCommandRunner added in v0.4.0 

type DefaultProjectCommandRunner struct {
	Locker                ProjectLocker
	LockURLGenerator      LockURLGenerator
	InitStepRunner        StepRunner
	PlanStepRunner        StepRunner
	ShowStepRunner        StepRunner
	ApplyStepRunner       StepRunner
	PolicyCheckStepRunner StepRunner
	RunStepRunner         CustomStepRunner
	EnvStepRunner         EnvStepRunner
	PullApprovedChecker   runtime.PullApprovedChecker
	WorkingDir            WorkingDir
	Webhooks              WebhooksSender
	WorkingDirLocker      WorkingDirLocker
}

DefaultProjectCommandRunner implements ProjectCommandRunner.

func (*DefaultProjectCommandRunner) Apply added in v0.4.0 

func (p *DefaultProjectCommandRunner) Apply(ctx models.ProjectCommandContext) models.ProjectResult

Apply runs terraform apply for the project described by ctx.

func (*DefaultProjectCommandRunner) ApprovePolicies added in v0.17.0 

func (p *DefaultProjectCommandRunner) ApprovePolicies(ctx models.ProjectCommandContext) models.ProjectResult

func (*DefaultProjectCommandRunner) Plan added in v0.4.0 

func (p *DefaultProjectCommandRunner) Plan(ctx models.ProjectCommandContext) models.ProjectResult

Plan runs terraform plan for the project described by ctx.

func (*DefaultProjectCommandRunner) PolicyCheck added in v0.17.0 

func (p *DefaultProjectCommandRunner) PolicyCheck(ctx models.ProjectCommandContext) models.ProjectResult

PolicyCheck evaluates policies defined with Rego for the project described by ctx.

type DefaultProjectFinder added in v0.2.1 

type DefaultProjectFinder struct{}

DefaultProjectFinder implements ProjectFinder.

func (*DefaultProjectFinder) DetermineProjects added in v0.3.0 

func (p *DefaultProjectFinder) DetermineProjects(log *logging.SimpleLogger, modifiedFiles []string, repoFullName string, absRepoDir string) []models.Project

See ProjectFinder.DetermineProjects.

func (*DefaultProjectFinder) DetermineProjectsViaConfig added in v0.4.0 

func (p *DefaultProjectFinder) DetermineProjectsViaConfig(log *logging.SimpleLogger, modifiedFiles []string, config valid.RepoCfg, absRepoDir string) ([]valid.Project, error)

See ProjectFinder.DetermineProjectsViaConfig.

type DefaultProjectLocker added in v0.4.0 

type DefaultProjectLocker struct {
	Locker    locking.Locker
	VCSClient vcs.Client
}

DefaultProjectLocker implements ProjectLocker.

func (*DefaultProjectLocker) TryLock added in v0.4.0 

func (p *DefaultProjectLocker) TryLock(log *logging.SimpleLogger, pull models.PullRequest, user models.User, workspace string, project models.Project) (*TryLockResponse, error)

TryLock implements ProjectLocker.TryLock.

type DefaultWorkingDirLocker added in v0.4.0 

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

DefaultWorkingDirLocker implements WorkingDirLocker.

func NewDefaultWorkingDirLocker added in v0.4.0 

func NewDefaultWorkingDirLocker() *DefaultWorkingDirLocker

NewDefaultWorkingDirLocker is a constructor.

func (*DefaultWorkingDirLocker) TryLock added in v0.4.0 

func (d *DefaultWorkingDirLocker) TryLock(repoFullName string, pullNum int, workspace string) (func(), error)

func (*DefaultWorkingDirLocker) TryLockPull added in v0.4.5 

func (d *DefaultWorkingDirLocker) TryLockPull(repoFullName string, pullNum int) (func(), error)

func (*DefaultWorkingDirLocker) UnlockPull added in v0.4.5 

func (d *DefaultWorkingDirLocker) UnlockPull(repoFullName string, pullNum int)

Unlock unlocks all workspaces for this pull.

type DeleteLockCommand added in v0.14.0 

type DeleteLockCommand interface {
	DeleteLock(id string) (*models.ProjectLock, error)
	DeleteLocksByPull(repoFullName string, pullNum int) error
}

DeleteLockCommand is the first step after a command request has been parsed.

type DirNotExistErr added in v0.4.14 

type DirNotExistErr struct {
	RepoRelDir string
}

DirNotExistErr is an error caused by the directory not existing.

func (DirNotExistErr) Error added in v0.4.14 

func (d DirNotExistErr) Error() string

Error implements the error interface.

type DrainStatus added in v0.13.0 

type DrainStatus struct {
	// ShuttingDown is whether we are in the progress of shutting down.
	ShuttingDown bool
	// InProgressOps is the number of operations currently in progress.
	InProgressOps int
}

type Drainer added in v0.13.0 

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

Drainer is used to gracefully shut down atlantis by waiting for in-progress operations to complete.

func (*Drainer) GetStatus added in v0.13.0 

func (d *Drainer) GetStatus() DrainStatus

func (*Drainer) OpDone added in v0.13.0 

func (d *Drainer) OpDone()

OpDone marks an operation as complete.

func (*Drainer) ShutdownBlocking added in v0.13.0 

func (d *Drainer) ShutdownBlocking()

ShutdownBlocking sets "shutting down" to true and blocks until there are no in progress operations.

func (*Drainer) StartOp added in v0.13.0 

func (d *Drainer) StartOp() bool

StartOp tries to start a new operation. It returns false if Atlantis is shutting down.

type EnvStepRunner added in v0.9.0 

type EnvStepRunner interface {
	Run(ctx models.ProjectCommandContext, cmd string, value string, path string, envs map[string]string) (string, error)
}

EnvStepRunner runs env steps.

type EventParser 

type EventParser struct {
	GithubUser         string
	GithubToken        string
	GitlabUser         string
	GitlabToken        string
	AllowDraftPRs      bool
	BitbucketUser      string
	BitbucketToken     string
	BitbucketServerURL string
	AzureDevopsToken   string
	AzureDevopsUser    string
}

EventParser parses VCS events.

func (*EventParser) GetBitbucketCloudPullEventType added in v0.4.8 

func (e *EventParser) GetBitbucketCloudPullEventType(eventTypeHeader string) models.PullRequestEventType

GetBitbucketCloudPullEventType returns the type of the pull request event given the Bitbucket Cloud header.

func (*EventParser) GetBitbucketServerPullEventType added in v0.4.8 

func (e *EventParser) GetBitbucketServerPullEventType(eventTypeHeader string) models.PullRequestEventType

GetBitbucketServerPullEventType returns the type of the pull request event given the Bitbucket Server header.

func (*EventParser) ParseAzureDevopsPull added in v0.10.0 

func (e *EventParser) ParseAzureDevopsPull(pull *azuredevops.GitPullRequest) (pullModel models.PullRequest, baseRepo models.Repo, headRepo models.Repo, err error)

ParseAzureDevopsPull parses the response from the Azure DevOps API endpoint (not from a webhook) that returns a pull request. See EventParsing for return value docs.

func (*EventParser) ParseAzureDevopsPullEvent added in v0.10.0 

func (e *EventParser) ParseAzureDevopsPullEvent(event azuredevops.Event) (pull models.PullRequest, pullEventType models.PullRequestEventType, baseRepo models.Repo, headRepo models.Repo, user models.User, err error)

ParseAzureDevopsPullEvent parses Azure DevOps pull request events. See EventParsing for return value docs.

func (*EventParser) ParseAzureDevopsRepo added in v0.10.0 

func (e *EventParser) ParseAzureDevopsRepo(adRepo *azuredevops.GitRepository) (models.Repo, error)

ParseAzureDevopsRepo parses the response from the Azure DevOps API endpoint that returns a repo into the Atlantis model. If the event payload doesn't contain a parent repository reference, extract the owner name from the URL. The URL will match one of two different formats:

https://runatlantis.visualstudio.com/project/_git/repo https://dev.azure.com/runatlantis/project/_git/repo

See EventParsing for return value docs.

func (*EventParser) ParseBitbucketCloudPullCommentEvent added in v0.4.8 

func (e *EventParser) ParseBitbucketCloudPullCommentEvent(body []byte) (pull models.PullRequest, baseRepo models.Repo, headRepo models.Repo, user models.User, comment string, err error)

ParseBitbucketCloudPullCommentEvent parses a pull request comment event from Bitbucket Cloud (bitbucket.org). See EventParsing for return value docs.

func (*EventParser) ParseBitbucketCloudPullEvent added in v0.4.3 

func (e *EventParser) ParseBitbucketCloudPullEvent(body []byte) (pull models.PullRequest, baseRepo models.Repo, headRepo models.Repo, user models.User, err error)

ParseBitbucketCloudPullEvent parses a pull request event from Bitbucket Cloud (bitbucket.org). See EventParsing for return value docs.

func (*EventParser) ParseBitbucketServerPullCommentEvent added in v0.4.8 

func (e *EventParser) ParseBitbucketServerPullCommentEvent(body []byte) (pull models.PullRequest, baseRepo models.Repo, headRepo models.Repo, user models.User, comment string, err error)

ParseBitbucketServerPullCommentEvent parses a pull request comment event from Bitbucket Server. See EventParsing for return value docs.

func (*EventParser) ParseBitbucketServerPullEvent added in v0.4.4 

func (e *EventParser) ParseBitbucketServerPullEvent(body []byte) (pull models.PullRequest, baseRepo models.Repo, headRepo models.Repo, user models.User, err error)

ParseBitbucketServerPullEvent parses a pull request event from Bitbucket Server. See EventParsing for return value docs.

func (*EventParser) ParseGithubIssueCommentEvent added in v0.2.0 

func (e *EventParser) ParseGithubIssueCommentEvent(comment *github.IssueCommentEvent) (baseRepo models.Repo, user models.User, pullNum int, err error)

ParseGithubIssueCommentEvent parses GitHub pull request comment events. See EventParsing for return value docs.

func (*EventParser) ParseGithubPull added in v0.2.0 

func (e *EventParser) ParseGithubPull(pull *github.PullRequest) (pullModel models.PullRequest, baseRepo models.Repo, headRepo models.Repo, err error)

ParseGithubPull parses the response from the GitHub API endpoint (not from a webhook) that returns a pull request. See EventParsing for return value docs.

func (*EventParser) ParseGithubPullEvent added in v0.4.0 

func (e *EventParser) ParseGithubPullEvent(pullEvent *github.PullRequestEvent) (pull models.PullRequest, pullEventType models.PullRequestEventType, baseRepo models.Repo, headRepo models.Repo, user models.User, err error)

ParseGithubPullEvent parses GitHub pull request events. See EventParsing for return value docs.

func (*EventParser) ParseGithubRepo added in v0.2.0 

func (e *EventParser) ParseGithubRepo(ghRepo *github.Repository) (models.Repo, error)

ParseGithubRepo parses the response from the GitHub API endpoint that returns a repo into the Atlantis model. See EventParsing for return value docs.

func (*EventParser) ParseGitlabMergeRequest added in v0.2.0 

func (e *EventParser) ParseGitlabMergeRequest(mr *gitlab.MergeRequest, baseRepo models.Repo) models.PullRequest

ParseGitlabMergeRequest parses the merge requests and returns a pull request model. We require passing in baseRepo because we can't get this information from the merge request. The only caller of this function already has that data so we can construct the pull request object correctly.

func (*EventParser) ParseGitlabMergeRequestCommentEvent added in v0.4.8 

func (e *EventParser) ParseGitlabMergeRequestCommentEvent(event gitlab.MergeCommentEvent) (baseRepo models.Repo, headRepo models.Repo, user models.User, err error)

ParseGitlabMergeRequestCommentEvent parses GitLab merge request comment events. See EventParsing for return value docs.

func (*EventParser) ParseGitlabMergeRequestEvent added in v0.4.8 

func (e *EventParser) ParseGitlabMergeRequestEvent(event gitlab.MergeEvent) (pull models.PullRequest, eventType models.PullRequestEventType, baseRepo models.Repo, headRepo models.Repo, user models.User, err error)

ParseGitlabMergeRequestEvent parses GitLab merge request events. pull is the parsed merge request. See EventParsing for return value docs.

type EventParsing 

type EventParsing interface {
	// ParseGithubIssueCommentEvent parses GitHub pull request comment events.
	// baseRepo is the repo that the pull request will be merged into.
	// user is the pull request author.
	// pullNum is the number of the pull request that triggered the webhook.
	ParseGithubIssueCommentEvent(comment *github.IssueCommentEvent) (
		baseRepo models.Repo, user models.User, pullNum int, err error)

	// ParseGithubPull parses the response from the GitHub API endpoint (not
	// from a webhook) that returns a pull request.
	// pull is the parsed pull request.
	// baseRepo is the repo the pull request will be merged into.
	// headRepo is the repo the pull request branch is from.
	ParseGithubPull(ghPull *github.PullRequest) (
		pull models.PullRequest, baseRepo models.Repo, headRepo models.Repo, err error)

	// ParseGithubPullEvent parses GitHub pull request events.
	// pull is the parsed pull request.
	// pullEventType is the type of event, for example opened/closed.
	// baseRepo is the repo the pull request will be merged into.
	// headRepo is the repo the pull request branch is from.
	// user is the pull request author.
	ParseGithubPullEvent(pullEvent *github.PullRequestEvent) (
		pull models.PullRequest, pullEventType models.PullRequestEventType,
		baseRepo models.Repo, headRepo models.Repo, user models.User, err error)

	// ParseGithubRepo parses the response from the GitHub API endpoint that
	// returns a repo into the Atlantis model.
	ParseGithubRepo(ghRepo *github.Repository) (models.Repo, error)

	// ParseGitlabMergeRequestEvent parses GitLab merge request events.
	// pull is the parsed merge request.
	// pullEventType is the type of event, for example opened/closed.
	// baseRepo is the repo the merge request will be merged into.
	// headRepo is the repo the merge request branch is from.
	// user is the pull request author.
	ParseGitlabMergeRequestEvent(event gitlab.MergeEvent) (
		pull models.PullRequest, pullEventType models.PullRequestEventType,
		baseRepo models.Repo, headRepo models.Repo, user models.User, err error)

	// ParseGitlabMergeRequestCommentEvent parses GitLab merge request comment
	// events.
	// baseRepo is the repo the merge request will be merged into.
	// headRepo is the repo the merge request branch is from.
	// user is the pull request author.
	ParseGitlabMergeRequestCommentEvent(event gitlab.MergeCommentEvent) (
		baseRepo models.Repo, headRepo models.Repo, user models.User, err error)

	// ParseGitlabMergeRequest parses the response from the GitLab API endpoint
	// that returns a merge request.
	ParseGitlabMergeRequest(mr *gitlab.MergeRequest, baseRepo models.Repo) models.PullRequest

	// ParseBitbucketCloudPullEvent parses a pull request event from Bitbucket
	// Cloud (bitbucket.org).
	// pull is the parsed pull request.
	// baseRepo is the repo the pull request will be merged into.
	// headRepo is the repo the pull request branch is from.
	// user is the pull request author.
	ParseBitbucketCloudPullEvent(body []byte) (
		pull models.PullRequest, baseRepo models.Repo,
		headRepo models.Repo, user models.User, err error)

	// ParseBitbucketCloudPullCommentEvent parses a pull request comment event
	// from Bitbucket Cloud (bitbucket.org).
	// pull is the parsed pull request.
	// baseRepo is the repo the pull request will be merged into.
	// headRepo is the repo the pull request branch is from.
	// user is the pull request author.
	// comment is the comment that triggered the event.
	ParseBitbucketCloudPullCommentEvent(body []byte) (
		pull models.PullRequest, baseRepo models.Repo,
		headRepo models.Repo, user models.User, comment string, err error)

	// GetBitbucketCloudPullEventType returns the type of the pull request
	// event given the Bitbucket Cloud header.
	GetBitbucketCloudPullEventType(eventTypeHeader string) models.PullRequestEventType

	// ParseBitbucketServerPullEvent parses a pull request event from Bitbucket
	// Server.
	// pull is the parsed pull request.
	// baseRepo is the repo the pull request will be merged into.
	// headRepo is the repo the pull request branch is from.
	// user is the pull request author.
	ParseBitbucketServerPullEvent(body []byte) (
		pull models.PullRequest, baseRepo models.Repo, headRepo models.Repo,
		user models.User, err error)

	// ParseBitbucketServerPullCommentEvent parses a pull request comment event
	// from Bitbucket Server.
	// pull is the parsed pull request.
	// baseRepo is the repo the pull request will be merged into.
	// headRepo is the repo the pull request branch is from.
	// user is the pull request author.
	// comment is the comment that triggered the event.
	ParseBitbucketServerPullCommentEvent(body []byte) (
		pull models.PullRequest, baseRepo models.Repo, headRepo models.Repo,
		user models.User, comment string, err error)

	// GetBitbucketServerPullEventType returns the type of the pull request
	// event given the Bitbucket Server header.
	GetBitbucketServerPullEventType(eventTypeHeader string) models.PullRequestEventType

	// ParseAzureDevopsPull parses the response from the Azure DevOps API endpoint (not
	// from a webhook) that returns a pull request.
	// pull is the parsed pull request.
	// baseRepo is the repo the pull request will be merged into.
	// headRepo is the repo the pull request branch is from.
	ParseAzureDevopsPull(adPull *azuredevops.GitPullRequest) (
		pull models.PullRequest, baseRepo models.Repo, headRepo models.Repo, err error)

	// ParseAzureDevopsPullEvent parses Azure DevOps pull request events.
	// pull is the parsed pull request.
	// pullEventType is the type of event, for example opened/closed.
	// baseRepo is the repo the pull request will be merged into.
	// headRepo is the repo the pull request branch is from.
	// user is the pull request author.
	ParseAzureDevopsPullEvent(pullEvent azuredevops.Event) (
		pull models.PullRequest, pullEventType models.PullRequestEventType,
		baseRepo models.Repo, headRepo models.Repo, user models.User, err error)

	// ParseAzureDevopsRepo parses the response from the Azure DevOps API endpoint that
	// returns a repo into the Atlantis model.
	ParseAzureDevopsRepo(adRepo *azuredevops.GitRepository) (models.Repo, error)
}

EventParsing parses webhook events from different VCS hosts into their respective Atlantis models. todo: rename to VCSParsing or the like because this also parses API responses #refactor

type FileWorkspace 

type FileWorkspace struct {
	DataDir string
	// CheckoutMerge is true if we should check out the branch that corresponds
	// to what the base branch will look like *after* the pull request is merged.
	// If this is false, then we will check out the head branch from the pull
	// request.
	CheckoutMerge bool
	// TestingOverrideHeadCloneURL can be used during testing to override the
	// URL of the head repo to be cloned. If it's empty then we clone normally.
	TestingOverrideHeadCloneURL string
	// TestingOverrideBaseCloneURL can be used during testing to override the
	// URL of the base repo to be cloned. If it's empty then we clone normally.
	TestingOverrideBaseCloneURL string
}

FileWorkspace implements WorkingDir with the file system.

func (*FileWorkspace) Clone 

func (w *FileWorkspace) Clone(
	log *logging.SimpleLogger,
	headRepo models.Repo,
	p models.PullRequest,
	workspace string) (string, bool, error)

Clone git clones headRepo, checks out the branch and then returns the absolute path to the root of the cloned repo. It also returns a boolean indicating if we should warn users that the branch we're merging into has been updated since we cloned it. If the repo already exists and is at the right commit it does nothing. This is to support running commands in multiple dirs of the same repo without deleting existing plans.

func (*FileWorkspace) Delete 

func (w *FileWorkspace) Delete(r models.Repo, p models.PullRequest) error

Delete deletes the workspace for this repo and pull.

func (*FileWorkspace) DeleteForWorkspace added in v0.4.0 

func (w *FileWorkspace) DeleteForWorkspace(r models.Repo, p models.PullRequest, workspace string) error

DeleteForWorkspace deletes the working dir for this workspace.

func (*FileWorkspace) GetPullDir added in v0.4.5 

func (w *FileWorkspace) GetPullDir(r models.Repo, p models.PullRequest) (string, error)

GetPullDir returns the dir where the workspaces for this pull are cloned. If the dir doesn't exist it will return an error.

func (*FileWorkspace) GetWorkingDir added in v0.4.0 

func (w *FileWorkspace) GetWorkingDir(r models.Repo, p models.PullRequest, workspace string) (string, error)

GetWorkingDir returns the path to the workspace for this repo and pull.

type GithubAppWorkingDir added in v0.14.0 

type GithubAppWorkingDir struct {
	WorkingDir
	Credentials    vcs.GithubCredentials
	GithubHostname string
}

GithubAppWorkingDir implements WorkingDir. It acts as a proxy to an instance of WorkingDir that refreshes the app's token before every clone, given Github App tokens expire quickly

func (*GithubAppWorkingDir) Clone added in v0.14.0 

func (g *GithubAppWorkingDir) Clone(log *logging.SimpleLogger, headRepo models.Repo, p models.PullRequest, workspace string) (string, bool, error)

Clone writes a fresh token for Github App authentication

type GithubPullGetter added in v0.2.0 

type GithubPullGetter interface {
	// GetPullRequest gets the pull request with id pullNum for the repo.
	GetPullRequest(repo models.Repo, pullNum int) (*github.PullRequest, error)
}

GithubPullGetter makes API calls to get pull requests.

type GitlabMergeRequestGetter added in v0.2.0 

type GitlabMergeRequestGetter interface {
	// GetMergeRequest gets the pull request with the id pullNum for the repo.
	GetMergeRequest(repoFullName string, pullNum int) (*gitlab.MergeRequest, error)
}

GitlabMergeRequestGetter makes API calls to get merge requests.

type LockURLGenerator 

type LockURLGenerator interface {
	// GenerateLockURL returns the full URL to the lock at lockID.
	GenerateLockURL(lockID string) string
}

LockURLGenerator generates urls to locks.

type MarkdownRenderer added in v0.2.0 

type MarkdownRenderer struct {
	// GitlabSupportsCommonMark is true if the version of GitLab we're
	// using supports the CommonMark markdown format.
	// If we're not configured with a GitLab client, this will be false.
	GitlabSupportsCommonMark bool
	DisableApplyAll          bool
	DisableApply             bool
	DisableMarkdownFolding   bool
	DisableRepoLocking       bool
}

MarkdownRenderer renders responses as markdown.

func (*MarkdownRenderer) Render added in v0.2.0 

func (m *MarkdownRenderer) Render(res CommandResult, cmdName models.CommandName, log string, verbose bool, vcsHost models.VCSHostType) string

Render formats the data into a markdown string. nolint: interfacer

type PendingPlan added in v0.4.5 

type PendingPlan struct {
	// RepoDir is the absolute path to the root of the repo that holds this
	// plan.
	RepoDir string
	// RepoRelDir is the relative path from the repo to the project that
	// the plan is for.
	RepoRelDir string
	// Workspace is the workspace this plan should execute in.
	Workspace   string
	ProjectName string
}

PendingPlan is a plan that has not been applied.

type PendingPlanFinder added in v0.4.5 

type PendingPlanFinder interface {
	Find(pullDir string) ([]PendingPlan, error)
	DeletePlans(pullDir string) error
}

type PlanCommandRunner added in v0.17.0 

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

func NewPlanCommandRunner added in v0.17.0 

func NewPlanCommandRunner(
	silenceVCSStatusNoPlans bool,
	vcsClient vcs.Client,
	pendingPlanFinder PendingPlanFinder,
	workingDir WorkingDir,
	commitStatusUpdater CommitStatusUpdater,
	projectCommandBuilder ProjectPlanCommandBuilder,
	projectCommandRunner ProjectPlanCommandRunner,
	dbUpdater *DBUpdater,
	pullUpdater *PullUpdater,
	policyCheckCommandRunner *PolicyCheckCommandRunner,
	autoMerger *AutoMerger,
	parallelPoolSize int,
) *PlanCommandRunner

func (*PlanCommandRunner) Run added in v0.17.0 

func (p *PlanCommandRunner) Run(ctx *CommandContext, cmd *CommentCommand)

type PolicyCheckCommand added in v0.17.0 

type PolicyCheckCommand struct{}

PolicyCheckCommand is a policy_check command that is automatically triggered after successful plan command.

func (PolicyCheckCommand) CommandName added in v0.17.0 

func (c PolicyCheckCommand) CommandName() models.CommandName

CommandName is policy_check.

func (PolicyCheckCommand) IsAutoplan added in v0.17.0 

func (c PolicyCheckCommand) IsAutoplan() bool

IsAutoplan is true for policy_check commands.

func (PolicyCheckCommand) IsVerbose added in v0.17.0 

func (c PolicyCheckCommand) IsVerbose() bool

IsVerbose is false for policy_check commands.

type PolicyCheckCommandRunner added in v0.17.0 

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

func NewPolicyCheckCommandRunner added in v0.17.0 

func NewPolicyCheckCommandRunner(
	dbUpdater *DBUpdater,
	pullUpdater *PullUpdater,
	commitStatusUpdater CommitStatusUpdater,
	projectCommandRunner ProjectPolicyCheckCommandRunner,
	parallelPoolSize int,
) *PolicyCheckCommandRunner

func (*PolicyCheckCommandRunner) Run added in v0.17.0 

func (p *PolicyCheckCommandRunner) Run(ctx *CommandContext, cmds []models.ProjectCommandContext)

type PolicyCheckProjectCommandContextBuilder added in v0.17.0 

type PolicyCheckProjectCommandContextBuilder struct {
	ProjectCommandContextBuilder *DefaultProjectCommandContextBuilder
	CommentBuilder               CommentBuilder
}

func (*PolicyCheckProjectCommandContextBuilder) BuildProjectContext added in v0.17.0 

func (cb *PolicyCheckProjectCommandContextBuilder) BuildProjectContext(
	ctx *CommandContext,
	cmdName models.CommandName,
	prjCfg valid.MergedProjectCfg,
	commentFlags []string,
	repoDir string,
	automerge, parallelApply, parallelPlan, verbose bool,
) (projectCmds []models.ProjectCommandContext)

type PreWorkflowHooksCommandRunner added in v0.16.0 

type PreWorkflowHooksCommandRunner interface {
	RunPreHooks(ctx *CommandContext) error
}

type ProjectApplyCommandBuilder added in v0.17.0 

type ProjectApplyCommandBuilder interface {
	// BuildApplyCommands builds project Apply commands for this ctx and comment. If
	// comment doesn't specify one project then there may be multiple commands
	// to be run.
	BuildApplyCommands(ctx *CommandContext, comment *CommentCommand) ([]models.ProjectCommandContext, error)
}

type ProjectApplyCommandRunner added in v0.17.0 

type ProjectApplyCommandRunner interface {
	// Apply runs terraform apply for the project described by ctx.
	Apply(ctx models.ProjectCommandContext) models.ProjectResult
}

type ProjectApprovePoliciesCommandBuilder added in v0.17.0 

type ProjectApprovePoliciesCommandBuilder interface {
	// BuildApprovePoliciesCommands builds project PolicyCheck commands for this ctx and comment.
	BuildApprovePoliciesCommands(ctx *CommandContext, comment *CommentCommand) ([]models.ProjectCommandContext, error)
}

type ProjectApprovePoliciesCommandRunner added in v0.17.0 

type ProjectApprovePoliciesCommandRunner interface {
	// Approves any failing OPA policies.
	ApprovePolicies(ctx models.ProjectCommandContext) models.ProjectResult
}

type ProjectCommandBuilder added in v0.4.0 

type ProjectCommandBuilder interface {
	ProjectPlanCommandBuilder
	ProjectApplyCommandBuilder
	ProjectApprovePoliciesCommandBuilder
}

ProjectCommandBuilder builds commands that run on individual projects.

type ProjectCommandContextBuilder added in v0.17.0 

type ProjectCommandContextBuilder interface {
	// BuildProjectContext builds project command contexts for atlantis commands
	BuildProjectContext(
		ctx *CommandContext,
		cmdName models.CommandName,
		prjCfg valid.MergedProjectCfg,
		commentFlags []string,
		repoDir string,
		automerge, parallelPlan, parallelApply, verbose bool,
	) []models.ProjectCommandContext
}

func NewProjectCommandContextBulder added in v0.17.0 

func NewProjectCommandContextBulder(policyCheckEnabled bool, commentBuilder CommentBuilder) ProjectCommandContextBuilder

type ProjectCommandRunner added in v0.4.0 

type ProjectCommandRunner interface {
	ProjectPlanCommandRunner
	ProjectApplyCommandRunner
	ProjectPolicyCheckCommandRunner
	ProjectApprovePoliciesCommandRunner
}

ProjectCommandRunner runs project commands. A project command is a command for a specific TF project.

type ProjectFinder 

type ProjectFinder interface {
	// DetermineProjects returns the list of projects that were modified based on
	// the modifiedFiles. The list will be de-duplicated.
	// absRepoDir is the path to the cloned repo on disk.
	DetermineProjects(log *logging.SimpleLogger, modifiedFiles []string, repoFullName string, absRepoDir string) []models.Project
	// DetermineProjectsViaConfig returns the list of projects that were modified
	// based on modifiedFiles and the repo's config.
	// absRepoDir is the path to the cloned repo on disk.
	DetermineProjectsViaConfig(log *logging.SimpleLogger, modifiedFiles []string, config valid.RepoCfg, absRepoDir string) ([]valid.Project, error)
}

ProjectFinder determines which projects were modified in a given pull request.

type ProjectLocker added in v0.4.0 

type ProjectLocker interface {
	// TryLock attempts to acquire the lock for this project. It returns true if the lock
	// was acquired. If it returns false, the lock was not acquired and the second
	// return value will be a string describing why the lock was not acquired.
	// The third return value is a function that can be called to unlock the
	// lock. It will only be set if the lock was acquired. Any errors will set
	// error.
	TryLock(log *logging.SimpleLogger, pull models.PullRequest, user models.User, workspace string, project models.Project) (*TryLockResponse, error)
}

ProjectLocker locks this project against other plans being run until this project is unlocked.

type ProjectPlanCommandBuilder added in v0.17.0 

type ProjectPlanCommandBuilder interface {
	// BuildAutoplanCommands builds project commands that will run plan on
	// the projects determined to be modified.
	BuildAutoplanCommands(ctx *CommandContext) ([]models.ProjectCommandContext, error)
	// BuildPlanCommands builds project plan commands for this ctx and comment. If
	// comment doesn't specify one project then there may be multiple commands
	// to be run.
	BuildPlanCommands(ctx *CommandContext, comment *CommentCommand) ([]models.ProjectCommandContext, error)
}

type ProjectPlanCommandRunner added in v0.17.0 

type ProjectPlanCommandRunner interface {
	// Plan runs terraform plan for the project described by ctx.
	Plan(ctx models.ProjectCommandContext) models.ProjectResult
}

type ProjectPolicyCheckCommandRunner added in v0.17.0 

type ProjectPolicyCheckCommandRunner interface {
	// PolicyCheck runs OPA defined policies for the project desribed by ctx.
	PolicyCheck(ctx models.ProjectCommandContext) models.ProjectResult
}

type PullCleaner 

type PullCleaner interface {
	// CleanUpPull deletes the workspaces used by the pull request on disk
	// and deletes any locks associated with this pull request for all workspaces.
	CleanUpPull(repo models.Repo, pull models.PullRequest) error
}

PullCleaner cleans up pull requests after they're closed/merged.

type PullClosedExecutor 

type PullClosedExecutor struct {
	Locker     locking.Locker
	VCSClient  vcs.Client
	WorkingDir WorkingDir
	Logger     logging.SimpleLogging
	DB         *db.BoltDB
}

PullClosedExecutor executes the tasks required to clean up a closed pull request.

func (*PullClosedExecutor) CleanUpPull 

func (p *PullClosedExecutor) CleanUpPull(repo models.Repo, pull models.PullRequest) error

CleanUpPull cleans up after a closed pull request.

type PullCommand added in v0.4.8 

type PullCommand interface {
	// CommandName is the name of the command we're running.
	CommandName() models.CommandName
	// IsVerbose is true if the output of this command should be verbose.
	IsVerbose() bool
	// IsAutoplan is true if this is an autoplan command vs. a comment command.
	IsAutoplan() bool
}

PullCommand is a command to run on a pull request.

type PullUpdater added in v0.17.0 

type PullUpdater struct {
	HidePrevPlanComments bool
	VCSClient            vcs.Client
	MarkdownRenderer     *MarkdownRenderer
}

type RepoAllowlistChecker added in v0.15.0 

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

RepoAllowlistChecker implements checking if repos are allowlisted to be used with this Atlantis.

func NewRepoAllowlistChecker added in v0.15.0 

func NewRepoAllowlistChecker(allowlist string) (*RepoAllowlistChecker, error)

NewRepoAllowlistChecker constructs a new checker and validates that the allowlist isn't malformed.

func (*RepoAllowlistChecker) IsAllowlisted added in v0.15.0 

func (r *RepoAllowlistChecker) IsAllowlisted(repoFullName string, vcsHostname string) bool

IsAllowlisted returns true if this repo is in our allowlist and false otherwise.

type StepRunner added in v0.4.0 

type StepRunner interface {
	// Run runs the step.
	Run(ctx models.ProjectCommandContext, extraArgs []string, path string, envs map[string]string) (string, error)
}

StepRunner runs steps. Steps are individual pieces of execution like `terraform plan`.

type TryLockResponse added in v0.4.0 

type TryLockResponse struct {
	// LockAcquired is true if the lock was acquired.
	LockAcquired bool
	// LockFailureReason is the reason why the lock was not acquired. It will
	// only be set if LockAcquired is false.
	LockFailureReason string
	// UnlockFn will unlock the lock created by the caller. This might be called
	// if there is an error later and the caller doesn't want to continue to
	// hold the lock.
	UnlockFn func() error
	// LockKey is the key for the lock if the lock was acquired.
	LockKey string
}

TryLockResponse is the result of trying to lock a project.

type UnlockCommandRunner added in v0.17.0 

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

func NewUnlockCommandRunner added in v0.17.0 

func NewUnlockCommandRunner(
	deleteLockCommand DeleteLockCommand,
	vcsClient vcs.Client,
) *UnlockCommandRunner

func (*UnlockCommandRunner) Run added in v0.17.0 

func (u *UnlockCommandRunner) Run(
	ctx *CommandContext,
	cmd *CommentCommand,
)

type WebhooksSender added in v0.4.0 

type WebhooksSender interface {
	// Send sends the webhook.
	Send(log *logging.SimpleLogger, res webhooks.ApplyResult) error
}

WebhooksSender sends webhook.

type WorkingDir added in v0.4.0 

type WorkingDir interface {
	// Clone git clones headRepo, checks out the branch and then returns the
	// absolute path to the root of the cloned repo. It also returns
	// a boolean indicating if we should warn users that the branch we're
	// merging into has been updated since we cloned it.
	Clone(log *logging.SimpleLogger, headRepo models.Repo, p models.PullRequest, workspace string) (string, bool, error)
	// GetWorkingDir returns the path to the workspace for this repo and pull.
	// If workspace does not exist on disk, error will be of type os.IsNotExist.
	GetWorkingDir(r models.Repo, p models.PullRequest, workspace string) (string, error)
	GetPullDir(r models.Repo, p models.PullRequest) (string, error)
	// Delete deletes the workspace for this repo and pull.
	Delete(r models.Repo, p models.PullRequest) error
	DeleteForWorkspace(r models.Repo, p models.PullRequest, workspace string) error
}

WorkingDir handles the workspace on disk for running commands.

type WorkingDirLocker added in v0.4.0 

type WorkingDirLocker interface {
	// TryLock tries to acquire a lock for this repo, workspace and pull.
	// It returns a function that should be used to unlock the workspace and
	// an error if the workspace is already locked. The error is expected to
	// be printed to the pull request.
	TryLock(repoFullName string, pullNum int, workspace string) (func(), error)
	// TryLockPull tries to acquire a lock for all the workspaces in this repo
	// and pull.
	// It returns a function that should be used to unlock the workspace and
	// an error if the workspace is already locked. The error is expected to
	// be printed to the pull request.
	TryLockPull(repoFullName string, pullNum int) (func(), error)
}

WorkingDirLocker is used to prevent multiple commands from executing at the same time for a single repo, pull, and workspace. We need to prevent this from happening because a specific repo/pull/workspace has a single workspace on disk and we haven't written Atlantis (yet) to handle concurrent execution within this workspace.

Source Files

View all Source files

Directories

Path Synopsis
Package db handles our database layer.
 Package db handles our database layer.
mocks
mocks/matchers
Code generated by pegomock.
 Code generated by pegomock.
Code generated by pegomock.
 Code generated by pegomock.
matchers
Code generated by pegomock.
 Code generated by pegomock.
fixtures
Package runtime holds code for actually running commands vs.
 Package runtime holds code for actually running commands vs.
cache
cache/mocks
cache/mocks/matchers
Code generated by pegomock.
 Code generated by pegomock.
mocks
mocks/matchers
Code generated by pegomock.
 Code generated by pegomock.
models
models/mocks
models/mocks/matchers
Code generated by pegomock.
 Code generated by pegomock.
policy
policy/mocks
policy/mocks/matchers
Code generated by pegomock.
 Code generated by pegomock.
mocks
mocks/matchers
Code generated by pegomock.
 Code generated by pegomock.
vcs
bitbucketcloud
Package bitbucketcloud holds code for Bitbucket Cloud aka (bitbucket.org).
 Package bitbucketcloud holds code for Bitbucket Cloud aka (bitbucket.org).
bitbucketserver
common
Package common is used to share common code between all VCS clients without running into circular dependency issues.
 Package common is used to share common code between all VCS clients without running into circular dependency issues.
fixtures
mocks
mocks/matchers
Code generated by pegomock.
 Code generated by pegomock.
mocks
mocks/matchers
Code generated by pegomock.
 Code generated by pegomock.
raw
Package raw contains the golang representations of the YAML elements supported in atlantis.yaml.
 Package raw contains the golang representations of the YAML elements supported in atlantis.yaml.
valid
Package valid contains the structs representing the atlantis.yaml config after it's been parsed and validated.
 Package valid contains the structs representing the atlantis.yaml config after it's been parsed and validated.

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.