Merge pull request #317 from jantman/issues/316

Fixes #316 - implement more granular decorations in TerraformEnvironmentStage

Author: kmanning

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Unreleased
 
 * [Issue #311](https://github.com/manheim/terraform-pipeline/issues/311) Fix non-deterministic test failures
+* [Issue #316](https://github.com/manheim/terraform-pipeline/issues/316) Implement more granular decorations in TerraformEnvironmentStage.
 
 # v5.12
 

docs/TerraformEnvironmentStage.md

@@ -41,4 +41,10 @@ def deployProd = new TerraformEnvironmentStage('prod').withEnv('KEY_03', 'VALUE_
 validate.then(deployQA)
         .then(deployProd)
         .build()
-```
+```
+
+### For Plugin Developers
+
+#### Decorate Stages/Commands or Hook before/after command execution
+
+TerraformEnvironmentStage has support for numerous decorators, to allow wrapping the various stages, steps, and individual commands. Please see the [source code](../src/TerraformEnvironmentStage.groovy) for details.

src/TerraformEnvironmentStage.groovy

@@ -9,9 +9,12 @@ class TerraformEnvironmentStage implements Stage, DecoratableStage {
     private static Closure stageNamePattern
 
     public static final String ALL = 'all'
+    public static final String INIT_COMMAND = 'init-command'
     public static final String PLAN = 'plan'
+    public static final String PLAN_COMMAND = 'plan-command'
     public static final String CONFIRM = 'confirm'
     public static final String APPLY = 'apply'
+    public static final String APPLY_COMMAND = 'apply-command'
 
     TerraformEnvironmentStage(String environment) {
         this.environment = environment
@@ -60,8 +63,12 @@ class TerraformEnvironmentStage implements Stage, DecoratableStage {
                 decorations.apply(ALL) {
                     stage(getStageNameFor(PLAN)) {
                         decorations.apply(PLAN) {
-                            sh initCommand.toString()
-                            sh planCommand.toString()
+                            decorations.apply(INIT_COMMAND) {
+                                sh initCommand.toString()
+                            }
+                            decorations.apply(PLAN_COMMAND) {
+                                sh planCommand.toString()
+                            }
                         }
                     }
 
@@ -78,8 +85,12 @@ class TerraformEnvironmentStage implements Stage, DecoratableStage {
                         // The stage name needs to be editable
                         stage(getStageNameFor(APPLY)) {
                             decorations.apply(APPLY) {
-                                sh initCommand.toString()
-                                sh applyCommand.toString()
+                                decorations.apply(INIT_COMMAND) {
+                                    sh initCommand.toString()
+                                }
+                                decorations.apply(APPLY_COMMAND) {
+                                    sh applyCommand.toString()
+                                }
                             }
                         }
                     }