path: root/tradefed_modules/test_module_config.go

package tradefed_modules

import (
	"encoding/json"
	"fmt"
	"io"
	"slices"
	"strings"

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

	"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)
	ctx.RegisterModuleType("test_module_config_host", TestModuleConfigHostFactory)
}

type testModuleConfigModule struct {
	android.ModuleBase
	android.DefaultableModuleBase

	tradefedProperties

	// Our updated testConfig.
	testConfig android.OutputPath
	manifest   android.OutputPath
	provider   tradefed.BaseTestProviderData

	supportFiles android.InstallPaths

	isHost bool
}

// Host is mostly the same as non-host, just some diffs for AddDependency and
// AndroidMkEntries, but the properties are the same.
type testModuleConfigHostModule struct {
	testModuleConfigModule
}

// 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"}
	testModuleConfigHostTag = dependencyTag{name: "TestModuleConfigHostBase"}
	pctx                    = android.NewPackageContext("android/soong/tradefed_modules")
)

func (m *testModuleConfigModule) InstallInTestcases() bool {
	return true
}

func (m *testModuleConfigModule) DepsMutator(ctx android.BottomUpMutatorContext) {
	if m.Base == nil {
		ctx.ModuleErrorf("'base' field must be set to a 'android_test' module.")
		return
	}
	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.
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-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) {
	m.validateBase(ctx, &testModuleConfigTag, "android_test", false)
	m.generateManifestAndConfig(ctx)

	moduleInfoJSON := ctx.ModuleInfoJSON()
	moduleInfoJSON.Class = []string{m.provider.MkAppClass}
	if m.provider.MkAppClass != "NATIVE_TESTS" {
		moduleInfoJSON.Tags = append(moduleInfoJSON.Tags, "tests")
	}
	if m.provider.IsUnitTest {
		moduleInfoJSON.IsUnitTest = "true"
	}
	moduleInfoJSON.CompatibilitySuites = append(moduleInfoJSON.CompatibilitySuites, m.tradefedProperties.Test_suites...)
	moduleInfoJSON.SystemSharedLibs = []string{"none"}
	moduleInfoJSON.ExtraRequired = append(moduleInfoJSON.ExtraRequired, m.provider.RequiredModuleNames...)
	moduleInfoJSON.ExtraRequired = append(moduleInfoJSON.ExtraRequired, *m.Base)
	moduleInfoJSON.ExtraHostRequired = append(moduleInfoJSON.ExtraRequired, m.provider.HostRequiredModuleNames...)
	moduleInfoJSON.TestConfig = []string{m.testConfig.String()}
	moduleInfoJSON.AutoTestConfig = []string{"true"}
	moduleInfoJSON.TestModuleConfigBase = proptools.String(m.Base)

	android.SetProvider(ctx, android.SupportFilesInfoProvider, android.SupportFilesInfo{
		SupportFiles: m.supportFiles,
	})
}

// Ensure at least one test_suite is listed.  Ideally it should be general-tests
// or device-tests, whichever is listed in base and prefer general-tests if both are listed.
// However this is not enforced yet.
//
// Returns true if okay and reports errors via ModuleErrorf.
func (m *testModuleConfigModule) validateTestSuites(ctx android.ModuleContext) bool {
	if len(m.tradefedProperties.Test_suites) == 0 {
		ctx.ModuleErrorf("At least one test-suite must be set or this won't run. Use \"general-tests\" or \"device-tests\"")
		return false
	}

	var extra_derived_suites []string
	// Ensure all suites listed are also in base.
	for _, s := range m.tradefedProperties.Test_suites {
		if !slices.Contains(m.provider.TestSuites, s) {
			extra_derived_suites = append(extra_derived_suites, s)
		}
	}
	if len(extra_derived_suites) != 0 {
		ctx.ModuleErrorf("Suites: [%s] listed but do not exist in base module: %s",
			strings.Join(extra_derived_suites, ", "),
			*m.tradefedProperties.Base)
		return false
	}

	return true
}

