Soap Request Schema Validation : mock Services

Below script can be placed under "OnRequest Script" of a mock service to automatically validate the XML Schema compliance to the corresponding incoming request.

The script validates the incoming request and incase the request does not comply to the Schema of the WSDL then an automated fault message is sent by the mock service on behalf of the incoming request. Implementation of this script can help us overcome the situation where we have to manually validate the request sent by application to the mock service to make sure it complies to the schema structure of the WSDL.

    import com.eviware.soapui.impl.wsdl.WsdlOperation;
    import com.eviware.soapui.impl.wsdl.support.wsdl.WsdlValidator;
    import com.eviware.soapui.impl.wsdl.support.wsdl.WsdlContext;
    import com.eviware.soapui.impl.wsdl.mock.WsdlMockOperation
    import com.eviware.soapui.impl.wsdl.panels.mockoperation.WsdlMockRequestMessageExchange;
    import com.eviware.soapui.impl.wsdl.mock.WsdlMockResult;
    import com.eviware.soapui.model.iface.MessagePart
    import org.w3c.dom.Element;
    import org.w3c.dom.Node;
    import org.w3c.dom.NodeList;
    import com.eviware.soapui.support.XmlHolder;
    def requestHolder = new XmlHolder( mockRequest.requestContent);
    requestHolder.declareNamespace( "soapenv", "http://schemas.xmlsoap.org/soap/envelope/");
    validateRequest( requestHolder);

     public validateRequest( requestHolder){
      def operationElementName = getOperationElementName( requestHolder);
      def operationName = operationElementToOperationName(operationElementName);
      if( operationName == null){
       String faultstring = "VALIDATION ERROR: The operation-element '" + operationElementName +
             "' can not be found. Are request and mockup of the same version?";
       log.info( faultstring);
       return createFaultResponse( faultstring, context.mockService.getMockedOperations().get(0));
      }
      WsdlContext wsdlcontext = context.mockService.getMockedInterfaces()[0].getDefinitionContext();
      WsdlValidator validator = new WsdlValidator(wsdlcontext);
      WsdlMockOperation operation = context.mockService.getMockOperationByName( operationName);
      WsdlMockRequestMessageExchange msgExchange = new WsdlMockRequestMessageExchange(mockRequest, operation);
      def errors = validator.assertRequest(msgExchange, /*envelopeOnly*/false);
      if (errors.length > 0 ){
       String validationErrors = "VALIDATION ERRORS: " + errors.collect(){ '\n' + it };
       log.info( validationErrors);
       return createFaultResponse( validationErrors, operation);
      }
      log.info("Request Validation OK!");
     }
     private String getOperationElementName( requestHolder){
      Element bodyElement = requestHolder.getDomNode( "//soapenv:Body");
      def operationElement = bodyElement.getChildNodes().item(0);
      while (operationElement && operationElement.nodeType != 1)
      {//nodeType 1 is Element
       operationElement = operationElement.nextSibling;
      }
      def operationElementName = operationElement.getNodeName();
      if( operationElementName.contains(':')){
       operationElementName = operationElementName.split(':')[1];
      }
      return operationElementName;
     }
      
     private String operationElementToOperationName(String operationElementName) {
      for( WsdlOperation wo : context.mockService.getMockedOperations()){   
       log.info( "- Operation: " + wo.getName())
       for( MessagePart mp : wo.getDefaultRequestParts()){
        String partElementName = mp.getProperties().get("partElementName");
        if( partElementName.contains('}')){
         int idx = partElementName.indexOf('}');
         partElementName = partElementName.substring(idx+1, partElementName.length());
        }
        log.info( "   " + partElementName);
        if( operationElementName.equals(partElementName)){
         return wo.getName();
        }
       }
      }
      return null;
     }
     private WsdlMockResult createFaultResponse( String faultstring, operation){
      String content = '''<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
            <soapenv:Body>
               <soapenv:Fault>
                  <faultcode>Server</faultcode>
                  <faultstring><![CDATA[''' + faultstring + ''']]></faultstring>
            </soapenv:Fault>
            </soapenv:Body>
         </soapenv:Envelope>''';
      WsdlMockResult mr = new WsdlMockResult(mockRequest);
      mockRequest.httpResponse.writer << content;
      mockRequest.httpResponse.status = 500;
      return mr;
     }