Add usage+help to all scripts

backlog-check-wip-limit

@@ -1,9 +1,39 @@
-#!/bin/sh -e
+#!/bin/bash -e
 redmine_api_key="${redmine_api_key:?"Need redmine API key"}"
 host="${host:-"https://progress.opensuse.org"}"
 query_id="${query_id:-400}"
 ticket_limit="${ticket_limit:-200}"
 wip_limit="${wip_limit:-10}"
 status="${status:-"In Progress"}"
-tickets=$(curl -s -H "X-Redmine-API-Key: $redmine_api_key" "https://progress.opensuse.org/issues.json?query_id=$query_id&limit=$ticket_limit" | jq -r '.issues | .[] | select(.status.name=="In Progress") | .id')
-test "$(echo "$tickets" | wc -l)" -le "$wip_limit"
+
+usage() {
+    cat << EOF
+Usage: $0 [OPTIONS]
+
+Checks the number of tickets in a redmine query against a "WIP-Limit".
+
+Options:
+ -h, --help         display this help
+EOF
+    exit "$1"
+}
+
+main() {
+    opts=$(getopt -o h -l help -n "$0" -- "$@") || usage 1
+    eval set -- "$opts"
+    while true; do
+        case "$1" in
+            -h | --help) usage 0 ;;
+            --)
+                shift
+                break
+                ;;
+            *) break ;;
+        esac
+    done
+
+    tickets=$(curl -s -H "X-Redmine-API-Key: $redmine_api_key" "https://progress.opensuse.org/issues.json?query_id=$query_id&limit=$ticket_limit" | jq -r '.issues | .[] | select(.status.name=="In Progress") | .id')
+    test "$(echo "$tickets" | wc -l)" -le "$wip_limit"
+}
+
+caller 0 > /dev/null || main "$@"

backlog-set-due-date

@@ -1,14 +1,4 @@
-#!/bin/sh -e
-
-# This script sets the due date on tickets in Redmine based on
-# specified conditions
-#
-# If you want to run this for testing there are two options
-# 1. Run the script without updating the tickets
-# dry_run=1 ./backlog-set-due-date
-#
-# 2. Like #1 but also read the tickets from a file
-# dry_run=1 ./backlog-set-due-date <issues-json-file>
+#!/bin/bash -e
 
 dry_run="${dry_run:-"0"}"
 query_id="${query_id:-230}"
@@ -17,22 +7,60 @@ host="${host:-"https://progress.opensuse.org"}"
 status="${status:-"In Progress"}"
 duration="${duration:-"14 days"}"
 priority="${priority:-"Low"}"
-issues=$(mktemp -t backlog-set-due-date-XXXX)
-jquery=".issues | .[] | select(.priority.name!=\"$priority\" and .due_date==null and .assigned_to!=null and .status.name==\"$status\")"
-
-if [ $# -eq 1 ] && [ -f "$1" ] && [ "$dry_run" = "1" ]; then
-    jq -r "$jquery" "$1" > "$issues"
-else
-    redmine_api_key="${redmine_api_key:?"Need redmine API key"}"
-    curl -sS -H "X-Redmine-API-Key: $redmine_api_key" "$host/issues.json?query_id=$query_id&limit=$ticket_limit" | jq -r "$jquery" > "$issues"
-fi
-
-[ "$dry_run" = "1" ] && prefix="echo"
-
-for id in $(jq .id "$issues"); do
-    due_date=$(date -d"+$duration" +%Y-%m-%d)
-    echo "Updating ticket $id, new due date setup to $due_date"
-    $prefix curl -v -H "X-Redmine-API-Key: $redmine_api_key" -H 'Content-Type: application/json' -X PUT \
-        -d "{\"issue\": {\"due_date\": \"$due_date\", \"notes\": \"Setting due date based on mean cycle time of SUSE QE Tools\"}}" \
-        "$host/issues/$id.json"
-done
+
+usage() {
+    cat << EOF
+Usage: $0 [OPTIONS]
+
+This script sets the due date on tickets in Redmine based on
+specified conditions.
+
+If you want to run this for testing there are two options:
+1. Run the script without updating the tickets
+dry_run=1 ./backlog-set-due-date
+
+2. Like #1 but also read the tickets from a file
+dry_run=1 ./backlog-set-due-date <issues-json-file>
+
+Options:
+ -h, --help         display this help
+EOF
+    exit "$1"
+}
+
+main() {
+    opts=$(getopt -o h -l help -n "$0" -- "$@") || usage 1
+    eval set -- "$opts"
+    while true; do
+        case "$1" in
+            -h | --help) usage 0 ;;
+            --)
+                shift
+                break
+                ;;
+            *) break ;;
+        esac
+    done
+
+    issues=$(mktemp -t backlog-set-due-date-XXXX)
+    jquery=".issues | .[] | select(.priority.name!=\"$priority\" and .due_date==null and .assigned_to!=null and .status.name==\"$status\")"
+
+    if [ $# -eq 1 ] && [ -f "$1" ] && [ "$dry_run" = "1" ]; then
+        jq -r "$jquery" "$1" > "$issues"
+    else
+        redmine_api_key="${redmine_api_key:?"Need redmine API key"}"
+        curl -sS -H "X-Redmine-API-Key: $redmine_api_key" "$host/issues.json?query_id=$query_id&limit=$ticket_limit" | jq -r "$jquery" > "$issues"
+    fi
+
+    [ "$dry_run" = "1" ] && prefix="echo"
+
+    for id in $(jq .id "$issues"); do
+        due_date=$(date -d"+$duration" +%Y-%m-%d)
+        echo "Updating ticket $id, new due date setup to $due_date"
+        $prefix curl -v -H "X-Redmine-API-Key: $redmine_api_key" -H 'Content-Type: application/json' -X PUT \
+            -d "{\"issue\": {\"due_date\": \"$due_date\", \"notes\": \"Setting due date based on mean cycle time of SUSE QE Tools\"}}" \
+            "$host/issues/$id.json"
+        done
+    }
+
+caller 0 > /dev/null || main "$@"

