4aedc86c6c
This relands Ibb1d774709ea421e18d5350009c203f83c5b2d60 after fixing a backward compatibility issue where some test configs rely on sh_tests not having a module name in their paths when sub_dir is specified. Bug: 156980228 Test: m ziptool-tests Test: sh_binary_test.go Change-Id: If0521a008e7170d94b601f3df9dd0c12d1c96d21
301 lines
9.9 KiB
Go
301 lines
9.9 KiB
Go
// Copyright 2019 Google Inc. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package sh
|
|
|
|
import (
|
|
"fmt"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/google/blueprint/proptools"
|
|
|
|
"android/soong/android"
|
|
"android/soong/tradefed"
|
|
)
|
|
|
|
// sh_binary is for shell scripts (and batch files) that are installed as
|
|
// executable files into .../bin/
|
|
//
|
|
// Do not use them for prebuilt C/C++/etc files. Use cc_prebuilt_binary
|
|
// instead.
|
|
|
|
var pctx = android.NewPackageContext("android/soong/sh")
|
|
|
|
func init() {
|
|
pctx.Import("android/soong/android")
|
|
|
|
android.RegisterModuleType("sh_binary", ShBinaryFactory)
|
|
android.RegisterModuleType("sh_binary_host", ShBinaryHostFactory)
|
|
android.RegisterModuleType("sh_test", ShTestFactory)
|
|
android.RegisterModuleType("sh_test_host", ShTestHostFactory)
|
|
}
|
|
|
|
type shBinaryProperties struct {
|
|
// Source file of this prebuilt.
|
|
Src *string `android:"path,arch_variant"`
|
|
|
|
// optional subdirectory under which this file is installed into
|
|
Sub_dir *string `android:"arch_variant"`
|
|
|
|
// optional name for the installed file. If unspecified, name of the module is used as the file name
|
|
Filename *string `android:"arch_variant"`
|
|
|
|
// when set to true, and filename property is not set, the name for the installed file
|
|
// is the same as the file name of the source file.
|
|
Filename_from_src *bool `android:"arch_variant"`
|
|
|
|
// Whether this module is directly installable to one of the partitions. Default: true.
|
|
Installable *bool
|
|
|
|
// install symlinks to the binary
|
|
Symlinks []string `android:"arch_variant"`
|
|
}
|
|
|
|
type TestProperties struct {
|
|
// list of compatibility suites (for example "cts", "vts") that the module should be
|
|
// installed into.
|
|
Test_suites []string `android:"arch_variant"`
|
|
|
|
// the name of the test configuration (for example "AndroidTest.xml") that should be
|
|
// installed with the module.
|
|
Test_config *string `android:"path,arch_variant"`
|
|
|
|
// list of files or filegroup modules that provide data that should be installed alongside
|
|
// the test.
|
|
Data []string `android:"path,arch_variant"`
|
|
|
|
// Add RootTargetPreparer to auto generated test config. This guarantees the test to run
|
|
// with root permission.
|
|
Require_root *bool
|
|
|
|
// the name of the test configuration template (for example "AndroidTestTemplate.xml") that
|
|
// should be installed with the module.
|
|
Test_config_template *string `android:"path,arch_variant"`
|
|
|
|
// Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
|
|
// doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
|
|
// explicitly.
|
|
Auto_gen_config *bool
|
|
}
|
|
|
|
type ShBinary struct {
|
|
android.ModuleBase
|
|
|
|
properties shBinaryProperties
|
|
|
|
sourceFilePath android.Path
|
|
outputFilePath android.OutputPath
|
|
installedFile android.InstallPath
|
|
}
|
|
|
|
var _ android.HostToolProvider = (*ShBinary)(nil)
|
|
|
|
type ShTest struct {
|
|
ShBinary
|
|
|
|
testProperties TestProperties
|
|
|
|
installDir android.InstallPath
|
|
|
|
data android.Paths
|
|
testConfig android.Path
|
|
}
|
|
|
|
func (s *ShBinary) HostToolPath() android.OptionalPath {
|
|
return android.OptionalPathForPath(s.installedFile)
|
|
}
|
|
|
|
func (s *ShBinary) DepsMutator(ctx android.BottomUpMutatorContext) {
|
|
if s.properties.Src == nil {
|
|
ctx.PropertyErrorf("src", "missing prebuilt source file")
|
|
}
|
|
}
|
|
|
|
func (s *ShBinary) OutputFile() android.OutputPath {
|
|
return s.outputFilePath
|
|
}
|
|
|
|
func (s *ShBinary) SubDir() string {
|
|
return proptools.String(s.properties.Sub_dir)
|
|
}
|
|
|
|
func (s *ShBinary) Installable() bool {
|
|
return s.properties.Installable == nil || proptools.Bool(s.properties.Installable)
|
|
}
|
|
|
|
func (s *ShBinary) Symlinks() []string {
|
|
return s.properties.Symlinks
|
|
}
|
|
|
|
func (s *ShBinary) generateAndroidBuildActions(ctx android.ModuleContext) {
|
|
s.sourceFilePath = android.PathForModuleSrc(ctx, proptools.String(s.properties.Src))
|
|
filename := proptools.String(s.properties.Filename)
|
|
filename_from_src := proptools.Bool(s.properties.Filename_from_src)
|
|
if filename == "" {
|
|
if filename_from_src {
|
|
filename = s.sourceFilePath.Base()
|
|
} else {
|
|
filename = ctx.ModuleName()
|
|
}
|
|
} else if filename_from_src {
|
|
ctx.PropertyErrorf("filename_from_src", "filename is set. filename_from_src can't be true")
|
|
return
|
|
}
|
|
s.outputFilePath = android.PathForModuleOut(ctx, filename).OutputPath
|
|
|
|
// This ensures that outputFilePath has the correct name for others to
|
|
// use, as the source file may have a different name.
|
|
ctx.Build(pctx, android.BuildParams{
|
|
Rule: android.CpExecutable,
|
|
Output: s.outputFilePath,
|
|
Input: s.sourceFilePath,
|
|
})
|
|
}
|
|
|
|
func (s *ShBinary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
|
|
s.generateAndroidBuildActions(ctx)
|
|
installDir := android.PathForModuleInstall(ctx, "bin", proptools.String(s.properties.Sub_dir))
|
|
s.installedFile = ctx.InstallExecutable(installDir, s.outputFilePath.Base(), s.outputFilePath)
|
|
}
|
|
|
|
func (s *ShBinary) AndroidMkEntries() []android.AndroidMkEntries {
|
|
return []android.AndroidMkEntries{android.AndroidMkEntries{
|
|
Class: "EXECUTABLES",
|
|
OutputFile: android.OptionalPathForPath(s.outputFilePath),
|
|
Include: "$(BUILD_SYSTEM)/soong_cc_prebuilt.mk",
|
|
ExtraEntries: []android.AndroidMkExtraEntriesFunc{
|
|
func(entries *android.AndroidMkEntries) {
|
|
s.customAndroidMkEntries(entries)
|
|
entries.SetString("LOCAL_MODULE_RELATIVE_PATH", proptools.String(s.properties.Sub_dir))
|
|
},
|
|
},
|
|
}}
|
|
}
|
|
|
|
func (s *ShBinary) customAndroidMkEntries(entries *android.AndroidMkEntries) {
|
|
entries.SetString("LOCAL_MODULE_SUFFIX", "")
|
|
entries.SetString("LOCAL_MODULE_STEM", s.outputFilePath.Rel())
|
|
if len(s.properties.Symlinks) > 0 {
|
|
entries.SetString("LOCAL_MODULE_SYMLINKS", strings.Join(s.properties.Symlinks, " "))
|
|
}
|
|
}
|
|
|
|
func (s *ShTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
|
|
s.ShBinary.generateAndroidBuildActions(ctx)
|
|
testDir := "nativetest"
|
|
if ctx.Target().Arch.ArchType.Multilib == "lib64" {
|
|
testDir = "nativetest64"
|
|
}
|
|
if ctx.Target().NativeBridge == android.NativeBridgeEnabled {
|
|
testDir = filepath.Join(testDir, ctx.Target().NativeBridgeRelativePath)
|
|
} else if !ctx.Host() && ctx.Config().HasMultilibConflict(ctx.Arch().ArchType) {
|
|
testDir = filepath.Join(testDir, ctx.Arch().ArchType.String())
|
|
}
|
|
if s.SubDir() != "" {
|
|
// Don't add the module name to the installation path if sub_dir is specified for backward
|
|
// compatibility.
|
|
s.installDir = android.PathForModuleInstall(ctx, testDir, s.SubDir())
|
|
} else {
|
|
s.installDir = android.PathForModuleInstall(ctx, testDir, s.Name())
|
|
}
|
|
s.installedFile = ctx.InstallExecutable(s.installDir, s.outputFilePath.Base(), s.outputFilePath)
|
|
|
|
s.data = android.PathsForModuleSrc(ctx, s.testProperties.Data)
|
|
|
|
var configs []tradefed.Config
|
|
if Bool(s.testProperties.Require_root) {
|
|
configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.RootTargetPreparer", nil})
|
|
} else {
|
|
options := []tradefed.Option{{Name: "force-root", Value: "false"}}
|
|
configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.RootTargetPreparer", options})
|
|
}
|
|
s.testConfig = tradefed.AutoGenShellTestConfig(ctx, s.testProperties.Test_config,
|
|
s.testProperties.Test_config_template, s.testProperties.Test_suites, configs, s.testProperties.Auto_gen_config, s.outputFilePath.Base())
|
|
}
|
|
|
|
func (s *ShTest) InstallInData() bool {
|
|
return true
|
|
}
|
|
|
|
func (s *ShTest) AndroidMkEntries() []android.AndroidMkEntries {
|
|
return []android.AndroidMkEntries{android.AndroidMkEntries{
|
|
Class: "NATIVE_TESTS",
|
|
OutputFile: android.OptionalPathForPath(s.outputFilePath),
|
|
Include: "$(BUILD_SYSTEM)/soong_cc_prebuilt.mk",
|
|
ExtraEntries: []android.AndroidMkExtraEntriesFunc{
|
|
func(entries *android.AndroidMkEntries) {
|
|
s.customAndroidMkEntries(entries)
|
|
entries.SetPath("LOCAL_MODULE_PATH", s.installDir.ToMakePath())
|
|
entries.AddStrings("LOCAL_COMPATIBILITY_SUITE", s.testProperties.Test_suites...)
|
|
if s.testConfig != nil {
|
|
entries.SetPath("LOCAL_FULL_TEST_CONFIG", s.testConfig)
|
|
}
|
|
for _, d := range s.data {
|
|
rel := d.Rel()
|
|
path := d.String()
|
|
if !strings.HasSuffix(path, rel) {
|
|
panic(fmt.Errorf("path %q does not end with %q", path, rel))
|
|
}
|
|
path = strings.TrimSuffix(path, rel)
|
|
entries.AddStrings("LOCAL_TEST_DATA", path+":"+rel)
|
|
}
|
|
},
|
|
},
|
|
}}
|
|
}
|
|
|
|
func InitShBinaryModule(s *ShBinary) {
|
|
s.AddProperties(&s.properties)
|
|
}
|
|
|
|
// sh_binary is for a shell script or batch file to be installed as an
|
|
// executable binary to <partition>/bin.
|
|
func ShBinaryFactory() android.Module {
|
|
module := &ShBinary{}
|
|
InitShBinaryModule(module)
|
|
android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibFirst)
|
|
return module
|
|
}
|
|
|
|
// sh_binary_host is for a shell script to be installed as an executable binary
|
|
// to $(HOST_OUT)/bin.
|
|
func ShBinaryHostFactory() android.Module {
|
|
module := &ShBinary{}
|
|
InitShBinaryModule(module)
|
|
android.InitAndroidArchModule(module, android.HostSupported, android.MultilibFirst)
|
|
return module
|
|
}
|
|
|
|
// sh_test defines a shell script based test module.
|
|
func ShTestFactory() android.Module {
|
|
module := &ShTest{}
|
|
InitShBinaryModule(&module.ShBinary)
|
|
module.AddProperties(&module.testProperties)
|
|
|
|
android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibFirst)
|
|
return module
|
|
}
|
|
|
|
// sh_test_host defines a shell script based test module that runs on a host.
|
|
func ShTestHostFactory() android.Module {
|
|
module := &ShTest{}
|
|
InitShBinaryModule(&module.ShBinary)
|
|
module.AddProperties(&module.testProperties)
|
|
|
|
android.InitAndroidArchModule(module, android.HostSupported, android.MultilibFirst)
|
|
return module
|
|
}
|
|
|
|
var Bool = proptools.Bool
|