From b3724716ffbb645f90663d24d6d2f50252600ec4 Mon Sep 17 00:00:00 2001
From: Jose Diaz-Gonzalez <email@josediazgonzalez.com>
Date: Tue, 24 Sep 2019 12:14:48 -0400
Subject: [PATCH] feat: implement build tracking

The DOKKU_PID now never gets overwritten except in the case that DOKKU is executed by the sudo user. If the command ends up executing a deploy, then the pid of the `dokku` owned process - which may have been executed via sudo - will be written to the file lock, allowing future commands to interact with the original process.

Additionally, the new builds plugin can be used to handle killing a build.
---
 docs/deployment/builds-management.md | 30 +++++++++++++++++++++++
 plugins/builds/commands              | 16 +++++++++++++
 plugins/builds/internal-functions    | 31 ++++++++++++++++++++++++
 plugins/builds/plugin.toml           |  4 ++++
 plugins/builds/subcommands/cancel    | 36 ++++++++++++++++++++++++++++
 plugins/builds/subcommands/default   |  6 +++++
 plugins/builds/subcommands/list      | 13 ++++++++++
 plugins/builds/subcommands/output    | 27 +++++++++++++++++++++
 plugins/builds/subcommands/report    | 15 ++++++++++++
 9 files changed, 178 insertions(+)
 create mode 100644 docs/deployment/builds-management.md
 create mode 100755 plugins/builds/commands
 create mode 100755 plugins/builds/internal-functions
 create mode 100644 plugins/builds/plugin.toml
 create mode 100755 plugins/builds/subcommands/cancel
 create mode 100755 plugins/builds/subcommands/default
 create mode 100755 plugins/builds/subcommands/list
 create mode 100755 plugins/builds/subcommands/output
 create mode 100755 plugins/builds/subcommands/report

