Skip to content

contrib/completions: sync bash completion with current CLI #5299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
immanuwell wants to merge 1 commit into
base: main
Choose a base branch
from
Open

contrib/completions: sync bash completion with current CLI #5299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 61 additions & 16 deletions contrib/completions/bash/runc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,23 +157,32 @@ _runc_exec() {
local boolean_options="
--help
--no-new-privs
--tty, -t
--detach, -d
--tty
-t
--detach
-d
--ignore-paused
"

local options_with_args="
--console-socket
--pidfd-socket
Comment thread
immanuwell marked this conversation as resolved.
--cwd
--env, -e
--user, -u
--additional-gids, -g
--process, -p
--env
-e
--user
-u
--additional-gids
-g
--process
-p
--pid-file
--process-label
--apparmor
--cap, -c
--cap
-c
--preserve-fds
--ignore-paused
--cgroup
"

local all_options="$options_with_args $boolean_options"
Expand All @@ -184,7 +193,7 @@ _runc_exec() {
return
;;

--console-socket | --cwd | --process | --apparmor)
--console-socket | --pidfd-socket | --cwd | --process | --pid-file | --apparmor)
case "$cur" in
*:*) ;; # TODO somehow do _filedir for stuff inside the image, if it's already specified (which is also somewhat difficult to determine)
'')
Expand Down Expand Up @@ -278,6 +287,7 @@ _runc_pause() {
--help
-h
"
local options_with_args=""

case "$cur" in
-*)
Expand All @@ -295,9 +305,17 @@ _runc_ps() {
-h
"
local options_with_args="
--format, -f
--format
-f
"

case "$prev" in
--format | -f)
COMPREPLY=($(compgen -W 'table json' -- "$cur"))
return
;;
esac

case "$cur" in
-*)
COMPREPLY=($(compgen -W "$boolean_options $options_with_args" -- "$cur"))
Expand All @@ -312,8 +330,10 @@ _runc_delete() {
local boolean_options="
--help
-h
--format, -f
--force
-f
"
local options_with_args=""

case "$cur" in
-*)
Expand All @@ -332,6 +352,7 @@ _runc_kill() {
--all
-a
"
local options_with_args=""

case "$prev" in
"kill")
Expand Down Expand Up @@ -393,7 +414,7 @@ _runc_list() {

case "$prev" in
--format | -f)
COMPREPLY=($(compgen -W 'text json' -- "$cur"))
COMPREPLY=($(compgen -W 'table json' -- "$cur"))
return
;;

Expand Down Expand Up @@ -456,8 +477,9 @@ _runc_spec() {
_runc_run() {
local boolean_options="
--help
--detatch
--detach
-d
--keep
--no-subreaper
--no-pivot
--no-new-keyring
Expand All @@ -467,12 +489,13 @@ _runc_run() {
--bundle
-b
--console-socket
--pidfd-socket
--pid-file
--preserve-fds
"

case "$prev" in
--bundle | -b | --console-socket | --pid-file)
--bundle | -b | --console-socket | --pidfd-socket | --pid-file)
case "$cur" in
'')
COMPREPLY=($(compgen -W '/' -- "$cur"))
Expand Down Expand Up @@ -575,11 +598,12 @@ _runc_create() {
--bundle
-b
--console-socket
--pidfd-socket
--pid-file
--preserve-fds
"
case "$prev" in
--bundle | -b | --console-socket | --pid-file)
--bundle | -b | --console-socket | --pidfd-socket | --pid-file)
case "$cur" in
'')
COMPREPLY=($(compgen -W '/' -- "$cur"))
Expand Down Expand Up @@ -619,6 +643,7 @@ _runc_help() {
_runc_restore() {
local boolean_options="
--help
-h
--tcp-established
--ext-unix-sk
--shell-job
Expand All @@ -634,11 +659,14 @@ _runc_restore() {
local options_with_args="
-b
--bundle
--console-socket
--image-path
--work-path
--manage-cgroups-mode
--pid-file
--empty-ns
--lsm-profile
--lsm-mount-context
"

local all_options="$options_with_args $boolean_options"
Expand All @@ -649,7 +677,7 @@ _runc_restore() {
return
;;

--pid-file | --image-path | --work-path | --bundle | -b)
--pid-file | --console-socket | --image-path | --work-path | --bundle | -b)
case "$cur" in
*:*) ;; # TODO somehow do _filedir for stuff inside the image, if it's already specified (which is also somewhat difficult to determine)
'')
Expand Down Expand Up @@ -679,11 +707,25 @@ _runc_restore() {
esac
}

