[Telemetry] Always uploading browser log if enabled instead of wait for crash to...
[chromium-blink-merge.git] / testing / test_env.py
blob052df6769b262c442a5b8721ae38c166c659c0b8
1 #!/usr/bin/env python
2 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
3 # Use of this source code is governed by a BSD-style license that can be
4 # found in the LICENSE file.
6 """Sets environment variables needed to run a chromium unit test."""
8 import os
9 import stat
10 import subprocess
11 import sys
13 # This is hardcoded to be src/ relative to this script.
14 ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
16 CHROME_SANDBOX_ENV = 'CHROME_DEVEL_SANDBOX'
17 CHROME_SANDBOX_PATH = '/opt/chromium/chrome_sandbox'
20 def get_sandbox_env(env):
21 """Returns the environment flags needed for the SUID sandbox to work."""
22 extra_env = {}
23 chrome_sandbox_path = env.get(CHROME_SANDBOX_ENV, CHROME_SANDBOX_PATH)
24 # The above would silently disable the SUID sandbox if the env value were
25 # an empty string. We don't want to allow that. http://crbug.com/245376
26 # TODO(jln): Remove this check once it's no longer possible to disable the
27 # sandbox that way.
28 if not chrome_sandbox_path:
29 chrome_sandbox_path = CHROME_SANDBOX_PATH
30 extra_env[CHROME_SANDBOX_ENV] = chrome_sandbox_path
32 return extra_env
35 def trim_cmd(cmd):
36 """Removes internal flags from cmd since they're just used to communicate from
37 the host machine to this script running on the swarm slaves."""
38 sanitizers = ['asan', 'lsan', 'msan', 'tsan']
39 internal_flags = frozenset('--%s=%d' % (name, value)
40 for name in sanitizers
41 for value in [0, 1])
42 return [i for i in cmd if i not in internal_flags]
45 def fix_python_path(cmd):
46 """Returns the fixed command line to call the right python executable."""
47 out = cmd[:]
48 if out[0] == 'python':
49 out[0] = sys.executable
50 elif out[0].endswith('.py'):
51 out.insert(0, sys.executable)
52 return out
55 def get_sanitizer_env(cmd, asan, lsan, msan, tsan):
56 """Returns the envirnoment flags needed for sanitizer tools."""
58 extra_env = {}
60 # Instruct GTK to use malloc while running sanitizer-instrumented tests.
61 extra_env['G_SLICE'] = 'always-malloc'
63 extra_env['NSS_DISABLE_ARENA_FREE_LIST'] = '1'
64 extra_env['NSS_DISABLE_UNLOAD'] = '1'
66 # TODO(glider): remove the symbolizer path once
67 # https://code.google.com/p/address-sanitizer/issues/detail?id=134 is fixed.
68 symbolizer_path = os.path.abspath(os.path.join(ROOT_DIR, 'third_party',
69 'llvm-build', 'Release+Asserts', 'bin', 'llvm-symbolizer'))
71 if lsan or tsan:
72 # LSan is not sandbox-compatible, so we can use online symbolization. In
73 # fact, it needs symbolization to be able to apply suppressions.
74 symbolization_options = ['symbolize=1',
75 'external_symbolizer_path=%s' % symbolizer_path]
76 elif (asan or msan) and sys.platform not in ['win32', 'cygwin']:
77 # ASan uses a script for offline symbolization, except on Windows.
78 # Important note: when running ASan with leak detection enabled, we must use
79 # the LSan symbolization options above.
80 symbolization_options = ['symbolize=0']
81 # Set the path to llvm-symbolizer to be used by asan_symbolize.py
82 extra_env['LLVM_SYMBOLIZER_PATH'] = symbolizer_path
83 else:
84 symbolization_options = []
86 if asan:
87 asan_options = symbolization_options[:]
88 if lsan:
89 asan_options.append('detect_leaks=1')
91 if asan_options:
92 extra_env['ASAN_OPTIONS'] = ' '.join(asan_options)
94 if sys.platform == 'darwin':
95 isolate_output_dir = os.path.abspath(os.path.dirname(cmd[0]))
96 # This is needed because the test binary has @executable_path embedded in
97 # it that the OS tries to resolve to the cache directory and not the
98 # mapped directory.
99 extra_env['DYLD_LIBRARY_PATH'] = str(isolate_output_dir)
101 if lsan:
102 if asan or msan:
103 lsan_options = []
104 else:
105 lsan_options = symbolization_options[:]
106 if sys.platform == 'linux2':
107 # Use the debug version of libstdc++ under LSan. If we don't, there will
108 # be a lot of incomplete stack traces in the reports.
109 extra_env['LD_LIBRARY_PATH'] = '/usr/lib/x86_64-linux-gnu/debug:'
111 extra_env['LSAN_OPTIONS'] = ' '.join(lsan_options)
113 if msan:
114 msan_options = symbolization_options[:]
115 if lsan:
116 msan_options.append('detect_leaks=1')
117 extra_env['MSAN_OPTIONS'] = ' '.join(msan_options)
119 if tsan:
120 tsan_options = symbolization_options[:]
121 extra_env['TSAN_OPTIONS'] = ' '.join(tsan_options)
123 return extra_env
126 def get_sanitizer_symbolize_command(json_path=None, executable_path=None):
127 """Construct the command to invoke offline symbolization script."""
128 script_path = '../tools/valgrind/asan/asan_symbolize.py'
129 cmd = [sys.executable, script_path]
130 if json_path is not None:
131 cmd.append('--test-summary-json-file=%s' % json_path)
132 if executable_path is not None:
133 cmd.append('--executable-path=%s' % executable_path)
134 return cmd
137 def get_json_path(cmd):
138 """Extract the JSON test summary path from a command line."""
139 json_path_flag = '--test-launcher-summary-output='
140 for arg in cmd:
141 if arg.startswith(json_path_flag):
142 return arg.split(json_path_flag).pop()
143 return None
146 def symbolize_snippets_in_json(cmd, env):
147 """Symbolize output snippets inside the JSON test summary."""
148 json_path = get_json_path(cmd)
149 if json_path is None:
150 return
152 try:
153 symbolize_command = get_sanitizer_symbolize_command(
154 json_path=json_path, executable_path=cmd[0])
155 p = subprocess.Popen(symbolize_command, stderr=subprocess.PIPE, env=env)
156 (_, stderr) = p.communicate()
157 except OSError as e:
158 print 'Exception while symbolizing snippets: %s' % e
160 if p.returncode != 0:
161 print "Error: failed to symbolize snippets in JSON:\n"
162 print stderr
165 def run_executable(cmd, env):
166 """Runs an executable with:
167 - environment variable CR_SOURCE_ROOT set to the root directory.
168 - environment variable LANGUAGE to en_US.UTF-8.
169 - environment variable CHROME_DEVEL_SANDBOX set
170 - Reuses sys.executable automatically.
172 extra_env = {}
173 # Many tests assume a English interface...
174 extra_env['LANG'] = 'en_US.UTF-8'
175 # Used by base/base_paths_linux.cc as an override. Just make sure the default
176 # logic is used.
177 env.pop('CR_SOURCE_ROOT', None)
178 extra_env.update(get_sandbox_env(env))
180 # Copy logic from tools/build/scripts/slave/runtest.py.
181 asan = '--asan=1' in cmd
182 lsan = '--lsan=1' in cmd
183 msan = '--msan=1' in cmd
184 tsan = '--tsan=1' in cmd
185 if sys.platform in ['win32', 'cygwin']:
186 # Symbolization works in-process on Windows even when sandboxed.
187 use_symbolization_script = False
188 else:
189 # LSan doesn't support sandboxing yet, so we use the in-process symbolizer.
190 # Note that ASan and MSan can work together with LSan.
191 use_symbolization_script = (asan or msan) and not lsan
193 if asan or lsan or msan or tsan:
194 extra_env.update(get_sanitizer_env(cmd, asan, lsan, msan, tsan))
196 if lsan or tsan:
197 # LSan and TSan are not sandbox-friendly.
198 cmd.append('--no-sandbox')
200 cmd = trim_cmd(cmd)
202 # Ensure paths are correctly separated on windows.
203 cmd[0] = cmd[0].replace('/', os.path.sep)
204 cmd = fix_python_path(cmd)
206 print('Additional test environment:\n%s\n'
207 'Command: %s\n' % (
208 '\n'.join(' %s=%s' %
209 (k, v) for k, v in sorted(extra_env.iteritems())),
210 ' '.join(cmd)))
211 env.update(extra_env or {})
212 try:
213 # See above comment regarding offline symbolization.
214 if use_symbolization_script:
215 # Need to pipe to the symbolizer script.
216 p1 = subprocess.Popen(cmd, env=env, stdout=subprocess.PIPE,
217 stderr=sys.stdout)
218 p2 = subprocess.Popen(
219 get_sanitizer_symbolize_command(executable_path=cmd[0]),
220 env=env, stdin=p1.stdout)
221 p1.stdout.close() # Allow p1 to receive a SIGPIPE if p2 exits.
222 p1.wait()
223 p2.wait()
224 # Also feed the out-of-band JSON output to the symbolizer script.
225 symbolize_snippets_in_json(cmd, env)
226 return p1.returncode
227 else:
228 return subprocess.call(cmd, env=env)
229 except OSError:
230 print >> sys.stderr, 'Failed to start %s' % cmd
231 raise
234 def main():
235 return run_executable(sys.argv[1:], os.environ.copy())
238 if __name__ == '__main__':
239 sys.exit(main())