From aa062513c06b70f88c4ce0fab3bc828155d5396f Mon Sep 17 00:00:00 2001
From: Niels de Vos <ndevos@redhat.com>
Date: Tue, 13 Oct 2020 10:34:29 +0200
Subject: [PATCH] ci: report connections failures with GitHub API

On occasion the scripts that use the GitHub API fail without logging any
useful error:

    ./scripts/get_github_labels.py --id=1568 --has-label=ci/skip/e2e
    Traceback (most recent call last):
      File "./scripts/get_github_labels.py", line 71, in <module>
        main()
      File "./scripts/get_github_labels.py", line 55, in main
        names = get_names(json)
      File "./scripts/get_github_labels.py", line 40, in get_names
        names.append(label['name'])
    TypeError: string indices must be integers

While debugging, it seems that the limit of API calls is reached:

    403 Client Error: rate limit exceeded

It is useful to have failure messages reported in the output of the CI
jobs for future potential troubleshooting.

Signed-off-by: Niels de Vos <ndevos@redhat.com>
---
 scripts/get_github_labels.py | 22 ++++++++++++++++++----
 scripts/get_patch_release.py | 11 ++++++++++-
 2 files changed, 28 insertions(+), 5 deletions(-)

diff --git a/scripts/get_github_labels.py b/scripts/get_github_labels.py
index 469a39429..0a1dfb0d2 100755
--- a/scripts/get_github_labels.py
+++ b/scripts/get_github_labels.py
@@ -4,9 +4,14 @@ Fetches the labels of an Issue or Pull-Request from GitHub.
 
 Parameters:
  --id=<id>: the number of the the GitHub Issue or Pull-Request
- --has-label=<label>: label to check (exit 0 if set, 1 unset), without
+ --has-label=<label>: label to check (exit 0 if set, 2 unset), without
                       --has-label, all labels of the Issue or Pull-Request
                       get printed.
+
+Exit codes:
+ 0: success
+ 1: any unexpected failure
+ 2: --has-label=<label> was passed, <label> is not set on the PR
 '''
 
 import argparse
@@ -28,6 +33,10 @@ def get_json_labels(gh_id):
     url = LABEL_URL_FMT % gh_id
     headers = {'Accept': 'application/vnd.github.v3+json'}
     res = requests.get(url, headers=headers)
+
+    # if "res.status_code != requests.codes.ok", raise an exception
+    res.raise_for_status()
+
     return res.json()
 
 
@@ -51,15 +60,20 @@ def main():
     args = parser.parse_args()
 
     # get the labels for the issue
-    json = get_json_labels(args.id)
+    try:
+        json = get_json_labels(args.id)
+    except Exception as err:
+        print('Error: %s' % err)
+        sys.exit(1)
+
     names = get_names(json)
 
-    # in case --has-label is passed, exit with 0 or 1
+    # in case --has-label is passed, exit with 0 or 2
     if args.has_label:
         if args.has_label in names:
             sys.exit(0)
         else:
-            sys.exit(1)
+            sys.exit(2)
     # --has-label was not passed, list all labels
     else:
         for name in names:
diff --git a/scripts/get_patch_release.py b/scripts/get_patch_release.py
index 333af3ac3..23b809df9 100755
--- a/scripts/get_patch_release.py
+++ b/scripts/get_patch_release.py
@@ -25,6 +25,10 @@ def get_json_releases():
     '''
     headers = {'Accept': 'application/vnd.github.v3+json'}
     res = requests.get(RELEASE_URL, headers=headers)
+
+    # if "res.status_code != requests.codes.ok", raise an exception
+    res.raise_for_status()
+
     return res.json()
 
 
@@ -47,7 +51,12 @@ def main():
     args = parser.parse_args()
 
     # get all the releases
-    json = get_json_releases()
+    try:
+        json = get_json_releases()
+    except Exception as err:
+        print('Error: %s' % err)
+        sys.exit(1)
+
     releases = get_releases(json)
 
     # in case --version is passed, exit with 0 or 1