/**
* 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.cxf.transport.http_osgi;
import java.io.InputStream;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;
import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletInputStream;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.xml.namespace.QName;
import org.apache.cxf.Bus;
import org.apache.cxf.message.ExchangeImpl;
import org.apache.cxf.message.Message;
import org.apache.cxf.message.MessageImpl;
import org.apache.cxf.security.SecurityContext;
import org.apache.cxf.service.model.EndpointInfo;
import org.apache.cxf.service.model.InterfaceInfo;
import org.apache.cxf.service.model.ServiceInfo;
import org.apache.cxf.transport.MessageObserver;
import org.apache.cxf.transport.http.AbstractHTTPDestination;
import org.apache.cxf.transport.http.HTTPSession;
import org.apache.cxf.transports.http.QueryHandler;
import org.apache.cxf.transports.http.QueryHandlerRegistry;
import org.apache.cxf.wsdl.EndpointReferenceUtils;
import org.apache.cxf.wsdl.http.AddressType;
import org.easymock.classextension.EasyMock;
import org.easymock.classextension.IMocksControl;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
public class OsgiServletTest extends Assert {
private static final String ADDRESS = "http://bar/snafu";
private static final String ROOT = "http://localhost:8080/";
private static final QName QNAME = new QName(ADDRESS, "foobar");
private static final String PATH = "/SoapContext/SoapPort";
private static final String URI = "/cxf" + PATH;
private static final String[] REGISTERED_PATHS = {"/soap", "/soap2", "/soappath", "/soap/test",
"/test/tst"};
private static final String[] REQUEST_PATHS = {"/soap", "/soap/2", "/soap2", "/soap3",
"/soap/test", "/soap/tst", "/soap/", "/test/tst/2",
"/test/2"};
private static final int[] MATCHED_PATH_INDEXES = {0, 0, 1, -1,
3, 0, 0, 4,
-1};
private static final String SERVICES = "/cxf/services";
private static final String QUERY = "wsdl";
private static final String VERB = "POST";
private static final String TEXT = "text/html";
private static final String TEXT_LIST = "text/html; charset=UTF-8";
private static final String XML = "text/xml";
private static final String ENCODING = "UTF-8";
private static final String NO_SERVICE =
"<html><body>No service was found.</body></html>";
private IMocksControl control;
private Bus bus;
private OsgiDestinationRegistryIntf registry;
private OsgiDestination destination;
private OsgiDestination nodestination;
private ServletConfig config;
private ServletContext context;
private HttpServletRequest request;
private HttpServletResponse response;
private MessageImpl message;
private MessageObserver observer;
private AddressType extensor;
private ExchangeImpl exchange;
private EndpointInfo endpoint;
private Set<String> paths;
@Before
public void setUp() {
control = EasyMock.createNiceControl();
bus = control.createMock(Bus.class);
registry = control.createMock(OsgiDestinationRegistryIntf.class);
destination = control.createMock(OsgiDestination.class);
nodestination = control.createMock(OsgiDestination.class);
context = control.createMock(ServletContext.class);
config = control.createMock(ServletConfig.class);
request = control.createMock(HttpServletRequest.class);
response = control.createMock(HttpServletResponse.class);
message = control.createMock(MessageImpl.class);
exchange = control.createMock(ExchangeImpl.class);
observer = control.createMock(MessageObserver.class);
extensor = control.createMock(AddressType.class);
endpoint = new EndpointInfo();
endpoint.setAddress(PATH);
endpoint.setName(QNAME);
ServiceInfo service = new ServiceInfo();
service.setInterface(new InterfaceInfo(service, QNAME));
endpoint.setService(service);
paths = new TreeSet<String>();
}
@After
public void tearDown() {
bus = null;
registry = null;
destination = null;
nodestination = null;
context = null;
config = null;
request = null;
response = null;
message = null;
exchange = null;
destination = null;
exchange = null;
observer = null;
extensor = null;
}
@Test
public void testInvokeNoDestination() throws Exception {
setUpRequest(URI, null, -1);
setUpResponse(404, TEXT, NO_SERVICE);
control.replay();
OsgiServlet servlet = setUpServlet();
servlet.invoke(request, response);
control.verify();
}
@Test
public void testInvokeGetServices() throws Exception {
setUpRequest(SERVICES, null, 1);
paths.add(PATH);
EasyMock.expect(request.getContextPath()).andReturn("");
EasyMock.expect(request.getServletPath()).andReturn("/cxf");
EasyMock.expect(registry.getDestinationForPath(PATH)).andReturn(destination);
setUpResponse(0, TEXT_LIST,
"<span class=\"field\">Endpoint address:</span> "
+ "<span class=\"value\">" + ROOT + URI + "</span>");
control.replay();
OsgiServlet servlet = setUpServlet();
servlet.invoke(request, response);
control.verify();
}
@Test
public void testInvokeGetServicesNoService() throws Exception {
setUpRequest(SERVICES, null, 0);
setUpResponse(0, TEXT_LIST,
"<span class=\"heading\">No services have been found.</span>");
control.replay();
OsgiServlet servlet = setUpServlet();
servlet.invoke(request, response);
control.verify();
}
@Test
public void testInvokeWsdlQuery() throws Exception {
setUpRequest(URI, PATH, -2);
setUpQuery();
control.replay();
OsgiServlet servlet = setUpServlet();
servlet.invoke(request, response);
control.verify();
}
@Test
public void testInvokeDestination() throws Exception {
setUpRequest(URI, PATH, -2);
setUpMessage();
control.replay();
OsgiServlet servlet = setUpServlet();
servlet.invoke(request, response);
control.verify();
}
@Test
public void testInvokeRestful() throws Exception {
setUpRequest(URI, null, -1);
setUpRestful();
setUpMessage();
control.replay();
OsgiServlet servlet = setUpServlet();
servlet.invoke(request, response);
control.verify();
}
@Test
public void testDestinationDetermination() throws Exception {
for (int i = 0; i < REQUEST_PATHS.length; i++) {
setUpPathRegistrationAndRequest(i);
final int mi = MATCHED_PATH_INDEXES[i];
if (mi < 0) {
// add the dummy path
EasyMock.expect(destination.getAddress())
.andReturn(EndpointReferenceUtils.getEndpointReference(PATH)).anyTimes();
setUpResponse(404, TEXT, NO_SERVICE);
} else {
// add the correct path
EasyMock.expect(destination.getAddress())
.andReturn(EndpointReferenceUtils.getEndpointReference(REGISTERED_PATHS[mi])).anyTimes();
// add the artifacts needed for updateDests() if a fallback occurs
if (!REQUEST_PATHS[i].equals(REGISTERED_PATHS[mi])) {
EasyMock.expect(request.getContextPath()).andReturn("");
EasyMock.expect(request.getServletPath()).andReturn("/cxf");
}
}
control.replay();
OsgiServlet servlet = setUpServlet();
servlet.invoke(request, response);
control.verify();
control.reset();
}
}
private void setUpRequest(String requestURI,
String path,
int destinationCount) throws Exception {
EasyMock.expect(request.getRequestURI()).andReturn(requestURI).anyTimes();
StringBuffer url = new StringBuffer(ROOT + requestURI);
EasyMock.expect(request.getRequestURL()).andReturn(url).anyTimes();
EasyMock.expect(request.getQueryString()).andReturn(QUERY).anyTimes();
EasyMock.expect(destination.getEndpointInfo()).andReturn(endpoint).anyTimes();
EasyMock.expect(destination.getBus()).andReturn(bus).anyTimes();
String defaultPath = SERVICES.equals(requestURI) ? "/services" : PATH;
EasyMock.expect(request.getPathInfo()).andReturn(path != null
? path
: defaultPath).anyTimes();
if (path != null) {
EasyMock.expect(registry.getDestinationForPath(path)).andReturn(destination);
}
if (destinationCount == -1) {
EasyMock.expect(registry.getDestinationsPaths()).andReturn(paths).anyTimes();
} else if (destinationCount >= 0) {
EasyMock.expect(registry.getDestinationsPaths()).andReturn(paths);
List<OsgiDestination> destinations =
new ArrayList<OsgiDestination>();
for (int i = 0; i < destinationCount; i++) {
destinations.add(destination);
}
EasyMock.expect(registry.getDestinations()).andReturn(destinations);
}
}
private void setUpMessage() throws Exception {
ServletInputStream sis = control.createMock(ServletInputStream.class);
EasyMock.expect(request.getInputStream()).andReturn(sis);
message.setContent(EasyMock.eq(InputStream.class), EasyMock.same(sis));
EasyMock.expectLastCall();
setUpProperty(AbstractHTTPDestination.HTTP_REQUEST, request);
setUpProperty(AbstractHTTPDestination.HTTP_RESPONSE, response);
setUpProperty(AbstractHTTPDestination.HTTP_CONTEXT, context);
setUpProperty(AbstractHTTPDestination.HTTP_CONFIG, config);
EasyMock.expect(request.getMethod()).andReturn(VERB);
setUpProperty(Message.HTTP_REQUEST_METHOD, VERB);
setUpProperty(Message.REQUEST_URI, URI);
setUpProperty(Message.QUERY_STRING, QUERY);
EasyMock.expect(request.getContentType()).andReturn(XML);
setUpProperty(Message.CONTENT_TYPE, XML);
EasyMock.expect(request.getHeader("Accept")).andReturn(XML);
setUpProperty(Message.ACCEPT_CONTENT_TYPE, XML);
destination.getAddress();
EasyMock.expectLastCall().andReturn(EndpointReferenceUtils.getEndpointReference(PATH));
setUpProperty(Message.BASE_PATH, PATH);
message.put(EasyMock.eq(SecurityContext.class), EasyMock.isA(SecurityContext.class));
EasyMock.expect(request.getCharacterEncoding()).andReturn(ENCODING);
setUpProperty(Message.ENCODING, ENCODING);
exchange.setSession(EasyMock.isA(HTTPSession.class));
EasyMock.expectLastCall();
}
private void setUpProperty(String name, Object value) {
message.put(EasyMock.eq(name), EasyMock.same(value));
EasyMock.expectLastCall().andReturn(null).anyTimes();
}
private void setUpResponse(int status,
String responseType,
String ... responseMsgs) throws Exception {
if (status != 0) {
response.setStatus(status);
EasyMock.expectLastCall();
}
if (responseType != null) {
response.setContentType(responseType);
EasyMock.expectLastCall();
}
if (responseMsgs != null) {
PrintWriter writer = control.createMock(PrintWriter.class);
EasyMock.expect(response.getWriter()).andReturn(writer).anyTimes();
for (String msg : responseMsgs) {
writer.write(msg);
EasyMock.expectLastCall();
}
}
}
private void setUpQuery() throws Exception {
QueryHandlerRegistry qrh =
control.createMock(QueryHandlerRegistry.class);
EasyMock.expect(bus.getExtension(QueryHandlerRegistry.class)).andReturn(qrh).anyTimes();
QueryHandler qh = control.createMock(QueryHandler.class);
List<QueryHandler> handlers = new ArrayList<QueryHandler>();
handlers.add(qh);
EasyMock.expect(qrh.getHandlers()).andReturn(handlers);
String base = ROOT + URI + "?" + QUERY;
EasyMock.expect(qh.isRecognizedQuery(EasyMock.eq(base),
EasyMock.eq(PATH),
EasyMock.same(endpoint))).andReturn(Boolean.TRUE);
EasyMock.expect(qh.getResponseContentType(EasyMock.eq(base),
EasyMock.eq(PATH))).andReturn(XML);
ServletOutputStream sos = control.createMock(ServletOutputStream.class);
EasyMock.expect(response.getOutputStream()).andReturn(sos);
qh.writeResponse(EasyMock.eq(base), EasyMock.eq(PATH), EasyMock.same(endpoint), EasyMock.same(sos));
EasyMock.expectLastCall();
sos.flush();
EasyMock.expectLastCall();
}
private void setUpRestful() {
paths.add(PATH);
EasyMock.expect(request.getContextPath()).andReturn("");
EasyMock.expect(request.getServletPath()).andReturn("/cxf");
EasyMock.expect(registry.getDestinationForPath(PATH)).andReturn(null);
EasyMock.expect(registry.getDestinationForPath(PATH)).andReturn(destination).times(2);
EasyMock.expect(destination.getMessageObserver()).andReturn(observer);
endpoint.addExtensor(extensor);
extensor.setLocation(EasyMock.eq(ROOT + URI));
EasyMock.expectLastCall();
}
private OsgiServlet setUpServlet() {
OsgiServlet servlet = new OsgiServlet(registry) {
public ServletContext getServletContext() {
return context;
}
public ServletConfig getServletConfig() {
return config;
}
protected MessageImpl createInMessage() {
return message;
}
protected ExchangeImpl createExchange() {
return exchange;
}
};
try {
servlet.init(config);
} catch (ServletException ex) {
// ignore
}
return servlet;
}
private void setUpPathRegistrationAndRequest(int index) throws Exception {
String requestURI = "/cxf" + REQUEST_PATHS[index];
EasyMock.expect(request.getRequestURI()).andReturn(requestURI).anyTimes();
StringBuffer url = new StringBuffer(ROOT + requestURI);
EasyMock.expect(request.getRequestURL()).andReturn(url).anyTimes();
EasyMock.expect(request.getQueryString()).andReturn(QUERY).anyTimes();
EasyMock.expect(request.getPathInfo()).andReturn(REQUEST_PATHS[index]).anyTimes();
EasyMock.expect(destination.getEndpointInfo()).andReturn(endpoint).anyTimes();
EasyMock.expect(nodestination.getEndpointInfo()).andReturn(endpoint).anyTimes();
EasyMock.expect(destination.getBus()).andReturn(bus).anyTimes();
EasyMock.expect(destination.getMessageObserver()).andReturn(observer).anyTimes();
int matched = MATCHED_PATH_INDEXES[index];
EasyMock.expect(registry.getDestinationsPaths()).andReturn(paths).anyTimes();
for (int i = 0; i < REGISTERED_PATHS.length; i++) {
paths.add(REGISTERED_PATHS[i]);
EasyMock.expect(registry.getDestinationForPath(REGISTERED_PATHS[i]))
.andReturn(matched == i ? destination : nodestination).anyTimes();
}
}
}