mach
author Chris Manchester <cmanchester@mozilla.com>
Wed, 02 Oct 2019 20:56:52 +0000
changeset 2364698 bd88f466b13aca5f160c1be15c22a17fe5dbb3aa
parent 2362374 b50c4cdef2ac1ed8949753711f608f19fd12acb3
child 2368624 bff3d6238e4cebedbb572883036392d93061b263
child 2369769 98c1166d9dc22074cc5663e9f3e2d6ebc072a40b
permissions -rwxr-xr-x
Bug 1578493 - Updates to sccache-dist docs. r=nalexander Differential Revision: https://phabricator.services.mozilla.com/D47836

#!/bin/sh
# 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/.

# The beginning of this script is both valid POSIX shell and valid Python,
# such that the script starts with the shell and is reexecuted with
# the right Python.

# Embeds a shell script inside a Python triple quote. This pattern is valid
# shell because `''':'`, `':'` and `:` are all equivalent, and `:` is a no-op.
''':'
py2commands="
    addtest
    analyze
    android
    android-emulator
    artifact
    awsy-test
    bootstrap
    browsertime
    build
    build-backend
    buildsymbols
    busted
    cargo
    check-spidermonkey
    clang-format
    compare-locales
    compileflags
    configure
    cppunittest
    cramtest
    crashtest
    devtools-css-db
    doc
    doctor
    empty-makefiles
    environment
    file-info
    firefox-ui-functional
    fluent-migration-test
    geckodriver
    geckodriver-test
    geckoview-junit
    gradle
    gtest
    ide
    import-pr
    install
    jsapi-tests
    jsshell-bench
    jstestbrowser
    jstests
    marionette-test
    mochitest
    mozbuild-reference
    mozharness
    mozregression
    package
    package-multi-locale
    pastebin
    power
    prettier-format
    puppeteer-test
    python
    python-safety
    python-test
    raptor
    raptor-test
    reftest
    release
    release-history
    remote
    repackage
    resource-usage
    robocop
    run
    rusttests
    show-log
    static-analysis
    talos-test
    taskcluster-build-image
    taskcluster-load-image
    taskgraph
    telemetry-tests-client
    test
    test-info
    tps-build
    try
    uuid
    valgrind-test
    vcs-setup
    vendor
    visualmetrics
    warnings-list
    warnings-summary
    watch
    web-platform-tests
    web-platform-tests-update
    webidl-example
    webidl-parser-test
    webrtc-gtest
    wpt
    wpt-manifest-update
    wpt-metadata-merge
    wpt-metadata-summary
    wpt-serve
    wpt-unittest
    wpt-update
    xpcshell-test
"

run_py() {
    # Try to run a specific Python interpreter. Fall back to the system
    # default Python if the specific interpreter couldn't be found.
    py_executable="$1"
    shift
    if which "$py_executable" > /dev/null
    then
        exec "$py_executable" "$0" "$@"
    elif [ "$py_executable" = "python2.7" ]; then
        exec python "$0" "$@"
    else
        echo "This mach command requires $py_executable, which wasn't found on the system!"
        exit 1
    fi
}

first_arg=$1
if [ "$first_arg" = "help" ]; then
    # When running `./mach help <command>`, the correct Python for <command>
    # needs to be used.
    first_arg=$2
fi

if [ -z "$first_arg" ]; then
    # User ran `./mach` or `./mach help`, use Python 3.
    run_py python3 "$@"
fi

case "${first_arg}" in
    "-"*)
        # We have global arguments which are tricky to parse from this shell
        # script. So invoke `mach` with a special --print-command argument to
        # return the name of the command. This adds extra overhead when using
        # global arguments, but global arguments are an edge case and this hack
        # is only needed temporarily for the Python 3 migration. We use Python
        # 2.7 because using Python 3 hits this error in build tasks:
        # https://searchfox.org/mozilla-central/rev/c7e8bc4996f9/build/moz.configure/init.configure#319
        command=`run_py python2.7 --print-command "$@" | tail -n1`
        ;;
    *)
        # In the common case, the first argument is the command.
        command=${first_arg};
        ;;
esac

# Check for the mach subcommand in the Python 2 commands list and run it
# with the correct interpreter.
case " $(echo $py2commands) " in
    *\ $command\ *)
        run_py python2.7 "$@"
        ;;
    *)
        run_py python3 "$@"
        ;;
esac

# Run Python 3 for everything else.
run_py python3 "$@"
'''

from __future__ import absolute_import, print_function, unicode_literals

import os
import sys

def ancestors(path):
    while path:
        yield path
        (path, child) = os.path.split(path)
        if child == "":
            break

def load_mach(dir_path, mach_path):
    if sys.version_info < (3, 5):
        import imp
        mach_bootstrap = imp.load_source('mach_bootstrap', mach_path)
    else:
        import importlib.util
        spec = importlib.util.spec_from_file_location('mach_bootstrap', mach_path)
        mach_bootstrap = importlib.util.module_from_spec(spec)
        spec.loader.exec_module(mach_bootstrap)

    return mach_bootstrap.bootstrap(dir_path)


def check_and_get_mach(dir_path):
    bootstrap_paths = (
        'build/mach_bootstrap.py',
        # test package bootstrap
        'tools/mach_bootstrap.py',
    )
    for bootstrap_path in bootstrap_paths:
        mach_path = os.path.join(dir_path, bootstrap_path)
        if os.path.isfile(mach_path):
            return load_mach(dir_path, mach_path)
    return None


def get_mach():
    # Check whether the current directory is within a mach src or obj dir.
    for dir_path in ancestors(os.getcwd()):
        # If we find a "config.status" and "mozinfo.json" file, we are in the objdir.
        config_status_path = os.path.join(dir_path, 'config.status')
        mozinfo_path = os.path.join(dir_path, 'mozinfo.json')
        if os.path.isfile(config_status_path) and os.path.isfile(mozinfo_path):
            import json
            info = json.load(open(mozinfo_path))
            if 'mozconfig' in info and 'MOZCONFIG' not in os.environ:
                # If the MOZCONFIG environment variable is not already set, set it
                # 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 on Windows
                os.environ[b'MOZCONFIG'] = str(info['mozconfig'])

            if 'topsrcdir' in info:
                # Continue searching for mach_bootstrap in the source directory.
                dir_path = info['topsrcdir']

        mach = check_and_get_mach(dir_path)
        if mach:
            return mach

    # If we didn't find a source path by scanning for a mozinfo.json, check
    # whether the directory containing this script is a source directory. We
    # follow symlinks so mach can be run even if cwd is outside the srcdir.
    return check_and_get_mach(os.path.dirname(os.path.realpath(__file__)))

def main(args):
    mach = get_mach()
    if not mach:
        print('Could not run mach: No mach source directory found.')
        sys.exit(1)
    sys.exit(mach.run(args))


if __name__ == '__main__':
    main(sys.argv[1:])