Release 1.38.0

Merge pull request #174 from dokku/dependabot/docker/mysql-8.3.0
chore(deps): bump mysql from 8.2.0 to 8.3.0
2024-01-29 08:34:56 -05:00 · 2024-01-29 08:34:42 -05:00 · 2024-01-22 03:43:24 +00:00 · 2023-12-19 00:25:02 -05:00 · 2023-12-15 03:58:44 +00:00 · 2023-12-09 23:56:07 -05:00
14 changed files with 309 additions and 136 deletions
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -17,16 +17,16 @@ concurrency:
 jobs:
  unit-tests-master:
    name: unit-tests
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
    env:
      DOKKU_VERSION: master

    steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
        with:
          python-version: '3.7.x'

@@ -51,7 +51,7 @@ jobs:

      - run: make test

-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
        if: failure()
        with:
          name: tmp/test-results
@@ -59,16 +59,16 @@ jobs:

  unit-tests-0_19_0:
    name: unit-tests-0.19.0
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
    env:
      DOKKU_TAG: v0.19.0

    steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
        with:
          python-version: '3.7.x'

@@ -93,7 +93,7 @@ jobs:

      - run: make test

-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
        if: failure()
        with:
          name: tmp/test-results
--- a/.github/workflows/tagged-release.yml
+++ b/.github/workflows/tagged-release.yml
@@ -10,7 +10,7 @@ on:
 jobs:
  tagged-release:
    name: tagged-release
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04

    steps:
      - uses: "marvinpinto/action-automatic-releases@v1.2.1"
--- a/2
+++ b/2
@@ -1 +1 @@
-FROM mysql:8.0.31
+FROM mysql:8.3.0
--- a/2
+++ b/2
@@ -21,7 +21,7 @@ ifneq ($(shell shellcheck --version >/dev/null 2>&1 ; echo $$?),0)
 ifeq ($(SYSTEM_NAME),darwin)
 	brew install shellcheck
 else
