How to use Groovy to set Status, Content-Length, Content-Type in the HTTP Response for a MockService

Question

I promise I have genuinely tried and failed to find an answer both here and over on StackOverflow. I've seen a number of variants on my question but nothing where the answer is as simple as mockResponse.setHeader(Content-Length, 0)

So I want to set various HTTP Response header fields in the Script of my MockService Response script.

The dialog tells me that I've got a number of variables available to me including log, mockRequest, mockResponse.

I've worked out the simple HelloWorld equivalent

log.info "Hello from my script"

I made a guess that for log that the methods would be info, warn etc.

But how do I use mockResponse to set some HTTP Header's in particular as mentioned in the question Content-Length and Status. I tried to find a reference for the methods but failed.

karelhusa · Accepted Answer

You can set an HTTP header by the code:&nbsp;mockRequest.httpResponse.setHeader('MyHeader', "HiThere;")Similarly you can set the Content-Length:&nbsp;mockRequest.httpResponse.setContentLength(456)&nbsp;BUT:&nbsp;further processing overrides your settings, e.g. the&nbsp;Content-Length with be the actual length of the response content.&nbsp;I assume you need to break standard mock processing and return the response by your own, e.g. as with this code in the OnRequest script:&nbsp;mockRequest.httpResponse.sendError(404)There is a conflict between our code and the standard mock processing (which normally has to do the settings). I am not aware yet, hot to tell SoapUI that it shall not override my values.&nbsp;

karelhusa · Answer

I believe it makes sense to build mocks with non-standard behavior.

Especially in heavily heterogenous environments, where are dozens of backend systems and different implementations of services, Many of my projects include ESB implementation, where we need to be prepared for different kinds of responses from backend services.

Therefore the mocks do scenarios e.g.:

- not well-formed XML

- invalid XML

- unexpected HTTP code

- long response time

- unavailability of the service

- pretending the service does not exist

- missing required HTTP headers

- giving SOAP Faults

The ESB service needs to handle all these responses and provide a response to the consumer which is appropriate and understandable.

This is why I also develop special processing in mocks.

timjohnarm · Answer

Ok so with a lot of help from&nbsp;KarelHusa&nbsp;I now have two solutions to getting&nbsp;a zero length response with a status code of 202 from a MockService/MockResponse for a SOAP operation using a MEP(MessageExchangePattern) of OneWay.&nbsp;Solution#1The simpler of the two involves the following, and came for Karel's last answer about Content-Encoding.&nbsp;On the Request add a Header with Accept-Encoding=identity.&nbsp;If you are using a SoapUI Request to do your initial testing then click on the Headers button/tab at the bottom of the window under the Request text and add a customer header Name=Accept-Encoding Value=identity.&nbsp;Then switch to your MockResponse and&nbsp;in the Navigator view on the left of the screen in the MockResponse Properties tab set Property=Response HTTP-Status Value=202&nbsp;Solution#2This is my final version of the script which I've been building on with Karel's help. It gives a greater level of flexibility especially if you have a difficult application as the final consumer of your MockService.&nbsp;log.info "Response Status=202 Content-Length=0"
// Get a reference to the request headers and log them
def rqHeaders = mockRequest.requestHeaders
for ( rqEntry in rqHeaders ) {
    log.info "Request Header ${rqEntry.key} = ${rqEntry.value}"
}

// Get rid of the Accept-Encoding value as this causes SoapUI to automatically
// add a corresponding Content-Encoding entry to the Response
rqHeaders.remove("Accept-Encoding");

// Get a reference to the response headers
def rsHeaders = mockResponse.responseHeaders
// Add the desired header values to the response
rsHeaders["Content-Length"] = ["0"]
rsHeaders["Content-Type"] = ["text/xml"]
// And log them
for ( rsEntry in rsHeaders ) {    log.info "Response Header ${rsEntry.key} = ${rsEntry.value}"} // And last but not least set the status code to 202 and zero length response
mockResponse.setResponseHttpStatus(202)
mockResponse.setResponseContent("")&nbsp;

karelhusa · Answer

timjohnarm, if you need to make a one-way SOAP mock, I would suggest:take a WSDL with a one-way operation, import it and make a mockthen select the operation and add a responsego to response properties and set the Response HTTP-Status to 202If you prefer to set the response code programatically you can use the API you have already mentioned, e.g. with a DISPATCH script:&nbsp;def resp = mockOperation.getMockResponseByName('MyResponse')
resp.setResponseHttpStatus(202)
return 'MyResponse'&nbsp;Karel&nbsp;

karelhusa · Answer

timjohnarm, the Content-Length header field gives the length of the HTTP body during the transfer. This means that the encoding (compression) matters.&nbsp;For instance if you use gzip for the transfer, the content is compressed during the transfer, however in SoapUI you see an uncompressed text. I assume the Content-Lenght 20 gives the compressed size (a compressed empty string).&nbsp;Karel&nbsp;

nmrao · Answer

Question is confusing by below contradicting statements:
&nbsp;
"the answer is as simple as mockResponse.setHeader(Content-Length, 0)"
&nbsp;
" how do I use mockResponse to set some HTTP Header's in particular as mentioned in the question Content-Length and Status. I tried to find a reference for the methods but failed."
&nbsp;
&nbsp;
&nbsp;

Forum Discussion

How to use Groovy to set Status, Content-Length, Content-Type in the HTTP Response for a MockService

10 Replies

Related Content

How to change Content-Length?

Swagger Compliance Assertion: Invalid content type [image/bmp]

DELETE Method Without Content-Type Header?

Write Error when sending large content length request body from ReadyAPI

Save API Response as Excel for Content-Type: application/ms-excel

Recent Discussions

How to upload a file via SOAP, as an attachment using python zeep

XQuery assertions are broken with SoapUI 5.6.0

Soapui 5.7.1 dependency : thoughtworks:xstream:jar:1.4.20

How to configure Swagger in Paas to use it in Oracle APEX instance.

clone TestSuite fails when there are more project with the same name