Updated _docker-compose to the latest version (from 0.1.0 to 1.5.0). (#5215)

Also fixed formatting of markdown URL in README.

plugins/docker-compose/README.md

@@ -1,5 +1,4 @@
 # Docker-compose plugin for oh my zsh
 
-A copy of the completion script from the [docker-compose](1) git repo.
+A copy of the completion script from the [docker-compose](https://github.com/docker/compose/blob/master/contrib/completion/zsh/_docker-compose) git repo.
 
-[1]:[https://github.com/docker/compose/blob/master/contrib/completion/zsh/_docker-compose]

plugins/docker-compose/_docker-compose

@@ -7,7 +7,7 @@
 # -------------------------------------------------------------------------
 # Version
 # -------
-#  0.1.0
+#  1.5.0
 # -------------------------------------------------------------------------
 # Authors
 # -------
@@ -19,58 +19,69 @@
 #  * @felixr docker zsh completion script : https://github.com/felixr/docker-zsh-completion
 # -------------------------------------------------------------------------
 
-# For compatibility reasons, Compose and therefore its completion supports several
+__docker-compose_q() {
-# stack compositon files as listed here, in descending priority.
+    docker-compose 2>/dev/null $compose_options "$@"
-# Support for these filenames might be dropped in some future version.
-__docker-compose_compose_file() {
-    local file
-    for file in docker-compose.y{,a}ml fig.y{,a}ml ; do
-        [ -e $file ] && {
-            echo $file
-            return
-        }
-    done
-    echo docker-compose.yml
 }
 
-# Extracts all service names from docker-compose.yml.
+# All services defined in docker-compose.yml
-___docker-compose_all_services_in_compose_file() {
+__docker-compose_all_services_in_compose_file() {
     local already_selected
     local -a services
-    already_selected=$(echo ${words[@]} | tr " " "|")
+    already_selected=$(echo $words | tr " " "|")
-    awk -F: '/^[a-zA-Z0-9]/{print $1}' "${compose_file:-$(__docker-compose_compose_file)}" 2>/dev/null | grep -Ev "$already_selected"
+    __docker-compose_q config --services \
+        | grep -Ev "^(${already_selected})$"
 }
 
 # All services, even those without an existing container
 __docker-compose_services_all() {
-    services=$(___docker-compose_all_services_in_compose_file)
+    [[ $PREFIX = -* ]] && return 1
-    _alternative "args:services:($services)"
+    integer ret=1
+    services=$(__docker-compose_all_services_in_compose_file)
+    _alternative "args:services:($services)" && ret=0
+
+    return ret
 }
 
 # All services that have an entry with the given key in their docker-compose.yml section
-___docker-compose_services_with_key() {
+__docker-compose_services_with_key() {
     local already_selected
     local -a buildable
-    already_selected=$(echo ${words[@]} | tr " " "|")
+    already_selected=$(echo $words | tr " " "|")
     # flatten sections to one line, then filter lines containing the key and return section name.
-    awk '/^[a-zA-Z0-9]/{printf "\n"};{printf $0;next;}' "${compose_file:-$(__docker-compose_compose_file)}" 2>/dev/null | awk -F: -v key=": +$1:" '$0 ~ key {print $1}' 2>/dev/null | grep -Ev "$already_selected"
+    __docker-compose_q config \
+        | sed -n -e '/^services:/,/^[^ ]/p' \
+        | sed -n 's/^  //p' \
+        | awk '/^[a-zA-Z0-9]/{printf "\n"};{printf $0;next;}' \
+        | grep " \+$1:" \
+        | cut -d: -f1 \
+        | grep -Ev "^(${already_selected})$"
 }
 
 # All services that are defined by a Dockerfile reference
 __docker-compose_services_from_build() {
-    buildable=$(___docker-compose_services_with_key build)
+    [[ $PREFIX = -* ]] && return 1
-    _alternative "args:buildable services:($buildable)"
+    integer ret=1
+    buildable=$(__docker-compose_services_with_key build)
+    _alternative "args:buildable services:($buildable)" && ret=0
+
+   return ret
 }
 
 # All services that are defined by an image
 __docker-compose_services_from_image() {
-    pullable=$(___docker-compose_services_with_key image)
+    [[ $PREFIX = -* ]] && return 1
-    _alternative "args:pullable services:($pullable)"
+    integer ret=1
+    pullable=$(__docker-compose_services_with_key image)
+    _alternative "args:pullable services:($pullable)" && ret=0
+
+    return ret
 }
 
 __docker-compose_get_services() {
-    local kind expl
+    [[ $PREFIX = -* ]] && return 1
-    declare -a running stopped lines args services
+    integer ret=1
+    local kind
+    declare -a running paused stopped lines args services
 
     docker_status=$(docker ps > /dev/null 2>&1)
     if [ $? -ne 0 ]; then
@@ -80,64 +91,78 @@ __docker-compose_get_services() {
 
     kind=$1
     shift
-    [[ $kind = (stopped|all) ]] && args=($args -a)
+    [[ $kind =~ (stopped|all) ]] && args=($args -a)
 
-    lines=(${(f)"$(_call_program commands docker ps ${args})"})
+    lines=(${(f)"$(_call_program commands docker $docker_options ps $args)"})
-    services=(${(f)"$(_call_program commands docker-compose 2>/dev/null ${compose_file:+-f $compose_file} ${compose_project:+-p $compose_project} ps -q)"})
+    services=(${(f)"$(_call_program commands docker-compose 2>/dev/null $compose_options ps -q)"})
 
     # Parse header line to find columns
     local i=1 j=1 k header=${lines[1]}
     declare -A begin end
-    while (( $j < ${#header} - 1 )) {
+    while (( j < ${#header} - 1 )); do
-        i=$(( $j + ${${header[$j,-1]}[(i)[^ ]]} - 1))
+        i=$(( j + ${${header[$j,-1]}[(i)[^ ]]} - 1 ))
-        j=$(( $i + ${${header[$i,-1]}[(i)  ]} - 1))
+        j=$(( i + ${${header[$i,-1]}[(i)  ]} - 1 ))
-        k=$(( $j + ${${header[$j,-1]}[(i)[^ ]]} - 2))
+        k=$(( j + ${${header[$j,-1]}[(i)[^ ]]} - 2 ))
-        begin[${header[$i,$(($j-1))]}]=$i
+        begin[${header[$i,$((j-1))]}]=$i
-        end[${header[$i,$(($j-1))]}]=$k
+        end[${header[$i,$((j-1))]}]=$k
-    }
+    done
     lines=(${lines[2,-1]})
 
     # Container ID
     local line s name
     local -a names
     for line in $lines; do
-        if [[ $services == *"${line[${begin[CONTAINER ID]},${end[CONTAINER ID]}]%% ##}"* ]]; then
+        if [[ ${services[@]} == *"${line[${begin[CONTAINER ID]},${end[CONTAINER ID]}]%% ##}"* ]]; then
             names=(${(ps:,:)${${line[${begin[NAMES]},-1]}%% *}})
             for name in $names; do
                 s="${${name%_*}#*_}:${(l:15:: :::)${${line[${begin[CREATED]},${end[CREATED]}]/ ago/}%% ##}}"
                 s="$s, ${line[${begin[CONTAINER ID]},${end[CONTAINER ID]}]%% ##}"
-                s="$s, ${${${line[$begin[IMAGE],$end[IMAGE]]}/:/\\:}%% ##}"
+                s="$s, ${${${line[${begin[IMAGE]},${end[IMAGE]}]}/:/\\:}%% ##}"
                 if [[ ${line[${begin[STATUS]},${end[STATUS]}]} = Exit* ]]; then
                     stopped=($stopped $s)
                 else
+                    if [[  ${line[${begin[STATUS]},${end[STATUS]}]} = *\(Paused\)* ]]; then
+                        paused=($paused $s)
+                    fi
                     running=($running $s)
                 fi
             done
         fi
     done
 
-    [[ $kind = (running|all) ]] && _describe -t services-running "running services" running
+    [[ $kind =~ (running|all) ]] && _describe -t services-running "running services" running "$@" && ret=0
-    [[ $kind = (stopped|all) ]] && _describe -t services-stopped "stopped services" stopped
+    [[ $kind =~ (paused|all) ]] && _describe -t services-paused "paused services" paused "$@" && ret=0
+    [[ $kind =~ (stopped|all) ]] && _describe -t services-stopped "stopped services" stopped "$@" && ret=0
+
+    return ret
+}
+
+__docker-compose_pausedservices() {
+    [[ $PREFIX = -* ]] && return 1
+    __docker-compose_get_services paused "$@"
 }
 
 __docker-compose_stoppedservices() {
+    [[ $PREFIX = -* ]] && return 1
     __docker-compose_get_services stopped "$@"
 }
 
 __docker-compose_runningservices() {
+    [[ $PREFIX = -* ]] && return 1
     __docker-compose_get_services running "$@"
 }
 
-__docker-compose_services () {
+__docker-compose_services() {
+    [[ $PREFIX = -* ]] && return 1
     __docker-compose_get_services all "$@"
 }
 
 __docker-compose_caching_policy() {
-    oldp=( "$1"(Nmh+1) )     # 1 hour
+    oldp=( "$1"(Nmh+1) )            # 1 hour
     (( $#oldp ))
 }
 
-__docker-compose_commands () {
+__docker-compose_commands() {
     local cache_policy
 
     zstyle -s ":completion:${curcontext}:" cache-policy cache_policy
@@ -151,110 +176,204 @@ __docker-compose_commands () {
         local -a lines
         lines=(${(f)"$(_call_program commands docker-compose 2>&1)"})
         _docker_compose_subcommands=(${${${lines[$((${lines[(i)Commands:]} + 1)),${lines[(I)  *]}]}## #}/ ##/:})
-        _store_cache docker_compose_subcommands _docker_compose_subcommands
+        (( $#_docker_compose_subcommands > 0 )) && _store_cache docker_compose_subcommands _docker_compose_subcommands
     fi
     _describe -t docker-compose-commands "docker-compose command" _docker_compose_subcommands
 }
 
-__docker-compose_subcommand () {
+__docker-compose_subcommand() {
-    local -a _command_args
+    local opts_help opts_force_recreate opts_no_recreate opts_no_build opts_remove_orphans opts_timeout opts_no_color opts_no_deps
+
+    opts_help='(: -)--help[Print usage]'
+    opts_force_recreate="(--no-recreate)--force-recreate[Recreate containers even if their configuration and image haven't changed. Incompatible with --no-recreate.]"
+    opts_no_recreate="(--force-recreate)--no-recreate[If containers already exist, don't recreate them. Incompatible with --force-recreate.]"
+    opts_no_build="(--build)--no-build[Don't build an image, even if it's missing.]"
+    opts_remove_orphans="--remove-orphans[Remove containers for services not defined in the Compose file]"
+    opts_timeout=('(-t --timeout)'{-t,--timeout}"[Specify a shutdown timeout in seconds. (default: 10)]:seconds: ")
+    opts_no_color='--no-color[Produce monochrome output.]'
+    opts_no_deps="--no-deps[Don't start linked services.]"
+
     integer ret=1
+
     case "$words[1]" in
         (build)
             _arguments \
-                '--no-cache[Do not use cache when building the image]' \
+                $opts_help \
+                '--force-rm[Always remove intermediate containers.]' \
+                '--no-cache[Do not use cache when building the image.]' \
+                '--pull[Always attempt to pull a newer version of the image.]' \
                 '*:services:__docker-compose_services_from_build' && ret=0
             ;;
+        (bundle)
+            _arguments \
+                $opts_help \
+                '(--output -o)'{--output,-o}'[Path to write the bundle file to. Defaults to "<project name>.dab".]:file:_files' && ret=0
+            ;;
+        (config)
+            _arguments \
+                $opts_help \
+                '(--quiet -q)'{--quiet,-q}"[Only validate the configuration, don't print anything.]" \
+                '--services[Print the service names, one per line.]' && ret=0
+            ;;
+        (create)
+            _arguments \
+                $opts_help \
+                $opts_force_recreate \
+                $opts_no_recreate \
+                $opts_no_build \
+                "(--no-build)--build[Build images before creating containers.]" \
+                '*:services:__docker-compose_services_all' && ret=0
+            ;;
+        (down)
+            _arguments \
+                $opts_help \
+                "--rmi[Remove images. Type must be one of: 'all': Remove all images used by any service. 'local': Remove only images that don't have a custom tag set by the \`image\` field.]:type:(all local)" \
+                '(-v --volumes)'{-v,--volumes}"[Remove named volumes declared in the \`volumes\` section of the Compose file and anonymous volumes attached to containers.]" \
+                $opts_remove_orphans && ret=0
+            ;;
+        (events)
+            _arguments \
+                $opts_help \
+                '--json[Output events as a stream of json objects]' \
+                '*:services:__docker-compose_services_all' && ret=0
+            ;;
+        (exec)
+            _arguments \
+                $opts_help \
+                '-d[Detached mode: Run command in the background.]' \
+                '--privileged[Give extended privileges to the process.]' \
+                '--user=[Run the command as this user.]:username:_users' \
+                '-T[Disable pseudo-tty allocation. By default `docker-compose exec` allocates a TTY.]' \
+                '--index=[Index of the container if there are multiple instances of a service \[default: 1\]]:index: ' \
+                '(-):running services:__docker-compose_runningservices' \
+                '(-):command: _command_names -e' \
+                '*::arguments: _normal' && ret=0
+            ;;
         (help)
             _arguments ':subcommand:__docker-compose_commands' && ret=0
             ;;
         (kill)
             _arguments \
+                $opts_help \
                 '-s[SIGNAL to send to the container. Default signal is SIGKILL.]:signal:_signals' \
                 '*:running services:__docker-compose_runningservices' && ret=0
             ;;
         (logs)
             _arguments \
-                '--no-color[Produce monochrome output.]' \
+                $opts_help \
+                '(-f --follow)'{-f,--follow}'[Follow log output]' \
+                $opts_no_color \
+                '--tail=[Number of lines to show from the end of the logs for each container.]:number of lines: ' \
+                '(-t --timestamps)'{-t,--timestamps}'[Show timestamps]' \
                 '*:services:__docker-compose_services_all' && ret=0
             ;;
-        (migrate-to-labels)
+        (pause)
             _arguments \
-                '(-):Recreate containers to add labels' && ret=0
+                $opts_help \
+                '*:running services:__docker-compose_runningservices' && ret=0
             ;;
         (port)
             _arguments \
-                '--protocol=-[tcp or udap (defaults to tcp)]:protocol:(tcp udp)' \
+                $opts_help \
-                '--index=-[index of the container if there are mutiple instances of a service (defaults to 1)]:index: ' \
+                '--protocol=[tcp or udp \[default: tcp\]]:protocol:(tcp udp)' \
+                '--index=[index of the container if there are multiple instances of a service \[default: 1\]]:index: ' \
                 '1:running services:__docker-compose_runningservices' \
                 '2:port:_ports' && ret=0
             ;;
         (ps)
             _arguments \
+                $opts_help \
                 '-q[Only display IDs]' \
                 '*:services:__docker-compose_services_all' && ret=0
             ;;
         (pull)
             _arguments \
-                '--allow-insecure-ssl[Allow insecure connections to the docker registry]' \
+                $opts_help \
+                '--ignore-pull-failures[Pull what it can and ignores images with pull failures.]' \
                 '*:services:__docker-compose_services_from_image' && ret=0
             ;;
+        (push)
+            _arguments \
+                $opts_help \
+                '--ignore-push-failures[Push what it can and ignores images with push failures.]' \
+                '*:services:__docker-compose_services' && ret=0
+            ;;
         (rm)
             _arguments \
+                $opts_help \
                 '(-f --force)'{-f,--force}"[Don't ask to confirm removal]" \
-                '-v[Remove volumes associated with containers]' \
+                '-v[Remove any anonymous volumes attached to containers]' \
                 '*:stopped services:__docker-compose_stoppedservices' && ret=0
             ;;
         (run)
             _arguments \
-                '--allow-insecure-ssl[Allow insecure connections to the docker registry]' \
+                $opts_help \
                 '-d[Detached mode: Run container in the background, print new container name.]' \
-                '--entrypoint[Overwrite the entrypoint of the image.]:entry point: ' \
                 '*-e[KEY=VAL Set an environment variable (can be used multiple times)]:environment variable KEY=VAL: ' \
-                '(-u --user)'{-u,--user=-}'[Run as specified username or uid]:username or uid:_users' \
+                '--entrypoint[Overwrite the entrypoint of the image.]:entry point: ' \
-                "--no-deps[Don't start linked services.]" \
+                '--name=[Assign a name to the container]:name: ' \
+                $opts_no_deps \
+                '(-p --publish)'{-p,--publish=}"[Publish a container's port(s) to the host]" \
                 '--rm[Remove container after run. Ignored in detached mode.]' \
                 "--service-ports[Run command with the service's ports enabled and mapped to the host.]" \
                 '-T[Disable pseudo-tty allocation. By default `docker-compose run` allocates a TTY.]' \
+                '(-u --user)'{-u,--user=}'[Run as specified username or uid]:username or uid:_users' \
+                '(-w --workdir)'{-w,--workdir=}'[Working directory inside the container]:workdir: ' \
                 '(-):services:__docker-compose_services' \
                 '(-):command: _command_names -e' \
                 '*::arguments: _normal' && ret=0
             ;;
         (scale)
-            _arguments '*:running services:__docker-compose_runningservices' && ret=0
+            _arguments \
+                $opts_help \
+                $opts_timeout \
+                '*:running services:__docker-compose_runningservices' && ret=0
             ;;
         (start)
-            _arguments '*:stopped services:__docker-compose_stoppedservices' && ret=0
+            _arguments \
+                $opts_help \
+                '*:stopped services:__docker-compose_stoppedservices' && ret=0
             ;;
         (stop|restart)
             _arguments \
-                '(-t --timeout)'{-t,--timeout}"[Specify a shutdown timeout in seconds. (default: 10)]:seconds: " \
+                $opts_help \
+                $opts_timeout \
                 '*:running services:__docker-compose_runningservices' && ret=0
             ;;
+        (unpause)
+            _arguments \
+                $opts_help \
+                '*:paused services:__docker-compose_pausedservices' && ret=0
+            ;;
         (up)
             _arguments \
-                '--allow-insecure-ssl[Allow insecure connections to the docker registry]' \
+                $opts_help \
-                '-d[Detached mode: Run containers in the background, print new container names.]' \
+                '(--abort-on-container-exit)-d[Detached mode: Run containers in the background, print new container names. Incompatible with --abort-on-container-exit.]' \
-                '--no-color[Produce monochrome output.]' \
+                $opts_no_color \
-                "--no-deps[Don't start linked services.]" \
+                $opts_no_deps \
-                "--no-recreate[If containers already exist, don't recreate them.]" \
+                $opts_force_recreate \
-                "--no-build[Don't build an image, even if it's missing]" \
+                $opts_no_recreate \
-                '(-t --timeout)'{-t,--timeout}"[Specify a shutdown timeout in seconds. (default: 10)]:seconds: " \
+                $opts_no_build \
-                "--x-smart-recreate[Only recreate containers whose configuration or image needs to be updated. (EXPERIMENTAL)]" \
+                "(--no-build)--build[Build images before starting containers.]" \
+                "(-d)--abort-on-container-exit[Stops all containers if any container was stopped. Incompatible with -d.]" \
+                '(-t --timeout)'{-t,--timeout}"[Use this timeout in seconds for container shutdown when attached or when containers are already running. (default: 10)]:seconds: " \
+                $opts_remove_orphans \
                 '*:services:__docker-compose_services_all' && ret=0
             ;;
         (version)
             _arguments \
+                $opts_help \
                 "--short[Shows only Compose's version number.]" && ret=0
             ;;
         (*)
-            _message 'Unknown sub command'
+            _message 'Unknown sub command' && ret=1
+            ;;
     esac
 
     return ret
 }
 
-_docker-compose () {
+_docker-compose() {
     # Support for subservices, which allows for `compdef _docker docker-shell=_docker_containers`.
     # Based on /usr/share/zsh/functions/Completion/Unix/_git without support for `ret`.
     if [[ $service != docker-compose ]]; then
@@ -262,34 +381,62 @@ _docker-compose () {
         return
     fi
 
-    local curcontext="$curcontext" state line ret=1
+    local curcontext="$curcontext" state line
+    integer ret=1
     typeset -A opt_args
 
     _arguments -C \
         '(- :)'{-h,--help}'[Get help]' \
-        '--verbose[Show more output]' \
-        '(- :)'{-v,--version}'[Print version and exit]' \
         '(-f --file)'{-f,--file}'[Specify an alternate docker-compose file (default: docker-compose.yml)]:file:_files -g "*.yml"' \
         '(-p --project-name)'{-p,--project-name}'[Specify an alternate project name (default: directory name)]:project name:' \
+        '--verbose[Show more output]' \
+        '(- :)'{-v,--version}'[Print version and exit]' \
+        '(-H --host)'{-H,--host}'[Daemon socket to connect to]:host:' \
+        '--tls[Use TLS; implied by --tlsverify]' \
+        '--tlscacert=[Trust certs signed only by this CA]:ca path:' \
+        '--tlscert=[Path to TLS certificate file]:client cert path:' \
+        '--tlskey=[Path to TLS key file]:tls key path:' \
+        '--tlsverify[Use TLS and verify the remote]' \
+        "--skip-hostname-check[Don't check the daemon's hostname against the name specified in the client certificate (for example if your docker host is an IP address)]" \
         '(-): :->command' \
         '(-)*:: :->option-or-argument' && ret=0
 
-    local counter=1
+    local -a relevant_compose_flags relevant_docker_flags compose_options docker_options
-    #local compose_file compose_project
+
-    while [ $counter -lt ${#words[@]} ]; do
+    relevant_compose_flags=(
-        case "${words[$counter]}" in
+        "--file" "-f"
-            -f|--file)
+        "--host" "-H"
-                (( counter++ ))
+        "--project-name" "-p"
-                compose_file="${words[$counter]}"
+        "--tls"
-                ;;
+        "--tlscacert"
-            -p|--project-name)
+        "--tlscert"
-                (( counter++ ))
+        "--tlskey"
-                compose_project="${words[$counter]}"
+        "--tlsverify"
-                ;;
+        "--skip-hostname-check"
-            *)
+    )
-                ;;
+
-        esac
+    relevant_docker_flags=(
-        (( counter++ ))
+        "--host" "-H"
+        "--tls"
+        "--tlscacert"
+        "--tlscert"
+        "--tlskey"
+        "--tlsverify"
+    )
+
+    for k in "${(@k)opt_args}"; do
+        if [[ -n "${relevant_docker_flags[(r)$k]}" ]]; then
+            docker_options+=$k
+            if [[ -n "$opt_args[$k]" ]]; then
+                docker_options+=$opt_args[$k]
+            fi
+        fi
+        if [[ -n "${relevant_compose_flags[(r)$k]}" ]]; then
+            compose_options+=$k
+            if [[ -n "$opt_args[$k]" ]]; then
+                compose_options+=$opt_args[$k]
+            fi
+        fi
     done
 
     case $state in