func TestModuleConfigFactory() android.Module {
	module := &testModuleConfigModule{}

	module.AddProperties(&module.tradefedProperties)
	android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
	android.InitDefaultableModule(module)

	return module
}

func TestModuleConfigHostFactory() android.Module {
	module := &testModuleConfigHostModule{}

	module.AddProperties(&module.tradefedProperties)
	android.InitAndroidMultiTargetsArchModule(module, android.HostSupported, android.MultilibCommon)
	android.InitDefaultableModule(module)
	module.isHost = true

	return module
}

// Implements android.AndroidMkEntriesProvider
var _ android.AndroidMkEntriesProvider = (*testModuleConfigModule)(nil)

func (m *testModuleConfigModule) nativeExtraEntries(entries *android.AndroidMkEntries) {
	// TODO(ron) provider for suffix and STEM?
	entries.SetString("LOCAL_MODULE_SUFFIX", "")
	// Should the stem and path use the base name or our module name?
	entries.SetString("LOCAL_MODULE_STEM", m.provider.OutputFile.Rel())
	entries.SetPath("LOCAL_MODULE_PATH", m.provider.InstallDir)
}

func (m *testModuleConfigModule) javaExtraEntries(entries *android.AndroidMkEntries) {
	// The app_prebuilt_internal.mk files try create a copy of the OutputFile as an .apk.
	// Normally, this copies the "package.apk" from the intermediate directory here.
	// To prevent the copy of the large apk and to prevent confusion with the real .apk we
	// link to, we set the STEM here to a bogus name and we set OutputFile to a small file (our manifest).
	// We do this so we don't have to add more conditionals to base_rules.mk
	// soong_java_prebult has the same issue for .jars so use this in both module types.
	entries.SetString("LOCAL_MODULE_STEM", fmt.Sprintf("UNUSED-%s", *m.Base))
	entries.SetString("LOCAL_MODULE_TAGS", "tests")
}

func (m *testModuleConfigModule) AndroidMkEntries() []android.AndroidMkEntries {
	appClass := m.provider.MkAppClass
	include := m.provider.MkInclude
	return []android.AndroidMkEntries{{
		Class:      appClass,
		OutputFile: android.OptionalPathForPath(m.manifest),
		Include:    include,
		Required:   []string{*m.Base},
		ExtraEntries: []android.AndroidMkExtraEntriesFunc{
			func(ctx android.AndroidMkExtraEntriesContext, entries *android.AndroidMkEntries) {
				entries.SetPath("LOCAL_FULL_TEST_CONFIG", m.testConfig)
				entries.SetString("LOCAL_TEST_MODULE_CONFIG_BASE", *m.Base)
				if m.provider.LocalSdkVersion != "" {
					entries.SetString("LOCAL_SDK_VERSION", m.provider.LocalSdkVersion)
				}
				if m.provider.LocalCertificate != "" {
					entries.SetString("LOCAL_CERTIFICATE", m.provider.LocalCertificate)
				}

				entries.SetBoolIfTrue("LOCAL_IS_UNIT_TEST", m.provider.IsUnitTest)
				entries.AddCompatibilityTestSuites(m.tradefedProperties.Test_suites...)
				entries.AddStrings("LOCAL_HOST_REQUIRED_MODULES", m.provider.HostRequiredModuleNames...)

				if m.provider.MkAppClass == "NATIVE_TESTS" {
					m.nativeExtraEntries(entries)
				} else {
					m.javaExtraEntries(entries)
				}

				// In normal java/app modules, the module writes LOCAL_COMPATIBILITY_SUPPORT_FILES
				// and then base_rules.mk ends up copying each of those dependencies from .intermediates to the install directory.
				// tasks/general-tests.mk, tasks/devices-tests.mk also use these to figure out
				// which testcase files to put in a zip for running tests on another machine.
				//
				// We need our files to end up in the zip, but we don't want \.mk files to
				// `install` files for us.
				// So we create a new make variable to indicate these should be in the zip
				// but not installed.
				entries.AddStrings("LOCAL_SOONG_INSTALLED_COMPATIBILITY_SUPPORT_FILES", m.supportFiles.Strings()...)
			},
		},
		// Ensure each of our supportFiles depends on the installed file in base so that our symlinks will always
		// resolve.  The provider gives us the .intermediate path for the support file in base, we change it to
		// the installed path with a string substitution.
		ExtraFooters: []android.AndroidMkExtraFootersFunc{
			func(w io.Writer, name, prefix, moduleDir string) {
				for _, f := range m.supportFiles.Strings() {
					// convert out/.../testcases/FrameworksServicesTests_contentprotection/file1.apk
					// to      out/.../testcases/FrameworksServicesTests/file1.apk
					basePath := strings.Replace(f, "/"+m.Name()+"/", "/"+*m.Base+"/", 1)
					fmt.Fprintf(w, "%s: %s\n", f, basePath)
				}
			},
		},
	}}
}

