add support for --update-branch-github

Author: boegel

easybuild/main.py

@@ -59,7 +59,7 @@
 from easybuild.tools.filetools import adjust_permissions, cleanup, write_file
 from easybuild.tools.github import check_github, close_pr, new_branch_github, find_easybuild_easyconfig
 from easybuild.tools.github import install_github_token, list_prs, new_pr, new_pr_from_branch, merge_pr
-from easybuild.tools.github import sync_pr_with_develop, update_pr
+from easybuild.tools.github import sync_pr_with_develop, update_branch, 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 set_up_configuration, use_color
@@ -294,8 +294,8 @@ def main(args=None, logfile=None, do_build=None, testing=False, modtool=None):
     categorized_paths = categorize_files_by_type(orig_paths)
 
     # command line options that do not require any easyconfigs to be specified
-    pr_options = options.new_branch_github or options.new_pr or options.new_pr_from_branch
-    pr_options = pr_options or options.preview_pr or options.sync_pr_with_develop or options.update_pr
+    pr_options = options.new_branch_github or options.new_pr or options.new_pr_from_branch or options.preview_pr
+    pr_options = pr_options or options.sync_pr_with_develop or options.update_branch_github or options.update_pr
     no_ec_opts = [options.aggregate_regtest, options.regtest, pr_options, search_query]
 
     # determine paths to easyconfigs
@@ -390,8 +390,10 @@ def main(args=None, logfile=None, do_build=None, testing=False, modtool=None):
             print(review_pr(paths=determined_paths, colored=use_color(options.color)))
         elif options.sync_pr_with_develop:
             sync_pr_with_develop(options.sync_pr_with_develop)
+        elif options.update_branch_github:
+            update_branch(options.update_branch_github, categorized_paths, ordered_ecs)
         elif options.update_pr:
-            update_pr(options.update_pr, categorized_paths, ordered_ecs, commit_msg=options.pr_commit_msg)
+            update_pr(options.update_pr, categorized_paths, ordered_ecs)
         else:
             raise EasyBuildError("Unknown PR option!")
 

easybuild/tools/config.py

@@ -442,8 +442,11 @@ def init_build_options(build_options=None, cmdline_options=None):
             cmdline_options.force = True
             retain_all_deps = True
 
-        if cmdline_options.new_branch_github or cmdline_options.new_pr or cmdline_options.update_pr:
-            _log.info("Retaining all dependencies of specified easyconfigs to create/update pull request")
+        new_update_opt = cmdline_options.new_branch_github or cmdline_options.new_pr
+        new_update_opt = new_update_opt or cmdline_options.update_branch_github or cmdline_options.update_pr
+
+        if new_update_opt:
+            _log.info("Retaining all dependencies of specified easyconfigs to create/update branch or pull request")
             retain_all_deps = True
 
         auto_ignore_osdeps_options = [cmdline_options.check_conflicts, cmdline_options.check_contrib,
@@ -453,7 +456,7 @@ def init_build_options(build_options=None, cmdline_options=None):
                                       cmdline_options.extended_dry_run, cmdline_options.fix_deprecated_easyconfigs,
                                       cmdline_options.missing_modules, cmdline_options.new_branch_github,
                                       cmdline_options.new_pr, cmdline_options.preview_pr,
-                                      cmdline_options.update_pr]
+                                      cmdline_options.update_branch_github, cmdline_options.update_pr]
         if any(auto_ignore_osdeps_options):
             _log.info("Auto-enabling ignoring of OS dependencies")
             cmdline_options.ignore_osdeps = True

easybuild/tools/github.py

@@ -1537,34 +1537,56 @@ def det_account_branch_for_pr(pr_id, github_user=None):
 
 
 @only_if_module_is_available('git', pkgname='GitPython')
-def update_pr(pr_id, paths, ecs, commit_msg=None):
+def update_branch(branch_name, paths, ecs, github_account=None, commit_msg=None):
     """
-    Update specified pull request using specified files
+    Update specified branch in GitHub using specified files
 
-    :param pr_id: ID of pull request to update
     :param paths: paths to categorized lists of files (easyconfigs, files to delete, patches)
+    :param github_account: GitHub account where branch is located
     :param ecs: list of parsed easyconfigs, incl. for dependencies (if robot is enabled)
     :param commit_msg: commit message to use
     """
+    if commit_msg is None:
+        commit_msg = build_option('pr_commit_msg')
 
     if commit_msg is None:
         raise EasyBuildError("A meaningful commit message must be specified via --pr-commit-msg when using --update-pr")
 
-    pr_target_account = build_option('pr_target_account')
-    pr_target_repo = build_option('pr_target_repo')
-
-    account, branch = det_account_branch_for_pr(pr_id)
+    if github_account is None:
+        github_account = build_option('github_user') or build_option('github_org')
 
-    _, _, _, _, diff_stat = _easyconfigs_pr_common(paths, ecs, start_branch=branch, pr_branch=branch,
-                                                   start_account=account, commit_msg=commit_msg)
+    _, _, _, _, diff_stat = _easyconfigs_pr_common(paths, ecs, start_branch=branch_name, pr_branch=branch_name,
+                                                   start_account=github_account, commit_msg=commit_msg)
 
     print_msg("Overview of changes:\n%s\n" % diff_stat, log=_log, prefix=False)
 
-    full_repo = '%s/%s' % (pr_target_account, pr_target_repo)
-    msg = "Updated %s PR #%s by pushing to branch %s/%s" % (full_repo, pr_id, account, branch)
+    full_repo = '%s/%s' % (github_account, build_option('pr_target_repo'))
+    msg = "pushed updated branch '%s' to %s" % (branch_name, full_repo)
     if build_option('dry_run') or build_option('extended_dry_run'):
         msg += " [DRY RUN]"