monitor-openqa_job

@@ -1,12 +1,5 @@
 #!/bin/bash -ex
 
-# Monitor an openQA job by polling the status of a job over the API.
-#
-# Continuously polls the openQA API for the status of the specified jobs until
-# all jobs finish. After the jobs have finished this program exits with an exit
-# code corresponding to the jobs' result. For example all jobs pass it would exit
-# this program with exit code 0 for success; otherwise with 1.
-
 set -euo pipefail
 
 # configuration variables with defaults.
@@ -18,38 +11,72 @@ obs_component="${obs_component:-"package"}"
 obs_package_name="${1:-""}"
 comment_on_obs=${comment_on_obs:-}
 
-# shellcheck source=/dev/null
-. "$(dirname "$0")"/_common
-
-[[ -f job_post_response ]] || (echo "Need job response status file 'job_post_response'" && exit 2)
-declare -A failed_versions
-failed_jobs=()
-for job_id in $(job_ids job_post_response); do
-    echo "Waiting for job $job_id to finish"
-    while sleep "${sleep_time}"; do
-        job_state=$($openqa_cli api --host "$host" jobs/"$job_id" | jq -r '.job.state')
-        [[ $job_state = 'done' ]] && break
+usage() {
+    cat << EOF
+Usage: $0 [OPTIONS]
+
+Monitor an openQA job by polling the status of a job over the API.
+
+Continuously polls the openQA API for the status of the specified jobs until
+all jobs finish. After the jobs have finished this program exits with an exit
+code corresponding to the jobs' result. For example all jobs pass it would
+exit this program with exit code 0 for success; otherwise with 1.
+
+Options:
+ -h, --help         display this help
+EOF
+    exit "$1"
+}
+
+main() {
+    opts=$(getopt -o h -l help -n "$0" -- "$@") || usage 1
+    eval set -- "$opts"
+    while true; do
+        case "$1" in
+            -h | --help) usage 0 ;;
+            --)
+                shift
+                break
+                ;;
+            *) break ;;
+        esac
     done
-    response=$($openqa_cli api --host "$host" jobs/"$job_id")
-    result=$(echo "$response" | jq -r '.job.result')
-    echo "Result of job $job_id: $result"
-    if [[ $result != 'passed' ]] && [[ -n $obs_package_name ]]; then
-        version=$(echo "$response" | jq -r '.job.settings.VERSION')
-        failed_versions[$version]=1
-        failed_jobs+=("$job_id")
-    fi
-done
-
-[[ ${failed_jobs[*]} ]] || exit 0
-[[ $comment_on_obs ]] || exit 1
-
-osc api "/comments/$obs_component/$obs_package_name" | grep id= | sed -n 's/.*id="\([^"]*\)">.*test.* failed.*/\1/p' | while read -r id; do
+
+    # shellcheck source=/dev/null
+    . "$(dirname "$0")"/_common
+
+    [[ -f job_post_response ]] || (echo "Need job response status file 'job_post_response'" && exit 2)
+    declare -A failed_versions
+    failed_jobs=()
+    for job_id in $(job_ids job_post_response); do
+        echo "Waiting for job $job_id to finish"
+        while sleep "${sleep_time}"; do
+            job_state=$($openqa_cli api --host "$host" jobs/"$job_id" | jq -r '.job.state')
+            [[ $job_state = 'done' ]] && break
+        done
+        response=$($openqa_cli api --host "$host" jobs/"$job_id")
+        result=$(echo "$response" | jq -r '.job.result')
+        echo "Result of job $job_id: $result"
+        if [[ $result != 'passed' ]] && [[ -n $obs_package_name ]]; then
+            version=$(echo "$response" | jq -r '.job.settings.VERSION')
+            failed_versions[$version]=1
+            failed_jobs+=("$job_id")
+        fi
+    done
+
+    [[ ${failed_jobs[*]} ]] || exit 0
+    [[ $comment_on_obs ]] || exit 1
+
+    osc api "/comments/$obs_component/$obs_package_name" | grep id= | sed -n 's/.*id="\([^"]*\)">.*test.* failed.*/\1/p' | while read -r id; do
     osc api -X DELETE /comment/"$id"
