Merge pull request #395 from buildkite-plugins/toote_fix_tester

Fix tester
buildkite-plugins · May 31, 2023 · e9719a5 · e9719a5
2 parents 607e920 + 7c55e9e
commit e9719a5
Show file tree

Hide file tree

Showing 19 changed files with 53 additions and 67 deletions.
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,6 +1,6 @@
 version: '2'
 services:
   tests:
-    image: buildkite/plugin-tester:v4.0.0
+    image: buildkite/plugin-tester:v4.1.0
     volumes:
       - ".:/plugin"
diff --git a/tests/build.bats b/tests/build.bats
@@ -1,6 +1,6 @@
 #!/usr/bin/env bats
 
-load '/usr/local/lib/bats/load.bash'
+load "${BATS_PLUGIN_PATH}/load.bash"
 load '../lib/shared'
 
 # export DOCKER_COMPOSE_STUB_DEBUG=/dev/stdout

diff --git a/tests/cleanup.bats b/tests/cleanup.bats
@@ -1,6 +1,6 @@
 #!/usr/bin/env bats
 
-load '/usr/local/lib/bats/load.bash'
+load "${BATS_PLUGIN_PATH}/load.bash"
 load '../lib/shared'
 load '../lib/run'
 
@@ -21,7 +21,7 @@ load '../lib/run'
     "-f docker-compose.yml -p buildkite1111 rm --force -v : echo removing stopped containers" \
     "-f docker-compose.yml -p buildkite1111 down --remove-orphans --volumes : echo removing everything"
 
-  run $PWD/hooks/pre-exit
+  run "$PWD"/hooks/pre-exit
 
   assert_success
   assert_output --partial "Cleaning up after docker-compose"

diff --git a/tests/docker-compose-cleanup.bats b/tests/docker-compose-cleanup.bats
@@ -1,13 +1,17 @@
 #!/usr/bin/env bats
 
-load '/usr/local/lib/bats/load.bash'
+load "${BATS_PLUGIN_PATH}/load.bash"
 load '../lib/shared'
 load '../lib/run'
 
