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

Copied to Clipboard!

How to use XmlStepDefinition method of com.consol.citrus.cucumber.step.xml.XmlStepDefinition class

Best Citrus code snippet using com.consol.citrus.cucumber.step.xml.XmlStepDefinition.XmlStepDefinition

Source:CitrusBackend.java

...17import com.consol.citrus.Citrus;18import com.consol.citrus.cucumber.CitrusLifecycleHooks;19import com.consol.citrus.cucumber.CitrusReporter;20import com.consol.citrus.cucumber.container.StepTemplate;21import com.consol.citrus.cucumber.step.xml.XmlStepDefinition;22import com.consol.citrus.exceptions.CitrusRuntimeException;23import cucumber.api.Scenario;24import cucumber.api.java.*;25import cucumber.runtime.*;26import cucumber.runtime.io.ResourceLoader;27import cucumber.runtime.io.ResourceLoaderClassFinder;28import cucumber.runtime.java.spring.CitrusSpringObjectFactory;29import cucumber.runtime.snippets.FunctionNameGenerator;30import gherkin.pickles.PickleStep;31import io.cucumber.stepexpression.TypeRegistry;32import org.slf4j.Logger;33import org.slf4j.LoggerFactory;34import org.springframework.context.ApplicationContext;35import org.springframework.context.ConfigurableApplicationContext;36import org.springframework.context.support.ClassPathXmlApplicationContext;37import java.lang.reflect.Method;38import java.util.List;39import java.util.Map;40/**41 * @author Christoph Deppisch42 * @since 2.643 */44public class CitrusBackend implements Backend {45    /** Citrus instance used by all scenarios */46    private static Citrus citrus;47    /** Logger */48    private static Logger log = LoggerFactory.getLogger(CitrusBackend.class);49    /** Basic resource loader */50    private ResourceLoader resourceLoader;51    private TypeRegistry typeRegistry;52    /**53     * Constructor using resource loader.54     * @param resourceLoader55     */56    public CitrusBackend(ResourceLoader resourceLoader, TypeRegistry typeRegistry) {57        this.resourceLoader = resourceLoader;58        this.typeRegistry = typeRegistry;59        Citrus.CitrusInstanceManager.addInstanceProcessor(instance -> instance.beforeSuite(CitrusReporter.SUITE_NAME));60    }61    @Override62    public void loadGlue(Glue glue, List<String> gluePaths) {63        try {64            Citrus.CitrusInstanceManager.addInstanceProcessor(new XmlStepInstanceProcessor(glue, gluePaths, getObjectFactory(), typeRegistry));65        } catch (IllegalAccessException e) {66            throw new CitrusRuntimeException("Failed to add XML step definition", e);67        }68        try {69            if (!gluePaths.contains(CitrusLifecycleHooks.class.getPackage().getName()) && getObjectFactory().addClass(CitrusLifecycleHooks.class)) {70                Method beforeMethod = CitrusLifecycleHooks.class.getMethod("before", Scenario.class);71                Before beforeAnnotation = beforeMethod.getAnnotation(Before.class);72                glue.addBeforeHook(new JavaHookDefinition(beforeMethod, beforeAnnotation.value(), beforeAnnotation.order(), beforeAnnotation.timeout(), getObjectFactory()));73                Method afterMethod = CitrusLifecycleHooks.class.getMethod("after", Scenario.class);74                After afterAnnotation = afterMethod.getAnnotation(After.class);75                glue.addAfterHook(new JavaHookDefinition(afterMethod, afterAnnotation.value(), afterAnnotation.order(), afterAnnotation.timeout(), getObjectFactory()));76            }77        } catch (NoSuchMethodException | IllegalAccessException e) {78            throw new CucumberException("Unable to add Citrus lifecylce hooks");79        }80    }81    @Override82    public void buildWorld() {83    }84    @Override85    public void disposeWorld() {86    }87    @Override88    public String getSnippet(PickleStep step, String keyword, FunctionNameGenerator functionNameGenerator) {89        return "";90    }91    /**92     * Gets the object factory instance that is configured in environment.93     * @return94     */95    private ObjectFactory getObjectFactory() throws IllegalAccessException {96        if (Env.INSTANCE.get(ObjectFactory.class.getName()).equals(CitrusObjectFactory.class.getName())) {97            return CitrusObjectFactory.instance();98        } else if (Env.INSTANCE.get(ObjectFactory.class.getName()).equals(CitrusSpringObjectFactory.class.getName())) {99            return CitrusSpringObjectFactory.instance();100        }101        return ObjectFactoryLoader.loadObjectFactory(new ResourceLoaderClassFinder(resourceLoader, Thread.currentThread().getContextClassLoader()),102                Env.INSTANCE.get(ObjectFactory.class.getName()));103    }104    /**105     * Provide access to the Citrus instance.106     * @return107     */108    public static Citrus getCitrus() {109        if (citrus == null) {110            citrus = Citrus.newInstance();111        }112        return citrus;113    }114    /**115     * Initializes Citrus instance with given application context.116     * @param applicationContext117     * @return118     */119    public static void initializeCitrus(ApplicationContext applicationContext) {120        if (citrus != null) {121            if (!citrus.getApplicationContext().equals(applicationContext)) {122                log.warn("Citrus instance has already been initialized - creating new instance and shutting down current instance");123                if (citrus.getApplicationContext() instanceof ConfigurableApplicationContext) {124                    ((ConfigurableApplicationContext) citrus.getApplicationContext()).stop();125                }126            } else {127                return;128            }129        }130        citrus = Citrus.newInstance(applicationContext);131    }132    /**133     * Reset Citrus instance. Use this method with special care. Usually Citrus instance should only be instantiated134     * once throughout the whole test suite run.135     */136    public static void resetCitrus() {137        citrus = null;138    }139    /**140     * Initialization hook performs before suite actions and XML step initialization. Called as soon as citrus instance is requested141     * from outside for the first time. Performs only once.142     */143    private static class XmlStepInstanceProcessor implements Citrus.InstanceProcessor {144        private final Glue glue;145        private final List<String> gluePaths;146        private final ObjectFactory objectFactory;147        private TypeRegistry typeRegistry;148        XmlStepInstanceProcessor(Glue glue, List<String> gluePaths, ObjectFactory objectFactory, TypeRegistry typeRegistry) {149            this.glue = glue;150            this.gluePaths = gluePaths;151            this.objectFactory = objectFactory;152            this.typeRegistry = typeRegistry;153        }154        @Override155        public void process(Citrus instance) {156            for (String gluePath : gluePaths) {157                String xmlStepConfigLocation = "classpath*:" + gluePath.replaceAll("\\.", "/").replaceAll("^classpath:", "") + "/**/*Steps.xml";158                log.info(String.format("Loading XML step definitions %s", xmlStepConfigLocation));159                ApplicationContext ctx = new ClassPathXmlApplicationContext(new String[]{ xmlStepConfigLocation }, true, instance.getApplicationContext());160                Map<String, StepTemplate> xmlSteps = ctx.getBeansOfType(StepTemplate.class);161                for (StepTemplate stepTemplate : xmlSteps.values()) {162                    if (log.isDebugEnabled()) {163                        log.debug(String.format("Found XML step definition: %s %s", stepTemplate.getName(), stepTemplate.getPattern().pattern()));164                    }165                    glue.addStepDefinition(new XmlStepDefinition(stepTemplate, objectFactory, typeRegistry));166                }167            }168        }169    }170}...

