Bug 840588 - Create a mach wrapper that searches up from $CWD for a topsrcdir [r=gps]

build/mach_bootstrap.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from __future__ import print_function, unicode_literals
+
+import os
+import platform
+import sys
+
+# TODO Bug 794506 Integrate with the in-tree virtualenv configuration.
+SEARCH_PATHS = [
+    'python/mach',
+    'python/mozboot',
+    'python/mozbuild',
+    'build/pymake',
+    'python/blessings',
+    'python/psutil',
+    'python/which',
+    'other-licenses/ply',
+    'xpcom/idl-parser',
+    'testing',
+    'testing/xpcshell',
+    'testing/mozbase/mozprocess',
+    'testing/mozbase/mozfile',
+    'testing/mozbase/mozinfo',
+]
+
+# Individual files providing mach commands.
+MACH_MODULES = [
+    'addon-sdk/mach_commands.py',
+    'layout/tools/reftest/mach_commands.py',
+    'python/mozboot/mozboot/mach_commands.py',
+    'python/mozbuild/mozbuild/config.py',
+    'python/mozbuild/mozbuild/mach_commands.py',
+    'python/mozbuild/mozbuild/frontend/mach_commands.py',
+    'testing/mochitest/mach_commands.py',
+    'testing/xpcshell/mach_commands.py',
+]
+
+def bootstrap(topsrcdir):
+    # Ensure we are running Python 2.7+. We put this check here so we generate a
+    # user-friendly error message rather than a cryptic stack trace on module
+    # import.
+    if sys.version_info[0] != 2 or sys.version_info[1] < 7:
+        print('Python 2.7 or above (but not Python 3) is required to run mach.')
+        print('You are running Python', platform.python_version())
+        sys.exit(1)
+
+    try:
+        import mach.main
+    except ImportError:
+        sys.path[0:0] = [os.path.join(topsrcdir, path) for path in SEARCH_PATHS]
+        import mach.main
+
+    mach = mach.main.Mach(topsrcdir)
+    for path in MACH_MODULES:
+        mach.load_commands_from_file(os.path.join(topsrcdir, path))
+    return mach

mach

@@ -6,61 +6,46 @@
 from __future__ import print_function, unicode_literals
 
 import os
-import platform
 import sys
 
-# Ensure we are running Python 2.7+. We put this check here so we generate a
+def ancestors(path):
-# user-friendly error message rather than a cryptic stack trace on module
+    while path:
-# import.
+        yield path
-if sys.version_info[0] != 2 or sys.version_info[1] < 7:
+        (path, child) = os.path.split(path)
-    print('Python 2.7 or above (but not Python 3) is required to run mach.')
+        if child == "":
-    print('You are running Python', platform.python_version())
+            break
-    sys.exit(1)
 
-# TODO Bug 794506 Integrate with the in-tree virtualenv configuration.
+def load_mach(topsrcdir):
-SEARCH_PATHS = [
+    sys.path[0:0] = [os.path.join(topsrcdir, "build")]
-    'python/mach',
+    import mach_bootstrap
-    'python/mozboot',
+    return mach_bootstrap.bootstrap(topsrcdir)
-    'python/mozbuild',
-    'build',
-    'build/pymake',
-    'python/blessings',
-    'python/psutil',
-    'python/which',
-    'other-licenses/ply',
-    'xpcom/idl-parser',
-    'testing',
-    'testing/xpcshell',
-    'testing/mozbase/mozprocess',
-    'testing/mozbase/mozfile',
-    'testing/mozbase/mozinfo',
-]
 
-# Individual files providing mach commands.
+# Check whether the current directory is within a mach src or obj dir.
-MACH_MODULES = [
+for dir_path in ancestors(os.getcwd()):
-    'addon-sdk/mach_commands.py',
+    # If we find a "mozinfo.json" file, we are in the objdir.
-    'layout/tools/reftest/mach_commands.py',
+    mozinfo_path = os.path.join(dir_path, "mozinfo.json")
-    'python/mozboot/mozboot/mach_commands.py',
+    if os.path.isfile(mozinfo_path):
-    'python/mozbuild/mozbuild/config.py',
+        import json
-    'python/mozbuild/mozbuild/mach_commands.py',
+        info = json.load(open(mozinfo_path))
-    'python/mozbuild/mozbuild/frontend/mach_commands.py',
+        if "mozconfig" in info and "MOZCONFIG" not in os.environ:
-    'testing/mochitest/mach_commands.py',
+            # If the MOZCONFIG environment variable is not already set, set it
-    'testing/xpcshell/mach_commands.py',
+            # to the value from mozinfo.json.  This will tell the build system
-]
+            # to look for a config file at the path in $MOZCONFIG rather than
+            # its default locations.
+            #
+            # Note: subprocess requires native strings in os.environ Python
+            # 2.7.2 and earlier on Windows.
+            os.environ[b"MOZCONFIG"] = str(info["mozconfig"])
 
-our_dir = os.path.dirname(os.path.abspath(__file__))
+        if "topsrcdir" in info:
+            # Continue searching for mach_bootstrap in the source directory.
+            dir_path = info["topsrcdir"]
 
-try:
+    # If we find the mach bootstrap module, we are in the srcdir.
-    import mach.main
+    mach_path = os.path.join(dir_path, "build/mach_bootstrap.py")
-except ImportError:
+    if os.path.isfile(mach_path):
-    sys.path[0:0] = [os.path.join(our_dir, path) for path in SEARCH_PATHS]
+        mach = load_mach(dir_path)
+        sys.exit(mach.run(sys.argv[1:]))
 
-    import mach.main
+print("Could not run mach: No mach source directory found")
-
+sys.exit(1)
-# All of the code is in a module because EVERYTHING IS A LIBRARY.
-mach = mach.main.Mach(our_dir)
-
-for path in MACH_MODULES:
-    mach.load_commands_from_file(os.path.join(our_dir, path))
-
-sys.exit(mach.run(sys.argv[1:]))