Understanding Assertions in SoapUI – SoapUI Tutorial #5

We have been working on basics of SoapUI like creating projects, adding WSDL, sending a request & receiving responses and generating test assets to go along with them so far.

In this 5th SoapUI tutorial, we will learn all about assertions in SoapUI. We strongly recommend you to follow the complete SoapUI training series on this page to learn all these core features.

Introduction to Assertions:

Assertions in SoapUI

As with any testing, we have to compare what we want the system to do and what it actually is doing, to arrive at a certain validation or assertion, which is what it is called in the context of web services. As testers, it does not matter if we executed 1000 or even million test steps, but for us, the result comparison is what determines the outcome of a test.

Therefore, we will spend this entire article on understanding how we can do that with SoapUI, although web services can be asserted manually. Also, a manual assertion is time-consuming when there are multiple responses and responses with large data. SoapUI assertions are excellent at overcoming these shortfalls.

SOAPUI Assertions compare the parts/all of the response message to the expected outcome. We can add a variety of assertions provided by SoapUI to any test step. Each type of assertion targets specific validations on the response such as matching text, comparing XPATH or we could also write queries based on our need.

When the test steps get executed, then the associated assertions receive the response for the respective test steps. If any response is failed then the respective assertion will be processed and the corresponding test step will be marked as failed. This notification can be viewed in the test case view. Also, we can find failed test steps in the test execution log. The sample test step assertion screen looks as below:

SOAPUI Assertions 1

In the above image, some of the test steps have FAILED and some of them have PASSED. The reason is the assertion.

As we discussed earlier, if the assert condition is not met with the expected results then the result is FAILED.

Working with different kinds of assertions in SoapUI:

Let us now see how to work with different types of assertions like:

  • Contains and Not Contains assertions
  • XPath match and
  • XQuery match assertions.

Firstly, we need a valid WSDL schema location. For that, we can use Medicare Supplier web service that is available at http://www.webservicex.net/medicareSupplier.asmx?WSDL.

Follow the steps as below:

Step 1. Create a new SOAP project by pressing CTRL + N and follow the steps. After creating the project, SOAPUI generates the list of interfaces and the corresponding requests.

Step 2. To add the test suite to this project follow these steps:

  • Right-click on the interface name MedicareSupplierSoap
  • Click Generate Testsuite option from the context menu
  • Click OK on the below window that comes up:

SOAPUI Assertions 2

  • In the next popup, need to enter your desired test suite name and click OK
  • SOAPUI PRO will generate the test suite along with the requests in the navigator panel.
  • Under the test suite, you will see some of the test steps with SOAP request step.

Step 3. To execute this test suite, double-click on the request step and specify the input value in the respective location. For instance, open GetSupplierByCity request and enter New York between the city tags.

  • Start this request by clicking on RUN icon – this will receive the response
  • Now let’s add assertions. For that, click Assertions tab present at the top of log tabs.
  • On right clicking, a popup menu will appear with some basic assertion related options as below:

SOAPUI Assertions 3

#1. Contains Assertion:

Click Add Assertion option or click it from the toolbar – Add Assertion window appears on the screen with different types of assertions.

1. Click Property Content category from the list – associated assertion types and their description is displayed

2. Click Contains assertion and click Add button

3. This is the assertion configuration window. Here itself we have to specify the expected condition based on the response.

For example, let me enter New York text in this text field. Ignore case in comparison checkbox will ignore even if the expected value is in upper case or lower case.

SOAPUI Assertions 4

4. Now execute the test suite and verify the results. As you have seen in the test suite window, green indicates the successful execution and red denotes failure.

#2. Not Contains Assertion

We can use “not contains” assertion for validating request in negative scenarios. We can use GetSupplierByZipCode request to learn that.

Open the request tab by double-clicking on it. In the input request, enter the invalid zip code in the appropriate location, such as 10029. Run this request now. Check the response data which has the supplier details for the given zip code – take a look at the image below:

(Click on image for enlarged view)

SOAPUI Assertions 5

The “not contains” assertion, it is highlighted in green colour as it is executed successfully.

In the configuration window, we have configured with positive expected value as below:


SOAPUI Assertions 6

It returns true if the expected conditional value is not found and returns false if the expected value is found in the response message.

Similarly, we can change the condition and run the request once again. It generates the results accordingly.

