From 655342e219dfc6d66d6a3248583bbd0968a03337 Mon Sep 17 00:00:00 2001
From: Sameer Naik <sameer@damagehead.com>
Date: Thu, 5 Nov 2015 22:17:00 +0530
Subject: [PATCH] tests: rewrite tests for better maintenance and readability

 - Reuse docker_helper.bash script in tests
 - Speed up of tests
 - Better readability
---
 bitnami/ruby/test.sh                  |  84 ++++++------
 bitnami/ruby/tests/docker_helper.bash | 177 ++++++++++++++++++++++++++
 2 files changed, 225 insertions(+), 36 deletions(-)
 create mode 100644 bitnami/ruby/tests/docker_helper.bash

diff --git a/bitnami/ruby/test.sh b/bitnami/ruby/test.sh
index 39a8a6b67fc0..40702de1e6df 100644
--- a/bitnami/ruby/test.sh
+++ b/bitnami/ruby/test.sh
@@ -1,14 +1,46 @@
 #!/usr/bin/env bats
-CONTAINER_NAME=bitnami-ruby-test
-IMAGE_NAME=bitnami/ruby
-VOL_PREFIX=/bitnami/$CONTAINER_NAME
 
-create_container(){
-  docker run -itd --name $CONTAINER_NAME $IMAGE_NAME
+# source the helper script
+APP_NAME=ruby
+VOLUMES=/app
+SLEEP_TIME=0
+load tests/docker_helper
+
+# Cleans up all running/stopped containers
+cleanup_environment() {
+  container_remove default
 }
 
-add_app() {
-  docker exec $CONTAINER_NAME sh -c "echo \"
+# Teardown called at the end of each test
+teardown() {
+  cleanup_environment
+}
+
+# cleanup the environment before starting the tests
+cleanup_environment
+
+@test "ruby, gem and bundler installed" {
+  container_create default -id
+
+  run container_exec default ruby -v
+  [ "$status" = 0 ]
+  run container_exec default gem -v
+  [ "$status" = 0 ]
+  run container_exec default bundle -v
+  [ "$status" = 0 ]
+}
+
+@test "can install gem modules with system requirements" {
+  container_create default -id
+  run container_exec default gem install nokogiri --no-ri --no-rdoc
+  [ "$status" = 0 ]
+}
+
+@test "port 3000 exposed" {
+  container_create default -id
+
+  # create sample sinatra application
+  container_exec default sh -c "cat > /app/server.rb <<EOF
 require 'sinatra'
 
 set :bind, '0.0.0.0'
@@ -16,37 +48,17 @@ set :port, 3000
 
 get '/hi' do
   'A Lanister always pays his debts'
-end\" > /app/server.rb"
-}
+end
+EOF"
 
-setup () {
-  create_container
-}
+  # install application dependencies
+  container_exec default gem install sinatra --no-ri --no-rdoc
 
-teardown() {
-  if [ "$(docker ps -a | grep $CONTAINER_NAME)" ]; then
-    docker rm -fv $CONTAINER_NAME
-  fi
-}
+  # start application and wait 5 secs for app to boot up
+  container_exec_detached default ruby server.rb
+  sleep 5
 
-@test "ruby, gem and bundler installed" {
-  run docker exec $CONTAINER_NAME ruby -v
-  [ "$status" = 0 ]
-  run docker exec $CONTAINER_NAME gem -v
-  [ "$status" = 0 ]
-  run docker exec $CONTAINER_NAME bundle -v
-  [ "$status" = 0 ]
-}
-
-@test "can install gem modules with system requirements" {
-  run docker exec $CONTAINER_NAME gem install nokogiri --no-ri --no-rdoc
-  [ "$status" = 0 ]
-}
-
-@test "port 3000 exposed" {
-  add_app
-  docker exec -d $CONTAINER_NAME sh -c 'gem install sinatra --no-ri --no-rdoc && ruby server.rb'
-  sleep 10
-  run docker run --rm --link $CONTAINER_NAME:ruby bitnami/ruby curl http://ruby:3000/hi
+  # test application using curl
+  run curl_client default http://ruby:3000/hi
   [[ "$output" =~ "A Lanister always pays his debts" ]]
 }
diff --git a/bitnami/ruby/tests/docker_helper.bash b/bitnami/ruby/tests/docker_helper.bash
new file mode 100644
index 000000000000..2458bff7ddd1
--- /dev/null
+++ b/bitnami/ruby/tests/docker_helper.bash
@@ -0,0 +1,177 @@
+#!/bin/bash
+
+##
+# Reusable helper script to do docker things in your tests
+##
+# The following variables should be defined in you BATS script for this helper
+# script to work correctly.
+#
+# APP_NAME                                    - app name, also used as the link alias in container_link_and_run_command
+# CONTAINER_NAME                              - prefix for the name of containers that will be created (default: bitnami-$APP_NAME-test)
+# IMAGE_NAME                                  - the docker image name (default: bitnami/$APP_NAME)
+# SLEEP_TIME                                  - time in seconds to wait for containers to start (default: 5)
+# VOL_PREFIX                                  - prefix of volumes inside the container (default: /bitnami/$APP_NAME)
+# VOLUMES                                     - colon separated list of container volumes (default: $VOL_PREFIX/data:$VOL_PREFIX/conf:$VOL_PREFIX/logs)
+# HOST_VOL_PREFIX                             - prefix of volumes mounted from the host (default: /tmp/bitnami/$CONTAINER_NAME)
+# container_link_and_run_command_DOCKER_ARGS  - optional arguments passed to docker run in container_link_and_run_command (default: none)
+##
+
+CONTAINER_NAME=bitnami-$APP_NAME-test
+IMAGE_NAME=${IMAGE_NAME:-bitnami/$APP_NAME}
+SLEEP_TIME=${SLEEP_TIME:-5}
+VOL_PREFIX=${VOL_PREFIX:-/bitnami/$APP_NAME}
+VOLUMES=${VOLUMES:-$VOL_PREFIX/data:$VOL_PREFIX/conf:$VOL_PREFIX/logs}
+HOST_VOL_PREFIX=${HOST_VOL_PREFIX:-/tmp/bitnami/$CONTAINER_NAME}
+
+# Creates a container whose name has the prefix $CONTAINER_NAME
+# $1: name for the new container
+# ${@:2}: additional arguments for docker run while starting the container
+container_create() {
+  docker run --name $CONTAINER_NAME-$1 "${@:2}" $IMAGE_NAME
+  sleep $SLEEP_TIME
+}
+
+# Creates a container with host mounted volumes for volumes listed in VOLUMES
+# $1: name for the new container
+# ${@:2}: additional arguments for docker run while starting the container
+container_create_with_host_volumes() {
+  # populate volume mount arguments from VOLUMES variable
+  VOLUME_ARGS=
+  OLD_IFS=${IFS}
+  IFS=":"
+  for VOLUME in $VOLUMES
+  do
+    VOL_NAME=$(basename $VOLUME)
+    VOLUME_ARGS+="-v $HOST_VOL_PREFIX/$1/$VOL_NAME:$VOLUME "
+  done
+  IFS=${OLD_IFS}
+
+  container_create $1 "${@:2}" $VOLUME_ARGS
+}
+
+# Start a stopped container
+# $1: name of the container
+container_start() {
+  if docker ps -a | grep -q $CONTAINER_NAME-$1; then
+    docker start $CONTAINER_NAME-$1
+    sleep $SLEEP_TIME
+  else
+    return 1
+  fi
+}
+
+# Stop a running container
+# $1: name of the container
+container_stop() {
+  if docker ps | grep -q $CONTAINER_NAME-$1; then
+    docker stop $CONTAINER_NAME-$1
+  else
+    return 1
+  fi
+}
+
+# Restart a running container (stops the container and then starts it)
+# $1: name of the container
+container_restart() {
+  if docker ps | grep -q $CONTAINER_NAME-$1; then
+    docker stop $CONTAINER_NAME-$1
+    docker start $CONTAINER_NAME-$1
+    sleep $SLEEP_TIME
+  fi
+}
+
+# Remove a running/stopped container
+# $1: name of the container
+container_remove() {
+  if docker ps -a | grep -q $CONTAINER_NAME-$1; then
+    docker stop $CONTAINER_NAME-$1
+    docker rm -v $CONTAINER_NAME-$1
+  fi
+}
+
+# Remove a running/stopped container and clear host volumes
+# $1: name of the container
+container_remove_full() {
+  container_remove $1
+
+  # populate volume mount and rm arguments from VOLUMES variable
+  VOLUME_ARGS=
+  RM_ARGS=
+  OLD_IFS=${IFS}
+  IFS=":"
+  for VOLUME in $VOLUMES
+  do
+    VOL_NAME=$(basename $VOLUME)
+    VOLUME_ARGS+="-v $HOST_VOL_PREFIX/$1/$VOL_NAME:$VOLUME "
+    RM_ARGS+="$VOLUME/* $VOLUME/.[^.]* "
+  done
+  IFS=${OLD_IFS}
+
+  docker run --rm --entrypoint bash $VOLUME_ARGS \
+      $IMAGE_NAME -c "rm -rf $RM_ARGS"
+}
+
+# Get the logs of a container
+# $1: name of the container
+container_logs() {
+  if docker ps -a | grep -q $CONTAINER_NAME-$1; then
+    docker logs $CONTAINER_NAME-$1
+  else
+    return 1
+  fi
+}
+
+# Docker inspect a container
+# $1: name of the container
+container_inspect() {
+  if docker ps -a | grep -q $CONTAINER_NAME-$1; then
+    # docker inspect "${@:2}" $CONTAINER_NAME-$1 # requires docker >= 1.9.0
+    docker inspect $CONTAINER_NAME-$1
+  else
+    return 1
+  fi
+}
+
+# Execute a command in a running container using docker exec
+# $1: name of the container
+container_exec() {
+  if docker ps | grep -q $CONTAINER_NAME-$1; then
+    docker exec $CONTAINER_NAME-$1 "${@:2}"
+  else
+    return 1
+  fi
+}
+
+# Execute a command in a running container using docker exec (detached)
+# $1: name of the container
+container_exec_detached() {
+  if docker ps | grep -q $CONTAINER_NAME-$1; then
+    docker exec -d $CONTAINER_NAME-$1 "${@:2}"
+  else
+    return 1
+  fi
+}
+
+# Generates docker link parameter for linking to a container
+# $1: name of the container to link
+# $2: alias for the link
+container_link() {
+  if docker ps -a | grep -q $CONTAINER_NAME-$1; then
+    echo "--link $CONTAINER_NAME-$1:$2"
+  fi
+}
+
+# Link to container and execute command
+# $1: name of the container to link to
+# ${@:2}: command to execute
+container_link_and_run_command() {
+  # launch command as the entrypoint to skip the s6 init sequence (speeds up the tests)
+  docker run --rm $(container_link $1 $APP_NAME) $container_link_and_run_command_DOCKER_ARGS --entrypoint ${2} $IMAGE_NAME "${@:3}"
+}
+
+# Link to container and execute curl
+# $1: name of the container to link to
+# ${@:2}: arguments to curl
+curl_client() {
+  container_link_and_run_command $1 curl --noproxy $APP_NAME --retry 5 -L "${@:2}"
+}