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
diff --git a/tradefed_modules/test_module_config.go b/tradefed_modules/test_module_config.go
new file mode 100644
index 0000000..ba6ab94
--- /dev/null
+++ b/tradefed_modules/test_module_config.go
@@ -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
+}