src/test/java/com/android/tools/r8/profile/art/completeness/EnumUnboxingUtilityMethodProfileRewritingTest.java

// Copyright (c) 2023, 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.profile.art.completeness;

import static com.android.tools.r8.utils.codeinspector.Matchers.isPresent;
import static org.hamcrest.MatcherAssert.assertThat;

import com.android.tools.r8.TestBase;
import com.android.tools.r8.TestParameters;
import com.android.tools.r8.TestParametersCollection;
import com.android.tools.r8.profile.art.model.ExternalArtProfile;
import com.android.tools.r8.profile.art.utils.ArtProfileInspector;
import com.android.tools.r8.references.Reference;
import com.android.tools.r8.synthesis.SyntheticItemsTestUtils;
import com.android.tools.r8.utils.InternalOptions.InlinerOptions;
import com.android.tools.r8.utils.MethodReferenceUtils;
import com.android.tools.r8.utils.codeinspector.ClassSubject;
import com.android.tools.r8.utils.codeinspector.CodeInspector;
import com.android.tools.r8.utils.codeinspector.MethodSubject;
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)
public class EnumUnboxingUtilityMethodProfileRewritingTest extends TestBase {

  @Parameter(0)
  public TestParameters parameters;

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

  @Test
  public void testR8() throws Exception {
    testForR8(parameters.getBackend())
        .addInnerClasses(getClass())
        .addKeepMainRule(Main.class)
        .addArtProfileForRewriting(getArtProfile())
        .addEnumUnboxingInspector(inspector -> inspector.assertUnboxed(MyEnum.class))
        .addOptionsModification(InlinerOptions::disableInlining)
        .noHorizontalClassMergingOfSynthetics()
        .setMinApi(parameters.getApiLevel())
        .compile()
        .inspectResidualArtProfile(this::inspect)
        .run(parameters.getRuntime(), Main.class)
        .assertSuccessWithOutputLines("Hello, world!");
  }

  private ExternalArtProfile getArtProfile() throws Exception {
    return ExternalArtProfile.builder()
        .addMethodRule(MethodReferenceUtils.mainMethod(Main.class))
        .addMethodRule(Reference.methodFromMethod(MyEnum.class.getDeclaredMethod("greet")))
        .addMethodRule(Reference.methodFromMethod(MyEnum.class.getDeclaredMethod("other")))
        .addMethodRule(Reference.methodFromMethod(MyEnum.class.getDeclaredMethod("values")))
        .build();
  }

  private void inspect(ArtProfileInspector profileInspector, CodeInspector inspector) {
    ClassSubject mainClassSubject = inspector.clazz(Main.class);
    assertThat(mainClassSubject, isPresent());
    assertThat(mainClassSubject.mainMethod(), isPresent());

    ClassSubject enumUnboxingLocalUtilityClassSubject =
        inspector.clazz(
            SyntheticItemsTestUtils.syntheticEnumUnboxingLocalUtilityClass(MyEnum.class));
    assertThat(enumUnboxingLocalUtilityClassSubject, isPresent());

    MethodSubject localGreetMethodSubject =
        enumUnboxingLocalUtilityClassSubject.uniqueMethodWithOriginalName("greet");
    assertThat(localGreetMethodSubject, isPresent());

    MethodSubject localOtherMethodSubject =
        enumUnboxingLocalUtilityClassSubject.uniqueMethodWithOriginalName("other");
    assertThat(localOtherMethodSubject, isPresent());

    MethodSubject localValuesMethodSubject =
        enumUnboxingLocalUtilityClassSubject.uniqueMethodWithOriginalName("values");
    assertThat(localValuesMethodSubject, isPresent());

    ClassSubject enumUnboxingSharedUtilityClassSubject =
        inspector.clazz(
            SyntheticItemsTestUtils.syntheticEnumUnboxingSharedUtilityClass(MyEnum.class));
    assertThat(enumUnboxingSharedUtilityClassSubject, isPresent());
    assertThat(enumUnboxingSharedUtilityClassSubject.clinit(), isPresent());

    MethodSubject sharedOrdinalMethodSubject =
        enumUnboxingSharedUtilityClassSubject.uniqueMethodWithOriginalName("ordinal");
    assertThat(sharedOrdinalMethodSubject, isPresent());

    MethodSubject sharedValuesMethodSubject =
        enumUnboxingSharedUtilityClassSubject.uniqueMethodWithOriginalName("values");
    assertThat(sharedValuesMethodSubject, isPresent());

    profileInspector
        .assertContainsClassRule(enumUnboxingSharedUtilityClassSubject)
        .assertContainsMethodRules(
            mainClassSubject.mainMethod(),
            localGreetMethodSubject,
            localOtherMethodSubject,
            localValuesMethodSubject,
            enumUnboxingSharedUtilityClassSubject.clinit(),
            sharedOrdinalMethodSubject,
            sharedValuesMethodSubject)
        .assertContainsNoOtherRules();
  }

  static class Main {

    public static void main(String[] args) {
      MyEnum a = System.currentTimeMillis() > 0 ? MyEnum.A : MyEnum.B;
      MyEnum b = a.other();
      a.greet();
      b.greet();
    }
  }

  enum MyEnum {
    A,
    B;

    void greet() {
      switch (this) {
        case A:
          System.out.print("Hello");
          break;
        case B:
          System.out.println(", world!");
          break;
      }
    }

    MyEnum other() {
      return MyEnum.values()[1 - ordinal()];
    }
  }
}