blob: 79627498f0417912c040ae06379821b6b0a90e20 [file] [log] [blame]
Dan Willemsenb0552672019-01-25 16:04:11 -08001// Copyright 2019 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
Jaewoong Jung4b79e982020-06-01 10:45:49 -070015package sh
Dan Willemsenb0552672019-01-25 16:04:11 -080016
17import (
18 "fmt"
Colin Cross7c7c1142019-07-29 16:46:49 -070019 "path/filepath"
Julien Desprez9e7fc142019-03-08 11:07:05 -080020 "strings"
Jaewoong Jung4b79e982020-06-01 10:45:49 -070021
Aditya Choudhary9b593522023-10-06 19:54:58 +000022 "android/soong/testing"
Jaewoong Jung6e0eee52020-05-29 16:15:32 -070023 "github.com/google/blueprint"
Jaewoong Jung4b79e982020-06-01 10:45:49 -070024 "github.com/google/blueprint/proptools"
25
26 "android/soong/android"
Rupert Shuttlewortha1a56e82021-02-09 10:59:06 +000027 "android/soong/bazel"
Jaewoong Jung6e0eee52020-05-29 16:15:32 -070028 "android/soong/cc"
Rob Seymour925aa092021-08-10 20:42:03 +000029 "android/soong/snapshot"
frankfengc5b87492020-06-03 10:28:47 -070030 "android/soong/tradefed"
Dan Willemsenb0552672019-01-25 16:04:11 -080031)
32
33// sh_binary is for shell scripts (and batch files) that are installed as
34// executable files into .../bin/
35//
36// Do not use them for prebuilt C/C++/etc files. Use cc_prebuilt_binary
37// instead.
38
Jaewoong Jung4b79e982020-06-01 10:45:49 -070039var pctx = android.NewPackageContext("android/soong/sh")
40
Dan Willemsenb0552672019-01-25 16:04:11 -080041func init() {
Jaewoong Jung4b79e982020-06-01 10:45:49 -070042 pctx.Import("android/soong/android")
43
Paul Duffin56fb8ee2021-03-08 15:05:52 +000044 registerShBuildComponents(android.InitRegistrationContext)
Dan Willemsenb0552672019-01-25 16:04:11 -080045}
46
Paul Duffin56fb8ee2021-03-08 15:05:52 +000047func registerShBuildComponents(ctx android.RegistrationContext) {
48 ctx.RegisterModuleType("sh_binary", ShBinaryFactory)
49 ctx.RegisterModuleType("sh_binary_host", ShBinaryHostFactory)
50 ctx.RegisterModuleType("sh_test", ShTestFactory)
51 ctx.RegisterModuleType("sh_test_host", ShTestHostFactory)
52}
53
54// Test fixture preparer that will register most sh build components.
55//
56// Singletons and mutators should only be added here if they are needed for a majority of sh
57// module types, otherwise they should be added under a separate preparer to allow them to be
58// selected only when needed to reduce test execution time.
59//
60// Module types do not have much of an overhead unless they are used so this should include as many
61// module types as possible. The exceptions are those module types that require mutators and/or
62// singletons in order to function in which case they should be kept together in a separate
63// preparer.
64var PrepareForTestWithShBuildComponents = android.GroupFixturePreparers(
65 android.FixtureRegisterWithContext(registerShBuildComponents),
66)
67
Dan Willemsenb0552672019-01-25 16:04:11 -080068type shBinaryProperties struct {
69 // Source file of this prebuilt.
Colin Cross27b922f2019-03-04 22:35:41 -080070 Src *string `android:"path,arch_variant"`
Dan Willemsenb0552672019-01-25 16:04:11 -080071
72 // optional subdirectory under which this file is installed into
73 Sub_dir *string `android:"arch_variant"`
74
75 // optional name for the installed file. If unspecified, name of the module is used as the file name
76 Filename *string `android:"arch_variant"`
77
78 // when set to true, and filename property is not set, the name for the installed file
79 // is the same as the file name of the source file.
80 Filename_from_src *bool `android:"arch_variant"`
81
82 // Whether this module is directly installable to one of the partitions. Default: true.
83 Installable *bool
Rashed Abdel-Tawab6a341312019-10-04 20:38:01 -070084
85 // install symlinks to the binary
86 Symlinks []string `android:"arch_variant"`
Colin Crosscc83efb2020-08-21 14:25:33 -070087
88 // Make this module available when building for ramdisk.
Yifan Hong39143a92020-10-26 12:43:12 -070089 // On device without a dedicated recovery partition, the module is only
90 // available after switching root into
91 // /first_stage_ramdisk. To expose the module before switching root, install
92 // the recovery variant instead.
Colin Crosscc83efb2020-08-21 14:25:33 -070093 Ramdisk_available *bool
94
Yifan Hong60e0cfb2020-10-21 15:17:56 -070095 // Make this module available when building for vendor ramdisk.
Yifan Hong39143a92020-10-26 12:43:12 -070096 // On device without a dedicated recovery partition, the module is only
97 // available after switching root into
98 // /first_stage_ramdisk. To expose the module before switching root, install
99 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700100 Vendor_ramdisk_available *bool
101
Colin Crosscc83efb2020-08-21 14:25:33 -0700102 // Make this module available when building for recovery.
103 Recovery_available *bool
Dan Willemsenb0552672019-01-25 16:04:11 -0800104}
105
Julien Desprez9e7fc142019-03-08 11:07:05 -0800106type TestProperties struct {
107 // list of compatibility suites (for example "cts", "vts") that the module should be
108 // installed into.
109 Test_suites []string `android:"arch_variant"`
110
111 // the name of the test configuration (for example "AndroidTest.xml") that should be
112 // installed with the module.
Colin Crossa6384822020-06-09 15:09:22 -0700113 Test_config *string `android:"path,arch_variant"`
Jaewoong Jung8eaeb092019-05-16 14:58:29 -0700114
115 // list of files or filegroup modules that provide data that should be installed alongside
116 // the test.
117 Data []string `android:"path,arch_variant"`
frankfengc5b87492020-06-03 10:28:47 -0700118
119 // Add RootTargetPreparer to auto generated test config. This guarantees the test to run
120 // with root permission.
121 Require_root *bool
122
123 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
124 // should be installed with the module.
125 Test_config_template *string `android:"path,arch_variant"`
126
127 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
128 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
129 // explicitly.
130 Auto_gen_config *bool
Jaewoong Jung6e0eee52020-05-29 16:15:32 -0700131
132 // list of binary modules that should be installed alongside the test
133 Data_bins []string `android:"path,arch_variant"`
134
135 // list of library modules that should be installed alongside the test
136 Data_libs []string `android:"path,arch_variant"`
137
138 // list of device binary modules that should be installed alongside the test.
139 // Only available for host sh_test modules.
140 Data_device_bins []string `android:"path,arch_variant"`
141
142 // list of device library modules that should be installed alongside the test.
143 // Only available for host sh_test modules.
144 Data_device_libs []string `android:"path,arch_variant"`
Dan Shib40deac2021-05-24 12:04:54 -0700145
Makoto Onuki1725b202023-08-24 22:17:56 +0000146 // list of java modules that provide data that should be installed alongside the test.
147 Java_data []string
148
Jooyung Han3ae4cca2022-02-22 16:33:24 +0900149 // Install the test into a folder named for the module in all test suites.
150 Per_testcase_directory *bool
151
Dan Shib40deac2021-05-24 12:04:54 -0700152 // Test options.
Zhenhuang Wang0ac5a432022-08-12 18:49:20 +0800153 Test_options android.CommonTestOptions
Julien Desprez9e7fc142019-03-08 11:07:05 -0800154}
155
Dan Willemsenb0552672019-01-25 16:04:11 -0800156type ShBinary struct {
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700157 android.ModuleBase
Liz Kammerea6666f2021-02-17 10:17:28 -0500158 android.BazelModuleBase
Dan Willemsenb0552672019-01-25 16:04:11 -0800159
160 properties shBinaryProperties
161
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700162 sourceFilePath android.Path
163 outputFilePath android.OutputPath
164 installedFile android.InstallPath
Dan Willemsenb0552672019-01-25 16:04:11 -0800165}
166
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700167var _ android.HostToolProvider = (*ShBinary)(nil)
Colin Cross7c7c1142019-07-29 16:46:49 -0700168
Julien Desprez9e7fc142019-03-08 11:07:05 -0800169type ShTest struct {
170 ShBinary
171
172 testProperties TestProperties
Jaewoong Jung8eaeb092019-05-16 14:58:29 -0700173
Jaewoong Jung4aedc862020-06-10 17:23:46 -0700174 installDir android.InstallPath
175
Colin Cross5c1d5fb2023-11-15 12:39:40 -0800176 data []android.DataPath
frankfengc5b87492020-06-03 10:28:47 -0700177 testConfig android.Path
Jaewoong Jung6e0eee52020-05-29 16:15:32 -0700178
179 dataModules map[string]android.Path
Julien Desprez9e7fc142019-03-08 11:07:05 -0800180}
181
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700182func (s *ShBinary) HostToolPath() android.OptionalPath {
183 return android.OptionalPathForPath(s.installedFile)
Colin Cross7c7c1142019-07-29 16:46:49 -0700184}
185
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700186func (s *ShBinary) DepsMutator(ctx android.BottomUpMutatorContext) {
Dan Willemsenb0552672019-01-25 16:04:11 -0800187}
188
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700189func (s *ShBinary) OutputFile() android.OutputPath {
Dan Willemsenb0552672019-01-25 16:04:11 -0800190 return s.outputFilePath
191}
192
Edward Liaw492ca052023-08-07 19:03:22 +0000193func (s *ShBinary) OutputFiles(tag string) (android.Paths, error) {
194 switch tag {
195 case "":
196 return android.Paths{s.outputFilePath}, nil
197 default:
198 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
199 }
200}
201
Dan Willemsenb0552672019-01-25 16:04:11 -0800202func (s *ShBinary) SubDir() string {
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700203 return proptools.String(s.properties.Sub_dir)
Dan Willemsenb0552672019-01-25 16:04:11 -0800204}
205
Rob Seymour925aa092021-08-10 20:42:03 +0000206func (s *ShBinary) RelativeInstallPath() string {
207 return s.SubDir()
208}
Dan Willemsenb0552672019-01-25 16:04:11 -0800209func (s *ShBinary) Installable() bool {
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700210 return s.properties.Installable == nil || proptools.Bool(s.properties.Installable)
Dan Willemsenb0552672019-01-25 16:04:11 -0800211}
212
Rashed Abdel-Tawab6a341312019-10-04 20:38:01 -0700213func (s *ShBinary) Symlinks() []string {
214 return s.properties.Symlinks
215}
216
Colin Crosscc83efb2020-08-21 14:25:33 -0700217var _ android.ImageInterface = (*ShBinary)(nil)
218
219func (s *ShBinary) ImageMutatorBegin(ctx android.BaseModuleContext) {}
220
221func (s *ShBinary) CoreVariantNeeded(ctx android.BaseModuleContext) bool {
222 return !s.ModuleBase.InstallInRecovery() && !s.ModuleBase.InstallInRamdisk()
223}
224
225func (s *ShBinary) RamdiskVariantNeeded(ctx android.BaseModuleContext) bool {
226 return proptools.Bool(s.properties.Ramdisk_available) || s.ModuleBase.InstallInRamdisk()
227}
228
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700229func (s *ShBinary) VendorRamdiskVariantNeeded(ctx android.BaseModuleContext) bool {
230 return proptools.Bool(s.properties.Vendor_ramdisk_available) || s.ModuleBase.InstallInVendorRamdisk()
231}
232
Inseob Kim08758f02021-04-08 21:13:22 +0900233func (s *ShBinary) DebugRamdiskVariantNeeded(ctx android.BaseModuleContext) bool {
234 return false
235}
236
Colin Crosscc83efb2020-08-21 14:25:33 -0700237func (s *ShBinary) RecoveryVariantNeeded(ctx android.BaseModuleContext) bool {
238 return proptools.Bool(s.properties.Recovery_available) || s.ModuleBase.InstallInRecovery()
239}
240
241func (s *ShBinary) ExtraImageVariations(ctx android.BaseModuleContext) []string {
242 return nil
243}
244
245func (s *ShBinary) SetImageVariation(ctx android.BaseModuleContext, variation string, module android.Module) {
246}
247
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700248func (s *ShBinary) generateAndroidBuildActions(ctx android.ModuleContext) {
Liz Kammer356f7d42021-01-26 09:18:53 -0500249 if s.properties.Src == nil {
250 ctx.PropertyErrorf("src", "missing prebuilt source file")
251 }
252
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700253 s.sourceFilePath = android.PathForModuleSrc(ctx, proptools.String(s.properties.Src))
254 filename := proptools.String(s.properties.Filename)
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800255 filenameFromSrc := proptools.Bool(s.properties.Filename_from_src)
Dan Willemsenb0552672019-01-25 16:04:11 -0800256 if filename == "" {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800257 if filenameFromSrc {
Dan Willemsenb0552672019-01-25 16:04:11 -0800258 filename = s.sourceFilePath.Base()
259 } else {
260 filename = ctx.ModuleName()
261 }
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800262 } else if filenameFromSrc {
Dan Willemsenb0552672019-01-25 16:04:11 -0800263 ctx.PropertyErrorf("filename_from_src", "filename is set. filename_from_src can't be true")
264 return
265 }
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700266 s.outputFilePath = android.PathForModuleOut(ctx, filename).OutputPath
Dan Willemsenb0552672019-01-25 16:04:11 -0800267
268 // This ensures that outputFilePath has the correct name for others to
269 // use, as the source file may have a different name.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700270 ctx.Build(pctx, android.BuildParams{
271 Rule: android.CpExecutable,
Dan Willemsenb0552672019-01-25 16:04:11 -0800272 Output: s.outputFilePath,
273 Input: s.sourceFilePath,
274 })
Aditya Choudhary26df39f2023-11-29 16:42:42 +0000275 ctx.SetProvider(blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: []string{s.sourceFilePath.String()}})
Dan Willemsenb0552672019-01-25 16:04:11 -0800276}
277
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700278func (s *ShBinary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross7c7c1142019-07-29 16:46:49 -0700279 s.generateAndroidBuildActions(ctx)
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700280 installDir := android.PathForModuleInstall(ctx, "bin", proptools.String(s.properties.Sub_dir))
Sundong Ahna5c5b9c2022-01-12 03:29:17 +0000281 if !s.Installable() {
282 s.SkipInstall()
283 }
Colin Cross7c7c1142019-07-29 16:46:49 -0700284 s.installedFile = ctx.InstallExecutable(installDir, s.outputFilePath.Base(), s.outputFilePath)
Colin Cross94bf5182021-11-09 17:21:14 -0800285 for _, symlink := range s.Symlinks() {
286 ctx.InstallSymlink(installDir, symlink, s.installedFile)
287 }
Colin Cross7c7c1142019-07-29 16:46:49 -0700288}
289
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700290func (s *ShBinary) AndroidMkEntries() []android.AndroidMkEntries {
291 return []android.AndroidMkEntries{android.AndroidMkEntries{
Dan Willemsenb0552672019-01-25 16:04:11 -0800292 Class: "EXECUTABLES",
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700293 OutputFile: android.OptionalPathForPath(s.outputFilePath),
Ivan Lozanod06cc742021-11-12 13:27:58 -0500294 Include: "$(BUILD_SYSTEM)/soong_cc_rust_prebuilt.mk",
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700295 ExtraEntries: []android.AndroidMkExtraEntriesFunc{
Colin Crossaa255532020-07-03 13:18:24 -0700296 func(ctx android.AndroidMkExtraEntriesContext, entries *android.AndroidMkEntries) {
Jaewoong Junge0dc8df2019-08-27 17:33:16 -0700297 s.customAndroidMkEntries(entries)
Jaewoong Jung4aedc862020-06-10 17:23:46 -0700298 entries.SetString("LOCAL_MODULE_RELATIVE_PATH", proptools.String(s.properties.Sub_dir))
Sundong Ahna5c5b9c2022-01-12 03:29:17 +0000299 entries.SetBoolIfTrue("LOCAL_UNINSTALLABLE_MODULE", !s.Installable())
Jaewoong Junge0dc8df2019-08-27 17:33:16 -0700300 },
Dan Willemsenb0552672019-01-25 16:04:11 -0800301 },
Jiyong Park0b0e1b92019-12-03 13:24:29 +0900302 }}
Dan Willemsenb0552672019-01-25 16:04:11 -0800303}
304
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700305func (s *ShBinary) customAndroidMkEntries(entries *android.AndroidMkEntries) {
Jaewoong Jung8eaeb092019-05-16 14:58:29 -0700306 entries.SetString("LOCAL_MODULE_SUFFIX", "")
307 entries.SetString("LOCAL_MODULE_STEM", s.outputFilePath.Rel())
Rashed Abdel-Tawab6a341312019-10-04 20:38:01 -0700308 if len(s.properties.Symlinks) > 0 {
309 entries.SetString("LOCAL_MODULE_SYMLINKS", strings.Join(s.properties.Symlinks, " "))
310 }
Jaewoong Jung8eaeb092019-05-16 14:58:29 -0700311}
312
Jaewoong Jung6e0eee52020-05-29 16:15:32 -0700313type dependencyTag struct {
314 blueprint.BaseDependencyTag
315 name string
316}
317
318var (
319 shTestDataBinsTag = dependencyTag{name: "dataBins"}
320 shTestDataLibsTag = dependencyTag{name: "dataLibs"}
321 shTestDataDeviceBinsTag = dependencyTag{name: "dataDeviceBins"}
322 shTestDataDeviceLibsTag = dependencyTag{name: "dataDeviceLibs"}
Makoto Onuki1725b202023-08-24 22:17:56 +0000323 shTestJavaDataTag = dependencyTag{name: "javaData"}
Jaewoong Jung6e0eee52020-05-29 16:15:32 -0700324)
325
326var sharedLibVariations = []blueprint.Variation{{Mutator: "link", Variation: "shared"}}
327
328func (s *ShTest) DepsMutator(ctx android.BottomUpMutatorContext) {
329 s.ShBinary.DepsMutator(ctx)
330
331 ctx.AddFarVariationDependencies(ctx.Target().Variations(), shTestDataBinsTag, s.testProperties.Data_bins...)
332 ctx.AddFarVariationDependencies(append(ctx.Target().Variations(), sharedLibVariations...),
333 shTestDataLibsTag, s.testProperties.Data_libs...)
Liz Kammer3bf97bd2022-04-26 09:38:20 -0400334 if ctx.Target().Os.Class == android.Host && len(ctx.Config().Targets[android.Android]) > 0 {
Jaewoong Jung642916f2020-10-09 17:25:15 -0700335 deviceVariations := ctx.Config().AndroidFirstDeviceTarget.Variations()
Jaewoong Jung6e0eee52020-05-29 16:15:32 -0700336 ctx.AddFarVariationDependencies(deviceVariations, shTestDataDeviceBinsTag, s.testProperties.Data_device_bins...)
337 ctx.AddFarVariationDependencies(append(deviceVariations, sharedLibVariations...),
338 shTestDataDeviceLibsTag, s.testProperties.Data_device_libs...)
Makoto Onuki1725b202023-08-24 22:17:56 +0000339
340 javaDataVariation := []blueprint.Variation{{"arch", android.Common.String()}}
341 ctx.AddVariationDependencies(javaDataVariation, shTestJavaDataTag, s.testProperties.Java_data...)
342
Jaewoong Jung6e0eee52020-05-29 16:15:32 -0700343 } else if ctx.Target().Os.Class != android.Host {
344 if len(s.testProperties.Data_device_bins) > 0 {
345 ctx.PropertyErrorf("data_device_bins", "only available for host modules")
346 }
347 if len(s.testProperties.Data_device_libs) > 0 {
348 ctx.PropertyErrorf("data_device_libs", "only available for host modules")
349 }
Makoto Onuki1725b202023-08-24 22:17:56 +0000350 if len(s.testProperties.Java_data) > 0 {
351 ctx.PropertyErrorf("Java_data", "only available for host modules")
352 }
Jaewoong Jung6e0eee52020-05-29 16:15:32 -0700353 }
354}
355
356func (s *ShTest) addToDataModules(ctx android.ModuleContext, relPath string, path android.Path) {
357 if _, exists := s.dataModules[relPath]; exists {
358 ctx.ModuleErrorf("data modules have a conflicting installation path, %v - %s, %s",
359 relPath, s.dataModules[relPath].String(), path.String())
360 return
361 }
362 s.dataModules[relPath] = path
Colin Cross5c1d5fb2023-11-15 12:39:40 -0800363 s.data = append(s.data, android.DataPath{SrcPath: path})
Jaewoong Jung6e0eee52020-05-29 16:15:32 -0700364}
365
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700366func (s *ShTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross7c7c1142019-07-29 16:46:49 -0700367 s.ShBinary.generateAndroidBuildActions(ctx)
Colin Cross5c1d5fb2023-11-15 12:39:40 -0800368
369 expandedData := android.PathsForModuleSrc(ctx, s.testProperties.Data)
370 // Emulate the data property for java_data dependencies.
371 for _, javaData := range ctx.GetDirectDepsWithTag(shTestJavaDataTag) {
372 expandedData = append(expandedData, android.OutputFilesForModule(ctx, javaData, "")...)
373 }
374 for _, d := range expandedData {
375 s.data = append(s.data, android.DataPath{SrcPath: d})
376 }
377
Colin Cross7c7c1142019-07-29 16:46:49 -0700378 testDir := "nativetest"
379 if ctx.Target().Arch.ArchType.Multilib == "lib64" {
380 testDir = "nativetest64"
381 }
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700382 if ctx.Target().NativeBridge == android.NativeBridgeEnabled {
Colin Cross7c7c1142019-07-29 16:46:49 -0700383 testDir = filepath.Join(testDir, ctx.Target().NativeBridgeRelativePath)
384 } else if !ctx.Host() && ctx.Config().HasMultilibConflict(ctx.Arch().ArchType) {
385 testDir = filepath.Join(testDir, ctx.Arch().ArchType.String())
386 }
Jaewoong Jung4aedc862020-06-10 17:23:46 -0700387 if s.SubDir() != "" {
388 // Don't add the module name to the installation path if sub_dir is specified for backward
389 // compatibility.
390 s.installDir = android.PathForModuleInstall(ctx, testDir, s.SubDir())
391 } else {
392 s.installDir = android.PathForModuleInstall(ctx, testDir, s.Name())
393 }
frankfengc5b87492020-06-03 10:28:47 -0700394
395 var configs []tradefed.Config
396 if Bool(s.testProperties.Require_root) {
397 configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.RootTargetPreparer", nil})
398 } else {
399 options := []tradefed.Option{{Name: "force-root", Value: "false"}}
400 configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.RootTargetPreparer", options})
401 }
frankfengbe6ae772020-09-28 13:22:57 -0700402 if len(s.testProperties.Data_device_bins) > 0 {
403 moduleName := s.Name()
404 remoteDir := "/data/local/tests/unrestricted/" + moduleName + "/"
405 options := []tradefed.Option{{Name: "cleanup", Value: "true"}}
406 for _, bin := range s.testProperties.Data_device_bins {
407 options = append(options, tradefed.Option{Name: "push-file", Key: bin, Value: remoteDir + bin})
408 }
409 configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.PushFilePreparer", options})
410 }
Cole Faust21680542022-12-07 18:18:37 -0800411 s.testConfig = tradefed.AutoGenTestConfig(ctx, tradefed.AutoGenTestConfigOptions{
412 TestConfigProp: s.testProperties.Test_config,
413 TestConfigTemplateProp: s.testProperties.Test_config_template,
414 TestSuites: s.testProperties.Test_suites,
415 Config: configs,
416 AutoGenConfig: s.testProperties.Auto_gen_config,
417 OutputFileName: s.outputFilePath.Base(),
418 DeviceTemplate: "${ShellTestConfigTemplate}",
419 HostTemplate: "${ShellTestConfigTemplate}",
420 })
Jaewoong Jung6e0eee52020-05-29 16:15:32 -0700421
422 s.dataModules = make(map[string]android.Path)
423 ctx.VisitDirectDeps(func(dep android.Module) {
424 depTag := ctx.OtherModuleDependencyTag(dep)
425 switch depTag {
426 case shTestDataBinsTag, shTestDataDeviceBinsTag:
Anton Hansson2f6422c2020-12-31 13:42:10 +0000427 path := android.OutputFileForModule(ctx, dep, "")
428 s.addToDataModules(ctx, path.Base(), path)
Jaewoong Jung6e0eee52020-05-29 16:15:32 -0700429 case shTestDataLibsTag, shTestDataDeviceLibsTag:
430 if cc, isCc := dep.(*cc.Module); isCc {
431 // Copy to an intermediate output directory to append "lib[64]" to the path,
432 // so that it's compatible with the default rpath values.
433 var relPath string
434 if cc.Arch().ArchType.Multilib == "lib64" {
435 relPath = filepath.Join("lib64", cc.OutputFile().Path().Base())
436 } else {
437 relPath = filepath.Join("lib", cc.OutputFile().Path().Base())
438 }
439 if _, exist := s.dataModules[relPath]; exist {
440 return
441 }
Colin Cross5c1d5fb2023-11-15 12:39:40 -0800442 relocatedLib := android.PathForModuleOut(ctx, "relocated").Join(ctx, relPath)
Jaewoong Jung6e0eee52020-05-29 16:15:32 -0700443 ctx.Build(pctx, android.BuildParams{
444 Rule: android.Cp,
445 Input: cc.OutputFile().Path(),
446 Output: relocatedLib,
447 })
448 s.addToDataModules(ctx, relPath, relocatedLib)
449 return
450 }
451 property := "data_libs"
452 if depTag == shTestDataDeviceBinsTag {
453 property = "data_device_libs"
454 }
455 ctx.PropertyErrorf(property, "%q of type %q is not supported", dep.Name(), ctx.OtherModuleType(dep))
456 }
457 })
Colin Cross5c1d5fb2023-11-15 12:39:40 -0800458
459 installedData := ctx.InstallTestData(s.installDir, s.data)
460 s.installedFile = ctx.InstallExecutable(s.installDir, s.outputFilePath.Base(), s.outputFilePath, installedData...)
461
Aditya Choudhary9b593522023-10-06 19:54:58 +0000462 ctx.SetProvider(testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Jaewoong Jung8eaeb092019-05-16 14:58:29 -0700463}
464
Colin Cross7c7c1142019-07-29 16:46:49 -0700465func (s *ShTest) InstallInData() bool {
466 return true
467}
468
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700469func (s *ShTest) AndroidMkEntries() []android.AndroidMkEntries {
470 return []android.AndroidMkEntries{android.AndroidMkEntries{
Jaewoong Jung8eaeb092019-05-16 14:58:29 -0700471 Class: "NATIVE_TESTS",
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700472 OutputFile: android.OptionalPathForPath(s.outputFilePath),
Ivan Lozanod06cc742021-11-12 13:27:58 -0500473 Include: "$(BUILD_SYSTEM)/soong_cc_rust_prebuilt.mk",
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700474 ExtraEntries: []android.AndroidMkExtraEntriesFunc{
Colin Crossaa255532020-07-03 13:18:24 -0700475 func(ctx android.AndroidMkExtraEntriesContext, entries *android.AndroidMkEntries) {
Jaewoong Junge0dc8df2019-08-27 17:33:16 -0700476 s.customAndroidMkEntries(entries)
Colin Crossc68db4b2021-11-11 18:59:15 -0800477 entries.SetPath("LOCAL_MODULE_PATH", s.installDir)
Liz Kammer57f5b332020-11-24 12:42:58 -0800478 entries.AddCompatibilityTestSuites(s.testProperties.Test_suites...)
Colin Crossa6384822020-06-09 15:09:22 -0700479 if s.testConfig != nil {
480 entries.SetPath("LOCAL_FULL_TEST_CONFIG", s.testConfig)
frankfengc5b87492020-06-03 10:28:47 -0700481 }
yangbill22bafec2022-02-11 18:06:07 +0800482 if s.testProperties.Data_bins != nil {
483 entries.AddStrings("LOCAL_TEST_DATA_BINS", s.testProperties.Data_bins...)
484 }
Jooyung Han3ae4cca2022-02-22 16:33:24 +0900485 entries.SetBoolIfTrue("LOCAL_COMPATIBILITY_PER_TESTCASE_DIRECTORY", Bool(s.testProperties.Per_testcase_directory))
Zhenhuang Wang0ac5a432022-08-12 18:49:20 +0800486
487 s.testProperties.Test_options.SetAndroidMkEntries(entries)
Jaewoong Junge0dc8df2019-08-27 17:33:16 -0700488 },
Jaewoong Jung8eaeb092019-05-16 14:58:29 -0700489 },
Jiyong Park0b0e1b92019-12-03 13:24:29 +0900490 }}
Julien Desprez9e7fc142019-03-08 11:07:05 -0800491}
492
Liz Kammer9b2ca5c2023-04-28 17:39:24 -0400493func initShBinaryModule(s *ShBinary, useBazel bool) {
Dan Willemsenb0552672019-01-25 16:04:11 -0800494 s.AddProperties(&s.properties)
Liz Kammer9b2ca5c2023-04-28 17:39:24 -0400495 if useBazel {
496 android.InitBazelModule(s)
497 }
Dan Willemsenb0552672019-01-25 16:04:11 -0800498}
499
Patrice Arrudae1034192019-03-11 13:20:17 -0700500// sh_binary is for a shell script or batch file to be installed as an
501// executable binary to <partition>/bin.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700502func ShBinaryFactory() android.Module {
Dan Willemsenb0552672019-01-25 16:04:11 -0800503 module := &ShBinary{}
Liz Kammer9b2ca5c2023-04-28 17:39:24 -0400504 initShBinaryModule(module, true)
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700505 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibFirst)
Dan Willemsenb0552672019-01-25 16:04:11 -0800506 return module
507}
508
Patrice Arrudae1034192019-03-11 13:20:17 -0700509// sh_binary_host is for a shell script to be installed as an executable binary
510// to $(HOST_OUT)/bin.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700511func ShBinaryHostFactory() android.Module {
Dan Willemsenb0552672019-01-25 16:04:11 -0800512 module := &ShBinary{}
Liz Kammer9b2ca5c2023-04-28 17:39:24 -0400513 initShBinaryModule(module, true)
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700514 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibFirst)
Dan Willemsenb0552672019-01-25 16:04:11 -0800515 return module
516}
Julien Desprez9e7fc142019-03-08 11:07:05 -0800517
Jaewoong Jung61a83682019-07-01 09:08:50 -0700518// sh_test defines a shell script based test module.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700519func ShTestFactory() android.Module {
Julien Desprez9e7fc142019-03-08 11:07:05 -0800520 module := &ShTest{}
Jason Wu6d8d44a2023-08-08 22:09:12 -0400521 initShBinaryModule(&module.ShBinary, true)
Julien Desprez9e7fc142019-03-08 11:07:05 -0800522 module.AddProperties(&module.testProperties)
523
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700524 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibFirst)
Julien Desprez9e7fc142019-03-08 11:07:05 -0800525 return module
526}
Jaewoong Jung61a83682019-07-01 09:08:50 -0700527
528// sh_test_host defines a shell script based test module that runs on a host.
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700529func ShTestHostFactory() android.Module {
Jaewoong Jung61a83682019-07-01 09:08:50 -0700530 module := &ShTest{}
Jason Wu6d8d44a2023-08-08 22:09:12 -0400531 initShBinaryModule(&module.ShBinary, true)
Jaewoong Jung61a83682019-07-01 09:08:50 -0700532 module.AddProperties(&module.testProperties)
Julien Desprez06f13992021-06-28 13:41:43 -0700533 // Default sh_test_host to unit_tests = true
534 if module.testProperties.Test_options.Unit_test == nil {
535 module.testProperties.Test_options.Unit_test = proptools.BoolPtr(true)
536 }
Jaewoong Jung61a83682019-07-01 09:08:50 -0700537
Jaewoong Jung4b79e982020-06-01 10:45:49 -0700538 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibFirst)
Jaewoong Jung61a83682019-07-01 09:08:50 -0700539 return module
540}
frankfengc5b87492020-06-03 10:28:47 -0700541
Rupert Shuttlewortha1a56e82021-02-09 10:59:06 +0000542type bazelShBinaryAttributes struct {
Yu Liub3024552021-11-23 14:53:41 -0800543 Srcs bazel.LabelListAttribute
Liz Kammer48c6ead2021-12-21 15:36:11 -0500544 Filename *string
545 Sub_dir *string
Rupert Shuttlewortha1a56e82021-02-09 10:59:06 +0000546 // Bazel also supports the attributes below, but (so far) these are not required for Bionic
547 // deps
548 // data
549 // args
550 // compatible_with
551 // deprecation
552 // distribs
553 // env
554 // exec_compatible_with
555 // exec_properties
556 // features
557 // licenses
558 // output_licenses
559 // restricted_to
560 // tags
561 // target_compatible_with
562 // testonly
563 // toolchains
564 // visibility
565}
566
Jason Wu6d8d44a2023-08-08 22:09:12 -0400567type bazelShTestAttributes struct {
Jason Wu25c69ee2023-08-24 15:40:10 -0400568 Srcs bazel.LabelListAttribute
569 Data bazel.LabelListAttribute
570 Data_bins bazel.LabelListAttribute
571 Tags bazel.StringListAttribute
572 Runs_on bazel.StringListAttribute
573 tradefed.TestConfigAttributes
Jason Wu6d8d44a2023-08-08 22:09:12 -0400574}
575
Chris Parsons637458d2023-09-19 20:09:00 +0000576func (m *ShBinary) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
Jingwen Chen07027912021-03-15 06:02:43 -0400577 srcs := bazel.MakeLabelListAttribute(
578 android.BazelLabelForModuleSrc(ctx, []string{*m.properties.Src}))
Rupert Shuttlewortha1a56e82021-02-09 10:59:06 +0000579
Liz Kammer48c6ead2021-12-21 15:36:11 -0500580 var filename *string
Yu Liub3024552021-11-23 14:53:41 -0800581 if m.properties.Filename != nil {
Liz Kammer48c6ead2021-12-21 15:36:11 -0500582 filename = m.properties.Filename
Yu Liub3024552021-11-23 14:53:41 -0800583 }
584
Liz Kammer48c6ead2021-12-21 15:36:11 -0500585 var subDir *string
Yu Liub3024552021-11-23 14:53:41 -0800586 if m.properties.Sub_dir != nil {
Liz Kammer48c6ead2021-12-21 15:36:11 -0500587 subDir = m.properties.Sub_dir
Yu Liub3024552021-11-23 14:53:41 -0800588 }
589
Rupert Shuttlewortha1a56e82021-02-09 10:59:06 +0000590 attrs := &bazelShBinaryAttributes{
Yu Liub3024552021-11-23 14:53:41 -0800591 Srcs: srcs,
592 Filename: filename,
593 Sub_dir: subDir,
Rupert Shuttlewortha1a56e82021-02-09 10:59:06 +0000594 }
595
Liz Kammerfc46bc12021-02-19 11:06:17 -0500596 props := bazel.BazelTargetModuleProperties{
Yu Liub3024552021-11-23 14:53:41 -0800597 Rule_class: "sh_binary",
598 Bzl_load_location: "//build/bazel/rules:sh_binary.bzl",
Liz Kammerfc46bc12021-02-19 11:06:17 -0500599 }
Rupert Shuttlewortha1a56e82021-02-09 10:59:06 +0000600
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux447f6c92021-08-31 20:30:36 +0000601 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: m.Name()}, attrs)
Rupert Shuttlewortha1a56e82021-02-09 10:59:06 +0000602}
603
Chris Parsons637458d2023-09-19 20:09:00 +0000604func (m *ShTest) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
Jason Wu6d8d44a2023-08-08 22:09:12 -0400605 srcs := bazel.MakeLabelListAttribute(
606 android.BazelLabelForModuleSrc(ctx, []string{*m.properties.Src}))
607
Jason Wu25c69ee2023-08-24 15:40:10 -0400608 dataBins := bazel.MakeLabelListAttribute(android.BazelLabelForModuleDeps(ctx, m.testProperties.Data_bins))
Jason Wu6d8d44a2023-08-08 22:09:12 -0400609
Jason Wu25c69ee2023-08-24 15:40:10 -0400610 var combinedData bazel.LabelList
611 combinedData.Append(android.BazelLabelForModuleSrc(ctx, m.testProperties.Data))
612 combinedData.Append(android.BazelLabelForModuleDeps(ctx, m.testProperties.Data_bins))
613 combinedData.Append(android.BazelLabelForModuleDeps(ctx, m.testProperties.Data_libs))
614 data := bazel.MakeLabelListAttribute(combinedData)
Jason Wu6d8d44a2023-08-08 22:09:12 -0400615
616 tags := bazel.MakeStringListAttribute(
617 m.testProperties.Test_options.Tags)
618
Jason Wu25c69ee2023-08-24 15:40:10 -0400619 testConfigAttributes := tradefed.GetTestConfigAttributes(
620 ctx,
621 m.testProperties.Test_config,
622 []string{},
623 m.testProperties.Auto_gen_config,
624 m.testProperties.Test_suites,
625 m.testProperties.Test_config_template,
626 nil,
627 nil,
628 )
Jason Wu6d8d44a2023-08-08 22:09:12 -0400629
Jason Wu25c69ee2023-08-24 15:40:10 -0400630 unitTest := m.testProperties.Test_options.Unit_test
Jason Wu6d8d44a2023-08-08 22:09:12 -0400631
Jason Wu25c69ee2023-08-24 15:40:10 -0400632 runs_on := bazel.MakeStringListAttribute(android.RunsOn(
633 m.ModuleBase.HostSupported(),
634 m.ModuleBase.DeviceSupported(),
635 (unitTest != nil && *unitTest)))
Jason Wu6d8d44a2023-08-08 22:09:12 -0400636
637 attrs := &bazelShTestAttributes{
638 Srcs: srcs,
639 Data: data,
Jason Wu25c69ee2023-08-24 15:40:10 -0400640 Data_bins: dataBins,
Jason Wu6d8d44a2023-08-08 22:09:12 -0400641 Tags: tags,
Jason Wu25c69ee2023-08-24 15:40:10 -0400642 Runs_on: runs_on,
643 TestConfigAttributes: testConfigAttributes,
Jason Wu6d8d44a2023-08-08 22:09:12 -0400644 }
645
646 props := bazel.BazelTargetModuleProperties{
647 Rule_class: "sh_test",
648 Bzl_load_location: "//build/bazel/rules:sh_test.bzl",
649 }
650 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: m.Name()}, attrs)
651}
652
frankfengc5b87492020-06-03 10:28:47 -0700653var Bool = proptools.Bool
Rob Seymour925aa092021-08-10 20:42:03 +0000654
655var _ snapshot.RelativeInstallPath = (*ShBinary)(nil)