src/test/java/com/android/tools/r8/keepanno/ClassAnnotatedByAnyAnnoConstraintPatternTest.java

// Copyright (c) 2024, 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.utils.codeinspector.Matchers.isAbsent;
import static com.android.tools.r8.utils.codeinspector.Matchers.isPresentAndNotRenamed;
import static com.android.tools.r8.utils.codeinspector.Matchers.isPresentAndRenamed;
import static org.hamcrest.MatcherAssert.assertThat;

import com.android.tools.r8.keepanno.annotations.AnnotationPattern;
import com.android.tools.r8.keepanno.annotations.ClassNamePattern;
import com.android.tools.r8.keepanno.annotations.KeepConstraint;
import com.android.tools.r8.keepanno.annotations.KeepItemKind;
import com.android.tools.r8.keepanno.annotations.KeepTarget;
import com.android.tools.r8.keepanno.annotations.UsedByReflection;
import com.android.tools.r8.keepanno.annotations.UsesReflection;
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.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
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 ClassAnnotatedByAnyAnnoConstraintPatternTest extends KeepAnnoTestBase {

  static final String EXPECTED = StringUtils.lines("C1: A1", "C2: A2");

  @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 {
    testForKeepAnno(parameters)
        .addProgramClasses(getInputClasses())
        .setExcludedOuterClass(getClass())
        .run(TestClass.class)
        .assertSuccessWithOutput(EXPECTED)
        .applyIf(parameters.isShrinker(), r -> r.inspect(this::checkOutput));
  }

  public List<Class<?>> getInputClasses() {
    return ImmutableList.of(
        TestClass.class,
        Reflector.class,
        A1.class,
        A2.class,
        A3.class,
        C1.class,
        C2.class,
        C3.class);
  }

  private void checkOutput(CodeInspector inspector) {
    // The class constant use will ensure the annotations remains.
    // They are not renamed as the keep-annotation will match them (they are themselves annotated).
    assertThat(inspector.clazz(A1.class), isPresentAndNotRenamed());
    assertThat(inspector.clazz(A2.class), isPresentAndNotRenamed());
    assertThat(inspector.clazz(A3.class), isPresentAndNotRenamed());
    // The first two classes are annotated so the keep-annotation applies and retains their name.
    assertThat(inspector.clazz(C1.class), isPresentAndNotRenamed());
    assertThat(inspector.clazz(C2.class), isPresentAndNotRenamed());
    // The last class will remain due to the class constant, but it is optimized/renamed.
    assertThat(inspector.clazz(C3.class), isPresentAndRenamed());
    // The class-retention annotation should not be present on the class as the pattern defaults
    // to only match runtime retention classes.
    assertThat(inspector.clazz(C2.class).annotation(A3.class), isAbsent());
  }

  @Target(ElementType.TYPE)
  @Retention(RetentionPolicy.RUNTIME)
  @interface A1 {}

  @Target(ElementType.TYPE)
  @Retention(RetentionPolicy.RUNTIME)
  @interface A2 {}

  @Target(ElementType.TYPE)
  @Retention(RetentionPolicy.CLASS)
  @interface A3 {}

  static class Reflector {

    @UsesReflection({
      @KeepTarget(
          classAnnotatedByClassNamePattern = @ClassNamePattern,
          constraints = {KeepConstraint.NAME},
          constrainAnnotations = @AnnotationPattern),
    })
    public void foo(Class<?>... classes) throws Exception {
      for (Class<?> clazz : classes) {
        if (clazz.getAnnotations().length > 0) {
          String typeName = clazz.getTypeName();
          System.out.print(typeName.substring(typeName.lastIndexOf('$') + 1) + ":");
          if (clazz.isAnnotationPresent(A1.class)) {
            System.out.print(" A1");
          }
          if (clazz.isAnnotationPresent(A2.class)) {
            System.out.print(" A2");
          }
          if (clazz.isAnnotationPresent(A3.class)) {
            System.out.print(" A3");
          }
          System.out.println();
        }
      }
    }
  }

  @A1
  static class C1 {}

  @A2
  @A3
  static class C2 {}

  static class C3 {}

  static class TestClass {

    @UsedByReflection(kind = KeepItemKind.CLASS_AND_METHODS)
    public static void main(String[] args) throws Exception {
      new Reflector().foo(C1.class, C2.class, C3.class);
    }
  }
}