Merge pull request #257 from ppalaga/i252

Fix #252 Add writeVersions parameter to AbstractDownloadLicensesMojo

src/it/download-licenses-file-names/licenses-cleanLicDir.expected.xml

@@ -4,20 +4,18 @@
     <dependency>
       <groupId>antlr</groupId>
       <artifactId>antlr</artifactId>
-      <version>2.7.7</version>
       <licenses>
         <license>
           <name>BSD License</name>
           <url>http://www.antlr.org/license.html</url>
           <distribution>repo</distribution>
-          <file>bsd-antlr.html</file>
+          <file>bsd-license-from-config.html</file>
         </license>
       </licenses>
     </dependency>
     <dependency>
       <groupId>com.sun.activation</groupId>
       <artifactId>javax.activation</artifactId>
-      <version>1.2.0</version>
       <licenses>
         <license>
           <name>CDDL/GPLv2+CE</name>
@@ -31,7 +29,6 @@
     <dependency>
       <groupId>commons-beanutils</groupId>
       <artifactId>commons-beanutils</artifactId>
-      <version>1.9.3</version>
       <licenses>
         <license>
           <name>Apache License, Version 2.0</name>
@@ -44,7 +41,6 @@
     <dependency>
       <groupId>commons-collections</groupId>
       <artifactId>commons-collections</artifactId>
-      <version>3.2.2</version>
       <licenses>
         <license>
           <name>Apache License, Version 2.0</name>

src/it/download-licenses-file-names/licenses-config-no-versions.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<licenseSummary>
+  <dependencies>
+    <dependency>
+      <groupId>antlr</groupId>
+      <artifactId>antlr</artifactId>
+      <licenses>
+        <license>
+          <name>BSD License</name>
+          <url>http://www.antlr.org/license.html</url>
+          <distribution>repo</distribution>
+          <file>bsd-license-from-config.html</file>
+        </license>
+      </licenses>
+    </dependency>
+  </dependencies>
+</licenseSummary>

src/it/download-licenses-file-names/pom.xml

@@ -77,7 +77,7 @@
             <configuration>
               <licensesOutputDirectory>${project.build.directory}/basic/licenses</licensesOutputDirectory>
               <licensesOutputFile>${project.build.directory}/basic/licenses.xml</licensesOutputFile>
-              <licensesConfigFile>${basedir}/licenses-config.xml</licensesConfigFile>
+              <licensesConfigFile>${basedir}/licenses-config-basic.xml</licensesConfigFile>
               <errorRemedy>xmlOutput</errorRemedy>
               <sortByGroupIdAndArtifactId>true</sortByGroupIdAndArtifactId>
               <licenseUrlReplacements>
@@ -140,14 +140,15 @@
               <goal>download-licenses</goal>
             </goals>
             <configuration>
-              <licensesConfigFile>${basedir}/src/license/licenses.xml</licensesConfigFile>
+              <licensesConfigFile>${basedir}/licenses-config-no-versions.xml</licensesConfigFile>
               <licensesOutputDirectory>${project.build.directory}/cleanLicDir/licenses</licensesOutputDirectory>
               <licensesOutputFile>${project.build.directory}/cleanLicDir/licenses.xml</licensesOutputFile>
               <licensesErrorsFile>${project.build.directory}/cleanLicDir/licenses-errors.xml</licensesErrorsFile>
               <cleanLicensesOutputDirectory>true</cleanLicensesOutputDirectory>
               <forceDownload>true</forceDownload>
               <errorRemedy>xmlOutput</errorRemedy>
               <sortByGroupIdAndArtifactId>true</sortByGroupIdAndArtifactId>
+              <writeVersions>false</writeVersions>
               <licenseUrlReplacements>
                 <licenseUrlReplacement>
                   <regexp>^https?://github\.com/([^/]+)/([^/]+)/blob/(.*)$</regexp>
@@ -156,10 +157,6 @@
               </licenseUrlReplacements>
               <licenseUrlFileNames>
                 <spdx/>
-                <bsd-antlr.html>
-                    sha1:074f8d6e91730b40875178666513014472888247
-                    \Qhttp://www.antlr.org/license.html\E
-                </bsd-antlr.html>
                 <cddl-gplv2-ce.txt>
                     sha1:c27730aef98e1d50e937d808654daad00b258f90
                     \Qhttps://raw.githubusercontent.com/javaee/activation/master/LICENSE.txt\E

src/it/download-licenses-file-names/postbuild.groovy

