11f2b61261
This PR adds a `--format=bash` option to `spack commands` to auto-generate the Bash programmable tab completion script. It can be extended to work for other shells. Progress: - [x] Fix bug in superclass initialization in `ArgparseWriter` - [x] Refactor `ArgparseWriter` (see below) - [x] Ensure that output of old `--format` options remains the same - [x] Add `ArgparseCompletionWriter` and `BashCompletionWriter` - [x] Add `--aliases` option to add command aliases - [x] Standardize positional argument names - [x] Tests for `spack commands --format=bash` coverage - [x] Tests to make sure `spack-completion.bash` stays up-to-date - [x] Tests for `spack-completion.bash` coverage - [x] Speed up `spack-completion.bash` by caching subroutine calls This PR also necessitates a significant refactoring of `ArgparseWriter`. Previously, `ArgparseWriter` was mostly a single `_write` method which handled everything from extracting the information we care about from the parser to formatting the output. Now, `_write` only handles recursion, while the information extraction is split into a separate `parse` method, and the formatting is handled by `format`. This allows subclasses to completely redefine how the format will appear without overriding all of `_write`. Co-Authored-by: Todd Gamblin <tgamblin@llnl.gov>
90 lines
2.6 KiB
Bash
Executable File
90 lines
2.6 KiB
Bash
Executable File
#!/bin/sh
|
|
#
|
|
# Copyright 2013-2020 Lawrence Livermore National Security, LLC and other
|
|
# Spack Project Developers. See the top-level COPYRIGHT file for details.
|
|
#
|
|
# SPDX-License-Identifier: (Apache-2.0 OR MIT)
|
|
|
|
#
|
|
# This script tests that Spack's tab completion scripts work.
|
|
#
|
|
# The tests are portable to bash, zsh, and bourne shell, and can be run
|
|
# in any of these shells.
|
|
#
|
|
|
|
export QA_DIR=$(dirname "$0")
|
|
export SHARE_DIR=$(cd "$QA_DIR/.." && pwd)
|
|
export SPACK_ROOT=$(cd "$QA_DIR/../../.." && pwd)
|
|
|
|
. "$QA_DIR/test-framework.sh"
|
|
|
|
# Fail on undefined variables
|
|
set -u
|
|
|
|
# Source setup-env.sh before tests
|
|
. "$SHARE_DIR/setup-env.sh"
|
|
. "$SHARE_DIR/spack-completion.$_sp_shell"
|
|
|
|
title "Testing spack-completion.$_sp_shell with $_sp_shell"
|
|
|
|
# Spack command is now available
|
|
succeeds which spack
|
|
|
|
title 'Testing all subcommands'
|
|
while IFS= read -r line
|
|
do
|
|
# Test that completion with no args works
|
|
succeeds _spack_completions ${line[*]} ''
|
|
|
|
# Test that completion with flags works
|
|
contains '-h --help' _spack_completions ${line[*]} -
|
|
done <<- EOF
|
|
$(spack commands --aliases --format=subcommands)
|
|
EOF
|
|
|
|
title 'Testing for correct output'
|
|
contains 'compiler' _spack_completions spack ''
|
|
contains 'install' _spack_completions spack inst
|
|
contains 'find' _spack_completions spack help ''
|
|
contains 'hdf5' _spack_completions spack list ''
|
|
contains 'py-numpy' _spack_completions spack list py-
|
|
contains 'mpi' _spack_completions spack providers ''
|
|
contains 'builtin' _spack_completions spack repo remove ''
|
|
contains 'packages' _spack_completions spack config edit ''
|
|
contains 'python' _spack_completions spack extensions ''
|
|
contains 'hdf5' _spack_completions spack -d install --jobs 8 ''
|
|
contains 'hdf5' _spack_completions spack install -v ''
|
|
|
|
# XFAIL: Fails for Python 2.6 because pkg_resources not found?
|
|
#contains 'compilers.py' _spack_completions spack test ''
|
|
|
|
title 'Testing debugging functions'
|
|
|
|
# This is a particularly tricky case that involves the following situation:
|
|
# `spack -d [] install `
|
|
# Here, [] represents the cursor, which is in the middle of the line.
|
|
# We should tab-complete optional flags for `spack`, not optional flags for
|
|
# `spack install` or package names.
|
|
COMP_LINE='spack -d install '
|
|
COMP_POINT=9
|
|
COMP_WORDS=(spack -d install)
|
|
COMP_CWORD=2
|
|
COMP_KEY=9
|
|
COMP_TYPE=64
|
|
|
|
_bash_completion_spack
|
|
contains "--all-help" echo "${COMPREPLY[@]}"
|
|
|
|
contains "['spack', '-d', 'install', '']" _pretty_print COMP_WORDS[@]
|
|
|
|
# Set the rest of the intermediate variables manually
|
|
COMP_WORDS_NO_FLAGS=(spack install)
|
|
COMP_CWORD_NO_FLAGS=1
|
|
subfunction=_spack
|
|
cur=
|
|
|
|
list_options=true
|
|
contains "'True'" _test_vars
|
|
list_options=false
|
|
contains "'False'" _test_vars
|