Spring/spring-ws
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Using MockStrategiesHelper

Browse Source
This commit is contained in:
Arjen Poutsma
2010-11-03 13:20:25 +00:00
parent 6ba078c3dc
commit f7be55005f
6 changed files with 320 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

115
test/src/main/java/org/springframework/ws/test/client/MockWebServiceServer.java
View File

@@ -16,11 +16,81 @@
package org.springframework.ws.test.client;
import org.springframework.beans.factory.BeanInitializationException;
import org.springframework.context.ApplicationContext;
import org.springframework.util.Assert;
import org.springframework.ws.client.core.WebServiceTemplate;
import org.springframework.ws.client.core.support.WebServiceGatewaySupport;
import org.springframework.ws.test.support.MockStrategiesHelper;
/**
* <strong>Main entry point for client-side Web service testing</strong>. Typically used to test a {@link
* WebServiceTemplate}, set up expectations on request messages, and create response messages.
* <p/>
* The typical usage of this class is:
* <ol>
* <li>Create a {@code MockWebServiceServer} instance by calling {@link #createServer(WebServiceTemplate)}.
* Typically, the template is configured as a Spring bean, either explicitly or as a property of a class that extends
* {@link WebServiceGatewaySupport WebServiceGatewaySupport}.</li>
* <li>Set up request expectations by calling {@link #expect(RequestMatcher)}, possibly by using the default
* {@link RequestMatcher} implementations provided in {@link RequestMatchers} (which can be statically imported).
* Multiple expectations can be set up by chaining {@link ResponseActions#andExpect(RequestMatcher)} calls.</li>
* <li>Create an appropriate response message by calling
* {@link ResponseActions#andRespond(ResponseCreator) andRespond(ResponseCreator)}, possibly by using the default
* {@link ResponseCreator} implementations provided in {@link ResponseCreators} (which can be statically imported).</li>
* <li>Use the {@code WebServiceTemplate} as normal, either directly of through client code.</li>
* <li>Call {@link #verify()}.</ol>
* Note that because of the 'fluent' API offered by this class (and related classes), you can typically use the Code
* Completion features (i.e. ctrl-space) in your IDE to set up the mocks.
* <p/>
* For example:
* <blockquote><pre>
* import org.junit.*;
* import org.springframework.beans.factory.annotation.Autowired;
* import org.springframework.test.context.ContextConfiguration;
* import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
* import org.springframework.xml.transform.StringSource;
* <strong>import org.springframework.ws.test.client.MockWebServiceServer</strong>;
* <strong>import static org.springframework.ws.test.client.RequestMatchers.*</strong>;
* <strong>import static org.springframework.ws.test.client.ResponseCreators.*</strong>;
*
* &#064;RunWith(SpringJUnit4ClassRunner.class)
* &#064;ContextConfiguration("applicationContext.xml")
* public class MyWebServiceClientIntegrationTest {
*
* // MyWebServiceClient extends WebServiceGatewaySupport, and is configured in applicationContext.xml
* &#064;Autowired
* private MyWebServiceClient client;
*
* private MockWebServiceServer mockServer;
*
* &#064;Before
* public void createServer() throws Exception {
* <strong>mockServer = MockWebServiceServer.createServer(client.getWebServiceTemplate())</strong>;
* }
*
* &#064;Test
* public void getCustomerCount() throws Exception {
* Source expectedRequestPayload =
* new StringSource("&lt;customerCountRequest xmlns=\"http://springframework.org/spring-ws/test\" /&gt;");
* Source responsePayload = new StringSource("&lt;customerCountResponse xmlns='http://springframework.org/spring-ws/test'&gt;" +
* "&lt;customerCount&gt;10&lt;/customerCount&gt;" +
* "&lt;/customerCountResponse&gt;");
*
* <strong>mockServer.expect(payload(expectedRequestPayload)).andRespond(withPayload(responsePayload));</strong>
*
* // client.getCustomerCount() uses the WebServiceTemplate
* int customerCount = client.getCustomerCount();
* assertEquals(10, response.getCustomerCount());
*
* <strong>mockServer.verify();</strong>
* }
* }
* </pre></blockquote>
*
* @author Arjen Poutsma
* @author Lukas Krecan
* @since 2.0
*/
public class MockWebServiceServer {
@@ -31,6 +101,12 @@ public class MockWebServiceServer {
this.mockMessageSender = mockMessageSender;
}
/**
* Creates a {@code MockWebServiceServer} instance based on the given {@link WebServiceTemplate}.
*
* @param webServiceTemplate the web service template
* @return the created server
*/
public static MockWebServiceServer createServer(WebServiceTemplate webServiceTemplate) {
Assert.notNull(webServiceTemplate, "'webServiceTemplate' must not be null");
@@ -40,9 +116,46 @@ public class MockWebServiceServer {
return new MockWebServiceServer(mockMessageSender);
}
/**
* Creates a {@code MockWebServiceServer} instance based on the given {@link WebServiceGatewaySupport}.
*
* @param gatewaySupport the client class
* @return the created server
*/
public static MockWebServiceServer createServer(WebServiceGatewaySupport gatewaySupport) {
Assert.notNull(gatewaySupport, "'gatewaySupport' must not be null");
return createServer(gatewaySupport.getWebServiceTemplate());
}
/**
* Creates a {@code MockWebServiceServer} instance based on the given {@link ApplicationContext}.
* <p/>
* This factory method will try and find a configured {@link WebServiceTemplate} in the given application context.
* If no template can be found, it will try and find a {@link WebServiceGatewaySupport}, and use its configured
* template. If neither can be found, an exception is thrown.
*
* @param applicationContext the application context to base the client on
* @return the created server
* @throws BeanInitializationException if the given application context contains neither a {@link
* WebServiceTemplate} nor a {@link WebServiceGatewaySupport}.
*/
public static MockWebServiceServer createServer(ApplicationContext applicationContext) {
MockStrategiesHelper strategiesHelper = new MockStrategiesHelper(applicationContext);
WebServiceTemplate webServiceTemplate = strategiesHelper.getStrategy(WebServiceTemplate.class);
if (webServiceTemplate != null) {
return createServer(webServiceTemplate);
}
WebServiceGatewaySupport gatewaySupport = strategiesHelper.getStrategy(WebServiceGatewaySupport.class);
if (gatewaySupport != null) {
return createServer(gatewaySupport);
}
throw new BeanInitializationException(
"Could not find either WebServiceTemplate or WebServiceGatewaySupport in application context");
}
/**
* Records an expectation specified by the given {@link RequestMatcher}. Returns a {@link ResponseActions} object
* that allows for setting up the response, or more expectations.
* that allows for creating the response, or to set up more expectations.
*
* @param requestMatcher the request matcher expected
* @return the response actions

59
test/src/main/java/org/springframework/ws/test/server/MockWebServiceClient.java
View File

@@ -17,18 +17,16 @@
package org.springframework.ws.test.server;
import java.io.IOException;
import java.util.Map;
import org.springframework.beans.factory.BeanInitializationException;
import org.springframework.context.ApplicationContext;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;
import org.springframework.ws.WebServiceMessage;
import org.springframework.ws.WebServiceMessageFactory;
import org.springframework.ws.context.DefaultMessageContext;
import org.springframework.ws.context.MessageContext;
import org.springframework.ws.soap.saaj.SaajSoapMessageFactory;
import org.springframework.ws.soap.server.SoapMessageDispatcher;
import org.springframework.ws.test.support.MockStrategiesHelper;
import org.springframework.ws.transport.WebServiceMessageReceiver;
import org.apache.commons.logging.Log;
@@ -110,56 +108,17 @@ public class MockWebServiceClient {
* @return the created client
*/
public static MockWebServiceClient createClient(ApplicationContext applicationContext) {
WebServiceMessageReceiver messageReceiver = getMessageReceiver(applicationContext);
WebServiceMessageFactory messageFactory = getMessageFactory(applicationContext);
Assert.notNull(applicationContext, "'applicationContext' must not be null");
MockStrategiesHelper strategiesHelper = new MockStrategiesHelper(applicationContext);
WebServiceMessageReceiver messageReceiver =
strategiesHelper.getStrategy(WebServiceMessageReceiver.class, SoapMessageDispatcher.class);
WebServiceMessageFactory messageFactory =
strategiesHelper.getStrategy(WebServiceMessageFactory.class, SaajSoapMessageFactory.class);
return new MockWebServiceClient(messageReceiver, messageFactory);
}
private static WebServiceMessageReceiver getMessageReceiver(ApplicationContext applicationContext) {
WebServiceMessageReceiver messageReceiver = getStrategy(applicationContext, WebServiceMessageReceiver.class);
if (messageReceiver == null) {
if (logger.isDebugEnabled()) {
logger.debug("No WebServiceMessageReceiver found, using default");
}
SoapMessageDispatcher soapMessageDispatcher = new SoapMessageDispatcher();
soapMessageDispatcher.setApplicationContext(applicationContext);
messageReceiver = soapMessageDispatcher;
}
return messageReceiver;
}
private static WebServiceMessageFactory getMessageFactory(ApplicationContext applicationContext) {
WebServiceMessageFactory messageFactory = getStrategy(applicationContext, WebServiceMessageFactory.class);
if (messageFactory == null) {
if (logger.isDebugEnabled()) {
logger.debug("No WebServiceMessageFactory found, using default");
}
SaajSoapMessageFactory saajSoapMessageFactory = new SaajSoapMessageFactory();
saajSoapMessageFactory.afterPropertiesSet();
messageFactory = saajSoapMessageFactory;
}
return messageFactory;
}
private static <T> T getStrategy(ApplicationContext applicationContext, Class<T> strategyInterface) {
Map<String, T> map = applicationContext.getBeansOfType(strategyInterface);
if (map.isEmpty()) {
return null;
}
else if (map.size() == 1) {
Map.Entry<String, T> entry = map.entrySet().iterator().next();
if (logger.isDebugEnabled()) {
logger.debug("Using " + ClassUtils.getShortName(strategyInterface) + " [" + entry.getKey() + "]");
}
return entry.getValue();
}
else {
throw new BeanInitializationException(
"Could not find exactly 1 " + ClassUtils.getShortName(strategyInterface) +
" in application context");
}
}
// Sending
/**

53
test/src/main/java/org/springframework/ws/test/support/MockStrategiesHelper.java
View File

@@ -18,8 +18,13 @@ package org.springframework.ws.test.support;
import java.util.Map;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.BeanCreationException;
import org.springframework.beans.factory.BeanInitializationException;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;
import org.apache.commons.logging.Log;
@@ -43,9 +48,17 @@ public class MockStrategiesHelper {
* @param applicationContext the application context
*/
public MockStrategiesHelper(ApplicationContext applicationContext) {
Assert.notNull(applicationContext, "'applicationContext' must not be null");
this.applicationContext = applicationContext;
}
/**
* Returns the application context.
*/
public ApplicationContext getApplicationContext() {
return applicationContext;
}
/**
* Returns a single strategy found in the given application context.
*
@@ -54,6 +67,7 @@ public class MockStrategiesHelper {
* @throws BeanInitializationException if there is more than 1 beans of the given type
*/
public <T> T getStrategy(Class<T> type) {
Assert.notNull(type, "'type' must not be null");
Map<String, T> map = applicationContext.getBeansOfType(type);
if (map.isEmpty()) {
return null;
@@ -71,4 +85,43 @@ public class MockStrategiesHelper {
}
}
/**
* Returns a single strategy found in the given application context, or instantiates a default strategy if no
* applicable strategy was found.
*
* @param type the type of bean to be found in the application context
* @param defaultType the type to instantiate and return when no bean of the specified type could be found
* @return the bean found in the application context, or the default type if no bean of the given type can be found
* @throws BeanInitializationException if there is more than 1 beans of the given type
*/
public <T, D extends T> T getStrategy(Class<T> type, Class<D> defaultType) {
Assert.notNull(defaultType, "'defaultType' must not be null");
T t = getStrategy(type);
if (t != null) {
return t;
}
else {
if (logger.isDebugEnabled()) {
logger.debug("No " + ClassUtils.getShortName(type) + " found, using default " +
ClassUtils.getShortName(defaultType));
}
T defaultStrategy = BeanUtils.instantiateClass(defaultType);
if (defaultStrategy instanceof ApplicationContextAware) {
ApplicationContextAware applicationContextAware = (ApplicationContextAware) defaultStrategy;
applicationContextAware.setApplicationContext(applicationContext);
}
if (defaultStrategy instanceof InitializingBean) {
InitializingBean initializingBean = (InitializingBean) defaultStrategy;
try {
initializingBean.afterPropertiesSet();
}
catch (Exception ex) {
throw new BeanCreationException("Invocation of init method failed", ex);
}
}
return defaultStrategy;
}
}
}

78
test/src/test/java/org/springframework/ws/test/client/MockWebServiceServerTest.java Normal file
View File

@@ -0,0 +1,78 @@
/*
* Copyright 2005-2010 the original author or authors.
*
* Licensed 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.springframework.ws.test.client;
import org.springframework.beans.factory.BeanInitializationException;
import org.springframework.context.support.StaticApplicationContext;
import org.springframework.ws.client.core.WebServiceTemplate;
import org.springframework.ws.client.core.support.WebServiceGatewaySupport;
import org.junit.Test;
import static org.junit.Assert.assertNotNull;
public class MockWebServiceServerTest {
@Test
public void createServerWebServiceTemplate() throws Exception {
WebServiceTemplate template = new WebServiceTemplate();
MockWebServiceServer server = MockWebServiceServer.createServer(template);
assertNotNull(server);
}
@Test
public void createServerGatewaySupport() throws Exception {
MyClient client = new MyClient();
MockWebServiceServer server = MockWebServiceServer.createServer(client);
assertNotNull(server);
}
@Test
public void createServerApplicationContextWebServiceTemplate() throws Exception {
StaticApplicationContext applicationContext = new StaticApplicationContext();
applicationContext.registerSingleton("webServiceTemplate", WebServiceTemplate.class);
applicationContext.refresh();
MockWebServiceServer server = MockWebServiceServer.createServer(applicationContext);
assertNotNull(server);
}
@Test
public void createServerApplicationContextWebServiceGatewaySupport() throws Exception {
StaticApplicationContext applicationContext = new StaticApplicationContext();
applicationContext.registerSingleton("myClient", MyClient.class);
applicationContext.refresh();
MockWebServiceServer server = MockWebServiceServer.createServer(applicationContext);
assertNotNull(server);
}
@Test(expected = BeanInitializationException.class)
public void createServerApplicationContextEmpty() throws Exception {
StaticApplicationContext applicationContext = new StaticApplicationContext();
applicationContext.refresh();
MockWebServiceServer server = MockWebServiceServer.createServer(applicationContext);
assertNotNull(server);
}
public static class MyClient extends WebServiceGatewaySupport {
}
}

48
test/src/test/java/org/springframework/ws/test/server/MockWebServiceClientTest.java Normal file
View File

@@ -0,0 +1,48 @@
/*
* Copyright 2005-2010 the original author or authors.
*
* Licensed 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.springframework.ws.test.server;
import org.springframework.context.support.StaticApplicationContext;
import org.springframework.ws.soap.saaj.SaajSoapMessageFactory;
import org.springframework.ws.soap.server.SoapMessageDispatcher;
import org.junit.Test;
import static org.junit.Assert.assertNotNull;
public class MockWebServiceClientTest {
@Test
public void createServerApplicationContext() throws Exception {
StaticApplicationContext applicationContext = new StaticApplicationContext();
applicationContext.registerSingleton("messageDispatcher", SoapMessageDispatcher.class);
applicationContext.registerSingleton("messageFactory", SaajSoapMessageFactory.class);
applicationContext.refresh();
MockWebServiceClient client = MockWebServiceClient.createClient(applicationContext);
assertNotNull(client);
}
@Test
public void createServerApplicationContextDefaults() throws Exception {
StaticApplicationContext applicationContext = new StaticApplicationContext();
applicationContext.refresh();
MockWebServiceClient client = MockWebServiceClient.createClient(applicationContext);
assertNotNull(client);
}
}

22
test/src/test/java/org/springframework/ws/test/support/MockStrategiesHelperTest.java
View File

@@ -31,7 +31,7 @@ public class MockStrategiesHelperTest {
StaticApplicationContext applicationContext = new StaticApplicationContext();
MockStrategiesHelper helper = new MockStrategiesHelper(applicationContext);
assertNull(helper.getStrategy(MyBean.class));
assertNull(helper.getStrategy(IMyBean.class));
}
@Test
@@ -40,7 +40,7 @@ public class MockStrategiesHelperTest {
applicationContext.registerSingleton("myBean", MyBean.class);
MockStrategiesHelper helper = new MockStrategiesHelper(applicationContext);
assertNotNull(helper.getStrategy(MyBean.class));
assertNotNull(helper.getStrategy(IMyBean.class));
}
@Test(expected = BeanInitializationException.class)
@@ -50,10 +50,24 @@ public class MockStrategiesHelperTest {
applicationContext.registerSingleton("myBean2", MyBean.class);
MockStrategiesHelper helper = new MockStrategiesHelper(applicationContext);
helper.getStrategy(MyBean.class);
helper.getStrategy(IMyBean.class);
}
@Test
public void noneWithDefault() {
StaticApplicationContext applicationContext = new StaticApplicationContext();
MockStrategiesHelper helper = new MockStrategiesHelper(applicationContext);
assertNotNull(helper.getStrategy(IMyBean.class, MyBean.class));
}
public static class MyBean {
public interface IMyBean {
}
public static class MyBean implements IMyBean {
}