Maven : Integration of tests

In the changing environment, the way tests are executed are also changing. Once we moved to agile mode from a traditional waterfall or v-Cycle mode of development we saw the need of automation. However, there is always a next step to be done, and in this case the obvious next step is to integrate them with development builds. There could be various ways to achive the same among which the most common one is deploying your tests on Jenkins. It provides a common platform where the development builds are done and at the same time the test builds can be done. In this article we will explore the possibility to integrate the various automated tests.

Maven : Integration of SoapUI automated Tests

SoapUI includes a Maven plugin for running SoapUI tests and mocks during Maven build. To use the correct version of SoapUI, you will have to see under the Soap Maven Repository. Maven should know about the soap repository and dependencies related to your project and it can be achieved by updating the maven settings which would be available at "conf" directory under maven binary location.
Edit the settings.xml and update the below elements as needed.

• Local Repository : Location of the directory where dependency repository would be stored locally for compilation
• Mirror : Location of maven mirror repository.
• Repository : maven repositories and other repository where dependent tools and configuration can be found
<repository> <id>soap.ui.repository</id> <name>Soap UI</name> <url>http://www.soapui.org/repository/maven2/</url> <snapshots><enabled>true</enabled></snapshots> <releases><enabled>true</enabled></releases> </repository>

• PluginRepository : maven repositories and other repository where dependency plugins can be found
<pluginrepository> <id>soap.ui.repository</id> <name>Soap UI</name> <url>http://www.soapui.org/repository/maven2/</url> <snapshots><enabled>false</enabled></snapshots> <releases><enabled>true</enabled></releases> </pluginRepository>

Attached an example settings.xml which is being used for one of the project.

<settings xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd"> <localrepository>C:\work\m2-repository</localRepository> <!--localRepository>${user.home}/.m2/repository</localRepository--> <mirrors> <mirror> <id>myrepos_central</id> <mirrorof>central</mirrorOf> <name>Maven Proxy mirroring central (maven 2) repository</name> <url>http://maven2.myrepos.com/proxy/repository/public</url> </mirror> </mirrors> <repositories> <repository> <id>myRepos.central</id> <name>myReposCentral Repository</name> <url>http://maven.myRepos.com/m2-repository/</url> <snapshots><enabled>true</enabled></snapshots> <releases><enabled>true</enabled></releases> </repository> <repository> <id>myRepos.repository</id> <name>myRepos Repository</name> <url>http://maven.myRepos.com/m2-repository/</url> <releases><enabled>true</enabled></releases> <snapshots><enabled>false</enabled></snapshots> </repository> <repository> <id>myRepos.snapshot.repository</id> <name>myReposSnapshot Repository</name> <url>http://maven.snapshot.myRepos.com/m2-snapshot-repository/</url> <releases><enabled>false</enabled></releases> <snapshots><enabled>true</enabled></snapshots> </repository> <repository> <id>myRepos.ext.non.free.repository</id> <name>myRepos Ext-Non-Free Repository</name> <url>http://maven2.myRepos.com/proxy/content/repositories/ext-non-free/</url> <releases><enabled>true</enabled></releases> <snapshots><enabled>false</enabled></snapshots> </repository> <repository> <id>EviwarePluginRepository</id> <name>myRepos Inhouse Releases</name> <url>http://maven2.myRepos.myCompany.com/proxy/content/repositories/eviwarePluginRepository/</url> <snapshots><enabled>true</enabled></snapshots> <releases><enabled>true</enabled></releases> </repository> <repository> <id>soap.ui.repository</id> <name>Soap UI</name> <url>http://www.soapui.org/repository/maven2/</url> <snapshots><enabled>true</enabled></snapshots> <releases><enabled>true</enabled></releases> </repository> </repositories> <pluginrepositories> <pluginrepository> <id>myRepos.plugins</id> <name>myRepos Central Repository</name> <url>http://maven.myRepos.com/m2-repository</url> <snapshots><enabled>true</enabled></snapshots> <releases><enabled>true</enabled></releases> </pluginRepository> <pluginrepository> <id>myReposInhouseReleases</id> <name>myRepos Inhouse Releases</name> <url>http://maven2.myRepos.mycompany.com/proxy/content/repositories/inhouse/</url> <snapshots><enabled>false</enabled></snapshots> <releases><enabled>true</enabled></releases> </pluginRepository> <pluginrepository> <id>soap.ui.repository</id> <name>Soap UI</name> <url>http://www.soapui.org/repository/maven2/</url> <snapshots><enabled>false</enabled></snapshots> <releases><enabled>true</enabled></releases> </pluginRepository> </pluginRepositories> </settings>

