| #!/usr/bin/env python |
| # Copyright 2012 The Chromium Authors |
| # Use of this source code is governed by a BSD-style license that can be |
| # found in the LICENSE file. |
| """Sets environment variables needed to run a chromium unit test.""" |
| |
| from __future__import print_function |
| import io |
| import os |
| import signal |
| import subprocess |
| import sys |
| import time |
| |
| # This is hardcoded to be src/ relative to this script. |
| ROOT_DIR= os.path.dirname(os.path.dirname(os.path.abspath(__file__))) |
| |
| |
| def trim_cmd(cmd): |
| """Removes internal flags from cmd since they're just used to communicate from |
| the host machine to this script running on the swarm slaves.""" |
| sanitizers=[ |
| 'asan','lsan','msan','tsan','coverage-continuous-mode', |
| 'skip-set-lpac-acls' |
| ] |
| internal_flags= frozenset('--%s=%d'%(name, value)for namein sanitizers |
| for valuein[0,1]) |
| return[ifor iin cmdif inotin internal_flags] |
| |
| |
| def fix_python_path(cmd): |
| """Returns the fixed command line to call the right python executable.""" |
| out= cmd[:] |
| if out[0]=='python': |
| out[0]= sys.executable |
| elif out[0].endswith('.py'): |
| out.insert(0, sys.executable) |
| return out |
| |
| |
| def get_sanitizer_env(asan, lsan, msan, tsan, cfi_diag): |
| """Returns the environment flags needed for sanitizer tools.""" |
| |
| extra_env={} |
| |
| # Instruct GTK to use malloc while running sanitizer-instrumented tests. |
| extra_env['G_SLICE']='always-malloc' |
| |
| extra_env['NSS_DISABLE_ARENA_FREE_LIST']='1' |
| extra_env['NSS_DISABLE_UNLOAD']='1' |
| |
| # TODO(glider): remove the symbolizer path once |
| # https://code.google.com/p/address-sanitizer/issues/detail?id=134 is fixed. |
| symbolizer_path= os.path.join(ROOT_DIR,'third_party','llvm-build', |
| 'Release+Asserts','bin','llvm-symbolizer') |
| |
| if lsanor tsan: |
| # LSan is not sandbox-compatible, so we can use online symbolization. In |
| # fact, it needs symbolization to be able to apply suppressions. |
| symbolization_options=[ |
| 'symbolize=1', |
| 'external_symbolizer_path=%s'% symbolizer_path |
| ] |
| elif(asanor msanor cfi_diag)and sys.platformnotin['win32','cygwin']: |
| # ASan uses a script for offline symbolization, except on Windows. |
| # Important note: when running ASan with leak detection enabled, we must use |
| # the LSan symbolization options above. |
| symbolization_options=['symbolize=0'] |
| # Set the path to llvm-symbolizer to be used by asan_symbolize.py |
| extra_env['LLVM_SYMBOLIZER_PATH']= symbolizer_path |
| else: |
| symbolization_options=[] |
| |
| # Leverage sanitizer to print stack trace on abort (e.g. assertion failure). |
| symbolization_options.append('handle_abort=1') |
| |
| if asan: |
| asan_options= symbolization_options[:] |
| if lsan: |
| asan_options.append('detect_leaks=1') |
| # LSan appears to have trouble with later versions of glibc. |
| # See https://github.com/google/sanitizers/issues/1322 |
| if'linux'in sys.platform: |
| asan_options.append('intercept_tls_get_addr=0') |
| |
| if asan_options: |
| extra_env['ASAN_OPTIONS']=' '.join(asan_options) |
| |
| if lsan: |
| if asanor msan: |
| lsan_options=[] |
| else: |
| lsan_options= symbolization_options[:] |
| if sys.platform=='linux2': |
| # Use the debug version of libstdc++ under LSan. If we don't, there will |
| # be a lot of incomplete stack traces in the reports. |
| extra_env['LD_LIBRARY_PATH']='/usr/lib/x86_64-linux-gnu/debug:' |
| |
| extra_env['LSAN_OPTIONS']=' '.join(lsan_options) |
| |
| if msan: |
| msan_options= symbolization_options[:] |
| if lsan: |
| msan_options.append('detect_leaks=1') |
| extra_env['MSAN_OPTIONS']=' '.join(msan_options) |
| extra_env['VK_ICD_FILENAMES']='' |
| extra_env['LIBGL_DRIVERS_PATH']='' |
| |
| if tsan: |
| tsan_options= symbolization_options[:] |
| extra_env['TSAN_OPTIONS']=' '.join(tsan_options) |
| |
| # CFI uses the UBSan runtime to provide diagnostics. |
| if cfi_diag: |
| ubsan_options= symbolization_options[:]+['print_stacktrace=1'] |
| extra_env['UBSAN_OPTIONS']=' '.join(ubsan_options) |
| |
| return extra_env |
| |
| |
| def get_coverage_continuous_mode_env(env): |
| """Append %c (clang code coverage continuous mode) flag to LLVM_PROFILE_FILE |
| pattern string.""" |
| llvm_profile_file= env.get('LLVM_PROFILE_FILE') |
| ifnot llvm_profile_file: |
| return{} |
| |
| # Do not insert %c into LLVM_PROFILE_FILE if it's already there as that'll |
| # cause the coverage instrumentation to write coverage data to default.profraw |
| # instead of LLVM_PROFILE_FILE. |
| if'%c'in llvm_profile_file: |
| return{'LLVM_PROFILE_FILE': llvm_profile_file} |
| |
| dirname, basename= os.path.split(llvm_profile_file) |
| root, ext= os.path.splitext(basename) |
| |
| return{'LLVM_PROFILE_FILE': os.path.join(dirname, root+'%c'+ ext)} |
| |
| |
| def get_sanitizer_symbolize_command(json_path=None, executable_path=None): |
| """Construct the command to invoke offline symbolization script.""" |
| script_path= os.path.join(ROOT_DIR,'tools','valgrind','asan', |
| 'asan_symbolize.py') |
| cmd=[sys.executable, script_path] |
| if json_pathisnotNone: |
| cmd.append('--test-summary-json-file=%s'% json_path) |
| if executable_pathisnotNone: |
| cmd.append('--executable-path=%s'% executable_path) |
| return cmd |
| |
| |
| def get_json_path(cmd): |
| """Extract the JSON test summary path from a command line.""" |
| json_path_flag='--test-launcher-summary-output=' |
| for argin cmd: |
| if arg.startswith(json_path_flag): |
| return arg.split(json_path_flag).pop() |
| returnNone |
| |
| |
| def symbolize_snippets_in_json(cmd, env): |
| """Symbolize output snippets inside the JSON test summary.""" |
| json_path= get_json_path(cmd) |
| if json_pathisNone: |
| return |
| |
| try: |
| symbolize_command= get_sanitizer_symbolize_command(json_path=json_path, |
| executable_path=cmd[0]) |
| p= subprocess.Popen(symbolize_command, stderr=subprocess.PIPE, env=env) |
| (_, stderr)= p.communicate() |
| exceptOSErroras e: |
| print('Exception while symbolizing snippets: %s'% e, file=sys.stderr) |
| raise |
| |
| if p.returncode!=0: |
| print('Error: failed to symbolize snippets in JSON:\n', file=sys.stderr) |
| print(stderr, file=sys.stderr) |
| raise subprocess.CalledProcessError(p.returncode, symbolize_command) |
| |
| |
| def get_escalate_sanitizer_warnings_command(json_path): |
| """Construct the command to invoke sanitizer warnings script.""" |
| script_path= os.path.join(ROOT_DIR,'tools','memory','sanitizer', |
| 'escalate_sanitizer_warnings.py') |
| cmd=[sys.executable, script_path] |
| cmd.append('--test-summary-json-file=%s'% json_path) |
| return cmd |
| |
| |
| def escalate_sanitizer_warnings_in_json(cmd, env): |
| """Escalate sanitizer warnings inside the JSON test summary.""" |
| json_path= get_json_path(cmd) |
| if json_pathisNone: |
| print( |
| 'Warning: Cannot escalate sanitizer warnings without a json summary ' |
| 'file:\n', |
| file=sys.stderr) |
| return0 |
| |
| try: |
| escalate_command= get_escalate_sanitizer_warnings_command(json_path) |
| p= subprocess.Popen(escalate_command, stderr=subprocess.PIPE, env=env) |
| (_, stderr)= p.communicate() |
| exceptOSErroras e: |
| print('Exception while escalating sanitizer warnings: %s'% e, |
| file=sys.stderr) |
| raise |
| |
| if p.returncode!=0: |
| print('Error: failed to escalate sanitizer warnings status in JSON:\n', |
| file=sys.stderr) |
| print(stderr, file=sys.stderr) |
| return p.returncode |
| |
| |
| def run_command_with_output(argv, stdoutfile, env=None, cwd=None): |
| """Run command and stream its stdout/stderr to the console & |stdoutfile|. |
| |
| Also forward_signals to obey |
| https://chromium.googlesource.com/infra/luci/luci-py/+/main/appengine/swarming/doc/Bot.md#graceful-termination_aka-the-sigterm-and-sigkill-dance |
| |
| Returns: |
| integer returncode of the subprocess. |
| """ |
| print('Running %r in %r (env: %r)'%(argv, cwd, env), file=sys.stderr) |
| assert stdoutfile |
| with io.open(stdoutfile,'wb')as writer, \ |
| io.open(stdoutfile,'rb',1)as reader: |
| process= _popen(argv, |
| env=env, |
| cwd=cwd, |
| stdout=writer, |
| stderr=subprocess.STDOUT) |
| forward_signals([process]) |
| while process.poll()isNone: |
| sys.stdout.write(reader.read().decode('utf-8')) |
| # This sleep is needed for signal propagation. See the |
| # wait_with_signals() docstring. |
| time.sleep(0.1) |
| # Read the remaining. |
| sys.stdout.write(reader.read().decode('utf-8')) |
| print('Command %r returned exit code %d'%(argv, process.returncode), |
| file=sys.stderr) |
| return process.returncode |
| |
| |
| def run_command(argv, env=None, cwd=None, log=True): |
| """Run command and stream its stdout/stderr both to stdout. |
| |
| Also forward_signals to obey |
| https://chromium.googlesource.com/infra/luci/luci-py/+/main/appengine/swarming/doc/Bot.md#graceful-termination_aka-the-sigterm-and-sigkill-dance |
| |
| Returns: |
| integer returncode of the subprocess. |
| """ |
| if log: |
| print('Running %r in %r (env: %r)'%(argv, cwd, env), file=sys.stderr) |
| process= _popen(argv, env=env, cwd=cwd, stderr=subprocess.STDOUT) |
| forward_signals([process]) |
| exit_code= wait_with_signals(process) |
| if log: |
| print('Command returned exit code %d'% exit_code, file=sys.stderr) |
| return exit_code |
| |
| |
| def run_command_output_to_handle(argv, file_handle, env=None, cwd=None): |
| """Run command and stream its stdout/stderr both to |file_handle|. |
| |
| Also forward_signals to obey |
| https://chromium.googlesource.com/infra/luci/luci-py/+/main/appengine/swarming/doc/Bot.md#graceful-termination_aka-the-sigterm-and-sigkill-dance |
| |
| Returns: |
| integer returncode of the subprocess. |
| """ |
| print('Running %r in %r (env: %r)'%(argv, cwd, env)) |
| process= _popen(argv, |
| env=env, |
| cwd=cwd, |
| stderr=file_handle, |
| stdout=file_handle) |
| forward_signals([process]) |
| exit_code= wait_with_signals(process) |
| print('Command returned exit code %d'% exit_code) |
| return exit_code |
| |
| |
| def wait_with_signals(process): |
| """A version of process.wait() that works cross-platform. |
| |
| This version properly surfaces the SIGBREAK signal. |
| |
| From reading the subprocess.py source code, it seems we need to explicitly |
| call time.sleep(). The reason is that subprocess.Popen.wait() on Windows |
| directly calls WaitForSingleObject(), but only time.sleep() properly surface |
| the SIGBREAK signal. |
| |
| Refs: |
| https://github.com/python/cpython/blob/v2.7.15/Lib/subprocess.py#L692 |
| https://github.com/python/cpython/blob/v2.7.15/Modules/timemodule.c#L1084 |
| |
| Returns: |
| returncode of the process. |
| """ |
| while process.poll()isNone: |
| time.sleep(0.1) |
| return process.returncode |
| |
| |
| def forward_signals(procs): |
| """Forwards unix's SIGTERM or win's CTRL_BREAK_EVENT to the given processes. |
| |
| This plays nicely with swarming's timeout handling. See also |
| https://chromium.googlesource.com/infra/luci/luci-py/+/main/appengine/swarming/doc/Bot.md#graceful-termination_aka-the-sigterm-and-sigkill-dance |
| |
| Args: |
| procs: A list of subprocess.Popen objects representing child processes. |
| """ |
| assert all(isinstance(p, subprocess.Popen)for pin procs) |
| |
| def _sig_handler(sig, _): |
| for pin procs: |
| if p.poll()isnotNone: |
| continue |
| # SIGBREAK is defined only for win32. |
| # pylint: disable=no-member |
| if sys.platform=='win32'and sig== signal.SIGBREAK: |
| p.send_signal(signal.CTRL_BREAK_EVENT) |
| else: |
| print('Forwarding signal(%d) to process %d'%(sig, p.pid)) |
| p.send_signal(sig) |
| # pylint: enable=no-member |
| |
| if sys.platform=='win32': |
| signal.signal(signal.SIGBREAK, _sig_handler)# pylint: disable=no-member |
| else: |
| signal.signal(signal.SIGTERM, _sig_handler) |
| signal.signal(signal.SIGINT, _sig_handler) |
| |
| |
| def run_executable(cmd, env, stdoutfile=None, cwd=None): |
| """Runs an executable with: |
| - CHROME_HEADLESS set to indicate that the test is running on a |
| bot and shouldn't do anything interactive like show modal dialogs. |
| - environment variable CR_SOURCE_ROOT set to the root directory. |
| - environment variable LANGUAGE to en_US.UTF-8. |
| - environment variable CHROME_DEVEL_SANDBOX set |
| - Reuses sys.executable automatically. |
| """ |
| extra_env={ |
| # Set to indicate that the executable is running non-interactively on |
| # a bot. |
| 'CHROME_HEADLESS':'1', |
| |
| # Many tests assume a English interface... |
| 'LANG':'en_US.UTF-8', |
| } |
| |
| # Used by base/base_paths_linux.cc as an override. Just make sure the default |
| # logic is used. |
| env.pop('CR_SOURCE_ROOT',None) |
| |
| # Copy logic from tools/build/scripts/slave/runtest.py. |
| asan='--asan=1'in cmd |
| lsan='--lsan=1'in cmd |
| msan='--msan=1'in cmd |
| tsan='--tsan=1'in cmd |
| cfi_diag='--cfi-diag=1'in cmd |
| # Treat sanitizer warnings as test case failures. |
| use_sanitizer_warnings_script='--fail-san=1'in cmd |
| if stdoutfileor sys.platformin['win32','cygwin']: |
| # Symbolization works in-process on Windows even when sandboxed. |
| use_symbolization_script=False |
| else: |
| # If any sanitizer is enabled, we print unsymbolized stack trace |
| # that is required to run through symbolization script. |
| use_symbolization_script=(asanor msanor cfi_diagor lsanor tsan) |
| |
| if asanor lsanor msanor tsanor cfi_diag: |
| extra_env.update(get_sanitizer_env(asan, lsan, msan, tsan, cfi_diag)) |
| |
| if lsanor tsan: |
| # LSan and TSan are not sandbox-friendly. |
| cmd.append('--no-sandbox') |
| |
| # Enable clang code coverage continuous mode. |
| if'--coverage-continuous-mode=1'in cmd: |
| extra_env.update(get_coverage_continuous_mode_env(env)) |
| |
| # pylint: disable=import-outside-toplevel |
| if'--skip-set-lpac-acls=1'notin cmdand sys.platform=='win32': |
| # //testing imports. |
| sys.path.insert( |
| 0, os.path.join(os.path.dirname(os.path.abspath(__file__)),'scripts')) |
| from scriptsimport common# pylint: disable=cyclic-import |
| common.set_lpac_acls(ROOT_DIR, is_test_script=True) |
| # pylint: enable=import-outside-toplevel |
| |
| cmd= trim_cmd(cmd) |
| |
| # Ensure paths are correctly separated on windows. |
| cmd[0]= cmd[0].replace('/', os.path.sep) |
| cmd= fix_python_path(cmd) |
| |
| # We also want to print the GTEST env vars that were set by the caller, |
| # because you need them to reproduce the task properly. |
| env_to_print= extra_env.copy() |
| for env_var_namein('GTEST_SHARD_INDEX','GTEST_TOTAL_SHARDS'): |
| if env_var_namein env: |
| env_to_print[env_var_name]= env[env_var_name] |
| |
| print('Additional test environment:\n%s\n' |
| 'Command: %s\n'% |
| ('\n'.join(' %s=%s'%(k, v) |
| for k, vin sorted(env_to_print.items())),' '.join(cmd))) |
| sys.stdout.flush() |
| env.update(extra_envor{}) |
| try: |
| if stdoutfile: |
| # Write to stdoutfile and poll to produce terminal output. |
| return run_command_with_output(cmd, |
| env=env, |
| stdoutfile=stdoutfile, |
| cwd=cwd) |
| if use_symbolization_script: |
| # See above comment regarding offline symbolization. |
| # Need to pipe to the symbolizer script. |
| p1= _popen(cmd, |
| env=env, |
| stdout=subprocess.PIPE, |
| cwd=cwd, |
| stderr=sys.stdout) |
| p2= _popen(get_sanitizer_symbolize_command(executable_path=cmd[0]), |
| env=env, |
| stdin=p1.stdout) |
| p1.stdout.close()# Allow p1 to receive a SIGPIPE if p2 exits. |
| forward_signals([p1, p2]) |
| wait_with_signals(p1) |
| wait_with_signals(p2) |
| # Also feed the out-of-band JSON output to the symbolizer script. |
| symbolize_snippets_in_json(cmd, env) |
| returncode= p1.returncode |
| else: |
| returncode= run_command(cmd, env=env, cwd=cwd, log=False) |
| # Check if we should post-process sanitizer warnings. |
| if use_sanitizer_warnings_script: |
| escalate_returncode= escalate_sanitizer_warnings_in_json(cmd, env) |
| ifnot returncodeand escalate_returncode: |
| print('Tests with sanitizer warnings led to task failure.') |
| returncode= escalate_returncode |
| return returncode |
| exceptOSError: |
| print('Failed to start %s'% cmd, file=sys.stderr) |
| raise |
| |
| |
| def _popen(*args,**kwargs): |
| assert'creationflags'notin kwargs |
| if sys.platform=='win32': |
| # Necessary for signal handling. See crbug.com/733612#c6. |
| kwargs['creationflags']= subprocess.CREATE_NEW_PROCESS_GROUP |
| return subprocess.Popen(*args,**kwargs) |
| |
| |
| def main(): |
| return run_executable(sys.argv[1:], os.environ.copy()) |
| |
| |
| if __name__=='__main__': |
| sys.exit(main()) |
