src/test/java/com/android/tools/r8/shaking/keptgraph/KeptByConditionalRuleTestRunner.java

// 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.shaking.keptgraph;

import static com.android.tools.r8.references.Reference.classFromClass;
import static com.android.tools.r8.references.Reference.methodFromMethod;
import static org.junit.Assert.assertEquals;

import com.android.tools.r8.NeverInline;
import com.android.tools.r8.TestBase;
import com.android.tools.r8.TestParameters;
import com.android.tools.r8.TestParametersCollection;
import com.android.tools.r8.origin.Origin;
import com.android.tools.r8.references.ClassReference;
import com.android.tools.r8.references.MethodReference;
import com.android.tools.r8.shaking.WhyAreYouKeepingConsumer;
import com.android.tools.r8.utils.StringUtils;
import com.android.tools.r8.utils.graphinspector.GraphInspector;
import com.android.tools.r8.utils.graphinspector.GraphInspector.QueryNode;
import com.android.tools.r8.utils.graphinspector.GraphInspector.QueryNodeSet;
import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;

@RunWith(Parameterized.class)
public class KeptByConditionalRuleTestRunner extends TestBase {

  public static class TestClass {

    public static void main(String[] args) {
      bar();
    }

    @NeverInline
    static void bar() {
      System.out.println("called bar");
    }

    @NeverInline
    static void baz() {
      System.out.println("called baz");
    }
  }

  private static final Class<?> CLASS = TestClass.class;
  private static final String CLASS_NAME = CLASS.getTypeName();
  private static final String EXPECTED = StringUtils.lines("called bar");

  private static final String CONDITIONAL_KEEP_RULE =
      "-if class " + CLASS_NAME + " -keep class " + CLASS_NAME + " { static void baz(); }";

  private final String EXPECTED_WHYAREYOUKEEPING =
      StringUtils.lines(
          "void " + CLASS_NAME + ".baz()",
          "|- is referenced in keep rule:",
          "|  " + CONDITIONAL_KEEP_RULE,
          "|- is satisfied with precondition:",
          "|  " + CLASS_NAME,
          "|- is referenced in keep rule:",
          "|  -keep class " + CLASS_NAME + " { public static void main(java.lang.String[]); }");

  private final TestParameters parameters;

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

  public KeptByConditionalRuleTestRunner(TestParameters parameters) {
    this.parameters = parameters;
  }

  @Test
  public void testKeptMethod() throws Exception {
    ClassReference clazz = classFromClass(CLASS);
    MethodReference mainMethod = methodFromMethod(CLASS.getDeclaredMethod("main", String[].class));
    MethodReference barMethod = methodFromMethod(CLASS.getDeclaredMethod("bar"));
    MethodReference bazMethod = methodFromMethod(CLASS.getDeclaredMethod("baz"));

    WhyAreYouKeepingConsumer whyAreYouKeepingConsumer = new WhyAreYouKeepingConsumer(null);
    GraphInspector inspector =
        testForR8(parameters.getBackend())
            .enableGraphInspector(whyAreYouKeepingConsumer)
            .enableInliningAnnotations()
            .addProgramClasses(CLASS)
            .addKeepMainRule(CLASS)
            .addKeepRules(CONDITIONAL_KEEP_RULE)
            .setMinApi(parameters)
            .run(parameters.getRuntime(), CLASS)
            .assertSuccessWithOutput(EXPECTED)
            .graphInspector();

    // The only root should be the keep annotation rule.
    assertEquals(1, inspector.getRoots().size());
    QueryNode keepMainRule = inspector.rule(Origin.unknown(), 1, 1).assertRoot();

    // Check that the call chain goes from root -> main(unchanged) -> bar(renamed).
    inspector.method(barMethod).assertRenamed().assertInvokedFrom(mainMethod);
    inspector.method(mainMethod).assertNotRenamed().assertKeptBy(keepMainRule);

    // Check that there is exactly one if-rule instance.
    QueryNodeSet ifRuleInstances = inspector.ruleInstances(CONDITIONAL_KEEP_RULE).assertSize(1);
    ifRuleInstances.assertAnyMatch(n -> n.isSatisfiedBy(inspector.clazz(clazz)));

    // Check baz is kept by the if rule.
    QueryNode barMethodNode = inspector.method(bazMethod).assertNotRenamed();
    ifRuleInstances.assertAllMatch(barMethodNode::isKeptBy);

    ByteArrayOutputStream baos = new ByteArrayOutputStream();
    whyAreYouKeepingConsumer.printWhyAreYouKeeping(bazMethod, new PrintStream(baos));
    assertEquals(EXPECTED_WHYAREYOUKEEPING, baos.toString());
  }
}