Merge pull request #33 from buildkite-plugins/support-multiple-images

Add support for multiple images in a single pipeline/definition

Author: Patrick Robinson

README.md

@@ -53,9 +53,16 @@ Example: `"my-task"`
 
 ### `image`
 
-The Docker image to deploy.
+The Docker image to deploy. This can be an array to substitute multiple images in a single container definition.
 
-Example: `"012345.dkr.ecr.us-east-1.amazonaws.com/my-service:123"`
+Examples:
+`"012345.dkr.ecr.us-east-1.amazonaws.com/my-service:123"`
+
+```yaml
+image:
+  - "012345.dkr.ecr.us-east-1.amazonaws.com/my-service:123"
+  - "012345.dkr.ecr.us-east-1.amazonaws.com/nginx:123"
+```
 
 ### `target-group`
 

examples/multiple-images.json

@@ -0,0 +1,26 @@
+[
+    {
+        "essential": true,
+        "image": "amazon/amazon-ecs-sample",
+        "memory": 100,
+        "name": "sample",
+        "portMappings": [
+            {
+                "containerPort": 80,
+                "hostPort": 80
+            }
+        ]
+    },
+    {
+        "essential": true,
+        "image": "amazon/amazon-ecs-sample",
+        "memory": 100,
+        "name": "sample",
+        "portMappings": [
+            {
+                "containerPort": 80,
+                "hostPort": 80
+            }
+        ]
+    }
+]

hooks/command

@@ -1,10 +1,36 @@
 #!/bin/bash
 set -euo pipefail
 
+# Reads either a value or a list from plugin config
+function plugin_read_list() {
+  prefix_read_list "BUILDKITE_PLUGIN_ECS_DEPLOY_$1"
+}
+
+# Reads either a value or a list from the given env prefix
+function prefix_read_list() {
+  local prefix="$1"
+  local parameter="${prefix}_0"
+
+  if [[ -n "${!parameter:-}" ]]; then
+    local i=0
+    local parameter="${prefix}_${i}"
+    while [[ -n "${!parameter:-}" ]]; do
+      echo "${!parameter}"
+      i=$((i+1))
+      parameter="${prefix}_${i}"
+    done
+  elif [[ -n "${!prefix:-}" ]]; then
+    echo "${!prefix}"
+  fi
+}
+
 cluster=${BUILDKITE_PLUGIN_ECS_DEPLOY_CLUSTER?}
 task_family=${BUILDKITE_PLUGIN_ECS_DEPLOY_TASK_FAMILY?}
 service_name=${BUILDKITE_PLUGIN_ECS_DEPLOY_SERVICE?}
-image=${BUILDKITE_PLUGIN_ECS_DEPLOY_IMAGE?}
+images=()
+while read -r line ; do
+  [[ -n "$line" ]] && images+=("$line")
+done <<< "$(plugin_read_list IMAGE)"
 task_definition=${BUILDKITE_PLUGIN_ECS_DEPLOY_TASK_DEFINITION?}
 desired_count=${BUILDKITE_PLUGIN_ECS_DEPLOY_DESIRED_COUNT:-"1"}
 task_role_arn=${BUILDKITE_PLUGIN_ECS_DEPLOY_TASK_ROLE_ARN:-""}
@@ -22,9 +48,11 @@ function create_service() {
     local target_group_arguments
     target_group_arguments=$(generate_target_group_arguments "$5" "$6" "$7")
 
+    # shellcheck disable=SC2016
     service_defined=$(aws ecs describe-services --cluster "$cluster_name" --service "$service_name" --query 'services[?status==`ACTIVE`].status' --output text |wc -l)
     if [[ $service_defined -eq 0 ]]; then
         echo "--- :ecs: Creating a Service $service_name in cluster $cluster_name"
+        # shellcheck disable=SC2086
         aws ecs create-service --cluster "$cluster_name" --service-name "$service_name" --task-definition "$task_definition" --desired-count "$desired_count" $target_group_arguments
     fi
 }
@@ -41,10 +69,14 @@ function generate_target_group_arguments() {
 }
 
 ## This is the template definition of your containers
-container_definitions_json=$(jq --arg IMAGE "$image" \
-'.[0].image=$IMAGE' \
-"$task_definition"
-)
+image_idx=0
+container_definitions_json=$(cat "${task_definition}")
+for image in "${images[@]}"; do
+  container_definitions_json=$(echo "$container_definitions_json" | jq --arg IMAGE "$image" \
+  ".[${image_idx}].image=\$IMAGE"
+  )
+  image_idx=$((image_idx+1))
+done
 
 echo "jq --arg IMAGE $image \
 '.taskDefinition.containerDefinitions[0].image=\$IMAGE' \
@@ -73,6 +105,7 @@ echo "Registered ${task_family}:${task_revision}"
 # Create service if it doesn't already exist
 create_service "$cluster" "${task_family}:${task_revision}" "$service_name" "$desired_count" "$target_group" "$target_container" "$target_port"
 
+# shellcheck disable=SC2016
 lb_config=$(aws ecs describe-services --cluster "$cluster" --services "$service_name" --query 'services[?status==`ACTIVE`]' |jq -r '.[0].loadBalancers[0]')
 error="+++ Cannot update a service to add a load balancer. First delete the service and then run again, or rename the service to force a new one to be created"
 

plugin.yml

@@ -15,7 +15,7 @@ configuration:
     task-family:
       type: string
     image:
-      type: string
+      type: [ string, array ]
     desired-count:
       type: string
     task-role-arn:

tests/command.bats

@@ -15,7 +15,7 @@ load '/usr/local/lib/bats/load.bash'
   export BUILDKITE_PLUGIN_ECS_DEPLOY_TASK_DEFINITION=examples/hello-world.json
 
   stub jq \
