Release 1.26.0

Add :pause subcommand and make :stop subcommand actually remove the container

Dockerfile

@@ -1 +1 @@
-FROM mysql:8.0.29
+FROM mysql:8.0.31

README.md

@@ -1,6 +1,6 @@
 # dokku mysql [![Build Status](https://img.shields.io/github/workflow/status/dokku/dokku-mysql/CI/master?style=flat-square "Build Status")](https://github.com/dokku/dokku-mysql/actions/workflows/ci.yml?query=branch%3Amaster) [![IRC Network](https://img.shields.io/badge/irc-libera-blue.svg?style=flat-square "IRC Libera")](https://webchat.libera.chat/?channels=dokku)
 
-Official mysql plugin for dokku. Currently defaults to installing [mysql 8.0.29](https://hub.docker.com/_/mysql/).
+Official mysql plugin for dokku. Currently defaults to installing [mysql 8.0.31](https://hub.docker.com/_/mysql/).
 
 ## Requirements
 
@@ -41,6 +41,7 @@ mysql:linked <service> <app>                       # check if the mysql service
 mysql:links <service>                              # list all apps linked to the mysql service
 mysql:list                                         # list all mysql services
 mysql:logs <service> [-t|--tail] <tail-num-optional> # print the most recent log(s) for this service
+mysql:pause <service>                              # pause a running mysql service
 mysql:promote <service> <app>                      # promote service <service> as DATABASE_URL in <app>
 mysql:restart <service>                            # graceful shutdown and restart of the mysql service container
 mysql:start <service>                              # start a previously stopped mysql service
@@ -370,12 +371,25 @@ dokku mysql:start lollipop
 dokku mysql:stop <service>
 ```
 
-Stop the service and the running container:
+Stop the service and removes the running container:
 
 ```shell
 dokku mysql:stop lollipop
 ```
 
+### pause a running mysql service
+
+```shell
+# usage
+dokku mysql:pause <service>
+```
+
+Pause the running container for the service:
+
+```shell
+dokku mysql:pause lollipop
+```
+
 ### graceful shutdown and restart of the mysql service container
 
 ```shell

bin/generate

@@ -148,6 +148,7 @@ def usage_lifecycle(service, variable, alias, image, scheme, ports, options, uni
         "promote",
         "start",
         "stop",
+        "pause",
         "restart",
         "upgrade",
     ]

common-functions

@@ -48,17 +48,27 @@ auth_service_filter() {
   export SSH_USER=${SSH_USER:=$USER}
   export SSH_NAME=${NAME:="default"}
   # the output of this trigger should be all the services a user has access to
-  plugn trigger user-auth-service "$SSH_USER" "$SSH_NAME" "${SERVICES[@]}"
+  plugn trigger user-auth-service "$SSH_USER" "$SSH_NAME" "$PLUGIN_COMMAND_PREFIX" "${SERVICES[@]}"
 }
 
 fn-services-list() {
   declare desc="prints a filtered list of all local apps"
   declare FILTER="$1"
-  local detected_services filtered_services services
+  local services=()
+
+  pushd "$PLUGIN_DATA_ROOT" >/dev/null
+  for f in *; do
+    [[ -d $f ]] || continue
+    services+=("$f")
+  done
+  popd &>/dev/null || pushd "/tmp" >/dev/null
+
+  if [[ "${#services[@]}" -eq 0 ]]; then
+    return
+  fi
 
-  local detected_services=("$(ls "$PLUGIN_DATA_ROOT" 2>/dev/null)")
   if [[ "$FILTER" == "false" ]]; then
-    for service in "${detected_services[@]}"; do
+    for service in "${services[@]}"; do
       if [[ -n "$service" ]]; then
         echo "$service"
       fi
@@ -66,8 +76,7 @@ fn-services-list() {
     return
   fi
 
-  filtered_services="$(auth_service_filter "${detected_services[@]}" 2>/dev/null)"
-  for service in "$filtered_services"; do
+  for service in $(auth_service_filter "${services[@]}" 2>/dev/null); do
     if [[ -n "$service" ]]; then
       echo "$service"
     fi
@@ -235,13 +244,14 @@ service_alternative_alias() {
 service_app_links() {
   declare desc="output all service links for a given app"
   declare APP="$1"
-  local SERVICE LINKED_APP
+  local LINKED_APP SERVICE SERVICE_ROOT
 
-  pushd "$PLUGIN_DATA_ROOT" >/dev/null
-  for SERVICE in $(fn-services-list); do
+  for SERVICE in $(fn-services-list true); do
     [[ -n "$SERVICE" ]] || continue
-    [[ -f "$SERVICE/LINKS" ]] || continue
-    for LINKED_APP in $(<"$SERVICE/LINKS"); do
+
+    SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
+    [[ -f "$SERVICE_ROOT/LINKS" ]] || continue
+    for LINKED_APP in $(<"$SERVICE_ROOT/LINKS"); do
       if [[ "$LINKED_APP" == "$APP" ]]; then
         echo "$SERVICE"
       fi
@@ -307,7 +317,6 @@ service_commit_config() {
   local CONFIG_VARIABLE="${PLUGIN_VARIABLE}_CONFIG_OPTIONS"
   local ENV_VARIABLE="${PLUGIN_VARIABLE}_CUSTOM_ENV"
 
-
   custom_env="${!ENV_VARIABLE}"
   [[ -n "$SERVICE_CUSTOM_ENV" ]] && custom_env="$SERVICE_CUSTOM_ENV"
   if [[ -n $custom_env ]]; then
@@ -434,7 +443,7 @@ service_container_rm() {
   local SERVICE_NAME="$(get_service_name "$SERVICE")"
   local ID
 
-  service_stop "$SERVICE"
+  service_pause "$SERVICE"
   ID=$(docker ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
   # this may be 'true' in tests...
   if [[ -z "$ID" ]] || [[ "$ID" == "true" ]]; then
@@ -588,7 +597,7 @@ service_link() {
   fi
 
   [[ -n $LINK ]] && dokku_log_fail "Already linked as $LINK"
-  plugn trigger service-action pre-link "$SERVICE" "$APP"
+  plugn trigger service-action pre-link "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
   add_to_links_file "$SERVICE" "$APP"
 
   if declare -f -F add_passed_docker_option >/dev/null; then
@@ -599,13 +608,13 @@ service_link() {
     dokku docker-options:add "$APP" build,deploy,run "--link $SERVICE_NAME:$SERVICE_DNS_HOSTNAME"
   fi
   [[ -n "$SERVICE_QUERYSTRING" ]] && SERVICE_URL="${SERVICE_URL}?${SERVICE_QUERYSTRING}"
-  plugn trigger service-action post-link "$SERVICE" "$APP"
+  plugn trigger service-action post-link "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
   if [[ "$DOKKU_GLOBAL_FLAGS" == *"--no-restart"* ]]; then
     config_set --no-restart "$APP" "${ALIAS}_URL=$SERVICE_URL"
   else
     config_set "$APP" "${ALIAS}_URL=$SERVICE_URL"
   fi
-  plugn trigger service-action post-link-complete "$SERVICE" "$APP"
+  plugn trigger service-action post-link-complete "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
 }
 
 service_linked_apps() {
@@ -635,7 +644,7 @@ service_links() {
 service_list() {
   declare desc="list all services and their status"
 
-  services=("$(fn-services-list true)")
+  mapfile -t services < <(fn-services-list true)
   if [[ "${#services[@]}" -eq 0 ]] || [[ -z "$services" ]]; then
     dokku_log_warn "There are no $PLUGIN_SERVICE services"
     return
@@ -643,7 +652,7 @@ service_list() {
 
   dokku_log_info2_quiet "$PLUGIN_SERVICE services"
   for service in "${services[@]}"; do
-    echo "$service"
+    echo "${service}"
   done
 }
 
@@ -887,19 +896,19 @@ service_status() {
   echo "missing" && return 0
 }
 
-service_stop() {
-  declare desc="stop a running service"
+service_pause() {
+  declare desc="pause a running service"
   declare SERVICE="$1"
   local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
   local SERVICE_NAME="$(get_service_name "$SERVICE")"
   local ID=$(docker ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
-  [[ -z $ID ]] && dokku_log_warn "Service is already stopped" && return 0
+  [[ -z $ID ]] && dokku_log_warn "Service is already paused" && return 0
 
   if [[ -n $ID ]]; then
-    dokku_log_info2_quiet "Stopping container"
+    dokku_log_info2_quiet "Pausing container"
     docker stop "$SERVICE_NAME" >/dev/null
     service_port_pause "$SERVICE"
-    dokku_log_verbose_quiet "Container stopped"
+    dokku_log_verbose_quiet "Container paused"
   else
     dokku_log_verbose_quiet "No container exists for $SERVICE"
   fi
@@ -915,7 +924,7 @@ service_unlink() {
   local SERVICE_DNS_HOSTNAME=$(service_dns_hostname "$SERVICE")
   local LINK=($(echo "$EXISTING_CONFIG" | grep "$SERVICE_URL" | cut -d: -f1)) || true
 
-  plugn trigger service-action pre-unlink "$SERVICE" "$APP"
+  plugn trigger service-action pre-unlink "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
   remove_from_links_file "$SERVICE" "$APP"
 
   if declare -f -F add_passed_docker_option >/dev/null; then
@@ -927,13 +936,13 @@ service_unlink() {
   fi
 
   [[ -z ${LINK[*]} ]] && dokku_log_fail "Not linked to app $APP"
-  plugn trigger service-action post-unlink "$SERVICE" "$APP"
+  plugn trigger service-action post-unlink "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
   if [[ "$DOKKU_GLOBAL_FLAGS" == *"--no-restart"* ]]; then
     config_unset --no-restart "$APP" "${LINK[@]}"
   else
     config_unset "$APP" "${LINK[@]}"
   fi
-  plugn trigger service-action post-unlink-complete "$SERVICE" "$APP"
+  plugn trigger service-action post-unlink-complete "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "$APP"
 }
 
 service_version() {

config

@@ -27,9 +27,9 @@ if [[ -n $DOKKU_API_VERSION ]]; then
   export PLUGIN_BASE_PATH="$PLUGIN_ENABLED_PATH"
 fi
 
-export PLUGIN_BUSYBOX_IMAGE="busybox:1.31.1-uclibc"
-export PLUGIN_AMBASSADOR_IMAGE="dokku/ambassador:0.3.3"
-export PLUGIN_S3BACKUP_IMAGE="dokku/s3backup:0.10.3"
-export PLUGIN_WAIT_IMAGE="dokku/wait:0.4.3"
+export PLUGIN_BUSYBOX_IMAGE="busybox:1.34.1-uclibc"
+export PLUGIN_AMBASSADOR_IMAGE="dokku/ambassador:0.5.0"
+export PLUGIN_S3BACKUP_IMAGE="dokku/s3backup:0.14.0"
+export PLUGIN_WAIT_IMAGE="dokku/wait:0.6.0"
 
 export MYSQL_CONFIG_OPTIONS=${MYSQL_CONFIG_OPTIONS:=""}

functions

@@ -41,7 +41,7 @@ service_create() {
     docker pull "$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION" || dokku_log_fail "$PLUGIN_SERVICE image $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION pull failed"
   fi
 
-  plugn trigger service-action pre-create "$SERVICE"
+  plugn trigger service-action pre-create "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
   mkdir -p "$SERVICE_ROOT" || dokku_log_fail "Unable to create service directory"
   mkdir -p "$SERVICE_ROOT/data" || dokku_log_fail "Unable to create service data directory"
   mkdir -p "$SERVICE_ROOT/$PLUGIN_CONFIG_SUFFIX" || dokku_log_fail "Unable to create service config directory"
@@ -65,9 +65,9 @@ service_create() {
 
   service_commit_config "$SERVICE"
   write_database_name "$SERVICE"
-  plugn trigger service-action post-create "$SERVICE"
+  plugn trigger service-action post-create "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
   service_create_container "$SERVICE"
-  plugn trigger service-action post-create-complete "$SERVICE"
+  plugn trigger service-action post-create-complete "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
 }
 
 service_create_container() {
@@ -117,7 +117,7 @@ service_export() {
 
   [[ -n $SSH_TTY ]] && stty -opost
   docker exec "$SERVICE_NAME" bash -c "printf '[client]\ndefault-character-set=utf8mb4\npassword=$PASSWORD\n' > /root/credentials.cnf"
-  docker exec "$SERVICE_NAME" mysqldump --defaults-extra-file=/root/credentials.cnf --user=mysql --single-transaction --quick "$DATABASE_NAME"
+  docker exec "$SERVICE_NAME" mysqldump --defaults-extra-file=/root/credentials.cnf --user=mysql --single-transaction --no-tablespaces --quick "$DATABASE_NAME"
   docker exec "$SERVICE_NAME" rm /root/credentials.cnf
   status=$?
   [[ -n $SSH_TTY ]] && stty opost

plugin.toml

@@ -1,4 +1,4 @@
 [plugin]
 description = "dokku mysql service plugin"
-version = "1.20.0"
+version = "1.26.0"
 [plugin.config]

service-list

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/config"
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/common-functions"
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+
+plugin-service-list() {
+  declare desc="allows listing all services for use by other dokku plugins"
+  declare SERVICE_TYPE="$1"
+
+  if [[ -n "$SERVICE_TYPE" ]] && [[ "$SERVICE_TYPE" != "$PLUGIN_COMMAND_PREFIX" ]]; then
+    return
+  fi
+
+  for service in $(fn-services-list false); do
+    echo "$PLUGIN_COMMAND_PREFIX:$service"
+  done
+}
+
+plugin-service-list "$@"

subcommands/destroy

@@ -41,7 +41,7 @@ service-destroy-cmd() {
   fi
 
   dokku_log_info2_quiet "Deleting $SERVICE"
-  plugn trigger service-action pre-delete "$SERVICE"
+  plugn trigger service-action pre-delete "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
   service_backup_unschedule "$SERVICE"
   service_container_rm "$SERVICE"
 
@@ -49,7 +49,7 @@ service-destroy-cmd() {
   docker run --rm -v "$SERVICE_HOST_ROOT/data:/data" -v "$SERVICE_HOST_ROOT/$PLUGIN_CONFIG_SUFFIX:/config" "$PLUGIN_BUSYBOX_IMAGE" chmod 777 -R /config /data
   rm -rf "$SERVICE_ROOT"
 
-  plugn trigger service-action post-delete "$SERVICE"
+  plugn trigger service-action post-delete "$PLUGIN_COMMAND_PREFIX" "$SERVICE"
   dokku_log_info2 "$PLUGIN_SERVICE container deleted: $SERVICE"
 }
 

subcommands/enter

@@ -19,8 +19,8 @@ service-enter-cmd() {
   [[ ${argv[0]} == "$cmd" ]] && shift 1
   declare SERVICE="$1"
 
-  dokku_log_info1_quiet "Filesystem changes may not persist after container restarts"
   verify_service_name "$SERVICE"
+  dokku_log_info1_quiet "Filesystem changes may not persist after container restarts"
   service_enter "$SERVICE" "${@:2}"
 }
 

subcommands/pause

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/config"
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_BASE_PATH/common/functions"
+source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
+
+service-pause-cmd() {
+  #E pause the running container for the service
+  #E dokku $PLUGIN_COMMAND_PREFIX:pause lollipop
+  #A service, service to run command against
+  declare desc="pause a running $PLUGIN_SERVICE service"
+  local cmd="$PLUGIN_COMMAND_PREFIX:pause" argv=("$@")
+  [[ ${argv[0]} == "$cmd" ]] && shift 1
+  declare SERVICE="$1"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
+  verify_service_name "$SERVICE"
+  service_pause "$SERVICE"
+}
+
+service-pause-cmd "$@"

subcommands/restart

@@ -16,7 +16,7 @@ service-restart-cmd() {
 
   [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
   verify_service_name "$SERVICE"
-  service_stop "$SERVICE"
+  service_pause "$SERVICE"
   service_start "$SERVICE"
   dokku_log_info1 "Please call dokku ps:restart on all linked apps"
 }

subcommands/stop

@@ -6,7 +6,7 @@ source "$PLUGIN_BASE_PATH/common/functions"
 source "$(dirname "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)")/functions"
 
 service-stop-cmd() {
-  #E stop the service and the running container
+  #E stop the service and removes the running container
   #E dokku $PLUGIN_COMMAND_PREFIX:stop lollipop
   #A service, service to run command against
   declare desc="stop a running $PLUGIN_SERVICE service"
@@ -16,7 +16,7 @@ service-stop-cmd() {
 
   [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a valid name for the service"
   verify_service_name "$SERVICE"
-  service_stop "$SERVICE"
+  service_container_rm "$SERVICE"
 }
 
 service-stop-cmd "$@"

tests/service_clone.bats

@@ -30,7 +30,7 @@ teardown() {
 @test "($PLUGIN_COMMAND_PREFIX:clone) error when new service already exists" {
   dokku "$PLUGIN_COMMAND_PREFIX:create" new_service
   run dokku "$PLUGIN_COMMAND_PREFIX:clone" l new_service
-  assert_contains "${lines[*]}" "service new_service already exists"
+  assert_contains "${lines[*]}" "Invalid service name new_service"
   assert_failure
 
   dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" new_service

tests/service_export.bats

@@ -23,7 +23,7 @@ teardown() {
   if [[ -n "$GITHUB_WORKFLOW" ]]; then
     skip "No tty is available on Github Actions"
   fi
-  export SSH_TTY=`tty`
+  export SSH_TTY=$(tty)
   run dokku "$PLUGIN_COMMAND_PREFIX:export" l
   echo "output: $output"
   echo "status: $status"

tests/service_link.bats

@@ -13,7 +13,6 @@ teardown() {
   dokku --force apps:destroy my-app
 }
 
-
 @test "($PLUGIN_COMMAND_PREFIX:link) error when there are no arguments" {
   run dokku "$PLUGIN_COMMAND_PREFIX:link"
   echo "output: $output"

tests/service_pause.bats

@@ -0,0 +1,25 @@
+#!/usr/bin/env bats
+load test_helper
+
+setup() {
+  dokku "$PLUGIN_COMMAND_PREFIX:create" l
+}
+
+teardown() {
+  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
+}
+
+@test "($PLUGIN_COMMAND_PREFIX:pause) error when there are no arguments" {
+  run dokku "$PLUGIN_COMMAND_PREFIX:pause"
+  assert_contains "${lines[*]}" "Please specify a valid name for the service"
+}
+
+@test "($PLUGIN_COMMAND_PREFIX:pause) error when service does not exist" {
+  run dokku "$PLUGIN_COMMAND_PREFIX:pause" not_existing_service
+  assert_contains "${lines[*]}" "service not_existing_service does not exist"
+}
+
+@test "($PLUGIN_COMMAND_PREFIX:pause) success" {
+  run dokku "$PLUGIN_COMMAND_PREFIX:pause" l
+  assert_success
+}

tests/service_restart.bats

@@ -23,4 +23,3 @@ teardown() {
   run dokku "$PLUGIN_COMMAND_PREFIX:restart" l
   assert_success
 }
-

tests/service_start.bats

@@ -23,4 +23,3 @@ teardown() {
   run dokku "$PLUGIN_COMMAND_PREFIX:start" l
   assert_success
 }
-

tests/service_stop.bats

@@ -23,4 +23,3 @@ teardown() {
   run dokku "$PLUGIN_COMMAND_PREFIX:stop" l
   assert_success
 }
-

tests/service_unexpose.bats

@@ -25,4 +25,3 @@ teardown() {
   [[ ! -f $PLUGIN_DATA_ROOT/PORT ]]
   assert_contains "${lines[*]}" "Service l unexposed"
 }
-