Merge pull request #2620 from dokku/2356-proxy-report

Implement domains:report and proxy:report

plugins/domains/commands

@@ -1,35 +1,11 @@
 #!/usr/bin/env bash
 [[ " help domains:help " == *" $1 "* ]] || exit "$DOKKU_NOT_IMPLEMENTED_EXIT"
+source "$PLUGIN_AVAILABLE_PATH/domains/internal-functions"
 set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 
 case "$1" in
   help | domains:help)
-    help_content_func () {
-      declare desc="return domains plugin help content"
-      cat<<help_content
-    domains [<app>], List domains
-    domains:add <app> <domain> [<domain> ...], Add domains to app
-    domains:add-global <domain> [<domain> ...], Add global domain names
-    domains:clear <app>, Clear all domains for app
-    domains:disable <app>, Disable VHOST support
-    domains:enable <app>, Enable VHOST support
-    domains:remove <app> <domain> [<domain> ...], Remove domains from app
-    domains:remove-global <domain> [<domain> ...], Remove global domain names
-    domains:set <app> <domain> [<domain> ...], Set domains for app
-    domains:set-global <domain> [<domain> ...], Set global domain names
-help_content
-    }
-
-    if [[ $1 = "domains:help" ]] ; then
-        echo -e 'Usage: dokku domains[:COMMAND]'
-        echo ''
-        echo 'Manage vhost domains used by the Dokku proxy.'
-        echo ''
-        echo 'Additional commands:'
-        help_content_func | sort | column -c2 -t -s,
-    else
-        help_content_func
-    fi
+    domains_help_cmd "$@"
     ;;
 
   *)

plugins/domains/internal-functions

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+domains_help_content_func () {
+    declare desc="return domains plugin help content"
+    cat<<help_content
+    domains [<app>], [DEPRECATED] Alternative for domains:report
+    domains:add <app> <domain> [<domain> ...], Add domains to app
+    domains:add-global <domain> [<domain> ...], Add global domain names
+    domains:clear <app>, Clear all domains for app
+    domains:disable <app>, Disable VHOST support
+    domains:enable <app>, Enable VHOST support
+    domains:remove <app> <domain> [<domain> ...], Remove domains from app
+    domains:remove-global <domain> [<domain> ...], Remove global domain names
+    domains:report [<app>] [<flag>], Displays a domains report for one or more apps
+    domains:set <app> <domain> [<domain> ...], Set domains for app
+    domains:set-global <domain> [<domain> ...], Set global domain names
+help_content
+}
+
+domains_help_cmd() {
+  if [[ $1 = "domains:help" ]] ; then
+    echo -e 'Usage: dokku domains[:COMMAND]'
+    echo ''
+    echo 'Manage vhost domains used by the Dokku proxy.'
+    echo ''
+    echo 'Additional commands:'
+    domains_help_content_func | sort | column -c2 -t -s,
+  elif [[ $(ps -o command= $PPID) == *"--all"* ]]; then
+    domains_help_content_func
+  else
+    cat<<help_desc
+    domains, Manage vhost domains used by the Dokku proxy
+help_desc
+  fi
+}

plugins/domains/subcommands/default

