Merge pull request #106 from sschuberth/master

Ignore fatal errors in POMs of transitive dependencies

README.adoc

@@ -258,6 +258,7 @@ The `downloadLicense` task has a set of properties, most can be set in the exten
 [cols="h,d"]
 |====
 |includeProjectDependencies |true if you want to include the transitive dependencies of your project dependencies
+|ignoreFatalParseErrors |true if you want to ignore fatal errors when parsing POMs of transitive dependencies
 |licenses |a pre-defined mapping of a dependency to a license; useful if the external repositories do not have license information available
 |aliases |a mapping between licenses; useful to consolidate the various POM definitions of different spelled/named licenses
 |excludeDependencies |a List of dependencies that are to be excluded from reporting

src/main/groovy/nl/javadude/gradle/plugins/license/DownloadLicenses.groovy

@@ -36,6 +36,11 @@ public class DownloadLicenses extends ConventionTask {
      */
     @Input boolean includeProjectDependencies
 
+    /**
+     * Ignore fatal errors when parsing POMs of transitive dependencies.
+     */
+    @Input boolean ignoreFatalParseErrors
+
     /**
      * List of dependencies that will be omitted in the report.
      */
@@ -88,6 +93,7 @@ public class DownloadLicenses extends ConventionTask {
         def dependencyLicensesSet = {
             def licenseResolver = new LicenseResolver(project: project,
                                                       includeProjectDependencies: getIncludeProjectDependencies(),
+                                                      ignoreFatalParseErrors: getIgnoreFatalParseErrors(),
                                                       aliases: aliases.collectEntries {
                                                           new MapEntry(resolveAliasKey(it.key), it.value)
                                                       },

src/main/groovy/nl/javadude/gradle/plugins/license/DownloadLicensesExtension.groovy

@@ -37,6 +37,11 @@ class DownloadLicensesExtension {
      */
     boolean includeProjectDependencies
 
+    /**
+     * Ignore fatal errors when parsing POMs of transitive dependencies.
+     */
+    boolean ignoreFatalParseErrors
+
     /**
      * File name for reports by dependency.
      */

src/main/groovy/nl/javadude/gradle/plugins/license/LicensePlugin.groovy

@@ -129,6 +129,7 @@ class LicensePlugin implements Plugin<Project> {
             reportByDependency = true
             reportByLicenseType = true
             includeProjectDependencies = false
+            ignoreFatalParseErrors = false
             reportByDependencyFileName = DEFAULT_FILE_NAME_FOR_REPORTS_BY_DEPENDENCY
             reportByLicenseFileName = DEFAULT_FILE_NAME_FOR_REPORTS_BY_LICENSE
             excludeDependencies = []
@@ -183,6 +184,7 @@ class LicensePlugin implements Plugin<Project> {
             reportByDependencyFileName = { downloadLicensesExtension.reportByDependencyFileName }
             reportByLicenseFileName = { downloadLicensesExtension.reportByLicenseFileName }
             includeProjectDependencies = {downloadLicensesExtension.includeProjectDependencies}
+            ignoreFatalParseErrors = {downloadLicensesExtension.ignoreFatalParseErrors}
             licenses = { downloadLicensesExtension.licenses }
             aliases = {downloadLicensesExtension.aliases }
             xml = { downloadLicensesExtension.report.xml.enabled }

src/main/groovy/nl/javadude/gradle/plugins/license/LicenseResolver.groovy

@@ -8,6 +8,7 @@ import org.gradle.api.artifacts.FileCollectionDependency
 import org.gradle.api.artifacts.ResolvedArtifact
 import org.gradle.api.logging.Logger
 import org.gradle.api.logging.Logging
+import org.gradle.api.tasks.TaskExecutionException
 
 import static DependencyMetadata.noLicenseMetaData
 
@@ -27,6 +28,7 @@ class LicenseResolver {
     private List<String> dependenciesToIgnore
     private boolean includeProjectDependencies
     private String dependencyConfiguration
+    private boolean ignoreFatalParseErrors
 
     /**
      * Provide set with dependencies metadata.
@@ -127,8 +129,8 @@ class LicenseResolver {
         def subprojects = project.rootProject.subprojects.groupBy { Project p -> "$p.group:$p.name:$p.version".toString()}
 
         if (project.configurations.any { it.name == dependencyConfiguration }) {
-            def runtimeConfiguration = project.configurations.getByName(dependencyConfiguration)
-            runtimeConfiguration.resolvedConfiguration.resolvedArtifacts.each { ResolvedArtifact d ->
+            def configuration = project.configurations.getByName(dependencyConfiguration)
+            configuration.resolvedConfiguration.resolvedArtifacts.each { ResolvedArtifact d ->
                 String dependencyDesc = "$d.moduleVersion.id.group:$d.moduleVersion.id.name:$d.moduleVersion.id.version".toString()
                 if(!dependenciesToIgnore.contains(dependencyDesc)) {
                     Project subproject = subprojects[dependencyDesc]?.first()
@@ -205,7 +207,20 @@ class LicenseResolver {
 
         XmlSlurper slurper = new XmlSlurper(true, false)
         slurper.setErrorHandler(new org.xml.sax.helpers.DefaultHandler())
-        GPathResult xml = slurper.parse(pStream)
+
+        GPathResult xml
+        try {
+            xml = slurper.parse(pStream)
+        } catch (org.xml.sax.SAXParseException e) {
+            // Fatal errors are still throw by DefaultHandler, so handle them here.
+            logger.warn("Unable to parse POM file for $dependencyDesc")
+            if (ignoreFatalParseErrors) {
+                return noLicenseMetaData(dependencyDesc)
+            } else {
+                throw new TaskExecutionException(e.getMessage())
+            }
+        }
+
         DependencyMetadata pomData = new DependencyMetadata(dependency: initialDependency)
 
         xml.licenses.license.each {

src/test/groovy/nl/javadude/gradle/plugins/license/DownloadLicensesIntegTest.groovy

@@ -73,6 +73,25 @@ class DownloadLicensesIntegTest extends Specification {
 
     }
 
+    def "Test that ignoring fatal pom parse errors works"() {
+        setup:
+        project.dependencies {
+            // This depends on "org.codehouse.plexus:plexus:1.0.4" whose POM is malformed.
+            compile "org.apache.maven:maven-ant-tasks:2.1.3"
+        }
+        downloadLicenses.ignoreFatalParseErrors = true
+
+        when:
+        downloadLicenses.execute()
+
+        then:
+        File f = getLicenseReportFolder()
+        assertLicenseReportsExist(f)
+
+        def xmlByDependency = xml4LicenseByDependencyReport(f)
+        dependenciesInReport(xmlByDependency) == 24
+    }
+
     def "Test that report generating in multi module build include subprojects dependencies"() {
         setup:
         subproject.dependencies {