build/mach_bootstrap.py

   1 # This Source Code Form is subject to the terms of the Mozilla Public
   2 # License, v. 2.0. If a copy of the MPL was not distributed with this
   3 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   4
   5 from __future__ import print_function, unicode_literals
   6
   7 import errno
   8 import json
   9 import os
  10 import platform
  11 import subprocess
  12 import sys
  13 import uuid
  14 if sys.version_info[0] < 3:
  15     import __builtin__ as builtins
  16 else:
  17     import builtins
  18
  19 from types import ModuleType
  20
  21
  22 STATE_DIR_FIRST_RUN = '''
  23 mach and the build system store shared state in a common directory on the
  24 filesystem. The following directory will be created:
  25
  26   {userdir}
  27
  28 If you would like to use a different directory, hit CTRL+c and set the
  29 MOZBUILD_STATE_PATH environment variable to the directory you would like to
  30 use and re-run mach. For this change to take effect forever, you'll likely
  31 want to export this environment variable from your shell's init scripts.
  32
  33 Press ENTER/RETURN to continue or CTRL+c to abort.
  34 '''.lstrip()
  35
  36
  37 # Individual files providing mach commands.
  38 MACH_MODULES = [
  39     'build/valgrind/mach_commands.py',
  40     'devtools/shared/css/generated/mach_commands.py',
  41     'dom/bindings/mach_commands.py',
  42     'layout/tools/reftest/mach_commands.py',
  43     'python/mach_commands.py',
  44     'python/safety/mach_commands.py',
  45     'python/mach/mach/commands/commandinfo.py',
  46     'python/mach/mach/commands/settings.py',
  47     'python/mozboot/mozboot/mach_commands.py',
  48     'python/mozbuild/mozbuild/mach_commands.py',
  49     'python/mozbuild/mozbuild/backend/mach_commands.py',
  50     'python/mozbuild/mozbuild/compilation/codecomplete.py',
  51     'python/mozbuild/mozbuild/frontend/mach_commands.py',
  52     'python/mozrelease/mozrelease/mach_commands.py',
  53     'taskcluster/mach_commands.py',
  54     'testing/awsy/mach_commands.py',
  55     'testing/firefox-ui/mach_commands.py',
  56     'testing/geckodriver/mach_commands.py',
  57     'testing/mach_commands.py',
  58     'testing/marionette/mach_commands.py',
  59     'testing/mochitest/mach_commands.py',
  60     'testing/mozharness/mach_commands.py',
  61     'testing/raptor/mach_commands.py',
  62     'testing/tps/mach_commands.py',
  63     'testing/talos/mach_commands.py',
  64     'testing/web-platform/mach_commands.py',
  65     'testing/xpcshell/mach_commands.py',
  66     'toolkit/components/telemetry/tests/marionette/mach_commands.py',
  67     'tools/browsertime/mach_commands.py',
  68     'tools/compare-locales/mach_commands.py',
  69     'tools/docs/mach_commands.py',
  70     'tools/lint/mach_commands.py',
  71     'tools/mach_commands.py',
  72     'tools/power/mach_commands.py',
  73     'tools/tryselect/mach_commands.py',
  74     'mobile/android/mach_commands.py',
  75 ]
  76
  77
  78 CATEGORIES = {
  79     'build': {
  80         'short': 'Build Commands',
  81         'long': 'Interact with the build system',
  82         'priority': 80,
  83     },
  84     'post-build': {
  85         'short': 'Post-build Commands',
  86         'long': 'Common actions performed after completing a build.',
  87         'priority': 70,
  88     },
  89     'testing': {
  90         'short': 'Testing',
  91         'long': 'Run tests.',
  92         'priority': 60,
  93     },
  94     'ci': {
  95         'short': 'CI',
  96         'long': 'Taskcluster commands',
  97         'priority': 59,
  98     },
  99     'devenv': {
 100         'short': 'Development Environment',
 101         'long': 'Set up and configure your development environment.',
 102         'priority': 50,
 103     },
 104     'build-dev': {
 105         'short': 'Low-level Build System Interaction',
 106         'long': 'Interact with specific parts of the build system.',
 107         'priority': 20,
 108     },
 109     'misc': {
 110         'short': 'Potpourri',
 111         'long': 'Potent potables and assorted snacks.',
 112         'priority': 10,
 113     },
 114     'release': {
 115         'short': 'Release automation',
 116         'long': 'Commands for used in release automation.',
 117         'priority': 5,
 118     },
 119     'disabled': {
 120         'short': 'Disabled',
 121         'long': 'The disabled commands are hidden by default. Use -v to display them. '
 122         'These commands are unavailable for your current context, '
 123         'run "mach <command>" to see why.',
 124         'priority': 0,
 125     },
 126 }
 127
 128
 129 def search_path(mozilla_dir, packages_txt):
 130     with open(os.path.join(mozilla_dir, packages_txt)) as f:
 131         packages = [line.rstrip().split(':') for line in f]
 132
 133     def handle_package(package):
 134         if package[0] == 'optional':
 135             try:
 136                 for path in handle_package(package[1:]):
 137                     yield path
 138             except Exception:
 139                 pass
 140
 141         if package[0] in ('windows', '!windows'):
 142             for_win = not package[0].startswith('!')
 143             is_win = sys.platform == 'win32'
 144             if is_win == for_win:
 145                 for path in handle_package(package[1:]):
 146                     yield path
 147
 148         if package[0] in ('python2', 'python3'):
 149             for_python3 = package[0].endswith('3')
 150             is_python3 = sys.version_info[0] > 2
 151             if is_python3 == for_python3:
 152                 for path in handle_package(package[1:]):
 153                     yield path
 154
 155         if package[0] == 'packages.txt':
 156             assert len(package) == 2
 157             for p in search_path(mozilla_dir, package[1]):
 158                 yield os.path.join(mozilla_dir, p)
 159
 160         if package[0].endswith('.pth'):
 161             assert len(package) == 2
 162             yield os.path.join(mozilla_dir, package[1])
 163
 164     for package in packages:
 165         for path in handle_package(package):
 166             yield path
 167
 168
 169 def bootstrap(topsrcdir, mozilla_dir=None):
 170     if mozilla_dir is None:
 171         mozilla_dir = topsrcdir
 172
 173     # Ensure we are running Python 2.7+. We put this check here so we generate a
 174     # user-friendly error message rather than a cryptic stack trace on module
 175     # import.
 176     if sys.version_info[0] != 2 or sys.version_info[1] < 7:
 177         print('Python 2.7 or above (but not Python 3) is required to run mach.')
 178         print('You are running Python', platform.python_version())
 179         sys.exit(1)
 180
 181     # Global build system and mach state is stored in a central directory. By
 182     # default, this is ~/.mozbuild. However, it can be defined via an
 183     # environment variable. We detect first run (by lack of this directory
 184     # existing) and notify the user that it will be created. The logic for
 185     # creation is much simpler for the "advanced" environment variable use
 186     # case. For default behavior, we educate users and give them an opportunity
 187     # to react. We always exit after creating the directory because users don't
 188     # like surprises.
 189     sys.path[0:0] = [os.path.join(mozilla_dir, path)
 190                      for path in search_path(mozilla_dir,
 191                                              'build/virtualenv_packages.txt')]
 192     import mach.base
 193     import mach.main
 194     from mozboot.util import get_state_dir
 195
 196     from mozbuild.util import patch_main
 197     patch_main()
 198
 199     def resolve_repository():
 200         import mozversioncontrol
 201
 202         try:
 203             # This API doesn't respect the vcs binary choices from configure.
 204             # If we ever need to use the VCS binary here, consider something
 205             # more robust.
 206             return mozversioncontrol.get_repository_object(path=mozilla_dir)
 207         except (mozversioncontrol.InvalidRepoPath,
 208                 mozversioncontrol.MissingVCSTool):
 209             return None
 210
 211     def should_skip_telemetry_submission(handler):
 212         # The user is performing a maintenance command.
 213         if handler.name in ('bootstrap', 'doctor', 'mach-commands', 'vcs-setup',
 214                             # We call mach environment in client.mk which would cause the
 215                             # data submission to block the forward progress of make.
 216                             'environment'):
 217             return True
 218
 219         # Never submit data when running in automation or when running tests.
 220         if any(e in os.environ for e in ('MOZ_AUTOMATION', 'TASK_ID', 'MACH_TELEMETRY_NO_SUBMIT')):
 221             return True
 222
 223         return False
 224
 225     def post_dispatch_handler(context, handler, instance, result,
 226                               start_time, end_time, depth, args):
 227         """Perform global operations after command dispatch.
 228
 229
 230         For now,  we will use this to handle build system telemetry.
 231         """
 232         # Don't write telemetry data if this mach command was invoked as part of another
 233         # mach command.
 234         if depth != 1 or os.environ.get('MACH_MAIN_PID') != str(os.getpid()):
 235             return
 236
 237         # Don't write telemetry data for 'mach' when 'DISABLE_TELEMETRY' is set.
 238         if os.environ.get('DISABLE_TELEMETRY') == '1':
 239             return
 240
 241         # We have not opted-in to telemetry
 242         if not context.settings.build.telemetry:
 243             return
 244
 245         from mozbuild.telemetry import gather_telemetry
 246         from mozbuild.base import MozbuildObject
 247         import mozpack.path as mozpath
 248
 249         if not isinstance(instance, MozbuildObject):
 250             instance = MozbuildObject.from_environment()
 251
 252         try:
 253             substs = instance.substs
 254         except Exception:
 255             substs = {}
 256
 257         command_attrs = getattr(context, 'command_attrs', {})
 258
 259         # We gather telemetry for every operation.
 260         paths = {
 261             instance.topsrcdir: '$topsrcdir/',
 262             instance.topobjdir: '$topobjdir/',
 263             mozpath.normpath(os.path.expanduser('~')): '$HOME/',
 264         }
 265         # This might override one of the existing entries, that's OK.
 266         # We don't use a sigil here because we treat all arguments as potentially relative
 267         # paths, so we'd like to get them back as they were specified.
 268         paths[mozpath.normpath(os.getcwd())] = ''
 269         data = gather_telemetry(command=handler.name, success=(result == 0),
 270                                 start_time=start_time, end_time=end_time,
 271                                 mach_context=context, substs=substs,
 272                                 command_attrs=command_attrs, paths=paths)
 273         if data:
 274             telemetry_dir = os.path.join(get_state_dir(), 'telemetry')
 275             try:
 276                 os.mkdir(telemetry_dir)
 277             except OSError as e:
 278                 if e.errno != errno.EEXIST:
 279                     raise
 280             outgoing_dir = os.path.join(telemetry_dir, 'outgoing')
 281             try:
 282                 os.mkdir(outgoing_dir)
 283             except OSError as e:
 284                 if e.errno != errno.EEXIST:
 285                     raise
 286
 287             with open(os.path.join(outgoing_dir, str(uuid.uuid4()) + '.json'),
 288                       'w') as f:
 289                 json.dump(data, f, sort_keys=True)
 290
 291         if should_skip_telemetry_submission(handler):
 292             return True
 293
 294         state_dir = get_state_dir()
 295
 296         machpath = os.path.join(instance.topsrcdir, 'mach')
 297         with open(os.devnull, 'wb') as devnull:
 298             subprocess.Popen([sys.executable, machpath, 'python',
 299                               '--no-virtualenv',
 300                               os.path.join(topsrcdir, 'build',
 301                                            'submit_telemetry_data.py'),
 302                               state_dir],
 303                              stdout=devnull, stderr=devnull)
 304
 305     def populate_context(context, key=None):
 306         if key is None:
 307             return
 308         if key == 'state_dir':
 309             state_dir = get_state_dir()
 310             if state_dir == os.environ.get('MOZBUILD_STATE_PATH'):
 311                 if not os.path.exists(state_dir):
 312                     print('Creating global state directory from environment variable: %s'
 313                           % state_dir)
 314                     os.makedirs(state_dir, mode=0o770)
 315             else:
 316                 if not os.path.exists(state_dir):
 317                     if not os.environ.get('MOZ_AUTOMATION'):
 318                         print(STATE_DIR_FIRST_RUN.format(userdir=state_dir))
 319                         try:
 320                             sys.stdin.readline()
 321                         except KeyboardInterrupt:
 322                             sys.exit(1)
 323
 324                     print('\nCreating default state directory: %s' % state_dir)
 325                     os.makedirs(state_dir, mode=0o770)
 326
 327             return state_dir
 328
 329         if key == 'local_state_dir':
 330             return get_state_dir(srcdir=True)
 331
 332         if key == 'topdir':
 333             return topsrcdir
 334
 335         if key == 'post_dispatch_handler':
 336             return post_dispatch_handler
 337
 338         if key == 'repository':
 339             return resolve_repository()
 340
 341         raise AttributeError(key)
 342
 343     # Note which process is top-level so that recursive mach invocations can avoid writing
 344     # telemetry data.
 345     if 'MACH_MAIN_PID' not in os.environ:
 346         os.environ[b'MACH_MAIN_PID'] = str(os.getpid()).encode('ascii')
 347
 348     driver = mach.main.Mach(os.getcwd())
 349     driver.populate_context_handler = populate_context
 350
 351     if not driver.settings_paths:
 352         # default global machrc location
 353         driver.settings_paths.append(get_state_dir())
 354     # always load local repository configuration
 355     driver.settings_paths.append(mozilla_dir)
 356
 357     for category, meta in CATEGORIES.items():
 358         driver.define_category(category, meta['short'], meta['long'],
 359                                meta['priority'])
 360
 361     repo = resolve_repository()
 362
 363     for path in MACH_MODULES:
 364         # Sparse checkouts may not have all mach_commands.py files. Ignore
 365         # errors from missing files.
 366         try:
 367             driver.load_commands_from_file(os.path.join(mozilla_dir, path))
 368         except mach.base.MissingFileError:
 369             if not repo or not repo.sparse_checkout_present():
 370                 raise
 371
 372     return driver
 373
 374
 375 # Hook import such that .pyc/.pyo files without a corresponding .py file in
 376 # the source directory are essentially ignored. See further below for details
 377 # and caveats.
 378 # Objdirs outside the source directory are ignored because in most cases, if
 379 # a .pyc/.pyo file exists there, a .py file will be next to it anyways.
 380 class ImportHook(object):
 381     def __init__(self, original_import):
 382         self._original_import = original_import
 383         # Assume the source directory is the parent directory of the one
 384         # containing this file.
 385         self._source_dir = os.path.normcase(os.path.abspath(
 386             os.path.dirname(os.path.dirname(__file__)))) + os.sep
 387         self._modules = set()
 388
 389     def __call__(self, name, globals=None, locals=None, fromlist=None,
 390                  level=-1):
 391         # name might be a relative import. Instead of figuring out what that
 392         # resolves to, which is complex, just rely on the real import.
 393         # Since we don't know the full module name, we can't check sys.modules,
 394         # so we need to keep track of which modules we've already seen to avoid
 395         # to stat() them again when they are imported multiple times.
 396         module = self._original_import(name, globals, locals, fromlist, level)
 397
 398         # Some tests replace modules in sys.modules with non-module instances.
 399         if not isinstance(module, ModuleType):
 400             return module
 401
 402         resolved_name = module.__name__
 403         if resolved_name in self._modules:
 404             return module
 405         self._modules.add(resolved_name)
 406
 407         # Builtin modules don't have a __file__ attribute.
 408         if not hasattr(module, '__file__'):
 409             return module
 410
 411         # Note: module.__file__ is not always absolute.
 412         path = os.path.normcase(os.path.abspath(module.__file__))
 413         # Note: we could avoid normcase and abspath above for non pyc/pyo
 414         # files, but those are actually rare, so it doesn't really matter.
 415         if not path.endswith(('.pyc', '.pyo')):
 416             return module
 417
 418         # Ignore modules outside our source directory
 419         if not path.startswith(self._source_dir):
 420             return module
 421
 422         # If there is no .py corresponding to the .pyc/.pyo module we're
 423         # loading, remove the .pyc/.pyo file, and reload the module.
 424         # Since we already loaded the .pyc/.pyo module, if it had side
 425         # effects, they will have happened already, and loading the module
 426         # with the same name, from another directory may have the same side
 427         # effects (or different ones). We assume it's not a problem for the
 428         # python modules under our source directory (either because it
 429         # doesn't happen or because it doesn't matter).
 430         if not os.path.exists(module.__file__[:-1]):
 431             if os.path.exists(module.__file__):
 432                 os.remove(module.__file__)
 433             del sys.modules[module.__name__]
 434             module = self(name, globals, locals, fromlist, level)
 435
 436         return module
 437
 438
 439 # Install our hook
 440 builtins.__import__ = ImportHook(builtins.__import__)