Make BugPattern{,Test}Extractor tests more maintainable
#937
Conversation
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed. |
| static BugPatternDocumentation create( | ||
| URI source, | ||
| String fullyQualifiedName, | ||
| String name, | ||
| ImmutableList<String> altNames, | ||
| String link, | ||
| ImmutableList<String> tags, | ||
| String summary, | ||
| String explanation, | ||
| SeverityLevel severityLevel, | ||
| boolean canDisable, | ||
| ImmutableList<String> suppressionAnnotations) { | ||
| return new AutoValue_BugPatternExtractor_BugPatternDocumentation( | ||
| source, | ||
| fullyQualifiedName, | ||
| name, | ||
| altNames, | ||
| link, | ||
| tags, | ||
| summary, | ||
| explanation, | ||
| severityLevel, | ||
| canDisable, | ||
| suppressionAnnotations); | ||
| } |
There was a problem hiding this comment.
This is boilerplate, but Error Prone flags new AutoValue_BugPatternExtractor_BugPatternDocumentation (and similar) calls outside the class in which the immutable type is defined.
| /** | ||
| * Utility class that offers mutually consistent JSON serialization and deserialization operations, | ||
| * without further specifying the exact schema used. | ||
| */ | ||
| final class Json { | ||
| private static final ObjectMapper OBJECT_MAPPER = | ||
| new ObjectMapper() | ||
| .setVisibility(PropertyAccessor.FIELD, Visibility.ANY) | ||
| .registerModules(new GuavaModule(), new ParameterNamesModule()); |
There was a problem hiding this comment.
This logic is moved to a separate class, not only because the tests use it, but also because other yet-to-backported code relies on it.
| BugPatternDocumentation.create( | ||
| URI.create("file:///MinimalBugChecker.java"), | ||
| "pkg.MinimalBugChecker", | ||
| "MinimalBugChecker", | ||
| ImmutableList.of(), | ||
| "", | ||
| ImmutableList.of(), | ||
| "MinimalBugChecker summary", | ||
| "", | ||
| ERROR, | ||
| /* canDisable= */ true, | ||
| ImmutableList.of(SuppressWarnings.class.getCanonicalName()))); |
There was a problem hiding this comment.
Here and below: these objects replace the JSON resource files.
...entation-support/src/main/java/tech/picnic/errorprone/documentation/BugPatternExtractor.java
Show resolved
Hide resolved
There was a problem hiding this comment.
Tnx for the quick review @mohamedsamehsalah! 🚀
I added one more commit, as I forgot to include a test class.
...entation-support/src/main/java/tech/picnic/errorprone/documentation/BugPatternExtractor.java
Show resolved
Hide resolved
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed. |
Stephan202
added
the
chore
| } | ||
|
|
||
| @FormatMethod | ||
| private static UncheckedIOException failure(IOException cause, String format, Object... args) { |
There was a problem hiding this comment.
Would it make sense to have the same ordering as creating the exception, so having cause last?
There was a problem hiding this comment.
Well, Java requires that the varargs argument is last (to avoid ambiguity). :)
There was a problem hiding this comment.
😂 oh ofcourse, forgot that. Let's merge!
As we're moving to a Java-based website generator located in the same package as the `Extractor` implementations, there is no need to validate the exact format of generated files; only that the data can be deserialized again. While there, track the source file from which data is extracted.
rickie
force-pushed
the
sschroevers/bugpattern-data-extrator-improvements
branch
from
56833db
to
9a0ad2b
Compare
|
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed. |
These change are backported from the
websitebranch.Suggested commit message: