JarUtil: Improve Robustness (Bug 522) and API doc, prepare for Jar-In-Jar. Add unit test.

Misc.:
  - IOUtil: Add toURL* methods
  - TempJarCache: Add 'URL getResource(String)'

2 files changed, 174 insertions, 5 deletions

diff --git a/src/junit/com/jogamp/common/util/TestJarUtil.java b/src/junit/com/jogamp/common/util/TestJarUtil.java
new file mode 100644
index 0000000..fd3b93e
--- /dev/null
+++ b/src/junit/com/jogamp/common/util/TestJarUtil.java
@@ -0,0 +1,169 @@
+/**
+ * Copyright 2011 JogAmp Community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ * 
+ *    1. Redistributions of source code must retain the above copyright notice, this list of
+ *       conditions and the following disclaimer.
+ * 
+ *    2. Redistributions in binary form must reproduce the above copyright notice, this list
+ *       of conditions and the following disclaimer in the documentation and/or other materials
+ *       provided with the distribution.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+ 
+package com.jogamp.common.util;
+
+import java.io.IOException;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.net.URLConnection;
+import java.net.JarURLConnection;
+import java.util.Enumeration;
+import java.util.jar.JarEntry;
+import java.util.jar.JarFile;
+
+import junit.framework.Assert;
+
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+import com.jogamp.common.GlueGenVersion;
+import com.jogamp.common.util.cache.TempCacheReg;
+import com.jogamp.common.util.cache.TempFileCache;
+import com.jogamp.common.util.cache.TempJarCache;
+
+public class TestJarUtil {
+    static TempFileCache fileCache;
+    
+    @BeforeClass
+    public static void init() {
+        // may already been initialized by other test
+        // Assert.assertFalse(TempCacheReg.isTempFileCacheUsed());
+        Assert.assertTrue(TempFileCache.initSingleton());
+        Assert.assertTrue(TempCacheReg.isTempFileCacheUsed());
+        
+        fileCache = new TempFileCache();
+        Assert.assertTrue(fileCache.isValid());
+        System.err.println("tmp dir: "+fileCache.getTempDir());
+    }
+    
+    static class TestClassLoader extends URLClassLoader {
+        public TestClassLoader(URL[] urls) {
+            super(urls);
+        }
+        public TestClassLoader(URL[] urls, ClassLoader parent) {
+            super(urls, parent);
+        }
+    }
+    
+    void validateJarFile(JarFile jarFile) throws IllegalArgumentException, IOException {
+        Assert.assertNotNull(jarFile);     
+        Assert.assertTrue("jarFile has zero entries: "+jarFile, jarFile.size()>0);
+        Enumeration<JarEntry> entries = jarFile.entries();
+        System.err.println("Entries of "+jarFile.getName()+": ");
+        int i = 0;
+        while(entries.hasMoreElements()) {
+            System.err.println(i+": "+entries.nextElement().getName());
+            i++;
+        }
+    }
+    
+    void validateJarFileURL(URL jarFileURL) throws IllegalArgumentException, IOException {
+        Assert.assertNotNull(jarFileURL);     
+        URLConnection aURLc = jarFileURL.openConnection();
+        Assert.assertTrue("jarFileURL has zero content: "+jarFileURL, aURLc.getContentLength()>0);
+        System.err.println("URLConnection: "+aURLc);
+        Assert.assertTrue("Not a JarURLConnection: "+aURLc, (aURLc instanceof JarURLConnection) );
+        JarURLConnection jURLc = (JarURLConnection) aURLc;
+        JarFile jarFile = jURLc.getJarFile();
+        validateJarFile(jarFile);
+    }
+    
+    void validateJarUtil(String expJarName, String clazzBinName, ClassLoader cl) throws IllegalArgumentException, IOException {
+        String jarName= JarUtil.getJarBasename(clazzBinName, cl);
+        Assert.assertNotNull(jarName);
+        Assert.assertEquals(expJarName, jarName);
+        
+        URL jarSubURL = JarUtil.getJarSubURL(clazzBinName, cl);
+        Assert.assertNotNull(jarSubURL);     
+        URLConnection urlConn = jarSubURL.openConnection();
+        Assert.assertTrue("jarSubURL has zero content: "+jarSubURL, urlConn.getContentLength()>0);
+        System.err.println("URLConnection of jarSubURL: "+urlConn);
+        
+        URL jarFileURL = JarUtil.getJarFileURL(clazzBinName, cl);
+        validateJarFileURL(jarFileURL);
+                
+        JarFile jarFile = JarUtil.getJarFile(clazzBinName, cl);
+        validateJarFile(jarFile);
+    }
+    
+    @Test
+    public void testJarUtilFlat01() throws IOException {
+        System.err.println("XXXXXXXXXXXXXXXXXXXXXXXXXXXX");
+        validateJarUtil("TestJarsInJar.jar", "ClassInJar0", this.getClass().getClassLoader());
+        System.err.println("XXXXXXXXXXXXXXXXXXXXXXXXXXXX");
+    }
+
+    @Test
+    public void testJarUtilJarInJar01() throws IOException, ClassNotFoundException {
+        System.err.println("XXXXXXXXXXXXXXXXXXXXXXXXXXXX");
+        
+        Assert.assertTrue(TempJarCache.initSingleton());
+        Assert.assertTrue(TempCacheReg.isTempJarCacheUsed());
+        Assert.assertTrue(TempJarCache.isInitialized());
+        
+        final ClassLoader rootCL = this.getClass().getClassLoader();
+        
+        // Get containing JAR file "TestJarsInJar.jar" and add it to the TempJarCache
+        TempJarCache.addAll(GlueGenVersion.class, JarUtil.getJarFile("ClassInJar0", rootCL));
+        
+        // Fetch and load the contained "ClassInJar1.jar"
+        final URL ClassInJar1_jarFileURL = JarUtil.getJarFileURL(TempJarCache.getResource("ClassInJar1.jar"));
+        final ClassLoader cl = new URLClassLoader(new URL[] { ClassInJar1_jarFileURL }, rootCL);
+        Assert.assertNotNull(cl);        
+        validateJarUtil("ClassInJar1.jar", "ClassInJar1", cl);
+        System.err.println("XXXXXXXXXXXXXXXXXXXXXXXXXXXX");
+    }
+    
+    @Test
+    public void testJarUtilJarInJar02() throws IOException, ClassNotFoundException {
+        System.err.println("XXXXXXXXXXXXXXXXXXXXXXXXXXXX");
+        
+        Assert.assertTrue(TempJarCache.initSingleton());
+        Assert.assertTrue(TempCacheReg.isTempJarCacheUsed());
+        Assert.assertTrue(TempJarCache.isInitialized());
+        
+        final ClassLoader rootCL = this.getClass().getClassLoader();
+        
+        // Get containing JAR file "TestJarsInJar.jar" and add it to the TempJarCache
+        TempJarCache.addAll(GlueGenVersion.class, JarUtil.getJarFile("ClassInJar0", rootCL));
+        
+        // Fetch and load the contained "ClassInJar1.jar"
+        final URL ClassInJar2_jarFileURL = JarUtil.getJarFileURL(TempJarCache.getResource("sub/ClassInJar2.jar"));
+        final ClassLoader cl = new URLClassLoader(new URL[] { ClassInJar2_jarFileURL }, rootCL);
+        Assert.assertNotNull(cl);        
+        validateJarUtil("ClassInJar2.jar", "ClassInJar2", cl);
+        System.err.println("XXXXXXXXXXXXXXXXXXXXXXXXXXXX");
+    }
+    
+    public static void main(String args[]) throws IOException {
+        String tstname = TestJarUtil.class.getName();
+        org.junit.runner.JUnitCore.main(tstname);
+    }
+
+}
diff --git a/src/junit/com/jogamp/common/util/TestTempJarCache.java b/src/junit/com/jogamp/common/util/TestTempJarCache.java
index e1e47af..199d0aa 100644
--- a/src/junit/com/jogamp/common/util/TestTempJarCache.java
+++ b/src/junit/com/jogamp/common/util/TestTempJarCache.java
@@ -137,7 +137,7 @@ public class TestTempJarCache {
     @Test
     public void testJarUtil01a() throws IOException {
         JarFile jarFile = JarUtil.getJarFile(GlueGenVersion.class.getName(), this.getClass().getClassLoader());
-        Assert.assertNotNull("jarFile: "+jarFile);
+        Assert.assertNotNull(jarFile);
         JarUtil.extract(fileCache.getTempDir(), null, jarFile, false, true, true);
         File f = new File(fileCache.getTempDir(), "META-INF/MANIFEST.MF");
         Assert.assertTrue(f.exists());
@@ -185,10 +185,10 @@ public class TestTempJarCache {
         final String libBaseName = "gluegen-rt";        
         final ClassLoader cl = getClass().getClassLoader();
         
-        URL jarUrlRoot = JarUtil.getJarURL(TempJarCache.class.getName(), cl);
-        jarUrlRoot = JarUtil.getJarURLDirname(jarUrlRoot);
+        URL jarUrlRoot = JarUtil.getJarSubURL(TempJarCache.class.getName(), cl);
+        jarUrlRoot = JarUtil.getURLDirname(jarUrlRoot);
         
-        URL nativeJarURL = JarUtil.getJarURL(jarUrlRoot, nativeJarName);        
+        URL nativeJarURL = JarUtil.getJarFileURL(jarUrlRoot, nativeJarName);        
         JarFile nativeJar = JarUtil.getJarFile(nativeJarURL, cl);
         
         TempJarCache.addNativeLibs(TempJarCache.class, nativeJar);
@@ -225,7 +225,7 @@ public class TestTempJarCache {
     
     @Test
     public void testTempJarCache04bDiffClassLoader() throws IOException {
-        URL[] urls = new URL[] { JarUtil.getJarURL(TempJarCache.class.getName(), getClass().getClassLoader()) };                
+        URL[] urls = new URL[] { JarUtil.getJarFileURL(TempJarCache.class.getName(), getClass().getClassLoader()) };                
         System.err.println("url: "+urls[0]);
         ClassLoader cl2 = new TestClassLoader(urls, null);  
         ClassLoader cl3 = new TestClassLoader(urls, null);