Skip cloning PR repository in case of no projects configured in repo …

…config file were changed

cmd/server.go

@@ -81,6 +81,7 @@ const (
 	SilenceAllowlistErrorsFlag = "silence-allowlist-errors"
 	// SilenceWhitelistErrorsFlag is deprecated for SilenceAllowlistErrorsFlag.
 	SilenceWhitelistErrorsFlag = "silence-whitelist-errors"
+	SkipCloneNoChanges         = "skip-clone-no-changes"
 	SlackTokenFlag             = "slack-token"
 	SSLCertFileFlag            = "ssl-cert-file"
 	SSLKeyFileFlag             = "ssl-key-file"
@@ -319,6 +320,10 @@ var boolFlags = map[string]boolFlag{
 			" This writes secrets to disk and should only be enabled in a secure environment.",
 		defaultValue: false,
 	},
+	SkipCloneNoChanges: {
+		description:  "Skips cloning the PR repo if there are no projects were changed in the PR.",
+		defaultValue: false,
+	},
 }
 var intFlags = map[string]intFlag{
 	PortFlag: {

cmd/server_test.go

@@ -86,6 +86,7 @@ var testFlags = map[string]interface{}{
 	SilenceForkPRErrorsFlag:    true,
 	SilenceAllowlistErrorsFlag: true,
 	SilenceVCSStatusNoPlans:    true,
+	SkipCloneNoChanges:         true,
 	SlackTokenFlag:             "slack-token",
 	SSLCertFileFlag:            "cert-file",
 	SSLKeyFileFlag:             "key-file",

server/events/project_command_builder.go

@@ -53,14 +53,15 @@ type ProjectCommandBuilder interface {
 // This class combines the data from the comment and any atlantis.yaml file or
 // Atlantis server config and then generates a set of contexts.
 type DefaultProjectCommandBuilder struct {
-	ParserValidator   *yaml.ParserValidator
-	ProjectFinder     ProjectFinder
-	VCSClient         vcs.Client
-	WorkingDir        WorkingDir
-	WorkingDirLocker  WorkingDirLocker
-	GlobalCfg         valid.GlobalCfg
-	PendingPlanFinder *DefaultPendingPlanFinder
-	CommentBuilder    CommentBuilder
+	ParserValidator    *yaml.ParserValidator
+	ProjectFinder      ProjectFinder
+	VCSClient          vcs.Client
+	WorkingDir         WorkingDir
+	WorkingDirLocker   WorkingDirLocker
+	GlobalCfg          valid.GlobalCfg
+	PendingPlanFinder  *DefaultPendingPlanFinder
+	CommentBuilder     CommentBuilder
+	SkipCloneNoChanges bool
 }
 
 // See ProjectCommandBuilder.BuildAutoplanCommands.
@@ -101,8 +102,41 @@ func (p *DefaultProjectCommandBuilder) BuildApplyCommands(ctx *CommandContext, c
 // buildPlanAllCommands builds plan contexts for all projects we determine were
 // modified in this ctx.
 func (p *DefaultProjectCommandBuilder) buildPlanAllCommands(ctx *CommandContext, commentFlags []string, verbose bool) ([]models.ProjectCommandContext, error) {
+	// We'll need the list of modified files.
+	modifiedFiles, err := p.VCSClient.GetModifiedFiles(ctx.BaseRepo, ctx.Pull)
+
+	if err != nil {
+		return nil, err
+	}
+	ctx.Log.Debug("%d files were modified in this pull request", len(modifiedFiles))
+
+	if p.SkipCloneNoChanges && p.VCSClient.IsSupportDownloadSingleFile(ctx.BaseRepo) {
+		hasRepoCfg, repoCfgData, err := p.VCSClient.DownloadRepoConfigFile(ctx.Pull)
+		if err != nil {
+			return nil, errors.Wrapf(err, "downloading %s", yaml.AtlantisYAMLFilename)
+		}
+
+		if hasRepoCfg {
+			repoCfg, err := p.ParserValidator.ParseRepoCfg(repoCfgData, "", p.GlobalCfg, ctx.BaseRepo.ID())
+			if err != nil {
+				return nil, errors.Wrapf(err, "parsing %s", yaml.AtlantisYAMLFilename)
+			}
+			ctx.Log.Info("successfully parsed remote %s file", yaml.AtlantisYAMLFilename)
+			matchingProjects, err := p.ProjectFinder.DetermineProjectsViaConfig(ctx.Log, modifiedFiles, repoCfg, "")
+			if err != nil {
+				return nil, err
+			}
+			ctx.Log.Info("%d projects are changed on MR %q based on their when_modified config", len(matchingProjects), ctx.Pull.Num)
+			if len(matchingProjects) == 0 {
+				ctx.Log.Info("skipping repo clone since no project was modified")
+				return []models.ProjectCommandContext{}, nil
+			}
+		}
+	}
+
 	// Need to lock the workspace we're about to clone to.
 	workspace := DefaultWorkspace
+
 	unlockFn, err := p.WorkingDirLocker.TryLock(ctx.BaseRepo.FullName, ctx.Pull.Num, workspace)
 	if err != nil {
 		ctx.Log.Warn("workspace was locked")
@@ -111,18 +145,10 @@ func (p *DefaultProjectCommandBuilder) buildPlanAllCommands(ctx *CommandContext,
 	ctx.Log.Debug("got workspace lock")
 	defer unlockFn()
 
-	// We'll need the list of modified files.
-	modifiedFiles, err := p.VCSClient.GetModifiedFiles(ctx.BaseRepo, ctx.Pull)
-	if err != nil {
-		return nil, err
-	}
-	ctx.Log.Debug("%d files were modified in this pull request", len(modifiedFiles))
-
 	repoDir, _, err := p.WorkingDir.Clone(ctx.Log, ctx.BaseRepo, ctx.HeadRepo, ctx.Pull, workspace)
 	if err != nil {
 		return nil, err
 	}
-
 	// Parse config file if it exists.
 	hasRepoCfg, err := p.ParserValidator.HasRepoCfg(repoDir)
 	if err != nil {
@@ -133,7 +159,7 @@ func (p *DefaultProjectCommandBuilder) buildPlanAllCommands(ctx *CommandContext,
 	if hasRepoCfg {
 		// If there's a repo cfg then we'll use it to figure out which projects
 		// should be planed.
-		repoCfg, err := p.ParserValidator.ParseRepoCfg(repoDir, p.GlobalCfg, ctx.BaseRepo.ID())
+		repoCfg, err := p.ParserValidator.ParseRepoCfg([]byte{}, repoDir, p.GlobalCfg, ctx.BaseRepo.ID())
 		if err != nil {
 			return nil, errors.Wrapf(err, "parsing %s", yaml.AtlantisYAMLFilename)
 		}
@@ -317,7 +343,7 @@ func (p *DefaultProjectCommandBuilder) getCfg(ctx *CommandContext, projectName s
 	}
 
 	var repoConfig valid.RepoCfg
-	repoConfig, err = p.ParserValidator.ParseRepoCfg(repoDir, p.GlobalCfg, ctx.BaseRepo.ID())
+	repoConfig, err = p.ParserValidator.ParseRepoCfg([]byte{}, repoDir, p.GlobalCfg, ctx.BaseRepo.ID())
 	if err != nil {
 		return
 	}

server/events/project_command_builder_internal_test.go

@@ -563,14 +563,15 @@ projects:
 			}
 
 			builder := &DefaultProjectCommandBuilder{
-				WorkingDirLocker:  NewDefaultWorkingDirLocker(),
-				WorkingDir:        workingDir,
-				ParserValidator:   parser,
-				VCSClient:         vcsClient,
-				ProjectFinder:     &DefaultProjectFinder{},
-				PendingPlanFinder: &DefaultPendingPlanFinder{},
-				CommentBuilder:    &CommentParser{},
-				GlobalCfg:         globalCfg,
+				WorkingDirLocker:   NewDefaultWorkingDirLocker(),
+				WorkingDir:         workingDir,
+				ParserValidator:    parser,
+				VCSClient:          vcsClient,
+				ProjectFinder:      &DefaultProjectFinder{},
+				PendingPlanFinder:  &DefaultPendingPlanFinder{},
+				CommentBuilder:     &CommentParser{},
+				GlobalCfg:          globalCfg,
+				SkipCloneNoChanges: false,
 			}
 
 			// We run a test for each type of command.

server/events/project_command_builder_test.go

@@ -135,14 +135,15 @@ projects:
 			}
 
 			builder := &events.DefaultProjectCommandBuilder{
-				WorkingDirLocker:  events.NewDefaultWorkingDirLocker(),
-				WorkingDir:        workingDir,
-				ParserValidator:   &yaml.ParserValidator{},
-				VCSClient:         vcsClient,
-				ProjectFinder:     &events.DefaultProjectFinder{},
-				PendingPlanFinder: &events.DefaultPendingPlanFinder{},
-				CommentBuilder:    &events.CommentParser{},
-				GlobalCfg:         valid.NewGlobalCfg(false, false, false),
+				WorkingDirLocker:   events.NewDefaultWorkingDirLocker(),
+				WorkingDir:         workingDir,
+				ParserValidator:    &yaml.ParserValidator{},
+				VCSClient:          vcsClient,
+				ProjectFinder:      &events.DefaultProjectFinder{},
+				PendingPlanFinder:  &events.DefaultPendingPlanFinder{},
+				CommentBuilder:     &events.CommentParser{},
+				GlobalCfg:          valid.NewGlobalCfg(false, false, false),
+				SkipCloneNoChanges: false,
 			}
 
 			ctxs, err := builder.BuildAutoplanCommands(&events.CommandContext{
@@ -358,13 +359,14 @@ projects:
 				}
 
 				builder := &events.DefaultProjectCommandBuilder{
-					WorkingDirLocker: events.NewDefaultWorkingDirLocker(),
-					WorkingDir:       workingDir,
-					ParserValidator:  &yaml.ParserValidator{},
-					VCSClient:        vcsClient,
-					ProjectFinder:    &events.DefaultProjectFinder{},
-					CommentBuilder:   &events.CommentParser{},
-					GlobalCfg:        valid.NewGlobalCfg(true, false, false),
+					WorkingDirLocker:   events.NewDefaultWorkingDirLocker(),
+					WorkingDir:         workingDir,
+					ParserValidator:    &yaml.ParserValidator{},
+					VCSClient:          vcsClient,
+					ProjectFinder:      &events.DefaultProjectFinder{},
+					CommentBuilder:     &events.CommentParser{},
+					GlobalCfg:          valid.NewGlobalCfg(true, false, false),
+					SkipCloneNoChanges: false,
 				}
 
 				var actCtxs []models.ProjectCommandContext
@@ -491,13 +493,14 @@ projects:
 			}
 
 			builder := &events.DefaultProjectCommandBuilder{
-				WorkingDirLocker: events.NewDefaultWorkingDirLocker(),
-				WorkingDir:       workingDir,
-				ParserValidator:  &yaml.ParserValidator{},
-				VCSClient:        vcsClient,
-				ProjectFinder:    &events.DefaultProjectFinder{},
-				CommentBuilder:   &events.CommentParser{},
-				GlobalCfg:        valid.NewGlobalCfg(true, false, false),
+				WorkingDirLocker:   events.NewDefaultWorkingDirLocker(),
+				WorkingDir:         workingDir,
+				ParserValidator:    &yaml.ParserValidator{},
+				VCSClient:          vcsClient,
+				ProjectFinder:      &events.DefaultProjectFinder{},
+				CommentBuilder:     &events.CommentParser{},
+				GlobalCfg:          valid.NewGlobalCfg(true, false, false),
+				SkipCloneNoChanges: false,
 			}
 
 			ctxs, err := builder.BuildPlanCommands(
@@ -562,14 +565,15 @@ func TestDefaultProjectCommandBuilder_BuildMultiApply(t *testing.T) {
 		ThenReturn(tmpDir, nil)
 
 	builder := &events.DefaultProjectCommandBuilder{
-		WorkingDirLocker:  events.NewDefaultWorkingDirLocker(),
-		WorkingDir:        workingDir,
-		ParserValidator:   &yaml.ParserValidator{},
-		VCSClient:         nil,
-		ProjectFinder:     &events.DefaultProjectFinder{},
-		PendingPlanFinder: &events.DefaultPendingPlanFinder{},
-		CommentBuilder:    &events.CommentParser{},
-		GlobalCfg:         valid.NewGlobalCfg(false, false, false),
+		WorkingDirLocker:   events.NewDefaultWorkingDirLocker(),
+		WorkingDir:         workingDir,
+		ParserValidator:    &yaml.ParserValidator{},
+		VCSClient:          nil,
+		ProjectFinder:      &events.DefaultProjectFinder{},
+		PendingPlanFinder:  &events.DefaultPendingPlanFinder{},
+		CommentBuilder:     &events.CommentParser{},
+		GlobalCfg:          valid.NewGlobalCfg(false, false, false),
+		SkipCloneNoChanges: false,
 	}
 
 	ctxs, err := builder.BuildApplyCommands(
@@ -630,13 +634,14 @@ projects:
 		AnyString())).ThenReturn(repoDir, nil)
 
 	builder := &events.DefaultProjectCommandBuilder{
-		WorkingDirLocker: events.NewDefaultWorkingDirLocker(),
-		WorkingDir:       workingDir,
-		ParserValidator:  &yaml.ParserValidator{},
-		VCSClient:        nil,
-		ProjectFinder:    &events.DefaultProjectFinder{},
-		CommentBuilder:   &events.CommentParser{},
-		GlobalCfg:        valid.NewGlobalCfg(true, false, false),
+		WorkingDirLocker:   events.NewDefaultWorkingDirLocker(),
+		WorkingDir:         workingDir,
+		ParserValidator:    &yaml.ParserValidator{},
+		VCSClient:          nil,
+		ProjectFinder:      &events.DefaultProjectFinder{},
+		CommentBuilder:     &events.CommentParser{},
+		GlobalCfg:          valid.NewGlobalCfg(true, false, false),
+		SkipCloneNoChanges: false,
 	}
 
 	ctx := &events.CommandContext{
@@ -692,13 +697,14 @@ func TestDefaultProjectCommandBuilder_EscapeArgs(t *testing.T) {
 			When(vcsClient.GetModifiedFiles(matchers.AnyModelsRepo(), matchers.AnyModelsPullRequest())).ThenReturn([]string{"main.tf"}, nil)
 
 			builder := &events.DefaultProjectCommandBuilder{
-				WorkingDirLocker: events.NewDefaultWorkingDirLocker(),
-				WorkingDir:       workingDir,
-				ParserValidator:  &yaml.ParserValidator{},
-				VCSClient:        vcsClient,
-				ProjectFinder:    &events.DefaultProjectFinder{},
-				CommentBuilder:   &events.CommentParser{},
-				GlobalCfg:        valid.NewGlobalCfg(true, false, false),
+				WorkingDirLocker:   events.NewDefaultWorkingDirLocker(),
+				WorkingDir:         workingDir,
+				ParserValidator:    &yaml.ParserValidator{},
+				VCSClient:          vcsClient,
+				ProjectFinder:      &events.DefaultProjectFinder{},
+				CommentBuilder:     &events.CommentParser{},
+				GlobalCfg:          valid.NewGlobalCfg(true, false, false),
+				SkipCloneNoChanges: false,
 			}
 
 			var actCtxs []models.ProjectCommandContext
@@ -856,13 +862,14 @@ projects:
 				AnyString())).ThenReturn(tmpDir, nil)
 
 			builder := &events.DefaultProjectCommandBuilder{
-				WorkingDirLocker: events.NewDefaultWorkingDirLocker(),
-				WorkingDir:       workingDir,
-				VCSClient:        vcsClient,
-				ParserValidator:  &yaml.ParserValidator{},
-				ProjectFinder:    &events.DefaultProjectFinder{},
-				CommentBuilder:   &events.CommentParser{},
-				GlobalCfg:        valid.NewGlobalCfg(true, false, false),
+				WorkingDirLocker:   events.NewDefaultWorkingDirLocker(),
+				WorkingDir:         workingDir,
+				VCSClient:          vcsClient,
+				ParserValidator:    &yaml.ParserValidator{},
+				ProjectFinder:      &events.DefaultProjectFinder{},
+				CommentBuilder:     &events.CommentParser{},
+				GlobalCfg:          valid.NewGlobalCfg(true, false, false),
+				SkipCloneNoChanges: false,
 			}
 
 			actCtxs, err := builder.BuildPlanCommands(

server/events/project_finder.go

@@ -120,11 +120,16 @@ func (p *DefaultProjectFinder) DetermineProjectsViaConfig(log *logging.SimpleLog
 			}
 			if match {
 				log.Debug("file %q matched pattern", file)
-				_, err := os.Stat(filepath.Join(absRepoDir, project.Dir))
-				if err == nil {
-					projects = append(projects, project)
+				// Skipping checking existing if remote atlantis.yaml was used
+				if len(absRepoDir) != 0 {
+					_, err := os.Stat(filepath.Join(absRepoDir, project.Dir))
+					if err == nil {
+						projects = append(projects, project)
+					} else {
+						log.Debug("project at dir %q not included because dir does not exist", project.Dir)
+					}
 				} else {
-					log.Debug("project at dir %q not included because dir does not exist", project.Dir)
+					projects = append(projects, project)
 				}
 				break
 			}

server/events/vcs/azuredevops_client.go

@@ -364,3 +364,11 @@ func SplitAzureDevopsRepoFullName(repoFullName string) (owner string, project st
 	}
 	return repoFullName[:lastSlashIdx], "", repoFullName[lastSlashIdx+1:]
 }
+
+func (g *AzureDevopsClient) IsSupportDownloadSingleFile(repo models.Repo) bool {
+	return false
+}
+
+func (g *AzureDevopsClient) DownloadRepoConfigFile(pull models.PullRequest) (bool, []byte, error) {
+	return false, []byte{}, fmt.Errorf("Not Implemented")
+}

server/events/vcs/bitbucketcloud/client.go

@@ -243,3 +243,14 @@ func (b *Client) makeRequest(method string, path string, reqBody io.Reader) ([]b
 	}
 	return respBody, nil
 }
+
+func (b *Client) IsSupportDownloadSingleFile(models.Repo) bool {
+	return false
+}
+
+// DownloadRepoConfigFile return `atlantis.yaml` content from VCS (which support fetch a single file from repository)
+// The first return value indicate that repo contain atlantis.yaml or not
+// if BaseRepo had one repo config file, its content will placed on the second return value
+func (b *Client) DownloadRepoConfigFile(pull models.PullRequest) (bool, []byte, error) {
+	return false, []byte{}, fmt.Errorf("Not Implemented")
+}

server/events/vcs/bitbucketserver/client.go

@@ -311,3 +311,14 @@ func (b *Client) makeRequest(method string, path string, reqBody io.Reader) ([]b
 	}
 	return respBody, nil
 }
+
+func (b *Client) IsSupportDownloadSingleFile(repo models.Repo) bool {
+	return false
+}
+
+// DownloadRepoConfigFile return `atlantis.yaml` content from VCS (which support fetch a single file from repository)
+// The first return value indicate that repo contain atlantis.yaml or not
+// if BaseRepo had one repo config file, its content will placed on the second return value
+func (b *Client) DownloadRepoConfigFile(pull models.PullRequest) (bool, []byte, error) {
+	return false, []byte{}, fmt.Errorf("not implemented")
+}

server/events/vcs/client.go

@@ -38,4 +38,10 @@ type Client interface {
 	UpdateStatus(repo models.Repo, pull models.PullRequest, state models.CommitStatus, src string, description string, url string) error
 	MergePull(pull models.PullRequest) error
 	MarkdownPullLink(pull models.PullRequest) (string, error)
+
+	// DownloadRepoConfigFile return `atlantis.yaml` content from VCS (which support fetch a single file from repository)
+	// The first return value indicate that repo contain atlantis.yaml or not
+	// if BaseRepo had one repo config file, its content will placed on the second return value
+	DownloadRepoConfigFile(pull models.PullRequest) (bool, []byte, error)
+	IsSupportDownloadSingleFile(repo models.Repo) bool
 }