Forum Discussion

Apoorva6's avatar
Apoorva6
Frequent Contributor
10 years ago

How to get soap mock response from external file!

I have soap request with ordernumber tag. I will be saving mock response with file name same as ordernumber value in request. How to get mock response of specific ordernumber request? There will be mu...
  • nmrao's avatar
    nmrao
    10 years ago

    Sorry to interrupt Rup.

    The details helped Apoorva.

     

    And this is my first try on mocking, followed the video from the same link that I provided earlier.

     

    Here are the steps:

     

    1. Generate a SOAP Mock Service by right click on to the service that you intended ( I believe, you know it already, added this for those who not aware, and this is first time for me too)

     

    2. Selete the intended mock operation.

    • Choose SCRIPT for Dispatch, Response 1 for Default Response
    • Open Response 1 and remove the existing reponse and just have ${content} as value for response
    • In the script editor have the following script:

     

    /*This script reads the salesOrderNumber from request using xpath
    * and checks corresponding response xml file from
    * mockResponses directory of your soapui project location.
    * Also expects a soapFault.xml file in the same location 
    * in order to send soap fault if no sales order number maches the 
    * existing files.
    * For example, soapui project located under C:\soapuiProjects
    * create a subdirectory called mockResponses under above directory
    * Make sure all your mock response files for sales orders under
    * C:\soapuiProjects\mockResponses directory including soapFault.xml
    * Assuming that  the soap response file extension is xml, not txt
    */
    def groovyUtils = new com.eviware.soapui.support.GroovyUtils(context)
def holder = groovyUtils.getXmlHolder(mockRequest.requestContent)
def soNumber = holder.getNodeValue("//*:BillingOrderLoadRequest/*:salesOrderNumber")
def file = new File (groovyUtils.projectPath+"/mockResponses/${soNumber}.xml")
def fileToLoad = 'soapFault'
if (file.exists()) {
	fileToLoad = soNumber	
} 
context.content = groovy.xml.XmlUtil.serialize(new XmlParser().parse(groovyUtils.projectPath+"/mockResponses/${fileToLoad}.xml"))

     

    Sample soapFault.xml

     

    <Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance" xmlns:xsd="http://www.w3.org/1999/XMLSchema">   
   <Body>   
      <Fault>
         <faultcode xsi:type="xsd:string">Client</faultcode>		 
         <faultstring xsi:type="xsd:string">Could not find the mock response file for the given sales order number</faultstring>		 
      </Fault>
   </Body>   
</Envelope>

     

     

     

nmrao's avatar
nmrao
Champion Level 3
10 years ago

Sorry to interrupt Rup.

The details helped Apoorva.

 

And this is my first try on mocking, followed the video from the same link that I provided earlier.

 

Here are the steps:

 

1. Generate a SOAP Mock Service by right click on to the service that you intended ( I believe, you know it already, added this for those who not aware, and this is first time for me too)

 

2. Selete the intended mock operation.

  • Choose SCRIPT for Dispatch, Response 1 for Default Response
  • Open Response 1 and remove the existing reponse and just have ${content} as value for response
  • In the script editor have the following script:

 

/*This script reads the salesOrderNumber from request using xpath
* and checks corresponding response xml file from
* mockResponses directory of your soapui project location.
* Also expects a soapFault.xml file in the same location 
* in order to send soap fault if no sales order number maches the 
* existing files.
* For example, soapui project located under C:\soapuiProjects
* create a subdirectory called mockResponses under above directory
* Make sure all your mock response files for sales orders under
* C:\soapuiProjects\mockResponses directory including soapFault.xml
* Assuming that  the soap response file extension is xml, not txt
*/
def groovyUtils = new com.eviware.soapui.support.GroovyUtils(context)
def holder = groovyUtils.getXmlHolder(mockRequest.requestContent)
def soNumber = holder.getNodeValue("//*:BillingOrderLoadRequest/*:salesOrderNumber")
def file = new File (groovyUtils.projectPath+"/mockResponses/${soNumber}.xml")
def fileToLoad = 'soapFault'
if (file.exists()) {
	fileToLoad = soNumber	
} 
context.content = groovy.xml.XmlUtil.serialize(new XmlParser().parse(groovyUtils.projectPath+"/mockResponses/${fileToLoad}.xml"))

 