@@ -79,7 +79,7 @@ return {
     assert Files.exists(asl2)
     assert asl2.text.contains('Version 2.0, January 2004')
 
-    final Path bsdAntlr = outputBase.resolve('licenses/bsd-antlr.html')
+    final Path bsdAntlr = outputBase.resolve('licenses/bsd-license-from-config.html')
     assert Files.exists(bsdAntlr)
     assert bsdAntlr.text.contains('Copyright (c) 2012 Terence Parr and Sam Harwell')
 

src/main/java/org/codehaus/mojo/license/AbstractDownloadLicensesMojo.java

@@ -431,6 +431,19 @@ public abstract class AbstractDownloadLicensesMojo
     @Parameter
     private Map<String, String> licenseUrlFileNames;
 
+    /**
+     * If {@code true}, {@link #licensesOutputFile} and {@link #licensesErrorsFile} will contain {@code <version>}
+     * elements for each {@code <dependency>}; otherwise the {@code <version>} {@link #licensesOutputFile} and
+     * {@link #licensesErrorsFile} elements will not be appended under {@code <dependency>} elements in
+     * <b>
+     * Might be useful if you want to keep the {@link #licensesOutputFile} under source control and you do not want to
+     * see the changing dependency versions there.
+     *
+     * @since 1.18
+     */
+    @Parameter( property = "license.writeVersions", defaultValue = "true" )
+    private boolean writeVersions;
+
     // ----------------------------------------------------------------------
     // Plexus Components
     // ----------------------------------------------------------------------
@@ -581,11 +594,11 @@ public void execute()
 
             List<ProjectLicenseInfo> depProjectLicensesWithErrors = filterErrors( depProjectLicenses );
             LicenseSummaryWriter.writeLicenseSummary( depProjectLicenses, licensesOutputFile, charset,
-                                                      licensesOutputFileEol );
+                                                      licensesOutputFileEol, writeVersions );
             if ( depProjectLicensesWithErrors != null && !depProjectLicensesWithErrors.isEmpty() )
             {
                 LicenseSummaryWriter.writeLicenseSummary( depProjectLicensesWithErrors, licensesErrorsFile, charset,
-                                                          licensesOutputFileEol );
+                                                          licensesOutputFileEol, writeVersions );
             }
         }
         catch ( Exception e )

src/main/java/org/codehaus/mojo/license/utils/LicenseSummaryWriter.java

