1 //
2 // ========================================================================
3 // Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd.
4 // ------------------------------------------------------------------------
5 // All rights reserved. This program and the accompanying materials
6 // are made available under the terms of the Eclipse Public License v1.0
7 // and Apache License v2.0 which accompanies this distribution.
8 //
9 // The Eclipse Public License is available at
10 // http://www.eclipse.org/legal/epl-v10.html
11 //
12 // The Apache License v2.0 is available at
13 // http://www.opensource.org/licenses/apache2.0.php
14 //
15 // You may elect to redistribute this code under either of these licenses.
16 // ========================================================================
17 //
18
19 package org.eclipse.jetty.testing;
20
21 import java.net.InetAddress;
22 import java.util.EnumSet;
23 import java.util.Enumeration;
24 import java.util.EventListener;
25
26 import javax.servlet.DispatcherType;
27
28 import org.eclipse.jetty.io.ByteArrayBuffer;
29 import org.eclipse.jetty.server.LocalConnector;
30 import org.eclipse.jetty.server.Server;
31 import org.eclipse.jetty.server.bio.SocketConnector;
32 import org.eclipse.jetty.server.handler.ErrorHandler;
33 import org.eclipse.jetty.server.nio.SelectChannelConnector;
34 import org.eclipse.jetty.servlet.FilterHolder;
35 import org.eclipse.jetty.servlet.ServletContextHandler;
36 import org.eclipse.jetty.servlet.ServletHolder;
37 import org.eclipse.jetty.util.Attributes;
38
39
40
41 /* ------------------------------------------------------------ */
42 /** Testing support for servlets and filters.
43 *
44 * Allows a programatic setup of a context with servlets and filters for
45 * testing. Raw HTTP requests may be sent to the context and responses received.
46 * To avoid handling raw HTTP see {@link org.eclipse.jetty.testing.HttpTester}.
47 * <pre>
48 * ServletTester tester=new ServletTester();
49 * tester.setContextPath("/context");
50 * tester.addServlet(TestServlet.class, "/servlet/*");
51 * tester.addServlet("org.eclipse.jetty.servlet.DefaultServlet", "/");
52 * tester.start();
53 * String response = tester.getResponses("GET /context/servlet/info HTTP/1.0\r\n\r\n");
54 * </pre>
55 *
56 * @see org.eclipse.jetty.testing.HttpTester
57 *
58 *
59 */
60 public class ServletTester
61 {
62 Server _server = new Server();
63 LocalConnector _connector = new LocalConnector();
64 // Context _context = new Context(Context.SESSIONS|Context.SECURITY);
65 //jaspi why security if it is not set up?
66 ServletContextHandler _context = new ServletContextHandler(ServletContextHandler.SESSIONS);
67
68 public ServletTester()
69 {
70 try
71 {
72 _server.addBean(new ErrorHandler());
73 _server.setSendServerVersion(false);
74 _server.addConnector(_connector);
75 _server.setHandler(_context);
76 }
77 catch (Error e)
78 {
79 throw e;
80 }
81 catch (RuntimeException e)
82 {
83 throw e;
84 }
85 catch (Exception e)
86 {
87 throw new RuntimeException(e);
88 }
89 }
90
91 /* ------------------------------------------------------------ */
92 public void dump()
93 {
94 _server.dump();
95 }
96
97 /* ------------------------------------------------------------ */
98 public void start() throws Exception
99 {
100 _server.start();
101 }
102
103 /* ------------------------------------------------------------ */
104 public void join() throws Exception
105 {
106 _server.join();
107 }
108
109 /* ------------------------------------------------------------ */
110 public void stop() throws Exception
111 {
112 _server.stop();
113 }
114
115 /* ------------------------------------------------------------ */
116 public ServletContextHandler getContext()
117 {
118 return _context;
119 }
120
121 /* ------------------------------------------------------------ */
122 /** Get raw HTTP responses from raw HTTP requests.
123 * Multiple requests and responses may be handled, but only if
124 * persistent connections conditions apply.
125 * @param rawRequests String of raw HTTP requests
126 * @return String of raw HTTP responses
127 * @throws Exception
128 */
129 public String getResponses(String rawRequests) throws Exception
130 {
131 return _connector.getResponses(rawRequests);
132 }
133
134 /* ------------------------------------------------------------ */
135 /** Get raw HTTP responses from raw HTTP requests.
136 * Multiple requests and responses may be handled, but only if
137 * persistent connections conditions apply.
138 * @param rawRequests String of raw HTTP requests
139 * @param connector The connector to handle the responses
140 * @return String of raw HTTP responses
141 * @throws Exception
142 */
143 public String getResponses(String rawRequests, LocalConnector connector) throws Exception
144 {
145 return connector.getResponses(rawRequests);
146 }
147
148 /* ------------------------------------------------------------ */
149 /** Get raw HTTP responses from raw HTTP requests.
150 * Multiple requests and responses may be handled, but only if
151 * persistent connections conditions apply.
152 * @param rawRequests String of raw HTTP requests
153 * @return String of raw HTTP responses
154 * @throws Exception
155 */
156 public ByteArrayBuffer getResponses(ByteArrayBuffer rawRequests) throws Exception
157 {
158 return _connector.getResponses(rawRequests,false);
159 }
160
161 /* ------------------------------------------------------------ */
162 /** Create a Socket connector.
163 * This methods adds a socket connector to the server
164 * @param localhost if true, only listen on local host, else listen on all interfaces.
165 * @return A URL to access the server via the socket connector.
166 * @throws Exception
167 */
168 public String createSocketConnector(boolean localhost)
169 throws Exception
170 {
171 synchronized (this)
172 {
173 SocketConnector connector = new SocketConnector();
174 if (localhost)
175 connector.setHost("127.0.0.1");
176 _server.addConnector(connector);
177 if (_server.isStarted())
178 connector.start();
179 else
180 connector.open();
181
182 return "http://127.0.0.1:"+connector.getLocalPort();
183 }
184 }
185
186 /* ------------------------------------------------------------ */
187 /** Create a SelectChannel connector.
188 * This methods adds a select channel connector to the server
189 * @return A URL to access the server via the connector.
190 * @throws Exception
191 */
192 public String createChannelConnector(boolean localhost)
193 throws Exception
194 {
195 synchronized (this)
196 {
197 SelectChannelConnector connector = new SelectChannelConnector();
198 if (localhost)
199 connector.setHost("127.0.0.1");
200 _server.addConnector(connector);
201 if (_server.isStarted())
202 connector.start();
203 else
204 connector.open();
205
206 return "http://"+(localhost?"127.0.0.1":
207 InetAddress.getLocalHost().getHostAddress()
208 )+":"+connector.getLocalPort();
209 }
210 }
211
212 /* ------------------------------------------------------------ */
213 /** Create a local connector.
214 * This methods adds a local connector to the server
215 * @return The LocalConnector object
216 * @throws Exception
217 */
218 public LocalConnector createLocalConnector()
219 throws Exception
220 {
221 synchronized (this)
222 {
223 LocalConnector connector = new LocalConnector();
224 _server.addConnector(connector);
225
226 if (_server.isStarted())
227 connector.start();
228
229 return connector;
230 }
231 }
232
233 /* ------------------------------------------------------------ */
234 /**
235 * @param listener
236 * @see org.eclipse.jetty.server.handler.ContextHandler#addEventListener(java.util.EventListener)
237 */
238 public void addEventListener(EventListener listener)
239 {
240 _context.addEventListener(listener);
241 }
242
243 /* ------------------------------------------------------------ */
244 /**
245 * @param filterClass
246 * @param pathSpec
247 * @param dispatches
248 * @return the FilterHolder
249 * @see org.eclipse.jetty.servlet.ServletContextHandler#addFilter(java.lang.Class, java.lang.String, int)
250 */
251 public FilterHolder addFilter(Class filterClass, String pathSpec, EnumSet<DispatcherType> dispatches)
252 {
253 return _context.addFilter(filterClass,pathSpec,dispatches);
254 }
255
256 /* ------------------------------------------------------------ */
257 /**
258 * @param filterClass
259 * @param pathSpec
260 * @param dispatches
261 * @return the FilterHolder
262 * @see org.eclipse.jetty.servlet.ServletContextHandler#addFilter(java.lang.String, java.lang.String, int)
263 */
264 public FilterHolder addFilter(String filterClass, String pathSpec, EnumSet<DispatcherType> dispatches)
265 {
266 return _context.addFilter(filterClass,pathSpec,dispatches);
267 }
268
269 /* ------------------------------------------------------------ */
270 /**
271 * @param servlet
272 * @param pathSpec
273 * @return the ServletHolder
274 * @see org.eclipse.jetty.servlet.ServletContextHandler#addServlet(java.lang.Class, java.lang.String)
275 */
276 public ServletHolder addServlet(Class servlet, String pathSpec)
277 {
278 return _context.addServlet(servlet,pathSpec);
279 }
280
281 /* ------------------------------------------------------------ */
282 /**
283 * @param className
284 * @param pathSpec
285 * @return the ServletHolder
286 * @see org.eclipse.jetty.servlet.ServletContextHandler#addServlet(java.lang.String, java.lang.String)
287 */
288 public ServletHolder addServlet(String className, String pathSpec)
289 {
290 return _context.addServlet(className,pathSpec);
291 }
292
293 /* ------------------------------------------------------------ */
294 /**
295 * @param name
296 * @return the Attribute object
297 * @see org.eclipse.jetty.servlet.ServletContextHandler#getAttribute(java.lang.String)
298 */
299 public Object getAttribute(String name)
300 {
301 return _context.getAttribute(name);
302 }
303
304 /* ------------------------------------------------------------ */
305 /**
306 * @return the Attribute Names
307 * @see org.eclipse.jetty.servlet.ServletContextHandler#getAttributeNames()
308 */
309 public Enumeration getAttributeNames()
310 {
311 return _context.getAttributeNames();
312 }
313
314 /* ------------------------------------------------------------ */
315 /**
316 * @return the attributes
317 * @see org.eclipse.jetty.servlet.ServletContextHandler#getAttributes()
318 */
319 public Attributes getAttributes()
320 {
321 return _context.getAttributes();
322 }
323
324 /* ------------------------------------------------------------ */
325 /**
326 * @return the resource base
327 * @see org.eclipse.jetty.servlet.ServletContextHandler#getResourceBase()
328 */
329 public String getResourceBase()
330 {
331 return _context.getResourceBase();
332 }
333
334 /* ------------------------------------------------------------ */
335 /**
336 * @param name
337 * @param value
338 * @see org.eclipse.jetty.servlet.ServletContextHandler#setAttribute(java.lang.String, java.lang.Object)
339 */
340 public void setAttribute(String name, Object value)
341 {
342 _context.setAttribute(name,value);
343 }
344
345 /* ------------------------------------------------------------ */
346 /**
347 * @param classLoader
348 * @see org.eclipse.jetty.servlet.ServletContextHandler#setClassLoader(java.lang.ClassLoader)
349 */
350 public void setClassLoader(ClassLoader classLoader)
351 {
352 _context.setClassLoader(classLoader);
353 }
354
355 /* ------------------------------------------------------------ */
356 /**
357 * @param contextPath
358 * @see org.eclipse.jetty.servlet.ServletContextHandler#setContextPath(java.lang.String)
359 */
360 public void setContextPath(String contextPath)
361 {
362 _context.setContextPath(contextPath);
363 }
364
365 /* ------------------------------------------------------------ */
366 /**
367 * @param eventListeners
368 * @see org.eclipse.jetty.servlet.ServletContextHandler#setEventListeners(java.util.EventListener[])
369 */
370 public void setEventListeners(EventListener[] eventListeners)
371 {
372 _context.setEventListeners(eventListeners);
373 }
374
375 /* ------------------------------------------------------------ */
376 /**
377 * @param resourceBase
378 * @see org.eclipse.jetty.servlet.ServletContextHandler#setResourceBase(java.lang.String)
379 */
380 public void setResourceBase(String resourceBase)
381 {
382 _context.setResourceBase(resourceBase);
383 }
384
385 }