func (m *testModuleConfigHostModule) DepsMutator(ctx android.BottomUpMutatorContext) {
	if m.Base == nil {
		ctx.ModuleErrorf("'base' field must be set to a 'java_test_host' module")
		return
	}
	ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), testModuleConfigHostTag, *m.Base)
}

// File to write:
// 1) out/host/linux-x86/testcases/derived-module/test_module_config.manifest # contains base's name.
// 2) out/host/linux-x86/testcases/derived-module/derived-module.config  # Update AnroidTest.xml
// 3) out/host/linux-x86/testcases/derived-module/base.jar
//   - written via soong_java_prebuilt.mk
//
// 4) out/host/linux-x86/testcases/derived-module/* # data dependencies from base.
//   - written via our InstallSymlink
func (m *testModuleConfigHostModule) GenerateAndroidBuildActions(ctx android.ModuleContext) {
	m.validateBase(ctx, &testModuleConfigHostTag, "java_test_host", true)
	m.generateManifestAndConfig(ctx)
	android.SetProvider(ctx, android.SupportFilesInfoProvider, android.SupportFilesInfo{
		SupportFiles: m.supportFiles,
	})
}

// Ensure the base listed is the right type by checking that we get the expected provider data.
// Returns false on errors and the context is updated with an error indicating the baseType expected.
func (m *testModuleConfigModule) validateBase(ctx android.ModuleContext, depTag *dependencyTag, baseType string, baseShouldBeHost bool) {
	ctx.VisitDirectDepsWithTag(*depTag, func(dep android.Module) {
		if provider, ok := android.OtherModuleProvider(ctx, dep, tradefed.BaseTestProviderKey); ok {
			if baseShouldBeHost == provider.IsHost {
				m.provider = provider
			} else {
				if baseShouldBeHost {
					ctx.ModuleErrorf("'android_test' module used as base, but 'java_test_host' expected.")
				} else {
					ctx.ModuleErrorf("'java_test_host' module used as base, but 'android_test' expected.")
				}
			}
		} else {
			ctx.ModuleErrorf("'%s' module used as base but it is not a '%s' module.", *m.Base, baseType)
		}
	})
}

