fix merge conflicts

Author: pzeballos

README.md

@@ -33,6 +33,8 @@ The name of the service the command should be run within. If the docker-compose
 
 A list of services to push. You can specify just the service name to push or the format `service:registry:tag` to override where the service's image is pushed to. Needless to say, the image for the service must have been built in the very same step or built and pushed previously to ensure it is available for pushing.
 
+**Important**: when the image for a service is pushed it sets metadata on the build so that future steps will know to use that image to run that service. This can lead to race conditions when pushing multiple images for a service. Can be turned off with the `push-metadata` option.
+
 :warning: If a service does not have an `image` configuration and no registry/tag are specified in the `push` option, pushing of the service will be skipped by docker.
 
 :warning: The `push` command will fail when the image refers to a remote registry that requires a login and the agent has not been authenticated for it (for example, using the [ecr](https://github.com/buildkite-plugins/ecr-buildkite-plugin) or [docker-login](https://github.com/buildkite-plugins/docker-login-buildkite-plugin) plugins).
@@ -171,6 +173,12 @@ Default: `false`
 
 A number of times to retry failed docker pull. Defaults to 0.
 
+#### `push-metadata` (push only, boolean)
+
+Whether to set the metadata aboout the image for a service being pushed.
+
+Default: `true`.
+
 #### `push-retries` (push only, integer)
 
 A number of times to retry failed docker push. Defaults to 0.
@@ -322,11 +330,11 @@ Note that [the effect of this option changes depending on your docker compose CL
 
 #### `entrypoint` (run only)
 
-Sets the `--entrypoint` argument when running `docker compose`.
+Sets the `--entrypoint` argument when running `docker compose`, can be set to an empty string.
 
 #### `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
@@ -285,7 +292,7 @@ if [[ "$(plugin_read_config RM "true")" == "true" ]]; then
 fi
 
 # Optionally sets --entrypoint
-if [[ -n "$(plugin_read_config ENTRYPOINT)" ]] ; then
+if plugin_config_exists ENTRYPOINT ; then
   run_params+=(--entrypoint)
   run_params+=("$(plugin_read_config ENTRYPOINT)")
 fi
@@ -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

docs/examples.md

@@ -26,6 +26,7 @@ steps:
 
 The plugin will honor the value of the `COMPOSE_FILE` environment variable if one exists (for example, at the pipeline or step level). But you can also specify custom Docker Compose config files with the `config` option:
 
+
 ```yml
 steps:
   - command: test.sh

lib/metadata.bash

@@ -56,6 +56,12 @@ function set_prebuilt_image() {
   local service="$2"
   local image="$3"
 
+  # assumes that the lib/shared.bash has already been sourced
+  if [ "$(plugin_read_config PUSH_METADATA "true")" != "true" ]; then
+    plugin_prompt "Not setting metadata for prebuilt image, push-metadata option is set to false"
+    return 0
+  fi
+
   plugin_set_metadata "$namespace" "$(prebuilt_image_meta_data_key "$service")" "$image"
 }
 

lib/shared.bash

@@ -86,6 +86,13 @@ function plugin_read_list_into_result() {
   [[ ${#result[@]} -gt 0 ]] || return 1
 }
 
+function plugin_config_exists() {
+  local var="BUILDKITE_PLUGIN_DOCKER_COMPOSE_${1}"
+
+  # Check if the variable is set
+  [ "${!var+is_set}" != "" ]
+}
+
 # Returns the name of the docker compose project for this build
 function docker_compose_project_name() {
   # No dashes or underscores because docker-compose will remove them anyways

plugin.yml

@@ -128,6 +128,8 @@ configuration:
       minimum: 1
     pull-retries:
       type: integer
+    push-metadata:
+      type: boolean
     push-retries:
       type: integer
     quiet-pull:
@@ -211,6 +213,7 @@ configuration:
     propagate-uid-gid: [ run ]
     pull: [ run ]
     pull-retries: [ run ]
+    push-metadata: [ push ]
     push-retries: [ push ]
     quiet-pull: [ push, run]
     quiet-push: [ push ]

tests/metadata.bats

@@ -53,3 +53,28 @@ load '../lib/metadata'
   assert_output --partial "buildkite-agent meta-data get docker-compose-plugin-built-image-tag-test"
   unstub buildkite-agent
 }
+
+@test "Set prebuilt image in metadata" {
+  stub buildkite-agent \
+    "meta-data set docker-compose-plugin-built-image-tag-test \* : echo setting metadata to \$4"
+
+  run set_prebuilt_image "docker-compose-plugin-" "test" "new-image"
+
+  assert_success
+
+  assert_output --partial "buildkite-agent meta-data set docker-compose-plugin-built-image-tag-test new-image"
+
+  unstub buildkite-agent
+}
+
+@test "Can skip setting prebuilt image in metadata" {
+  export BUILDKITE_PLUGIN_DOCKER_COMPOSE_PUSH_METADATA=false
+
+  run set_prebuilt_image "docker-compose-plugin-" "test" "new-image"
+
+  assert_success
+
+  refute_output --partial "buildkite-agent meta-data set docker-compose-plugin-built-image-tag-test new-image"
+  assert_output --partial "Not setting metadata for prebuilt image, push-metadata option is set to false"
+}
+

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=""
@@ -900,6 +921,29 @@ cmd3"
   unstub buildkite-agent
 }
 
+@test "Run with empty entrypoint" {
+  export BUILDKITE_PLUGIN_DOCKER_COMPOSE_RUN=myservice
+  export BUILDKITE_COMMAND=""
+  export BUILDKITE_PLUGIN_DOCKER_COMPOSE_CHECK_LINKED_CONTAINERS=false
+  export BUILDKITE_PLUGIN_DOCKER_COMPOSE_CLEANUP=false
+  export BUILDKITE_PLUGIN_DOCKER_COMPOSE_ENTRYPOINT=""
+
+  stub docker \
+    "compose -f docker-compose.yml -p buildkite1111 up -d --scale myservice=0 myservice : echo ran myservice dependencies" \
+    "compose -f docker-compose.yml -p buildkite1111 run --name buildkite1111_myservice_build_1 -T --rm --entrypoint '' myservice : echo ran myservice"
+
+  stub buildkite-agent \
+    "meta-data exists docker-compose-plugin-built-image-tag-myservice : exit 1"
+
+  run "$PWD"/hooks/command
+
+  assert_success
+  assert_output --partial "ran myservice"
+
+  unstub docker
+  unstub buildkite-agent
+}
+
 @test "Run with mount-buildkite-agent enabled" {
   export BUILDKITE_PLUGIN_DOCKER_COMPOSE_RUN=myservice
   export BUILDKITE_COMMAND=""