Complete SOAP Web Service Testing Tutorial: Step-by-Step Guide with SOAPUI Tool

1. What is a Web Service?

A Web Service is any software code that is available over the internet and is used to transfer XML messages or data using Web Protocols like HTTP. For example., the client sends a request to the server over the network and a specific port where Web Service is hosted and waits for a response. Once the response is received, communication got completed.

1.1. Features of Web Service:

  • It uses XML for message communication.
  • It is platform-independent.
  • It can be available over the Internet or private network.
  • It can also process complex documents and not just messages.

1.2. Types of Web Services:

There are three types of Web Services that are used for client-server communication:
  1. SOAP Web Service (Simple Object Access Protocol)
  2. REST Web Service (Representational State Transfer)
  3. WSDL (Web Service Description Language)

Table of Contents

1. What is a Web Service?
    1.1. Features of Web Service
    1.2. Types of Web Services

2. What is SOAP Protocol?
    2.1. SOAP Protocol Features
    2.2. SOAP Message Format
    2.3. SOAP Message Structure Example

3. What is SOAPUI?
    3.1. Types of Testing SOAPUI can perform
    3.2. Protocols & Technologies SOAPUI Supports
    3.3. Installing SOAPUI
    3.3.1. Installing on Linux
    3.3.2. Installing on Windows/MAC

4. Working with SOAPUI Interface
    4.1. Main Window
    4.2. Create Your First SOAP Project
    4.3. What is a WSDL?
    4.4. SOAPUI Test Case, Test Step, Test Suite, Logs Pane, and Assertions
    4.5. SOAPUI Properties

2. What is SOAP Protocol?

Simple Object Access Protocol API, is a protocol used for exchanging structured information in web services. It defines a set of rules and formats for creating messages, exchanging data, and invoking methods across different platforms and programming languages.

To provide an example of a SOAP API, let's consider a hypothetical scenario where you have a weather forecasting service that exposes a SOAP API. The API allows users to retrieve weather information for a specific location.

Here's an example of how a SOAP API request and response may look like:

SOAP API Request:

xml
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.example.com/weather-api">
   <SOAP-ENV:Body>
      <ns1:GetWeatherRequest>
         <ns1:Location>London</ns1:Location>
      </ns1:GetWeatherRequest>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

In this example, the request is wrapped within a SOAP envelope. The <ns1:GetWeatherRequest> element specifies the operation to be performed, which is retrieving the weather information for a specific location.

SOAP API Response:

xml
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.example.com/weather-api">
   <SOAP-ENV:Body>
      <ns1:GetWeatherResponse>
         <ns1:Temperature>25°C</ns1:Temperature>
         <ns1:WeatherCondition>Sunny</ns1:WeatherCondition>
      </ns1:GetWeatherResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

In the response, the weather information for the requested location is returned. The <ns1:GetWeatherResponse> element contains the temperature and weather condition.

In this example, the SOAP API uses XML as the message format, and the request and response are wrapped within the SOAP envelope. The API defines specific elements and namespaces to represent the operations and data being exchanged.

SOAP APIs often rely on a WSDL (Web Services Description Language) file that provides a detailed description of the API, including the supported operations, data types, and message formats. The WSDL acts as a contract between the API provider and consumers, ensuring that both parties understand how to interact with the API.


2.1. SOAP Protocol Features

The SOAP (Simple Object Access Protocol) protocol is a messaging protocol used for exchanging structured information in web services. It offers several key features that make it a powerful tool for communication between applications. Some of the key features of the SOAP protocol are:

1. Extensibility: SOAP allows for the use of additional protocols and technologies by supporting various message exchange patterns, such as request-response, one-way, and notification-style messaging. This extensibility makes it adaptable to different communication scenarios.

2. Platform and Language Independence: SOAP is designed to be platform and language-independent, allowing applications written in different programming languages and running on different platforms to communicate with each other seamlessly. This makes it a highly interoperable protocol.

3. Message Structure: SOAP messages have a well-defined structure consisting of an envelope, header, and body. The envelope provides the overall structure of the message, the header contains additional information about the message, and the body carries the actual data being transmitted. This structure ensures consistency and standardization in the message exchange.

4. Data Encoding: SOAP supports multiple data encoding formats, including XML (Extensible Markup Language), which is the most commonly used format. XML provides a flexible and human-readable way to represent data, making it easy to understand and process.

5. Protocol Independence: SOAP can be used over different protocols, such as HTTP, SMTP, and more. It utilizes the underlying protocol for message transmission, allowing it to work seamlessly over various network protocols and infrastructures.

