Visitar URL original
refactor: Replace Plexus AbstractLogEnabled with SLF4J · apache/maven-plugin-tools@23242f4 · GitHub
Skip to content

Commit 23242f4

Browse files
timtebeekTeamModerne
authored and
slawekjaranowski
committed
refactor: Replace Plexus AbstractLogEnabled with SLF4J
* refactor: Replace Plexus AbstractLogEnabled with SLF4J Use this link to re-run the recipe: https://app.moderne.io/builder/P4zH7djn6?organizationId=QXBhY2hlIE1hdmVu Co-authored-by: Moderne <team@moderne.io> * Remove calls to `enableLogging` and retain original logger name for scanner * Apply formatter and fix checkstyle violations * Fix more checkstyle violations * Apply for JavaJavadocMojoDescriptorExtractor --------- Co-authored-by: Moderne <team@moderne.io> (cherry picked from commit 301bc33)
1 parent 210ac1d commit 23242f4

9 files changed

Lines changed: 76 additions & 90 deletions

File tree

‎maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/JavaAnnotationsMojoDescriptorExtractor.java‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,15 @@
7979
import org.codehaus.plexus.archiver.UnArchiver;
8080
import org.codehaus.plexus.archiver.manager.ArchiverManager;
8181
import org.codehaus.plexus.archiver.manager.NoSuchArchiverException;
82-
import org.codehaus.plexus.logging.AbstractLogEnabled;
8382
import org.codehaus.plexus.util.StringUtils;
8483
import org.eclipse.aether.RepositorySystem;
8584
import org.eclipse.aether.artifact.DefaultArtifact;
8685
import org.eclipse.aether.resolution.ArtifactRequest;
8786
import org.eclipse.aether.resolution.ArtifactResolutionException;
8887
import org.eclipse.aether.resolution.ArtifactResult;
8988
import org.objectweb.asm.Opcodes;
89+
import org.slf4j.Logger;
90+
import org.slf4j.LoggerFactory;
9091

