All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.javacrumbs.springws.test.simple.WsMockControl Maven / Gradle / Ivy

/**
 * Copyright 2009-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 net.javacrumbs.springws.test.simple;

import java.io.IOException;
import java.net.URI;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;

import net.javacrumbs.springws.test.MockWebServiceMessageSender;
import net.javacrumbs.springws.test.RequestProcessor;
import net.javacrumbs.springws.test.WsTestException;
import net.javacrumbs.springws.test.context.WsTestContext;
import net.javacrumbs.springws.test.context.WsTestContextHolder;
import net.javacrumbs.springws.test.expression.XPathExpressionResolver;
import net.javacrumbs.springws.test.generator.DefaultResponseGenerator;
import net.javacrumbs.springws.test.lookup.ResourceLookup;
import net.javacrumbs.springws.test.lookup.SimpleResourceLookup;
import net.javacrumbs.springws.test.template.FreeMarkerTemplateProcessor;
import net.javacrumbs.springws.test.template.TemplateProcessor;
import net.javacrumbs.springws.test.template.XsltTemplateProcessor;
import net.javacrumbs.springws.test.validator.ExpressionAssertRequestValidator;
import net.javacrumbs.springws.test.validator.SchemaRequestValidator;
import net.javacrumbs.springws.test.validator.XPathRequestValidator;
import net.javacrumbs.springws.test.validator.XmlCompareRequestValidator;

import org.springframework.core.io.DefaultResourceLoader;
import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceLoader;
import org.springframework.ws.WebServiceMessage;
import org.springframework.ws.WebServiceMessageFactory;
import org.springframework.ws.server.EndpointInterceptor;
import org.springframework.ws.transport.WebServiceMessageSender;

/**
 * Utility class for easy unit-test mock preparation. Usually used in this way
 * 
 * //create control
 * WsMockControl mockControl = new WsMockControl();
 * //create mock
 * WebServiceMessageSender mockMessageSender = mockControl.expectRequest("PRG-DUB-request.xml").returnResponse("PRG-DUB-response.xml").createMock();
 * //use the mock
 * webServiceTemplate.setMessageSender(mockMessageSender);
 * 
 * //do your test here ...
 * 
 * //verify that the mock was used
 * mockControl.verify();
 * 
* * @author Lukas Krecan * */ public class WsMockControl { private final List requestProcessors = new ArrayList(); private TemplateProcessor templateProcessor = new XsltTemplateProcessor(); private ResourceLoader resourceLoader = new DefaultResourceLoader(); private boolean ignoreWhitespace = true; private List interceptors = new ArrayList(); /** * Create mock {@link WebServiceMessageSender}. If behavior not defined, * throws {@link IllegalStateException}. * * @return */ public WebServiceMessageSender createMock() throws IllegalStateException { if (requestProcessors.isEmpty()) { throw new IllegalStateException("No request processor defined. Please call at least returnResponse() method."); } MockWebServiceMessageSender messageSender = new MockWebServiceMessageSender(); messageSender.setRequestProcessors(requestProcessors); messageSender.setInterceptors(interceptors); return messageSender; } /** * Adds request processor. Uses toString() method to get description of the * processor and calls * {@link #addRequestProcessor(RequestProcessor, String)}. * * @param requestProcessor * @return */ public WsMockControl addRequestProcessor(RequestProcessor requestProcessor) { return addRequestProcessor(requestProcessor, requestProcessor.toString()); } /** * Adds a request processor. If the processor does not implement * {@link LimitingRequestProcessor} it's wrapped in * {@link LimitingRequestProcessorWrapper}. * * @param requestProcessor * @param requestProcessorDescription * @return */ public WsMockControl addRequestProcessor(RequestProcessor requestProcessor, String requestProcessorDescription) { if (requestProcessor instanceof LimitingRequestProcessor) { requestProcessors.add((LimitingRequestProcessor) requestProcessor); } else { requestProcessors.add(new LimitingRequestProcessorWrapper(requestProcessor, requestProcessorDescription)); } return this; } /** * Expects that request will be the same as content of the resource. * @param resourceName * @return */ public WsMockControl expectRequest(String resourceName) { return expectRequest(getResourceLoader().getResource(resourceName)); } /** * Expects that request will be the same as content of the resource. * * @param resource * @return */ public WsMockControl expectRequest(Resource resource) { XmlCompareRequestValidator validator = new XmlCompareRequestValidator(); ResourceLookup resourceLookup = createResourceLookup(resource); validator.setControlResourceLookup(resourceLookup); validator.setFailIfControlResourceNotFound(true); validator.setIgnoreWhitespace(ignoreWhitespace); addRequestProcessor(validator, "expectRequest(" + resource.getDescription() + ")"); return this; } /** * Validate requests using given schemas. * @param xsds * @return */ public WsMockControl validateSchema(Resource... xsds) { SchemaRequestValidator validator = new SchemaRequestValidator(); validator.setSchemas(xsds); try { validator.afterPropertiesSet(); } catch (IOException e) { throw new IllegalArgumentException("Can not create schema validator.",e); } addRequestProcessor(validator); return this; } /** * Validate requests using given schemas. * @param xsdPaths * @return */ public WsMockControl validateSchema(String... xsdPaths) { Resource[] resources = new Resource[xsdPaths.length]; for (int i = 0; i < xsdPaths.length; i++) { resources[i] = resourceLoader.getResource(xsdPaths[i]); } return validateSchema(resources); } /** * Creates resource lookup to be used in request validators and response generators. * @param resourceName * @return */ protected ResourceLookup createResourceLookup(Resource resource) { SimpleResourceLookup resourceLookup = new SimpleResourceLookup(resource); resourceLookup.setTemplateProcessor(templateProcessor); return resourceLookup; } /** * Mock will fail if the expression evaluates to true. * * @param expression * @param namespaceMap * @return */ public WsMockControl failIf(String expression, Map namespaceMap) { XPathRequestValidator validator = new XPathRequestValidator(); validator.setExceptionMapping(Collections.singletonMap(expression, "XPath assertion \"" + expression + "\" failed.")); XPathExpressionResolver expressionResolver = new XPathExpressionResolver(); expressionResolver.setNamespaceMap(namespaceMap); validator.setExpressionResolver(expressionResolver); addRequestProcessor(validator, "failIf(\"" + expression + "\")"); return this; } /** * Mock will fail if the expression evaluates to false. * * @param expression * @param namespaceMap * @return */ public WsMockControl assertThat(String expression, Map namespaceMap) { ExpressionAssertRequestValidator validator = new ExpressionAssertRequestValidator(); validator.setAssertExpression(expression); XPathExpressionResolver expressionResolver = new XPathExpressionResolver(); expressionResolver.setNamespaceMap(namespaceMap); validator.setExpressionResolver(expressionResolver); addRequestProcessor(validator, "assertThat(\"" + expression + "\")"); return this; } public WsMockControl returnResponse(String resourceName) { return returnResponse(getResourceLoader().getResource(resourceName)); } /** * Mock will return response taken from the resource. * * @param resourceName * @return */ public WsMockControl returnResponse(Resource resource) { DefaultResponseGenerator responseGenerator = new DefaultResponseGenerator(); ResourceLookup resourceLookup = createResourceLookup(resource); responseGenerator.setResourceLookup(resourceLookup); addRequestProcessor(responseGenerator, "returnResponse(" + resource.getDescription() + ")"); return this; } /** * From now use FreeMarker for templates. * @return */ public WsMockControl useFreeMarkerTemplateProcessor() { FreeMarkerTemplateProcessor freemarkerTemplateProcessor = new FreeMarkerTemplateProcessor(); freemarkerTemplateProcessor.setResourceLoader(new DefaultResourceLoader()); freemarkerTemplateProcessor.afterPropertiesSet(); return useTemplateProcessor(freemarkerTemplateProcessor); } /** * From now use XSLT for templates. * @return */ public WsMockControl useXsltTemplateProcessor() { return useTemplateProcessor(new XsltTemplateProcessor()); } /** * Sets template processor to be used. * * @param templateProcessor * @return */ public WsMockControl useTemplateProcessor(TemplateProcessor templateProcessor) { this.templateProcessor = templateProcessor; return this; } /** * Mock will throw an exception. * * @param exception * @return */ public WsMockControl throwException(final RuntimeException exception) { RequestProcessor thrower = new RequestProcessor() { public WebServiceMessage processRequest(URI uri, WebServiceMessageFactory messageFactory, WebServiceMessage request) throws IOException { throw exception; } }; addRequestProcessor(thrower, "throwException(\"" + exception.getMessage() + "\")"); return this; } /** * Expects given uri. If other URI is used, {@link WsTestException} is * thrown. * * @param expectedUri * @return */ public WsMockControl expectUri(final URI expectedUri) { RequestProcessor validator = new RequestProcessor() { public WebServiceMessage processRequest(URI uri, WebServiceMessageFactory messageFactory, WebServiceMessage request) throws IOException { if (!uri.equals(expectedUri)) { throw new WsTestException("Expected uri " + expectedUri + " but got " + uri); } return null; } }; addRequestProcessor(validator, "expectUri(\"" + expectedUri + "\")"); return this; } /** * Returns list of request processors. * @return */ public List getRequestProcessors() { return new ArrayList(requestProcessors); } /** * Sets number of calls for the last {@link RequestProcessor}. If given * processor was called less the min times, verify will throw * {@link WsTestException}, if it was called for more then max times, the * {@link RequestProcessor} will do nothing and return null. See * {@link LimitingRequestProcessor} for more details. * * @param min * @param max * @return */ public WsMockControl times(int min, int max) { if (requestProcessors.isEmpty()) { throw new IllegalStateException("Can not set behaviour. No request processor defined."); } LimitingRequestProcessor lastProcessor = getLastProcessor(); lastProcessor.setMinNumberOfProcessedRequests(min); lastProcessor.setMaxNumberOfProcessedRequests(max); return this; } public WsMockControl times(int count) { return times(count, count); } public WsMockControl once() { return times(1); } public WsMockControl anyTimes() { return times(0, Integer.MAX_VALUE); } public WsMockControl atLeastOnce() { return times(1, Integer.MAX_VALUE); } private LimitingRequestProcessor getLastProcessor() { return requestProcessors.get(requestProcessors.size() - 1); } /** * Verifies that all RequestProcessors were called given number of times. */ public void verify() { for (LimitingRequestProcessor processor : requestProcessors) { processor.verify(); } } public ResourceLoader getResourceLoader() { return resourceLoader; } public void setResourceLoader(ResourceLoader resourceLoader) { this.resourceLoader = resourceLoader; } public boolean isIgnoreWhitespace() { return ignoreWhitespace; } public WsMockControl ignoreWhitespace(boolean ignoreWhitespace) { this.ignoreWhitespace = ignoreWhitespace; return this; } public WsMockControl addInterceptor(EndpointInterceptor interceptor) { interceptors.add(interceptor); return this; } /** * Simplifies setting of context attribute. See {@link WsTestContext} for more details. * @param name * @param value * @return */ public WsMockControl setTestContextAttribute(String name, Object value) { WsTestContextHolder.getTestContext().setAttribute(name, value); return this; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy