Add support for older versions of Docker compose and improve code docs

start.sh

@@ -1,6 +1,13 @@
-#!/bin/bash
+#!/usr/bin/env bash
+#
+# start.sh - is the main start script for our Demo cluster. Running it will launch a docker-compose environment
+# that contains a fully connected ioFog ECN. Optionally, you can launch a different compose, e.g. tutorial.
+#
+# Usage : ./start.sh -h
+#
 
 set -o errexit -o pipefail -o noclobber -o nounset
+
 cd "$(dirname "$0")"
 
 # Import our helper functions
@@ -22,7 +29,7 @@ printHelp() {
 	echo "                      supported values: iofog, tutorial"
 }
 
-checkComposeFile() {
+checkForComposeFile() {
     local ENVIRONMENT="$1"
     local COMPOSE_FILE="docker-compose-${ENVIRONMENT}.yml"
     if [[ ! -f "${COMPOSE_FILE}" ]]; then
@@ -35,7 +42,8 @@ startIofog() {
     echoInfo "Building containers for ioFog stack..."
     local BUILD_ARGS="--build-arg LOCAL_CONTROLLER_PACKAGE=${CONTROLLER_PACKAGE} --build-arg LOCAL_CONNECTOR_PACKAGE=${CONNECTOR_PACKAGE} --build-arg LOCAL_AGENT_PACKAGE=${AGENT_PACKAGE}"
     local COMPOSE_BUILD_ARGS="${IOFOG_BUILD_NO_CACHE} ${BUILD_ARGS:=""}"
-    docker-compose -f "docker-compose-iofog.yml" build ${COMPOSE_BUILD_ARGS} > /dev/null
+    local SERVICE_LIST="iofog-connector iofog-controller iofog-agent iofog-init"
+    docker-compose -f "docker-compose-iofog.yml" build ${COMPOSE_BUILD_ARGS} ${SERVICE_LIST} > /dev/null
 
     echoInfo "Spinning up containers for ioFog stack..."
     docker-compose -f "docker-compose-iofog.yml" up --detach --no-recreate
@@ -117,12 +125,17 @@ while [[ "$#" -ge 1 ]]; do
             ;;
     esac
 done
-ENVIRONMENT=${ENVIRONMENT:="iofog"} # by default, setup only the ioFog stack
 
-prettyHeader "Starting ioFog Demo (\"${ENVIRONMENT}\" environment)..."
+prettyHeader "Starting ioFog Demo"
+
+# Figure out which environment we are going to be starting. By default, setup only the ioFog stack
+ENVIRONMENT=${ENVIRONMENT:="iofog"}
+
+checkForComposeFile "iofog"
+
+if [[ "${ENVIRONMENT}" != "iofog" ]]; then checkForComposeFile "${ENVIRONMENT}"; fi
 
-checkComposeFile "iofog"
-if [[ "${ENVIRONMENT}" != "iofog" ]]; then checkComposeFile "${ENVIRONMENT}"; fi
+echoInfo "Starting \"${ENVIRONMENT}\" demo environment..."
 
 # Create a new ssh key
 echoInfo "Creating new ssh key for tests..."

status.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 #
-# status.sh - Print the status of the Demo cluster and it's components
+# status.sh - Print the status of the Demo cluster and its components
 #
 # Usage: ./status.sh
 #

stop.sh

@@ -1,6 +1,12 @@
-#!/bin/bash
+#!/usr/bin/env bash
+#
+# stop.sh - will tear down a running docker-compose Demo environment
+#
+# Usage : ./stop.sh -h
+#
 
 set -o errexit -o pipefail -o noclobber -o nounset
+
 cd "$(dirname "$0")"
 
 # Import our helper functions

test.sh

@@ -1,4 +1,9 @@
-#!/bin/bash
+#!/usr/bin/env bash
+#
+# test.sh - will pull and run the TestRunner suite against an already Demo compose cluster.
+#
+# Usage : ./test.sh -h
+#
 
 set -o errexit -o pipefail -o noclobber -o nounset
 cd "$(dirname "$0")"
@@ -34,6 +39,7 @@ echoInfo "Retrieving endpoints for ioFog stack"
 AGENT_IP=$(docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' iofog-agent)
 CONTROLLER_IP=$(docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' iofog-controller)
 CONNECTOR_IP=$(docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' iofog-connector)
+
 # Output the config for our Test suite config
 echo "${CONNECTOR_IP}:8080" >| test/conf/connector.conf
 echo "${CONTROLLER_IP}:51121" >| test/conf/controller.conf

utils.sh

@@ -1,8 +1,9 @@
 #!/usr/bin/env sh
+#
 # utils.sh - a simple set of functions for use throughout our bash scripts
 #
 # Usage : source utils.sh
-
+#
 
 # Export the name of the script for later use
 THIS_SCRIPT="$(basename "${0}")"
@@ -11,6 +12,7 @@ export THIS_SCRIPT
 #
 # Check for DEBUG - looks for the DEBUG environment variable. If it
 # is found, it enables more debugging output.
+#
 checkForDebug() {
 
 	# Allow anyone to set a DEBUG environment variable for extra output