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