-    "--arg IMAGE hello-world:llamas '.[0].image=\$IMAGE' examples/hello-world.json : echo '{\"json\":true}'" \
+    "--arg IMAGE hello-world:llamas '.[0].image=\$IMAGE' : echo '{\"json\":true}'" \
     "'.taskDefinition.revision' : echo 1" \
     "-r '.[0].loadBalancers[0]' : echo null"
 
@@ -38,7 +38,43 @@ load '/usr/local/lib/bats/load.bash'
   unset BUILDKITE_PLUGIN_ECS_DEPLOY_SERVICE
   unset BUILDKITE_PLUGIN_ECS_DEPLOY_TASK_DEFINITION
   unset BUILDKITE_PLUGIN_ECS_DEPLOY_IMAGE
+}
+
+@test "Run a deploy with multiple images" {
+  export BUILDKITE_BUILD_NUMBER=1
+  export BUILDKITE_PLUGIN_ECS_DEPLOY_CLUSTER=my-cluster
+  export BUILDKITE_PLUGIN_ECS_DEPLOY_SERVICE=my-service
+  export BUILDKITE_PLUGIN_ECS_DEPLOY_TASK_FAMILY=hello-world
+  export BUILDKITE_PLUGIN_ECS_DEPLOY_IMAGE_0=hello-world:llamas
+  export BUILDKITE_PLUGIN_ECS_DEPLOY_IMAGE_1=hello-world:alpacas
+  export BUILDKITE_PLUGIN_ECS_DEPLOY_TASK_DEFINITION=examples/multiple-images.json
+
+  stub jq \
+    "--arg IMAGE hello-world:llamas '.[0].image=\$IMAGE' : echo '[{\"image\":\"hello-world:llamas\"},{\"image\":\"replaceme\"}]'" \
+    "--arg IMAGE hello-world:alpacas '.[1].image=\$IMAGE' : echo '[{\"image\":\"hello-world:llamas\"},{\"image\":\"hello-world:alpacas\"}]'" \
+    "'.taskDefinition.revision' : echo 1" \
+    "-r '.[0].loadBalancers[0]' : echo null"
+
+  stub aws \
+    "ecs register-task-definition --family hello-world --container-definitions '[{\"image\":\"hello-world:llamas\"},{\"image\":\"hello-world:alpacas\"}]' : echo '{\"taskDefinition\":{\"revision\":1}}'" \
+    "ecs describe-services --cluster my-cluster --service my-service --query 'services[?status==\`ACTIVE\`].status' --output text : echo '1'" \
+    "ecs describe-services --cluster my-cluster --services my-service --query 'services[?status==\`ACTIVE\`]' : echo 'null'" \
+    "ecs update-service --cluster my-cluster --service my-service --task-definition hello-world:1 : echo ok" \
+    "ecs wait services-stable --cluster my-cluster --services my-service : echo ok" \
+    "ecs describe-services --cluster my-cluster --service my-service : echo ok"
+
+  run "$PWD/hooks/command"
+
+  assert_success
+  assert_output --partial "Service is up 🚀"
+
+  unstub aws
+  unstub jq
+  unset BUILDKITE_PLUGIN_ECS_DEPLOY_CLUSTER
+  unset BUILDKITE_PLUGIN_ECS_DEPLOY_SERVICE
   unset BUILDKITE_PLUGIN_ECS_DEPLOY_TASK_DEFINITION
+  unset BUILDKITE_PLUGIN_ECS_DEPLOY_IMAGE_0
+  unset BUILDKITE_PLUGIN_ECS_DEPLOY_IMAGE_1
 }
 
 @test "Run a deploy when service does not exist" {
@@ -50,7 +86,7 @@ load '/usr/local/lib/bats/load.bash'
   export BUILDKITE_PLUGIN_ECS_DEPLOY_TASK_DEFINITION=examples/hello-world.json
 
   stub jq \
-    "--arg IMAGE hello-world:llamas '.[0].image=\$IMAGE' examples/hello-world.json : echo '{\"json\":true}'" \
+    "--arg IMAGE hello-world:llamas '.[0].image=\$IMAGE' : echo '{\"json\":true}'" \
     "'.taskDefinition.revision' : echo 1" \
     "-r '.[0].loadBalancers[0]' : echo null"
 
@@ -87,7 +123,7 @@ load '/usr/local/lib/bats/load.bash'
   export BUILDKITE_PLUGIN_ECS_DEPLOY_TASK_ROLE_ARN=arn:aws:iam::012345678910:role/world
 
   stub jq \
-    "--arg IMAGE hello-world:llamas '.[0].image=\$IMAGE' examples/hello-world.json : echo '{\"json\":true}'" \
+    "--arg IMAGE hello-world:llamas '.[0].image=\$IMAGE' : echo '{\"json\":true}'" \
     "'.taskDefinition.revision' : echo 1" \
     "-r '.[0].loadBalancers[0]' : echo null"
 
@@ -125,7 +161,7 @@ load '/usr/local/lib/bats/load.bash'
   export BUILDKITE_PLUGIN_ECS_DEPLOY_TARGET_CONTAINER_PORT=80
 
   stub jq \
-    "--arg IMAGE hello-world:llamas '.[0].image=\$IMAGE' examples/hello-world.json : echo '{\"json\":true}'" \
+    "--arg IMAGE hello-world:llamas '.[0].image=\$IMAGE' : echo '{\"json\":true}'" \
     "'.taskDefinition.revision' : echo 1" \
     "-r '.[0].loadBalancers[0]' : echo alb" \
     "-r .containerName : echo nginx" \