Learn Advanced SoapUI Groovy Scripting Concepts – SoapUI Tutorial #9

In this tutorial, we will learn in detail about advanced SoapUI Groovy Scripting Concepts. Let’s get started.

The previous SoapUI tutorials have been an introduction to SoapUI and its programming concepts. We will now move into more advanced Groovy scripting concepts. Let us do this with Conditional flow statements – both Boolean and iterative statements. We will then move on to the arrays collection.

This is the 9th tutorial in our SoapUI tutorial series.

Conditional statements are used to control the flow of the execution. Here are the different types of conditional statements in Groovy. 

Learn Advanced SoapUI Groovy Scripting Concepts

#1) Control or logical statements

These statements result in true or false based on the logical conditions. They are AND, OR and NOT. The symbols used are ‘&& (and)’, ‘|’| and ‘! (exclamation)’ respectively. The behavior is as mentioned in the truth table:

“And” Operator truth table:

“OR” operator truth table:

“NOT” operator for negation purposes.

Conditional statement: programming languages support the following conditional statements:

• If…else statement
• If…else if…else statement
• Ternary operator
• Switch statement

A) if…else block syntax 

if <condition>
{
<Statements to be executed>
}
Else
{
<default statements>
}

In this syntax, when <condition> meets true the given statement will get executed. We need to enclose the statements with curly braces if the block contains more than one line. This instructs that the entire block should be executed based on the condition.

Look at the example code snippet.

int a=100
int b=200
if (a>b)
{
                log.info('B is greater than A');
                <To Do>
}
else
{
                log.info('A is greater or both are equal');
<To Do>
}

An if…else… statement should contain only one ELSE block.
B) Multiple conditional blocks: if…else if…else syntax
if <condition1>

 {

                 <Statements to be executed>

 }

 Else if <condition2….n>

 {

                 <Statements to be executed>

 }

 Else

 {

                 <default statements>

 }
If…else if…else statement is a little different than if…else… statement- in terms that it has else if block. This block is used to add multiple conditions. Look at the following example.
int a=100
int b=200
int c=300
if (a&amp;gt;b &amp;amp;&amp;amp; a&amp;gt;c)
{
                log.info('A is greater than B and C');
}
else if  (b&amp;gt;a &amp;amp;&amp;amp; b&amp;gt;c)
{
                log.info('B is greater than A and C');
}
else
{
                log.info('C is greater than A and B or All are equal numbers');
}

Also, look at the output screenshot for the above script: Also, please use this as a reference for the boolen operator example too:

C) Ternary operator
This operator works similar to if…else statement. It has two operands such as question mark (TRUE) and colon for FALSE / default statements.
def A = 100

 def B = (A > 100) ? “PASS” : “FAIL”

 log.info(B)
Here’s the screenshot for the above script.

D) Switch case: This statement allows for multiple conditional branches with different values. It also supports comparison of class object references, regular expressions, collections such as arrays, lists, etc.
Switch <value>

 {

 case <match1>:

                 <execute block>;

                 break;

 case <match1…match (n)>:

                 <execute block>;

                 break;
default:

 <execute default block>;

 }
The case statement compares the values with the switch case value. If it’s a match, then the corresponding case block gets executed. Once the block is executed then it should be stopped by the “break” keyword. If we missed “break” keyword at the end of the case statement, then the execution will be moved to the next case statement and that might not be necessary.  If none of the cases are correct, the default block will be executed. Please note that Groovy supports all the major operators and keywords as it is incorporated with the java libraries.
def country=&amp;quot;India&amp;quot;
switch(country)
{
	case &amp;quot;Japan&amp;quot;:
		log.info('Country matched with 1st case statement');
		break;
	case &amp;quot;Australia&amp;quot;:
		log.info('Country matched with 2st case statement');
		break;
	case &amp;quot;India&amp;quot;:
		log.info('Country matched with 3st case statement');
		break;
	default:
		log.info('None of the matches available :(');
}

Here’s the output screenshot for the above script.



#2. Looping or Iterative Statements
They enable repetition whenever required and are especially useful for data driven testing.
For instance, let us assume we have a few zip codes in an excel file. We can use iterative statements to retrieve all the zip codes one by one from the excel file and pass it to service i.e. GetSuppliersZipcode. SoapUI also provides an alternative feature called data source and data source loop test steps.(Available only in SoapUI Pro trial and licensed versions.)
We can use the following iterative statements in the groovy script:

For loop
While loop

For loop: 
for (<initialization>; <condition>; <increment /decrement>)

 {

                 <Execute Statements>;

 }
In the above syntax, initialization denotes the starting point of the loop and based on the condition loop will continue or stop the execution.
See the script below
for(int i=1; i<=10; i++)

 {

                 log.info(‘Loop Iterated ‘ + i + ‘ times’);

 }
The above script will produce the results as shown in the following screenshot.









Now let us use control statements and iterative statements in our real testing world. Follow the below steps:

