Change behavior of builder.use to only use builder once

Author: KevinSnyderCodes

commands/build.sh

@@ -111,14 +111,14 @@ fi
 
 build_params+=(build)
 
-if [[ -n "$(plugin_read_config BUILDER_NAME "")" ]] && [[ "$(plugin_read_config BUILDER_USE_ONCE "false")" == "true" ]]; then
-  build_params+=("--builder" "$(plugin_read_config BUILDER_NAME "")")
-fi
-
 if [[ ! "$(plugin_read_config SKIP_PULL "false")" == "true" ]] ; then
   build_params+=(--pull)
 fi
 
+if [[ -n "$(plugin_read_config BUILDER_NAME "")" ]] && [[ "$(plugin_read_config BUILDER_USE "false")" == "true" ]]; then
+  build_params+=("--builder" "$(plugin_read_config BUILDER_NAME "")")
+fi
+
 if [[ "$(plugin_read_config NO_CACHE "false")" == "true" ]] ; then
   build_params+=(--no-cache)
 fi

hooks/pre-command

@@ -8,12 +8,11 @@ DIR="$(cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd)"
 
 builder_create="$(plugin_read_config BUILDER_CREATE "false")"
 builder_use="$(plugin_read_config BUILDER_USE "false")"
-builder_use_once="$(plugin_read_config BUILDER_USE_ONCE "false")"
 builder_name="$(plugin_read_config BUILDER_NAME "")"
 
-if [[ "${builder_create}" == "true" ]] || [[ "${builder_use}" == "true" ]] || [[ "${builder_use_once}" == "true" ]]; then
+if [[ "${builder_create}" == "true" ]] || [[ "${builder_use}" == "true" ]]; then
     if [[ -z "${builder_name}" ]]; then
-        echo "+++ 🚨 Builder Name cannot be empty when using 'create', 'use', or 'use-once' parameters"
+        echo "+++ 🚨 Builder Name cannot be empty when using 'create' or 'use' parameters"
         exit 1
     fi
 fi
@@ -63,8 +62,8 @@ if [[ "${builder_create}" == "true" ]]; then
 
         echo "~~~ :docker: Creating Builder Instance '${builder_name}' with Driver '${build_driver}'"
         docker buildx create "${builder_instance_args[@]}"
-        if [[ "${builder_use}" == "false" ]] && [[ "${builder_use_once}" == "false" ]]; then
-            echo "~~~ :warning: Builder Instance '${builder_name}' created but will not be used as 'use: true' or 'use-once: true' parameter not specified"
+        if [[ "${builder_use}" == "false" ]]; then
+            echo "~~~ :warning: Builder Instance '${builder_name}' created but will not be used as 'use: true' parameter not specified"
         fi
     else
         echo "~~~ :docker: Not Creating Builder Instance '${builder_name}' as already exists"
@@ -74,15 +73,12 @@ fi
 if [[ "${builder_use}" == "true" ]]; then
     if builder_instance_exists "${builder_name}"; then
         echo "~~~ :docker: Using Builder Instance '${builder_name}'"
-        docker buildx use "${builder_name}"
     else
         echo "+++ 🚨 Builder Instance '${builder_name}' does not exist"
         exit 1
     fi
-elif [[ "${builder_use_once}" == "false" ]]; then
+else
     current_builder=$(docker buildx inspect | grep -m 1 "Name" | awk '{print $2}') || true
     current_builder_driver=$(docker buildx inspect | grep -m 1 "Driver" | awk '{print $2}') || true
     echo "~~~ :docker: Using Default Builder '${current_builder}' with Driver '${current_builder_driver}'"
-else
-    echo "~~~ :docker: Using Builder Instance '${builder_name}' once"
 fi

tests/build.bats

@@ -31,6 +31,22 @@ setup_file() {
   unstub docker
 }
 
+@test "Build with builder" {
+  export BUILDKITE_PLUGIN_DOCKER_COMPOSE_BUILD=myservice
+  export BUILDKITE_PLUGIN_DOCKER_COMPOSE_BUILDER_NAME=mybuilder
+  export BUILDKITE_PLUGIN_DOCKER_COMPOSE_BUILDER_USE=true
+
+  stub docker \
+    "compose -f docker-compose.yml -p buildkite1111 build --pull --builder mybuilder myservice : echo built myservice"
+
+  run "$PWD"/hooks/command
+
+  assert_success
+  assert_output --partial "built myservice"
+
+  unstub docker
+}
+
 @test "Build with no-cache" {
   export BUILDKITE_PLUGIN_DOCKER_COMPOSE_BUILD=myservice
   export BUILDKITE_PLUGIN_DOCKER_COMPOSE_NO_CACHE=true

tests/builder-instances.bats

@@ -25,7 +25,7 @@ load '../lib/shared'
     run "$PWD"/hooks/pre-command
 
     assert_failure
-    assert_output "+++ 🚨 Builder Name cannot be empty when using 'create', 'use', or 'use-once' parameters"
+    assert_output "+++ 🚨 Builder Name cannot be empty when using 'create' or 'use' parameters"
 }
 
 @test "Use Builder Instance with invalid Name" {
@@ -34,7 +34,7 @@ load '../lib/shared'
     run "$PWD"/hooks/pre-command
 
     assert_failure
-    assert_output "+++ 🚨 Builder Name cannot be empty when using 'create', 'use', or 'use-once' parameters"
+    assert_output "+++ 🚨 Builder Name cannot be empty when using 'create' or 'use' parameters"
 }
 
 @test "Create Builder Instance with invalid Driver" {
@@ -104,7 +104,7 @@ load '../lib/shared'
 
     assert_success
     assert_output --partial "~~~ :docker: Creating Builder Instance 'builder-name' with Driver 'docker-container'"
-    assert_output --partial "~~~ :warning: Builder Instance 'builder-name' created but will not be used as 'use: true' or 'use-once: true' parameter not specified"
+    assert_output --partial "~~~ :warning: Builder Instance 'builder-name' created but will not be used as 'use: true' parameter not specified"
 
     assert_output --partial "~~~ :docker: Using Default Builder 'test' with Driver 'driver'"
 
@@ -131,8 +131,7 @@ load '../lib/shared'
     export BUILDKITE_PLUGIN_DOCKER_COMPOSE_BUILDER_NAME=builder-name
 
     stub docker \
-        "buildx inspect builder-name : exit 0" \
-        "buildx use builder-name : exit 0"
+        "buildx inspect builder-name : exit 0"
 
     run "$PWD"/hooks/pre-command