@@ -8,6 +8,7 @@ domains_main_cmd() {
   local cmd="domains"
   local APP="$2"
 
+  dokku_log_warn "Deprecated: Please use domains:report"
   if [[ "$(is_global_vhost_enabled)" == "true" ]]; then
     dokku_log_info2_quiet "Global Domain Name"
     get_global_vhosts

plugins/domains/subcommands/report

@@ -0,0 +1,92 @@
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+source "$PLUGIN_AVAILABLE_PATH/domains/functions"
+
+fn-domains-app-enabled() {
+  declare APP="$1"
+  local DOMAINS_APP_ENABLED=false
+  if [[ "$(is_app_vhost_enabled "$APP")" == "true" ]]; then
+    DOMAINS_APP_ENABLED=true
+  fi
+  echo "$DOMAINS_APP_ENABLED"
+}
+
+fn-domains-app-vhosts() {
+  declare APP="$1"
+  local APP_VHOST_FILE="$DOKKU_ROOT/$APP/VHOST"
+  if [[ -f "$APP_VHOST_FILE" ]]; then
+    tr '\n' ' ' < "$APP_VHOST_FILE"
+  fi
+}
+
+fn-domains-global-enabled() {
+  local DOMAINS_GLOBAL_ENABLED=false
+  if [[ "$(is_global_vhost_enabled)" == "true" ]]; then
+    DOMAINS_GLOBAL_ENABLED=true
+  fi
+  echo "$DOMAINS_GLOBAL_ENABLED"
+}
+
+fn-domains-global-vhosts() {
+  if [[ "$(is_global_vhost_enabled)" == "true" ]]; then
+    get_global_vhosts | tr '\n' ' '
+  fi
+}
+
+domains_report_single_app() {
+  local APP="$1"; local APP_DIR="$DOKKU_ROOT/$APP"; local INFO_FLAG="$2"
+  if [[ "$INFO_FLAG" == "true" ]]; then
+    INFO_FLAG=""
+  fi
+  verify_app_name "$APP"
+  local flag_map=(
+    "--domains-app-enabled: $(fn-domains-app-enabled "$APP")"
+    "--domains-app-vhosts: $(fn-domains-app-vhosts "$APP")"
+    "--domains-global-enabled: $(fn-domains-global-enabled)"
+    "--domains-global-vhosts: $(fn-domains-global-vhosts)"
+  )
+
+  if [[ -z "$INFO_FLAG" ]]; then
+    dokku_log_info2 "$APP domains 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
+}
+
+domains_report_cmd() {
+  declare desc="displays a domains report for one or more apps"
+  local cmd="domains:report"
+  local INSTALLED_APPS=$(dokku_apps); local APP
+
+  if [[ -z $2 ]]; then
+    for APP in $INSTALLED_APPS; do
+      domains_report_single_app "$APP" "true"
+    done
+  else
+    domains_report_single_app "$2" "$3"
+  fi
+}
+
+domains_report_cmd "$@"

plugins/nginx-vhosts/commands

@@ -1,21 +1,15 @@
 #!/usr/bin/env bash
 [[ " help nginx:help " == *" $1 "* ]] || exit "$DOKKU_NOT_IMPLEMENTED_EXIT"
+source "$PLUGIN_AVAILABLE_PATH/nginx-vhosts/internal-functions"
 set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
-source "$PLUGIN_AVAILABLE_PATH/nginx-vhosts/functions"
 
 case "$1" in
   help | nginx:help)
-    
-
-    if [[ $1 = "nginx:help" ]] ; then
-        help_formatted
-    else
-        help_content_func
-    fi
-  ;;
+    nginx_vhosts_help_cmd "$@"
+    ;;
 
   *)
     exit "$DOKKU_NOT_IMPLEMENTED_EXIT"
-  ;;
+    ;;
 
 esac

plugins/nginx-vhosts/functions

@@ -6,25 +6,6 @@ source "$PLUGIN_AVAILABLE_PATH/config/functions"
 source "$PLUGIN_AVAILABLE_PATH/domains/functions"
 source "$PLUGIN_AVAILABLE_PATH/ps/functions"
 
