Deduplicate openqa-cli options and help

[perlpunk]

Use a spec file to deduplicate the options and help output for openqa-cli.

Advantages

Only one place, no duplicated information that can diverge over time

Currently the global options are repeated in several places:

• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/Command.pm#L100-L110
• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/CLI/api.pm#L116 ff
• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/CLI/schedule.pm#L59 ff
• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/CLI/monitor.pm#L67 ff
• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/CLI/archive.pm#L50 ff

And the options for the subcommands are also duplicated:

• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/CLI/api.pm#L21-L28
• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/CLI/api.pm#L123 ff
• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/CLI/schedule.pm#L34-L37
• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/CLI/schedule.pm#L66
• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/CLI/monitor.pm#L49-L50
• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/CLI/monitor.pm#L77
• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/CLI/archive.pm#L16-L17
• https://github.com/os-autoinst/openQA/blob/master/lib/OpenQA/CLI/archive.pm#L55

Some of the options were forgotten in the pod, e.g. archive does not list --pretty, --quiet and --verbose

Easy shell completion

@b10n1k had the nice idea to add shell completion for openqa-cli (#6063).

However, manually written completion scripts have several disadvantages. Typos, and the content can diverge over time. Duplicated information again.

With the spec file we can get bas/zsh completion practically for free with appspec, including completion descriptions for bash.
We only have to regenerate it when an option gets added/changed, and a test can ensure that we don't forget regeneration.
So appspec would only be a dependency for us openQA authors.
(Note that this PR doesn't include completion yet)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.11%. Comparing base (921e74b) to head (47c3c7b).
Report is 2 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #6316   +/-   ##
=======================================
  Coverage   99.11%   99.11%           
=======================================
  Files         399      399           
  Lines       40721    40771   +50     
=======================================
+ Hits        40362    40412   +50     
  Misses        359      359           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[okurz]

what's the meaning of this magic number?

[perlpunk]

I could set it to zero.
It's the width of the left column, determined by the maximum item length, and I just thought it would be nice to have a minimum width if there are only very short items.

[okurz]

ok. how about a constant called accordingly?

[perlpunk]

I found a better way. I just use Getopt::Long::Descriptive which provides a function to generate the usage table.
The format of the option spec is compatible between Getopt::Long, Getopt::Long::Descriptive and App::Spec.

[perlpunk]

Not sure how to solve this error:
https://build.opensuse.org/package/live_build_log/devel:openQA:GitHub:os-autoinst:openQA:PR-6316/openQA:openQA-client-test/openSUSE_Tumbleweed/x86_64

Could not open '/usr/share/openqa/script/../public/openqa-cli.yaml' for reading: No such file or directory

Where should I put a file that the client needs to read?

[kalikiana]

Not sure how to solve this error: https://build.opensuse.org/package/live_build_log/devel:openQA:GitHub:os-autoinst:openQA:PR-6316/openQA:openQA-client-test/openSUSE_Tumbleweed/x86_64

Could not open '/usr/share/openqa/script/../public/openqa-cli.yaml' for reading: No such file or directory

Where should I put a file that the client needs to read?

How about datadir/openqa/client

[b10n1k]

Not sure how to solve this error: https://build.opensuse.org/package/live_build_log/devel:openQA:GitHub:os-autoinst:openQA:PR-6316/openQA:openQA-client-test/openSUSE_Tumbleweed/x86_64

Could not open '/usr/share/openqa/script/../public/openqa-cli.yaml' for reading: No such file or directory

Where should I put a file that the client needs to read?

I guess the easiest would be somewhere in lib/openQA as under /usr/share/openqa there are only lib and script dirs.. even so public seems it should be able to be found in /usr/share/openqa/!! Did you try to build and debug in the build env? Maybe it is about copy the file in that location

[perlpunk]

The file will now be installed to /usr/share/openqa/client/openqa-cli.yaml. In git it's still under public/ for now. That's why the code has to check for both locations.
Alternatively we could create a client/ folder in git.

[Martchus]

Looks good I guess. I only have a small nitpick on the use lines.