Sample soapFault.xml

 

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance" xmlns:xsd="http://www.w3.org/1999/XMLSchema">   
   <Body>   
      <Fault>
         <faultcode xsi:type="xsd:string">Client</faultcode>		 
         <faultstring xsi:type="xsd:string">Could not find the mock response file for the given sales order number</faultstring>		 
      </Fault>
   </Body>   
</Envelope>

 

 

 

  • Apoorva6's avatar
    Apoorva6
    Frequent Contributor
    10 years ago
    I have soap request with ordernumber tag. I will be saving mock response with file name same as ordernumber value in request. How to get mock response of specific ordernumber request? There will be multiple users placing response file in same path with name of ordernumber value from request. They need to get their corresponding response only after hiting same mock URL. I have soapui free version. Thanks in advance.
  • WirtRo48's avatar
    WirtRo48
    Occasional Contributor
    10 years ago

    Your mock-response should be a groovy script. There you can read in your file (filename based on the submitted ordernumber) and then you have to set an internal variable like this:

     

    def groovyUtils = new com.eviware.soapui.support.GroovyUtils( context );
    def holder = groovyUtils.getXmlHolder(mockRequest.requestContent);
    String sInputOrderNumber = holder.getNodeValue("//<... here you need the tag from incomming request>");
    lUtil.log(LogUtil.LogLevel.INFO, " Incomming ordernumber: " + sInputOrderNumber);

    ...

    // read correct file based on ordernumber

    String sResult = ... getOrderNumberResult( sInputOrderNumber );
    // set context variable
    context.setProperty("result", sResult);

     

    Then, in your mock-response, you only put something like this:

    ${result}

     

    That means, whatever you read in from your file will be returned to the caller. That also means tha you should have your complete returnmessage in your mock-file.

     

    ( P.S.: Of course, you can have your retunr message in the response and only put the return variable there it belonged in the message.)

  • nmrao's avatar
    nmrao
    Champion Level 3
    10 years ago
    /* If you already have all the directory structure of the project
* defined(in cvs, svn etc) and can't change as mentioned in the above script
* you may use below one which uses the location of respones as project property,
* say define a project custom property MOCK_RESPONSES_LOCATION and set the path
* in unix style ('/' as path separator) even on windows. Of course, you may use at test suite, or 
    * testcase level property too if you wish.
* soapFault.xml is need here too in case of failure. 
*/
def groovyUtils = new com.eviware.soapui.support.GroovyUtils(context)
def holder = groovyUtils.getXmlHolder(mockRequest.requestContent)
def soNumber = holder.getNodeValue("//*:BillingOrderLoadRequest/*:salesOrderNumber")
def project = mockResponse.mockOperation.mockService.project
def responseLocation = project.getPropertyValue('MOCK_RESPONSES_LOCATION')
def file = new File("${responseLocation}/${soNumber}.xml")
def fileToLoad = 'soapFault'
if (file.exists()) {
	fileToLoad = soNumber	
} 
context.content = new File("${responseLocation}/${fileToLoad}.xml").text
  • Apoorva6's avatar
    Apoorva6
    Frequent Contributor
    10 years ago

    Hi Rao,

     

    Thanks a lot for script. Can you please modify the script bit to include the external path instead of Soap project path ? Because I need to fetch the mock response files from external path. Also I am not using any external property.xml to include the predifined properties. So the second script you provided, I cannot use. I am creating an external path C:Users\mockResponse path to store mockresponse and Fault.xml

  • nmrao's avatar
    nmrao
    Champion Level 3
    10 years ago
    All you need is to add a property at project level and specify your local path into order to use the second one. Did you try any of the above at least?
  • Apoorva6's avatar
    Apoorva6
    Frequent Contributor
    10 years ago
    Thank you very much. It worked finally with project path. Thank you Rao and Rup both...
  • uma6kasturi's avatar
    uma6kasturi
    Occasional Contributor
    9 years ago

    Hi Rao,

     

    can you give similar example for rest mocking(.json) too please , similar to soap  which you had suggested above 

  • nmrao's avatar
    nmrao
    Champion Level 3
    9 years ago
    uma6kasturi, It is recommended that not to cross post. Please create a new topic with as much details as you can, that will help for every one on the forum.