toolshed/abra-bash
toolshed/abra-bash
Archived
5
0
Fork 3
Code Pull Requests Releases Activity

Add per-subcommand help
All checks were successful
continuous-integration/drone/pr Build is passing
Details

Browse Source
This commit is contained in:
3wc 2020-12-30 23:05:06 +02:00
parent 55a406573b
commit 7ec625e329
1 changed files with 136 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

207
abra
View File

@ -35,6 +35,7 @@ Usage:
abra [options] server <host> apps [--status] abra [options] server <host> apps [--status]
abra [options] upgrade abra [options] upgrade
abra [options] version abra [options] version
abra [options] help [<subcommand>]
Options: Options:
-e, --env=<path> Environment variables to load -e, --env=<path> Environment variables to load
@ -143,12 +144,12 @@ eval "var_$1+=($value)"; else eval "var_$1=$value"; fi; return 0; fi; done
return 1; }; stdout() { printf -- "cat <<'EOM'\n%s\nEOM\n" "$1"; }; stderr() { return 1; }; stdout() { printf -- "cat <<'EOM'\n%s\nEOM\n" "$1"; }; stderr() {
printf -- "cat <<'EOM' >&2\n%s\nEOM\n" "$1"; }; error() { printf -- "cat <<'EOM' >&2\n%s\nEOM\n" "$1"; }; error() {
[[ -n $1 ]] && stderr "$1"; stderr "$usage"; _return 1; }; _return() { [[ -n $1 ]] && stderr "$1"; stderr "$usage"; _return 1; }; _return() {
printf -- "exit %d\n" "$1"; exit "$1"; }; set -e; trimmed_doc=${DOC:1:1447} printf -- "exit %d\n" "$1"; exit "$1"; }; set -e; trimmed_doc=${DOC:1:1484}
usage=${DOC:40:1183}; digest=e7fac usage=${DOC:40:1220}; digest=9c7dc
shorts=(-h -s -e '' '' '' '' '' '' '' '' '' '') shorts=(-e -s -h '' '' '' '' '' '' '' '' '' '')
longs=(--help --stack --env --server --domain --pass --auto --status --skip-check --force --no-tty --user --all) longs=(--env --stack --help --server --domain --pass --auto --status --skip-check --force --no-tty --user --all)
argcounts=(0 1 1 1 1 0 0 0 0 0 0 1 0); node_0(){ switch __help 0; }; node_1(){ argcounts=(1 1 0 1 1 0 0 0 0 0 0 1 0); node_0(){ value __env 0; }; node_1(){
value __stack 1; }; node_2(){ value __env 2; }; node_3(){ value __server 3; } value __stack 1; }; node_2(){ switch __help 2; }; node_3(){ value __server 3; }
node_4(){ value __domain 4; }; node_5(){ switch __pass 5; }; node_6(){ node_4(){ value __domain 4; }; node_5(){ switch __pass 5; }; node_6(){
switch __auto 6; }; node_7(){ switch __status 7; }; node_8(){ switch __auto 6; }; node_7(){ switch __status 7; }; node_8(){
switch __skip_check 8; }; node_9(){ switch __force 9; }; node_10(){ switch __skip_check 8; }; node_9(){ switch __force 9; }; node_10(){
@ -158,64 +159,67 @@ value _service_ a; }; node_16(){ value _src_ a; }; node_17(){ value _dst_ a; }
node_18(){ value _args_ a true; }; node_19(){ value _secret_ a; }; node_20(){ node_18(){ value _args_ a true; }; node_19(){ value _secret_ a; }; node_20(){
value _version_ a; }; node_21(){ value _cmd_ a; }; node_22(){ value _data_ a; } value _version_ a; }; node_21(){ value _cmd_ a; }; node_22(){ value _data_ a; }
node_23(){ value _command_ a; }; node_24(){ value _host_ a; }; node_25(){ node_23(){ value _command_ a; }; node_24(){ value _host_ a; }; node_25(){
value _user_ a; }; node_26(){ value _port_ a; }; node_27(){ _command app; } value _user_ a; }; node_26(){ value _port_ a; }; node_27(){ value _subcommand_ a
node_28(){ _command new; }; node_29(){ _command list; }; node_30(){ _command ls }; node_28(){ _command app; }; node_29(){ _command new; }; node_30(){
}; node_31(){ _command deploy; }; node_32(){ _command undeploy; }; node_33(){ _command list; }; node_31(){ _command ls; }; node_32(){ _command deploy; }
_command config; }; node_34(){ _command delete; }; node_35(){ _command rm; } node_33(){ _command undeploy; }; node_34(){ _command config; }; node_35(){
node_36(){ _command logs; }; node_37(){ _command cp; }; node_38(){ _command delete; }; node_36(){ _command rm; }; node_37(){ _command logs; }
_command check; }; node_39(){ _command ps; }; node_40(){ _command run; } node_38(){ _command cp; }; node_39(){ _command check; }; node_40(){ _command ps
node_41(){ _command secret; }; node_42(){ _command auto; }; node_43(){ }; node_41(){ _command run; }; node_42(){ _command secret; }; node_43(){
_command generate; }; node_44(){ _command insert; }; node_45(){ _command server _command auto; }; node_44(){ _command generate; }; node_45(){ _command insert; }
}; node_46(){ _command add; }; node_47(){ _command init; }; node_48(){ node_46(){ _command server; }; node_47(){ _command add; }; node_48(){
_command apps; }; node_49(){ _command upgrade; }; node_50(){ _command version; } _command init; }; node_49(){ _command apps; }; node_50(){ _command upgrade; }
node_51(){ optional 0 1 2; }; node_52(){ optional 51; }; node_53(){ optional 3 node_51(){ _command version; }; node_52(){ _command help; }; node_53(){
}; node_54(){ optional 4; }; node_55(){ optional 5; }; node_56(){ optional 6; } optional 0 1 2; }; node_54(){ optional 53; }; node_55(){ optional 3; }
node_57(){ required 52 27 28 53 54 55 56 13; }; node_58(){ either 29 30; } node_56(){ optional 4; }; node_57(){ optional 5; }; node_58(){ optional 6; }
node_59(){ required 58; }; node_60(){ optional 7; }; node_61(){ node_59(){ required 54 28 29 55 56 57 58 13; }; node_60(){ either 30 31; }
required 52 27 59 60 53; }; node_62(){ optional 8; }; node_63(){ node_61(){ required 60; }; node_62(){ optional 7; }; node_63(){
required 52 27 14 31 62; }; node_64(){ required 52 27 14 32; }; node_65(){ required 54 28 61 62 55; }; node_64(){ optional 8; }; node_65(){
required 52 27 14 33; }; node_66(){ either 34 35; }; node_67(){ required 66; } required 54 28 14 32 64; }; node_66(){ required 54 28 14 33; }; node_67(){
node_68(){ optional 9; }; node_69(){ required 52 27 14 67 68; }; node_70(){ required 54 28 14 34; }; node_68(){ either 35 36; }; node_69(){ required 68; }
optional 15; }; node_71(){ required 52 27 14 36 70; }; node_72(){ node_70(){ optional 9; }; node_71(){ required 54 28 14 69 70; }; node_72(){
required 52 27 14 37 16 17; }; node_73(){ required 52 27 14 38; }; node_74(){ optional 15; }; node_73(){ required 54 28 14 37 72; }; node_74(){
required 52 27 14 39; }; node_75(){ optional 10; }; node_76(){ optional 11; } required 54 28 14 38 16 17; }; node_75(){ required 54 28 14 39; }; node_76(){
node_77(){ oneormore 18; }; node_78(){ required 52 27 14 40 75 76 15 77; } required 54 28 14 40; }; node_77(){ optional 10; }; node_78(){ optional 11; }
node_79(){ required 52 27 14 41 42 55; }; node_80(){ optional 21; }; node_81(){ node_79(){ oneormore 18; }; node_80(){ required 54 28 14 41 77 78 15 79; }
required 52 27 14 41 43 19 20 80 55; }; node_82(){ node_81(){ required 54 28 14 42 43 57; }; node_82(){ optional 21; }; node_83(){
required 52 27 14 41 44 19 20 22 55; }; node_83(){ either 19 12; }; node_84(){ required 54 28 14 42 44 19 20 82 57; }; node_84(){
required 83; }; node_85(){ required 52 27 14 41 67 84 55 68; }; node_86(){ required 54 28 14 42 45 19 20 22 57; }; node_85(){ either 19 12; }; node_86(){
optional 77; }; node_87(){ required 52 27 14 23 86; }; node_88(){ optional 25; } required 85; }; node_87(){ required 54 28 14 42 69 86 57 70; }; node_88(){
node_89(){ optional 26; }; node_90(){ required 52 45 46 24 88 89; }; node_91(){ optional 79; }; node_89(){ required 54 28 14 23 88; }; node_90(){ optional 25; }
required 52 45 59; }; node_92(){ required 52 45 24 35; }; node_93(){ node_91(){ optional 26; }; node_92(){ required 54 46 47 24 90 91; }; node_93(){
required 52 45 24 47; }; node_94(){ required 52 45 24 48 60; }; node_95(){ required 54 46 61; }; node_94(){ required 54 46 24 36; }; node_95(){
required 52 49; }; node_96(){ required 52 50; }; node_97(){ required 54 46 24 48; }; node_96(){ required 54 46 24 49 62; }; node_97(){
either 57 61 63 64 65 69 71 72 73 74 78 79 81 82 85 87 90 91 92 93 94 95 96; } required 54 50; }; node_98(){ required 54 51; }; node_99(){ optional 27; }
node_98(){ required 97; }; cat <<<' docopt_exit() { node_100(){ required 54 52 99; }; node_101(){
[[ -n $1 ]] && printf "%s\n" "$1" >&2; printf "%s\n" "${DOC:40:1183}" >&2 either 59 63 65 66 67 71 73 74 75 76 80 81 83 84 87 89 92 93 94 95 96 97 98 100
exit 1; }'; unset var___help var___stack var___env var___server var___domain \ }; node_102(){ required 101; }; cat <<<' docopt_exit() {
[[ -n $1 ]] && printf "%s\n" "$1" >&2; printf "%s\n" "${DOC:40:1220}" >&2
exit 1; }'; unset var___env var___stack var___help var___server var___domain \
var___pass var___auto var___status var___skip_check var___force var___no_tty \ var___pass var___auto var___status var___skip_check var___force var___no_tty \
var___user var___all var__type_ var__domain_ var__service_ var__src_ var__dst_ \ var___user var___all var__type_ var__domain_ var__service_ var__src_ var__dst_ \
var__args_ var__secret_ var__version_ var__cmd_ var__data_ var__command_ \ var__args_ var__secret_ var__version_ var__cmd_ var__data_ var__command_ \
var__host_ var__user_ var__port_ var_app var_new var_list var_ls var_deploy \ var__host_ var__user_ var__port_ var__subcommand_ var_app var_new var_list \
var_undeploy var_config var_delete var_rm var_logs var_cp var_check var_ps \ var_ls var_deploy var_undeploy var_config var_delete var_rm var_logs var_cp \
var_run var_secret var_auto var_generate var_insert var_server var_add \ var_check var_ps var_run var_secret var_auto var_generate var_insert \
var_init var_apps var_upgrade var_version; parse 98 "$@" var_server var_add var_init var_apps var_upgrade var_version var_help
local prefix=${DOCOPT_PREFIX:-''}; unset "${prefix}__help" "${prefix}__stack" \ parse 102 "$@"; local prefix=${DOCOPT_PREFIX:-''}; unset "${prefix}__env" \
"${prefix}__env" "${prefix}__server" "${prefix}__domain" "${prefix}__pass" \ "${prefix}__stack" "${prefix}__help" "${prefix}__server" "${prefix}__domain" \
"${prefix}__auto" "${prefix}__status" "${prefix}__skip_check" \ "${prefix}__pass" "${prefix}__auto" "${prefix}__status" \
"${prefix}__force" "${prefix}__no_tty" "${prefix}__user" "${prefix}__all" \ "${prefix}__skip_check" "${prefix}__force" "${prefix}__no_tty" \
"${prefix}_type_" "${prefix}_domain_" "${prefix}_service_" "${prefix}_src_" \ "${prefix}__user" "${prefix}__all" "${prefix}_type_" "${prefix}_domain_" \
"${prefix}_dst_" "${prefix}_args_" "${prefix}_secret_" "${prefix}_version_" \ "${prefix}_service_" "${prefix}_src_" "${prefix}_dst_" "${prefix}_args_" \
"${prefix}_cmd_" "${prefix}_data_" "${prefix}_command_" "${prefix}_host_" \ "${prefix}_secret_" "${prefix}_version_" "${prefix}_cmd_" "${prefix}_data_" \
"${prefix}_user_" "${prefix}_port_" "${prefix}app" "${prefix}new" \ "${prefix}_command_" "${prefix}_host_" "${prefix}_user_" "${prefix}_port_" \
"${prefix}list" "${prefix}ls" "${prefix}deploy" "${prefix}undeploy" \ "${prefix}_subcommand_" "${prefix}app" "${prefix}new" "${prefix}list" \
"${prefix}config" "${prefix}delete" "${prefix}rm" "${prefix}logs" \ "${prefix}ls" "${prefix}deploy" "${prefix}undeploy" "${prefix}config" \
"${prefix}cp" "${prefix}check" "${prefix}ps" "${prefix}run" "${prefix}secret" \ "${prefix}delete" "${prefix}rm" "${prefix}logs" "${prefix}cp" "${prefix}check" \
"${prefix}auto" "${prefix}generate" "${prefix}insert" "${prefix}server" \ "${prefix}ps" "${prefix}run" "${prefix}secret" "${prefix}auto" \
"${prefix}add" "${prefix}init" "${prefix}apps" "${prefix}upgrade" \ "${prefix}generate" "${prefix}insert" "${prefix}server" "${prefix}add" \
"${prefix}version"; eval "${prefix}"'__help=${var___help:-false}' "${prefix}init" "${prefix}apps" "${prefix}upgrade" "${prefix}version" \
"${prefix}help"; eval "${prefix}"'__env=${var___env:-}'
eval "${prefix}"'__stack=${var___stack:-}' eval "${prefix}"'__stack=${var___stack:-}'
eval "${prefix}"'__env=${var___env:-}' eval "${prefix}"'__help=${var___help:-false}'
eval "${prefix}"'__server=${var___server:-}' eval "${prefix}"'__server=${var___server:-}'
eval "${prefix}"'__domain=${var___domain:-}' eval "${prefix}"'__domain=${var___domain:-}'
eval "${prefix}"'__pass=${var___pass:-false}' eval "${prefix}"'__pass=${var___pass:-false}'
@ -239,6 +243,7 @@ eval "${prefix}"'_command_=${var__command_:-}'
eval "${prefix}"'_host_=${var__host_:-}' eval "${prefix}"'_host_=${var__host_:-}'
eval "${prefix}"'_user_=${var__user_:-}' eval "${prefix}"'_user_=${var__user_:-}'
eval "${prefix}"'_port_=${var__port_:-}' eval "${prefix}"'_port_=${var__port_:-}'
eval "${prefix}"'_subcommand_=${var__subcommand_:-}'
eval "${prefix}"'app=${var_app:-false}'; eval "${prefix}"'new=${var_new:-false}' eval "${prefix}"'app=${var_app:-false}'; eval "${prefix}"'new=${var_new:-false}'
eval "${prefix}"'list=${var_list:-false}'; eval "${prefix}"'ls=${var_ls:-false}' eval "${prefix}"'list=${var_list:-false}'; eval "${prefix}"'ls=${var_ls:-false}'
eval "${prefix}"'deploy=${var_deploy:-false}' eval "${prefix}"'deploy=${var_deploy:-false}'
@ -258,21 +263,23 @@ eval "${prefix}"'add=${var_add:-false}'
eval "${prefix}"'init=${var_init:-false}' eval "${prefix}"'init=${var_init:-false}'
eval "${prefix}"'apps=${var_apps:-false}' eval "${prefix}"'apps=${var_apps:-false}'
eval "${prefix}"'upgrade=${var_upgrade:-false}' eval "${prefix}"'upgrade=${var_upgrade:-false}'
eval "${prefix}"'version=${var_version:-false}'; local docopt_i=1 eval "${prefix}"'version=${var_version:-false}'
eval "${prefix}"'help=${var_help:-false}'; local docopt_i=1
[[ $BASH_VERSION =~ ^4.3 ]] && docopt_i=2; for ((;docopt_i>0;docopt_i--)); do [[ $BASH_VERSION =~ ^4.3 ]] && docopt_i=2; for ((;docopt_i>0;docopt_i--)); do
declare -p "${prefix}__help" "${prefix}__stack" "${prefix}__env" \ declare -p "${prefix}__env" "${prefix}__stack" "${prefix}__help" \
"${prefix}__server" "${prefix}__domain" "${prefix}__pass" "${prefix}__auto" \ "${prefix}__server" "${prefix}__domain" "${prefix}__pass" "${prefix}__auto" \
"${prefix}__status" "${prefix}__skip_check" "${prefix}__force" \ "${prefix}__status" "${prefix}__skip_check" "${prefix}__force" \
"${prefix}__no_tty" "${prefix}__user" "${prefix}__all" "${prefix}_type_" \ "${prefix}__no_tty" "${prefix}__user" "${prefix}__all" "${prefix}_type_" \
"${prefix}_domain_" "${prefix}_service_" "${prefix}_src_" "${prefix}_dst_" \ "${prefix}_domain_" "${prefix}_service_" "${prefix}_src_" "${prefix}_dst_" \
"${prefix}_args_" "${prefix}_secret_" "${prefix}_version_" "${prefix}_cmd_" \ "${prefix}_args_" "${prefix}_secret_" "${prefix}_version_" "${prefix}_cmd_" \
"${prefix}_data_" "${prefix}_command_" "${prefix}_host_" "${prefix}_user_" \ "${prefix}_data_" "${prefix}_command_" "${prefix}_host_" "${prefix}_user_" \
"${prefix}_port_" "${prefix}app" "${prefix}new" "${prefix}list" "${prefix}ls" \ "${prefix}_port_" "${prefix}_subcommand_" "${prefix}app" "${prefix}new" \
"${prefix}deploy" "${prefix}undeploy" "${prefix}config" "${prefix}delete" \ "${prefix}list" "${prefix}ls" "${prefix}deploy" "${prefix}undeploy" \
"${prefix}rm" "${prefix}logs" "${prefix}cp" "${prefix}check" "${prefix}ps" \ "${prefix}config" "${prefix}delete" "${prefix}rm" "${prefix}logs" \
"${prefix}run" "${prefix}secret" "${prefix}auto" "${prefix}generate" \ "${prefix}cp" "${prefix}check" "${prefix}ps" "${prefix}run" "${prefix}secret" \
"${prefix}insert" "${prefix}server" "${prefix}add" "${prefix}init" \ "${prefix}auto" "${prefix}generate" "${prefix}insert" "${prefix}server" \
"${prefix}apps" "${prefix}upgrade" "${prefix}version"; done; } "${prefix}add" "${prefix}init" "${prefix}apps" "${prefix}upgrade" \
"${prefix}version" "${prefix}help"; done; }
# docopt parser above, complete command for generating this parser is `docopt.sh abra` # docopt parser above, complete command for generating this parser is `docopt.sh abra`
PROGRAM_NAME=$(basename "$0") PROGRAM_NAME=$(basename "$0")
@ -475,11 +482,26 @@ stack_logs (){
# abra app .. # abra app ..
####################################### #######################################
###### .. app (list|ls) ###### .. app ls
help_app_ls (){
help_app_list
}
sub_app_ls (){ sub_app_ls (){
sub_app_list sub_app_list
} }
help_app_list (){
echo "abra [options] app (list|ls) [--status] [--server=<server>]
List your exciting apps
OPTIONS
--status Show whether apps are deployed (warning! slow!)
--server=<server> Filter to a specific server"
}
sub_app_list (){ sub_app_list (){
SERVER="$abra___server" SERVER="$abra___server"
if [ -z "$SERVER" ]; then if [ -z "$SERVER" ]; then
@ -547,7 +569,19 @@ sub_app_list (){
# Align table `-t` based on tab characters -s`^V<Tab>` # Align table `-t` based on tab characters -s`^V<Tab>`
} }
###### .. app new [--domain=<domain> --server=<server>] ###### .. app new
help_app_new (){
echo "abra [options] app new [--server=<server>] [--domain=<domain>] [--pass] [--auto] <type>
Create a new app of <type> (e.g. wordpress or custom-html)
OPTIONS
--server=<server> Specify which server to use (default: prompt)
--domain=<domain> Set the domain name (default: prompt)
--auto Auto-generate secrets (default: no)
--pass Store generated secrets in pass (default: no)"
}
sub_app_new (){ sub_app_new (){
require_abra_dir require_abra_dir
get_servers get_servers
@ -612,6 +646,14 @@ sub_app_new (){
} }
###### .. app <domain> deploy ###### .. app <domain> deploy
help_app_deploy (){
echo "abra [options] app <domain> deploy [--skip-check]
Deploy app <domain> to the configured server
OPTIONS
--skip-check Don't check whether app definition is up-to-date first"
}
sub_app_deploy (){ sub_app_deploy (){
load_instance load_instance
load_instance_env load_instance_env
@ -998,6 +1040,28 @@ sub_version() {
echo "$ABRA_VERSION" echo "$ABRA_VERSION"
} }
###### .. help
sub_help() {
if [ -z "$abra__subcommand_" ]; then
printf "%s" "$DOC"
exit
fi
HELP_CMD="help_${abra__subcommand_}"
if type "$HELP_CMD" > /dev/null 2>&1; then
"$HELP_CMD"
else
HELP_COMMANDS=$(declare -Ff | grep 'help_' | cut -d' ' -f3)
error "No help found for '$abra__subcommand_'
Try one of these:
${HELP_COMMANDS//help_/}"
fi
}
#######################################
# cheeky docker aliases
#######################################
###### .. stack <args>... ###### .. stack <args>...
sub_stack() { sub_stack() {
# shellcheck disable=SC2068 # shellcheck disable=SC2068
@ -1027,7 +1091,8 @@ abra() {
abra__secret_ abra__version_ abra__data_ abra___user abra__host_ \ abra__secret_ abra__version_ abra__data_ abra___user abra__host_ \
abra__type_ abra__port_ abra__user_ abra__service_ abra__src_ abra__dst_ \ abra__type_ abra__port_ abra__user_ abra__service_ abra__src_ abra__dst_ \
abra__domain_ abra___server abra___domain abra___force abra___pass \ abra__domain_ abra___server abra___domain abra___force abra___pass \
abra___auto abra___status abra___no_tty abra___skip_check abra___auto abra___status abra___no_tty abra___skip_check \
abra__subcommand_
if ! type tput > /dev/null 2>&1; then if ! type tput > /dev/null 2>&1; then
tput() { tput() {