Added tests for download var expansion

Author: toote

tests/download-compressed.bats

@@ -8,7 +8,7 @@ load "${BATS_PLUGIN_PATH}/load.bash"
 @test "Invalid compressed format" {
   export BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD="file.log"
   export BUILDKITE_PLUGIN_ARTIFACTS_COMPRESSED="file.rar"
-  
+
   run "$PWD/hooks/pre-command"
 
   assert_failure
@@ -22,7 +22,7 @@ load "${BATS_PLUGIN_PATH}/load.bash"
 @test "Single value zip" {
   export BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD="*.log"
   export BUILDKITE_PLUGIN_ARTIFACTS_COMPRESSED="file.zip"
-  
+
   stub buildkite-agent \
     "artifact download \* \* : echo downloaded \$3 to \$4"
 
@@ -46,7 +46,7 @@ load "${BATS_PLUGIN_PATH}/load.bash"
 @test "Single value tgz" {
   export BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD="*.log"
   export BUILDKITE_PLUGIN_ARTIFACTS_COMPRESSED="file.tgz"
-  
+
   stub buildkite-agent \
     "artifact download \* \* : echo downloaded \$3 to \$4"
 
@@ -230,7 +230,7 @@ load "${BATS_PLUGIN_PATH}/load.bash"
 
   unstub buildkite-agent
   unstub tar
-  
+
   unset BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD
   unset BUILDKITE_PLUGIN_ARTIFACTS_BUILD
   unset BUILDKITE_PLUGIN_ARTIFACTS_COMPRESSED
@@ -402,4 +402,117 @@ load "${BATS_PLUGIN_PATH}/load.bash"
   unset BUILDKITE_PLUGIN_ARTIFACTS_UPLOAD_TO
   unset BUILDKITE_PLUGIN_ARTIFACTS_UPLOAD_0_FROM
   unset BUILDKITE_PLUGIN_ARTIFACTS_UPLOAD_0_TO
-}
+}
+
+@test "Pre-command does not replace compressed file variables" {
+  export RANDOM_VAR="random-value"
+  export BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD="bar.log"
+  export BUILDKITE_PLUGIN_ARTIFACTS_COMPRESSED="FILE-\${RANDOM_VAR}.zip"
+
+  stub buildkite-agent \
+    "artifact download \* \* : echo downloaded artifact \$3 to \$4"
+
+  run "$PWD/hooks/pre-command"
+
+  assert_failure
+  refute_output --partial "downloaded artifact FILE-random-value.zip"
+  assert_output --partial "downloaded artifact FILE-\${RANDOM_VAR}.zip"
+
+  unstub buildkite-agent
+
+  unset BUILDKITE_PLUGIN_ARTIFACTS_COMPRESSED
+  unset BUILDKITE_PLUGIN_ARTIFACTS_EXPAND_UPLOAD_VARS
+}
+
+@test "Pre-command replaces compressed file variables" {
+  export RANDOM_VAR="random-value"
+  export OTHER_VAR="other-value"
+  export BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD="bar-\${OTHER_VAR}.log"
+  export BUILDKITE_PLUGIN_ARTIFACTS_COMPRESSED="FILE-\${RANDOM_VAR}.zip"
+  export BUILDKITE_PLUGIN_ARTIFACTS_EXPAND_DOWNLOAD_VARS="true"
+
+  stub buildkite-agent \
+    "artifact download \* \* : echo downloaded artifact \$3 to \$4"
+
+  stub unzip \
+    "\* \* : echo extracted \$2 from \$1; touch \$2"
+
+  run "$PWD/hooks/pre-command"
+
+  assert_success
+  assert_output --partial "downloaded artifact FILE-random-value.zip"
+  assert_output --partial "Uncompressing bar-other-value.log from FILE-random-value.zip"
+
+  unstub buildkite-agent
+  unstub unzip
+
+  unset BUILDKITE_PLUGIN_ARTIFACTS_COMPRESSED
+  unset BUILDKITE_PLUGIN_ARTIFACTS_EXPAND_UPLOAD_VARS
+}
+
+@test "Pre-command replaces file variables with relocation" {
+  export RANDOM_VAR="random-value"
+  export OTHER_VAR="other-value"
+  export DEST_VAR="dest-value"
+  export BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD_FROM="/tmp/bar-\${OTHER_VAR}.log"
+  export BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD_TO="/tmp/baz-\${DEST_VAR}.log"
+  export BUILDKITE_PLUGIN_ARTIFACTS_COMPRESSED="FILE-\${RANDOM_VAR}.zip"
+  export BUILDKITE_PLUGIN_ARTIFACTS_EXPAND_DOWNLOAD_VARS="true"
+
+  stub buildkite-agent \
+    "artifact download \* \* : echo downloaded artifact \$3 to \$4"
+
+  stub unzip \
+    "\* \* : echo extracted \$2 from \$1; touch \$2"
+
+  run "$PWD/hooks/pre-command"
+
+  assert_success
+  assert_output --partial "downloaded artifact FILE-random-value.zip"
+  assert_output --partial "Uncompressing /tmp/bar-other-value.log from FILE-random-value.zip"
+  assert_output --partial "Moving [/tmp/bar-other-value.log] to [/tmp/baz-dest-value.log]"
+
+  assert [ ! -e /tmp/bar-other-value.log ]
+  assert [ -e /tmp/baz-dest-value.log ]
+  rm /tmp/baz-dest-value.log
+
+  unstub buildkite-agent
+  unstub unzip
+
+  unset BUILDKITE_PLUGIN_ARTIFACTS_COMPRESSED
+  unset BUILDKITE_PLUGIN_ARTIFACTS_EXPAND_UPLOAD_VARS
+}
+
+@test "Pre-command replaces file variables with multiple files with relocation sometimes" {
+  export RANDOM_VAR="random-value"
+  export OTHER_VAR="other-value"
+  export DEST_VAR="dest-value"
+  export BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD_0="/tmp/bar.log"
+  export BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD_1_FROM="/tmp/bar-\${OTHER_VAR}.log"
+  export BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD_1_TO="/tmp/baz-\${DEST_VAR}.log"
+  export BUILDKITE_PLUGIN_ARTIFACTS_COMPRESSED="FILE-\${RANDOM_VAR}.zip"
+  export BUILDKITE_PLUGIN_ARTIFACTS_EXPAND_DOWNLOAD_VARS="true"
+
+  stub buildkite-agent \
+    "artifact download \* \* : echo downloaded artifact \$3 to \$4"
+
+  stub unzip \
+    "\* \* \* : echo extracted \$2 and \$3 from \$1; touch \$2 \$3"
+
+  run "$PWD/hooks/pre-command"
+
+  assert_success
+  assert_output --partial "downloaded artifact FILE-random-value.zip"
+  assert_output --partial "Uncompressing /tmp/bar.log /tmp/bar-other-value.log from FILE-random-value.zip"
+  assert_output --partial "Moving [/tmp/bar-other-value.log] to [/tmp/baz-dest-value.log]"
+
+  assert [ ! -e /tmp/bar-other-value.log ]
+  assert [ -e /tmp/baz-dest-value.log ]
+  rm /tmp/baz-dest-value.log
+
+  unstub buildkite-agent
+  unstub unzip
+
+  unset BUILDKITE_PLUGIN_ARTIFACTS_COMPRESSED
+  unset BUILDKITE_PLUGIN_ARTIFACTS_EXPAND_UPLOAD_VARS
+}

tests/download.bats

@@ -263,7 +263,7 @@ load "${BATS_PLUGIN_PATH}/load.bash"
 
 @test "Pre-command does nothing if there is no download-specific vars setup" {
   run "$PWD/hooks/pre-command"
-  
+
   assert_success
   refute_output --partial "Downloading artifacts"
 }
@@ -287,4 +287,71 @@ load "${BATS_PLUGIN_PATH}/load.bash"
   unset BUILDKITE_PLUGIN_ARTIFACTS_UPLOAD_TO
   unset BUILDKITE_PLUGIN_ARTIFACTS_UPLOAD_0_FROM
   unset BUILDKITE_PLUGIN_ARTIFACTS_UPLOAD_0_TO
-}
+}
+
+@test "Pre-command does not expand variables by default" {
+  export RANDOM_VAR="random-var"
+  export BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD="file-\${RANDOM_VAR}.log"
+
+  stub buildkite-agent \
+    "artifact download \* \* : echo can not download artifact \$3 to \$4; exit 1"
+
+  run "$PWD/hooks/pre-command"
+
+  assert_failure
+  assert_output --partial "Error in download of file-\${RANDOM_VAR}.log"
+  refute_output --partial "file-random-var.log to ."
+
+  unstub buildkite-agent
+  unset BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD
+  unset BUILDKITE_PLUGIN_ARTIFACTS_EXPAND_DOWNLOAD_VARS
+}
+
+@test "Pre-command downloads artifacts with expansion" {
+  export RANDOM_VAR="random-var"
+  export BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD="\${RANDOM_VAR}.log"
+  export BUILDKITE_PLUGIN_ARTIFACTS_EXPAND_DOWNLOAD_VARS="true"
+
+  stub buildkite-agent \
+    "artifact download \* \* : echo downloaded artifact \$3 to \$4"
+
+  run "$PWD/hooks/pre-command"
+
+  assert_success
+  assert_output --partial "Downloading artifacts"
+  assert_output --partial "downloaded artifact random-var.log to ."
+
+  unstub buildkite-agent
+  unset BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD
+  unset BUILDKITE_PLUGIN_ARTIFACTS_EXPAND_DOWNLOAD_VARS
+}
+
+@test "Pre-command downloads multiple artifacts with expansion and relocation" {
+  export RANDOM_VAR="random-var"
+  export DEST_VAR="dest-var"
+  export BUILDKITE_PLUGIN_ARTIFACTS_EXPAND_DOWNLOAD_VARS="true"
+  export BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD_0="file.log"
+  export BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD_1_FROM="file-\${RANDOM_VAR}.log"
+  export BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD_1_TO="dest-\${DEST_VAR}.log"
+
+  stub buildkite-agent \
+    "artifact download \* \* : echo downloaded artifact \$3 to \$4; touch \$3" \
+    "artifact download \* \* : echo downloaded artifact \$3 to \$4; touch \$3"
+
+  run "$PWD/hooks/pre-command"
+
+  assert_success
+  assert_output --partial "Downloading artifacts"
+  assert_output --partial "downloaded artifact file-random-var.log to ."
+  assert_output --partial "Moving [file-random-var.log] to [dest-dest-var.log]"
+
+  assert [ -e file.log ]
+  assert [ -e dest-dest-var.log ]
+  assert [ ! -e file-random-var.log ]
+
+  rm file.log dest-dest-var.log
+
+  unstub buildkite-agent
+  unset BUILDKITE_PLUGIN_ARTIFACTS_DOWNLOAD
+  unset BUILDKITE_PLUGIN_ARTIFACTS_EXPAND_DOWNLOAD_VARS
+}