Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 1 | // Copyright 2016 Google Inc. All rights reserved. |
| 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 | |
| 15 | package cc |
| 16 | |
| 17 | import ( |
| 18 | "path/filepath" |
nelsonli | 0d7111e | 2019-09-17 16:35:23 +0800 | [diff] [blame] | 19 | "strconv" |
Julien Desprez | 3b933d3 | 2021-01-14 11:49:15 -0800 | [diff] [blame] | 20 | |
Cole Faust | 65cb40a | 2024-10-21 15:41:42 -0700 | [diff] [blame] | 21 | "github.com/google/blueprint/proptools" |
| 22 | |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 23 | "android/soong/android" |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 24 | "android/soong/tradefed" |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 25 | ) |
| 26 | |
Trevor Radcliffe | f389cb4 | 2022-03-24 21:06:14 +0000 | [diff] [blame] | 27 | // TestLinkerProperties properties to be registered via the linker |
| 28 | type TestLinkerProperties struct { |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 29 | // if set, build against the gtest library. Defaults to true. |
Colin Cross | 600c9df | 2016-09-13 12:26:16 -0700 | [diff] [blame] | 30 | Gtest *bool |
Christopher Ferris | 9df92d6 | 2018-08-21 12:40:08 -0700 | [diff] [blame] | 31 | |
Trevor Radcliffe | cd8fd67 | 2022-05-03 14:51:16 +0000 | [diff] [blame] | 32 | // if set, use the isolated gtest runner. Defaults to true if gtest is also true and the arch is Windows, false |
| 33 | // otherwise. |
Christopher Ferris | 9df92d6 | 2018-08-21 12:40:08 -0700 | [diff] [blame] | 34 | Isolated *bool |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 35 | } |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 36 | |
Trevor Radcliffe | f389cb4 | 2022-03-24 21:06:14 +0000 | [diff] [blame] | 37 | // TestInstallerProperties properties to be registered via the installer |
| 38 | type TestInstallerProperties struct { |
| 39 | // list of compatibility suites (for example "cts", "vts") that the module should be installed into. |
| 40 | Test_suites []string `android:"arch_variant"` |
| 41 | } |
| 42 | |
yelinhsieh | 9fc6040 | 2018-10-01 19:23:14 +0800 | [diff] [blame] | 43 | // Test option struct. |
| 44 | type TestOptions struct { |
Zhenhuang Wang | 0ac5a43 | 2022-08-12 18:49:20 +0800 | [diff] [blame] | 45 | android.CommonTestOptions |
| 46 | |
yelinhsieh | 9fc6040 | 2018-10-01 19:23:14 +0800 | [diff] [blame] | 47 | // The UID that you want to run the test as on a device. |
| 48 | Run_test_as *string |
Dan Shi | 95d1942 | 2020-08-15 12:24:26 -0700 | [diff] [blame] | 49 | |
David Srbecky | 519db27 | 2020-06-18 18:07:00 +0100 | [diff] [blame] | 50 | // A list of free-formed strings without spaces that categorize the test. |
| 51 | Test_suite_tag []string |
Dan Shi | 95d1942 | 2020-08-15 12:24:26 -0700 | [diff] [blame] | 52 | |
| 53 | // a list of extra test configuration files that should be installed with the module. |
| 54 | Extra_test_configs []string `android:"path,arch_variant"` |
Dan Shi | d79572f | 2020-11-13 14:33:46 -0800 | [diff] [blame] | 55 | |
Justin Yun | 46f6605 | 2021-05-04 18:42:24 +0900 | [diff] [blame] | 56 | // Add ShippingApiLevelModuleController to auto generated test config. If the device properties |
Justin Yun | a364cfb | 2021-05-13 12:39:42 +0900 | [diff] [blame] | 57 | // for the shipping api level is less than the min_shipping_api_level, skip this module. |
| 58 | Min_shipping_api_level *int64 |
| 59 | |
| 60 | // Add ShippingApiLevelModuleController to auto generated test config. If any of the device |
| 61 | // shipping api level and vendor api level properties are less than the |
| 62 | // vsr_min_shipping_api_level, skip this module. |
| 63 | // As this includes the shipping api level check, it is not allowed to define |
| 64 | // min_shipping_api_level at the same time with this property. |
| 65 | Vsr_min_shipping_api_level *int64 |
Justin Yun | 46f6605 | 2021-05-04 18:42:24 +0900 | [diff] [blame] | 66 | |
| 67 | // Add MinApiLevelModuleController with ro.vndk.version property. If ro.vndk.version has an |
Justin Yun | a364cfb | 2021-05-13 12:39:42 +0900 | [diff] [blame] | 68 | // integer value and the value is less than the min_vndk_version, skip this module. |
| 69 | Min_vndk_version *int64 |
Dan Shi | ec73143 | 2023-05-26 04:21:44 +0000 | [diff] [blame] | 70 | |
| 71 | // Extra <option> tags to add to the auto generated test xml file under the test runner, e.g., GTest. |
| 72 | // The "key" is optional in each of these. |
| 73 | Test_runner_options []tradefed.Option |
yelinhsieh | 9fc6040 | 2018-10-01 19:23:14 +0800 | [diff] [blame] | 74 | } |
| 75 | |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 76 | type TestBinaryProperties struct { |
Dan Willemsen | 3340d60 | 2016-12-27 14:40:40 -0800 | [diff] [blame] | 77 | // Disables the creation of a test-specific directory when used with |
| 78 | // relative_install_path. Useful if several tests need to be in the same |
Colin Cross | 3a02c7b | 2024-05-21 13:46:22 -0700 | [diff] [blame] | 79 | // directory. |
Dan Willemsen | 3340d60 | 2016-12-27 14:40:40 -0800 | [diff] [blame] | 80 | No_named_install_directory *bool |
Colin Cross | faeb7aa | 2017-02-01 14:12:44 -0800 | [diff] [blame] | 81 | |
| 82 | // list of files or filegroup modules that provide data that should be installed alongside |
| 83 | // the test |
Dan Shi | 67a8834 | 2020-02-25 16:34:39 -0800 | [diff] [blame] | 84 | Data []string `android:"path,arch_variant"` |
Colin Cross | a929db0 | 2017-03-27 16:27:50 -0700 | [diff] [blame] | 85 | |
Cole Faust | 65cb40a | 2024-10-21 15:41:42 -0700 | [diff] [blame] | 86 | // Same as data, but adds depedencies on modules using the device's os variant, and common |
| 87 | // architecture's variant. Can be useful to add device-built apps to the data of a host |
| 88 | // test. |
| 89 | Device_common_data []string `android:"path_device_common"` |
| 90 | |
| 91 | // Same as data, but adds depedencies on modules using the device's os variant, and the device's |
| 92 | // first architecture's variant. Can be useful to add device-built apps to the data of a host |
| 93 | // test. |
| 94 | Device_first_data []string `android:"path_device_first"` |
| 95 | |
Chris Parsons | 79d66a5 | 2020-06-05 17:26:16 -0400 | [diff] [blame] | 96 | // list of shared library modules that should be installed alongside the test |
| 97 | Data_libs []string `android:"arch_variant"` |
| 98 | |
Colin Cross | c8caa06 | 2021-09-24 16:50:14 -0700 | [diff] [blame] | 99 | // list of binary modules that should be installed alongside the test |
| 100 | Data_bins []string `android:"arch_variant"` |
| 101 | |
Julien Desprez | e146e39 | 2018-08-02 15:00:46 -0700 | [diff] [blame] | 102 | // the name of the test configuration (for example "AndroidTest.xml") that should be |
| 103 | // installed with the module. |
Colin Cross | 27b922f | 2019-03-04 22:35:41 -0800 | [diff] [blame] | 104 | Test_config *string `android:"path,arch_variant"` |
Jack He | 3333889 | 2018-09-19 02:21:28 -0700 | [diff] [blame] | 105 | |
| 106 | // the name of the test configuration template (for example "AndroidTestTemplate.xml") that |
| 107 | // should be installed with the module. |
Colin Cross | 27b922f | 2019-03-04 22:35:41 -0800 | [diff] [blame] | 108 | Test_config_template *string `android:"path,arch_variant"` |
yelinhsieh | 9fc6040 | 2018-10-01 19:23:14 +0800 | [diff] [blame] | 109 | |
| 110 | // Test options. |
| 111 | Test_options TestOptions |
Dan Shi | 37ee3b8 | 2019-06-06 16:23:32 -0700 | [diff] [blame] | 112 | |
| 113 | // Add RootTargetPreparer to auto generated test config. This guarantees the test to run |
| 114 | // with root permission. |
| 115 | Require_root *bool |
Dan Shi | 20ccd21 | 2019-08-27 10:37:24 -0700 | [diff] [blame] | 116 | |
| 117 | // Add RunCommandTargetPreparer to stop framework before the test and start it after the test. |
| 118 | Disable_framework *bool |
nelsonli | 0d7111e | 2019-09-17 16:35:23 +0800 | [diff] [blame] | 119 | |
Dan Shi | 6ffaaa8 | 2019-09-26 11:41:36 -0700 | [diff] [blame] | 120 | // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml |
| 121 | // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true |
| 122 | // explicitly. |
| 123 | Auto_gen_config *bool |
easoncylee | 1e3fdcd | 2020-04-30 10:08:33 +0800 | [diff] [blame] | 124 | |
| 125 | // Add parameterized mainline modules to auto generated test config. The options will be |
| 126 | // handled by TradeFed to download and install the specified modules on the device. |
| 127 | Test_mainline_modules []string |
Colin Cross | cfb0f5e | 2021-09-24 15:47:17 -0700 | [diff] [blame] | 128 | |
| 129 | // Install the test into a folder named for the module in all test suites. |
| 130 | Per_testcase_directory *bool |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 131 | } |
| 132 | |
| 133 | func init() { |
Steven Moreland | 87c9d7b | 2017-11-02 21:38:28 -0700 | [diff] [blame] | 134 | android.RegisterModuleType("cc_test", TestFactory) |
| 135 | android.RegisterModuleType("cc_test_library", TestLibraryFactory) |
| 136 | android.RegisterModuleType("cc_benchmark", BenchmarkFactory) |
| 137 | android.RegisterModuleType("cc_test_host", TestHostFactory) |
| 138 | android.RegisterModuleType("cc_benchmark_host", BenchmarkHostFactory) |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 139 | } |
| 140 | |
Patrice Arruda | c249c71 | 2019-03-19 17:00:29 -0700 | [diff] [blame] | 141 | // cc_test generates a test config file and an executable binary file to test |
| 142 | // specific functionality on a device. The executable binary gets an implicit |
| 143 | // static_libs dependency on libgtests unless the gtest flag is set to false. |
Steven Moreland | 87c9d7b | 2017-11-02 21:38:28 -0700 | [diff] [blame] | 144 | func TestFactory() android.Module { |
Colin Cross | 8ff1058 | 2023-12-07 13:10:56 -0800 | [diff] [blame] | 145 | module := NewTest(android.HostAndDeviceSupported) |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 146 | return module.Init() |
| 147 | } |
| 148 | |
Patrice Arruda | c249c71 | 2019-03-19 17:00:29 -0700 | [diff] [blame] | 149 | // cc_test_library creates an archive of files (i.e. .o files) which is later |
| 150 | // referenced by another module (such as cc_test, cc_defaults or cc_test_library) |
| 151 | // for archiving or linking. |
Steven Moreland | 87c9d7b | 2017-11-02 21:38:28 -0700 | [diff] [blame] | 152 | func TestLibraryFactory() android.Module { |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 153 | module := NewTestLibrary(android.HostAndDeviceSupported) |
| 154 | return module.Init() |
| 155 | } |
| 156 | |
Patrice Arruda | c249c71 | 2019-03-19 17:00:29 -0700 | [diff] [blame] | 157 | // cc_benchmark compiles an executable binary that performs benchmark testing |
| 158 | // of a specific component in a device. Additional files such as test suites |
| 159 | // and test configuration are installed on the side of the compiled executed |
| 160 | // binary. |
Steven Moreland | 87c9d7b | 2017-11-02 21:38:28 -0700 | [diff] [blame] | 161 | func BenchmarkFactory() android.Module { |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 162 | module := NewBenchmark(android.HostAndDeviceSupported) |
Aditya Choudhary | 87b2ab2 | 2023-11-17 15:27:06 +0000 | [diff] [blame] | 163 | module.testModule = true |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 164 | return module.Init() |
| 165 | } |
| 166 | |
Patrice Arruda | c249c71 | 2019-03-19 17:00:29 -0700 | [diff] [blame] | 167 | // cc_test_host compiles a test host binary. |
Steven Moreland | 87c9d7b | 2017-11-02 21:38:28 -0700 | [diff] [blame] | 168 | func TestHostFactory() android.Module { |
Colin Cross | 8ff1058 | 2023-12-07 13:10:56 -0800 | [diff] [blame] | 169 | module := NewTest(android.HostSupported) |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 170 | return module.Init() |
| 171 | } |
| 172 | |
Patrice Arruda | c249c71 | 2019-03-19 17:00:29 -0700 | [diff] [blame] | 173 | // cc_benchmark_host compiles an executable binary that performs benchmark |
| 174 | // testing of a specific component in the host. Additional files such as |
| 175 | // test suites and test configuration are installed on the side of the |
| 176 | // compiled executed binary. |
Steven Moreland | 87c9d7b | 2017-11-02 21:38:28 -0700 | [diff] [blame] | 177 | func BenchmarkHostFactory() android.Module { |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 178 | module := NewBenchmark(android.HostSupported) |
| 179 | return module.Init() |
| 180 | } |
| 181 | |
Chris Parsons | 216e10a | 2020-07-09 17:12:52 -0400 | [diff] [blame] | 182 | func (test *testBinary) dataPaths() []android.DataPath { |
Liz Kammer | 1c14a21 | 2020-05-12 15:26:55 -0700 | [diff] [blame] | 183 | return test.data |
| 184 | } |
| 185 | |
Jingwen Chen | 537242c | 2022-08-24 11:53:27 +0000 | [diff] [blame] | 186 | func (test *testBinary) testBinary() bool { |
| 187 | return true |
| 188 | } |
| 189 | |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 190 | type testDecorator struct { |
Trevor Radcliffe | f389cb4 | 2022-03-24 21:06:14 +0000 | [diff] [blame] | 191 | LinkerProperties TestLinkerProperties |
| 192 | InstallerProperties TestInstallerProperties |
| 193 | installer *baseInstaller |
| 194 | linker *baseLinker |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 195 | } |
| 196 | |
Colin Cross | 600c9df | 2016-09-13 12:26:16 -0700 | [diff] [blame] | 197 | func (test *testDecorator) gtest() bool { |
Trevor Radcliffe | f389cb4 | 2022-03-24 21:06:14 +0000 | [diff] [blame] | 198 | return BoolDefault(test.LinkerProperties.Gtest, true) |
Colin Cross | 600c9df | 2016-09-13 12:26:16 -0700 | [diff] [blame] | 199 | } |
| 200 | |
Spandan Das | f5a8655 | 2023-07-22 03:16:53 +0000 | [diff] [blame] | 201 | func (test *testDecorator) isolated(ctx android.EarlyModuleContext) bool { |
Trevor Radcliffe | cd8fd67 | 2022-05-03 14:51:16 +0000 | [diff] [blame] | 202 | return BoolDefault(test.LinkerProperties.Isolated, false) |
| 203 | } |
| 204 | |
Jingwen Chen | 537242c | 2022-08-24 11:53:27 +0000 | [diff] [blame] | 205 | // NOTE: Keep this in sync with cc/cc_test.bzl#gtest_copts |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 206 | func (test *testDecorator) linkerFlags(ctx ModuleContext, flags Flags) Flags { |
Colin Cross | 600c9df | 2016-09-13 12:26:16 -0700 | [diff] [blame] | 207 | if !test.gtest() { |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 208 | return flags |
| 209 | } |
| 210 | |
Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 211 | flags.Local.CFlags = append(flags.Local.CFlags, "-DGTEST_HAS_STD_STRING") |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 212 | if ctx.Host() { |
Liana Kazanova | b88279f | 2024-07-15 18:45:23 +0000 | [diff] [blame] | 213 | flags.Local.CFlags = append(flags.Local.CFlags, "-O0", "-g") |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 214 | |
| 215 | switch ctx.Os() { |
| 216 | case android.Windows: |
Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 217 | flags.Local.CFlags = append(flags.Local.CFlags, "-DGTEST_OS_WINDOWS") |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 218 | case android.Linux: |
Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 219 | flags.Local.CFlags = append(flags.Local.CFlags, "-DGTEST_OS_LINUX") |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 220 | case android.Darwin: |
Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 221 | flags.Local.CFlags = append(flags.Local.CFlags, "-DGTEST_OS_MAC") |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 222 | } |
| 223 | } else { |
Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 224 | flags.Local.CFlags = append(flags.Local.CFlags, "-DGTEST_OS_LINUX_ANDROID") |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 225 | } |
| 226 | |
| 227 | return flags |
| 228 | } |
| 229 | |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 230 | func (test *testDecorator) linkerDeps(ctx BaseModuleContext, deps Deps) Deps { |
Colin Cross | 600c9df | 2016-09-13 12:26:16 -0700 | [diff] [blame] | 231 | if test.gtest() { |
Jeff Gaston | af3cc2d | 2017-09-27 17:01:44 -0700 | [diff] [blame] | 232 | if ctx.useSdk() && ctx.Device() { |
Dan Albert | 7dd5899 | 2018-02-09 15:22:59 -0800 | [diff] [blame] | 233 | deps.StaticLibs = append(deps.StaticLibs, "libgtest_main_ndk_c++", "libgtest_ndk_c++") |
Trevor Radcliffe | cd8fd67 | 2022-05-03 14:51:16 +0000 | [diff] [blame] | 234 | } else if test.isolated(ctx) { |
Christopher Ferris | 9df92d6 | 2018-08-21 12:40:08 -0700 | [diff] [blame] | 235 | deps.StaticLibs = append(deps.StaticLibs, "libgtest_isolated_main") |
Christopher Ferris | 34cbba6 | 2019-07-17 15:46:29 -0700 | [diff] [blame] | 236 | // The isolated library requires liblog, but adding it |
| 237 | // as a static library means unit tests cannot override |
| 238 | // liblog functions. Instead make it a shared library |
| 239 | // dependency. |
| 240 | deps.SharedLibs = append(deps.SharedLibs, "liblog") |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 241 | } else { |
| 242 | deps.StaticLibs = append(deps.StaticLibs, "libgtest_main", "libgtest") |
| 243 | } |
| 244 | } |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 245 | |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 246 | return deps |
| 247 | } |
| 248 | |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 249 | func (test *testDecorator) linkerProps() []interface{} { |
Trevor Radcliffe | f389cb4 | 2022-03-24 21:06:14 +0000 | [diff] [blame] | 250 | return []interface{}{&test.LinkerProperties} |
| 251 | } |
| 252 | |
| 253 | func (test *testDecorator) installerProps() []interface{} { |
| 254 | return []interface{}{&test.InstallerProperties} |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 255 | } |
| 256 | |
Colin Cross | 4a9e6ec | 2023-12-18 15:29:41 -0800 | [diff] [blame] | 257 | func (test *testDecorator) moduleInfoJSON(ctx android.ModuleContext, moduleInfoJSON *android.ModuleInfoJSON) { |
| 258 | if android.PrefixInList(moduleInfoJSON.CompatibilitySuites, "mts-") && |
| 259 | !android.InList("mts", moduleInfoJSON.CompatibilitySuites) { |
| 260 | moduleInfoJSON.CompatibilitySuites = append(moduleInfoJSON.CompatibilitySuites, "mts") |
| 261 | } |
| 262 | } |
| 263 | |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 264 | func NewTestInstaller() *baseInstaller { |
| 265 | return NewBaseInstaller("nativetest", "nativetest64", InstallInData) |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 266 | } |
| 267 | |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 268 | type testBinary struct { |
Trevor Radcliffe | f389cb4 | 2022-03-24 21:06:14 +0000 | [diff] [blame] | 269 | *testDecorator |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 270 | *binaryDecorator |
| 271 | *baseCompiler |
Dan Shi | 95d1942 | 2020-08-15 12:24:26 -0700 | [diff] [blame] | 272 | Properties TestBinaryProperties |
| 273 | data []android.DataPath |
| 274 | testConfig android.Path |
| 275 | extraTestConfigs android.Paths |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 276 | } |
| 277 | |
| 278 | func (test *testBinary) linkerProps() []interface{} { |
| 279 | props := append(test.testDecorator.linkerProps(), test.binaryDecorator.linkerProps()...) |
| 280 | props = append(props, &test.Properties) |
| 281 | return props |
| 282 | } |
| 283 | |
Colin Cross | 37047f1 | 2016-12-13 17:06:13 -0800 | [diff] [blame] | 284 | func (test *testBinary) linkerDeps(ctx DepsContext, deps Deps) Deps { |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 285 | deps = test.testDecorator.linkerDeps(ctx, deps) |
| 286 | deps = test.binaryDecorator.linkerDeps(ctx, deps) |
Chris Parsons | 79d66a5 | 2020-06-05 17:26:16 -0400 | [diff] [blame] | 287 | deps.DataLibs = append(deps.DataLibs, test.Properties.Data_libs...) |
Colin Cross | c8caa06 | 2021-09-24 16:50:14 -0700 | [diff] [blame] | 288 | deps.DataBins = append(deps.DataBins, test.Properties.Data_bins...) |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 289 | return deps |
| 290 | } |
| 291 | |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 292 | func (test *testBinary) linkerFlags(ctx ModuleContext, flags Flags) Flags { |
| 293 | flags = test.binaryDecorator.linkerFlags(ctx, flags) |
| 294 | flags = test.testDecorator.linkerFlags(ctx, flags) |
Colin Cross | b881e32 | 2024-05-10 13:24:17 -0700 | [diff] [blame] | 295 | |
| 296 | // Add a default rpath to allow tests to dlopen libraries specified in data_libs. |
| 297 | // Host modules already get an rpath specified in linker.go. |
| 298 | if !ctx.Host() { |
| 299 | flags.Global.LdFlags = append(flags.Global.LdFlags, `-Wl,-rpath,\$$ORIGIN`) |
| 300 | } |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 301 | return flags |
| 302 | } |
| 303 | |
Colin Cross | 4a9e6ec | 2023-12-18 15:29:41 -0800 | [diff] [blame] | 304 | func (test *testBinary) moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON) { |
| 305 | if ctx.Host() && Bool(test.Properties.Test_options.Unit_test) { |
| 306 | moduleInfoJSON.CompatibilitySuites = append(moduleInfoJSON.CompatibilitySuites, "host-unit-tests") |
| 307 | } |
| 308 | moduleInfoJSON.TestOptionsTags = append(moduleInfoJSON.TestOptionsTags, test.Properties.Test_options.Tags...) |
| 309 | moduleInfoJSON.TestMainlineModules = append(moduleInfoJSON.TestMainlineModules, test.Properties.Test_mainline_modules...) |
| 310 | if test.testConfig != nil { |
| 311 | if _, ok := test.testConfig.(android.WritablePath); ok { |
| 312 | moduleInfoJSON.AutoTestConfig = []string{"true"} |
| 313 | } |
| 314 | moduleInfoJSON.TestConfig = append(moduleInfoJSON.TestConfig, test.testConfig.String()) |
| 315 | } |
| 316 | moduleInfoJSON.TestConfig = append(moduleInfoJSON.TestConfig, test.extraTestConfigs.Strings()...) |
| 317 | |
Colin Cross | 4a9e6ec | 2023-12-18 15:29:41 -0800 | [diff] [blame] | 318 | moduleInfoJSON.DataDependencies = append(moduleInfoJSON.DataDependencies, test.Properties.Data_bins...) |
| 319 | |
| 320 | if len(test.InstallerProperties.Test_suites) > 0 { |
| 321 | moduleInfoJSON.CompatibilitySuites = append(moduleInfoJSON.CompatibilitySuites, test.InstallerProperties.Test_suites...) |
| 322 | } else { |
| 323 | moduleInfoJSON.CompatibilitySuites = append(moduleInfoJSON.CompatibilitySuites, "null-suite") |
| 324 | } |
| 325 | |
| 326 | test.binaryDecorator.moduleInfoJSON(ctx, moduleInfoJSON) |
| 327 | test.testDecorator.moduleInfoJSON(ctx, moduleInfoJSON) |
| 328 | moduleInfoJSON.Class = []string{"NATIVE_TESTS"} |
| 329 | |
| 330 | } |
| 331 | |
Trevor Radcliffe | f389cb4 | 2022-03-24 21:06:14 +0000 | [diff] [blame] | 332 | func (test *testBinary) installerProps() []interface{} { |
| 333 | return append(test.baseInstaller.installerProps(), test.testDecorator.installerProps()...) |
| 334 | } |
| 335 | |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 336 | func (test *testBinary) install(ctx ModuleContext, file android.Path) { |
Chris Parsons | 216e10a | 2020-07-09 17:12:52 -0400 | [diff] [blame] | 337 | dataSrcPaths := android.PathsForModuleSrc(ctx, test.Properties.Data) |
Cole Faust | 65cb40a | 2024-10-21 15:41:42 -0700 | [diff] [blame] | 338 | dataSrcPaths = append(dataSrcPaths, android.PathsForModuleSrc(ctx, test.Properties.Device_common_data)...) |
| 339 | dataSrcPaths = append(dataSrcPaths, android.PathsForModuleSrc(ctx, test.Properties.Device_first_data)...) |
Chris Parsons | 216e10a | 2020-07-09 17:12:52 -0400 | [diff] [blame] | 340 | |
| 341 | for _, dataSrcPath := range dataSrcPaths { |
| 342 | test.data = append(test.data, android.DataPath{SrcPath: dataSrcPath}) |
| 343 | } |
Chris Parsons | 79d66a5 | 2020-06-05 17:26:16 -0400 | [diff] [blame] | 344 | |
| 345 | ctx.VisitDirectDepsWithTag(dataLibDepTag, func(dep android.Module) { |
| 346 | depName := ctx.OtherModuleName(dep) |
Ivan Lozano | 4e5f07d | 2021-11-04 14:09:38 -0400 | [diff] [blame] | 347 | linkableDep, ok := dep.(LinkableInterface) |
Chris Parsons | 79d66a5 | 2020-06-05 17:26:16 -0400 | [diff] [blame] | 348 | if !ok { |
Ivan Lozano | 4e5f07d | 2021-11-04 14:09:38 -0400 | [diff] [blame] | 349 | ctx.ModuleErrorf("data_lib %q is not a LinkableInterface module", depName) |
Chris Parsons | 79d66a5 | 2020-06-05 17:26:16 -0400 | [diff] [blame] | 350 | } |
Ivan Lozano | 4e5f07d | 2021-11-04 14:09:38 -0400 | [diff] [blame] | 351 | if linkableDep.OutputFile().Valid() { |
Chris Parsons | 216e10a | 2020-07-09 17:12:52 -0400 | [diff] [blame] | 352 | test.data = append(test.data, |
Ivan Lozano | 4e5f07d | 2021-11-04 14:09:38 -0400 | [diff] [blame] | 353 | android.DataPath{SrcPath: linkableDep.OutputFile().Path(), |
| 354 | RelativeInstallPath: linkableDep.RelativeInstallPath()}) |
Chris Parsons | 79d66a5 | 2020-06-05 17:26:16 -0400 | [diff] [blame] | 355 | } |
| 356 | }) |
Colin Cross | c8caa06 | 2021-09-24 16:50:14 -0700 | [diff] [blame] | 357 | ctx.VisitDirectDepsWithTag(dataBinDepTag, func(dep android.Module) { |
| 358 | depName := ctx.OtherModuleName(dep) |
Ivan Lozano | 4e5f07d | 2021-11-04 14:09:38 -0400 | [diff] [blame] | 359 | linkableDep, ok := dep.(LinkableInterface) |
Colin Cross | c8caa06 | 2021-09-24 16:50:14 -0700 | [diff] [blame] | 360 | if !ok { |
Ivan Lozano | 4e5f07d | 2021-11-04 14:09:38 -0400 | [diff] [blame] | 361 | ctx.ModuleErrorf("data_bin %q is not a LinkableInterface module", depName) |
Colin Cross | c8caa06 | 2021-09-24 16:50:14 -0700 | [diff] [blame] | 362 | } |
Ivan Lozano | 4e5f07d | 2021-11-04 14:09:38 -0400 | [diff] [blame] | 363 | if linkableDep.OutputFile().Valid() { |
Colin Cross | c8caa06 | 2021-09-24 16:50:14 -0700 | [diff] [blame] | 364 | test.data = append(test.data, |
Ivan Lozano | 4e5f07d | 2021-11-04 14:09:38 -0400 | [diff] [blame] | 365 | android.DataPath{SrcPath: linkableDep.OutputFile().Path(), |
| 366 | RelativeInstallPath: linkableDep.RelativeInstallPath()}) |
Colin Cross | c8caa06 | 2021-09-24 16:50:14 -0700 | [diff] [blame] | 367 | } |
| 368 | }) |
Chris Parsons | 79d66a5 | 2020-06-05 17:26:16 -0400 | [diff] [blame] | 369 | |
Kiyoung Kim | aa39480 | 2024-01-08 12:55:45 +0900 | [diff] [blame] | 370 | testInstallBase := getTestInstallBase(ctx.InVendorOrProduct()) |
Dan Shi | ad04250 | 2023-08-02 13:53:00 -0700 | [diff] [blame] | 371 | configs := getTradefedConfigOptions(ctx, &test.Properties, test.isolated(ctx), ctx.Device()) |
yelinhsieh | 9fc6040 | 2018-10-01 19:23:14 +0800 | [diff] [blame] | 372 | |
Cole Faust | 2168054 | 2022-12-07 18:18:37 -0800 | [diff] [blame] | 373 | test.testConfig = tradefed.AutoGenTestConfig(ctx, tradefed.AutoGenTestConfigOptions{ |
| 374 | TestConfigProp: test.Properties.Test_config, |
| 375 | TestConfigTemplateProp: test.Properties.Test_config_template, |
| 376 | TestSuites: test.testDecorator.InstallerProperties.Test_suites, |
| 377 | Config: configs, |
Dan Shi | ec73143 | 2023-05-26 04:21:44 +0000 | [diff] [blame] | 378 | TestRunnerOptions: test.Properties.Test_options.Test_runner_options, |
Cole Faust | 2168054 | 2022-12-07 18:18:37 -0800 | [diff] [blame] | 379 | AutoGenConfig: test.Properties.Auto_gen_config, |
| 380 | TestInstallBase: testInstallBase, |
| 381 | DeviceTemplate: "${NativeTestConfigTemplate}", |
| 382 | HostTemplate: "${NativeHostTestConfigTemplate}", |
| 383 | }) |
Colin Cross | faeb7aa | 2017-02-01 14:12:44 -0800 | [diff] [blame] | 384 | |
Dan Shi | 95d1942 | 2020-08-15 12:24:26 -0700 | [diff] [blame] | 385 | test.extraTestConfigs = android.PathsForModuleSrc(ctx, test.Properties.Test_options.Extra_test_configs) |
| 386 | |
Colin Cross | 600c9df | 2016-09-13 12:26:16 -0700 | [diff] [blame] | 387 | test.binaryDecorator.baseInstaller.dir = "nativetest" |
| 388 | test.binaryDecorator.baseInstaller.dir64 = "nativetest64" |
Dan Willemsen | 3340d60 | 2016-12-27 14:40:40 -0800 | [diff] [blame] | 389 | |
| 390 | if !Bool(test.Properties.No_named_install_directory) { |
| 391 | test.binaryDecorator.baseInstaller.relative = ctx.ModuleName() |
Nan Zhang | 0007d81 | 2017-11-07 10:57:05 -0800 | [diff] [blame] | 392 | } else if String(test.binaryDecorator.baseInstaller.Properties.Relative_install_path) == "" { |
Dan Willemsen | 3340d60 | 2016-12-27 14:40:40 -0800 | [diff] [blame] | 393 | ctx.PropertyErrorf("no_named_install_directory", "Module install directory may only be disabled if relative_install_path is set") |
| 394 | } |
| 395 | |
Julien Desprez | 8908b37 | 2021-02-04 10:10:16 -0800 | [diff] [blame] | 396 | if ctx.Host() && test.gtest() && test.Properties.Test_options.Unit_test == nil { |
Julien Desprez | 3b933d3 | 2021-01-14 11:49:15 -0800 | [diff] [blame] | 397 | test.Properties.Test_options.Unit_test = proptools.BoolPtr(true) |
| 398 | } |
Colin Cross | 5c1d5fb | 2023-11-15 12:39:40 -0800 | [diff] [blame] | 399 | |
| 400 | test.binaryDecorator.baseInstaller.installTestData(ctx, test.data) |
Dan Willemsen | 1d577e2 | 2016-08-29 15:53:15 -0700 | [diff] [blame] | 401 | test.binaryDecorator.baseInstaller.install(ctx, file) |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 402 | } |
| 403 | |
Kevin Dagostino | 32edd1a | 2022-12-04 11:16:42 +0000 | [diff] [blame] | 404 | func getTestInstallBase(useVendor bool) string { |
| 405 | // TODO: (b/167308193) Switch to /data/local/tests/unrestricted as the default install base. |
| 406 | testInstallBase := "/data/local/tmp" |
| 407 | if useVendor { |
| 408 | testInstallBase = "/data/local/tests/vendor" |
| 409 | } |
| 410 | return testInstallBase |
| 411 | } |
| 412 | |
Dan Shi | ad04250 | 2023-08-02 13:53:00 -0700 | [diff] [blame] | 413 | func getTradefedConfigOptions(ctx android.EarlyModuleContext, properties *TestBinaryProperties, isolated bool, device bool) []tradefed.Config { |
Kevin Dagostino | 32edd1a | 2022-12-04 11:16:42 +0000 | [diff] [blame] | 414 | var configs []tradefed.Config |
| 415 | |
| 416 | for _, module := range properties.Test_mainline_modules { |
| 417 | configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module}) |
| 418 | } |
Dan Shi | ad04250 | 2023-08-02 13:53:00 -0700 | [diff] [blame] | 419 | if device { |
| 420 | if Bool(properties.Require_root) { |
| 421 | configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.RootTargetPreparer", nil}) |
| 422 | } else { |
| 423 | var options []tradefed.Option |
| 424 | options = append(options, tradefed.Option{Name: "force-root", Value: "false"}) |
| 425 | configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.RootTargetPreparer", options}) |
| 426 | } |
| 427 | if Bool(properties.Disable_framework) { |
| 428 | var options []tradefed.Option |
| 429 | configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.StopServicesSetup", options}) |
| 430 | } |
Kevin Dagostino | 32edd1a | 2022-12-04 11:16:42 +0000 | [diff] [blame] | 431 | } |
| 432 | if isolated { |
| 433 | configs = append(configs, tradefed.Option{Name: "not-shardable", Value: "true"}) |
| 434 | } |
| 435 | if properties.Test_options.Run_test_as != nil { |
| 436 | configs = append(configs, tradefed.Option{Name: "run-test-as", Value: String(properties.Test_options.Run_test_as)}) |
| 437 | } |
| 438 | for _, tag := range properties.Test_options.Test_suite_tag { |
| 439 | configs = append(configs, tradefed.Option{Name: "test-suite-tag", Value: tag}) |
| 440 | } |
| 441 | if properties.Test_options.Min_shipping_api_level != nil { |
| 442 | if properties.Test_options.Vsr_min_shipping_api_level != nil { |
| 443 | ctx.PropertyErrorf("test_options.min_shipping_api_level", "must not be set at the same time as 'vsr_min_shipping_api_level'.") |
| 444 | } |
| 445 | var options []tradefed.Option |
| 446 | options = append(options, tradefed.Option{Name: "min-api-level", Value: strconv.FormatInt(int64(*properties.Test_options.Min_shipping_api_level), 10)}) |
| 447 | configs = append(configs, tradefed.Object{"module_controller", "com.android.tradefed.testtype.suite.module.ShippingApiLevelModuleController", options}) |
| 448 | } |
| 449 | if properties.Test_options.Vsr_min_shipping_api_level != nil { |
| 450 | var options []tradefed.Option |
| 451 | options = append(options, tradefed.Option{Name: "vsr-min-api-level", Value: strconv.FormatInt(int64(*properties.Test_options.Vsr_min_shipping_api_level), 10)}) |
| 452 | configs = append(configs, tradefed.Object{"module_controller", "com.android.tradefed.testtype.suite.module.ShippingApiLevelModuleController", options}) |
| 453 | } |
| 454 | if properties.Test_options.Min_vndk_version != nil { |
| 455 | var options []tradefed.Option |
| 456 | options = append(options, tradefed.Option{Name: "min-api-level", Value: strconv.FormatInt(int64(*properties.Test_options.Min_vndk_version), 10)}) |
| 457 | options = append(options, tradefed.Option{Name: "api-level-prop", Value: "ro.vndk.version"}) |
| 458 | configs = append(configs, tradefed.Object{"module_controller", "com.android.tradefed.testtype.suite.module.MinApiLevelModuleController", options}) |
| 459 | } |
| 460 | return configs |
| 461 | } |
| 462 | |
Colin Cross | 8ff1058 | 2023-12-07 13:10:56 -0800 | [diff] [blame] | 463 | func NewTest(hod android.HostOrDeviceSupported) *Module { |
| 464 | module, binary := newBinary(hod) |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 465 | module.multilib = android.MultilibBoth |
Aditya Choudhary | 4b6eaf4 | 2023-11-21 15:38:37 +0000 | [diff] [blame] | 466 | module.testModule = true |
Dan Willemsen | 1d577e2 | 2016-08-29 15:53:15 -0700 | [diff] [blame] | 467 | binary.baseInstaller = NewTestInstaller() |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 468 | |
| 469 | test := &testBinary{ |
Trevor Radcliffe | f389cb4 | 2022-03-24 21:06:14 +0000 | [diff] [blame] | 470 | testDecorator: &testDecorator{ |
| 471 | linker: binary.baseLinker, |
| 472 | installer: binary.baseInstaller, |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 473 | }, |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 474 | binaryDecorator: binary, |
| 475 | baseCompiler: NewBaseCompiler(), |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 476 | } |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 477 | module.compiler = test |
| 478 | module.linker = test |
| 479 | module.installer = test |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 480 | return module |
| 481 | } |
| 482 | |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 483 | type testLibrary struct { |
Trevor Radcliffe | f389cb4 | 2022-03-24 21:06:14 +0000 | [diff] [blame] | 484 | *testDecorator |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 485 | *libraryDecorator |
| 486 | } |
| 487 | |
Jingwen Chen | 537242c | 2022-08-24 11:53:27 +0000 | [diff] [blame] | 488 | func (test *testLibrary) testLibrary() bool { |
| 489 | return true |
| 490 | } |
| 491 | |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 492 | func (test *testLibrary) linkerProps() []interface{} { |
Trevor Radcliffe | f389cb4 | 2022-03-24 21:06:14 +0000 | [diff] [blame] | 493 | var props []interface{} |
| 494 | props = append(props, test.testDecorator.linkerProps()...) |
| 495 | return append(props, test.libraryDecorator.linkerProps()...) |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 496 | } |
| 497 | |
Colin Cross | 37047f1 | 2016-12-13 17:06:13 -0800 | [diff] [blame] | 498 | func (test *testLibrary) linkerDeps(ctx DepsContext, deps Deps) Deps { |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 499 | deps = test.testDecorator.linkerDeps(ctx, deps) |
| 500 | deps = test.libraryDecorator.linkerDeps(ctx, deps) |
| 501 | return deps |
| 502 | } |
| 503 | |
| 504 | func (test *testLibrary) linkerFlags(ctx ModuleContext, flags Flags) Flags { |
| 505 | flags = test.libraryDecorator.linkerFlags(ctx, flags) |
| 506 | flags = test.testDecorator.linkerFlags(ctx, flags) |
| 507 | return flags |
| 508 | } |
| 509 | |
Colin Cross | 4a9e6ec | 2023-12-18 15:29:41 -0800 | [diff] [blame] | 510 | func (test *testLibrary) moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON) { |
| 511 | if len(test.InstallerProperties.Test_suites) > 0 { |
| 512 | moduleInfoJSON.CompatibilitySuites = append(moduleInfoJSON.CompatibilitySuites, test.InstallerProperties.Test_suites...) |
| 513 | } |
| 514 | |
| 515 | test.libraryDecorator.moduleInfoJSON(ctx, moduleInfoJSON) |
| 516 | test.testDecorator.moduleInfoJSON(ctx, moduleInfoJSON) |
| 517 | } |
| 518 | |
Trevor Radcliffe | f389cb4 | 2022-03-24 21:06:14 +0000 | [diff] [blame] | 519 | func (test *testLibrary) installerProps() []interface{} { |
| 520 | return append(test.baseInstaller.installerProps(), test.testDecorator.installerProps()...) |
| 521 | } |
| 522 | |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 523 | func NewTestLibrary(hod android.HostOrDeviceSupported) *Module { |
Colin Cross | ab3b732 | 2016-12-09 14:46:15 -0800 | [diff] [blame] | 524 | module, library := NewLibrary(android.HostAndDeviceSupported) |
Dan Willemsen | 28bda51 | 2016-08-31 16:32:55 -0700 | [diff] [blame] | 525 | library.baseInstaller = NewTestInstaller() |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 526 | test := &testLibrary{ |
Trevor Radcliffe | f389cb4 | 2022-03-24 21:06:14 +0000 | [diff] [blame] | 527 | testDecorator: &testDecorator{ |
| 528 | linker: library.baseLinker, |
| 529 | installer: library.baseInstaller, |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 530 | }, |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 531 | libraryDecorator: library, |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 532 | } |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 533 | module.linker = test |
Trevor Radcliffe | f389cb4 | 2022-03-24 21:06:14 +0000 | [diff] [blame] | 534 | module.installer = test |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 535 | return module |
| 536 | } |
| 537 | |
Colin Cross | e28f4e2 | 2017-04-24 18:10:29 -0700 | [diff] [blame] | 538 | type BenchmarkProperties struct { |
Anders Lewis | b97e818 | 2017-07-14 15:20:13 -0700 | [diff] [blame] | 539 | // list of files or filegroup modules that provide data that should be installed alongside |
| 540 | // the test |
Colin Cross | 27b922f | 2019-03-04 22:35:41 -0800 | [diff] [blame] | 541 | Data []string `android:"path"` |
Anders Lewis | b97e818 | 2017-07-14 15:20:13 -0700 | [diff] [blame] | 542 | |
Colin Cross | e28f4e2 | 2017-04-24 18:10:29 -0700 | [diff] [blame] | 543 | // list of compatibility suites (for example "cts", "vts") that the module should be |
| 544 | // installed into. |
Julien Desprez | e146e39 | 2018-08-02 15:00:46 -0700 | [diff] [blame] | 545 | Test_suites []string `android:"arch_variant"` |
| 546 | |
| 547 | // the name of the test configuration (for example "AndroidTest.xml") that should be |
| 548 | // installed with the module. |
Colin Cross | 27b922f | 2019-03-04 22:35:41 -0800 | [diff] [blame] | 549 | Test_config *string `android:"path,arch_variant"` |
Jack He | 3333889 | 2018-09-19 02:21:28 -0700 | [diff] [blame] | 550 | |
| 551 | // the name of the test configuration template (for example "AndroidTestTemplate.xml") that |
| 552 | // should be installed with the module. |
Colin Cross | 27b922f | 2019-03-04 22:35:41 -0800 | [diff] [blame] | 553 | Test_config_template *string `android:"path,arch_variant"` |
Dan Shi | 37ee3b8 | 2019-06-06 16:23:32 -0700 | [diff] [blame] | 554 | |
| 555 | // Add RootTargetPreparer to auto generated test config. This guarantees the test to run |
| 556 | // with root permission. |
| 557 | Require_root *bool |
Dan Shi | 6ffaaa8 | 2019-09-26 11:41:36 -0700 | [diff] [blame] | 558 | |
| 559 | // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml |
| 560 | // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true |
| 561 | // explicitly. |
| 562 | Auto_gen_config *bool |
Colin Cross | e28f4e2 | 2017-04-24 18:10:29 -0700 | [diff] [blame] | 563 | } |
| 564 | |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 565 | type benchmarkDecorator struct { |
| 566 | *binaryDecorator |
Colin Cross | e28f4e2 | 2017-04-24 18:10:29 -0700 | [diff] [blame] | 567 | Properties BenchmarkProperties |
Colin Cross | 5c1d5fb | 2023-11-15 12:39:40 -0800 | [diff] [blame] | 568 | data []android.DataPath |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 569 | testConfig android.Path |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 570 | } |
| 571 | |
Liz Kammer | be46fcc | 2021-11-01 15:32:43 -0400 | [diff] [blame] | 572 | func (benchmark *benchmarkDecorator) benchmarkBinary() bool { |
| 573 | return true |
| 574 | } |
| 575 | |
Colin Cross | e28f4e2 | 2017-04-24 18:10:29 -0700 | [diff] [blame] | 576 | func (benchmark *benchmarkDecorator) linkerProps() []interface{} { |
| 577 | props := benchmark.binaryDecorator.linkerProps() |
| 578 | props = append(props, &benchmark.Properties) |
| 579 | return props |
| 580 | } |
| 581 | |
Colin Cross | 37047f1 | 2016-12-13 17:06:13 -0800 | [diff] [blame] | 582 | func (benchmark *benchmarkDecorator) linkerDeps(ctx DepsContext, deps Deps) Deps { |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 583 | deps = benchmark.binaryDecorator.linkerDeps(ctx, deps) |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 584 | deps.StaticLibs = append(deps.StaticLibs, "libgoogle-benchmark") |
| 585 | return deps |
| 586 | } |
| 587 | |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 588 | func (benchmark *benchmarkDecorator) install(ctx ModuleContext, file android.Path) { |
Colin Cross | 5c1d5fb | 2023-11-15 12:39:40 -0800 | [diff] [blame] | 589 | for _, d := range android.PathsForModuleSrc(ctx, benchmark.Properties.Data) { |
| 590 | benchmark.data = append(benchmark.data, android.DataPath{SrcPath: d}) |
| 591 | } |
Chris Parsons | 79d66a5 | 2020-06-05 17:26:16 -0400 | [diff] [blame] | 592 | |
Dan Shi | 37ee3b8 | 2019-06-06 16:23:32 -0700 | [diff] [blame] | 593 | var configs []tradefed.Config |
| 594 | if Bool(benchmark.Properties.Require_root) { |
nelsonli | 0d7111e | 2019-09-17 16:35:23 +0800 | [diff] [blame] | 595 | configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.RootTargetPreparer", nil}) |
Dan Shi | 37ee3b8 | 2019-06-06 16:23:32 -0700 | [diff] [blame] | 596 | } |
Cole Faust | 2168054 | 2022-12-07 18:18:37 -0800 | [diff] [blame] | 597 | benchmark.testConfig = tradefed.AutoGenTestConfig(ctx, tradefed.AutoGenTestConfigOptions{ |
| 598 | TestConfigProp: benchmark.Properties.Test_config, |
| 599 | TestConfigTemplateProp: benchmark.Properties.Test_config_template, |
| 600 | TestSuites: benchmark.Properties.Test_suites, |
| 601 | Config: configs, |
| 602 | AutoGenConfig: benchmark.Properties.Auto_gen_config, |
| 603 | DeviceTemplate: "${NativeBenchmarkTestConfigTemplate}", |
| 604 | HostTemplate: "${NativeBenchmarkTestConfigTemplate}", |
| 605 | }) |
Colin Cross | 303e21f | 2018-08-07 16:49:25 -0700 | [diff] [blame] | 606 | |
Colin Cross | 28690e9 | 2017-09-08 16:20:30 -0700 | [diff] [blame] | 607 | benchmark.binaryDecorator.baseInstaller.dir = filepath.Join("benchmarktest", ctx.ModuleName()) |
| 608 | benchmark.binaryDecorator.baseInstaller.dir64 = filepath.Join("benchmarktest64", ctx.ModuleName()) |
Colin Cross | 5c1d5fb | 2023-11-15 12:39:40 -0800 | [diff] [blame] | 609 | benchmark.binaryDecorator.baseInstaller.installTestData(ctx, benchmark.data) |
Dan Willemsen | 1d577e2 | 2016-08-29 15:53:15 -0700 | [diff] [blame] | 610 | benchmark.binaryDecorator.baseInstaller.install(ctx, file) |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 611 | } |
| 612 | |
Colin Cross | 4a9e6ec | 2023-12-18 15:29:41 -0800 | [diff] [blame] | 613 | func (benchmark *benchmarkDecorator) moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON) { |
| 614 | benchmark.binaryDecorator.moduleInfoJSON(ctx, moduleInfoJSON) |
| 615 | |
| 616 | moduleInfoJSON.Class = []string{"NATIVE_TESTS"} |
| 617 | if len(benchmark.Properties.Test_suites) > 0 { |
| 618 | moduleInfoJSON.CompatibilitySuites = append(moduleInfoJSON.CompatibilitySuites, benchmark.Properties.Test_suites...) |
| 619 | } else { |
| 620 | moduleInfoJSON.CompatibilitySuites = append(moduleInfoJSON.CompatibilitySuites, "null-suite") |
| 621 | } |
| 622 | |
| 623 | if android.PrefixInList(moduleInfoJSON.CompatibilitySuites, "mts-") && |
| 624 | !android.InList("mts", moduleInfoJSON.CompatibilitySuites) { |
| 625 | moduleInfoJSON.CompatibilitySuites = append(moduleInfoJSON.CompatibilitySuites, "mts") |
| 626 | } |
| 627 | |
| 628 | if benchmark.testConfig != nil { |
| 629 | if _, ok := benchmark.testConfig.(android.WritablePath); ok { |
| 630 | moduleInfoJSON.AutoTestConfig = []string{"true"} |
| 631 | } |
| 632 | moduleInfoJSON.TestConfig = []string{benchmark.testConfig.String()} |
| 633 | } |
| 634 | } |
| 635 | |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 636 | func NewBenchmark(hod android.HostOrDeviceSupported) *Module { |
Colin Cross | 8ff1058 | 2023-12-07 13:10:56 -0800 | [diff] [blame] | 637 | module, binary := newBinary(hod) |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 638 | module.multilib = android.MultilibBoth |
Colin Cross | 28690e9 | 2017-09-08 16:20:30 -0700 | [diff] [blame] | 639 | binary.baseInstaller = NewBaseInstaller("benchmarktest", "benchmarktest64", InstallInData) |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 640 | |
| 641 | benchmark := &benchmarkDecorator{ |
| 642 | binaryDecorator: binary, |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 643 | } |
Colin Cross | b916a38 | 2016-07-29 17:28:03 -0700 | [diff] [blame] | 644 | module.linker = benchmark |
| 645 | module.installer = benchmark |
Colin Cross | 4d9c2d1 | 2016-07-29 12:48:20 -0700 | [diff] [blame] | 646 | return module |
| 647 | } |