6. Error Handling: SOAP provides a standardized mechanism for handling errors and exceptions. It defines a SOAP fault message structure that allows for the reporting of errors and exceptions that occur during message processing. This helps in troubleshooting and identifying issues in communication between applications.

7. Security: SOAP supports various security mechanisms to ensure the confidentiality, integrity, and authenticity of exchanged messages. It can be integrated with security protocols like HTTPS, WS-Security, and others to provide secure communication over the network.

8. Standards-Based: SOAP is based on open standards and is defined by the World Wide Web Consortium (W3C). This ensures that SOAP-based web services can be implemented using standardized specifications, promoting interoperability and consistency.

2.2. SOAP Message Format

A SOAP message can be an XML document that contains the following elements:
  • Envelope - It defines the beginning and end of the message.
  • Header - It is an optional part of the SOAP message and is used in processing the message at an intermediary point or at the endpoint. 
  • Body - It is the actual XML message and a mandatory element.
  • Fault - It is the optional element that contains the faults or errors information that occurred during the processing of the message. There are some sub-elements present for the fault:
    • <faultcode>
    • <faultstring>
    • <faultactor>
    • <detail>
Please note that all these specifications can be changed or modified with new SOAP Protocol versions. For updated specifications on SOAP Message format please refer following links: 

2.3 SOAP Message Structure Example

<?xml version="1.0"?>  
<SOAP:Envelope  
xmlns:SOAP="http://www.w3.org/2003/05/SOAP-envelope/"  
SOAP:encodingStyle="http://www.w3.org/2003/05/SOAP-encoding">  

	<SOAP:Header>  
		...  
	</SOAP:Header>  
  
	<SOAP:Body>  
		...  
	<SOAP:Fault>  
		...  
	</SOAP:Fault>  

        </SOAP:Body>  
  
</SOAP:Envelope>


3. What is SOAPUI?

SOAPUI is an open-source tool for testing Web Services. These services can be SOAP Web Services, RESTFUL Services, or HTTP-based services. SOAPUI is a very popular tool and has more than 3 million downloads. A lot of community support and knowledge is available online for this tool. There is also a commercial version available for this tool with extra functionality called READYAPI.

3.1. Types of Testing SOAPUI can perform: 

  1. Functional Testing
  2. Load Testing 
  3. Security Testing
  4. Regression Testing 
You can create a functional test and run it as a load test in SOAPUI.

3.2. Protocols & Technologies SOAPUI Supports:

  1. SOAP – Simple Object Access Protocol
  2. WSDL – Web Service Definition Language
  3. REST – Representational State Transfer
  4. HTTP – Hyper Text Transmission Protocol
  5. HTTPS – Hyper Text Transmission Protocol Secured
  6. AMF – Action Message Format
  7. JDBC – Java Database Connectivity
  8. JMS – Java Messaging Service

3.3. Installing SOAPUI

SoapUI is cross-platform and is written in JAVA, so it runs on most operating systems, It supports several Windows Versions, Mac, and multiple Linux platforms. SoapUI requires a 1.6+ version of the JRE (Java Runtime Environment), at least 1 GB of memory is recommended, and about 100 MB of disk space.

3.3.1. Installing on Linux

  1. Download the Linux binary from http://www.soapui.org/
  2. Unzip it in a directory of your choice
  3. And run $ bin/soapui.sh

3.3.2. Installing on Windows/MAC

  1. Download the installer from download for Windows.
  2. Installation is pretty straightforward, start it by just double-clicking on the installer.
  3. It will ask you to select the destination folder, select and continue.
  4. The next step asks you to select the components you want to install, go with the default selections.
  5. On the next screen, it asks you to install SOAPUI tutorials, you can add or skip it.
  6. Few more basic options will come and that's it. Finished!

4. Working with SOAPUI Interface

4.1. Main Window

  1. Main Toolbar
  2. Icons Toolbar
  3. Navigator Pane - Expandable tree display of workspace content.
  4. Properties Pane - Predefined workspace properties.
  5. Log Inspectors


4.2 Create Your First SOAP Project

  1. Click on 'New SOAP Project' to create a new project.

2. Enter a name for your project.
3. Enter the WSDL file path - 

4. And click OK.
5. SOAPUI will create the project from the WSDL provided in the navigator bar.
6. Expand the NumberToDollars and then double-click on Request 1. It will display the following XML file on the right side:

