Avoid processing *.aar dependencies which can not be parsed and cause…

… gradle failures (#172) With the Android gradle plugin 'com.android.tools.build:gradle:7.1.0' the dependency resolution changed and therefore different dependency types like '.aar' appear within the list of resolved artifacts/dependencies. These types have to be excluded before parsing a dependency to avoid failures. Currently .aar dependencies will cause following error: ``` > Task :app:licenseReleaseReport circularimageview dependency does not have a license. [Fatal Error] vectordrawable-animated-1.1.0.aar:1:1: Content is not allowed in prolog. > Task :app:licenseReleaseReport FAILED FAILURE: Build failed with an exception. * What went wrong: Execution failed for task ':app:licenseReleaseReport'. > org.xml.sax.SAXParseException; systemId: file:///home/user/caches/modules-2/files-2.1/androidx.vectordrawable/vectordrawable-animated/1.1.0/fcda1161354501471c30a4e077af6b5c4d4eddc6/vectordrawable-animated-1.1.0.aar; lineNumber: 1; columnNumber: 1; Content is not allowed in prolog. * Try: > Run with --stacktrace option to get the stack trace. > Run with --info or --debug option to get more log output. > Run with --scan to get full insights. * Get more help at https://help.gradle.org BUILD FAILED in 21s 11 actionable tasks: 5 executed, 6 up-to-date ```
jaredsburrows · Apr 8, 2022 · a0b5036 · a0b5036
1 parent 19feac1
commit a0b5036
Show file tree

Hide file tree

Showing 2 changed files with 205 additions and 0 deletions.
diff --git a/src/main/kotlin/com/jaredsburrows/license/LicenseReportTask.kt b/src/main/kotlin/com/jaredsburrows/license/LicenseReportTask.kt
@@ -164,6 +164,11 @@ internal open class LicenseReportTask : DefaultTask() { // tasks can't be final
       .lenientConfiguration
       .artifacts.forEach { resolvedArtifact ->
 
+        // Skip artifact processing for non-pom type artifacts
+        if (resolvedArtifact.type != "pom") {
+          return@forEach
+        }
+
         val pomFile = resolvedArtifact.file
         val node = xmlParser.parse(pomFile)
 

diff --git a/src/test/groovy/com/jaredsburrows/license/LicensePluginAndroidSpec.groovy b/src/test/groovy/com/jaredsburrows/license/LicensePluginAndroidSpec.groovy
@@ -1212,4 +1212,204 @@ final class LicensePluginAndroidSpec extends Specification {
     taskName << ['licenseDebugReport', 'licenseReleaseReport']
     copyEnabled << [true, false]
   }
+
+  @Unroll def '#taskName with android gradle plugin version < 7.1.0 (7.0.4)'() {
+    given:
+    def androidGradlePluginVersion = '7.0.4'
+    buildFile <<
+      """
+      buildscript {
+        repositories {
+          mavenCentral()
+          google()
+        }
+
+        dependencies {
+          classpath files($classpathString)
+          classpath 'com.android.tools.build:gradle:${androidGradlePluginVersion}'
+        }
+      }
+
+      repositories {
+        maven {
+          url '${mavenRepoUrl}'
+        }
+      }
+
+      apply plugin: 'com.android.application'
+      apply plugin: 'com.jaredsburrows.license'
+
+      android {
+        compileSdkVersion 28
+
+        defaultConfig {
+          applicationId 'com.example'
+        }
+      }
+
+      dependencies {
+        implementation 'com.android.support:design:26.1.0'
+      }
+      """
+
+    when:
+    def result = gradleWithCommand(testProjectDir.root, "${taskName}", '-s')
+    def actualHtml = new File(reportFolder, "${taskName}.html").text
+    def actualJson = new File(reportFolder, "${taskName}.json").text
+    def expectedHtml =
+      """
+      <html>
+      <head>
+          <style>body { font-family: sans-serif } pre { background-color: #eeeeee; padding: 1em; white-space: pre-wrap; display: inline-block }</style>
+          <title>Open source licenses</title>
+      </head>
+      <body>
+      <h3>Notice for packages:</h3>
+      <ul>
+          <li><a href="#1934118923">design (26.1.0)</a>
+              <dl>
+                  <dt>Copyright &copy; 20xx The original author or authors</dt>
+              </dl>
+          </li>
+          <a name="1934118923"></a>
+          <pre>${myGetLicenseText('apache-2.0.txt')}</pre>
+          <br>
+          <hr>
+      </ul>
+      </body>
+      </html>
+      """
+    def expectedJson =
+      """
+      [
+        {
+          "project": "design",
+          "description": null,
+          "version": "26.1.0",
+          "developers": [],
+          "url": null,
+          "year": null,
+          "licenses": [
+            {
+              "license": "The Apache Software License",
+              "license_url": "http://www.apache.org/licenses/LICENSE-2.0.txt"
+            }
+          ],
+          "dependency": "com.android.support:design:26.1.0"
+        }
+      ]
+      """
+
+
+    then:
+    result.task(":${taskName}").outcome == SUCCESS
+    result.output.find("Wrote CSV report to .*${reportFolder}/${taskName}.csv.")
+    result.output.find("Wrote HTML report to .*${reportFolder}/${taskName}.html.")
+    result.output.find("Wrote JSON report to .*${reportFolder}/${taskName}.json.")
+    assertHtml(expectedHtml, actualHtml)
+    assertJson(expectedJson, actualJson)
+
+    where:
+    taskName << ['licenseDebugReport', 'licenseReleaseReport']
+  }
+
+ @Unroll def '#taskName with android gradle plugin version >= 7.1.0 (7.1.1)'() {
+   given:
+   def androidGradlePluginVersion = '7.1.1'
+   buildFile <<
+     """
+      buildscript {
+        repositories {
+          mavenCentral()
+          google()
+        }
+
+        dependencies {
+          classpath files($classpathString)
+          classpath 'com.android.tools.build:gradle:${androidGradlePluginVersion}'
+        }
+      }
+
+      repositories {
+        maven {
+          url '${mavenRepoUrl}'
+        }
+      }
+
+      apply plugin: 'com.android.application'
+      apply plugin: 'com.jaredsburrows.license'
+
+      android {
+        compileSdkVersion 28
+
+        defaultConfig {
+          applicationId 'com.example'
+        }
+      }
+
+      dependencies {
+        implementation 'com.android.support:design:26.1.0'
+      }
+      """
+
+   when:
+   def result = gradleWithCommand(testProjectDir.root, "${taskName}", '-s')
+   def actualHtml = new File(reportFolder, "${taskName}.html").text
+   def actualJson = new File(reportFolder, "${taskName}.json").text
+   def expectedHtml =
+     """
+      <html>
+      <head>
+          <style>body { font-family: sans-serif } pre { background-color: #eeeeee; padding: 1em; white-space: pre-wrap; display: inline-block }</style>
+          <title>Open source licenses</title>
+      </head>
+      <body>
+      <h3>Notice for packages:</h3>
+      <ul>
+          <li><a href="#1934118923">design (26.1.0)</a>
+              <dl>
+                  <dt>Copyright &copy; 20xx The original author or authors</dt>
+              </dl>
+          </li>
+          <a name="1934118923"></a>
+          <pre>${myGetLicenseText('apache-2.0.txt')}</pre>
+          <br>
+          <hr>
+      </ul>
+      </body>
+      </html>
+      """
+   def expectedJson =
+     """
+      [
+        {
+          "project": "design",
+          "description": null,
+          "version": "26.1.0",
+          "developers": [],
+          "url": null,
+          "year": null,
+          "licenses": [
+            {
+              "license": "The Apache Software License",
+              "license_url": "http://www.apache.org/licenses/LICENSE-2.0.txt"
+            }
+          ],
+          "dependency": "com.android.support:design:26.1.0"
+        }
+      ]
+      """
+
+
+   then:
+   result.task(":${taskName}").outcome == SUCCESS
+   result.output.find("Wrote CSV report to .*${reportFolder}/${taskName}.csv.")
+   result.output.find("Wrote HTML report to .*${reportFolder}/${taskName}.html.")
+   result.output.find("Wrote JSON report to .*${reportFolder}/${taskName}.json.")
+   assertHtml(expectedHtml, actualHtml)
+   assertJson(expectedJson, actualJson)
+
+   where:
+   taskName << ['licenseDebugReport', 'licenseReleaseReport']
+ }
 }