_runc_features() {
local boolean_options="
--help
-h
"

case "$cur" in
-*)
COMPREPLY=($(compgen -W "$boolean_options" -- "$cur"))
;;
esac
}

_runc_resume() {
local boolean_options="
--help
-h
"
local options_with_args=""

case "$cur" in
-*)
Expand All @@ -700,6 +742,7 @@ _runc_state() {
--help
-h
"
local options_with_args=""

case "$cur" in
-*)
Expand All @@ -715,6 +758,7 @@ _runc_start() {
--help
-h
"
local options_with_args=""

case "$cur" in
-*)
Expand Down Expand Up @@ -775,6 +819,7 @@ _runc() {
delete
events
exec
features
kill
list
pause
Expand Down
112 changes: 112 additions & 0 deletions tests/integration/completion.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
#!/usr/bin/env bats

load helpers

function setup() {
requires root
}

function _get_comp_words_by_ref() {
local OPTIND _opt
while getopts "n:" _opt; do
:
done
shift $((OPTIND - 1))

local cur_var=$1
local prev_var=$2
local words_var=$3
local cword_var=$4

printf -v "$cur_var" '%s' "${COMP_WORDS[COMP_CWORD]}"
if ((COMP_CWORD > 0)); then
printf -v "$prev_var" '%s' "${COMP_WORDS[COMP_CWORD - 1]}"
else
printf -v "$prev_var" ''
fi
eval "$words_var=()"
local i
for ((i = 0; i < ${#COMP_WORDS[@]}; i++)); do
eval "$words_var+=(\"\${COMP_WORDS[$i]}\")"
done
printf -v "$cword_var" '%s' "$COMP_CWORD"
}

function _filedir() {
:
}

function compopt() {
return 0
}

function complete_runc() {
# shellcheck disable=SC1091
source "${INTEGRATION_ROOT}/../../contrib/completions/bash/runc"

COMP_WORDS=("$@")
COMP_CWORD=$((${#COMP_WORDS[@]} - 1))
COMPREPLY=()
_runc

printf '%s\n' "${COMPREPLY[@]}"
}

function contains_reply() {
local needle=$1
shift

local reply
for reply in "$@"; do
if [ "$reply" = "$needle" ]; then
return 0
fi
done

return 1
}

@test "top-level completion includes features" {
mapfile -t replies < <(complete_runc runc fe)

contains_reply "features" "${replies[@]}"
}

@test "delete completion suggests --force without a trailing comma" {
mapfile -t replies < <(complete_runc runc delete --f)

contains_reply "--force" "${replies[@]}"
run ! contains_reply "--force," "${replies[@]}"
}

@test "run completion matches supported flags" {
mapfile -t replies < <(complete_runc runc run --k)
contains_reply "--keep" "${replies[@]}"

mapfile -t replies < <(complete_runc runc run --d)
contains_reply "--detach" "${replies[@]}"
run ! contains_reply "--detatch" "${replies[@]}"

mapfile -t replies < <(complete_runc runc run --pidf)
contains_reply "--pidfd-socket" "${replies[@]}"
}

@test "exec completion includes pidfd socket and plain long flags" {
mapfile -t replies < <(complete_runc runc exec --pidf)
contains_reply "--pidfd-socket" "${replies[@]}"

mapfile -t replies < <(complete_runc runc exec --t)
contains_reply "--tty" "${replies[@]}"
run ! contains_reply "--tty," "${replies[@]}"
}

@test "format completions use table or json" {
mapfile -t replies < <(complete_runc runc list --format "")
contains_reply "table" "${replies[@]}"
contains_reply "json" "${replies[@]}"
run ! contains_reply "text" "${replies[@]}"

mapfile -t replies < <(complete_runc runc ps --format "")
contains_reply "table" "${replies[@]}"
contains_reply "json" "${replies[@]}"
}
Loading