add support for --list-prs

easybuild/main.py

@@ -60,7 +60,7 @@
 from easybuild.tools.docs import list_software
 from easybuild.tools.filetools import adjust_permissions, cleanup, write_file
 from easybuild.tools.github import check_github, find_easybuild_easyconfig, install_github_token
-from easybuild.tools.github import new_pr, merge_pr, update_pr
+from easybuild.tools.github import list_prs, new_pr, merge_pr, update_pr
 from easybuild.tools.hooks import START, END, load_hooks, run_hook
 from easybuild.tools.modules import modules_tool
 from easybuild.tools.options import parse_external_modules_metadata, process_software_build_specs, use_color
@@ -284,6 +284,14 @@ def main(args=None, logfile=None, do_build=None, testing=False, modtool=None):
     elif options.install_github_token:
         install_github_token(options.github_user, silent=build_option('silent'))
 
+    elif options.list_prs:
+        parameters = {
+            'direction': options.list_prs_direction,
+            'sort': options.list_prs_order,
+            'state': options.list_prs_state,
+            }
+        print list_prs(parameters)
+
     elif options.merge_pr:
         merge_pr(options.merge_pr)
 
@@ -303,6 +311,7 @@ def main(args=None, logfile=None, do_build=None, testing=False, modtool=None):
         options.install_github_token,
         options.list_installed_software,
         options.list_software,
+        options.list_prs,
         options.merge_pr,
         options.review_pr,
         options.terse,

easybuild/tools/github.py

@@ -958,6 +958,32 @@ def not_eligible(msg):
     return res
 
 
+def list_prs(parameters):
+    """
+    List PRs
+
+    :param parameters: Selection parameters for PRs, see https://developer.github.com/v3/pulls/#parameters
+    """
+
+    if 'per_page' not in parameters:
+        parameters.update({'per_page': GITHUB_MAX_PER_PAGE})
+
+    pr_target_account = build_option('pr_target_account')
+    pr_target_repo = build_option('pr_target_repo')
+
+    pr_url = lambda g: g.repos[pr_target_account][pr_target_repo].pulls
+    status, pr_data = github_api_get_request(pr_url, None, **parameters)
+    if status != HTTP_STATUS_OK:
+        raise EasyBuildError("Failed to get PR data from %s/%s (parameters: %s, status: %d %s)",
+                             pr_target_account, pr_target_repo, parameters, status, pr_data)
+
+    lines = []
+    for pr in pr_data:
+        lines.append("PR #%s: %s" % (pr['number'], pr['title']))
+
+    return '\n'.join(lines)
+
+
 def merge_pr(pr):
     """
     Merge specified pull request

easybuild/tools/options.py

@@ -550,6 +550,10 @@ def informative_options(self):
 
     def github_options(self):
         """GitHub integration configuration options."""
+        github_list_pr_states = ['open', 'closed', 'all']
+        github_list_pr_orders = ['created', 'updated', 'popularity', 'long-running']
+        github_list_pr_directions = ['asc', 'desc']
+
         descr = ("GitHub integration options", "Integration with GitHub")
 
         opts = OrderedDict({
@@ -562,6 +566,10 @@ def github_options(self):
             'github-user': ("GitHub username", str, 'store', None),
             'github-org': ("GitHub organization", str, 'store', None),
             'install-github-token': ("Install GitHub token (requires --github-user)", None, 'store_true', False),
+            'list-prs': ("List pull requests", None, 'store_true', None),
+            'list-prs-state': ("State for listing pull requests", 'choice', 'store', 'open', github_list_pr_states),
+            'list-prs-order': ("Order for sorting pull requests", 'choice', 'store', 'created', github_list_pr_orders),
+            'list-prs-direction': ("Direction for sorting pull requests", 'choice', 'store', 'desc', github_list_pr_directions),
             'merge-pr': ("Merge pull request", int, 'store', None, {'metavar': 'PR#'}),
             'new-pr': ("Open a new pull request", None, 'store_true', False),
             'pr-branch-name': ("Branch name to use for new PRs; '<timestamp>_new_pr_<name><version>' if unspecified",

test/framework/github.py

@@ -114,6 +114,25 @@ def test_read(self):
         except (IOError, OSError):
             pass
 
+    def test_list_prs(self):
+        """Test fetch_easyconfigs_from_pr function."""
+        if self.github_token is None:
+            print "Skipping test_list_prs, no GitHub token available?"
+            return
+
+        parameters = {'state': 'closed', 'sort': 'created', 'direction': 'asc', 'per_page': 1}
+
+        init_config(build_options={'pr_target_account': GITHUB_USER,
+                                   'pr_target_repo': GITHUB_REPO})
+
+        expected = "PR #1: a pr"
+
+        try:
+            output = gh.list_prs(parameters)
+            self.assertEqual(expected, output)
+        except Exception as err:
+            print err
+
     def test_fetch_easyconfigs_from_pr(self):
         """Test fetch_easyconfigs_from_pr function."""
         if self.github_token is None: