Bash completion support for checkbox-cli tool

[pseudocc]

Description

Describe your changes here:

• Automatically generate bash completion with python3-argcomplete.
• Use ArgumentParser.add_subparsers to replace the former sub command parsing logics.
• Make plainbox.impl.clitools.CommandBase.register_arguments a static function, so we don't need to instantiate while adding parameters for each sub parser.
• Use an action(WarnDeprecated) to print warning messages for deprecated sub commands.
• Add corresponding completers for each parameters(both top parser and sub parsers).

Resolved issues

None.

Documentation

No functionality changes.

• Automated tests are included for the changed functionality in this PR. If to be merged without tests, please elaborate why.
• Necessary documentation is provided for the changed functionality in this PR (tests are documentation, too).

Tests

• Steps to follow for reviewer to run & manually test are provided.
  • Build and install the packages.
  • Test the bash completion thing manually:
    • Type checkbox-cli run <tab><tab>
    • Type checkbox-cli run com.canonical.certification::after-suspend-<tab><tab>
    • Type checkbox-cli list <tab><tab>
    • Etc..
  • Run some commands:
    • Type checkbox-cli run com.canonical.certification::dpkg
    • Type checkbox-cli list
    • Etc..
• A list of what tests were run and on what platform/configuration is provided.
  • Since there is no functionality changes, so I did not test it that thoroughly.

[pseudocc]

I made a force sync by mistake, reopen this PR.

[pieqq]

Hi!

I finally found some time to test this.

I (successfully) built the checkbox and checkbox22 snaps like so:

cd checkbox-core-snap
./prepare.sh series22
cd series22
snapcraft

# Ended up with checkbox22_1.30.dev_amd64.snap

cd ../../checkbox-snap
./prepare_classic.sh series_classic22
cd series_classic22
snapcraft

# Got checkbox_2.3.dev_amd64.snap

I then installed them on a test device:

sudo snap install checkbox22_1.30.dev_amd64.snap --dangerous
sudo snap install checkbox_2.3.dev_amd64.snap -dangerous --classic

But the autocompletion does not work.

If, from bash, I run:

checkbox.checkbox-cli list <tab><tab>

I get a list of the files in the current directory, and that's all.

Same for checkbox.checkbox-cli run <tab><tab>, etc.

I also tried going into the snap using checkbox.shell, then run the checkbox-cli commands directly from there, but got similar results.

I'm not sure if the invokation of the commands is different when we run checkbox-cli from the snap. For information:

# Enter the snap
$ checkbox.shell
checkbox runtime shell, type 'exit' to quit the session
$ which checkbox-cli
/snap/checkbox22/current/bin/checkbox-cli
$ cat /snap/checkbox22/current/bin/checkbox-cli
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import re
import sys
from checkbox_ng.launcher.checkbox_cli import main
if __name__ == '__main__':
    sys.argv[0] = re.sub(r'(-script\.pyw|\.exe)?$', '', sys.argv[0])
    sys.exit(main())

In the setup.py from checkbox-ng, checkbox-cli is declared as an entry point like so:

   entry_points={
        'console_scripts': [
            'checkbox-cli=checkbox_ng.launcher.checkbox_cli:main',
   (...)

The argcomplete library is present within the snap:

$ cd /snap/checkbox22/x1/usr/lib/python3/dist-packages/argcomplete/
$ ls
__init__.py  bash_completion.d  compat.py  completers.py  my_argparse.py  my_shlex.py

Having a look at the documentation for that package, it seems something is required before you can actually use it. Not sure if this step is run and/or if it succeed in the snap.

[pseudocc]

Hi pieqq,

Thank you for you efforts, I did not test whether this would work for snaps, I just tested the debian packages and it works like a charm.

I am not quite familiar with snap packaging process, but I suppose that there should be rules to place the completion script to the correct place like these 2 files do:
checkbox-ng/debian/checkbox-ng.bash-completion, checkbox-ng/debian/completions/checkbox-cli.

If you may provide me some hints on it, that would be of great help.
Unfortunately, ncov2019 just got me these days and my employee probation review is coming and I still have a couple of items to do, I might investigate this later on.

My MM: pseudoc.

Sincerely,
pseudocc.

[pieqq]

I know Checkbox uses some kind of wrapper to provide the checkbox-cli command in the snap. However, I'm not entirely sure how that works, and how that could interact with argcomplete. Maybe @kissiel or @jocave would have an idea?

[yphus]

Please rebase your work on top of current main branch

[yphus]

Closing this for now. If auto-completion can work with snaps and debs please reopen.