You can buy this project and download/modify it how often you want.
/* * Copyright 2006-2015 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 com.consol.citrus.dsl.builder; import com.consol.citrus.TestAction; import com.consol.citrus.actions.ReceiveMessageAction; import com.consol.citrus.dsl.actions.DelegatingTestAction; import com.consol.citrus.endpoint.Endpoint; import com.consol.citrus.exceptions.CitrusRuntimeException; import com.consol.citrus.message.Message; import com.consol.citrus.message.MessageType; import com.consol.citrus.util.FileUtils; import com.consol.citrus.validation.MessageValidator; import com.consol.citrus.validation.builder.*; import com.consol.citrus.validation.callback.ValidationCallback; import com.consol.citrus.validation.context.DefaultValidationContext; import com.consol.citrus.validation.context.ValidationContext; import com.consol.citrus.validation.json.*; import com.consol.citrus.validation.script.ScriptValidationContext; import com.consol.citrus.validation.xml.*; import com.consol.citrus.variable.MessageHeaderVariableExtractor; import com.consol.citrus.variable.dictionary.DataDictionary; import com.consol.citrus.ws.actions.ReceiveSoapMessageAction; import org.springframework.context.ApplicationContext; import org.springframework.core.io.Resource; import org.springframework.oxm.Marshaller; import org.springframework.oxm.XmlMappingException; import org.springframework.util.Assert; import org.springframework.xml.transform.StringResult; import java.io.IOException; import java.util.Map; /** * Receive message action builder offers configuration methods for a receive test action. Build options * include construction of control message payload and headers as well as value extraction. * * @author Christoph Deppisch * @since 2.3 */ public class ReceiveMessageBuilder extends AbstractTestActionBuilder> { /** Self reference for generics support */ private final T self; /** Message type for this action builder */ private String messageType; /** Validation context used in this action builder */ private XmlMessageValidationContext xmlMessageValidationContext = new XmlMessageValidationContext(); private JsonMessageValidationContext jsonMessageValidationContext = new JsonMessageValidationContext(); private DefaultValidationContext defaultValidationContext = new DefaultValidationContext(); /** JSON validation context used in this action builder */ private JsonPathMessageValidationContext jsonPathValidationContext; /** Script validation context used in this action builder */ private ScriptValidationContext scriptValidationContext; /** Variable extractors filled within this action builder */ private MessageHeaderVariableExtractor headerExtractor; private XpathPayloadVariableExtractor xpathExtractor; private JsonPathVariableExtractor jsonPathExtractor; /** Basic application context */ private ApplicationContext applicationContext; /** * Default constructor using test action, basic application context and position handle. * @param action */ public ReceiveMessageBuilder(A action) { this(new DelegatingTestAction(action)); } /** * Default constructor. */ public ReceiveMessageBuilder() { this((A) new ReceiveMessageAction()); } /** * Constructor using delegate test action. * @param action */ public ReceiveMessageBuilder(DelegatingTestAction action) { super(action); this.self = (T) this; } /** * Sets the message endpoint to receive messages from. * @param messageEndpoint * @return */ public ReceiveMessageBuilder endpoint(Endpoint messageEndpoint) { getAction().setEndpoint(messageEndpoint); return this; } /** * Sets the message endpoint uri to receive messages from. * @param messageEndpointUri * @return */ public ReceiveMessageBuilder endpoint(String messageEndpointUri) { getAction().setEndpointUri(messageEndpointUri); return this; } /** * Adds a custom timeout to this message receiving action. * @param receiveTimeout * @return */ public T timeout(long receiveTimeout) { getAction().setReceiveTimeout(receiveTimeout); return self; } /** * Expect a control message in this receive action. * @param controlMessage * @return */ public T message(Message controlMessage) { StaticMessageContentBuilder staticMessageContentBuilder = StaticMessageContentBuilder.withMessage(controlMessage); staticMessageContentBuilder.setMessageHeaders(getMessageContentBuilder().getMessageHeaders()); getAction().setMessageBuilder(staticMessageContentBuilder); return self; } /** * Sets the payload data on the message builder implementation. * @param payload * @return */ protected void setPayload(String payload) { MessageContentBuilder messageContentBuilder = getMessageContentBuilder(); if (messageContentBuilder instanceof PayloadTemplateMessageBuilder) { ((PayloadTemplateMessageBuilder) messageContentBuilder).setPayloadData(payload); } else if (messageContentBuilder instanceof StaticMessageContentBuilder) { ((StaticMessageContentBuilder) messageContentBuilder).getMessage().setPayload(payload); } else { throw new CitrusRuntimeException("Unable to set payload on message builder type: " + messageContentBuilder.getClass()); } } /** * Expect this message payload data in received message. * @param payload * @return */ public T payload(String payload) { setPayload(payload); return self; } /** * Expect this message payload data in received message. * @param payloadResource * @return */ public T payload(Resource payloadResource) { try { setPayload(FileUtils.readToString(payloadResource)); } catch (IOException e) { throw new CitrusRuntimeException("Failed to read payload resource", e); } return self; } /** * Expect this message payload as model object which is marshalled to a character sequence * using the default object to xml mapper before validation is performed. * @param payload * @param marshaller * @return */ public T payload(Object payload, Marshaller marshaller) { StringResult result = new StringResult(); try { marshaller.marshal(payload, result); } catch (XmlMappingException e) { throw new CitrusRuntimeException("Failed to marshal object graph for message payload", e); } catch (IOException e) { throw new CitrusRuntimeException("Failed to marshal object graph for message payload", e); } setPayload(result.toString()); return self; } /** * Expect this message payload as model object which is marshalled to a character sequence using the default object to xml mapper that * is available in Spring bean application context. * * @param payload * @return */ public T payloadModel(Object payload) { Assert.notNull(applicationContext, "Citrus application context is not initialized!"); return payload(payload, applicationContext.getBean(Marshaller.class)); } /** * Expect this message payload as model object which is marshalled to a character sequence using the given object to xml mapper that * is accessed by its bean name in Spring bean application context. * * @param payload * @param marshallerName * @return */ public T payload(Object payload, String marshallerName) { Assert.notNull(applicationContext, "Citrus application context is not initialized!"); return payload(payload, applicationContext.getBean(marshallerName, Marshaller.class)); } /** * Expect this message header entry in received message. * @param name * @param value * @return */ public T header(String name, Object value) { getMessageContentBuilder().getMessageHeaders().put(name, value); return self; } /** * Expect this message header data in received message. Message header data is used in * SOAP messages as XML fragment for instance. * @param data * @return */ public T header(String data) { getMessageContentBuilder().getHeaderData().add(data); return self; } /** * Expect this message header data in received message from file resource. Message header data is used in * SOAP messages as XML fragment for instance. * @param resource * @return */ public T header(Resource resource) { try { getMessageContentBuilder().getHeaderData().add(FileUtils.readToString(resource)); } catch (IOException e) { throw new CitrusRuntimeException("Failed to read header resource", e); } return self; } /** * Adds script validation. * @param validationScript * @return */ public T validateScript(String validationScript) { getScriptValidationContext().setValidationScript(validationScript); return self; } /** * Reads validation script file resource and sets content as validation script. * @param scriptResource * @return */ public T validateScript(Resource scriptResource) { try { validateScript(FileUtils.readToString(scriptResource)); } catch (IOException e) { throw new CitrusRuntimeException("Failed to read script resource file", e); } return self; } /** * Adds script validation file resource. * @param fileResourcePath * @return */ public T validateScriptResource(String fileResourcePath) { getScriptValidationContext().setValidationScriptResourcePath(fileResourcePath); return self; } /** * Adds custom validation script type. * @param type * @return */ public T validateScriptType(String type) { getScriptValidationContext().setScriptType(type); return self; } /** * Sets a explicit message type for this receive action. * @param messageType * @return */ public T messageType(MessageType messageType) { messageType(messageType.name()); return self; } /** * Sets a explicit message type for this receive action. * @param messageType * @return */ public T messageType(String messageType) { this.messageType = messageType; getAction().setMessageType(messageType); if (messageType.equalsIgnoreCase(MessageType.XML.name())) { getAction().getValidationContexts().add(xmlMessageValidationContext); getAction().getValidationContexts().remove(jsonMessageValidationContext); } else if (messageType.equalsIgnoreCase(MessageType.JSON.name())) { getAction().getValidationContexts().remove(xmlMessageValidationContext); getAction().getValidationContexts().add(jsonMessageValidationContext); } else { getAction().getValidationContexts().remove(xmlMessageValidationContext); getAction().getValidationContexts().remove(jsonMessageValidationContext); getAction().getValidationContexts().add(defaultValidationContext); } return self; } /** * Sets schema validation enabled/disabled for this message. * @param enabled * @return */ public T schemaValidation(boolean enabled) { xmlMessageValidationContext.setSchemaValidation(enabled); return self; } /** * Validates XML namespace with prefix and uri. * @param prefix * @param namespaceUri * @return */ public T validateNamespace(String prefix, String namespaceUri) { xmlMessageValidationContext.getControlNamespaces().put(prefix, namespaceUri); return self; } /** * Adds message element validation. * @param path * @param controlValue * @return */ public T validate(String path, Object controlValue) { if (JsonPathMessageValidationContext.isJsonPathExpression(path)) { if (!messageType.equalsIgnoreCase(MessageType.JSON.name())) { throw new CitrusRuntimeException(String.format("Failed to set JSONPath validation expression on message type '%s' - please use JSON message type", messageType)); } getJsonPathValidationContext().getJsonPathExpressions().put(path, controlValue); } else { getXPathValidationContext().getXpathExpressions().put(path, controlValue); } return self; } /** * Adds ignore path expression for message element. * @param path * @return */ public T ignore(String path) { if (messageType.equalsIgnoreCase(MessageType.XML.name())) { xmlMessageValidationContext.getIgnoreExpressions().add(path); } else if (messageType.equalsIgnoreCase(MessageType.JSON.name())) { jsonMessageValidationContext.getIgnoreExpressions().add(path); } return self; } /** * Adds XPath message element validation. * @param xPathExpression * @param controlValue * @return */ public T xpath(String xPathExpression, Object controlValue) { validate(xPathExpression, controlValue); return self; } /** * Adds JsonPath message element validation. * @param jsonPathExpression * @param controlValue * @return */ public T jsonPath(String jsonPathExpression, Object controlValue) { validate(jsonPathExpression, controlValue); return self; } /** * Sets explicit schema instance name to use for schema validation. * @param schemaName * @return */ public T xsd(String schemaName) { xmlMessageValidationContext.setSchema(schemaName); return self; } /** * Sets explicit xsd schema repository instance to use for validation. * @param schemaRepository * @return */ public T xsdSchemaRepository(String schemaRepository) { xmlMessageValidationContext.setSchemaRepository(schemaRepository); return self; } /** * Adds explicit namespace declaration for later path validation expressions. * @param prefix * @param namespaceUri * @return */ public T namespace(String prefix, String namespaceUri) { getXpathVariableExtractor().getNamespaces().put(prefix, namespaceUri); xmlMessageValidationContext.getNamespaces().put(prefix, namespaceUri); return self; } /** * Sets default namespace declarations on this action builder. * @param namespaceMappings * @return */ public T namespaces(Map namespaceMappings) { getXpathVariableExtractor().getNamespaces().putAll(namespaceMappings); xmlMessageValidationContext.getNamespaces().putAll(namespaceMappings); return self; } /** * Sets message selector string. * @param messageSelector * @return */ public T selector(String messageSelector) { getAction().setMessageSelectorString(messageSelector); return self; } /** * Sets message selector elements. * @param messageSelector * @return */ public T selector(Map messageSelector) { getAction().setMessageSelector(messageSelector); return self; } /** * Sets explicit message validator for this receive action. * @param validator * @return */ public T validator(MessageValidator validator) { getAction().setValidator(validator); return self; } /** * Sets explicit message validator by name. * @param validatorName * @return */ @SuppressWarnings("unchecked") public T validator(String validatorName) { Assert.notNull(applicationContext, "Citrus application context is not initialized!"); MessageValidator validator = applicationContext.getBean(validatorName, MessageValidator.class); getAction().setValidator(validator); return self; } /** * Sets explicit data dictionary for this receive action. * @param dictionary * @return */ public T dictionary(DataDictionary dictionary) { getAction().setDataDictionary(dictionary); return self; } /** * Sets explicit data dictionary by name. * @param dictionaryName * @return */ @SuppressWarnings("unchecked") public T dictionary(String dictionaryName) { Assert.notNull(applicationContext, "Citrus application context is not initialized!"); DataDictionary dictionary = applicationContext.getBean(dictionaryName, DataDictionary.class); getAction().setDataDictionary(dictionary); return self; } /** * Extract message header entry as variable. * @param headerName * @param variable * @return */ public T extractFromHeader(String headerName, String variable) { if (headerExtractor == null) { headerExtractor = new MessageHeaderVariableExtractor(); getAction().getVariableExtractors().add(headerExtractor); } headerExtractor.getHeaderMappings().put(headerName, variable); return self; } /** * Extract message element via XPath or JSONPath from message payload as new test variable. * @param path * @param variable * @return */ public T extractFromPayload(String path, String variable) { if (JsonPathMessageValidationContext.isJsonPathExpression(path)) { getJsonPathVariableExtractor().getJsonPathExpressions().put(path, variable); } else { getXpathVariableExtractor().getXpathExpressions().put(path, variable); } return self; } /** * Adds validation callback to the receive action for validating * the received message with Java code. * @param callback * @return */ public T validationCallback(ValidationCallback callback) { callback.setApplicationContext(applicationContext); getAction().setValidationCallback(callback); return self; } /** * Sets the Spring bean application context. * @param applicationContext */ public T withApplicationContext(ApplicationContext applicationContext) { this.applicationContext = applicationContext; return self; } /** * Enable SOAP specific properties on this receiving message action. * @return * @deprecated since 2.6 in favor of using {@link SoapActionBuilder} */ public ReceiveSoapMessageBuilder soap() { ReceiveSoapMessageAction receiveSoapMessageAction = new ReceiveSoapMessageAction(); receiveSoapMessageAction.setActor(getAction().getActor()); receiveSoapMessageAction.setDescription(getAction().getDescription()); receiveSoapMessageAction.setEndpoint(getAction().getEndpoint()); receiveSoapMessageAction.setEndpointUri(getAction().getEndpointUri()); receiveSoapMessageAction.setMessageSelector(getAction().getMessageSelector()); receiveSoapMessageAction.setMessageSelectorString(getAction().getMessageSelectorString()); receiveSoapMessageAction.setMessageType(getAction().getMessageType()); receiveSoapMessageAction.setMessageBuilder(getAction().getMessageBuilder()); receiveSoapMessageAction.setReceiveTimeout(getAction().getReceiveTimeout()); receiveSoapMessageAction.setValidationCallback(getAction().getValidationCallback()); receiveSoapMessageAction.setValidationContexts(getAction().getValidationContexts()); receiveSoapMessageAction.setValidator(getAction().getValidator()); receiveSoapMessageAction.setVariableExtractors(getAction().getVariableExtractors()); action.setDelegate(receiveSoapMessageAction); ReceiveSoapMessageBuilder builder = new ReceiveSoapMessageBuilder(action); builder.withApplicationContext(applicationContext); builder.setMessageType(messageType); builder.setDefaultValidationContext(defaultValidationContext); builder.setXmlMessageValidationContext(xmlMessageValidationContext); builder.setJsonPathValidationContext(jsonPathValidationContext); builder.setScriptValidationContext(scriptValidationContext); builder.setJsonPathValidationContext(jsonPathValidationContext); builder.setHeaderExtractor(headerExtractor); builder.setXpathExtractor(xpathExtractor); builder.setJsonPathExtractor(jsonPathExtractor); return builder; } /** * Enable HTTP specific properties on this receiving message action. * @return * @deprecated since 2.6 in favor of using {@link HttpActionBuilder} */ public ReceiveHttpMessageBuilder http() { ReceiveHttpMessageBuilder builder = new ReceiveHttpMessageBuilder(action); builder.withApplicationContext(applicationContext); builder.setMessageType(messageType); builder.setDefaultValidationContext(defaultValidationContext); builder.setXmlMessageValidationContext(xmlMessageValidationContext); builder.setJsonPathValidationContext(jsonPathValidationContext); builder.setScriptValidationContext(scriptValidationContext); builder.setJsonPathValidationContext(jsonPathValidationContext); builder.setHeaderExtractor(headerExtractor); builder.setXpathExtractor(xpathExtractor); builder.setJsonPathExtractor(jsonPathExtractor); return builder; } /** * Get message builder, if already registered or create a new message builder and register it * * @return the message builder in use */ protected AbstractMessageContentBuilder getMessageContentBuilder() { if (getAction().getMessageBuilder() != null && getAction().getMessageBuilder() instanceof AbstractMessageContentBuilder) { return (AbstractMessageContentBuilder) getAction().getMessageBuilder(); } else { PayloadTemplateMessageBuilder messageBuilder = new PayloadTemplateMessageBuilder(); getAction().setMessageBuilder(messageBuilder); return messageBuilder; } } /** * Creates new variable extractor and adds it to test action. */ private XpathPayloadVariableExtractor getXpathVariableExtractor() { if (xpathExtractor == null) { xpathExtractor = new XpathPayloadVariableExtractor(); getAction().getVariableExtractors().add(xpathExtractor); } return xpathExtractor; } /** * Creates new variable extractor and adds it to test action. */ private JsonPathVariableExtractor getJsonPathVariableExtractor() { if (jsonPathExtractor == null) { jsonPathExtractor = new JsonPathVariableExtractor(); getAction().getVariableExtractors().add(jsonPathExtractor); } return jsonPathExtractor; } /** * Gets the validation context as XML validation context an raises exception if existing validation context is * not a XML validation context. * @return */ private XpathMessageValidationContext getXPathValidationContext() { if (xmlMessageValidationContext instanceof XpathMessageValidationContext) { return ((XpathMessageValidationContext)xmlMessageValidationContext); } else if (xmlMessageValidationContext instanceof XmlMessageValidationContext) { XpathMessageValidationContext xPathContext = new XpathMessageValidationContext(); xPathContext.setNamespaces(xmlMessageValidationContext.getNamespaces()); xPathContext.setControlNamespaces(xmlMessageValidationContext.getControlNamespaces()); xPathContext.setIgnoreExpressions(xmlMessageValidationContext.getIgnoreExpressions()); xPathContext.setSchema(xmlMessageValidationContext.getSchema()); xPathContext.setSchemaRepository(xmlMessageValidationContext.getSchemaRepository()); xPathContext.setSchemaValidation(xmlMessageValidationContext.isSchemaValidationEnabled()); xPathContext.setDTDResource(xmlMessageValidationContext.getDTDResource()); getAction().getValidationContexts().remove(xmlMessageValidationContext); getAction().getValidationContexts().add(xPathContext); xmlMessageValidationContext = xPathContext; return xPathContext; } else { throw new CitrusRuntimeException("Unable to set XML property on validation context type " + xmlMessageValidationContext); } } /** * Creates new script validation context if not done before and gets the script validation context. */ private ScriptValidationContext getScriptValidationContext() { if (scriptValidationContext == null) { scriptValidationContext = new ScriptValidationContext(messageType.toString()); getAction().getValidationContexts().add(scriptValidationContext); } return scriptValidationContext; } /** * Creates new JSONPath validation context if not done before and gets the validation context. */ private JsonPathMessageValidationContext getJsonPathValidationContext() { if (jsonPathValidationContext == null) { jsonPathValidationContext = new JsonPathMessageValidationContext(); getAction().getValidationContexts().add(jsonPathValidationContext); } return jsonPathValidationContext; } /** * Provides access to receive message action delegate. * @return */ protected ReceiveMessageAction getAction() { return (ReceiveMessageAction) action.getDelegate(); } /** * Sets the message type. * @param messageType */ protected void setMessageType(MessageType messageType) { this.messageType = messageType.name(); } /** * Sets the message type. * @param messageType */ protected void setMessageType(String messageType) { this.messageType = messageType; } /** * Sets the xpath extractor. * @param xpathExtractor */ protected void setXpathExtractor(XpathPayloadVariableExtractor xpathExtractor) { this.xpathExtractor = xpathExtractor; } /** * Sets the jsonPath extractor. * @param jsonPathExtractor */ protected void setJsonPathExtractor(JsonPathVariableExtractor jsonPathExtractor) { this.jsonPathExtractor = jsonPathExtractor; } /** * Sets the header extractor. * @param headerExtractor */ protected void setHeaderExtractor(MessageHeaderVariableExtractor headerExtractor) { this.headerExtractor = headerExtractor; } /** * Sets the script message validator. * @param scriptValidationContext */ protected void setScriptValidationContext(ScriptValidationContext scriptValidationContext) { this.scriptValidationContext = scriptValidationContext; } /** * Sets the script message validator. * @param jsonPathValidationContext */ protected void setJsonPathValidationContext(JsonPathMessageValidationContext jsonPathValidationContext) { this.jsonPathValidationContext = jsonPathValidationContext; } /** * Sets the XML validation context. * @param validationContext */ protected void setXmlMessageValidationContext(XmlMessageValidationContext validationContext) { this.xmlMessageValidationContext = validationContext; } /** * Sets the JSON validation context. * @param validationContext */ protected void setJsonMessageValidationContext(JsonMessageValidationContext validationContext) { this.jsonMessageValidationContext = validationContext; } /** * Sets the default validation context. * @param validationContext */ protected void setDefaultValidationContext(DefaultValidationContext validationContext) { this.defaultValidationContext = validationContext; } }
