Add usage+help to all scripts #331

okurz · 2024-07-23T13:00:14Z

trigger-pflash-test: Allow to import for testability and extendability
trigger-openqa_in_openqa: Allow to import for testability and extendability
os-autoinst-testapi-usage: Allow to import for testability and extendability
os-autoinst-obs-auto-submit: Allow to import for testability and extendability
openqa-schedule-mm-ping-test: Allow to import for testability and extendability
openqa-query-for-job-label: Allow to import for testability and extendability
openqa-monitor-investigation-candidates: Allow to import for testability and extendability
openqa-monitor-incompletes: Allow to import for testability and extendability
openqa-label-known-issues-multi: Allow to import for testability and extendability
openqa-label-known-issues-hook: Allow to import for testability and extendability
openqa-label-known-issues-and-investigate-hook: Allow to import for testability and extendability
openqa-label-known-issues: Allow to import for testability and extendability
openqa-investigate-multi: Allow to import for testability and extendability
openqa-incompletes-stats: Allow to import for testability and extendability
openqa-advanced-retrigger-jobs: Allow to import for testability and extendability
obs-check-package-origin: Allow to import for testability and extendability
obs-check-devel-openqa-leap-extra-dependencies: Allow to import for testability and extendability
monitor-openqa_job: Allow to import for testability and extendability
trigger-pflash-test: Add usage+help
trigger-openqa_in_openqa: Add usage+help
reboot-stability-check: Add usage+help
os-autoinst-testapi-usage: Add usage+help
os-autoinst-obs-auto-submit: Add usage+help
openqa-schedule-mm-ping-test: Add usage+help
openqa-query-for-job-label: Add usage+help
openqa-monitor-investigation-candidates: Add usage+help
openqa-monitor-incompletes: Add usage+help
openqa-label-known-issues-multi: Add usage+help
openqa-label-known-issues-hook: Add usage+help
openqa-label-known-issues-and-investigate-hook: Add usage+help
openqa-investigate-multi: Add usage+help
openqa-investigate: Add usage+help
openqa-incompletes-stats: Add usage+help
openqa-advanced-retrigger-jobs: Add usage+help
obs-check-package-origin: Add usage+help
obs-check-devel-openqa-leap-extra-dependencies: Add usage+help
monitor-openqa_job: Add usage+help
backlog-set-due-date: Add usage+help
backlog-check-wip-limit: Add usage+help
openqa-label-known-issues: Add argument parsing
t: Add test for help of openqa-label-known-issues

Related progress issue: https://progress.opensuse.org/issues/160889

mergify · 2024-07-23T13:00:52Z

This pull request is now in conflicts. Could you fix it? 🙏

asdil12 · 2024-07-23T13:49:52Z

monitor-openqa_job