9192
/**
9293
* JavaMojoDescriptorExtractor, a MojoDescriptor extractor to read descriptors from java classes with annotations.
@@ -97,7 +98,8 @@
9798
*/
9899
@Named(JavaAnnotationsMojoDescriptorExtractor.NAME)
99100
@Singleton
100-
public class JavaAnnotationsMojoDescriptorExtractor extends AbstractLogEnabled implements MojoDescriptorExtractor {
101+
public class JavaAnnotationsMojoDescriptorExtractor implements MojoDescriptorExtractor {
102+
private static final Logger LOGGER = LoggerFactory.getLogger(JavaAnnotationsMojoDescriptorExtractor.class);
101103
public static final String NAME = "java-annotations";
102104

103105
private static final GroupKey GROUP_KEY = new GroupKey(GroupKey.JAVA_GROUP, 100);
@@ -451,7 +453,7 @@ private DocletTag findInClassHierarchy(JavaClass javaClass, String tagName) {
451453
} catch (Throwable t) {
452454
str = javaClass.getValue();
453455
}
454-
getLogger().warn("Failed extracting tag '" + tagName + "' from class " + str);
456+
LOGGER.warn("Failed extracting tag '" + tagName + "' from class " + str);
455457
throw (NoClassDefFoundError) new NoClassDefFoundError(e.getMessage()).initCause(e);
456458
}
457459
}
@@ -491,7 +493,7 @@ private Map<String, JavaAnnotatedElement> extractFieldsAnnotations(
491493

492494
return rawParams;
493495
} catch (NoClassDefFoundError e) {
494-
getLogger().warn("Failed extracting parameters from " + javaClass);
496+
LOGGER.warn("Failed extracting parameters from " + javaClass);
495497
throw e;
496498
}
497499
}
@@ -543,7 +545,7 @@ private Map<String, JavaAnnotatedElement> extractMethodsAnnotations(
543545
} catch (Throwable t) {
544546
str = javaClass.getValue();
545547
}
546-
getLogger().warn("Failed extracting methods from " + str);
548+
LOGGER.warn("Failed extracting methods from " + str);
547549
throw (NoClassDefFoundError) new NoClassDefFoundError(e.getMessage()).initCause(e);
548550
}
549551
}
@@ -592,10 +594,10 @@ protected void extendJavaProjectBuilderWithSourcesJar(
592594
} catch (ArtifactResolutionException e) {
593595
String message = "Unable to get sources artifact for " + artifact.getId()
594596
+ ". Some javadoc tags (@since, @deprecated and comments) won't be used";
595-
if (getLogger().isDebugEnabled()) {
596-
getLogger().warn(message, e);
597+
if (LOGGER.isDebugEnabled()) {
598+
LOGGER.warn(message, e);
597599
} else {
598-
getLogger().warn(message);
600+
LOGGER.warn(message);
599601
}
600602
return;
601603
}

‎maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/DefaultMojoAnnotationsScanner.java‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,14 @@
4949
import org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoClassVisitor;
5050
import org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoFieldVisitor;
5151
import org.apache.maven.tools.plugin.extractor.annotations.scanner.visitors.MojoParameterVisitor;
52-
import org.codehaus.plexus.logging.AbstractLogEnabled;
5352
import org.codehaus.plexus.util.DirectoryScanner;
5453
import org.codehaus.plexus.util.StringUtils;
5554
import org.codehaus.plexus.util.reflection.Reflector;
5655
import org.codehaus.plexus.util.reflection.ReflectorException;
5756
import org.objectweb.asm.ClassReader;
5857
import org.objectweb.asm.Type;
58+
import org.slf4j.Logger;
59+
import org.slf4j.LoggerFactory;
5960

6061
/**
6162
* Mojo scanner with java annotations.
@@ -65,7 +66,8 @@
6566
*/
6667
@Named
6768
@Singleton
68-
public class DefaultMojoAnnotationsScanner extends AbstractLogEnabled implements MojoAnnotationsScanner {
69+
public class DefaultMojoAnnotationsScanner implements MojoAnnotationsScanner {
70+
private static final Logger LOGGER = LoggerFactory.getLogger(DefaultMojoAnnotationsScanner.class);
6971
public static final String MVN4_API = "org.apache.maven.api.plugin.annotations.";
7072
public static final String MOJO_V4 = MVN4_API + "Mojo";
7173
public static final String EXECUTE_V4 = MVN4_API + "Execute";
@@ -166,7 +168,7 @@ protected Map<String, MojoAnnotatedClass> scanArchive(File archiveFile, Artifact
166168
}
167169
} catch (IllegalArgumentException e) {
168170
// In case of a class with newer specs an IllegalArgumentException can be thrown
169-
getLogger().error("Failed to analyze " + archiveFile.getAbsolutePath() + "!/" + zipEntryName);
171+
LOGGER.error("Failed to analyze " + archiveFile.getAbsolutePath() + "!/" + zipEntryName);
170172

171173
throw e;
172174
}
@@ -224,17 +226,15 @@ private void analyzeClassStream(
224226
ClassReader rdr = new ClassReader(is);
225227
rdr.accept(mojoClassVisitor, ClassReader.SKIP_FRAMES | ClassReader.SKIP_CODE | ClassReader.SKIP_DEBUG);
226228
} catch (ArrayIndexOutOfBoundsException aiooe) {
227-
getLogger()
228-
.warn(
229-
"Error analyzing class " + file + " in " + source + ": ignoring class",
230-
getLogger().isDebugEnabled() ? aiooe : null);
229+
LOGGER.warn(
230+
"Error analyzing class " + file + " in " + source + ": ignoring class",
231+
LOGGER.isDebugEnabled() ? aiooe : null);
231232
return;
232233
} catch (IllegalArgumentException iae) {
233234
if (iae.getMessage() == null) {
234-
getLogger()
235-
.warn(
236-
"Error analyzing class " + file + " in " + source + ": ignoring class",
237-
getLogger().isDebugEnabled() ? iae : null);
235+
LOGGER.warn(
236+
"Error analyzing class " + file + " in " + source + ": ignoring class",
237+
LOGGER.isDebugEnabled() ? iae : null);
238238
return;
239239
} else {
240240
throw iae;
@@ -251,10 +251,9 @@ private void analyzeClassStream(
251251

252252
if (mojoAnnotatedClass != null) // see MPLUGIN-206 we can have intermediate classes without annotations
253253
{
254-
if (getLogger().isDebugEnabled() && mojoAnnotatedClass.hasAnnotations()) {
255-
getLogger()
256-
.debug("found MojoAnnotatedClass:" + mojoAnnotatedClass.getClassName() + ":"
257-
+ mojoAnnotatedClass);
254+
if (LOGGER.isDebugEnabled() && mojoAnnotatedClass.hasAnnotations()) {
255+
LOGGER.debug(
256+
"found MojoAnnotatedClass:" + mojoAnnotatedClass.getClassName() + ":" + mojoAnnotatedClass);
258257
}
259258
mojoAnnotatedClass.setArtifact(artifact);
260259
mojoAnnotatedClasses.put(mojoAnnotatedClass.getClassName(), mojoAnnotatedClass);

‎maven-plugin-tools-annotations/src/test/java/org/apache/maven/tools/plugin/extractor/annotations/JavaAnnotationsMojoDescriptorExtractorTest.java‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,11 @@
3535
import org.apache.maven.tools.plugin.DefaultPluginToolsRequest;
3636
import org.apache.maven.tools.plugin.extractor.ExtractionException;
3737
import org.apache.maven.tools.plugin.extractor.annotations.scanner.DefaultMojoAnnotationsScanner;
38-
import org.codehaus.plexus.logging.Logger;
3938
import org.junit.jupiter.api.Test;
4039
import org.junit.jupiter.api.io.TempDir;
4140

4241
import static org.junit.jupiter.api.Assertions.assertEquals;
4342
import static org.junit.jupiter.api.Assertions.assertThrows;
44-
import static org.mockito.Mockito.mock;
4543

4644
class JavaAnnotationsMojoDescriptorExtractorTest {
4745
@TempDir
@@ -55,7 +53,6 @@ MojoDescriptor extractDescriptorFromMojoClass(Class<? extends AbstractMojo> mojo
5553
Files.copy(sourceClass, targetDir.resolve(sourceClass.getFileName()));
5654
JavaAnnotationsMojoDescriptorExtractor mojoDescriptorExtractor = new JavaAnnotationsMojoDescriptorExtractor();
5755
DefaultMojoAnnotationsScanner scanner = new DefaultMojoAnnotationsScanner();
58-
scanner.enableLogging(mock(Logger.class));
5956
mojoDescriptorExtractor.mojoAnnotationsScanner = scanner;
6057
PluginDescriptor pluginDescriptor = new PluginDescriptor();
6158
MavenProject mavenProject = new MavenProject();

‎maven-plugin-tools-annotations/src/test/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/DefaultMojoAnnotationsScannerTest.java‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@
3737
import org.apache.maven.tools.plugin.extractor.annotations.ParametersWithGenericsMojo;
3838
import org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent;
3939
import org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent;
40-
import org.codehaus.plexus.logging.Logger;
4140
import org.junit.jupiter.api.Test;
4241

4342
import static org.assertj.core.api.Assertions.assertThat;
@@ -46,7 +45,6 @@
4645
import static org.junit.jupiter.api.Assertions.assertFalse;
4746
import static org.junit.jupiter.api.Assertions.assertNotNull;
4847
import static org.junit.jupiter.api.Assertions.assertTrue;
49-
import static org.mockito.Mockito.mock;
5048

5149
class DefaultMojoAnnotationsScannerTest {
5250
private DefaultMojoAnnotationsScanner scanner = new DefaultMojoAnnotationsScanner();
@@ -58,15 +56,13 @@ void testSkipModuleInfoClassInArchive() throws Exception {
5856

5957
@Test
6058
void testJava8Annotations() throws Exception {
61-
scanner.enableLogging(mock(Logger.class));
6259
scanner.scanArchive(new File("target/test-classes/java8-annotations.jar"), null, false);
6360
}
6461

6562
@Test
6663
void scanDeprecatedMojoAnnotatins() throws ExtractionException, IOException {
6764
File directoryToScan = new File(DeprecatedMojo.class.getResource("").getFile());
6865

69-
scanner.enableLogging(mock(Logger.class));
7066
Map<String, MojoAnnotatedClass> result =
7167
scanner.scanDirectory(directoryToScan, Collections.singletonList("DeprecatedMojo.class"), null, false);
7268

@@ -94,7 +90,6 @@ void scanParametersWithGenerics() throws ExtractionException, IOException {
9490
File directoryToScan =
9591
new File(ParametersWithGenericsMojo.class.getResource("").getFile());
9692

97-
scanner.enableLogging(mock(Logger.class));
9893
Map<String, MojoAnnotatedClass> result = scanner.scanDirectory(
9994
directoryToScan, Collections.singletonList("ParametersWithGenericsMojo**.class"), null, false);
10095

@@ -141,7 +136,6 @@ void scanFooMojoClass() throws Exception {
141136
request.setIncludePatterns(Arrays.asList("**/FooMojo.class"));
142137
request.setProject(new MavenProject());
143138

144-
scanner.enableLogging(mock(Logger.class));
145139
Map<String, MojoAnnotatedClass> mojoAnnotatedClasses = scanner.scan(request);
146140

147141
System.out.println("mojoAnnotatedClasses:" + mojoAnnotatedClasses);

‎maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/extractor/AbstractScriptedMojoDescriptorExtractor.java‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,19 @@
3030
import org.apache.maven.plugin.descriptor.MojoDescriptor;
3131
import org.apache.maven.project.MavenProject;
3232
import org.apache.maven.tools.plugin.PluginToolsRequest;
33-
import org.codehaus.plexus.logging.AbstractLogEnabled;
3433
import org.codehaus.plexus.util.DirectoryScanner;
3534
import org.codehaus.plexus.util.FileUtils;
35+
import org.slf4j.Logger;
36+
import org.slf4j.LoggerFactory;
3637

3738
/**
3839
* @deprecated Scripting support for Mojos is deprecated and is planned to be removed in Maven 4.0
3940
* @author jdcasey
4041
*/
4142
@Deprecated
42-
public abstract class AbstractScriptedMojoDescriptorExtractor extends AbstractLogEnabled
43-
implements MojoDescriptorExtractor {
43+
public abstract class AbstractScriptedMojoDescriptorExtractor implements MojoDescriptorExtractor {
44+
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractScriptedMojoDescriptorExtractor.class);
45+
4446
@Override
4547
public boolean isDeprecated() {
4648
return true;
@@ -50,7 +52,7 @@ public boolean isDeprecated() {
5052
@Override
5153
public List<MojoDescriptor> execute(PluginToolsRequest request)
5254
throws ExtractionException, InvalidPluginDescriptorException {
53-
getLogger().debug("Running: " + getClass().getName());
55+
LOGGER.debug("Running: " + getClass().getName());
5456
String metadataExtension = getMetadataFileExtension(request);
5557
String scriptExtension = getScriptFileExtension(request);
5658

@@ -75,8 +77,8 @@ public List<MojoDescriptor> execute(PluginToolsRequest request)
7577
scriptFilesKeyedByBasedir, project.getBuild().getOutputDirectory(), request);
7678

7779
if (!mojoDescriptors.isEmpty()) {
78-
getLogger().warn("Scripting support for mojos is deprecated and is planned to be removed in Maven 4.");
79-
getLogger().warn("Found " + mojoDescriptors.size() + " scripted mojos.");
80+
LOGGER.warn("Scripting support for mojos is deprecated and is planned to be removed in Maven 4.");
81+
LOGGER.warn("Found " + mojoDescriptors.size() + " scripted mojos.");
8082
}
8183

8284
return mojoDescriptors;
@@ -140,9 +142,8 @@ protected Map<String, Set<File>> gatherFilesByBasedir(
140142
for (String resourceDir : directories) {
141143
Set<File> sources = new HashSet<>();
142144

143-
getLogger()
144-
.debug("Scanning script dir: " + resourceDir + " with extractor: "
145-
+ getClass().getName());
145+
LOGGER.debug("Scanning script dir: " + resourceDir + " with extractor: "
146+
+ getClass().getName());
146147
File dir = new File(resourceDir);
147148
if (!dir.isAbsolute()) {
148149
dir = new File(basedir, resourceDir).getAbsoluteFile();

‎maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/scanner/DefaultMojoScanner.java‎

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@
3636
import org.apache.maven.tools.plugin.extractor.GroupKey;
3737
import org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractor;
3838
import org.apache.maven.tools.plugin.extractor.MojoDescriptorExtractorComparator;
39-
import org.codehaus.plexus.logging.AbstractLogEnabled;
40-
import org.codehaus.plexus.logging.Logger;
41-
import org.codehaus.plexus.logging.console.ConsoleLogger;
39+
import org.slf4j.Logger;
40+
import org.slf4j.LoggerFactory;
4241

4342
/**
4443
* @author jdcasey
4544
*/
4645
@Named
47-
public class DefaultMojoScanner extends AbstractLogEnabled implements MojoScanner {
46+
public class DefaultMojoScanner implements MojoScanner {
47+
private static final Logger LOGGER = LoggerFactory.getLogger("standalone-scanner-logger");
4848

4949
private Map<String, MojoDescriptorExtractor> mojoDescriptorExtractors;
5050

@@ -61,8 +61,6 @@ public class DefaultMojoScanner extends AbstractLogEnabled implements MojoScanne
6161
@Inject
6262
public DefaultMojoScanner(Map<String, MojoDescriptorExtractor> extractors) {
6363
this.mojoDescriptorExtractors = extractors;
64-
65-
this.enableLogging(new ConsoleLogger(Logger.LEVEL_INFO, "standalone-scanner-logger"));
6664
}
6765

6866
/**
@@ -78,40 +76,39 @@ public DefaultMojoScanner() {
7876
@Override
7977
public void populatePluginDescriptor(PluginToolsRequest request)
8078
throws ExtractionException, InvalidPluginDescriptorException {
81-
Logger logger = getLogger();
8279

8380
int numMojoDescriptors = 0;
8481

8582
List<MojoDescriptorExtractor> orderedExtractors = getOrderedExtractors();
8683

87-
logger.debug("Using " + orderedExtractors.size() + " mojo extractors.");
84+
LOGGER.debug("Using " + orderedExtractors.size() + " mojo extractors.");
8885

8986
HashMap<String, Integer> groupStats = new HashMap<>();
9087

9188
for (MojoDescriptorExtractor extractor : orderedExtractors) {
9289
GroupKey groupKey = extractor.getGroupKey();
9390
String extractorId = extractor.getName();
9491

95-
logger.debug("Applying " + extractorId + " mojo extractor");
92+
LOGGER.debug("Applying " + extractorId + " mojo extractor");
9693

9794
List<MojoDescriptor> extractorDescriptors = extractor.execute(request);
9895

9996
int extractorDescriptorsCount = extractorDescriptors.size();
10097

101-
logger.info(extractorId + " mojo extractor found " + extractorDescriptorsCount + " mojo descriptor"
98+
LOGGER.info(extractorId + " mojo extractor found " + extractorDescriptorsCount + " mojo descriptor"
10299
+ (extractorDescriptorsCount > 1 ? "s" : "") + ".");
103100
numMojoDescriptors += extractorDescriptorsCount;
104101

105102
if (extractor.isDeprecated() && extractorDescriptorsCount > 0) {
106-
logger.warn("");
107-
logger.warn("Deprecated extractor " + extractorId
103+
LOGGER.warn("");
104+
LOGGER.warn("Deprecated extractor " + extractorId
108105
+ " extracted " + extractorDescriptorsCount
109106
+ " descriptor" + (extractorDescriptorsCount > 1 ? "s" : "")
110107
+ ". Upgrade your Mojo definitions.");
111108
if (GroupKey.JAVA_GROUP.equals(groupKey.getGroup())) {
112-
logger.warn("You should use Mojo Annotations instead of Javadoc tags.");
109+
LOGGER.warn("You should use Mojo Annotations instead of Javadoc tags.");
113110
}
114-
logger.warn("");
111+
LOGGER.warn("");
115112
}
116113

117114
if (groupStats.containsKey(groupKey.getGroup())) {
@@ -121,15 +118,15 @@ public void populatePluginDescriptor(PluginToolsRequest request)
121118
}
122119

123120
for (MojoDescriptor descriptor : extractorDescriptors) {
124-
logger.debug("Adding mojo: " + descriptor + " to plugin descriptor.");
121+
LOGGER.debug("Adding mojo: " + descriptor + " to plugin descriptor.");
125122

126123
descriptor.setPluginDescriptor(request.getPluginDescriptor());
127124

128125
request.getPluginDescriptor().addMojo(descriptor);
129126
}
130127
}
131128

132-
logger.debug("Discovered descriptors by groups: " + groupStats);
129+
LOGGER.debug("Discovered descriptors by groups: " + groupStats);
133130

134131
if (numMojoDescriptors == 0 && !request.isSkipErrorNoDescriptorsFound()) {
135132
throw new InvalidPluginDescriptorException("No mojo definitions were found for plugin: "

‎maven-plugin-tools-generators/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,6 @@
2828

2929
import org.apache.maven.project.MavenProject;
3030
import org.apache.velocity.VelocityContext;
31-
import org.codehaus.plexus.logging.AbstractLogEnabled;
32-
import org.codehaus.plexus.logging.Logger;
33-
import org.codehaus.plexus.logging.console.ConsoleLogger;
3431
import org.codehaus.plexus.util.io.CachingOutputStream;
3532
import org.codehaus.plexus.velocity.VelocityComponent;
3633

@@ -44,7 +41,7 @@
4441
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
4542
* @since 2.4
4643
*/
47-
public class PluginHelpGenerator extends AbstractLogEnabled {
44+
public class PluginHelpGenerator {
4845
/**
4946
* Default generated class name
5047
*/
@@ -60,7 +57,7 @@ public class PluginHelpGenerator extends AbstractLogEnabled {
6057
* Default constructor
6158
*/
6259
public PluginHelpGenerator() {
63-
this.enableLogging(new ConsoleLogger(Logger.LEVEL_INFO, "PluginHelpGenerator"));
60+
// nop
6461
}
6562

6663
// ----------------------------------------------------------------------

0 commit comments

Comments
 (0)