cc/test.go - SHIFTPHONES/android_build_soong - Gitiles

 // Copyright 2016 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 cc

 import (
 	"path/filepath"
 	"strconv"
 	"strings"

 	"android/soong/android"
 	"android/soong/tradefed"
 )

 type TestProperties struct {
 	// if set, build against the gtest library. Defaults to true.
 	Gtest *bool

 	// if set, use the isolated gtest runner. Defaults to false.
 	Isolated *bool

 	// List of APEXes that this module tests. The module has access to
 	// the private part of the listed APEXes even when it is not included in the
 	// APEXes.
 	Test_for []string
 }

 // Test option struct.
 type TestOptions struct {
 	// The UID that you want to run the test as on a device.
 	Run_test_as *string
 	// A list of free-formed strings without spaces that categorize the test.
 	Test_suite_tag []string
 }

 type TestBinaryProperties struct {
 	// Create a separate binary for each source file.  Useful when there is
 	// global state that can not be torn down and reset between each test suite.
 	Test_per_src *bool

 	// Disables the creation of a test-specific directory when used with
 	// relative_install_path. Useful if several tests need to be in the same
 	// directory, but test_per_src doesn't work.
 	No_named_install_directory *bool

 	// list of files or filegroup modules that provide data that should be installed alongside
 	// the test
 	Data []string `android:"path,arch_variant"`

 	// list of shared library modules that should be installed alongside the test
 	Data_libs []string `android:"arch_variant"`

 	// 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"`

 	// 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"`

 	// Test options.
 	Test_options TestOptions

 	// Add RootTargetPreparer to auto generated test config. This guarantees the test to run
 	// with root permission.
 	Require_root *bool

 	// Add RunCommandTargetPreparer to stop framework before the test and start it after the test.
 	Disable_framework *bool

 	// Add MinApiLevelModuleController to auto generated test config. If the device property of
 	// "ro.product.first_api_level" < Test_min_api_level, then skip this module.
 	Test_min_api_level *int64

 	// Add MinApiLevelModuleController to auto generated test config. If the device property of
 	// "ro.build.version.sdk" < Test_min_sdk_version, then skip this module.
 	Test_min_sdk_version *int64

 	// 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

 	// Add parameterized mainline modules to auto generated test config. The options will be
 	// handled by TradeFed to download and install the specified modules on the device.
 	Test_mainline_modules []string
 }

 func init() {
 	android.RegisterModuleType("cc_test", TestFactory)
 	android.RegisterModuleType("cc_test_library", TestLibraryFactory)
 	android.RegisterModuleType("cc_benchmark", BenchmarkFactory)
 	android.RegisterModuleType("cc_test_host", TestHostFactory)
 	android.RegisterModuleType("cc_benchmark_host", BenchmarkHostFactory)
 }

 // cc_test generates a test config file and an executable binary file to test
 // specific functionality on a device. The executable binary gets an implicit
 // static_libs dependency on libgtests unless the gtest flag is set to false.
 func TestFactory() android.Module {
 	module := NewTest(android.HostAndDeviceSupported)
 	return module.Init()
 }

 // cc_test_library creates an archive of files (i.e. .o files) which is later
 // referenced by another module (such as cc_test, cc_defaults or cc_test_library)
 // for archiving or linking.
 func TestLibraryFactory() android.Module {
 	module := NewTestLibrary(android.HostAndDeviceSupported)
 	return module.Init()
 }

 // cc_benchmark compiles an executable binary that performs benchmark testing
 // of a specific component in a device. Additional files such as test suites
 // and test configuration are installed on the side of the compiled executed
 // binary.
 func BenchmarkFactory() android.Module {
 	module := NewBenchmark(android.HostAndDeviceSupported)
 	return module.Init()
 }

 // cc_test_host compiles a test host binary.
 func TestHostFactory() android.Module {
 	module := NewTest(android.HostSupported)
 	return module.Init()
 }

 // cc_benchmark_host compiles an executable binary that performs benchmark
 // testing of a specific component in the host. Additional files such as
 // test suites and test configuration are installed on the side of the
 // compiled executed binary.
 func BenchmarkHostFactory() android.Module {
 	module := NewBenchmark(android.HostSupported)
 	return module.Init()
 }

 type testPerSrc interface {
 	testPerSrc() bool
 	srcs() []string
 	isAllTestsVariation() bool
 	setSrc(string, string)
 	unsetSrc()
 }

 func (test *testBinary) testPerSrc() bool {
 	return Bool(test.Properties.Test_per_src)
 }

 func (test *testBinary) srcs() []string {
 	return test.baseCompiler.Properties.Srcs
 }

 func (test *testBinary) dataPaths() []android.DataPath {
 	return test.data
 }

 func (test *testBinary) isAllTestsVariation() bool {
 	stem := test.binaryDecorator.Properties.Stem
 	return stem != nil && *stem == ""
 }

 func (test *testBinary) setSrc(name, src string) {
 	test.baseCompiler.Properties.Srcs = []string{src}
 	test.binaryDecorator.Properties.Stem = StringPtr(name)
 }

 func (test *testBinary) unsetSrc() {
 	test.baseCompiler.Properties.Srcs = nil
 	test.binaryDecorator.Properties.Stem = StringPtr("")
 }

 var _ testPerSrc = (*testBinary)(nil)

 func TestPerSrcMutator(mctx android.BottomUpMutatorContext) {
 	if m, ok := mctx.Module().(*Module); ok {
 		if test, ok := m.linker.(testPerSrc); ok {
 			numTests := len(test.srcs())
 			if test.testPerSrc() && numTests > 0 {
 				if duplicate, found := android.CheckDuplicate(test.srcs()); found {
 					mctx.PropertyErrorf("srcs", "found a duplicate entry %q", duplicate)
 					return
 				}
 				testNames := make([]string, numTests)
 				for i, src := range test.srcs() {
 					testNames[i] = strings.TrimSuffix(filepath.Base(src), filepath.Ext(src))
 				}
 				// In addition to creating one variation per test source file,
 				// create an additional "all tests" variation named "", and have it
 				// depends on all other test_per_src variations. This is useful to
 				// create subsequent dependencies of a given module on all
 				// test_per_src variations created above: by depending on
 				// variation "", that module will transitively depend on all the
 				// other test_per_src variations without the need to know their
 				// name or even their number.
 				testNames = append(testNames, "")
 				tests := mctx.CreateLocalVariations(testNames...)
 				all_tests := tests[numTests]
 				all_tests.(*Module).linker.(testPerSrc).unsetSrc()
 				// Prevent the "all tests" variation from being installable nor
 				// exporting to Make, as it won't create any output file.
 				all_tests.(*Module).Properties.PreventInstall = true
 				all_tests.(*Module).Properties.HideFromMake = true
 				for i, src := range test.srcs() {
 					tests[i].(*Module).linker.(testPerSrc).setSrc(testNames[i], src)
 					mctx.AddInterVariantDependency(testPerSrcDepTag, all_tests, tests[i])
 				}
 			}
 		}
 	}
 }

 type testDecorator struct {
 	Properties TestProperties
 	linker     *baseLinker
 }

 func (test *testDecorator) gtest() bool {
 	return BoolDefault(test.Properties.Gtest, true)
 }

 func (test *testDecorator) testFor() []string {
 	return test.Properties.Test_for
 }

 func (test *testDecorator) linkerFlags(ctx ModuleContext, flags Flags) Flags {
 	if !test.gtest() {
 		return flags
 	}

 	flags.Local.CFlags = append(flags.Local.CFlags, "-DGTEST_HAS_STD_STRING")
 	if ctx.Host() {
 		flags.Local.CFlags = append(flags.Local.CFlags, "-O0", "-g")

 		switch ctx.Os() {
 		case android.Windows:
 			flags.Local.CFlags = append(flags.Local.CFlags, "-DGTEST_OS_WINDOWS")
 		case android.Linux:
 			flags.Local.CFlags = append(flags.Local.CFlags, "-DGTEST_OS_LINUX")
 		case android.Darwin:
 			flags.Local.CFlags = append(flags.Local.CFlags, "-DGTEST_OS_MAC")
 		}
 	} else {
 		flags.Local.CFlags = append(flags.Local.CFlags, "-DGTEST_OS_LINUX_ANDROID")
 	}

 	return flags
 }

 func (test *testDecorator) linkerDeps(ctx BaseModuleContext, deps Deps) Deps {
 	if test.gtest() {
 		if ctx.useSdk() && ctx.Device() {
 			deps.StaticLibs = append(deps.StaticLibs, "libgtest_main_ndk_c++", "libgtest_ndk_c++")
 		} else if BoolDefault(test.Properties.Isolated, false) {
 			deps.StaticLibs = append(deps.StaticLibs, "libgtest_isolated_main")
 			// The isolated library requires liblog, but adding it
 			// as a static library means unit tests cannot override
 			// liblog functions. Instead make it a shared library
 			// dependency.
 			deps.SharedLibs = append(deps.SharedLibs, "liblog")
 		} else {
 			deps.StaticLibs = append(deps.StaticLibs, "libgtest_main", "libgtest")
 		}
 	}

 	return deps
 }

 func (test *testDecorator) linkerInit(ctx BaseModuleContext, linker *baseLinker) {
 	// 1. Add ../../lib[64] to rpath so that out/host/linux-x86/nativetest/<test dir>/<test> can
 	// find out/host/linux-x86/lib[64]/library.so
 	// 2. Add ../../../lib[64] to rpath so that out/host/linux-x86/testcases/<test dir>/<CPU>/<test> can
 	// also find out/host/linux-x86/lib[64]/library.so
 	runpaths := []string{"../../lib", "../../../lib"}
 	for _, runpath := range runpaths {
 		if ctx.toolchain().Is64Bit() {
 			runpath += "64"
 		}
 		linker.dynamicProperties.RunPaths = append(linker.dynamicProperties.RunPaths, runpath)
 	}

 	// add "" to rpath so that test binaries can find libraries in their own test directory
 	linker.dynamicProperties.RunPaths = append(linker.dynamicProperties.RunPaths, "")
 }

 func (test *testDecorator) linkerProps() []interface{} {
 	return []interface{}{&test.Properties}
 }

 func NewTestInstaller() *baseInstaller {
 	return NewBaseInstaller("nativetest", "nativetest64", InstallInData)
 }

 type testBinary struct {
 	testDecorator
 	*binaryDecorator
 	*baseCompiler
 	Properties TestBinaryProperties
 	data       []android.DataPath
 	testConfig android.Path
 }

 func (test *testBinary) linkerProps() []interface{} {
 	props := append(test.testDecorator.linkerProps(), test.binaryDecorator.linkerProps()...)
 	props = append(props, &test.Properties)
 	return props
 }

 func (test *testBinary) linkerInit(ctx BaseModuleContext) {
 	test.testDecorator.linkerInit(ctx, test.binaryDecorator.baseLinker)
 	test.binaryDecorator.linkerInit(ctx)
 }

 func (test *testBinary) linkerDeps(ctx DepsContext, deps Deps) Deps {
 	deps = test.testDecorator.linkerDeps(ctx, deps)
 	deps = test.binaryDecorator.linkerDeps(ctx, deps)
 	deps.DataLibs = append(deps.DataLibs, test.Properties.Data_libs...)
 	return deps
 }

 func (test *testBinary) linkerFlags(ctx ModuleContext, flags Flags) Flags {
 	flags = test.binaryDecorator.linkerFlags(ctx, flags)
 	flags = test.testDecorator.linkerFlags(ctx, flags)
 	return flags
 }

 func (test *testBinary) install(ctx ModuleContext, file android.Path) {
 	dataSrcPaths := android.PathsForModuleSrc(ctx, test.Properties.Data)

 	for _, dataSrcPath := range dataSrcPaths {
 		test.data = append(test.data, android.DataPath{SrcPath: dataSrcPath})
 	}

 	ctx.VisitDirectDepsWithTag(dataLibDepTag, func(dep android.Module) {
 		depName := ctx.OtherModuleName(dep)
 		ccDep, ok := dep.(LinkableInterface)

 		if !ok {
 			ctx.ModuleErrorf("data_lib %q is not a linkable cc module", depName)
 		}
 		ccModule, ok := dep.(*Module)
 		if !ok {
 			ctx.ModuleErrorf("data_lib %q is not a cc module", depName)
 		}
 		if ccDep.OutputFile().Valid() {
 			test.data = append(test.data,
 				android.DataPath{SrcPath: ccDep.OutputFile().Path(),
 					RelativeInstallPath: ccModule.installer.relativeInstallPath()})
 		}
 	})

 	var api_level_prop string
 	var configs []tradefed.Config
 	var min_level string
 	for _, module := range test.Properties.Test_mainline_modules {
 		configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module})
 	}
 	if Bool(test.Properties.Require_root) {
 		configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.RootTargetPreparer", nil})
 	} else {
 		var options []tradefed.Option
 		options = append(options, tradefed.Option{Name: "force-root", Value: "false"})
 		configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.RootTargetPreparer", options})
 	}
 	if Bool(test.Properties.Disable_framework) {
 		var options []tradefed.Option
 		configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.StopServicesSetup", options})
 	}
 	if Bool(test.testDecorator.Properties.Isolated) {
 		configs = append(configs, tradefed.Option{Name: "not-shardable", Value: "true"})
 	}
 	if test.Properties.Test_options.Run_test_as != nil {
 		configs = append(configs, tradefed.Option{Name: "run-test-as", Value: String(test.Properties.Test_options.Run_test_as)})
 	}
 	for _, tag := range test.Properties.Test_options.Test_suite_tag {
 		configs = append(configs, tradefed.Option{Name: "test-suite-tag", Value: tag})
 	}
 	if test.Properties.Test_min_api_level != nil && test.Properties.Test_min_sdk_version != nil {
 		ctx.PropertyErrorf("test_min_api_level", "'test_min_api_level' and 'test_min_sdk_version' should not be set at the same time.")
 	} else if test.Properties.Test_min_api_level != nil {
 		api_level_prop = "ro.product.first_api_level"
 		min_level = strconv.FormatInt(int64(*test.Properties.Test_min_api_level), 10)
 	} else if test.Properties.Test_min_sdk_version != nil {
 		api_level_prop = "ro.build.version.sdk"
 		min_level = strconv.FormatInt(int64(*test.Properties.Test_min_sdk_version), 10)
 	}
 	if api_level_prop != "" {
 		var options []tradefed.Option
 		options = append(options, tradefed.Option{Name: "min-api-level", Value: min_level})
 		options = append(options, tradefed.Option{Name: "api-level-prop", Value: api_level_prop})
 		configs = append(configs, tradefed.Object{"module_controller", "com.android.tradefed.testtype.suite.module.MinApiLevelModuleController", options})
 	}

 	test.testConfig = tradefed.AutoGenNativeTestConfig(ctx, test.Properties.Test_config,
 		test.Properties.Test_config_template, test.Properties.Test_suites, configs, test.Properties.Auto_gen_config)

 	test.binaryDecorator.baseInstaller.dir = "nativetest"
 	test.binaryDecorator.baseInstaller.dir64 = "nativetest64"

 	if !Bool(test.Properties.No_named_install_directory) {
 		test.binaryDecorator.baseInstaller.relative = ctx.ModuleName()
 	} else if String(test.binaryDecorator.baseInstaller.Properties.Relative_install_path) == "" {
 		ctx.PropertyErrorf("no_named_install_directory", "Module install directory may only be disabled if relative_install_path is set")
 	}

 	test.binaryDecorator.baseInstaller.install(ctx, file)
 }

 func NewTest(hod android.HostOrDeviceSupported) *Module {
 	module, binary := NewBinary(hod)
 	module.multilib = android.MultilibBoth
 	binary.baseInstaller = NewTestInstaller()

 	test := &testBinary{
 		testDecorator: testDecorator{
 			linker: binary.baseLinker,
 		},
 		binaryDecorator: binary,
 		baseCompiler:    NewBaseCompiler(),
 	}
 	module.compiler = test
 	module.linker = test
 	module.installer = test
 	return module
 }

 type testLibrary struct {
 	testDecorator
 	*libraryDecorator
 }

 func (test *testLibrary) linkerProps() []interface{} {
 	return append(test.testDecorator.linkerProps(), test.libraryDecorator.linkerProps()...)
 }

 func (test *testLibrary) linkerInit(ctx BaseModuleContext) {
 	test.testDecorator.linkerInit(ctx, test.libraryDecorator.baseLinker)
 	test.libraryDecorator.linkerInit(ctx)
 }

 func (test *testLibrary) linkerDeps(ctx DepsContext, deps Deps) Deps {
 	deps = test.testDecorator.linkerDeps(ctx, deps)
 	deps = test.libraryDecorator.linkerDeps(ctx, deps)
 	return deps
 }

 func (test *testLibrary) linkerFlags(ctx ModuleContext, flags Flags) Flags {
 	flags = test.libraryDecorator.linkerFlags(ctx, flags)
 	flags = test.testDecorator.linkerFlags(ctx, flags)
 	return flags
 }

 func NewTestLibrary(hod android.HostOrDeviceSupported) *Module {
 	module, library := NewLibrary(android.HostAndDeviceSupported)
 	library.baseInstaller = NewTestInstaller()
 	test := &testLibrary{
 		testDecorator: testDecorator{
 			linker: library.baseLinker,
 		},
 		libraryDecorator: library,
 	}
 	module.linker = test
 	return module
 }

 type BenchmarkProperties struct {
 	// list of files or filegroup modules that provide data that should be installed alongside
 	// the test
 	Data []string `android:"path"`

 	// 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"`

 	// 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"`

 	// Add RootTargetPreparer to auto generated test config. This guarantees the test to run
 	// with root permission.
 	Require_root *bool

 	// 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 benchmarkDecorator struct {
 	*binaryDecorator
 	Properties BenchmarkProperties
 	data       android.Paths
 	testConfig android.Path
 }

 func (benchmark *benchmarkDecorator) linkerInit(ctx BaseModuleContext) {
 	runpath := "../../lib"
 	if ctx.toolchain().Is64Bit() {
 		runpath += "64"
 	}
 	benchmark.baseLinker.dynamicProperties.RunPaths = append(benchmark.baseLinker.dynamicProperties.RunPaths, runpath)
 	benchmark.binaryDecorator.linkerInit(ctx)
 }

 func (benchmark *benchmarkDecorator) linkerProps() []interface{} {
 	props := benchmark.binaryDecorator.linkerProps()
 	props = append(props, &benchmark.Properties)
 	return props
 }

 func (benchmark *benchmarkDecorator) linkerDeps(ctx DepsContext, deps Deps) Deps {
 	deps = benchmark.binaryDecorator.linkerDeps(ctx, deps)
 	deps.StaticLibs = append(deps.StaticLibs, "libgoogle-benchmark")
 	return deps
 }

 func (benchmark *benchmarkDecorator) install(ctx ModuleContext, file android.Path) {
 	benchmark.data = android.PathsForModuleSrc(ctx, benchmark.Properties.Data)

 	var configs []tradefed.Config
 	if Bool(benchmark.Properties.Require_root) {
 		configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.RootTargetPreparer", nil})
 	}
 	benchmark.testConfig = tradefed.AutoGenNativeBenchmarkTestConfig(ctx, benchmark.Properties.Test_config,
 		benchmark.Properties.Test_config_template, benchmark.Properties.Test_suites, configs, benchmark.Properties.Auto_gen_config)

 	benchmark.binaryDecorator.baseInstaller.dir = filepath.Join("benchmarktest", ctx.ModuleName())
 	benchmark.binaryDecorator.baseInstaller.dir64 = filepath.Join("benchmarktest64", ctx.ModuleName())
 	benchmark.binaryDecorator.baseInstaller.install(ctx, file)
 }

 func NewBenchmark(hod android.HostOrDeviceSupported) *Module {
 	module, binary := NewBinary(hod)
 	module.multilib = android.MultilibBoth
 	binary.baseInstaller = NewBaseInstaller("benchmarktest", "benchmarktest64", InstallInData)

 	benchmark := &benchmarkDecorator{
 		binaryDecorator: binary,
 	}
 	module.linker = benchmark
 	module.installer = benchmark
 	return module
 }
	// Copyright 2016 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 cc

	import (
	"path/filepath"
	"strconv"
	"strings"

	"android/soong/android"
	"android/soong/tradefed"
	)

	type TestProperties struct {
	// if set, build against the gtest library. Defaults to true.
	Gtest *bool

	// if set, use the isolated gtest runner. Defaults to false.
	Isolated *bool

	// List of APEXes that this module tests. The module has access to
	// the private part of the listed APEXes even when it is not included in the
	// APEXes.
	Test_for []string
	}

	// Test option struct.
	type TestOptions struct {
	// The UID that you want to run the test as on a device.
	Run_test_as *string
	// A list of free-formed strings without spaces that categorize the test.
	Test_suite_tag []string
	}

	type TestBinaryProperties struct {
	// Create a separate binary for each source file. Useful when there is
	// global state that can not be torn down and reset between each test suite.
	Test_per_src *bool

	// Disables the creation of a test-specific directory when used with
	// relative_install_path. Useful if several tests need to be in the same
	// directory, but test_per_src doesn't work.
	No_named_install_directory *bool

	// list of files or filegroup modules that provide data that should be installed alongside
	// the test
	Data []string `android:"path,arch_variant"`

	// list of shared library modules that should be installed alongside the test
	Data_libs []string `android:"arch_variant"`

	// 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"`

	// 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"`

	// Test options.
	Test_options TestOptions

	// Add RootTargetPreparer to auto generated test config. This guarantees the test to run
	// with root permission.
	Require_root *bool

	// Add RunCommandTargetPreparer to stop framework before the test and start it after the test.
	Disable_framework *bool

	// Add MinApiLevelModuleController to auto generated test config. If the device property of
	// "ro.product.first_api_level" < Test_min_api_level, then skip this module.
	Test_min_api_level *int64

	// Add MinApiLevelModuleController to auto generated test config. If the device property of
	// "ro.build.version.sdk" < Test_min_sdk_version, then skip this module.
	Test_min_sdk_version *int64

	// 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

	// Add parameterized mainline modules to auto generated test config. The options will be
	// handled by TradeFed to download and install the specified modules on the device.
	Test_mainline_modules []string
	}

	func init() {
	android.RegisterModuleType("cc_test", TestFactory)
	android.RegisterModuleType("cc_test_library", TestLibraryFactory)
	android.RegisterModuleType("cc_benchmark", BenchmarkFactory)
	android.RegisterModuleType("cc_test_host", TestHostFactory)
	android.RegisterModuleType("cc_benchmark_host", BenchmarkHostFactory)
	}

	// cc_test generates a test config file and an executable binary file to test
	// specific functionality on a device. The executable binary gets an implicit
	// static_libs dependency on libgtests unless the gtest flag is set to false.
	func TestFactory() android.Module {
	module := NewTest(android.HostAndDeviceSupported)
	return module.Init()
	}

	// cc_test_library creates an archive of files (i.e. .o files) which is later
	// referenced by another module (such as cc_test, cc_defaults or cc_test_library)
	// for archiving or linking.
	func TestLibraryFactory() android.Module {
	module := NewTestLibrary(android.HostAndDeviceSupported)
	return module.Init()
	}

	// cc_benchmark compiles an executable binary that performs benchmark testing
	// of a specific component in a device. Additional files such as test suites
	// and test configuration are installed on the side of the compiled executed
	// binary.
	func BenchmarkFactory() android.Module {
	module := NewBenchmark(android.HostAndDeviceSupported)
	return module.Init()
	}

	// cc_test_host compiles a test host binary.
	func TestHostFactory() android.Module {
	module := NewTest(android.HostSupported)
	return module.Init()
	}

	// cc_benchmark_host compiles an executable binary that performs benchmark
	// testing of a specific component in the host. Additional files such as
	// test suites and test configuration are installed on the side of the
	// compiled executed binary.
	func BenchmarkHostFactory() android.Module {
	module := NewBenchmark(android.HostSupported)
	return module.Init()
	}

	type testPerSrc interface {
	testPerSrc() bool
	srcs() []string
	isAllTestsVariation() bool
	setSrc(string, string)
	unsetSrc()
	}

	func (test *testBinary) testPerSrc() bool {
	return Bool(test.Properties.Test_per_src)
	}

	func (test *testBinary) srcs() []string {
	return test.baseCompiler.Properties.Srcs
	}

	func (test *testBinary) dataPaths() []android.DataPath {
	return test.data
	}

	func (test *testBinary) isAllTestsVariation() bool {
	stem := test.binaryDecorator.Properties.Stem
	return stem != nil && *stem == ""
	}

	func (test *testBinary) setSrc(name, src string) {
	test.baseCompiler.Properties.Srcs = []string{src}
	test.binaryDecorator.Properties.Stem = StringPtr(name)
	}

	func (test *testBinary) unsetSrc() {
	test.baseCompiler.Properties.Srcs = nil
	test.binaryDecorator.Properties.Stem = StringPtr("")
	}

	var _ testPerSrc = (*testBinary)(nil)

	func TestPerSrcMutator(mctx android.BottomUpMutatorContext) {
	if m, ok := mctx.Module().(*Module); ok {
	if test, ok := m.linker.(testPerSrc); ok {
	numTests := len(test.srcs())
	if test.testPerSrc() && numTests > 0 {
	if duplicate, found := android.CheckDuplicate(test.srcs()); found {
	mctx.PropertyErrorf("srcs", "found a duplicate entry %q", duplicate)
	return
	}
	testNames := make([]string, numTests)
	for i, src := range test.srcs() {
	testNames[i] = strings.TrimSuffix(filepath.Base(src), filepath.Ext(src))
	}
	// In addition to creating one variation per test source file,
	// create an additional "all tests" variation named "", and have it
	// depends on all other test_per_src variations. This is useful to
	// create subsequent dependencies of a given module on all
	// test_per_src variations created above: by depending on
	// variation "", that module will transitively depend on all the
	// other test_per_src variations without the need to know their
	// name or even their number.
	testNames = append(testNames, "")
	tests := mctx.CreateLocalVariations(testNames...)
	all_tests := tests[numTests]
	all_tests.(*Module).linker.(testPerSrc).unsetSrc()
	// Prevent the "all tests" variation from being installable nor
	// exporting to Make, as it won't create any output file.
	all_tests.(*Module).Properties.PreventInstall = true
	all_tests.(*Module).Properties.HideFromMake = true
	for i, src := range test.srcs() {
	tests[i].(*Module).linker.(testPerSrc).setSrc(testNames[i], src)
	mctx.AddInterVariantDependency(testPerSrcDepTag, all_tests, tests[i])
	}
	}
	}
	}
	}

	type testDecorator struct {
	Properties TestProperties
	linker *baseLinker
	}

	func (test *testDecorator) gtest() bool {
	return BoolDefault(test.Properties.Gtest, true)
	}

	func (test *testDecorator) testFor() []string {
	return test.Properties.Test_for
	}

	func (test *testDecorator) linkerFlags(ctx ModuleContext, flags Flags) Flags {
	if !test.gtest() {
	return flags
	}

	flags.Local.CFlags = append(flags.Local.CFlags, "-DGTEST_HAS_STD_STRING")
	if ctx.Host() {
	flags.Local.CFlags = append(flags.Local.CFlags, "-O0", "-g")

	switch ctx.Os() {
	case android.Windows:
	flags.Local.CFlags = append(flags.Local.CFlags, "-DGTEST_OS_WINDOWS")
	case android.Linux:
	flags.Local.CFlags = append(flags.Local.CFlags, "-DGTEST_OS_LINUX")
	case android.Darwin:
	flags.Local.CFlags = append(flags.Local.CFlags, "-DGTEST_OS_MAC")
	}
	} else {
	flags.Local.CFlags = append(flags.Local.CFlags, "-DGTEST_OS_LINUX_ANDROID")
	}

	return flags
	}

	func (test *testDecorator) linkerDeps(ctx BaseModuleContext, deps Deps) Deps {
	if test.gtest() {
	if ctx.useSdk() && ctx.Device() {
	deps.StaticLibs = append(deps.StaticLibs, "libgtest_main_ndk_c++", "libgtest_ndk_c++")
	} else if BoolDefault(test.Properties.Isolated, false) {
	deps.StaticLibs = append(deps.StaticLibs, "libgtest_isolated_main")
	// The isolated library requires liblog, but adding it
	// as a static library means unit tests cannot override
	// liblog functions. Instead make it a shared library
	// dependency.
	deps.SharedLibs = append(deps.SharedLibs, "liblog")
	} else {
	deps.StaticLibs = append(deps.StaticLibs, "libgtest_main", "libgtest")
	}
	}

	return deps
	}

	func (test testDecorator) linkerInit(ctx BaseModuleContext, linker baseLinker) {
	// 1. Add ../../lib[64] to rpath so that out/host/linux-x86/nativetest/<test dir>/<test> can
	// find out/host/linux-x86/lib[64]/library.so
	// 2. Add ../../../lib[64] to rpath so that out/host/linux-x86/testcases/<test dir>/<CPU>/<test> can
	// also find out/host/linux-x86/lib[64]/library.so
	runpaths := []string{"../../lib", "../../../lib"}
	for _, runpath := range runpaths {
	if ctx.toolchain().Is64Bit() {
	runpath += "64"
	}
	linker.dynamicProperties.RunPaths = append(linker.dynamicProperties.RunPaths, runpath)
	}

	// add "" to rpath so that test binaries can find libraries in their own test directory
	linker.dynamicProperties.RunPaths = append(linker.dynamicProperties.RunPaths, "")
	}

	func (test *testDecorator) linkerProps() []interface{} {
	return []interface{}{&test.Properties}
	}

	func NewTestInstaller() *baseInstaller {
	return NewBaseInstaller("nativetest", "nativetest64", InstallInData)
	}

	type testBinary struct {
	testDecorator
	*binaryDecorator
	*baseCompiler
	Properties TestBinaryProperties
	data []android.DataPath
	testConfig android.Path
	}

	func (test *testBinary) linkerProps() []interface{} {
	props := append(test.testDecorator.linkerProps(), test.binaryDecorator.linkerProps()...)
	props = append(props, &test.Properties)
	return props
	}

	func (test *testBinary) linkerInit(ctx BaseModuleContext) {
	test.testDecorator.linkerInit(ctx, test.binaryDecorator.baseLinker)
	test.binaryDecorator.linkerInit(ctx)
	}

	func (test *testBinary) linkerDeps(ctx DepsContext, deps Deps) Deps {
	deps = test.testDecorator.linkerDeps(ctx, deps)
	deps = test.binaryDecorator.linkerDeps(ctx, deps)
	deps.DataLibs = append(deps.DataLibs, test.Properties.Data_libs...)
	return deps
	}

	func (test *testBinary) linkerFlags(ctx ModuleContext, flags Flags) Flags {
	flags = test.binaryDecorator.linkerFlags(ctx, flags)
	flags = test.testDecorator.linkerFlags(ctx, flags)
	return flags
	}

	func (test *testBinary) install(ctx ModuleContext, file android.Path) {
	dataSrcPaths := android.PathsForModuleSrc(ctx, test.Properties.Data)

	for _, dataSrcPath := range dataSrcPaths {
	test.data = append(test.data, android.DataPath{SrcPath: dataSrcPath})
	}

	ctx.VisitDirectDepsWithTag(dataLibDepTag, func(dep android.Module) {
	depName := ctx.OtherModuleName(dep)
	ccDep, ok := dep.(LinkableInterface)

	if !ok {
	ctx.ModuleErrorf("data_lib %q is not a linkable cc module", depName)
	}
	ccModule, ok := dep.(*Module)
	if !ok {
	ctx.ModuleErrorf("data_lib %q is not a cc module", depName)
	}
	if ccDep.OutputFile().Valid() {
	test.data = append(test.data,
	android.DataPath{SrcPath: ccDep.OutputFile().Path(),
	RelativeInstallPath: ccModule.installer.relativeInstallPath()})
	}
	})

	var api_level_prop string
	var configs []tradefed.Config
	var min_level string
	for _, module := range test.Properties.Test_mainline_modules {
	configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module})
	}
	if Bool(test.Properties.Require_root) {
	configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.RootTargetPreparer", nil})
	} else {
	var options []tradefed.Option
	options = append(options, tradefed.Option{Name: "force-root", Value: "false"})
	configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.RootTargetPreparer", options})
	}
	if Bool(test.Properties.Disable_framework) {
	var options []tradefed.Option
	configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.StopServicesSetup", options})
	}
	if Bool(test.testDecorator.Properties.Isolated) {
	configs = append(configs, tradefed.Option{Name: "not-shardable", Value: "true"})
	}
	if test.Properties.Test_options.Run_test_as != nil {
	configs = append(configs, tradefed.Option{Name: "run-test-as", Value: String(test.Properties.Test_options.Run_test_as)})
	}
	for _, tag := range test.Properties.Test_options.Test_suite_tag {
	configs = append(configs, tradefed.Option{Name: "test-suite-tag", Value: tag})
	}
	if test.Properties.Test_min_api_level != nil && test.Properties.Test_min_sdk_version != nil {
	ctx.PropertyErrorf("test_min_api_level", "'test_min_api_level' and 'test_min_sdk_version' should not be set at the same time.")
	} else if test.Properties.Test_min_api_level != nil {
	api_level_prop = "ro.product.first_api_level"
	min_level = strconv.FormatInt(int64(*test.Properties.Test_min_api_level), 10)
	} else if test.Properties.Test_min_sdk_version != nil {
	api_level_prop = "ro.build.version.sdk"
	min_level = strconv.FormatInt(int64(*test.Properties.Test_min_sdk_version), 10)
	}
	if api_level_prop != "" {
	var options []tradefed.Option
	options = append(options, tradefed.Option{Name: "min-api-level", Value: min_level})
	options = append(options, tradefed.Option{Name: "api-level-prop", Value: api_level_prop})
	configs = append(configs, tradefed.Object{"module_controller", "com.android.tradefed.testtype.suite.module.MinApiLevelModuleController", options})
	}

	test.testConfig = tradefed.AutoGenNativeTestConfig(ctx, test.Properties.Test_config,
	test.Properties.Test_config_template, test.Properties.Test_suites, configs, test.Properties.Auto_gen_config)

	test.binaryDecorator.baseInstaller.dir = "nativetest"
	test.binaryDecorator.baseInstaller.dir64 = "nativetest64"

	if !Bool(test.Properties.No_named_install_directory) {
	test.binaryDecorator.baseInstaller.relative = ctx.ModuleName()
	} else if String(test.binaryDecorator.baseInstaller.Properties.Relative_install_path) == "" {
	ctx.PropertyErrorf("no_named_install_directory", "Module install directory may only be disabled if relative_install_path is set")
	}

	test.binaryDecorator.baseInstaller.install(ctx, file)
	}

	func NewTest(hod android.HostOrDeviceSupported) *Module {
	module, binary := NewBinary(hod)
	module.multilib = android.MultilibBoth
	binary.baseInstaller = NewTestInstaller()

	test := &testBinary{
	testDecorator: testDecorator{
	linker: binary.baseLinker,
	},
	binaryDecorator: binary,
	baseCompiler: NewBaseCompiler(),
	}
	module.compiler = test
	module.linker = test
	module.installer = test
	return module
	}

	type testLibrary struct {
	testDecorator
	*libraryDecorator
	}

	func (test *testLibrary) linkerProps() []interface{} {
	return append(test.testDecorator.linkerProps(), test.libraryDecorator.linkerProps()...)
	}

	func (test *testLibrary) linkerInit(ctx BaseModuleContext) {
	test.testDecorator.linkerInit(ctx, test.libraryDecorator.baseLinker)
	test.libraryDecorator.linkerInit(ctx)
	}

	func (test *testLibrary) linkerDeps(ctx DepsContext, deps Deps) Deps {
	deps = test.testDecorator.linkerDeps(ctx, deps)
	deps = test.libraryDecorator.linkerDeps(ctx, deps)
	return deps
	}

	func (test *testLibrary) linkerFlags(ctx ModuleContext, flags Flags) Flags {
	flags = test.libraryDecorator.linkerFlags(ctx, flags)
	flags = test.testDecorator.linkerFlags(ctx, flags)
	return flags
	}

	func NewTestLibrary(hod android.HostOrDeviceSupported) *Module {
	module, library := NewLibrary(android.HostAndDeviceSupported)
	library.baseInstaller = NewTestInstaller()
	test := &testLibrary{
	testDecorator: testDecorator{
	linker: library.baseLinker,
	},
	libraryDecorator: library,
	}
	module.linker = test
	return module
	}

	type BenchmarkProperties struct {
	// list of files or filegroup modules that provide data that should be installed alongside
	// the test
	Data []string `android:"path"`

	// 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"`

	// 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"`

	// Add RootTargetPreparer to auto generated test config. This guarantees the test to run
	// with root permission.
	Require_root *bool

	// 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 benchmarkDecorator struct {
	*binaryDecorator
	Properties BenchmarkProperties
	data android.Paths
	testConfig android.Path
	}

	func (benchmark *benchmarkDecorator) linkerInit(ctx BaseModuleContext) {
	runpath := "../../lib"
	if ctx.toolchain().Is64Bit() {
	runpath += "64"
	}
	benchmark.baseLinker.dynamicProperties.RunPaths = append(benchmark.baseLinker.dynamicProperties.RunPaths, runpath)
	benchmark.binaryDecorator.linkerInit(ctx)
	}

	func (benchmark *benchmarkDecorator) linkerProps() []interface{} {
	props := benchmark.binaryDecorator.linkerProps()
	props = append(props, &benchmark.Properties)
	return props
	}

	func (benchmark *benchmarkDecorator) linkerDeps(ctx DepsContext, deps Deps) Deps {
	deps = benchmark.binaryDecorator.linkerDeps(ctx, deps)
	deps.StaticLibs = append(deps.StaticLibs, "libgoogle-benchmark")
	return deps
	}

	func (benchmark *benchmarkDecorator) install(ctx ModuleContext, file android.Path) {
	benchmark.data = android.PathsForModuleSrc(ctx, benchmark.Properties.Data)

	var configs []tradefed.Config
	if Bool(benchmark.Properties.Require_root) {
	configs = append(configs, tradefed.Object{"target_preparer", "com.android.tradefed.targetprep.RootTargetPreparer", nil})
	}
	benchmark.testConfig = tradefed.AutoGenNativeBenchmarkTestConfig(ctx, benchmark.Properties.Test_config,
	benchmark.Properties.Test_config_template, benchmark.Properties.Test_suites, configs, benchmark.Properties.Auto_gen_config)

	benchmark.binaryDecorator.baseInstaller.dir = filepath.Join("benchmarktest", ctx.ModuleName())
	benchmark.binaryDecorator.baseInstaller.dir64 = filepath.Join("benchmarktest64", ctx.ModuleName())
	benchmark.binaryDecorator.baseInstaller.install(ctx, file)
	}

	func NewBenchmark(hod android.HostOrDeviceSupported) *Module {
	module, binary := NewBinary(hod)
	module.multilib = android.MultilibBoth
	binary.baseInstaller = NewBaseInstaller("benchmarktest", "benchmarktest64", InstallInData)

	benchmark := &benchmarkDecorator{
	binaryDecorator: binary,
	}
	module.linker = benchmark
	module.installer = benchmark
	return module
	}