| // Copyright (c) 2019, the R8 project authors. Please see the AUTHORS file |
| // for details. All rights reserved. Use of this source code is governed by a |
| // BSD-style license that can be found in the LICENSE file. |
| package com.android.tools.r8.kotlin.metadata; |
| |
| import static com.android.tools.r8.KotlinCompilerTool.KOTLINC; |
| import static com.android.tools.r8.utils.codeinspector.Matchers.isExtensionFunction; |
| import static com.android.tools.r8.utils.codeinspector.Matchers.isPresent; |
| import static com.android.tools.r8.utils.codeinspector.Matchers.isRenamed; |
| import static org.hamcrest.CoreMatchers.not; |
| import static org.hamcrest.MatcherAssert.assertThat; |
| import static org.junit.Assert.assertTrue; |
| |
| import com.android.tools.r8.TestParameters; |
| import com.android.tools.r8.ToolHelper; |
| import com.android.tools.r8.ToolHelper.KotlinTargetVersion; |
| import com.android.tools.r8.shaking.ProguardKeepAttributes; |
| import com.android.tools.r8.utils.codeinspector.ClassSubject; |
| import com.android.tools.r8.utils.codeinspector.CodeInspector; |
| import com.android.tools.r8.utils.codeinspector.KmClassSubject; |
| import com.android.tools.r8.utils.codeinspector.KmFunctionSubject; |
| import com.android.tools.r8.utils.codeinspector.KmPackageSubject; |
| import java.nio.file.Path; |
| import java.util.Collection; |
| import java.util.HashMap; |
| import java.util.List; |
| import java.util.Map; |
| import org.junit.BeforeClass; |
| import org.junit.Test; |
| import org.junit.runner.RunWith; |
| import org.junit.runners.Parameterized; |
| |
| @RunWith(Parameterized.class) |
| public class MetadataRewriteInClasspathTypeTest extends KotlinMetadataTestBase { |
| |
| private final TestParameters parameters; |
| |
| @Parameterized.Parameters(name = "{0} target: {1}") |
| public static Collection<Object[]> data() { |
| return buildParameters( |
| getTestParameters().withCfRuntimes().build(), KotlinTargetVersion.values()); |
| } |
| |
| public MetadataRewriteInClasspathTypeTest( |
| TestParameters parameters, KotlinTargetVersion targetVersion) { |
| super(targetVersion); |
| this.parameters = parameters; |
| } |
| |
| private static final Map<KotlinTargetVersion, Path> baseLibJarMap = new HashMap<>(); |
| private static final Map<KotlinTargetVersion, Path> extLibJarMap = new HashMap<>(); |
| |
| @BeforeClass |
| public static void createLibJar() throws Exception { |
| String baseLibFolder = PKG_PREFIX + "/classpath_lib_base"; |
| String extLibFolder = PKG_PREFIX + "/classpath_lib_ext"; |
| for (KotlinTargetVersion targetVersion : KotlinTargetVersion.values()) { |
| Path baseLibJar = |
| kotlinc(KOTLINC, targetVersion) |
| .addSourceFiles(getKotlinFileInTest(baseLibFolder, "itf")) |
| .compile(); |
| Path extLibJar = |
| kotlinc(KOTLINC, targetVersion) |
| .addClasspathFiles(baseLibJar) |
| .addSourceFiles(getKotlinFileInTest(extLibFolder, "impl")) |
| .compile(); |
| baseLibJarMap.put(targetVersion, baseLibJar); |
| extLibJarMap.put(targetVersion, extLibJar); |
| } |
| } |
| |
| @Test |
| public void testMetadataInClasspathType_merged() throws Exception { |
| Path baseLibJar = baseLibJarMap.get(targetVersion); |
| Path libJar = |
| testForR8(parameters.getBackend()) |
| .addClasspathFiles(baseLibJar) |
| .addProgramFiles(extLibJarMap.get(targetVersion)) |
| // Keep the Extra class and its interface (which has the method). |
| .addKeepRules("-keep class **.Extra") |
| // Keep the ImplKt extension method which requires metadata |
| // to be called with Kotlin syntax from other kotlin code. |
| .addKeepRules("-keep class **.ImplKt { <methods>; }") |
| .addKeepAttributes(ProguardKeepAttributes.RUNTIME_VISIBLE_ANNOTATIONS) |
| .compile() |
| .inspect(this::inspectMerged) |
| .writeToZip(); |
| |
| Path output = |
| kotlinc(parameters.getRuntime().asCf(), KOTLINC, targetVersion) |
| .addClasspathFiles(baseLibJar, libJar) |
| .addSourceFiles(getKotlinFileInTest(PKG_PREFIX + "/classpath_app", "main")) |
| .setOutputPath(temp.newFolder().toPath()) |
| .compile(); |
| |
| testForJvm() |
| .addRunClasspathFiles(ToolHelper.getKotlinStdlibJar(), baseLibJar, libJar) |
| .addClasspath(output) |
| .run(parameters.getRuntime(), PKG + ".classpath_app.MainKt") |
| .assertSuccessWithOutputLines("Impl::foo"); |
| } |
| |
| private void inspectMerged(CodeInspector inspector) { |
| String implClassName = PKG + ".classpath_lib_ext.Impl"; |
| String implKtClassName = PKG + ".classpath_lib_ext.ImplKt"; |
| String extraClassName = PKG + ".classpath_lib_ext.Extra"; |
| |
| assertThat(inspector.clazz(implClassName), not(isPresent())); |
| |
| ClassSubject implKt = inspector.clazz(implKtClassName); |
| assertThat(implKt, isPresent()); |
| assertThat(implKt, not(isRenamed())); |
| // API entry is kept, hence the presence of Metadata. |
| KmPackageSubject kmPackage = implKt.getKmPackage(); |
| assertThat(kmPackage, isPresent()); |
| |
| KmFunctionSubject kmFunction = kmPackage.kmFunctionExtensionWithUniqueName("fooExt"); |
| assertThat(kmFunction, isPresent()); |
| |
| ClassSubject extra = inspector.clazz(extraClassName); |
| assertThat(extra, isPresent()); |
| assertThat(extra, not(isRenamed())); |
| // API entry is kept, hence the presence of Metadata. |
| KmClassSubject kmClass = extra.getKmClass(); |
| assertThat(kmClass, isPresent()); |
| List<ClassSubject> superTypes = kmClass.getSuperTypes(); |
| assertTrue(superTypes.stream().noneMatch( |
| supertype -> supertype.getFinalDescriptor().contains("Impl"))); |
| // Can't build ClassSubject with Itf in classpath. Instead, check if the reference to Itf is |
| // not altered via descriptors. |
| List<String> superTypeDescriptors = kmClass.getSuperTypeDescriptors(); |
| assertTrue(superTypeDescriptors.stream().noneMatch(supertype -> supertype.contains("Impl"))); |
| assertTrue(superTypeDescriptors.stream().anyMatch(supertype -> supertype.contains("Itf"))); |
| } |
| |
| @Test |
| public void testMetadataInClasspathType_renamed() throws Exception { |
| Path baseLibJar = baseLibJarMap.get(targetVersion); |
| Path libJar = |
| testForR8(parameters.getBackend()) |
| .addClasspathFiles(baseLibJar) |
| .addProgramFiles(extLibJarMap.get(targetVersion)) |
| // Keep the Extra class and its interface (which has the method). |
| .addKeepRules("-keep class **.Extra") |
| // Keep Super, but allow minification. |
| .addKeepRules("-keep,allowobfuscation class **.Impl") |
| // Keep the ImplKt extension method which requires metadata |
| // to be called with Kotlin syntax from other kotlin code. |
| .addKeepRules("-keep class **.ImplKt { <methods>; }") |
| .addKeepAttributes(ProguardKeepAttributes.RUNTIME_VISIBLE_ANNOTATIONS) |
| .compile() |
| .inspect(this::inspectRenamed) |
| .writeToZip(); |
| |
| Path output = |
| kotlinc(parameters.getRuntime().asCf(), KOTLINC, targetVersion) |
| .addClasspathFiles(baseLibJar, libJar) |
| .addSourceFiles(getKotlinFileInTest(PKG_PREFIX + "/classpath_app", "main")) |
| .setOutputPath(temp.newFolder().toPath()) |
| .compile(); |
| |
| testForJvm() |
| .addRunClasspathFiles(ToolHelper.getKotlinStdlibJar(), baseLibJar, libJar) |
| .addClasspath(output) |
| .run(parameters.getRuntime(), PKG + ".classpath_app.MainKt") |
| .assertSuccessWithOutputLines("Impl::foo"); |
| } |
| |
| private void inspectRenamed(CodeInspector inspector) { |
| String implClassName = PKG + ".classpath_lib_ext.Impl"; |
| String implKtClassName = PKG + ".classpath_lib_ext.ImplKt"; |
| String extraClassName = PKG + ".classpath_lib_ext.Extra"; |
| |
| ClassSubject impl = inspector.clazz(implClassName); |
| assertThat(impl, isRenamed()); |
| |
| ClassSubject implKt = inspector.clazz(implKtClassName); |
| assertThat(implKt, isPresent()); |
| assertThat(implKt, not(isRenamed())); |
| // API entry is kept, hence the presence of Metadata. |
| KmPackageSubject kmPackage = implKt.getKmPackage(); |
| assertThat(kmPackage, isPresent()); |
| |
| KmFunctionSubject kmFunction = kmPackage.kmFunctionExtensionWithUniqueName("fooExt"); |
| assertThat(kmFunction, isExtensionFunction()); |
| |
| ClassSubject extra = inspector.clazz(extraClassName); |
| assertThat(extra, isPresent()); |
| assertThat(extra, not(isRenamed())); |
| // API entry is kept, hence the presence of Metadata. |
| KmClassSubject kmClass = extra.getKmClass(); |
| assertThat(kmClass, isPresent()); |
| List<ClassSubject> superTypes = kmClass.getSuperTypes(); |
| assertTrue(superTypes.stream().noneMatch( |
| supertype -> supertype.getFinalDescriptor().contains("Impl"))); |
| assertTrue(superTypes.stream().anyMatch( |
| supertype -> supertype.getFinalDescriptor().equals(impl.getFinalDescriptor()))); |
| } |
| } |