Merge pull request #32 from buildkite-plugins/support-elbs

Support Classic Load Balancers

Author: Patrick Robinson

hooks/command

@@ -35,11 +35,14 @@ 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:-""}
 target_group=${BUILDKITE_PLUGIN_ECS_DEPLOY_TARGET_GROUP:-""}
-# Resolve any runtime environment variables it has
-target_group=$(eval "echo $target_group")
+load_balancer_name=${BUILDKITE_PLUGIN_ECS_DEPLOY_LOAD_BALANCER_NAME:-""}
 target_container=${BUILDKITE_PLUGIN_ECS_DEPLOY_TARGET_CONTAINER_NAME:-""}
 target_port=${BUILDKITE_PLUGIN_ECS_DEPLOY_TARGET_CONTAINER_PORT:-""}
 
+# Resolve any runtime environment variables it has
+target_group=$(eval "echo $target_group")
+load_balancer_name=$(eval "echo $load_balancer_name")
+
 function create_service() {
     local cluster_name=$1
     local task_definition=$2
@@ -62,8 +65,20 @@ function generate_target_group_arguments() {
     local target_container=$2
     local target_port=$3
     local target_group_arguments=""
-    if [[ -n $target_group ]] && [[ -n $target_container ]] && [[ -n $target_port ]]; then
-      target_group_arguments="--load-balancers targetGroupArn=${target_group},containerName=${target_container},containerPort=${target_port}"
+    if [[ -n $target_container ]] && [[ -n $target_port ]]; then
+      local load_balancer_ref=""
+      if [[ -n $target_group ]]; then
+        load_balancer_ref="targetGroupArn=${target_group}"
+      elif [[ -n $load_balancer_name ]]; then
+        load_balancer_ref="loadBalancerName=${load_balancer_name}"
+      else
+        echo "+++ ^^^"
+        # shellcheck disable=SC2016
+        echo '+++ You must specify either `target-group` or `load-balancer-name`'
+        exit 1
+      fi
+
+      target_group_arguments="--load-balancers ${load_balancer_ref},containerName=${target_container},containerPort=${target_port}"
     fi
     echo "$target_group_arguments"
 }
@@ -78,10 +93,6 @@ for image in "${images[@]}"; do
   image_idx=$((image_idx+1))
 done
 
-echo "jq --arg IMAGE $image \
-'.taskDefinition.containerDefinitions[0].image=\$IMAGE' \
-$task_definition" > /tmp/foo
-
 echo "--- :ecs: Registering new task definition for ${task_family}"
 register_command="aws ecs register-task-definition \
     --family ${task_family} \
@@ -107,12 +118,15 @@ create_service "$cluster" "${task_family}:${task_revision}" "$service_name" "$de
 
 # 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"
+error="+++ ^^^
++++ Cannot update a service to add/remove a load balancer. First delete the service and then run again, or rename the service to force a new one to be created"
 
 # No easy way to tell if the target group has changed, since describe-services only returns the load balancer name
-if [[ "$lb_config" == "null" ]] && [[ -n $target_group ]]; then
-  echo "$error"
-  exit 1
+if [[ "$lb_config" == "null" ]]; then
+  if [[ -n "$target_group" ]] || [[ -n "$load_balancer_name" ]]; then
+    echo "$error"
+    exit 1
+  fi
 fi
 
 if [[ "$lb_config" == "null" ]]; then
@@ -121,6 +135,12 @@ if [[ "$lb_config" == "null" ]]; then
 elif [[ $(echo "$lb_config" |jq -r '.containerName') != "$target_container" ]] || [[ $(echo "$lb_config" |jq -r '.containerPort') -ne $target_port ]]; then
   echo "$error"
   exit 1
+elif [[ -n "$target_group" ]] && [[ $(echo "$lb_config" |jq -r '.targetGroupArn') != "$target_group" ]]; then
+  echo "$error"
+  exit 1
+elif [[ -n "$load_balancer_name" ]] && [[ $(echo "$lb_config" |jq -r '.loadBalancerName') != "$load_balancer_name" ]]; then
+  echo "$error"
+  exit 1
 fi
 
 echo "--- :ecs: Updating service for ${service_name}"

plugin.yml

@@ -22,6 +22,8 @@ configuration:
       type: string
     target-group:
       type: string
+    load-balanccer-name:
+      type: string
     target-container-name:
       type: string
     target-container-port:

tests/command.bats

@@ -165,7 +165,8 @@ load '/usr/local/lib/bats/load.bash'
     "'.taskDefinition.revision' : echo 1" \
     "-r '.[0].loadBalancers[0]' : echo alb" \
     "-r .containerName : echo nginx" \
-    "-r .containerPort : echo 80"
+    "-r .containerPort : echo 80" \
+    "-r .targetGroupArn : echo 'arn:aws:elasticloadbalancing:us-east-1:012345678910:targetgroup/alb/e987e1234cd12abc'"
 
   stub aws \
     "ecs register-task-definition --family hello-world --container-definitions '{\"json\":true}' : echo '{\"taskDefinition\":{\"revision\":1}}'" \
@@ -186,4 +187,50 @@ load '/usr/local/lib/bats/load.bash'
   unset BUILDKITE_PLUGIN_ECS_DEPLOY_CLUSTER
   unset BUILDKITE_PLUGIN_ECS_DEPLOY_SERVICE
   unset BUILDKITE_PLUGIN_ECS_DEPLOY_TASK_DEFINITION
+  unset BUILDKITE_PLUGIN_ECS_DEPLOY_TARGET_GROUP
+  unset BUILDKITE_PLUGIN_ECS_DEPLOY_TARGET_CONTAINER_NAME
+  unset BUILDKITE_PLUGIN_ECS_DEPLOY_TARGET_CONTAINER_PORT
 }
+
+@test "Run a deploy with ELBv1" {
+  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=hello-world:llamas
+  export BUILDKITE_PLUGIN_ECS_DEPLOY_TASK_DEFINITION=examples/hello-world.json
+  export BUILDKITE_PLUGIN_ECS_DEPLOY_LOAD_BALANCER_NAME=nginx-elb
+  export BUILDKITE_PLUGIN_ECS_DEPLOY_TARGET_CONTAINER_NAME=nginx
+  export BUILDKITE_PLUGIN_ECS_DEPLOY_TARGET_CONTAINER_PORT=80
+
+  stub jq \
+    "--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" \
+    "-r .containerPort : echo 80" \
+    "-r .loadBalancerName : echo nginx-elb"
+
+  stub aws \
+    "ecs register-task-definition --family hello-world --container-definitions '{\"json\":true}' : echo '{\"taskDefinition\":{\"revision\":1}}'" \
+    "ecs describe-services --cluster my-cluster --service my-service --query 'services[?status==\`ACTIVE\`].status' --output text : echo -n ''" \
+    "ecs create-service --cluster my-cluster --service-name my-service --task-definition hello-world:1 --desired-count 1 --load-balancers loadBalancerName=nginx-elb,containerName=nginx,containerPort=80 : echo -n ''" \
+    "ecs describe-services --cluster my-cluster --services my-service --query 'services[?status==\`ACTIVE\`]' : echo '[{\"loadBalancerName\": \"alb\",\"containerName\": \"nginx\",\"containerPort\": 80}]'" \
+    "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_TARGET_CONTAINER_NAME
+  unset BUILDKITE_PLUGIN_ECS_DEPLOY_TARGET_CONTAINER_PORT
+  unset BUILDKITE_PLUGIN_ECS_DEPLOY_LOAD_BALANCER_NAME
+}