Fix regression - Delete .terraform.lock.hcl if it was created by terraform init #1701
Conversation
gezb
changed the title
| outputs, err := p.runSteps(ctx.Steps, ctx, projAbsPath) | ||
| if err != nil { | ||
| if unlockErr := lockAttempt.UnlockFn(); unlockErr != nil { | ||
| ctx.Log.Err("error unlocking state after plan error: %v", unlockErr) | ||
| } | ||
| if !lockFileExistsProirToPlan && common.FileExists(lockfilePath) { |
There was a problem hiding this comment.
| if !lockFileExistsProirToPlan && common.FileExists(lockfilePath) { | |
| if !lockFileExistsPriorToPlan && common.FileExists(lockfilePath) { |
| outputs, err := p.runSteps(ctx.Steps, ctx, projAbsPath) | ||
| if err != nil { | ||
| if unlockErr := lockAttempt.UnlockFn(); unlockErr != nil { | ||
| ctx.Log.Err("error unlocking state after plan error: %v", unlockErr) | ||
| } | ||
| if !lockFileExistsProirToPlan && common.FileExists(lockfilePath) { | ||
| // if the lock file did not exist before running the plan delete the lock file that was generated |
There was a problem hiding this comment.
Why is this only being run when there is an error in the steps? Does this file need to be present for an apply? Maybe it might make sense to use something like git to detect whether this is a new file that's been generated previously and clean this up before the init runs in the step runner itself.
There was a problem hiding this comment.
Good spot I have moved this outside the if err != nil {
|
this still is not correct - Looking at the CircleCI output the apply step of the e2e tests now fails because the lock file does not exist - not sure of the best way to solve this now? @nishkrishnan any ideas? |
I mentioned an idea in an above comment: "Maybe it might make sense to use something like git cli to detect whether this is a new file that's been generated previously and clean this up before the init runs in the step runner itself." If the file is committed, it won't show up when running git status. |
|
OK I have rewritten this and I think its ready for re-review - One change I have had to make is require TF > 0.14.0 in the E2E tests as I have added a test around the lock file handling |
server/events/working_dir.go
Outdated
| cmd := exec.Command("git", "ls-files", filename) | ||
| cmd.Dir = cloneDir | ||
|
|
||
| output, err := cmd.CombinedOutput() | ||
|
|
||
| if err != nil { | ||
| log.Warn("Error checking if %s is tracked: %s", filename, string(output)) | ||
| return false, err | ||
| } | ||
| return len(output) > 0, nil |
There was a problem hiding this comment.
I'm more in favor with just keeping all this logic in core/runtime/common or even in InitStepRunner
- I dont know if there is really going to be something else that uses this logic. The long term solution is to just clean up after each operation
ProjectCommandContextis becoming a dumping ground for things we need to plumb through the service and is losing it's meaning, let's not add to that unnecessarily.- We can leave
ProjectCommandRunnerout of this, which already has a lot going on.
There was a problem hiding this comment.
I have made the suggested change and moved the code to check if file is tracked in git into core/runtime/common
…aform init (#1701) * Delete .terraform.lock.hcl prior to terraform init if it is not staged * Changes suggeted by reviewer
…aform init (runatlantis#1701) * Delete .terraform.lock.hcl prior to terraform init if it is not staged * Changes suggeted by reviewer
This PR fixes a regression I introduced with the changes in #1651 reported in #1698
My initial change did not take into account that the terraform init ran as part of the workflow will create the
.terraform.lock.hcllock file and the knock on affects of this file existing when the project is re-plannedIf the lock file exists after terraform init has run and it did not exist initially we delete it