Add GH service support for repo integrity content (#20)

Author: alfinkel

CHANGES.md

@@ -1,3 +1,9 @@
+# 1.1.0
+
+- [NEW] Added repository details retrieval to Github service class.
+- [NEW] Added recent commit details retrieval to Github service class.
+- [NEW] Added repository branch protection details retrieval to Github service class.
+
 # 1.0.2
 
 - [FIXED] Added PyYAML library as a dependency to resolve Github service issue.

compliance/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 """Compliance automation package."""
 
-__version__ = '1.0.2'
+__version__ = '1.1.0'

compliance/notify.py

@@ -25,7 +25,7 @@
 
 from compliance.config import get_config
 from compliance.utils.services import pagerduty
-from compliance.utils.services.github import GitHub
+from compliance.utils.services.github import Github
 from compliance.utils.test import parse_test_id
 
 from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
@@ -413,7 +413,7 @@ def __init__(self, results, controls):
         # Using the locker repo url to define the base url.  The expectation
         # is that the Github issues repository will share the base url.
         parsed_locker_url = urlparse(get_config().get('locker.repo_url'))
-        self._github = GitHub(
+        self._github = Github(
             get_config().creds,
             f'{parsed_locker_url.scheme}://{parsed_locker_url.hostname}'
         )

compliance/utils/services/github.py

@@ -29,7 +29,7 @@
 import yaml
 
 
-class GitHub(object):
+class Github(object):
     """Github service helper class."""
 
     def __init__(self, config=None, base_url='https://github.com'):
@@ -484,6 +484,53 @@ def remove_labels(self, repo, issue, *labels):
         # Each response has all the labels, so only return the last one
         return response
 
+    def get_repo_details(self, repo):
+        """
+        Retrieve a repository's metadata.
+
+        :param repo: the organization/repository as a string.
+
+        :returns: the repository's metadata details.
+        """
+        self.session.headers.update(
+            {'Accept': 'application/vnd.github.v3+json'}
+        )
+        return self._make_request('get', f'repos/{repo}')
+
+    def get_commit_details(self, repo, since):
+        """
+        Retrieve a repository's commit details since a given date/time.
+
+        :param repo: the organization/repository as a string.
+        :param since: the starting date/time as a datetime.
+
+        :returns: the repository's commit details since a given date/time.
+        """
+        self.session.headers.update(
+            {'Accept': 'application/vnd.github.v3+json'}
+        )
+        return self._make_request(
+            'get',
+            f'repos/{repo}/commits',
+            params={'since': since.strftime('%Y-%m-%dT%H:%M:%SZ')}
+        )
+
+    def get_branch_protection_details(self, repo, branch='master'):
+        """
+        Retrieve a repository branch's branch protection details.
+
+        :param repo: the organization/repository as a string.
+        :param branch: the branch as a string.
+
+        :returns: the repository branch's branch protection details.
+        """
+        self.session.headers.update(
+            {'Accept': 'application/vnd.github.luke-cage-preview+json'}
+        )
+        return self._make_request(
+            'get', f'repos/{repo}/branches/{branch}/protection'
+        )
+
     def _make_request(self, method, url, parse=True, **kwargs):
         r = self.session.request(method, url, **kwargs)
         r.raise_for_status()

test/t_compliance/t_notify/test_gh_notifier.py

@@ -35,21 +35,21 @@ def setUp(self):
         for status in ['pass', 'fail', 'error', 'warn']:
             name, result = self._generate_result(status)
             self.results[name] = result
-        self.si_patcher = patch('compliance.notify.GitHub.search_issues')
+        self.si_patcher = patch('compliance.notify.Github.search_issues')
         self.search_issues_mock = self.si_patcher.start()
-        self.ai_patcher = patch('compliance.notify.GitHub.add_issue')
+        self.ai_patcher = patch('compliance.notify.Github.add_issue')
         self.add_issue_mock = self.ai_patcher.start()
-        self.pi_patcher = patch('compliance.notify.GitHub.patch_issue')
+        self.pi_patcher = patch('compliance.notify.Github.patch_issue')
         self.patch_issue_mock = self.pi_patcher.start()
-        self.aic_patcher = patch('compliance.notify.GitHub.add_issue_comment')
+        self.aic_patcher = patch('compliance.notify.Github.add_issue_comment')
         self.add_issue_comment_mock = self.aic_patcher.start()
-        self.gap_patcher = patch('compliance.notify.GitHub.get_all_projects')
+        self.gap_patcher = patch('compliance.notify.Github.get_all_projects')
         self.get_all_projects_mock = self.gap_patcher.start()
-        self.gc_patcher = patch('compliance.notify.GitHub.get_columns')
+        self.gc_patcher = patch('compliance.notify.Github.get_columns')
         self.get_columns_mock = self.gc_patcher.start()
-        self.gac_patcher = patch('compliance.notify.GitHub.get_all_cards')
+        self.gac_patcher = patch('compliance.notify.Github.get_all_cards')
         self.get_all_cards_mock = self.gac_patcher.start()
-        self.ac_patcher = patch('compliance.notify.GitHub.add_card')
+        self.ac_patcher = patch('compliance.notify.Github.add_card')
         self.add_card_mock = self.ac_patcher.start()
 
     def tearDown(self):