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

Copied to Clipboard!

How to use MessageHeaderVariableExtractor class of com.consol.citrus.variable package

Best Citrus code snippet using com.consol.citrus.variable.MessageHeaderVariableExtractor

Source:AbstractMessageActionParser.java

...22import com.consol.citrus.validation.context.ValidationContext;23import com.consol.citrus.validation.json.*;24import com.consol.citrus.validation.xml.XpathMessageConstructionInterceptor;25import com.consol.citrus.validation.script.GroovyScriptMessageBuilder;26import com.consol.citrus.variable.MessageHeaderVariableExtractor;27import com.consol.citrus.variable.VariableExtractor;28import org.springframework.beans.factory.BeanCreationException;29import org.springframework.beans.factory.xml.BeanDefinitionParser;30import org.springframework.util.CollectionUtils;31import org.springframework.util.StringUtils;32import org.springframework.util.xml.DomUtils;33import org.w3c.dom.Element;34import java.util.*;35/**36 * Parser providing basic message element configurations used in send and receive actions.37 * 38 * @author Christoph Deppisch39 */40public abstract class AbstractMessageActionParser implements BeanDefinitionParser {41    /**42     * Static parse method taking care of basic message element parsing.43     * 44     * @param messageElement45     */46    public AbstractMessageContentBuilder constructMessageBuilder(Element messageElement) {47        AbstractMessageContentBuilder messageBuilder = null;48        49        if (messageElement != null) {50            messageBuilder = parsePayloadTemplateBuilder(messageElement);51            52            if (messageBuilder == null) {53                messageBuilder = parseScriptBuilder(messageElement);54            }55        }56        if (messageBuilder == null) {57            messageBuilder = new PayloadTemplateMessageBuilder();58        }59        if (messageElement != null && messageElement.hasAttribute("name")) {60            messageBuilder.setMessageName(messageElement.getAttribute("name"));61        }62        return messageBuilder;63    }64    65    /**66     * @param messageElement67     * @return68     */69    private GroovyScriptMessageBuilder parseScriptBuilder(Element messageElement) {70        GroovyScriptMessageBuilder scriptMessageBuilder = null;71        72        Element builderElement = DomUtils.getChildElementByTagName(messageElement, "builder");73        if (builderElement != null) {74            String builderType = builderElement.getAttribute("type");75            76            if (!StringUtils.hasText(builderType)) {77                throw new BeanCreationException("Missing message builder type - please define valid type " +78                        "attribute for message builder");79            } else if (builderType.equals("groovy")) {80                scriptMessageBuilder = new GroovyScriptMessageBuilder();81            } else {82                throw new BeanCreationException("Unsupported message builder type: '" + builderType + "'");83            }84            String scriptResourcePath = builderElement.getAttribute("file");85            if (StringUtils.hasText(scriptResourcePath)) {86                scriptMessageBuilder.setScriptResourcePath(scriptResourcePath);87                if (builderElement.hasAttribute("charset")) {88                    scriptMessageBuilder.setScriptResourceCharset(builderElement.getAttribute("charset"));89                }90            } else {91                scriptMessageBuilder.setScriptData(DomUtils.getTextValue(builderElement).trim());92            }93        }94        if (scriptMessageBuilder != null && messageElement.hasAttribute("name")) {95            scriptMessageBuilder.setMessageName(messageElement.getAttribute("name"));96        }97        98        return scriptMessageBuilder;99    }100    /**101     * Parses message payload template information given in message element.102     * @param messageElement103     */104    private PayloadTemplateMessageBuilder parsePayloadTemplateBuilder(Element messageElement) {105        PayloadTemplateMessageBuilder messageBuilder;106        107        messageBuilder = parsePayloadElement(messageElement);108        109        Element xmlDataElement = DomUtils.getChildElementByTagName(messageElement, "data");110        if (xmlDataElement != null) {111            messageBuilder = new PayloadTemplateMessageBuilder();112            messageBuilder.setPayloadData(DomUtils.getTextValue(xmlDataElement).trim());113        }114        Element xmlResourceElement = DomUtils.getChildElementByTagName(messageElement, "resource");115        if (xmlResourceElement != null) {116            messageBuilder = new PayloadTemplateMessageBuilder();117            messageBuilder.setPayloadResourcePath(xmlResourceElement.getAttribute("file"));118            if (xmlResourceElement.hasAttribute("charset")) {119                messageBuilder.setPayloadResourceCharset(xmlResourceElement.getAttribute("charset"));120            }121        }122        123        if (messageBuilder != null) {124            Map<String, String> overwriteXpath = new HashMap<>();125            Map<String, String> overwriteJsonPath = new HashMap<>();126            List<?> messageValueElements = DomUtils.getChildElementsByTagName(messageElement, "element");127            for (Iterator<?> iter = messageValueElements.iterator(); iter.hasNext();) {128                Element messageValue = (Element) iter.next();129                String pathExpression = messageValue.getAttribute("path");130                if (JsonPathMessageValidationContext.isJsonPathExpression(pathExpression)) {131                    overwriteJsonPath.put(pathExpression, messageValue.getAttribute("value"));132                } else {133                    overwriteXpath.put(pathExpression, messageValue.getAttribute("value"));134                }135            }136            137            if (!overwriteXpath.isEmpty()) {138                XpathMessageConstructionInterceptor interceptor = new XpathMessageConstructionInterceptor(overwriteXpath);139                messageBuilder.add(interceptor);140            }141            if (!overwriteJsonPath.isEmpty()) {142                JsonPathMessageConstructionInterceptor interceptor = new JsonPathMessageConstructionInterceptor(overwriteJsonPath);143                messageBuilder.add(interceptor);144            }145        } 146        147        return messageBuilder;148    }149    /**150     * Parses the xs:any payload elements nested in message element.151     * @param messageElement152     */153    private PayloadTemplateMessageBuilder parsePayloadElement(Element messageElement) {154        PayloadTemplateMessageBuilder messageBuilder = null;155        156        // parse payload with xs-any element157        Element payloadElement = DomUtils.getChildElementByTagName(messageElement, "payload");158        if (payloadElement != null) {159            messageBuilder = new PayloadTemplateMessageBuilder();160            if (messageElement.hasAttribute("name")) {161                messageBuilder.setMessageName(messageElement.getAttribute("name"));162            }163            List<Element> payload = DomUtils.getChildElements(payloadElement);164            if (CollectionUtils.isEmpty(payload)) {165                messageBuilder.setPayloadData("");166            } else {167                messageBuilder.setPayloadData(PayloadElementParser.parseMessagePayload(payload.get(0)));168            }169        }170        171        return messageBuilder;172    }173    /**174     * Parse message header elements in action and add headers to 175     * message content builder.176     * 177     * @param actionElement the action DOM element.178     * @param messageBuilder the message content builder.179     * @param validationContexts list of validation contexts.180     */181    protected void parseHeaderElements(Element actionElement, AbstractMessageContentBuilder messageBuilder, List<ValidationContext> validationContexts) {182        Element headerElement = DomUtils.getChildElementByTagName(actionElement, "header");183        Map<String, Object> messageHeaders = new LinkedHashMap<>();184        if (headerElement != null) {185            List<?> elements = DomUtils.getChildElementsByTagName(headerElement, "element");186            for (Iterator<?> iter = elements.iterator(); iter.hasNext();) {187                Element headerValue = (Element) iter.next();188                189                String name = headerValue.getAttribute("name");190                String value = headerValue.getAttribute("value");191                String type = headerValue.getAttribute("type");192                if (StringUtils.hasText(type)) {193                    value = MessageHeaderType.createTypedValue(type, value);194                }195                196                messageHeaders.put(name, value);197            }198            199            List<Element> headerDataElements = DomUtils.getChildElementsByTagName(headerElement, "data");200            for (Element headerDataElement : headerDataElements) {201                messageBuilder.getHeaderData().add(DomUtils.getTextValue(headerDataElement).trim());202            }203            List<Element> headerResourceElements = DomUtils.getChildElementsByTagName(headerElement, "resource");204            for (Element headerResourceElement : headerResourceElements) {205                String charset = headerResourceElement.getAttribute("charset");206                messageBuilder.getHeaderResources().add(headerResourceElement.getAttribute("file") + (StringUtils.hasText(charset) ? FileUtils.FILE_PATH_CHARSET_PARAMETER + charset : ""));207            }208            // parse fragment with xs-any element209            List<Element> headerFragmentElements = DomUtils.getChildElementsByTagName(headerElement, "fragment");210            for (Element headerFragmentElement : headerFragmentElements) {211                List<Element> fragment = DomUtils.getChildElements(headerFragmentElement);212                if (!CollectionUtils.isEmpty(fragment)) {213                    messageBuilder.getHeaderData().add(PayloadElementParser.parseMessagePayload(fragment.get(0)));214                }215            }216            messageBuilder.setMessageHeaders(messageHeaders);217            if (headerElement.hasAttribute("ignore-case")) {218                boolean ignoreCase = Boolean.valueOf(headerElement.getAttribute("ignore-case"));219                validationContexts.stream().filter(context -> context instanceof HeaderValidationContext)220                                            .map(context -> (HeaderValidationContext) context)221                                            .forEach(context -> context.setHeaderNameIgnoreCase(ignoreCase));222            }223        }224    }225    226    /**227     * Parses header extract information.228     * @param element the root action element.229     * @param variableExtractors the variable extractors to add new extractors to.230     */231    protected void parseExtractHeaderElements(Element element, List<VariableExtractor> variableExtractors) {232        Element extractElement = DomUtils.getChildElementByTagName(element, "extract");233        Map<String, String> extractHeaderValues = new HashMap<>();234        if (extractElement != null) {235            List<?> headerValueElements = DomUtils.getChildElementsByTagName(extractElement, "header");236            for (Iterator<?> iter = headerValueElements.iterator(); iter.hasNext();) {237                Element headerValue = (Element) iter.next();238                extractHeaderValues.put(headerValue.getAttribute("name"), headerValue.getAttribute("variable"));239            }240            241            MessageHeaderVariableExtractor headerVariableExtractor = new MessageHeaderVariableExtractor();242            headerVariableExtractor.setHeaderMappings(extractHeaderValues);243            if (!CollectionUtils.isEmpty(extractHeaderValues)) {244                variableExtractors.add(headerVariableExtractor);245            }246        }247    }248}...

Source:SendMessageActionParserTest.java

...21import com.consol.citrus.validation.builder.PayloadTemplateMessageBuilder;22import com.consol.citrus.validation.json.JsonPathMessageConstructionInterceptor;23import com.consol.citrus.validation.xml.XpathMessageConstructionInterceptor;24import com.consol.citrus.validation.script.GroovyScriptMessageBuilder;25import com.consol.citrus.variable.MessageHeaderVariableExtractor;26import org.testng.Assert;27import org.testng.annotations.Test;28/**29 * @author Christoph Deppisch30 */31public class SendMessageActionParserTest extends AbstractActionParserTest<SendMessageAction> {32    @Test33    public void testSendMessageActionParser() {34        assertActionCount(8);35        assertActionClassAndName(SendMessageAction.class, "send");36        37        PayloadTemplateMessageBuilder messageBuilder;38        GroovyScriptMessageBuilder groovyMessageBuilder;39        40        // 1st action41        SendMessageAction action = getNextTestActionFromTest();42        messageBuilder = (PayloadTemplateMessageBuilder)action.getMessageBuilder();43        44        Assert.assertNull(messageBuilder.getPayloadResourcePath());45        Assert.assertNotNull(messageBuilder.getPayloadData());46        Assert.assertEquals(messageBuilder.getPayloadData().trim(), "<TestMessage>Hello Citrus</TestMessage>");47        Assert.assertEquals(messageBuilder.getMessageHeaders().size(), 1);48        Assert.assertEquals(messageBuilder.getMessageHeaders().get("operation"), "Test");49        Assert.assertEquals(messageBuilder.getMessageInterceptors().size(), 0);50        Assert.assertEquals(action.getEndpoint(), beanDefinitionContext.getBean("myMessageEndpoint", Endpoint.class));51        Assert.assertNull(action.getEndpointUri());52        Assert.assertNull(action.getDataDictionary());53        //2nd action54        action = getNextTestActionFromTest();55        messageBuilder = (PayloadTemplateMessageBuilder)action.getMessageBuilder();56        Assert.assertNull(messageBuilder.getPayloadResourcePath());57        Assert.assertNotNull(messageBuilder.getPayloadData());58        Assert.assertEquals(messageBuilder.getPayloadData().trim(), "<?xml version=\"1.0\" encoding=\"UTF-8\"?><TestMessage xmlns=\"http://citrusframework.org/test\">Hello Citrus</TestMessage>");59        Assert.assertEquals(messageBuilder.getMessageHeaders().size(), 1);60        Assert.assertEquals(messageBuilder.getMessageHeaders().get("operation"), "Test");61        Assert.assertEquals(messageBuilder.getHeaderData().size(), 1);62        Assert.assertEquals(messageBuilder.getHeaderData().get(0).trim(), "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Header xmlns=\"http://citrusframework.org/test\">\n   <operation>hello</operation>\n</Header>");63        Assert.assertEquals(messageBuilder.getMessageInterceptors().size(), 0);64        Assert.assertEquals(action.getEndpoint(), beanDefinitionContext.getBean("myMessageEndpoint", Endpoint.class));65        Assert.assertNull(action.getEndpointUri());66        Assert.assertNull(action.getDataDictionary());67        // 3rd action68        action = getNextTestActionFromTest();69        messageBuilder = (PayloadTemplateMessageBuilder)action.getMessageBuilder();70        71        Assert.assertNotNull(messageBuilder.getPayloadResourcePath());72        Assert.assertEquals(messageBuilder.getPayloadResourcePath(), "classpath:com/consol/citrus/actions/test-request-payload.xml");73        Assert.assertNull(messageBuilder.getPayloadData());74        Assert.assertEquals(messageBuilder.getMessageHeaders().size(), 0);75        Assert.assertEquals(messageBuilder.getMessageInterceptors().size(), 0);76        Assert.assertEquals(action.getEndpoint(), beanDefinitionContext.getBean("myMessageEndpoint", Endpoint.class));77        Assert.assertNull(action.getEndpointUri());78        // 4th action79        action = getNextTestActionFromTest();80        groovyMessageBuilder = (GroovyScriptMessageBuilder)action.getMessageBuilder();81        82        Assert.assertNull(groovyMessageBuilder.getScriptResourcePath());83        Assert.assertNotNull(groovyMessageBuilder.getScriptData());84        Assert.assertEquals(groovyMessageBuilder.getScriptData().trim(), "println '<TestMessage>Hello Citrus</TestMessage>'");85        Assert.assertEquals(groovyMessageBuilder.getMessageHeaders().size(), 2);86        Assert.assertEquals(groovyMessageBuilder.getMessageHeaders().get("header1"), "Test");87        Assert.assertEquals(groovyMessageBuilder.getMessageHeaders().get("header2"), "Test");88        Assert.assertEquals(action.getEndpoint(), beanDefinitionContext.getBean("myMessageEndpoint", Endpoint.class));89        Assert.assertNull(action.getEndpointUri());90        // 5th action91        action = getNextTestActionFromTest();92        groovyMessageBuilder = (GroovyScriptMessageBuilder)action.getMessageBuilder();93        94        Assert.assertNotNull(groovyMessageBuilder.getScriptResourcePath());95        Assert.assertEquals(groovyMessageBuilder.getScriptResourcePath(), "classpath:com/consol/citrus/script/example.groovy");96        Assert.assertNull(groovyMessageBuilder.getScriptData());97        Assert.assertEquals(action.getEndpoint(), beanDefinitionContext.getBean("myMessageEndpoint", Endpoint.class));98        Assert.assertNull(action.getEndpointUri());99        // 6th action100        action = getNextTestActionFromTest();101        Assert.assertEquals(action.getVariableExtractors().size(), 1);102        Assert.assertTrue(action.getVariableExtractors().get(0) instanceof MessageHeaderVariableExtractor);103        MessageHeaderVariableExtractor headerVariableExtractor = (MessageHeaderVariableExtractor)action.getVariableExtractors().get(0);104        105        Assert.assertEquals(headerVariableExtractor.getHeaderMappings().size(), 1);106        Assert.assertEquals(headerVariableExtractor.getHeaderMappings().get("operation"), "operation");107        Assert.assertEquals(action.getEndpoint(), beanDefinitionContext.getBean("myMessageEndpoint", Endpoint.class));108        Assert.assertNull(action.getEndpointUri());109        messageBuilder = (PayloadTemplateMessageBuilder)action.getMessageBuilder();110        Assert.assertNull(messageBuilder.getPayloadResourcePath());111        Assert.assertNotNull(messageBuilder.getPayloadData());112        Assert.assertEquals(messageBuilder.getPayloadData().trim(), "<TestMessage>Hello Citrus</TestMessage>");113        114        Assert.assertEquals(messageBuilder.getMessageInterceptors().size(), 1);115        Assert.assertTrue(messageBuilder.getMessageInterceptors().get(0) instanceof XpathMessageConstructionInterceptor);116        XpathMessageConstructionInterceptor messageConstructionInterceptor = (XpathMessageConstructionInterceptor)messageBuilder.getMessageInterceptors().get(0);117        ...

Source:MessageHeaderVariableExtractor.java

...27 * Variable extractor reading message headers and saves them to new test variables.28 *29 * @author Christoph Deppisch30 */31public class MessageHeaderVariableExtractor implements VariableExtractor {32    /** Map holding header names and target variable names */33    private final Map<String, Object> headerMappings;34    public MessageHeaderVariableExtractor() {35        this(new Builder());36    }37    /**38     * Constructor using fluent builder.39     * @param builder40     */41    private MessageHeaderVariableExtractor(Builder builder) {42        this.headerMappings = builder.expressions;43    }44    /**45     * Reads header information and saves new test variables.46     */47    public void extractVariables(Message message, TestContext context) {48        if (CollectionUtils.isEmpty(headerMappings)) { return; }49        for (Entry<String, Object> entry : headerMappings.entrySet()) {50            String headerElementName = entry.getKey();51            String targetVariableName = Optional.ofNullable(entry.getValue())52                    .map(Object::toString)53                    .orElseThrow(() -> new CitrusRuntimeException(String.format("Variable name must be set for extractor " +54                            "on header '%s'", headerElementName)));55            if (message.getHeader(headerElementName) == null) {56                throw new UnknownElementException("Could not find header element " + headerElementName + " in received header");57            }58            context.setVariable(targetVariableName, message.getHeader(headerElementName).toString());59        }60    }61    /**62     * Fluent builder.63     */64    public static final class Builder implements VariableExtractor.Builder<MessageHeaderVariableExtractor, Builder> {65        private final Map<String, Object> expressions = new LinkedHashMap<>();66        /**67         * Static entry method for builder.68         * @return69         */70        public static Builder fromHeaders() {71            return new Builder();72        }73        /**74         * Evaluate all header name expressions and store values as new variables to the test context.75         * @param expressions76         * @return77         */78        public Builder headers(Map<String, String> expressions) {79            this.expressions.putAll(expressions);80            return this;81        }82        /**83         * Reads header by its name and stores value as new variable to the test context.84         * @param headerName85         * @param variableName86         * @return87         */88        public Builder header(final String headerName, final String variableName) {89            this.expressions.put(headerName, variableName);90            return this;91        }92        @Override93        public Builder expressions(Map<String, Object> expressions) {94            this.expressions.putAll(expressions);95            return this;96        }97        @Override98        public Builder expression(final String headerName, final Object variableName) {99            this.expressions.put(headerName, variableName);100            return this;101        }102        @Override103        public MessageHeaderVariableExtractor build() {104            return new MessageHeaderVariableExtractor(this);105        }106    }107    /**108     * Gets the headerMappings.109     * @return the headerMappings110     */111    public Map<String, Object> getHeaderMappings() {112        return headerMappings;113    }114}...