Add progress option (#467)

* Add progress option to Docker Compose plugin configuration and update README

* Reorder progress option in plugin.yml configuration for consistency

Author: paymand

README.md

@@ -2,11 +2,10 @@
 
 A [Buildkite plugin](https://buildkite.com/docs/agent/v3/plugins) that lets you build, run and push build steps using [Docker Compose](https://docs.docker.com/compose/).
 
-* Containers are built, run and linked on demand using Docker Compose
-* Containers are namespaced to each build job, and cleaned up after use
-* Supports pre-building of images, allowing for fast parallel builds across distributed agents
-* Supports pushing tagged images to a repository
-
+- Containers are built, run and linked on demand using Docker Compose
+- Containers are namespaced to each build job, and cleaned up after use
+- Supports pre-building of images, allowing for fast parallel builds across distributed agents
+- Supports pushing tagged images to a repository
 
 ## Examples
 
@@ -30,7 +29,7 @@ The name of the service the command should be run within. If the docker-compose
 
 #### `push`
 
-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.
+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.
 
 :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.
 
@@ -190,7 +189,7 @@ Note that there is a single build command run for all services so the target val
 
 A list of volumes to mount into the container. If a matching volume exists in the Docker Compose config file, this option will override that definition.
 
-Additionally, volumes may be specified via the agent environment variable `BUILDKITE_DOCKER_DEFAULT_VOLUMES`, a `;` (semicolon)  delimited list of mounts in the `-v` syntax. (Ex. `buildkite:/buildkite;./app:/app`).
+Additionally, volumes may be specified via the agent environment variable `BUILDKITE_DOCKER_DEFAULT_VOLUMES`, a `;` (semicolon) delimited list of mounts in the `-v` syntax. (Ex. `buildkite:/buildkite;./app:/app`).
 
 #### `expand-volume-vars` (run only, boolean, unsafe)
 
@@ -236,6 +235,10 @@ If set to false, runs with `--no-deps` and doesn't start linked services.
 
 The default is `true`.
 
+### `progress` (string)
+
+If set, runs with `--progress VALUE` (can be any of: auto, tty, plain, json, quiet).
+
 #### `pre-run-dependencies` (run only, boolean)
 
 If `dependencies` are activated (which is the default), you can skip starting them up before the main container by setting this option to `false`. This is useful if you want compose to take care of that on its own at the expense of messier output in the run step.
@@ -293,8 +296,9 @@ If set to true, all docker compose commands will run with compatibility mode. Eq
 The default is `false`.
 
 Note that [the effect of this option changes depending on your docker compose CLI version](https://docs.docker.com/compose/cli-command-compatibility/#flags-that-will-not-be-implemented):
-* in v1 it translates (composefile) v3 deploy keys to their non-swarm (composefile) v2 equivalents
-* in v2 it will revert some behaviour to v1 as well, including (but not limited to):
+
+- in v1 it translates (composefile) v3 deploy keys to their non-swarm (composefile) v2 equivalents
+- in v2 it will revert some behaviour to v1 as well, including (but not limited to):
   - [Character separator for container names](https://github.com/docker/compose/blob/a0acc20d883ce22b8b0c65786e3bea1328809bbd/cmd/compose/compose.go#L181)
   - [Not normalizing compose models (when running `config`)](https://github.com/docker/compose/blob/2e7644ff21f9ca0ea6fb5e8d41d4f6af32cd7e20/cmd/compose/convert.go#L69)
 

lib/shared.bash

@@ -266,6 +266,10 @@ function run_docker_compose() {
     command+=(--compatibility)
   fi
 
+  if [[ -n "$(plugin_read_config PROGRESS)" ]]; then
+    command+=(--progress "$(plugin_read_config PROGRESS)")
+  fi
+
   for file in $(docker_compose_config_files) ; do
     command+=(-f "$file")
   done
@@ -330,4 +334,4 @@ function builder_instance_exists() {
     else
         return 1 # Builder does not exist
     fi
-}
+}

plugin.yml

@@ -112,6 +112,9 @@ configuration:
       type: boolean
     prebuilt-image-namespace:
       type: string
+    progress:
+      type: string
+      enum: [ "auto", "tty", "plain", "json", "quiet" ]
     propagate-environment:
       type: boolean
     propagate-uid-gid:
@@ -197,6 +200,7 @@ configuration:
     mount-ssh-agent: [ run ]
     no-cache: [ build, run ]
     pre-run-dependencies: [ run ]
+    progress: [ build, push, run ]
     propagate-environment: [ run ]
     propagate-uid-gid: [ run ]
     pull: [ run ]

tests/run.bats

@@ -224,6 +224,30 @@ cmd3"
   unstub buildkite-agent
 }
 
+@test "Run with progress=quiet" {
+  export BUILDKITE_COMMAND=pwd
+
+  export BUILDKITE_PLUGIN_DOCKER_COMPOSE_RUN=myservice
+  export BUILDKITE_PLUGIN_DOCKER_COMPOSE_CLEANUP=false
+  export BUILDKITE_PLUGIN_DOCKER_COMPOSE_PROGRESS=quiet
+
+  stub docker \
+    "compose --progress quiet -f docker-compose.yml -p buildkite1111 -f docker-compose.buildkite-1-override.yml pull myservice : echo pulled myservice" \
+    "compose --progress quiet -f docker-compose.yml -p buildkite1111 -f docker-compose.buildkite-1-override.yml up -d --scale myservice=0 myservice : echo started dependencies for myservice" \
+    "compose --progress quiet -f docker-compose.yml -p buildkite1111 -f docker-compose.buildkite-1-override.yml run --name buildkite1111_myservice_build_1 -T --rm myservice /bin/sh -e -c 'pwd' : echo ran myservice with use aliases output"
+
+  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 myimage"
+
+  run "$PWD"/hooks/command
+
+  assert_success
+  assert_output --partial "ran myservice with use aliases output"
+  unstub docker
+  unstub buildkite-agent
+}
+
 @test "Run without a prebuilt image without pulling" {
   export BUILDKITE_PLUGIN_DOCKER_COMPOSE_RUN=myservice
   export BUILDKITE_COMMAND="echo hello world"