-done
-comment="openQA-in-openQA test(s) failed (job IDs: ${failed_jobs[*]}), see https://openqa.opensuse.org/tests/overview?"
-for version in "${!failed_versions[@]}"; do
-    comment+="version=${version}&"
-done
-comment+="groupid=$openqa_groupid"
-osc api --data="$comment" -X POST "/comments/${obs_component}/$obs_package_name"
-exit 1
+    done
+    comment="openQA-in-openQA test(s) failed (job IDs: ${failed_jobs[*]}), see https://openqa.opensuse.org/tests/overview?"
+    for version in "${!failed_versions[@]}"; do
+        comment+="version=${version}&"
+    done
+    comment+="groupid=$openqa_groupid"
+    osc api --data="$comment" -X POST "/comments/${obs_component}/$obs_package_name"
+    exit 1
+}
+
+caller 0 > /dev/null || main "$@"

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

@@ -2,16 +2,45 @@
 
 osc="osc --apiurl https://api.opensuse.org"
 
-for project in $($osc search --project -s 'devel:openQA:Leap:' | grep -o '^devel:openQA:Leap:.*'); do
-    for package in $($osc list "$project"); do
-        $osc api "/comments/package/$project/$package" \
-            | yq -pxml -oy '.comments.comment |= ([] + .) | .comments.comment[].+content' \
-            | grep -q "Reason for linking:" \
-            || {
-                echo "No reason for $project/$package, consider adding a comment or remove the link (see poo#128087 for details)" >&2
-                problem=1
-            }
+usage() {
+    cat << EOF
+Usage: $0 [OPTIONS]
+
+Checks devel:openQA:Leap: OBS project dependencies.
+
+Options:
+ -h, --help         display this help
+EOF
+    exit "$1"
+}
+
+main() {
+    opts=$(getopt -o h -l help -n "$0" -- "$@") || usage 1
+    eval set -- "$opts"
+    while true; do
+        case "$1" in
+            -h | --help) usage 0 ;;
+            --)
+                shift
+                break
+                ;;
+            *) break ;;
+        esac
     done
-done
 
-test -z "$problem"
+    for project in $($osc search --project -s 'devel:openQA:Leap:' | grep -o '^devel:openQA:Leap:.*'); do
+        for package in $($osc list "$project"); do
+            $osc api "/comments/package/$project/$package" \
+                | yq -pxml -oy '.comments.comment |= ([] + .) | .comments.comment[].+content' \
+                | grep -q "Reason for linking:" \
+                || {
+                    echo "No reason for $project/$package, consider adding a comment or remove the link (see poo#128087 for details)" >&2
+                    problem=1
+                }
+        done
+    done
+
+    test -z "$problem"
+}
+
+caller 0 > /dev/null || main "$@"

obs-check-package-origin

@@ -1,11 +1,5 @@
 #!/bin/bash -e
 
-# Motivation: https://progress.opensuse.org/issues/154723
-# 1. fetch requirements from package spec file,
-# 2. look for package names for such requirements
-# 3. search all relevant instances where the package is maintained
-# 4. fetch version info from spec file and from Tumbleweed repo
-
 osc="${osc:-"osc --apiurl https://api.opensuse.org"}"
 
 BLUE="\e[94m"
@@ -155,12 +149,45 @@ list_versions() {
     done | sort | column -t -N Origin,Version,TW-Version
 }
 
-init_check
-[ $# -eq 0 ] && {
-    info "Usage: $0 package-name ..."
-    exit 99
+usage() {
+    cat << EOF
+Usage: $0 [OPTIONS]
+
+Motivation: https://progress.opensuse.org/issues/154723
+1. fetch requirements from package spec file,
+2. look for package names for such requirements
+3. search all relevant instances where the package is maintained
+4. fetch version info from spec file and from Tumbleweed repo
+
+Options:
+ -h, --help         display this help
+EOF
+    exit "$1"
+}
+
+main() {
+    opts=$(getopt -o h -l help -n "$0" -- "$@") || usage 1
+    eval set -- "$opts"
+    while true; do
+        case "$1" in
+            -h | --help) usage 0 ;;
+            --)
+                shift
+                break
+                ;;
+            *) break ;;
+        esac
+    done
+
+    init_check
+    [ $# -eq 0 ] && {
+        info "Usage: $0 package-name ..."
+        exit 99
+    }
+    while (($#)); do
+        list_versions "$1"
+        shift
+    done
 }
-while (($#)); do
-    list_versions "$1"
-    shift
-done
+
+caller 0 > /dev/null || main "$@"