Add the ability to disable Atlantis locking a repo (#1340)

* Add the ability to disable Atlantis locking a repo

* Fix incorrect logic when creating locking Client

Co-authored-by: kbaldyga <[email protected]>

* Add tests for noOpLocker to improve coverage

Co-authored-by: Gerald Barker <[email protected]>
Co-authored-by: kbaldyga <[email protected]>

cmd/server.go

@@ -56,6 +56,7 @@ const (
 	DisableApplyFlag           = "disable-apply"
 	DisableAutoplanFlag        = "disable-autoplan"
 	DisableMarkdownFoldingFlag = "disable-markdown-folding"
+	DisableRepoLockingFlag     = "disable-repo-locking"
 	GHHostnameFlag             = "gh-hostname"
 	GHTokenFlag                = "gh-token"
 	GHUserFlag                 = "gh-user"
@@ -291,6 +292,10 @@ var boolFlags = map[string]boolFlag{
 		description:  "Disable atlantis auto planning feature",
 		defaultValue: false,
 	},
+	DisableRepoLockingFlag: {
+		description:  "Disable atlantis locking repos",
+		defaultValue: false,
+	},
 	AllowDraftPRs: {
 		description:  "Enable autoplan for Github Draft Pull Requests",
 		defaultValue: false,

cmd/server_test.go

@@ -67,6 +67,7 @@ var testFlags = map[string]interface{}{
 	DisableApplyAllFlag:        true,
 	DisableApplyFlag:           true,
 	DisableMarkdownFoldingFlag: true,
+	DisableRepoLockingFlag:     true,
 	GHHostnameFlag:             "ghhostname",
 	GHTokenFlag:                "token",
 	GHUserFlag:                 "user",

runatlantis.io/docs/server-configuration.md

@@ -220,6 +220,12 @@ Values are chosen in this order:
   ```
   Disable atlantis auto planning
 
+* ### `--disable-repo-locking`
+  ```bash
+  atlantis server --disable-repo-locking
+  ```
+  Stops atlantis locking projects and or workspaces when running terraform
+
 * ### `--gh-hostname`
   ```bash
   atlantis server --gh-hostname="my.github.enterprise.com"

server/events/comment_parser.go

@@ -16,16 +16,17 @@ package events
 import (
 	"bytes"
 	"fmt"
-	"github.com/flynn-archive/go-shlex"
-	"github.com/runatlantis/atlantis/server/events/models"
-	"github.com/runatlantis/atlantis/server/events/yaml"
-	"github.com/spf13/pflag"
 	"io/ioutil"
 	"net/url"
 	"path/filepath"
 	"regexp"
 	"strings"
 	"text/template"
+
+	"github.com/flynn-archive/go-shlex"
+	"github.com/runatlantis/atlantis/server/events/models"
+	"github.com/runatlantis/atlantis/server/events/yaml"
+	"github.com/spf13/pflag"
 )
 
 const (

server/events/locking/locking.go

@@ -146,3 +146,47 @@ func (c *Client) lockKeyToProjectWorkspace(key string) (models.Project, string,
 
 	return models.Project{RepoFullName: matches[1], Path: matches[2]}, matches[3], nil
 }
+
+type NoOpLocker struct{}
+
+// NewNoOpLocker returns a new lno operation lockingclient.
+func NewNoOpLocker() *NoOpLocker {
+	return &NoOpLocker{}
+}
+
+// TryLock attempts to acquire a lock to a project and workspace.
+func (c *NoOpLocker) TryLock(p models.Project, workspace string, pull models.PullRequest, user models.User) (TryLockResponse, error) {
+	return TryLockResponse{true, models.ProjectLock{}, c.key(p, workspace)}, nil
+}
+
+// Unlock attempts to unlock a project and workspace. If successful,
+// a pointer to the now deleted lock will be returned. Else, that
+// pointer will be nil. An error will only be returned if there was
+// an error deleting the lock (i.e. not if there was no lock).
+func (c *NoOpLocker) Unlock(key string) (*models.ProjectLock, error) {
+	return &models.ProjectLock{}, nil
+}
+
+// List returns a map of all locks with their lock key as the map key.
+// The lock key can be used in GetLock() and Unlock().
+func (c *NoOpLocker) List() (map[string]models.ProjectLock, error) {
+	m := make(map[string]models.ProjectLock)
+	return m, nil
+}
+
+// UnlockByPull deletes all locks associated with that pull request.
+func (c *NoOpLocker) UnlockByPull(repoFullName string, pullNum int) ([]models.ProjectLock, error) {
+	return []models.ProjectLock{}, nil
+}
+
+// GetLock attempts to get the lock stored at key. If successful,
+// a pointer to the lock will be returned. Else, the pointer will be nil.
+// An error will only be returned if there was an error getting the lock
+// (i.e. not if there was no lock).
+func (c *NoOpLocker) GetLock(key string) (*models.ProjectLock, error) {
+	return nil, nil
+}
+
+func (c *NoOpLocker) key(p models.Project, workspace string) string {
+	return fmt.Sprintf("%s/%s/%s", p.RepoFullName, p.Path, workspace)
+}

server/events/locking/locking_test.go

@@ -144,3 +144,40 @@ func TestGetLock(t *testing.T) {
 	Ok(t, err)
 	Equals(t, &pl, lock)
 }
+
+func TestTryLock_NoOpLocker(t *testing.T) {
+	RegisterMockTestingT(t)
+	currLock := models.ProjectLock{}
+	l := locking.NewNoOpLocker()
+	r, err := l.TryLock(project, workspace, pull, user)
+	Ok(t, err)
+	Equals(t, locking.TryLockResponse{LockAcquired: true, CurrLock: currLock, LockKey: "owner/repo/path/workspace"}, r)
+}
+
+func TestUnlock_NoOpLocker(t *testing.T) {
+	l := locking.NewNoOpLocker()
+	lock, err := l.Unlock("owner/repo/path/workspace")
+	Ok(t, err)
+	Equals(t, &models.ProjectLock{}, lock)
+}
+
+func TestList_NoOpLocker(t *testing.T) {
+	l := locking.NewNoOpLocker()
+	list, err := l.List()
+	Ok(t, err)
+	Equals(t, map[string]models.ProjectLock{}, list)
+}
+
+func TestUnlockByPull_NoOpLocker(t *testing.T) {
+	l := locking.NewNoOpLocker()
+	_, err := l.UnlockByPull("owner/repo", 1)
+	Ok(t, err)
+}
+
+func TestGetLock_NoOpLocker(t *testing.T) {
+	l := locking.NewNoOpLocker()
+	lock, err := l.GetLock("owner/repo/path/workspace")
+	Ok(t, err)
+	var expected *models.ProjectLock = nil
+	Equals(t, expected, lock)
+}

server/events/markdown_renderer.go

@@ -40,16 +40,18 @@ type MarkdownRenderer struct {
 	DisableApplyAll          bool
 	DisableApply             bool
 	DisableMarkdownFolding   bool
+	DisableRepoLocking       bool
 }
 
 // commonData is data that all responses have.
 type commonData struct {
-	Command         string
-	Verbose         bool
-	Log             string
-	PlansDeleted    bool
-	DisableApplyAll bool
-	DisableApply    bool
+	Command            string
+	Verbose            bool
+	Log                string
+	PlansDeleted       bool
+	DisableApplyAll    bool
+	DisableApply       bool
+	DisableRepoLocking bool
 }
 
 // errData is data about an error response.
@@ -72,8 +74,9 @@ type resultData struct {
 
 type planSuccessData struct {
 	models.PlanSuccess
-	PlanWasDeleted bool
-	DisableApply   bool
+	PlanWasDeleted     bool
+	DisableApply       bool
+	DisableRepoLocking bool
 }
 
 type projectResultTmplData struct {
@@ -88,12 +91,13 @@ type projectResultTmplData struct {
 func (m *MarkdownRenderer) Render(res CommandResult, cmdName models.CommandName, log string, verbose bool, vcsHost models.VCSHostType) string {
 	commandStr := strings.Title(cmdName.String())
 	common := commonData{
-		Command:         commandStr,
-		Verbose:         verbose,
-		Log:             log,
-		PlansDeleted:    res.PlansDeleted,
-		DisableApplyAll: m.DisableApplyAll || m.DisableApply,
-		DisableApply:    m.DisableApply,
+		Command:            commandStr,
+		Verbose:            verbose,
+		Log:                log,
+		PlansDeleted:       res.PlansDeleted,
+		DisableApplyAll:    m.DisableApplyAll || m.DisableApply,
+		DisableApply:       m.DisableApply,
+		DisableRepoLocking: m.DisableRepoLocking,
 	}
 	if res.Error != nil {
 		return m.renderTemplate(unwrappedErrWithLogTmpl, errData{res.Error.Error(), common})
@@ -136,9 +140,9 @@ func (m *MarkdownRenderer) renderProjectResults(results []models.ProjectResult,
 			})
 		} else if result.PlanSuccess != nil {
 			if m.shouldUseWrappedTmpl(vcsHost, result.PlanSuccess.TerraformOutput) {
-				resultData.Rendered = m.renderTemplate(planSuccessWrappedTmpl, planSuccessData{PlanSuccess: *result.PlanSuccess, PlanWasDeleted: common.PlansDeleted, DisableApply: common.DisableApply})
+				resultData.Rendered = m.renderTemplate(planSuccessWrappedTmpl, planSuccessData{PlanSuccess: *result.PlanSuccess, PlanWasDeleted: common.PlansDeleted, DisableApply: common.DisableApply, DisableRepoLocking: common.DisableRepoLocking})
 			} else {
-				resultData.Rendered = m.renderTemplate(planSuccessUnwrappedTmpl, planSuccessData{PlanSuccess: *result.PlanSuccess, PlanWasDeleted: common.PlansDeleted, DisableApply: common.DisableApply})
+				resultData.Rendered = m.renderTemplate(planSuccessUnwrappedTmpl, planSuccessData{PlanSuccess: *result.PlanSuccess, PlanWasDeleted: common.PlansDeleted, DisableApply: common.DisableApply, DisableRepoLocking: common.DisableRepoLocking})
 			}
 			numPlanSuccesses++
 		} else if result.ApplySuccess != "" {
@@ -258,7 +262,7 @@ var planSuccessWrappedTmpl = template.Must(template.New("").Parse(
 var planNextSteps = "{{ if .PlanWasDeleted }}This plan was not saved because one or more projects failed and automerge requires all plans pass.{{ else }}" +
 	"{{ if not .DisableApply }}* :arrow_forward: To **apply** this plan, comment:\n" +
 	"    * `{{.ApplyCmd}}`\n{{end}}" +
-	"* :put_litter_in_its_place: To **delete** this plan click [here]({{.LockURL}})\n" +
+	"{{ if not .DisableRepoLocking }}* :put_litter_in_its_place: To **delete** this plan click [here]({{.LockURL}})\n{{end}}" +
 	"* :repeat: To **plan** this project again, comment:\n" +
 	"    * `{{.RePlanCmd}}`{{end}}"
 var applyUnwrappedSuccessTmpl = template.Must(template.New("").Parse(