Source:CitrusSpringBackend.java

...7import com.consol.citrus.CitrusInstanceProcessor;8import com.consol.citrus.CitrusSpringContext;9import com.consol.citrus.cucumber.backend.CitrusBackend;10import com.consol.citrus.cucumber.container.StepTemplate;11import com.consol.citrus.cucumber.step.xml.XmlStepDefinition;12import io.cucumber.core.backend.Container;13import io.cucumber.core.backend.Glue;14import io.cucumber.core.backend.Lookup;15import io.cucumber.core.resource.ClasspathSupport;16import org.slf4j.Logger;17import org.slf4j.LoggerFactory;18import org.springframework.context.ApplicationContext;19import org.springframework.context.support.ClassPathXmlApplicationContext;20/**21 * @author Christoph Deppisch22 */23public class CitrusSpringBackend extends CitrusBackend {24    /** Logger */25    private static Logger log = LoggerFactory.getLogger(CitrusSpringBackend.class);26    /**27     * Constructor using resource loader.28     *29     * @param lookup30     * @param container31     */32    public CitrusSpringBackend(Lookup lookup, Container container) {33        super(lookup, container);34    }35    @Override36    public void loadGlue(Glue glue, List<URI> gluePaths) {37        if (CitrusInstanceManager.hasInstance()) {38            new XmlStepInstanceProcessor(glue, gluePaths, lookup).process(CitrusInstanceManager.getOrDefault());39        } else {40            CitrusInstanceManager.addInstanceProcessor(new XmlStepInstanceProcessor(glue, gluePaths, lookup));41        }42        super.loadGlue(glue, gluePaths);43    }44    /**45     * Initialization hook performs before suite actions and XML step initialization. Called as soon as citrus instance is requested46     * from outside for the first time. Performs only once.47     */48    private static class XmlStepInstanceProcessor implements CitrusInstanceProcessor {49        private final Glue glue;50        private final List<URI> gluePaths;51        private final Lookup lookup;52        XmlStepInstanceProcessor(Glue glue, List<URI> gluePaths, Lookup lookup) {53            this.glue = glue;54            this.gluePaths = gluePaths;55            this.lookup = lookup;56        }57        @Override58        public void process(Citrus instance) {59            for (URI gluePath : gluePaths) {60                String xmlStepConfigLocation = "classpath*:" + ClasspathSupport.resourceNameOfPackageName(ClasspathSupport.packageName(gluePath)) + "/**/*Steps.xml";61                log.info(String.format("Loading XML step definitions %s", xmlStepConfigLocation));62                ApplicationContext ctx;63                if (instance.getCitrusContext() instanceof CitrusSpringContext) {64                    ctx = new ClassPathXmlApplicationContext(new String[]{ xmlStepConfigLocation }, true, ((CitrusSpringContext) instance.getCitrusContext()).getApplicationContext());65                } else {66                    ctx = new ClassPathXmlApplicationContext(new String[]{ xmlStepConfigLocation }, true);67                }68                Map<String, StepTemplate> xmlSteps = ctx.getBeansOfType(StepTemplate.class);69                for (StepTemplate stepTemplate : xmlSteps.values()) {70                    if (log.isDebugEnabled()) {71                        log.debug(String.format("Found XML step definition: %s %s", stepTemplate.getName(), stepTemplate.getPattern().pattern()));72                    }73                    glue.addStepDefinition(new XmlStepDefinition(stepTemplate, lookup));74                }75            }76        }77    }78}...

