Add bash and zsh completion scripts for openqa-cli

[b10n1k]

• Allow static completion of the openqa-cli
• Provide full cli options for each subcommand
• Group options for each subcommand
• Not help text in bash due to compgen function doesn't support descriptions

[perlpunk]

The only thing I don't like is the duplication. We would have the parameters now in four places:

• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/CLI/api.pm#L21
• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/CLI/api.pm#L119
• And now in the two completion scripts

There is a solution for that, but it is a bigger change, not sure if we want that here.

I wrote a program that can create pod and completion scripts from a YAML file.
The openqa-cli code could also read the YAML file, so we would only have the parameters in one place.
But it would be a new dependency, at least for developers.
(One cool thing is that it can generate completion with descriptions also for bash, with a trick)

I could at least post a proof of concept.

[perlpunk]

I could at least post a proof of concept.

https://gist.github.com/perlpunk/b0d9fe14f3c877f28d8af3db6be28c70
Here is the demo with the bash completion including descriptions:
https://gist.github.com/perlpunk/b0d9fe14f3c877f28d8af3db6be28c70#file-demo-txt

[b10n1k]

The only thing I don't like is the duplication. We would have the parameters now in four places:

• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/CLI/api.pm#L21
• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/CLI/api.pm#L119
• And now in the two completion scripts

There is a solution for that, but it is a bigger change, not sure if we want that here.

I wrote a program that can create pod and completion scripts from a YAML file. The openqa-cli code could also read the YAML file, so we would only have the parameters in one place. But it would be a new dependency, at least for developers. (One cool thing is that it can generate completion with descriptions also for bash, with a trick)

I could at least post a proof of concept.

awesome and thanks for taking the time for the proof of concept.
in general, this was one idea for the hackweek, and learning stuff for me. I know that ideally it should be automatic in some way, but it was easier for me to provide something within the hackweek, and thats why I keep it as simple as possible. Not sure I am going to do the automation, as I believe is on another level for me and my plan is to look at another small project I am interested in. I hope we are not gonna be too restrict with this PR for now. It is so cool to have it and I have also additional ideas for it.
So manybe we could open some backlog tickets for the rest? wdyt?

[Martchus]

It is not nice that we not only introduce one more place where we specify arguments but even two. Ideally we have a single source of truth. That would of course complicate things. Maybe we can make it so there's at least just one additional place where we specify arguments.

The code that does the argument parsing definitely needs to state in a comment that one also has to change these files when adding new parameters or changing help texts.

[okurz]

Considering that @perlpunk already provided a proof of concept to reduce duplication with #6063 (comment) we should follow that approach

[Wabri]

Suggested change

	'--osd[Set target host to http://openqa.suse.de]'
	'--osd[Set target host to https://openqa.suse.de]'

[Wabri]

Is the help message imply Monitor? Like this:

Suggested change

	'--monitor[it until all jobs are done/cancelled and return non-zero exit code if at least on job has not passed/softfailed]'
	'--monitor[Monitor it until all jobs are done/cancelled and return non-zero exit code if at least on job has not passed/softfailed]'

[okurz]

I tried out the sub-packages. From within podman run --rm -it registry.opensuse.org/opensuse/tumbleweed I did

zypper ar https://download.opensuse.org/repositories/devel:/openQA:/GitHub:/os-autoinst:/openQA:/PR-6063/openSUSE_Tumbleweed/ pr
zypper in openQA-client-bash-completion openQA-client-zsh-completion
rpm -ql openQA-client-zsh-completion-4.6.1733298771.703167ed-7471.1.x86_64
rpm -ql openQA-client-bash-completion-4.6.1733298771.703167ed-7471.1.x86_64

and found
/usr/share/zsh/site-functions/_openqa-cli
/usr/share/zsh/site-functions/_openqa-cli/openqa-cli-completion.zsh
/usr/share/bash-completion/completions/openqa-cli
/usr/share/bash-completion/completions/openqa-cli/openqa-cli-completion.bash

[perlpunk]

I wrote in #6063 (comment):

What we need in the end is this (and with those exact filenames):

/usr/share/zsh/site-functions/_openqa-cli
/usr/share/bash-completion/completions/openqa-cli

Those files need to be there, as files, not directories.

When you hit tab in bash, it looks into /usr/share/bash-completion/completions for a file with the same filename as the command. you can just have a look in that directory. You only see filenames there, right? No directories.
The same for zsh, just that the convention there is to prepend the file with an underscore.

Also I showed you the example for git-subrepo before. We looked at the output for rpm -ql together.

% rpm -ql git-subrepo-zsh-completion-0.4.6-16.4.noarch.rpm
/usr/share/zsh
/usr/share/zsh/site-functions
/usr/share/zsh/site-functions/_git-subrepo
% rpm -ql git-subrepo-bash-completion-0.4.6-16.4.noarch.rpm
/usr/share/bash-completion/completions/git-subrepo

Simply look at those files and think about what the files should look like for openqa-cli. Replace git-subrepo with openqa-cli.

[okurz]

Latest changes look good but please keep in mind that the major issue is still #6063 (review)

[perlpunk]

I wouldn't add anything to a user's bashrc/zshrc by default when doing make install.
And if they have bash-completion installed, it shouldn't be necessary anyway. Same for zsh.