GRAILS-3577 - PluginPackager shows a directory is accessible

Author: rvowles

grails-core/src/main/groovy/org/codehaus/groovy/grails/plugins/publishing/PluginDescriptorGenerator.groovy

@@ -82,36 +82,6 @@ class PluginDescriptorGenerator {
         generatePluginXml(pluginProps, xml)
     }
 
-    /* the pluginExcludes are Ant matched from the base of the application, but since the
-       pluginProps is not necessarily a class and we don't actually know where it is, we need
-       to go through the resources figuring out what the common resource base is. We are going to assume
-       a common Grails application layout to fudge this.
-    */
-    private String resourceBaseMatchDirs = ['grails-app', 'web-app', 'scripts', 'test', 'src']
-    private File findCommonResourceBase() {
-        if (!resourceList) return null // no resources, won't loop
-
-        for (Resource r in resourceList) {
-            File f = r.file
-
-            while (f != null && !resourceBaseMatchDirs.contains(f.name)) {
-                f = f.parentFile
-            }
-
-            if (f) {
-                  if (f.parentFile == null) { // wonderful, thanks Resource
-                    return new File(f.absolutePath.substring(0, f.absolutePath.lastIndexOf(File.separator)))
-                } else {
-                    return f.parentFile
-                }
-            }
-        }
-
-        GrailsUtil.warn("Unable to determine common resource base when generating plugin.xml")
-
-        return null
-    }
-
     private boolean matchesPluginExcludes(List<String> pluginExcludes, File commonResourceBase, Resource r) {
 
         // if we have no excludes or no common resource base, we don't match
@@ -129,6 +99,17 @@ class PluginDescriptorGenerator {
         return false
     }
 
+    // this is needed to pass the test as the resources don't really exist
+    private File filterPluginDir(File pluginDir) {
+        if (!pluginDir) return null
+
+        if (pluginDir.absolutePath.endsWith(File.separator + ".")) {
+            return new File(pluginDir.absolutePath.substring(0, pluginDir.absolutePath.lastIndexOf(File.separator)))
+        } else {
+            return pluginDir
+        }
+    }
+
     protected void generatePluginXml(pluginProps, MarkupBuilder xml) {
         // Write the content!
         def props = ['author', 'authorEmail', 'title', 'description', 'documentation', 'type', 'packaging']
@@ -155,7 +136,7 @@ class PluginDescriptorGenerator {
                     if (pluginProps[p]) "${p}"(pluginProps[p])
                 }
                 xml.resources {
-                    File commonResourceBase = findCommonResourceBase()
+                    File commonResourceBase = filterPluginDir(pluginProps['pluginDir']?.file)
 
                     for (r in resourceList) {
                         def matcher = r.URL.toString() =~ ARTEFACT_PATTERN

grails-core/src/test/groovy/org/codehaus/groovy/grails/plugins/publishing/PluginDescriptorGeneratorSpec.groovy

@@ -32,7 +32,7 @@ class PluginDescriptorGeneratorSpec extends Specification {
             def generator = new PluginDescriptorGenerator(new BuildSettings(),"foo", [])
         when:
             def sw = new StringWriter()
-            generator.generatePluginXml([version:1.0, dependsOn:[core:1.0], author:"Bob", pluginExcludes: ["**/test/**"]], sw)
+            generator.generatePluginXml([version:1.0, dependsOn:[core:1.0], author:"Bob", pluginDir: new FileSystemResource(new File(".")), pluginExcludes: ["**/test/**"]], sw)
             def xml = new XmlSlurper().parseText(sw.toString())
         then:
             xml.@name == 'foo'
@@ -45,15 +45,15 @@ class PluginDescriptorGeneratorSpec extends Specification {
 
     def "Test plugin/excludes is honoured for resources"() {
         given:
-            def generator = new PluginDescriptorGenerator(new BuildSettings(),"foo", [
+            def generator = new PluginDescriptorGenerator(new BuildSettings(),"foo",  [
                 new FileSystemResource(new File("grails-app/controllers/FooController.groovy")),
                 new FileSystemResource(new File("grails-app/controllers/test/BarController.groovy")),
                 new FileSystemResource(new File("grails-app/services/test/MyService.groovy")),
                 new FileSystemResource(new File("grails-app/services/MyService2.groovy"))
             ])
         when:
             def sw = new StringWriter()
-            generator.generatePluginXml([version:1.0, dependsOn:[core:1.0], author:"Bob", pluginExcludes: ["**/test/**"]], sw)
+            generator.generatePluginXml([version:1.0, dependsOn:[core:1.0], author:"Bob", pluginDir: new FileSystemResource(new File(".")), pluginExcludes: ["**/test/**"]], sw)
             def xml = new XmlSlurper().parseText(sw.toString())
         then:
             xml.@name == 'foo'