src/test/java/com/android/tools/r8/keepanno/CheckOptimizedOutAnnotationTest.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.keepanno;

import static com.android.tools.r8.DiagnosticsMatcher.diagnosticMessage;
import static com.android.tools.r8.utils.codeinspector.Matchers.isAbsent;
import static com.android.tools.r8.utils.codeinspector.Matchers.isPresent;
import static org.hamcrest.CoreMatchers.allOf;
import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.junit.Assume.assumeFalse;
import static org.junit.Assume.assumeTrue;

import com.android.tools.r8.DiagnosticsLevel;
import com.android.tools.r8.DiagnosticsMatcher;
import com.android.tools.r8.errors.CheckDiscardDiagnostic;
import com.android.tools.r8.keepanno.annotations.CheckOptimizedOut;
import com.android.tools.r8.utils.AndroidApiLevel;
import com.android.tools.r8.utils.StringUtils;
import com.android.tools.r8.utils.codeinspector.CodeInspector;
import com.google.common.collect.ImmutableList;
import java.util.List;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameter;

@RunWith(Parameterized.class)
public class CheckOptimizedOutAnnotationTest extends KeepAnnoTestBase {

  static final String EXPECTED = StringUtils.lines("A", "B.baz");

  @Parameter public KeepAnnoParameters parameters;

  @Parameterized.Parameters(name = "{0}")
  public static List<KeepAnnoParameters> data() {
    return createParameters(
        getTestParameters().withDefaultRuntimes().withApiLevel(AndroidApiLevel.B).build());
  }

  @Test
  public void test() throws Exception {
    assumeFalse(parameters.isR8());
    testForKeepAnno(parameters)
        .enableNativeInterpretation()
        .addProgramClasses(getInputClasses())
        .addKeepMainRule(TestClass.class)
        .setExcludedOuterClass(getClass())
        .run(TestClass.class)
        .assertSuccessWithOutput(EXPECTED)
        .applyIf(parameters.isShrinker(), r -> r.inspect(this::checkOutput));
  }

  @Test
  public void testCurrentR8() throws Throwable {
    assumeTrue(parameters.isR8() && parameters.isCurrentR8());
    testForKeepAnno(parameters)
        .enableNativeInterpretation()
        .addProgramClasses(getInputClasses())
        .addKeepMainRule(TestClass.class)
        .applyIfR8Current(
            b ->
                b.allowDiagnosticWarningMessages()
                    .setDiagnosticsLevelModifier(
                        (level, diagnostic) ->
                            level == DiagnosticsLevel.ERROR ? DiagnosticsLevel.WARNING : level)
                    .compileWithExpectedDiagnostics(
                        diagnostics -> {
                          diagnostics
                              .assertOnlyWarnings()
                              .assertWarningsMatch(
                                  DiagnosticsMatcher.diagnosticType(CheckDiscardDiagnostic.class));
                          CheckDiscardDiagnostic discard =
                              (CheckDiscardDiagnostic) diagnostics.getWarnings().get(0);
                          // The discard error should report one error for A.toString.
                          assertEquals(
                              discard.getDiagnosticMessage(), 1, discard.getNumberOfFailures());
                          assertThat(
                              discard,
                              diagnosticMessage(containsString("A.toString() was not discarded")));
                        })
                    .run(parameters.getRuntime(), TestClass.class)
                    .assertSuccessWithOutput(EXPECTED)
                    .inspect(this::checkOutput));
  }

  @Test
  public void testLegacyR8() throws Throwable {
    assumeTrue(parameters.isR8() && !parameters.isCurrentR8());
    assertTrue(parameters.isLegacyR8());
    try {
      testForKeepAnno(parameters)
          .enableNativeInterpretation()
          .addProgramClasses(getInputClasses())
          .addKeepMainRule(TestClass.class)
          .run(TestClass.class);
    } catch (AssertionError e) {
      assertThat(
          e.getMessage(),
          allOf(
              containsString("Discard checks failed"),
              containsString("A.toString() was not discarded")));
      return;
    }
    fail("Expected compile failure");
  }

  public List<Class<?>> getInputClasses() {
    return ImmutableList.of(TestClass.class, A.class, B.class);
  }

  private void checkOutput(CodeInspector inspector) {
    // A is escaping in the call println(this) and remains in the residual.
    assertThat(inspector.clazz(A.class), isPresent());
    assertThat(inspector.clazz(A.class).uniqueMethodWithOriginalName("toString"), isPresent());

    // Both foo and bar are respectively inlined and dead.
    assertThat(inspector.clazz(A.class).uniqueMethodWithOriginalName("foo"), isAbsent());
    assertThat(inspector.clazz(A.class).uniqueMethodWithOriginalName("bar"), isAbsent());

    // B is fully inlined and not in the residual program (in R8).
    assertThat(inspector.clazz(B.class), parameters.isPG() ? isPresent() : isAbsent());
  }

  static class A {

    @CheckOptimizedOut
    public void foo() {
      System.out.println(this);
    }

    @CheckOptimizedOut
    public void bar() {
      System.out.println("A.bar");
    }

    @CheckOptimizedOut
    @Override
    public String toString() {
      return "A";
    }
  }

  @CheckOptimizedOut
  static class B {

    public void baz() {
      System.out.println("B.baz");
    }
  }

  static class TestClass {

    public static void main(String[] args) throws Exception {
      new A().foo();
      new B().baz();
    }
  }
}