7. Now you have to replace the '?' in <web:dNum>?</web:dNum> field with a number let's say 2 and press the green 'execute' arrow on the top left of the XML view.
8. And a response will be returned for this request, in the response you would see that 2 would be converted to 'two dollars' (you can select any of the two modes like xml or raw for the request and response):


Great! You just have done your first test of a SOAP Web Service using WSDL.

Similarly, you can test the remaining web service 'NumberToWords' by replacing the '?' with the corresponding value and executing it, and checking the response.

4.3 What is a WSDL?

WSDL, or Web Service Description Language, is an XML-based definition language. It’s used for describing the functionality of a SOAP-based web service.

WSDL files are the core of testing SOAP-based services. SoapUI uses WSDL files to generate test requests, assertions, and mock services. WSDL files define various aspects of SOAP messages:
  • Any element or attribute is allowed multiple times
  • The required elements and attributes
  • Optional elements and attributes
  • The specific order of elements or attributes
WSDL file can be seen as a contract between the provider and the consumer of the service. SoapUI supports the 1.1 version of the WSDL specification and corresponding bindings for SOAP versions 1.1 and 1.2.

We have already created a project from the WSDL file in section 4.2 of this article. 

4.4 SOAPUI Test Case, Test Step, Test Suite, Logs Pane, and Assertions

Let me explain each of these elements of SOAPUI in more detail:

1. Test Case:
A test case is a container that holds one or more test steps. It allows you to define a set of tests that will be executed together. Each test case has a name, description, and configuration options, including settings for timeouts, authentication, and headers. You can create multiple test cases to cover different scenarios and variations of your web service.

2. Test Step:
A test step is an individual action that is performed as part of a test case. There are several types of test steps in SOAPUI, including:

i. REST Request: A REST request sends an HTTP request to a web service and receives a response.
ii. SOAP Request: A SOAP request sends an XML-based SOAP message to a web service and receives a SOAP response.
iii. JDBC Request: A JDBC request sends a SQL query to a database and receives a response.
iv. Groovy Script: A Groovy script step allows you to write custom code to manipulate test data, perform complex calculations, or customize test behavior.
v. Delay: A delay step pauses the test execution for a specified time period.

Each test step has its own configuration options, such as endpoint URL, HTTP method, request headers, request body, and assertions.

3. Test Suite:
A test suite is a collection of related test cases. It allows you to organize your tests and run them together. You can create multiple test suites to cover different aspects of your web service, such as functional testing, performance testing, or security testing. Test suites have their own configuration options, such as test case order, parallel execution, etc. 

4. Logs Pane:
The Logs pane provides a detailed view of the test execution process. It shows the request and response messages, as well as any errors or warnings that occur during the test. The logs can be helpful in debugging issues or identifying areas for improvement in your tests.

The Logs pane can be filtered by severity level, such as errors, warnings, or information messages. This allows you to focus on specific areas of interest during the testing process.

5. Assertions:
Assertions are used to validate the results of a test step. They allow you to specify expected values and compare them to the actual values returned by the service.

4.5 SOAPUI Properties

SOAPUI, properties are used to store data that can be shared between different parts of a test case or between different test cases. They are essentially variables that can be used to store values that may change during the execution of a test.

Here are some key points about properties in SOAPUI:

1. Defining Properties: Properties can be defined at various levels, including the project level, the test suite level, the test case level, and the test step level. This allows you to define properties that are specific to a particular test or that can be shared across multiple tests.

2. Setting Property Values: Property values can be set in a variety of ways. For example, you can set the value of a property manually in the SOAPUI user interface, or you can use a script to set the value programmatically. You can also set property values dynamically based on the results of a previous test step or based on input data from a file.

3. Using Properties in Test Steps: Properties can be used in test steps to substitute variable values in requests, headers, or other elements. This can be useful when testing services that require dynamic input values, such as timestamps or user IDs.

4. Reading Property Values: You can also read the value of a property at any point in a test using a script. This allows you to check the value of a property and take action based on its value.

5. Property Expansion: SOAPUI supports property expansion, which allows you to use a property reference in a request or script and have the value of the property automatically substituted at runtime.

Conclusion

In summary, properties in SOAPUI are a powerful tool for managing data and making tests more flexible and reusable. They allow you to store and manipulate data at various levels of a test, and they can be used to create dynamic test scenarios that can adapt to changing input values.


