Release 1.4.6

Use --if-exists with import

README.md

@@ -1,6 +1,6 @@
 # dokku postgres [![Build Status](https://img.shields.io/travis/dokku/dokku-postgres.svg?branch=master "Build Status")](https://travis-ci.org/dokku/dokku-postgres) [![IRC Network](https://img.shields.io/badge/irc-freenode-blue.svg "IRC Freenode")](https://webchat.freenode.net/?channels=dokku)
 
-Official postgres plugin for dokku. Currently defaults to installing [postgres 10.2](https://hub.docker.com/_/postgres/).
+Official postgres plugin for dokku. Currently defaults to installing [postgres 10.4](https://hub.docker.com/_/postgres/).
 
 ## requirements
 
@@ -46,6 +46,7 @@ postgres:start <name>             Start a previously stopped postgres service
 postgres:stop <name>              Stop a running postgres service
 postgres:unexpose <name>          Unexpose a previously exposed postgres service
 postgres:unlink <name> <app>      Unlink the postgres service from the app
+postgres:upgrade <name>           Upgrade service <service> to the specified version
 ```
 
 ## usage
@@ -59,7 +60,7 @@ dokku postgres:create lolipop
 # it *must* be compatible with the
 # official postgres image
 export POSTGRES_IMAGE="postgres"
-export POSTGRES_IMAGE_VERSION="10.2"
+export POSTGRES_IMAGE_VERSION="10.4"
 dokku postgres:create lolipop
 
 # you can also specify custom environment
@@ -184,7 +185,7 @@ OR
 
 ## upgrade/downgrade
 
-At the moment a database can’t be upgraded  (or downgraded) inplace. Instead a clone has to be made, like this:
+At the moment a database can’t be upgraded (or downgraded) inplace. Instead a clone has to be made, like this:
 
 ```shell
 # Our original DB using PG 9.5
@@ -207,7 +208,7 @@ $ dokku postgres:destroy db9.5
 If you wish to tune the postgres instances various .conf files, you can find them by using the postgres:info command.
 
 ```shell
-dokku postgres:info lolipop 
+dokku postgres:info lolipop
 # or
 dokku postgres:info lolipop --data-dir
 ```
@@ -244,14 +245,14 @@ dokku postgres:backup-unschedule lolipop
 ```
 
 Backup auth can also be set up for different regions, signature versions and endpoints (e.g. for minio):
- 
+
 ```
 # setup s3 backup authentication with different region
 dokku postgres:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION
- 
+
 # setup s3 backup authentication with different signature version and endpoint
 dokku postgres:backup-auth lolipop AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY AWS_REGION AWS_SIGNATURE_VERSION ENDPOINT_URL
- 
+
 # more specific example for minio auth
 dokku postgres:backup-auth lolipop MINIO_ACCESS_KEY_ID MINIO_SECRET_ACCESS_KEY us-east-1 s3v4 https://YOURMINIOSERVICE
 ```
@@ -267,7 +268,7 @@ dokku postgres:connect db < ./dump.sql
 ## Security
 
 The connection to the database is done over SSL. A self-signed certificate is
-automatically generated when creating the service.  It can be replaced by a
+automatically generated when creating the service. It can be replaced by a
 custom certificate by overwriting the `server.crt` and `server.key` files in
 `/var/lib/dokku/services/postgres/<DB_NAME>/data`.
 The `server.key` must be chmoded to 600 and must be owned by the postgres user

common-functions

@@ -273,6 +273,21 @@ service_backup_unset_encryption() {
   rm -rf "$SERVICE_BACKUP_ENCRYPTION_ROOT"
 }
 
+service_container_rm() {
+  declare desc="Stops a service and removes the running container"
+  declare SERVICE="$1"
+  local SERVICE_NAME="$(get_service_name "$SERVICE")"
+
+  service_stop "$SERVICE"
+  local ID=$(docker inspect "$SERVICE_NAME" -f '{{ .ID }}' 2> /dev/null || true)
+  [[ -z "$ID" ]] && return 0
+
+  dokku_log_verbose_quiet "Removing container"
+  if ! docker rm "$SERVICE_NAME" > /dev/null 2>&1; then
+    dokku_log_fail "Unable to remove container for service $SERVICE"
+  fi
+}
+
 service_enter() {
   declare desc="enters running app container of specified proc type"
   declare SERVICE="$1" && shift 1
@@ -300,6 +315,17 @@ service_exposed_ports() {
   done
 }
 
+service_image_exists() {
+  declare desc="Checks if the current image exists"
+  local IMAGE="$PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION"
+
+  if [[ "$(docker images -q "$IMAGE" 2> /dev/null)" == "" ]]; then
+    return 1
+  fi
+
+  return 0
+}
+
 service_info() {
   declare desc="Retrieves information about a given service"
   declare SERVICE="$1" INFO_FLAG="$2"
@@ -448,24 +474,24 @@ service_parse_args() {
   for arg in "$@"; do
     shift
     case "$arg" in
-      "--config-options") set -- "$@" "-c" ;;
-      "--custom-env")     set -- "$@" "-C" ;;
-      "--image")          set -- "$@" "-i" ;;
-      "--image-version")  set -- "$@" "-I" ;;
-      "--password")       set -- "$@" "-p" ;;
-      "--root-password")  set -- "$@" "-r" ;;
-
-      "--alias")          set -- "$@" "-a" ;;
-      "--database")       set -- "$@" "-d" ;;
-      "--memory")         set -- "$@" "-m" ;;
-      "--querystring")    set -- "$@" "-q" ;;
-      "--user")           set -- "$@" "-u" ;;
-      *)                  set -- "$@" "$arg"
+      "--alias")                 set -- "$@" "-a" ;;
+      "--config-options")        set -- "$@" "-c" ;;
+      "--custom-env")            set -- "$@" "-C" ;;
+      "--database")              set -- "$@" "-d" ;;
+      "--image-version")         set -- "$@" "-I" ;;
+      "--image")                 set -- "$@" "-i" ;;
+      "--memory")                set -- "$@" "-m" ;;
+      "--password")              set -- "$@" "-p" ;;
+      "--querystring")           set -- "$@" "-q" ;;
+      "--restart-apps")          set -- "$@" "-R" ;;
+      "--root-password")         set -- "$@" "-r" ;;
+      "--user")                  set -- "$@" "-u" ;;
+      *)                         set -- "$@" "$arg"
     esac
   done
 
   OPTIND=1
-  while getopts "a:c:C:d:i:I:m:p:q:r:u:" opt; do
+  while getopts "a:c:C:d:i:I:m:p:q:R:r:u:" opt; do
     case "$opt" in
       a)
          SERVICE_ALIAS="${OPTARG^^}"; export SERVICE_ALIAS="${SERVICE_ALIAS%_URL}"
@@ -486,6 +512,8 @@ service_parse_args() {
          ;;
       q) export SERVICE_QUERYSTRING=${OPTARG#"?"}
          ;;
+      R) export SERVICE_RESTART_APPS=$OPTARG
+         ;;
       r) export SERVICE_ROOT_PASSWORD=$OPTARG
          ;;
       u) export SERVICE_USER=$OPTARG

config

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 export POSTGRES_IMAGE=${POSTGRES_IMAGE:="postgres"}
-export POSTGRES_IMAGE_VERSION=${POSTGRES_IMAGE_VERSION:="10.2"}
+export POSTGRES_IMAGE_VERSION=${POSTGRES_IMAGE_VERSION:="10.4"}
 export POSTGRES_ROOT=${POSTGRES_ROOT:="/var/lib/dokku/services/postgres"}
 export POSTGRES_HOST_ROOT=${POSTGRES_HOST_ROOT:=$POSTGRES_ROOT}
 

functions

@@ -29,7 +29,7 @@ service_create() {
 
   service_parse_args "${@:2}"
 
-  if ! docker images | grep -e "^$PLUGIN_IMAGE " | grep -q " $PLUGIN_IMAGE_VERSION " ; then
+  if ! service_image_exists "$SERVICE"; then
     if [[ "$PLUGIN_DISABLE_PULL" == "true" ]]; then
       dokku_log_warn "${PLUGIN_DISABLE_PULL_VARIABLE} environment variable detected. Not running pull command." 1>&2
       dokku_log_warn "   docker pull ${IMAGE}" 1>&2
@@ -114,7 +114,7 @@ service_import() {
   if [[ -t 0 ]]; then
     dokku_log_fail "No data provided on stdin."
   fi
-  docker exec -i "$SERVICE_NAME" env PGPASSWORD="$PASSWORD" pg_restore -h localhost -cO -d "$DATABASE_NAME" -U postgres -w
+  docker exec -i "$SERVICE_NAME" env PGPASSWORD="$PASSWORD" pg_restore -h localhost -cO --if-exists -d "$DATABASE_NAME" -U postgres -w
 }
 
 service_start() {
@@ -130,14 +130,13 @@ service_start() {
 
   dokku_log_info2_quiet "Starting container"
   local PREVIOUS_ID=$(docker ps -f status=exited | grep -e "$SERVICE_NAME$" | awk '{print $1}') || true
-  local IMAGE_EXISTS=$(docker images | grep -e "^$PLUGIN_IMAGE " | grep -q " $PLUGIN_IMAGE_VERSION " && true)
   local PASSWORD="$(cat "$SERVICE_ROOT/PASSWORD")"
 
   if [[ -n $PREVIOUS_ID ]]; then
     docker start "$PREVIOUS_ID" > /dev/null
     service_port_unpause "$SERVICE"
     dokku_log_info2 "Container started"
-  elif $IMAGE_EXISTS && [[ -n "$PASSWORD" ]]; then
+  elif service_image_exists "$SERVICE" && [[ -n "$PASSWORD" ]]; then
     service_create_container "$SERVICE"
   else
     dokku_log_verbose_quiet "Neither container nor valid configuration exists for $SERVICE"

help-functions

@@ -76,7 +76,7 @@ fn-help-contents() {
 fn-help-contents-subcommand() {
   declare SUBCOMMAND="$1" FULL_OUTPUT="$2"
   local TMPDIR=$(mktemp -d)
-  local UNCLEAN_FILE="${TMPDIR}cmd-unclean" CLEAN_FILE="${TMPDIR}cmd-clean"
+  local UNCLEAN_FILE="${TMPDIR}/cmd-unclean" CLEAN_FILE="${TMPDIR}/cmd-clean"
   local BOLD CMD_OUTPUT CYAN EXAMPLE LIGHT_GRAY NORMAL
   trap 'rm -rf "$TMPDIR" > /dev/null' RETURN INT TERM EXIT
 

plugin.toml

@@ -1,4 +1,4 @@
 [plugin]
 description = "dokku postgres service plugin"
-version = "1.3.0"
+version = "1.4.6"
 [plugin.config]

subcommands/clone

@@ -9,9 +9,9 @@ service-clone-cmd() {
   #E dokku $PLUGIN_COMMAND_PREFIX:clone lolipop lolipop-2
   #A service, service to run command against
   #A new-service, name of new service
-  #F -c|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
+  #F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
   #F -i|--image IMAGE, the image name to start the service with
-  #F -i|--image-version IMAGE_VERSION, the image version to start the service with
+  #F -I|--image-version IMAGE_VERSION, the image version to start the service with
   #F -p|--password PASSWORD, override the user-level service password
   #F -r|--root-password PASSWORD, override the root-level service password
   declare desc="create container <new-name> then copy data from <name> into <new-name>"

subcommands/create

@@ -17,9 +17,9 @@ service-create-cmd() {
   #E export ${PLUGIN_DEFAULT_ALIAS}_CUSTOM_ENV="USER=alpha;HOST=beta"
   #E dokku $PLUGIN_COMMAND_PREFIX:create lolipop
   #A service, service to run command against
-  #F -c|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
+  #F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
   #F -i|--image IMAGE, the image name to start the service with
-  #F -i|--image-version IMAGE_VERSION, the image version to start the service with
+  #F -I|--image-version IMAGE_VERSION, the image version to start the service with
   #F -p|--password PASSWORD, override the user-level service password
   #F -r|--root-password PASSWORD, override the root-level service password
   declare desc="create a $PLUGIN_SERVICE service"

subcommands/upgrade

@@ -0,0 +1,55 @@
+#!/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"
+source "$PLUGIN_AVAILABLE_PATH/ps/functions"
+
+service-upgrade-cmd() {
+  #E you can upgrade an existing service to a new image or image-version
+  #E dokku $PLUGIN_COMMAND_PREFIX:upgrade lolipop
+  #A service, service to run command against
+  #F -C|--custom-env "USER=alpha;HOST=beta", semi-colon delimited environment variables to start the service with
+  #F -i|--image IMAGE, the image name to start the service with
+  #F -I|--image-version IMAGE_VERSION, the image version to start the service with
+  #F -R|--restart-apps "true", whether to force an app restart
+  declare desc="upgrade service <service> to the specified versions"
+  local cmd="$PLUGIN_COMMAND_PREFIX:upgrade" argv=("$@"); [[ ${argv[0]} == "$cmd" ]] && shift 1
+  declare SERVICE="$1" UPGRADE_FLAG_LIST="${@:2}"
+
+  [[ -z "$SERVICE" ]] && dokku_log_fail "Please specify a name for the service"
+  verify_service_name "$SERVICE"
+
+  local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
+  local ID="$(cat "$SERVICE_ROOT/ID")"
+  is_container_status "$ID" "Running" || dokku_log_fail "Service ${SERVICE} container is not running"
+
+  service_parse_args "${@:2}"
+
+  if ! service_image_exists "$SERVICE"; then
+    dokku_log_fail "Unable to proceed with upgrade, image ${PLUGIN_IMAGE}:${PLUGIN_IMAGE_VERSION} does not exist"
+  fi
+
+  dokku_log_info2 "Upgrading $SERVICE to $PLUGIN_IMAGE:$PLUGIN_IMAGE_VERSION"
+  if [[ "$SERVICE_RESTART_APPS" == "true" ]]; then
+    dokku_log_info2 "Stopping all linked services"
+    for app in $(service_linked_apps "$SERVICE"); do
+      ps_stop "$app"
+    done
+  fi
+
+  dokku_log_info2 "Stopping $SERVICE"
+  service_container_rm "$SERVICE"
+  service_start "$SERVICE" "${@:2}"
+
+  if [[ "$SERVICE_RESTART_APPS" == "true" ]]; then
+    dokku_log_info2 "Starting all linked services"
+    for app in $(service_linked_apps "$SERVICE"); do
+      ps_start "$app"
+    done
+  fi
+
+  dokku_log_info2 "Done"
+}
+
+service-upgrade-cmd "$@"

tests/bin/docker

@@ -22,7 +22,7 @@ case "$1" in
     echo "mongo                                3.2.9               12eadb136159        2 days ago          291.1 MB"
     echo "mysql                                5.7.12              57d56ac47bed        2 days ago          321.3 MB"
     echo "nats                                 0.9.4               9216d5a4eec8        2 days ago          109.3 MB"
-    echo "postgres                             10.2               6412eb70175e        2 days ago          265.7 MB"
+    echo "postgres                             10.4               6412eb70175e        2 days ago          265.7 MB"
     echo "rabbitmq                             3.6.5-management    327b803301e9        2 days ago          143.5 MB"
     echo "redis                                3.2.3               9216d5a4eec8        2 days ago          109.3 MB"
     echo "rethinkdb                            2.3.4               f27010a550ec        2 days ago          196.3 MB"
@@ -71,7 +71,7 @@ case "$1" in
       echo 'c0f74fc90377        mongo:3.2.9                                "/entrypoint.sh mong"      11 seconds ago       Up 10 seconds       27017/tcp                                  dokku.mongo.l'
       echo '0f33b1c86da9        mysql:5.7.12                               "/entrypoint.sh mysq"      11 seconds ago       Up 10 seconds       3306/tcp                                   dokku.mysql.l'
       echo '9f10b6dc12d5        nats:0.9.4                                 "/entrypoint.sh redi"      11 seconds ago       Up 10 seconds       4222/tcp                                   dokku.nats.l'
-      echo '7f899b723c08        postgres:10.2                             "/docker-entrypoint."      11 seconds ago       Up 10 seconds       5432/tcp                                   dokku.postgres.l'
+      echo '7f899b723c08        postgres:10.4                             "/docker-entrypoint."      11 seconds ago       Up 10 seconds       5432/tcp                                   dokku.postgres.l'
       echo '5e50a462661e        rabbitmq:3.6.5-management                  "/docker-entrypoint."      11 seconds ago       Up 10 seconds       5672/tcp, 15672/tcp                        dokku.rabbitmq.l'
       echo 'c39ca00fa3c6        redis:3.2.3                                "/entrypoint.sh redi"      11 seconds ago       Up 10 seconds       6379/tcp                                   dokku.redis.l'
       echo 'dc98c2939a80        rethinkdb:2.3.4                            "rethinkdb --bind al"      11 seconds ago       Up 10 seconds       8080/tcp, 28015/tcp, 29015/tcp             dokku.rethinkdb.l'

tests/service_import.bats

@@ -32,6 +32,6 @@ teardown() {
   export ECHO_DOCKER_COMMAND="true"
   run dokku "$PLUGIN_COMMAND_PREFIX:import" l < "$PLUGIN_DATA_ROOT/fake.dump"
   password="$(cat "$PLUGIN_DATA_ROOT/l/PASSWORD")"
-  assert_output "docker exec -i dokku.postgres.l env PGPASSWORD=$password pg_restore -h localhost -cO -d l -U postgres -w"
+  assert_output "docker exec -i dokku.postgres.l env PGPASSWORD=$password pg_restore -h localhost -cO --if-exists -d l -U postgres -w"
 }
 

tests/service_list.bats

@@ -11,20 +11,20 @@ teardown() {
 
 @test "($PLUGIN_COMMAND_PREFIX:list) with no exposed ports, no linked apps" {
   run dokku "$PLUGIN_COMMAND_PREFIX:list"
-  assert_contains "${lines[*]}" "l     postgres:10.2  running  -              -"
+  assert_contains "${lines[*]}" "l     postgres:10.4  running  -              -"
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:list) with exposed ports" {
   dokku "$PLUGIN_COMMAND_PREFIX:expose" l 4242
   run dokku "$PLUGIN_COMMAND_PREFIX:list"
-  assert_contains "${lines[*]}" "l     postgres:10.2  running  5432->4242     -"
+  assert_contains "${lines[*]}" "l     postgres:10.4  running  5432->4242     -"
 }
 
 @test "($PLUGIN_COMMAND_PREFIX:list) with linked app" {
   dokku apps:create my_app
   dokku "$PLUGIN_COMMAND_PREFIX:link" l my_app
   run dokku "$PLUGIN_COMMAND_PREFIX:list"
-  assert_contains "${lines[*]}" "l     postgres:10.2  running  -              my_app"
+  assert_contains "${lines[*]}" "l     postgres:10.4  running  -              my_app"
   dokku --force apps:destroy my_app
 }