Add test for plan-draft behavior

runatlantis · May 25, 2020 · d7ce637 · d7ce637
1 parent c300dee
commit d7ce637
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 11 deletions.
diff --git a/cmd/server.go b/cmd/server.go
@@ -64,7 +64,7 @@ const (
 	GitlabWebhookSecretFlag    = "gitlab-webhook-secret" // nolint: gosec
 	HidePrevPlanComments       = "hide-prev-plan-comments"
 	LogLevelFlag               = "log-level"
-	PlanDrafts                 = "plan-drafts"
+	AllowDraftPRs              = "allow-draft-prs"
 	PortFlag                   = "port"
 	RepoConfigFlag             = "repo-config"
 	RepoConfigJSONFlag         = "repo-config-json"
@@ -254,15 +254,15 @@ var boolFlags = map[string]boolFlag{
 		description:  "Disable \"atlantis apply\" command so a specific project/workspace/directory has to be specified for applies.",
 		defaultValue: false,
 	},
+	AllowDraftPRs: {
+		description:  "Enable autoplan for Github Draft Pull Requests",
+		defaultValue: false,
+	},
 	HidePrevPlanComments: {
 		description: "Hide previous plan comments to reduce clutter in the PR. " +
 			"VCS support is limited to: GitHub.",
 		defaultValue: false,
 	},
-	PlanDrafts: {
-		description:  "Enable autoplan for Github Draft Pull Requests",
-		defaultValue: false,
-	},
 	RequireApprovalFlag: {
 		description:  "Require pull requests to be \"Approved\" before allowing the apply command to be run.",
 		defaultValue: false,

diff --git a/cmd/server_test.go b/cmd/server_test.go
@@ -75,7 +75,7 @@ var testFlags = map[string]interface{}{
 	GitlabUserFlag:             "gitlab-user",
 	GitlabWebhookSecretFlag:    "gitlab-secret",
 	LogLevelFlag:               "debug",
-	PlanDrafts:                 true,
+	AllowDraftPRs:              true,
 	PortFlag:                   8181,
 	RepoWhitelistFlag:          "github.com/runatlantis/atlantis",
 	RequireApprovalFlag:        true,

diff --git a/server/events/event_parser.go b/server/events/event_parser.go
@@ -266,6 +266,7 @@ type EventParser struct {
 	GithubToken        string
 	GitlabUser         string
 	GitlabToken        string
+	AllowDraftPRs      bool
 	BitbucketUser      string
 	BitbucketToken     string
 	BitbucketServerURL string
@@ -418,11 +419,11 @@ func (e *EventParser) ParseGithubPullEvent(pullEvent *github.PullRequestEvent) (
 	}
 
 	if pullEvent.GetPullRequest().GetDraft() {
-		// if the PR is in draft state we do not initiate actions proactively however,
-		// we must still clean up locks in the event of a user initiated plan
+		// Even if the PR is in draft state users can manually run plan or may
+		// be using the -allow-draft-prs flag. If so then we need to ensure locks are cleaned up.
 		if pullEvent.GetAction() == "closed" {
 			pullEventType = models.ClosedPullEvent
-		} else {
+		} else if !e.AllowDraftPRs {
 			pullEventType = models.OtherPullEvent
 		}
 	} else {

diff --git a/server/events/event_parser_test.go b/server/events/event_parser_test.go
@@ -36,6 +36,7 @@ var parser = events.EventParser{
 	GithubToken:        "github-token",
 	GitlabUser:         "gitlab-user",
 	GitlabToken:        "gitlab-token",
+	AllowDraftPRs:      false,
 	BitbucketUser:      "bitbucket-user",
 	BitbucketToken:     "bitbucket-token",
 	BitbucketServerURL: "http://mycorp.com:7490",
@@ -160,6 +161,22 @@ func TestParseGithubPullEvent(t *testing.T) {
 	Equals(t, models.User{Username: "user"}, actUser)
 }
 
+func TestParseGithubPullEventFromDraft(t *testing.T) {
+	// verify that draft PRs are treated as 'other' events by default
+	testEvent := deepcopy.Copy(PullEvent).(github.PullRequestEvent)
+	draftPR := true
+	testEvent.PullRequest.Draft = &draftPR
+	_, evType, _, _, _, err := parser.ParseGithubPullEvent(&testEvent)
+	Ok(t, err)
+	Equals(t, models.OtherPullEvent, evType)
+	// verify that drafts are planned if requested
+	parser.AllowDraftPRs = true
+	defer func() { parser.AllowDraftPRs = false }()
+	_, evType, _, _, _, err = parser.ParseGithubPullEvent(&testEvent)
+	Ok(t, err)
+	Equals(t, models.OpenedPullEvent, evType)
+}
+
 func TestParseGithubPullEvent_EventType(t *testing.T) {
 	cases := []struct {
 		action   string

diff --git a/server/server.go b/server/server.go
@@ -290,7 +290,7 @@ func NewServer(userConfig UserConfig, config Config) (*Server, error) {
 		GithubToken:        userConfig.GithubToken,
 		GitlabUser:         userConfig.GitlabUser,
 		GitlabToken:        userConfig.GitlabToken,
-		PlanDrafts:         userConfig.PlanDrafts,
+		AllowDraftPRs:      userConfig.PlanDrafts,
 		BitbucketUser:      userConfig.BitbucketUser,
 		BitbucketToken:     userConfig.BitbucketToken,
 		BitbucketServerURL: userConfig.BitbucketBaseURL,

diff --git a/server/user_config.go b/server/user_config.go
@@ -34,7 +34,7 @@ type UserConfig struct {
 	GitlabWebhookSecret        string `mapstructure:"gitlab-webhook-secret"`
 	HidePrevPlanComments       bool   `mapstructure:"hide-prev-plan-comments"`
 	LogLevel                   string `mapstructure:"log-level"`
-	PlanDrafts                 bool   `mapstructure:"plan-drafts"`
+	PlanDrafts                 bool   `mapstructure:"allow-draft-prs"`
 	Port                       int    `mapstructure:"port"`
 	RepoConfig                 string `mapstructure:"repo-config"`
 	RepoConfigJSON             string `mapstructure:"repo-config-json"`