├── README.md
├── SampleFramework-soapui-project.xml
└── soapui.xls


/README.md:
--------------------------------------------------------------------------------
 1 | # SoapUIFramework
 2 | Excel Data Driven Framework for API Automation using SoapUi and groovy
 3 | 
 4 | PreRequisite:
 5 | 1. Make sure to add jxl.jar to the soapuiinstallationfolder/lib and soapuiinstallationfolder/bin/ext
 6 | 2. Soapui installation folder will be your C:\Program Files\SmartBear\SoapUI-5.5.0 unless you installed in other folders
 7 | 3. Download the project xml and excel to your machine and make sure the soapui.xls also placed in the same folder where you placed the project xml file. 
 8 | 4. Import the project in to your workspace.
 9 | 
10 | Running the suite:
11 | 
12 | 1. runme groovy script file under TestRunner testcase takes care of reading the values from excel and driving the tests based on the Yes/No keywords in the excel.
13 | 2. You can also run the TestRunner testcase from cmd. 
14 | 
15 | Adding more tests:
16 | 
17 | 1. Create as many as tests you want in the same suite.
18 | 2. Make sure the tests created in soapui is same as in the excel sheet. 
19 | 3. If you add a new test case, make sure to add the below script in the tearDown script of the test case.
20 | 4. If you want to run same test case with multiple test data, use a different iteration in the excel sheet.
21 | 
22 | // Code to execute the GenerateCSVReport test step
23 | testRunner.testCase.testSuite.project.testSuites["Library"].testCases["Reporting_Utility"].
24 | testSteps["GenerateCSVReport"].run(testRunner, context);
25 | 
26 | Reports:
27 | 1. Reports will be generated to the folder where the project is placed in the local machine.
28 | 2. Reports are done based on the below article. 
29 | https://dzone.com/articles/how-to-achieve-csv-reporting-in-soapui-open-source-1
30 | 3. Request and response bodies are also stored in a notepad file in the results folder along with the csv reports.
31 | 
32 | Please contact me if you need any details through mech.amuthansakthivel@gmail.com
33 | 
34 | 
35 | 


