SOAP Teststep View

A SOAP Teststep is a WSDL-aware Teststep that reference a specific webservice method. You have request and response area with various that help you manage the complexity of SOAP-XML data models based on WSDL-XSD-Schema definition. Run your SOAP request and verify the response. You can view the HTTP header fields for request and response. A Soap Teststep is created based on a WSDL operation either for a SOAP 1.1 or SOAP 1.2 WsdlService Port

SOAP Teststep editor screenshot

Overview

The SOAP Teststep View provides a number of sub views and configuration options.

  • Teststep configuration options that effects request and response handling.
  • A Request view with a number of views that shows request information
  • A Response view with a number of views that show response information

Teststep configuration options

SOAP Teststep editor configuration screenshot

Teststep configuration view

  • Send Request with MTOM will transform your request in the required MTOM request format and replace all occurrences of elements of type {http://www.w3.org/2005/05/xmlmime} base64Binary with the {http://www.w3.org/2004/08/xop/include }Include. It will applyall required transformations to create a valid MTOM optimized request.
  • Resolve XOP:include in Response transforms an MTOM-optimized response to a response without optimizations. It will inline the SOAPAttachment data and transform all occurrences of {http://www.w3.org/2004/08/xop/include }Include with {http://www.w3.org/2005/05/xmlmime} base64Binary
  • Webservice url is required to send the request to the webservice endpoint under test. If you choose to use View Environment and have configured the webservice urls for this WSDL and the selected Run Environment, the url becomes non-editable. If no authentication is selected the HTTP header autorization is omitted otherwise sent with the base64 encoded string of username for basic authentication and password for basic authentication as displayed in preview base64 encoded authentication string.
  • WSDL operation reference is a required setting for a SOAP Teststep. APIJockey TEST uses the WSDL-definitions to validate the request and the response. It allows for using MTOM-optimized requests as described above. When you click on the binocular button, you will get a dialog with a list of WSDL definitions with their SOAP 1.1. and SOAP 1.2 operations.
  • Authentication options include no authentication, basic authentication with username and password and bearer authentication with bearer token in a free to define http header.

SOAP Request editor overview

The request view contains several tabs to display different information

  • Request with variables your XML editor with syntax highlighting
  • XML editor is a visual tree-like editor that allows you to edit XML elements with text content and select variables.
  • Request with variable values resolved. Viewer that resolves values of Variables
  • Assertions based on simplified XPath that assert occurrences of specified elements. Details see below
  • Attachments allow for selection and preview of documents that you want to send with your request.
  • URLRequest Details displays the HTTP headers used to create the request.

Tab Request with variables

  • Run Teststep will send the request to the specified URL, wait for the response and run all assertions against the response.
  • Request editor is your Syntax-Highlighting editor to work on your request
  • Create new request from WSDL operation will delete your current request and create a new one based on the current WSDL operation information.
  • Validate request will validate against the WSDL operation information and displays errors in case of non-conformance with this specification.
  • Pretty print XML does indents and create newlines for each element.

You enter your request in this syntax highlighting XML editor. Variables are colored to make them easy to distinguish, see Variables

Screenshot SOAP request editor

XML editor

The XML editor provides an additional edit option, with focus on XML elements that have text content and where the structure does not need to be changed. This is often the case for existing requests where values only need to be variable-ized or just changed.

NOTE: Press the ENTER key when editing is done to update the underlying xml.

Screenshot SOAP request XML editor

Request with variable values resolved

When you use variables, see Variables their name/value will be represented as follows:

  • tab Request with Variables as a highlighted variable identifier
  • tab XML editor no highlighting of the variable identifier
  • tab Request with Variables resolved with the current variable value, Attachment references are NOT resolved

When you switch from your request editor to this tab, APIJockey TEST will reevaluate the variables and resolve these as it does when sending the request. Bear in mind that this is only a viewer.

Assertions

Testing webservices can become repetitive and cumbersome. Assertions help you to automate checks and free you from repetitive error-prone verifications. You will find more time to further explore responses and find unexpected behaviour.

Assertions have their own tab in the SOAP Request view and allow you for editing assertions while viewing the Response.

Screenshot SOAP Assertionlist with Button description

APIJockey TEST supports the following assertions types

  • create a new XPath Assertion to verify the SOAP Response with an XPath expresssion. APIJockey TEST will support you with a visual editor to enter the XPath and to define the type of verification. See XPath Assertion editor.
  • create a new HTTP Assertion HTTP Status, response time and data length, see HTTP Assertion editor.
  • create a new Image Assertion will create an AI-based Assertion that will assess Text and Barcode information from your image. Note: PDF-Documents are also considered images in this Assertion type. See Image Assertion editor.
  • create a new PDF Assertion will create a PDF Assertion that will assess Text and document property information from your PDf-Document. Note: Sometimes PDF-Documents contain images, only and no text will be found. See PDF Assertion editor. In this case, you will need to use the Image Assertion type. See Image Assertion editor.

Attachments

See SOAP Attachments

URL request header

This tab displays the HTTP header used with the last URL request and may be empty if no request has been sent after (re-)starting APIJockey TEST.