From 5fb1c237dc22616116a7ae247ba87b38badb6983 Mon Sep 17 00:00:00 2001 From: Aaron Digulla Date: Thu, 20 Jun 2019 17:00:38 +0200 Subject: [PATCH] Fix #337 Use slf4j over old logging APIs in Maven Based on https://github.com/mojohaus/license-maven-plugin/pull/339 --- pom.xml | 17 ++- src/license/THIRD-PARTY.properties | 2 +- .../license/AbstractAddThirdPartyMojo.java | 68 +++++------ .../license/AbstractDownloadLicensesMojo.java | 63 +++++----- .../mojo/license/AbstractFileHeaderMojo.java | 76 ++++++------ .../mojo/license/AbstractLicenseMojo.java | 18 +-- .../mojo/license/AbstractLicenseNameMojo.java | 24 ++-- .../mojo/license/AbstractLicensesXmlMojo.java | 5 +- .../license/AbstractThirdPartyReportMojo.java | 11 +- .../mojo/license/AddThirdPartyMojo.java | 24 ++-- .../AggregateDownloadLicensesMojo.java | 1 - .../license/AggregatorAddThirdPartyMojo.java | 33 ++--- .../mojo/license/CommentStyleListMojo.java | 5 +- .../mojo/license/DownloadLicensesMojo.java | 1 - .../mojo/license/LicenseListMojo.java | 7 +- .../LicensesXmlInsertVersionsMojo.java | 12 +- .../mojo/license/RemoveFileHeaderMojo.java | 54 ++++----- .../license/UpdateProjectLicenseMojo.java | 9 +- .../license/api/DefaultThirdPartyHelper.java | 17 +-- .../license/api/DefaultThirdPartyTool.java | 113 ++++++++---------- .../mojo/license/api/DependenciesTool.java | 21 ++-- .../mojo/license/api/ThirdPartyTool.java | 2 +- .../license/download/LicenseDownloader.java | 17 +-- .../download/LicensedArtifactResolver.java | 20 ++-- .../license/download/PreferredFileNames.java | 36 +++--- .../license/download/UrlReplacements.java | 30 ++--- .../mojo/license/header/FileHeaderFilter.java | 38 +----- .../header/UpdateFileHeaderFilter.java | 30 ++--- .../mojo/license/model/LicenseRepository.java | 20 +--- .../mojo/license/model/LicenseStore.java | 39 ++---- .../license/api/FreeMarkerHelperTest.java | 24 +--- .../license/download/LicenseMatchersTest.java | 1 - 32 files changed, 379 insertions(+), 459 deletions(-) diff --git a/pom.xml b/pom.xml index 7eea48632..976763d8f 100644 --- a/pom.xml +++ b/pom.xml @@ -137,6 +137,11 @@ + + org.apache.maven.plugin-tools + maven-plugin-annotations + ${pluginPluginVersion} + org.apache.httpcomponents httpclient @@ -147,6 +152,11 @@ httpcore ${version.httpcomponents.httpcore} + + org.slf4j + slf4j-api + 1.7.26 + @@ -237,7 +247,6 @@ org.apache.maven.plugin-tools maven-plugin-annotations - ${pluginPluginVersion} provided @@ -301,10 +310,8 @@ - log4j - log4j - 1.2.17 - runtime + org.slf4j + slf4j-api diff --git a/src/license/THIRD-PARTY.properties b/src/license/THIRD-PARTY.properties index 7113f11f9..4478e968a 100644 --- a/src/license/THIRD-PARTY.properties +++ b/src/license/THIRD-PARTY.properties @@ -20,7 +20,7 @@ #Sat Feb 23 19:57:14 CET 2019 classworlds--classworlds--1.1=http\://classworlds.codehaus.org/license.html commons-beanutils--commons-beanutils--1.7.0=The Apache Software License, Version 2.0 -dom4j--dom4j--1.1=BSD 4-Cluse JDOM +dom4j--dom4j--1.1=BSD 4-Clause DOM4J nekohtml--xercesMinimal--1.9.6.2=The Apache Software License, Version 2.0 org.codehaus.plexus--plexus-container-default--1.0-alpha-9-stable-1=The Apache Software License, Version 2.0 org.codehaus.plexus--plexus-i18n--1.0-beta-7=The Apache Software License, Version 2.0 diff --git a/src/main/java/org/codehaus/mojo/license/AbstractAddThirdPartyMojo.java b/src/main/java/org/codehaus/mojo/license/AbstractAddThirdPartyMojo.java index 484738979..b914ac704 100644 --- a/src/main/java/org/codehaus/mojo/license/AbstractAddThirdPartyMojo.java +++ b/src/main/java/org/codehaus/mojo/license/AbstractAddThirdPartyMojo.java @@ -29,7 +29,6 @@ import org.apache.maven.artifact.repository.ArtifactRepository; import org.apache.maven.plugin.MojoExecutionException; import org.apache.maven.plugin.MojoFailureException; -import org.apache.maven.plugin.logging.Log; import org.apache.maven.plugins.annotations.Component; import org.apache.maven.plugins.annotations.Parameter; import org.apache.maven.project.MavenProject; @@ -59,6 +58,8 @@ import org.codehaus.mojo.license.api.DependenciesToolException; import org.eclipse.aether.resolution.ArtifactResolutionException; import org.eclipse.aether.transfer.ArtifactNotFoundException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * Abstract mojo for all third-party mojos. @@ -69,6 +70,7 @@ public abstract class AbstractAddThirdPartyMojo extends AbstractLicenseMojo { + private static final Logger LOG = LoggerFactory.getLogger( AbstractAddThirdPartyMojo.class ); // ---------------------------------------------------------------------- // Mojo Parameters @@ -715,11 +717,8 @@ protected void init() throws Exception { - Log log = getLog(); - - if ( log.isDebugEnabled() ) + if ( getLog().isDebugEnabled() ) { - // always be verbose in debug mode setVerbose( true ); } @@ -728,11 +727,8 @@ protected void init() long buildTimestamp = getBuildTimestamp(); - if ( isVerbose() || getLog().isDebugEnabled() ) - { - log.debug( "Build start at : " + buildTimestamp ); - log.debug( "third-party file : " + thirdPartyFile.lastModified() ); - } + LOG.debug( "Build start at: {}", buildTimestamp ); + LOG.debug( "third-party file: {}", thirdPartyFile.lastModified() ); doGenerate = force || !thirdPartyFile.exists() || buildTimestamp > thirdPartyFile.lastModified(); @@ -741,10 +737,7 @@ protected void init() File bundleFile = FileUtil.getFile( outputDirectory, bundleThirdPartyPath ); - if ( isVerbose() || getLog().isDebugEnabled() ) - { - log.debug( "bundle third-party file : " + bundleFile.lastModified() ); - } + LOG.debug( "bundle third-party file: {}", bundleFile.lastModified() ); doGenerateBundle = force || !bundleFile.exists() || buildTimestamp > bundleFile.lastModified(); } else @@ -764,18 +757,18 @@ protected void init() { throw new MojoExecutionException( "You can't use both licenseMergesFile and licenseMergesUrl" ); } - getLog().warn( "" ); - getLog().warn( "!!! licenseMergesFile is deprecated, use now licenseMergesUrl !!!" ); - getLog().warn( "" ); - getLog().warn( "licenseMerges will be overridden by licenseMergesFile." ); - getLog().warn( "" ); + LOG.warn( "" ); + LOG.warn( "!!! licenseMergesFile is deprecated, use now licenseMergesUrl !!!" ); + LOG.warn( "" ); + LOG.warn( "licenseMerges will be overridden by licenseMergesFile." ); + LOG.warn( "" ); licenseMerges = FileUtils.readLines( new File( licenseMergesFile ), "utf-8" ); } else if ( licenseMergesUrl != null ) { - getLog().warn( "" ); - getLog().warn( "licenseMerges will be overridden by licenseMergesUrl." ); - getLog().warn( "" ); + LOG.warn( "" ); + LOG.warn( "licenseMerges will be overridden by licenseMergesUrl." ); + LOG.warn( "" ); if ( UrlRequester.isStringUrl( licenseMergesUrl ) ) { licenseMerges = Arrays.asList( UrlRequester.getFromUrl( licenseMergesUrl ).split( "[\n\r]+" ) ); @@ -874,7 +867,7 @@ protected ThirdPartyHelper getHelper() { helper = new DefaultThirdPartyHelper( getProject(), getEncoding(), isVerbose(), dependenciesTool, thirdPartyTool, getProject().getRemoteArtifactRepositories(), - getProject().getRemoteProjectRepositories(), getLog() ); + getProject().getRemoteProjectRepositories() ); } return helper; } @@ -934,20 +927,19 @@ void checkUnsafeDependencies() { if ( CollectionUtils.isNotEmpty( unsafeDependencies ) ) { - Log log = getLog(); - if ( log.isWarnEnabled() ) + if ( LOG.isWarnEnabled() ) { boolean plural = unsafeDependencies.size() > 1; String message = String.format( "There %s %d %s with no license :", plural ? "are" : "is", unsafeDependencies.size(), plural ? "dependencies" : "dependency" ); - log.warn( message ); + LOG.warn( message ); for ( MavenProject dep : unsafeDependencies ) { // no license found for the dependency - log.warn( " - " + MojoHelper.getArtifactId( dep.getArtifact() ) ); + LOG.warn( " - {}", MojoHelper.getArtifactId( dep.getArtifact() ) ); } } } @@ -961,7 +953,7 @@ boolean checkForbiddenLicenses() if ( CollectionUtils.isNotEmpty( blackLicenses ) ) { Set licenses = licenseMap.keySet(); - getLog().info( "Excluded licenses (blacklist): " + blackLicenses ); + LOG.info( "Excluded licenses (blacklist): {}", blackLicenses ); for ( String excludeLicense : blackLicenses ) { @@ -977,20 +969,19 @@ boolean checkForbiddenLicenses() if ( CollectionUtils.isNotEmpty( whiteLicenses ) ) { Set dependencyLicenses = licenseMap.keySet(); - getLog().info( "Included licenses (whitelist): " + whiteLicenses ); + LOG.info( "Included licenses (whitelist): {}", whiteLicenses ); for ( String dependencyLicense : dependencyLicenses ) { - getLog().debug( "Testing license '" + dependencyLicense + "'" ); + LOG.debug( "Testing license '{}'", dependencyLicense ); if ( !whiteLicenses.contains( dependencyLicense ) && CollectionUtils.isNotEmpty( licenseMap.get( dependencyLicense ) ) ) { - getLog().debug( "Testing dependency license '" + dependencyLicense - + "' against all other licenses" ); + LOG.debug( "Testing dependency license '{}' against all other licenses", dependencyLicense ); for ( MavenProject dependency : licenseMap.get( dependencyLicense ) ) { - getLog().debug( " testing dependency " + dependency ); + LOG.debug( "- testing dependency {}" + dependency ); boolean forbiddenLicenseUsed = true; @@ -1012,8 +1003,10 @@ boolean checkForbiddenLicenses() if ( licenseMap.get( otherLicense ).contains( dependency ) ) { - getLog().info( "License: '" + dependencyLicense + "' for '" + dependency + "'is OK " - + "since it is also licensed under '" + otherLicense + "'" ); + LOG.info( "License: '{}' for '{}' is OK since it is also licensed under '{}'", + dependencyLicense, + dependency, + otherLicense ); // this dependency is licensed under another license from white list forbiddenLicenseUsed = false; break; @@ -1035,8 +1028,7 @@ boolean checkForbiddenLicenses() if ( !safe ) { - Log log = getLog(); - log.warn( "There are " + unsafeLicenses.size() + " forbidden licenses used:" ); + LOG.warn( "There are {} forbidden licenses used:", unsafeLicenses.size() ); for ( String unsafeLicense : unsafeLicenses ) { @@ -1050,7 +1042,7 @@ boolean checkForbiddenLicenses() { sb.append( "\n -" ).append( MojoHelper.getArtifactName( dep ) ); } - log.warn( sb.toString() ); + LOG.warn( "{}", sb ); } } } diff --git a/src/main/java/org/codehaus/mojo/license/AbstractDownloadLicensesMojo.java b/src/main/java/org/codehaus/mojo/license/AbstractDownloadLicensesMojo.java index 2041babb2..5939e7306 100644 --- a/src/main/java/org/codehaus/mojo/license/AbstractDownloadLicensesMojo.java +++ b/src/main/java/org/codehaus/mojo/license/AbstractDownloadLicensesMojo.java @@ -64,6 +64,8 @@ import org.codehaus.mojo.license.spdx.SpdxLicenseList; import org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments.ContentSanitizer; import org.codehaus.mojo.license.utils.FileUtil; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * Created on 23/05/16. @@ -74,6 +76,7 @@ public abstract class AbstractDownloadLicensesMojo extends AbstractLicensesXmlMojo implements MavenProjectDependenciesConfigurator { + private static final Logger LOG = LoggerFactory.getLogger( AbstractDownloadLicensesMojo.class ); // ---------------------------------------------------------------------- // Mojo Parameters @@ -702,12 +705,12 @@ public void execute() if ( isSkip() ) { - getLog().info( "skip flag is on, will skip goal." ); + LOG.info( "skip flag is on, will skip goal." ); return; } this.errorRemedy = getEffectiveErrorRemedy( this.quiet, this.errorRemedy ); - this.preferredFileNames = PreferredFileNames.build( licensesOutputDirectory, licenseUrlFileNames, getLog() ); + this.preferredFileNames = PreferredFileNames.build( licensesOutputDirectory, licenseUrlFileNames ); this.cache = new Cache( licenseUrlFileNames != null && !licenseUrlFileNames.isEmpty() ); this.urlReplacements = urlReplacements(); @@ -761,7 +764,7 @@ public void execute() { for ( LicensedArtifact artifact : dependencies.values() ) { - getLog().debug( "Checking licenses for project " + artifact ); + LOG.debug( "Checking licenses for project " + artifact ); final ProjectLicenseInfo depProject = createDependencyProject( artifact ); matchers.replaceMatches( depProject ); @@ -782,7 +785,7 @@ public void execute() { downloadLicenses( licenseDownloader, depProject, true ); } - getLog().debug( "Finished populating cache" ); + LOG.debug( "Finished populating cache" ); /* * Then attempt to download the rest of the URLs using the available cache entries to select local * file names based on file content sha1 @@ -826,7 +829,7 @@ public void execute() /* do nothing */ break; case warn: - getLog().warn( "There were " + downloadErrorCount + " download errors - check the warnings above" ); + LOG.warn( "There were {} download errors - check the warnings above", downloadErrorCount ); break; case xmlOutput: if ( downloadErrorCount > 0 ) @@ -843,7 +846,7 @@ public void execute() private UrlReplacements urlReplacements() { - UrlReplacements.Builder b = UrlReplacements.builder( getLog() ).useDefaults( useDefaultUrlReplacements ); + UrlReplacements.Builder b = UrlReplacements.builder().useDefaults( useDefaultUrlReplacements ); if ( licenseUrlReplacements != null ) { for ( LicenseUrlReplacement r : licenseUrlReplacements ) @@ -863,7 +866,7 @@ private Map contentSanitizers() final Map defaultSanitizers = SpdxLicenseList.getLatest().getAttachments().getContentSanitizers(); result.putAll( defaultSanitizers ); - if ( getLog().isDebugEnabled() && !defaultSanitizers.isEmpty() ) + if ( LOG.isDebugEnabled() && !defaultSanitizers.isEmpty() ) { final StringBuilder sb = new StringBuilder() // .append( "Applied " ) // @@ -888,7 +891,7 @@ private Map contentSanitizers() } sb.append( "" ); - getLog().debug( sb.toString() ); + LOG.debug( sb.toString() ); } } if ( licenseContentSanitizers != null ) @@ -922,7 +925,7 @@ private void removeOrphanFiles( List deps ) final File file = new File( licensesOutputDirectory, fileName ); if ( file.exists() ) { - getLog().info( "Removing orphan license file \"" + file + "\"" ); + LOG.info( "Removing orphan license file \"{}\"", file ); file.delete(); } } @@ -1032,7 +1035,7 @@ private void initDirectories() { if ( cleanLicensesOutputDirectory ) { - getLog().info( "Cleaning licensesOutputDirectory '" + licensesOutputDirectory + "'" ); + LOG.info( "Cleaning licensesOutputDirectory '{}'", licensesOutputDirectory ); FileUtils.cleanDirectory( licensesOutputDirectory ); } } @@ -1191,7 +1194,7 @@ private void downloadLicenses( LicenseDownloader licenseDownloader, ProjectLicen boolean matchingUrlsOnly ) throws MojoFailureException { - getLog().debug( "Downloading license(s) for project " + depProject ); + LOG.debug( "Downloading license(s) for project {}", depProject ); List licenses = depProject.getLicenses(); @@ -1257,7 +1260,7 @@ else if ( license.getUrl() != null ) if ( !licenseOutputFile.exists() || forceDownload ) { LicenseDownloadResult result = - licenseDownloader.downloadLicense( licenseUrl, fileNameEntry, getLog() ); + licenseDownloader.downloadLicense( licenseUrl, fileNameEntry ); if ( !organizeLicensesByDependencies && result.isSuccess() ) { /* check if we can re-use an existing file that has the same content */ @@ -1267,9 +1270,12 @@ else if ( license.getUrl() != null ) final File oldFile = result.getFile(); if ( !oldFile.getName().equals( name ) ) { - getLog().debug( "Found preferred name '" + name - + "' by sha1 after downloading '" + licenseUrl + "'; renaming from '" - + oldFile.getName() + "'" ); + LOG.debug( + "Found preferred name '{}' by SHA1 after downloading '{}'; " + + "renaming from '{}'", + name, + licenseUrl, + oldFile.getName() ); final File newFile = new File( licensesOutputDirectory, name ); if ( newFile.exists() ) { @@ -1300,21 +1306,24 @@ else if ( licenseOutputFile.exists() ) } catch ( URISyntaxException e ) { - handleError( depProject, "POM for dependency " + depProject.toGavString() - + " has an invalid license URL: " + licenseUrl ); - getLog().debug( e ); + String msg = "POM for dependency " + depProject.toGavString() + + " has an invalid license URL: " + licenseUrl; + handleError( depProject, msg ); + LOG.debug( msg, e ); } catch ( FileNotFoundException e ) { - handleError( depProject, "POM for dependency " + depProject.toGavString() - + " has a license URL that returns file not found: " + licenseUrl ); - getLog().debug( e ); + String msg = "POM for dependency " + depProject.toGavString() + + " has a license URL that returns file not found: " + licenseUrl; + handleError( depProject, msg ); + LOG.debug( msg, e ); } catch ( IOException e ) { - handleError( depProject, "Unable to retrieve license from URL '" + licenseUrl + "' for dependency '" - + depProject.toGavString() + "': " + e.getMessage() ); - getLog().debug( e ); + String msg = "Unable to retrieve license from URL '" + licenseUrl + "' for dependency '" + + depProject.toGavString() + "': " + e.getMessage(); + handleError( depProject, msg ); + LOG.debug( msg, e ); } } licenseIndex++; @@ -1340,7 +1349,7 @@ private void handleError( ProjectLicenseInfo depProject, String msg ) throws Moj { if ( depProject.isApproved() ) { - getLog().debug( "Supressing manually approved license issue: " + msg ); + LOG.debug( "Supressing manually approved license issue: {}", msg ); } else { @@ -1350,12 +1359,12 @@ private void handleError( ProjectLicenseInfo depProject, String msg ) throws Moj /* do nothing */ break; case warn: - getLog().warn( msg ); + LOG.warn( msg ); break; case failFast: throw new MojoFailureException( msg ); case xmlOutput: - getLog().error( msg ); + LOG.error( msg ); depProject.addDownloaderMessage( msg ); break; default: diff --git a/src/main/java/org/codehaus/mojo/license/AbstractFileHeaderMojo.java b/src/main/java/org/codehaus/mojo/license/AbstractFileHeaderMojo.java index 1fdc04042..875b4ff73 100644 --- a/src/main/java/org/codehaus/mojo/license/AbstractFileHeaderMojo.java +++ b/src/main/java/org/codehaus/mojo/license/AbstractFileHeaderMojo.java @@ -38,12 +38,13 @@ import org.codehaus.mojo.license.model.License; import org.codehaus.mojo.license.utils.FileUtil; import org.codehaus.mojo.license.utils.MojoHelper; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import java.io.File; import java.io.IOException; import java.nio.file.Files; import java.nio.file.StandardCopyOption; -import java.util.Arrays; import java.util.Collections; import java.util.EnumMap; import java.util.HashMap; @@ -61,6 +62,7 @@ */ public abstract class AbstractFileHeaderMojo extends AbstractLicenseNameMojo { + private static final Logger LOG = LoggerFactory.getLogger( AbstractFileHeaderMojo.class ); // ---------------------------------------------------------------------- // Mojo Parameters @@ -411,12 +413,12 @@ public void init() throws Exception { if ( isFailOnMissingHeader() ) { - getLog().warn( "The failOnMissingHeader has no effect if the property dryRun is not set." ); + LOG.warn( "The failOnMissingHeader has no effect if the property dryRun is not set." ); } if ( isFailOnNotUptodateHeader() ) { - getLog().warn( "The failOnNotUptodateHeader has no effect if the property dryRun is not set." ); + LOG.warn( "The failOnNotUptodateHeader has no effect if the property dryRun is not set." ); } } @@ -432,7 +434,7 @@ public void init() throws Exception String str = String.format( commentFormat, aTransformer.getName(), aTransformer.getDescription() ); buffer.append( str ); } - getLog().info( buffer.toString() ); + LOG.info( "{}", buffer ); } // set timestamp used for temporary files this.timestamp = System.nanoTime(); @@ -442,7 +444,7 @@ public void init() throws Exception roots = DEFAULT_ROOTS; if ( isVerbose() ) { - getLog().info( "Will use default roots " + Arrays.toString( roots ) ); + LOG.info( "Will use default roots {}", ( Object ) roots ); } } @@ -451,7 +453,7 @@ public void init() throws Exception includes = DEFAULT_INCLUDES; if ( isVerbose() ) { - getLog().info( "Will use default includes " + Arrays.toString( includes ) ); + LOG.info( "Will use default includes {}", ( Object ) includes ); } } @@ -460,7 +462,7 @@ public void init() throws Exception excludes = DEFAULT_EXCLUDES; if ( isVerbose() ) { - getLog().info( "Will use default excludes" + Arrays.toString( excludes ) ); + LOG.info( "Will use default excludes {}", ( Object ) excludes ); } } @@ -469,18 +471,18 @@ public void init() throws Exception processStartTag = cleanHeaderConfiguration( processStartTag, FileHeaderTransformer.DEFAULT_PROCESS_START_TAG ); if ( isVerbose() ) { - getLog().info( "Will use processStartTag: " + processStartTag ); + LOG.info( "Will use processStartTag: {}", processStartTag ); } processEndTag = cleanHeaderConfiguration( processEndTag, FileHeaderTransformer.DEFAULT_PROCESS_END_TAG ); if ( isVerbose() ) { - getLog().info( "Will use processEndTag: " + processEndTag ); + LOG.info( "Will use processEndTag: {}", processEndTag ); } sectionDelimiter = cleanHeaderConfiguration( sectionDelimiter, FileHeaderTransformer.DEFAULT_SECTION_DELIMITER ); if ( isVerbose() ) { - getLog().info( "Will use sectionDelimiter: " + sectionDelimiter ); + LOG.info( "Will use sectionDelimiter: {}", sectionDelimiter ); } // add default extensions from header transformers @@ -509,7 +511,7 @@ public void init() throws Exception { if ( isVerbose() ) { - getLog().info( "Associate extension " + extension + " to comment style " + commentStyle ); + LOG.info( "Associate extension '{}' to comment style '{}'", extension, commentStyle ); } extensionToCommentStyle.put( extension, commentStyle ); } @@ -524,15 +526,15 @@ public void init() throws Exception if ( extensionToCommentStyle.containsKey( extension ) ) { // override existing extension mapping - getLog().warn( "The extension " + extension + " is already accepted for comment style " - + extensionToCommentStyle.get( extension ) ); + LOG.warn( "The extension '{}' is already accepted for comment style '{}'", + extension, extensionToCommentStyle.get( extension ) ); } String commentStyle = entry.getValue(); // check transformer exists getTransformer( transformers, commentStyle ); if ( isVerbose() ) { - getLog().info( "Associate extension '" + extension + "' to comment style '" + commentStyle + "'" ); + LOG.info( "Associate extension '{}' to comment style '{}'", extension, commentStyle ); } extensionToCommentStyle.put( extension, commentStyle ); } @@ -547,7 +549,7 @@ public void init() throws Exception // build the description template if ( isVerbose() ) { - getLog().info( "Use description template : " + descriptionTemplate ); + LOG.info( "Use description template: {}", descriptionTemplate ); } descriptionTemplate0 = freeMarkerHelper.getTemplate( descriptionTemplate ); } @@ -581,20 +583,20 @@ public void doAction() throws Exception int nbFiles = processedFiles.size(); if ( nbFiles == 0 && !ignoreNoFileToScan ) { - getLog().warn( "No file to scan." ); + LOG.warn( "No file to scan." ); } else { String delay = MojoHelper.convertTime( System.nanoTime() - t0 ); String message = String.format( "Scan %s file%s header done in %s.", nbFiles, nbFiles > 1 ? "s" : "", delay ); - getLog().info( message ); + LOG.info( message ); } Set states = result.keySet(); if ( states.size() == 1 && states.contains( FileState.uptodate ) ) { // all files where up to date - getLog().info( "All files are up-to-date." ); + LOG.info( "All files are up-to-date." ); } else { @@ -606,7 +608,7 @@ public void doAction() throws Exception reportType( result, state, buffer ); } - getLog().info( buffer.toString() ); + LOG.info( buffer.toString() ); } } @@ -672,8 +674,8 @@ private void processCommentStyle( String commentStyle, List filesToTreat ) if ( isVerbose() ) { - getLog().info( "Process header '" + commentStyle + "'" ); - getLog().info( " - using " + license.getDescription() ); + LOG.info( "Process header '{}'", commentStyle ); + LOG.info( " - using {}", license.getDescription() ); } // use header transformer according to comment style given in header @@ -696,7 +698,7 @@ private FileHeaderProcessor getFileHeaderProcessor( License license, FileHeaderT if ( inceptionYear == null ) { - getLog().warn( "No inceptionYear defined (will use current year)" ); + LOG.warn( "No inceptionYear defined (will use current year)" ); } Copyright copyright = getCopyright( getCopyrightOwners() ); @@ -714,7 +716,6 @@ private FileHeaderProcessor getFileHeaderProcessor( License license, FileHeaderT filter.setUpdateDescription( canUpdateDescription ); filter.setUpdateLicense( canUpdateLicense ); - filter.setLog( getLog() ); // update processor filter return new FileHeaderProcessor( filter, header, transformer ); } @@ -731,7 +732,7 @@ private void processFile( FileHeaderProcessor processor, File file ) throws IOEx if ( processedFiles.contains( file ) ) { - getLog().info( " - skip already processed file " + file ); + LOG.info( " - skip already processed file {}", file ); return; } @@ -744,7 +745,7 @@ private void processFile( FileHeaderProcessor processor, File file ) throws IOEx } catch ( Exception e ) { - getLog().warn( "skip failed file : " + e.getMessage() + LOG.warn( "skip failed file: " + e.getMessage() + ( e.getCause() == null ? "" : " Cause : " + e.getCause().getMessage() ), e ); FileState.fail.addFile( file, result ); doFinalize = false; @@ -780,8 +781,8 @@ private boolean processFile( FileHeaderProcessor processor, File file, File proc if ( getLog().isDebugEnabled() ) { - getLog().debug( " - process file " + file ); - getLog().debug( " - will process into file " + processFile ); + LOG.debug( " - process file {}", file ); + LOG.debug( " - will process into file {}", processFile ); } // update the file header description @@ -793,15 +794,12 @@ private boolean processFile( FileHeaderProcessor processor, File file, File proc descriptionParameters.put( "organizationName", organizationName ); descriptionParameters.put( "file", file ); - getLog().debug( "Description parameters:" + descriptionParameters ); + LOG.debug( "Description parameters: {}", descriptionParameters ); String description = freeMarkerHelper.renderTemplate( descriptionTemplate0, descriptionParameters ); processor.updateDescription( description ); - if ( getLog().isDebugEnabled() ) - { - getLog().debug( "header description : " + processor.getFileHeaderDescription() ); - } + LOG.debug( "header description : " + processor.getFileHeaderDescription() ); String content; @@ -823,7 +821,7 @@ private boolean processFile( FileHeaderProcessor processor, File file, File proc //check that file is not marked to be ignored if ( content.contains( ignoreTag ) ) { - getLog().info( " - ignore file (detected " + ignoreTag + ") " + file ); + LOG.info( " - ignore file (detected {}) {}", ignoreTag, file ); FileState.ignore.addFile( file, result ); @@ -856,7 +854,7 @@ private boolean processFile( FileHeaderProcessor processor, File file, File proc if ( isVerbose() ) { - getLog().info( " - header was updated for " + file ); + LOG.info( " - header was updated for {}", file ); } if ( processor.isModified() ) { @@ -886,7 +884,7 @@ private boolean processFile( FileHeaderProcessor processor, File file, File proc // no header at all, add a new header if ( isVerbose() ) { - getLog().info( " - adding license header on file " + file ); + LOG.info( " - adding license header on file {}", file ); } //FIXME tchemit 20100409 xml files must add header after a xml prolog line @@ -924,11 +922,7 @@ private void finalizeFile( File file, File processFile ) throws IOException FileUtil.deleteFile( backupFile ); } - if ( isVerbose() ) - { - getLog().debug( " - backup original file " + file ); - } - + LOG.debug( " - backup original file {}", file ); Files.copy( file.toPath(), backupFile.toPath(), StandardCopyOption.COPY_ATTRIBUTES ); } @@ -949,7 +943,7 @@ private void finalizeFile( File file, File processFile ) throws IOException } catch ( IOException e ) { - getLog().warn( e.getMessage() ); + LOG.warn( "Error updating {} -> {}", processFile, file, e ); } } } diff --git a/src/main/java/org/codehaus/mojo/license/AbstractLicenseMojo.java b/src/main/java/org/codehaus/mojo/license/AbstractLicenseMojo.java index 859366cb2..198fc1f43 100644 --- a/src/main/java/org/codehaus/mojo/license/AbstractLicenseMojo.java +++ b/src/main/java/org/codehaus/mojo/license/AbstractLicenseMojo.java @@ -31,9 +31,10 @@ import org.apache.maven.project.MavenProject; import org.codehaus.mojo.license.utils.MojoHelper; import org.codehaus.plexus.util.ReaderFactory; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import java.io.File; -import java.util.Arrays; /** * Abstract license mojo. @@ -44,6 +45,7 @@ public abstract class AbstractLicenseMojo extends AbstractMojo { + private static final Logger LOG = LoggerFactory.getLogger( AbstractLicenseMojo.class ); // ---------------------------------------------------------------------- // Mojo Parameters @@ -147,7 +149,7 @@ public final void execute() if ( mustSkip ) { - getLog().info( "skip flag is on, will skip goal." ); + LOG.info( "skip flag is on, will skip goal." ); return; } @@ -156,7 +158,7 @@ public final void execute() boolean canContinue = checkPackaging(); if ( !canContinue ) { - getLog().warn( "The goal is skip due to packaging '" + getProject().getPackaging() + "'" ); + LOG.warn( "The goal is skip due to packaging '{}'", getProject().getPackaging() ); return; } @@ -190,7 +192,7 @@ public final void execute() { if ( isVerbose() ) { - getLog().info( "Goal will not be executed." ); + LOG.info( "Goal will not be executed." ); } return; } @@ -388,12 +390,12 @@ protected void checkEncoding() if ( isVerbose() ) { - getLog().info( "Will check encoding : " + getEncoding() ); + LOG.info( "Will check encoding: {}", getEncoding() ); } if ( StringUtils.isEmpty( getEncoding() ) ) { - getLog().warn( "File encoding has not been set, using platform encoding " + ReaderFactory.FILE_ENCODING - + ", i.e. build is platform dependent!" ); + LOG.warn( "File encoding has not been set, using platform encoding {}, i.e. build is platform dependent!", + ReaderFactory.FILE_ENCODING ); setEncoding( ReaderFactory.FILE_ENCODING ); } } @@ -410,7 +412,7 @@ protected void addResourceDir( File dir, String... includes ) boolean added = MojoHelper.addResourceDir( dir, getProject(), includes ); if ( added && isVerbose() ) { - getLog().info( "add resource " + dir + " with includes " + Arrays.toString( includes ) ); + LOG.info( "add resource {} with includes {}", dir, ( Object ) includes ); } } diff --git a/src/main/java/org/codehaus/mojo/license/AbstractLicenseNameMojo.java b/src/main/java/org/codehaus/mojo/license/AbstractLicenseNameMojo.java index 32a1cc441..454dcc576 100644 --- a/src/main/java/org/codehaus/mojo/license/AbstractLicenseNameMojo.java +++ b/src/main/java/org/codehaus/mojo/license/AbstractLicenseNameMojo.java @@ -31,6 +31,8 @@ import org.codehaus.mojo.license.model.LicenseStore; import org.codehaus.plexus.util.DirectoryScanner; import org.codehaus.plexus.util.FileUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import java.io.File; import java.io.IOException; @@ -41,6 +43,7 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +import java.util.Properties; import java.util.Set; /** @@ -53,6 +56,7 @@ public abstract class AbstractLicenseNameMojo extends AbstractLicenseMojo { + private static final Logger LOG = LoggerFactory.getLogger( AbstractLicenseNameMojo.class ); // ---------------------------------------------------------------------- // Constants @@ -182,7 +186,7 @@ protected void init() { // init licenses store - licenseStore = LicenseStore.createLicenseStore( getLog(), licenseResolver ); + licenseStore = LicenseStore.createLicenseStore( licenseResolver ); // check licenseName exists license = getLicense( licenseName, true ); @@ -296,10 +300,7 @@ void getFilesToTreatForRoots( String[] includes, String[] excludes, List continue; } - if ( getLog().isDebugEnabled() ) - { - getLog().debug( "discovering source files in " + src ); - } + LOG.debug( "discovering source files in {}", src ); ds.setBasedir( f ); // scan @@ -460,14 +461,14 @@ Map> obtainFilesToProcessByCommentStyle( Map } if ( f.exists() ) { - getLog().info( "Will search files to update from root " + f ); + LOG.info( "Will search files to update from root {}", f ); rootsList.add( f.getAbsolutePath() ); } else { if ( isVerbose() ) { - getLog().info( "Skip not found root " + f ); + LOG.info( "Skip not found root {}", f ); } } } @@ -525,7 +526,14 @@ private Set getFiles( EnumMap> result, FileState stat // Private Methods // ---------------------------------------------------------------------- - private void addPropertiesToContext( Map properties, String prefix, Map context ) + private void addPropertiesToContext( Properties properties, String prefix, Map context ) + { + @SuppressWarnings( { "rawtypes", "unchecked" } ) + Map cast = (Map) properties; + addPropertiesToContext( cast, prefix, context ); + } + + private void addPropertiesToContext( Map properties, String prefix, Map context ) { if ( properties != null ) { diff --git a/src/main/java/org/codehaus/mojo/license/AbstractLicensesXmlMojo.java b/src/main/java/org/codehaus/mojo/license/AbstractLicensesXmlMojo.java index e80af56d8..fe0780ea6 100644 --- a/src/main/java/org/codehaus/mojo/license/AbstractLicensesXmlMojo.java +++ b/src/main/java/org/codehaus/mojo/license/AbstractLicensesXmlMojo.java @@ -40,6 +40,8 @@ import org.codehaus.mojo.license.download.LicenseSummaryWriter; import org.codehaus.mojo.license.download.LicensedArtifactResolver; import org.codehaus.mojo.license.download.ProjectLicenseInfo; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * A common parent for {@link LicensesXmlInsertVersionsMojo} and {@link AbstractDownloadLicensesMojo}. @@ -50,6 +52,7 @@ public abstract class AbstractLicensesXmlMojo extends AbstractMojo { + private static final Logger LOG = LoggerFactory.getLogger( AbstractLicensesXmlMojo.class ); /** * The output file containing a mapping between each dependency and it's license information. @@ -129,7 +132,7 @@ private void initEncoding() if ( licensesOutputFileEncoding == null ) { licensesOutputFileEncoding = System.getProperty( "file.encoding" ); - getLog().warn( "Using the default system encoding for reading or writing licenses.xml file." + LOG.warn( "Using the default system encoding for reading or writing licenses.xml file." + " This makes your build platform dependent. You should set either" + " project.build.sourceEncoding or licensesOutputFileEncoding" ); } diff --git a/src/main/java/org/codehaus/mojo/license/AbstractThirdPartyReportMojo.java b/src/main/java/org/codehaus/mojo/license/AbstractThirdPartyReportMojo.java index 6e2251c08..dccdbcd0a 100644 --- a/src/main/java/org/codehaus/mojo/license/AbstractThirdPartyReportMojo.java +++ b/src/main/java/org/codehaus/mojo/license/AbstractThirdPartyReportMojo.java @@ -49,6 +49,8 @@ import org.codehaus.mojo.license.utils.MojoHelper; import org.codehaus.mojo.license.utils.UrlRequester; import org.codehaus.plexus.i18n.I18N; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import java.io.File; import java.io.IOException; @@ -73,6 +75,7 @@ public abstract class AbstractThirdPartyReportMojo extends AbstractMavenReport implements MavenProjectDependenciesConfigurator { + private static final Logger LOG = LoggerFactory.getLogger( AbstractThirdPartyReportMojo.class ); // ---------------------------------------------------------------------- // Mojo Parameters @@ -390,9 +393,9 @@ protected void init() { if ( licenseMergesUrl != null ) { - getLog().warn( "" ); - getLog().warn( "licenseMerges will be overridden by licenseMergesUrl." ); - getLog().warn( "" ); + LOG.warn( "" ); + LOG.warn( "licenseMerges will be overridden by licenseMergesUrl." ); + LOG.warn( "" ); if ( UrlRequester.isStringUrl( licenseMergesUrl ) ) { licenseMerges = Arrays.asList( UrlRequester.getFromUrl( licenseMergesUrl ).split( "[\n\r]+" ) ); @@ -564,7 +567,7 @@ Collection createThirdPartyDetails( MavenProject project, boo ThirdPartyHelper thirdPartyHelper = new DefaultThirdPartyHelper( project, encoding, verbose, dependenciesTool, thirdPartyTool, - project.getRemoteArtifactRepositories(), project.getRemoteProjectRepositories(), getLog() ); + project.getRemoteArtifactRepositories(), project.getRemoteProjectRepositories() ); // load dependencies of the project SortedMap projectDependencies = thirdPartyHelper.loadDependencies( this, loadedDependencies ); diff --git a/src/main/java/org/codehaus/mojo/license/AddThirdPartyMojo.java b/src/main/java/org/codehaus/mojo/license/AddThirdPartyMojo.java index 388f83d75..1e5bec0d5 100644 --- a/src/main/java/org/codehaus/mojo/license/AddThirdPartyMojo.java +++ b/src/main/java/org/codehaus/mojo/license/AddThirdPartyMojo.java @@ -34,7 +34,6 @@ import org.apache.commons.collections.CollectionUtils; import org.apache.commons.collections.MapUtils; import org.apache.maven.plugin.MojoExecutionException; -import org.apache.maven.plugin.logging.Log; import org.apache.maven.plugins.annotations.LifecyclePhase; import org.apache.maven.plugins.annotations.Mojo; import org.apache.maven.plugins.annotations.Parameter; @@ -49,6 +48,8 @@ import org.codehaus.mojo.license.model.LicenseMap; import org.codehaus.mojo.license.utils.FileUtil; import org.codehaus.mojo.license.utils.SortedProperties; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; // CHECKSTYLE_OFF: LineLength /** @@ -69,6 +70,7 @@ defaultPhase = LifecyclePhase.GENERATE_RESOURCES ) public class AddThirdPartyMojo extends AbstractAddThirdPartyMojo implements MavenProjectDependenciesConfigurator { + private static final Logger LOG = LoggerFactory.getLogger( AddThirdPartyMojo.class ); // ---------------------------------------------------------------------- // Mojo Parameters @@ -158,7 +160,7 @@ protected boolean checkSkip() if ( !doGenerate && !doGenerateBundle && !doGenerateMissing ) { - getLog().info( "All files are up to date, skip goal execution." ); + LOG.info( "All files are up to date, skip goal execution." ); return false; } return true; @@ -196,7 +198,7 @@ protected void doAction() { // there is no missing dependencies, but still a missing file, delete it - getLog().info( "There is no dependency to put in missing file, delete it at " + missingFile ); + LOG.info( "There is no dependency to put in missing file, delete it at {}", missingFile ); FileUtil.deleteFile( missingFile ); } @@ -204,7 +206,7 @@ protected void doAction() { // can deploy missing file - getLog().info( "Will attach third party file from " + missingFile ); + LOG.info( "Will attach third party file from {}", missingFile ); getHelper().attachThirdPartyDescriptor( missingFile ); } @@ -265,7 +267,7 @@ protected SortedProperties createUnsafeMapping() resolveDependencyArtifacts().getAllDependencies() ); if ( isVerbose() ) { - getLog().info( "found " + unsafeMappings.size() + " unsafe mappings" ); + LOG.info( "found {} unsafe mappings", unsafeMappings.size() ); } // compute if missing file should be (re)-generate @@ -274,22 +276,22 @@ protected SortedProperties createUnsafeMapping() if ( doGenerateMissing && isVerbose() ) { StringBuilder sb = new StringBuilder(); - sb.append( "Will use from missing file " ); + sb.append( "Will use " ); sb.append( unsafeMappings.size() ); - sb.append( " dependencies :" ); + sb.append( " dependencies from missingFile:" ); for ( Map.Entry entry : unsafeMappings.entrySet() ) { String id = (String) entry.getKey(); String license = (String) entry.getValue(); sb.append( "\n - " ).append( id ).append( " - " ).append( license ); } - getLog().info( sb.toString() ); + LOG.info( "{}", sb ); } else { if ( useMissingFile && !unsafeMappings.isEmpty() ) { - getLog().info( "Missing file " + missingFile + " is up-to-date." ); + LOG.info( "Missing file {} is up-to-date.", missingFile ); } } return unsafeMappings; @@ -387,10 +389,8 @@ private void writeMissingFile() throws IOException { - Log log = getLog(); - FileUtil.createDirectoryIfNecessary( missingFile.getParentFile() ); - log.info( "Regenerate missing license file " + missingFile ); + LOG.info( "Regenerate missing license file {}", missingFile ); FileOutputStream writer = new FileOutputStream( missingFile ); try diff --git a/src/main/java/org/codehaus/mojo/license/AggregateDownloadLicensesMojo.java b/src/main/java/org/codehaus/mojo/license/AggregateDownloadLicensesMojo.java index 66aaa9ac4..fd44d576f 100644 --- a/src/main/java/org/codehaus/mojo/license/AggregateDownloadLicensesMojo.java +++ b/src/main/java/org/codehaus/mojo/license/AggregateDownloadLicensesMojo.java @@ -108,7 +108,6 @@ protected boolean isSkip() /** * {@inheritDoc} */ - @SuppressWarnings( "unchecked" ) protected Map getDependencies() { final Map result = new TreeMap<>(); diff --git a/src/main/java/org/codehaus/mojo/license/AggregatorAddThirdPartyMojo.java b/src/main/java/org/codehaus/mojo/license/AggregatorAddThirdPartyMojo.java index 30361e5e4..e5a9acf53 100644 --- a/src/main/java/org/codehaus/mojo/license/AggregatorAddThirdPartyMojo.java +++ b/src/main/java/org/codehaus/mojo/license/AggregatorAddThirdPartyMojo.java @@ -33,7 +33,6 @@ import org.apache.maven.artifact.Artifact; import org.apache.maven.model.Plugin; import org.apache.maven.plugin.MojoExecutionException; -import org.apache.maven.plugin.logging.Log; import org.apache.maven.plugins.annotations.LifecyclePhase; import org.apache.maven.plugins.annotations.Mojo; import org.apache.maven.plugins.annotations.Parameter; @@ -42,6 +41,8 @@ import org.apache.maven.project.ProjectBuildingException; import org.codehaus.mojo.license.model.LicenseMap; import org.codehaus.mojo.license.utils.SortedProperties; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * This goal forks executions of the add-third-party goal for all the leaf projects @@ -60,6 +61,8 @@ requiresDependencyResolution = ResolutionScope.TEST, threadSafe = true ) public class AggregatorAddThirdPartyMojo extends AbstractAddThirdPartyMojo { + private static final Logger LOG = LoggerFactory.getLogger( AggregatorAddThirdPartyMojo.class ); + // ---------------------------------------------------------------------- // Mojo Parameters // ---------------------------------------------------------------------- @@ -131,7 +134,7 @@ protected boolean checkSkip() if ( !doGenerate && !doGenerateBundle ) { - getLog().info( "All files are up to date, skip goal execution." ); + LOG.info( "All files are up to date, skip goal execution." ); return false; } return super.checkSkip(); @@ -143,18 +146,18 @@ protected void init() throws Exception // CHECKSTYLE_OFF: LineLength if ( aggregateMissingLicensesFile != null && !aggregateMissingLicensesFile.equals( missingFile ) ) { - getLog().warn( "" ); - getLog().warn( "You should use *missingFile* parameter instead of deprecated *aggregateMissingLicensesFile*." ); - getLog().warn( "" ); + LOG.warn( "" ); + LOG.warn( "You should use *missingFile* parameter instead of deprecated *aggregateMissingLicensesFile*." ); + LOG.warn( "" ); missingFile = aggregateMissingLicensesFile; } if ( aggregateMissingLicensesFileArtifact != null && !aggregateMissingLicensesFileArtifact.equals( missingLicensesFileArtifact ) ) { - getLog().warn( "" ); - getLog().warn( "You should use *missingLicensesFileArtifact* parameter instead of deprecated *aggregateMissingLicensesFileArtifact*." ); - getLog().warn( "" ); + LOG.warn( "" ); + LOG.warn( "You should use *missingLicensesFileArtifact* parameter instead of deprecated *aggregateMissingLicensesFileArtifact*." ); + LOG.warn( "" ); missingLicensesFileArtifact = aggregateMissingLicensesFileArtifact; } // CHECKSTYLE_ON: LineLength @@ -168,11 +171,9 @@ protected void init() throws Exception protected void doAction() throws Exception { - Log log = getLog(); - if ( isVerbose() ) { - log.info( "After executing on " + reactorProjects.size() + " project(s)" ); + LOG.info( "After executing on {} project(s)", reactorProjects.size() ); } licenseMap = new LicenseMap(); @@ -223,19 +224,19 @@ protected void doAction() LicenseMap childLicenseMap = mojo.licenseMap; if ( isVerbose() ) { - getLog().info( String.format( "Found %d license(s) in module %s:%s", - childLicenseMap.size(), mojo.project.getGroupId(), mojo.project.getArtifactId() ) ); + LOG.info( "Found {} license(s) in module {}:{}", + childLicenseMap.size(), mojo.project.getGroupId(), mojo.project.getArtifactId() ); } licenseMap.putAll( childLicenseMap ); } - getLog().info( licenseMap.size() + " detected license(s)." ); + LOG.info( "Detected {} license(s).", licenseMap.size() ); if ( isVerbose() ) { for ( Map.Entry> entry: licenseMap.entrySet() ) { - getLog().info( " - " + entry.getKey() + " for " + entry.getValue().size() + " artifact(s)." ); + LOG.info( " - {} for {} artifact(s).", entry.getKey(), entry.getValue().size() ); } } @@ -279,7 +280,7 @@ protected SortedProperties createUnsafeMapping() if ( isVerbose() ) { - getLog().info( "Use missing file path : " + path ); + LOG.info( "Use missing file path: {}", path ); } SortedProperties unsafeMappings = new SortedProperties( getEncoding() ); diff --git a/src/main/java/org/codehaus/mojo/license/CommentStyleListMojo.java b/src/main/java/org/codehaus/mojo/license/CommentStyleListMojo.java index c9dcdc15c..1d9414104 100644 --- a/src/main/java/org/codehaus/mojo/license/CommentStyleListMojo.java +++ b/src/main/java/org/codehaus/mojo/license/CommentStyleListMojo.java @@ -28,6 +28,8 @@ import org.apache.maven.plugins.annotations.Mojo; import org.apache.maven.plugins.annotations.Parameter; import org.codehaus.mojo.license.header.transformer.FileHeaderTransformer; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import java.util.ArrayList; import java.util.Arrays; @@ -45,6 +47,7 @@ public class CommentStyleListMojo extends AbstractLicenseMojo { + private static final Logger LOG = LoggerFactory.getLogger( CommentStyleListMojo.class ); // ---------------------------------------------------------------------- // Mojo Parameters @@ -143,6 +146,6 @@ public void doAction() } } - getLog().info( buffer.toString() ); + LOG.info( "{}", buffer ); } } diff --git a/src/main/java/org/codehaus/mojo/license/DownloadLicensesMojo.java b/src/main/java/org/codehaus/mojo/license/DownloadLicensesMojo.java index dd75dbe86..b0a6bebed 100644 --- a/src/main/java/org/codehaus/mojo/license/DownloadLicensesMojo.java +++ b/src/main/java/org/codehaus/mojo/license/DownloadLicensesMojo.java @@ -82,7 +82,6 @@ protected boolean isSkip() return skipDownloadLicenses; } - @SuppressWarnings( "unchecked" ) protected Map getDependencies() { final Map result = new TreeMap<>(); diff --git a/src/main/java/org/codehaus/mojo/license/LicenseListMojo.java b/src/main/java/org/codehaus/mojo/license/LicenseListMojo.java index b8f85028a..f5e2d6ab6 100644 --- a/src/main/java/org/codehaus/mojo/license/LicenseListMojo.java +++ b/src/main/java/org/codehaus/mojo/license/LicenseListMojo.java @@ -28,6 +28,8 @@ import org.apache.maven.plugins.annotations.Parameter; import org.codehaus.mojo.license.model.License; import org.codehaus.mojo.license.model.LicenseStore; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import java.io.IOException; import java.util.Arrays; @@ -44,6 +46,7 @@ public class LicenseListMojo extends AbstractLicenseMojo { + private static final Logger LOG = LoggerFactory.getLogger( LicenseListMojo.class ); // ---------------------------------------------------------------------- // Mojo Parameters @@ -100,7 +103,7 @@ protected void init() { // obtain licenses store - licenseStore = LicenseStore.createLicenseStore( getLog(), extraResolver ); + licenseStore = LicenseStore.createLicenseStore( extraResolver ); } /** @@ -153,6 +156,6 @@ public void doAction() } } } - getLog().info( buffer.toString() ); + LOG.info( "{}", buffer ); } } diff --git a/src/main/java/org/codehaus/mojo/license/LicensesXmlInsertVersionsMojo.java b/src/main/java/org/codehaus/mojo/license/LicensesXmlInsertVersionsMojo.java index 087cbb8ef..fddcb50e9 100644 --- a/src/main/java/org/codehaus/mojo/license/LicensesXmlInsertVersionsMojo.java +++ b/src/main/java/org/codehaus/mojo/license/LicensesXmlInsertVersionsMojo.java @@ -42,6 +42,8 @@ import org.codehaus.mojo.license.download.LicensedArtifact; import org.codehaus.mojo.license.download.ProjectLicenseInfo; import org.codehaus.mojo.license.utils.FileUtil; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * Insert versions into a {@code licenses.xml} file that might have been generated by a {@code *download-licenses} mojo @@ -54,6 +56,7 @@ public class LicensesXmlInsertVersionsMojo extends AbstractLicensesXmlMojo { + private static final Logger LOG = LoggerFactory.getLogger( LicensesXmlInsertVersionsMojo.class ); /** * The file whose XML content will be used as a base for adding versions. Defaults to @@ -72,14 +75,13 @@ public class LicensesXmlInsertVersionsMojo @Parameter( property = "license.skipDownloadLicenses", defaultValue = "false" ) private boolean skipDownloadLicenses; - @SuppressWarnings( "unchecked" ) public void execute() throws MojoExecutionException, MojoFailureException { if ( skipDownloadLicenses ) { - getLog().info( "Skipping due to skipDownloadLicenses = true" ); + LOG.info( "Skipping due to skipDownloadLicenses = true" ); return; } @@ -97,8 +99,8 @@ public void execute() if ( projectLicenseInfos.isEmpty() && licensesInputFile.equals( licensesOutputFile ) ) { - getLog().info( "Nothing to do. The licensesInputFile \"" + licensesInputFile - + "\" is either empty or does not exist." ); + LOG.info( "Nothing to do. The licensesInputFile \"{}\" is either empty or does not exist.", + licensesInputFile ); return; } @@ -148,7 +150,7 @@ public ArtifactFilters getArtifactFilters() for ( ProjectLicenseInfo dependencyLicenseInfo : projectLicenseInfos ) { - getLog().debug( "Checking licenses for project " + dependencyLicenseInfo.toString() ); + LOG.debug( "Checking licenses for project {}", dependencyLicenseInfo ); final String id = dependencyLicenseInfo.getId(); final LicensedArtifact dependency = resolvedDepsMap.get( id ); if ( dependency == null ) diff --git a/src/main/java/org/codehaus/mojo/license/RemoveFileHeaderMojo.java b/src/main/java/org/codehaus/mojo/license/RemoveFileHeaderMojo.java index 49794fadf..4e0874986 100644 --- a/src/main/java/org/codehaus/mojo/license/RemoveFileHeaderMojo.java +++ b/src/main/java/org/codehaus/mojo/license/RemoveFileHeaderMojo.java @@ -32,10 +32,11 @@ import org.codehaus.mojo.license.utils.FileUtil; import org.codehaus.mojo.license.utils.MojoHelper; import org.codehaus.plexus.util.FileUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import java.io.File; import java.io.IOException; -import java.util.Arrays; import java.util.Collections; import java.util.EnumMap; import java.util.HashSet; @@ -53,6 +54,7 @@ @Mojo( name = "remove-file-header", threadSafe = true ) public class RemoveFileHeaderMojo extends AbstractLicenseNameMojo { + private static final Logger LOG = LoggerFactory.getLogger( RemoveFileHeaderMojo.class ); // ---------------------------------------------------------------------- // Mojo Parameters @@ -255,7 +257,7 @@ public void init() throws Exception String str = String.format( commentFormat, aTransformer.getName(), aTransformer.getDescription() ); buffer.append( str ); } - getLog().info( buffer.toString() ); + LOG.info( "{}", buffer ); } // set timestamp used for temporary files @@ -268,7 +270,7 @@ public void init() throws Exception roots = DEFAULT_ROOTS; if ( isVerbose() ) { - getLog().info( "Will use default roots " + Arrays.toString( roots ) ); + LOG.info( "Will use default roots {}", ( Object ) roots ); } } @@ -277,7 +279,7 @@ public void init() throws Exception includes = DEFAULT_INCLUDES; if ( isVerbose() ) { - getLog().info( "Will use default includes " + Arrays.toString( includes ) ); + LOG.info( "Will use default includes {}", ( Object ) includes ); } } @@ -286,7 +288,7 @@ public void init() throws Exception excludes = DEFAULT_EXCLUDES; if ( isVerbose() ) { - getLog().info( "Will use default excludes" + Arrays.toString( excludes ) ); + LOG.info( "Will use default excludes {}", ( Object ) excludes ); } } @@ -302,7 +304,7 @@ public void init() throws Exception { if ( isVerbose() ) { - getLog().info( "Associate extension " + extension + " to comment style " + commentStyle ); + LOG.info( "Associate extension '{}' to comment style '{}'", extension, commentStyle ); } extensionToCommentStyle.put( extension, commentStyle ); } @@ -319,8 +321,8 @@ public void init() throws Exception { // override existing extension mapping - getLog().warn( "The extension " + extension + " is already accepted for comment style " - + extensionToCommentStyle.get( extension ) ); + LOG.warn( "The extension '{}' is already accepted for comment style '{}'", + extension, extensionToCommentStyle.get( extension ) ); } String commentStyle = entry.getValue(); @@ -329,7 +331,7 @@ public void init() throws Exception if ( isVerbose() ) { - getLog().info( "Associate extension '" + extension + "' to comment style '" + commentStyle + "'" ); + LOG.info( "Associate extension '{}' to comment style '{}'", extension, commentStyle ); } extensionToCommentStyle.put( extension, commentStyle ); } @@ -372,20 +374,18 @@ public void doAction() throws Exception int nbFiles = processedFiles.size(); if ( nbFiles == 0 && !ignoreNoFileToScan ) { - getLog().warn( "No file to scan." ); + LOG.warn( "No file to scan." ); } else { String delay = MojoHelper.convertTime( System.nanoTime() - t0 ); - String message = - String.format( "Scan %s file%s header done in %s.", nbFiles, nbFiles > 1 ? "s" : "", delay ); - getLog().info( message ); + LOG.info( "Scanned {} file headers in {}.", nbFiles, delay ); } Set states = result.keySet(); if ( states.size() == 1 && states.contains( FileState.uptodate ) ) { // all files where up to date - getLog().info( "All files are up-to-date." ); + LOG.info( "All files are up-to-date." ); } else { @@ -397,7 +397,7 @@ public void doAction() throws Exception reportType( result, state, buffer ); } - getLog().info( buffer.toString() ); + LOG.info( "{}", buffer ); } } @@ -423,8 +423,8 @@ private void processCommentStyle( String commentStyle, List filesToTreat ) if ( isVerbose() ) { - getLog().info( "Process header '" + commentStyle + "'" ); - getLog().info( " - using " + license.getDescription() ); + LOG.info( "Process header '{}'", commentStyle ); + LOG.info( " - using {}", license.getDescription() ); } // use header transformer according to comment style given in header @@ -455,7 +455,7 @@ private boolean processFile( FileHeaderTransformer transformer, File file, File //check that file is not marked to be ignored if ( content.contains( ignoreTag ) ) { - getLog().info( " - ignore file (detected " + ignoreTag + ") " + file ); + LOG.info( " - ignore file (detected {}) {}", ignoreTag, file ); FileState.ignore.addFile( file, result ); @@ -491,7 +491,7 @@ private boolean processFile( FileHeaderTransformer transformer, File file, File if ( isVerbose() ) { - getLog().info( " - header was removed for " + file ); + LOG.info( " - header was removed for {}", file ); } String contentWithoutHeader = content.substring( 0, firstIndex ) + content.substring( lastIndex + 1 ); @@ -513,7 +513,7 @@ private void processFile( FileHeaderTransformer transformer, File file ) throws if ( processedFiles.contains( file ) ) { - getLog().info( " - skip already processed file " + file ); + LOG.info( " - skip already processed file {}", file ); return; } @@ -526,8 +526,10 @@ private void processFile( FileHeaderTransformer transformer, File file ) throws } catch ( Exception e ) { - getLog().warn( "skip failed file : " + e.getMessage() - + ( e.getCause() == null ? "" : " Cause : " + e.getCause().getMessage() ), e ); + LOG.warn( "skip failed file: {}{}", + e.getMessage(), + e.getCause() == null ? "" : " Cause : " + e.getCause().getMessage(), + e ); FileState.fail.addFile( file, result ); doFinalize = false; } @@ -571,11 +573,7 @@ private void finalizeFile( File file, File processFile ) throws IOException FileUtil.deleteFile( backupFile ); } - if ( isVerbose() ) - { - getLog().debug( " - backup original file " + file ); - } - + LOG.debug( " - backup original file {}", file ); FileUtil.renameFile( file, backupFile ); } @@ -595,7 +593,7 @@ private void finalizeFile( File file, File processFile ) throws IOException } catch ( IOException e ) { - getLog().warn( e.getMessage() ); + LOG.warn( e.getMessage(), e ); } } } diff --git a/src/main/java/org/codehaus/mojo/license/UpdateProjectLicenseMojo.java b/src/main/java/org/codehaus/mojo/license/UpdateProjectLicenseMojo.java index a2bb49314..0390e20e2 100644 --- a/src/main/java/org/codehaus/mojo/license/UpdateProjectLicenseMojo.java +++ b/src/main/java/org/codehaus/mojo/license/UpdateProjectLicenseMojo.java @@ -27,6 +27,8 @@ import org.apache.maven.plugins.annotations.Parameter; import org.codehaus.mojo.license.model.License; import org.codehaus.mojo.license.utils.FileUtil; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import java.io.File; @@ -45,6 +47,7 @@ public class UpdateProjectLicenseMojo extends AbstractLicenseNameMojo { + private static final Logger LOG = LoggerFactory.getLogger( UpdateProjectLicenseMojo.class ); // ---------------------------------------------------------------------- // Mojo Parameters @@ -166,17 +169,17 @@ protected void doAction() if ( doGenerate ) { - getLog().info( "Will create or update license file [" + license.getName() + "] to " + licenseFile ); + LOG.info( "Will create or update license file [{}] to {}", license.getName(), licenseFile ); if ( isVerbose() ) { - getLog().info( "detail of license :\n" + license ); + LOG.info( "detail of license :\n{}", license ); } if ( licenseFile.exists() && isKeepBackup() ) { if ( isVerbose() ) { - getLog().info( "backup " + licenseFile ); + LOG.info( "backup {}", licenseFile ); } // copy it to backup file FileUtil.backupFile( licenseFile ); diff --git a/src/main/java/org/codehaus/mojo/license/api/DefaultThirdPartyHelper.java b/src/main/java/org/codehaus/mojo/license/api/DefaultThirdPartyHelper.java index f2225b10c..a0c5ec70b 100644 --- a/src/main/java/org/codehaus/mojo/license/api/DefaultThirdPartyHelper.java +++ b/src/main/java/org/codehaus/mojo/license/api/DefaultThirdPartyHelper.java @@ -27,7 +27,6 @@ import org.apache.maven.artifact.repository.ArtifactRepository; import org.apache.maven.plugin.MojoExecutionException; import org.apache.maven.plugin.MojoFailureException; -import org.apache.maven.plugin.logging.Log; import org.apache.maven.project.MavenProject; import org.apache.maven.project.ProjectBuildingException; import org.codehaus.mojo.license.model.LicenseMap; @@ -46,6 +45,8 @@ import java.util.SortedSet; import java.util.TreeMap; import org.eclipse.aether.repository.RemoteRepository; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * Default implementation of the {@link org.codehaus.mojo.license.api.ThirdPartyHelper}. @@ -56,6 +57,7 @@ public class DefaultThirdPartyHelper implements ThirdPartyHelper { + private static final Logger LOG = LoggerFactory.getLogger( DefaultThirdPartyHelper.class ); /** * DependenciesTool to load dependencies. @@ -96,11 +98,6 @@ public class DefaultThirdPartyHelper */ private final boolean verbose; - /** - * Instance logger. - */ - private final Log log; - /** * Cache of dependencies (as maven project) loaded. */ @@ -116,13 +113,12 @@ public class DefaultThirdPartyHelper * @param thirdPartyTool tool to load third-parties descriptors * @param remoteRepositoriesCoreApi maven remote repositories, in the core api format * @param remoteRepositories maven remote repositories - * @param log logger */ // CHECKSTYLE_OFF: ParameterNumber public DefaultThirdPartyHelper( MavenProject project, String encoding, boolean verbose, DependenciesTool dependenciesTool, ThirdPartyTool thirdPartyTool, List remoteRepositoriesCoreApi, - List remoteRepositories, Log log ) + List remoteRepositories ) { // CHECKSTYLE_ON: ParameterNumber this.project = project; @@ -132,7 +128,6 @@ public DefaultThirdPartyHelper( MavenProject project, String encoding, boolean v this.thirdPartyTool = thirdPartyTool; this.remoteRepositoriesCoreApi = remoteRepositoriesCoreApi; this.remoteRepositories = remoteRepositories; - this.log = log; this.thirdPartyTool.setVerbose( verbose ); } @@ -212,7 +207,7 @@ public void attachThirdPartyDescriptor( File file ) */ public SortedSet getProjectsWithNoLicense( LicenseMap licenseMap ) { - return thirdPartyTool.getProjectsWithNoLicense( licenseMap, verbose ); + return thirdPartyTool.getProjectsWithNoLicense( licenseMap ); } /** @@ -336,7 +331,7 @@ public void mergeLicenses( List licenseMerges, LicenseMap licenseMap ) Set mergedLicense = entry.getValue(); if ( verbose ) { - log.info( "Will merge to *" + mainLicense + "*, licenses: " + mergedLicense ); + LOG.info( "Will merge to '{}', licenses: {}", mainLicense, mergedLicense ); } thirdPartyTool.mergeLicenses( licenseMap, mainLicense, mergedLicense ); diff --git a/src/main/java/org/codehaus/mojo/license/api/DefaultThirdPartyTool.java b/src/main/java/org/codehaus/mojo/license/api/DefaultThirdPartyTool.java index 56bf0a6f1..966aa7ed1 100644 --- a/src/main/java/org/codehaus/mojo/license/api/DefaultThirdPartyTool.java +++ b/src/main/java/org/codehaus/mojo/license/api/DefaultThirdPartyTool.java @@ -43,7 +43,6 @@ import java.util.regex.Matcher; import java.util.regex.Pattern; import org.apache.commons.collections.CollectionUtils; -import org.apache.commons.io.IOUtils; import org.apache.commons.lang3.ArrayUtils; import org.apache.commons.lang3.StringUtils; import org.apache.maven.artifact.Artifact; @@ -60,8 +59,6 @@ import org.codehaus.mojo.license.utils.UrlRequester; import org.codehaus.plexus.component.annotations.Component; import org.codehaus.plexus.component.annotations.Requirement; -import org.codehaus.plexus.logging.AbstractLogEnabled; -import org.codehaus.plexus.logging.Logger; import org.eclipse.aether.RepositorySystemSession; import org.eclipse.aether.artifact.DefaultArtifact; import org.eclipse.aether.artifact.DefaultArtifactType; @@ -70,6 +67,8 @@ import org.eclipse.aether.resolution.ArtifactResolutionException; import org.eclipse.aether.resolution.ArtifactResult; import org.eclipse.aether.transfer.ArtifactNotFoundException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * Default implementation of the third party tool. @@ -79,9 +78,10 @@ */ @Component( role = ThirdPartyTool.class, hint = "default" ) public class DefaultThirdPartyTool - extends AbstractLogEnabled implements ThirdPartyTool { + private static final Logger LOG = LoggerFactory.getLogger( DefaultThirdPartyTool.class ); + /** * Classifier of the third-parties descriptor attached to a maven module. */ @@ -163,36 +163,31 @@ public void attachThirdPartyDescriptor( MavenProject project, File file ) /** * {@inheritDoc} */ - public SortedSet getProjectsWithNoLicense( LicenseMap licenseMap, boolean doLog ) + public SortedSet getProjectsWithNoLicense( LicenseMap licenseMap ) { - Logger log = getLogger(); - // get unsafe dependencies (says with no license) SortedSet unsafeDependencies = licenseMap.get( LicenseMap.UNKNOWN_LICENSE_MESSAGE ); - if ( doLog ) + if ( CollectionUtils.isEmpty( unsafeDependencies ) ) { - if ( CollectionUtils.isEmpty( unsafeDependencies ) ) - { - log.debug( "There is no dependency with no license from poms." ); - } - else + LOG.debug( "There is no dependency with no license from poms." ); + } + else + { + if ( LOG.isDebugEnabled() ) { - if ( log.isDebugEnabled() ) + boolean plural = unsafeDependencies.size() > 1; + String message = String.format( "There %s %d %s with no license from poms :", + plural ? "are" : "is", + unsafeDependencies.size(), + plural ? "dependencies" : "dependency" ); + LOG.debug( message ); + for ( MavenProject dep : unsafeDependencies ) { - boolean plural = unsafeDependencies.size() > 1; - String message = String.format( "There %s %d %s with no license from poms :", - plural ? "are" : "is", - unsafeDependencies.size(), - plural ? "dependencies" : "dependency" ); - log.debug( message ); - for ( MavenProject dep : unsafeDependencies ) - { - - // no license found for the dependency - log.debug( " - " + MojoHelper.getArtifactId( dep.getArtifact() ) ); - } + + // no license found for the dependency + LOG.debug( " - {}", MojoHelper.getArtifactId( dep.getArtifact() ) ); } } } @@ -235,10 +230,7 @@ public SortedProperties loadThirdPartyDescriptorsForUnsafeMapping( Set if ( thirdPartyDescriptor != null && thirdPartyDescriptor.exists() && thirdPartyDescriptor.length() > 0 ) { - if ( getLogger().isInfoEnabled() ) - { - getLogger().info( "Detects third party descriptor " + thirdPartyDescriptor ); - } + LOG.info( "Detects third party descriptor {}", thirdPartyDescriptor ); // there is a third party file detected form the given dependency SortedProperties unsafeMappings = new SortedProperties( encoding ); @@ -246,7 +238,7 @@ public SortedProperties loadThirdPartyDescriptorsForUnsafeMapping( Set if ( thirdPartyDescriptor.exists() ) { - getLogger().info( "Load missing file " + thirdPartyDescriptor ); + LOG.info( "Load missing file {}", thirdPartyDescriptor ); // load the missing file unsafeMappings.load( thirdPartyDescriptor ); @@ -322,7 +314,7 @@ public File resolvThirdPartyDescriptor( MavenProject project, List lic String id = MojoHelper.getArtifactId( project.getArtifact() ); if ( o == null ) { - getLogger().warn( "could not acquire the license for " + id ); + LOG.warn( "could not acquire the license for {}", id ); continue; } License license = (License) o; @@ -397,13 +389,13 @@ public void addLicense( LicenseMap licenseMap, MavenProject project, List lic if ( StringUtils.isEmpty( license.getName() ) ) { - getLogger().warn( "The license for " + id + " has no name (but exist)" ); + LOG.warn( "The license for {} has no name (but exist)", id ); licenseKey = license.getUrl(); } if ( StringUtils.isEmpty( licenseKey ) ) { - getLogger().warn( "No license url defined for " + id ); + LOG.warn( "No license url defined for {}", id ); licenseKey = LicenseMap.UNKNOWN_LICENSE_MESSAGE; } licenseMap.put( licenseKey, project ); @@ -428,7 +420,7 @@ public void mergeLicenses( LicenseMap licenseMap, String mainLicense, Set( projectComparator ); licenseMap.put( mainLicense, mainSet ); @@ -440,14 +432,14 @@ public void mergeLicenses( LicenseMap licenseMap, String mainLicense, Set unsafeDependencies = getProjectsWithNoLicense( licenseMap, false ); + SortedSet unsafeDependencies = getProjectsWithNoLicense( licenseMap ); SortedProperties unsafeMappings = new SortedProperties( encoding ); @@ -495,7 +487,7 @@ public SortedProperties loadUnsafeMapping( LicenseMap licenseMap, { // there is some unsafe dependencies - getLogger().info( "Load missing file " + missingFile ); + LOG.info( "Load missingFile {}", missingFile ); // load the missing file unsafeMappings.load( missingFile ); @@ -530,7 +522,7 @@ public SortedProperties loadUnsafeMapping( LicenseMap licenseMap, { // migrates id to migratedId - getLogger().info( "Migrates [" + id + "] to [" + migratedId + "] in the missing file." ); + LOG.info( "Migrates [{}] to [{}] in the missing file.", id, migratedId ); Object value = unsafeMappings.get( id ); unsafeMappings.remove( id ); unsafeMappings.put( migratedId, value ); @@ -544,8 +536,8 @@ public SortedProperties loadUnsafeMapping( LicenseMap licenseMap, // there is some unknown dependencies in the missing file, remove them for ( String id : unknownDependenciesId ) { - getLogger().warn( - "dependency [" + id + "] does not exist in project, remove it from the missing file." ); + LOG.warn( + "dependency [{}] does not exist in project, remove it from the missing file.", id ); unsafeMappings.remove( id ); } @@ -560,7 +552,7 @@ public SortedProperties loadUnsafeMapping( LicenseMap licenseMap, MavenProject project = artifactCache.get( id ); if ( project == null ) { - getLogger().warn( "dependency [" + id + "] does not exist in project." ); + LOG.warn( "dependency [{}] does not exist in project.", id ); continue; } @@ -595,10 +587,7 @@ public SortedProperties loadUnsafeMapping( LicenseMap licenseMap, for ( MavenProject project : unsafeDependencies ) { String id = MojoHelper.getArtifactId( project.getArtifact() ); - if ( getLogger().isDebugEnabled() ) - { - getLogger().debug( "dependency [" + id + "] has no license, add it in the missing file." ); - } + LOG.debug( "dependency [{}] has no license, add it in the missing file.", id ); unsafeMappings.setProperty( id, "" ); } } @@ -625,7 +614,7 @@ public void overrideLicenses( LicenseMap licenseMap, SortedMap properties = new HashMap<>(); properties.put( "licenseMap", licenseMap.entrySet() ); properties.put( "dependencyMap", licenseMap.toDependencyMap().entrySet() ); String content = freeMarkerHelper.renderTemplate( lineFormat, properties ); - log.info( "Writing third-party file to " + thirdPartyFile ); + LOG.info( "Writing third-party file to " + thirdPartyFile ); if ( verbose ) { - log.info( content ); + LOG.info( content ); } FileUtil.printString( thirdPartyFile, content, encoding ); @@ -683,7 +670,7 @@ public void writeBundleThirdPartyFile( File thirdPartyFile, File outputDirectory // creates the bundled license file File bundleTarget = FileUtil.getFile( outputDirectory, bundleThirdPartyPath ); - getLogger().info( "Writing bundled third-party file to " + bundleTarget ); + LOG.info( "Writing bundled third-party file to {}", bundleTarget ); FileUtil.copyFile( thirdPartyFile, bundleTarget ); } @@ -711,19 +698,17 @@ private void loadOneGlobalSet( SortedSet unsafeDependencies, Licen { File propFile = resolveArtifact( dep.getGroupId(), dep.getArtifactId(), dep.getVersion(), dep.getType(), dep.getClassifier(), remoteRepositories ); - getLogger().info( - String.format( "Loading global license map from %s: %s", dep.toString(), propFile.getAbsolutePath() ) ); + LOG.info( + "Loading global license map from {}: {}", dep.toString(), propFile.getAbsolutePath() ); SortedProperties props = new SortedProperties( "utf-8" ); - InputStream propStream = null; - try + try ( InputStream propStream = new FileInputStream( propFile ) ) { - propStream = new FileInputStream( propFile ); props.load( propStream ); } - finally + catch ( IOException e ) { - IOUtils.closeQuietly( propStream ); + throw new IOException( "Unable to load " + propFile.getAbsolutePath(), e ); } for ( Object keyObj : props.keySet() ) @@ -761,7 +746,7 @@ private File resolveThirdPartyDescriptor( MavenProject project, List loadProjectDependencies( ResolvedProjectD { localCache.putAll( cache ); } - final Logger log = getLogger(); - ProjectBuildingRequest projectBuildingRequest = new DefaultProjectBuildingRequest( mavenSession.getProjectBuildingRequest() ) .setValidationLevel( ModelBuildingRequest.VALIDATION_LEVEL_MINIMAL ) @@ -146,10 +144,7 @@ public SortedMap loadProjectDependencies( ResolvedProjectD if ( !artifactFilters.isIncluded( artifact ) ) { - if ( verbose ) - { - log.debug( "Excluding artifact " + artifact ); - } + LOG.debug( "Excluding artifact {}", artifact ); continue; } @@ -157,7 +152,7 @@ public SortedMap loadProjectDependencies( ResolvedProjectD if ( verbose ) { - log.info( "detected artifact " + id ); + LOG.info( "detected artifact {}", id ); } MavenProject depMavenProject; @@ -169,7 +164,7 @@ public SortedMap loadProjectDependencies( ResolvedProjectD { if ( verbose ) { - log.info( "add dependency [" + id + "] (from cache)" ); + LOG.info( "add dependency [{}] (from cache)", id ); } } else @@ -201,13 +196,13 @@ public SortedMap loadProjectDependencies( ResolvedProjectD } catch ( ProjectBuildingException e ) { - log.warn( "Unable to obtain POM for artifact : " + artifact, e ); + LOG.warn( "Unable to obtain POM for artifact: {}", artifact, e ); continue; } if ( verbose ) { - log.info( "add dependency [" + id + "]" ); + LOG.info( "add dependency [{}]", id ); } // store it also in cache diff --git a/src/main/java/org/codehaus/mojo/license/api/ThirdPartyTool.java b/src/main/java/org/codehaus/mojo/license/api/ThirdPartyTool.java index eb782ee88..8ce799e2d 100644 --- a/src/main/java/org/codehaus/mojo/license/api/ThirdPartyTool.java +++ b/src/main/java/org/codehaus/mojo/license/api/ThirdPartyTool.java @@ -127,7 +127,7 @@ File resolveMissingLicensesDescriptor( String groupId, String artifactId, String * @param doLog a flag to add debug logs * @return the set of projects with no license */ - SortedSet getProjectsWithNoLicense( LicenseMap licenseMap, boolean doLog ); + SortedSet getProjectsWithNoLicense( LicenseMap licenseMap ); /** * Loads unsafe mapping and returns it. diff --git a/src/main/java/org/codehaus/mojo/license/download/LicenseDownloader.java b/src/main/java/org/codehaus/mojo/license/download/LicenseDownloader.java index 446949b93..3a29d9c0b 100644 --- a/src/main/java/org/codehaus/mojo/license/download/LicenseDownloader.java +++ b/src/main/java/org/codehaus/mojo/license/download/LicenseDownloader.java @@ -66,10 +66,11 @@ import org.apache.http.impl.conn.DefaultProxyRoutePlanner; import org.apache.http.protocol.HttpContext; import org.apache.maven.plugin.MojoFailureException; -import org.apache.maven.plugin.logging.Log; import org.apache.maven.settings.Proxy; import org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments.ContentSanitizer; import org.codehaus.mojo.license.utils.FileUtil; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * Utilities for downloading remote license files. @@ -79,6 +80,7 @@ */ public class LicenseDownloader implements AutoCloseable { + private static final Logger LOG = LoggerFactory.getLogger( LicenseDownloader.class ); private static final Pattern EXTENSION_PATTERN = Pattern.compile( "\\.[a-z]{1,4}$", Pattern.CASE_INSENSITIVE ); @@ -160,13 +162,12 @@ protected HttpHost determineProxy( HttpHost target, HttpRequest request, HttpCon * * @param licenseUrlString the URL * @param outputFile a hint where to store the license file - * @param log * @return the path to the file where the downloaded license file was stored * @throws IOException * @throws URISyntaxException * @throws MojoFailureException */ - public LicenseDownloadResult downloadLicense( String licenseUrlString, FileNameEntry fileNameEntry, Log log ) + public LicenseDownloadResult downloadLicense( String licenseUrlString, FileNameEntry fileNameEntry ) throws IOException, URISyntaxException, MojoFailureException { final File outputFile = fileNameEntry.getFile(); @@ -179,7 +180,7 @@ public LicenseDownloadResult downloadLicense( String licenseUrlString, FileNameE if ( licenseUrlString.startsWith( "file://" ) ) { - log.debug( "Downloading '" + licenseUrlString + "' -> '" + outputFile + "'" ); + LOG.debug( "Downloading '{}' -> '{}'", licenseUrlString, outputFile ); Path in = Paths.get( new URI( licenseUrlString ) ); if ( sanitizers.isEmpty() ) { @@ -196,7 +197,7 @@ public LicenseDownloadResult downloadLicense( String licenseUrlString, FileNameE } else { - log.debug( "About to download '" + licenseUrlString + "'" ); + LOG.debug( "About to download '{}'", licenseUrlString ); try ( CloseableHttpResponse response = client.execute( new HttpGet( licenseUrlString ) ) ) { final StatusLine statusLine = response.getStatusLine(); @@ -215,8 +216,10 @@ public LicenseDownloadResult downloadLicense( String licenseUrlString, FileNameE File updatedFile = fileNameEntry.isPreferred() ? outputFile : updateFileExtension( outputFile, contentType != null ? contentType.getMimeType() : null ); - log.debug( "Downloading '" + licenseUrlString + "' -> '" + updatedFile + "'" - + ( fileNameEntry.isPreferred() ? " (preferred file name)" : "" ) ); + LOG.debug( "Downloading '{}' -> '{}'{}", + licenseUrlString, + updatedFile, + fileNameEntry.isPreferred() ? " (preferred file name)" : "" ); if ( sanitizers.isEmpty() ) { diff --git a/src/main/java/org/codehaus/mojo/license/download/LicensedArtifactResolver.java b/src/main/java/org/codehaus/mojo/license/download/LicensedArtifactResolver.java index c95d554df..f5896f9aa 100644 --- a/src/main/java/org/codehaus/mojo/license/download/LicensedArtifactResolver.java +++ b/src/main/java/org/codehaus/mojo/license/download/LicensedArtifactResolver.java @@ -43,8 +43,8 @@ import org.codehaus.mojo.license.download.LicensedArtifact.Builder; import org.codehaus.plexus.component.annotations.Component; import org.codehaus.plexus.component.annotations.Requirement; -import org.codehaus.plexus.logging.AbstractLogEnabled; -import org.codehaus.plexus.logging.Logger; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * A tool to deal with dependencies of a project. @@ -54,8 +54,8 @@ */ @Component( role = LicensedArtifactResolver.class, hint = "default" ) public class LicensedArtifactResolver - extends AbstractLogEnabled { + private static final Logger LOG = LoggerFactory.getLogger( LicensedArtifactResolver.class ); /** * Message used when an invalid expression pattern is found. @@ -113,8 +113,6 @@ public void loadProjectDependencies( ResolvedProjectDependencies artifacts, final Map excludeArtifacts = new HashMap<>(); final Map includeArtifacts = new HashMap<>(); - final Logger log = getLogger(); - ProjectBuildingRequest projectBuildingRequest = new DefaultProjectBuildingRequest( mavenSession.getProjectBuildingRequest() ) .setRemoteRepositories( remoteRepositories ) @@ -137,10 +135,7 @@ public void loadProjectDependencies( ResolvedProjectDependencies artifacts, if ( !artifactFilters.isIncluded( artifact ) ) { - if ( verbose ) - { - log.debug( "Excluding artifact " + artifact ); - } + LOG.debug( "Excluding artifact {}", artifact ); continue; } @@ -148,7 +143,7 @@ public void loadProjectDependencies( ResolvedProjectDependencies artifacts, if ( verbose ) { - log.info( "detected artifact " + id ); + LOG.info( "detected artifact {}", id ); } LicensedArtifact depMavenProject; @@ -158,7 +153,7 @@ public void loadProjectDependencies( ResolvedProjectDependencies artifacts, if ( depMavenProject != null ) { - log.debug( "Dependency [" + id + "] already present in the result" ); + LOG.debug( "Dependency [{}] already present in the result", id ); } else { @@ -170,7 +165,6 @@ public void loadProjectDependencies( ResolvedProjectDependencies artifacts, final MavenProject project = mavenProjectBuilder .build( artifact, true, projectBuildingRequest ) .getProject(); - @SuppressWarnings( "unchecked" ) List lics = project.getLicenses(); if ( lics != null ) { @@ -191,7 +185,7 @@ public void loadProjectDependencies( ResolvedProjectDependencies artifacts, if ( verbose ) { - log.info( "add dependency [" + id + "]" ); + LOG.info( "add dependency [{}]", id ); } result.put( id, depMavenProject ); diff --git a/src/main/java/org/codehaus/mojo/license/download/PreferredFileNames.java b/src/main/java/org/codehaus/mojo/license/download/PreferredFileNames.java index 817d633ff..7cd03b12a 100644 --- a/src/main/java/org/codehaus/mojo/license/download/PreferredFileNames.java +++ b/src/main/java/org/codehaus/mojo/license/download/PreferredFileNames.java @@ -39,11 +39,12 @@ import java.util.TreeSet; import java.util.regex.Pattern; -import org.apache.maven.plugin.logging.Log; import org.codehaus.mojo.license.spdx.SpdxLicenseInfo; import org.codehaus.mojo.license.spdx.SpdxLicenseInfo.Attachments.UrlInfo; import org.codehaus.mojo.license.spdx.SpdxLicenseList; import org.codehaus.mojo.license.utils.FileUtil; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * An url -> {@link FileNameEntry} mapping. @@ -54,14 +55,13 @@ // CHECKSTYLE_OFF: MethodLength public class PreferredFileNames { + private static final Logger LOG = LoggerFactory.getLogger( PreferredFileNames.class ); /** * @param licensesOutputDirectory * @param licenseUrlFileNames - * @param log * @return a new {@link PreferredFileNames} built of AbstractDownloadLicensesMojo.licenseUrlFileNames */ - public static PreferredFileNames build( File licensesOutputDirectory, Map licenseUrlFileNames, - Log log ) + public static PreferredFileNames build( File licensesOutputDirectory, Map licenseUrlFileNames ) { final Map>> fileNameToUrlPatterns = new LinkedHashMap<>(); final Map sha1TofileName = new LinkedHashMap(); @@ -71,7 +71,7 @@ public static PreferredFileNames build( File licensesOutputDirectory, Map en : licenseUrlFileNames.entrySet() ) @@ -119,17 +119,17 @@ else if ( en.getValue() != null ) } } } - return new PreferredFileNames( licensesOutputDirectory, fileNameToUrlPatterns, sha1TofileName, log ); + return new PreferredFileNames( licensesOutputDirectory, fileNameToUrlPatterns, sha1TofileName ); } - private static void spdx( Log log, Map>> result, + private static void spdx( Map>> result, Map sha1TofileName ) { final Map>> fileNameToUrlPatterns = new TreeMap<>(); final SpdxLicenseList spdxList = SpdxLicenseList.getLatest(); final Map lics = spdxList.getLicenses(); - log.info( "Honoring " + lics.size() + " SPDX licenses" ); + LOG.info( "Honoring {} SPDX licenses", lics.size() ); /* Count in how many licenses is the given sha1 used */ final Map> sha1ToLicenseIds = new HashMap<>(); @@ -239,8 +239,8 @@ else if ( !( avail.getKey() == useSha1 || ( avail.getKey() != null && avail.getKey().equals( useSha1 ) ) ) || !isEqual( usePatterns, avail.getValue() ) ) { - log.warn( "Available: " + fileName + ", " + avail.getKey() + ", " + avail.getValue() ); - log.warn( "To add : " + fileName + ", " + useSha1 + ", " + patterns ); + LOG.warn( "Available: {}, {}, {}", fileName, avail.getKey(), avail.getValue() ); + LOG.warn( "To add : {}, {}, {}", fileName, useSha1, patterns ); throw new IllegalStateException( fileName + " already present" ); } @@ -248,7 +248,7 @@ else if ( !( avail.getKey() == useSha1 } } - if ( log.isDebugEnabled() ) + if ( LOG.isDebugEnabled() ) { final StringBuilder sb = new StringBuilder(); sb.append( "\n" ); @@ -271,8 +271,8 @@ else if ( !( avail.getKey() == useSha1 } sb.append( "\n" ); - log.debug( "SPDX licenseUrlFileNames:" ); - log.debug( sb.toString() ); + LOG.debug( "SPDX licenseUrlFileNames:" ); + LOG.debug( sb.toString() ); } result.putAll( fileNameToUrlPatterns ); } @@ -298,17 +298,15 @@ private static boolean isEqual( final List newPatterns, List o private final File licensesOutputDirectory; private final Map>> fileNameToUrlPatterns; private final Map sha1ToFileName; - private final Log log; public PreferredFileNames( File licensesOutputDirectory, Map>> fileNameToUrlPatterns, - Map sha1ToFileName, Log log ) + Map sha1ToFileName ) { super(); this.licensesOutputDirectory = licensesOutputDirectory; this.fileNameToUrlPatterns = fileNameToUrlPatterns; this.sha1ToFileName = sha1ToFileName; - this.log = log; } /** @@ -332,8 +330,10 @@ public FileNameEntry getEntryByUrl( String url ) { if ( pat.matcher( url ).matches() ) { - log.debug( "Using file name '" + fn.getKey() + "' for URL '" + url + "' that matched pattern '" - + pat.pattern() + "'" ); + LOG.debug( "Using file name '{}' for URL '{}' that matched pattern '{}'", + fn.getKey(), + url, + pat.pattern() ); return new FileNameEntry( new File( licensesOutputDirectory, fn.getKey() ), true, fn.getValue().getKey() ); } diff --git a/src/main/java/org/codehaus/mojo/license/download/UrlReplacements.java b/src/main/java/org/codehaus/mojo/license/download/UrlReplacements.java index 9db4f8154..703745db5 100644 --- a/src/main/java/org/codehaus/mojo/license/download/UrlReplacements.java +++ b/src/main/java/org/codehaus/mojo/license/download/UrlReplacements.java @@ -29,9 +29,10 @@ import java.util.List; import java.util.Set; -import org.apache.maven.plugin.logging.Log; import org.codehaus.mojo.license.spdx.SpdxLicenseList; import org.codehaus.mojo.license.spdx.SpdxLicenseList.Attachments.UrlReplacement; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * Applies manually configured license URL replacements as well as the default ones a necessary. @@ -41,21 +42,19 @@ */ public class UrlReplacements { + private static final Logger LOG = LoggerFactory.getLogger( UrlReplacements.class ); - public static Builder builder( Log log ) + public static Builder builder() { - return new Builder( log ); + return new Builder(); } private final List replacements; - private final Log log; - - UrlReplacements( List replacements, Log log ) + UrlReplacements( List replacements ) { super(); this.replacements = replacements; - this.log = log; } public String rewriteIfNecessary( final String originalLicenseUrl ) @@ -66,9 +65,9 @@ public String rewriteIfNecessary( final String originalLicenseUrl ) resultUrl = r.getUrlPattern().matcher( resultUrl ).replaceAll( r.getReplacement() ); } - if ( log.isDebugEnabled() && !resultUrl.equals( originalLicenseUrl ) ) + if ( LOG.isDebugEnabled() && !resultUrl.equals( originalLicenseUrl ) ) { - log.debug( String.format( "Rewrote URL %s => %s", originalLicenseUrl, resultUrl ) ); + LOG.debug( "Rewrote URL {} => {}", originalLicenseUrl, resultUrl ); } return resultUrl; } @@ -82,17 +81,10 @@ public static class Builder { private List replacements = new ArrayList<>(); - private final Log log; - private boolean useDefaults; private Set ids = new HashSet<>(); - public Builder( Log log ) - { - this.log = log; - } - public Builder replacement( String id, String urlPattern, String replacement ) { @@ -130,7 +122,7 @@ public UrlReplacements build() } } - if ( usedDefaults > 0 && log.isDebugEnabled() ) + if ( usedDefaults > 0 && LOG.isDebugEnabled() ) { final StringBuilder sb = new StringBuilder(); sb.append( "Appending " + usedDefaults + " default licenseUrlReplacements:\n" ) @@ -156,12 +148,12 @@ public UrlReplacements build() } sb .append( "\n" ); - log.debug( sb.toString() ); + LOG.debug( sb.toString() ); } } List rs = Collections.unmodifiableList( replacements ); replacements = null; - return new UrlReplacements( rs, log ); + return new UrlReplacements( rs ); } } } diff --git a/src/main/java/org/codehaus/mojo/license/header/FileHeaderFilter.java b/src/main/java/org/codehaus/mojo/license/header/FileHeaderFilter.java index cc5e72499..7379902f9 100644 --- a/src/main/java/org/codehaus/mojo/license/header/FileHeaderFilter.java +++ b/src/main/java/org/codehaus/mojo/license/header/FileHeaderFilter.java @@ -22,9 +22,10 @@ * #L% */ -import org.apache.maven.plugin.logging.Log; import org.codehaus.mojo.license.header.transformer.FileHeaderTransformer; import org.nuiton.processor.filters.DefaultFilter; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * File Header filter. @@ -35,6 +36,7 @@ public abstract class FileHeaderFilter extends DefaultFilter { + private static final Logger LOG = LoggerFactory.getLogger( FileHeaderFilter.class ); /** * flag set to {@code true} when a header was detected (says detects both @@ -77,11 +79,6 @@ public abstract class FileHeaderFilter */ protected String fullHeaderContent; - /** - * maven logger. - */ - protected Log log; - /** * Obtains the new header to use according to the old one. * @@ -100,34 +97,14 @@ public FileHeaderFilter() { } - /** - * @return logger - */ - public Log getLog() - { - return log; - } - - /** - * Sets the logger. - * - * @param log logger to use - */ - public void setLog( Log log ) - { - this.log = log; - } - /** * {@inheritDoc} */ @Override protected String performInFilter( String ch ) { - if ( log.isDebugEnabled() ) - { - log.debug( "performInFilter - original header =\n" + ch ); - } + LOG.debug( "performInFilter - original header =\n{}", ch ); + if ( isTouched() ) { // Can NOT authorize two header in a same source @@ -179,10 +156,7 @@ protected String performInFilter( String ch ) @Override protected String performOutFilter( String ch ) { - if ( log.isDebugEnabled() ) - { - log.debug( ch ); - } + LOG.debug( ch ); return ch; } diff --git a/src/main/java/org/codehaus/mojo/license/header/UpdateFileHeaderFilter.java b/src/main/java/org/codehaus/mojo/license/header/UpdateFileHeaderFilter.java index 90c3b682f..33752447c 100644 --- a/src/main/java/org/codehaus/mojo/license/header/UpdateFileHeaderFilter.java +++ b/src/main/java/org/codehaus/mojo/license/header/UpdateFileHeaderFilter.java @@ -24,6 +24,8 @@ import org.codehaus.mojo.license.header.transformer.FileHeaderTransformer; import org.codehaus.mojo.license.model.Copyright; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * Implementation of {@link FileHeaderFilter} to update an incoming header. @@ -33,6 +35,7 @@ */ public class UpdateFileHeaderFilter extends FileHeaderFilter { + private static final Logger LOG = LoggerFactory.getLogger( UpdateFileHeaderFilter.class ); /** * Flag sets to {@code true} if description can be updated. @@ -68,14 +71,11 @@ protected FileHeader getNewHeader( FileHeader oldHeader ) if ( isUpdateDescription() && !transformer.isDescriptionEquals( oldHeader, newHeader ) ) { - // can update description and it has changed - if ( log.isDebugEnabled() ) - { - log.debug( "description has changed from [" + oldHeader.getDescription() + "] to [" - + newHeader.getDescription() + "]" ); - } + LOG.debug( "description has changed from [{}] to [{}]", + oldHeader.getDescription(), + newHeader.getDescription() ); // description has changed, mark header to be updated modified = true; @@ -86,14 +86,11 @@ protected FileHeader getNewHeader( FileHeader oldHeader ) if ( isUpdateCopyright() && !transformer.isCopyrightEquals( oldHeader, newHeader ) ) { - // can update copyright and it has changed - if ( log.isDebugEnabled() ) - { - log.debug( "copyright has changed from [" + oldHeader.getCopyright() + "] to [" - + newHeader.getCopyright() + "]" ); - } + LOG.debug( "copyright has changed from [{}] to [{}]", + oldHeader.getCopyright(), + newHeader.getCopyright() ); // description has changed, mark header to be updated modified = true; @@ -104,14 +101,11 @@ protected FileHeader getNewHeader( FileHeader oldHeader ) if ( isUpdateLicense() && !transformer.isLicenseEquals( oldHeader, newHeader ) ) { - // can update license and it has changed - if ( log.isDebugEnabled() ) - { - log.debug( "license has changed from [" + oldHeader.getLicense() + "] to [" + newHeader.getLicense() - + "]" ); - } + LOG.debug( "license has changed from [{}] to [{}]", + oldHeader.getLicense(), + newHeader.getLicense() ); // description has changed, mark header to be updated modified = true; diff --git a/src/main/java/org/codehaus/mojo/license/model/LicenseRepository.java b/src/main/java/org/codehaus/mojo/license/model/LicenseRepository.java index 748d66d4a..936cae508 100644 --- a/src/main/java/org/codehaus/mojo/license/model/LicenseRepository.java +++ b/src/main/java/org/codehaus/mojo/license/model/LicenseRepository.java @@ -23,9 +23,9 @@ */ import org.apache.commons.lang3.StringUtils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; import org.codehaus.mojo.license.utils.MojoHelper; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import java.io.IOException; import java.net.URL; @@ -46,11 +46,7 @@ public class LicenseRepository implements Iterable { - - /** - * Logger. - */ - private static final Log LOG = LogFactory.getLog( LicenseRepository.class ); + private static final Logger LOG = LoggerFactory.getLogger( LicenseRepository.class ); public static final String REPOSITORY_DEFINITION_FILE = "licenses.properties"; @@ -160,14 +156,8 @@ public void load() license.setDescription( licenseDescription ); - if ( LOG.isInfoEnabled() ) - { - LOG.info( "register " + license.getDescription() ); - } - if ( LOG.isDebugEnabled() ) - { - LOG.debug( license ); - } + LOG.info( "register {}", license.getDescription() ); + LOG.debug( "{}", license ); licenses.add( license ); } licenses = Collections.unmodifiableList( licenses ); diff --git a/src/main/java/org/codehaus/mojo/license/model/LicenseStore.java b/src/main/java/org/codehaus/mojo/license/model/LicenseStore.java index aa396ad80..294bde270 100644 --- a/src/main/java/org/codehaus/mojo/license/model/LicenseStore.java +++ b/src/main/java/org/codehaus/mojo/license/model/LicenseStore.java @@ -23,9 +23,9 @@ */ import org.apache.commons.lang3.StringUtils; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; import org.apache.maven.plugin.MojoExecutionException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import java.io.IOException; import java.net.URL; @@ -47,7 +47,7 @@ public class LicenseStore /** * Logger. */ - private static final Log LOG = LogFactory.getLog( LicenseStore.class ); + private static final Logger LOG = LoggerFactory.getLogger( LicenseStore.class ); /** * class-path directory where is the licenses repository. @@ -69,7 +69,7 @@ public class LicenseStore */ protected boolean init; - public static LicenseStore createLicenseStore( org.apache.maven.plugin.logging.Log log, String... extraResolver ) + public static LicenseStore createLicenseStore( String... extraResolver ) throws MojoExecutionException { LicenseStore store; @@ -83,7 +83,7 @@ public static LicenseStore createLicenseStore( org.apache.maven.plugin.logging.L { if ( StringUtils.isNotEmpty( s ) ) { - log.info( "adding extra resolver " + s ); + LOG.info( "adding extra resolver {}", s ); store.addRepository( s ); } } @@ -174,9 +174,9 @@ public License getLicense( String licenseName ) break; } } - if ( result == null && LOG.isDebugEnabled() ) + if ( result == null ) { - LOG.debug( "could not find license named '" + licenseName + "'" ); + LOG.debug( "could not find license named '{}'", licenseName ); } return result; } @@ -192,10 +192,7 @@ public void addRepository( String extraResolver ) else if ( extraResolver.startsWith( CLASSPATH_PROTOCOL ) ) { extraResolver = extraResolver.substring( CLASSPATH_PROTOCOL.length() ); - if ( LOG.isDebugEnabled() ) - { - LOG.info( "Using classpath extraresolver: " + extraResolver ); - } + LOG.info( "Using classpath extraresolver: {}", extraResolver ); URL baseURL = getClass().getClassLoader().getResource( extraResolver ); addRepository( baseURL ); } @@ -212,10 +209,7 @@ public void addRepository( URL baseURL ) checkNotInit( "addRepository" ); LicenseRepository repository = new LicenseRepository(); repository.setBaseURL( baseURL ); - if ( LOG.isDebugEnabled() ) - { - LOG.debug( "Adding a license repository " + repository ); - } + LOG.debug( "Adding a license repository {}", repository ); addRepository( repository ); } @@ -226,10 +220,7 @@ public void addJarRepository() URL baseURL = getClass().getResource( JAR_LICENSE_REPOSITORY ); LicenseRepository repository = new LicenseRepository(); repository.setBaseURL( baseURL ); - if ( LOG.isDebugEnabled() ) - { - LOG.debug( "Adding a jar license repository " + repository ); - } + LOG.debug( "Adding a jar license repository {}", repository ); addRepository( repository ); } @@ -237,10 +228,7 @@ public void addRootPackageClassPathRepository() throws IOException { checkNotInit( "addRootPackageClassPathRepository" ); - if ( LOG.isDebugEnabled() ) - { - LOG.debug( "Adding a no package class path license repository " ); - } + LOG.debug( "Adding a no package class path license repository " ); addRepository( new RootPackageClassPathLicenseRepository() ); } @@ -260,10 +248,7 @@ protected void addRepository( LicenseRepository repository ) repositories = new ArrayList<>(); } - if ( LOG.isInfoEnabled() ) - { - LOG.info( "Adding a license repository " + repository.getBaseURL() ); - } + LOG.info( "Adding a license repository {}", repository.getBaseURL() ); repositories.add( repository ); } diff --git a/src/test/java/org/codehaus/mojo/license/api/FreeMarkerHelperTest.java b/src/test/java/org/codehaus/mojo/license/api/FreeMarkerHelperTest.java index e7890349f..7f285c95f 100644 --- a/src/test/java/org/codehaus/mojo/license/api/FreeMarkerHelperTest.java +++ b/src/test/java/org/codehaus/mojo/license/api/FreeMarkerHelperTest.java @@ -25,14 +25,14 @@ import java.util.HashMap; import java.util.Map; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; import org.apache.maven.artifact.DefaultArtifact; import org.apache.maven.artifact.versioning.VersionRange; import org.apache.maven.project.MavenProject; import org.codehaus.mojo.license.model.LicenseMap; import org.junit.Assert; import org.junit.Test; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; /** * Tests the {@link FreeMarkerHelper} and given templates. @@ -42,10 +42,7 @@ */ public class FreeMarkerHelperTest { - /** - * Logger. - */ - private static final Log log = LogFactory.getLog( FreeMarkerHelperTest.class ); + private static final Logger LOG = LoggerFactory.getLogger(FreeMarkerHelperTest.class); @Test public void testRenderTemplateForThirdPartyFile() @@ -79,10 +76,7 @@ public void testRenderTemplateForThirdPartyFile() properties.put( "dependencyMap", licenseMap.toDependencyMap().entrySet() ); String s = helper.renderTemplate( "/org/codehaus/mojo/license/third-party-file.ftl", properties ); - if ( log.isInfoEnabled() ) - { - log.info( s ); - } + LOG.info( "{}", s ); } @Test @@ -118,10 +112,7 @@ public void testRenderTemplateForThirdPartyFileGroupByLicense() String s = helper.renderTemplate( "/org/codehaus/mojo/license/third-party-file-groupByLicense.ftl", properties ); - if ( log.isInfoEnabled() ) - { - log.info( s ); - } + LOG.info( "{}", s ); } @Test @@ -149,9 +140,6 @@ public void testRenderTemplateForUpdateFileHeader() String s = helper.renderTemplate( "/org/codehaus/mojo/license/default-file-header-description.ftl", properties ); Assert.assertEquals( "projectName\n$Id:$\n$HeadURL:$", s ); - if ( log.isInfoEnabled() ) - { - log.info( s ); - } + LOG.info( "{}", s ); } } diff --git a/src/test/java/org/codehaus/mojo/license/download/LicenseMatchersTest.java b/src/test/java/org/codehaus/mojo/license/download/LicenseMatchersTest.java index f0a67d16a..b08ad9d44 100644 --- a/src/test/java/org/codehaus/mojo/license/download/LicenseMatchersTest.java +++ b/src/test/java/org/codehaus/mojo/license/download/LicenseMatchersTest.java @@ -22,7 +22,6 @@ * #L% */ -import java.util.ArrayList; import java.util.List; import org.codehaus.mojo.license.download.LicenseMatchers.DependencyMatcher;