Once the settings are configured your maven can execute soapUI tests.
The second step is to create pom files for the execution of the SoapUI tests. You may have two scenario here, one where you only have one project file and the other where you have multiple project files. For single project file based execution it is easier as you have to create only one pom file which can be located at the same place as the SoapUI project file. For multiple project file however, we need to organize our project to be in the way below :

• Soap-Project
• Project-1
• Soap-Project-file.xml (Soap UI project file)
• pom.xml (Child pom file configured for this project)
• Project-2
• Soap-Project-file.xml (Soap UI project file)
• pom.xml (Child pom file configured for this project)
• Project-n
• Soap-Project-file.xml (Soap UI project file)
• pom.xml (Child pom file configured for this project)
• pom.xml (master pom file)

Prefer to use names of the files or directories without spaces or special characters to avoid referencing issues.

The master pom file would look as below :
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelversion>4.0.0</modelVersion> <groupid>myApp.MyOrg.com</groupId> <artifactid>master-pom</artifactId> <version>2.1.4-SNAPSHOT</version> <packaging>pom</packaging> <modules> <module>Project-1</module> <module>Project-2</module> <module>Project-n</module> </modules> </project>

A typical child pom file would look as below :

<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelversion>4.0.0</modelVersion> <groupid>myApp.myOrg.com</groupId> <artifactid>SoapUI_ProjectName</artifactId> <version>1.0-SNAPSHOT</version> <parent> <groupid>myApp.myOrg.com</groupId> <artifactid>master-pom</artifactId> <version>2.1.4-SNAPSHOT</version> </parent> <properties> <oracle.jdbc.driver.class.name>oracle.jdbc.OracleDriver</oracle.jdbc.driver.class.name> <nuodb.jdbc.driver.class.name>com.nuodb.jdbc.Driver</nuodb.jdbc.driver.class.name> <db.connection.url>jdbc:com.nuodb://192.168.0.101:48004/MYDATABASE?schema=SCHEMAU1</db.connection.url> <db.driver.class.name>${nuodb.jdbc.driver.class.name}</db.driver.class.name> <db.connection.username>USERNAME</db.connection.username> <db.connection.password>KARMAONEPL</db.connection.password> <application.url>http://xxx.xxx.xxx.xxx/applicationURL</application.url> <application.url>http://xxx.xxx.xxx.xxx/applicatioURL</application.url> <!-- Proxy Configuration goes here--> <proxy.host>xxx.xxx.xxx.xxx</proxy.host> <proxy.port>proxy-port</proxy.port> </properties> <profiles> <profile> <id>profile-1</id> <properties> <application.url>${application.url}</application.url> <use.proxy>false</use.proxy> <proxy.host></proxy.host> </properties> </profile> <profile> <id>profile-2</id> <properties> <application.url>${application.url}</application.url> <use.proxy>false</use.proxy> <proxy.host></proxy.host> </properties> </profile> </profiles> <!-- Declare the dependencies to your project here --> <dependencies> <dependency> <groupid>com.oracle</groupId> <artifactid>ojdbc6</artifactId> <version>11.2.0.4.0</version> </dependency> <dependency> <groupid>com.nuodb.jdbc</groupId> <artifactid>nuodb-jdbc</artifactId> <version>2.3.1</version> </dependency> <!-- One can also define custom dependency as below --> <dependency> <groupid>com.myOrg</groupId> <artifactid>linux</artifactId> <version>1.0</version> <scope>system</scope> <systempath>${project.basedir}/../dependencies/Linux.jar</systemPath> </dependency> </dependencies> <pluginrepositories> <pluginrepository> <id>smartbear-sweden-plugin-repository</id> <url>http://www.soapui.org/repository/maven2/</url> </pluginRepository> </pluginRepositories> <build> <plugins> <plugin> <groupid>com.smartbear.soapui</groupId> <artifactid>soapui-maven-plugin</artifactId> <version>5.2.1</version> <executions> <execution> <id>Project-1</id> <phase>test</phase> <goals> <goal>test</goal> </goals> <configuration> <projectfile>Project-1/Soap-Project-file.xml</projectFile> <outputfolder>${project.basedir}/target-result</outputFolder> <junitreport>true</junitReport> <exportall>true</exportAll> <testfailignore>true</testFailIgnore> <!-- You can define custom properties at project level which are or can be used in SoapUI project. For example URL of the application or some variable --> <projectproperties> <value>variable1=value1</value> <value>variable2=value2</value> <value>variablen=valuen</value> </projectProperties> </configuration> </execution> </executions> <dependencies> <dependency> <groupid>com.oracle</groupId> <artifactid>ojdbc6</artifactId> <version>11.2.0.4.0</version> </dependency> <dependency> <groupid>com.nuodb.jdbc</groupId> <artifactid>nuodb-jdbc</artifactId> <version>2.3.1</version> </dependency> </dependencies> </plugin> </plugins> </build> </project>

