Test_Module_Config soong implementation
New soong module type `TestModuleConfig` This module type allows to write: test_module_config { name: "DerivedFrameworks1", base: "FrameworksServicesTests", include_filters: ["com.android.server.accessibility.FingerprintGestureDispatcherTest"], } This goal is to put the test options (include_fitler in this case) in Android.bp rather than TEST_MAPPING to be able to name a set of options and to allow the CI to more precise about which part of a TestModule might be failing. In general, it is recommended to split up tests rather than use this approach, but that isn't always feasible. More details on project here: https://docs.google.com/document/d/1MpA4BS6mTr-1D-K9MVmzdHkSufAvIkkM4gPEUglNodk/edit?tab=t.0 Migration plan here: https://docs.google.com/document/d/1x3w-BvKO3E-GbY8YOSBuzJC6-pkLkuhfjSyZ1hJQBYM/edit?tab=t.0 Some details of final output: * All the [data] files from Derived are the same as base. * The apk names is changed to be the Module name * The test options are added to .config file * test-file-name in the .config file (for base.apk) is changed to be new apk. * module-info.json is hand inspected between base and derived. * I added a .manifest file so future tools know what base is, if they need it. We are working a mechanism to use a CAS so the zip of the testcases won't explode. (however the trident disk image will get bigger) % tree -ls out/target/product/shiba/testcases/DerivedFrameworks1 out/target/product/shiba/testcases/FrameworksServicesTests [ 4096] out/target/product/shiba/testcases/DerivedFrameworks1 ├── [ 4096] arm64 │ └── [ 72346281] DerivedFrameworks1.apk ├── [ 20887] BstatsTestApp.apk ├── [ 4096] data │ └── [ 851] broken_shortcut.xml ├── [ 3157] DerivedFrameworks1.config ├── [ 12695] JobTestApp.apk ├── [ 8599] MediaButtonReceiverHolderTestHelperApp.apk ├── [ 16791] SimpleServiceTestApp1.apk ├── [ 16791] SimpleServiceTestApp2.apk ├── [ 16791] SimpleServiceTestApp3.apk ├── [ 1017540] SuspendTestApp.apk └── [ 36] test_module_config.manifest [ 4096] out/target/product/shiba/testcases/FrameworksServicesTests ├── [ 4096] arm64 │ └── [ 72346281] FrameworksServicesTests.apk ├── [ 20887] BstatsTestApp.apk ├── [ 4096] data │ └── [ 851] broken_shortcut.xml ├── [ 2866] FrameworksServicesTests.config ├── [ 12695] JobTestApp.apk ├── [ 8599] MediaButtonReceiverHolderTestHelperApp.apk ├── [ 16791] SimpleServiceTestApp1.apk ├── [ 16791] SimpleServiceTestApp2.apk ├── [ 16791] SimpleServiceTestApp3.apk └── [ 1017540] SuspendTestApp.apk Fixes: 314148134 Test: atest DerivedFrameworks1 DerivedFrameworks2 Test: m blueprint_tests Change-Id: Ib73a3404557e0bd583b065f0cf2fd55fba9ccdbe
This commit is contained in:
@@ -1313,6 +1313,12 @@ func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
|
|||||||
a.extraTestConfigs = android.PathsForModuleSrc(ctx, a.testProperties.Test_options.Extra_test_configs)
|
a.extraTestConfigs = android.PathsForModuleSrc(ctx, a.testProperties.Test_options.Extra_test_configs)
|
||||||
a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
|
a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
|
||||||
android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
|
android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
|
||||||
|
android.SetProvider(ctx, tradefed.BaseTestProviderKey, tradefed.BaseTestProviderData{
|
||||||
|
InstalledFiles: a.data,
|
||||||
|
OutputFile: a.OutputFile(),
|
||||||
|
TestConfig: a.testConfig,
|
||||||
|
HostRequiredModuleNames: a.HostRequiredModuleNames(),
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path {
|
func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path {
|
||||||
|
@@ -19,6 +19,7 @@
|
|||||||
from __future__ import print_function
|
from __future__ import print_function
|
||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
|
import json
|
||||||
import sys
|
import sys
|
||||||
from xml.dom import minidom
|
from xml.dom import minidom
|
||||||
|
|
||||||
@@ -31,6 +32,8 @@ from manifest import write_xml
|
|||||||
KNOWN_PREPARERS = ['com.android.tradefed.targetprep.TestAppInstallSetup',
|
KNOWN_PREPARERS = ['com.android.tradefed.targetprep.TestAppInstallSetup',
|
||||||
'com.android.tradefed.targetprep.suite.SuiteApkInstaller']
|
'com.android.tradefed.targetprep.suite.SuiteApkInstaller']
|
||||||
|
|
||||||
|
KNOWN_TEST_RUNNERS = ['com.android.tradefed.testtype.AndroidJUnitTest']
|
||||||
|
|
||||||
MAINLINE_CONTROLLER = 'com.android.tradefed.testtype.suite.module.MainlineTestModuleController'
|
MAINLINE_CONTROLLER = 'com.android.tradefed.testtype.suite.module.MainlineTestModuleController'
|
||||||
|
|
||||||
def parse_args():
|
def parse_args():
|
||||||
@@ -43,8 +46,12 @@ def parse_args():
|
|||||||
help=('overwrite package fields in the test config'))
|
help=('overwrite package fields in the test config'))
|
||||||
parser.add_argument('--test-file-name', default='', dest='test_file_name',
|
parser.add_argument('--test-file-name', default='', dest='test_file_name',
|
||||||
help=('overwrite test file name in the test config'))
|
help=('overwrite test file name in the test config'))
|
||||||
|
parser.add_argument('--orig-test-file-name', default='', dest='orig_test_file_name',
|
||||||
|
help=('Use with test-file-name to only override a single apk'))
|
||||||
parser.add_argument('--mainline-package-name', default='', dest='mainline_package_name',
|
parser.add_argument('--mainline-package-name', default='', dest='mainline_package_name',
|
||||||
help=('overwrite mainline module package name in the test config'))
|
help=('overwrite mainline module package name in the test config'))
|
||||||
|
parser.add_argument('--test-runner-options', default='', dest='test_runner_options',
|
||||||
|
help=('Add test runner options in the test config'))
|
||||||
parser.add_argument('input', help='input test config file')
|
parser.add_argument('input', help='input test config file')
|
||||||
parser.add_argument('output', help='output test config file')
|
parser.add_argument('output', help='output test config file')
|
||||||
return parser.parse_args()
|
return parser.parse_args()
|
||||||
@@ -76,6 +83,18 @@ def overwrite_test_file_name(test_config_doc, test_file_name):
|
|||||||
if option.getAttribute('name') == "test-file-name":
|
if option.getAttribute('name') == "test-file-name":
|
||||||
option.setAttribute('value', test_file_name)
|
option.setAttribute('value', test_file_name)
|
||||||
|
|
||||||
|
def overwrite_single_test_file_name(test_config_doc, orig_test_file_name, new_test_file_name):
|
||||||
|
|
||||||
|
test_config = parse_test_config(test_config_doc)
|
||||||
|
tests = get_children_with_tag(test_config, 'target_preparer')
|
||||||
|
|
||||||
|
for test in tests:
|
||||||
|
if test.getAttribute('class') in KNOWN_PREPARERS:
|
||||||
|
options = get_children_with_tag(test, 'option')
|
||||||
|
for option in options:
|
||||||
|
if option.getAttribute('name') == "test-file-name" and option.getAttribute('value') == orig_test_file_name:
|
||||||
|
option.setAttribute('value', new_test_file_name)
|
||||||
|
|
||||||
def overwrite_mainline_module_package_name(test_config_doc, mainline_package_name):
|
def overwrite_mainline_module_package_name(test_config_doc, mainline_package_name):
|
||||||
|
|
||||||
test_config = parse_test_config(test_config_doc)
|
test_config = parse_test_config(test_config_doc)
|
||||||
@@ -86,6 +105,31 @@ def overwrite_mainline_module_package_name(test_config_doc, mainline_package_nam
|
|||||||
if option.getAttribute('name') == "mainline-module-package-name":
|
if option.getAttribute('name') == "mainline-module-package-name":
|
||||||
option.setAttribute('value', mainline_package_name)
|
option.setAttribute('value', mainline_package_name)
|
||||||
|
|
||||||
|
def add_test_runner_options_toplevel(test_config_doc, test_runner_options):
|
||||||
|
|
||||||
|
test_config = parse_test_config(test_config_doc)
|
||||||
|
|
||||||
|
test_config.appendChild(test_config_doc.createComment("Options from Android.bp"))
|
||||||
|
test_config.appendChild(test_config_doc.createTextNode("\n"))
|
||||||
|
for new_option in json.loads(test_runner_options):
|
||||||
|
option = test_config_doc.createElement("option")
|
||||||
|
# name and value are mandatory,
|
||||||
|
name = new_option.get('Name')
|
||||||
|
if not name:
|
||||||
|
raise RuntimeError('"name" must set in test_runner_option"')
|
||||||
|
value = new_option.get('Value')
|
||||||
|
if not value:
|
||||||
|
raise RuntimeError('"value" must set in test_runner_option"')
|
||||||
|
option.setAttribute('name', name) # 'include-filter')
|
||||||
|
option.setAttribute('value', value) # 'android.test.example.devcodelab.DevCodelabTest#testHelloFail')
|
||||||
|
key = new_option.get('Key')
|
||||||
|
if key:
|
||||||
|
option.setAttribute('key', key) # 'include-filter')
|
||||||
|
# add tab and newline for readability
|
||||||
|
test_config.appendChild(test_config_doc.createTextNode(" "))
|
||||||
|
test_config.appendChild(option)
|
||||||
|
test_config.appendChild(test_config_doc.createTextNode("\n"))
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
"""Program entry point."""
|
"""Program entry point."""
|
||||||
try:
|
try:
|
||||||
@@ -100,11 +144,20 @@ def main():
|
|||||||
overwrite_package_name(doc, manifest_doc, args.package_name)
|
overwrite_package_name(doc, manifest_doc, args.package_name)
|
||||||
|
|
||||||
if args.test_file_name:
|
if args.test_file_name:
|
||||||
|
if args.orig_test_file_name:
|
||||||
|
overwrite_single_test_file_name(doc, args.orig_test_file_name, args.test_file_name)
|
||||||
|
else:
|
||||||
|
# You probably never want to override the test_file_name if there
|
||||||
|
# are several in the xml, but this is currently only used on generated
|
||||||
|
# AndroidTest.xml where there is only a single test-file-name (no data)
|
||||||
overwrite_test_file_name(doc, args.test_file_name)
|
overwrite_test_file_name(doc, args.test_file_name)
|
||||||
|
|
||||||
if args.mainline_package_name:
|
if args.mainline_package_name:
|
||||||
overwrite_mainline_module_package_name(doc, args.mainline_package_name)
|
overwrite_mainline_module_package_name(doc, args.mainline_package_name)
|
||||||
|
|
||||||
|
if args.test_runner_options:
|
||||||
|
add_test_runner_options_toplevel(doc, args.test_runner_options)
|
||||||
|
|
||||||
with open(args.output, 'w') as f:
|
with open(args.output, 'w') as f:
|
||||||
write_xml(f, doc)
|
write_xml(f, doc)
|
||||||
|
|
||||||
|
@@ -13,6 +13,7 @@ bootstrap_go_package {
|
|||||||
"autogen.go",
|
"autogen.go",
|
||||||
"config.go",
|
"config.go",
|
||||||
"makevars.go",
|
"makevars.go",
|
||||||
|
"providers.go",
|
||||||
],
|
],
|
||||||
pluginFor: ["soong_build"],
|
pluginFor: ["soong_build"],
|
||||||
}
|
}
|
||||||
|
21
tradefed/providers.go
Normal file
21
tradefed/providers.go
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
package tradefed
|
||||||
|
|
||||||
|
import (
|
||||||
|
"android/soong/android"
|
||||||
|
|
||||||
|
"github.com/google/blueprint"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Output files we need from a base test that we derive from.
|
||||||
|
type BaseTestProviderData struct {
|
||||||
|
// data files and apps for android_test
|
||||||
|
InstalledFiles android.Paths
|
||||||
|
// apk for android_test
|
||||||
|
OutputFile android.Path
|
||||||
|
// Either handwritten or generated TF xml.
|
||||||
|
TestConfig android.Path
|
||||||
|
// Other modules we require to be installed to run tests. We expect base to build them.
|
||||||
|
HostRequiredModuleNames []string
|
||||||
|
}
|
||||||
|
|
||||||
|
var BaseTestProviderKey = blueprint.NewProvider[BaseTestProviderData]()
|
21
tradefed_modules/Android.bp
Normal file
21
tradefed_modules/Android.bp
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
package {
|
||||||
|
default_applicable_licenses: ["Android-Apache-2.0"],
|
||||||
|
}
|
||||||
|
|
||||||
|
bootstrap_go_package {
|
||||||
|
name: "soong-tradefed-modules",
|
||||||
|
pkgPath: "android/soong/tradefed_modules",
|
||||||
|
deps: [
|
||||||
|
"blueprint",
|
||||||
|
"soong-android",
|
||||||
|
"soong-java",
|
||||||
|
"soong-tradefed",
|
||||||
|
],
|
||||||
|
srcs: [
|
||||||
|
"test_module_config.go",
|
||||||
|
],
|
||||||
|
testSrcs: [
|
||||||
|
"test_module_config_test.go",
|
||||||
|
],
|
||||||
|
pluginFor: ["soong_build"],
|
||||||
|
}
|
219
tradefed_modules/test_module_config.go
Normal file
219
tradefed_modules/test_module_config.go
Normal file
@@ -0,0 +1,219 @@
|
|||||||
|
package tradefed_modules
|
||||||
|
|
||||||
|
import (
|
||||||
|
"android/soong/android"
|
||||||
|
"android/soong/tradefed"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/google/blueprint"
|
||||||
|
"github.com/google/blueprint/proptools"
|
||||||
|
)
|
||||||
|
|
||||||
|
func init() {
|
||||||
|
RegisterTestModuleConfigBuildComponents(android.InitRegistrationContext)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Register the license_kind module type.
|
||||||
|
func RegisterTestModuleConfigBuildComponents(ctx android.RegistrationContext) {
|
||||||
|
ctx.RegisterModuleType("test_module_config", TestModuleConfigFactory)
|
||||||
|
}
|
||||||
|
|
||||||
|
type testModuleConfigModule struct {
|
||||||
|
android.ModuleBase
|
||||||
|
android.DefaultableModuleBase
|
||||||
|
base android.Module
|
||||||
|
|
||||||
|
tradefedProperties
|
||||||
|
|
||||||
|
// Our updated testConfig.
|
||||||
|
testConfig android.OutputPath
|
||||||
|
manifest android.InstallPath
|
||||||
|
provider tradefed.BaseTestProviderData
|
||||||
|
}
|
||||||
|
|
||||||
|
// Properties to list in Android.bp for this module.
|
||||||
|
type tradefedProperties struct {
|
||||||
|
// Module name of the base test that we will run.
|
||||||
|
Base *string `android:"path,arch_variant"`
|
||||||
|
|
||||||
|
// Tradefed Options to add to tradefed xml when not one of the include or exclude filter or property.
|
||||||
|
// Sample: [{name: "TestRunnerOptionName", value: "OptionValue" }]
|
||||||
|
Options []tradefed.Option
|
||||||
|
|
||||||
|
// List of tradefed include annotations to add to tradefed xml, like "android.platform.test.annotations.Presubmit".
|
||||||
|
// Tests will be restricted to those matching an include_annotation or include_filter.
|
||||||
|
Include_annotations []string
|
||||||
|
|
||||||
|
// List of tradefed include annotations to add to tradefed xml, like "android.support.test.filters.FlakyTest".
|
||||||
|
// Tests matching an exclude annotation or filter will be skipped.
|
||||||
|
Exclude_annotations []string
|
||||||
|
|
||||||
|
// List of tradefed include filters to add to tradefed xml, like "fully.qualified.class#method".
|
||||||
|
// Tests will be restricted to those matching an include_annotation or include_filter.
|
||||||
|
Include_filters []string
|
||||||
|
|
||||||
|
// List of tradefed exclude filters to add to tradefed xml, like "fully.qualified.class#method".
|
||||||
|
// Tests matching an exclude annotation or filter will be skipped.
|
||||||
|
Exclude_filters []string
|
||||||
|
|
||||||
|
// List of compatibility suites (for example "cts", "vts") that the module should be
|
||||||
|
// installed into.
|
||||||
|
Test_suites []string
|
||||||
|
}
|
||||||
|
|
||||||
|
type dependencyTag struct {
|
||||||
|
blueprint.BaseDependencyTag
|
||||||
|
name string
|
||||||
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
testModuleConfigTag = dependencyTag{name: "TestModuleConfigBase"}
|
||||||
|
pctx = android.NewPackageContext("android/soong/tradefed_modules")
|
||||||
|
)
|
||||||
|
|
||||||
|
func (m *testModuleConfigModule) InstallInTestcases() bool {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *testModuleConfigModule) DepsMutator(ctx android.BottomUpMutatorContext) {
|
||||||
|
ctx.AddDependency(ctx.Module(), testModuleConfigTag, *m.Base)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Takes base's Tradefed Config xml file and generates a new one with the test properties
|
||||||
|
// appeneded from this module.
|
||||||
|
// Rewrite the name of the apk in "test-file-name" to be our module's name, rather than the original one.
|
||||||
|
func (m *testModuleConfigModule) fixTestConfig(ctx android.ModuleContext, baseTestConfig android.Path) android.OutputPath {
|
||||||
|
// Test safe to do when no test_runner_options, but check for that earlier?
|
||||||
|
fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", ctx.ModuleName()+".config")
|
||||||
|
rule := android.NewRuleBuilder(pctx, ctx)
|
||||||
|
command := rule.Command().BuiltTool("test_config_fixer").Input(baseTestConfig).Output(fixedConfig)
|
||||||
|
options := m.composeOptions()
|
||||||
|
if len(options) == 0 {
|
||||||
|
ctx.ModuleErrorf("Test options must be given when using test_module_config. Set include/exclude filter or annotation.")
|
||||||
|
}
|
||||||
|
xmlTestModuleConfigSnippet, _ := json.Marshal(options)
|
||||||
|
escaped := proptools.NinjaAndShellEscape(string(xmlTestModuleConfigSnippet))
|
||||||
|
command.FlagWithArg("--test-file-name=", ctx.ModuleName()+".apk").
|
||||||
|
FlagWithArg("--orig-test-file-name=", *m.tradefedProperties.Base+".apk").
|
||||||
|
FlagWithArg("--test-runner-options=", escaped)
|
||||||
|
rule.Build("fix_test_config", "fix test config")
|
||||||
|
return fixedConfig.OutputPath
|
||||||
|
}
|
||||||
|
|
||||||
|
// Convert --exclude_filters: ["filter1", "filter2"] ->
|
||||||
|
// [ Option{Name: "exclude-filters", Value: "filter1"}, Option{Name: "exclude-filters", Value: "filter2"},
|
||||||
|
// ... + include + annotations ]
|
||||||
|
func (m *testModuleConfigModule) composeOptions() []tradefed.Option {
|
||||||
|
options := m.Options
|
||||||
|
for _, e := range m.Exclude_filters {
|
||||||
|
options = append(options, tradefed.Option{Name: "exclude-filter", Value: e})
|
||||||
|
}
|
||||||
|
for _, i := range m.Include_filters {
|
||||||
|
options = append(options, tradefed.Option{Name: "include-filter", Value: i})
|
||||||
|
}
|
||||||
|
for _, e := range m.Exclude_annotations {
|
||||||
|
options = append(options, tradefed.Option{Name: "exclude-annotation", Value: e})
|
||||||
|
}
|
||||||
|
for _, i := range m.Include_annotations {
|
||||||
|
options = append(options, tradefed.Option{Name: "include-annotation", Value: i})
|
||||||
|
}
|
||||||
|
return options
|
||||||
|
}
|
||||||
|
|
||||||
|
// Files to write and where they come from:
|
||||||
|
// 1) test_module_config.manifest
|
||||||
|
// - Leave a trail of where we got files from in case other tools need it.
|
||||||
|
//
|
||||||
|
// 2) $Module.config
|
||||||
|
// - comes from base's module.config (AndroidTest.xml), and then we add our test_options.
|
||||||
|
// provider.TestConfig
|
||||||
|
// [rules via soong_app_prebuilt]
|
||||||
|
//
|
||||||
|
// 3) $ARCH/$Module.apk
|
||||||
|
// - comes from base
|
||||||
|
// provider.OutputFile
|
||||||
|
// [rules via soong_app_prebuilt]
|
||||||
|
//
|
||||||
|
// 4) [bases data]
|
||||||
|
// - We copy all of bases data (like helper apks) to our install directory too.
|
||||||
|
// Since we call AndroidMkEntries on base, it will write out LOCAL_COMPATIBILITY_SUPPORT_FILES
|
||||||
|
// with this data and app_prebuilt.mk will generate the rules to copy it from base.
|
||||||
|
// We have no direct rules here to add to ninja.
|
||||||
|
//
|
||||||
|
// If we change to symlinks, this all needs to change.
|
||||||
|
func (m *testModuleConfigModule) GenerateAndroidBuildActions(ctx android.ModuleContext) {
|
||||||
|
|
||||||
|
ctx.VisitDirectDepsWithTag(testModuleConfigTag, func(dep android.Module) {
|
||||||
|
if provider, ok := android.OtherModuleProvider(ctx, dep, tradefed.BaseTestProviderKey); ok {
|
||||||
|
m.base = dep
|
||||||
|
m.provider = provider
|
||||||
|
} else {
|
||||||
|
ctx.ModuleErrorf("The base module '%s' does not provide test BaseTestProviderData. Only 'android_test' modules are supported.", dep.Name())
|
||||||
|
return
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
// 1) A manifest file listing the base.
|
||||||
|
installDir := android.PathForModuleInstall(ctx, ctx.ModuleName())
|
||||||
|
out := android.PathForModuleOut(ctx, "test_module_config.manifest")
|
||||||
|
android.WriteFileRule(ctx, out, fmt.Sprintf("{%q: %q}", "base", *m.tradefedProperties.Base))
|
||||||
|
ctx.InstallFile(installDir, out.Base(), out)
|
||||||
|
|
||||||
|
// 2) Module.config / AndroidTest.xml
|
||||||
|
// Note, there is still a "test-tag" element with base's module name, but
|
||||||
|
// Tradefed team says its ignored anyway.
|
||||||
|
m.testConfig = m.fixTestConfig(ctx, m.provider.TestConfig)
|
||||||
|
|
||||||
|
// 3) Write ARCH/Module.apk in testcases.
|
||||||
|
// Handled by soong_app_prebuilt and OutputFile in entries.
|
||||||
|
// Nothing to do here.
|
||||||
|
|
||||||
|
// 4) Copy base's data files.
|
||||||
|
// Handled by soong_app_prebuilt and LOCAL_COMPATIBILITY_SUPPORT_FILES.
|
||||||
|
// Nothing to do here.
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestModuleConfigFactory() android.Module {
|
||||||
|
module := &testModuleConfigModule{}
|
||||||
|
|
||||||
|
module.AddProperties(&module.tradefedProperties)
|
||||||
|
android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibCommon)
|
||||||
|
android.InitDefaultableModule(module)
|
||||||
|
|
||||||
|
return module
|
||||||
|
}
|
||||||
|
|
||||||
|
// Implements android.AndroidMkEntriesProvider
|
||||||
|
var _ android.AndroidMkEntriesProvider = (*testModuleConfigModule)(nil)
|
||||||
|
|
||||||
|
func (m *testModuleConfigModule) AndroidMkEntries() []android.AndroidMkEntries {
|
||||||
|
// We rely on base writing LOCAL_COMPATIBILITY_SUPPORT_FILES for its data files
|
||||||
|
entriesList := m.base.(android.AndroidMkEntriesProvider).AndroidMkEntries()
|
||||||
|
entries := &entriesList[0]
|
||||||
|
entries.OutputFile = android.OptionalPathForPath(m.provider.OutputFile)
|
||||||
|
entries.ExtraEntries = append(entries.ExtraEntries, func(ctx android.AndroidMkExtraEntriesContext, entries *android.AndroidMkEntries) {
|
||||||
|
entries.SetString("LOCAL_MODULE", m.Name()) // out module name, not base's
|
||||||
|
|
||||||
|
// Out update config file with extra options.
|
||||||
|
entries.SetPath("LOCAL_FULL_TEST_CONFIG", m.testConfig)
|
||||||
|
entries.SetString("LOCAL_MODULE_TAGS", "tests")
|
||||||
|
// Required for atest to run additional tradefed testtypes
|
||||||
|
entries.AddStrings("LOCAL_HOST_REQUIRED_MODULES", m.provider.HostRequiredModuleNames...)
|
||||||
|
|
||||||
|
// Clear the JNI symbols because they belong to base not us. Either transform the names in the string
|
||||||
|
// or clear the variable because we don't need it, we are copying bases libraries not generating
|
||||||
|
// new ones.
|
||||||
|
entries.SetString("LOCAL_SOONG_JNI_LIBS_SYMBOLS", "")
|
||||||
|
|
||||||
|
// Don't append to base's test-suites, only use the ones we define, so clear it before
|
||||||
|
// appending to it.
|
||||||
|
entries.SetString("LOCAL_COMPATIBILITY_SUITE", "")
|
||||||
|
if len(m.tradefedProperties.Test_suites) > 0 {
|
||||||
|
entries.AddCompatibilityTestSuites(m.tradefedProperties.Test_suites...)
|
||||||
|
} else {
|
||||||
|
entries.AddCompatibilityTestSuites("null-suite")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
return entriesList
|
||||||
|
}
|
204
tradefed_modules/test_module_config_test.go
Normal file
204
tradefed_modules/test_module_config_test.go
Normal file
@@ -0,0 +1,204 @@
|
|||||||
|
// Copyright 2024 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 tradefed_modules
|
||||||
|
|
||||||
|
import (
|
||||||
|
"android/soong/android"
|
||||||
|
"android/soong/java"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
const bp = `
|
||||||
|
android_app {
|
||||||
|
name: "foo",
|
||||||
|
srcs: ["a.java"],
|
||||||
|
sdk_version: "current",
|
||||||
|
}
|
||||||
|
|
||||||
|
android_test_helper_app {
|
||||||
|
name: "HelperApp",
|
||||||
|
srcs: ["helper.java"],
|
||||||
|
}
|
||||||
|
|
||||||
|
android_test {
|
||||||
|
name: "base",
|
||||||
|
sdk_version: "current",
|
||||||
|
data: [":HelperApp", "data/testfile"],
|
||||||
|
}
|
||||||
|
|
||||||
|
test_module_config {
|
||||||
|
name: "derived_test",
|
||||||
|
base: "base",
|
||||||
|
exclude_filters: ["android.test.example.devcodelab.DevCodelabTest#testHelloFail"],
|
||||||
|
include_annotations: ["android.platform.test.annotations.LargeTest"],
|
||||||
|
}
|
||||||
|
|
||||||
|
`
|
||||||
|
|
||||||
|
// Ensure we create files needed and set the AndroidMkEntries needed
|
||||||
|
func TestModuleConfigAndroidTest(t *testing.T) {
|
||||||
|
|
||||||
|
ctx := android.GroupFixturePreparers(
|
||||||
|
java.PrepareForTestWithJavaDefaultModules,
|
||||||
|
android.FixtureRegisterWithContext(RegisterTestModuleConfigBuildComponents),
|
||||||
|
).RunTestWithBp(t, bp)
|
||||||
|
|
||||||
|
derived := ctx.ModuleForTests("derived_test", "android_common")
|
||||||
|
// Assert there are rules to create these files.
|
||||||
|
derived.Output("test_module_config.manifest")
|
||||||
|
derived.Output("test_config_fixer/derived_test.config")
|
||||||
|
|
||||||
|
// Ensure some basic rules exist.
|
||||||
|
ctx.ModuleForTests("base", "android_common").Output("package-res.apk")
|
||||||
|
entries := android.AndroidMkEntriesForTest(t, ctx.TestContext, derived.Module())[0]
|
||||||
|
|
||||||
|
// Ensure some entries from base are there, specifically support files for data and helper apps.
|
||||||
|
assertEntryPairValues(t, entries.EntryMap["LOCAL_COMPATIBILITY_SUPPORT_FILES"], []string{"HelperApp.apk", "data/testfile"})
|
||||||
|
|
||||||
|
// And some new derived entries are there.
|
||||||
|
android.AssertArrayString(t, "", entries.EntryMap["LOCAL_MODULE_TAGS"], []string{"tests"})
|
||||||
|
|
||||||
|
// And ones we override
|
||||||
|
android.AssertArrayString(t, "", entries.EntryMap["LOCAL_SOONG_JNI_LIBS_SYMBOLS"], []string{""})
|
||||||
|
|
||||||
|
android.AssertStringMatches(t, "", entries.EntryMap["LOCAL_FULL_TEST_CONFIG"][0], "derived_test/android_common/test_config_fixer/derived_test.config")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Make sure we call test-config-fixer with the right args.
|
||||||
|
func TestModuleConfigOptions(t *testing.T) {
|
||||||
|
|
||||||
|
ctx := android.GroupFixturePreparers(
|
||||||
|
java.PrepareForTestWithJavaDefaultModules,
|
||||||
|
android.FixtureRegisterWithContext(RegisterTestModuleConfigBuildComponents),
|
||||||
|
).RunTestWithBp(t, bp)
|
||||||
|
|
||||||
|
// Check that we generate a rule to make a new AndroidTest.xml/Module.config file.
|
||||||
|
derived := ctx.ModuleForTests("derived_test", "android_common")
|
||||||
|
rule_cmd := derived.Rule("fix_test_config").RuleParams.Command
|
||||||
|
android.AssertStringDoesContain(t, "Bad FixConfig rule inputs", rule_cmd,
|
||||||
|
`--test-file-name=derived_test.apk --orig-test-file-name=base.apk --test-runner-options='[{"Name":"exclude-filter","Key":"","Value":"android.test.example.devcodelab.DevCodelabTest#testHelloFail"},{"Name":"include-annotation","Key":"","Value":"android.platform.test.annotations.LargeTest"}]'`)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ensure we error for a base we don't support.
|
||||||
|
func TestModuleConfigBadBaseShouldFail(t *testing.T) {
|
||||||
|
badBp := `
|
||||||
|
java_test_host {
|
||||||
|
name: "base",
|
||||||
|
srcs: ["a.java"],
|
||||||
|
}
|
||||||
|
|
||||||
|
test_module_config {
|
||||||
|
name: "derived_test",
|
||||||
|
base: "base",
|
||||||
|
exclude_filters: ["android.test.example.devcodelab.DevCodelabTest#testHelloFail"],
|
||||||
|
include_annotations: ["android.platform.test.annotations.LargeTest"],
|
||||||
|
}`
|
||||||
|
|
||||||
|
ctx := android.GroupFixturePreparers(
|
||||||
|
java.PrepareForTestWithJavaDefaultModules,
|
||||||
|
android.FixtureRegisterWithContext(RegisterTestModuleConfigBuildComponents),
|
||||||
|
).ExtendWithErrorHandler(
|
||||||
|
android.FixtureExpectsAtLeastOneErrorMatchingPattern("does not provide test BaseTestProviderData")).
|
||||||
|
RunTestWithBp(t, badBp)
|
||||||
|
|
||||||
|
ctx.ModuleForTests("derived_test", "android_common")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Ensure we error for a base we don't support.
|
||||||
|
func TestModuleConfigNoFiltersOrAnnotationsShouldFail(t *testing.T) {
|
||||||
|
badBp := `
|
||||||
|
android_test {
|
||||||
|
name: "base",
|
||||||
|
sdk_version: "current",
|
||||||
|
srcs: ["a.java"],
|
||||||
|
}
|
||||||
|
|
||||||
|
test_module_config {
|
||||||
|
name: "derived_test",
|
||||||
|
base: "base",
|
||||||
|
}`
|
||||||
|
|
||||||
|
ctx := android.GroupFixturePreparers(
|
||||||
|
java.PrepareForTestWithJavaDefaultModules,
|
||||||
|
android.FixtureRegisterWithContext(RegisterTestModuleConfigBuildComponents),
|
||||||
|
).ExtendWithErrorHandler(
|
||||||
|
android.FixtureExpectsAtLeastOneErrorMatchingPattern("Test options must be given")).
|
||||||
|
RunTestWithBp(t, badBp)
|
||||||
|
|
||||||
|
ctx.ModuleForTests("derived_test", "android_common")
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestModuleConfigMultipleDerivedTestsWriteDistinctMakeEntries(t *testing.T) {
|
||||||
|
multiBp := `
|
||||||
|
android_test {
|
||||||
|
name: "base",
|
||||||
|
sdk_version: "current",
|
||||||
|
srcs: ["a.java"],
|
||||||
|
}
|
||||||
|
|
||||||
|
test_module_config {
|
||||||
|
name: "derived_test",
|
||||||
|
base: "base",
|
||||||
|
include_annotations: ["android.platform.test.annotations.LargeTest"],
|
||||||
|
}
|
||||||
|
|
||||||
|
test_module_config {
|
||||||
|
name: "another_derived_test",
|
||||||
|
base: "base",
|
||||||
|
include_annotations: ["android.platform.test.annotations.LargeTest"],
|
||||||
|
}`
|
||||||
|
|
||||||
|
ctx := android.GroupFixturePreparers(
|
||||||
|
java.PrepareForTestWithJavaDefaultModules,
|
||||||
|
android.FixtureRegisterWithContext(RegisterTestModuleConfigBuildComponents),
|
||||||
|
).RunTestWithBp(t, multiBp)
|
||||||
|
|
||||||
|
{
|
||||||
|
derived := ctx.ModuleForTests("derived_test", "android_common")
|
||||||
|
entries := android.AndroidMkEntriesForTest(t, ctx.TestContext, derived.Module())[0]
|
||||||
|
// All these should be the same in both derived tests
|
||||||
|
assertEntryPairValues(t, entries.EntryMap["LOCAL_COMPATIBILITY_SUPPORT_FILES"], []string{"HelperApp.apk", "data/testfile"})
|
||||||
|
android.AssertArrayString(t, "", entries.EntryMap["LOCAL_SOONG_JNI_LIBS_SYMBOLS"], []string{""})
|
||||||
|
// Except this one, which points to the updated tradefed xml file.
|
||||||
|
android.AssertStringMatches(t, "", entries.EntryMap["LOCAL_FULL_TEST_CONFIG"][0], "derived_test/android_common/test_config_fixer/derived_test.config")
|
||||||
|
// And this one, the module name.
|
||||||
|
android.AssertArrayString(t, "", entries.EntryMap["LOCAL_MODULE"], []string{"derived_test"})
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
derived := ctx.ModuleForTests("another_derived_test", "android_common")
|
||||||
|
entries := android.AndroidMkEntriesForTest(t, ctx.TestContext, derived.Module())[0]
|
||||||
|
// All these should be the same in both derived tests
|
||||||
|
assertEntryPairValues(t, entries.EntryMap["LOCAL_COMPATIBILITY_SUPPORT_FILES"], []string{"HelperApp.apk", "data/testfile"})
|
||||||
|
android.AssertArrayString(t, "", entries.EntryMap["LOCAL_SOONG_JNI_LIBS_SYMBOLS"], []string{""})
|
||||||
|
// Except this one, which points to the updated tradefed xml file.
|
||||||
|
android.AssertStringMatches(t, "", entries.EntryMap["LOCAL_FULL_TEST_CONFIG"][0], "another_derived_test/android_common/test_config_fixer/another_derived_test.config")
|
||||||
|
// And this one, the module name.
|
||||||
|
android.AssertArrayString(t, "", entries.EntryMap["LOCAL_MODULE"], []string{"another_derived_test"})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Use for situations where the entries map contains pairs: [srcPath:installedPath1, srcPath2:installedPath2]
|
||||||
|
// and we want to compare the RHS of the pairs, i.e. installedPath1, installedPath2
|
||||||
|
func assertEntryPairValues(t *testing.T, actual []string, expected []string) {
|
||||||
|
for i, e := range actual {
|
||||||
|
parts := strings.Split(e, ":")
|
||||||
|
if len(parts) != 2 {
|
||||||
|
t.Errorf("Expected entry to have a value delimited by :, received: %s", e)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
android.AssertStringEquals(t, "", parts[1], expected[i])
|
||||||
|
}
|
||||||
|
}
|
Reference in New Issue
Block a user