Fix(#2769): Modify the annotation processor in 2.x to give a warning if a plugin builder attribute does not have a public setter. #3195
Conversation
This adds setters to `@PluginBuilderAttribute` fields in setter classes that lack the corresponding public setter.
… plugin builder attribute does not have a public setter.
Generated by gradle/develocity-actions |
There was a problem hiding this comment.
Thanks for your contribution! I added some minor remarks below.
If you haven't done it already, please sign the ASF ICLA.
| import javax.tools.JavaFileObject; | ||
| import javax.tools.StandardJavaFileManager; | ||
| import javax.tools.ToolProvider; | ||
| import org.junit.Test; |
There was a problem hiding this comment.
| import org.junit.Test; | |
| import org.junit.jupiter.api.Test; |
Please use JUnit 5. Our JUnit 4 tests are being currently rewritten to JUnit 5.
When using JUnit 5, the recommended style is to make all classes and methods package-private instead of public.
| // Get the source files | ||
| Path sourceFile = Paths.get(FAKE_PLUGIN_CLASS_PATH); | ||
|
|
||
| assertThat(Files.exists(sourceFile)).isTrue(); |
There was a problem hiding this comment.
| assertThat(Files.exists(sourceFile)).isTrue(); | |
| assertThat(sourceFile).exists(); |
| } | ||
|
|
||
| @Test | ||
| public void IgnoreWarningWhenSuppressWarningsIsPresent() { |
There was a problem hiding this comment.
| public void IgnoreWarningWhenSuppressWarningsIsPresent() { | |
| public void ignoreWarningWhenSuppressWarningsIsPresent() { |
| // Get the source files | ||
| Path sourceFile = Paths.get(FAKE_PLUGIN_CLASS_PATH); | ||
| System.out.println(FAKE_PLUGIN_CLASS_PATH); | ||
| assertThat(Files.exists(sourceFile)).isTrue(); |
There was a problem hiding this comment.
| assertThat(Files.exists(sourceFile)).isTrue(); | |
| assertThat(sourceFile).exists(); |
| boolean followsNamePattern = methodName | ||
| .toLowerCase(Locale.ROOT) | ||
| .equals(String.format("set%s", fieldName.toLowerCase(Locale.ROOT))) | ||
| || methodName | ||
| .toLowerCase(Locale.ROOT) | ||
| .equals(String.format("with%s", fieldName.toLowerCase(Locale.ROOT))); | ||
|
|
||
| if (fieldName.toLowerCase(Locale.ROOT).startsWith("is")) { | ||
| followsNamePattern = methodName | ||
| .toLowerCase(Locale.ROOT) | ||
| .equals(String.format( | ||
| "set%s", | ||
| fieldName | ||
| .toLowerCase(Locale.ROOT) | ||
| .substring(2))) | ||
| || methodName | ||
| .toLowerCase(Locale.ROOT) | ||
| .equals(String.format( | ||
| "with%s", | ||
| fieldName | ||
| .toLowerCase(Locale.ROOT) | ||
| .substring(2))); | ||
| } |
There was a problem hiding this comment.
I think we could be stricter here and use a case-sensitive comparison, for example add a helper method that:
- Removes an
isprefix from the field name. - Capitalizes the first letter.
- Compares with the method name with
setorwithremoved.
| processingEnv | ||
| .getMessager() | ||
| .printMessage( | ||
| Diagnostic.Kind.WARNING, |
There was a problem hiding this comment.
I think that ERROR would be fine here.
Just make sure that the message contains a mention about the @SuppressWarnings annotation, so third-party Log4j plugin developers don't get crazy if they can not create a setter.
The following commit modifies the annotation processor in 2.x to shell out a warning if the plugin builder attribute does not have a public setter.
A
@SuppressWarnings("log4j.public.setter")attribute can be used to ignore this compilation warning incase it is a known issue.Checklist
2.xbranch if you are targeting Log4j 2; usemainotherwise./mvnw verifysucceeds (if it fails due to code formatting issues reported by Spotless, simply run./mvnw spotless:applyand retry)src/changelog/.2.x.xdirectory