You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
874 lines
34 KiB
874 lines
34 KiB
#!/usr/bin/env python3
|
|
#
|
|
# Copyright 2017, The Android Open Source Project
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
"""
|
|
Command line utility for running Android tests through TradeFederation.
|
|
|
|
atest helps automate the flow of building test modules across the Android
|
|
code base and executing the tests via the TradeFederation test harness.
|
|
|
|
atest is designed to support any test types that can be ran by TradeFederation.
|
|
"""
|
|
|
|
# pylint: disable=line-too-long
|
|
|
|
from __future__ import print_function
|
|
|
|
import collections
|
|
import logging
|
|
import os
|
|
import sys
|
|
import tempfile
|
|
import time
|
|
import platform
|
|
|
|
from multiprocessing import Process
|
|
|
|
import atest_arg_parser
|
|
import atest_configs
|
|
import atest_error
|
|
import atest_execution_info
|
|
import atest_utils
|
|
import bug_detector
|
|
import cli_translator
|
|
import constants
|
|
import module_info
|
|
import result_reporter
|
|
import test_runner_handler
|
|
|
|
from metrics import metrics
|
|
from metrics import metrics_base
|
|
from metrics import metrics_utils
|
|
from test_runners import regression_test_runner
|
|
from tools import atest_tools as at
|
|
|
|
EXPECTED_VARS = frozenset([
|
|
constants.ANDROID_BUILD_TOP,
|
|
'ANDROID_TARGET_OUT_TESTCASES',
|
|
constants.ANDROID_OUT])
|
|
TEST_RUN_DIR_PREFIX = "%Y%m%d_%H%M%S"
|
|
CUSTOM_ARG_FLAG = '--'
|
|
OPTION_NOT_FOR_TEST_MAPPING = (
|
|
'Option `%s` does not work for running tests in TEST_MAPPING files')
|
|
|
|
DEVICE_TESTS = 'tests that require device'
|
|
HOST_TESTS = 'tests that do NOT require device'
|
|
RESULT_HEADER_FMT = '\nResults from %(test_type)s:'
|
|
RUN_HEADER_FMT = '\nRunning %(test_count)d %(test_type)s.'
|
|
TEST_COUNT = 'test_count'
|
|
TEST_TYPE = 'test_type'
|
|
# Tasks that must run in the build time but unable to build by soong.
|
|
# (e.g subprocesses that invoke host commands.)
|
|
ACLOUD_CREATE = at.acloud_create
|
|
INDEX_TARGETS = at.index_targets
|
|
|
|
|
|
def _run_multi_proc(func, *args, **kwargs):
|
|
"""Start a process with multiprocessing and return Process object.
|
|
|
|
Args:
|
|
func: A string of function name which will be the target name.
|
|
args/kwargs: check doc page:
|
|
https://docs.python.org/3.8/library/multiprocessing.html#process-and-exceptions
|
|
|
|
Returns:
|
|
multiprocessing.Process object.
|
|
"""
|
|
|
|
proc = Process(target=func, *args, **kwargs)
|
|
proc.start()
|
|
return proc
|
|
|
|
|
|
def _parse_args(argv):
|
|
"""Parse command line arguments.
|
|
|
|
Args:
|
|
argv: A list of arguments.
|
|
|
|
Returns:
|
|
An argspace.Namespace class instance holding parsed args.
|
|
"""
|
|
# Store everything after '--' in custom_args.
|
|
pruned_argv = argv
|
|
custom_args_index = None
|
|
if CUSTOM_ARG_FLAG in argv:
|
|
custom_args_index = argv.index(CUSTOM_ARG_FLAG)
|
|
pruned_argv = argv[:custom_args_index]
|
|
parser = atest_arg_parser.AtestArgParser()
|
|
parser.add_atest_args()
|
|
args = parser.parse_args(pruned_argv)
|
|
args.custom_args = []
|
|
if custom_args_index is not None:
|
|
for arg in argv[custom_args_index+1:]:
|
|
logging.debug('Quoting regex argument %s', arg)
|
|
args.custom_args.append(atest_utils.quote(arg))
|
|
return args
|
|
|
|
|
|
def _configure_logging(verbose):
|
|
"""Configure the logger.
|
|
|
|
Args:
|
|
verbose: A boolean. If true display DEBUG level logs.
|
|
"""
|
|
# Clear the handlers to prevent logging.basicConfig from being called twice.
|
|
logging.getLogger('').handlers = []
|
|
log_format = '%(asctime)s %(filename)s:%(lineno)s:%(levelname)s: %(message)s'
|
|
datefmt = '%Y-%m-%d %H:%M:%S'
|
|
if verbose:
|
|
logging.basicConfig(level=logging.DEBUG,
|
|
format=log_format, datefmt=datefmt)
|
|
else:
|
|
logging.basicConfig(level=logging.INFO,
|
|
format=log_format, datefmt=datefmt)
|
|
|
|
|
|
def _missing_environment_variables():
|
|
"""Verify the local environment has been set up to run atest.
|
|
|
|
Returns:
|
|
List of strings of any missing environment variables.
|
|
"""
|
|
missing = list(filter(None, [x for x in EXPECTED_VARS if not os.environ.get(x)]))
|
|
if missing:
|
|
logging.error('Local environment doesn\'t appear to have been '
|
|
'initialized. Did you remember to run lunch? Expected '
|
|
'Environment Variables: %s.', missing)
|
|
return missing
|
|
|
|
|
|
def make_test_run_dir():
|
|
"""Make the test run dir in ATEST_RESULT_ROOT.
|
|
|
|
Returns:
|
|
A string of the dir path.
|
|
"""
|
|
if not os.path.exists(constants.ATEST_RESULT_ROOT):
|
|
os.makedirs(constants.ATEST_RESULT_ROOT)
|
|
ctime = time.strftime(TEST_RUN_DIR_PREFIX, time.localtime())
|
|
test_result_dir = tempfile.mkdtemp(prefix='%s_' % ctime,
|
|
dir=constants.ATEST_RESULT_ROOT)
|
|
return test_result_dir
|
|
|
|
|
|
def get_extra_args(args):
|
|
"""Get extra args for test runners.
|
|
|
|
Args:
|
|
args: arg parsed object.
|
|
|
|
Returns:
|
|
Dict of extra args for test runners to utilize.
|
|
"""
|
|
extra_args = {}
|
|
if args.wait_for_debugger:
|
|
extra_args[constants.WAIT_FOR_DEBUGGER] = None
|
|
steps = args.steps or constants.ALL_STEPS
|
|
if constants.INSTALL_STEP not in steps:
|
|
extra_args[constants.DISABLE_INSTALL] = None
|
|
# The key and its value of the dict can be called via:
|
|
# if args.aaaa:
|
|
# extra_args[constants.AAAA] = args.aaaa
|
|
arg_maps = {'all_abi': constants.ALL_ABI,
|
|
'collect_tests_only': constants.COLLECT_TESTS_ONLY,
|
|
'custom_args': constants.CUSTOM_ARGS,
|
|
'disable_teardown': constants.DISABLE_TEARDOWN,
|
|
'dry_run': constants.DRY_RUN,
|
|
'generate_baseline': constants.PRE_PATCH_ITERATIONS,
|
|
'generate_new_metrics': constants.POST_PATCH_ITERATIONS,
|
|
'host': constants.HOST,
|
|
'instant': constants.INSTANT,
|
|
'iterations': constants.ITERATIONS,
|
|
'rerun_until_failure': constants.RERUN_UNTIL_FAILURE,
|
|
'retry_any_failure': constants.RETRY_ANY_FAILURE,
|
|
'serial': constants.SERIAL,
|
|
'sharding': constants.SHARDING,
|
|
'tf_debug': constants.TF_DEBUG,
|
|
'tf_template': constants.TF_TEMPLATE,
|
|
'user_type': constants.USER_TYPE,
|
|
'flakes_info': constants.FLAKES_INFO,
|
|
'tf_early_device_release': constants.TF_EARLY_DEVICE_RELEASE,
|
|
'request_upload_result': constants.REQUEST_UPLOAD_RESULT}
|
|
not_match = [k for k in arg_maps if k not in vars(args)]
|
|
if not_match:
|
|
raise AttributeError('%s object has no attribute %s'
|
|
%(type(args).__name__, not_match))
|
|
extra_args.update({arg_maps.get(k): v for k, v in vars(args).items()
|
|
if arg_maps.get(k) and v})
|
|
return extra_args
|
|
|
|
|
|
def _get_regression_detection_args(args, results_dir):
|
|
"""Get args for regression detection test runners.
|
|
|
|
Args:
|
|
args: parsed args object.
|
|
results_dir: string directory to store atest results.
|
|
|
|
Returns:
|
|
Dict of args for regression detection test runner to utilize.
|
|
"""
|
|
regression_args = {}
|
|
pre_patch_folder = (os.path.join(results_dir, 'baseline-metrics') if args.generate_baseline
|
|
else args.detect_regression.pop(0))
|
|
post_patch_folder = (os.path.join(results_dir, 'new-metrics') if args.generate_new_metrics
|
|
else args.detect_regression.pop(0))
|
|
regression_args[constants.PRE_PATCH_FOLDER] = pre_patch_folder
|
|
regression_args[constants.POST_PATCH_FOLDER] = post_patch_folder
|
|
return regression_args
|
|
|
|
|
|
def _validate_exec_mode(args, test_infos, host_tests=None):
|
|
"""Validate all test execution modes are not in conflict.
|
|
|
|
Exit the program with error code if have device-only and host-only.
|
|
If no conflict and host side, add args.host=True.
|
|
|
|
Args:
|
|
args: parsed args object.
|
|
test_info: TestInfo object.
|
|
host_tests: True if all tests should be deviceless, False if all tests
|
|
should be device tests. Default is set to None, which means
|
|
tests can be either deviceless or device tests.
|
|
"""
|
|
all_device_modes = [x.get_supported_exec_mode() for x in test_infos]
|
|
err_msg = None
|
|
# In the case of '$atest <device-only> --host', exit.
|
|
if (host_tests or args.host) and constants.DEVICE_TEST in all_device_modes:
|
|
device_only_tests = [x.test_name for x in test_infos
|
|
if x.get_supported_exec_mode() == constants.DEVICE_TEST]
|
|
err_msg = ('Specified --host, but the following tests are device-only:\n ' +
|
|
'\n '.join(sorted(device_only_tests)) + '\nPlease remove the option '
|
|
'when running device-only tests.')
|
|
# In the case of '$atest <host-only> <device-only> --host' or
|
|
# '$atest <host-only> <device-only>', exit.
|
|
if (constants.DEVICELESS_TEST in all_device_modes and
|
|
constants.DEVICE_TEST in all_device_modes):
|
|
err_msg = 'There are host-only and device-only tests in command.'
|
|
if host_tests is False and constants.DEVICELESS_TEST in all_device_modes:
|
|
err_msg = 'There are host-only tests in command.'
|
|
if err_msg:
|
|
logging.error(err_msg)
|
|
metrics_utils.send_exit_event(constants.EXIT_CODE_ERROR, logs=err_msg)
|
|
sys.exit(constants.EXIT_CODE_ERROR)
|
|
# In the case of '$atest <host-only>', we add --host to run on host-side.
|
|
# The option should only be overridden if `host_tests` is not set.
|
|
if not args.host and host_tests is None:
|
|
args.host = bool(constants.DEVICELESS_TEST in all_device_modes)
|
|
|
|
|
|
def _validate_tm_tests_exec_mode(args, test_infos):
|
|
"""Validate all test execution modes are not in conflict.
|
|
|
|
Split the tests in Test Mapping files into two groups, device tests and
|
|
deviceless tests running on host. Validate the tests' host setting.
|
|
For device tests, exit the program if any test is found for host-only.
|
|
For deviceless tests, exit the program if any test is found for device-only.
|
|
|
|
Args:
|
|
args: parsed args object.
|
|
test_info: TestInfo object.
|
|
"""
|
|
device_test_infos, host_test_infos = _split_test_mapping_tests(
|
|
test_infos)
|
|
# No need to verify device tests if atest command is set to only run host
|
|
# tests.
|
|
if device_test_infos and not args.host:
|
|
_validate_exec_mode(args, device_test_infos, host_tests=False)
|
|
if host_test_infos:
|
|
_validate_exec_mode(args, host_test_infos, host_tests=True)
|
|
|
|
|
|
def _will_run_tests(args):
|
|
"""Determine if there are tests to run.
|
|
|
|
Currently only used by detect_regression to skip the test if just running
|
|
regression detection.
|
|
|
|
Args:
|
|
args: parsed args object.
|
|
|
|
Returns:
|
|
True if there are tests to run, false otherwise.
|
|
"""
|
|
return not (args.detect_regression and len(args.detect_regression) == 2)
|
|
|
|
|
|
# pylint: disable=no-else-return
|
|
# This method is going to dispose, let's ignore pylint for now.
|
|
def _has_valid_regression_detection_args(args):
|
|
"""Validate regression detection args.
|
|
|
|
Args:
|
|
args: parsed args object.
|
|
|
|
Returns:
|
|
True if args are valid
|
|
"""
|
|
if args.generate_baseline and args.generate_new_metrics:
|
|
logging.error('Cannot collect both baseline and new metrics'
|
|
'at the same time.')
|
|
return False
|
|
if args.detect_regression is not None:
|
|
if not args.detect_regression:
|
|
logging.error('Need to specify at least 1 arg for'
|
|
' regression detection.')
|
|
return False
|
|
elif len(args.detect_regression) == 1:
|
|
if args.generate_baseline or args.generate_new_metrics:
|
|
return True
|
|
logging.error('Need to specify --generate-baseline or'
|
|
' --generate-new-metrics.')
|
|
return False
|
|
elif len(args.detect_regression) == 2:
|
|
if args.generate_baseline:
|
|
logging.error('Specified 2 metric paths and --generate-baseline'
|
|
', either drop --generate-baseline or drop a path')
|
|
return False
|
|
if args.generate_new_metrics:
|
|
logging.error('Specified 2 metric paths and --generate-new-metrics, '
|
|
'either drop --generate-new-metrics or drop a path')
|
|
return False
|
|
return True
|
|
else:
|
|
logging.error('Specified more than 2 metric paths.')
|
|
return False
|
|
return True
|
|
|
|
|
|
def _has_valid_test_mapping_args(args):
|
|
"""Validate test mapping args.
|
|
|
|
Not all args work when running tests in TEST_MAPPING files. Validate the
|
|
args before running the tests.
|
|
|
|
Args:
|
|
args: parsed args object.
|
|
|
|
Returns:
|
|
True if args are valid
|
|
"""
|
|
is_test_mapping = atest_utils.is_test_mapping(args)
|
|
if not is_test_mapping:
|
|
return True
|
|
options_to_validate = [
|
|
(args.generate_baseline, '--generate-baseline'),
|
|
(args.detect_regression, '--detect-regression'),
|
|
(args.generate_new_metrics, '--generate-new-metrics'),
|
|
]
|
|
for arg_value, arg in options_to_validate:
|
|
if arg_value:
|
|
logging.error(OPTION_NOT_FOR_TEST_MAPPING, arg)
|
|
return False
|
|
return True
|
|
|
|
|
|
def _validate_args(args):
|
|
"""Validate setups and args.
|
|
|
|
Exit the program with error code if any setup or arg is invalid.
|
|
|
|
Args:
|
|
args: parsed args object.
|
|
"""
|
|
if _missing_environment_variables():
|
|
sys.exit(constants.EXIT_CODE_ENV_NOT_SETUP)
|
|
if args.generate_baseline and args.generate_new_metrics:
|
|
logging.error(
|
|
'Cannot collect both baseline and new metrics at the same time.')
|
|
sys.exit(constants.EXIT_CODE_ERROR)
|
|
if not _has_valid_regression_detection_args(args):
|
|
sys.exit(constants.EXIT_CODE_ERROR)
|
|
if not _has_valid_test_mapping_args(args):
|
|
sys.exit(constants.EXIT_CODE_ERROR)
|
|
|
|
|
|
def _print_module_info_from_module_name(mod_info, module_name):
|
|
"""print out the related module_info for a module_name.
|
|
|
|
Args:
|
|
mod_info: ModuleInfo object.
|
|
module_name: A string of module.
|
|
|
|
Returns:
|
|
True if the module_info is found.
|
|
"""
|
|
title_mapping = collections.OrderedDict()
|
|
title_mapping[constants.MODULE_COMPATIBILITY_SUITES] = 'Compatibility suite'
|
|
title_mapping[constants.MODULE_PATH] = 'Source code path'
|
|
title_mapping[constants.MODULE_INSTALLED] = 'Installed path'
|
|
target_module_info = mod_info.get_module_info(module_name)
|
|
is_module_found = False
|
|
if target_module_info:
|
|
atest_utils.colorful_print(module_name, constants.GREEN)
|
|
for title_key in title_mapping:
|
|
atest_utils.colorful_print("\t%s" % title_mapping[title_key],
|
|
constants.CYAN)
|
|
for info_value in target_module_info[title_key]:
|
|
print("\t\t{}".format(info_value))
|
|
is_module_found = True
|
|
return is_module_found
|
|
|
|
|
|
def _print_test_info(mod_info, test_infos):
|
|
"""Print the module information from TestInfos.
|
|
|
|
Args:
|
|
mod_info: ModuleInfo object.
|
|
test_infos: A list of TestInfos.
|
|
|
|
Returns:
|
|
Always return EXIT_CODE_SUCCESS
|
|
"""
|
|
for test_info in test_infos:
|
|
_print_module_info_from_module_name(mod_info, test_info.test_name)
|
|
atest_utils.colorful_print("\tRelated build targets", constants.MAGENTA)
|
|
sorted_build_targets = sorted(list(test_info.build_targets))
|
|
print("\t\t{}".format(", ".join(sorted_build_targets)))
|
|
for build_target in sorted_build_targets:
|
|
if build_target != test_info.test_name:
|
|
_print_module_info_from_module_name(mod_info, build_target)
|
|
atest_utils.colorful_print("", constants.WHITE)
|
|
return constants.EXIT_CODE_SUCCESS
|
|
|
|
|
|
def is_from_test_mapping(test_infos):
|
|
"""Check that the test_infos came from TEST_MAPPING files.
|
|
|
|
Args:
|
|
test_infos: A set of TestInfos.
|
|
|
|
Returns:
|
|
True if the test infos are from TEST_MAPPING files.
|
|
"""
|
|
return list(test_infos)[0].from_test_mapping
|
|
|
|
|
|
def _split_test_mapping_tests(test_infos):
|
|
"""Split Test Mapping tests into 2 groups: device tests and host tests.
|
|
|
|
Args:
|
|
test_infos: A set of TestInfos.
|
|
|
|
Returns:
|
|
A tuple of (device_test_infos, host_test_infos), where
|
|
device_test_infos: A set of TestInfos for tests that require device.
|
|
host_test_infos: A set of TestInfos for tests that do NOT require
|
|
device.
|
|
"""
|
|
assert is_from_test_mapping(test_infos)
|
|
host_test_infos = {info for info in test_infos if info.host}
|
|
device_test_infos = {info for info in test_infos if not info.host}
|
|
return device_test_infos, host_test_infos
|
|
|
|
|
|
# pylint: disable=too-many-locals
|
|
def _run_test_mapping_tests(results_dir, test_infos, extra_args, mod_info):
|
|
"""Run all tests in TEST_MAPPING files.
|
|
|
|
Args:
|
|
results_dir: String directory to store atest results.
|
|
test_infos: A set of TestInfos.
|
|
extra_args: Dict of extra args to add to test run.
|
|
mod_info: ModuleInfo object.
|
|
|
|
Returns:
|
|
Exit code.
|
|
"""
|
|
device_test_infos, host_test_infos = _split_test_mapping_tests(test_infos)
|
|
# `host` option needs to be set to True to run host side tests.
|
|
host_extra_args = extra_args.copy()
|
|
host_extra_args[constants.HOST] = True
|
|
test_runs = [(host_test_infos, host_extra_args, HOST_TESTS)]
|
|
if extra_args.get(constants.HOST):
|
|
atest_utils.colorful_print(
|
|
'Option `--host` specified. Skip running device tests.',
|
|
constants.MAGENTA)
|
|
else:
|
|
test_runs.append((device_test_infos, extra_args, DEVICE_TESTS))
|
|
|
|
test_results = []
|
|
for tests, args, test_type in test_runs:
|
|
if not tests:
|
|
continue
|
|
header = RUN_HEADER_FMT % {TEST_COUNT: len(tests), TEST_TYPE: test_type}
|
|
atest_utils.colorful_print(header, constants.MAGENTA)
|
|
logging.debug('\n'.join([str(info) for info in tests]))
|
|
tests_exit_code, reporter = test_runner_handler.run_all_tests(
|
|
results_dir, tests, args, mod_info, delay_print_summary=True)
|
|
atest_execution_info.AtestExecutionInfo.result_reporters.append(reporter)
|
|
test_results.append((tests_exit_code, reporter, test_type))
|
|
|
|
all_tests_exit_code = constants.EXIT_CODE_SUCCESS
|
|
failed_tests = []
|
|
for tests_exit_code, reporter, test_type in test_results:
|
|
atest_utils.colorful_print(
|
|
RESULT_HEADER_FMT % {TEST_TYPE: test_type}, constants.MAGENTA)
|
|
result = tests_exit_code | reporter.print_summary()
|
|
if result:
|
|
failed_tests.append(test_type)
|
|
all_tests_exit_code |= result
|
|
|
|
# List failed tests at the end as a reminder.
|
|
if failed_tests:
|
|
atest_utils.colorful_print(
|
|
atest_utils.delimiter('=', 30, prenl=1), constants.YELLOW)
|
|
atest_utils.colorful_print(
|
|
'\nFollowing tests failed:', constants.MAGENTA)
|
|
for failure in failed_tests:
|
|
atest_utils.colorful_print(failure, constants.RED)
|
|
|
|
return all_tests_exit_code
|
|
|
|
|
|
def _dry_run(results_dir, extra_args, test_infos, mod_info):
|
|
"""Only print the commands of the target tests rather than running them in actual.
|
|
|
|
Args:
|
|
results_dir: Path for saving atest logs.
|
|
extra_args: Dict of extra args for test runners to utilize.
|
|
test_infos: A list of TestInfos.
|
|
mod_info: ModuleInfo object.
|
|
|
|
Returns:
|
|
A list of test commands.
|
|
"""
|
|
all_run_cmds = []
|
|
for test_runner, tests in test_runner_handler.group_tests_by_test_runners(test_infos):
|
|
runner = test_runner(results_dir, module_info=mod_info)
|
|
run_cmds = runner.generate_run_commands(tests, extra_args)
|
|
for run_cmd in run_cmds:
|
|
all_run_cmds.append(run_cmd)
|
|
print('Would run test via command: %s'
|
|
% (atest_utils.colorize(run_cmd, constants.GREEN)))
|
|
return all_run_cmds
|
|
|
|
def _print_testable_modules(mod_info, suite):
|
|
"""Print the testable modules for a given suite.
|
|
|
|
Args:
|
|
mod_info: ModuleInfo object.
|
|
suite: A string of suite name.
|
|
"""
|
|
testable_modules = mod_info.get_testable_modules(suite)
|
|
print('\n%s' % atest_utils.colorize('%s Testable %s modules' % (
|
|
len(testable_modules), suite), constants.CYAN))
|
|
print(atest_utils.delimiter('-'))
|
|
for module in sorted(testable_modules):
|
|
print('\t%s' % module)
|
|
|
|
def _is_inside_android_root():
|
|
"""Identify whether the cwd is inside of Android source tree.
|
|
|
|
Returns:
|
|
False if the cwd is outside of the source tree, True otherwise.
|
|
"""
|
|
build_top = os.getenv(constants.ANDROID_BUILD_TOP, ' ')
|
|
return build_top in os.getcwd()
|
|
|
|
def _non_action_validator(args):
|
|
"""Method for non-action arguments such as --version, --help, --history,
|
|
--latest_result, etc.
|
|
|
|
Args:
|
|
args: An argspace.Namespace class instance holding parsed args.
|
|
"""
|
|
if not _is_inside_android_root():
|
|
atest_utils.colorful_print(
|
|
"\nAtest must always work under ${}!".format(
|
|
constants.ANDROID_BUILD_TOP), constants.RED)
|
|
sys.exit(constants.EXIT_CODE_OUTSIDE_ROOT)
|
|
if args.version:
|
|
if os.path.isfile(constants.VERSION_FILE):
|
|
with open(constants.VERSION_FILE) as version_file:
|
|
print(version_file.read())
|
|
sys.exit(constants.EXIT_CODE_SUCCESS)
|
|
if args.help:
|
|
atest_arg_parser.print_epilog_text()
|
|
sys.exit(constants.EXIT_CODE_SUCCESS)
|
|
if args.history:
|
|
atest_execution_info.print_test_result(constants.ATEST_RESULT_ROOT,
|
|
args.history)
|
|
sys.exit(constants.EXIT_CODE_SUCCESS)
|
|
if args.latest_result:
|
|
atest_execution_info.print_test_result_by_path(
|
|
constants.LATEST_RESULT_FILE)
|
|
sys.exit(constants.EXIT_CODE_SUCCESS)
|
|
# TODO(b/131879842): remove below statement after they are fully removed.
|
|
if any((args.detect_regression,
|
|
args.generate_baseline,
|
|
args.generate_new_metrics)):
|
|
stop_msg = ('Please STOP using arguments below -- they are obsolete and '
|
|
'will be removed in a very near future:\n'
|
|
'\t--detect-regression\n'
|
|
'\t--generate-baseline\n'
|
|
'\t--generate-new-metrics\n')
|
|
msg = ('Please use below arguments instead:\n'
|
|
'\t--iterations\n'
|
|
'\t--rerun-until-failure\n'
|
|
'\t--retry-any-failure\n')
|
|
atest_utils.colorful_print(stop_msg, constants.RED)
|
|
atest_utils.colorful_print(msg, constants.CYAN)
|
|
|
|
def _dry_run_validator(args, results_dir, extra_args, test_infos, mod_info):
|
|
"""Method which process --dry-run argument.
|
|
|
|
Args:
|
|
args: An argspace.Namespace class instance holding parsed args.
|
|
result_dir: A string path of the results dir.
|
|
extra_args: A dict of extra args for test runners to utilize.
|
|
test_infos: A list of test_info.
|
|
mod_info: ModuleInfo object.
|
|
Returns:
|
|
Exit code.
|
|
"""
|
|
args.tests.sort()
|
|
dry_run_cmds = _dry_run(results_dir, extra_args, test_infos, mod_info)
|
|
if args.verify_cmd_mapping:
|
|
try:
|
|
atest_utils.handle_test_runner_cmd(' '.join(args.tests),
|
|
dry_run_cmds,
|
|
do_verification=True)
|
|
except atest_error.DryRunVerificationError as e:
|
|
atest_utils.colorful_print(str(e), constants.RED)
|
|
return constants.EXIT_CODE_VERIFY_FAILURE
|
|
if args.update_cmd_mapping:
|
|
atest_utils.handle_test_runner_cmd(' '.join(args.tests),
|
|
dry_run_cmds)
|
|
return constants.EXIT_CODE_SUCCESS
|
|
|
|
def _exclude_modules_in_targets(build_targets):
|
|
"""Method that excludes MODULES-IN-* targets.
|
|
|
|
Args:
|
|
build_targets: A set of build targets.
|
|
|
|
Returns:
|
|
A set of build targets that excludes MODULES-IN-*.
|
|
"""
|
|
shrank_build_targets = build_targets.copy()
|
|
logging.debug('Will exclude all "%s*" from the build targets.',
|
|
constants.MODULES_IN)
|
|
for target in build_targets:
|
|
if target.startswith(constants.MODULES_IN):
|
|
logging.debug('Ignore %s.', target)
|
|
shrank_build_targets.remove(target)
|
|
return shrank_build_targets
|
|
|
|
def acloud_create_validator(results_dir, args):
|
|
"""Check lunch'd target before running 'acloud create'.
|
|
|
|
Args:
|
|
results_dir: A string of the results directory.
|
|
args: A list of arguments.
|
|
|
|
Returns:
|
|
If the target is valid:
|
|
A tuple of (multiprocessing.Process,
|
|
string of report file path)
|
|
else:
|
|
None, None
|
|
"""
|
|
if not any((args.acloud_create, args.start_avd)):
|
|
return None, None
|
|
if args.start_avd:
|
|
args.acloud_create = ['--num=1']
|
|
acloud_args = ' '.join(args.acloud_create)
|
|
target = os.getenv('TARGET_PRODUCT', "")
|
|
if 'cf_x86' in target:
|
|
report_file = at.get_report_file(results_dir, acloud_args)
|
|
acloud_proc = _run_multi_proc(
|
|
func=ACLOUD_CREATE,
|
|
args=[report_file],
|
|
kwargs={'args':acloud_args,
|
|
'no_metrics_notice':args.no_metrics})
|
|
return acloud_proc, report_file
|
|
atest_utils.colorful_print(
|
|
'{} is not cf_x86 family; will not create any AVD.'.format(target),
|
|
constants.RED)
|
|
return None, None
|
|
|
|
# pylint: disable=too-many-statements
|
|
# pylint: disable=too-many-branches
|
|
# pylint: disable=too-many-return-statements
|
|
def main(argv, results_dir, args):
|
|
"""Entry point of atest script.
|
|
|
|
Args:
|
|
argv: A list of arguments.
|
|
results_dir: A directory which stores the ATest execution information.
|
|
args: An argspace.Namespace class instance holding parsed args.
|
|
|
|
Returns:
|
|
Exit code.
|
|
"""
|
|
_configure_logging(args.verbose)
|
|
_validate_args(args)
|
|
metrics_utils.get_start_time()
|
|
os_pyver = '{}:{}'.format(platform.platform(), platform.python_version())
|
|
metrics.AtestStartEvent(
|
|
command_line=' '.join(argv),
|
|
test_references=args.tests,
|
|
cwd=os.getcwd(),
|
|
os=os_pyver)
|
|
_non_action_validator(args)
|
|
proc_acloud, report_file = acloud_create_validator(results_dir, args)
|
|
mod_info = module_info.ModuleInfo(force_build=args.rebuild_module_info)
|
|
if args.rebuild_module_info:
|
|
proc_idx = _run_multi_proc(INDEX_TARGETS)
|
|
proc_idx.join()
|
|
translator = cli_translator.CLITranslator(
|
|
module_info=mod_info,
|
|
print_cache_msg=not args.clear_cache)
|
|
if args.list_modules:
|
|
_print_testable_modules(mod_info, args.list_modules)
|
|
return constants.EXIT_CODE_SUCCESS
|
|
build_targets = set()
|
|
test_infos = set()
|
|
if _will_run_tests(args):
|
|
find_start = time.time()
|
|
build_targets, test_infos = translator.translate(args)
|
|
if args.no_modules_in:
|
|
build_targets = _exclude_modules_in_targets(build_targets)
|
|
find_duration = time.time() - find_start
|
|
if not test_infos:
|
|
return constants.EXIT_CODE_TEST_NOT_FOUND
|
|
if not is_from_test_mapping(test_infos):
|
|
_validate_exec_mode(args, test_infos)
|
|
else:
|
|
_validate_tm_tests_exec_mode(args, test_infos)
|
|
if args.info:
|
|
return _print_test_info(mod_info, test_infos)
|
|
build_targets |= test_runner_handler.get_test_runner_reqs(mod_info,
|
|
test_infos)
|
|
extra_args = get_extra_args(args)
|
|
if any((args.update_cmd_mapping, args.verify_cmd_mapping, args.dry_run)):
|
|
return _dry_run_validator(args, results_dir, extra_args, test_infos,
|
|
mod_info)
|
|
if args.detect_regression:
|
|
build_targets |= (regression_test_runner.RegressionTestRunner('')
|
|
.get_test_runner_build_reqs())
|
|
# args.steps will be None if none of -bit set, else list of params set.
|
|
steps = args.steps if args.steps else constants.ALL_STEPS
|
|
if build_targets and constants.BUILD_STEP in steps:
|
|
if constants.TEST_STEP in steps and not args.rebuild_module_info:
|
|
# Run extra tasks along with build step concurrently. Note that
|
|
# Atest won't index targets when only "-b" is given(without -t).
|
|
proc_idx = _run_multi_proc(INDEX_TARGETS, daemon=True)
|
|
# Add module-info.json target to the list of build targets to keep the
|
|
# file up to date.
|
|
build_targets.add(mod_info.module_info_target)
|
|
build_start = time.time()
|
|
success = atest_utils.build(build_targets, verbose=args.verbose)
|
|
build_duration = time.time() - build_start
|
|
metrics.BuildFinishEvent(
|
|
duration=metrics_utils.convert_duration(build_duration),
|
|
success=success,
|
|
targets=build_targets)
|
|
rebuild_module_info = constants.DETECT_TYPE_NOT_REBUILD_MODULE_INFO
|
|
if args.rebuild_module_info:
|
|
rebuild_module_info = constants.DETECT_TYPE_REBUILD_MODULE_INFO
|
|
metrics.LocalDetectEvent(
|
|
detect_type=rebuild_module_info,
|
|
result=int(build_duration))
|
|
if not success:
|
|
return constants.EXIT_CODE_BUILD_FAILURE
|
|
# Always reload module-info after build finish.
|
|
# TODO(b/178675689) Move it to a thread when running test.
|
|
mod_info.generate_atest_merged_dep_file()
|
|
if proc_acloud:
|
|
proc_acloud.join()
|
|
status = at.probe_acloud_status(report_file)
|
|
if status != 0:
|
|
return status
|
|
acloud_duration = at.get_acloud_duration(report_file)
|
|
find_build_duration = find_duration + build_duration
|
|
if find_build_duration - acloud_duration >= 0:
|
|
# find+build took longer, saved acloud create time.
|
|
logging.debug('Saved acloud create time: %ss.',
|
|
acloud_duration)
|
|
metrics.LocalDetectEvent(
|
|
detect_type=constants.DETECT_TYPE_ACLOUD_CREATE,
|
|
result=round(acloud_duration))
|
|
else:
|
|
# acloud create took longer, saved find+build time.
|
|
logging.debug('Saved Find and Build time: %ss.',
|
|
find_build_duration)
|
|
metrics.LocalDetectEvent(
|
|
detect_type=constants.DETECT_TYPE_FIND_BUILD,
|
|
result=round(find_build_duration))
|
|
elif constants.TEST_STEP not in steps:
|
|
logging.warning('Install step without test step currently not '
|
|
'supported, installing AND testing instead.')
|
|
steps.append(constants.TEST_STEP)
|
|
tests_exit_code = constants.EXIT_CODE_SUCCESS
|
|
test_start = time.time()
|
|
if constants.TEST_STEP in steps:
|
|
if not is_from_test_mapping(test_infos):
|
|
tests_exit_code, reporter = test_runner_handler.run_all_tests(
|
|
results_dir, test_infos, extra_args, mod_info)
|
|
atest_execution_info.AtestExecutionInfo.result_reporters.append(reporter)
|
|
else:
|
|
tests_exit_code = _run_test_mapping_tests(
|
|
results_dir, test_infos, extra_args, mod_info)
|
|
if args.detect_regression:
|
|
regression_args = _get_regression_detection_args(args, results_dir)
|
|
# TODO(b/110485713): Should not call run_tests here.
|
|
reporter = result_reporter.ResultReporter(
|
|
collect_only=extra_args.get(constants.COLLECT_TESTS_ONLY))
|
|
atest_execution_info.AtestExecutionInfo.result_reporters.append(reporter)
|
|
tests_exit_code |= regression_test_runner.RegressionTestRunner(
|
|
'').run_tests(
|
|
None, regression_args, reporter)
|
|
metrics.RunTestsFinishEvent(
|
|
duration=metrics_utils.convert_duration(time.time() - test_start))
|
|
preparation_time = atest_execution_info.preparation_time(test_start)
|
|
if preparation_time:
|
|
# Send the preparation time only if it's set.
|
|
metrics.RunnerFinishEvent(
|
|
duration=metrics_utils.convert_duration(preparation_time),
|
|
success=True,
|
|
runner_name=constants.TF_PREPARATION,
|
|
test=[])
|
|
if tests_exit_code != constants.EXIT_CODE_SUCCESS:
|
|
tests_exit_code = constants.EXIT_CODE_TEST_FAILURE
|
|
return tests_exit_code
|
|
|
|
if __name__ == '__main__':
|
|
RESULTS_DIR = make_test_run_dir()
|
|
atest_configs.GLOBAL_ARGS = _parse_args(sys.argv[1:])
|
|
with atest_execution_info.AtestExecutionInfo(
|
|
sys.argv[1:], RESULTS_DIR,
|
|
atest_configs.GLOBAL_ARGS) as result_file:
|
|
if not atest_configs.GLOBAL_ARGS.no_metrics:
|
|
atest_utils.print_data_collection_notice()
|
|
USER_FROM_TOOL = os.getenv(constants.USER_FROM_TOOL, '')
|
|
if USER_FROM_TOOL == '':
|
|
metrics_base.MetricsBase.tool_name = constants.TOOL_NAME
|
|
else:
|
|
metrics_base.MetricsBase.tool_name = USER_FROM_TOOL
|
|
|
|
EXIT_CODE = main(sys.argv[1:], RESULTS_DIR, atest_configs.GLOBAL_ARGS)
|
|
DETECTOR = bug_detector.BugDetector(sys.argv[1:], EXIT_CODE)
|
|
if EXIT_CODE not in constants.EXIT_CODES_BEFORE_TEST:
|
|
metrics.LocalDetectEvent(
|
|
detect_type=constants.DETECT_TYPE_BUG_DETECTED,
|
|
result=DETECTOR.caught_result)
|
|
if result_file:
|
|
print("Run 'atest --history' to review test result history.")
|
|
sys.exit(EXIT_CODE)
|