Merge pull request #118 from buildkite-plugins/toote_cleanup

Some cleanup

Author: pzeballos

hooks/post-command

@@ -62,6 +62,12 @@ for LEVEL in "${SAVE_LEVELS[@]}"; do
     echo "Saving ${LEVEL}-level cache of ${CACHE_PATH}"
     if compression_active && [ "${already_compressed:-false}" = 'false' ]; then
       ACTUAL_PATH=$(mktemp)
+
+      # TERM in case it is cancelled
+      # EXIT when the script ends
+      # shellcheck disable=SC2064 # we want the expansion to happen now
+      trap "cleanup_compression_tempfile '${ACTUAL_PATH}'" TERM EXIT
+
       compress "${CACHE_PATH}" "${ACTUAL_PATH}"
       already_compressed='true' # avoid re-compressing the files
     fi
@@ -71,10 +77,3 @@ for LEVEL in "${SAVE_LEVELS[@]}"; do
     echo "Cache of ${LEVEL} already exists, skipping"
   fi
 done
-
-# remove temporary compressed artifacts
-if [ "$(plugin_read_config KEEP_COMPRESSED_ARTIFACTS 'false')" = 'false' ]; then
-  if compression_active && [ "${already_compressed:-false}" == 'true' ] && [ -e "${ACTUAL_PATH}" ]; then
-    rm -rf "${ACTUAL_PATH}"
-  fi
-fi

hooks/pre-command

@@ -41,18 +41,21 @@ for CURRENT_LEVEL in "${SORTED_LEVELS[@]}"; do
 
     if compression_active; then
       TEMP_PATH=$(mktemp)
+
+      # TERM in case it is cancelled
+      # EXIT when the script ends
+      # shellcheck disable=SC2064 # we want the expansion to happen now
+      trap "cleanup_compression_tempfile '${TEMP_PATH}'" TERM  EXIT
+
       backend_exec get "${KEY}" "${TEMP_PATH}"
       decompress "${TEMP_PATH}" "${RESTORE_PATH}"
-      if [ "$(plugin_read_config KEEP_COMPRESSED_ARTIFACTS 'false')" = 'false' ]; then
-        rm -rf "${TEMP_PATH}"
-      fi
     else
       backend_exec get "${KEY}" "${RESTORE_PATH}"
     fi
 
     exit 0
   elif [ "${CURRENT_LEVEL}" = "${MAX_LEVEL}" ]; then
-    echo "Cache miss up to ${CURRENT_LEVEL}-level, sorry"
+    echo "Cache miss up to ${CURRENT_LEVEL}-level for ${RESTORE_PATH}, sorry"
     break
   fi
 done

lib/compression.bash

@@ -37,3 +37,11 @@ decompress() {
     PATH="${PATH}:${DIR}/../compression" "${COMPRESSION}_wrapper" "decompress" "${FILE}" "${RESTORE_PATH}"
   fi
 }
+
+cleanup_compression_tempfile() {
+  FILE="$1"
+
+  if [ "$(plugin_read_config KEEP_COMPRESSED_ARTIFACTS 'false')" = 'false' ]; then
+    rm -rf "${FILE}"
+  fi
+}

tests/compression.bats

@@ -81,3 +81,27 @@ setup() {
 
   unstub dummy_decompress_wrapper
 }
+
+@test 'cleanup_compression_tempfile works' {
+  touch temp_file
+
+  # by default it removes the file
+  run cleanup_compression_tempfile temp_file
+  assert_success
+  assert [ ! -e  temp_file ]
+
+  # if we want to keep the file, it should not be removed
+  export BUILDKITE_PLUGIN_CACHE_KEEP_COMPRESSED_ARTIFACTS=true
+  touch temp_file
+
+  run cleanup_compression_tempfile temp_file
+  assert_success
+  assert [ -e  temp_file ]
+
+  # but we can also ask specifically to have it removed
+  export BUILDKITE_PLUGIN_CACHE_KEEP_COMPRESSED_ARTIFACTS=false
+
+  run cleanup_compression_tempfile temp_file
+  assert_success
+  assert [ ! -e  temp_file ]
+}

tests/pre-command.bats

@@ -69,7 +69,7 @@ teardown() {
   run "$PWD/hooks/pre-command"
 
   assert_success
-  assert_output --partial 'Cache miss up to file-level, sorry'
+  assert_output --partial 'Cache miss up to file-level'
 
   unstub cache_dummy
 }
@@ -84,7 +84,7 @@ teardown() {
   run "$PWD/hooks/pre-command"
 
   assert_success
-  assert_output --partial 'Cache miss up to step-level, sorry'
+  assert_output --partial 'Cache miss up to step-level'
 
   unstub cache_dummy
 }
@@ -99,7 +99,7 @@ teardown() {
   run "$PWD/hooks/pre-command"
 
   assert_success
-  assert_output --partial 'Cache miss up to step-level, sorry'
+  assert_output --partial 'Cache miss up to step-level'
 
   unstub cache_dummy
 }
@@ -115,7 +115,7 @@ teardown() {
   run "$PWD/hooks/pre-command"
 
   assert_success
-  assert_output --partial 'Cache miss up to branch-level, sorry'
+  assert_output --partial 'Cache miss up to branch-level'
 
   unstub cache_dummy
 }
@@ -131,7 +131,7 @@ teardown() {
   run "$PWD/hooks/pre-command"
 
   assert_success
-  assert_output --partial 'Cache miss up to pipeline-level, sorry'
+  assert_output --partial 'Cache miss up to pipeline-level'
 
   unstub cache_dummy
 }
@@ -149,7 +149,7 @@ teardown() {
   run "$PWD/hooks/pre-command"
 
   assert_success
-  assert_output --partial 'Cache miss up to all-level, sorry'
+  assert_output --partial 'Cache miss up to all-level'
 
   unstub cache_dummy
 }