@@ -54,7 +54,7 @@
 public class LicenseSummaryWriter
 {
     public static void writeLicenseSummary( List<ProjectLicenseInfo> dependencies, File outputFile, Charset charset,
-            Eol eol )
+            Eol eol, boolean writeVersions )
         throws ParserConfigurationException, TransformerException, IOException
     {
         DocumentBuilderFactory fact = DocumentBuilderFactory.newInstance();
@@ -68,7 +68,7 @@ public static void writeLicenseSummary( List<ProjectLicenseInfo> dependencies, F
 
         for ( ProjectLicenseInfo dep : dependencies )
         {
-            dependenciesNode.appendChild( createDependencyNode( doc, dep ) );
+            dependenciesNode.appendChild( createDependencyNode( doc, dep, writeVersions ) );
         }
 
         // Prepare the output file File
@@ -87,7 +87,7 @@ public static void writeLicenseSummary( List<ProjectLicenseInfo> dependencies, F
         }
     }
 
-    public static Node createDependencyNode( Document doc, ProjectLicenseInfo dep )
+    public static Node createDependencyNode( Document doc, ProjectLicenseInfo dep, boolean writeVersions )
     {
         Node depNode = doc.createElement( "dependency" );
 
@@ -99,9 +99,12 @@ public static Node createDependencyNode( Document doc, ProjectLicenseInfo dep )
         artifactIdNode.appendChild( doc.createTextNode( dep.getArtifactId() ) );
         depNode.appendChild( artifactIdNode );
 
-        Node versionNode = doc.createElement( "version" );
-        versionNode.appendChild( doc.createTextNode( dep.getVersion() ) );
-        depNode.appendChild( versionNode );
+        if ( writeVersions )
+        {
+            Node versionNode = doc.createElement( "version" );
+            versionNode.appendChild( doc.createTextNode( dep.getVersion() ) );
+            depNode.appendChild( versionNode );
+        }
 
         Node licensesNode = doc.createElement( "licenses" );
         if ( dep.getLicenses() == null || dep.getLicenses().size() == 0 )

src/test/java/org/codehaus/mojo/license/utils/LicenseSummaryTest.java

@@ -107,26 +107,51 @@ public void testWriteReadLicenseSummary()
         licSummary.add( dep1 );
         licSummary.add( dep2 );
 
-        File licenseSummaryFile = File.createTempFile( "licSummary", "tmp" );
-        // File licenseSummaryFile = new File( "src/test/resources/license-summary-test-2.xml" );
-        LicenseSummaryWriter.writeLicenseSummary( licSummary, licenseSummaryFile, StandardCharsets.UTF_8, Eol.LF );
+        {
+            File licenseSummaryFile = File.createTempFile( "licSummary", "tmp" );
+            LicenseSummaryWriter.writeLicenseSummary( licSummary, licenseSummaryFile, StandardCharsets.UTF_8, Eol.LF,
+                                                      true );
 
-        Assert.assertTrue( licenseSummaryFile.exists() );
-        FileInputStream fis = new FileInputStream( licenseSummaryFile );
-        List<ProjectLicenseInfo> list = LicenseSummaryReader.parseLicenseSummary( fis );
-        fis.close();
-        ProjectLicenseInfo dep = list.get( 0 );
-        Assert.assertEquals( "org.test", dep.getGroupId() );
-        Assert.assertEquals( "test1", dep.getArtifactId() );
-        Assert.assertEquals( "1.0", dep.getVersion() );
+            Assert.assertTrue( licenseSummaryFile.exists() );
+            FileInputStream fis = new FileInputStream( licenseSummaryFile );
+            List<ProjectLicenseInfo> list = LicenseSummaryReader.parseLicenseSummary( fis );
+            fis.close();
+            ProjectLicenseInfo dep = list.get( 0 );
+            Assert.assertEquals( "org.test", dep.getGroupId() );
+            Assert.assertEquals( "test1", dep.getArtifactId() );
+            Assert.assertEquals( "1.0", dep.getVersion() );
 
-        List<ProjectLicense> licenses = dep.getLicenses();
-        Assert.assertEquals( 1, licenses.size() );
-        ProjectLicense lic0 = dep.getLicenses().get(0);
-        Assert.assertEquals( "lgpl", lic0.getName() );
-        Assert.assertEquals( "http://www.gnu.org/licenses/lgpl-3.0.txt", lic0.getUrl() );
-        Assert.assertEquals( "lgpl-3.0.txt", lic0.getFile() );
-        Assert.assertEquals( "lgpl version 3.0", lic0.getComments() );
+            List<ProjectLicense> licenses = dep.getLicenses();
+            Assert.assertEquals( 1, licenses.size() );
+            ProjectLicense lic0 = dep.getLicenses().get(0);
+            Assert.assertEquals( "lgpl", lic0.getName() );
+            Assert.assertEquals( "http://www.gnu.org/licenses/lgpl-3.0.txt", lic0.getUrl() );
+            Assert.assertEquals( "lgpl-3.0.txt", lic0.getFile() );
+            Assert.assertEquals( "lgpl version 3.0", lic0.getComments() );
+        }
+
+        {
+            File licenseSummaryFile = File.createTempFile( "licSummaryNoVersion", "tmp" );
+            LicenseSummaryWriter.writeLicenseSummary( licSummary, licenseSummaryFile, StandardCharsets.UTF_8, Eol.LF,
+                                                      false );
+
+            Assert.assertTrue( licenseSummaryFile.exists() );
+            FileInputStream fis = new FileInputStream( licenseSummaryFile );
+            List<ProjectLicenseInfo> list = LicenseSummaryReader.parseLicenseSummary( fis );
+            fis.close();
+            ProjectLicenseInfo dep = list.get( 0 );
+            Assert.assertEquals( "org.test", dep.getGroupId() );
+            Assert.assertEquals( "test1", dep.getArtifactId() );
+            Assert.assertNull( dep.getVersion() );
+
+            List<ProjectLicense> licenses = dep.getLicenses();
+            Assert.assertEquals( 1, licenses.size() );
+            ProjectLicense lic0 = dep.getLicenses().get(0);
+            Assert.assertEquals( "lgpl", lic0.getName() );
+            Assert.assertEquals( "http://www.gnu.org/licenses/lgpl-3.0.txt", lic0.getUrl() );
+            Assert.assertEquals( "lgpl-3.0.txt", lic0.getFile() );
+            Assert.assertEquals( "lgpl version 3.0", lic0.getComments() );
+        }
 
     }
 }