diff --git a/server/controllers/events/events_controller_e2e_test.go b/server/controllers/events/events_controller_e2e_test.go
index c1cbded81e..9e7cd6eea5 100644
--- a/server/controllers/events/events_controller_e2e_test.go
+++ b/server/controllers/events/events_controller_e2e_test.go
@@ -67,8 +67,8 @@ func TestGitHubWorkflow(t *testing.T) {
if testing.Short() {
t.SkipNow()
}
- // Ensure we have >= TF 0.12 locally.
- ensureRunning012(t)
+ // Ensure we have >= TF 0.14 locally.
+ ensureRunning014(t)
cases := []struct {
Description string
@@ -456,12 +456,165 @@ func TestGitHubWorkflow(t *testing.T) {
}
}
+func TestSimlpleWorkflow_terraformLockFile(t *testing.T) {
+
+ if testing.Short() {
+ t.SkipNow()
+ }
+ // Ensure we have >= TF 0.14 locally.
+ ensureRunning014(t)
+
+ cases := []struct {
+ Description string
+ // RepoDir is relative to testfixtures/test-repos.
+ RepoDir string
+ // ModifiedFiles are the list of files that have been modified in this
+ // pull request.
+ ModifiedFiles []string
+ // ExpAutoplan is true if we expect Atlantis to autoplan.
+ ExpAutoplan bool
+ // Comments are what our mock user writes to the pull request.
+ Comments []string
+ // ExpReplies is a list of files containing the expected replies that
+ // Atlantis writes to the pull request in order. A reply from a parallel operation
+ // will be matched using a substring check.
+ ExpReplies [][]string
+ // LockFileTracked deterims if the `.terraform.lock.hcl` file is tracked in git
+ // if this is true we dont expect the lockfile to be modified by terraform init
+ // if false we expect the lock file to be updated
+ LockFileTracked bool
+ }{
+ {
+ Description: "simple with plan comment lockfile staged",
+ RepoDir: "simple-with-lockfile",
+ ModifiedFiles: []string{"main.tf"},
+ ExpAutoplan: true,
+ Comments: []string{
+ "atlantis plan",
+ },
+ ExpReplies: [][]string{
+ {"exp-output-autoplan.txt"},
+ {"exp-output-plan.txt"},
+ },
+ LockFileTracked: true,
+ },
+ {
+ Description: "simple with plan comment lockfile not staged",
+ RepoDir: "simple-with-lockfile",
+ ModifiedFiles: []string{"main.tf"},
+ Comments: []string{
+ "atlantis plan",
+ },
+ ExpReplies: [][]string{
+ {"exp-output-autoplan.txt"},
+ {"exp-output-plan.txt"},
+ },
+ LockFileTracked: false,
+ },
+ }
+ for _, c := range cases {
+ t.Run(c.Description, func(t *testing.T) {
+ RegisterMockTestingT(t)
+
+ // reset userConfig
+ userConfig = server.UserConfig{}
+ userConfig.DisableApply = true
+
+ ctrl, vcsClient, githubGetter, atlantisWorkspace := setupE2E(t, c.RepoDir)
+ // Set the repo to be cloned through the testing backdoor.
+ repoDir, headSHA, cleanup := initializeRepo(t, c.RepoDir)
+ defer cleanup()
+
+ oldLockFilePath, err := filepath.Abs(filepath.Join("testfixtures", "null_provider_lockfile_old_version"))
+ Ok(t, err)
+ oldLockFileContent, err := ioutil.ReadFile(oldLockFilePath)
+ Ok(t, err)
+
+ if c.LockFileTracked {
+ runCmd(t, "", "cp", oldLockFilePath, fmt.Sprintf("%s/.terraform.lock.hcl", repoDir))
+ runCmd(t, repoDir, "git", "add", ".terraform.lock.hcl")
+ runCmd(t, repoDir, "git", "commit", "-am", "stage .terraform.lock.hcl")
+ }
+
+ atlantisWorkspace.TestingOverrideHeadCloneURL = fmt.Sprintf("file://%s", repoDir)
+
+ // Setup test dependencies.
+ w := httptest.NewRecorder()
+ When(githubGetter.GetPullRequest(AnyRepo(), AnyInt())).ThenReturn(GitHubPullRequestParsed(headSHA), nil)
+ When(vcsClient.GetModifiedFiles(AnyRepo(), matchers.AnyModelsPullRequest())).ThenReturn(c.ModifiedFiles, nil)
+
+ // First, send the open pull request event which triggers autoplan.
+ pullOpenedReq := GitHubPullRequestOpenedEvent(t, headSHA)
+ ctrl.Post(w, pullOpenedReq)
+ ResponseContains(t, w, 200, "Processing...")
+
+ // check lock file content
+ actualLockFileContent, err := ioutil.ReadFile(fmt.Sprintf("%s/repos/runatlantis/atlantis-tests/2/default/.terraform.lock.hcl", atlantisWorkspace.DataDir))
+ Ok(t, err)
+ if c.LockFileTracked {
+ if string(oldLockFileContent) != string(actualLockFileContent) {
+ t.Error("Expected terraform.lock.hcl file not to be different as it has been staged")
+ t.FailNow()
+ }
+ } else {
+ if string(oldLockFileContent) == string(actualLockFileContent) {
+ t.Error("Expected terraform.lock.hcl file to be different as it should have been updated")
+ t.FailNow()
+ }
+ }
+
+ if !c.LockFileTracked {
+ // replace the lock file generated by the previous init to simulate
+ // dependcies needing updating in a latter plan
+ runCmd(t, "", "cp", oldLockFilePath, fmt.Sprintf("%s/repos/runatlantis/atlantis-tests/2/default/.terraform.lock.hcl", atlantisWorkspace.DataDir))
+ }
+
+ // Now send any other comments.
+ for _, comment := range c.Comments {
+ commentReq := GitHubCommentEvent(t, comment)
+ w = httptest.NewRecorder()
+ ctrl.Post(w, commentReq)
+ ResponseContains(t, w, 200, "Processing...")
+ }
+
+ // check lock file content
+ actualLockFileContent, err = ioutil.ReadFile(fmt.Sprintf("%s/repos/runatlantis/atlantis-tests/2/default/.terraform.lock.hcl", atlantisWorkspace.DataDir))
+ Ok(t, err)
+ if c.LockFileTracked {
+ if string(oldLockFileContent) != string(actualLockFileContent) {
+ t.Error("Expected terraform.lock.hcl file not to be different as it has been staged")
+ t.FailNow()
+ }
+ } else {
+ if string(oldLockFileContent) == string(actualLockFileContent) {
+ t.Error("Expected terraform.lock.hcl file to be different as it should have been updated")
+ t.FailNow()
+ }
+ }
+
+ // Let's verify the pre-workflow hook was called for each comment including the pull request opened event
+ mockPreWorkflowHookRunner.VerifyWasCalled(Times(2)).Run(runtimematchers.AnyModelsPreWorkflowHookCommandContext(), EqString("some dummy command"), AnyString())
+
+ // Now we're ready to verify Atlantis made all the comments back (or
+ // replies) that we expect. We expect each plan to have 1 comment,
+ // and apply have 1 for each comment plus one for the locks deleted at the
+ // end.
+
+ _, _, actReplies, _ := vcsClient.VerifyWasCalled(Times(2)).CreateComment(AnyRepo(), AnyInt(), AnyString(), AnyString()).GetAllCapturedArguments()
+ Assert(t, len(c.ExpReplies) == len(actReplies), "missing expected replies, got %d but expected %d", len(actReplies), len(c.ExpReplies))
+ for i, expReply := range c.ExpReplies {
+ assertCommentEquals(t, expReply, actReplies[i], c.RepoDir, false)
+ }
+ })
+ }
+}
+
func TestGitHubWorkflowWithPolicyCheck(t *testing.T) {
if testing.Short() {
t.SkipNow()
}
- // Ensure we have >= TF 0.12 locally.
- ensureRunning012(t)
+ // Ensure we have >= TF 0.14 locally.
+ ensureRunning014(t)
// Ensure we have >= Conftest 0.21 locally.
ensureRunningConftest(t)
@@ -1132,11 +1285,11 @@ func ensureRunningConftest(t *testing.T) {
}
}
-// Will fail test if terraform isn't in path and isn't version >= 0.12
-func ensureRunning012(t *testing.T) {
+// Will fail test if terraform isn't in path and isn't version >= 0.14
+func ensureRunning014(t *testing.T) {
localPath, err := exec.LookPath("terraform")
if err != nil {
- t.Log("terraform >= 0.12 must be installed to run this test")
+ t.Log("terraform >= 0.14 must be installed to run this test")
t.FailNow()
}
versionOutBytes, err := exec.Command(localPath, "version").Output() // #nosec
@@ -1152,7 +1305,7 @@ func ensureRunning012(t *testing.T) {
}
localVersion, err := version.NewVersion(match[1])
Ok(t, err)
- minVersion, err := version.NewVersion("0.12.0")
+ minVersion, err := version.NewVersion("0.14.0")
Ok(t, err)
if localVersion.LessThan(minVersion) {
t.Logf("must have terraform version >= %s, you have %s", minVersion, localVersion)
diff --git a/server/controllers/events/testfixtures/null_provider_lockfile_old_version b/server/controllers/events/testfixtures/null_provider_lockfile_old_version
new file mode 100644
index 0000000000..09c858af04
--- /dev/null
+++ b/server/controllers/events/testfixtures/null_provider_lockfile_old_version
@@ -0,0 +1,20 @@
+# This file is maintained automatically by "terraform init".
+# Manual edits may be lost in future updates.
+
+provider "registry.terraform.io/hashicorp/null" {
+ version = "3.0.0"
+ constraints = "3.0.0"
+ hashes = [
+ "h1:ysHGBhBNkIiJLEpthB/IVCLpA1Qoncp3KbCTFGFZTO0=",
+ "zh:05fb7eab469324c97e9b73a61d2ece6f91de4e9b493e573bfeda0f2077bc3a4c",
+ "zh:1688aa91885a395c4ae67636d411475d0b831e422e005dcf02eedacaafac3bb4",
+ "zh:24a0b1292e3a474f57c483a7a4512d797e041bc9c2fbaac42fe12e86a7fb5a3c",
+ "zh:2fc951bd0d1b9b23427acc93be09b6909d72871e464088171da60fbee4fdde03",
+ "zh:6db825759425599a326385a68acc6be2d9ba0d7d6ef587191d0cdc6daef9ac63",
+ "zh:85985763d02618993c32c294072cc6ec51f1692b803cb506fcfedca9d40eaec9",
+ "zh:a53186599c57058be1509f904da512342cfdc5d808efdaf02dec15f0f3cb039a",
+ "zh:c2e07b49b6efa676bdc7b00c06333ea1792a983a5720f9e2233db27323d2707c",
+ "zh:cdc8fe1096103cf5374751e2e8408ec4abd2eb67d5a1c5151fe2c7ecfd525bef",
+ "zh:dbdef21df0c012b0d08776f3d4f34eb0f2f229adfde07ff252a119e52c0f65b7",
+ ]
+}
diff --git a/server/controllers/events/testfixtures/test-repos/simple-with-lockfile/exp-output-autoplan.txt b/server/controllers/events/testfixtures/test-repos/simple-with-lockfile/exp-output-autoplan.txt
new file mode 100644
index 0000000000..b301024b0c
--- /dev/null
+++ b/server/controllers/events/testfixtures/test-repos/simple-with-lockfile/exp-output-autoplan.txt
@@ -0,0 +1,48 @@
+Ran Plan for dir: `.` workspace: `default`
+
+Show Output
+
+```diff
+
+Terraform used the selected providers to generate the following execution
+plan. Resource actions are indicated with the following symbols:
++ create
+
+Terraform will perform the following actions:
+
+ # null_resource.simple[0] will be created
++ resource "null_resource" "simple" {
+ + id = (known after apply)
+ }
+
+ # null_resource.simple2 will be created
++ resource "null_resource" "simple2" {
+ + id = (known after apply)
+ }
+
+ # null_resource.simple3 will be created
++ resource "null_resource" "simple3" {
+ + id = (known after apply)
+ }
+
+Plan: 3 to add, 0 to change, 0 to destroy.
+
+Changes to Outputs:
++ var = "default"
++ workspace = "default"
+
+```
+
+* :arrow_forward: To **apply** this plan, comment:
+ * `atlantis apply -d .`
+* :put_litter_in_its_place: To **delete** this plan click [here](lock-url)
+* :repeat: To **plan** this project again, comment:
+ * `atlantis plan -d .`
+Show Output
+
+```diff
+
+Terraform used the selected providers to generate the following execution
+plan. Resource actions are indicated with the following symbols:
++ create
+
+Terraform will perform the following actions:
+
+ # null_resource.simple[0] will be created
++ resource "null_resource" "simple" {
+ + id = (known after apply)
+ }
+
+ # null_resource.simple2 will be created
++ resource "null_resource" "simple2" {
+ + id = (known after apply)
+ }
+
+ # null_resource.simple3 will be created
++ resource "null_resource" "simple3" {
+ + id = (known after apply)
+ }
+
+Plan: 3 to add, 0 to change, 0 to destroy.
+
+Changes to Outputs:
++ var = "default"
++ workspace = "default"
+
+```
+
+* :arrow_forward: To **apply** this plan, comment:
+ * `atlantis apply -d .`
+* :put_litter_in_its_place: To **delete** this plan click [here](lock-url)
+* :repeat: To **plan** this project again, comment:
+ * `atlantis plan -d .`
+