feat: add report trigger

This allows users to quickly show the state of any configured application, as well as the state of their server. In doing so, we make it easy for them to provide information necessary for debugging in a single command.

plugins/storage/internal-functions

@@ -1,8 +1,77 @@
 #!/usr/bin/env bash
-set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
 source "$PLUGIN_AVAILABLE_PATH/docker-options/functions"
 source "$PLUGIN_AVAILABLE_PATH/storage/functions"
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+cmd-storage-report() {
+  declare desc="displays a storage report for one or more apps"
+  local cmd="storage:report"
+  local INSTALLED_APPS=$(dokku_apps)
+  local APP="$2" INFO_FLAG="$3"
+
+  if [[ -n "$APP" ]] && [[ "$APP" == --* ]]; then
+    INFO_FLAG="$APP"
+    APP=""
+  fi
+
+  if [[ -z "$APP" ]] && [[ -z "$INFO_FLAG" ]]; then
+    INFO_FLAG="true"
+  fi
+
+  if [[ -z "$APP" ]]; then
+    for app in $INSTALLED_APPS; do
+      cmd-storage-report-single "$app" "$INFO_FLAG" | tee || true
+    done
+  else
+    cmd-storage-report-single "$APP" "$INFO_FLAG"
+  fi
+}
+
+cmd-storage-report-single() {
+  declare APP="$1" INFO_FLAG="$2"
+  if [[ "$INFO_FLAG" == "true" ]]; then
+    INFO_FLAG=""
+  fi
+  verify_app_name "$APP"
+  local flag_map=(
+    "--storage-build-mounts: $(fn-storage-bind-mounts "$APP" build)"
+    "--storage-deploy-mounts: $(fn-storage-bind-mounts "$APP" deploy)"
+    "--storage-run-mounts: $(fn-storage-bind-mounts "$APP" run)"
+  )
+
+  if [[ -z "$INFO_FLAG" ]]; then
+    dokku_log_info2_quiet "$APP storage information"
+    for flag in "${flag_map[@]}"; do
+      key="$(echo "${flag#--}" | cut -f1 -d' ' | tr - ' ')"
+      dokku_log_verbose "$(printf "%-30s %-25s" "${key^}" "${flag#*: }")"
+    done
+  else
+    local match=false; local value_exists=false
+    for flag in "${flag_map[@]}"; do
+      valid_flags="${valid_flags} $(echo "$flag" | cut -d':' -f1)"
+      if [[ "$flag" == "${INFO_FLAG}:"* ]]; then
+        value=${flag#*: }
+        size="${#value}"
+        if [[ "$size" -ne 0 ]]; then
+          echo "$value" && match=true && value_exists=true
+        else
+          match=true
+        fi
+      fi
+    done
+    [[ "$match" == "true" ]] || dokku_log_fail "Invalid flag passed, valid flags:${valid_flags}"
+    [[ "$value_exists" == "true" ]] || dokku_log_fail "not deployed"
+  fi
+}
+
+fn-storage-bind-mounts() {
+  declare APP="$1" PHASE="$2"
+  local PHASE_FILE="$(fn-get-phase-file-path "$APP" "$PHASE")"
+  if [[ -r "$PHASE_FILE" ]]; then
+    sed -e '/^-v/!d' "$PHASE_FILE" | tr '\n' ' '
+  fi
+}
 
 storage_help_content_func() {
     declare desc="return storage plugin help content"

plugins/storage/report

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+source "$PLUGIN_AVAILABLE_PATH/storage/internal-functions"
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+cmd-storage-report-single "$@"

plugins/storage/subcommands/report

@@ -1,79 +1,5 @@
 #!/usr/bin/env bash
+source "$PLUGIN_AVAILABLE_PATH/storage/internal-functions"
 set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
-source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
-source "$PLUGIN_AVAILABLE_PATH/docker-options/functions"
 
-fn-storage-bind-mounts() {
-  declare APP="$1" PHASE="$2"
-  local PHASE_FILE="$(fn-get-phase-file-path "$APP" "$PHASE")"
-  if [[ -r "$PHASE_FILE" ]]; then
-    sed -e '/^-v/!d' "$PHASE_FILE" | tr '\n' ' '
-  fi
-}
-
-report_single_app() {
-  declare APP="$1" INFO_FLAG="$2"
-  local APP_DIR="$DOKKU_ROOT/$APP"
-  if [[ "$INFO_FLAG" == "true" ]]; then
-    INFO_FLAG=""
-  fi
-  verify_app_name "$APP"
-  local flag_map=(
-    "--storage-build-mounts: $(fn-storage-bind-mounts "$APP" build)"
-    "--storage-deploy-mounts: $(fn-storage-bind-mounts "$APP" deploy)"
-    "--storage-run-mounts: $(fn-storage-bind-mounts "$APP" run)"
-  )
-
-  if [[ -z "$INFO_FLAG" ]]; then
-    dokku_log_info2_quiet "$APP storage information"
-    for flag in "${flag_map[@]}"; do
-      key="$(echo "${flag#--}" | cut -f1 -d' ' | tr - ' ')"
-      dokku_log_verbose "$(printf "%-20s %-25s" "${key^}" "${flag#*: }")"
-    done
-  else
-    local match=false; local value_exists=false
-    for flag in "${flag_map[@]}"; do
-      valid_flags="${valid_flags} $(echo "$flag" | cut -d':' -f1)"
-      if [[ "$flag" == "${INFO_FLAG}:"* ]]; then
-        value=${flag#*: }
-        size="${#value}"
-        if [[ "$size" -ne 0 ]]; then
-          echo "$value" && match=true && value_exists=true
-        else
-          match=true
-        fi
-      fi
-    done
-    if [[ "$match" == "true" ]]; then
-      [[ "$value_exists" == "true" ]] || dokku_log_fail "not deployed"
-    else
-      dokku_log_fail "Invalid flag passed, valid flags:${valid_flags}"
-    fi
-  fi
-}
-
-storage_report_cmd() {
-  declare desc="displays a storage report for one or more apps"
-  local cmd="storage:report"
-  local INSTALLED_APPS=$(dokku_apps)
-  local APP="$2" INFO_FLAG="$3"
-
-  if [[ -n "$APP" ]] && [[ "$APP" == --* ]]; then
-    INFO_FLAG="$APP"
-    APP=""
-  fi
-
-  if [[ -z "$APP" ]] && [[ -z "$INFO_FLAG" ]]; then
-    INFO_FLAG="true"
-  fi
-
-  if [[ -z "$APP" ]]; then
-    for app in $INSTALLED_APPS; do
-      report_single_app "$app" "$INFO_FLAG" | tee || true
-    done
-  else
-    report_single_app "$APP" "$INFO_FLAG"
-  fi
-}
-
-storage_report_cmd "$@"
+cmd-storage-report "$@"