Conform to function declaration standards

- declare desc variable
- declare all positional arguments
- set the cmd
- properly handle DOKKU_APP_NAME

commands

@@ -89,7 +89,7 @@ case "$1" in
       declare desc="return $PLUGIN_COMMAND_PREFIX plugin help content"
       cat<<help_content
     $PLUGIN_COMMAND_PREFIX:clone <name> <new-name>, Create container <new-name> then copy data from <name> into <new-name>
-    $PLUGIN_COMMAND_PREFIX:connect <name>, Connect via telnet to a $PLUGIN_SERVICE service
+    $PLUGIN_COMMAND_PREFIX:connect <name>, Connect via mongo to a $PLUGIN_SERVICE service
     $PLUGIN_COMMAND_PREFIX:create <name>, Create a $PLUGIN_SERVICE service
     $PLUGIN_COMMAND_PREFIX:destroy <name>, Delete the $PLUGIN_SERVICE service and stop its container if there are no links left
     $PLUGIN_COMMAND_PREFIX:export <name>, Export a dump of the $PLUGIN_SERVICE service database

subcommands/clone

@@ -5,11 +5,14 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-clone-cmd() {
-  [[ -z $2 ]] && dokku_log_fail "Please specify a name for the service"
+  declare desc="create container <new-name> then copy data from <name> into <new-name>"
-  [[ -z $3 ]] && dokku_log_fail "Please specify a name for the new service"
+  local cmd="$PLUGIN_COMMAND_PREFIX:clone" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  verify_service_name "$2"
+  declare SERVICE="$1" NEW_SERVICE="$2"
-  SERVICE="$2"
+
-  NEW_SERVICE="$3"
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  [[ -z "$NEW_SERVICE" ]] && dokku_log_fail "Please specify a name for the new service"
+
+  verify_service_name "$SERVICE"
   dokku "$PLUGIN_COMMAND_PREFIX:create" "$NEW_SERVICE"
   dokku_log_info1 "Copying data from $SERVICE to $NEW_SERVICE"
   dokku "$PLUGIN_COMMAND_PREFIX:export" "$SERVICE" | dokku "$PLUGIN_COMMAND_PREFIX:import" "$NEW_SERVICE" > /dev/null 2>&1 || true

subcommands/connect

@@ -5,9 +5,13 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-connect-cmd() {
-  [[ -z $2 ]] && dokku_log_fail "Please specify a name for the service"
+  declare desc="connect via mongo to a $PLUGIN_SERVICE service"
-  verify_service_name "$2"
+  local cmd="$PLUGIN_COMMAND_PREFIX:connect" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  SERVICE="$2"; SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
+  declare SERVICE="$1"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  verify_service_name "$SERVICE"
+  SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
   SERVICE_NAME="$(get_service_name "$SERVICE")"
   PASSWORD="$(cat "$SERVICE_ROOT/PASSWORD")"
   has_tty && SERVICE_TTY_OPTS="-t"

subcommands/create

@@ -5,9 +5,13 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-create-cmd() {
-  [[ -z $2 ]] && dokku_log_fail "Please specify a name for the service"
+  declare desc="create a $PLUGIN_SERVICE service"
-  [[ ! -d "$PLUGIN_DATA_ROOT/$2" ]] || dokku_log_fail "$PLUGIN_SERVICE service $2 already exists"
+  local cmd="$PLUGIN_COMMAND_PREFIX:create" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  SERVICE="$2"; SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"; LINKS_FILE="$SERVICE_ROOT/LINKS"
+  declare SERVICE="$1"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  [[ ! -d "$PLUGIN_DATA_ROOT/$SERVICE" ]] || dokku_log_fail "$PLUGIN_SERVICE service $SERVICE already exists"
+  SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"; LINKS_FILE="$SERVICE_ROOT/LINKS"
 
   if ! docker images | grep -e "^$PLUGIN_IMAGE " | grep -q " $PLUGIN_IMAGE_VERSION " ; then
     docker pull "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" || dokku_log_fail "$PLUGIN_SERVICE image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION pull failed"

subcommands/destroy

@@ -5,14 +5,18 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-destroy-cmd() {
-  [[ -z $2 ]] && dokku_log_fail "Please specify a name for the service"
+  declare desc="delete the $PLUGIN_SERVICE service and stop its container if there are no links left"
-  verify_service_name "$2"
+  local cmd="$PLUGIN_COMMAND_PREFIX:destroy" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  SERVICE="$2"; SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"; LINKS_FILE="$SERVICE_ROOT/LINKS"
+  declare SERVICE="$1" FORCE_DESTROY="$2"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  verify_service_name "$SERVICE"
+  SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"; LINKS_FILE="$SERVICE_ROOT/LINKS"
   SERVICE_NAME="$(get_service_name "$SERVICE")"
 
   [[ -s "$LINKS_FILE" ]] && dokku_log_fail "Cannot delete linked service"
 
-  [[ "$3" == "force" ]] && DOKKU_APPS_FORCE_DELETE=1
+  [[ "$FORCE_DESTROY" == "force" ]] && DOKKU_APPS_FORCE_DELETE=1
   if [[ -z "$DOKKU_APPS_FORCE_DELETE" ]]; then
     dokku_log_warn "WARNING: Potentially Destructive Action"
     dokku_log_warn "This command will destroy $SERVICE $PLUGIN_SERVICE service."
@@ -28,6 +32,7 @@ mongo-destroy-cmd() {
 
   dokku_log_info1 "Deleting $SERVICE"
   if [[ -n $(docker ps -aq -f name="$SERVICE_NAME") ]]; then
+    dokku_log_verbose_quiet "Deleting container data"
     service_stop "$SERVICE"
     sleep 1
 

subcommands/export

@@ -5,9 +5,13 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-export-cmd() {
-  [[ -z $2 ]] && dokku_log_fail "Please specify a name for the service"
+  declare desc="export a dump of the $PLUGIN_SERVICE service database"
-  verify_service_name "$2"
+  local cmd="$PLUGIN_COMMAND_PREFIX:export" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  SERVICE="$2"; SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
+  declare SERVICE="$1"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  verify_service_name "$SERVICE"
+  SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
   SERVICE_NAME="$(get_service_name "$SERVICE")"
   PASSWORD="$(cat "$SERVICE_ROOT/PASSWORD")"
 

subcommands/expose

@@ -5,9 +5,13 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-expose-cmd() {
-  [[ -z $2 ]] && dokku_log_fail "Please specify a name for the service"
+  declare desc="expose a $PLUGIN_SERVICE service on custom port if provided (random port otherwise)"
-  verify_service_name "$2"
+  local cmd="$PLUGIN_COMMAND_PREFIX:expose" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  service_port_expose "$2" "${@:3}"
+  declare SERVICE="$1"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  verify_service_name "$SERVICE"
+  service_port_expose "$SERVICE" "${@:2}"
 }
 
 mongo-expose-cmd "$@"

subcommands/import

@@ -5,9 +5,13 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-import-cmd() {
-  [[ -z $2 ]] && dokku_log_fail "Please specify a name for the service"
+  declare desc="import a dump into the $PLUGIN_SERVICE service database"
-  verify_service_name "$2"
+  local cmd="$PLUGIN_COMMAND_PREFIX:import" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  SERVICE="$2"; SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
+  declare SERVICE="$1"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  verify_service_name "$SERVICE"
+  SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
   SERVICE_NAME="$(get_service_name "$SERVICE")"
   PASSWORD="$(cat "$SERVICE_ROOT/PASSWORD")"
 

subcommands/info

@@ -5,9 +5,13 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-info-cmd() {
-  [[ -z $2 ]] && dokku_log_fail "Please specify a name for the service"
+  declare desc="print the connection information"
-  verify_service_name "$2"
+  local cmd="$PLUGIN_COMMAND_PREFIX:info" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  service_info "$2"
+  declare SERVICE="$1"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  verify_service_name "$SERVICE"
+  service_info "$SERVICE"
 }
 
 mongo-info-cmd "$@"

subcommands/link

@@ -5,11 +5,16 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-link-cmd() {
-  [[ -z $2 ]] && dokku_log_fail "Please specify a name for the service"
+  declare desc="link the $PLUGIN_SERVICE service to the app"
-  [[ -z $3 ]] && dokku_log_fail "Please specify an app to run the command on"
+  local cmd="$PLUGIN_COMMAND_PREFIX:link" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  verify_app_name "$3"
+  declare SERVICE="$1" APP="$2"
-  verify_service_name "$2"
+  APP=${APP:="$DOKKU_APP_NAME"}
-  service_link "$2" "$3"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  [[ -z "$APP" ]] && dokku_log_fail "Please specify an app to run the command on"
+  verify_app_name "$APP"
+  verify_service_name "$SERVICE"
+  service_link "$SERVICE" "$APP"
 }
 
 mongo-link-cmd "$@"

subcommands/list

@@ -5,6 +5,9 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-list-cmd() {
+  declare desc="list all $PLUGIN_SERVICE services"
+  local cmd="$PLUGIN_COMMAND_PREFIX:list" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+
   service_list
 }
 

subcommands/logs

@@ -5,9 +5,13 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-logs-cmd() {
-  [[ -z $2 ]] && dokku_log_fail "Please specify a name for the service"
+  declare desc="print the most recent log(s) for this service"
-  verify_service_name "$2"
+  local cmd="$PLUGIN_COMMAND_PREFIX:logs" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  service_logs "$2" "$3"
+  declare SERVICE="$1" TAIL="$2"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  verify_service_name "$SERVICE"
+  service_logs "$SERVICE" "$TAIL"
 }
 
 mongo-logs-cmd "$@"

subcommands/promote

@@ -5,11 +5,16 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-promote-cmd() {
-  [[ -z $2 ]] && dokku_log_fail "Please specify a name for the service"
+  declare desc="promote service <name> as ${PLUGIN_DEFAULT_ALIAS}_URL in <app>"
-  [[ -z $3 ]] && dokku_log_fail "Please specify an app to run the command on"
+  local cmd="$PLUGIN_COMMAND_PREFIX:promote" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  verify_service_name "$2"
+  declare SERVICE="$1" APP="$2"
-  verify_app_name "$3"
+  APP=${APP:="$DOKKU_APP_NAME"}
-  promote "$2" "$3"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  [[ -z "$APP" ]] && dokku_log_fail "Please specify an app to run the command on"
+  verify_service_name "$SERVICE"
+  verify_app_name "$APP"
+  promote "$SERVICE" "$APP"
 }
 
 mongo-promote-cmd "$@"

subcommands/restart

@@ -5,10 +5,14 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-restart-cmd() {
-  [[ -z $2 ]] && dokku_log_fail "Please specify a name for the service"
+  declare desc="graceful shutdown and restart of the $PLUGIN_SERVICE service container"
-  verify_service_name "$2"
+  local cmd="$PLUGIN_COMMAND_PREFIX:restart" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  service_stop "$2"
+  declare SERVICE="$1"
-  service_start "$2"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  verify_service_name "$SERVICE"
+  service_stop "$SERVICE"
+  service_start "$SERVICE"
   dokku_log_info1 "Please call dokku ps:restart on all linked apps"
 }
 

subcommands/start

@@ -5,9 +5,13 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-start-cmd() {
-  [[ -z $2 ]] && dokku_log_fail "Please specify a name for the service"
+  declare desc="start a previously stopped $PLUGIN_SERVICE service"
-  verify_service_name "$2"
+  local cmd="$PLUGIN_COMMAND_PREFIX:start" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  service_start "$2"
+  declare SERVICE="$1"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  verify_service_name "$SERVICE"
+  service_start "$SERVICE"
 }
 
 mongo-start-cmd "$@"

subcommands/stop

@@ -5,9 +5,13 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-stop-cmd() {
-  [[ -z $2 ]] && dokku_log_fail "Please specify a name for the service"
+  declare desc="stop a running $PLUGIN_SERVICE service"
-  verify_service_name "$2"
+  local cmd="$PLUGIN_COMMAND_PREFIX:stop" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  service_stop "$2"
+  declare SERVICE="$1"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  verify_service_name "$SERVICE"
+  service_stop "$SERVICE"
 }
 
 mongo-stop-cmd "$@"

subcommands/unexpose

@@ -5,9 +5,13 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-unexpose-cmd() {
-  [[ -z $2 ]] && dokku_log_fail "Please specify a name for the service"
+  declare desc="unexpose a previously exposed $PLUGIN_SERVICE service"
-  verify_service_name "$2"
+  local cmd="$PLUGIN_COMMAND_PREFIX:unexpose" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  service_port_unexpose "$2"
+  declare SERVICE="$1"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  verify_service_name "$SERVICE"
+  service_port_unexpose "$SERVICE"
 }
 
 mongo-unexpose-cmd "$@"

subcommands/unlink

@@ -5,11 +5,16 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 mongo-unlink-cmd() {
-  [[ -z $2 ]] && dokku_log_fail "Please specify a name for the service"
+  declare desc="unlink the $PLUGIN_SERVICE service from the app"
-  [[ -z $3 ]] && dokku_log_fail "Please specify an app to run the command on"
+  local cmd="$PLUGIN_COMMAND_PREFIX:unlink" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
-  verify_app_name "$3"
+  declare SERVICE="$1" APP="$2"
-  verify_service_name "$2"
+  APP=${APP:="$DOKKU_APP_NAME"}
-  service_unlink "$2" "$3"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  [[ -z "$APP" ]] && dokku_log_fail "Please specify an app to run the command on"
+  verify_app_name "$APP"
+  verify_service_name "$SERVICE"
+  service_unlink "$SERVICE" "$APP"
 }
 
 mongo-unlink-cmd "$@"