Add option --override-repository (#792)
* Add option --override-repository to allow controlling where git clones happen from.
* Address review
diff --git a/emsdk.py b/emsdk.py
index 96a47e3..0aae94e 100644
--- a/emsdk.py
+++ b/emsdk.py
@@ -182,6 +182,27 @@
else:
EMSDK_SET_ENV = os.path.join(emsdk_path(), 'emsdk_set_env.bat')
+
+# Parses https://github.com/emscripten-core/emscripten/tree/d6aced8 to a pair (https://github.com/emscripten-core/emscripten, d6aced8)
+def parse_github_url_and_refspec(url):
+ if not url:
+ return ('', '')
+
+ if url.endswith(('/tree/', '/tree', '/commit/', '/commit')):
+ raise Exception('Malformed git URL and refspec ' + url + '!')
+
+ if '/tree/' in url:
+ if url.endswith('/'):
+ raise Exception('Malformed git URL and refspec ' + url + '!')
+ return url.split('/tree/')
+ elif '/commit/' in url:
+ if url.endswith('/'):
+ raise Exception('Malformed git URL and refspec ' + url + '!')
+ return url.split('/commit/')
+ else:
+ return (url, 'main') # Assume the default branch is main in the absence of a refspec
+
+
ARCHIVE_SUFFIXES = ('zip', '.tar', '.gz', '.xz', '.tbz2', '.bz2')
@@ -498,11 +519,11 @@
return len([name for name in os.listdir(path) if os.path.exists(os.path.join(path, name))])
-def run(cmd, cwd=None):
+def run(cmd, cwd=None, quiet=False):
debug_print('run(cmd=' + str(cmd) + ', cwd=' + str(cwd) + ')')
process = subprocess.Popen(cmd, cwd=cwd, env=os.environ.copy())
process.communicate()
- if process.returncode != 0:
+ if process.returncode != 0 and not quiet:
errlog(str(cmd) + ' failed with error code ' + str(process.returncode) + '!')
return process.returncode
@@ -792,33 +813,37 @@
git_clone_args = []
if GIT_CLONE_SHALLOW:
git_clone_args += ['--depth', '1']
+ print('Cloning from ' + url + '...')
return run([GIT(), 'clone'] + git_clone_args + [url, dstpath]) == 0
-def git_checkout_and_pull(repo_path, branch):
- debug_print('git_checkout_and_pull(repo_path=' + repo_path + ', branch=' + branch + ')')
+def git_checkout_and_pull(repo_path, branch_or_tag):
+ debug_print('git_checkout_and_pull(repo_path=' + repo_path + ', branch/tag=' + branch_or_tag + ')')
ret = run([GIT(), 'fetch', '--quiet', 'origin'], repo_path)
if ret != 0:
return False
try:
- print("Fetching latest changes to the branch '" + branch + "' for '" + repo_path + "'...")
+ print("Fetching latest changes to the branch/tag '" + branch_or_tag + "' for '" + repo_path + "'...")
ret = run([GIT(), 'fetch', '--quiet', 'origin'], repo_path)
if ret != 0:
return False
- # run([GIT, 'checkout', '-b', branch, '--track', 'origin/'+branch], repo_path)
# this line assumes that the user has not gone and manually messed with the
# repo and added new remotes to ambiguate the checkout.
- ret = run([GIT(), 'checkout', '--quiet', branch], repo_path)
+ ret = run([GIT(), 'checkout', '--quiet', branch_or_tag], repo_path)
if ret != 0:
return False
- # this line assumes that the user has not gone and made local changes to the repo
- ret = run([GIT(), 'merge', '--ff-only', 'origin/' + branch], repo_path)
+ # Test if branch_or_tag is a branch, or if it is a tag that needs to be updated
+ target_is_tag = run([GIT(), 'symbolic-ref', '-q', 'HEAD'], repo_path, quiet=True)
+ if not target_is_tag:
+ # update branch to latest (not needed for tags)
+ # this line assumes that the user has not gone and made local changes to the repo
+ ret = run([GIT(), 'merge', '--ff-only', 'origin/' + branch_or_tag], repo_path)
if ret != 0:
return False
except:
errlog('git operation failed!')
return False
- print("Successfully updated and checked out branch '" + branch + "' on repository '" + repo_path + "'")
+ print("Successfully updated and checked out branch/tag '" + branch_or_tag + "' on repository '" + repo_path + "'")
print("Current repository version: " + git_repo_version(repo_path))
return True
@@ -1684,7 +1709,9 @@
setattr(self, key, value)
# Cache the name ID of this Tool (these are read very often)
- self.name = self.id + '-' + self.version
+ self.name = self.id
+ if self.version:
+ self.name += '-' + self.version
if hasattr(self, 'bitness'):
self.name += '-' + str(self.bitness) + 'bit'
@@ -2873,6 +2900,10 @@
in the environment where the build is invoked.
See README.md for details.
+ --override-repository: Specifies the git URL to use for a given Tool. E.g.
+ --override-repository emscripten-main@https://github.com/<fork>/emscripten/tree/<refspec>
+
+
emsdk uninstall <tool/sdk> - Removes the given tool or SDK from disk.''')
if WINDOWS:
@@ -2920,6 +2951,13 @@
return True
return False
+ def extract_string_arg(name):
+ for i in range(len(args)):
+ if args[i] == name:
+ value = args[i + 1]
+ del args[i:i + 2]
+ return value
+
arg_old = extract_bool_arg('--old')
arg_uses = extract_bool_arg('--uses')
arg_permanent = extract_bool_arg('--permanent')
@@ -2949,6 +2987,20 @@
load_dot_emscripten()
load_sdk_manifest()
+ # Apply any overrides to git branch names to clone from.
+ forked_url = extract_string_arg('--override-repository')
+ while forked_url:
+ tool_name, url_and_refspec = forked_url.split('@')
+ t = find_tool(tool_name)
+ if not t:
+ errlog('Failed to find tool ' + tool_name + '!')
+ return False
+ else:
+ t.url, t.git_branch = parse_github_url_and_refspec(url_and_refspec)
+ debug_print('Reading git repository URL "' + t.url + '" and git branch "' + t.git_branch + '" for Tool "' + tool_name + '".')
+
+ forked_url = extract_string_arg('--override-repository')
+
# Process global args
for i in range(len(args)):
if args[i].startswith('--generator='):