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

import static junit.framework.TestCase.assertEquals;
import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.Assert.assertThrows;
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.DiagnosticsMatcher;
import com.android.tools.r8.TestBase;
import com.android.tools.r8.TestDiagnosticMessagesImpl;
import com.android.tools.r8.TestParameters;
import com.android.tools.r8.ToolHelper;
import com.android.tools.r8.ToolHelper.ProcessResult;
import com.android.tools.r8.retrace.internal.RetraceAbortException;
import com.android.tools.r8.retrace.stacktraces.ActualBotStackTraceBase;
import com.android.tools.r8.retrace.stacktraces.ActualIdentityStackTrace;
import com.android.tools.r8.retrace.stacktraces.ActualRetraceBotStackTrace;
import com.android.tools.r8.retrace.stacktraces.AmbiguousMethodVerboseStackTrace;
import com.android.tools.r8.retrace.stacktraces.AmbiguousMissingLineStackTrace;
import com.android.tools.r8.retrace.stacktraces.AmbiguousStackTrace;
import com.android.tools.r8.retrace.stacktraces.AmbiguousWithMultipleLineMappingsStackTrace;
import com.android.tools.r8.retrace.stacktraces.AmbiguousWithSignatureStackTrace;
import com.android.tools.r8.retrace.stacktraces.AutoStackTrace;
import com.android.tools.r8.retrace.stacktraces.CircularReferenceStackTrace;
import com.android.tools.r8.retrace.stacktraces.ClassWithDashStackTrace;
import com.android.tools.r8.retrace.stacktraces.ColonInFileNameStackTrace;
import com.android.tools.r8.retrace.stacktraces.DifferentLineNumberSpanStackTrace;
import com.android.tools.r8.retrace.stacktraces.FileNameExtensionStackTrace;
import com.android.tools.r8.retrace.stacktraces.FoundMethodVerboseStackTrace;
import com.android.tools.r8.retrace.stacktraces.IdentityMappingStackTrace;
import com.android.tools.r8.retrace.stacktraces.InlineFileNameStackTrace;
import com.android.tools.r8.retrace.stacktraces.InlineFileNameWithInnerClassesStackTrace;
import com.android.tools.r8.retrace.stacktraces.InlineInOutlineStackTrace;
import com.android.tools.r8.retrace.stacktraces.InlineNoLineAssumeNoInlineAmbiguousStackTrace;
import com.android.tools.r8.retrace.stacktraces.InlineNoLineNumberAssumeNoInlineStackTrace;
import com.android.tools.r8.retrace.stacktraces.InlineNoLineNumberStackTrace;
import com.android.tools.r8.retrace.stacktraces.InlineNoLineWithBaseEntryNumberAssumeNoInlineStackTrace;
import com.android.tools.r8.retrace.stacktraces.InlinePreambleNoOriginalStackTrace;
import com.android.tools.r8.retrace.stacktraces.InlineSourceFileContextStackTrace;
import com.android.tools.r8.retrace.stacktraces.InlineSourceFileStackTrace;
import com.android.tools.r8.retrace.stacktraces.InlineWithLineNumbersStackTrace;
import com.android.tools.r8.retrace.stacktraces.InvalidMinifiedRangeStackTrace;
import com.android.tools.r8.retrace.stacktraces.InvalidOriginalRangeStackTrace;
import com.android.tools.r8.retrace.stacktraces.InvalidStackTrace;
import com.android.tools.r8.retrace.stacktraces.MapVersionWarningStackTrace;
import com.android.tools.r8.retrace.stacktraces.MemberFieldOverlapStackTrace;
import com.android.tools.r8.retrace.stacktraces.MovedSynthetizedInfoStackTraceTest;
import com.android.tools.r8.retrace.stacktraces.MultipleDotsInFileNameStackTrace;
import com.android.tools.r8.retrace.stacktraces.MultipleLinesNoLineNumberStackTrace;
import com.android.tools.r8.retrace.stacktraces.MultipleMapVersionsWarningStackTrace;
import com.android.tools.r8.retrace.stacktraces.MultipleOriginalLinesNoLineNumberStackTrace;
import com.android.tools.r8.retrace.stacktraces.NamedModuleStackTrace;
import com.android.tools.r8.retrace.stacktraces.NoObfuscatedLineNumberWithOverrideTest;
import com.android.tools.r8.retrace.stacktraces.NoObfuscationRangeMappingWithStackTrace;
import com.android.tools.r8.retrace.stacktraces.NpeInlineRetraceStackTrace;
import com.android.tools.r8.retrace.stacktraces.NullStackTrace;
import com.android.tools.r8.retrace.stacktraces.ObfucatedExceptionClassStackTrace;
import com.android.tools.r8.retrace.stacktraces.ObfuscatedRangeToSingleLineStackTrace;
import com.android.tools.r8.retrace.stacktraces.OutlineInOutlineStackTrace;
import com.android.tools.r8.retrace.stacktraces.OutlineSimpleStackTrace;
import com.android.tools.r8.retrace.stacktraces.OutlineWithInliningStackTrace;
import com.android.tools.r8.retrace.stacktraces.OutsideLineRangeStackTraceTest;
import com.android.tools.r8.retrace.stacktraces.OverloadSameLineTest;
import com.android.tools.r8.retrace.stacktraces.OverloadedWithAndWithoutRangeStackTrace;
import com.android.tools.r8.retrace.stacktraces.PreambleLineNumberStackTrace;
import com.android.tools.r8.retrace.stacktraces.RetraceAssertionErrorStackTrace;
import com.android.tools.r8.retrace.stacktraces.SingleLineNoLineNumberStackTrace;
import com.android.tools.r8.retrace.stacktraces.SourceFileNameSynthesizeStackTrace;
import com.android.tools.r8.retrace.stacktraces.SourceFileWithNumberAndEmptyStackTrace;
import com.android.tools.r8.retrace.stacktraces.StackTraceForTest;
import com.android.tools.r8.retrace.stacktraces.SuppressedStackTrace;
import com.android.tools.r8.retrace.stacktraces.SyntheticLambdaMethodStackTrace;
import com.android.tools.r8.retrace.stacktraces.SyntheticLambdaMethodWithInliningStackTrace;
import com.android.tools.r8.retrace.stacktraces.TrailingWhitespaceStackTrace;
import com.android.tools.r8.retrace.stacktraces.UnicodeInFileNameStackTrace;
import com.android.tools.r8.retrace.stacktraces.UnknownSourceStackTrace;
import com.android.tools.r8.retrace.stacktraces.VerboseUnknownStackTrace;
import com.android.tools.r8.utils.BooleanUtils;
import com.android.tools.r8.utils.StringUtils;
import com.google.common.collect.ImmutableList;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.function.Consumer;
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 RetraceTests extends TestBase {

  @Parameters(name = "{0}, external: {1}, verbose: {2}, stream: {3}")
  public static Collection<Object[]> data() {
    return buildParameters(
        getTestParameters().withSystemRuntime().build(),
        BooleanUtils.values(),
        BooleanUtils.values(),
        BooleanUtils.values());
  }

  private final TestParameters parameters;
  private final boolean external;
  private final boolean verbose;
  private final boolean stream;

  public RetraceTests(
      TestParameters parameters, boolean external, boolean verbose, boolean stream) {
    this.parameters = parameters;
    this.external = external;
    this.verbose = verbose;
    this.stream = stream;
  }

  @Test
  public void testClassWithDashStackTrace() throws Exception {
    runRetraceTest(new ClassWithDashStackTrace());
  }

  @Test
  public void testCanMapExceptionClass() throws Exception {
    runRetraceTest(new ObfucatedExceptionClassStackTrace());
  }

  @Test
  public void testSuppressedStackTrace() throws Exception {
    runRetraceTest(new SuppressedStackTrace());
  }

  @Test
  public void testFileNameStackTrace() throws Exception {
    runRetraceTest(new FileNameExtensionStackTrace());
  }

  @Test
  public void testInlineFileNameStackTrace() throws Exception {
    runRetraceTest(new InlineFileNameStackTrace());
  }

  @Test
  public void testInlineFileNameWithInnerClassesStackTrace() throws Exception {
    runRetraceTest(new InlineFileNameWithInnerClassesStackTrace());
  }

  @Test
  public void testNoObfuscationRangeMappingWithStackTrace() throws Exception {
    runRetraceTest(new NoObfuscationRangeMappingWithStackTrace());
  }

  @Test
  public void testOverloadedWithAndWithoutRangeStackTrace() throws Exception {
    runRetraceTest(new OverloadedWithAndWithoutRangeStackTrace());
  }

  @Test
  public void testNullLineTrace() {
    TestDiagnosticMessagesImpl diagnosticsHandler = new TestDiagnosticMessagesImpl();
    NullStackTrace nullStackTrace = new NullStackTrace();
    RetraceCommand retraceCommand =
        RetraceCommand.builder(diagnosticsHandler)
            .setMappingSupplier(
                ProguardMappingSupplier.builder()
                    .setProguardMapProducer(
                        ProguardMapProducer.fromString(nullStackTrace.mapping()))
                    .build())
            .setStackTrace(nullStackTrace.obfuscatedStackTrace())
            .setRetracedStackTraceConsumer(retraced -> fail())
            .build();
    try {
      Retrace.run(retraceCommand);
    } catch (RetraceAbortException e) {
      diagnosticsHandler.assertOnlyErrors();
      diagnosticsHandler.assertErrorsCount(1);
      assertThat(
          diagnosticsHandler.getErrors().get(0).getDiagnosticMessage(),
          containsString("The stack trace line is <null>"));
    }
  }

  @Test
  public void testInvalidStackTraceLineWarnings() throws Exception {
    InvalidStackTrace invalidStackTraceTest = new InvalidStackTrace();
    runRetraceTest(invalidStackTraceTest).assertNoMessages();
  }

  @Test
  public void testAssertionErrorInRetrace() throws Exception {
    runRetraceTest(new RetraceAssertionErrorStackTrace());
  }

  @Test
  public void testActualStackTraces() throws Exception {
    List<ActualBotStackTraceBase> stackTraces =
        ImmutableList.of(new ActualIdentityStackTrace(), new ActualRetraceBotStackTrace());
    for (ActualBotStackTraceBase stackTrace : stackTraces) {
      runRetraceTest(stackTrace).assertNoWarnings();
    }
  }

  @Test
  public void testAmbiguousStackTrace() throws Exception {
    runRetraceTest(new AmbiguousStackTrace());
  }

  @Test
  public void testAmbiguousMissingLineStackTrace() throws Exception {
    runRetraceTest(new AmbiguousMissingLineStackTrace());
  }

  @Test
  public void testAmbiguousWithSignatureStackTrace() throws Exception {
    runRetraceTest(new AmbiguousWithSignatureStackTrace());
  }

  @Test
  public void testAmbiguousMultipleMappingsTest() throws Exception {
    runRetraceTest(new AmbiguousWithMultipleLineMappingsStackTrace());
  }

  @Test
  public void testInliningWithLineNumbers() throws Exception {
    runRetraceTest(new InlineWithLineNumbersStackTrace());
  }

  @Test
  public void testInliningNoLineNumberInfoStackTraces() throws Exception {
    runRetraceTest(new InlineNoLineNumberStackTrace());
  }

  @Test
  public void testInlineNoLineNumberAssumeNoInlineStackTrace() throws Exception {
    runRetraceTest(new InlineNoLineNumberAssumeNoInlineStackTrace());
  }

  @Test
  public void testInlineNoLineAssumeNoInlineAmbiguousStackTrace() throws Exception {
    runRetraceTest(new InlineNoLineAssumeNoInlineAmbiguousStackTrace());
  }

  @Test
  public void testInlinePreambleNoOriginalStackTrace() throws Exception {
    runRetraceTest(new InlinePreambleNoOriginalStackTrace());
  }

  @Test
  public void testInlineNoLineWithBaseEntryNumberAssumeNoInlineStackTrace() throws Exception {
    runRetraceTest(new InlineNoLineWithBaseEntryNumberAssumeNoInlineStackTrace());
  }

  @Test
  public void testMovedSynthetizedInfoStackTraceTest() throws Exception {
    runRetraceTest(new MovedSynthetizedInfoStackTraceTest());
  }

  @Test
  public void testCircularReferenceStackTrace() throws Exception {
    // Proguard retrace (and therefore the default regular expression) will not retrace circular
    // reference exceptions.
    assumeTrue("b/178599214", false);
    runRetraceTest(new CircularReferenceStackTrace());
  }

  @Test
  public void testObfuscatedRangeToSingleLine() throws Exception {
    runRetraceTest(new ObfuscatedRangeToSingleLineStackTrace());
  }

  @Test
  public void testBootLoaderAndNamedModulesStackTrace() throws Exception {
    assumeTrue("b/170293908", false);
    runRetraceTest(new NamedModuleStackTrace());
  }

  @Test
  public void testUnknownSourceStackTrace() throws Exception {
    runRetraceTest(new UnknownSourceStackTrace());
  }

  @Test
  public void testInlineSourceFileContext() throws Exception {
    runRetraceTest(new InlineSourceFileContextStackTrace());
  }

  @Test
  public void testInlineSourceFileStackTrace() throws Exception {
    runRetraceTest(new InlineSourceFileStackTrace());
  }

  @Test
  public void testColonInSourceFileNameStackTrace() throws Exception {
    runRetraceTest(new ColonInFileNameStackTrace());
  }

  @Test
  public void testMultipleDotsInFileNameStackTrace() throws Exception {
    runRetraceTest(new MultipleDotsInFileNameStackTrace());
  }

  @Test
  public void testUnicodeInFileNameStackTrace() throws Exception {
    runRetraceTest(new UnicodeInFileNameStackTrace());
  }

  @Test
  public void testMemberFieldOverlapStackTrace() throws Exception {
    MemberFieldOverlapStackTrace stackTraceForTest = new MemberFieldOverlapStackTrace();
    runRetraceTest(stackTraceForTest);
    inspectRetraceTest(stackTraceForTest, stackTraceForTest::inspectField);
  }

  @Test
  public void testSourceFileWithNumberAndEmptyStackTrace() throws Exception {
    runRetraceTest(new SourceFileWithNumberAndEmptyStackTrace());
  }

  @Test
  public void testSourceFileNameSynthesizeStackTrace() throws Exception {
    runRetraceTest(new SourceFileNameSynthesizeStackTrace());
  }

  @Test
  public void testAutoStackTrace() throws Exception {
    runRetraceTest(new AutoStackTrace());
  }

  @Test
  public void testRetraceSynthesizedLambda() throws Exception {
    runExperimentalRetraceTest(new SyntheticLambdaMethodStackTrace());
  }

  @Test
  public void testRetraceSynthesizedLambdaWithInlining() throws Exception {
    runExperimentalRetraceTest(new SyntheticLambdaMethodWithInliningStackTrace());
  }

  @Test
  public void testNoObfuscatedLineNumberWithOverrideTest() throws Exception {
    runRetraceTest(new NoObfuscatedLineNumberWithOverrideTest());
  }

  @Test
  public void testOverloadSameLineTest() throws Exception {
    runRetraceTest(new OverloadSameLineTest());
  }

  @Test
  public void testSingleLineNoLineNumberStackTrace() throws Exception {
    runRetraceTest(new SingleLineNoLineNumberStackTrace());
  }

  @Test
  public void testMultipleLinesNoLineNumberStackTrace() throws Exception {
    runRetraceTest(new MultipleLinesNoLineNumberStackTrace());
  }

  @Test
  public void testFoundMethod() throws Exception {
    runRetraceTest(new FoundMethodVerboseStackTrace());
  }

  @Test
  public void testUnknownMethod() throws Exception {
    runRetraceTest(new AmbiguousMethodVerboseStackTrace());
  }

  @Test
  public void testVerboseUnknownMethod() throws Exception {
    runRetraceTest(new VerboseUnknownStackTrace());
  }

  @Test
  public void testNpeInlineRetraceStackTrace() throws Exception {
    runExperimentalRetraceTest(new NpeInlineRetraceStackTrace());
  }

  @Test
  public void testMultipleOriginalLinesNoLineNumberStackTrace() throws Exception {
    runRetraceTest(new MultipleOriginalLinesNoLineNumberStackTrace());
  }

  @Test
  public void testDifferentLineNumberSpanStackTrace() throws Exception {
    runRetraceTest(new DifferentLineNumberSpanStackTrace());
  }

  @Test
  public void testOutlineSimpleStackTrace() throws Exception {
    runExperimentalRetraceTest(new OutlineSimpleStackTrace());
  }

  @Test
  public void testOutlineWithInliningStackTrace() throws Exception {
    runExperimentalRetraceTest(new OutlineWithInliningStackTrace());
  }

  @Test
  public void testOutlineInOutlineStackTrace() throws Exception {
    runExperimentalRetraceTest(new OutlineInOutlineStackTrace());
  }

  @Test
  public void testInlineInOutlineStackTrace() throws Exception {
    runExperimentalRetraceTest(new InlineInOutlineStackTrace());
  }

  @Test
  public void testOutsideLineRangeStackTraceTest() throws Exception {
    runRetraceTest(new OutsideLineRangeStackTraceTest());
  }

  @Test
  public void testIdentityMappingStackTrace() throws Exception {
    runRetraceTest(new IdentityMappingStackTrace());
  }

  @Test
  public void testPreambleLineNumberStackTrace() throws Exception {
    runRetraceTest(new PreambleLineNumberStackTrace());
  }

  @Test
  public void testMapVersionWarningStackTrace() throws Exception {
    // TODO(b/204289928): Internalize the diagnostics checking.
    assumeFalse(external);
    runRetraceTest(new MapVersionWarningStackTrace())
        .assertOnlyWarnings()
        .assertWarningsCount(1)
        .assertAllWarningsMatch(
            DiagnosticsMatcher.diagnosticType(RetraceUnknownMapVersionDiagnostic.class));
  }

  @Test
  public void testMultipleMapVersionWarningStackTrace() throws Exception {
    // TODO(b/204289928): Internalize the diagnostics checking.
    assumeFalse(external);
    runRetraceTest(new MultipleMapVersionsWarningStackTrace())
        .assertOnlyWarnings()
        .assertAllWarningsMatch(
            DiagnosticsMatcher.diagnosticType(RetraceUnknownMapVersionDiagnostic.class))
        .assertWarningsCount(2)
        .assertWarningsMatch(
            DiagnosticsMatcher.diagnosticMessage(containsString("98.0")),
            DiagnosticsMatcher.diagnosticMessage(containsString("99.0")));
  }

  @Test
  public void testTrailingWhitespaceStackTrace() throws Exception {
    runRetraceTest(new TrailingWhitespaceStackTrace());
  }

  @Test
  public void testInvalidMinifiedRangeStackTrace() {
    assumeFalse(external);
    assertThrows(
        InvalidMappingFileException.class,
        () -> runRetraceTest(new InvalidMinifiedRangeStackTrace()));
  }

  @Test
  public void testInvalidOriginalRangeStackTrace() {
    assumeFalse(external);
    assertThrows(
        InvalidMappingFileException.class,
        () -> runRetraceTest(new InvalidOriginalRangeStackTrace()));
  }

  private void inspectRetraceTest(
      StackTraceForTest stackTraceForTest, Consumer<Retracer> inspection) {
    inspection.accept(
        Retracer.createDefault(
            ProguardMapProducer.fromString(stackTraceForTest.mapping()),
            new TestDiagnosticMessagesImpl()));
  }

  private TestDiagnosticMessagesImpl runRetraceTest(StackTraceForTest stackTraceForTest)
      throws Exception {
    return runRetraceTest(stackTraceForTest, false);
  }

  private TestDiagnosticMessagesImpl runExperimentalRetraceTest(StackTraceForTest stackTraceForTest)
      throws Exception {
    return runRetraceTest(stackTraceForTest, true);
  }

  private TestDiagnosticMessagesImpl runRetraceTest(
      StackTraceForTest stackTraceForTest, boolean allowExperimentalMapping) throws Exception {
    String expectedStackTrace =
        StringUtils.joinLines(
            verbose
                ? stackTraceForTest.retraceVerboseStackTrace()
                : stackTraceForTest.retracedStackTrace());
    if (external) {
      assumeTrue(parameters.isCfRuntime());
      // The external dependency is built on top of R8Lib. If test.py is run with
      // no r8lib, do not try and run the external R8 Retrace since it has not been built.
      assumeTrue(ToolHelper.isTestingR8Lib());
      assertTrue(Files.exists(ToolHelper.R8LIB_JAR));
      Path path = temp.newFolder().toPath();
      Path mappingFile = path.resolve("mapping");
      Files.write(mappingFile, stackTraceForTest.mapping().getBytes());
      Path stackTraceFile = path.resolve("stacktrace.txt");
      Files.write(
          stackTraceFile,
          StringUtils.joinLines(stackTraceForTest.obfuscatedStackTrace())
              .getBytes(StandardCharsets.UTF_8));

      List<String> command = new ArrayList<>();
      command.add(parameters.getRuntime().asCf().getJavaExecutable().toString());
      command.add("-ea");
      command.add("-cp");
      command.add(ToolHelper.R8_RETRACE_JAR.toString());
      if (allowExperimentalMapping) {
        command.add("-Dcom.android.tools.r8.experimentalmapping");
      }
      command.add("com.android.tools.r8.retrace.Retrace");
      command.add(mappingFile.toString());
      command.add(stackTraceFile.toString());
      if (verbose) {
        command.add("-verbose");
      }
      command.add("-quiet");
      ProcessBuilder builder = new ProcessBuilder(command);
      ProcessResult processResult = ToolHelper.runProcess(builder);
      assertEquals(expectedStackTrace + StringUtils.LINE_SEPARATOR, processResult.stdout);
      // TODO(b/177204438): Parse diagnostics from stdErr
      return new TestDiagnosticMessagesImpl();
    } else {
      TestDiagnosticMessagesImpl diagnosticsHandler = new TestDiagnosticMessagesImpl();
      StringBuilder retracedStackTraceBuilder = new StringBuilder();
      RetraceCommand.Builder builder =
          RetraceCommand.builder(diagnosticsHandler)
              .setMappingSupplier(
                  ProguardMappingSupplier.builder()
                      .setProguardMapProducer(
                          ProguardMapProducer.fromString(stackTraceForTest.mapping()))
                      .setLoadAllDefinitions(!stream)
                      .setAllowExperimental(allowExperimentalMapping)
                      .build())
              .setRetracedStackTraceConsumer(
                  retraced -> {
                    if (retracedStackTraceBuilder.length() > 0) {
                      retracedStackTraceBuilder.append(StringUtils.LINE_SEPARATOR);
                    }
                    retracedStackTraceBuilder.append(StringUtils.joinLines(retraced));
                  })
              .setVerbose(verbose);
      setStacktraceSupplierAndRetraceConsumer(builder, stackTraceForTest.obfuscatedStackTrace());
      RetraceCommand retraceCommand = builder.build();
      Retrace.run(retraceCommand);
      assertEquals(expectedStackTrace, retracedStackTraceBuilder.toString());
      return diagnosticsHandler;
    }
  }

  private void setStacktraceSupplierAndRetraceConsumer(
      RetraceCommand.Builder builder, List<String> stackTrace) {
    if (stream) {
      Iterator<String> iterator = stackTrace.iterator();
      builder.setStackTrace(() -> iterator.hasNext() ? ImmutableList.of(iterator.next()) : null);
    } else {
      builder.setStackTrace(stackTrace);
    }
  }
}