Karate Test Runner Example: How to Write Automated Tests

Karate is a popular open-source framework that allows developers to automate functional, performance, and UI testing of API-based applications. It is an alternative to tools like Selenium, RestAssured, and JMeter. One of the key features of Karate is the TestRunner class. In this blog post, we’ll walk you through an example of how to use Karate Test Runner to write automated tests for your API-based applications.

What is Karate Test Runner?

Karate Test Runner is a Java-based test automation framework that uses the Cucumber syntax to write tests. It combines API testing, UI automation, and performance testing into one platform. Karate provides built-in features for mocking, parallel execution, and reporting along with an easy-to-use syntax. The Karate Test Runner also supports easy integration with Continuous Integration (CI) tools like Jenkins, Bamboo and many others.

Example of Karate Test Runner

To demonstrate how Karate Test Runner can be used to automate testing of API-based applications, let’s consider an example. Suppose we have an API-based application that allows users to retrieve data from a database. The application has methods for getting a single record and all records.

First, we define the Karate feature file. This file contains the scenarios and the step definition expressions. The step definition expressions define the actions that are to be taken and the expected results.

The feature file for this example could look like this:

Feature: Get data from a database

Scenario: Get all data from the database
Given url ‚http://localhost:8080/api/data‘
When method GET
Then status 200
And match response contains { „data“: „#[0].data“ }

Scenario: Get single record from the database
Given url ‚http://localhost:8080/api/data/1‘
When method GET
Then status 200
And match response contains { „id“: „1“, „data“: „#[0].data“ }

The next step is to define the Java class file that will run the Karate feature file. This class file is known as the Test Runner class. It loads the Karate feature file, runs the scenarios defined in the feature file, and generates the test reports.

The Java class file for this example could look like this:

import com.intuit.karate.junit4.Karate;
import org.junit.runner.RunWith;

public class DataTestRunner {

That’s it. We can run the test by simply running the Test Runner class file in any IDE or via a command-line interface.

Executing the tests and generating the reports

After running the Test Runner class file, the test reports are generated in the target folder of the project. The reports contain details on the number of tests run, the number of tests passed, and the number of tests failed.

The reports also include detailed logs of the test cases, failure reasons if any, and the response received from the API endpoint. With Karate, it’s easy to pinpoint the exact location of the failure and quickly identify the issue to resolve.

Frequently Asked Questions about Karate Test Runner Example

If you’re a developer, you’d know how important testing your code is. Tests help you ensure that your code works correctly and as intended. Karate is one tool you can consider to test your web services. It’s an open-source tool that uses Gherkin syntax (a human-readable language) to write tests. Here are some frequently asked questions about Karate Test Runner Example.

1. What is Karate Test Runner Example, and how does it work?

Karate Test Runner Example is an open-source tool for testing web services. You can use Karate to write automated tests that validate the functionality and behavior of your RESTful APIs. It’s built on top of the Cucumber testing framework and has a syntax that’s easy to read and write. One of the unique features of Karate is that it doesn’t require a setup or tear down, which means it has zero boilerplate code.

To use Karate, you download the Karate JAR file from the internet and add it as a dependency to your project. You can then write your tests using Karate’s syntax, which is similar to Gherkin. The tests are run through the Karate Test Runner, which executes the tests and generates a report.

2. What benefits does Karate offer for testing compared to other tools?

One of the significant benefits of using Karate is that it’s easy to learn and use. You don’t need to have prior experience in writing tests or using other testing frameworks to get started with Karate. The tests are written in a human-readable language, which makes them easy to understand and maintain.

Another significant benefit of using Karate is its zero boilerplate code. You don’t need to set up any configurations or dependencies to start writing and executing tests. Karate comes with built-in support for HTTP, JSON, XML, and GraphQL, which means you can test any web service that uses any of these protocols.

3. How does Karate handle data-driven testing?

Karate supports data-driven testing, which means you can run the same test with different data inputs. You can use the Scenario Outline keyword in Karate to define a test scenario with placeholders for the data inputs. The data inputs are defined in a data table using the Examples keyword.

For example, let’s say you want to test whether your API returns the correct response for a given set of input parameters. You can define a Scenario Outline that takes two input parameters, performs an API call, and validates the response.

Scenario Outline: Test API with different inputs
Given url ‚http://myapi.com‘
When request ,
Then status 200
And response

| input1 | input2 | expectedResponse |
| 1 | 2 | „Success“ |
| 10 | 20 | „Error“ |

When you run this test, Karate will execute the Scenario Outline twice with the input values from the data table. It will replace the placeholders with the data inputs, perform the API call, and validate the response.

4. How can I integrate Karate with my CI/CD pipeline?

Karate Test Runner can be integrated into your continuous integration and delivery pipeline. You can use Maven or Gradle build tools to automate the execution of your tests.

For example, let’s say you have a Maven project and want to run the Karate tests as part of your build process. You can add the following plugin configuration to your pom.xml file:

„` com.intuit.karate



When you run the Maven build command, it will automatically execute the Karate tests and generate a report. You can configure your CI/CD tool to run the Maven build command as part of the build process.

5. What reporting features does Karate offer?

Karate generates a detailed HTML report that shows you the test results, including the status and response of each test. The report also includes a breakdown of the scenarios and steps, which makes it easy to locate any issues in your tests.

Additionally, Karate provides built-in support for Cucumber reports, which means you can generate reports in JSON, HTML, or JUnit XML formats. You can use these reports to integrate your tests with your existing reporting tools or to display your test results on a web page.

Karate Test Runner Example: A Complete Guide

Karate is an open-source testing tool that allows you to automate API tests, from RESTful APIs to SOAP web services. With Karate, you write test scripts using simple Gherkin syntax, including Given-When-Then statements.

In this blog post, we will walk you through a complete example of how to use Karate to run tests on a RESTful API.

Step 1: Install Karate

Before you can get started with Karate, you will need to install it. You can do this by downloading the latest version of Karate from the official Karate website, or by using a package manager such as Maven or Gradle.

For this example, we will be using Maven. To install Karate using Maven, add the following dependency to your pom.xml file:


Step 2: Create Your Test Script

Once you have Karate installed, you can create your test script. For this example, we will be testing a RESTful API that returns a list of books.

Feature: Get All Books
Scenario: Get All Books
Given url 'http://localhost:8080/books'
When method GET
Then status 200
And match response contains { books: '#[0].title' }

In this script, we first define the feature and scenario names. We then use the Given statement to specify the URL of our API endpoint. We use the When statement to define the HTTP method (GET) to use to call the API. Finally, we use the Then statement to verify that the API returns a 200 status code and that the response contains at least one book with a title.

Step 3: Run Your Test Script

Now that you have your test script, you can run it using the Karate test runner. To do this, you can use the following command:

mvn test -Dtest=com.example.test.TestRunner

In this command, we are using Maven to run our test script located in com/example/test/TestRunner.java.

Step 4: View Your Test Results

After running your test script, you can view the results in the console output. If your tests passed, you should see something like the following:

[INFO] -------------------------------------------------------
[INFO] -------------------------------------------------------
[INFO] Running com.example.test.TestRunner
21:06:22.990 [main] INFO com.intuit.karate.Runner - Karate version: 0.9.6
21:06:23.223 [main] INFO com.intuit.karate.Runner - karate.env system property was: null
21:06:23.528 [main] DEBUG com.intuit.karate.Runner - <> http://localhost:8080/books
21:06:23.573 [main] DEBUG com.intuit.karate.Runner - response time in milliseconds: 41
21:06:23.574 [main] DEBUG com.intuit.karate.Runner - response <<<<<<<<<<<<<<<<<<<<
[ {
"id" : 1,
"title" : "The Great Gatsby",
"author" : "F. Scott Fitzgerald",
"year" : 1925
} ]
21:06:23.576 [main] INFO com.intuit.karate.Runner - waiting for parallel tests to complete ...
21:06:23.578 [pool-1-thread-1] INFO com.intuit.karate.Runner - <> parallel runner done for scenario: com/example/test/test.feature:4 - Get All Books
21:06:23.578 [main] INFO com.intuit.karate.Runner - <> waiting for all background threads to complete ...
21:06:23.578 [main] INFO com.intuit.karate.Runner - <> all background threads complete
21:06:23.578 [main] INFO com.intuit.karate.Runner -
21:06:23.578 [main] INFO com.intuit.karate.Runner - -------------------------------------------------------
21:06:23.578 [main] INFO com.intuit.karate.Runner -
21:06:23.579 [main] INFO com.intuit.karate.Runner - test.feature:4 - Get All Books: <> http://localhost:8080/books [200] ... 25ms
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 2.867 s - in com.example.test.TestRunner
[INFO] Results:
[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

In this example, our tests passed, and we can see the steps that were executed, along with the status code of our API response and the response itself.

Step 5: Refine Your Test Script

Now that you have your tests running, you can refine your test script to verify additional functionality in your API. For example, you might want to test that users can add new books to the API, or that the API returns the correct response for invalid queries.


Karate is a simple yet powerful testing tool that allows you to create automated tests for RESTful APIs quickly. By following the steps in this guide, you should now have a good understanding of how to use Karate to test your RESTful APIs, from installing Karate to running your tests and viewing the results. By continuing to refine your test scripts, you can ensure that your APIs are functioning correctly and reliably.

Ähnliche Beiträge