Add a script to checkout a worktree of gst-build and its subprojects

https://bugzilla.gnome.org/show_bug.cgi?id=794519

2 files changed, 103 insertions, 0 deletions

diff --git a/README.md b/README.md
index 0719aca819..ae28e1d7cc 100644
--- a/README.md
+++ b/README.md
@@ -115,6 +115,20 @@ Run a specific test from a specific test file:
 GST_CHECKS=test_subbuffer meson test -C build/ --suite gstreamer gst_gstbuffer
 ```
 
+## Checkout another branch using worktrees
+
+If you need to have several versions of GStreamer coexisting (eg. `master` and `1.14`),
+you can use the `checkout-branch-worktree` script provided by `gst-build`. It allows you
+to create a new `gst-build` environment with new checkout of all the GStreamer modules as
+[git worktrees](https://git-scm.com/docs/git-worktree).
+
+For example to get a fresh checkout of `gst-1.14` from a `gst-build` in master already
+built in a `build` directory you can simply run:
+
+```
+./checkout-branch-worktree ../gst-1.14 1.14 -C build/
+```
+
 ## Add information about GStreamer development environment in your prompt line
 
 ### Bash prompt
diff --git a/checkout-branch-worktree b/checkout-branch-worktree
new file mode 100755
index 0000000000..1a7124150c
--- /dev/null
+++ b/checkout-branch-worktree
@@ -0,0 +1,89 @@
+#!/usr/bin/env python3
+
+import argparse
+import json
+import os
+import subprocess
+import xml.etree.ElementTree as ET
+import sys
+
+from common import git
+from common import Colors
+from common import get_meson
+from common import accept_command
+
+
+SCRIPTDIR = os.path.normpath(os.path.dirname(__file__))
+
+
+def checkout_subprojects(worktree_dir, branch):
+    subprojects_dir = os.path.join(SCRIPTDIR, "subprojects")
+    worktree_subdir = os.path.join(worktree_dir, "subprojects")
+
+    meson = get_meson()
+    installed_s = subprocess.check_output([sys.executable, meson, 'introspect',
+                                            options.builddir, '--projectinfo'])
+    for subproj in json.loads(installed_s.decode())["subprojects"]:
+        repo_name = subproj["name"]
+        if not repo_name.startswith("gst"):
+            continue
+
+        repo_dir = os.path.normpath(os.path.join(SCRIPTDIR, subprojects_dir, repo_name))
+        if not os.path.exists(os.path.join(repo_dir, '.git')):
+            continue
+
+        workdir = os.path.normpath(os.path.join(worktree_subdir, repo_name))
+        if not checkout_worktree(repo_name, repo_dir, workdir, branch):
+            return False
+
+    return True
+
+
+def checkout_worktree(repo_name, repo_dir, worktree_dir, branch):
+    print("Checking out worktree %s in %s (branch %s)" % (repo_name, worktree_dir, branch))
+    try:
+        git("worktree", "add", worktree_dir, branch, repository_path=repo_dir)
+    except Exception as e:
+        out = getattr(e, "output", b"").decode()
+        print("\nCould not checkout worktree %s, please fix and try again."
+              " Error:\n\n%s %s" % (repo_dir, out, e))
+
+        return False
+
+    commit_message = git("show", repository_path=repo_dir).split("\n")
+    print(u"  -> %s%s%s - %s" % (Colors.HEADER, repo_dir, Colors.ENDC,
+                                    commit_message[4].strip()))
+
+    return True
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(prog="git-update")
+
+
+    parser.add_argument('worktree_dir', metavar='worktree_dir', type=str,
+                        help='The directory where to checkout the new worktree')
+    parser.add_argument('branch', metavar='branch', type=str,
+                        help='The branch to checkout')
+    parser.add_argument("--no-color",
+                        default=False,
+                        action='store_true',
+                        help="Do not output ansi colors.")
+    parser.add_argument("--builddir", '-C',
+                        default=os.path.join(SCRIPTDIR, "build"),
+                        help="The meson build directory")
+    options = parser.parse_args()
+
+    if options.no_color:
+        Colors.disable()
+
+    if not os.path.exists(options.builddir):
+        print("GStreamer not built in %s\n\nBuild it and try again" %
+              options.builddir)
+        exit(1)
+
+    options.worktree_dir = os.path.abspath(options.worktree_dir)
+    if not checkout_worktree('gst-build', SCRIPTDIR, options.worktree_dir, options.branch):
+        exit(1)
+    if not checkout_subprojects(options.worktree_dir, options.branch):
+        exit(1)