How to Use SoapUI Integrated with Maven for Automation Testing

SoapUI is a popular open-source tool used for testing SOAP and REST APIs. It comes with a user-friendly interface and a variety of features to help you test API requests and responses. In this article, we will explore how to use SoapUI integrated with Maven for automation testing.

Why Use SoapUI with Maven?

Maven is a popular build automation tool that simplifies building and managing Java projects. It is widely used in the industry, and it has many features that make it an ideal choice for automation testing with SoapUI.

By integrating SoapUI with Maven, you can easily run your SoapUI tests as part of your Maven build process. This will help you to automate your testing process, reduce the time required to test your APIs, and ensure that your tests are always up-to-date.

Setting Up SoapUI and Maven

Before we can start using SoapUI with Maven, we must set up both tools on our system. First, download and install SoapUI from the official website. Once SoapUI is installed, we can proceed with installing Maven.

To install Maven, follow these steps:

1. Download the latest version of Maven from the official website.
2. Extract the downloaded file to a directory on your system.
3. Add the bin directory of the extracted folder to your system’s PATH environment variable.
4. Verify that Maven is installed by opening a terminal or command prompt and running the command mvn -version.
   

Creating a Maven Project for SoapUI Tests

Now that we have both SoapUI and Maven installed, we can create a Maven project for our SoapUI tests. To create a new Maven project, follow these steps:

1. Open a terminal or command prompt and navigate to the directory where you want to create your project.
2. Run the following command: mvn archetype:generate -DgroupId=com.example -DartifactId=my-soapui-project -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
3. This will create a new Maven project with the group ID com.example and the artifact ID my-soapui-project.
   

Adding SoapUI Tests to the Maven Project

Now that we have a Maven project, we can add our SoapUI tests to the project. To do this, follow these steps:

1. Create a new SoapUI project by opening SoapUI and selecting File > New SOAP Project.
2. Follow the prompts to create a new project, including specifying the WSDL file and endpoint for your API.
3. Once your project is created, create a new test suite and add your test cases.
4. Save your SoapUI project.
   

Next, we need to add our SoapUI project to our Maven project. To do this, follow these steps:

1. In your Maven project directory, create a new directory called src/test/resources.
2. Copy your SoapUI project file (.xml) to this directory.
3. In the pom.xml file of your Maven project, add the following code:
   

<build>
  <plugins>
    <plugin>
      <groupId>com.smartbear.soapui</groupId>
      <artifactId>soapui-maven-plugin</artifactId>
      <version>5.6.0</version>
      <configuration>
        <projectFile>${basedir}/src/test/resources/my-soapui-project.xml</projectFile>
        <outputFolder>${basedir}/target/surefire-reports</outputFolder>
        <junitReport>true</junitReport>
        <exportwAll>true</exportwAll>
      </configuration>
      <executions>
        <execution>
          <phase>test</phase>
          <goals>
            <goal>test</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

This code configures the SoapUI Maven plugin to run our SoapUI tests during the test phase of the Maven build process.

Creating Assertions in SoapUI Projects

Now that we have our SoapUI tests added to our Maven project, we can create assertions to validate the responses of our API calls. To create assertions in SoapUI, follow these steps:

1. Open your SoapUI project and navigate to the test case where you want to create an assertion.
2. Right-click on the step that you want to validate and select Add Assertion.
3. Choose the type of assertion that you want to create (e.g. Contains, XPath Match, Valid HTTP Status Codes, etc.).
4. Configure the assertion according to your needs.
5. Save your SoapUI project.
   

Running SoapUI Tests with Assertions Using Maven

Now that we have our SoapUI tests and assertions added to our Maven project, we can run them using Maven. To run your SoapUI tests with Maven and validate the responses using assertions, follow these steps:

1. Open a terminal or command prompt and navigate to your Maven project directory.
2. Run the following command: mvn clean test
3. This will run your SoapUI tests and generate a report in the target/surefire-reports directory of your Maven project.
   

During the test execution, if any assertion fails, the test will fail and an error message will be displayed in the console. By creating assertions, we can ensure that our API calls are returning the expected responses.

Conclusion

In this article, we have learned how to use SoapUI integrated with Maven for automation testing, including how to create assertions in SoapUI projects. By using these two tools together, we can automate our testing process, reduce the time required to test our APIs, and ensure that our tests are always up-to-date. If you are looking to get started with automation testing using SoapUI and Maven, give this tutorial a try!