#3. XPath Match assertion

XPath match assertion is the little bit different in terms that it will assert the response using actual response data.

For example, if we have login authentication web service that will authenticate the user credentials and send the acknowledgement to the client with some Boolean type of data which may be TRUE or FALSE in the form of XML.

As you know XML documents are built by tags. So when specifying the expected value in the configuration, it should be in the form of XML.

Let try to do that:

Add one more assertion for the GetSupplierByCity request. In the Add Assertion window, click Property Content category and then click XPath match assertion.

SOAPUI Assertions 7

The below window is displayed:

SOAPUI Assertions 8

The top section is the declaration part and bottom section is expected result part.

When we click on the Declare option we will get some auto-generated declaration scripts like below:

declare namespace soap=’http://schemas.xmlsoap.org/soap/envelope/’;
declare namespace ns1=’http://www.webservicex.net/’;

In the above scripts, the first line denotes the response that should be XML data and enclosed SOAP tags. In the next line, the whole response will be assigned or copied into the ns1 namespace variable during the execution. If we want to filter particular data from the whole response, we have to add the following script.

//ns1:SupplierData[1]

As you know, if you execute the GetSupplierByCity request, it will produce the response which contains the list of supplier’s personal data that belongs to New York City. Here, we have used XPath Match expression to extract the specific supplier’s personal details from the bulk response. For that purpose, we have used an ns1 variable. Now click on the Select from a Current button.

Then SOAPUI generates the following result:

<SupplierData xmlns="http://www.webservicex.net/"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<SupplierNumber>0127051883</SupplierNumber>
<CompanyName>KMART CORP</CompanyName>
<Address1>250 W 34TH ST</Address1>
<Address2/>
<City>NEW YORK</City>
<Zip>NY</Zip>
<ZipPlus4>10119</ZipPlus4>
<Telephone>0002</Telephone>
<Description>(212)760-1242</Description>
<IsSupplierParticipating>04</IsSupplierParticipating>
</SupplierData>

Please refer this screenshot:

SOAPUI Assertions 9

Here in the response data, you can see only one supplier personal data. Based on the number that is present inside the angle brackets, the output will be generated.

By so far, this is about choosing the portion of the response that is required, how can/are we using XPath Match assertion?

Let get to that: Click on the Save button once you are OK with the response.

Initially, if you would have executed this service after configuring XPath match assertion with no changes, the result will be a successful response, status highlighted in green.

But let’s change the input parameter in the input request to something that is an invalid city -“XYZ or ABC”. Run the request and check the results as well as the assertion status. We will get failure response and red status indication for the assertion. Because we had already specified that the particular supplier data should be present in the service response in the expected result configuration and when the city name is invalid, that supplier is clearly not present.

This is how we can assert the XML response using XPath Match expression assertion. Agreed that this is quite simple to start with but if you try with different service responses, you will get a much better idea.

We can also use aggregate functions in XPath Match expression. They are Sum, Min, Max, Count and Avg.

For example, if we want to know the total number of suppliers count in the expected results, write the following script.

