Merge pull request #415 from jleopold28/issue_379

jleopold28 · web-flow · commit d06a9ba46bc9 · 2022-02-03T13:43:02.000-05:00
Add chdir argument to support Terraform 0.15+
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Unreleased
 - [Issue #422](https://github.com/manheim/terraform-pipeline/issues/422) TerraformPlugin and TerraformPluginVersion should implement TerraformInitCommandPlugin
+- [Issue #379](https://github.com/manheim/terraform-pipeline/issues/379) Support Terraform 0.15. Added `-chdir` argument.
+- [Issue #395](https://github.com/manheim/terraform-pipeline/issues/395) Support Terraform 1.0. Added `-chdir` argument.
+
 
 # v5.18
 
diff --git a/docs/TerraformDirectoryPlugin.md b/docs/TerraformDirectoryPlugin.md
@@ -2,7 +2,10 @@
 
 This plugin allows Terraform to run in a specific directory so that the number of files at the root of any given project can be limited.
 
-It works by appending the directory to the end of any Terraform command run by terraform-pipeline. You can either specify a directory when initializing the plugin, or it will default to the `./terraform/` directory.
+It works by appending `-chdir=<directory>` before any Terraform sub-command (`init`, `plan`, etc.) run by terraform-pipeline. You can either specify a directory when initializing the plugin, or it will default to the `./terraform/` directory.
+
+### Terraform Version Notes
+Previous versions of this plugin would append the directory to the end of the Terraform commands. This has been removed as of Terraform 0.15 and replaced with the `-chdir` argument.
 
 ```
 // Jenkinsfile
diff --git a/src/TerraformApplyCommand.groovy b/src/TerraformApplyCommand.groovy
@@ -7,6 +7,7 @@ class TerraformApplyCommand implements TerraformCommand, Resettable {
     private suffixes = []
     private args = []
     private String directory
+    private boolean chdir_flag = false
     private Closure variablePattern
     private Closure mapPattern
     private static plugins = []
@@ -75,17 +76,25 @@ class TerraformApplyCommand implements TerraformCommand, Resettable {
         return this
     }
 
+    public TerraformApplyCommand withChangeDirectoryFlag() {
+        this.chdir_flag = true
+        return this
+    }
+
     public String toString() {
         applyPlugins()
         def pieces = []
         pieces += prefixes
         pieces << terraformBinary
+        if (directory && chdir_flag) {
+            pieces << "-chdir=${directory}"
+        }
         pieces << command
         if (!input) {
             pieces << "-input=false"
         }
         pieces += args
-        if (directory) {
+        if (directory && !chdir_flag) {
             pieces << directory
         }
 
diff --git a/src/TerraformInitCommand.groovy b/src/TerraformInitCommand.groovy
@@ -8,6 +8,7 @@ class TerraformInitCommand implements TerraformCommand, Resettable {
     private backendConfigs = []
     private boolean doBackend = true
     private String directory
+    private boolean chdir_flag = false
     private static plugins = []
     private appliedPlugins = []
 
@@ -35,6 +36,11 @@ class TerraformInitCommand implements TerraformCommand, Resettable {
         return this
     }
 
+    public TerraformInitCommand withChangeDirectoryFlag() {
+        this.chdir_flag = true
+        return this
+    }
+
     public TerraformInitCommand withBackendConfig(String backendConfig) {
         this.backendConfigs << backendConfig
         return this
@@ -50,6 +56,9 @@ class TerraformInitCommand implements TerraformCommand, Resettable {
         def pieces = []
         pieces += prefixes
         pieces << terraformBinary
+        if (directory && chdir_flag) {
+            pieces << "-chdir=${directory}"
+        }
         pieces << command
         if (!input) {
             pieces << "-input=false"
@@ -61,7 +70,7 @@ class TerraformInitCommand implements TerraformCommand, Resettable {
         } else {
             pieces << "-backend=false"
         }
-        if (directory) {
+        if (directory && !chdir_flag) {
             pieces << directory
         }
 
diff --git a/src/TerraformPlanCommand.groovy b/src/TerraformPlanCommand.groovy
@@ -7,6 +7,7 @@ class TerraformPlanCommand implements TerraformCommand, Resettable {
     private suffixes = []
     private arguments = []
     private String directory
+    private boolean chdir_flag = false
     private String errorFile
     private Closure variablePattern
     private Closure mapPattern
@@ -37,6 +38,11 @@ class TerraformPlanCommand implements TerraformCommand, Resettable {
         return this
     }
 
+    public TerraformPlanCommand withChangeDirectoryFlag() {
+        this.chdir_flag = true
+        return this
+    }
+
     public TerraformPlanCommand withArgument(String argument) {
         this.arguments << argument
         return this
@@ -81,12 +87,15 @@ class TerraformPlanCommand implements TerraformCommand, Resettable {
         def pieces = []
         pieces = pieces + prefixes
         pieces << terraformBinary
+        if (directory && chdir_flag) {
+            pieces << "-chdir=${directory}"
+        }
         pieces << command
         if (!input) {
             pieces << "-input=false"
         }
         pieces += arguments
-        if (directory) {
+        if (directory && !chdir_flag) {
             pieces << directory
         }
 
diff --git a/src/TerraformPlugin.groovy b/src/TerraformPlugin.groovy
@@ -61,11 +61,15 @@ class TerraformPlugin implements TerraformValidateCommandPlugin,
         // if (new SemanticVersion(version) >= new SemanticVersion('0.12.0')) should be used
         // here.  Unit tests pass with the above, but running Jenkinsfile in a pipeline context
         // does not.  Debug statements show that the above will return 0 when it should return 'true'.
-        if ((new SemanticVersion(version) <=> new SemanticVersion('0.12.0')) >= 0) {
+        if ((new SemanticVersion(version) <=> new SemanticVersion('0.15.0')) >= 0) {
+            return new TerraformPluginVersion15()
+        }
+        else if ((new SemanticVersion(version) <=> new SemanticVersion('0.12.0')) >= 0) {
             return new TerraformPluginVersion12()
         }
-
-        return new TerraformPluginVersion11()
+        else {
+            return new TerraformPluginVersion11()
+        }
     }
 
     static void withVersion(String userVersion) {
diff --git a/src/TerraformPluginVersion15.groovy b/src/TerraformPluginVersion15.groovy
@@ -0,0 +1,18 @@
+class TerraformPluginVersion15 extends TerraformPluginVersion12 {
+
+    public void apply(TerraformValidateCommand command) {
+        super.apply(command.withChangeDirectoryFlag())
+    }
+
+    public void apply(TerraformInitCommand command) {
+        super.apply(command.withChangeDirectoryFlag())
+    }
+
+    public void apply(TerraformPlanCommand command) {
+        super.apply(command.withChangeDirectoryFlag())
+    }
+
+    public void apply(TerraformApplyCommand command) {
+        super.apply(command.withChangeDirectoryFlag())
+    }
+}
diff --git a/src/TerraformValidateCommand.groovy b/src/TerraformValidateCommand.groovy
@@ -5,6 +5,7 @@ class TerraformValidateCommand implements Resettable {
     private prefixes = []
     private suffixes = []
     private String directory
+    private boolean chdir_flag = false
     private static plugins = []
     private appliedPlugins = []
 
@@ -31,16 +32,24 @@ class TerraformValidateCommand implements Resettable {
         return this
     }
 
+    public TerraformValidateCommand withChangeDirectoryFlag() {
+        this.chdir_flag = true
+        return this
+    }
+
     public String toString() {
         applyPlugins()
         def pieces = []
         pieces = pieces + prefixes
         pieces << terraformBinary
+        if (directory && chdir_flag) {
+            pieces << "-chdir=${directory}"
+        }
         pieces << command
         for (String argument in arguments) {
             pieces << argument
         }
-        if (directory) {
+        if (directory && !chdir_flag) {
             pieces << directory
         }
         pieces += suffixes
diff --git a/test/TerraformApplyCommandTest.groovy b/test/TerraformApplyCommandTest.groovy
@@ -155,6 +155,15 @@ class TerraformApplyCommandTest {
             def actualCommand = command.toString()
             assertThat(actualCommand, endsWith(" foobar"))
         }
+
+        @Test
+        void addsDirectoryArgumentWithChangeDirectoryFlag() {
+            def command = new TerraformApplyCommand().withDirectory("foobar")
+                                                     .withChangeDirectoryFlag()
+
+            def actualCommand = command.toString()
+            assertThat(actualCommand, containsString(" -chdir=foobar"))
+        }
     }
 
     @Nested
diff --git a/test/TerraformInitCommandTest.groovy b/test/TerraformInitCommandTest.groovy
@@ -90,6 +90,15 @@ class TerraformInitCommandTest {
             def actualCommand = command.toString()
             assertThat(actualCommand, endsWith(" foobar"))
         }
+
+        @Test
+        void addsDirectoryArgumentWithChangeDirectoryFlag() {
+            def command = new TerraformInitCommand().withDirectory("foobar")
+                                                    .withChangeDirectoryFlag()
+
+            def actualCommand = command.toString()
+            assertThat(actualCommand, containsString(" -chdir=foobar"))
+        }
     }
 
     @Nested
diff --git a/test/TerraformPlanCommandTest.groovy b/test/TerraformPlanCommandTest.groovy
@@ -52,6 +52,15 @@ class TerraformPlanCommandTest {
             def actualCommand = command.toString()
             assertThat(actualCommand, endsWith(" foobar"))
         }
+
+        @Test
+        void addsDirectoryArgumentWithChangeDirectoryFlag() {
+            def command = new TerraformPlanCommand().withDirectory("foobar")
+                                                    .withChangeDirectoryFlag()
+
+            def actualCommand = command.toString()
+            assertThat(actualCommand, containsString(" -chdir=foobar"))
+        }
     }
 
     @Nested
diff --git a/test/TerraformPluginTest.groovy b/test/TerraformPluginTest.groovy
@@ -102,12 +102,39 @@ class TerraformPluginTest {
         }
 
         @Test
-        void returnsVersion12ForMoreThan0_12_0() {
+        void returnsVersion15For0_15_0() {
             def plugin = new TerraformPlugin()
 
-            def foundStrategy = plugin.strategyFor('0.12.3')
+            def foundStrategy = plugin.strategyFor('0.15.0')
 
-            assertThat(foundStrategy, instanceOf(TerraformPluginVersion12.class))
+            assertThat(foundStrategy, instanceOf(TerraformPluginVersion15.class))
+        }
+
+        @Test
+        void returnsVersion15ForMoreThan0_15_0() {
+            def plugin = new TerraformPlugin()
+
+            def foundStrategy = plugin.strategyFor('0.15.4')
+
+            assertThat(foundStrategy, instanceOf(TerraformPluginVersion15.class))
+        }
+
+        @Test
+        void returnsVersion15For1_0_0() {
+            def plugin = new TerraformPlugin()
+
+            def foundStrategy = plugin.strategyFor('1.0.0')
+
+            assertThat(foundStrategy, instanceOf(TerraformPluginVersion15.class))
+        }
+
+        @Test
+        void returnsVersion15ForMoreThan1_0_0() {
+            def plugin = new TerraformPlugin()
+
+            def foundStrategy = plugin.strategyFor('1.1.4')
+
+            assertThat(foundStrategy, instanceOf(TerraformPluginVersion15.class))
         }
 
     }
diff --git a/test/TerraformPluginVersion15Test.groovy b/test/TerraformPluginVersion15Test.groovy
@@ -0,0 +1,69 @@
+import static org.hamcrest.Matchers.containsString
+import static org.hamcrest.MatcherAssert.assertThat
+import org.junit.jupiter.api.Nested
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.extension.ExtendWith
+
+@ExtendWith(ResetStaticStateExtension.class)
+class TerraformPluginVersion15Test {
+    @Nested
+    class ModifiesTerraformValidateCommand {
+        @Test
+        void toUseTerraform15CliSyntaxForDirectory() {
+            def validate = new TerraformValidateCommand()
+            def version15 = new TerraformPluginVersion15()
+
+            version15.apply(validate)
+            validate.withDirectory('foobar')
+            def result = validate.toString()
+
+            assertThat(result, containsString(" -chdir=foobar"))
+        }
+    }
+
+    @Nested
+    class ModifiesTerraformInitCommand {
+        @Test
+        void toUseTerraform15CliSyntaxForDirectory() {
+            def init = new TerraformInitCommand()
+            def version15 = new TerraformPluginVersion15()
+
+            version15.apply(init)
+            init.withDirectory('foobar')
+            def result = init.toString()
+
+            assertThat(result, containsString(" -chdir=foobar"))
+        }
+    }
+
+    @Nested
+    class ModifiesTerraformPlanCommand {
+        @Test
+        void toUseTerraform15CliSyntaxForDirectory() {
+            def plan = new TerraformPlanCommand()
+            def version15 = new TerraformPluginVersion15()
+
+            version15.apply(plan)
+            plan.withDirectory('foobar')
+            def result = plan.toString()
+
+            assertThat(result, containsString(" -chdir=foobar"))
+        }
+    }
+
+    @Nested
+    class ModifiesTerraformApplyCommand {
+        @Test
+        void toUseTerraform15CliSyntaxForDirectory() {
+            def apply = new TerraformApplyCommand()
+            def version15 = new TerraformPluginVersion15()
+
+            version15.apply(apply)
+            apply.withDirectory('foobar')
+            def result = apply.toString()
+
+            assertThat(result, containsString(" -chdir=foobar"))
+        }
+    }
+}
+
diff --git a/test/TerraformValidateCommandTest.groovy b/test/TerraformValidateCommandTest.groovy
@@ -1,3 +1,4 @@
+import static org.hamcrest.Matchers.containsString
 import static org.hamcrest.MatcherAssert.assertThat
 import static org.hamcrest.Matchers.endsWith
 import static org.hamcrest.Matchers.startsWith
@@ -20,6 +21,15 @@ class TerraformValidateCommandTest {
             def actualCommand = command.toString()
             assertThat(actualCommand, endsWith(" foobar"))
         }
+
+        @Test
+        void addsDirectoryArgumentWithChangeDirectoryFlag() {
+            def command = new TerraformValidateCommand().withDirectory("foobar")
+                                                        .withChangeDirectoryFlag()
+
+            def actualCommand = command.toString()
+            assertThat(actualCommand, containsString(" -chdir=foobar"))
+        }
     }
 
     @Nested
