env vars don't autocomplete within commands

[joshgav]

Describe the bug

Environment variables don't autocomplete within an az ... command.

To Reproduce

MY_VAR=test
echo $MY_V<tab>    # autocompletes
az vm start -n $MY_V<tab>   # does not autocomplete

Expected behavior

MY_VAR=test
az vm start -n $MY_V<tab>    # should autocomplete

Environment summary

Installed with apt on Ubuntu 17.04
az CLI version 2.0.32
GNU bash, version 4.4.19(1)-release (x86_64-pc-linux-gnu)

[yonzhan]

Jiashuo Li (@jiasli) add to S162.

[jiasli]

Related to kislyuk/argcomplete#67

For dev, as mentioned here, Azure CLI registers auto-complete using

azure-cli/src/azure-cli/az.completion.sh

Line 11 in 983399f

eval "$(register-python-argcomplete az)"

For production, Azure CLI registers auto-complete using

azure-cli/az.completion

Line 21 in 983399f

complete -o nospace -F _python_argcomplete "az"

We can add -o bashdefault to az.completion for a quick fix. Feng Zhou (@fengzhou-msft), is it possible to replace az.completion with az.completion.sh so that they share the same logic?

Meanwhile, register-python-argcomplete doesn't include -o bashdefault in the default complete call. Luckily, this can be overridden with --complete-arguments, and it later goes to the complete command. You may directly run this command to register auto-complete for az:

eval "$(register-python-argcomplete az --complete-arguments -o nospace -o default -o bashdefault)"

The result is as expected:

$ az $ TabTab

$BASH                      $DIRSTACK                  $LOGNAME                   $SHELL
$BASHOPTS                  $EUID                      $LS_COLORS                 $SHELLOPTS
$BASHPID                   $GROUPS                    $MACHTYPE                  $SHLVL