Add Testcase with your desired name. I have created as “T9_GetSupplierByZipCode_TestCase”.
Then add a property named “Property_Zipcode”
Add the Test Request step for “GetSupplierByZipCode” service and put the property name in the request as shown in the screenshot.


Add the groovy script test steps as shown in the following screenshot.

In the groovy script editor, write the following script.
for (int zipCode=1; zipCode&amp;lt;10; zipCode++)
{
	testRunner.testCase.testSteps['Properties'].
setPropertyValue('Property_Zipcode', '3000' + zipCode )
	def testStep = testRunner.testCase.testSteps['GetSupplierByZipCode'];

	if (zipCode&amp;gt;5)
	{
		log.info('**************Stopped Execution*************');
		break;
	}
	testStep.run(testRunner,context);
	log.info('Executed ' + zipCode + ' times')
}

The following results are received in the log as well as in the service response screen.

(Click on the image for an enlarged view)

“while” loop: 
Syntax:








while <condition>

 {

                 <Execute Statements>;

 }
The above logic can also be implemented using the “while” loop too.
Hence, the gist is that iterative statements can be used to:

Execute test cases or test steps repeatedly
Control the flow of the execution through the control statements.

#3. Arrays Collection
Array collection helps store multiple values in a single variable or object. Array index starts at zero by default and we need to use that index with array name to access the corresponding value stored in the array. Syntax to declare arrays in groovy script:
arrayName = new Object[5] or,

 arrayName = new Object[10][] or, 

 arrayName = new Object[10][10][]
Note: While declaring arrays we must specify the initial size otherwise it will throw a compile error. Here’s a simple example of a single dimensional array.
ArrayObj = new Object [5];

 ArrayObj[0] = “Testcase1”;

 ArrayObj[1] = “Testcase2”;

 ArrayObj[2] = “Testcase3”;

 ArrayObj[3] = “Testcase4”;

 ArrayObj[4] = “Testcase5”;
Let us now implement this in our regular test steps. So add property, test request and script test steps under the project test suite as shown in the following screenshot.

Then double click on the script test step and write the following script.
def MAX_LIMIT = 5
def zipCodes = new Object[MAX_LIMIT]

zipCodes[0] = &amp;quot;92704&amp;quot;
zipCodes[1] = &amp;quot;99362&amp;quot;
zipCodes[2] = &amp;quot;31401&amp;quot;
zipCodes[3] = &amp;quot;90247&amp;quot;
zipCodes[4] = &amp;quot;87102&amp;quot;

int i=0;
while (i&amp;lt;5)
{
	if (i&amp;lt;5)
	{
		testRunner.testCase.testSteps['Properties'].
setPropertyValue('Property_Zipcode',zipCodes[i]);
		def testStep = testRunner.testCase.testSteps['GetSupplierByZipCode'];
		testStep.run(testRunner,context);
		log.info('Loop executed ' + i + ' times');
	}
	i++;
}
log.info(&amp;quot;Testcase execution is completed....&amp;quot;);

In this script, we initialized array object as 5 and assigned five zip codes in each array location respectively. Next part of the script is iterative block. Here we iterate the loop up to 5 times. Each time array value will be assigned to the property and then move to GetSupplierByZipCode web service to pass this array value in the request. After that, service step will be executed with the zip code. 

Finally we will get the following message in the log as shown in the screenshot.



So arrays are very useful to handle multiple elements with different types. More practice will foster better understanding and ease of use.
Conclusion
This was an overall introduction with examples of conditional or logical blocks that include IF…ELSE, switch and ternary statements. These statements are controlled by logical operators such as AND, OR, NOT. When compared to “switch” block “if” block is fast and simple. It is critical to handle multiple collections like arrays to iterate the testing process and loop statements.
Next SoapUI tutorial #10: In the next post we will learn “Object-Oriented Groovy Scripting in SoapUI”.
More useful concepts are coming up in the next SoapUI Groovy Script tutorials. Keep reading and please share your experiences and queries in the comments section below. We would love to hear from you. 









			


				

					

						
Was this helpful?
					
					

						

							
			

				
                			

										
			

				
                			

									
					
				

				

					

						
													

								

								

							
											
					
					

						Submit
						Cancel
					
				

				
Thanks for your feedback!

			

			
 
 
 
 
 
 
 


	
Recommended Reading
	

		

	
How to Handle Exception in SoapUI Groovy Scripts – SoapUI Tutorial #11

	
How to Write Basic Groovy Script in SoapUI - SoapUi Tutorial #6

	
How to Use Properties in SoapUI Groovy Script - SoapUI Tutorial #7

	
In-Depth Eclipse Tutorials For Beginners

	
4 Important Features of SoapUI Pro for Pro Audience – SoapUI Tutorial #12

	
15+ SoapUI Tutorials: The Best Web Services API Testing Tool

	
Step by Step SoapUI Download and Installation Process – SoapUI Tutorial #3

	
A Quick SoapUI Guide to Store Request and Response Data in a File – SoapUI Tutorial #15