https://github.com/reportportal/agent-java-karate
Karate integration for ReportPortal
https://github.com/reportportal/agent-java-karate
java karate karate-framework karate-tests reportportal test-automation testing testing-framework testing-tools tests
Last synced: 3 months ago
JSON representation
Karate integration for ReportPortal
- Host: GitHub
- URL: https://github.com/reportportal/agent-java-karate
- Owner: reportportal
- License: apache-2.0
- Created: 2019-04-17T10:59:32.000Z (about 7 years ago)
- Default Branch: develop
- Last Pushed: 2026-03-16T21:07:10.000Z (3 months ago)
- Last Synced: 2026-03-17T03:21:54.059Z (3 months ago)
- Topics: java, karate, karate-framework, karate-tests, reportportal, test-automation, testing, testing-framework, testing-tools, tests
- Language: Java
- Homepage:
- Size: 4.7 MB
- Stars: 9
- Watchers: 9
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ReportPortal runtime Hook for Karate tests
Karate reporters which uploads the results to a ReportPortal server.
> **DISCLAIMER**: We use Google Analytics for sending anonymous usage information such as agent's and client's names, and their versions
> after a successful launch start. This information might help us to improve both ReportPortal backend and client sides. It is used by the
> ReportPortal team only and is not supposed for sharing with 3rd parties.
[](https://central.sonatype.com/artifact/com.epam.reportportal/agent-java-karate)
[](https://github.com/reportportal/agent-java-karate/actions/workflows/ci.yml)
[](https://codecov.io/github/reportportal/agent-java-karate)
[](https://slack.epmrpp.reportportal.io/)
[](http://stackoverflow.com/questions/tagged/reportportal)
[](http://reportportal.io?style=flat)
The latest version: 5.3.6. Please use `Maven Central` link above to get the agent.
## Overview: How to Add ReportPortal Logging to Your Project
To start using ReportPortal with Karate framework please do the following steps:
1. [Configuration](#configuration)
* Create/update the `reportportal.properties` configuration file
* Build system configuration
* Add Listener
* Runtime
* Post-running
2. [Logging configuration](#logging)
* Loggers and their types
3. [Running tests](#running-tests)
* Build system commands
## Configuration
### 'reportportal.properties' configuration file
As the first step you need to create a file named `reportportal.properties` in your Java project in a source
folder `src/main/resources` or `src/test/resources` (depending on where your tests are located):
**reportportal.properties**
```
rp.endpoint = http://localhost:8080
rp.api.key = test_YIvQraKKSquDZqrA6JLCWCX5qwmMZBk_7tTm_fkN44AHCi18Ze0RtYqxWNYKxk5p
rp.launch = Karate Tests
rp.project = default_personal
```
**Property description**
* `rp.endpoint` - the URL for the ReportPortal server (actual link).
* `rp.api.key` - an access token for ReportPortal which is used for user identification. It can be found on your report
portal user profile page.
* `rp.project` - a project ID on which the agent will report test launches. Must be set to one of your assigned
projects.
* `rp.launch` - a user-selected identifier of test launches.
The full list of supported properties is located here in client-java library documentation (a common library for all
Java agents): https://github.com/reportportal/client-java
## Build system configuration
### Maven
If your project is Maven-based you need to add dependencies to `pom.xml` file:
```xml
com.epam.reportportal
agent-java-karate
5.3.6
test
```
You are free to use you own version of Karate, but not earlier than 1.0.0. If you leave just Agent dependency it will
be still OK, it will use transitive Karate version.
### Gradle
For Gradle-based projects please update dependencies section in `build.gradle` file:
```groovy
dependencies {
testImplementation 'com.epam.reportportal:agent-java-karate:5.3.6'
}
```
## Listener configuration
### Runtime
Runtime publisher uploads Karate tests on ReportPortal during the test execution, providing real-time monitoring capabilities. To publish
test results in this case, the test project should use by `ReportPortalHook` class, an instance of which you should pass to Karate runner.
E.G.:
```java
import com.epam.reportportal.karate.ReportPortalHook;
import com.intuit.karate.Results;
import com.intuit.karate.Runner;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
class ScenarioRunnerTest {
@Test
void testParallel() {
ReportPortalHook karateRuntimeHook = new ReportPortalHook(); // Initialize ReportPortal runtime Karate hook
Results results = Runner // Regular Karate runner
.path("classpath:features") // Path with feature files
.hook(karateRuntimeHook) // Add Karate hook
.outputCucumberJson(true) // Generate cucumber report
.tags("~@ignore") // Ignore tests marked with the tag
.parallel(2); // Run in 2 Threads
// Here you can additionally run tests, retries, etc.
karateRuntimeHook.finishLaunch(); // Finish execution on ReportPortal
Assertions.assertEquals(0, results.getFailCount(), "Non-zero fail count.\n Errors:\n" + results.getErrorMessages());
}
}
```
### Post-running
Post-running publisher uploads Karate tests on ReportPortal after the test execution. It uses Karate result object to get data about tests.
It might be useful if your tests make heavy load both on ReportPortal server or on the running node. To publish test results in this case,
the test project should run by `KarateReportPortalRunner` instead of Karate runner.
E.G.:
```java
import com.epam.reportportal.karate.KarateReportPortalRunner;
import com.intuit.karate.Results;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
public class KarateRunnerTest {
@Test
public void testAll() {
Results results = KarateReportPortalRunner // Our runner with a Karate Publisher
.path("classpath:features") // Path with feature files
.outputCucumberJson(true) // Generate cucumber report
.tags("~@ignore") // Ignore tests marked with the tag
.parallel(2); // Run in 2 Threads
Assertions.assertEquals(0, results.getFailCount(), "Non-zero fail count.\n Errors:\n" + results.getErrorMessages());
}
}
```
## Logging
Karate uses `slf4j` as Logging library, so you are free to choose any Logging Framework.
ReportPortal provides its own logger implementations for major logging frameworks like *Log4j* and *Logback*. It also
provides additional formatting features for popular client and test libraries like: *Selenide*, *Apache HttpComponents*,
*Rest Assured*, etc.
Here is the list of supported loggers and setup documentation links.
**Logging frameworks:**
| **Library name** | **Documentation link** |
|------------------|-----------------------------------------------------|
| Log4j | https://github.com/reportportal/logger-java-log4j |
| Logback | https://github.com/reportportal/logger-java-logback |
**HTTP clients:**
| **Library name** | **Documentation link** |
|-----------------------|------------------------------------------------------------|
| OkHttp3 | https://github.com/reportportal/logger-java-okhttp3 |
| Apache HttpComponents | https://github.com/reportportal/logger-java-httpcomponents |
## Running tests
We are set. To run tests we just need to execute corresponding command in our build system.
#### Maven
`mvn test` or `mvnw test` if you are using Maven wrapper
#### Gradle
`gradle test` or `gradlew test` if you are using Gradle wrapper