-    print_msg(msg, log=_log, prefix=False)
+    print_msg(msg, log=_log)
+
+
+@only_if_module_is_available('git', pkgname='GitPython')
+def update_pr(pr_id, paths, ecs, commit_msg=None):
+    """
+    Update specified pull request using specified files
+
+    :param pr_id: ID of pull request to update
+    :param paths: paths to categorized lists of files (easyconfigs, files to delete, patches)
+    :param ecs: list of parsed easyconfigs, incl. for dependencies (if robot is enabled)
+    :param commit_msg: commit message to use
+    """
+
+    github_account, branch_name = det_account_branch_for_pr(pr_id)
+
+    update_branch(branch_name, paths, ecs, github_account=github_account, commit_msg=commit_msg)
+
+    full_repo = '%s/%s' % (build_option('pr_target_account'), build_option('pr_target_repo'))
+    msg = "updated https://github.com/%s/pull/%s" % (full_repo, pr_id)
+    if build_option('dry_run') or build_option('extended_dry_run'):
+        msg += " [DRY RUN]"
+    print_msg(msg, log=_log)
 
 
 def check_github():

easybuild/tools/options.py

@@ -612,6 +612,7 @@ def github_options(self):
             'review-pr': ("Review specified pull request", int, 'store', None, {'metavar': 'PR#'}),
             'test-report-env-filter': ("Regex used to filter out variables in environment dump of test report",
                                        None, 'regex', None),
+            'update-branch-github': ("Update specified branch in GitHub", str, 'store', None),
             'update-pr': ("Update an existing pull request", int, 'store', None, {'metavar': 'PR#'}),
             'upload-test-report': ("Upload full test report as a gist on GitHub", None, 'store_true', False, 'u'),
         })
@@ -1358,6 +1359,8 @@ def set_up_configuration(args=None, logfile=None, testing=False, silent=False):
     if not robot_path:
         print_warning("Robot search path is empty!")
 
+    new_update_opt = options.new_pr or options.new_pr_from_branch or options.update_branch_github or options.update_pr
+
     # configure & initialize build options
     config_options_dict = eb_go.get_options_by_section('config')
     build_options = {
@@ -1366,7 +1369,7 @@ def set_up_configuration(args=None, logfile=None, testing=False, silent=False):
         'external_modules_metadata': parse_external_modules_metadata(options.external_modules_metadata),
         'pr_path': pr_path,
         'robot_path': robot_path,
-        'silent': testing or options.new_pr or options.update_pr,
+        'silent': testing or new_update_opt,
         'try_to_generate': try_to_generate,
         'valid_stops': [x[0] for x in EasyBlock.get_steps()],
     }

test/framework/options.py

@@ -2884,6 +2884,35 @@ def test_new_pr_from_branch(self):
         ]
         self._assert_regexs(regexs, txt)
 
+    def test_update_branch_github(self):
+        """Test --update-branch-github."""
+        if self.github_token is None:
+            print("Skipping test_update_branch_github, no GitHub token available?")
+            return
+
+        topdir = os.path.dirname(os.path.abspath(__file__))
+        test_ecs = os.path.join(topdir, 'easyconfigs', 'test_ecs')
+        toy_ec = os.path.join(test_ecs, 't', 'toy', 'toy-0.0.eb')
+
+        args = [
+            '--update-branch-github=develop',
+            '--github-user=boegel',  # used to determine account to grab branch from (no GitHub token needed)
+            toy_ec,
+            '--pr-commit-msg="this is just a test"',
+            '-D',
+        ]
+        txt, _ = self._run_mock_eb(args, do_build=True, raise_error=True, testing=False)
+
+        full_repo = 'boegel/easybuild-easyconfigs'
+        regexs = [
+            r"^== fetching branch 'develop' from https://github.com/%s.git\.\.\." % full_repo,
+            r"^== copying easyconfigs to .*/git-working-dir.*/easybuild-easyconfigs...",
+            r"^== pushing branch 'develop' to remote '.*' \([email protected]:%s.git\) \[DRY RUN\]" % full_repo,
+            r"^Overview of changes:\n.*/easyconfigs/t/toy/toy-0.0.eb \| 32",
+            r"== pushed updated branch 'develop' to boegel/easybuild-easyconfigs \[DRY RUN\]",
+        ]
+        self._assert_regexs(regexs, txt)
+
     def test_new_update_pr(self):
         """Test use of --new-pr (dry run only)."""
         if self.github_token is None:
@@ -3067,9 +3096,9 @@ def test_new_update_pr(self):
             r"^== fetching branch 'develop' from https://github.com/easybuilders/easybuild-easyconfigs.git...",
             r".*/toy-0.0-gompi-2018a-test.eb\s*\|",
             r"^\s*1 file(s?) changed",
-            "^== pushing branch 'develop' to remote '.*' \([email protected]:easybuilders/easybuild-easyconfigs.git\)",
-            r"^Updated easybuilders/easybuild-easyconfigs PR #2237 "
-            "by pushing to branch easybuilders/develop \[DRY RUN\]",
+            r"^== pushing branch 'develop' to remote '.*' \([email protected]:easybuilders/easybuild-easyconfigs.git\)",
+            r"^== pushed updated branch 'develop' to easybuilders/easybuild-easyconfigs \[DRY RUN\]",
+            r"^== updated https://github.com/easybuilders/easybuild-easyconfigs/pull/2237 \[DRY RUN\]",
         ]
         self._assert_regexs(regexs, txt)