init

test/org/apache/tomcat/util/scan/TestAbstractInputStreamJar.java

@@ -0,0 +1,59 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.tomcat.util.scan;
+
+import java.io.ByteArrayOutputStream;
+import java.io.File;
+import java.io.InputStream;
+import java.net.URL;
+
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+import org.apache.catalina.util.IOTools;
+import org.apache.catalina.webresources.TomcatURLStreamHandlerFactory;
+import org.apache.tomcat.Jar;
+
+public class TestAbstractInputStreamJar {
+
+    @Before
+    public void register() {
+        TomcatURLStreamHandlerFactory.register();
+    }
+
+
+    @Test
+    public void testNestedJarGetInputStream() throws Exception {
+        File f = new File("test/webresources/war-url-connection.war");
+        StringBuilder sb = new StringBuilder("war:");
+        sb.append(f.toURI().toURL());
+        sb.append("*/WEB-INF/lib/test.jar");
+
+        Jar jar = JarFactory.newInstance(new URL(sb.toString()));
+
+        InputStream is1 = jar.getInputStream("META-INF/resources/index.html");
+        ByteArrayOutputStream baos1 = new ByteArrayOutputStream();
+        IOTools.flow(is1, baos1);
+
+        InputStream is2 = jar.getInputStream("META-INF/resources/index.html");
+        ByteArrayOutputStream baos2 = new ByteArrayOutputStream();
+        IOTools.flow(is2, baos2);
+
+        Assert.assertArrayEquals(baos1.toByteArray(), baos2.toByteArray());
+    }
+}

test/org/apache/tomcat/util/scan/TestJarScanner.java

@@ -0,0 +1,46 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.tomcat.util.scan;
+
+import java.util.StringTokenizer;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+import org.apache.catalina.startup.TomcatBaseTest;
+
+public class TestJarScanner extends TomcatBaseTest {
+
+    @Test
+    public void testJarsToSkipFormat() {
+
+        String jarList = System.getProperty(Constants.SKIP_JARS_PROPERTY);
+        Assert.assertNotNull("Jar skip list is null", jarList);
+        Assert.assertFalse("Jar skip list is empty", jarList.isEmpty());
+        StringTokenizer tokenizer = new StringTokenizer(jarList, ",");
+        String token;
+        while (tokenizer.hasMoreElements()) {
+            token = tokenizer.nextToken();
+            Assert.assertTrue("Token \"" + token + "\" does not end with \".jar\"",
+                    token.endsWith(".jar"));
+            Assert.assertEquals("Token \"" + token + "\" contains sub string \".jar\"" +
+                    " or separator \",\" is missing",
+                    token.length() - ".jar".length(),
+                    token.indexOf(".jar"));
+        }
+    }
+}

test/org/apache/tomcat/util/scan/TestStandardJarScanner.java

@@ -0,0 +1,132 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.tomcat.util.scan;
+
+import java.io.File;
+import java.io.IOException;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.junit.Assert;
+import org.junit.Assume;
+import org.junit.Test;
+
+import org.apache.tomcat.Jar;
+import org.apache.tomcat.JarScanType;
+import org.apache.tomcat.JarScannerCallback;
+import org.apache.tomcat.unittest.TesterServletContext;
+import org.apache.tomcat.util.compat.JreCompat;
+
+public class TestStandardJarScanner {
+
+    @Test
+    public void testWebappClassPath() {
+        Assume.assumeFalse("No URLClassLoader with Java 9", JreCompat.isJre9Available());
+
+        StandardJarScanner scanner = new StandardJarScanner();
+
+        scanner.setScanClassPath(true);
+        // When running the test on Java 9, one or more URLs to jimage files may
+        // be returned. By setting the scanAllFiles option, a callback will be
+        // generated for these files which in turn will mean the number of URLs
+        // and the number of call backs will agree and this test will pass.
+        // There is a TODO in StandardJarScanner to add 'proper' Java 9 support.
+        scanner.setScanAllFiles(true);
+
+        LoggingCallback callback = new LoggingCallback();
+
+        scanner.scan(JarScanType.PLUGGABILITY, new TesterServletContext(), callback);
+
+        List<String> callbacks = callback.getCallbacks();
+
+        ClassLoader cl = TesterServletContext.class.getClassLoader();
+        if (cl instanceof URLClassLoader) {
+            URL[] urls =  ((URLClassLoader) cl).getURLs();
+
+            int size;
+            if (urls == null) {
+                size = 0;
+            } else {
+                size = urls.length;
+            }
+            // Some JREs (Gump) construct a class path that includes JARs that
+            // reference additional JARs via the Class-Path attribute of the
+            // Manifest. These JARs are not returned in ClassLoader.getURLs().
+            // Therefore, this test looks for at least as many JARs as there are
+            // URLs but it can't check for an exact match.
+            Assert.assertTrue("[" + callbacks.size() + "] callbacks but expected at least [" +
+                    size + "]", callbacks.size() >= size);
+
+        } else {
+            Assert.fail("Unexpected class loader type: " + cl.getClass().getName());
+        }
+    }
+
+
+    /**
+     * Tomcat should ignore URLs which do not have a file part and do not use the file scheme.
+     */
+    @Test
+    public void skipsInvalidClasspathURLNoFilePartNoFileScheme() {
+        StandardJarScanner scanner = new StandardJarScanner();
+        LoggingCallback callback = new LoggingCallback();
+        TesterServletContext context = new TesterServletContext() {
+            @Override
+            public ClassLoader getClassLoader() {
+                URLClassLoader urlClassLoader;
+                try {
+                    urlClassLoader = new URLClassLoader(
+                            new URL[] { new URL("http://felix.extensions:9/") });
+                } catch (MalformedURLException e) {
+                    throw new RuntimeException(e);
+                }
+                return urlClassLoader;
+            }
+        };
+        scanner.scan(JarScanType.PLUGGABILITY, context, callback);
+    }
+
+
+    private static class LoggingCallback implements JarScannerCallback {
+
+        List<String> callbacks = new ArrayList<>();
+
+        @Override
+        public void scan(Jar jar, String webappPath,
+                boolean isWebapp) throws IOException {
+            callbacks.add(jar.getJarFileURL().toString() + "::" + webappPath + "::" + isWebapp);
+        }
+
+        @Override
+        public void scan(File file, String webappPath, boolean isWebapp)
+                throws IOException {
+            callbacks.add(file.toString() + "::" + webappPath + "::" + isWebapp);
+        }
+
+        @Override
+        public void scanWebInfClasses() throws IOException {
+            callbacks.add("N/A::WEB-INF/classes::N/A");
+        }
+
+        public List<String> getCallbacks() {
+            return callbacks;
+        }
+    }
+}