You can configure additional details for the project execution by further addition following parameters

• projectFile : Specified the name of the SoapUI project file to use, default value is ${pom.artifactId}-soapui-project.xml
• testSuite : Specifies the name of the TestSuite to run
• testCase : Specifies the name of the TestCase to run
• endpoint : Overrides the service endpoint to be invoked by any TestRequests
• host : Overrides the target host:port to be invoked by any TestRequests
• username : Overrides the username used by any TestRequests run
• password : Overrides the password used by any TestRequests run
• domain : Overrides the domain used by any TestRequests run
• printReport : Controls if a small test report should be printed to the console (true/false)
• outputFolder : Set which folder results/reports are saved to
• junitReport : Turns on creation of JUnit-reports, (true/false)
• exportAll : Controls if all test requests should be exported (default only exports errors), (true/false)
• settingsFile : Specifies SoapUI settings file to use
• wssPasswordType : Specifies WSS password type
• project.password : Specifies password for encrypted project
• settingsFile.password : Specifies password for encrypted settings file
• globalProperties : Sets global properties
• projectProperties : Sets project properties
• saveAfterRun : Saves project file after run
• testFailIgnore : Ignore failed tests.
• reportFormat : Sets formats for created report. Pro only.
• reportName : Sets which report to create. Pro only.
• coverage : Sets the output to include Coverage HTML reports. Pro only.
• environment : Sets the active environment. Pro only.

You will have to replicate the above configuration for all the child projects. Child project names in the pom, the directory name and the name mentioned under the master pom file should be same. Once the pom configuration is done you can test your execution with below command.

 > mvn -U clean install

In case of integration of mock service you will have to do some minor modification in the phase and goal of the execution section. The execution should appear as below :


<executions> <execution> <id>mockProjectName</id> <phase>pre-integration-test</phase> <goals> <goal>mock</goal> </goals> <configuration> <projectfile>mockServices/SoapUI-mock-ProjectFile.xml</projectFile> <noblock>true</noBlock> <junitreport>true</junitReport> </configuration> </execution> </executions></text> 

 You can also define the following properties in order to customize your mock service on run time

• projectFile : Specified the name of the SoapUI project file to use, default value is ${pom.artifactId}-soapui-project.xml
• mockService : Specified the MockService to run
• port : The local port to listen on, overrides the port configured for the MockService
• path : The local path to listen on, overrides the path configured for the MockService
• noBlock : Turns off blocking when MockRunner has started
• settingsFile : Specifies SoapUI settings file to use, will contain path to integrated tool to run
• project.password : Specifies password for encrypted project file
• settingsFile.password : Specifies password for encrypted soapui settings file
• saveAfterRun : Saves project file after run.

For more details following links can be referenced

https://www.soapui.org/test-automation/maven/maven-2-x.html

http://blog.karit.geek.nz/2009/08/using-soapui-to-do-testing-as-part-of.html 

https://cduu.wordpress.com/2012/10/17/execute-specific-maven-goal-using-profiles/