servo/python/mach_bootstrap.py

# 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 subprocess
import sys
from distutils.spawn import find_executable

SEARCH_PATHS = [
    "python/mach",
    "python/toml",
    "python/mozlog",
    "python/mozinfo",
    "python/mozdebug",
    "tests/wpt",
    "tests/wpt/harness",
]

# Individual files providing mach commands.
MACH_MODULES = [
    'python/servo/bootstrap_commands.py',
    'python/servo/build_commands.py',
    'python/servo/testing_commands.py',
    'python/servo/post_build_commands.py',
    'python/servo/devenv_commands.py',
]


CATEGORIES = {
    'bootstrap': {
        'short': 'Bootstrap Commands',
        'long': 'Bootstrap the build system',
        'priority': 90,
    },
    'build': {
        'short': 'Build Commands',
        'long': 'Interact with the build system',
        'priority': 80,
    },
    'post-build': {
        'short': 'Post-build Commands',
        'long': 'Common actions performed after completing a build.',
        'priority': 70,
    },
    'testing': {
        'short': 'Testing',
        'long': 'Run tests.',
        'priority': 60,
    },
    'devenv': {
        'short': 'Development Environment',
        'long': 'Set up and configure your development environment.',
        'priority': 50,
    },
    'build-dev': {
        'short': 'Low-level Build System Interaction',
        'long': 'Interact with specific parts of the build system.',
        'priority': 20,
    },
    'misc': {
        'short': 'Potpourri',
        'long': 'Potent potables and assorted snacks.',
        'priority': 10,
    },
    'disabled': {
        'short': 'Disabled',
        'long': 'The disabled commands are hidden by default. Use -v to display them. These commands are unavailable '
                'for your current context, run "mach <command>" to see why.',
        'priority': 0,
    }
}


def _get_exec(name, default=None):
    path = find_executable(name)
    if not path:
        return default
    return path


def _activate_virtualenv(topdir):
    virtualenv_path = os.path.join(topdir, "python", "_virtualenv")
    python = _get_exec("python2", "python")

    if not os.path.exists(virtualenv_path):
        virtualenv = _get_exec("virtualenv2", "virtualenv")
        subprocess.check_call([virtualenv, "-p", python, virtualenv_path])

    activate_path = os.path.join(virtualenv_path, "bin", "activate_this.py")
    execfile(activate_path, dict(__file__=activate_path))

    # TODO: Right now, we iteratively install all the requirements by invoking
    # `pip install` each time. If it were the case that there were conflicting
    # requirements, we wouldn't know about them. Once
    # https://github.com/pypa/pip/issues/988 is addressed, then we can just
    # chain each of the requirements files into the same `pip install` call
    # and it will check for conflicts.
    requirements_paths = [
        os.path.join(topdir, "python", "requirements.txt"),
        os.path.join(topdir, "tests", "wpt", "harness", "requirements.txt"),
        os.path.join(topdir, "tests", "wpt", "harness", "requirements_servo.txt"),
    ]
    for path in requirements_paths:
        subprocess.check_call(["pip", "install", "-q", "-r", path])


def bootstrap(topdir):
    topdir = os.path.abspath(topdir)

    # 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 not (3, 0) > sys.version_info >= (2, 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)

    _activate_virtualenv(topdir)

    def populate_context(context, key=None):
        if key is None:
            return
        if key == 'topdir':
            return topdir
        raise AttributeError(key)

    sys.path[0:0] = [os.path.join(topdir, path) for path in SEARCH_PATHS]
    import mach.main
    mach = mach.main.Mach(os.getcwd())
    mach.populate_context_handler = populate_context

    for category, meta in CATEGORIES.items():
        mach.define_category(category, meta['short'], meta['long'],
                             meta['priority'])

    for path in MACH_MODULES:
        mach.load_commands_from_file(os.path.join(topdir, path))

    return mach