Merge pull request #486 from buildkite-plugins/toote_require_all_images

`require-prebuild` affects all images

Author: pzeballos

README.md

@@ -332,7 +332,7 @@ Sets the `--entrypoint` argument when running `docker compose`, can be set to an
 
 #### `require-prebuild` (run only, boolean)
 
-If no prebuilt image is found for the run step, it will cause the plugin to fail the step.
+Make sure that images for the service being run and all specified in `pull` are found for the run step, fail the step otherwise. Note that specifying a `run-image` will skip this check for the service being run.
 
 The default is `false`.
 

commands/run.sh

@@ -49,6 +49,13 @@ for service_name in "${prebuilt_candidates[@]}" ; do
     prebuilt_image="$prebuilt_image_override"
   elif prebuilt_image=$(get_prebuilt_image "$prebuilt_image_namespace" "$service_name") ; then
      echo "~~~ :docker: Found a pre-built image for $service_name"
+  else
+    echo "+++ 🚨 No pre-built image found from a previous 'build' step for service ${service_name} and config file."
+
+    if [[ "${BUILDKITE_PLUGIN_DOCKER_COMPOSE_REQUIRE_PREBUILD:-}" =~ ^(true|on|1)$ ]]; then
+      echo "The step specified that it was required"
+      exit 1
+    fi
   fi
 
   if [[ -n "$prebuilt_image" ]] ; then
@@ -350,15 +357,6 @@ fi
 
 run_params+=("$run_service")
 
-if [[ ! -f "$override_file" ]] ; then
-  echo "+++ 🚨 No pre-built image found from a previous 'build' step for this service and config file."
-
-  if [[ "${BUILDKITE_PLUGIN_DOCKER_COMPOSE_REQUIRE_PREBUILD:-}" =~ ^(true|on|1)$ ]]; then
-    echo "The step specified that it was required"
-    exit 1
-  fi
-fi
-
 up_params+=("up")  # this ensures that the array has elements to avoid issues with bash 4.3
 
 if [[ "$(plugin_read_config WAIT "false")" == "true" ]] ; then

tests/run.bats

@@ -59,6 +59,27 @@ teardown() {
   unstub buildkite-agent
 }
 
+@test "Fail running without a prebuilt image for pull service and require-prebuild" {
+  export BUILDKITE_PLUGIN_DOCKER_COMPOSE_RUN=myservice
+  export BUILDKITE_COMMAND="echo hello world"
+  export BUILDKITE_PLUGIN_DOCKER_COMPOSE_REQUIRE_PREBUILD=true
+  export BUILDKITE_PLUGIN_DOCKER_COMPOSE_PULL=other-service
+
+  stub buildkite-agent \
+    "meta-data exists docker-compose-plugin-built-image-tag-myservice : exit 0" \
+    "meta-data get docker-compose-plugin-built-image-tag-myservice : echo myservice-image" \
+    "meta-data exists docker-compose-plugin-built-image-tag-other-service : exit 1"
+
+  run "$PWD"/hooks/command
+
+  assert_failure
+
+  assert_output --partial "Found a pre-built image for myservice"
+  assert_output --partial "No pre-built image found"
+
+  unstub buildkite-agent
+}
+
 @test "Run without a prebuilt image and an empty command" {
   export BUILDKITE_PLUGIN_DOCKER_COMPOSE_RUN=myservice
   export BUILDKITE_COMMAND=""