// Actions to write:
//  1. manifest file to testcases dir
//  2. Symlink to base.apk under base's arch dir
//  3. Symlink to all data dependencies
//  4. New Module.config / AndroidTest.xml file with our options.
func (m *testModuleConfigModule) generateManifestAndConfig(ctx android.ModuleContext) {
	// Keep before early returns.
	android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
		TestOnly:       true,
		TopLevelTarget: true,
	})

	if !m.validateTestSuites(ctx) {
		return
	}
	// Ensure the base provider is accurate
	if m.provider.TestConfig == nil {
		return
	}
	// 1) A manifest file listing the base, write text to a tiny file.
	installDir := android.PathForModuleInstall(ctx, ctx.ModuleName())
	manifest := android.PathForModuleOut(ctx, "test_module_config.manifest")
	android.WriteFileRule(ctx, manifest, fmt.Sprintf("{%q: %q}", "base", *m.tradefedProperties.Base))
	// build/soong/android/androidmk.go has this comment:
	//    Assume the primary install file is last
	// so we need to Install our file last.
	ctx.InstallFile(installDir, manifest.Base(), manifest)
	m.manifest = manifest.OutputPath

	// 2) Symlink to base.apk
	baseApk := m.provider.OutputFile

	// Typically looks like this for baseApk
	// FrameworksServicesTests
	// └── x86_64
	//    └── FrameworksServicesTests.apk
	if m.provider.MkAppClass != "NATIVE_TESTS" {
		symlinkName := fmt.Sprintf("%s/%s", ctx.DeviceConfig().DeviceArch(), baseApk.Base())
		// Only android_test, not java_host_test puts the output in the DeviceArch dir.
		if m.provider.IsHost || ctx.DeviceConfig().DeviceArch() == "" {
			// testcases/CtsDevicePolicyManagerTestCases
			// ├── CtsDevicePolicyManagerTestCases.jar
			symlinkName = baseApk.Base()
		}

		target := installedBaseRelativeToHere(symlinkName, *m.tradefedProperties.Base)
		installedApk := ctx.InstallAbsoluteSymlink(installDir, symlinkName, target)
		m.supportFiles = append(m.supportFiles, installedApk)
	}

	// 3) Symlink for all data deps
	// And like this for data files and required modules
	// FrameworksServicesTests
	// ├── data
	// │   └── broken_shortcut.xml
	// ├── JobTestApp.apk
	for _, symlinkName := range m.provider.TestcaseRelDataFiles {
		target := installedBaseRelativeToHere(symlinkName, *m.tradefedProperties.Base)
		installedPath := ctx.InstallAbsoluteSymlink(installDir, symlinkName, target)
		m.supportFiles = append(m.supportFiles, installedPath)
	}

	// 4) Module.config / AndroidTest.xml
	m.testConfig = m.fixTestConfig(ctx, m.provider.TestConfig)

	// 5) We provide so we can be listed in test_suites.
	android.SetProvider(ctx, tradefed.BaseTestProviderKey, tradefed.BaseTestProviderData{
		TestcaseRelDataFiles:    testcaseRel(m.supportFiles.Paths()),
		OutputFile:              baseApk,
		TestConfig:              m.testConfig,
		HostRequiredModuleNames: m.provider.HostRequiredModuleNames,
		RequiredModuleNames:     m.provider.RequiredModuleNames,
		TestSuites:              m.tradefedProperties.Test_suites,
		IsHost:                  m.provider.IsHost,
		LocalCertificate:        m.provider.LocalCertificate,
		IsUnitTest:              m.provider.IsUnitTest,
	})

	android.SetProvider(ctx, android.TestSuiteInfoProvider, android.TestSuiteInfo{
		TestSuites: m.tradefedProperties.Test_suites,
	})
}

var _ android.AndroidMkEntriesProvider = (*testModuleConfigHostModule)(nil)

func testcaseRel(paths android.Paths) []string {
	relPaths := []string{}
	for _, p := range paths {
		relPaths = append(relPaths, p.Rel())
	}
	return relPaths
}

// Given a relative path to a file in the current directory or a subdirectory,
// return a relative path under our sibling directory named `base`.
// There should be one "../" for each subdir we descend plus one to backup to "base".
//
//	 ThisDir/file1
//	 ThisDir/subdir/file2
//	would return "../base/file1" or "../../subdir/file2"
func installedBaseRelativeToHere(targetFileName string, base string) string {
	backup := strings.Repeat("../", strings.Count(targetFileName, "/")+1)
	return fmt.Sprintf("%s%s/%s", backup, base, targetFileName)
}