Gracefully handle errors fetching GitHub data ARCHBOM-1310 (#28)

We're hitting GitHub internal errors trying to fetch data from the edx-blog repository. I've submitted a ticket to GitHub, but we should handle such cases gracefully without causing the entire health check to fail.

CHANGELOG.rst

@@ -16,6 +16,14 @@ Unreleased
 
 *
 
+[1.1.1] - 2020-07-21
+~~~~~~~~~~~~~~~~~~~~
+
+Fixed
+_____
+
+* Gracefully handle errors in fetching data from GitHub
+
 [1.1.0] - 2020-07-16
 ~~~~~~~~~~~~~~~~~~~~
 

pytest_repo_health/__init__.py

@@ -5,7 +5,7 @@
 """
 
 
-__version__ = "1.1.0"
+__version__ = "1.1.1"
 
 
 def health_metadata(parent_path, output_keys):

pytest_repo_health/fixtures/github.py

@@ -4,8 +4,9 @@
 import os
 import re
 
-import github
 import pytest
+from github import GitHub
+from github.errors import GitHubError
 
 URL_PATTERN = r"github.com[/:](?P<org_name>[^/]+)/(?P<repo_name>[^/\.]+)"
 
@@ -21,15 +22,16 @@ def github_client():
     except KeyError:
         raise Exception("To use any of the GitHub fixtures, you must set the GITHUB_TOKEN environment variable "
                         "to contain a GitHub personal access token.")
-    return github.GitHub(token)
+    return GitHub(token)
 
 
 @pytest.fixture
 async def github_repo(git_origin_url, github_client, loop):  # pylint: disable=redefined-outer-name, unused-argument
     """
     A fixture to fetch information from the GitHub API about the examined repository.
     Because github.py uses aiohttp, any checks using this fixture must be declared
-    via ``async def``.
+    via ``async def``.  Returns ``None`` if there is an error fetching data from
+    GitHub (such as a network failure or GitHub internal error).
     """
     if git_origin_url is None:
         # There isn't an origin for this repository or directory
@@ -40,4 +42,7 @@ async def github_repo(git_origin_url, github_client, loop):  # pylint: disable=r
         return None
     org_name = match.group("org_name")
     repo_name = match.group("repo_name")
-    return await github_client.fetch_repository(org_name, repo_name)
+    try:
+        return await github_client.fetch_repository(org_name, repo_name)
+    except GitHubError:
+        return None