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

import static com.android.tools.r8.DiagnosticsMatcher.diagnosticMessage;
import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;

import com.android.tools.r8.LibraryDesugaringTestConfiguration;
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.ToolHelper;
import com.android.tools.r8.Version;
import com.android.tools.r8.androidresources.AndroidResourceTestingUtils.AndroidTestResource;
import com.android.tools.r8.androidresources.AndroidResourceTestingUtils.AndroidTestResourceBuilder;
import com.android.tools.r8.desugar.desugaredlibrary.test.LibraryDesugaringSpecification;
import com.android.tools.r8.profile.art.model.ExternalArtProfile;
import com.android.tools.r8.references.ClassReference;
import com.android.tools.r8.references.Reference;
import com.android.tools.r8.startup.profile.ExternalStartupClass;
import com.android.tools.r8.startup.profile.ExternalStartupItem;
import com.android.tools.r8.startup.utils.StartupTestingUtils;
import com.google.common.collect.ImmutableList;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;
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 R8BuildMetadataTest extends TestBase {

  @Parameter(0)
  public TestParameters parameters;

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

  @Test
  public void test() throws Exception {
    ClassReference mainReference = Reference.classFromClass(Main.class);
    List<ExternalStartupItem> startupProfile =
        ImmutableList.of(ExternalStartupClass.builder().setClassReference(mainReference).build());
    R8BuildMetadata buildMetadata =
        testForR8(parameters.getBackend())
            .addProgramClasses(Main.class, PostStartup.class)
            .addKeepMainRule(Main.class)
            .addArtProfileForRewriting(
                ExternalArtProfile.builder().addClassRule(mainReference).build())
            .applyIf(
                parameters.isDexRuntime(),
                testBuilder ->
                    testBuilder
                        .addLibraryFiles(ToolHelper.getMostRecentAndroidJar())
                        .addAndroidResources(getTestResources())
                        .addFeatureSplit(FeatureSplitMain.class)
                        .addKeepMainRule(FeatureSplitMain.class)
                        .apply(StartupTestingUtils.addStartupProfile(startupProfile))
                        .enableCoreLibraryDesugaring(
                            LibraryDesugaringTestConfiguration.forSpecification(
                                LibraryDesugaringSpecification.JDK11.getSpecification()))
                        .enableIsolatedSplits(true)
                        .enableOptimizedShrinking())
            .allowDiagnosticInfoMessages(parameters.canUseNativeMultidex())
            .collectBuildMetadata()
            .enableInliningAnnotations()
            .setMinApi(parameters)
            .compileWithExpectedDiagnostics(
                diagnostics -> {
                  if (parameters.canUseNativeMultidex()) {
                    diagnostics.assertInfosMatch(
                        diagnosticMessage(containsString("Startup DEX files contains")));
                  } else {
                    diagnostics.assertNoMessages();
                  }
                })
            .getBuildMetadata();
    String json = buildMetadata.toJson();
    System.out.println(json);
    // Inspecting the exact contents is not important here, but it *is* important to test that the
    // property names are unobfuscated when testing with R8lib (!).
    assertThat(json, containsString("\"version\":\"" + Version.LABEL + "\""));
    buildMetadata = R8BuildMetadata.fromJson(json);
    inspectDeserializedBuildMetadata(buildMetadata);
  }

  private AndroidTestResource getTestResources() throws IOException {
    return new AndroidTestResourceBuilder().withSimpleManifestAndAppNameString().build(temp);
  }

  private void inspectDeserializedBuildMetadata(R8BuildMetadata buildMetadata) {
    // Baseline profile rewriting metadata.
    assertNotNull(buildMetadata.getBaselineProfileRewritingMetadata());
    // Compilation metadata.
    assertNotNull(buildMetadata.getCompilationMetadata());
    // Dex files metadata.
    if (parameters.isDexRuntime()) {
      boolean isDexLayoutOptimizationEnabled = parameters.canUseNativeMultidex();
      assertEquals(
          isDexLayoutOptimizationEnabled ? 2 : 1, buildMetadata.getDexFilesMetadata().size());
      R8DexFileMetadata firstDexFileMetadata = buildMetadata.getDexFilesMetadata().get(0);
      assertNotNull(firstDexFileMetadata.getChecksum());
      assertEquals(isDexLayoutOptimizationEnabled, firstDexFileMetadata.isStartup());
      if (isDexLayoutOptimizationEnabled) {
        R8DexFileMetadata secondDexFileMetadata = buildMetadata.getDexFilesMetadata().get(1);
        assertNotNull(secondDexFileMetadata.getChecksum());
        assertFalse(secondDexFileMetadata.isStartup());
      }
    } else {
      assertNull(buildMetadata.getDexFilesMetadata());
    }
    // Feature splits metadata.
    R8FeatureSplitsMetadata featureSplitsMetadata = buildMetadata.getFeatureSplitsMetadata();
    if (parameters.isDexRuntime()) {
      assertNotNull(featureSplitsMetadata);
      assertTrue(featureSplitsMetadata.isIsolatedSplitsEnabled());
      assertEquals(1, featureSplitsMetadata.getFeatureSplits().size());
      R8FeatureSplitMetadata featureSplitMetadata = featureSplitsMetadata.getFeatureSplits().get(0);
      assertNotNull(featureSplitMetadata);
      assertEquals(1, featureSplitMetadata.getDexFilesMetadata().size());
      R8DexFileMetadata featureSplitDexFile = featureSplitMetadata.getDexFilesMetadata().get(0);
      assertNotNull(featureSplitDexFile);
      assertNotNull(featureSplitDexFile.getChecksum());
      assertFalse(featureSplitDexFile.isStartup());
    } else {
      assertNull(featureSplitsMetadata);
    }
    // Options metadata.
    assertNotNull(buildMetadata.getOptionsMetadata());
    assertNotNull(buildMetadata.getOptionsMetadata().getKeepAttributesMetadata());
    assertEquals(
        parameters.isCfRuntime() ? null : Integer.toString(parameters.getApiLevel().getLevel()),
        buildMetadata.getOptionsMetadata().getMinApiLevel());
    assertFalse(buildMetadata.getOptionsMetadata().isDebugModeEnabled());
    // Options metadata (library desugaring).
    R8LibraryDesugaringMetadata libraryDesugaringMetadata =
        buildMetadata.getOptionsMetadata().getLibraryDesugaringMetadata();
    if (parameters.isDexRuntime()) {
      assertNotNull(libraryDesugaringMetadata);
      assertEquals(
          "com.tools.android:desugar_jdk_libs_configuration:2.1.4",
          libraryDesugaringMetadata.getIdentifier());
    } else {
      assertNull(libraryDesugaringMetadata);
    }
    // Resource optimization metadata.
    if (parameters.isDexRuntime()) {
      R8ResourceOptimizationMetadata resourceOptimizationMetadata =
          buildMetadata.getResourceOptimizationMetadata();
      assertNotNull(resourceOptimizationMetadata);
      assertTrue(resourceOptimizationMetadata.isOptimizedShrinkingEnabled());
    } else {
      assertNull(buildMetadata.getResourceOptimizationMetadata());
    }
    // Startup optimization metadata.
    R8StartupOptimizationMetadata startupOptimizationOptions =
        buildMetadata.getStartupOptizationOptions();
    if (parameters.isDexRuntime()) {
      assertNotNull(startupOptimizationOptions);
    } else {
      assertNull(startupOptimizationOptions);
    }
    // Stats metadata.
    assertNotNull(buildMetadata.getStatsMetadata());
    // Version metadata.
    assertEquals(Version.LABEL, buildMetadata.getVersion());
  }

  static class Main {

    public static void main(String[] args) {
      testStream(args);
      PostStartup.onEvent();
    }

    static void testStream(String[] args) {
      List<String> stringList = Arrays.asList(args);
      List<Integer> integerList =
          stringList.stream().map(Integer::parseInt).collect(Collectors.toList());
      System.out.println(integerList.size());
    }
  }

  static class PostStartup {

    @NeverInline
    public static void onEvent() {
      System.out.println("PostStartup.onEvent");
    }
  }

  static class FeatureSplitMain {

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