[update-checkout] Allow the source root to be passed in instead of hard coding to SWIFT_SOURCE_ROOT.

This enables mocking testing to work (otherwise we would create repos in
SWIFT_SOURCE_ROOT). SWIFT_SOURCE_ROOT is the default value so nothing changes
unless one specifies the argument explicitly.

Author: gottesmm

utils/update_checkout/update_checkout/update_checkout.py

@@ -81,10 +81,10 @@ def get_branch_for_repo(config, repo_name, scheme_name, scheme_map,
     return repo_branch, cross_repo
 
 
-def update_single_repository(args):
-    config, repo_name, scheme_name, scheme_map, tag, timestamp, \
-        reset_to_remote, should_clean, cross_repos_pr = args
-    repo_path = os.path.join(SWIFT_SOURCE_ROOT, repo_name)
+def update_single_repository(pool_args):
+    source_root, config, repo_name, scheme_name, scheme_map, tag, timestamp, \
+        reset_to_remote, should_clean, cross_repos_pr = pool_args
+    repo_path = os.path.join(source_root, repo_name)
     if not os.path.isdir(repo_path):
         return
 
@@ -175,7 +175,7 @@ def update_single_repository(args):
 def get_timestamp_to_match(args):
     if not args.match_timestamp:
         return None
-    with shell.pushd(os.path.join(SWIFT_SOURCE_ROOT, "swift"),
+    with shell.pushd(os.path.join(args.source_root, "swift"),
                      dry_run=False, echo=False):
         return shell.capture(["git", "log", "-1", "--format=%cI"],
                              echo=False).strip()
@@ -198,7 +198,7 @@ def update_all_repositories(args, config, scheme_name, cross_repos_pr):
         if repo_name in args.skip_repository_list:
             print("Skipping update of '" + repo_name + "', requested by user")
             continue
-        my_args = [config,
+        my_args = [args.source_root, config,
                    repo_name,
                    scheme_name,
                    scheme_map,
@@ -220,7 +220,7 @@ def obtain_additional_swift_sources(pool_args):
     env = dict(os.environ)
     env.update({'GIT_TERMINAL_PROMPT': 0})
 
-    with shell.pushd(SWIFT_SOURCE_ROOT, dry_run=False, echo=False):
+    with shell.pushd(args.source_root, dry_run=False, echo=False):
 
         print("Cloning '" + repo_name + "'")
 
@@ -236,14 +236,14 @@ def obtain_additional_swift_sources(pool_args):
                       env=env,
                       echo=True)
         if scheme_name:
-            src_path = os.path.join(SWIFT_SOURCE_ROOT, repo_name, ".git")
+            src_path = os.path.join(args.source_root, repo_name, ".git")
             shell.run(['git', '--git-dir',
                        src_path, '--work-tree',
-                       os.path.join(SWIFT_SOURCE_ROOT, repo_name),
+                       os.path.join(args.source_root, repo_name),
                        'checkout', repo_branch],
                       env=env,
                       echo=False)
-    with shell.pushd(os.path.join(SWIFT_SOURCE_ROOT, repo_name),
+    with shell.pushd(os.path.join(args.source_root, repo_name),
                      dry_run=False, echo=False):
         shell.run(["git", "submodule",
                    "update", "--recursive"],
@@ -255,7 +255,7 @@ def obtain_all_additional_swift_sources(args, config, with_ssh, scheme_name,
                                         skip_history, skip_repository_list):
 
     pool_args = []
-    with shell.pushd(SWIFT_SOURCE_ROOT, dry_run=False, echo=False):
+    with shell.pushd(args.source_root, dry_run=False, echo=False):
         for repo_name, repo_info in config['repos'].items():
             if repo_name in skip_repository_list:
                 print("Skipping clone of '" + repo_name + "', requested by "
@@ -308,7 +308,7 @@ def obtain_all_additional_swift_sources(args, config, with_ssh, scheme_name,
                               args.n_processes)
 
 
-def dump_repo_hashes(config, branch_scheme_name='repro'):
+def dump_repo_hashes(args, config, branch_scheme_name='repro'):
     """
     Dumps the current state of the repo into a new config file that contains a
     master branch scheme with the relevant branches set to the appropriate
@@ -319,17 +319,17 @@ def dump_repo_hashes(config, branch_scheme_name='repro'):
     for config_copy_key in config_copy_keys:
         new_config[config_copy_key] = config[config_copy_key]
     repos = {}
-    repos = repo_hashes(config)
+    repos = repo_hashes(args, config)
     branch_scheme = {'aliases': [branch_scheme_name], 'repos': repos}
     new_config['branch-schemes'] = {branch_scheme_name: branch_scheme}
     json.dump(new_config, sys.stdout, indent=4)
 
 
-def repo_hashes(config):
+def repo_hashes(args, config):
     repos = {}
     for repo_name, repo_info in sorted(config['repos'].items(),
                                        key=lambda x: x[0]):
-        repo_path = os.path.join(SWIFT_SOURCE_ROOT, repo_name)
+        repo_path = os.path.join(args.source_root, repo_name)
         if os.path.exists(repo_path):
             with shell.pushd(repo_path, dry_run=False, echo=False):
                 h = shell.capture(["git", "rev-parse", "HEAD"],
@@ -340,8 +340,8 @@ def repo_hashes(config):
     return repos
 
 
-def print_repo_hashes(config):
-    repos = repo_hashes(config)
+def print_repo_hashes(args, config):
+    repos = repo_hashes(args, config)
     for repo_name, repo_hash in sorted(repos.items(),
                                        key=lambda x: x[0]):
         print("{:<35}: {:<35}".format(repo_name, repo_hash))
@@ -484,6 +484,11 @@ def main():
         help="Number of threads to run at once",
         default=0,
         dest="n_processes")
+    parser.add_argument(
+        "--source-root",
+        help="The root directory to checkout repositories",
+        default=SWIFT_SOURCE_ROOT,
+        dest='source_root')
     args = parser.parse_args()
 
     if not args.scheme:
@@ -513,7 +518,7 @@ def main():
         return (None, None)
 
     if args.dump_hashes_config:
-        dump_repo_hashes(config, args.dump_hashes_config)
+        dump_repo_hashes(args, config, args.dump_hashes_config)
         return (None, None)
 
     cross_repos_pr = {}
@@ -540,7 +545,7 @@ def main():
                                                             skip_repo_list)
 
     # Quick check whether somebody is calling update in an empty directory
-    directory_contents = os.listdir(SWIFT_SOURCE_ROOT)
+    directory_contents = os.listdir(args.source_root)
     if not ('cmark' in directory_contents or
             'llvm' in directory_contents or
             'clang' in directory_contents):
@@ -556,5 +561,5 @@ def main():
         print("update-checkout failed, fix errors and try again")
     else:
         print("update-checkout succeeded")
-        print_repo_hashes(config)
+        print_repo_hashes(args, config)
     sys.exit(fail_count)