Release 1.37.0

chore(deps): bump mongo from 7.0.14 to 8.0.0

.github/workflows/ci.yml

@@ -26,7 +26,7 @@ jobs:
         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
@@ -68,7 +68,7 @@ jobs:
         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

Dockerfile

@@ -1 +1 @@
-FROM mongo:7.0.2
+FROM mongo:8.0.0

Makefile

@@ -1,5 +1,6 @@
 HARDWARE = $(shell uname -m)
 SYSTEM_NAME  = $(shell uname -s | tr '[:upper:]' '[:lower:]')
+ARCH = $(shell dpkg --print-architecture)
 SHFMT_VERSION = 3.0.2
 XUNIT_TO_GITHUB_VERSION = 0.3.0
 XUNIT_READER_VERSION = 0.1.0
@@ -21,7 +22,11 @@ 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 jammy-backports main restricted universe multiverse'
+ifeq ($(ARCH),arm64)
+  sudo add-apt-repository 'deb http://ports.ubuntu.com/ubuntu-ports jammy-backports main restricted universe multiverse'
+else
+  sudo add-apt-repository 'deb http://archive.ubuntu.com/ubuntu jammy-backports main restricted universe multiverse'
+endif
 	sudo rm -rf /var/lib/apt/lists/* && sudo apt-get clean
 	sudo apt-get update -qq && sudo apt-get install -qq -y shellcheck
 endif

README.md

@@ -1,6 +1,6 @@
 # dokku mongo [![Build Status](https://img.shields.io/github/actions/workflow/status/dokku/dokku-mongo/ci.yml?branch=master&style=flat-square "Build Status")](https://github.com/dokku/dokku-mongo/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 mongo plugin for dokku. Currently defaults to installing [mongo 7.0.2](https://hub.docker.com/_/mongo/).
+Official mongo plugin for dokku. Currently defaults to installing [mongo 8.0.0](https://hub.docker.com/_/mongo/).
 
 ## Requirements
 
@@ -75,9 +75,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 mongo docker container
 
 Create a mongo service named lollipop:
@@ -94,7 +94,7 @@ export MONGO_IMAGE_VERSION="${PLUGIN_IMAGE_VERSION}"
 dokku mongo:create lollipop
 ```
 
-You can also specify custom environment variables to start the mongo service in semi-colon separated form.
+You can also specify custom environment variables to start the mongo service in semicolon-separated form.
 
 ```shell
 export MONGO_CUSTOM_ENV="USER=alpha;HOST=beta"
@@ -152,7 +152,7 @@ dokku mongo:info lollipop --version
 
 ```shell
 # usage
-dokku mongo:list 
+dokku mongo:list
 ```
 
 List all services:
@@ -458,9 +458,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 mongo docker container
 
 You can upgrade an existing service to a new image or image-version:
@@ -502,9 +502,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 mongo docker container
 
 You can clone an existing service to a new one:

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):
+def compile(
-    prefix = "\n\n".join([
+    service,
-        header(service),
+    version,
-        description(service, image, 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),
+                commands_section(
-                usage_section(service, variable, alias, image, scheme, ports, options, unimplemented),
+                    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(
+    return "\n".join(sponsor_data)
-        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_intro(
-            usage_lifecycle(service, variable, alias, image, scheme, ports, options, unimplemented),
+                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_lifecycle(
-            usage_backup(service, variable, alias, image, scheme, ports, options, unimplemented),
+                service, variable, alias, image, scheme, ports, options, unimplemented
-            usage_docker_pull(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))
 
@@ -491,10 +615,10 @@ def main():
 
     with open("Dockerfile") as f:
         for line in f.readlines():
-          if "FROM " in line:
+            if "FROM " in line:
-              image, version = line.split(" ")[1].split(":")
+                image, version = line.split(" ")[1].split(":")
-              image = image.strip()
+                image = image.strip()
-              version = version.strip()
+                version = version.strip()
 
     with open("config") as f:
         for line in f.readlines():
@@ -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 = re.search('\[(["\w\s,_-]+)\]', line).group(1)
-                sponsors = [s.strip("\"") for s in sponsors.split(",")]
+                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")

plugin.toml

@@ -1,4 +1,4 @@
 [plugin]
 description = "dokku mongo service plugin"
-version = "1.36.2"
+version = "1.37.0"
 [plugin.config]

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=("$@")

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=("$@")

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=("$@")

tests/link_networks.bats

@@ -48,7 +48,7 @@ teardown() {
   assert_output_contains bridge 0
   assert_output_contains custom-network
 
-  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.Aliases}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.DNSNames}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
   echo "output: $output"
   echo "status: $status"
   assert_success
@@ -120,7 +120,7 @@ teardown() {
   assert_output_contains custom-network
   assert_output_contains bridge
 
-  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.Aliases}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.DNSNames}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
   echo "output: $output"
   echo "status: $status"
   assert_success
@@ -192,7 +192,7 @@ teardown() {
   assert_output_contains bridge
   assert_output_contains custom-network
 
-  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.Aliases}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.ls -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.DNSNames}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
   echo "output: $output"
   echo "status: $status"
   assert_success
@@ -258,7 +258,7 @@ teardown() {
   assert_output_contains bridge
   assert_output_contains custom-network
 
-  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.lsa -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.Aliases}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
+  run docker inspect dokku.$PLUGIN_COMMAND_PREFIX.lsa -f '{{range $net,$v := .NetworkSettings.Networks}}{{range $k,$alias := $v.DNSNames}}{{printf "alias:%s\n" $alias}}{{end}}{{end}}'
   echo "output: $output"
   echo "status: $status"
   assert_success

tests/shellcheck-exclude

@@ -1,4 +1,5 @@
 # SC1090 - Can't follow non-constant source. Use a directive to specify location - https://github.com/koalaman/shellcheck/wiki/SC1090
+# SC1091 - Not following - <https://github.com/koalaman/shellcheck/wiki/SC1091>
 # SC2034 - Variable appears unused. Verify it or export it - https://github.com/koalaman/shellcheck/wiki/SC2034
 # SC2155 - Declare and assign separately to avoid masking return values - https://github.com/koalaman/shellcheck/wiki/SC2155
 # SC2206 - Quote to prevent word splitting/globbing, or split robustly with mapfile or read -a - https://github.com/koalaman/shellcheck/wiki/SC2206