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/.
5 from __future__
import print_function
, unicode_literals
13 STATE_DIR_FIRST_RUN
= '''
14 mach and the build system store shared state in a common directory on the
15 filesystem. The following directory will be created:
19 If you would like to use a different directory, hit CTRL+c and set the
20 MOZBUILD_STATE_PATH environment variable to the directory you would like to
21 use and re-run mach. For this change to take effect forever, you'll likely
22 want to export this environment variable from your shell's init scripts.
26 # TODO Bug 794506 Integrate with the in-tree virtualenv configuration.
31 'python/mozversioncontrol',
40 'dom/bindings/parser',
41 'layout/tools/reftest',
46 'testing/web-platform',
47 'testing/web-platform/harness',
48 'testing/marionette/client/marionette',
49 'testing/marionette/transport',
50 'testing/mozbase/mozcrash',
51 'testing/mozbase/mozdebug',
52 'testing/mozbase/mozdevice',
53 'testing/mozbase/mozfile',
54 'testing/mozbase/mozhttpd',
55 'testing/mozbase/mozlog',
56 'testing/mozbase/moznetwork',
57 'testing/mozbase/mozprocess',
58 'testing/mozbase/mozprofile',
59 'testing/mozbase/mozrunner',
60 'testing/mozbase/mozsystemmonitor',
61 'testing/mozbase/mozinfo',
62 'testing/mozbase/moztest',
63 'testing/mozbase/mozversion',
64 'testing/mozbase/manifestparser',
68 # Individual files providing mach commands.
70 'addon-sdk/mach_commands.py',
71 'build/valgrind/mach_commands.py',
72 'dom/bindings/mach_commands.py',
73 'layout/tools/reftest/mach_commands.py',
74 'python/mach_commands.py',
75 'python/mach/mach/commands/commandinfo.py',
76 'python/mozboot/mozboot/mach_commands.py',
77 'python/mozbuild/mozbuild/mach_commands.py',
78 'python/mozbuild/mozbuild/frontend/mach_commands.py',
79 'services/common/tests/mach_commands.py',
80 'testing/mach_commands.py',
81 'testing/marionette/mach_commands.py',
82 'testing/mochitest/mach_commands.py',
83 'testing/xpcshell/mach_commands.py',
84 'testing/talos/mach_commands.py',
85 'testing/web-platform/mach_commands.py',
86 'testing/xpcshell/mach_commands.py',
87 'tools/docs/mach_commands.py',
88 'tools/mercurial/mach_commands.py',
89 'tools/mach_commands.py',
95 'short': 'Build Commands',
96 'long': 'Interact with the build system',
100 'short': 'Post-build Commands',
101 'long': 'Common actions performed after completing a build.',
106 'long': 'Run tests.',
110 'short': 'Development Environment',
111 'long': 'Set up and configure your development environment.',
115 'short': 'Low-level Build System Interaction',
116 'long': 'Interact with specific parts of the build system.',
120 'short': 'Potpourri',
121 'long': 'Potent potables and assorted snacks.',
126 '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.',
132 def bootstrap(topsrcdir
, mozilla_dir
=None):
133 if mozilla_dir
is None:
134 mozilla_dir
= topsrcdir
136 # Ensure we are running Python 2.7+. We put this check here so we generate a
137 # user-friendly error message rather than a cryptic stack trace on module
139 if sys
.version_info
[0] != 2 or sys
.version_info
[1] < 7:
140 print('Python 2.7 or above (but not Python 3) is required to run mach.')
141 print('You are running Python', platform
.python_version())
144 # Global build system and mach state is stored in a central directory. By
145 # default, this is ~/.mozbuild. However, it can be defined via an
146 # environment variable. We detect first run (by lack of this directory
147 # existing) and notify the user that it will be created. The logic for
148 # creation is much simpler for the "advanced" environment variable use
149 # case. For default behavior, we educate users and give them an opportunity
150 # to react. We always exit after creating the directory because users don't
155 sys
.path
[0:0] = [os
.path
.join(mozilla_dir
, path
) for path
in SEARCH_PATHS
]
158 def populate_context(context
, key
=None):
161 if key
== 'state_dir':
162 state_user_dir
= os
.path
.expanduser('~/.mozbuild')
163 state_env_dir
= os
.environ
.get('MOZBUILD_STATE_PATH', None)
165 if not os
.path
.exists(state_env_dir
):
166 print('Creating global state directory from environment variable: %s'
168 os
.makedirs(state_env_dir
, mode
=0o770)
169 print('Please re-run mach.')
171 state_dir
= state_env_dir
173 if not os
.path
.exists(state_user_dir
):
174 print(STATE_DIR_FIRST_RUN
.format(userdir
=state_user_dir
))
176 for i
in range(20, -1, -1):
178 sys
.stdout
.write('%d ' % i
)
180 except KeyboardInterrupt:
183 print('\nCreating default state directory: %s' % state_user_dir
)
184 os
.mkdir(state_user_dir
)
185 print('Please re-run mach.')
187 state_dir
= state_user_dir
192 raise AttributeError(key
)
194 mach
= mach
.main
.Mach(os
.getcwd())
195 mach
.populate_context_handler
= populate_context
197 for category
, meta
in CATEGORIES
.items():
198 mach
.define_category(category
, meta
['short'], meta
['long'],
201 for path
in MACH_MODULES
:
202 mach
.load_commands_from_file(os
.path
.join(mozilla_dir
, path
))