Merge pull request #22 from gruntwork-io/yori-allow-delete-provisioner

Destroy provisioner

Author: yorinasub17

examples/pex/main.tf

@@ -45,6 +45,11 @@ module "pex_resource" {
     RUN_PEX_TEST_ENV = var.echo_string
   }
 
+  enable_destroy_provisioner = true
+  destroy_command_args       = "--is-delete"
+  pass_in_previous_triggers  = true
+  previous_trigger_option    = "--triggers-json"
+
   enabled = var.enabled
 }
 

examples/pex/sample-python-script/sample_python_script/main.py

@@ -7,18 +7,31 @@
 
 @click.command()
 @click.option("--is-data/--no-is-data", default=False, help="Whether or not this is run as a data source")
-def main(is_data):
+@click.option("--is-delete/--no-is-delete", default=False, help="Whether or not this is run as a delete provisioner")
+@click.option("--triggers-json", help="JSON encoded triggers for the resource")
+def main(is_data, is_delete, triggers_json):
     if is_data:
         query = json.loads(sys.stdin.read())
-        print(json.dumps({
-            "echo": query.get("echo", ""),
-            "out": "This was successfully run as data source.",
-            "python_version_info": str(sys.version_info),
-        }))
+        print(
+            json.dumps(
+                {
+                    "echo": query.get("echo", ""),
+                    "out": "This was successfully run as data source.",
+                    "python_version_info": str(sys.version_info),
+                    "triggers": triggers_json,
+                }
+            )
+        )
+    elif is_delete:
+        print("python version: {}".format(sys.version_info))
+        print("This was successfully run as a ___DELETE___ local-exec provisioner")
+        print("Environment variable: {}".format(os.environ.get("RUN_PEX_TEST_ENV", None)))
+        print("Triggers: {}".format(triggers_json))
     else:
         print("python version: {}".format(sys.version_info))
         print("This was successfully run as a local-exec provisioner")
         print("Environment variable: {}".format(os.environ.get("RUN_PEX_TEST_ENV", None)))
+        print("Triggers: {}".format(triggers_json))
 
 
 if __name__ == "__main__":

modules/run-pex-as-resource/main.tf

@@ -21,8 +21,23 @@ resource "null_resource" "run_pex" {
   triggers = var.triggers
 
   provisioner "local-exec" {
-    command = "python ${module.pex_env.pex_path} ${module.pex_env.entrypoint_path} ${var.script_main_function} ${var.command_args}"
+    command = "${local.python_call} ${var.command_args}"
+    environment = merge(
+      {
+        PYTHONPATH = module.pex_env.python_path
+      },
+      var.env,
+    )
+  }
 
+  provisioner "local-exec" {
+    when = destroy
+    command = (
+      var.enable_destroy_provisioner
+      # NOTE: The nested string interpolation can not be extracted because of the reference to self.
+      ? "${local.python_call} ${var.destroy_command_args} ${var.pass_in_previous_triggers ? "${var.previous_trigger_option} '${jsonencode(self.triggers != null ? self.triggers : {})}'" : ""}"
+      : "echo 'Skipping delete provisioner'"
+    )
     environment = merge(
       {
         PYTHONPATH = module.pex_env.python_path
@@ -31,3 +46,7 @@ resource "null_resource" "run_pex" {
     )
   }
 }
+
+locals {
+  python_call = "python ${module.pex_env.pex_path} ${module.pex_env.entrypoint_path} ${var.script_main_function}"
+}

modules/run-pex-as-resource/variables.tf

@@ -32,6 +32,14 @@ variable "command_args" {
   default = ""
 }
 
+variable "destroy_command_args" {
+  description = "The arguments to pass to the command as a string on delete"
+  type        = string
+
+  # We don't use null here because this is interpolated into the python script.
+  default = ""
+}
+
 variable "triggers" {
   description = "A map of arbitrary strings that, when changed, will force the null resource to be replaced, re-running any associated provisioners."
   type        = map(string)
@@ -49,3 +57,21 @@ variable "enabled" {
   type        = bool
   default     = true
 }
+
+variable "enable_destroy_provisioner" {
+  description = "If you set this variable to true, the same command will be called on destroy with the args specified in destroy_command_args."
+  type        = bool
+  default     = false
+}
+
+variable "pass_in_previous_triggers" {
+  description = "If you set this variable to true, this module will pass in the json encoded triggers that were used when the resource was created. If the script expects option args, use var.previous_trigger_option to set which option to pass the triggers json as."
+  type        = bool
+  default     = false
+}
+
+variable "previous_trigger_option" {
+  description = "Pass in the json encoded trigger with this string as the option to passing into the command. E.g, setting this to `--triggers` will pass in the option `--triggers TRIGGERS_JSON`."
+  type        = string
+  default     = ""
+}

test/pex_test.go

@@ -7,7 +7,7 @@ import (
 
 	"github.com/gruntwork-io/terratest/modules/random"
 	"github.com/gruntwork-io/terratest/modules/terraform"
-	"github.com/gruntwork-io/terratest/modules/test-structure"
+	test_structure "github.com/gruntwork-io/terratest/modules/test-structure"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -16,7 +16,10 @@ func TestRunPex(t *testing.T) {
 
 	testFolder := test_structure.CopyTerraformFolderToTemp(t, "..", "examples")
 	terratestOptions := createBaseTerratestOptions(t, filepath.Join(testFolder, "pex"))
-	defer terraform.Destroy(t, terratestOptions)
+	defer func() {
+		destroyOut := terraform.Destroy(t, terratestOptions)
+		assert.Contains(t, destroyOut, "___DELETE___")
+	}()
 
 	expectedFoo := random.UniqueId()
 	terratestOptions.Vars = map[string]interface{}{
@@ -34,9 +37,18 @@ func TestRunPexTriggers(t *testing.T) {
 
 	testFolder := test_structure.CopyTerraformFolderToTemp(t, "..", "examples")
 	terratestOptions := createBaseTerratestOptions(t, filepath.Join(testFolder, "pex"))
-	defer terraform.Destroy(t, terratestOptions)
-
 	expectedFoo := random.UniqueId()
+
+	defer func() {
+		// Remove triggers from the passed in vars to ensure the unique string is not passed in on destroy. This way, we
+		// can validate that the triggers option is indeed coming from the triggers stored in the state file.
+		delete(terratestOptions.Vars, "triggers")
+
+		destroyOut := terraform.Destroy(t, terratestOptions)
+		assert.Contains(t, destroyOut, "___DELETE___")
+		assert.Contains(t, destroyOut, expectedFoo)
+	}()
+
 	terratestOptions.Vars = map[string]interface{}{
 		"echo_string": expectedFoo,
 		"triggers": map[string]string{