Author
Vaneesh Behl
Passionately writing and working in Tech Space for more than a decade.

    Comments

    Post a Comment

    Popular posts from this blog

    What Role Graphic Design Services Play in Marketing

    Image
    Graphic design plays an essential part in today's marketing landscape and can provide an advantage for businesses. If you believe that graphic design is about images or drawings, then you're not right. Instead, it's about visuals proficient in solving problems using images. The vast majority of digital experts widely accept it as being one of the most important aspects of digital marketing because it helps marketers increase brand recognition and affect the decision-making process for their clients. In general, it is a representation of typography, symbols, colours, images, and symbols that contribute to the overall aesthetics of the communicated message. It is based on certain rules, trends, and concepts derived from a target audience's psychology studies. Get your work done by professional graphic design services 2022 .  Improve User Experience By in-Corporating Graphics In everything from brand identity to marketing via digital, any business can use graphic designs t...
    Read more

    Python Behave Tutorial: A Comprehensive Guide to Behavior-Driven Development (BDD)

    Image
    In this tutorial, we'll explain each and every aspect of Behavior Driven Development. This BDD Python tutorial will help you create and design your automation tests and framework. Table of Content 1. What is BDD? 2. What is Gherkin Language in BDD? 3. What is Behave in Python? 4. Installing and Setup Behave 5. Project Structure for Behave Python (BDD) 6. Feature Files, Step Functions and Other Files in Behave Feature File Step Functions Step Parameters Passing String Param from Feature File Passing Integer Param from Feature File environment.py file behave.ini file 7. Run Feature files in Behave Run a single feature file Run multiple feature files Generate JUNIT xml reports with behave Run feature files with Python suite file Upcoming Tutorials: 8. API Automation Testing with BDD Python (Behave) 9. Selenium Automation with BDD Python (Behave) 1. What is BDD? BDD stands for Behavior Driven Development. BDD is an agile process of development. It encourages non-technical or business t...
    Read more

    Top 10 Highly Paid Indian CEOs in the USA

    Image
    Top Indian CEOs in the USA Indian Americans have been making significant contributions to the US economy for decades. Many Indian-origin executives have reached the pinnacle of success in American corporations and hold some of the highest-paid positions in the country. In this post, we will take a look at the top 10 highly paid Indian-origin CEOs in the USA, their history, academics, salary, and net worth. 1. Sunder Pichai   Salary US$ 199.7 million Sundar Pichai is the CEO of Google and Alphabet Inc. Born in Tamil Nadu, India, Pichai grew up in a middle-class family and earned a Bachelor’s degree in Metallurgical Engineering from the Indian Institute of Technology in Kharagpur. He went on to earn a Master’s degree in Material Sciences and Engineering from Stanford University and an MBA from the Wharton School of the University of Pennsylvania. Pichai joined Google in 2004 and rose through the ranks to become CEO in 2015. His annual salary in 2021 was $2 million, and his net ...
    Read more

    17 Best Demo Websites for Automation Testing Practice

    Image
    We need demo websites for various purposes, like learning new tools and for automation testing practice. In this post, we cherry-picked some of the best websites to practice Selenium automation testing. This set of demo websites would help you to enhance your automation skills.  This post can help various people like,  Automation Testing learners, Experienced professionals, and even Automation Testing tutors/teachers. They all can benefit from these demo websites. Table of Contents 1. Techlistic Automation Practice Form 2. Amazon like Demo E-Commerce Website 3. Make My Trip like Travel Portal 4. Demo Automation Practice Web Table 5. Google.com 6. Demo Website for Handling Alerts 7. Way2Automation Demo 8. NewTours DemoAUT 9. The Demo Site 10. DemoQA 11. Para Bank 12. Orange HRM 13. Sauce Labs Demo E-Commerce Site 14. Demo Bank Demo Websites for API Automation Testing Practice 15. Restful Booker 16. Pet Store 17. Demo REST API Best Demo Websites for Automation Practice Let's...
    Read more

    Mastering Selenium Practice: Automating Web Tables with Demo Examples

    Image
    Demo Webtable 1 (Static Table) This table has 7 rows and 3 columns. So, the distribution of rows and columns is even. We can assume this table is a static or linear table. This table is easy to automate.  Company Contact Country Google Maria Anders Germany Meta Francisco Chang Mexico Microsoft Roland Mendel Austria Island Trading Helen Bennett UK Adobe Yoshi Tannamuri Canada Amazon Giovanni Rovelli Italy Demo Webtable 2 (Dynamic Table) This table has an uneven distribution of rows and columns the last row has two columns only, but the other rows have 7 columns each. So, let's assume it is a dynamic table. This table is a tougher task. Structure Country City Height Built Rank … Total 4 buildings Burj Khalifa UAE Dubai 829m 2010 1 Clock Tower Hotel Saudi Arabia Mecca 601m 2012 2 Taipei 101 Taiwan Taipei 509m 2004 3 Financial Center China Shanghai 492m 2008 4 Selenium Practice Exercises for Demo Table 2 -  Verify that there are only 4 structure values present in the table with Se...
    Read more

    14 Best Selenium Practice Exercises for Automation Practice

    Image
      This page contains the list of Selenium Program exercises for automation practice. Your skills will definitely get a boost after solving these Selenium Practice Assignments. In these assignments, you will find the Sample Applications for Automation Testing . These Practice Assignments are designed in such a way that learners can enhance their automation skills. They also include multiple Sample Test Cases for Selenium along with step-by-step description which needs to be automated.  Reference links to  Selenium WebDriver Commands  for solutions are provided in the assignments. 10 Best Selenium Practice Exercises for Automation Practice Automate Amazon-like e-Comm Website with Selenium WebDriver In this self-learning project assignment, we'll automate all the major e-commerce website features with Selenium and Java. We'll automate Sign-up and login, search products, and purchase products for Amazon an e-commerce website. Automate GoDaddy.com Website features with Se...
    Read more

    Top 11 Interview Blunders That Can Cost You the Job: Expert Tips to Avoid Them

    Image
    Job interviews are nerve-wracking, even for the most confident job seekers. After all, you want to impress the interviewer and secure the position. Unfortunately, many people make interview blunders that prevent them from getting hired. In this blog, we'll take a look at eleven interview blunders that are common among job seekers and explain why they can be so detrimental to your chances of landing a job. 1. Arriving late The first impression is the most important one, and arriving late to an interview is a surefire way to make a bad one. It suggests that you are unreliable, disorganized, or simply don't care enough about the job to make an effort to arrive on time. In some cases, arriving late might even result in your interview being canceled altogether. 2. Dressing inappropriately What you wear to an interview can have a significant impact on how you are perceived by the interviewer. Dressing too casually or too formally can give off the wrong impression. Always make sure ...
    Read more

    What is Encapsulation in Java?

    Encapsulation is a mechanism of binding code and data together in a single unit. Let’s take an example of Capsule. Different powdered or liquid medicines are encapsulated inside a capsule. Likewise in encapsulation, all the methods and variables are wrapped together in a single class. However if we setup public getter and setter methods to update (for example  void setAge(int age) )and read (for example   int getAge() ) the private data fields then the outside class can access those private data fields via public methods. This way data can only be accessed by public methods thus making the private fields and their implementation hidden for outside classes. That’s why encapsulation is known as  data hiding.  Lets see an example to understand this concept better. Example of Encapsulation: /* Create a class Encapsulation.java */ public class Encapsulation { private String name ; private int age ; public int getAge () { return ag...
    Read more

    Automate GoDaddy.com Features with Selenium WebDriver

    Image
    This post contains two assignments that helps you to learn Selenium browser commands. These are the simplest assignments. So, this assignment post is the best suited to start your automation tester journey. 1. Automate Browser Actions on GoDaddy.com If you are a beginner in automation testing and looking forward to writing your first Selenium code, then this post is the best destination for you. This assignment will teach you the basic commands of Selenium Webdriver to perform basic actions like., Launch the browser, maximize the browser window, validate the page title, and close the browser. In this post, you will find very basic step-by-step assignments which will upgrade your understanding of Selenium Webdriver and its commands. 1. Test Case - Open Godaddy.com and maximize the browser window. Steps to Automate:
    Read more

    How I learned Selenium WebDriver in just 4 weeks

    Image
    You can learn Selenium WebDriver yourself in just 1 month, yes you read it right! If you want above statement to work for you, then you would have to come up with a proper study plan and follow it with discipline. Discipline is the key here. Let me help you to make that study plan and also will share very useful blog posts links for the same, later in this post. Table of Content 1. My Story of becoming Selenium Professional 2. My Experiments with Selenium 3. Future of Selenium Automation Testing 4. Which language has a better career prospect with Selenium - Java or Python? 5. The 4 Weeks Plan to Learn Selenium WebDriver 6. What next after being Selenium expert? 1. My Story of becoming a Selenium Automation Professional I started my career way back in 2011 as a Manual Software Tester. I had interest in Java but didn't have much practical knowledge of it. I started learning Java slowly. It took some time to get some good  knowledge on Java. Then in 2012 I switched my first c...
    Read more