| #!/usr/bin/env vpython |
| # |
| # Copyright 2018 The Chromium Authors. All rights reserved. |
| # Use of this source code is governed by a BSD-style license that can be |
| # found in the LICENSE file. |
| |
| import argparse |
| import collections |
| import json |
| import logging |
| import os |
| import pipes |
| import re |
| import signal |
| import socket |
| import sys |
| import tempfile |
| |
| # The following non-std imports are fetched via vpython. See the list at |
| # //.vpython |
| import dateutil.parser # pylint: disable=import-error |
| import jsonlines # pylint: disable=import-error |
| import psutil # pylint: disable=import-error |
| |
| CHROMIUM_SRC_PATH = os.path.abspath(os.path.join( |
| os.path.dirname(__file__), '..', '..')) |
| |
| # Use the android test-runner's gtest results support library for generating |
| # output json ourselves. |
| sys.path.insert(0, os.path.join(CHROMIUM_SRC_PATH, 'build', 'android')) |
| from pylib.base import base_test_result # pylint: disable=import-error |
| from pylib.results import json_results # pylint: disable=import-error |
| |
| # Use luci-py's subprocess42.py |
| sys.path.insert( |
| 0, os.path.join(CHROMIUM_SRC_PATH, 'tools', 'swarming_client', 'utils')) |
| import subprocess42 # pylint: disable=import-error |
| |
| DEFAULT_CROS_CACHE = os.path.abspath(os.path.join( |
| CHROMIUM_SRC_PATH, 'build', 'cros_cache')) |
| CHROMITE_PATH = os.path.abspath(os.path.join( |
| CHROMIUM_SRC_PATH, 'third_party', 'chromite')) |
| CROS_RUN_TEST_PATH = os.path.abspath(os.path.join( |
| CHROMITE_PATH, 'bin', 'cros_run_test')) |
| |
| # GN target that corresponds to the cros browser sanity test. |
| SANITY_TEST_TARGET = 'cros_browser_sanity_test' |
| |
| # This is a special hostname that resolves to a different DUT in the lab |
| # depending on which lab machine you're on. |
| LAB_DUT_HOSTNAME = 'variable_chromeos_device_hostname' |
| |
| |
| class TestFormatError(Exception): |
| pass |
| |
| |
| class RemoteTest(object): |
| |
| # This is a basic shell script that can be appended to in order to invoke the |
| # test on the device. |
| BASIC_SHELL_SCRIPT = [ |
| '#!/bin/sh', |
| |
| # /home is mounted with "noexec" in the device, but some of our tools |
| # and tests use the home dir as a workspace (eg: vpython downloads |
| # python binaries to ~/.vpython-root). /usr/local/tmp doesn't have this |
| # restriction, so change the location of the home dir for the |
| # duration of the test. |
| 'export HOME=/usr/local/tmp', |
| ] |
| |
| def __init__(self, args, unknown_args): |
| self._additional_args = unknown_args |
| self._path_to_outdir = args.path_to_outdir |
| self._test_launcher_summary_output = args.test_launcher_summary_output |
| self._logs_dir = args.logs_dir |
| self._use_vm = args.use_vm |
| |
| self._retries = 0 |
| self._timeout = None |
| |
| # The location on disk of a shell script that can be optionally used to |
| # invoke the test on the device. If it's not set, we assume self._test_cmd |
| # contains the test invocation. |
| self._on_device_script = None |
| |
| self._test_cmd = [ |
| CROS_RUN_TEST_PATH, |
| '--board', args.board, |
| '--cache-dir', args.cros_cache, |
| ] |
| if args.use_vm: |
| self._test_cmd += [ |
| '--start', |
| # Don't persist any filesystem changes after the VM shutsdown. |
| '--copy-on-write', |
| '--device', 'localhost' |
| ] |
| else: |
| self._test_cmd += [ |
| '--device', args.device if args.device else LAB_DUT_HOSTNAME |
| ] |
| if args.logs_dir: |
| self._test_cmd += [ |
| '--results-src', '/var/log/', |
| '--results-dest-dir', args.logs_dir, |
| ] |
| |
| # This environment variable is set for tests that have been instrumented |
| # for code coverage. Its incoming value is expected to be a location |
| # inside a subdirectory of result_dir above. This is converted to an |
| # absolute path that the vm is able to write to, and passed in the |
| # --results-src flag to cros_run_vm_test for copying out of the vm before |
| # its termination. |
| self._llvm_profile_var = None |
| if os.environ.get('LLVM_PROFILE_FILE'): |
| _, llvm_profile_file = os.path.split(os.environ['LLVM_PROFILE_FILE']) |
| self._llvm_profile_var = '/tmp/profraw/%s' % llvm_profile_file |
| |
| # This should make the vm test runner exfil the profiling data. |
| self._test_cmd += [ |
| '--results-src', '/tmp/profraw' |
| ] |
| |
| self._test_env = setup_env() |
| |
| @property |
| def suite_name(self): |
| raise NotImplementedError('Child classes need to define suite name.') |
| |
| @property |
| def test_cmd(self): |
| return self._test_cmd |
| |
| def write_test_script_to_disk(self, script_contents): |
| # Since we're using an on_device_script to invoke the test, we'll need to |
| # set cwd. |
| self._test_cmd += [ |
| '--remote-cmd', |
| '--cwd', os.path.relpath(self._path_to_outdir, CHROMIUM_SRC_PATH), |
| ] |
| logging.info('Running the following command on the device:') |
| logging.info('\n' + '\n'.join(script_contents)) |
| fd, tmp_path = tempfile.mkstemp(suffix='.sh', dir=self._path_to_outdir) |
| os.fchmod(fd, 0755) |
| with os.fdopen(fd, 'wb') as f: |
| f.write('\n'.join(script_contents) + '\n') |
| return tmp_path |
| |
| def run_test(self): |
| # Traps SIGTERM and kills all child processes of cros_run_test when it's |
| # caught. This will allow us to capture logs from the device if a test hangs |
| # and gets timeout-killed by swarming. See also: |
| # https://chromium.googlesource.com/infra/luci/luci-py/+/master/appengine/swarming/doc/Bot.md#graceful-termination_aka-the-sigterm-and-sigkill-dance |
| test_proc = None |
| def _kill_child_procs(trapped_signal, _): |
| logging.warning( |
| 'Received signal %d. Killing child processes of test.', |
| trapped_signal) |
| if not test_proc or not test_proc.pid: |
| # This shouldn't happen? |
| logging.error('Test process not running.') |
| return |
| for child in psutil.Process(test_proc.pid).children(): |
| logging.warning('Killing process %s', child) |
| child.kill() |
| |
| signal.signal(signal.SIGTERM, _kill_child_procs) |
| |
| for i in xrange(self._retries+1): |
| logging.info('########################################') |
| logging.info('Test attempt #%d', i) |
| logging.info('########################################') |
| test_proc = subprocess42.Popen( |
| self._test_cmd, stdout=sys.stdout, stderr=sys.stderr, |
| env=self._test_env) |
| try: |
| test_proc.wait(timeout=self._timeout) |
| except subprocess42.TimeoutExpired: |
| logging.error('Test timed out. Sending SIGTERM.') |
| # SIGTERM the proc and wait 10s for it to close. |
| test_proc.terminate() |
| try: |
| test_proc.wait(timeout=10) |
| except subprocess42.TimeoutExpired: |
| # If it hasn't closed in 10s, SIGKILL it. |
| logging.error('Test did not exit in time. Sending SIGKILL.') |
| test_proc.kill() |
| test_proc.wait() |
| logging.info('Test exitted with %d.', test_proc.returncode) |
| if test_proc.returncode == 0: |
| break |
| |
| ret = self.post_run(test_proc.returncode) |
| # Allow post_run to override test proc return code. (Useful when the host |
| # side Tast bin returns 0 even for failed tests.) |
| if ret is not None: |
| return ret |
| return test_proc.returncode |
| |
| def post_run(self, return_code): |
| if self._on_device_script: |
| os.remove(self._on_device_script) |
| # Create a simple json results file for a test run. The results will contain |
| # only one test (suite_name), and will either be a PASS or FAIL depending on |
| # return_code. |
| if self._test_launcher_summary_output: |
| result = (base_test_result.ResultType.FAIL if return_code else |
| base_test_result.ResultType.PASS) |
| suite_result = base_test_result.BaseTestResult(self.suite_name, result) |
| run_results = base_test_result.TestRunResults() |
| run_results.AddResult(suite_result) |
| with open(self._test_launcher_summary_output, 'w') as f: |
| json.dump(json_results.GenerateResultsDict([run_results]), f) |
| |
| |
| class TastTest(RemoteTest): |
| |
| def __init__(self, args, unknown_args): |
| super(TastTest, self).__init__(args, unknown_args) |
| |
| self._suite_name = args.suite_name |
| self._tests = args.tests |
| self._conditional = args.conditional |
| |
| if not self._llvm_profile_var and not self._logs_dir: |
| # The host-side Tast bin returns 0 when tests fail, so we need to capture |
| # and parse its json results to reliably determine if tests fail. |
| raise TestFormatError( |
| 'When using the host-side Tast bin, "--logs-dir" must be passed in ' |
| 'order to parse its results.') |
| |
| @property |
| def suite_name(self): |
| return self._suite_name |
| |
| def build_test_command(self): |
| if '--gtest_filter=%s' % self.suite_name in self._additional_args: |
| logging.info( |
| 'GTest filtering not supported for tast tests. The ' |
| '--gtest_filter arg will be ignored.') |
| self._additional_args.remove('--gtest_filter=%s' % self.suite_name) |
| if any(arg.startswith('--gtest_repeat') for arg in self._additional_args): |
| logging.info( |
| '--gtest_repeat not supported for tast tests. The arg will be ' |
| 'ignored.') |
| self._additional_args = [ |
| arg for arg in self._additional_args if not arg.startswith( |
| '--gtest_repeat')] |
| |
| if self._additional_args: |
| logging.error( |
| 'Tast tests should not have additional args. These will be ' |
| 'ignored: %s', self._additional_args) |
| |
| # VMs don't have the disk space for an unstripped version of Chrome, so only |
| # strip when running on VMs. |
| if not self._use_vm: |
| self._test_cmd.append('--nostrip') |
| |
| self._test_cmd += [ |
| '--deploy', |
| '--mount', |
| '--build-dir', os.path.relpath(self._path_to_outdir, CHROMIUM_SRC_PATH), |
| ] |
| |
| # Coverage tests require some special pre-test setup, so use an |
| # on_device_script in that case. For all other tests, use cros_run_test's |
| # built-in '--tast' option. This gives us much better results reporting. |
| if self._llvm_profile_var: |
| # Build the shell script that will be used on the device to invoke the |
| # test. |
| device_test_script_contents = self.BASIC_SHELL_SCRIPT[:] |
| device_test_script_contents += [ |
| 'echo "LLVM_PROFILE_FILE=%s" >> /etc/chrome_dev.conf' % ( |
| self._llvm_profile_var) |
| ] |
| |
| local_test_runner_cmd = ['local_test_runner', '-waituntilready'] |
| if self._use_vm: |
| # If we're running tests in VMs, tell the test runner to skip tests that |
| # aren't compatible. |
| local_test_runner_cmd.append('-extrauseflags=tast_vm') |
| if self._conditional: |
| local_test_runner_cmd.append(pipes.quote(self._conditional)) |
| else: |
| local_test_runner_cmd.extend(self._tests) |
| device_test_script_contents.append(' '.join(local_test_runner_cmd)) |
| |
| self._on_device_script = self.write_test_script_to_disk( |
| device_test_script_contents) |
| |
| self._test_cmd += [ |
| '--files', os.path.relpath(self._on_device_script), |
| '--', |
| './' + os.path.relpath(self._on_device_script, self._path_to_outdir) |
| ] |
| else: |
| # Capture tast's results in the logs dir as well. |
| if self._logs_dir: |
| self._test_cmd += [ |
| '--results-dir', self._logs_dir, |
| ] |
| if self._conditional: |
| # Don't use pipes.quote() here. Something funky happens with the arg |
| # as it gets passed down from cros_run_test to tast. (Tast picks up the |
| # escaping single quotes and complains that the conditional "must be |
| # within parentheses".) |
| self._test_cmd.append('--tast=%s' % self._conditional) |
| else: |
| self._test_cmd.append('--tast') |
| self._test_cmd.extend(self._tests) |
| |
| def post_run(self, return_code): |
| # If we don't need to parse the host-side Tast tool's results, fall back to |
| # the parent method's default behavior. |
| if self._llvm_profile_var: |
| return super(TastTest, self).post_run(return_code) |
| |
| tast_results_path = os.path.join(self._logs_dir, 'streamed_results.jsonl') |
| if not os.path.exists(tast_results_path): |
| logging.error( |
| 'Tast results not found at %s. Falling back to generic result ' |
| 'reporting.', tast_results_path) |
| return super(TastTest, self).post_run(return_code) |
| |
| # See the link below for the format of the results: |
| # https://godoc.org/chromium.googlesource.com/chromiumos/platform/tast.git/src/chromiumos/cmd/tast/run#TestResult |
| with jsonlines.open(tast_results_path) as reader: |
| tast_results = collections.deque(reader) |
| |
| suite_results = base_test_result.TestRunResults() |
| for test in tast_results: |
| errors = test['errors'] |
| start, end = test['start'], test['end'] |
| # Use dateutil to parse the timestamps since datetime can't handle |
| # nanosecond precision. |
| duration = dateutil.parser.parse(end) - dateutil.parser.parse(start) |
| duration_ms = duration.total_seconds() * 1000 |
| if bool(test['skipReason']): |
| result = base_test_result.ResultType.SKIP |
| elif errors: |
| result = base_test_result.ResultType.FAIL |
| else: |
| result = base_test_result.ResultType.PASS |
| error_log = '' |
| if errors: |
| # See the link below for the format of these errors: |
| # https://godoc.org/chromium.googlesource.com/chromiumos/platform/tast.git/src/chromiumos/tast/testing#Error |
| for err in errors: |
| error_log += str(err['stack']) + '\n' |
| base_result = base_test_result.BaseTestResult( |
| test['name'], result, duration=duration_ms, log=error_log) |
| suite_results.AddResult(base_result) |
| |
| if self._test_launcher_summary_output: |
| with open(self._test_launcher_summary_output, 'w') as f: |
| json.dump(json_results.GenerateResultsDict([suite_results]), f) |
| |
| if not suite_results.DidRunPass(): |
| return 1 |
| elif return_code: |
| logging.warning( |
| 'No failed tests found, but exit code of %d was returned from ' |
| 'cros_run_test.', return_code) |
| return return_code |
| return 0 |
| |
| |
| |
| class GTestTest(RemoteTest): |
| |
| # The following list corresponds to paths that should not be copied over to |
| # the device during tests. In other words, these files are only ever used on |
| # the host. |
| _FILE_BLACKLIST = [ |
| re.compile(r'.*build/android.*'), |
| re.compile(r'.*build/chromeos.*'), |
| re.compile(r'.*build/cros_cache.*'), |
| # The following matches anything under //testing/ that isn't under |
| # //testing/buildbot/filters/. |
| re.compile(r'.*testing/(?!buildbot/filters).*'), |
| re.compile(r'.*third_party/chromite.*'), |
| re.compile(r'.*tools/swarming_client.*'), |
| ] |
| |
| def __init__(self, args, unknown_args): |
| super(GTestTest, self).__init__(args, unknown_args) |
| |
| self._test_exe = args.test_exe |
| self._runtime_deps_path = args.runtime_deps_path |
| self._vpython_dir = args.vpython_dir |
| |
| self._test_launcher_shard_index = args.test_launcher_shard_index |
| self._test_launcher_total_shards = args.test_launcher_total_shards |
| |
| self._on_device_script = None |
| self._stop_ui = args.stop_ui |
| |
| @property |
| def suite_name(self): |
| return self._test_exe |
| |
| def build_test_command(self): |
| # To keep things easy for us, ensure both types of output locations are |
| # the same. |
| if self._test_launcher_summary_output and self._logs_dir: |
| json_out_dir = os.path.dirname(self._test_launcher_summary_output) or '.' |
| if os.path.abspath(json_out_dir) != os.path.abspath(self._logs_dir): |
| raise TestFormatError( |
| '--test-launcher-summary-output and --logs-dir must point to ' |
| 'the same directory.') |
| |
| if self._test_launcher_summary_output: |
| result_dir, result_file = os.path.split( |
| self._test_launcher_summary_output) |
| # If args.test_launcher_summary_output is a file in cwd, result_dir will |
| # be an empty string, so replace it with '.' when this is the case so |
| # cros_run_test can correctly handle it. |
| if not result_dir: |
| result_dir = '.' |
| device_result_file = '/tmp/%s' % result_file |
| self._test_cmd += [ |
| '--results-src', device_result_file, |
| '--results-dest-dir', result_dir, |
| ] |
| |
| # Build the shell script that will be used on the device to invoke the test. |
| device_test_script_contents = self.BASIC_SHELL_SCRIPT[:] |
| if self._llvm_profile_var: |
| device_test_script_contents += [ |
| 'export LLVM_PROFILE_FILE=%s'% self._llvm_profile_var, |
| ] |
| |
| if self._vpython_dir: |
| vpython_spec_path = os.path.relpath( |
| os.path.join(CHROMIUM_SRC_PATH, '.vpython'), |
| self._path_to_outdir) |
| # Initialize the vpython cache. This can take 10-20s, and some tests |
| # can't afford to wait that long on the first invocation. |
| device_test_script_contents.extend([ |
| 'export PATH=$PATH:$PWD/%s' % (self._vpython_dir), |
| 'vpython -vpython-spec %s -vpython-tool install' % ( |
| vpython_spec_path), |
| ]) |
| |
| test_invocation = ( |
| './%s --test-launcher-shard-index=%d ' |
| '--test-launcher-total-shards=%d' % ( |
| self._test_exe, self._test_launcher_shard_index, |
| self._test_launcher_total_shards) |
| ) |
| if self._test_launcher_summary_output: |
| test_invocation += ' --test-launcher-summary-output=%s' % ( |
| device_result_file) |
| if self._additional_args: |
| test_invocation += ' %s' % ' '.join(self._additional_args) |
| |
| if self._stop_ui: |
| device_test_script_contents += [ |
| 'stop ui', |
| ] |
| # The UI service on the device owns the chronos user session, so shutting |
| # it down as chronos kills the entire execution of the test. So we'll have |
| # to run as root up until the test invocation. |
| test_invocation = 'su chronos -c -- "%s"' % test_invocation |
| # And we'll need to chown everything since cros_run_test's "--as-chronos" |
| # option normally does that for us. |
| device_test_script_contents.append('chown -R chronos: ../..') |
| else: |
| self._test_cmd += [ |
| # Some tests fail as root, so run as the less privileged user |
| # 'chronos'. |
| '--as-chronos', |
| ] |
| |
| device_test_script_contents.append(test_invocation) |
| |
| self._on_device_script = self.write_test_script_to_disk( |
| device_test_script_contents) |
| |
| runtime_files = [os.path.relpath(self._on_device_script)] |
| runtime_files += self._read_runtime_files() |
| if self._vpython_dir: |
| # --vpython-dir is relative to the out dir, but --files expects paths |
| # relative to src dir, so fix the path up a bit. |
| runtime_files.append( |
| os.path.relpath( |
| os.path.abspath(os.path.join(self._path_to_outdir, |
| self._vpython_dir)), |
| CHROMIUM_SRC_PATH)) |
| # TODO(bpastene): Add the vpython spec to the test's runtime deps instead |
| # of handling it here. |
| runtime_files.append('.vpython') |
| |
| for f in runtime_files: |
| self._test_cmd.extend(['--files', f]) |
| |
| self._test_cmd += [ |
| '--', |
| './' + os.path.relpath(self._on_device_script, self._path_to_outdir) |
| ] |
| |
| def _read_runtime_files(self): |
| if not self._runtime_deps_path: |
| return [] |
| |
| abs_runtime_deps_path = os.path.abspath( |
| os.path.join(self._path_to_outdir, self._runtime_deps_path)) |
| with open(abs_runtime_deps_path) as runtime_deps_file: |
| files = [l.strip() for l in runtime_deps_file if l] |
| rel_file_paths = [] |
| for f in files: |
| rel_file_path = os.path.relpath( |
| os.path.abspath(os.path.join(self._path_to_outdir, f))) |
| if not any(regex.match(rel_file_path) for regex in self._FILE_BLACKLIST): |
| rel_file_paths.append(rel_file_path) |
| return rel_file_paths |
| |
| def post_run(self, _): |
| if self._on_device_script: |
| os.remove(self._on_device_script) |
| |
| |
| class BrowserSanityTest(RemoteTest): |
| |
| def __init__(self, args, unknown_args): |
| super(BrowserSanityTest, self).__init__(args, unknown_args) |
| |
| # 10 min should be enough time for the sanity test to pass. |
| self._retries = 1 |
| self._timeout = 600 |
| |
| @property |
| def suite_name(self): |
| return SANITY_TEST_TARGET |
| |
| def build_test_command(self): |
| if '--gtest_filter=%s' % SANITY_TEST_TARGET in self._additional_args: |
| logging.info( |
| 'GTest filtering not supported for the sanity test. The ' |
| '--gtest_filter arg will be ignored.') |
| self._additional_args.remove('--gtest_filter=%s' % SANITY_TEST_TARGET) |
| if any(arg.startswith('--gtest_repeat') for arg in self._additional_args): |
| logging.info( |
| '--gtest_repeat not supported for sanity test. The arg will be ' |
| 'ignored.') |
| self._additional_args = [ |
| arg for arg in self._additional_args if not arg.startswith( |
| '--gtest_repeat')] |
| |
| if self._additional_args: |
| logging.error( |
| 'Sanity test should not have additional args: These will be ' |
| 'ignored: %s', self._additional_args) |
| |
| # VMs don't have the disk space for an unstripped version of Chrome |
| # instrumented for code coverage, so only strip in that case. |
| if not self._use_vm or not os.environ.get('LLVM_PROFILE_FILE'): |
| self._test_cmd.append('--nostrip') |
| |
| device_test_script_contents = self.BASIC_SHELL_SCRIPT[:] |
| if self._llvm_profile_var: |
| device_test_script_contents += [ |
| 'echo "LLVM_PROFILE_FILE=%s" >> /etc/chrome_dev.conf' % ( |
| self._llvm_profile_var) |
| ] |
| |
| # vm_sanity.py is the sanity test, which is baked into the device image. |
| device_test_script_contents.append('/usr/local/autotest/bin/vm_sanity.py') |
| |
| self._on_device_script = self.write_test_script_to_disk( |
| device_test_script_contents) |
| |
| self._test_cmd += [ |
| '--files', os.path.relpath(self._on_device_script), |
| # The sanity test smoke-checks the system browser, so deploy our |
| # locally-built chrome to the device before testing. |
| '--deploy', |
| '--mount', |
| '--build-dir', os.path.relpath(self._path_to_outdir, CHROMIUM_SRC_PATH), |
| '--', |
| './' + os.path.relpath(self._on_device_script, self._path_to_outdir) |
| ] |
| |
| |
| def device_test(args, unknown_args): |
| # cros_run_test has trouble with relative paths that go up directories, |
| # so cd to src/, which should be the root of all data deps. |
| os.chdir(CHROMIUM_SRC_PATH) |
| |
| # pylint: disable=redefined-variable-type |
| # TODO: Remove the above when depot_tool's pylint is updated to include the |
| # fix to https://github.com/PyCQA/pylint/issues/710. |
| if args.test_type == 'tast': |
| test = TastTest(args, unknown_args) |
| elif args.test_exe == SANITY_TEST_TARGET: |
| test = BrowserSanityTest(args, unknown_args) |
| else: |
| test = GTestTest(args, unknown_args) |
| |
| test.build_test_command() |
| logging.info('Running the following command on the device:') |
| logging.info(' '.join(test.test_cmd)) |
| |
| return test.run_test() |
| |
| |
| def host_cmd(args, unknown_args): |
| if not args.cmd: |
| raise TestFormatError('Must specify command to run on the host.') |
| elif unknown_args: |
| raise TestFormatError( |
| 'Args "%s" unsupported. Is your host command correctly formatted?' % ( |
| ' '.join(unknown_args))) |
| elif args.deploy_chrome and not args.path_to_outdir: |
| raise TestFormatError( |
| '--path-to-outdir must be specified if --deploy-chrome is passed.') |
| |
| cros_run_test_cmd = [ |
| CROS_RUN_TEST_PATH, |
| '--board', args.board, |
| '--cache-dir', args.cros_cache, |
| ] |
| if args.use_vm: |
| cros_run_test_cmd += [ |
| '--start', |
| # Don't persist any filesystem changes after the VM shutsdown. |
| '--copy-on-write', |
| '--device', 'localhost', |
| ] |
| else: |
| cros_run_test_cmd += [ |
| '--device', args.device if args.device else LAB_DUT_HOSTNAME |
| ] |
| if args.verbose: |
| cros_run_test_cmd.append('--debug') |
| |
| if args.logs_dir: |
| cros_run_test_cmd += [ |
| '--results-src', '/var/log/', |
| '--results-dest-dir', args.logs_dir, |
| ] |
| |
| test_env = setup_env() |
| if args.deploy_chrome: |
| cros_run_test_cmd += [ |
| '--deploy', |
| '--mount', |
| '--build-dir', os.path.abspath(args.path_to_outdir), |
| ] |
| |
| cros_run_test_cmd += [ |
| '--host-cmd', |
| '--', |
| ] + args.cmd |
| |
| logging.info('Running the following command:') |
| logging.info(' '.join(cros_run_test_cmd)) |
| |
| return subprocess42.call( |
| cros_run_test_cmd, stdout=sys.stdout, stderr=sys.stderr, env=test_env) |
| |
| |
| def setup_env(): |
| """Returns a copy of the current env with some needed vars added.""" |
| env = os.environ.copy() |
| # Some chromite scripts expect chromite/bin to be on PATH. |
| env['PATH'] = env['PATH'] + ':' + os.path.join(CHROMITE_PATH, 'bin') |
| # deploy_chrome needs a set of GN args used to build chrome to determine if |
| # certain libraries need to be pushed to the device. It looks for the args via |
| # an env var. To trigger the default deploying behavior, give it a dummy set |
| # of args. |
| # TODO(crbug.com/823996): Make the GN-dependent deps controllable via cmd |
| # line args. |
| if not env.get('GN_ARGS'): |
| env['GN_ARGS'] = 'enable_nacl = true' |
| if not env.get('USE'): |
| env['USE'] = 'highdpi' |
| return env |
| |
| |
| def add_common_args(*parsers): |
| for parser in parsers: |
| parser.add_argument('--verbose', '-v', action='store_true') |
| parser.add_argument( |
| '--board', type=str, required=True, help='Type of CrOS device.') |
| parser.add_argument( |
| '--cros-cache', type=str, default=DEFAULT_CROS_CACHE, |
| help='Path to cros cache.') |
| parser.add_argument( |
| '--path-to-outdir', type=str, required=True, |
| help='Path to output directory, all of whose contents will be ' |
| 'deployed to the device.') |
| parser.add_argument( |
| '--runtime-deps-path', type=str, |
| help='Runtime data dependency file from GN.') |
| parser.add_argument( |
| '--vpython-dir', type=str, |
| help='Location on host of a directory containing a vpython binary to ' |
| 'deploy to the device before the test starts. The location of ' |
| 'this dir will be added onto PATH in the device. WARNING: The ' |
| 'arch of the device might not match the arch of the host, so ' |
| 'avoid using "${platform}" when downloading vpython via CIPD.') |
| # TODO(bpastene): Switch all uses of "--vm-logs-dir" to "--logs-dir". |
| parser.add_argument( |
| '--vm-logs-dir', '--logs-dir', type=str, dest='logs_dir', |
| help='Will copy everything under /var/log/ from the device after the ' |
| 'test into the specified dir.') |
| |
| vm_or_device_group = parser.add_mutually_exclusive_group() |
| vm_or_device_group.add_argument( |
| '--use-vm', action='store_true', |
| help='Will run the test in the VM instead of a device.') |
| vm_or_device_group.add_argument( |
| '--device', type=str, |
| help='Hostname (or IP) of device to run the test on. This arg is not ' |
| 'required if --use-vm is set.') |
| |
| |
| def main(): |
| parser = argparse.ArgumentParser() |
| subparsers = parser.add_subparsers(dest='test_type') |
| # Host-side test args. |
| host_cmd_parser = subparsers.add_parser( |
| 'host-cmd', |
| help='Runs a host-side test. Pass the host-side command to run after ' |
| '"--". If --use-vm is passed, hostname and port for the device ' |
| 'will be 127.0.0.1:9222.') |
| host_cmd_parser.set_defaults(func=host_cmd) |
| host_cmd_parser.add_argument( |
| '--deploy-chrome', action='store_true', |
| help='Will deploy a locally built Chrome binary to the device before ' |
| 'running the host-cmd.') |
| host_cmd_parser.add_argument('cmd', nargs=argparse.REMAINDER) |
| # GTest args. |
| # TODO(bpastene): Rename 'vm-test' arg to 'gtest'. |
| gtest_parser = subparsers.add_parser( |
| 'vm-test', |
| help='Runs a device-side gtest.') |
| gtest_parser.set_defaults(func=device_test) |
| gtest_parser.add_argument( |
| '--test-exe', type=str, required=True, |
| help='Path to test executable to run inside the device. If the value is ' |
| '%s, the sanity test that ships with the device image runs instead. ' |
| 'This test smokes-check the system browser (eg: loads a simple ' |
| 'webpage, executes some javascript), so a fully-built Chrome binary ' |
| 'that can get deployed to the device is expected to be available in ' |
| 'the out-dir.' % SANITY_TEST_TARGET) |
| |
| # GTest args. Some are passed down to the test binary in the device. Others |
| # are parsed here since they might need tweaking or special handling. |
| gtest_parser.add_argument( |
| '--test-launcher-summary-output', type=str, |
| help='When set, will pass the same option down to the test and retrieve ' |
| 'its result file at the specified location.') |
| # Shard args are parsed here since we might also specify them via env vars. |
| gtest_parser.add_argument( |
| '--test-launcher-shard-index', |
| type=int, default=os.environ.get('GTEST_SHARD_INDEX', 0), |
| help='Index of the external shard to run.') |
| gtest_parser.add_argument( |
| '--test-launcher-total-shards', |
| type=int, default=os.environ.get('GTEST_TOTAL_SHARDS', 1), |
| help='Total number of external shards.') |
| gtest_parser.add_argument( |
| '--stop-ui', action='store_true', |
| help='Will stop the UI service in the device before running the test.') |
| |
| # Tast test args. |
| # pylint: disable=line-too-long |
| tast_test_parser = subparsers.add_parser( |
| 'tast', |
| help='Runs a device-side set of Tast tests. For more details, see: ' |
| 'https://chromium.googlesource.com/chromiumos/platform/tast/+/master/docs/running_tests.md') |
| tast_test_parser.set_defaults(func=device_test) |
| tast_test_parser.add_argument( |
| '--suite-name', type=str, required=True, |
| help='Name to apply to the set of Tast tests to run. This has no effect ' |
| 'on what is executed, but is used mainly for test results reporting ' |
| 'and tracking (eg: flakiness dashboard).') |
| tast_test_parser.add_argument( |
| '--test-launcher-summary-output', type=str, |
| help='Generates a simple GTest-style JSON result file for the test run.') |
| # TODO(bpastene): Change all uses of "--conditional" to use "--attr-expr". |
| tast_test_parser.add_argument( |
| '--conditional', '--attr-expr', type=str, dest='conditional', |
| help='A boolean expression whose matching tests will run ' |
| '(eg: ("dep:chrome")).') |
| tast_test_parser.add_argument( |
| '--test', '-t', action='append', dest='tests', |
| help='A Tast test to run in the device (eg: "ui.ChromeLogin").') |
| |
| add_common_args(gtest_parser, tast_test_parser, host_cmd_parser) |
| args, unknown_args = parser.parse_known_args() |
| |
| logging.basicConfig(level=logging.DEBUG if args.verbose else logging.WARN) |
| |
| if not args.use_vm and not args.device: |
| # If we're not running on a VM, but haven't specified a hostname, assume |
| # we're on a lab bot and are trying to run a test on a lab DUT. See if the |
| # magic lab DUT hostname resolves to anything. (It will in the lab and will |
| # not on dev machines.) |
| try: |
| socket.getaddrinfo(LAB_DUT_HOSTNAME, None) |
| except socket.gaierror: |
| logging.error( |
| 'The default DUT hostname of %s is unreachable.', LAB_DUT_HOSTNAME) |
| return 1 |
| if args.use_vm: |
| if not os.path.exists('/dev/kvm'): |
| logging.error('/dev/kvm is missing. Is KVM installed on this machine?') |
| return 1 |
| elif not os.access('/dev/kvm', os.W_OK): |
| logging.error( |
| '/dev/kvm is not writable as current user. Perhaps you should be ' |
| 'root?') |
| return 1 |
| |
| args.cros_cache = os.path.abspath(args.cros_cache) |
| return args.func(args, unknown_args) |
| |
| |
| if __name__ == '__main__': |
| sys.exit(main()) |
