You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by jb...@apache.org on 2013/08/04 20:00:41 UTC

svn commit: r1510282 - in /tomcat/trunk: java/org/apache/catalina/startup/WebappServiceLoader.java test/org/apache/catalina/startup/TestWebappServiceLoader.java test/org/apache/catalina/startup/service-config.txt

Author: jboynes
Date: Sun Aug  4 18:00:40 2013
New Revision: 1510282

URL: http://svn.apache.org/r1510282
Log:
Tests for WebappServiceLoader (requires EasyMock)

Added:
    tomcat/trunk/test/org/apache/catalina/startup/TestWebappServiceLoader.java   (with props)
    tomcat/trunk/test/org/apache/catalina/startup/service-config.txt
Modified:
    tomcat/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java

Modified: tomcat/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java?rev=1510282&r1=1510281&r2=1510282&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java (original)
+++ tomcat/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java Sun Aug  4 18:00:40 2013
@@ -128,8 +128,7 @@ public class WebappServiceLoader<T> {
         return loadServices(serviceType, servicesFound);
     }
 
-    private void parseConfigFile(Set<String> servicesFound, URL url)
-            throws IOException {
+    void parseConfigFile(Set<String> servicesFound, URL url) throws IOException {
         try (InputStream is = url.openStream()) {
             InputStreamReader in =
                     new InputStreamReader(is, StandardCharsets.UTF_8);
@@ -149,8 +148,7 @@ public class WebappServiceLoader<T> {
         }
     }
 
-    private Collection<T> loadServices(Class<T> serviceType,
-                                       Set<String> servicesFound)
+    Collection<T> loadServices(Class<T> serviceType, Set<String> servicesFound)
             throws IOException {
         ClassLoader loader = context.getClassLoader();
         List<T> services = new ArrayList<>(servicesFound.size());

Added: tomcat/trunk/test/org/apache/catalina/startup/TestWebappServiceLoader.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/test/org/apache/catalina/startup/TestWebappServiceLoader.java?rev=1510282&view=auto
==============================================================================
--- tomcat/trunk/test/org/apache/catalina/startup/TestWebappServiceLoader.java (added)
+++ tomcat/trunk/test/org/apache/catalina/startup/TestWebappServiceLoader.java Sun Aug  4 18:00:40 2013
@@ -0,0 +1,171 @@
+/*
+ * 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.catalina.startup;
+
+import java.io.IOException;
+import java.net.URL;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+import javax.servlet.ServletContainerInitializer;
+import javax.servlet.ServletContext;
+
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+import org.easymock.IMocksControl;
+
+import static org.easymock.EasyMock.createMockBuilder;
+import static org.easymock.EasyMock.createStrictControl;
+import static org.easymock.EasyMock.eq;
+import static org.easymock.EasyMock.expect;
+import static org.easymock.EasyMock.expectLastCall;
+import static org.easymock.EasyMock.isA;
+import static org.easymock.EasyMock.same;
+
+public class TestWebappServiceLoader {
+    private static final String CONFIG_FILE =
+            "META-INF/services/javax.servlet.ServletContainerInitializer";
+    private IMocksControl control;
+    private ClassLoader cl;
+    private ClassLoader parent;
+    private ServletContext context;
+    private WebappServiceLoader<ServletContainerInitializer> loader;
+
+    @Before
+    public void init() {
+        control = createStrictControl();
+        parent = control.createMock(ClassLoader.class);
+        cl = createMockBuilder(ClassLoader.class)
+                .withConstructor(parent)
+                .addMockedMethod("loadClass", String.class)
+                .createMock(control);
+        context = control.createMock(ServletContext.class);
+        expect(context.getClassLoader()).andStubReturn(cl);
+    }
+
+    @Test
+    public void testNoInitializersFound() throws IOException {
+        loader = new WebappServiceLoader<>(context);
+        expect(context.getAttribute(ServletContext.ORDERED_LIBS)).andReturn(null);
+        expect(cl.getResources(CONFIG_FILE)).andReturn(Collections.<URL>emptyEnumeration());
+        control.replay();
+        Assert.assertTrue(loader.load(ServletContainerInitializer.class).isEmpty());
+        control.verify();
+    }
+
+    @Test
+    @SuppressWarnings("unchecked")
+    public void testInitializerFromClasspath() throws IOException {
+        URL url = new URL("file://test");
+        loader = createMockBuilder(WebappServiceLoader.class)
+                .addMockedMethod("parseConfigFile", Set.class, URL.class)
+                .withConstructor(context).createMock(control);
+        expect(context.getAttribute(ServletContext.ORDERED_LIBS)).andReturn(null);
+        expect(cl.getResources(CONFIG_FILE))
+                .andReturn(Collections.enumeration(Collections.singleton(url)));
+        loader.parseConfigFile(isA(Set.class), same(url));
+        control.replay();
+        Assert.assertTrue(loader.load(ServletContainerInitializer.class).isEmpty());
+        control.verify();
+    }
+
+    @Test
+    @SuppressWarnings("unchecked")
+    public void testWithOrdering() throws IOException {
+        URL url1 = new URL("file://jar1.jar");
+        URL sci1 = new URL("jar:file://jar1.jar!/" + CONFIG_FILE);
+        URL url2 = new URL("file://dir/");
+        URL sci2 = new URL("file://dir/" + CONFIG_FILE);
+        loader = createMockBuilder(WebappServiceLoader.class)
+                .addMockedMethod("parseConfigFile", Set.class, URL.class)
+                .withConstructor(context).createMock(control);
+        List<String> jars = Arrays.asList("jar1.jar", "dir/");
+        expect(context.getAttribute(ServletContext.ORDERED_LIBS)).andReturn(jars);
+        expect(context.getResource("/WEB-INF/lib/jar1.jar")).andReturn(url1);
+        loader.parseConfigFile(isA(Set.class), eq(sci1));
+        expect(context.getResource("/WEB-INF/lib/dir/")).andReturn(url2);
+        loader.parseConfigFile(isA(Set.class), eq(sci2));
+        expect(parent.getResources(CONFIG_FILE)).andReturn(Collections.<URL>emptyEnumeration());
+
+        control.replay();
+        Assert.assertTrue(loader.load(ServletContainerInitializer.class).isEmpty());
+        control.verify();
+    }
+
+    @Test
+    public void testParseConfigFile() throws IOException {
+        Set<String> found = new HashSet<>();
+        loader = new WebappServiceLoader<>(context);
+        loader.parseConfigFile(found, getClass().getResource("service-config.txt"));
+        Assert.assertEquals(Collections.singleton("provider1"), found);
+    }
+
+    @Test
+    public void testLoadServices() throws Exception {
+        Class<?> sci = TesterServletContainerInitializer1.class;
+        loader = new WebappServiceLoader<>(context);
+        cl.loadClass(sci.getName());
+        expectLastCall().andReturn(sci);
+        Set<String> names = Collections.singleton(sci.getName());
+        control.replay();
+        Collection<ServletContainerInitializer> initializers =
+                loader.loadServices(ServletContainerInitializer.class, names);
+        Assert.assertEquals(1, initializers.size());
+        Assert.assertTrue(sci.isInstance(initializers.iterator().next()));
+        control.verify();
+    }
+
+    @Test
+    public void testServiceIsNotExpectedType() throws Exception {
+        Class<?> sci = Object.class;
+        loader = new WebappServiceLoader<>(context);
+        cl.loadClass(sci.getName());
+        expectLastCall().andReturn(sci);
+        Set<String> names = Collections.singleton(sci.getName());
+        control.replay();
+        try {
+            loader.loadServices(ServletContainerInitializer.class, names);
+        } catch (IOException e) {
+            Assert.assertTrue(e.getCause() instanceof ClassCastException);
+        } finally {
+            control.verify();
+        }
+    }
+
+    @Test
+    public void testServiceCannotBeConstructed() throws Exception {
+        Class<?> sci = Integer.class;
+        loader = new WebappServiceLoader<>(context);
+        cl.loadClass(sci.getName());
+        expectLastCall().andReturn(sci);
+        Set<String> names = Collections.singleton(sci.getName());
+        control.replay();
+        try {
+            loader.loadServices(ServletContainerInitializer.class, names);
+        } catch (IOException e) {
+            Assert.assertTrue(e.getCause() instanceof InstantiationException);
+        } finally {
+            control.verify();
+        }
+    }
+}

Propchange: tomcat/trunk/test/org/apache/catalina/startup/TestWebappServiceLoader.java
------------------------------------------------------------------------------
    svn:eol-style = native

Added: tomcat/trunk/test/org/apache/catalina/startup/service-config.txt
URL: http://svn.apache.org/viewvc/tomcat/trunk/test/org/apache/catalina/startup/service-config.txt?rev=1510282&view=auto
==============================================================================
--- tomcat/trunk/test/org/apache/catalina/startup/service-config.txt (added)
+++ tomcat/trunk/test/org/apache/catalina/startup/service-config.txt Sun Aug  4 18:00:40 2013
@@ -0,0 +1,20 @@
+# 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.
+
+# This is a test file for the WebappServiceLoader
+# It contains comment lines and blank lines
+
+provider1 # This comment should be ignored
+provider1 # provider 1 should only be returned once



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Re: svn commit: r1510282 - in /tomcat/trunk: java/org/apache/catalina/startup/WebappServiceLoader.java test/org/apache/catalina/startup/TestWebappServiceLoader.java test/org/apache/catalina/startup/service-config.txt

Posted by Jeremy Boynes <je...@boynes.com>.
On Aug 4, 2013, at 11:32 AM, Mark Thomas <ma...@apache.org> wrote:

> On 04/08/2013 20:00, jboynes@apache.org wrote:
>> Author: jboynes
>> Date: Sun Aug  4 18:00:40 2013
>> New Revision: 1510282
>> 
>> URL: http://svn.apache.org/r1510282
>> Log:
>> Tests for WebappServiceLoader (requires EasyMock)
> 
> Please fix the various checkstyle errors this commit has triggered.

Curse you auto format.
Done, sorry.


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Re: svn commit: r1510282 - in /tomcat/trunk: java/org/apache/catalina/startup/WebappServiceLoader.java test/org/apache/catalina/startup/TestWebappServiceLoader.java test/org/apache/catalina/startup/service-config.txt

Posted by Mark Thomas <ma...@apache.org>.
On 04/08/2013 20:00, jboynes@apache.org wrote:
> Author: jboynes
> Date: Sun Aug  4 18:00:40 2013
> New Revision: 1510282
> 
> URL: http://svn.apache.org/r1510282
> Log:
> Tests for WebappServiceLoader (requires EasyMock)

Please fix the various checkstyle errors this commit has triggered.

Mark

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org