Creating API-Helpers Using the Citrus Integration Framework

In this article, I want to show you how you can create and configure API helpers using Java and the Citrus Integration Framework. Further helpers can already be used in a test project to send a request to the desired interface and, accordingly, receive a response with further validation of the obtained data. We will look at helpers for such system interfaces as: REST, SOAP and WebSocket services. I think they are the most popular and we encounter them more often than others in testing. Below is a call to the REST service: http(httpActionBuilder -> httpActionBuilder .send() http(httpActionBuilder -> httpActionBuilder .receive() .response(HttpStatus.OK) .messageType(MessageType.JSON) } @Test() @CitrusTest public void getTestActions () { this .context = citrus.createTestContext(); .client( "httpHelperClient" ) .get( "users" )); .client( "httpHelperClient" ) .payload(getJsonData(), "objectMapper" )); I also show you how to configure the client "bean" and "objectMapper" in the citrus-context.xml file. This client can then be used in the helper to send the request, and the "objectMapper" can be used for serialization and deserialization. id= "httpHelperClient" request-url= "${url}" content-type= "application/json" timeout= "30000" /> Below is a call to the SOAP service: soap(soapActionBuilder -> soapActionBuilder .send() );

soap(soapActionBuilder -> soapActionBuilder .receive() ); } @Test() @CitrusTest public void getTestActions () { this .context = citrus.createTestContext(); PojoToXML > convRequest = new PojoToXML<>(); PojoToXML > convResponse = new PojoToXML<>(); .client( "soapHelperClient" ) .payload(convRequest.convert(NumberToDollars.class, getNumberToDollarsRequest(), "http://www.dataaccess.com/webservicesserver/" , "NumberToDollars" )) .client( "soapHelperClient" ) .xsdSchemaRepository( "schemaRepositoryService" ) .payload(convResponse.convert(NumberToDollarsResponse.class, getNumberToDollarsResponse(), "http://www.dataaccess.com/webservicesserver/" , "NumberToDollarsResponse" )) In this code i use my custom Marshaler named PojoToXML. Code below: generic = requestClass; JAXBContext jaxbContext = JAXBContext.newInstance((Class) requestClass); Marshaller jaxbMarshaller = jaxbContext.createMarshaller(); jaxbMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); JAXBElement jaxbElement = (Class) requestClass, (T) requestData); } } }; jaxbMarshaller.marshal(jaxbElement, output); s = String.valueOf(output); e.printStackTrace(); } } } import javax.xml.bind.JAXBContext; import javax.xml.bind.JAXBElement; import javax.xml.bind.JAXBException; import javax.xml.bind.Marshaller; import javax.xml.namespace.QName; import java.io.IOException; import java.io.OutputStream; public class PojoToXML { public T generic; public String convert (T requestClass, Object requestData, String namespaseURI, String localPart) { //namespaseURI=http://oms.rt.ru/ , localPart=submitOrderRequest String s = null ; try { // To format XML new JAXBElement ( new QName(namespaseURI, localPart), OutputStream output = new OutputStream() { private StringBuilder string = new StringBuilder(); @Override public void write ( int b) throws IOException { this .string.append(( char ) b ); public String toString () { return this .string.toString(); } catch (JAXBException e) { return s; I also show how to configure the client "bean" and additional settings for working with xml in the citrus-context.xml file. id= "soapHelperClient" request-url= "${urlSOAP}" timeout= "30000" /> Below is a call to the WebSocket service: send(action -> action );

receive(action -> action .messageType(MessageType.JSON) ); } @Test() @CitrusTest public void getTestActionsWSS () { this .context = citrus.createTestContext(); .endpoint( "wssHelperClient" ) .fork( true ) .endpoint( "wssHelperClient" ) .payload(getJsonDataResponseWSS(), "objectMapper" ) I also show you how to configure the client "bean" in the citrus-context.xml file and you should add an "objectMapper" in case of interaction by JSON messages. id= "wssHelperClient" url= "${urlWSS}" timeout= "30000" /> To summarize, in each case we create two "actions", one action to send a request and the second to receive a response and then validate the data. In general, this is all for helpers now. I hope my examples help you.