--------------------------------------------------------------------------------
/SampleFramework-soapui-project.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <con:soapui-project id="86a5ff52-5df4-4696-b5fd-9ab668ae670c" activeEnvironment="Default" name="SampleFramework" resourceRoot="" soapui-version="5.5.0" xmlns:con="http://eviware.com/soapui/config"><con:settings/><con:interface xsi:type="con:RestService" id="bd43e7ce-f798-4eb8-ae54-7a4f1e612749" wadlVersion="http://wadl.dev.java.net/2009/02" name="https://restcountries.eu" type="rest" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><con:settings/><con:definitionCache type="TEXT" rootPart=""/><con:endpoints><con:endpoint>https://restcountries.eu</con:endpoint></con:endpoints><con:resource name="Name" path="/rest/v2/name/{name}" id="c77a4e8e-9aa2-433e-9f45-d567c856ad79"><con:settings/><con:parameters><con:parameter><con:name>name</con:name><con:value>name</con:value><con:style>TEMPLATE</con:style><con:default>name</con:default><con:path xsi:nil="true"/><con:description xsi:nil="true"/></con:parameter></con:parameters><con:method name="Name 1" id="1a04201e-1726-4c83-9427-7f8b98ce7e12" method="GET"><con:settings/><con:parameters/><con:representation type="RESPONSE"><con:mediaType>application/json;charset=utf-8</con:mediaType><con:status>200</con:status><con:params/><con:element>Response</con:element></con:representation><con:representation type="FAULT"><con:mediaType>application/json;charset=utf-8</con:mediaType><con:status>404</con:status><con:params/><con:element xmlns:ind="https://restcountries.eu/rest/v2/name/India">ind:Fault</con:element></con:representation><con:representation type="FAULT"><con:mediaType xsi:nil="true"/><con:status>404</con:status><con:params/><con:element>data</con:element></con:representation><con:representation type="FAULT"><con:mediaType xsi:nil="true"/><con:status>404</con:status><con:params/><con:element>data</con:element></con:representation><con:representation type="FAULT"><con:mediaType xsi:nil="true"/><con:status>404</con:status><con:params/><con:element>data</con:element></con:representation><con:representation type="FAULT"><con:mediaType xsi:nil="true"/><con:status>404</con:status><con:params/><con:element>data</con:element></con:representation><con:representation type="FAULT"><con:mediaType xsi:nil="true"/><con:status>404</con:status><con:params/><con:element>data</con:element></con:representation><con:representation type="FAULT"><con:mediaType xsi:nil="true"/><con:status>404</con:status><con:params/><con:element>data</con:element></con:representation><con:representation type="FAULT"><con:mediaType xsi:nil="true"/><con:status>404</con:status><con:params/><con:element>data</con:element></con:representation><con:request name="getCountryDetailsByName" id="6c07c31c-e179-48d4-945e-c7b61950a338" mediaType="application/json"><con:settings><con:setting id="com.eviware.soapui.impl.wsdl.WsdlRequest@request-headers">&lt;xml-fragment/></con:setting></con:settings><con:endpoint>https://restcountries.eu</con:endpoint><con:request/><con:originalUri>https://restcountries.eu/rest/v2/name/India</con:originalUri><con:credentials><con:authType>No Authorization</con:authType></con:credentials><con:jmsConfig JMSDeliveryMode="PERSISTENT"/><con:jmsPropertyConfig/><con:parameters><entry key="name" value="India" xmlns="http://eviware.com/soapui/config"/></con:parameters><con:parameterOrder><con:entry>name</con:entry></con:parameterOrder></con:request></con:method></con:resource></con:interface><con:testSuite id="315258f9-c9f1-4d07-aa74-958880a7df50" name="RegressionSuite"><con:settings/><con:runType>SEQUENTIAL</con:runType><con:testCase id="b01a1e06-fa8e-4119-ae31-0481d4d7292c" failOnError="true" failTestCaseOnErrors="true" keepSession="false" maxResults="0" name="TestRunner" searchProperties="true"><con:settings/><con:testStep type="groovy" name="runme" id="a52dcbb4-d7f4-45c4-9f1c-49d4ebde9cde"><con:settings/><con:config><script>
  3 | 
  4 | // IMPORT THE LIBRARIES WE NEED
  5 | 
  6 | import com.eviware.soapui.support.XmlHolder
  7 | import jxl.*
  8 | import jxl.write.*
  9 | 
 10 | def myTestCase = context.testCase //myTestCase contains the test case
 11 | 
 12 | def size //Variables used to handle the loop and to move inside the file
 13 | def projectPath = new com.eviware.soapui.support.GroovyUtils(context).projectPath //get the project location directory dynamically
 14 | 
 15 | log.info(projectPath)
 16 | 
 17 | Workbook workbook1 = Workbook.getWorkbook(new File(projectPath+"\\soapui.xls")) //file containing the data
 18 | //WritableWorkbook workbook = Workbook.createWorkbook(new File("C:\\Users\\asakthiv\\Desktop\\soapui.xls"))
 19 | 
 20 | Sheet sheet1 = workbook1.getSheet(0) //Index 0 will read the first sheet from the workbook, you can also specify the sheet name with "Sheet1"
 21 | //WritableSheet sheet = workbook.getSheet("")
 22 | //Sheet sheet1 = workbook1.getSheet("Sheet1")
 23 | 
 24 | size= sheet1.getRows().toInteger() //get the number of rows, each row is a data set
 25 | columns = sheet1.getColumns().toInteger()
 26 | 
 27 | log.info( "rows count :"+size) 
 28 | log.info(" columns count :"+ columns)
 29 | 
 30 | 
 31 | 
 32 | 
 33 | 
 34 | for( int i=1;i &lt;size ;i++){
 35 | 		testRunner.testCase.testSuite.setPropertyValue("result","")
 36 | 		if( sheet1.getCell(2,i).getContents()=="Yes"){
 37 | 		//log.info("i value is :"+ i +" content is :"+ value) //columnnumber , rownumber
 38 | 	
 39 | 		testRunner.testCase.testSuite.setPropertyValue("testName", sheet1.getCell(0,i).getContents())
 40 | 		testRunner.testCase.testSuite.project.setPropertyValue("Iteration",sheet1.getCell(1,i).getContents())
 41 | 		testRunner.testCase.testSuite.setPropertyValue("execute", sheet1.getCell(2,i).getContents())
 42 | 		
 43 | 		testRunner.testCase.testSuite.setPropertyValue("countryCode", sheet1.getCell(3,i).getContents())
 44 | 
 45 | 		def tcase = testRunner.testCase.testSuite.testCases[testRunner.testCase.testSuite.getPropertyValue("testName")]
 46 | 		def prop = new com.eviware.soapui.support.types.StringToObjectMap()
 47 | 		runner = tcase.run(prop,true)
 48 | 		log.info( "i ---->"+ i)
 49 | 		Thread.sleep(5000)
 50 | 		}
 51 | 	if(testRunner.testCase.testSuite.getPropertyValue("result") == "pass"){
 52 | 		log.info("Test Case passed")
 53 | 		//Label label = new Label(3,i,"Pass")
 54 | 		//sheet.addCell(label)
 55 | 	}
 56 | 	else{
 57 | 		log.info("Test Case failed")
 58 | 		//Label label = new Label(3,i,"Fail")
 59 | 		//sheet.addCell(label)
 60 | 	}
 61 | 	
 62 | 		//tcase.getTestStepByName("getCountryDetailsByName").setPropertyValue("name",sheet1.getCell(0,i).getContents())
 63 | 		//def status=tcase.getTestStepByName("getCountryDetailsByName").run(testRunner,context)
 64 | 		//def result = status.getStatus().toString()
 65 | 		//log.info("Result :"+result)
 66 | 		//def project= testRunner.testCase.testSuite.project;
 67 | 		//def tcase = project.testSuites["RealSuite"].testCases[testRunner.testCase.testSuite.getPropertyValue("testName")];
 68 | 	
 69 | }
 70 | 
 71 | //workbook.write()
 72 | //workbook.close()
 73 | 
 74 | </script></con:config></con:testStep><con:properties/></con:testCase><con:testCase id="88ce22b6-187d-4dfd-bd47-2ce3dd041f8d" failOnError="true" failTestCaseOnErrors="true" keepSession="false" maxResults="0" name="TestCase1" searchProperties="true"><con:settings/><con:testStep type="restrequest" name="getCountryDetailsByName" id="50483388-b3c0-4d4a-a033-cb82d001c067"><con:settings/><con:config service="https://restcountries.eu" resourcePath="/rest/v2/name/{name}" methodName="Name 1" xsi:type="con:RestRequestStep" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><con:restRequest name="getCountryDetailsByName" id="38a1d86d-f077-4c44-90eb-3ec69662d358" mediaType="application/json"><con:settings><con:setting id="com.eviware.soapui.impl.wsdl.WsdlRequest@request-headers">&lt;xml-fragment/></con:setting></con:settings><con:endpoint>https://restcountries.eu</con:endpoint><con:request/><con:originalUri>https://restcountries.eu/rest/v2/name/India</con:originalUri><con:assertion type="GroovyScriptAssertion" id="f78e12bb-e051-4e9c-9749-729f60f3c479" name="Script Assertion"><con:configuration><scriptText>import groovy.json.JsonSlurper
 75 | 
 76 | def responseMessage = messageExchange.response.responseContent
 77 | def json = new JsonSlurper().parseText(responseMessage)
 78 | 
 79 | assert json.name.toString() != null
 80 | </scriptText></con:configuration></con:assertion><con:credentials><con:authType>No Authorization</con:authType></con:credentials><con:jmsConfig JMSDeliveryMode="PERSISTENT"/><con:jmsPropertyConfig/><con:parameters><entry key="name" value="${#TestSuite#countryCode}" xmlns="http://eviware.com/soapui/config"/></con:parameters><con:parameterOrder><con:entry>name</con:entry></con:parameterOrder></con:restRequest></con:config></con:testStep><con:testStep type="transfer" name="Copy of CountryCodeTransfer" id="680ff245-d646-4886-96e2-0a7730ae5317"><con:settings/><con:config xsi:type="con:PropertyTransfersStep" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><con:transfers setNullOnMissingSource="true" transferTextContent="true" failOnError="true" ignoreEmpty="false" transferToAll="false" entitize="false" transferChildNodes="false"><con:name>CountryCode</con:name><con:sourceType>Response</con:sourceType><con:sourceStep>getCountryDetailsByName</con:sourceStep><con:sourcePath>$.[0].altSpellings[0]</con:sourcePath><con:targetType>name</con:targetType><con:targetStep>getCountryDetailsFromCode</con:targetStep><con:type>JSONPATH</con:type><con:upgraded>true</con:upgraded></con:transfers></con:config></con:testStep><con:testStep type="restrequest" name="getCountryDetailsFromCode" id="c7dbc641-685d-4bac-9748-993becc6abf8"><con:settings/><con:config service="https://restcountries.eu" resourcePath="/rest/v2/name/{name}" methodName="Name 1" xsi:type="con:RestRequestStep" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><con:restRequest name="Copy of getCountryDetailsFromCode" id="1ee635d0-8938-4761-bfb8-99e61a52d27b" mediaType="application/json"><con:settings><con:setting id="com.eviware.soapui.impl.wsdl.WsdlRequest@request-headers">&lt;xml-fragment/></con:setting></con:settings><con:endpoint>https://restcountries.eu</con:endpoint><con:request/><con:originalUri>https://restcountries.eu/rest/v2/alpha/IN</con:originalUri><con:assertion type="GroovyScriptAssertion" id="a287d8a7-0b49-4584-9401-e8695586ac64" name="Script Assertion"><con:configuration><scriptText>import groovy.json.JsonSlurper
 81 | 
 82 | def responseMessage = messageExchange.response.responseContent
 83 | def json = new JsonSlurper().parseText(responseMessage)
 84 | 
 85 | assert json.name.toString() != null
 86 | def value = context.expand('${#TestSuite#countryCode}')
 87 | //assert json.name.toString() == value</scriptText></con:configuration></con:assertion><con:credentials><con:authType>No Authorization</con:authType></con:credentials><con:jmsConfig JMSDeliveryMode="PERSISTENT"/><con:jmsPropertyConfig/><con:parameters>
 88 |   <con:entry key="code" value="AD"/>
 89 |   <con:entry key="name" value="AD"/>
 90 | </con:parameters><con:parameterOrder><con:entry>code</con:entry></con:parameterOrder></con:restRequest></con:config></con:testStep><con:testStep type="groovy" name="Logger" id="7fd02e43-f1fb-4598-998c-5baa3ead77e6"><con:settings/><con:config><script>testRunner.testCase.testSuite.setPropertyValue("result","pass")</script></con:config></con:testStep><con:tearDownScript>// Code to execute the GenerateCSVReport test step
 91 | testRunner.testCase.testSuite.project.testSuites["Library"].testCases["Reporting_Utility"].
 92 | testSteps["GenerateCSVReport"].run(testRunner, context);</con:tearDownScript><con:properties/></con:testCase><con:properties><con:property><con:name>result</con:name><con:value>pass</con:value></con:property><con:property><con:name>testName</con:name><con:value>TestCase1</con:value></con:property><con:property><con:name>execute</con:name><con:value>Yes</con:value></con:property><con:property><con:name>countryCode</con:name><con:value>Andorra</con:value></con:property></con:properties></con:testSuite><con:testSuite id="d3790e86-bdb4-414b-8956-e4625e2e2de5" name="Library" disabled="true"><con:settings/><con:runType>SEQUENTIAL</con:runType><con:testCase id="d7c9ea59-bdab-40c2-ad9d-850a25b943fd" failOnError="true" failTestCaseOnErrors="true" keepSession="false" maxResults="0" name="Reporting_Utility" searchProperties="true"><con:settings/><con:testStep type="groovy" name="GenerateCSVReport" id="58b876db-8128-4086-9b3d-c82d90c56822"><con:settings/><con:config><script>// Try-catch block to handle exceptions
 93 | try {
 94 | // 1. Create a "SoapUIResults" folder in the project path 
 95 |       // Retrieve the project root folder
 96 |       def projectPath = new com.eviware.soapui.support.GroovyUtils(context).projectPath
 97 |       // Specify a folder inside project root to store the results
 98 |       String folderPath = projectPath + "/SoapUIResults";
 99 |       // Create a File object for the specified path
100 |       def resultFolder = new File(folderPath);
101 |       // Check for existence of folder and create a folder
102 |       if(!resultFolder.exists())
103 |       {
104 |         resultFolder.mkdirs();
105 |       }
106 | /* ------------------------------------------------------------------------------- */
107 | // 2. Create a subfolder (with timestamp) to store the request-response local copy 
108 |       // Retrieve the latest execution date-time
109 |       Date d = new Date();
110 |       def executionDate = d.format("dd-MMM-yyyy HH_mm");
111 |       // Specify the subfolder path with name Request-Response_CurrentTimeStamp
112 |       String subfolderPath1 = folderPath+ "/Request-Response_"+executionDate;
113 |       // Create this sub-folder
114 |       new File(subfolderPath1).mkdirs();
115 | /* ------------------------------------------------------------------------------- */
116 | // 3. Create another subfolder "CSV Reports" to store the reports file 
117 |       // Specify the subfolder path with name CSV Reports
118 |       String subfolderPath2 = folderPath+ "/CSV Reports";
119 |       // Create this sub-folder
120 |       new File(subfolderPath2).mkdirs();
121 | /* ------------------------------------------------------------------------------- */
122 | // 4. Create a Report.csv file inside the CSV Reports folder 
123 |       // Create a File object for Report csv file (with timestamp)
124 |       def reportFile = new File(subfolderPath2, "Report_"+executionDate+".csv");
125 |       // Check for existence of report file and create a file
126 |       if(!reportFile.exists())
127 |       {
128 |         reportFile.createNewFile();
129 |         // Create required column names in the report file
130 |         reportFile.write('"Test Suite","Test Case","Test Step","Step Type","Step Status",'
131 |                         +'"Result message","Execution Date"');
132 |       }
133 | /* ------------------------------------------------------------------------------- */
134 | // 5. Inserting data in the file
135 |       // Iterate over all the test steps results
136 |   for(stepResult in testRunner.getResults())
137 |   {
138 |     // Retrieve Test Suite name
139 |    def testSuite = testRunner.testCase.testSuite.name;
140 |    // Retrieve Test Case name
141 |    def testCase = testRunner.testCase.name;
142 |    // Retrieve Test Step
143 |    def testStep = stepResult.getTestStep();
144 |    // Retrieve Test Step name
145 |    def testStepName = testStep.name
146 |    // Retrieve Test Step type
147 |    def type = testStep.config.type
148 |    // Retrieve Test Step status
149 |    def status = stepResult.getStatus()
150 |    // Creating new line in report file
151 |    reportFile.append('\n');
152 |    // Write all the necessary information in the file
153 |    reportFile.append('"' + testSuite + '",');
154 |    reportFile.append('"' + testCase + '",');
155 |    reportFile.append('"' + testStepName + '",');
156 |    reportFile.append('"' + type + '",');
157 |    reportFile.append('"' + status + '",');
158 |    // Retrieve the test result messages
159 |    reportFile.append('"');
160 |    for(resMessage in stepResult.getMessages())
161 |    {
162 |      // Write messages and separate multiple messages by new line
163 |      reportFile.append('Message:' + resMessage + '\n');
164 |    }
165 |    reportFile.append('",');
166 |    //Write executionDate in the file
167 |    reportFile.append('"' + executionDate + '",');
168 | /* ------------------------------------------------------------------------------- */
169 | // 6. Extract the request and response and save it to external file
170 |       // Verify if the test step type is request: SOAP project or restrequest: REST project
171 |         if((type=="request").or(type=="restrequest"))
172 |         {
173 |           // Extract the request from the test step
174 |           def extRequest = testStep.properties["Request"].value;    
175 |       // Create a file in the reports folder and write the request
176 |       // Naming convention: request_TestSuiteName_TestCaseName_TestStepName.txt
177 |       def iterationvalue = testRunner.testCase.testSuite.project.getPropertyValue("Iteration")
178 |       def requestFile=subfolderPath1+"/request_"+testSuite+"_"+testCase+"_"+testStepName+"_"+iterationvalue+".txt";
179 |       def rqfile = new File(requestFile);
180 |       rqfile.write(extRequest, "UTF-8");
181 |       // Extract the response from the test step
182 |       def extResponse = stepResult.getResponseContent();    
183 |       // Create a file in the reports folder and write the response
184 |       // Naming convention: response_TestSuiteName_TestCaseName_TestStepName.txt
185 |       def responseFile=subfolderPath1+"/response_"+testSuite+"_"+testCase+"_"+testStepName+"_"+iterationvalue+".txt";
186 |       def rsfile = new File(responseFile);
187 |       rsfile.write(extResponse, "UTF-8");
188 |      }
189 |    }
190 |  }
191 | catch(exc)
192 | {
193 |    log.error("Exception happened: " + exc.toString());
194 | }</script></con:config></con:testStep><con:properties/></con:testCase><con:properties/></con:testSuite><con:properties><con:property><con:name>Iteration</con:name><con:value>3</con:value></con:property></con:properties><con:wssContainer/><con:oAuth2ProfileContainer/><con:oAuth1ProfileContainer/><con:sensitiveInformation/></con:soapui-project>


--------------------------------------------------------------------------------
/soapui.xls:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/amuthansakthivel/SoapUIFramework/fa93fa34dc5ca700eab4f4ba4f36eac19cc97e58/soapui.xls


--------------------------------------------------------------------------------