A first stab at docopt-sh integration

This commit is contained in:
Luke Murphy 2020-10-25 21:41:17 +01:00
parent dad72c820a
commit ae6c2c26ae
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
2 changed files with 144 additions and 43 deletions

View File

@ -14,4 +14,13 @@ dev-install-yq:
chmod +x yq_linux_amd64 && \
mv yq_linux_amd64 ~/.local/bin/yq
.PHONY: dev-install install test dev-install-yq
docopt:
@if [ ! -d ".venv" ]; then \
python3 -m venv .venv && \
.venv/bin/pip install -U pip setuptools wheel && \
.venv/bin/pip install docopt-sh; \
fi
.venv/bin/docopt.sh abra
.PHONY: dev-install install test dev-install-yq docopt

176
abra
View File

@ -1,4 +1,137 @@
#!/bin/bash
#!/usr/bin/env bash
###### Global help
DOC="The cooperative cloud utility belt 🎩🐇
Usage:
abra
Options:
Commands:
"
### TODO(decentral1se): convert this into `DOC`
sub_help() {
echo "Usage: $PROGRAM_NAME [OPTIONS] COMMAND [ARGS]..."
echo ""
echo "Options:"
echo " --config Stack configuration to use"
echo " --env Environment variables to load"
echo " --help Show this message and exit"
echo " --stack Name of the target stack"
echo " --version Show program version"
echo ""
echo "Commands:"
echo " server manage remote host"
echo " cp copy files to a container"
echo " deploy let 'em rip"
echo " logs tail logs from a deployed service"
echo " multilogs tail logs from a whole stackk"
echo " run run a command in the specified service's container"
echo " secret manage secrets"
echo " upgrade upgrade to the latest version"
}
sub_secret_help() {
echo "Usage: $PROGRAM_NAME [global opts] secret <subcommand> [sub opts]"
echo ""
echo "Subcommands:"
echo " generate SECRET VERSION [PWGEN] generate & store secret"
echo " insert SECRET VERSION PW save PW in docker and pass"
}
sub_server_help() {
echo "Usage: $PROGRAM_NAME [global opts] server <subcommand> [sub opts]"
echo ""
echo "Subcommands:"
echo " add HOST [USER] [PORT] set up remote Docker context"
echo " rm HOST"
echo " use HOST activate remote Docker context"
echo " init HOST activate swarm mode"
}
###
# docopt parser below, refresh this parser with `docopt.sh abra`
# shellcheck disable=2016,1075
docopt() { parse() { if ${DOCOPT_DOC_CHECK:-true}; then local doc_hash
if doc_hash=$(printf "%s" "$DOC" | (sha256sum 2>/dev/null || shasum -a 256)); then
if [[ ${doc_hash:0:5} != "$digest" ]]; then
stderr "The current usage doc (${doc_hash:0:5}) does not match \
what the parser was generated with (${digest})
Run \`docopt.sh\` to refresh the parser."; _return 70; fi; fi; fi
local root_idx=$1; shift; argv=("$@"); parsed_params=(); parsed_values=()
left=(); testdepth=0; local arg; while [[ ${#argv[@]} -gt 0 ]]; do
if [[ ${argv[0]} = "--" ]]; then for arg in "${argv[@]}"; do
parsed_params+=('a'); parsed_values+=("$arg"); done; break
elif [[ ${argv[0]} = --* ]]; then parse_long
elif [[ ${argv[0]} = -* && ${argv[0]} != "-" ]]; then parse_shorts
elif ${DOCOPT_OPTIONS_FIRST:-false}; then for arg in "${argv[@]}"; do
parsed_params+=('a'); parsed_values+=("$arg"); done; break; else
parsed_params+=('a'); parsed_values+=("${argv[0]}"); argv=("${argv[@]:1}"); fi
done; local idx; if ${DOCOPT_ADD_HELP:-true}; then
for idx in "${parsed_params[@]}"; do [[ $idx = 'a' ]] && continue
if [[ ${shorts[$idx]} = "-h" || ${longs[$idx]} = "--help" ]]; then
stdout "$trimmed_doc"; _return 0; fi; done; fi
if [[ ${DOCOPT_PROGRAM_VERSION:-false} != 'false' ]]; then
for idx in "${parsed_params[@]}"; do [[ $idx = 'a' ]] && continue
if [[ ${longs[$idx]} = "--version" ]]; then stdout "$DOCOPT_PROGRAM_VERSION"
_return 0; fi; done; fi; local i=0; while [[ $i -lt ${#parsed_params[@]} ]]; do
left+=("$i"); ((i++)) || true; done
if ! required "$root_idx" || [ ${#left[@]} -gt 0 ]; then error; fi; return 0; }
parse_shorts() { local token=${argv[0]}; local value; argv=("${argv[@]:1}")
[[ $token = -* && $token != --* ]] || _return 88; local remaining=${token#-}
while [[ -n $remaining ]]; do local short="-${remaining:0:1}"
remaining="${remaining:1}"; local i=0; local similar=(); local match=false
for o in "${shorts[@]}"; do if [[ $o = "$short" ]]; then similar+=("$short")
[[ $match = false ]] && match=$i; fi; ((i++)) || true; done
if [[ ${#similar[@]} -gt 1 ]]; then
error "${short} is specified ambiguously ${#similar[@]} times"
elif [[ ${#similar[@]} -lt 1 ]]; then match=${#shorts[@]}; value=true
shorts+=("$short"); longs+=(''); argcounts+=(0); else value=false
if [[ ${argcounts[$match]} -ne 0 ]]; then if [[ $remaining = '' ]]; then
if [[ ${#argv[@]} -eq 0 || ${argv[0]} = '--' ]]; then
error "${short} requires argument"; fi; value=${argv[0]}; argv=("${argv[@]:1}")
else value=$remaining; remaining=''; fi; fi; if [[ $value = false ]]; then
value=true; fi; fi; parsed_params+=("$match"); parsed_values+=("$value"); done
}; parse_long() { local token=${argv[0]}; local long=${token%%=*}
local value=${token#*=}; local argcount; argv=("${argv[@]:1}")
[[ $token = --* ]] || _return 88; if [[ $token = *=* ]]; then eq='='; else eq=''
value=false; fi; local i=0; local similar=(); local match=false
for o in "${longs[@]}"; do if [[ $o = "$long" ]]; then similar+=("$long")
[[ $match = false ]] && match=$i; fi; ((i++)) || true; done
if [[ $match = false ]]; then i=0; for o in "${longs[@]}"; do
if [[ $o = $long* ]]; then similar+=("$long"); [[ $match = false ]] && match=$i
fi; ((i++)) || true; done; fi; if [[ ${#similar[@]} -gt 1 ]]; then
error "${long} is not a unique prefix: ${similar[*]}?"
elif [[ ${#similar[@]} -lt 1 ]]; then
[[ $eq = '=' ]] && argcount=1 || argcount=0; match=${#shorts[@]}
[[ $argcount -eq 0 ]] && value=true; shorts+=(''); longs+=("$long")
argcounts+=("$argcount"); else if [[ ${argcounts[$match]} -eq 0 ]]; then
if [[ $value != false ]]; then
error "${longs[$match]} must not have an argument"; fi
elif [[ $value = false ]]; then
if [[ ${#argv[@]} -eq 0 || ${argv[0]} = '--' ]]; then
error "${long} requires argument"; fi; value=${argv[0]}; argv=("${argv[@]:1}")
fi; if [[ $value = false ]]; then value=true; fi; fi; parsed_params+=("$match")
parsed_values+=("$value"); }; required() { local initial_left=("${left[@]}")
local node_idx; ((testdepth++)) || true; for node_idx in "$@"; do
if ! "node_$node_idx"; then left=("${initial_left[@]}"); ((testdepth--)) || true
return 1; fi; done; if [[ $((--testdepth)) -eq 0 ]]; then
left=("${initial_left[@]}"); for node_idx in "$@"; do "node_$node_idx"; done; fi
return 0; }; stdout() { printf -- "cat <<'EOM'\n%s\nEOM\n" "$1"; }; stderr() {
printf -- "cat <<'EOM' >&2\n%s\nEOM\n" "$1"; }; error() {
[[ -n $1 ]] && stderr "$1"; stderr "$usage"; _return 1; }; _return() {
printf -- "exit %d\n" "$1"; exit "$1"; }; set -e; trimmed_doc=${DOC:0:74}
usage=${DOC:39:13}; digest=8c7d3; shorts=(); longs=(); argcounts=(); node_0(){
required ; }; node_1(){ required 0; }; cat <<<' docopt_exit() {
[[ -n $1 ]] && printf "%s\n" "$1" >&2; printf "%s\n" "${DOC:39:13}" >&2; exit 1
}'; unset ; parse 1 "$@"; return 0; local prefix=${DOCOPT_PREFIX:-''}; unset
local docopt_i=1; [[ $BASH_VERSION =~ ^4.3 ]] && docopt_i=2
for ((;docopt_i>0;docopt_i--)); do declare -p ; done; }
# docopt parser above, complete command for generating this parser is `docopt.sh abra`
PROGRAM_NAME=$(basename "$0")
@ -152,39 +285,8 @@ if [ -f "$ABRA_STACK_DIR/abra-commands.sh" ]; then
source "$ABRA_STACK_DIR/abra-commands.sh"
fi
###### Global help
sub_help() {
echo "Usage: $PROGRAM_NAME [OPTIONS] COMMAND [ARGS]..."
echo ""
echo "Options:"
echo " --config Stack configuration to use"
echo " --env Environment variables to load"
echo " --help Show this message and exit"
echo " --stack Name of the target stack"
echo " --version Show program version"
echo ""
echo "Commands:"
echo " server manage remote host"
echo " cp copy files to a container"
echo " deploy let 'em rip"
echo " logs tail logs from a deployed service"
echo " multilogs tail logs from a whole stackk"
echo " run run a command in the specified service's container"
echo " secret manage secrets"
echo " upgrade upgrade to the latest version"
}
###### Subcommand `secret`
sub_secret_help() {
echo "Usage: $PROGRAM_NAME [global opts] secret <subcommand> [sub opts]"
echo ""
echo "Subcommands:"
echo " generate SECRET VERSION [PWGEN] generate & store secret"
echo " insert SECRET VERSION PW save PW in docker and pass"
}
sub_secret_insert() {
require_stack
load_context
@ -391,16 +493,6 @@ sub_cp() {
###### Subcommand `context`
sub_server_help() {
echo "Usage: $PROGRAM_NAME [global opts] server <subcommand> [sub opts]"
echo ""
echo "Subcommands:"
echo " add HOST [USER] [PORT] set up remote Docker context"
echo " rm HOST"
echo " use HOST activate remote Docker context"
echo " init HOST activate swarm mode"
}
sub_server_init() {
load_context