Merge pull request #442 from duckpuppy/ignore_vars_with_planfile

Fixes #436 - Omit variables and variable files from apply command when using a plan file

Author: duckpuppy

.gitignore

@@ -6,6 +6,7 @@ build
 *.iml
 /out
 .history
+bin/
 tags
 .vscode
 shell.nix

CHANGELOG.md

@@ -7,6 +7,7 @@
   TerraformTaintPlugin: Support main and master branches
 - [Issue #432](https://github.com/manheim/terraform-pipeline/issues/432) pass TagPlugin through `-var-file={env}-tags.tfvars`
 - [Issue #417](https://github.com/manheim/terraform-pipeline/issues/417) DestroyPlugin & PassPlanFilePlugin - Terraform Destroy can't be called with a plan file
+- [Issue #436](https://github.com/manheim/terraform-pipeline/issues/436) Bug Fix: Omit variables and variable files from apply command if a plan file is specified
 
 # v5.19
 

src/TerraformApplyCommand.groovy

@@ -6,6 +6,7 @@ class TerraformApplyCommand implements TerraformCommand, Resettable {
     private prefixes = []
     private suffixes = []
     private args = []
+    private vars = []
     private String directory
     private String planFile
     private boolean chdir_flag = false
@@ -39,7 +40,7 @@ class TerraformApplyCommand implements TerraformCommand, Resettable {
 
     public TerraformApplyCommand withVariable(String key, String value) {
         def pattern = variablePattern ?: { myKey, myValue -> "-var '${myKey}=${myValue}'" }
-        this.args << pattern.call(key, value).toString()
+        this.vars << pattern.call(key, value).toString()
         return this
     }
 
@@ -51,7 +52,7 @@ class TerraformApplyCommand implements TerraformCommand, Resettable {
     }
 
     public TerraformApplyCommand withVariableFile(String fileName) {
-        this.args << "-var-file=./${fileName}"
+        this.vars << "-var-file=./${fileName}"
         return this
     }
 
@@ -119,6 +120,11 @@ class TerraformApplyCommand implements TerraformCommand, Resettable {
             pieces << "-input=false"
         }
         pieces += args
+        // If we have a plan file, we cannot pass vars, they're already
+        // baked into the plan.
+        if (!planFile) {
+            pieces += vars
+        }
         if (directory && !chdir_flag && !planFile) {
             pieces << directory
         }

test/TerraformApplyCommandTest.groovy

@@ -245,6 +245,27 @@ class TerraformApplyCommandTest {
             def actualCommand = command.toString()
             assertThat(actualCommand, startsWith("terraform apply"))
         }
+
+        @Test
+        void ignoresVarsIfPlanFilePresent() {
+            def command = new TerraformApplyCommand().withPlanFile("foobar")
+                                                     .withVariable("foo", "bar")
+                                                     .withVariableFile("varfile")
+
+            def actualCommand = command.toString()
+            assertThat(actualCommand, not(containsString("-var")))
+            assertThat(actualCommand, not(containsString("-var-file")))
+        }
+
+        @Test
+        void usesVarsIfPlanFileNotPresent() {
+            def command = new TerraformApplyCommand().withVariable("foo", "bar")
+                                                     .withVariableFile("varfile")
+
+            def actualCommand = command.toString()
+            assertThat(actualCommand, containsString("-var"))
+            assertThat(actualCommand, containsString("-var-file"))
+        }
     }
 
     @Nested