-	sudo add-apt-repository 'deb http://archive.ubuntu.com/ubuntu trusty-backports main restricted universe multiverse'
+	sudo add-apt-repository 'deb http://archive.ubuntu.com/ubuntu jammy-backports main restricted universe multiverse'
 	sudo rm -rf /var/lib/apt/lists/* && sudo apt-get clean
 	sudo apt-get update -qq && sudo apt-get install -qq -y shellcheck
 endif
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # dokku mysql [![Build Status](https://img.shields.io/github/actions/workflow/status/dokku/dokku-mysql/ci.yml?branch=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.31](https://hub.docker.com/_/mysql/).
+Official mysql plugin for dokku. Currently defaults to installing [mysql 8.3.0](https://hub.docker.com/_/mysql/).

 ## Requirements

@@ -74,9 +74,9 @@ flags:
 - `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
 - `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
 - `-p|--password PASSWORD`: override the user-level service password
- `-P|--post-create-network NETWORKS`: a comman-separated list of networks to attach the service container to after service creation
+- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
 - `-r|--root-password PASSWORD`: override the root-level service password
- `-S|--post-start-network NETWORKS`: a comman-separated list of networks to attach the service container to after service start
+- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
 - `-s|--shm-size SHM_SIZE`: override shared memory size for mysql docker container

 Create a mysql service named lollipop:
@@ -93,7 +93,7 @@ export MYSQL_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
 dokku mysql:create lollipop
 ```

-You can also specify custom environment variables to start the mysql service in semi-colon separated form.
+You can also specify custom environment variables to start the mysql service in semicolon-separated form.

 ```shell
 export MYSQL_CUSTOM_ENV="USER=alpha;HOST=beta"
@@ -457,9 +457,9 @@ flags:
 - `-i|--image IMAGE`: the image name to start the service with
 - `-I|--image-version IMAGE_VERSION`: the image version to start the service with
 - `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
- `-P|--post-create-network NETWORKS`: a comman-separated list of networks to attach the service container to after service creation
+- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
 - `-R|--restart-apps "true"`: whether or not to force an app restart (default: false)
- `-S|--post-start-network NETWORKS`: a comman-separated list of networks to attach the service container to after service start
+- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
 - `-s|--shm-size SHM_SIZE`: override shared memory size for mysql docker container

 You can upgrade an existing service to a new image or image-version:
@@ -501,9 +501,9 @@ flags:
 - `-m|--memory MEMORY`: container memory limit in megabytes (default: unlimited)
 - `-N|--initial-network INITIAL_NETWORK`: the initial network to attach the service to
 - `-p|--password PASSWORD`: override the user-level service password
- `-P|--post-create-network NETWORKS`: a comman-separated list of networks to attach the service container to after service creation
+- `-P|--post-create-network NETWORKS`: a comma-separated list of networks to attach the service container to after service creation
 - `-r|--root-password PASSWORD`: override the root-level service password
- `-S|--post-start-network NETWORKS`: a comman-separated list of networks to attach the service container to after service start
+- `-S|--post-start-network NETWORKS`: a comma-separated list of networks to attach the service container to after service start
 - `-s|--shm-size SHM_SIZE`: override shared memory size for mysql docker container

 You can clone an existing service to a new one:
--- a/2
+++ b/2
@@ -1,7 +1,7 @@
 # -*- mode: ruby -*-
 # vi: set ft=ruby :

-BOX_NAME = ENV["BOX_NAME"] || "bento/ubuntu-20.04"
+BOX_NAME = ENV["BOX_NAME"] || "bento/ubuntu-22.04"
 BOX_MEMORY = ENV["BOX_MEMORY"] || "2048"
 DOKKU_VERSION = "master"

--- a/bin/generate
+++ b/bin/generate
@@ -1,15 +1,30 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 from __future__ import print_function
+
 import os
 import re


-def compile(service, version, variable, alias, image, scheme, ports, sponsors, options, unimplemented, dokku_version):
-    prefix = "\n\n".join([
+def compile(
+    service,
+    version,
+    variable,
+    alias,
+    image,
+    scheme,
+    ports,
+    sponsors,
+    options,
+    unimplemented,
+    dokku_version,
+):
+    prefix = "\n\n".join(
+        [
            header(service),
            description(service, image, version),
-    ])
+        ]
+    )

    if len(sponsors) > 0:
        prefix += "\n\n"
@@ -21,8 +36,19 @@ def compile(service, version, variable, alias, image, scheme, ports, sponsors, o
                prefix,
                requirements_section(dokku_version),
                installation_section(service, dokku_version),
-                commands_section(service, variable, alias, image, scheme, ports, unimplemented),
-                usage_section(service, variable, alias, image, scheme, ports, options, unimplemented),
+                commands_section(
+                    service, variable, alias, image, scheme, ports, unimplemented
+                ),
+                usage_section(
+                    service,
+                    variable,
+                    alias,
+                    image,
+                    scheme,
+                    ports,
+                    options,
+                    unimplemented,
+                ),
            ]
        )
        .replace("\n\n\n\n\n", "\n")
@@ -55,17 +81,25 @@ def sponsors_section(service, sponsors):
    if len(sponsors) == 0:
        return ""

-    sponsor_data = ["## Sponsors", "", f"The {service} plugin was generously sponsored by the following:", ""]
+    sponsor_data = [
+        "## Sponsors",
+        "",
+        f"The {service} plugin was generously sponsored by the following:",
+        "",
+    ]
    sponsor_data.extend([f"- [{s}](https://github.com/{s})" for s in sponsors])

-    return "\n".join(
-        sponsor_data
-    )
+    return "\n".join(sponsor_data)


 def requirements_section(dokku_version):
    return "\n".join(
-        ["## Requirements", "", f"- dokku {dokku_version}", "- docker 1.8.x",]
+        [
+            "## Requirements",
+            "",
+            f"- dokku {dokku_version}",
+            "- docker 1.8.x",
+        ]
    )


@@ -115,17 +149,31 @@ def commands_section(service, variable, alias, image, scheme, ports, unimplement
    return "\n".join(content)


-def usage_section(service, variable, alias, image, scheme, ports, options, unimplemented):
+def usage_section(
+    service, variable, alias, image, scheme, ports, options, unimplemented
+):
    return "\n\n".join(
        [
            "## Usage",
            f"Help for any commands can be displayed by specifying the command as an argument to {service}:help. Plugin help output in conjunction with any files in the `docs/` folder is used to generate the plugin documentation. Please consult the `{service}:help` command for any undocumented commands.",
-            usage_intro(service, variable, alias, image, scheme, ports, options, unimplemented),
-            usage_lifecycle(service, variable, alias, image, scheme, ports, options, unimplemented),
-            usage_automation(service, variable, alias, image, scheme, ports, options, unimplemented),
-            usage_data_management(service, variable, alias, image, scheme, ports, options, unimplemented),
-            usage_backup(service, variable, alias, image, scheme, ports, options, unimplemented),
-            usage_docker_pull(service, variable, alias, image, scheme, ports, options, unimplemented),
+            usage_intro(
+                service, variable, alias, image, scheme, ports, options, unimplemented
+            ),
+            usage_lifecycle(
+                service, variable, alias, image, scheme, ports, options, unimplemented
+            ),
+            usage_automation(
+                service, variable, alias, image, scheme, ports, options, unimplemented
+            ),
+            usage_data_management(
+                service, variable, alias, image, scheme, ports, options, unimplemented
+            ),
+            usage_backup(
+                service, variable, alias, image, scheme, ports, options, unimplemented
+            ),
+            usage_docker_pull(
+                service, variable, alias, image, scheme, ports, options, unimplemented
+            ),
        ]
    )

@@ -135,11 +183,22 @@ def usage_intro(service, variable, alias, image, scheme, ports, options, unimple
    content = ["### Basic Usage"]

    return fetch_commands_content(
-        service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
+        service,
+        variable,
+        alias,
+        image,
+        scheme,
+        ports,
+        options,
+        unimplemented,
+        commands,
+        content,
    )


-def usage_lifecycle(service, variable, alias, image, scheme, ports, options, unimplemented):
+def usage_lifecycle(
+    service, variable, alias, image, scheme, ports, options, unimplemented
+):
    commands = [
        "connect",
        "enter",
@@ -160,11 +219,22 @@ def usage_lifecycle(service, variable, alias, image, scheme, ports, options, uni
    ]

    return fetch_commands_content(
-        service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
+        service,
+        variable,
+        alias,
+        image,
+        scheme,
+        ports,
+        options,
+        unimplemented,
+        commands,
+        content,
    )


-def usage_automation(service, variable, alias, image, scheme, ports, options, unimplemented):
+def usage_automation(
+    service, variable, alias, image, scheme, ports, options, unimplemented
+):
    commands = ["app-links", "clone", "exists", "linked", "links"]
    content = [
        "### Service Automation",
@@ -174,11 +244,22 @@ def usage_automation(service, variable, alias, image, scheme, ports, options, un
    ]

    return fetch_commands_content(
-        service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
+        service,
+        variable,
+        alias,
+        image,
+        scheme,
+        ports,
+        options,
+        unimplemented,
+        commands,
+        content,
    )


-def usage_data_management(service, variable, alias, image, scheme, ports, options, unimplemented):
+def usage_data_management(
+    service, variable, alias, image, scheme, ports, options, unimplemented
+):
    commands = ["import", "export"]
    content = [
        "### Data Management",
@@ -188,11 +269,22 @@ def usage_data_management(service, variable, alias, image, scheme, ports, option
    ]

    return fetch_commands_content(
-        service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
+        service,
+        variable,
+        alias,
+        image,
+        scheme,
+        ports,
+        options,
+        unimplemented,
+        commands,
+        content,
    )


-def usage_backup(service, variable, alias, image, scheme, ports, options, unimplemented):
+def usage_backup(
+    service, variable, alias, image, scheme, ports, options, unimplemented
+):
    commands = [
        "backup-auth",
        "backup-deauth",
@@ -215,11 +307,22 @@ def usage_backup(service, variable, alias, image, scheme, ports, options, unimpl
    ]

    return fetch_commands_content(
-        service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
+        service,
+        variable,
+        alias,
+        image,
+        scheme,
+        ports,
+        options,
+        unimplemented,
+        commands,
+        content,
    )


-def usage_docker_pull(service, variable, alias, image, scheme, ports, options, unimplemented):
+def usage_docker_pull(
+    service, variable, alias, image, scheme, ports, options, unimplemented
+):
    service_prefix = service.upper()
    return "\n".join(
        [
@@ -233,11 +336,30 @@ def usage_docker_pull(service, variable, alias, image, scheme, ports, options, u


 def fetch_commands_content(
-    service, variable, alias, image, scheme, ports, options, unimplemented, commands, content
+    service,
+    variable,
+    alias,
+    image,
+    scheme,
+    ports,
+    options,
+    unimplemented,
+    commands,
+    content,
 ):
    i = 0
    for command in commands:
-        output = command_help(command, service, variable, alias, image, scheme, ports, options, unimplemented)
+        output = command_help(
+            command,
+            service,
+            variable,
+            alias,
+            image,
+            scheme,
+            ports,
+            options,
+            unimplemented,
+        )
        if output == "":
            continue
        content.append(output)
@@ -275,7 +397,9 @@ def parse_args(line):
    return " ".join(arguments)


-def command_help(command, service, variable, alias, image, scheme, ports, options, unimplemented):
+def command_help(
+    command, service, variable, alias, image, scheme, ports, options, unimplemented
+):
    if command in unimplemented:
        return ""

@@ -285,7 +409,7 @@ def command_help(command, service, variable, alias, image, scheme, ports, option
        "",
        "```shell",
        "# usage",
-        f"dokku {service}:{command} {data['arguments_string']}",
+        f"dokku {service}:{command} {data['arguments_string']}".strip(),
        "```",
    ]

@@ -442,11 +566,11 @@ def process_sentence(sentence_lines):
        parts = []
        for word in sentence.strip().split(" "):
            if word.isupper() and len(word) > 1:
-                for ending in [':', '.']:
+                for ending in [":", "."]:
                    if word.endswith(ending):
-                        word = '`{0}`{1}'.format(word[:-1], ending)
+                        word = "`{0}`{1}".format(word[:-1], ending)
                else:
-                    word = '`{0}`'.format(word)
+                    word = "`{0}`".format(word)
            parts.append(word)
        text.append(" ".join(parts))

@@ -524,10 +648,22 @@ def main():
    with open("plugin.toml") as f:
        for line in f.readlines():
            if line.startswith("sponsors"):
-                sponsors = re.search("\[([\"\w\s,_-]+)\]", line).group(1)
-                sponsors = [s.strip("\"") for s in sponsors.split(",")]
+                sponsors = re.search('\[(["\w\s,_-]+)\]', line).group(1)
+                sponsors = [s.strip('"') for s in sponsors.split(",")]

-    text = compile(service, version, variable, alias, image, scheme, ports, sponsors, options, unimplemented, "0.19.x+")
+    text = compile(
+        service,
+        version,
+        variable,
+        alias,
+        image,
+        scheme,
+        ports,
+        sponsors,
+        options,
+        unimplemented,
+        "0.19.x+",
+    )

    base_path = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
    readme_file = os.path.join(base_path, "README.md")
--- a/107
+++ b/107
@@ -62,7 +62,7 @@ fn-services-list() {
    [[ -d $f ]] || continue
    services+=("$f")
  done
-  popd &>/dev/null || pushd "/tmp" >/dev/null
+  popd >/dev/null 2>&1 || pushd "/tmp" >/dev/null

  if [[ "${#services[@]}" -eq 0 ]]; then
    return
@@ -282,7 +282,7 @@ service_backup() {
  BACKUP_TMPDIR=$(mktemp -d --tmpdir)
  trap 'rm -rf "$BACKUP_TMPDIR" > /dev/null' RETURN INT TERM EXIT

-  "$DOCKER_BIN" container inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist"
+  "$DOCKER_BIN" container inspect "$ID" >/dev/null 2>&1 || dokku_log_fail "Service container does not exist"
  is_container_status "$ID" "Running" || dokku_log_fail "Service container is not running"

  (service_export "$SERVICE" >"${BACKUP_TMPDIR}/export")
@@ -457,7 +457,7 @@ service_container_rm() {
  local ID

  service_pause "$SERVICE"
-  ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
+  ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$") || true
  # this may be 'true' in tests...
  if [[ -z "$ID" ]] || [[ "$ID" == "true" ]]; then
    return 0
@@ -483,7 +483,7 @@ service_enter() {
  local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
  local ID="$(cat "$SERVICE_ROOT/ID")"

-  "$DOCKER_BIN" container inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist"
+  "$DOCKER_BIN" container inspect "$ID" >/dev/null 2>&1 || dokku_log_fail "Service container does not exist"
  is_container_status "$ID" "Running" || dokku_log_fail "Service container is not running"

  local EXEC_CMD=""
@@ -691,7 +691,7 @@ service_logs() {
    DOKKU_LOGS_ARGS+=" --follow"
  fi

-  "$DOCKER_BIN" container inspect "$ID" &>/dev/null || dokku_log_fail "Service container does not exist"
+  "$DOCKER_BIN" container inspect "$ID" >/dev/null 2>&1 || dokku_log_fail "Service container does not exist"
  is_container_status "$ID" "Running" || dokku_log_warn "Service logs may not be output as service is not running"

  # shellcheck disable=SC2086
@@ -810,39 +810,36 @@ service_root_password() {

 service_port_expose() {
  declare desc="wrapper for exposing service ports"
-  declare SERVICE="$1"
-  service_start "$SERVICE" "true"
-  service_port_unpause "$SERVICE" "true" "${@:2}"
-}
-
-service_port_pause() {
-  declare desc="pause service exposure"
-  declare SERVICE="$1" LOG_FAIL="$2"
+  declare SERVICE="$1" PORTS=(${@:2})
  local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
-  local EXPOSED_NAME="$(get_service_name "$SERVICE").ambassador"
  local PORT_FILE="$SERVICE_ROOT/PORT"
+  local SERVICE_NAME="$(get_service_name "$SERVICE")"
+  local EXPOSED_NAME="$SERVICE_NAME.ambassador"

-  if [[ "$LOG_FAIL" == "true" ]]; then
-    [[ ! -f "$PORT_FILE" ]] && dokku_log_fail "Service not exposed"
-  else
-    [[ ! -f "$PORT_FILE" ]] && return 0
+  if [[ ${#PORTS[@]} -eq 0 ]]; then
+    # shellcheck disable=SC2206
+    PORTS=(${PORTS[@]:-$(get_random_ports ${#PLUGIN_DATASTORE_PORTS[@]})})
  fi

-  local GREP_NAME="^/${EXPOSED_NAME}$"
-  local CONTAINER_NAME="$("$DOCKER_BIN" container ps -f name="$GREP_NAME" --format "{{.Names}}")"
-  if [[ -z "$CONTAINER_NAME" ]]; then
-    if [[ "$LOG_FAIL" == "true" ]]; then
-      dokku_log_info1 "Service $SERVICE unexposed"
-    fi
-
-    return
+  [[ "${#PORTS[@]}" != "${#PLUGIN_DATASTORE_PORTS[@]}" ]] && dokku_log_fail "${#PLUGIN_DATASTORE_PORTS[@]} ports to be exposed need to be provided in the following order: ${PLUGIN_DATASTORE_PORTS[*]}"
+
+  if [[ -s "$PORT_FILE" ]]; then
+    # shellcheck disable=SC2207
+    PORTS=($(cat "$PORT_FILE"))
+    dokku_log_fail "Service $SERVICE already exposed on port(s) ${PORTS[*]}"
  fi

+  if "$DOCKER_BIN" container inspect "$EXPOSED_NAME" >/dev/null 2>&1; then
+    dokku_log_warn "Service $SERVICE has an untracked expose container, removing"
    "$DOCKER_BIN" container stop "$EXPOSED_NAME" >/dev/null 2>&1 || true
-  "$DOCKER_BIN" container rm "$EXPOSED_NAME" >/dev/null 2>&1 || true
-  if [[ "$LOG_FAIL" == "true" ]]; then
-    dokku_log_info1 "Service $SERVICE unexposed"
+    suppress_output "$DOCKER_BIN" container rm "$EXPOSED_NAME"
  fi
+
+  echo "${PORTS[@]}" >"$PORT_FILE"
+
+  service_start "$SERVICE" "true"
+  service_port_reconcile_status "$SERVICE"
+  dokku_log_info1 "Service $SERVICE exposed on port(s) [container->host]: $(service_exposed_ports "$SERVICE")"
 }

 service_port_unexpose() {
@@ -850,39 +847,41 @@ service_port_unexpose() {
  declare SERVICE="$1"
  local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
  local PORT_FILE="$SERVICE_ROOT/PORT"
-  service_port_pause "$SERVICE" "true"
+
  rm -rf "$PORT_FILE"
+  service_port_reconcile_status "$SERVICE"
+  dokku_log_info1 "Service $SERVICE unexposed"
 }

-service_port_unpause() {
-  declare desc="start service exposure"
-  declare SERVICE="$1" LOG_FAIL="$2"
+service_port_reconcile_status() {
+  declare SERVICE="$1"
  local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
-  local SERVICE_NAME="$(get_service_name "$SERVICE")"
-  local EXPOSED_NAME="${SERVICE_NAME}.ambassador"
  local PORT_FILE="$SERVICE_ROOT/PORT"
-  # shellcheck disable=SC2068
-  local PORTS=(${@:3})
-  # shellcheck disable=SC2068
-  PORTS=(${PORTS[@]:-$(get_random_ports ${#PLUGIN_DATASTORE_PORTS[@]})})
-  local ID=$(cat "$SERVICE_ROOT/ID")
+  local SERVICE_NAME="$(get_service_name "$SERVICE")"
+  local EXPOSED_NAME="$SERVICE_NAME.ambassador"

-  [[ "${#PORTS[@]}" != "${#PLUGIN_DATASTORE_PORTS[@]}" ]] && dokku_log_fail "${#PLUGIN_DATASTORE_PORTS[@]} ports to be exposed need to be provided in the following order: ${PLUGIN_DATASTORE_PORTS[*]}"
-
-  if [[ "$LOG_FAIL" == "true" ]]; then
-    [[ -f "$PORT_FILE" ]] && PORTS=($(cat "$PORT_FILE")) && dokku_log_fail "Service $SERVICE already exposed on port(s) ${PORTS[*]}"
-  else
-    [[ ! -f "$PORT_FILE" ]] && return 0
-    PORTS=($(cat "$PORT_FILE"))
+  if [[ ! -s "$PORT_FILE" ]]; then
+    if "$DOCKER_BIN" container inspect "$EXPOSED_NAME" >/dev/null 2>&1; then
+      "$DOCKER_BIN" container stop "$EXPOSED_NAME" >/dev/null 2>&1 || true
+      suppress_output "$DOCKER_BIN" container rm "$EXPOSED_NAME"
+      return $?
+    fi
+    return
  fi

-  echo "${PORTS[@]}" >"$PORT_FILE"
+  if is_container_status "$EXPOSED_NAME" "Running"; then
+    return
+  fi

+  if "$DOCKER_BIN" container inspect "$EXPOSED_NAME" >/dev/null 2>&1; then
+    suppress_output "$DOCKER_BIN" container start "$EXPOSED_NAME"
+    return $?
+  fi
+
+  # shellcheck disable=SC2207
+  PORTS=($(cat "$PORT_FILE"))
  # shellcheck disable=SC2046
  "$DOCKER_BIN" container run -d --link "$SERVICE_NAME:$PLUGIN_COMMAND_PREFIX" --name "$EXPOSED_NAME" $(docker_ports_options "${PORTS[@]}") --restart always --label dokku=ambassador --label "dokku.ambassador=$PLUGIN_COMMAND_PREFIX" "$PLUGIN_AMBASSADOR_IMAGE" >/dev/null
-  if [[ "$LOG_FAIL" == "true" ]]; then
-    dokku_log_info1 "Service $SERVICE exposed on port(s) [container->host]: $(service_exposed_ports "$SERVICE")"
-  fi
 }

 service_promote() {
@@ -940,13 +939,15 @@ service_pause() {
  declare SERVICE="$1"
  local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
  local SERVICE_NAME="$(get_service_name "$SERVICE")"
-  local ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
+  local ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "name=^/$SERVICE_NAME$") || true
  [[ -z $ID ]] && dokku_log_warn "Service is already paused" && return 0

  if [[ -n $ID ]]; then
    dokku_log_info2_quiet "Pausing container"
    "$DOCKER_BIN" container stop "$SERVICE_NAME" >/dev/null
-    service_port_pause "$SERVICE"
+    if "$DOCKER_BIN" container inspect "$ID" >/dev/null 2>&1; then
+      "$DOCKER_BIN" container stop "$SERVICE_NAME.ambassador" >/dev/null 2>&1 || true
+    fi
    dokku_log_verbose_quiet "Container paused"
  else
    dokku_log_verbose_quiet "No container exists for $SERVICE"
--- a/14
+++ b/14
@@ -141,6 +141,8 @@ service_create_container() {
    done < <(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-create-network" | tr "," "\n")
  fi
  suppress_output "$DOCKER_BIN" container start "$(cat "$SERVICE_ROOT/ID")"
+  service_port_reconcile_status "$SERVICE"
+
  if [[ -n "$(fn-plugin-property-get "$PLUGIN_COMMAND_PREFIX" "$SERVICE" "post-start-network")" ]]; then
    dokku_log_verbose_quiet "Connecting to networks after container start"
    while read -r line || [[ -n "$line" ]]; do
@@ -166,12 +168,10 @@ service_export() {
  local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
  local SERVICE_NAME="$(get_service_name "$SERVICE")"
  local DATABASE_NAME="$(get_database_name "$SERVICE")"
-  local PASSWORD="$(service_password "$SERVICE")"
+  local ROOTPASSWORD="$(service_root_password "$SERVICE")"

  [[ -n $SSH_TTY ]] && stty -opost
-  "$DOCKER_BIN" container exec "$SERVICE_NAME" bash -c "printf '[client]\ndefault-character-set=utf8mb4\npassword=$PASSWORD\n' > /root/credentials.cnf"
-  "$DOCKER_BIN" container exec "$SERVICE_NAME" mysqldump --defaults-extra-file=/root/credentials.cnf --user=mysql --single-transaction --no-tablespaces --quick "$DATABASE_NAME"
-  "$DOCKER_BIN" container exec "$SERVICE_NAME" rm /root/credentials.cnf
+  "$DOCKER_BIN" container exec "$SERVICE_NAME" mysqldump --default-character-set=utf8mb4 --user=root --password="$ROOTPASSWORD" --single-transaction --no-tablespaces --quick "$DATABASE_NAME"
  status=$?
  [[ -n $SSH_TTY ]] && stty opost
  exit $status
@@ -196,7 +196,7 @@ service_start() {
  local QUIET="$2"
  local SERVICE_ROOT="$PLUGIN_DATA_ROOT/$SERVICE"
  local SERVICE_NAME="$(get_service_name "$SERVICE")"
-  local ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "status=running" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
+  local ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "status=running" --filter "name=^/$SERVICE_NAME$") || true
  if [[ -n $ID ]]; then
    [[ -z $QUIET ]] && dokku_log_warn "Service is already started"
    if [[ ! -f "$SERVICE_ROOT/ID" ]] || [[ "$(cat "$SERVICE_ROOT/ID")" != "$ID" ]]; then
@@ -207,13 +207,13 @@ service_start() {
  fi

  dokku_log_info2_quiet "Starting container"
-  local PREVIOUS_ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "status=exited" --filter "name=^/$SERVICE_NAME$" --format '{{ .ID }}') || true
+  local PREVIOUS_ID=$("$DOCKER_BIN" container ps -aq --no-trunc --filter "status=exited" --filter "name=^/$SERVICE_NAME$") || true
  local ROOTPASSWORD="$(service_root_password "$SERVICE")"
  local PASSWORD="$(service_password "$SERVICE")"

  if [[ -n $PREVIOUS_ID ]]; then
    "$DOCKER_BIN" container start "$PREVIOUS_ID" >/dev/null
-    service_port_unpause "$SERVICE"
+    service_port_reconcile_status "$SERVICE"
    dokku_log_info2 "Container started"
  elif service_image_exists "$SERVICE" && [[ -n "$ROOTPASSWORD" ]] && [[ -n "$PASSWORD" ]]; then
    service_create_container "$SERVICE"
--- a/plugin.toml
+++ b/plugin.toml
@@ -1,4 +1,4 @@
 [plugin]
 description = "dokku mysql service plugin"
-version = "1.31.0"
+version = "1.38.0"
 [plugin.config]
--- a/subcommands/clone
+++ b/subcommands/clone
@@ -17,9 +17,9 @@ service-clone-cmd() {
  #F -m|--memory MEMORY, container memory limit in megabytes (default: unlimited)
  #F -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to
  #F -p|--password PASSWORD, override the user-level service password
-  #F -P|--post-create-network NETWORKS, a comman-separated list of networks to attach the service container to after service creation
+  #F -P|--post-create-network NETWORKS, a comma-separated list of networks to attach the service container to after service creation
  #F -r|--root-password PASSWORD, override the root-level service password
-  #F -S|--post-start-network NETWORKS, a comman-separated list of networks to attach the service container to after service start
+  #F -S|--post-start-network NETWORKS, a comma-separated list of networks to attach the service container to after service start
  #F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
  declare desc="create container <new-name> then copy data from <name> into <new-name>"
  local cmd="$PLUGIN_COMMAND_PREFIX:clone" argv=("$@")
--- a/subcommands/create
+++ b/subcommands/create
@@ -14,7 +14,7 @@ service-create-cmd() {
  #E export ${PLUGIN_VARIABLE}_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
  #E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
  #E you can also specify custom environment variables to start
-  #E the ${PLUGIN_COMMAND_PREFIX} service in semi-colon separated form.
+  #E the ${PLUGIN_COMMAND_PREFIX} service in semicolon-separated form.
  #E export ${PLUGIN_VARIABLE}_CUSTOM_ENV="USER=alpha;HOST=beta"
  #E dokku $PLUGIN_COMMAND_PREFIX:create lollipop
  #A service, service to run command against
@@ -25,9 +25,9 @@ service-create-cmd() {
  #F -m|--memory MEMORY, container memory limit in megabytes (default: unlimited)
  #F -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to
  #F -p|--password PASSWORD, override the user-level service password
-  #F -P|--post-create-network NETWORKS, a comman-separated list of networks to attach the service container to after service creation
+  #F -P|--post-create-network NETWORKS, a comma-separated list of networks to attach the service container to after service creation
  #F -r|--root-password PASSWORD, override the root-level service password
-  #F -S|--post-start-network NETWORKS, a comman-separated list of networks to attach the service container to after service start
+  #F -S|--post-start-network NETWORKS, a comma-separated list of networks to attach the service container to after service start
  #F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
  declare desc="create a $PLUGIN_SERVICE service"
  local cmd="$PLUGIN_COMMAND_PREFIX:create" argv=("$@")
--- a/subcommands/upgrade
+++ b/subcommands/upgrade
@@ -15,9 +15,9 @@ service-upgrade-cmd() {
  #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 -N|--initial-network INITIAL_NETWORK, the initial network to attach the service to
-  #F -P|--post-create-network NETWORKS, a comman-separated list of networks to attach the service container to after service creation
+  #F -P|--post-create-network NETWORKS, a comma-separated list of networks to attach the service container to after service creation
  #F -R|--restart-apps "true", whether or not to force an app restart (default: false)
-  #F -S|--post-start-network NETWORKS, a comman-separated list of networks to attach the service container to after service start
+  #F -S|--post-start-network NETWORKS, a comma-separated list of networks to attach the service container to after service start
  #F -s|--shm-size SHM_SIZE, override shared memory size for $PLUGIN_COMMAND_PREFIX docker container
  declare desc="upgrade service <service> to the specified versions"
  local cmd="$PLUGIN_COMMAND_PREFIX:upgrade" argv=("$@")
--- a/tests/service_expose.bats
+++ b/tests/service_expose.bats
@@ -2,29 +2,65 @@
 load test_helper

 setup() {
-  dokku "$PLUGIN_COMMAND_PREFIX:create" l
+  dokku "$PLUGIN_COMMAND_PREFIX:create" ls
 }

 teardown() {
-  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" l
+  dokku --force "$PLUGIN_COMMAND_PREFIX:destroy" ls
 }

@test "($PLUGIN_COMMAND_PREFIX:expose) error when there are no arguments" {
  run dokku "$PLUGIN_COMMAND_PREFIX:expose"
+  echo "output: $output"
+  echo "status: $status"
+  assert_failure
  assert_contains "${lines[*]}" "Please specify a valid name for the service"
 }

@test "($PLUGIN_COMMAND_PREFIX:expose) error when service does not exist" {
  run dokku "$PLUGIN_COMMAND_PREFIX:expose" not_existing_service
+  echo "output: $output"
+  echo "status: $status"
+  assert_failure
  assert_contains "${lines[*]}" "service not_existing_service does not exist"
 }

+@test "($PLUGIN_COMMAND_PREFIX:expose) error when already exposed" {
+  run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_failure
+  assert_contains "${lines[*]}" "Service ls already exposed on port(s)"
+
+  run sudo rm "$PLUGIN_DATA_ROOT/ls/PORT"
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+
+  run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
+  assert_contains "${lines[*]}" "Service ls has an untracked expose container, removing"
+}
+
@test "($PLUGIN_COMMAND_PREFIX:expose) success when not providing custom ports" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:expose" l
+  run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
  [[ "${lines[*]}" =~ exposed\ on\ port\(s\)\ \[container\-\>host\]\:\ [[:digit:]]+ ]]
 }

@test "($PLUGIN_COMMAND_PREFIX:expose) success when providing custom ports" {
-  run dokku "$PLUGIN_COMMAND_PREFIX:expose" l 4242
+  run dokku "$PLUGIN_COMMAND_PREFIX:expose" ls 4242
+  echo "output: $output"
+  echo "status: $status"
+  assert_success
  assert_contains "${lines[*]}" "exposed on port(s) [container->host]: 3306->4242"
 }
Author	SHA1	Message	Date
Jose Diaz-Gonzalez	1b0cd97539	Release 1.38.0 Some checks failed tagged-release / tagged-release (push) Has been cancelled Details	2024-01-29 08:34:56 -05:00
Jose Diaz-Gonzalez	3305de6dbd	Merge pull request #174 from dokku/dependabot/docker/mysql-8.3.0 chore(deps): bump mysql from 8.2.0 to 8.3.0	2024-01-29 08:34:42 -05:00
dependabot[bot]	1f4d7ceeb2	chore(deps): bump mysql from 8.2.0 to 8.3.0 Bumps mysql from 8.2.0 to 8.3.0. --- updated-dependencies: - dependency-name: mysql dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>	2024-01-22 03:43:24 +00:00
Jose Diaz-Gonzalez	9f0d37450b	Merge pull request #173 from dokku/dependabot/github_actions/actions/upload-artifact-4 chore(deps): bump actions/upload-artifact from 3 to 4	2023-12-19 00:25:02 -05:00
dependabot[bot]	99a5d1c2e8	chore(deps): bump actions/upload-artifact from 3 to 4 Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 3 to 4. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](https://github.com/actions/upload-artifact/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>	2023-12-15 03:58:44 +00:00
Jose Diaz-Gonzalez	a181ee805e	Release 1.37.1 Some checks failed tagged-release / tagged-release (push) Has been cancelled Details	2023-12-09 23:56:07 -05:00
Jose Diaz-Gonzalez	709072c25e	docs: update docs and generation script	2023-12-09 23:55:46 -05:00
Jose Diaz-Gonzalez	f2d6006d58	chore: fix typo	2023-12-09 13:51:12 -05:00
Jose Diaz-Gonzalez	63a51d0d31	chore: fix typo	2023-12-09 13:48:37 -05:00
Jose Diaz-Gonzalez	f59ba77174	Release 1.37.0 Some checks failed tagged-release / tagged-release (push) Has been cancelled Details	2023-12-09 13:46:42 -05:00
Jose Diaz-Gonzalez	60a5f2012e	Merge pull request #171 from dokku/dependabot/docker/mysql-8.2.0 chore(deps): bump mysql from 8.1.0 to 8.2.0	2023-12-09 13:46:26 -05:00
Jose Diaz-Gonzalez	b92439331e	Merge pull request #172 from dokku/dependabot/github_actions/actions/setup-python-5 chore(deps): bump actions/setup-python from 4 to 5	2023-12-09 13:46:18 -05:00
dependabot[bot]	b7193d5b3e	chore(deps): bump actions/setup-python from 4 to 5 Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4 to 5. - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](https://github.com/actions/setup-python/compare/v4...v5) --- updated-dependencies: - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>	2023-12-07 03:26:19 +00:00
dependabot[bot]	c77475be54	chore(deps): bump mysql from 8.1.0 to 8.2.0 Bumps mysql from 8.1.0 to 8.2.0. --- updated-dependencies: - dependency-name: mysql dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>	2023-10-30 03:28:04 +00:00
Jose Diaz-Gonzalez	b7e16d9325	Release 1.36.0 Some checks failed tagged-release / tagged-release (push) Has been cancelled Details	2023-09-09 22:39:50 -04:00
Jose Diaz-Gonzalez	d9cd2649c6	Merge pull request #169 from dokku/dependabot/github_actions/actions/checkout-4 chore(deps): bump actions/checkout from 3 to 4	2023-09-07 00:11:47 -04:00
dependabot[bot]	a36b5f001f	chore(deps): bump actions/checkout from 3 to 4 Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>	2023-09-07 03:24:25 +00:00
Jose Diaz-Gonzalez	c505c47ef3	Merge pull request #170 from dokku/newer-ubuntu feat: upgrade test suite from ubuntu 20.04 to 22.04	2023-09-06 23:24:04 -04:00
Jose Diaz-Gonzalez	2b497ed8b9	feat: upgrade test suite from ubuntu 20.04 to 22.04	2023-09-06 22:37:21 -04:00
Jose Diaz-Gonzalez	b778beae85	Release 1.35.0 Some checks failed tagged-release / tagged-release (push) Has been cancelled Details	2023-08-05 23:23:42 -04:00
Jose Diaz-Gonzalez	d0c625e255	Merge pull request #168 from dokku/dependabot/docker/mysql-8.1.0 chore(deps): bump mysql from 8.0.34 to 8.1.0	2023-08-05 23:23:25 -04:00
dependabot[bot]	53ccb6ccd1	chore(deps): bump mysql from 8.0.34 to 8.1.0 Bumps mysql from 8.0.34 to 8.1.0. --- updated-dependencies: - dependency-name: mysql dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>	2023-08-03 03:05:04 +00:00
Jose Diaz-Gonzalez	31e89cad7d	Release 1.34.1 Some checks failed tagged-release / tagged-release (push) Has been cancelled Details	2023-07-30 16:09:41 -04:00
Jose Diaz-Gonzalez	8a33b6b7bc	Merge pull request #167 from dokku/dependabot/docker/mysql-8.0.34 chore(deps): bump mysql from 8.0.33 to 8.0.34	2023-07-30 16:09:34 -04:00
dependabot[bot]	5f05e12f40	chore(deps): bump mysql from 8.0.33 to 8.0.34 Bumps mysql from 8.0.33 to 8.0.34. --- updated-dependencies: - dependency-name: mysql dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>	2023-07-25 03:57:05 +00:00
Jose Diaz-Gonzalez	0cd46e0572	Release 1.34.0 Some checks failed tagged-release / tagged-release (push) Has been cancelled Details	2023-05-28 00:59:57 -04:00
Jose Diaz-Gonzalez	9e3761bc11	Release 1.32.2 Some checks failed tagged-release / tagged-release (push) Has been cancelled Details	2023-04-27 22:01:29 -04:00
josegonzalez	834345bfef	Merge pull request #166 from dokku/dependabot/docker/mysql-8.0.33 chore(deps): bump mysql from 8.0.32 to 8.0.33	2023-04-27 22:01:15 -04:00
dependabot[bot]	3a076b7142	chore(deps): bump mysql from 8.0.32 to 8.0.33 Bumps mysql from 8.0.32 to 8.0.33. --- updated-dependencies: - dependency-name: mysql dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>	2023-04-18 03:57:07 +00:00
Jose Diaz-Gonzalez	52773ace68	Release 1.32.1 Some checks failed tagged-release / tagged-release (push) Has been cancelled Details	2023-03-05 05:23:02 -05:00
josegonzalez	8a08396a71	Merge pull request #152 from dokku/dependabot/docker/mysql-8.0.32 chore(deps): bump mysql from 8.0.31 to 8.0.32	2023-03-05 05:21:42 -05:00
josegonzalez	9354d90156	refactor: use root credentials to create database dump This fixes an issue introduced in mysql 8.0.32 where we now need RELOAD and PROCESS to make a dump. Since we already import via root, exporting via root should be fine as well.	2023-03-05 04:46:02 -05:00
Jose Diaz-Gonzalez	57261263af	Release 1.32.0 Some checks failed tagged-release / tagged-release (push) Has been cancelled Details	2023-02-25 22:13:11 -05:00
josegonzalez	9ade1d6a93	Merge pull request #165 from dokku/error-when-link-exists Show an error when an ambassador container already exists but we don't have expose configuration	2023-02-25 22:11:34 -05:00
Jose Diaz-Gonzalez	9dbbc876cf	fix: show an error when an ambassador container already exists but we don't have expose configuration Closes dokku/dokku-redis#200	2023-02-25 20:10:37 -05:00
josegonzalez	fce19e6116	docs: update version in readme	2023-02-07 07:42:20 -05:00
dependabot[bot]	56bd3fa123	chore(deps): bump mysql from 8.0.31 to 8.0.32 Bumps mysql from 8.0.31 to 8.0.32. --- updated-dependencies: - dependency-name: mysql dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>	2023-02-07 12:29:05 +00:00