java/testing.go - android_build_soong - Gitiles

 // Copyright 2019 Google Inc. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
 //     http://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.

 package java

 import (
 	"fmt"
 	"reflect"
 	"sort"
 	"strings"
 	"testing"

 	"android/soong/android"
 	"android/soong/cc"
 	"android/soong/dexpreopt"
 	"github.com/google/blueprint"
 )

 const defaultJavaDir = "default/java"

 // Test fixture preparer that will register most java build components.
 //
 // Singletons and mutators should only be added here if they are needed for a majority of java
 // module types, otherwise they should be added under a separate preparer to allow them to be
 // selected only when needed to reduce test execution time.
 //
 // Module types do not have much of an overhead unless they are used so this should include as many
 // module types as possible. The exceptions are those module types that require mutators and/or
 // singletons in order to function in which case they should be kept together in a separate
 // preparer.
 var PrepareForTestWithJavaBuildComponents = android.GroupFixturePreparers(
 	// Make sure that mutators and module types, e.g. prebuilt mutators available.
 	android.PrepareForTestWithAndroidBuildComponents,
 	// Make java build components available to the test.
 	android.FixtureRegisterWithContext(RegisterRequiredBuildComponentsForTest),
 )

 // Test fixture preparer that will define default java modules, e.g. standard prebuilt modules.
 var PrepareForTestWithJavaDefaultModules = android.GroupFixturePreparers(
 	// Make sure that all the module types used in the defaults are registered.
 	PrepareForTestWithJavaBuildComponents,
 	// The java default module definitions.
 	android.FixtureAddTextFile(defaultJavaDir+"/Android.bp", GatherRequiredDepsForTest()),
 )

 var PrepareForTestWithOverlayBuildComponents = android.FixtureRegisterWithContext(registerOverlayBuildComponents)

 // Prepare a fixture to use all java module types, mutators and singletons fully.
 //
 // This should only be used by tests that want to run with as much of the build enabled as possible.
 var PrepareForIntegrationTestWithJava = android.GroupFixturePreparers(
 	cc.PrepareForIntegrationTestWithCc,
 	PrepareForTestWithJavaDefaultModules,
 )

 // Prepare a fixture with the standard files required by a java_sdk_library module.
 var PrepareForTestWithJavaSdkLibraryFiles = android.FixtureMergeMockFs(android.MockFS{
 	"api/current.txt":               nil,
 	"api/removed.txt":               nil,
 	"api/system-current.txt":        nil,
 	"api/system-removed.txt":        nil,
 	"api/test-current.txt":          nil,
 	"api/test-removed.txt":          nil,
 	"api/module-lib-current.txt":    nil,
 	"api/module-lib-removed.txt":    nil,
 	"api/system-server-current.txt": nil,
 	"api/system-server-removed.txt": nil,
 })

 // FixtureWithLastReleaseApis creates a preparer that creates prebuilt versions of the specified
 // modules for the `last` API release. By `last` it just means last in the list of supplied versions
 // and as this only provides one version it can be any value.
 //
 // This uses FixtureWithPrebuiltApis under the covers so the limitations of that apply to this.
 func FixtureWithLastReleaseApis(moduleNames ...string) android.FixturePreparer {
 	return FixtureWithPrebuiltApis(map[string][]string{
 		"30": moduleNames,
 	})
 }

 // PrepareForTestWithPrebuiltsOfCurrentApi is a preparer that creates prebuilt versions of the
 // standard modules for the current version.
 //
 // This uses FixtureWithPrebuiltApis under the covers so the limitations of that apply to this.
 var PrepareForTestWithPrebuiltsOfCurrentApi = FixtureWithPrebuiltApis(map[string][]string{
 	"current": {},
 	// Can't have current on its own as it adds a prebuilt_apis module but doesn't add any
 	// .txt files which causes the prebuilt_apis module to fail.
 	"30": {},
 })

 // FixtureWithPrebuiltApis creates a preparer that will define prebuilt api modules for the
 // specified releases and modules.
 //
 // The supplied map keys are the releases, e.g. current, 29, 30, etc. The values are a list of
 // modules for that release. Due to limitations in the prebuilt_apis module which this preparer
 // uses the set of releases must include at least one numbered release, i.e. it cannot just include
 // "current".
 //
 // This defines a file in the mock file system in a predefined location (prebuilts/sdk/Android.bp)
 // and so only one instance of this can be used in each fixture.
 func FixtureWithPrebuiltApis(release2Modules map[string][]string) android.FixturePreparer {
 	mockFS := android.MockFS{}
 	path := "prebuilts/sdk/Android.bp"

 	bp := fmt.Sprintf(`
 			prebuilt_apis {
 				name: "sdk",
 				api_dirs: ["%s"],
 				imports_sdk_version: "none",
 				imports_compile_dex: true,
 			}
 		`, strings.Join(android.SortedStringKeys(release2Modules), `", "`))

 	for release, modules := range release2Modules {
 		libs := append([]string{"android", "core-for-system-modules"}, modules...)
 		mockFS.Merge(prebuiltApisFilesForLibs([]string{release}, libs))
 	}
 	return android.GroupFixturePreparers(
 		android.FixtureAddTextFile(path, bp),
 		android.FixtureMergeMockFs(mockFS),
 	)
 }

 func TestConfig(buildDir string, env map[string]string, bp string, fs map[string][]byte) android.Config {
 	bp += GatherRequiredDepsForTest()

 	mockFS := android.MockFS{}

 	cc.GatherRequiredFilesForTest(mockFS)

 	for k, v := range fs {
 		mockFS[k] = v
 	}

 	if env == nil {
 		env = make(map[string]string)
 	}
 	if env["ANDROID_JAVA8_HOME"] == "" {
 		env["ANDROID_JAVA8_HOME"] = "jdk8"
 	}
 	config := android.TestArchConfig(buildDir, env, bp, mockFS)

 	return config
 }

 func prebuiltApisFilesForLibs(apiLevels []string, sdkLibs []string) map[string][]byte {
 	fs := make(map[string][]byte)
 	for _, level := range apiLevels {
 		for _, lib := range sdkLibs {
 			for _, scope := range []string{"public", "system", "module-lib", "system-server", "test"} {
 				fs[fmt.Sprintf("prebuilts/sdk/%s/%s/%s.jar", level, scope, lib)] = nil
 				// No finalized API files for "current"
 				if level != "current" {
 					fs[fmt.Sprintf("prebuilts/sdk/%s/%s/api/%s.txt", level, scope, lib)] = nil
 					fs[fmt.Sprintf("prebuilts/sdk/%s/%s/api/%s-removed.txt", level, scope, lib)] = nil
 				}
 			}
 		}
 		fs[fmt.Sprintf("prebuilts/sdk/%s/public/framework.aidl", level)] = nil
 	}
 	return fs
 }

 // Register build components provided by this package that are needed by tests.
 //
 // In particular this must register all the components that are used in the `Android.bp` snippet
 // returned by GatherRequiredDepsForTest()
 func RegisterRequiredBuildComponentsForTest(ctx android.RegistrationContext) {
 	RegisterAARBuildComponents(ctx)
 	RegisterAppBuildComponents(ctx)
 	RegisterAppImportBuildComponents(ctx)
 	RegisterAppSetBuildComponents(ctx)
 	RegisterBootImageBuildComponents(ctx)
 	RegisterDexpreoptBootJarsComponents(ctx)
 	RegisterDocsBuildComponents(ctx)
 	RegisterGenRuleBuildComponents(ctx)
 	RegisterJavaBuildComponents(ctx)
 	RegisterPrebuiltApisBuildComponents(ctx)
 	RegisterRuntimeResourceOverlayBuildComponents(ctx)
 	RegisterSdkLibraryBuildComponents(ctx)
 	RegisterStubsBuildComponents(ctx)
 	RegisterSystemModulesBuildComponents(ctx)

 	// Make sure that any tool related module types needed by dexpreopt have been registered.
 	dexpreopt.RegisterToolModulesForTest(ctx)
 }

 // Gather the module definitions needed by tests that depend upon code from this package.
 //
 // Returns an `Android.bp` snippet that defines the modules that are needed by this package.
 func GatherRequiredDepsForTest() string {
 	var bp string

 	extraModules := []string{
 		"core-lambda-stubs",
 		"ext",
 		"android_stubs_current",
 		"android_system_stubs_current",
 		"android_test_stubs_current",
 		"android_module_lib_stubs_current",
 		"android_system_server_stubs_current",
 		"core.current.stubs",
 		"legacy.core.platform.api.stubs",
 		"stable.core.platform.api.stubs",
 		"kotlin-stdlib",
 		"kotlin-stdlib-jdk7",
 		"kotlin-stdlib-jdk8",
 		"kotlin-annotations",
 	}

 	for _, extra := range extraModules {
 		bp += fmt.Sprintf(`
 			java_library {
 				name: "%s",
 				srcs: ["a.java"],
 				sdk_version: "none",
 				system_modules: "stable-core-platform-api-stubs-system-modules",
 				compile_dex: true,
 			}
 		`, extra)
 	}

 	// For class loader context and <uses-library> tests.
 	dexpreoptModules := []string{"android.test.runner"}
 	dexpreoptModules = append(dexpreoptModules, dexpreopt.CompatUsesLibs...)
 	dexpreoptModules = append(dexpreoptModules, dexpreopt.OptionalCompatUsesLibs...)

 	for _, extra := range dexpreoptModules {
 		bp += fmt.Sprintf(`
 			java_library {
 				name: "%s",
 				srcs: ["a.java"],
 				sdk_version: "none",
 				system_modules: "stable-core-platform-api-stubs-system-modules",
 				compile_dex: true,
 				installable: true,
 			}
 		`, extra)
 	}

 	bp += `
 		java_library {
 			name: "framework",
 			srcs: ["a.java"],
 			sdk_version: "none",
 			system_modules: "stable-core-platform-api-stubs-system-modules",
 			aidl: {
 				export_include_dirs: ["framework/aidl"],
 			},
 		}

 		android_app {
 			name: "framework-res",
 			sdk_version: "core_platform",
 		}`

 	systemModules := []string{
 		"core-current-stubs-system-modules",
 		"legacy-core-platform-api-stubs-system-modules",
 		"stable-core-platform-api-stubs-system-modules",
 	}

 	for _, extra := range systemModules {
 		bp += fmt.Sprintf(`
 			java_system_modules {
 				name: "%[1]s",
 				libs: ["%[1]s-lib"],
 			}
 			java_library {
 				name: "%[1]s-lib",
 				sdk_version: "none",
 				system_modules: "none",
 			}
 		`, extra)
 	}

 	// Make sure that any tools needed for dexpreopting are defined.
 	bp += dexpreopt.BpToolModulesForTest()

 	// Make sure that the dex_bootjars singleton module is instantiated for the tests.
 	bp += `
 		dex_bootjars {
 			name: "dex_bootjars",
 		}
 `

 	return bp
 }

 func CheckModuleDependencies(t *testing.T, ctx *android.TestContext, name, variant string, expected []string) {
 	t.Helper()
 	module := ctx.ModuleForTests(name, variant).Module()
 	deps := []string{}
 	ctx.VisitDirectDeps(module, func(m blueprint.Module) {
 		deps = append(deps, m.Name())
 	})
 	sort.Strings(deps)

 	if actual := deps; !reflect.DeepEqual(expected, actual) {
 		t.Errorf("expected %#q, found %#q", expected, actual)
 	}
 }

 func CheckHiddenAPIRuleInputs(t *testing.T, expected string, hiddenAPIRule android.TestingBuildParams) {
 	t.Helper()
 	actual := strings.TrimSpace(strings.Join(android.NormalizePathsForTesting(hiddenAPIRule.Implicits), "\n"))
 	expected = strings.TrimSpace(expected)
 	if actual != expected {
 		t.Errorf("Expected hiddenapi rule inputs:\n%s\nactual inputs:\n%s", expected, actual)
 	}
 }
	// Copyright 2019 Google Inc. All rights reserved.
	//
	// Licensed under the Apache License, Version 2.0 (the "License");
	// you may not use this file except in compliance with the License.
	// You may obtain a copy of the License at
	//
	// http://www.apache.org/licenses/LICENSE-2.0
	//
	// Unless required by applicable law or agreed to in writing, software
	// distributed under the License is distributed on an "AS IS" BASIS,
	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	// See the License for the specific language governing permissions and
	// limitations under the License.

	package java

	import (
	"fmt"
	"reflect"
	"sort"
	"strings"
	"testing"

	"android/soong/android"
	"android/soong/cc"
	"android/soong/dexpreopt"
	"github.com/google/blueprint"
	)

	const defaultJavaDir = "default/java"

	// Test fixture preparer that will register most java build components.
	//
	// Singletons and mutators should only be added here if they are needed for a majority of java
	// module types, otherwise they should be added under a separate preparer to allow them to be
	// selected only when needed to reduce test execution time.
	//
	// Module types do not have much of an overhead unless they are used so this should include as many
	// module types as possible. The exceptions are those module types that require mutators and/or
	// singletons in order to function in which case they should be kept together in a separate
	// preparer.
	var PrepareForTestWithJavaBuildComponents = android.GroupFixturePreparers(
	// Make sure that mutators and module types, e.g. prebuilt mutators available.
	android.PrepareForTestWithAndroidBuildComponents,
	// Make java build components available to the test.
	android.FixtureRegisterWithContext(RegisterRequiredBuildComponentsForTest),
	)

	// Test fixture preparer that will define default java modules, e.g. standard prebuilt modules.
	var PrepareForTestWithJavaDefaultModules = android.GroupFixturePreparers(
	// Make sure that all the module types used in the defaults are registered.
	PrepareForTestWithJavaBuildComponents,
	// The java default module definitions.
	android.FixtureAddTextFile(defaultJavaDir+"/Android.bp", GatherRequiredDepsForTest()),
	)

	var PrepareForTestWithOverlayBuildComponents = android.FixtureRegisterWithContext(registerOverlayBuildComponents)

	// Prepare a fixture to use all java module types, mutators and singletons fully.
	//
	// This should only be used by tests that want to run with as much of the build enabled as possible.
	var PrepareForIntegrationTestWithJava = android.GroupFixturePreparers(
	cc.PrepareForIntegrationTestWithCc,
	PrepareForTestWithJavaDefaultModules,
	)

	// Prepare a fixture with the standard files required by a java_sdk_library module.
	var PrepareForTestWithJavaSdkLibraryFiles = android.FixtureMergeMockFs(android.MockFS{
	"api/current.txt": nil,
	"api/removed.txt": nil,
	"api/system-current.txt": nil,
	"api/system-removed.txt": nil,
	"api/test-current.txt": nil,
	"api/test-removed.txt": nil,
	"api/module-lib-current.txt": nil,
	"api/module-lib-removed.txt": nil,
	"api/system-server-current.txt": nil,
	"api/system-server-removed.txt": nil,
	})

	// FixtureWithLastReleaseApis creates a preparer that creates prebuilt versions of the specified
	// modules for the `last` API release. By `last` it just means last in the list of supplied versions
	// and as this only provides one version it can be any value.
	//
	// This uses FixtureWithPrebuiltApis under the covers so the limitations of that apply to this.
	func FixtureWithLastReleaseApis(moduleNames ...string) android.FixturePreparer {
	return FixtureWithPrebuiltApis(map[string][]string{
	"30": moduleNames,
	})
	}

	// PrepareForTestWithPrebuiltsOfCurrentApi is a preparer that creates prebuilt versions of the
	// standard modules for the current version.
	//
	// This uses FixtureWithPrebuiltApis under the covers so the limitations of that apply to this.
	var PrepareForTestWithPrebuiltsOfCurrentApi = FixtureWithPrebuiltApis(map[string][]string{
	"current": {},
	// Can't have current on its own as it adds a prebuilt_apis module but doesn't add any
	// .txt files which causes the prebuilt_apis module to fail.
	"30": {},
	})

	// FixtureWithPrebuiltApis creates a preparer that will define prebuilt api modules for the
	// specified releases and modules.
	//
	// The supplied map keys are the releases, e.g. current, 29, 30, etc. The values are a list of
	// modules for that release. Due to limitations in the prebuilt_apis module which this preparer
	// uses the set of releases must include at least one numbered release, i.e. it cannot just include
	// "current".
	//
	// This defines a file in the mock file system in a predefined location (prebuilts/sdk/Android.bp)
	// and so only one instance of this can be used in each fixture.
	func FixtureWithPrebuiltApis(release2Modules map[string][]string) android.FixturePreparer {
	mockFS := android.MockFS{}
	path := "prebuilts/sdk/Android.bp"

	bp := fmt.Sprintf(`
	prebuilt_apis {
	name: "sdk",
	api_dirs: ["%s"],
	imports_sdk_version: "none",
	imports_compile_dex: true,
	}
	`, strings.Join(android.SortedStringKeys(release2Modules), `", "`))

	for release, modules := range release2Modules {
	libs := append([]string{"android", "core-for-system-modules"}, modules...)
	mockFS.Merge(prebuiltApisFilesForLibs([]string{release}, libs))
	}
	return android.GroupFixturePreparers(
	android.FixtureAddTextFile(path, bp),
	android.FixtureMergeMockFs(mockFS),
	)
	}

	func TestConfig(buildDir string, env map[string]string, bp string, fs map[string][]byte) android.Config {
	bp += GatherRequiredDepsForTest()

	mockFS := android.MockFS{}

	cc.GatherRequiredFilesForTest(mockFS)

	for k, v := range fs {
	mockFS[k] = v
	}

	if env == nil {
	env = make(map[string]string)
	}
	if env["ANDROID_JAVA8_HOME"] == "" {
	env["ANDROID_JAVA8_HOME"] = "jdk8"
	}
	config := android.TestArchConfig(buildDir, env, bp, mockFS)

	return config
	}

	func prebuiltApisFilesForLibs(apiLevels []string, sdkLibs []string) map[string][]byte {
	fs := make(map[string][]byte)
	for _, level := range apiLevels {
	for _, lib := range sdkLibs {
	for _, scope := range []string{"public", "system", "module-lib", "system-server", "test"} {
	fs[fmt.Sprintf("prebuilts/sdk/%s/%s/%s.jar", level, scope, lib)] = nil
	// No finalized API files for "current"
	if level != "current" {
	fs[fmt.Sprintf("prebuilts/sdk/%s/%s/api/%s.txt", level, scope, lib)] = nil
	fs[fmt.Sprintf("prebuilts/sdk/%s/%s/api/%s-removed.txt", level, scope, lib)] = nil
	}
	}
	}
	fs[fmt.Sprintf("prebuilts/sdk/%s/public/framework.aidl", level)] = nil
	}
	return fs
	}

	// Register build components provided by this package that are needed by tests.
	//
	// In particular this must register all the components that are used in the `Android.bp` snippet
	// returned by GatherRequiredDepsForTest()
	func RegisterRequiredBuildComponentsForTest(ctx android.RegistrationContext) {
	RegisterAARBuildComponents(ctx)
	RegisterAppBuildComponents(ctx)
	RegisterAppImportBuildComponents(ctx)
	RegisterAppSetBuildComponents(ctx)
	RegisterBootImageBuildComponents(ctx)
	RegisterDexpreoptBootJarsComponents(ctx)
	RegisterDocsBuildComponents(ctx)
	RegisterGenRuleBuildComponents(ctx)
	RegisterJavaBuildComponents(ctx)
	RegisterPrebuiltApisBuildComponents(ctx)
	RegisterRuntimeResourceOverlayBuildComponents(ctx)
	RegisterSdkLibraryBuildComponents(ctx)
	RegisterStubsBuildComponents(ctx)
	RegisterSystemModulesBuildComponents(ctx)

	// Make sure that any tool related module types needed by dexpreopt have been registered.
	dexpreopt.RegisterToolModulesForTest(ctx)
	}

	// Gather the module definitions needed by tests that depend upon code from this package.
	//
	// Returns an `Android.bp` snippet that defines the modules that are needed by this package.
	func GatherRequiredDepsForTest() string {
	var bp string

	extraModules := []string{
	"core-lambda-stubs",
	"ext",
	"android_stubs_current",
	"android_system_stubs_current",
	"android_test_stubs_current",
	"android_module_lib_stubs_current",
	"android_system_server_stubs_current",
	"core.current.stubs",
	"legacy.core.platform.api.stubs",
	"stable.core.platform.api.stubs",
	"kotlin-stdlib",
	"kotlin-stdlib-jdk7",
	"kotlin-stdlib-jdk8",
	"kotlin-annotations",
	}

	for _, extra := range extraModules {
	bp += fmt.Sprintf(`
	java_library {
	name: "%s",
	srcs: ["a.java"],
	sdk_version: "none",
	system_modules: "stable-core-platform-api-stubs-system-modules",
	compile_dex: true,
	}
	`, extra)
	}

	// For class loader context and <uses-library> tests.
	dexpreoptModules := []string{"android.test.runner"}
	dexpreoptModules = append(dexpreoptModules, dexpreopt.CompatUsesLibs...)
	dexpreoptModules = append(dexpreoptModules, dexpreopt.OptionalCompatUsesLibs...)

	for _, extra := range dexpreoptModules {
	bp += fmt.Sprintf(`
	java_library {
	name: "%s",
	srcs: ["a.java"],
	sdk_version: "none",
	system_modules: "stable-core-platform-api-stubs-system-modules",
	compile_dex: true,
	installable: true,
	}
	`, extra)
	}

	bp += `
	java_library {
	name: "framework",
	srcs: ["a.java"],
	sdk_version: "none",
	system_modules: "stable-core-platform-api-stubs-system-modules",
	aidl: {
	export_include_dirs: ["framework/aidl"],
	},
	}

	android_app {
	name: "framework-res",
	sdk_version: "core_platform",
	}`

	systemModules := []string{
	"core-current-stubs-system-modules",
	"legacy-core-platform-api-stubs-system-modules",
	"stable-core-platform-api-stubs-system-modules",
	}

	for _, extra := range systemModules {
	bp += fmt.Sprintf(`
	java_system_modules {
	name: "%[1]s",
	libs: ["%[1]s-lib"],
	}
	java_library {
	name: "%[1]s-lib",
	sdk_version: "none",
	system_modules: "none",
	}
	`, extra)
	}

	// Make sure that any tools needed for dexpreopting are defined.
	bp += dexpreopt.BpToolModulesForTest()

	// Make sure that the dex_bootjars singleton module is instantiated for the tests.
	bp += `
	dex_bootjars {
	name: "dex_bootjars",
	}
	`

	return bp
	}

	func CheckModuleDependencies(t testing.T, ctx android.TestContext, name, variant string, expected []string) {
	t.Helper()
	module := ctx.ModuleForTests(name, variant).Module()
	deps := []string{}
	ctx.VisitDirectDeps(module, func(m blueprint.Module) {
	deps = append(deps, m.Name())
	})
	sort.Strings(deps)

	if actual := deps; !reflect.DeepEqual(expected, actual) {
	t.Errorf("expected %#q, found %#q", expected, actual)
	}
	}

	func CheckHiddenAPIRuleInputs(t *testing.T, expected string, hiddenAPIRule android.TestingBuildParams) {
	t.Helper()
	actual := strings.TrimSpace(strings.Join(android.NormalizePathsForTesting(hiddenAPIRule.Implicits), "\n"))
	expected = strings.TrimSpace(expected)
	if actual != expected {
	t.Errorf("Expected hiddenapi rule inputs:\n%s\nactual inputs:\n%s", expected, actual)
	}
	}