-        [[ $job_state = 'done' ]] && break
+usage() {
+    cat << EOF
+Usage: $0 [OPTIONS]


Maybe add an example here on how to invoke this script (how to supply job id(s?)).

asdil12 · 2024-07-23T13:51:35Z

obs-check-devel-openqa-leap-extra-dependencies

+    cat << EOF
+Usage: $0 [OPTIONS]
+
+Checks devel:openQA:Leap: OBS project dependencies.


Please be a bit more descriptive here.
Even reading the source code I'm still not sure what exactly this script does.

Yep, me neither

If nobody knows what this does, we might want to delete the script.

No, the script is actively used within https://gitlab.suse.de/openqa/scripts-ci/

asdil12 · 2024-07-23T13:53:54Z

obs-check-package-origin

-    exit 99
+usage() {
+    cat << EOF
+Usage: $0 [OPTIONS]


Please include positional argument(s) in usage.

asdil12 · 2024-07-23T13:55:19Z

openqa-advanced-retrigger-jobs

+
+usage() {
+    cat << EOF
+Usage: $0 [OPTIONS]


Please provide an example call and/or a list of arguments (that are supplied via env in this case I guess)

asdil12 · 2024-07-23T13:56:05Z

openqa-incompletes-stats

+
+usage() {
+    cat << EOF
+Usage: $0 [OPTIONS]


Please provide an example call and/or a list of arguments (that are supplied via env in this case I guess)

asdil12 · 2024-07-23T13:56:50Z

openqa-incompletes-stats

+    cat << EOF
+Usage: $0 [OPTIONS]
+
+Get statistics about recent incomplete openQA jobs.


What kind of statistics? Does it simply print the sum of jobs that incompleted since $failed_since?

backlog-check-wip-limit

asdil12 · 2024-07-23T13:58:54Z

openqa-investigate

@@ -388,4 +385,29 @@ main() {
    investigate "$@"
 }

+usage() {
+    cat << EOF
+Usage: echo jobnumber | $0 [OPTIONS]


Please add some info on host_url, dry_run, verbose, prio_add, …

asdil12 · 2024-07-23T13:59:25Z

openqa-investigate-multi

@@ -18,4 +28,16 @@ main() {
    exit $rc
 }

+usage() {
+    cat << EOF
+Usage: echo jobnumber | $0 [OPTIONS]


Same as above

backlog-check-wip-limit

asdil12 · 2024-07-23T14:05:48Z

openqa-label-known-issues

+
+Takes an openQA job URL, looks for matching "known issues", for example from
+progress.opensuse.org, labels the job and retriggers if specified in the issue
+(see the source code for details how to mark tickets).


Please add some text on what a known issues is and how it is found in progress.
Also maybe add an example on these labels. I'm not even sure if this refers to labels on openQA jobs or on some magic strings in progress ticket subjects.
Looking at the source code I cannot answer this question - it would be more of a prerequisite to even understand the source.

asdil12 · 2024-07-23T14:06:44Z

openqa-label-known-issues-and-investigate-hook

@@ -46,4 +55,18 @@ hook() {
    fi
 }

+usage() {
+    cat << EOF
+Usage: $0 [OPTIONS]


Please update the usage according to the description below

asdil12 · 2024-07-23T14:08:02Z

openqa-label-known-issues-and-investigate-hook

+
+"hook script" intended to be called by openQA instances taking a job ID as
+parameter and forwarding a complete job URL to "openqa-label-known-issues" on
+stdin and all left unknowns to "openqa-investigate"


What do 'left unknowns' refer to? Is this dependent on the output of openqa-label-known-issues that tells this script if a job is unknown (whatever that means)?

b10n1k

I didnt go through all the changes for now. But one thing, maybe a picky one, is to add an expected output.
Also some can be piped. if there are some common cases of those cases, it would be nice to documented somewhere.

asdil12 · 2024-07-23T14:08:54Z

openqa-label-known-issues-hook

+
+usage() {
+    cat << EOF
+Usage: $0 [OPTIONS]


Please update the usage according to the description below.
Maybe add an example

asdil12 · 2024-07-23T14:11:41Z

backlog-check-wip-limit

+    cat << EOF
+Usage: $0 [OPTIONS]
+
+Checks the number of tickets in a redmine query against a "WIP-Limit".


Please document at least the most important env vars and what happens if check fails (exit code=1?)

trigger-pflash-test

asdil12 · 2024-07-23T14:28:26Z

trigger-openqa_in_openqa

+    cat << EOF
+Usage: $0 [OPTIONS]
+
+Triggers tests on an openQA instance testing openQA itself.


Suggested change

Triggers tests on an openQA instance testing openQA itself.

Schedules tests on an openQA instance testing openQA itself.

Using the openQA-in-openQA test distribution from:

https://raw.githubusercontent.com/os-autoinst/os-autoinst-distri-openQA

The application is called "trigger" so I would prefer to reuse that wording

asdil12 · 2024-07-23T14:32:04Z

reboot-stability-check

+    cat << EOF
+Usage: $0 [OPTIONS] HOSTS...
+
+Conducts reboot stability checks against a space- separated list of hosts.


Suggested change

Conducts reboot stability checks against a space- separated list of hosts.

Conducts reboot stability checks against a space- separated list of hosts.

Each host is pinged, checked for listening on port 22 and sshed to and rebooted several times.

asdil12 · 2024-07-23T14:32:46Z

os-autoinst-testapi-usage

-shift
+usage() {
+    cat << EOF
+Usage: $0 path_to_testapi path_to_code_repository [path_to_another_repository] [...]


What does this script do and why?

I really don't know

backlog-set-due-date

reboot-stability-check

test/01-label-known-issues.t

okurz · 2024-07-29T11:02:30Z

I applied the suggested changes where possible. I will need to incorporate the other comments and rewrap where necessary. No need to review more in the current state.

perlpunk · 2024-09-25T14:33:08Z

openqa-label-known-issues

+            -h | --help) usage 0 ;;
+            -H | --host)
+                host=$2
+                shift


Suggested change

shift

shift 2

mergify · 2024-10-14T11:09:46Z

This pull request is now in conflicts. Could you fix it? 🙏

…estability and extendability

…bility

…xtendability

…bility

…ability

…estability and extendability

…xtendability

…extendability

…dability

…ity and extendability

…dability

…endability

…ndability

…ability

…bility