FIx for feature-18

Author: dsperling

.gitignore

@@ -1,3 +1,5 @@
 .vscode
-logs
+logs/
 *.jmx
+test/
+*.xcworkspace/

README.md

@@ -28,7 +28,7 @@ docker run -v <oath to jmx>:/plans -v <path to pem>:/keys -v <path to logs>:/log
     --env AWS_SECRET_ACCESS_KEY=<access key> \
     --env AWS_DEFAULT_REGION=<region> \
     --env SECURITY_GROUP=<security group within your VPC> \
-    --env SUBNET_ID=<subnet ID within your VPC> \
+    --env SUBNET_ID=<subnet IDs within your VPC> \
     --env KEY_NAME=<key pair name without extension> \
     --env MINION_COUNT=<number of minions> \
     smithmicro/lucy /plans/demo.jmx
@@ -40,7 +40,7 @@ docker run -v $PWD/plans:/plans -v $PWD/keys:/keys -v $PWD/logs:/logs \
     --env AWS_SECRET_ACCESS_KEY=abcdefghijklmnopqrstuvwxyz0123456789ABCDEF \
     --env AWS_DEFAULT_REGION=us-east-1 \
     --env SECURITY_GROUP=sg-12345678 \
-    --env SUBNET_ID=subnet-12345678 \
+    --env SUBNET_ID=subnet-12345678,subnet-87654321 \
     --env KEY_NAME=jmeter-key \
     --env MINION_COUNT=5 \
     smithmicro/lucy /plans/demo.jmx
@@ -89,45 +89,12 @@ The `lucy` container uses 3 volumes:
 * `/keys` - mapped into the orchestrator to provide the PEM file
 * `/logs` - mapped into the orchestrator to provide the output jmeter.log and results.jtl
 
-## Local Testing with Docker Compose
-The `jmeter/docker-compose.yml` file allows for local testing of the Gru and Minion nodes without incurring costs from AWS.
-Edit the docker-compose.yml file and replicate the `links`, `environment` and `minionN` sections to increase the number of Minions to test.
-```
-version: '2'
-
-services:
-  gru:
-    ...
-    links: 
-      - minion1
-      - minion2
-      - minion3
-      - minion4
-    environment: 
-      - MINION_HOSTS=minion1,minion2,minion3,minion4
-    ...
-  minion1:
-    image: smithmicro/jmeter:latest
-  minion2:
-    image: smithmicro/jmeter:latest
-  minion3:
-    image: smithmicro/jmeter:latest
-  minion4:
-    image: smithmicro/jmeter:latest
-
-```
-Then run:
-```
-docker-compose up
-```
-Using the `docker-compose scale` command does not work as it creates hostnames like `minion_1`.  This causes an error in JMeter as it uses the hostname in URL form and sees the underscore as an illegal URL character.
-
 ## Environment Variables
 The following required and optional environment variables are supported:
 
 | Variable | Required | Default | Notes |
 |---|---|---|---|
-|AWS_DEFAULT_REGION|Yes|None|AWS Region (e.g. us-east-1)|
+|AWS_DEFAULT_REGION|Yes|None|AWS Region (e.g. `us-east-1`)|
 |AWS_ACCESS_KEY_ID|Yes|None|AWS Access Key|
 |AWS_SECRET_ACCESS_KEY|Yes|None|AWS Secret Key|
 |INPUT_JMX|Yes|None|File path of JMeter Test file to run (.jmx).  You can optionally specify this as the first command line option of `docker run`|
@@ -136,24 +103,20 @@ The following required and optional environment variables are supported:
 |SUBNET_ID|Yes|None|One or more Subnets (comma separated) that are assigned to your VPC|
 |VPC_ID||VPC assigned to SUBNET_ID|We dautomatically erive this from your SUBNET_ID|
 |JMETER_VERSION||latest|smithmicro/lucy Image tag.  See Docker Hub for [available versions](https://hub.docker.com/r/smithmicro/jmeter/tags/).|
-|INSTANCE_TYPE||t2.micro|To double your memory, pass t2.small|
-|MEM_LIMIT||950m|If you are using t2.small, set MEM_LIMIT to 1995m|
+|INSTANCE_TYPE||t2.micro|To double your memory, pass `t2.small`|
+|MEM_LIMIT||950m|If you are using t2.small, set MEM_LIMIT to `1995m`|
 |MINION_COUNT||2||
 |PEM_PATH||/keys|This must match your Volume map.  See Volume section above.|
 |CLUSTER_NAME||JMeter|Name that appears in your AWS Cluster UI|
-|GRU_PRIVATE_IP||(blank)|Set to true if you would like to run Lucy within AWS.  See GitHub [Issue 8](https://github.com/smithmicro/jmeter-ecs/issues/8) for details.|
+|GRU_PRIVATE_IP||None|Set to `true` if you would like to run Lucy within AWS.  See GitHub [Issue 8](https://github.com/smithmicro/jmeter-ecs/issues/8) for details.|
+|JMETER_FLAGS||None|Custom JMeter command line options.  For example, passing `-X` will tell the Minion to exit at the end of the test|
+|RETAIN_CLUSTER||None|Set to `true` if you want to re-use your cluster for future tests.  Warning, you will incur AWS charges if you leave your cluster running.|
 
 ## Notes
-This Docker image uses the Instance Metadata API documented here:
-* http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
-
-To get the instance public hostname within the `entrypoint.sh` script, we call:
-* `curl -s --max-time 5 http://169.254.169.254/latest/meta-data/public-hostname`
-
 For more information on JMeter Distributed Testing, see:
 * http://jmeter.apache.org/usermanual/remote-test.html
 
 ## Inspired by...
 https://en.wikipedia.org/wiki/Despicable_Me_2
 
-![Minions](https://pbs.twimg.com/tweet_video_thumb/C8CtmUbVwAAaboL.jpg "Minions")
+![Minions](https://pbs.twimg.com/tweet_video_thumb/C8CtmUbVwAAaboL.jpg "Minions")

jmeter/docker-compose.yml

@@ -1,5 +1,9 @@
 version: '2'
 
+# This compose file allows for local testing of the Gru and Minion nodes without incurring 
+# costs from AWS.  Edit the docker-compose.yml file and replicate the links, environment 
+# and minionN sections to increase the number of Minions to test.
+
 services:
   gru:
     build: .

lucy/Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine:3.5
+FROM alpine:3.7
 
 LABEL maintainer="David Sperling <[email protected]>"
 
@@ -9,6 +9,7 @@ ENV JMETER_FLAGS=
 ENV AWS_ACCESS_KEY_ID=
 ENV AWS_SECRET_ACCESS_KEY=
 ENV AWS_DEFAULT_REGION=
+ENV RETAIN_CLUSTER=
 
 # Install the AWS CLI
 RUN apk add --update --no-cache \

lucy/docker-compose.yml

@@ -12,7 +12,7 @@ services:
       # example values
       - KEY_NAME=123
       - SECURITY_GROUP=sg-12345678
-      - SUBNET_ID=subnet-12345678
+      - SUBNET_ID=subnet-12345678,subnet-87654321
       - AWS_DEFAULT_REGION=us-west-2
       - AWS_ACCESS_KEY_ID=123
       - AWS_SECRET_ACCESS_KEY=123

lucy/lucy.sh

@@ -71,10 +71,20 @@ fi
 
 # Step 1 - Create our ECS Cluster with MINION_COUNT+1 instances
 ecs-cli --version
-echo "Creating cluster/$CLUSTER_NAME"
+echo "Detecting existing cluster/$CLUSTER_NAME"
 INSTANCE_COUNT=$((MINION_COUNT+1))
-ecs-cli up --cluster $CLUSTER_NAME --size $INSTANCE_COUNT --capability-iam --instance-type $INSTANCE_TYPE --keypair $KEY_NAME \
-  --security-group $SECURITY_GROUP --vpc $VPC_ID --subnets $SUBNET_ID --force --verbose
+CONTAINER_INSTANCE_COUNT=$(aws ecs describe-clusters --cluster $CLUSTER_NAME \
+  --query 'clusters[*].[registeredContainerInstancesCount]' --output text)
+if [ "$CONTAINER_INSTANCE_COUNT" == $INSTANCE_COUNT ]; then
+  echo "Using existing cluster/$CLUSTER_NAME"
+else
+  if [ "$CONTAINER_INSTANCE_COUNT" != '0' ]; then
+    echo "Instance count is $CONTAINER_INSTANCE_COUNT, but requested instance count is $INSTANCE_COUNT"
+  fi
+  echo "Creating cluster/$CLUSTER_NAME"
+  ecs-cli up --cluster $CLUSTER_NAME --size $INSTANCE_COUNT --capability-iam --instance-type $INSTANCE_TYPE --keypair $KEY_NAME \
+    --security-group $SECURITY_GROUP --vpc $VPC_ID --subnets $SUBNET_ID --force --verbose
+fi
 
 # Step 2 - Wait for the cluster to have all container instances registered
 while true; do
@@ -107,7 +117,7 @@ MINION_INSTANCE_IDS=$(aws ecs describe-container-instances --cluster $CLUSTER_NA
 echo "Minion instances IDs: $MINION_INSTANCE_IDS"
 
 # Step 5 - Get IP addresses from Gru (Public or Private) and Minions (always Private)
-if [ "$GRU_PRIVATE_IP" = '' ]; then
+if [ "$GRU_PRIVATE_IP" == '' ]; then
   GRU_HOST=$(aws ec2 describe-instances --instance-ids $GRU_INSTANCE_ID \
       --query 'Reservations[*].Instances[*].[PublicIpAddress]' --output text | tr -d '\n')
 else
@@ -137,7 +147,10 @@ echo "Copying results from Gru"
 scp -r -i $PEM_PATH/$KEY_NAME.pem -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no ec2-user@${GRU_HOST}:/logs/* /logs
 
 # Step 7 - Delete the cluster
-echo "Deleting cluster/$CLUSTER_NAME"
-ecs-cli down --cluster $CLUSTER_NAME --force
-
+if [ "$RETAIN_CLUSTER" == '' ]; then
+  echo "Deleting cluster/$CLUSTER_NAME"
+  ecs-cli down --cluster $CLUSTER_NAME --force
+else
+  echo "cluster/$CLUSTER_NAME is retained upon request."
+fi
 echo "Complete"