diff --git a/docs/deployment/builds-management.md b/docs/deployment/builds-management.md
new file mode 100644
index 000000000..cf3e779dd
--- /dev/null
+++ b/docs/deployment/builds-management.md
@@ -0,0 +1,30 @@
+# Build Management
+
+> New as of 0.19.0
+
+```
+builds:cancel <app>                            # Cancel a running build for an app
+builds:list <app>                              # List all running builds
+builds:output <app>                           #  Shows build output
+builds:report [<app>] [<flag>]                 # Displays a build report for one or more apps
+```
+
+## Usage
+
+### Listing running deploys
+
+### Viewing the status of a deploy
+
+### Viewing build output for a deploy
+
+### Canceling a running deploy
+
+It can be useful to kill a deploy if that deploy does not appear to be progressing, is impacting other apps through system resource utilization, or if a successful deploy will result in app errors. To do so, the `builds:cancel` command can be used:
+
+```shell
+dokku builds:cancel node-js-app
+```
+
+This command will send a `QUIT` signal to the Process Group ID of the process handling the deploy, and should terminate all processes within that process tree. Finally, it will unlock the deploy so that a new deploy may be immediately invoked.
+
+> Warning: This may also result in invalid app state depending upon when the app deploy was killed.
diff --git a/plugins/builds/commands b/plugins/builds/commands
new file mode 100755
index 000000000..bbb121222
--- /dev/null
+++ b/plugins/builds/commands
@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+[[ " help builds:help " == *" $1 "* ]] || exit "$DOKKU_NOT_IMPLEMENTED_EXIT"
+source "$PLUGIN_AVAILABLE_PATH/builds/internal-functions"
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+
+case "$1" in
+  help | builds:help)
+    cmd-builds-help "$@"
+    ;;
+
+  *)
+    exit "$DOKKU_NOT_IMPLEMENTED_EXIT"
+    ;;
+
+esac
diff --git a/plugins/builds/internal-functions b/plugins/builds/internal-functions
new file mode 100755
index 000000000..1b56fad60
--- /dev/null
+++ b/plugins/builds/internal-functions
@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+
+fn-builds-help-content() {
+  declare desc="return logs plugin help content"
+  cat <<help_content
+    builds, Manage running builds
+    builds:cancel <app>, Cancel a running build for an app
+    builds:list <app>, List all running builds
+    builds:output <app>, Shows build output
+    builds:report [<app>] [<flag>], Displays a build report for one or more apps
+help_content
+}
+
+cmd-builds-help() {
+  if [[ $1 == "builds:help" ]]; then
+    echo -e 'Usage: dokku builds[:COMMAND]'
+    echo ''
+    echo 'Manage running builds'
+    echo ''
+    echo 'Additional commands:'
+    fn-builds-help-content | sort | column -c2 -t -s,
+  elif [[ $(ps -o command= $PPID) == *"--all"* ]]; then
+    fn-builds-help-content
+  else
+    cat <<help_desc
+    builds, Manage running builds
+help_desc
+  fi
+}
diff --git a/plugins/builds/plugin.toml b/plugins/builds/plugin.toml
new file mode 100644
index 000000000..3dae3d778
--- /dev/null
+++ b/plugins/builds/plugin.toml
@@ -0,0 +1,4 @@
+[plugin]
+description = "dokku core builds plugin"
+version = "0.33.6"
+[plugin.config]
diff --git a/plugins/builds/subcommands/cancel b/plugins/builds/subcommands/cancel
new file mode 100755
index 000000000..a45d85f99
--- /dev/null
+++ b/plugins/builds/subcommands/cancel
@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+
+cmd-builds-cancel() {
+  declare desc="cancel a running build for an app"
+  declare cmd="builds:cancel"
+  [[ "$1" == "$cmd" ]] && shift 1
+  declare APP="$1"
+  verify_app_name "$APP"
+
+  local APP_DEPLOY_LOCK_FILE PROCESS_ID PROCESS_GROUP_ID
+  APP_DEPLOY_LOCK_FILE="$DOKKU_ROOT/$APP/.deploy.lock"
+  if [[ ! -f "$APP_DEPLOY_LOCK_FILE" ]]; then
+    dokku_log_info1 "No matching app deploy found"
+    return
+  fi
+
+  PROCESS_ID="$(cat "$APP_DEPLOY_LOCK_FILE")"
+  if [[ -z "$PROCESS_ID" ]]; then
+    dokku_log_info1 "No matching app deploy found"
+    return
+  fi
+
+  PROCESS_GROUP_ID="$(ps -o pgid= "$PROCESS_ID" || true)"
+  if [[ -z "$PROCESS_ID" ]]; then
+    dokku_log_info1 "No matching app deploy found"
+    return
+  fi
+
+  dokku_log_info1 "Killing app deploy"
+  kill -quit -- "-${PROCESS_GROUP_ID}" && rm -f "$DOKKU_ROOT/$APP/.deploy.lock"
+}
+
+ps_kill_deploy_cmd "$@"
diff --git a/plugins/builds/subcommands/default b/plugins/builds/subcommands/default
new file mode 100755
index 000000000..f0205d69f
--- /dev/null
+++ b/plugins/builds/subcommands/default
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_AVAILABLE_PATH/builds/internal-functions"
+
+cmd-builds-help "builds:help"
diff --git a/plugins/builds/subcommands/list b/plugins/builds/subcommands/list
new file mode 100755
index 000000000..b8bf8b624
--- /dev/null
+++ b/plugins/builds/subcommands/list
@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+
+cmd-builds-list() {
+  declare desc="list all running builds"
+  declare cmd="builds:list"
+  [[ "$1" == "$cmd" ]] && shift 1
+
+}
+
+cmd-builds-list "$@"
diff --git a/plugins/builds/subcommands/output b/plugins/builds/subcommands/output
new file mode 100755
index 000000000..4ddb23ecc
--- /dev/null
+++ b/plugins/builds/subcommands/output
@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+
+cmd-builds-output() {
+  declare desc="shows build output"
+  declare cmd="builds:output"
+  [[ "$1" == "$cmd" ]] && shift 1
+  declare APP="$1"
+  verify_app_name "$APP"
+
+  local APP_DEPLOY_LOCK_FILE PROCESS_ID
+  APP_DEPLOY_LOCK_FILE="$DOKKU_ROOT/$APP/.deploy.lock"
+  if [[ ! -f "$APP_DEPLOY_LOCK_FILE" ]]; then
+    dokku_log_info1 "No matching app deploy found"
+    return
+  fi
+
+  PROCESS_ID="$(cat "$APP_DEPLOY_LOCK_FILE")"
+  if [[ -z "$PROCESS_ID" ]]; then
+    dokku_log_info1 "No matching app deploy found"
+    return
+  fi
+}
+
+cmd-builds-output "$@"
diff --git a/plugins/builds/subcommands/report b/plugins/builds/subcommands/report
new file mode 100755
index 000000000..f9a78f2f9
--- /dev/null
+++ b/plugins/builds/subcommands/report
@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+set -eo pipefail
+[[ $DOKKU_TRACE ]] && set -x
+source "$PLUGIN_CORE_AVAILABLE_PATH/common/functions"
+
+cmd-builds-report() {
+  declare desc="displays a build report for one or more apps"
+  declare cmd="builds:report"
+  [[ "$1" == "$cmd" ]] && shift 1
+  declare APP="$1"
+  verify_app_name "$APP"
+
+}
+
+cmd-builds-report "$@"