| # Copyright 2018 The Chromium OS 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 json |
| import logging |
| import os |
| |
| import dateutil.parser |
| |
| from autotest_lib.client.common_lib import base_job |
| from autotest_lib.client.common_lib import error |
| from autotest_lib.client.common_lib.cros import dev_server |
| from autotest_lib.server import test |
| from autotest_lib.server import utils |
| |
| |
| # A datetime.DateTime representing the Unix epoch in UTC. |
| _UNIX_EPOCH = dateutil.parser.parse('1970-01-01T00:00:00Z') |
| |
| |
| class tast(test.test): |
| """Autotest server test that runs a Tast test suite. |
| |
| Tast is an integration-testing framework analagous to the test-running |
| portion of Autotest. See |
| https://chromium.googlesource.com/chromiumos/platform/tast/ for more |
| information. |
| |
| This class runs the "tast" command locally to execute a Tast test suite on a |
| remote DUT. |
| """ |
| version = 1 |
| |
| # Maximum time to wait for various tast commands to complete, in seconds. |
| _VERSION_TIMEOUT_SEC = 10 |
| _LIST_TIMEOUT_SEC = 30 |
| |
| # Additional time to add to the run timeout (e.g. for collecting crashes and |
| # logs). |
| _RUN_OVERHEAD_SEC = 20 |
| # Additional time given to the run command to exit before it's killed. |
| _RUN_EXIT_SEC = 5 |
| |
| # Number of times to retry SSH connection attempts to the DUT. |
| _SSH_CONNECT_RETRIES = 2 |
| |
| # File written by the tast command containing test results, as |
| # newline-terminated JSON TestResult objects. |
| _STREAMED_RESULTS_FILENAME = 'streamed_results.jsonl' |
| |
| # Text file written by the tast command if a global error caused the test |
| # run to fail (e.g. SSH connection to DUT was lost). |
| _RUN_ERROR_FILENAME = 'run_error.txt' |
| |
| # Maximum number of failing and missing tests to include in error messages. |
| _MAX_TEST_NAMES_IN_ERROR = 3 |
| |
| # Default paths where Tast files are installed by Portage packages. |
| _TAST_PATH = '/usr/bin/tast' |
| _REMOTE_BUNDLE_DIR = '/usr/libexec/tast/bundles/remote' |
| _REMOTE_DATA_DIR = '/usr/share/tast/data' |
| _REMOTE_TEST_RUNNER_PATH = '/usr/bin/remote_test_runner' |
| |
| # Alternate locations for Tast files when using Server-Side Packaging. |
| # These files are installed from autotest_server_package.tar.bz2. |
| _SSP_ROOT = '/usr/local/tast' |
| _SSP_TAST_PATH = os.path.join(_SSP_ROOT, 'tast') |
| _SSP_REMOTE_BUNDLE_DIR = os.path.join(_SSP_ROOT, 'bundles/remote') |
| _SSP_REMOTE_DATA_DIR = os.path.join(_SSP_ROOT, 'data') |
| _SSP_REMOTE_TEST_RUNNER_PATH = os.path.join(_SSP_ROOT, 'remote_test_runner') |
| |
| # Prefix added to Tast test names when writing their results to TKO |
| # status.log files. |
| _TEST_NAME_PREFIX = 'tast.' |
| |
| # Prefixes of keyval keys recorded for missing tests. |
| _MISSING_TEST_KEYVAL_PREFIX = 'tast_missing_test.' |
| |
| # Job start/end TKO event status codes from base_client_job._rungroup in |
| # client/bin/job.py. |
| _JOB_STATUS_START = 'START' |
| _JOB_STATUS_END_GOOD = 'END GOOD' |
| _JOB_STATUS_END_FAIL = 'END FAIL' |
| _JOB_STATUS_END_ABORT = 'END ABORT' |
| |
| # In-job TKO event status codes from base_client_job._run_test_base in |
| # client/bin/job.py and client/common_lib/error.py. |
| _JOB_STATUS_GOOD = 'GOOD' |
| _JOB_STATUS_FAIL = 'FAIL' |
| |
| # Status reason used when an individual Tast test doesn't finish running. |
| _TEST_DID_NOT_FINISH_MSG = 'Test did not finish' |
| |
| def initialize(self, host, test_exprs, ignore_test_failures=False, |
| max_run_sec=3600, install_root='/'): |
| """ |
| @param host: remote.RemoteHost instance representing DUT. |
| @param test_exprs: Array of strings describing tests to run. |
| @param ignore_test_failures: If False, this test will fail if individual |
| Tast tests report failure. If True, this test will only fail in |
| response to the tast command failing to run successfully. This |
| should generally be False when the test is running inline and True |
| when it's running asynchronously. |
| @param max_run_sec: Integer maximum running time for the "tast run" |
| command in seconds. |
| @param install_root: Root directory under which Tast binaries are |
| installed. Alternate values may be passed by unit tests. |
| |
| @raises error.TestFail if the Tast installation couldn't be found. |
| """ |
| self._host = host |
| self._test_exprs = test_exprs |
| self._ignore_test_failures = ignore_test_failures |
| self._max_run_sec = max_run_sec |
| self._install_root = install_root |
| self._fake_now = None |
| |
| # List of JSON objects describing tests that will be run. See Test in |
| # src/platform/tast/src/chromiumos/tast/testing/test.go for details. |
| self._tests_to_run = [] |
| |
| # List of JSON objects corresponding to tests from |
| # _STREAMED_RESULTS_FILENAME. See TestResult in |
| # src/platform/tast/src/chromiumos/cmd/tast/run/results.go for details. |
| self._test_results = [] |
| |
| # Error message read from _RUN_ERROR_FILENAME, if any. |
| self._run_error = None |
| |
| # The data dir can be missing if no remote tests registered data files, |
| # but all other files must exist. |
| self._tast_path = self._get_path((self._TAST_PATH, self._SSP_TAST_PATH)) |
| self._remote_bundle_dir = self._get_path((self._REMOTE_BUNDLE_DIR, |
| self._SSP_REMOTE_BUNDLE_DIR)) |
| self._remote_data_dir = self._get_path((self._REMOTE_DATA_DIR, |
| self._SSP_REMOTE_DATA_DIR), |
| allow_missing=True) |
| self._remote_test_runner_path = self._get_path( |
| (self._REMOTE_TEST_RUNNER_PATH, |
| self._SSP_REMOTE_TEST_RUNNER_PATH)) |
| |
| # Register a hook to write the results of individual Tast tests as |
| # top-level entries in the TKO status.log file. |
| self.job.add_post_run_hook(self._log_all_tests) |
| |
| def run_once(self): |
| """Runs a single iteration of the test.""" |
| self._log_version() |
| self._get_tests_to_run() |
| |
| run_failed = False |
| try: |
| self._run_tests() |
| except: |
| run_failed = True |
| raise |
| finally: |
| self._read_run_error() |
| # Parse partial results even if the tast command didn't finish. |
| self._parse_results(run_failed) |
| |
| def set_fake_now_for_testing(self, now): |
| """Sets a fake timestamp to use in place of time.time() for unit tests. |
| |
| @param now Numeric timestamp as would be returned by time.time(). |
| """ |
| self._fake_now = now |
| |
| def _get_path(self, paths, allow_missing=False): |
| """Returns the path to an installed Tast-related file or directory. |
| |
| @param paths: Tuple or list of absolute paths in root filesystem, e.g. |
| ("/usr/bin/tast", "/usr/local/tast/tast"). |
| @param allow_missing: True if it's okay for the path to be missing. |
| |
| @returns Absolute path within install root, e.g. "/usr/bin/tast", or an |
| empty string if the path wasn't found and allow_missing is True. |
| |
| @raises error.TestFail if the path couldn't be found and allow_missing |
| is False. |
| """ |
| for path in paths: |
| abs_path = os.path.join(self._install_root, |
| os.path.relpath(path, '/')) |
| if os.path.exists(abs_path): |
| return abs_path |
| |
| if allow_missing: |
| return '' |
| raise error.TestFail('None of %s exist' % list(paths)) |
| |
| def _log_version(self): |
| """Runs the tast command locally to log its version.""" |
| try: |
| utils.run([self._tast_path, '-version'], |
| timeout=self._VERSION_TIMEOUT_SEC, |
| stdout_tee=utils.TEE_TO_LOGS, |
| stderr_tee=utils.TEE_TO_LOGS, |
| stderr_is_expected=True, |
| stdout_level=logging.INFO, |
| stderr_level=logging.ERROR) |
| except error.CmdError as e: |
| logging.error('Failed to log tast version: %s', str(e)) |
| |
| def _run_tast(self, subcommand, extra_subcommand_args, timeout_sec, |
| log_stdout=False): |
| """Runs the tast command locally to e.g. list available tests or perform |
| testing against the DUT. |
| |
| @param subcommand: Subcommand to pass to the tast executable, e.g. 'run' |
| or 'list'. |
| @param extra_subcommand_args: List of additional subcommand arguments. |
| @param timeout_sec: Integer timeout for the command in seconds. |
| @param log_stdout: If true, write stdout to log. |
| |
| @returns client.common_lib.utils.CmdResult object describing the result. |
| |
| @raises error.TestFail if the tast command fails or times out. |
| """ |
| cmd = [ |
| self._tast_path, |
| '-verbose=true', |
| '-logtime=false', |
| subcommand, |
| '-build=false', |
| '-remotebundledir=' + self._remote_bundle_dir, |
| '-remotedatadir=' + self._remote_data_dir, |
| '-remoterunner=' + self._remote_test_runner_path, |
| '-sshretries=%d' % self._SSH_CONNECT_RETRIES, |
| ] |
| cmd.extend(extra_subcommand_args) |
| cmd.append('%s:%d' % (self._host.hostname, self._host.port)) |
| cmd.extend(self._test_exprs) |
| |
| logging.info('Running ' + |
| ' '.join([utils.sh_quote_word(a) for a in cmd])) |
| try: |
| return utils.run(cmd, |
| ignore_status=False, |
| timeout=timeout_sec, |
| stdout_tee=(utils.TEE_TO_LOGS if log_stdout |
| else None), |
| stderr_tee=utils.TEE_TO_LOGS, |
| stderr_is_expected=True, |
| stdout_level=logging.INFO, |
| stderr_level=logging.ERROR) |
| except error.CmdError as e: |
| # The tast command's output generally ends with a line describing |
| # the error that was encountered; include it in the first line of |
| # the TestFail exception. Fall back to stderr if stdout is empty (as |
| # is the case with the "list" subcommand, which uses stdout to print |
| # test data). |
| get_last_line = lambda s: s.strip().split('\n')[-1].strip() |
| last_line = (get_last_line(e.result_obj.stdout) or |
| get_last_line(e.result_obj.stderr)) |
| msg = (' (last line: %s)' % last_line) if last_line else '' |
| raise error.TestFail('Failed to run tast%s: %s' % (msg, str(e))) |
| except error.CmdTimeoutError as e: |
| raise error.TestFail('Got timeout while running tast: %s' % str(e)) |
| |
| def _get_tests_to_run(self): |
| """Runs the tast command to update the list of tests that will be run. |
| |
| @raises error.TestFail if the tast command fails or times out. |
| """ |
| logging.info('Getting list of tests that will be run') |
| result = self._run_tast('list', ['-json=true'], self._LIST_TIMEOUT_SEC) |
| try: |
| self._tests_to_run = json.loads(result.stdout.strip()) |
| except ValueError as e: |
| raise error.TestFail('Failed to parse tests: %s' % str(e)) |
| if len(self._tests_to_run) == 0: |
| expr = ' '.join([utils.sh_quote_word(a) for a in self._test_exprs]) |
| raise error.TestFail('No tests matched by %s' % expr) |
| |
| logging.info('Expect to run %d test(s)', len(self._tests_to_run)) |
| |
| def _run_tests(self): |
| """Runs the tast command to perform testing. |
| |
| @raises error.TestFail if the tast command fails or times out (but not |
| if individual tests fail). |
| """ |
| timeout_sec = self._get_run_tests_timeout_sec() |
| logging.info('Running tests with timeout of %d sec', timeout_sec) |
| devservers, _ = dev_server.ImageServer.get_available_devservers( |
| self._host.hostname) |
| logging.info('Using devservers: %s', ', '.join(devservers)) |
| args = [ |
| '-resultsdir=' + self.resultsdir, |
| '-waituntilready=true', |
| '-timeout=' + str(timeout_sec), |
| '-devservers=' + ','.join(devservers), |
| ] |
| self._run_tast('run', args, timeout_sec + tast._RUN_EXIT_SEC, |
| log_stdout=True) |
| |
| def _get_run_tests_timeout_sec(self): |
| """Computes the timeout for the 'tast run' command. |
| |
| @returns Integer timeout in seconds. |
| """ |
| # Go time.Duration values are serialized to nanoseconds. |
| total_ns = sum([int(t['timeout']) for t in self._tests_to_run]) |
| return min(total_ns / 1000000000 + tast._RUN_OVERHEAD_SEC, |
| self._max_run_sec) |
| |
| def _read_run_error(self): |
| """Reads a global run error message written by the tast command.""" |
| # The file is only written if a run error occurred. |
| path = os.path.join(self.resultsdir, self._RUN_ERROR_FILENAME) |
| if os.path.exists(path): |
| with open(path, 'r') as f: |
| self._run_error = f.read().strip() |
| |
| def _parse_results(self, ignore_missing_file): |
| """Parses results written by the tast command. |
| |
| @param ignore_missing_file: If True, return without raising an exception |
| if the Tast results file is missing. This is used to avoid raising a |
| new error if there was already an earlier error while running the |
| tast process. |
| |
| @raises error.TestFail if results file is missing and |
| ignore_missing_file is False, or one or more tests failed and |
| _ignore_test_failures is false. |
| """ |
| # The file may not exist if "tast run" failed to run. Tests that were |
| # seen from the earlier "tast list" command will be reported as having |
| # missing results. |
| path = os.path.join(self.resultsdir, self._STREAMED_RESULTS_FILENAME) |
| if not os.path.exists(path): |
| if ignore_missing_file: |
| return |
| raise error.TestFail('Results file %s not found' % path) |
| |
| failed = [] |
| seen_test_names = set() |
| with open(path, 'r') as f: |
| for line in f: |
| line = line.strip() |
| if not line: |
| continue |
| try: |
| test = json.loads(line) |
| except ValueError as e: |
| raise error.TestFail('Failed to parse %s: %s' % (path, e)) |
| self._test_results.append(test) |
| |
| name = test['name'] |
| seen_test_names.add(name) |
| |
| if test.get('errors'): |
| for err in test['errors']: |
| logging.warning('%s: %s', name, err['reason']) |
| failed.append(name) |
| else: |
| # The test will have a zero (i.e. 0001-01-01 00:00:00 UTC) |
| # end time (preceding the Unix epoch) if it didn't report |
| # completion. |
| if _rfc3339_time_to_timestamp(test['end']) <= 0: |
| failed.append(name) |
| |
| missing = [t['name'] for t in self._tests_to_run |
| if t['name'] not in seen_test_names] |
| |
| if missing: |
| self._record_missing_tests(missing) |
| |
| failure_msg = self._get_failure_message(failed, missing) |
| if failure_msg: |
| raise error.TestFail(failure_msg) |
| |
| def _get_failure_message(self, failed, missing): |
| """Returns an error message describing failed and/or missing tests. |
| |
| @param failed: List of string names of Tast tests that failed. |
| @param missing: List of string names of Tast tests with missing results. |
| |
| @returns String to be used as error.TestFail message. |
| """ |
| def list_tests(names): |
| """Returns a string listing tests. |
| |
| @param names: List of string test names. |
| |
| @returns String listing tests. |
| """ |
| s = ' '.join(sorted(names)[:self._MAX_TEST_NAMES_IN_ERROR]) |
| if len(names) > self._MAX_TEST_NAMES_IN_ERROR: |
| s += ' ...' |
| return s |
| |
| msg = '' |
| if failed and not self._ignore_test_failures: |
| msg = '%d failed: %s' % (len(failed), list_tests(failed)) |
| if missing: |
| if msg: |
| msg += '; ' |
| msg += '%d missing: %s' % (len(missing), list_tests(missing)) |
| return msg |
| |
| def _log_all_tests(self): |
| """Writes entries to the TKO status.log file describing the results of |
| all tests. |
| """ |
| seen_test_names = set() |
| for test in self._test_results: |
| self._log_test(test) |
| seen_test_names.add(test['name']) |
| |
| def _log_test(self, test): |
| """Writes events to the TKO status.log file describing the results from |
| a Tast test. |
| |
| @param test: A JSON object corresponding to a single test from a Tast |
| results.json file. See TestResult in |
| src/platform/tast/src/chromiumos/cmd/tast/run/results.go for |
| details. |
| """ |
| name = test['name'] |
| start_time = _rfc3339_time_to_timestamp(test['start']) |
| end_time = _rfc3339_time_to_timestamp(test['end']) |
| |
| test_reported_errors = bool(test.get('errors')) |
| test_skipped = bool(test.get('skipReason')) |
| # The test will have a zero (i.e. 0001-01-01 00:00:00 UTC) end time |
| # (preceding the Unix epoch) if it didn't report completion. |
| test_finished = end_time > 0 |
| |
| # Avoid reporting tests that were skipped. |
| if test_skipped and not test_reported_errors: |
| return |
| |
| self._log_test_event(self._JOB_STATUS_START, name, start_time) |
| |
| if test_finished and not test_reported_errors: |
| self._log_test_event(self._JOB_STATUS_GOOD, name, end_time) |
| end_status = self._JOB_STATUS_END_GOOD |
| else: |
| # The previous START event automatically increases the log |
| # indentation level until the following END event. |
| if test_reported_errors: |
| for err in test['errors']: |
| error_time = _rfc3339_time_to_timestamp(err['time']) |
| self._log_test_event(self._JOB_STATUS_FAIL, name, |
| error_time, err['reason']) |
| if not test_finished: |
| # If a run-level error was encountered (e.g. the SSH connection |
| # to the DUT was lost), report it here to make it easier to see |
| # the reason why the test didn't finish. |
| if self._run_error: |
| self._log_test_event(self._JOB_STATUS_FAIL, name, |
| start_time, self._run_error) |
| self._log_test_event(self._JOB_STATUS_FAIL, name, start_time, |
| self._TEST_DID_NOT_FINISH_MSG) |
| end_time = start_time |
| |
| end_status = self._JOB_STATUS_END_FAIL |
| |
| self._log_test_event(end_status, name, end_time) |
| |
| def _log_test_event(self, status_code, test_name, timestamp, message=''): |
| """Logs a single event to the TKO status.log file. |
| |
| @param status_code: Event status code, e.g. 'END GOOD'. See |
| client/common_lib/log.py for accepted values. |
| @param test_name: Tast test name, e.g. 'ui.ChromeLogin'. |
| @param timestamp: Event timestamp (as seconds since Unix epoch). |
| @param message: Optional human-readable message. |
| """ |
| full_name = self._TEST_NAME_PREFIX + test_name |
| # The TKO parser code chokes on floating-point timestamps. |
| entry = base_job.status_log_entry(status_code, None, full_name, message, |
| None, timestamp=int(timestamp)) |
| self.job.record_entry(entry, False) |
| |
| def _record_missing_tests(self, missing): |
| """Records tests with missing results in job keyval file. |
| |
| @param missing: List of string names of Tast tests with missing results. |
| """ |
| keyvals = {} |
| for i, name in enumerate(sorted(missing)): |
| keyvals['%s%d' % (self._MISSING_TEST_KEYVAL_PREFIX, i)] = name |
| utils.write_keyval(self.job.resultdir, keyvals) |
| |
| |
| class _LessBrokenParserInfo(dateutil.parser.parserinfo): |
| """dateutil.parser.parserinfo that interprets years before 100 correctly. |
| |
| Our version of dateutil.parser.parse misinteprets an unambiguous string like |
| '0001-01-01T00:00:00Z' as having a two-digit year, which it then converts to |
| 2001. This appears to have been fixed by |
| https://github.com/dateutil/dateutil/commit/fc696254. This parserinfo |
| implementation always honors the provided year to prevent this from |
| happening. |
| """ |
| def convertyear(self, year, century_specified=False): |
| return int(year) |
| |
| |
| def _rfc3339_time_to_timestamp(time_str): |
| """Converts an RFC3339 time into a Unix timestamp. |
| |
| @param time_str: RFC3339-compatible time, e.g. |
| '2018-02-25T07:45:35.916929332-07:00'. |
| |
| @returns Float number of seconds since the Unix epoch. Negative if the time |
| precedes the epoch. |
| """ |
| dt = dateutil.parser.parse(time_str, parserinfo=_LessBrokenParserInfo()) |
| return (dt - _UNIX_EPOCH).total_seconds() |