count (//ns1:SupplierData) and it returns 536 as a result. Remember all the aggregate functions should be in lowercase.

#4. XQuery Match Assertion:

This is slightly similar to XPath Match assertion. As we have seen in the XPath Match assertion configuration, there will be two sections – declaration and expected result.

  • Add XQuery Match assertion for the request
  • In the configuration window, click declare button and write the following script
  • Now click Select from Current button
  • SOAPUI generates the response for the script

XQuery expression also supports XPath Match expression but it has its own scripting syntax which cannot be used in XPath match assertion.

For Example:

We will see one example to fetch all the supplier data response using XQuery expression. Look at this sample screenshot to understand better.

SOAPUI Assertions 10

Actual Script:

declare namespace soap='http://schemas.xmlsoap.org/soap/envelope/';
declare namespace ns1='http://www.webservicex.net/';

<resultData>
{
for $x in //ns1:SupplierData
return $x
}
</resultData>

There are more built-in functions available to use in XQuery expression. They are where, order by, for, return and so on. To get more information about these functions, visit www.w3cschools.com website.

Conclusion:

Well, those are the most commonly used assertions for you.

The point of emphasis here is that: Assertions are most important to predict the expected result of the web services accurately. That’s the reason it is one of the key features in SOAPUI PRO.

Next tutorial: In the next tutorial, we will get groovy with scripting basics and more…

Please stay connected. As always, your comments, questions and suggestions are most welcome.




Recommended reading

22 comments ↓

#1 krishna iva

Thank you.
very detailed tutorial.assertions are very useful for functional testing.

#2 sunitha

Thank You.
For the detailed tutorial.

#3 Karunagara Pandi

Thank you @krishna iva and @sunitha

#4 Roshan

Very helpful
Thank you
If we are running multiple request or Batch Testing, are we adding assertions for each request?

#5 Karunagara Pandi

@Roshan: Yes! we can add assertion for each test request under the TestSuite. While executing the test suite altogether, service response will be asserted according to the assertions that we added.

#6 indu

Can you please post a Test Case for a SOAP project with assertions.

#7 Gaurav Khurana

Thanks a lot , This one is really nice..

Please make the following corrections
http://www.webservicex.net/medicareSupplier.asmx?WSDL.
Better remove the (.) from webservice at the end because its also getting copied

I struggled a lot to get the option of Assertions. as while creating project we have to select some option called as (add validation) if we don’t assertions were not coming.. i even downloaded (Soap NG) version to get that option

#8 Hemant

I am using below Currency converter Open Source WSDL:

http://www.webservicex.com/currencyconvertor.asmx
Where I have added below Xpath Assertion to validate the floating ConversationRateResult Response value

declare namespace soap=’http://schemas.xmlsoap.org/soap/envelope/’;
declare namespace ns1=’http://www.webserviceX.NET/’;
matches(//ns1:ConversationRateResult/text(),'[0-9][0-9].[0-9][0-9]*’)
But when I am validating it by clicking Select from current Button in XPath Match Configuration window I am getting Expected value as “False” Instead of “True”

Can you please suggest in this.

#9 Kyle

Great tutorials! Thank you!

#10 Bhakti

Can we add assertions only using Pro Version? Is it not allowed in open source?

#11 Riyaz

Bhakti,
You can use Open Source version and add assertions.
regards
Riyaz

#12 Tanu

I tried the xpath assertion but it didnt work for me. Can any one here help me with the same. I am using Soapui 5.2.0. When I try and execute “GetSupplierByCity” xpath match assertion , On clicking declare I could see the auto generated scripts as mentioned but on clicking select from current button I am u

#13 Tanu

I am unable to see the expected result as shown in screenshot. Only pop out message displays “Invalid Xpath xpression”. Unable to understand this.

#14 kiran

Awesome way of explaining…pls keep posting this kind of posts.. Appreciate the one who designed this article

#15 john.tran

It’s so great! Thank You!

#16 Bhanu

Good one. Thanks a lot.

Please remove c in the http://www.w3cschools.com.

#17 Nayana

Tanu , please try Pro version it works on Pro.

#18 Pratik L

Hi, I am trying Xpath Assertion by following above-mentioned steps but when clicking on “Select from current” button getting an error message “Missing content to select from”, please assist what is the problem and how to resolve it.

#19 Pratik L

Above mentioned bug got resolved, I am able to move ahead.

#20 zishan paya

I am using assertion on REST api. Will I be able to use xpath match and XQuery match?
What are possible assertion with REST api with JSON response.

#21 Ravindar

When I run XPath match query it is working fine but when we try to run XQuery in Soap UI, I’m getting excpetion as “XQuery Match Assertion failed for path [declare namespace ns1=”;
declare namespace ns2=’http://xius.com/coupon/wsserver’;
declare namespace soapenv=’http://schemas.xmlsoap.org/soap/envelope/’;

{
for $x in //ns1:couponSerialNumber
return $x
}
] : RuntimeException:java.lang.reflect.InvocationTargetException

#22 BRREDDY

Hi, I’m trying XQuery Assertion with above mentioned steps but I’m getting error as below.

” XQuery Match Assertion failed for path [declare namespace ns1=”;
declare namespace ns2=’http://xius.com/coupon/wsserver’;
declare namespace soapenv=’http://schemas.xmlsoap.org/soap/envelope/’;

{
for $x in //ns2:couponSerialNumber
return $x
}
] : ComparisonFailure:null expected: but was:<[]> “

Leave a Comment