Skip to content

Change diagnostic repr underline style #253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 14, 2023
Merged

Change diagnostic repr underline style #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 67 additions & 54 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,60 @@ Full JUnit5 integration is provided to help streamline the development process.
**This module is still under development.** Any contributions or feedback
are always welcome!

## Features

- Implements in-memory file management compatible with the NIO Path and
FileSystem API, enabling tests to run without write access to the host
system, and without awkward resource-cleanup logic.
- Ability to run compilation on combinations of real files, class path
resources, and in-memory files.
- Supports Java 9 JPMS modules as intended.
- Ability to customise a large assortment of configuration parameters
to enable you to test exactly what you need to test.
- Provides support for `javac` out of the box, with the
ability to support other JSR-199 implementations if desired --
just make use of one of the compiler classes, or make your own!
- Implements a fully functional JSR-199 Path JavaFileManager.
- Fluent syntax for creating configurations, executing them, and
inspecting the results.
- Integration with AssertJ for fluent assertions on compilation
results.
- Ability to have multiple source roots, just like when using
`javac` normally.
- Diagnostic reporting includes stacktraces, so you can find out
exactly what triggered a diagnostic and begin debugging any
issues in your applications quickly.
- Helpful error messages to assist in annotation processor development

```
[main] ERROR io.github.ascopes.jct.diagnostics.TracingDiagnosticListener - cannot find symbol
symbol: class Generated
location: package javax.annotation
[main] INFO io.github.ascopes.jct.compilers.CompilationFactory - Compilation with compiler Javac 9 failed after ~332.3ms

java.lang.AssertionError: Expected a successful compilation, but it failed.

Diagnostics:

- [ERROR] compiler.err.cant.resolve.location /sources-f1728706-5de5-4b89-9a6a-b51233ce67c8/io/github/ascopes/jct/examples/immutables/dataclass/ImmutableAnimal.java (at line 25, col 18)

23 | @SuppressWarnings({"all"})
24 | @ParametersAreNonnullByDefault
25 | @javax.annotation.Generated("org.immutables.processor.ProxyProcessor")
+ ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^
26 | @Immutable
27 | @CheckReturnValue

cannot find symbol
symbol: class Generated
location: package javax.annotation

at io.github.ascopes.jct.acceptancetests.immutables.ImmutablesIntegrationTest.immutablesValueProducesTheExpectedClass(ImmutablesIntegrationTest.java:66)
at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:104)
at java.base/java.lang.reflect.Method.invoke(Method.java:577)
...
```

## Installation

The project can be found on Maven Central.
Expand All @@ -63,6 +117,19 @@ dependencies {
}
```

## JPMS

If your tests make use of JPMS (i.e. they have a `module-info.java` somewhere), then you will want
to add a requirement for this module like so:

```java
open module my.tests {
...
requires io.github.ascopes.jct;
...
}
```

## Examples

### In-memory code, using RAM disks for source directories
Expand Down Expand Up @@ -234,60 +301,6 @@ class ExampleTest {
}
```

## Features

- Implements in-memory file management compatible with the NIO Path and
FileSystem API, enabling tests to run without write access to the host
system, and without awkward resource-cleanup logic.
- Ability to run compilation on combinations of real files, class path
resources, and in-memory files.
- Supports Java 9 JPMS modules as intended.
- Ability to customise a large assortment of configuration parameters
to enable you to test exactly what you need to test.
- Provides support for `javac` out of the box, with the
ability to support other JSR-199 implementations if desired --
just make use of one of the compiler classes, or make your own!
- Implements a fully functional JSR-199 Path JavaFileManager.
- Fluent syntax for creating configurations, executing them, and
inspecting the results.
- Integration with AssertJ for fluent assertions on compilation
results.
- Ability to have multiple source roots, just like when using
`javac` normally.
- Diagnostic reporting includes stacktraces, so you can find out
exactly what triggered a diagnostic and begin debugging any
issues in your applications quickly.
- Helpful error messages to assist in annotation processor development

```
[main] ERROR io.github.ascopes.jct.diagnostics.TracingDiagnosticListener - cannot find symbol
symbol: class Generated
location: package javax.annotation
[main] INFO io.github.ascopes.jct.compilers.CompilationFactory - Compilation with compiler Javac 9 failed after ~332.3ms

java.lang.AssertionError: Expected a successful compilation, but it failed.

Diagnostics:

- [ERROR] compiler.err.cant.resolve.location /sources-f1728706-5de5-4b89-9a6a-b51233ce67c8/io/github/ascopes/jct/examples/immutables/dataclass/ImmutableAnimal.java (at line 25, col 18)

23 | @SuppressWarnings({"all"})
24 | @ParametersAreNonnullByDefault
25 | @javax.annotation.Generated("org.immutables.processor.ProxyProcessor")
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
26 | @Immutable
27 | @CheckReturnValue

cannot find symbol
symbol: class Generated
location: package javax.annotation

at io.github.ascopes.jct.acceptancetests.immutables.ImmutablesIntegrationTest.immutablesValueProducesTheExpectedClass(ImmutablesIntegrationTest.java:66)
at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:104)
at java.base/java.lang.reflect.Method.invoke(Method.java:577)
...
```

