Rework TraceDiagnosticListAssert logic, first tests for JctCompilationAssertTest

Author: ascopes

java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/JctCompilationAssert.java

@@ -19,7 +19,7 @@
 import static java.util.stream.Collectors.toUnmodifiableList;
 
 import io.github.ascopes.jct.compilers.JctCompilation;
-import io.github.ascopes.jct.repr.DiagnosticListRepresentation;
+import io.github.ascopes.jct.repr.TraceDiagnosticListRepresentation;
 import java.util.Collection;
 import javax.annotation.CheckReturnValue;
 import javax.annotation.Nullable;
@@ -100,11 +100,15 @@ public JctCompilationAssert isSuccessfulWithoutWarnings() {
   public JctCompilationAssert isFailure() {
     isNotNull();
 
+    // If we fail due to failOnWarnings, we expect the compiler itself to have failed the
+    // build because of this. If the compiler ignores this flag and succeeds, then this method will
+    // follow that behaviour and treat the compilation as a success.
+
     if (actual.isSuccessful()) {
       // If we have any warnings, we should show them in the error message as it might be useful
       // to the user.
       failWithDiagnostics(
-          DiagnosticKindAssert.WARNING_DIAGNOSTIC_KINDS,
+          DiagnosticKindAssert.WARNING_AND_ERROR_DIAGNOSTIC_KINDS,
           "Expected compilation to fail, but it succeeded."
       );
     }
@@ -317,12 +321,13 @@ private void failWithDiagnostics(
       failWithMessage(message, args);
     } else {
       var fullMessage = String.join(
-          "\n\n",
+          "\n",
           args.length > 0
               ? String.format(message, args)
               : message,
+          "",
           "Diagnostics:",
-          DiagnosticListRepresentation.getInstance().toStringOf(diagnostics)
+          TraceDiagnosticListRepresentation.getInstance().toStringOf(diagnostics)
       );
 
       failWithMessage(fullMessage);

java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/TraceDiagnosticListAssert.java

@@ -21,7 +21,7 @@
 import static java.util.function.Predicate.not;
 
 import io.github.ascopes.jct.diagnostics.TraceDiagnostic;
-import io.github.ascopes.jct.repr.DiagnosticListRepresentation;
+import io.github.ascopes.jct.repr.TraceDiagnosticListRepresentation;
 import io.github.ascopes.jct.utils.StringUtils;
 import java.util.ArrayList;
 import java.util.LinkedHashSet;
@@ -59,7 +59,7 @@ public TraceDiagnosticListAssert(
       @Nullable List<? extends TraceDiagnostic<? extends JavaFileObject>> traceDiagnostics
   ) {
     super(traceDiagnostics, TraceDiagnosticListAssert.class);
-    info.useRepresentation(DiagnosticListRepresentation.getInstance());
+    info.useRepresentation(TraceDiagnosticListRepresentation.getInstance());
   }
 
   /**
@@ -71,7 +71,7 @@ public TraceDiagnosticListAssert(
    */
   @CheckReturnValue
   public TraceDiagnosticListAssert errors() {
-    return filteringByKinds(Kind.ERROR);
+    return filteringByKinds(DiagnosticKindAssert.ERROR_DIAGNOSTIC_KINDS);
   }
 
   /**
@@ -84,7 +84,7 @@ public TraceDiagnosticListAssert errors() {
    */
   @CheckReturnValue
   public TraceDiagnosticListAssert warnings() {
-    return filteringByKinds(Kind.WARNING, Kind.MANDATORY_WARNING);
+    return filteringByKinds(DiagnosticKindAssert.WARNING_DIAGNOSTIC_KINDS);
   }
 
   /**
@@ -207,7 +207,7 @@ public TraceDiagnosticListAssert excludingKinds(Iterable<Kind> kinds) {
    * @throws AssertionError if this list is null.
    */
   public TraceDiagnosticListAssert hasNoErrors() {
-    return hasNoDiagnosticsOfKinds(Kind.ERROR);
+    return hasNoDiagnosticsOfKinds(DiagnosticKindAssert.ERROR_DIAGNOSTIC_KINDS);
   }
 
   /**
@@ -218,7 +218,7 @@ public TraceDiagnosticListAssert hasNoErrors() {
    * @throws AssertionError if this list is null.
    */
   public TraceDiagnosticListAssert hasNoErrorsOrWarnings() {
-    return hasNoDiagnosticsOfKinds(Kind.ERROR, Kind.WARNING, Kind.MANDATORY_WARNING);
+    return hasNoDiagnosticsOfKinds(DiagnosticKindAssert.WARNING_AND_ERROR_DIAGNOSTIC_KINDS);
   }
 
   /**
@@ -229,7 +229,7 @@ public TraceDiagnosticListAssert hasNoErrorsOrWarnings() {
    * @throws AssertionError if this list is null.
    */
   public TraceDiagnosticListAssert hasNoWarnings() {
-    return hasNoDiagnosticsOfKinds(Kind.WARNING, Kind.MANDATORY_WARNING);
+    return hasNoDiagnosticsOfKinds(DiagnosticKindAssert.WARNING_DIAGNOSTIC_KINDS);
   }
 
   /**
@@ -298,17 +298,30 @@ public TraceDiagnosticListAssert hasNoDiagnosticsOfKinds(Kind kind, Kind... more
   public TraceDiagnosticListAssert hasNoDiagnosticsOfKinds(Iterable<Kind> kinds) {
     requireNonNullValues(kinds, "kinds");
 
-    return filteringBy(kind(kinds))
-        .withFailMessage(() -> {
-          var allKindsString = StreamSupport.stream(kinds.spliterator(), false)
-              .map(next -> next.name().toLowerCase(Locale.ROOT).replace('_', ' '))
-              .collect(Collectors.collectingAndThen(
-                  Collectors.toUnmodifiableList(),
-                  names -> StringUtils.toWordedList(names, ", ", ", or ")
-              ));
-
-          return String.format("Expected no %s diagnostics", allKindsString);
-        });
+    var actualDiagnostics = actual
+        .stream()
+        .filter(kind(kinds))
+        .collect(Collectors.toList());
+
+    if (!actualDiagnostics.isEmpty()) {
+      var allKindsString = StreamSupport.stream(kinds.spliterator(), false)
+          .map(next -> next.name().toLowerCase(Locale.ROOT).replace('_', ' '))
+          .sorted()
+          .collect(Collectors.collectingAndThen(
+              Collectors.toUnmodifiableList(),
+              names -> StringUtils.toWordedList(names, ", ", ", or ")
+          ));
+
+      failWithActualExpectedAndMessage(
+          actualDiagnostics.size(),
+          0,
+          "Expected no %s diagnostics.\n\nDiagnostics:\n%s",
+          allKindsString,
+          TraceDiagnosticListRepresentation.getInstance().toStringOf(actualDiagnostics)
+      );
+    }
+
+    return myself;
   }
 
   /**

java-compiler-testing/src/main/java/io/github/ascopes/jct/compilers/JctCompilation.java

@@ -78,14 +78,14 @@ default boolean isFailure() {
    *
    * @return the compilation units.
    */
-  Set<? extends JavaFileObject> getCompilationUnits();
+  Set<JavaFileObject> getCompilationUnits();
 
   /**
    * Get the diagnostics that were reported by the compilation.
    *
    * @return the diagnostics
    */
-  List<? extends TraceDiagnostic<? extends JavaFileObject>> getDiagnostics();
+  List<TraceDiagnostic<JavaFileObject>> getDiagnostics();
 
   /**
    * Get the file manager that was used to store and manage files.

java-compiler-testing/src/main/java/io/github/ascopes/jct/compilers/impl/JctCompilationImpl.java

@@ -49,7 +49,7 @@ public final class JctCompilationImpl implements JctCompilation {
   private final boolean failOnWarnings;
   private final List<String> outputLines;
   private final Set<JavaFileObject> compilationUnits;
-  private final List<TraceDiagnostic<? extends JavaFileObject>> diagnostics;
+  private final List<TraceDiagnostic<JavaFileObject>> diagnostics;
   private final JctFileManager fileManager;
 
   private JctCompilationImpl(Builder builder) {
@@ -88,7 +88,7 @@ public Set<JavaFileObject> getCompilationUnits() {
   }
 
   @Override
-  public List<TraceDiagnostic<? extends JavaFileObject>> getDiagnostics() {
+  public List<TraceDiagnostic<JavaFileObject>> getDiagnostics() {
     return diagnostics;
   }
 
@@ -134,10 +134,10 @@ public static final class Builder {
     private List<String> outputLines;
 
     @Nullable
-    private Set<? extends JavaFileObject> compilationUnits;
+    private Set<JavaFileObject> compilationUnits;
 
     @Nullable
-    private List<? extends TraceDiagnostic<? extends JavaFileObject>> diagnostics;
+    private List<TraceDiagnostic<JavaFileObject>> diagnostics;
 
     @Nullable
     @WillNotClose
@@ -192,7 +192,7 @@ public Builder outputLines(List<String> outputLines) {
      * @param compilationUnits the compilation units.
      * @return this builder.
      */
-    public Builder compilationUnits(Set<? extends JavaFileObject> compilationUnits) {
+    public Builder compilationUnits(Set<JavaFileObject> compilationUnits) {
       this.compilationUnits = requireNonNull(compilationUnits, "compilationUnits");
       return this;
     }
@@ -204,7 +204,7 @@ public Builder compilationUnits(Set<? extends JavaFileObject> compilationUnits)
      * @return this builder.
      */
     public Builder diagnostics(
-        List<? extends TraceDiagnostic<? extends JavaFileObject>> diagnostics
+        List<TraceDiagnostic<JavaFileObject>> diagnostics
     ) {
       this.diagnostics = requireNonNull(diagnostics, "diagnostics");
       return this;

java-compiler-testing/src/main/java/io/github/ascopes/jct/diagnostics/TracingDiagnosticListener.java

@@ -118,7 +118,7 @@ public boolean isStackTraceReportingEnabled() {
    *
    * @return the diagnostics in a list.
    */
-  public List<TraceDiagnostic<? extends S>> getDiagnostics() {
+  public List<TraceDiagnostic<S>> getDiagnostics() {
     return List.copyOf(diagnostics);
   }
 

java-compiler-testing/src/main/java/io/github/ascopes/jct/repr/DiagnosticListRepresentation.java renamed to java-compiler-testing/src/main/java/io/github/ascopes/jct/repr/TraceDiagnosticListRepresentation.java

@@ -36,21 +36,21 @@
 @API(since = "0.0.1", status = Status.STABLE)
 @Immutable
 @ThreadSafe
-public final class DiagnosticListRepresentation implements Representation {
+public final class TraceDiagnosticListRepresentation implements Representation {
 
-  private static final DiagnosticListRepresentation INSTANCE
-      = new DiagnosticListRepresentation();
+  private static final TraceDiagnosticListRepresentation INSTANCE
+      = new TraceDiagnosticListRepresentation();
 
   /**
    * Get an instance of this diagnostic collection representation.
    *
    * @return the instance.
    */
-  public static DiagnosticListRepresentation getInstance() {
+  public static TraceDiagnosticListRepresentation getInstance() {
     return INSTANCE;
   }
 
-  private DiagnosticListRepresentation() {
+  private TraceDiagnosticListRepresentation() {
     // Nothing to see here, move along now.
   }
 
@@ -63,7 +63,7 @@ public String toStringOf(@Nullable Object object) {
     @SuppressWarnings("unchecked")
     var diagnostics = (Collection<? extends TraceDiagnostic<? extends JavaFileObject>>) object;
 
-    return diagnostics
+    return "\n" + diagnostics
         .stream()
         .map(TraceDiagnosticRepresentation.getInstance()::toStringOf)
         .map(this::indentAndBullet)

java-compiler-testing/src/test/java/io/github/ascopes/jct/tests/helpers/Fixtures.java

@@ -16,6 +16,7 @@
 package io.github.ascopes.jct.tests.helpers;
 
 import static io.github.ascopes.jct.tests.helpers.GenericMock.mockRaw;
+import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.RETURNS_DEEP_STUBS;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
@@ -35,6 +36,7 @@
 import java.nio.file.FileSystems;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.time.Instant;
 import java.util.Collection;
 import java.util.List;
 import java.util.Locale;
@@ -44,9 +46,9 @@
 import java.util.stream.Stream;
 import javax.annotation.processing.Processor;
 import javax.tools.Diagnostic;
+import javax.tools.Diagnostic.Kind;
 import javax.tools.JavaFileManager.Location;
 import javax.tools.JavaFileObject;
-import javax.tools.JavaFileObject.Kind;
 import org.mockito.quality.Strictness;
 
 /**
@@ -191,20 +193,43 @@ public static List<String> someFlags() {
    * @return the mock.
    */
   public static Diagnostic<JavaFileObject> someDiagnostic() {
-    return mockRaw(Diagnostic.class)
+    var mock = mockRaw(Diagnostic.class)
         .<Diagnostic<JavaFileObject>>upcastedTo()
-        .build();
+        .build(withSettings().strictness(Strictness.LENIENT));
+
+    createStubMethodsFor(mock);
+    return mock;
   }
 
   /**
-   * Get a tracee diagnostic mock.
+   * Get a trace diagnostic mock.
    *
    * @return the mock.
    */
+  @SuppressWarnings("deprecation")
   public static TraceDiagnostic<JavaFileObject> someTraceDiagnostic() {
-    return mockRaw(TraceDiagnostic.class)
+    var mock = mockRaw(TraceDiagnostic.class)
         .<TraceDiagnostic<JavaFileObject>>upcastedTo()
-        .build();
+        .build(withSettings().strictness(Strictness.LENIENT));
+
+    createStubMethodsFor(mock);
+    when(mock.getTimestamp()).thenReturn(Instant.now());
+    when(mock.getThreadName()).thenReturn(Thread.currentThread().getName());
+    when(mock.getThreadId()).thenReturn(Thread.currentThread().getId());
+    when(mock.getStackTrace()).thenReturn(someStackTraceList());
+    return mock;
+  }
+
+  /**
+   * Get a trace diagnostic mock.
+   *
+   * @param kind the kind of the diagnostic to create.
+   * @return the mock.
+   */
+  public static TraceDiagnostic<JavaFileObject> someTraceDiagnostic(Diagnostic.Kind kind) {
+    var mock = someTraceDiagnostic();
+    when(mock.getKind()).thenReturn(kind);
+    return mock;
   }
 
   /**
@@ -223,7 +248,7 @@ public static List<StackTraceElement> someStackTraceList() {
    *
    * @return some trace diagnostics.
    */
-  public static List<TraceDiagnostic<? extends JavaFileObject>> someTraceDiagnostics() {
+  public static List<TraceDiagnostic<JavaFileObject>> someTraceDiagnostics() {
     return Stream
         .generate(Fixtures::someTraceDiagnostic)
         .limit(someInt(3, 8))
@@ -333,7 +358,7 @@ public static JavaFileObject someJavaFileObject() {
         .strictness(Strictness.LENIENT));
 
     when(obj.getName()).thenReturn(name);
-    when(obj.getKind()).thenReturn(Kind.SOURCE);
+    when(obj.getKind()).thenReturn(JavaFileObject.Kind.SOURCE);
     return obj;
   }
 
@@ -442,6 +467,20 @@ public static <T> T oneOf(Collection<T> items) {
     }
   }
 
+  private static void createStubMethodsFor(Diagnostic<JavaFileObject> diagnostic) {
+    var col = someLong(1, 100);
+    when(diagnostic.getColumnNumber()).thenReturn(col);
+    var line = someLong(1, 2_000);
+    when(diagnostic.getLineNumber()).thenReturn(line);
+    var startPos = 1 + ((line * col) / 2) + someLong(1, 10_000);
+    when(diagnostic.getStartPosition()).thenReturn(startPos);
+    when(diagnostic.getEndPosition()).thenReturn(someLong(startPos, startPos + 10_000));
+    when(diagnostic.getPosition()).thenReturn(startPos);
+    when(diagnostic.getKind()).thenReturn(oneOf(Diagnostic.Kind.class));
+    when(diagnostic.getSource()).thenReturn(null);
+    when(diagnostic.getMessage(any())).thenReturn(someText());
+  }
+
   /**
    * A temporary file system.
    */