src/test/java/com/android/tools/r8/benchmarks/appdumps/ChromeBenchmarks.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.benchmarks.appdumps;

import com.android.tools.r8.R8FullTestBuilder;
import com.android.tools.r8.R8PartialTestBuilder;
import com.android.tools.r8.R8PartialTestCompileResult;
import com.android.tools.r8.TestDiagnosticMessages;
import com.android.tools.r8.TestParameters;
import com.android.tools.r8.ToolHelper;
import com.android.tools.r8.Version;
import com.android.tools.r8.benchmarks.BenchmarkBase;
import com.android.tools.r8.benchmarks.BenchmarkConfig;
import com.android.tools.r8.utils.LibraryProvidedProguardRulesTestUtils;
import com.android.tools.r8.utils.timing.Timing;
import com.google.common.collect.ImmutableList;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.List;
import org.junit.Ignore;
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 ChromeBenchmarks extends BenchmarkBase {

  private static final Path dir = Paths.get(ToolHelper.THIRD_PARTY_DIR, "opensource-apps/chrome");

  public ChromeBenchmarks(BenchmarkConfig config, TestParameters parameters) {
    super(config, parameters);
  }

  @Parameters(name = "{0}")
  public static List<Object[]> data() {
    return parametersFromConfigs(configs());
  }

  public static List<BenchmarkConfig> configs() {
    return ImmutableList.of(
        AppDumpBenchmarkBuilder.builder()
            .setName("ChromeApp")
            .setDumpDependencyPath(dir)
            .setFromRevision(16457)
            .buildR8(ChromeBenchmarks::configure),
        AppDumpBenchmarkBuilder.builder()
            .setName("ChromeAppPartial")
            .setDumpDependencyPath(dir)
            .setFromRevision(16457)
            .buildR8WithPartialShrinking(
                ChromeBenchmarks::configurePartial, ChromeBenchmarks::inspectPartial),
        AppDumpBenchmarkBuilder.builder()
            .setName("ChromeAppTreeShaking")
            .setDumpDependencyPath(dir)
            .setFromRevision(16457)
            .setRuntimeOnly()
            .buildR8(ChromeBenchmarks::configureTreeShaking));
  }

  private static void configure(R8FullTestBuilder testBuilder) {
    testBuilder
        .addDontWarn("android.adservices.common.AdServicesOutcomeReceiver")
        .addOptionsModification(
            options -> options.getOpenClosedInterfacesOptions().suppressAllOpenInterfaces())
        .allowDiagnosticMessages()
        .allowUnusedDontWarnPatterns()
        .allowUnusedProguardConfigurationRules()
        .allowUnnecessaryDontWarnWildcards();
  }

  private static void configurePartial(R8PartialTestBuilder testBuilder) {
    testBuilder
        .addDontWarn("android.adservices.common.AdServicesOutcomeReceiver")
        .allowDiagnosticMessages()
        .allowUnusedDontWarnPatterns()
        .allowUnusedProguardConfigurationRules()
        .allowUnnecessaryDontWarnWildcards();
  }

  private static void configureTreeShaking(R8FullTestBuilder testBuilder) {
    configure(testBuilder);
    testBuilder.addOptionsModification(
        options ->
            options.getTestingOptions().enqueuerInspector =
                (appInfo, enqueuerMode) -> {
                  if (appInfo.options().printTimes) {
                    Timing timing = appInfo.app().timing;
                    timing.end(); // End "Create result"
                    timing.end(); // End "Trace application"
                    timing.end(); // End "Enqueuer"
                    timing.end(); // End "Strip unused code"
                    timing.report(); // Report "R8 main"
                  }
                  throw new AbortBenchmarkException();
                });
  }

  private static void inspectPartial(R8PartialTestCompileResult compileResult) {
    compileResult.inspectDiagnosticMessages(
        diagnostics ->
            diagnostics
                .applyIf(
                    Version.isMainVersion(),
                    d ->
                        d.assertWarningsMatch(
                            LibraryProvidedProguardRulesTestUtils.getDiagnosticMatcher()),
                    TestDiagnosticMessages::assertNoWarnings)
                .assertNoErrors());
  }

  @Ignore
  @Test
  @Override
  public void testBenchmarks() throws Exception {
    super.testBenchmarks();
  }

  @Test
  public void testChromeApp() throws Exception {
    testBenchmarkWithName("ChromeApp");
  }

  @Test
  public void testChromeAppPartial() throws Exception {
    testBenchmarkWithName("ChromeAppPartial");
  }

  @Test
  public void testChromeTreeShaking() throws Exception {
    testBenchmarkWithName("ChromeTreeShaking");
  }
}