## ECJ support

While this module initially supported ECJ, there were a number of problems relating to bugs
Expand Down
11 changes: 9 additions & 2 deletions ...piler-testing/src/main/java/io/github/ascopes/jct/repr/TraceDiagnosticRepresentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,8 +260,15 @@ private void appendPossibleUnderline(StringBuilder builder, int startOfLine, int
.append(" ".repeat(lineNumberWidth))
.append(" + ");

for (int i = startOfLine; i < Math.min(endOfLine, endOffset); ++i) {
builder.append(startOffset <= i ? '^' : ' ');
var endIndex = Math.min(endOfLine, endOffset);
for (int i = startOfLine; i < endIndex; ++i) {
if (i < startOffset) {
builder.append(' ');
} else if (i == startOffset || i == endOffset - 1) {
builder.append('^');
} else {
builder.append('~');
}
}

builder.append('\n');
Expand Down
26 changes: 13 additions & 13 deletions ...rc/test/java/io/github/ascopes/jct/tests/unit/repr/TraceDiagnosticRepresentationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@
* @author Ashley Scopes
*/
@DisplayName("TraceDiagnosticRepresentation tests")
@SuppressWarnings("NullableProblems")
class TraceDiagnosticRepresentationTest {

@TempDir
Expand Down Expand Up @@ -132,7 +131,7 @@ void toStringOfTraceDiagnosticRendersTheDiagnosticWhenFileContentsArePresentViaG
" 4 | ",
" 5 | public class HelloWorld {",
" 6 | public static int main(String[] args) throws Throwable {",
" + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^",
" + ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^",
" 7 | var scanner = new Scanner(System.in);",
" 8 | System.out.print(\"What is your name? \");",
"",
Expand Down Expand Up @@ -184,7 +183,7 @@ void toStringOfTraceDiagnosticRendersTheDiagnosticWhenFileContentsArePresentViaO
" 4 | ",
" 5 | public class HelloWorld {",
" 6 | public static int main(String[] args) throws Throwable {",
" + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^",
" + ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^",
" 7 | var scanner = new Scanner(System.in);",
" 8 | System.out.print(\"What is your name? \");",
"",
Expand Down Expand Up @@ -236,7 +235,7 @@ void toStringOfTraceDiagnosticRendersDiagnosticWhenGetCharContentReturnsNullViaO
" 4 | ",
" 5 | public class HelloWorld {",
" 6 | public static int main(String[] args) throws Throwable {",
" + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^",
" + ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^",
" 7 | var scanner = new Scanner(System.in);",
" 8 | System.out.print(\"What is your name? \");",
"",
Expand Down Expand Up @@ -327,9 +326,9 @@ void toStringOfRendersMultilineSnippetsCorrectly() {
" 4 | ",
" 5 | public class HelloWorld {",
" 6 | public static int main(String[] args) throws Throwable {",
" + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^",
" + ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~",
" 7 | var scanner = new Scanner(System.in);",
" + ^^^^^^^^^^^^^^^",
" + ~~~~~~~~~~~~~~^",
" 8 | System.out.print(\"What is your name? \");",
" 9 | var name = scanner.nextLine();",
"",
Expand Down Expand Up @@ -373,25 +372,26 @@ void toStringOfRendersMultilineSnippetsCorrectlyWithErroneousEndPositions() {
" 4 | ",
" 5 | public class HelloWorld {",
" 6 | public static int main(String[] args) throws Throwable {",
" + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^",
" + ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~",
" 7 | var scanner = new Scanner(System.in);",
" + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^",
" + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~",
" 8 | System.out.print(\"What is your name? \");",
" + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^",
" + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~",
" 9 | var name = scanner.nextLine();",
" + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^",
" + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~",
" 10 | System.out.printf(\"Hello, %s!\", name);",
" + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^",
" + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~",
" 11 | }",
" + ^^^",
" + ~~~",
" 12 | }",
" + ^",
" + ~",
"",
" Entrypoint must be a void method."
);
}

@DisplayName("toStringOf(TraceDiagnostic) renders the diagnostic when source is not present")
@SuppressWarnings("DataFlowIssue")
@Test
void toStringOfTraceDiagnosticRendersTheDiagnosticWhenSourceIsNotPresent() {
// Given
Expand Down