Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use getXPathValidationContext method of com.consol.citrus.dsl.builder.ReceiveMessageBuilder class

Best Citrus code snippet using com.consol.citrus.dsl.builder.ReceiveMessageBuilder.getXPathValidationContext

Source:ReceiveMessageBuilder.java

...504    public T validate(String path, Object controlValue) {505        if (JsonPathMessageValidationContext.isJsonPathExpression(path)) {506            getJsonPathValidationContext().getJsonPathExpressions().put(path, controlValue);507        } else {508            getXPathValidationContext().getXpathExpressions().put(path, controlValue);509        }510        return self;511    }512    513    /**514     * Adds ignore path expression for message element.515     * @param path516     * @return517     */518    public T ignore(String path) {519        if (messageType.equalsIgnoreCase(MessageType.XML.name())520                || messageType.equalsIgnoreCase(MessageType.XHTML.name())) {521            xmlMessageValidationContext.getIgnoreExpressions().add(path);522        } else if (messageType.equalsIgnoreCase(MessageType.JSON.name())) {523            jsonMessageValidationContext.getIgnoreExpressions().add(path);524        }525        return self;526    }527    528    /**529     * Adds XPath message element validation.530     * @param xPathExpression531     * @param controlValue532     * @return533     */534    public T xpath(String xPathExpression, Object controlValue) {535        validate(xPathExpression, controlValue);536        return self;537    }538    /**539     * Adds JsonPath message element validation.540     * @param jsonPathExpression541     * @param controlValue542     * @return543     */544    public T jsonPath(String jsonPathExpression, Object controlValue) {545        validate(jsonPathExpression, controlValue);546        return self;547    }548    549    /**550     * Sets explicit schema instance name to use for schema validation.551     * @param schemaName552     * @return553     */554    public T xsd(String schemaName) {555        xmlMessageValidationContext.setSchema(schemaName);556        return self;557    }558    /**559     * Sets explicit schema instance name to use for schema validation.560     * @param schemaName The name of the schema bean561     */562    public T jsonSchema(String schemaName) {563        jsonMessageValidationContext.setSchema(schemaName);564        return self;565    }566    567    /**568     * Sets explicit xsd schema repository instance to use for validation.569     * @param schemaRepository570     * @return571     */572    public T xsdSchemaRepository(String schemaRepository) {573        xmlMessageValidationContext.setSchemaRepository(schemaRepository);574        return self;575    }576    /**577     * Sets explicit json schema repository instance to use for validation.578     * @param schemaRepository The name of the schema repository bean579     * @return580     */581    public T jsonSchemaRepository(String schemaRepository) {582        jsonMessageValidationContext.setSchemaRepository(schemaRepository);583        return self;584    }585    586    /**587     * Adds explicit namespace declaration for later path validation expressions.588     * @param prefix589     * @param namespaceUri590     * @return591     */592    public T namespace(String prefix, String namespaceUri) {593        getXpathVariableExtractor().getNamespaces().put(prefix, namespaceUri);594        xmlMessageValidationContext.getNamespaces().put(prefix, namespaceUri);595        return self;596    }597    598    /**599     * Sets default namespace declarations on this action builder.600     * @param namespaceMappings601     * @return602     */603    public T namespaces(Map<String, String> namespaceMappings) {604        getXpathVariableExtractor().getNamespaces().putAll(namespaceMappings);605        xmlMessageValidationContext.getNamespaces().putAll(namespaceMappings);606        return self;607    }608    609    /**610     * Sets message selector string.611     * @param messageSelector612     * @return613     */614    public T selector(String messageSelector) {615        getAction().setMessageSelector(messageSelector);616        return self;617    }618    619    /**620     * Sets message selector elements.621     * @param messageSelector622     * @return623     */624    public T selector(Map<String, Object> messageSelector) {625        getAction().setMessageSelectorMap(messageSelector);626        return self;627    }628    629    /**630     * Sets explicit message validators for this receive action.631     * @param validators632     * @return633     */634    public T validator(MessageValidator<? extends ValidationContext> ... validators) {635        Stream.of(validators).forEach(getAction()::addValidator);636        return self;637    }638    639    /**640     * Sets explicit message validators by name.641     * @param validatorNames642     * @return643     */644    @SuppressWarnings("unchecked")645    public T validator(String ... validatorNames) {646        Assert.notNull(applicationContext, "Citrus application context is not initialized!");647        for (String validatorName : validatorNames) {648            getAction().addValidator(applicationContext.getBean(validatorName, MessageValidator.class));649        }650        return self;651    }652    /**653     * Sets explicit header validator for this receive action.654     * @param validators655     * @return656     */657    public T headerValidator(HeaderValidator... validators) {658        Stream.of(validators).forEach(headerValidationContext::addHeaderValidator);659        return self;660    }661    /**662     * Sets explicit header validators by name.663     * @param validatorNames664     * @return665     */666    @SuppressWarnings("unchecked")667    public T headerValidator(String ... validatorNames) {668        Assert.notNull(applicationContext, "Citrus application context is not initialized!");669        for (String validatorName : validatorNames) {670            headerValidationContext.addHeaderValidator(applicationContext.getBean(validatorName, HeaderValidator.class));671        }672        return self;673    }674    /**675     * Sets explicit data dictionary for this receive action.676     * @param dictionary677     * @return678     */679    public T dictionary(DataDictionary dictionary) {680        getAction().setDataDictionary(dictionary);681        return self;682    }683    /**684     * Sets explicit data dictionary by name.685     * @param dictionaryName686     * @return687     */688    @SuppressWarnings("unchecked")689    public T dictionary(String dictionaryName) {690        Assert.notNull(applicationContext, "Citrus application context is not initialized!");691        DataDictionary dictionary = applicationContext.getBean(dictionaryName, DataDictionary.class);692        getAction().setDataDictionary(dictionary);693        return self;694    }695    696    /**697     * Extract message header entry as variable.698     * @param headerName699     * @param variable700     * @return701     */702    public T extractFromHeader(String headerName, String variable) {703        if (headerExtractor == null) {704            headerExtractor = new MessageHeaderVariableExtractor();705            getAction().getVariableExtractors().add(headerExtractor);706        }707        708        headerExtractor.getHeaderMappings().put(headerName, variable);709        return self;710    }711    712    /**713     * Extract message element via XPath or JSONPath from message payload as new test variable.714     * @param path715     * @param variable716     * @return717     */718    public T extractFromPayload(String path, String variable) {719        if (JsonPathMessageValidationContext.isJsonPathExpression(path)) {720            getJsonPathVariableExtractor().getJsonPathExpressions().put(path, variable);721        } else {722            getXpathVariableExtractor().getXpathExpressions().put(path, variable);723        }724        return self;725    }726    727    /**728     * Adds validation callback to the receive action for validating 729     * the received message with Java code.730     * @param callback731     * @return732     */733    public T validationCallback(ValidationCallback callback) {734        if (callback instanceof ApplicationContextAware) {735            ((ApplicationContextAware) callback).setApplicationContext(applicationContext);736        }737        getAction().setValidationCallback(callback);738        return self;739    }740    /**741     * Sets the Spring bean application context.742     * @param applicationContext743     */744    public T withApplicationContext(ApplicationContext applicationContext) {745        this.applicationContext = applicationContext;746        return self;747    }748    /**749     * Get message builder, if already registered or create a new message builder and register it750     *751     * @return the message builder in use752     */753    protected AbstractMessageContentBuilder getMessageContentBuilder() {754        if (getAction().getMessageBuilder() != null && getAction().getMessageBuilder() instanceof AbstractMessageContentBuilder) {755            return (AbstractMessageContentBuilder) getAction().getMessageBuilder();756        } else {757            PayloadTemplateMessageBuilder messageBuilder = new PayloadTemplateMessageBuilder();758            getAction().setMessageBuilder(messageBuilder);759            return messageBuilder;760        }761    }762    /**763     * Creates new variable extractor and adds it to test action.764     */765    private XpathPayloadVariableExtractor getXpathVariableExtractor() {766        if (xpathExtractor == null) {767            xpathExtractor = new XpathPayloadVariableExtractor();768            getAction().getVariableExtractors().add(xpathExtractor);769        }770        return xpathExtractor;771    }772    /**773     * Creates new variable extractor and adds it to test action.774     */775    private JsonPathVariableExtractor getJsonPathVariableExtractor() {776        if (jsonPathExtractor == null) {777            jsonPathExtractor = new JsonPathVariableExtractor();778            getAction().getVariableExtractors().add(jsonPathExtractor);779        }780        return jsonPathExtractor;781    }782    /**783     * Gets the validation context as XML validation context an raises exception if existing validation context is784     * not a XML validation context.785     * @return786     */787    private XpathMessageValidationContext getXPathValidationContext() {788        if (xmlMessageValidationContext instanceof XpathMessageValidationContext) {789            return ((XpathMessageValidationContext)xmlMessageValidationContext);790        } else {791            XpathMessageValidationContext xPathContext = new XpathMessageValidationContext();792            xPathContext.setNamespaces(xmlMessageValidationContext.getNamespaces());793            xPathContext.setControlNamespaces(xmlMessageValidationContext.getControlNamespaces());794            xPathContext.setIgnoreExpressions(xmlMessageValidationContext.getIgnoreExpressions());795            xPathContext.setSchema(xmlMessageValidationContext.getSchema());796            xPathContext.setSchemaRepository(xmlMessageValidationContext.getSchemaRepository());797            xPathContext.setSchemaValidation(xmlMessageValidationContext.isSchemaValidationEnabled());798            xPathContext.setDTDResource(xmlMessageValidationContext.getDTDResource());799            getAction().getValidationContexts().remove(xmlMessageValidationContext);800            getAction().getValidationContexts().add(xPathContext);801            xmlMessageValidationContext = xPathContext;...

getXPathValidationContext

Using AI Code Generation

1import com.consol.citrus.dsl.builder.ReceiveMessageBuilder;2import com.consol.citrus.dsl.runner.TestRunner;3import com.consol.citrus.dsl.testng.TestNGCitrusTestDesigner;4import org.springframework.beans.factory.annotation.Autowired;5import org.springframework.core.io.ClassPathResource;6import org.testng.annotations.Test;7public class MyTest extends TestNGCitrusTestDesigner {8    private TestRunner runner;9    public void test() {10        runner.receive(receiveBuilder -> receiveBuilder.endpoint("myEndpoint")11                .messageType("text/xml")12                .payload(new ClassPathResource("payload.xml"))13                .getXPathValidationContext().ignoreNamespacePrefixes("ns1", "ns2"));14    }15}16import com.consol.citrus.dsl.builder.ReceiveMessageBuilder;17import com.consol.citrus.dsl.runner.TestRunner;18import com.consol.citrus.dsl.testng.TestNGCitrusTestDesigner;19import org.springframework.beans.factory.annotation.Autowired;20import org.springframework.core.io.ClassPathResource;21import org.testng.annotations.Test;22public class MyTest extends TestNGCitrusTestDesigner {23    private TestRunner runner;24    public void test() {25        runner.receive(receiveBuilder -> receiveBuilder.endpoint("myEndpoint")26                .messageType("text/xml")27                .payload(new ClassPathResource("payload.xml"))28                .getXPathValidationContext().ignoreNamespacePrefixes("ns1", "ns2"));29    }30}31import com.consol.citrus.dsl.builder.ReceiveMessageBuilder;32import com.consol.citrus.dsl.runner.TestRunner;33import com.consol.citrus.dsl.testng.TestNGCitrusTestDesigner;34import org.springframework.beans.factory.annotation.Autowired;35import org.springframework.core.io.ClassPathResource;36import org.testng.annotations.Test;37public class MyTest extends TestNGCitrusTestDesigner {38    private TestRunner runner;39    public void test() {40        runner.receive(receiveBuilder -> receiveBuilder.endpoint("myEndpoint")41                .messageType("text/xml")42                .payload(new ClassPathResource("payload.xml"))43                .getXPathValidationContext().ignoreNamespacePrefixes("ns1", "ns2"));44    }

getXPathValidationContext

Using AI Code Generation

1package com.consol.citrus.dsl.builder;2import com.consol.citrus.context.TestContext;3import com.consol.citrus.message.Message;4import com.consol.citrus.validation.builder.AbstractMessageContentBuilder;5import com.consol.citrus.validation.xml.XpathMessageValidationContext;6import com.consol.citrus.validation.xml.XpathPayloadVariableExtractor;7import org.springframework.util.CollectionUtils;8import org.springframework.util.StringUtils;9import org.w3c.dom.Document;10import javax.xml.transform.Source;11import javax.xml.xpath.XPathExpression;12import java.util.*;13public class XPathMessageContentBuilder extends AbstractMessageContentBuilder<XPathMessageContentBuilder> {14    private final List<XPathExpression> xPathExpressions = new ArrayList<>();15    public XPathMessageContentBuilder(List<XPathExpression> xPathExpressions) {16        super("XPath message content builder");17        this.xPathExpressions.addAll(xPathExpressions);18    }19    public String buildMessageContent(Message message, TestContext context) {20        StringBuilder builder = new StringBuilder();21        Document document = context.parseXmlString(message.getPayload(String.class));22        for (XPathExpression xPathExpression : xPathExpressions) {23            String expressionResult = context.getXpathProcessor().evaluateAsString(xPathExpression, document);24            if (StringUtils.hasText(expressionResult)) {25                builder.append(expressionResult);26            }27        }28        return builder.toString();29    }30    public List<String> extractMessageElements(String message, TestContext context) {31        List<String> elements = new ArrayList<>();32        Document document = context.parseXmlString(message);33        for (XPathExpression xPathExpression : xPathExpressions) {34            String expressionResult = context.getXpathProcessor().evaluateAsString(xPathExpression, document);35            if (StringUtils.hasText(expressionResult)) {36                elements.add(expressionResult);37            }38        }

getXPathValidationContext

Using AI Code Generation

1import com.consol.citrus.dsl.runner.TestRunner;2import com.consol.citrus.dsl.builder.ReceiveMessageBuilder;3import com.consol.citrus.dsl.builder.BuilderSupport;4import com.consol.citrus.validation.xml.XmlMessageValidationContext;5import com.consol.citrus.validation.xml.XmlValidationContext;6import com.consol.citrus.validation.xml.XpathMessageValidationContext;7import com.consol.citrus.message.MessageType;8import org.springframework.util.StringUtils;9import java.util.Map;10import java.util.HashMap;11import org.springframework.core.io.ClassPathResource;12import org.springframework.core.io.Resource;13import org.springframework.util.CollectionUtils;14import com.consol.citrus.context.TestContext;15import com.consol.citrus.exceptions.ValidationException;16import com.consol.citrus.message.Message;17import com.consol.citrus.message.MessageType;18import com.consol.citrus.validation.context.ValidationContext;19import com.consol.citrus.validation.xml.XmlMessageValidationContext;20import com.consol.citrus.validation.xml.XmlValidationContext;21import com.consol.citrus.validation.xml.XpathMessageValidationContext;22import com.consol.citrus.xml.namespace.NamespaceContextBuilder;23import com.consol.citrus.xml.namespace.NamespaceContextBuilderSupport;24import com.consol.citrus.xml.namespace.SimpleNamespaceContextBuilder;25import com.consol.citrus.xml.namespace.StaticNamespaceContextBuilder;26import com.consol.citrus.xml.namespace.XPathNamespaceContextBuilder;27import com.consol.citrus.xml.namespace.XPathNamespaceContextBuilderSupport;28import com.consol.citrus.xml.namespace.SimpleXPathNamespaceContextBuilder;29import com.consol.citrus.xml.namespace.StaticXPathNamespaceContextBuilder;30import com.consol.citrus.xml.namespace.XPathUtils;31import com.consol.citrus.xml.XsdSchemaRepository;32import com.consol.citrus.xml.schema.XsdSchemaCollection;33import org.springframework.util.CollectionUtils;34import org.springframework.core.io.Resource;35import org.springframework.core.io.ClassPathResource;36import org.springframework.util.StringUtils;37import java.util.List;38import java.util.ArrayList;39import java.util.Map;40import java.util.HashMap;41import org.springframework.util.Assert;42import org.springframework.util.CollectionUtils;43import org.springframework.util.StringUtils;44import java.util.Map;45import java.util.HashMap;46import org.springframework.core.io.ClassPathResource;47import org.springframework.core.io.Resource;48import org.springframework.util.CollectionUtils;49import com.consol.citrus.context.TestContext;50import com.consol.citrus

getXPathValidationContext

Using AI Code Generation

1ReceiveMessageBuilder receiveMessageBuilder = new ReceiveMessageBuilder();2ReceiveTimeoutBuilder receiveTimeoutBuilder = new ReceiveTimeoutBuilder();3ReceiveTimeoutBuilder receiveTimeoutBuilder = new ReceiveTimeoutBuilder();4ReceiveTimeoutBuilder receiveTimeoutBuilder = new ReceiveTimeoutBuilder();5ReceiveTimeoutBuilder receiveTimeoutBuilder = new ReceiveTimeoutBuilder();6ReceiveTimeoutBuilder receiveTimeoutBuilder = new ReceiveTimeoutBuilder();7ReceiveTimeoutBuilder receiveTimeoutBuilder = new ReceiveTimeoutBuilder();

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.