-help_formatted (){
-  echo -e 'Usage: dokku nginx[:COMMAND]'
-  echo ''
-  echo 'Interact with Dokku'"'"'s Nginx proxy.'
-  echo ''
-  echo 'Additional commands:'
-  help_content_func | sort | column -c2 -t -s,
-}
-
-help_content_func () {
-      declare desc="return nginx plugin help content"
-      cat<<help_content
-    nginx, Interact with Dokku's Nginx proxy
-    nginx:build-config <app>, (Re)builds nginx config for given app
-    nginx:access-logs <app> [-t], Show the nginx access logs for an application (-t follows)
-    nginx:error-logs <app> [-t], Show the nginx error logs for an application (-t follows)
-help_content
-    }
-
 validate_nginx() {
   declare desc="validate entire nginx config"
   set +e

plugins/nginx-vhosts/internal-functions

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+nginx_vhosts_help_content_func() {
+    declare desc="return nginx plugin help content"
+    cat<<help_content
+    nginx:build-config <app>, (Re)builds nginx config for given app
+    nginx:access-logs <app> [-t], Show the nginx access logs for an application (-t follows)
+    nginx:error-logs <app> [-t], Show the nginx error logs for an application (-t follows)
+help_content
+}
+
+nginx_vhosts_help_cmd() {
+  if [[ $1 = "nginx:help" ]] ; then
+    echo -e 'Usage: dokku nginx[:COMMAND]'
+    echo ''
+    echo 'Interact with Dokku'"'"'s Nginx proxy.'
+    echo ''
+    echo 'Additional commands:'
+    nginx_vhosts_help_content_func | sort | column -c2 -t -s,
+  elif [[ $(ps -o command= $PPID) == *"--all"* ]]; then
+    nginx_vhosts_help_content_func
+  else
+    cat<<help_desc
+    nginx, Interact with Dokku's Nginx proxy
+help_desc
+  fi
+}

plugins/nginx-vhosts/subcommands/default

@@ -1,13 +1,5 @@
 #!/usr/bin/env bash
 set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
-source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
-source "$PLUGIN_AVAILABLE_PATH/config/functions"
-source "$PLUGIN_AVAILABLE_PATH/nginx-vhosts/functions"
+source "$PLUGIN_AVAILABLE_PATH/nginx-vhosts/internal-functions"
 
-nginx_main_cmd() {
-  declare desc="display nginx plugin help content"
-  local cmd="nginx"
-  help_formatted
-}
-
-nginx_main_cmd "$@"
+nginx_vhosts_help_cmd "$@"

plugins/proxy/commands

@@ -1,33 +1,11 @@
 #!/usr/bin/env bash
 [[ " help proxy:help " == *" $1 "* ]] || exit "$DOKKU_NOT_IMPLEMENTED_EXIT"
+source "$PLUGIN_AVAILABLE_PATH/proxy/internal-functions"
 set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
 
 case "$1" in
   help | proxy:help)
-    help_content_func () {
-      declare desc="return proxy plugin help content"
-      cat<<help_content
-    proxy <app>, Show proxy settings for app
-    proxy:enable <app>, Enable proxy for app
-    proxy:disable <app>, Disable proxy for app
-    proxy:ports <app>, List proxy port mappings for app
-    proxy:ports-clear <app>, Clear all proxy port mappings for app
-    proxy:ports-add <app> <scheme>:<host-port>:<container-port> [<scheme>:<host-port>:<container-port>...], Set proxy port mappings for app
-    proxy:ports-remove <app> <host-port> [<host-port>|<scheme>:<host-port>:<container-port>...], Unset proxy port mappings for app
-    proxy:set <app> <proxy-type>, Set proxy type for app
-help_content
-    }
-
-    if [[ $1 = "proxy:help" ]] ; then
-        echo -e 'Usage: dokku proxy[:COMMAND]'
-        echo ''
-        echo 'Control the proxy used by dokku, per app.'
-        echo ''
-        echo 'Additional commands:'
-        help_content_func | sort | column -c2 -t -s,
-    else
-        help_content_func
-    fi
+    proxy_help_cmd "$@"
     ;;
 
   *)

plugins/proxy/functions

@@ -24,10 +24,16 @@ get_app_proxy_type() {
   echo "$APP_PROXY_TYPE"
 }
 
