fix: simplify check module

The `check` module now accepts `command` and `args`, which is more
familiar than `program`. It also returns `exitcode`, `error` and
`output`, which are useful for debugging.

integration/scripts/check_bucket_not_empty

@@ -3,6 +3,7 @@ set -euo pipefail
 
 DIE() { echo "$*" 1>&2; exit 1; }
 
-[[ ! -z "${SOURCE}" ]] || DIE "source not set"
+[[ ! -z "${SOURCE:-}" ]] || DIE "source not set"
 
+echo "listing ${SOURCE}"
 [[ ! -z $(aws s3 ls ${SOURCE}) ]] || DIE "bucket is empty"

integration/scripts/check_object_copy

@@ -18,24 +18,9 @@ TMPNAME=$(basename ${TMPFILE})
 
 echo "{\"hello\": \"world\"}" > "$TMPFILE"
 
-aws s3 cp ${TMPFILE} s3://${SOURCE} --content-type application/json 1>&2
-if [ $? -ne 0 ]; then
-    DIE "failed to copy file to source"
-fi
-
-ORIGINAL=$(aws s3api head-object --bucket ${SOURCE} --key ${TMPNAME} | jq 'del(.LastModified)')
-if [ $? -ne 0 ]; then
-    DIE "failed to read file from source"
-fi
-
-
-COPY=$(aws s3api head-object --bucket ${DESTINATION} --key ${TMPNAME} | jq 'del(.LastModified)')
-if [ $? -ne 0 ]; then
-    DIE "failed to read file from destination"
-fi
-
-if [ "$ORIGINAL" = "$COPY" ]; then
-    echo "ok"
-else
-    DIE "object differs"
-fi
+aws s3 cp ${TMPFILE} s3://${SOURCE} --content-type application/json 1>&2 || DIE "failed to copy file to source"
+
+ORIGINAL=$(aws s3api head-object --bucket ${SOURCE} --key ${TMPNAME} | jq 'del(.LastModified)' || DIE "failed to read file from source")
+COPY=$(aws s3api head-object --bucket ${DESTINATION} --key ${TMPNAME} | jq 'del(.LastModified)' || DIE "failed to read file from destination")
+
+[ "$ORIGINAL" = "$COPY" ] || DIE "object differs"

integration/tests/check/main.tf

@@ -1,4 +1,4 @@
 data "external" "check" {
-  program = concat(["${path.module}/run"], var.program)
+  program = concat(["${path.module}/run"], [var.command], var.args)
   query   = var.env_vars
 }

integration/tests/check/outputs.tf

@@ -1,3 +1,11 @@
-output "result" {
-  value = data.external.check.result
+output "error" {
+  value = data.external.check.result.error
+}
+
+output "exitcode" {
+  value = tonumber(data.external.check.result.exitcode)
+}
+
+output "output" {
+  value = data.external.check.result.output
 }

integration/tests/check/run

@@ -21,5 +21,6 @@ if [ $RESULT -ne 0 ]; then
     ERROR=$(echo -n "$OUTPUT" | tail -n1 | jq -Rsa .)
 fi
 
+# terraform external data source expects all arguments to be strings
+echo "{\"error\": ${ERROR}, \"exitcode\": \"${RESULT}\", \"output\": $(echo -n "$OUTPUT" | jq -Rsa .)}"
 # always return 0, let caller decide if error message warrants any action
-echo "{\"error\": ${ERROR}}"

integration/tests/check/variables.tf

@@ -1,15 +1,19 @@
-variable "program" {
+variable "command" {
   description = <<-EOF
-    A list of strings, whose first element is the program to run and whose
-    subsequent elements are optional command line arguments to the program.
-    Terraform does not execute the program through a shell, so it is not
-    necessary to escape shell metacharacters nor add quotes around arguments
-    containing spaces.
+    Command to execute
   EOF
-  type        = list(string)
+  type        = string
   nullable    = false
 }
 
+variable "args" {
+  description = <<-EOF
+    Command line arguments
+  EOF
+  type        = list(string)
+  nullable    = false
+  default     = []
+}
 variable "env_vars" {
   description = <<-EOF
     Environment variables

integration/tests/forwarder.tftest.hcl

@@ -20,6 +20,25 @@ run "install_forwarder" {
   }
 }
 
+run "check_file_not_copied" {
+  module {
+    source = "./tests/check"
+  }
+
+  variables {
+    command = "./scripts/check_object_copy"
+    env_vars = {
+      SOURCE      = run.setup.source.bucket
+      DESTINATION = run.setup.destination.bucket
+    }
+  }
+
+  assert {
+    condition     = output.result.error == "failed to read file from destination"
+    error_message = "Unexpected error"
+  }
+}
+
 run "subscribe_bucket_notifications_to_sqs" {
   module {
     source = "./tests/bucket_subscription"
@@ -31,13 +50,13 @@ run "subscribe_bucket_notifications_to_sqs" {
   }
 }
 
-run "check" {
+run "check_copy_succeeds" {
   module {
     source = "./tests/check"
   }
 
   variables {
-    program  = ["./scripts/check_object_copy"]
+    command  = "./scripts/check_object_copy"
     env_vars = {
       SOURCE      = run.setup.source.bucket
       DESTINATION = run.setup.destination.bucket

integration/tests/simple.tftest.hcl

@@ -10,14 +10,14 @@ run "check" {
   }
 
   variables {
-    program = ["./scripts/check_bucket_not_empty"]
+    command = "./scripts/check_bucket_not_empty"
     env_vars = {
       SOURCE = run.setup.source.bucket
     }
   }
 
   assert {
-    condition     = output.result.error == ""
+    condition     = output.exitcode == 0
     error_message = "Bucket not empty check failed"
   }
 }