tests: Add some basic tests for the completions getter

Author: 3v1n0

.github/workflows/test.yml

@@ -0,0 +1,12 @@
+name: Test
+on: [push]
+jobs:
+  bash-completions-checker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v3
+      - name: Run tests
+        run: |
+          bash tests/test-bash-completions-getter.sh
+

tests/test-bash-completions-getter.sh

@@ -0,0 +1,133 @@
+#!/usr/bin/env bash
+# set -x
+
+this_dir="$(dirname "$0")"
+src_dir="$this_dir/.."
+bash_completer="$src_dir/bash-completions-getter.sh"
+
+exec 535>&2
+our_stderr=535
+
+exec 999>/dev/null
+completion_out=999
+
+if [ -n "$DEBUG" ]; then
+    completion_out=$our_stderr
+
+    if [ "$DEBUG" -gt 1 ]; then
+        set -x
+    fi
+fi
+
+check_completion() {
+    local OIFS=$IFS
+    local input="$1"
+    local expected_completions=("$2")
+    local expected_options=("$3")
+    local expected_exit_code=${4:-0};
+    local -a output
+
+    echo "Checking completion $input" >&2
+
+    # shellcheck source=./bash-completions-getter.sh disable=SC1091
+    source "$bash_completer"
+    mapfile -t output < <(test_bash_completion "$input" 2>&$completion_out; echo $?)
+    echo -n "  output: " >&2; printf "'%s'," "${output[@]}" >&2; echo >&2
+
+    if [ "${#output[@]}" -eq 0 ]; then
+        echo "Unepxected output"
+        exit 1
+    fi
+
+    local exit_code="${output[-1]}"
+    unset 'output[-1]';
+    echo "  exit code: $exit_code" >&2
+
+    if [ "$exit_code" -ne "$expected_exit_code" ]; then
+        echo "! invalid exit code, expecting: $expected_exit_code";
+        [ -n "$message" ] && echo "$message"
+        exit 1
+    fi
+
+    if [ "$exit_code" -ne 0 ]; then
+        return 0
+    fi
+
+    IFS=' '
+    local options=("${output[0]}")
+    IFS=$OIFS
+    local completions=("${output[@]:1}")
+
+    echo -n "  options: " >&2; printf "'%s'," "${options[@]}" >&2; echo >&2
+    echo -n "  completions: " >&2; printf "'%s'," "${completions[@]}" >&2; echo >&2
+
+    if [[ "${completions[*]}" != "${expected_completions[*]}" ]]; then
+        echo -n "! invalid completions, expecting: "; printf "'%s'," "${expected_completions[@]}"; echo
+        exit 1
+    fi
+
+    if [[ "${options[*]}" != "${expected_options[*]}" ]]; then
+        echo -n "! invalid options, expecting: "; printf "'%s'," "${expected_options[@]}"; echo
+        exit 1
+    fi
+}
+
+expect_failure() {
+    check_completion "$1" '' '' 1
+}
+
+function test_complete_function() {
+    if [[ "$1" != "$EXPECTED_COMPLETE_PROGRAM" ]]; then
+        echo "Unexpected complete program: '$1'" >&$our_stderr
+        return 1
+    fi
+
+    if [[ "$2" != "$EXPECTED_COMPLETE_WORD" ]]; then
+        echo "Unexpected complete word: '$2'" >&$our_stderr
+        return 2
+    fi
+
+    if [[ "$3" != "$EXPECTED_COMPLETE_PRE_WORD" ]]; then
+        echo "Unexpected complete previous word: '$3'" >&$our_stderr
+        return 3
+    fi
+
+    COMPREPLY=("${TEST_COMPLETE_REPLY[@]}")
+}
+
+expect_failure hopefully-invalid-command-completion
+
+complete -W "foo" foo-with-word
+check_completion foo-with-word "foo"
+
+complete -o nospace -W "foo" foo-with-word-and-option
+check_completion foo-with-word-and-option "foo" nospace
+
+complete -W "foo --bar" foo-with-multiple-words
+check_completion foo-with-multiple-words "foo --bar"
+
+complete -o nospace -W "foo" foo-with-word-and-option
+check_completion foo-with-word-and-option "foo" nospace
+
+function foo_complete_function_simple() {
+    EXPECTED_COMPLETE_PROGRAM=foo-with-function-simple
+    EXPECTED_COMPLETE_WORD="''"
+    EXPECTED_COMPLETE_PRE_WORD="'foo-with-function-simple'"
+    TEST_COMPLETE_REPLY=(a --b --c)
+    test_complete_function "$@"
+}
+
+complete -F foo_complete_function_simple foo-with-function-simple
+check_completion 'foo-with-function-simple ' "a --b --c"
+
+
+function foo_complete_function() {
+    EXPECTED_COMPLETE_PROGRAM=foo-with-function
+    EXPECTED_COMPLETE_WORD="'word'"
+    EXPECTED_COMPLETE_PRE_WORD="'pre-word'"
+    TEST_COMPLETE_REPLY=(-c -D efgh)
+    test_complete_function "$@"
+}
+
+complete -F foo_complete_function foo-with-function
+check_completion 'foo-with-function pre-word word' "-c -D efgh"