Add the ability to manually execute checks against an application

Checks can be run in several ways:

- checks:run APP
- checks:run APP PROCESS_TYPE
- checks:run APP PROCESS_TYPE.CONTAINER_INDEX

This will reuse the existing checks infrastructure as defined by the checks plugin, and therefore if no checks file is defined, it will default to the normal Dokku container check.

Closes #2218

plugins/checks/check-deploy

@@ -53,7 +53,6 @@ checks_check_deploy() {
     local DOKKU_APP_CONTAINER_ID=${DOKKU_APP_CIDS[0]}
   fi
 
-
   # source global and in-app envs to get DOKKU_CHECKS_WAIT and any other necessary vars
   eval "$(config_export global)"
   eval "$(config_export app "$APP")"

plugins/checks/commands

@@ -10,6 +10,7 @@ case "$1" in
     checks <app>, Show zero-downtime status
     checks:disable <app> [process-type(s)], Disable zero-downtime deployment for all processes (or comma-separated process-type list) ***WARNING: this will cause downtime during deployments***
     checks:enable <app> [process-type(s)], Enable zero-downtime deployment for all processes (or comma-separated process-type list)
+    checks:run <app> [process-type(s)], Runs zero-downtime checks for all processes (or comma-separated process-type list)
     checks:skip <app> [process-type(s)], Skip zero-downtime checks for all processes (or comma-separated process-type list)
 help_content
     }

plugins/checks/subcommands/run

@@ -0,0 +1,89 @@
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+source "$PLUGIN_AVAILABLE_PATH/checks/functions"
+
+check_all_processes() {
+  local APP="$1"; CHECK_PROC_TYPE="$2"
+  local DOKKU_SCALE_FILE="$DOKKU_ROOT/$APP/DOKKU_SCALE"
+  local VALID_CHECK_PROC_TYPE=false
+
+  local line; local PROC_TYPE; local PROC_COUNT
+  while read -r line || [[ -n "$line" ]]; do
+    [[ "$line" =~ ^#.* ]] && continue
+    line="$(strip_inline_comments "$line")"
+    local PROC_TYPE=${line%%=*}
+    local PROC_COUNT=${line#*=}
+
+    if [[ -n "$CHECK_PROC_TYPE" ]] && [[ "$CHECK_PROC_TYPE" != "$PROC_TYPE" ]]; then
+      continue
+    fi
+
+    VALID_CHECK_PROC_TYPE=true
+    if [[ "$(is_app_proctype_checks_disabled "$APP" "$PROC_TYPE")" == "true" ]]; then
+      dokku_log_info1 "Zero downtime is disabled for app ($APP.$PROC_TYPE). Skipping checks"
+      continue
+    fi
+
+    check_process_type "$APP" "$PROC_TYPE" "$PROC_COUNT"
+  done < "$DOKKU_SCALE_FILE"
+
+  if [[ "$VALID_CHECK_PROC_TYPE" == "false" ]]; then
+    dokku_log_fail "Invalid process type specified ($APP.$CHECK_PROC_TYPE)"
+  fi
+}
+
+check_process_type() {
+  local APP="$1" PROC_TYPE="$2" PROC_COUNT="$3"
+  local CONTAINER_INDEX=1
+
+  while [[ $CONTAINER_INDEX -le $PROC_COUNT ]]; do
+    check_process "$APP" "$PROC_TYPE" "$CONTAINER_INDEX"
+    local CONTAINER_INDEX=$(( CONTAINER_INDEX + 1 ))
+  done
+}
+
+check_process() {
+  local APP="$1" PROC_TYPE="$2" CONTAINER_INDEX="$3"
+  local DOKKU_CONTAINER_ID_FILE="$DOKKU_ROOT/$APP/CONTAINER.$PROC_TYPE.$CONTAINER_INDEX"
+  local DOKKU_IP_FILE="$DOKKU_ROOT/$APP/IP.$PROC_TYPE.$CONTAINER_INDEX"
+  local DOKKU_PORT_FILE="$DOKKU_ROOT/$APP/PORT.$PROC_TYPE.$CONTAINER_INDEX"
+
+  if [[ ! -f "$DOKKU_CONTAINER_ID_FILE" ]]; then
+    dokku_log_fail "Invalid container index specified ($APP.$PROC_TYPE.$CONTAINER_INDEX)"
+  fi
+
+  dokku_log_info1 "Running checks for app ($APP.$PROC_TYPE.$CONTAINER_INDEX)"
+  local CONTAINER_ID=$(< "$DOKKU_CONTAINER_ID_FILE")
+  local IP=$(< "$DOKKU_IP_FILE")
+  local PORT=$(< "$DOKKU_PORT_FILE")
+  plugn trigger check-deploy "$APP" "$CONTAINER_ID" "$PROC_TYPE" "$PORT" "$IP"
+}
+
+checks_run_cmd() {
+  declare desc="run zero-downtime checks for app/proctypes"
+  local cmd="checks:run"
+  [[ "$1" == "$cmd" ]] && shift 1
+  local APP="$1"; verify_app_name "$APP"
+  local PROCTYPES="${2:-_all_}"
+
+  dokku_log_info1 "Running pre-flight checks"
+  if [[ "$PROCTYPES" == "_all_" ]]; then
+    check_all_processes "$APP"
+  else
+    local PROC_TYPE OIFS="$IFS" IFS=,
+    for PROC_TYPE in $PROCTYPES; do
+      IFS="$OIFS"
+
+      local CONTAINER_INDEX=$(echo "$PROC_TYPE" | cut -d'.' -f2 -s)
+      local PROC_TYPE=$(echo "$PROC_TYPE" | cut -d'.' -f1)
+      if [[ -n "$CONTAINER_INDEX" ]]; then
+        check_process "$APP" "$PROC_TYPE" "$CONTAINER_INDEX"
+      else
+        check_all_processes "$APP" "$PROC_TYPE"
+      fi
+    done
+  fi
+}
+
+checks_run_cmd "$@"

plugins/common/functions

@@ -624,7 +624,7 @@ dokku_deploy_cmd() {
       trap 'kill_new $id' INT TERM EXIT
       if [[ "$(is_app_proctype_checks_disabled "$APP" "$PROC_TYPE")" == "false" ]]; then
         dokku_log_info1 "Attempting pre-flight checks"
-        plugn trigger check-deploy  "$APP" "$id" "$PROC_TYPE" "$port" "$ipaddr"
+        plugn trigger check-deploy "$APP" "$id" "$PROC_TYPE" "$port" "$ipaddr"
       fi
       trap -        INT TERM EXIT