xref: /aosp_15_r20/art/test/testrunner/env.py (revision 795d594fd825385562da6b089ea9b2033f3abf5a)
1# Copyright 2017, The Android Open Source Project
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7#     http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15import os
16import re
17import tempfile
18import subprocess
19
20_env = dict(os.environ)
21
22# Check if we are running from the build system.
23ART_TEST_RUN_FROM_SOONG = os.environ.get("ART_TEST_RUN_FROM_SOONG")
24
25if not ART_TEST_RUN_FROM_SOONG:
26  # begin import $ANDROID_BUILD_TOP/art/tools/build/var_cache.py
27  _THIS_DIR = os.path.dirname(os.path.realpath(__file__))
28  _TOP = os.path.join(_THIS_DIR, "../../..")
29  _VAR_CACHE_DIR = os.path.join(_TOP, "art/tools/build/")
30
31  import sys
32  sys.path.append(_VAR_CACHE_DIR)
33  import var_cache  # type: ignore
34  # end import var_cache.py
35
36def _getEnvBoolean(var, default):
37  val = _env.get(var)
38  if val:
39    if val == "True" or val == "true":
40      return True
41    if val == "False" or val == "false":
42      return False
43  return default
44
45def _get_build_var(var_name):
46  if ART_TEST_RUN_FROM_SOONG:
47    return _env.get(var_name)
48  return var_cache.get_build_var(var_name)
49
50def _get_build_var_boolean(var, default):
51  val = _get_build_var(var)
52  if val:
53    if val == "True" or val == "true":
54      return True
55    if val == "False" or val == "false":
56      return False
57  return default
58
59def get_env(key):
60  return _env.get(key)
61
62def _get_android_build_top():
63  path_to_top = _env.get('ANDROID_BUILD_TOP')
64  if not path_to_top:
65    # nothing set. try to guess it based on the relative path of this env.py file.
66    this_file_path = os.path.realpath(__file__)
67    path_to_top = os.path.join(os.path.dirname(this_file_path), '../../../')
68    path_to_top = os.path.realpath(path_to_top)
69
70  if not os.path.exists(os.path.join(path_to_top, 'build/envsetup.sh')):
71    if not ART_TEST_RUN_FROM_SOONG:
72      raise AssertionError("env.py must be located inside an android source tree")
73
74  return path_to_top
75
76ANDROID_BUILD_TOP = _get_android_build_top()
77
78# Directory used to store files build by the run-test script.
79ART_TEST_RUN_TEST_BUILD_PATH = _env.get('ART_TEST_RUN_TEST_BUILD_PATH')
80
81# Keep going after encountering a test failure?
82ART_TEST_KEEP_GOING = _getEnvBoolean('ART_TEST_KEEP_GOING', True)
83
84# Do you want failed tests to have their artifacts cleaned up?
85ART_TEST_RUN_TEST_ALWAYS_CLEAN = _getEnvBoolean('ART_TEST_RUN_TEST_ALWAYS_CLEAN', True)
86
87ART_TEST_BISECTION = _getEnvBoolean('ART_TEST_BISECTION', False)
88
89# Do you want run-tests with the host/target's second arch?
90ART_TEST_RUN_TEST_2ND_ARCH = _getEnvBoolean('ART_TEST_RUN_TEST_2ND_ARCH', True)
91
92HOST_2ND_ARCH_PREFIX = _get_build_var('HOST_2ND_ARCH_PREFIX')
93
94ART_TEST_CHROOT = _env.get('ART_TEST_CHROOT')
95ART_TEST_ANDROID_ROOT = _env.get('ART_TEST_ANDROID_ROOT')
96ART_TEST_ANDROID_ART_ROOT = _env.get('ART_TEST_ANDROID_ART_ROOT')
97ART_TEST_ANDROID_I18N_ROOT = _env.get('ART_TEST_ANDROID_I18N_ROOT')
98ART_TEST_ANDROID_TZDATA_ROOT = _env.get('ART_TEST_ANDROID_TZDATA_ROOT')
99
100ART_TEST_WITH_STRACE = _getEnvBoolean('ART_TEST_DEBUG_GC', False)
101
102EXTRA_DISABLED_TESTS = set(_env.get("ART_TEST_RUN_TEST_SKIP", "").split())
103
104ART_TEST_RUN_TEST_BUILD = _getEnvBoolean('ART_TEST_RUN_TEST_BUILD', False)
105
106TARGET_2ND_ARCH = _get_build_var('TARGET_2ND_ARCH')
107TARGET_ARCH = _get_build_var('TARGET_ARCH')
108
109# Note: ART_2ND_PHONY_TEST_TARGET_SUFFIX is 2ND_ART_PHONY_TEST_TARGET_SUFFIX in .mk files
110# Note: ART_2ND_PHONY_TEST_HOST_SUFFIX is 2ND_ART_PHONY_HOST_TARGET_SUFFIX in .mk files
111# Python does not let us have variable names starting with a digit, so it has differ.
112
113if TARGET_2ND_ARCH:
114  if "64" in TARGET_ARCH:
115    ART_PHONY_TEST_TARGET_SUFFIX = "64"
116    ART_2ND_PHONY_TEST_TARGET_SUFFIX = "32"
117  else:
118    ART_PHONY_TEST_TARGET_SUFFIX = "32"
119    ART_2ND_PHONY_TEST_TARGET_SUFFIX = ""
120else:
121  if "64" in TARGET_ARCH:
122    ART_PHONY_TEST_TARGET_SUFFIX = "64"
123    ART_2ND_PHONY_TEST_TARGET_SUFFIX = ""
124  else:
125    ART_PHONY_TEST_TARGET_SUFFIX = "32"
126    ART_2ND_PHONY_TEST_TARGET_SUFFIX = ""
127
128HOST_PREFER_32_BIT = _get_build_var('HOST_PREFER_32_BIT')
129if HOST_PREFER_32_BIT == "true":
130  ART_PHONY_TEST_HOST_SUFFIX = "32"
131  ART_2ND_PHONY_TEST_HOST_SUFFIX = ""
132else:
133  ART_PHONY_TEST_HOST_SUFFIX = "64"
134  ART_2ND_PHONY_TEST_HOST_SUFFIX = "32"
135
136if HOST_OUT_EXECUTABLES := _get_build_var("HOST_OUT_EXECUTABLES"):
137  HOST_OUT_EXECUTABLES = os.path.join(ANDROID_BUILD_TOP, HOST_OUT_EXECUTABLES)
138
139  # Set up default values for $D8, $SMALI, etc to the $HOST_OUT_EXECUTABLES/$name path.
140  for tool in ['smali', 'jasmin', 'd8']:
141    os.environ.setdefault(tool.upper(), HOST_OUT_EXECUTABLES + '/' + tool)
142
143if ANDROID_JAVA_TOOLCHAIN := _get_build_var('ANDROID_JAVA_TOOLCHAIN'):
144  ANDROID_JAVA_TOOLCHAIN = os.path.join(ANDROID_BUILD_TOP, ANDROID_JAVA_TOOLCHAIN)
145
146  # include platform prebuilt java, javac, etc in $PATH.
147  os.environ['PATH'] = ANDROID_JAVA_TOOLCHAIN + ':' + os.environ['PATH']
148
149DIST_DIR = _get_build_var('DIST_DIR')
150SOONG_OUT_DIR = _get_build_var('SOONG_OUT_DIR')
151
152ART_TEST_RUN_ON_ARM_FVP = _getEnvBoolean('ART_TEST_RUN_ON_ARM_FVP', False)
153
154ART_TEST_ON_VM = _env.get('ART_TEST_ON_VM')
155
156ART_TEST_SSH_PORT = _env.get('ART_TEST_SSH_PORT', 10001)
157ART_TEST_SSH_USER = _env.get('ART_TEST_SSH_USER', 'ubuntu')
158ART_TEST_SSH_HOST = _env.get('ART_TEST_SSH_HOST', 'localhost')
159ART_SSH_CONFIG = os.path.join(os.path.dirname(__file__), 'ssh_config')
160ART_SSH_CMD = _env.get('ART_SSH_CMD', f"ssh -q -F {ART_SSH_CONFIG} -p {ART_TEST_SSH_PORT} "
161                                      f"{ART_TEST_SSH_USER}@{ART_TEST_SSH_HOST}")
162ART_SCP_CMD = _env.get('ART_SCP_CMD', f"scp -q -F {ART_SSH_CONFIG} -P {ART_TEST_SSH_PORT} -p -r")
163ART_CHROOT_CMD = _env.get('ART_CHROOT_CMD', "unshare --user --map-root-user chroot art-test-chroot")
164if ART_TEST_ON_VM:
165  ART_TEST_CHROOT = _env.get('ART_TEST_CHROOT', f"/home/{ART_TEST_SSH_USER}/art-test-chroot")
166else:
167  ART_TEST_CHROOT = _env.get('ART_TEST_CHROOT', "/data/local/art-test-chroot")
168