From a5d171773d4d082a201778a4cadbc6938de0f608 Mon Sep 17 00:00:00 2001 From: Joe Onorato Date: Sat, 20 Jul 2024 17:39:56 -0700 Subject: [PATCH] Add jarjar_rename property to java modules. It's the same mechanism that aconfig uses, but now it's exposed directly to Android.bp files. (I had wanted to test it out there before making it a property just in case it didn't work well) Bug: 352385368 Test: go test -v -run TestJarJar.* Change-Id: I72d797d08a250be93779ee4b038a1b8fc62123b7 --- java/Android.bp | 1 + java/base.go | 19 ++++++++-- java/jarjar_test.go | 85 +++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 102 insertions(+), 3 deletions(-) create mode 100644 java/jarjar_test.go diff --git a/java/Android.bp b/java/Android.bp index a941754db..9603815a1 100644 --- a/java/Android.bp +++ b/java/Android.bp @@ -101,6 +101,7 @@ bootstrap_go_package { "hiddenapi_singleton_test.go", "jacoco_test.go", "java_test.go", + "jarjar_test.go", "jdeps_test.go", "kotlin_test.go", "lint_test.go", diff --git a/java/base.go b/java/base.go index be12ffd62..02df14770 100644 --- a/java/base.go +++ b/java/base.go @@ -91,6 +91,10 @@ type CommonProperties struct { // if not blank, run jarjar using the specified rules file Jarjar_rules *string `android:"path,arch_variant"` + // java class names to rename with jarjar when a reverse dependency has a jarjar_prefix + // property. + Jarjar_rename []string + // if not blank, used as prefix to generate repackage rule Jarjar_prefix *string @@ -2655,8 +2659,7 @@ func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProvi // Gather repackage information from deps result := collectDirectDepsProviders(ctx) - // Update that with entries we've stored for ourself - for orig, renamed := range module.jarjarRenameRules { + add := func(orig string, renamed string) { if result == nil { result = &JarJarProviderData{ Rename: make(map[string]string), @@ -2665,12 +2668,22 @@ func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProvi if renamed != "" { if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed { ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting) - continue + return } } (*result).Rename[orig] = renamed } + // Update that with entries we've stored for ourself + for orig, renamed := range module.jarjarRenameRules { + add(orig, renamed) + } + + // Update that with entries given in the jarjar_rename property. + for _, orig := range module.properties.Jarjar_rename { + add(orig, "") + } + // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work. if result == nil { return nil diff --git a/java/jarjar_test.go b/java/jarjar_test.go new file mode 100644 index 000000000..82bfa2b86 --- /dev/null +++ b/java/jarjar_test.go @@ -0,0 +1,85 @@ +// Copyright 2018 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" + "testing" + + "android/soong/android" +) + +func AssertJarJarRename(t *testing.T, result *android.TestResult, libName, original, expectedRename string) { + module := result.ModuleForTests(libName, "android_common") + + provider, found := android.OtherModuleProvider(result.OtherModuleProviderAdaptor(), module.Module(), JarJarProvider) + android.AssertBoolEquals(t, fmt.Sprintf("found provider (%s)", libName), true, found) + + renamed, found := provider.Rename[original] + android.AssertBoolEquals(t, fmt.Sprintf("found rename (%s)", libName), true, found) + android.AssertStringEquals(t, fmt.Sprintf("renamed (%s)", libName), expectedRename, renamed) +} + +func TestJarJarRenameDifferentModules(t *testing.T) { + t.Parallel() + result := android.GroupFixturePreparers( + prepareForJavaTest, + ).RunTestWithBp(t, ` + java_library { + name: "their_lib", + jarjar_rename: ["com.example.a"], + } + + java_library { + name: "boundary_lib", + jarjar_prefix: "RENAME", + static_libs: ["their_lib"], + } + + java_library { + name: "my_lib", + static_libs: ["boundary_lib"], + } + `) + + original := "com.example.a" + renamed := "RENAME.com.example.a" + AssertJarJarRename(t, result, "their_lib", original, "") + AssertJarJarRename(t, result, "boundary_lib", original, renamed) + AssertJarJarRename(t, result, "my_lib", original, renamed) +} + +func TestJarJarRenameSameModule(t *testing.T) { + t.Parallel() + result := android.GroupFixturePreparers( + prepareForJavaTest, + ).RunTestWithBp(t, ` + java_library { + name: "their_lib", + jarjar_rename: ["com.example.a"], + jarjar_prefix: "RENAME", + } + + java_library { + name: "my_lib", + static_libs: ["their_lib"], + } + `) + + original := "com.example.a" + renamed := "RENAME.com.example.a" + AssertJarJarRename(t, result, "their_lib", original, renamed) + AssertJarJarRename(t, result, "my_lib", original, renamed) +}