Source:XmlStepDefinition.java

...24 * Special step definition that runs a XML step definition template on execution.25 * @author Christoph Deppisch26 * @since 2.627 */28public class XmlStepDefinition implements StepDefinition {29    private final ExpressionArgumentMatcher argumentMatcher;30    private final ObjectFactory objectFactory;31    private final StepTemplate stepTemplate;32    public XmlStepDefinition(StepTemplate stepTemplate, ObjectFactory objectFactory, TypeRegistry typeRegistry) {33        this.objectFactory = objectFactory;34        this.stepTemplate = stepTemplate;35        this.argumentMatcher = new ExpressionArgumentMatcher(new StepExpressionFactory(typeRegistry).createExpression(stepTemplate.getPattern().pattern()));36    }37    @Override38    public List<Argument> matchedArguments(PickleStep step) {39        return argumentMatcher.argumentsFrom(step);40    }41    @Override42    public String getLocation(boolean detail) {43        return stepTemplate.getName();44    }45    @Override46    public Integer getParameterCount() {...

XmlStepDefinition

Using AI Code Generation

1package com.consol.citrus.cucumber.step.xml;2import com.consol.citrus.context.TestContext;3import com.consol.citrus.exceptions.CitrusRuntimeException;4import com.consol.citrus.xml.namespace.NamespaceContextBuilder;5import com.consol.citrus.xml.xpath.XPathUtils;6import cucumber.api.java.en.Then;7import cucumber.api.java.en.When;8import org.springframework.beans.factory.annotation.Autowired;9import org.springframework.util.StringUtils;10import org.w3c.dom.Document;11import org.w3c.dom.Node;12import org.w3c.dom.NodeList;13import org.xml.sax.InputSource;14import javax.xml.parsers.DocumentBuilder;15import javax.xml.parsers.DocumentBuilderFactory;16import javax.xml.xpath.XPathExpression;17import javax.xml.xpath.XPathExpressionException;18import javax.xml.xpath.XPathFactory;19import java.io.StringReader;20import java.util.HashMap;21import java.util.Map;22import java.util.regex.Matcher;23import java.util.regex.Pattern;24public class XmlStepDefinition {25    private TestContext context;26    private NamespaceContextBuilder namespaceContextBuilder;27    @Then("^XML is valid$")28    public void xmlIsValid(String xml) {29        try {30            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();31            factory.setNamespaceAware(true);32            DocumentBuilder builder = factory.newDocumentBuilder();33            builder.parse(new InputSource(new StringReader(xml)));34        } catch (Exception e) {35            throw new CitrusRuntimeException("Failed to parse XML", e);36        }37    }38    @Then("^XML is not valid$")39    public void xmlIsNotValid(String xml) {40        try {41            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();42            factory.setNamespaceAware(true);43            DocumentBuilder builder = factory.newDocumentBuilder();44            builder.parse(new InputSource(new StringReader(xml)));45        } catch (Exception e) {46            return;47        }48        throw new CitrusRuntimeException("XML is valid");49    }50    @Then("^XML contains XPath \"([^\"]*)\"$")51    public void xmlContainsXPath(String xml, String path) {

XmlStepDefinition

Using AI Code Generation

1import com.consol.citrus.cucumber.step.xml.XmlStepDefinition;2import com.consol.citrus.xml.namespace.NamespaceContextBuilder;3import com.consol.citrus.xml.namespace.SimpleNamespaceContextBuilder;4import cucumber.api.java.en.Given;5import cucumber.api.java.en.Then;6import cucumber.api.java.en.When;7import org.springframework.beans.factory.annotation.Autowired;8import org.springframework.core.io.ClassPathResource;9import org.springframework.util.StringUtils;10import org.w3c.dom.Document;11import org.w3c.dom.Node;12import org.xml.sax.SAXException;13import javax.xml.parsers.DocumentBuilder;14import javax.xml.parsers.DocumentBuilderFactory;15import javax.xml.parsers.ParserConfigurationException;16import java.io.IOException;17public class MySteps {18    private XmlStepDefinition xmlStepDefinition;19    @Given("^I have a foo$")20    public void iHaveAFoo() throws IOException, SAXException, ParserConfigurationException {21        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();22        dbf.setNamespaceAware(true);23        DocumentBuilder db = dbf.newDocumentBuilder();24        Document doc = db.parse(new ClassPathResource("foo.xml").getInputStream());25        xmlStepDefinition.xml().setPayload(doc);26    }27    @When("^I add a bar$")28    public void iAddABar() throws IOException, SAXException, ParserConfigurationException {29        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();30        dbf.setNamespaceAware(true);31        DocumentBuilder db = dbf.newDocumentBuilder();32        Document doc = db.parse(new ClassPathResource("bar.xml").getInputStream());33        xmlStepDefinition.xml().setPayload(doc);34    }35    @Then("^I should have a foobar$")36    public void iShouldHaveAFoobar() throws IOException, SAXException, ParserConfigurationException {37        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();38        dbf.setNamespaceAware(true);39        DocumentBuilder db = dbf.newDocumentBuilder();40        Document doc = db.parse(new ClassPathResource("foobar.xml").getInputStream());41        xmlStepDefinition.xml().validatePayload(doc);42    }43    @Then("^I should have a foobar with namespaces$")44    public void iShouldHaveAFoobarWithNamespaces() throws IOException, SAXException, ParserConfigurationException {45        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();46        dbf.setNamespaceAware(true);47        DocumentBuilder db = dbf.newDocumentBuilder();48        Document doc = db.parse(new ClassPathResource("foobar.xml").getInputStream());

XmlStepDefinition

Using AI Code Generation

1package com.consol.citrus.cucumber.step.xml;2import java.io.IOException;3import org.junit.Assert;4import org.springframework.beans.factory.annotation.Autowired;5import org.springframework.beans.factory.annotation.Qualifier;6import org.springframework.core.io.Resource;7import org.springframework.util.StringUtils;8import com.consol.citrus.context.TestContext;9import com.consol.citrus.exceptions.CitrusRuntimeException;10import com.consol.citrus.message.Message;11import com.consol.citrus.message.MessageType;12import com.consol.citrus.message.MessageTypeResolver;13import com.consol.citrus.validation.xml.XmlMessageValidationContext;14import com.consol.citrus.validation.xml.XmlMessageValidationContextBuilder;15import com.consol.citrus.validation.xml.XmlMessageValidator;16import com.consol.citrus.xml.XsdSchemaRepository;17import cucumber.api.java.en.Then;18import cucumber.api.java.en.When;19public class XmlStepDefinition {20    private TestContext context;21    @Qualifier("xmlMessageValidator")22    private XmlMessageValidator xmlMessageValidator;23    private XsdSchemaRepository xsdSchemaRepository;24    private MessageTypeResolver messageTypeResolver;25    @When("^receive XML message$")26    public void receiveXmlMessage(String xmlData) {27        Message message = new Message(xmlData);28        message.setType(MessageType.XML.name());29        XmlMessageValidationContext validationContext = new XmlMessageValidationContextBuilder()30                .schemaRepository(xsdSchemaRepository)31                .build();32        xmlMessageValidator.validateMessage(message, context, validationContext);33    }34    @When("^receive XML message from resource$")35    public void receiveXmlMessageFromResource(String resourceName) {36        Resource resource = context.getReferenceResolver().resolve(resourceName, Resource.class);37        if (!resource.exists()) {38            throw new CitrusRuntimeException("Failed to find resource for name: " + resourceName);39        }40        Message message = new Message();41        try {42            message.setPayload(resource.getInputStream());43        } catch (IOException e) {44            throw new CitrusRuntimeException("Failed to read XML message resource", e);45        }46        message.setType(MessageType.XML.name());47        XmlMessageValidationContext validationContext = new XmlMessageValidationContextBuilder()48                .schemaRepository(xsdSchemaRepository)49                .build();50        xmlMessageValidator.validateMessage(message, context, validationContext);51    }52    @When("^receive XML message from file$")53    public void receiveXmlMessageFromFile(String filePath)

XmlStepDefinition

Using AI Code Generation

1public class 3 extends XmlStepDefinition {2    public 3() {3        super(new XmlStepDefinition());4    }5}6public class 4 extends XmlStepDefinition {7    public 4() {8        super(new XmlStepDefinition());9    }10}11public class 5 extends XmlStepDefinition {12    public 5() {13        super(new XmlStepDefinition());14    }15}16public class 6 extends XmlStepDefinition {17    public 6() {18        super(new XmlStepDefinition());19    }20}21public class 7 extends XmlStepDefinition {22    public 7() {23        super(new XmlStepDefinition());24    }25}26public class 8 extends XmlStepDefinition {27    public 8() {28        super(new XmlStepDefinition());29    }30}31public class 9 extends XmlStepDefinition {32    public 9() {33        super(new XmlStepDefinition());34    }35}36public class 10 extends XmlStepDefinition {37    public 10() {38        super(new XmlStepDefinition());39    }40}41public class 11 extends XmlStepDefinition {42    public 11() {43        super(new XmlStepDefinition());44    }45}

XmlStepDefinition

Using AI Code Generation

1public class XmlStepDefinition extends StepDefinition {2    public void setXmlPath(String path) {3        this.xmlPath = path;4    }5}6public class XmlStepDefinition extends StepDefinition {7    public void setXmlPath(String path) {8        this.xmlPath = path;9    }10}11public class XmlStepDefinition extends StepDefinition {12    public void setXmlPath(String path) {13        this.xmlPath = path;14    }15}16public class XmlStepDefinition extends StepDefinition {17    public void setXmlPath(String path) {18        this.xmlPath = path;19    }20}21public class XmlStepDefinition extends StepDefinition {22    public void setXmlPath(String path) {23        this.xmlPath = path;24    }25}26public class XmlStepDefinition extends StepDefinition {27    public void setXmlPath(String path) {28        this.xmlPath = path;29    }30}31public class XmlStepDefinition extends StepDefinition {32    public void setXmlPath(String path) {33        this.xmlPath = path;34    }35}36public class XmlStepDefinition extends StepDefinition {37    public void setXmlPath(String path) {38        this.xmlPath = path;39    }40}41public class XmlStepDefinition extends StepDefinition {42    public void setXmlPath(String path)

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.