-@test "Default cleanup of docker-compose" {
+setup () {
   run_docker_compose() {
+    # shellcheck disable=2317 # funtion used by loaded scripts
     echo "$@"
   }
+}
+
+@test "Default cleanup of docker-compose" {
   run compose_cleanup
 
   assert_success
@@ -18,9 +22,6 @@ load '../lib/run'
 
 @test "Possible to gracefully shutdown containers in docker-compose cleanup" {
   export BUILDKITE_PLUGIN_DOCKER_COMPOSE_GRACEFUL_SHUTDOWN=1
-  run_docker_compose() {
-    echo "$@"
-  }
   run compose_cleanup
 
   assert_success
@@ -31,9 +32,6 @@ load '../lib/run'
 
 @test "Possible to skip volume destruction in docker-compose cleanup" {
   export BUILDKITE_PLUGIN_DOCKER_COMPOSE_LEAVE_VOLUMES=1
-  run_docker_compose() {
-    echo "$@"
-  }
   run compose_cleanup
 
   assert_success

diff --git a/tests/docker-compose-config.bats b/tests/docker-compose-config.bats
@@ -1,6 +1,6 @@
 #!/usr/bin/env bats
 
-load '/usr/local/lib/bats/load.bash'
+load "${BATS_PLUGIN_PATH}/load.bash"
 load '../lib/shared'
 
 @test "Read docker-compose config when none exists" {

diff --git a/tests/docker-compose-images.bats b/tests/docker-compose-images.bats
@@ -2,7 +2,7 @@
 
 # export DOCKER_COMPOSE_STUB_DEBUG=/dev/tty
 
-load '/usr/local/lib/bats/load.bash'
+load "${BATS_PLUGIN_PATH}/load.bash"
 load '../lib/shared'
 load '../lib/push'
 

diff --git a/tests/docker-compose-verbosity.bats b/tests/docker-compose-verbosity.bats
@@ -1,6 +1,6 @@
 #!/usr/bin/env bats
 
-load '/usr/local/lib/bats/load.bash'
+load "${BATS_PLUGIN_PATH}/load.bash"
 load '../lib/shared'
 load '../lib/run'
 

diff --git a/tests/image-override-file.bats b/tests/image-override-file.bats
@@ -1,6 +1,6 @@
 #!/usr/bin/env bats
 
-load '/usr/local/lib/bats/load.bash'
+load "${BATS_PLUGIN_PATH}/load.bash"
 load '../lib/shared'
 
 myservice_override_file1=$(cat <<-EOF

diff --git a/tests/logs.bats b/tests/logs.bats
@@ -1,23 +1,27 @@
 #!/usr/bin/env bats
 
-load '/usr/local/lib/bats/load.bash'
+load "${BATS_PLUGIN_PATH}/load.bash"
 load '../lib/run'
 load '../lib/shared'
 
 # export DOCKER_PS_BY_PROJECT_STUB_DEBUG=/dev/tty
 # export CHECK_LINKED_CONTAINERS_AND_SAVE_LOGS_STUB_DEBUG=/dev/tty
 # export DOCKER_STUB_DEBUG=/dev/tty
 
-@test "Upload log settings: on-error" {
-  export LOG_DIR="docker-compose-logs"
-
+setup () {
   function docker_ps_by_project() {
+    # shellcheck disable=2317 # funtion used by loaded scripts
     cat tests/fixtures/id-service-multiple-services.txt
   }
 
   function plugin_prompt_and_run() {
+    # shellcheck disable=2317 # funtion used by loaded scripts
     echo "ran plugin_prompt_and_run"
   }
+}
+
+@test "Upload log settings: on-error" {
+  export LOG_DIR="docker-compose-logs"
 
   stub docker \
     "inspect --format={{.State.ExitCode}} 456456 : echo 1" \
@@ -36,14 +40,6 @@ load '../lib/shared'
 @test "Upload log settings: always" {
   export LOG_DIR="docker-compose-logs"
 
-  function docker_ps_by_project() {
-    cat tests/fixtures/id-service-multiple-services.txt
-  }
-
-  function plugin_prompt_and_run() {
-    echo "ran plugin_prompt_and_run"
-  }
-
   stub docker \
     "inspect --format={{.State.ExitCode}} 456456 : echo 1" \
     "logs -t 456456 : echo got logs for failed" \
@@ -62,14 +58,6 @@ load '../lib/shared'
 @test "Upload log settings: never" {
   export LOG_DIR="docker-compose-logs"
 
-  function docker_ps_by_project() {
-    cat tests/fixtures/id-service-multiple-services.txt
-  }
-
-  function plugin_prompt_and_run() {
-    echo "ran plugin_prompt_and_run"
-  }
-
   run check_linked_containers_and_save_logs \
     "main" "/tmp/docker-compose-logs" "never"
 

diff --git a/tests/metadata.bats b/tests/metadata.bats
@@ -2,7 +2,7 @@
 
 # export BUILDKITE_AGENT_STUB_DEBUG=/dev/tty
 
-load '/usr/local/lib/bats/load.bash'
+load "${BATS_PLUGIN_PATH}/load.bash"
 load '../lib/shared'
 load '../lib/metadata'
 

diff --git a/tests/multiple-commands.bats b/tests/multiple-commands.bats
@@ -1,6 +1,6 @@
 #!/usr/bin/env bats
 
-load '/usr/local/lib/bats/load.bash'
+load "${BATS_PLUGIN_PATH}/load.bash"
 load '../lib/shared'
 load '../lib/metadata'
 
@@ -37,7 +37,7 @@ setup_file() {
      "meta-data exists docker-compose-plugin-built-image-tag-myservice : test -f /tmp/build-run-metadata" \
      "meta-data get docker-compose-plugin-built-image-tag-myservice : cat /tmp/build-run-metadata"
 
-  run $PWD/hooks/command
+  run "$PWD"/hooks/command
 
   assert_success
   assert_output --partial "Building services myservice"
@@ -73,7 +73,7 @@ setup_file() {
      "pull my.repository/llamas:test-myservice-build-1 : echo pulled pre-built image" \
      "tag my.repository/llamas:test-myservice-build-1 buildkite12_myservice : echo re-tagged pre-built image"
 
-  run $PWD/hooks/command
+  run "$PWD"/hooks/command
 
   assert_success
 
@@ -104,7 +104,7 @@ setup_file() {
      "meta-data exists docker-compose-plugin-built-image-tag-myservice : exit 1" \
      "meta-data exists docker-compose-plugin-built-image-tag-myservice : exit 1"
 
-  run $PWD/hooks/command
+  run "$PWD"/hooks/command
 
   assert_success
 
@@ -142,7 +142,7 @@ setup_file() {
      "pull myservice-tag : echo pulled pre-built image" \
      "tag myservice-tag buildkite12_myservice : echo re-tagged pre-built image"
 
-  run $PWD/hooks/command
+  run "$PWD"/hooks/command
 
   assert_success
 

diff --git a/tests/output.bats b/tests/output.bats
@@ -1,6 +1,6 @@
 #!/usr/bin/env bats
 
-load '/usr/local/lib/bats/load.bash'
+load "${BATS_PLUGIN_PATH}/load.bash"
 load '../lib/shared'
 load '../lib/run'
 
@@ -45,7 +45,7 @@ setup_file() {
     "logs -t 456456 : exit 0" \
     "inspect --format={{.State.ExitCode}} 789789 : echo 0"
 
-  run $PWD/hooks/command
+  run "$PWD"/hooks/command
 
   assert_success
   assert_output --partial "built myservice"
@@ -89,7 +89,7 @@ setup_file() {
     "logs -t 456456 : exit 0" \
     "inspect --format={{.State.ExitCode}} 789789 : echo 0"
 
-  run $PWD/hooks/command
+  run "$PWD"/hooks/command
 
   assert_failure
   assert_output --partial "built myservice"
@@ -128,7 +128,7 @@ setup_file() {
     "inspect --format={{.State.ExitCode}} 456456 : echo 0" \
     "inspect --format={{.State.ExitCode}} 789789 : echo 0"
 
-  run $PWD/hooks/command
+  run "$PWD"/hooks/command
 
   assert_success
   assert_output --partial "built myservice"
@@ -168,7 +168,7 @@ setup_file() {
     "ps -a --filter label=com.docker.compose.project=buildkite1111 -q : echo" \
     "ps -a --filter label=com.docker.compose.project=buildkite1111 --format '{{.ID}}\\t{{.Label \"com.docker.compose.service\"}}' : cat tests/fixtures/id-service-no-services.txt"
 
-  run $PWD/hooks/command
+  run "$PWD"/hooks/command
 
   assert_success
   assert_output --partial "built myservice"

diff --git a/tests/plugin-config.bats b/tests/plugin-config.bats
@@ -1,6 +1,6 @@
 #!/usr/bin/env bats
 
-load '/usr/local/lib/bats/load.bash'
+load "${BATS_PLUGIN_PATH}/load.bash"
 load '../lib/shared'
 
 @test "Read existing config without default" {

diff --git a/tests/project-name.bats b/tests/project-name.bats
@@ -1,6 +1,6 @@
 #!/usr/bin/env bats
 
-load '/usr/local/lib/bats/load.bash'
+load "${BATS_PLUGIN_PATH}/load.bash"
 load '../lib/shared'
 
 @test "Project name comes from BUILDKITE_JOB_ID" {

diff --git a/tests/push.bats b/tests/push.bats
@@ -1,6 +1,6 @@
 #!/usr/bin/env bats
 
-load '/usr/local/lib/bats/load.bash'
+load "${BATS_PLUGIN_PATH}/load.bash"
 load '../lib/shared'
 
 # export DOCKER_COMPOSE_STUB_DEBUG=/dev/tty
@@ -24,7 +24,7 @@ load '../lib/shared'
   stub docker \
     "image inspect somewhere.dkr.ecr.some-region.amazonaws.com/blah : exit 0"
 
-  run $PWD/hooks/command
+  run "$PWD"/hooks/command
 
   assert_success
   assert_output --partial ":warning: Skipping build"
@@ -59,7 +59,7 @@ load '../lib/shared'
     "meta-data exists docker-compose-plugin-built-image-tag-myservice1 : exit 1" \
     "meta-data exists docker-compose-plugin-built-image-tag-myservice2 : exit 1"
 
-  run $PWD/hooks/command
+  run "$PWD"/hooks/command
 
   assert_success
   assert_output --partial "tagging image1"
@@ -90,7 +90,7 @@ load '../lib/shared'
     "meta-data exists docker-compose-plugin-built-image-tag-myservice : exit 0" \
     "meta-data get docker-compose-plugin-built-image-tag-myservice : echo myimage"
 
-  run $PWD/hooks/command
+  run "$PWD"/hooks/command
 
   assert_success
   assert_output --partial "pulled prebuilt image"
@@ -110,7 +110,7 @@ load '../lib/shared'
   stub docker-compose \
     "-f docker-compose.yml -p buildkite1111 config : echo blah"
 
-  run $PWD/hooks/command
+  run "$PWD"/hooks/command
 
   assert_success
   refute_output --partial "pulled prebuilt image"
@@ -152,7 +152,7 @@ load '../lib/shared'
     "meta-data exists docker-compose-plugin-built-image-tag-myservice : exit 0" \
     "meta-data get docker-compose-plugin-built-image-tag-myservice : echo prebuilt"
 
-  run $PWD/hooks/command
+  run "$PWD"/hooks/command
 
   assert_success
   assert_output --partial "pulled prebuilt image"
@@ -185,7 +185,7 @@ load '../lib/shared'
     "tag buildkite1111_helper my.repository/helper:llamas : echo tagged helper" \
     "push my.repository/helper:llamas : echo pushed helper"
 
-  run $PWD/hooks/command
+  run "$PWD"/hooks/command
 
   assert_success
   assert_output --partial "built helper"

diff --git a/tests/run.bats b/tests/run.bats
@@ -1,6 +1,6 @@
 #!/usr/bin/env bats
 
-load '/usr/local/lib/bats/load.bash'
+load "${BATS_PLUGIN_PATH}/load.bash"
 load '../lib/shared'
 load '../lib/run'
 

diff --git a/tests/v2/build.bats b/tests/v2/build.bats
@@ -1,6 +1,6 @@
 #!/usr/bin/env bats
 
-load '/usr/local/lib/bats/load.bash'
+load "${BATS_PLUGIN_PATH}/load.bash"
 load '../../lib/shared'
 
 # export DOCKER_COMPOSE_STUB_DEBUG=/dev/stdout