src/test/java/com/android/tools/r8/resolution/duplicatedefinitions/MaximallySpecificSingleDominatingAfterJoinTest.java

// Copyright (c) 2022, 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.resolution.duplicatedefinitions;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assume.assumeTrue;

import com.android.tools.r8.TestBase;
import com.android.tools.r8.TestCompilerBuilder;
import com.android.tools.r8.TestParameters;
import com.android.tools.r8.TestParametersCollection;
import com.android.tools.r8.ToolHelper;
import com.android.tools.r8.graph.AppInfoWithClassHierarchy;
import com.android.tools.r8.graph.AppView;
import com.android.tools.r8.graph.DexMethod;
import com.android.tools.r8.graph.MethodResolutionResult;
import com.android.tools.r8.graph.MethodResolutionResult.SingleResolutionResult;
import com.android.tools.r8.utils.AndroidApp;
import com.android.tools.r8.utils.ZipUtils.ZipBuilder;
import com.google.common.collect.ImmutableSet;
import java.nio.file.Path;
import java.util.HashSet;
import java.util.Set;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameter;
import org.junit.runners.Parameterized.Parameters;

@RunWith(Parameterized.class)
/**
 * This is testing resolving Main.f for:
 *
 * <pre>
 * I: I_L { f }
 * J: J_L extends I { f }
 * K: K_L extends J { }, K_P extends J { }
 * class Main implements I,K
 * </pre>
 */
public class MaximallySpecificSingleDominatingAfterJoinTest extends TestBase {

  private static final String EXPECTED = "J::foo";

  @Parameter() public TestParameters parameters;

  @Parameters(name = "{0}")
  public static TestParametersCollection data() {
    return getTestParameters().withAllRuntimesAndApiLevels().build();
  }

  private Path libraryClasses;

  @Before
  public void setup() throws Exception {
    libraryClasses = temp.newFile("lib.jar").toPath();
    ZipBuilder.builder(libraryClasses)
        .addFilesRelative(
            ToolHelper.getClassPathForTests(),
            ToolHelper.getClassFileForTestClass(K.class),
            ToolHelper.getClassFileForTestClass(J.class),
            ToolHelper.getClassFileForTestClass(I.class))
        .build();
  }

  @Test
  public void testResolution() throws Exception {
    assumeTrue(parameters.isOrSimulateNoneRuntime());
    AndroidApp.Builder builder = AndroidApp.builder();
    builder.addProgramFiles(
        ToolHelper.getClassFileForTestClass(K.class),
        ToolHelper.getClassFileForTestClass(Main.class));
    builder.addLibraryFiles(parameters.getDefaultRuntimeLibrary(), libraryClasses);
    AppView<AppInfoWithClassHierarchy> appView =
        computeAppViewWithClassHierarchy(
            builder.build(), null, options -> options.loadAllClassDefinitions = true);
    AppInfoWithClassHierarchy appInfo = appView.appInfo();
    DexMethod method = buildNullaryVoidMethod(Main.class, "foo", appInfo.dexItemFactory());
    MethodResolutionResult methodResolutionResult =
        appInfo.unsafeResolveMethodDueToDexFormat(method);
    assertTrue(methodResolutionResult.isSingleResolution());
    Set<String> methodResults = new HashSet<>();
    methodResolutionResult.forEachMethodResolutionResult(
        result -> {
          assertTrue(result.isSingleResolution());
          SingleResolutionResult<?> resolution = result.asSingleResolution();
          methodResults.add(
              (resolution.getResolvedHolder().isProgramClass() ? "Program: " : "Library: ")
                  + resolution.getResolvedMethod().getReference().toString());
        });
    assertEquals(ImmutableSet.of("Library: void " + typeName(J.class) + ".foo()"), methodResults);
  }

  @Test
  public void testJvm() throws Exception {
    assumeTrue(parameters.isCfRuntime());
    testForJvm()
        .addRunClasspathFiles(libraryClasses)
        .addProgramClasses(K.class, Main.class)
        .run(parameters.getRuntime(), Main.class)
        .assertSuccessWithOutputLines(EXPECTED);
  }

  @Test
  public void testD8() throws Exception {
    assumeTrue(parameters.isDexRuntime());
    runTest(
        testForD8(parameters.getBackend()),
        parameters.getDexRuntimeVersion().isDalvik()
            ? VerifyError.class
            // TODO(b/214382176): Extend resolution to support multiple definition results.
            : AbstractMethodError.class);
  }

  @Test
  public void testR8() throws Exception {
    runTest(
        testForR8(parameters.getBackend()).addKeepMainRule(Main.class),
        parameters.isDexRuntime() && parameters.getDexRuntimeVersion().isDalvik()
            ? VerifyError.class
            // TODO(b/214382176): Extend resolution to support multiple definition results.
            : AbstractMethodError.class);
  }

  private void runTest(
      TestCompilerBuilder<?, ?, ?, ?, ?> testBuilder,
      Class<? extends Throwable> errorIfNotSupportingDefaultMethods)
      throws Exception {
    testBuilder
        .addProgramClasses(K.class, Main.class)
        .addDefaultRuntimeLibrary(parameters)
        .addLibraryFiles(libraryClasses)
        .setMinApi(parameters.getApiLevel())
        .addOptionsModification(options -> options.loadAllClassDefinitions = true)
        .compile()
        .addBootClasspathFiles(buildOnDexRuntime(parameters, libraryClasses))
        .run(parameters.getRuntime(), Main.class)
        .assertSuccessWithOutputLinesIf(
            parameters.canUseDefaultAndStaticInterfaceMethods(), EXPECTED)
        // TODO(b/230289235): Extend to support multiple definition results.
        .assertFailureWithErrorThatThrowsIf(
            !parameters.canUseDefaultAndStaticInterfaceMethods(),
            errorIfNotSupportingDefaultMethods);
  }

  public interface I {
    default void foo() {
      System.out.println("I::foo");
    }
  }

  public interface J extends I {
    @Override
    default void foo() {
      System.out.println("J::foo");
    }
  }

  /* Present on both library and program */
  public interface K extends J {}

  public static class Main implements I, K {

    public static void main(String[] args) {
      new Main().foo();
    }
  }
}