+get_app_proxy_port_map() {
+  declare desc="return a list of configured port mappings"
+  local APP="$1"; local PROXY_PORT_MAP="$(config_get "$APP" DOKKU_PROXY_PORT_MAP || true)"
+  echo "$PROXY_PORT_MAP"
+}
+
 list_app_proxy_ports() {
   declare desc="list proxy port mappings for an app"
   local APP="$1"; verify_app_name "$APP"
-  local PROXY_PORT_MAP="$(config_get "$APP" DOKKU_PROXY_PORT_MAP || true)"
+  local PROXY_PORT_MAP="$(get_app_proxy_port_map "$APP")"
 
   if [[ -n "$PROXY_PORT_MAP" ]]; then
     dokku_log_info1_quiet "Port mappings for $APP"
@@ -45,7 +51,7 @@ filter_app_proxy_ports() {
   declare desc="list proxy port mappings for an app that start with a particular scheme and a host port"
   local APP="$1"; verify_app_name "$APP"
   local SCHEME="$2" HOST_PORT="$3"
-  local PROXY_PORT_MAP="$(config_get "$APP" DOKKU_PROXY_PORT_MAP || true)"
+  local PROXY_PORT_MAP="$(get_app_proxy_port_map "$APP")"
 
   if [[ -n "$PROXY_PORT_MAP" ]]; then
     local port_map
@@ -62,7 +68,7 @@ filter_app_proxy_ports() {
 add_proxy_ports() {
   declare desc="add proxy port mappings from an app"
   local APP="$1"
-  local PROXY_PORT_MAP="$(config_get "$APP" DOKKU_PROXY_PORT_MAP || true)"
+  local PROXY_PORT_MAP="$(get_app_proxy_port_map "$APP")"
   shift 1
 
   local INPUT_PORTS="$*"
@@ -78,7 +84,7 @@ add_proxy_ports() {
 remove_proxy_ports() {
   declare desc="remove specific proxy port mappings from an app"
   local APP="$1"
-  local PROXY_PORT_MAP="$(config_get "$APP" DOKKU_PROXY_PORT_MAP || true)"
+  local PROXY_PORT_MAP="$(get_app_proxy_port_map "$APP")"
   local RE_PORT='^[0-9]+$'
   shift 1
 

plugins/proxy/internal-functions

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+
+proxy_help_content_func() {
+    declare desc="return proxy plugin help content"
+    cat<<help_content
+    proxy <app>, [DEPRECATED] Show proxy settings for app
+    proxy:enable <app>, Enable proxy for app
+    proxy:disable <app>, Disable proxy for app
+    proxy:ports <app>, List proxy port mappings for app
+    proxy:ports-clear <app>, Clear all proxy port mappings for app
+    proxy:ports-add <app> <scheme>:<host-port>:<container-port> [<scheme>:<host-port>:<container-port>...], Set proxy port mappings for app
+    proxy:ports-remove <app> <host-port> [<host-port>|<scheme>:<host-port>:<container-port>...], Unset proxy port mappings for app
+    proxy:report [<app>] [<flag>], Displays a proxy report for one or more apps
+    proxy:set <app> <proxy-type>, Set proxy type for app
+help_content
+}
+
+proxy_help_cmd() {
+  if [[ $1 = "proxy:help" ]] ; then
+    echo -e 'Usage: dokku proxy[:COMMAND]'
+    echo ''
+    echo 'Manage the proxy used by dokku on a per app.'
+    echo ''
+    echo 'Additional commands:'
+    proxy_help_content_func | sort | column -c2 -t -s,
+  elif [[ $(ps -o command= $PPID) == *"--all"* ]]; then
+    proxy_help_content_func
+  else
+    cat<<help_desc
+    proxy, Manage the proxy used by dokku on a per app
+help_desc
+  fi
+}

plugins/proxy/subcommands/default

@@ -12,6 +12,7 @@ proxy_main_cmd() {
     local APPS="$1"
   fi
 
+  dokku_log_warn "Deprecated: Please use proxy:report"
   dokku_col_log_info1_quiet "App Name" "Proxy Type"
   local app
   for app in $APPS; do

plugins/proxy/subcommands/report

@@ -0,0 +1,70 @@
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+source "$PLUGIN_AVAILABLE_PATH/proxy/functions"
+
+fn-proxy-enabled() {
+  declare APP="$1"
+  local PROXY_ENABLED=false
+
+  if [[ "$(is_app_proxy_enabled "$APP")" == "true" ]]; then
+    PROXY_ENABLED=true
+  fi
+  echo "$PROXY_ENABLED"
+}
+
+proxy_report_single_app() {
+  local APP="$1"; local APP_DIR="$DOKKU_ROOT/$APP"; local INFO_FLAG="$2"
+  if [[ "$INFO_FLAG" == "true" ]]; then
+    INFO_FLAG=""
+  fi
+  verify_app_name "$APP"
+  local flag_map=(
+    "--proxy-enabled: $(fn-proxy-enabled "$APP")"
+    "--proxy-type: $(get_app_proxy_type "$APP")"
+    "--proxy-port-map: $(get_app_proxy_port_map "$APP")"
+  )
+
+  if [[ -z "$INFO_FLAG" ]]; then
+    dokku_log_info2 "$APP proxy 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
+}
+
+proxy_report_cmd() {
+  declare desc="displays a proxy report for one or more apps"
+  local cmd="proxy:report"
+  local INSTALLED_APPS=$(dokku_apps); local APP
+
+  if [[ -z $2 ]]; then
+    for APP in $INSTALLED_APPS; do
+      proxy_report_single_app "$APP" "true"
+    done
+  else
+    proxy_report_single_app "$2" "$3"
+  fi
+}
+
+proxy_report_cmd "$@"