Merge pull request #981 from grails/embeddedJarHandling

Handle loading migrations from embedded jars (plugins)

Author: jdaugherty

grails-database-migration/src/main/groovy/org/grails/plugins/databasemigration/liquibase/EmbeddedJarPathHandler.groovy

@@ -0,0 +1,75 @@
+package org.grails.plugins.databasemigration.liquibase
+
+import groovy.transform.CompileStatic
+import liquibase.resource.AbstractPathResourceAccessor
+import liquibase.resource.PathResource
+import liquibase.resource.Resource
+import liquibase.resource.ResourceAccessor
+import liquibase.resource.ZipPathHandler
+
+import java.nio.file.FileSystem
+import java.nio.file.FileSystems
+import java.nio.file.Path
+import java.nio.file.Paths
+
+@CompileStatic
+class EmbeddedJarPathHandler extends ZipPathHandler {
+    @Override
+    int getPriority(String root) {
+        if (root.startsWith("jar:file:") && root.endsWith("!/")) { //only can handle `jar:` urls for the entire jar
+            if (parseJarPath(root).contains('!')) {
+                return PRIORITY_SPECIALIZED
+            }
+        }
+        PRIORITY_NOT_APPLICABLE
+    }
+
+    private String parseJarPath(String root) {
+        root.substring(9, root.lastIndexOf("!"))
+    }
+
+    @Override
+    ResourceAccessor getResourceAccessor(String root) throws FileNotFoundException {
+        String jarPath = parseJarPath(root)
+        new EmbeddedJarResourceAccessor(jarPath.split('!').toList())
+    }
+}
+
+@CompileStatic
+class EmbeddedJarResourceAccessor extends AbstractPathResourceAccessor {
+    private FileSystem fileSystem
+
+    EmbeddedJarResourceAccessor(List<String> jarPaths) {
+        try {
+            Path firstPath = Paths.get(jarPaths.pop())
+            fileSystem = FileSystems.newFileSystem(firstPath, null as ClassLoader)
+
+            while(jarPaths) {
+                Path innerPath = fileSystem.getPath(jarPaths.pop())
+                fileSystem = FileSystems.newFileSystem(innerPath, null as ClassLoader)
+            }
+        } catch (e) {
+            throw new IllegalArgumentException(e.getMessage(), e)
+        }
+    }
+
+    @Override
+    void close() throws Exception {
+        //can't close the filesystem because they often get reused and/or are being used by other things
+    }
+
+    @Override
+    protected Path getRootPath() {
+        return this.fileSystem.getPath("/")
+    }
+
+    @Override
+    protected Resource createResource(Path file, String pathToAdd) {
+        return new PathResource(pathToAdd, file)
+    }
+
+    @Override
+    List<String> describeLocations() {
+        return Collections.singletonList(fileSystem.toString())
+    }
+}

grails-database-migration/src/main/resources/META-INF/services/liquibase.resource.PathHandler

@@ -0,0 +1 @@
+org.grails.plugins.databasemigration.liquibase.EmbeddedJarPathHandler