Merge pull request #68 from buildkite-plugins/toote_fs_backend_fixes

FS debugging and logging

Author: pzeballos

backends/cache_fs

@@ -3,6 +3,12 @@ set -euo pipefail
 
 CACHE_FOLDER="${BUILDKITE_PLUGIN_FS_CACHE_FOLDER:-/var/cache/buildkite}"
 
+if ! [ -d "${CACHE_FOLDER}" ]; then
+  echo "Cache folder ${CACHE_FOLDER} does not exist"
+  echo 'Is the BUILDKITE_PLUGIN_FS_CACHE_FOLDER variable setup correctly?'
+  exit 1
+fi
+
 DIR="$(cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd)"
 
 # shellcheck source=lib/lock.bash
@@ -53,4 +59,4 @@ elif [ "$OPCODE" = 'save' ]; then
   save_cache "$@"
 else
   exit 255
-fi
+fi

lib/lock.bash

@@ -15,7 +15,7 @@ wait_and_lock () {
 
   for ATTEMPT in $(seq 1 "${max_attempts}"); do
     if ! lock "${1}"; then
-      echo 'Waiting for folder lock'
+      echo "Waiting for folder lock ${file}"
       sleep "${ATTEMPT}"
     else
       return 0

tests/cache_fs.bats

@@ -6,7 +6,7 @@
 setup() {
   load "${BATS_PLUGIN_PATH}/load.bash"
 
-  export BUILDKITE_PLUGIN_FS_CACHE_FOLDER=/tmp/fs-test
+  export BUILDKITE_PLUGIN_FS_CACHE_FOLDER="/${BATS_TEST_TMPDIR}/fs-test"
   mkdir -p "${BUILDKITE_PLUGIN_FS_CACHE_FOLDER}"
   touch "${BUILDKITE_PLUGIN_FS_CACHE_FOLDER}/existing_file"
   mkdir "${BUILDKITE_PLUGIN_FS_CACHE_FOLDER}/existing_folder"
@@ -23,6 +23,16 @@ teardown() {
   assert_output ''
 }
 
+@test "Backend fails if cache folder does not exist" {
+  export BUILDKITE_PLUGIN_FS_CACHE_FOLDER=/does/not/exist
+
+  run "${PWD}/backends/cache_fs" exists whatever
+
+  assert_failure 1
+  assert_output --partial 'Cache folder /does/not/exist does not exist'
+  assert_output --partial 'BUILDKITE_PLUGIN_FS_CACHE_FOLDER variable'
+}
+
 @test 'Exists on non-existing file fails' {
   run "${PWD}/backends/cache_fs" exists PATH/THAT/DOES/NOT/EXIST
 
@@ -38,7 +48,7 @@ teardown() {
 }
 
 @test 'Exists on existing folder works' {
-  run "${PWD}/backends/cache_fs" exists existing_folder 
+  run "${PWD}/backends/cache_fs" exists existing_folder
 
   assert_success
   assert_output ''
@@ -48,7 +58,7 @@ teardown() {
   touch "${BATS_TEST_TMPDIR}/new-file"
 
   run "${PWD}/backends/cache_fs" exists new-file
-  
+
   assert_failure
   assert_output ''
 
@@ -74,7 +84,7 @@ teardown() {
   echo 'random content' > "${BATS_TEST_TMPDIR}/new-folder/new-file"
 
   run "${PWD}/backends/cache_fs" exists new-folder
-  
+
   assert_failure
   assert_output ''