\n
protected SOAPResponse mockResponse(String resp) {\r\n def envelope = new XmlSlurper().parseText(resp)\r\n new SOAPResponse(envelope: envelope)\r\n}\r\n<\/pre>\n<\/div>\nRequest and response logging<\/h2>\n
The WsLite itself doesn\u2019t use any logging framework. We usually handle it by adding own sendWithLogging<\/code> method:<\/p>\n\n
private SOAPResponse sendWithLogging(String action, Closure cl) {\r\n SOAPResponse response = client.send(SOAPAction: action, cl)\r\n log(response?.httpRequest, response?.httpResponse)\r\n return response\r\n}\r\n\r\nprivate void log(HTTPRequest request, HTTPResponse response) {\r\n log.debug(\"HTTPRequest $request with content:\\n${request?.contentAsString}\")\r\n log.debug(\"HTTPResponse $response with content:\\n${response?.contentAsString}\")\r\n}\r\n<\/pre>\n<\/div>\nThis logs the actual request and response send through SOAPClient<\/code>.
\nBut it logs only when invocation is successful and errors are much more interesting\u2026 So here goes withExceptionHandler<\/code> method:<\/p>\n\n
private SOAPResponse withExceptionHandler(Closure cl) {\r\n try {\r\n cl.call()\r\n } catch (SOAPFaultException soapEx) {\r\n log(soapEx.httpRequest, soapEx.httpResponse)\r\n def message = soapEx.hasFault() ? soapEx.fault.text() : soapEx.message\r\n throw new InfrastructureException(message)\r\n } catch (HTTPClientException httpEx) {\r\n log(httpEx.request, httpEx.response)\r\n throw new InfrastructureException(httpEx.message)\r\n }\r\n}\r\ndef send(String action, Closure cl) {\r\n withExceptionHandler {\r\n sendWithLogging(action, cl)\r\n }\r\n}\r\n<\/pre>\n<\/div>\nenvelope<\/p>\n
XmlSlurper gotchas<\/h2>\n
Working with XML document with XmlSlurper<\/code> is generally great fun, but is some cases could introduce some problems.
\nA trivial example is parsing an id with a number to Long<\/code> value:<\/p>\ndef id = Long.valueOf(edit.'@id' as String)<\/pre>\nThe Attribute<\/code> class (which edit.'@id'<\/code> evaluates to) can be converted to String using as<\/code> operator, but converting to Long<\/code> requires using valueOf<\/code>.<\/p>\nThe second example is a bit more complicated. Consider following XML fragment:<\/p>\n
\n
\r\n \r\n \r\n \r\n <\/params>\r\n 123<\/value>\r\n<\/edit>\r\n\r\n \r\n \r\n \r\n <\/params>\r\n 456<\/value>\r\n<\/edit>\r\n<\/pre>\n<\/div>\nWe want to find id of edit<\/code> whose label<\/code> is label1<\/strong>. The simplest solution seems to be:<\/p>\n\n
def param = doc.edit.params.param.find { it['@value'] == 'label1' }\r\ndef edit = params.parent().parent()<\/pre>\n<\/div>\nBut it doesn\u2019t work! The parent<\/code> method returns multiple edits<\/code>, not only the one that is parent of given param<\/code>\u2026<\/p>\nHere\u2019s the correct solution:<\/p>\n
\n
doc.edit.find { edit ->\r\n edit.params.param.find { it['@value'] == 'label1' }\r\n}\r\n<\/pre>\n<\/div>\nExample<\/h2>\n
The example working project covering those hints could be found on GitHub<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"TL;DR\nThere is a example working GitHub project which covers unit testing and request\/response logging when using WsLite.\nWhy Groovy WsLite ?\nI’m a huge fan of Groovy WsLite project for calling SOAP web services. Yes, in a real world you have to deal with those – big companies have huge amount of “legacy” code and are crazy about homogeneous architecture – only SOAP, Java, Oracle, AIX… \nBut I also never been comfortable with XFire\/CXF approach of web service client code generation. I wrote a bit about other posibilites in this post. With JAXB you can also experience some freaky classloading errors – as Tomek described on his blog. In a large commercial project the “the less code the better” principle is significant. And the code generated from XSD could look kinda ugly – especially more complicated structures like sequences, choices, anys etc.\nUsing WsLite with native Groovy concepts like XmlSlurper could be a great choice. But since it’s a dynamic approach you have to be really careful – write good unit tests and log requests. Below are my few hints for using WsLite in practice.\nUnit testing\nSuppose you have some invocation of WsLite SOAPClient (original WsLite example):\n\ndef getMothersDay(long _year) {\r\n def response = client.send(SOAPAction: action) {\r\n body {\r\n GetMothersDay('xmlns':'http:\/\/www.27seconds.com\/Holidays\/US\/Dates\/') {\r\n year(_year)\r\n }\r\n }\r\n }\r\n response.GetMothersDayResponse.GetMothersDayResult.text()\r\n}\r\n\n\nHow can the unit test like? My suggestion is to mock SOAPClient and write a simple helper to test that builded XML is correct. Example using great SpockFramework: \n\nvoid setup() {\r\n client = Mock(SOAPClient)\r\n service.client = client\r\n}\r\n\r\ndef \"should pass year to GetMothersDay and return date\"() {\r\n given:\r\n def year = 2013\r\n when:\r\n def date = service.getMothersDay(year)\r\n then:\r\n 1 * client.send(_, _) >> { Map params, Closure requestBuilder ->\r\n Document doc = buildAndParseXml(requestBuilder)\r\n assertXpathEvaluatesTo(\"$year\", '\/\/ns:GetMothersDay\/ns:year', doc)\r\n return mockResponse(Responses.mothersDay)\r\n }\r\n date == \"2013-05-12T00:00:00\"\r\n}\r\n\n\nThis uses a real cool feature of Spock – even when you mock the invocation with “any mark” (_), you are able to get actual arguments. So we can build XML that would be passed to SOAPClient's send method and check that specific XPaths are correct:\n\nvoid setup() {\r\n engine = XMLUnit.newXpathEngine()\r\n engine.setNamespaceContext(new SimpleNamespaceContext(namespaces()))\r\n}\r\n\r\nprotected Document buildAndParseXml(Closure xmlBuilder) {\r\n def writer = new StringWriter()\r\n def builder = new MarkupBuilder(writer)\r\n builder.xml(xmlBuilder)\r\n return XMLUnit.buildControlDocument(writer.toString())\r\n}\r\n\r\nprotected void assertXpathEvaluatesTo(String expectedValue,\r\n String xpathExpression, Document doc) throws XpathException {\r\n Assert.assertEquals(expectedValue,\r\n engine.evaluate(xpathExpression, doc))\r\n}\r\n\r\nprotected Map namespaces() {\r\n return [ns: 'http:\/\/www.27seconds.com\/Holidays\/US\/Dates\/']\r\n}\r\n\n\nThe XMLUnit library is used just for XpathEngine, but it is much more powerful for comparing XML documents. The NamespaceContext is needed to use correct prefixes (e.g. ns:GetMothersDay) in your Xpath expressions.\nFinally – the mock returns SOAPResponse instance filled with envelope parsed from some constant XML:\n\nprotected SOAPResponse mockResponse(String resp) {\r\n def envelope = new XmlSlurper().parseText(resp)\r\n new SOAPResponse(envelope: envelope)\r\n}\r\n\n\nRequest and response logging\nThe WsLite itself doesn’t use any logging framework. We usually handle it by adding own sendWithLogging method:\n\nprivate SOAPResponse sendWithLogging(String action, Closure cl) {\r\n SOAPResponse response = client.send(SOAPAction: action, cl)\r\n log(response?.httpRequest, response?.httpResponse)\r\n return response\r\n}\r\n\r\nprivate void log(HTTPRequest request, HTTPResponse response) {\r\n log.debug(\"HTTPRequest $request with content:\\n${request?.contentAsString}\")\r\n log.debug(\"HTTPResponse $response with content:\\n${response?.contentAsString}\")\r\n}\r\n\n\nThis logs the actual request and response send through SOAPClient.\nBut it logs only when invocation is successful and errors are much more interesting… So here goes withExceptionHandler method:\n\nprivate SOAPResponse withExceptionHandler(Closure cl) {\r\n try {\r\n cl.call()\r\n } catch (SOAPFaultException soapEx) {\r\n log(soapEx.httpRequest, soapEx.httpResponse)\r\n def message = soapEx.hasFault() ? soapEx.fault.text() : soapEx.message\r\n throw new InfrastructureException(message)\r\n } catch (HTTPClientException httpEx) {\r\n log(httpEx.request, httpEx.response)\r\n throw new InfrastructureException(httpEx.message)\r\n }\r\n}\r\ndef send(String action, Closure cl) {\r\n withExceptionHandler {\r\n sendWithLogging(action, cl)\r\n }\r\n}\r\n\n\nXmlSlurper gotchas\nWorking with XML document with XmlSlurper is generally great fun, but is some cases could introduce some problems.\nA trivial example is parsing an id with a number to Long value:\n\ndef id = Long.valueOf(edit.'@id' as String)\r\n\n\nThe Attribute class (which edit.'@id' evaluates to) can be converted to String using as operator, but converting to Long requires using valueOf.\nThe second example is a bit more complicated. Consider following XML fragment:\n\n<edit id=\"3\">\r\n <params>\r\n <param value=\"label1\" name=\"label\"\/>\r\n <param value=\"2\" name=\"param2\"\/>\r\n <\/params>\r\n <value>123<\/value>\r\n<\/edit>\r\n<edit id=\"6\">\r\n <params>\r\n <param value=\"label2\" name=\"label\"\/>\r\n <param value=\"2\" name=\"param2\"\/>\r\n <\/params>\r\n <value>456<\/value>\r\n<\/edit>\r\n\n\nWe want to find id of edit whose label is label1. The simplest solution seems to be:\n\ndef param = doc.edit.params.param.find { it['@value'] == 'label1' }\r\ndef edit = params.parent().parent()\r\n\n\nBut it doesn’t work! The parent method returns multiple edits, not only the one that is parent of given param… \nHere’s the correct solution:\n\ndoc.edit.find { edit ->\r\n edit.params.param.find { it['@value'] == 'label1' }\r\n}\r\n\n\nExample\nThe example working project covering those hints could be found on GitHub.\n","protected":false},"author":5,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[11],"tags":[50,107],"class_list":["post-10954","post","type-post","status-publish","format-standard","category-development-design","tag-groovy","tag-xml"],"_links":{"self":[{"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/posts\/10954","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/comments?post=10954"}],"version-history":[{"count":12,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/posts\/10954\/revisions"}],"predecessor-version":[{"id":14759,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/posts\/10954\/revisions\/14759"}],"wp:attachment":[{"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/media?parent=10954"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/categories?post=10954"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/tags?post=10954"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}