Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/testmonitor/testng-listener
This TestNG listener can be used to report the results for your test cases in TestMonitor.
https://github.com/testmonitor/testng-listener
java selenium testmonitor testng
Last synced: 2 days ago
JSON representation
This TestNG listener can be used to report the results for your test cases in TestMonitor.
- Host: GitHub
- URL: https://github.com/testmonitor/testng-listener
- Owner: testmonitor
- License: mit
- Created: 2021-12-01T11:13:02.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-02T17:23:18.000Z (11 months ago)
- Last Synced: 2024-09-20T00:35:37.613Z (7 days ago)
- Topics: java, selenium, testmonitor, testng
- Language: Java
- Homepage:
- Size: 32.2 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# TestMonitor TestNG Listener
This TestNG listener can be used to report the results for your test cases in [TestMonitor](https://www.testmonitor.com). Additionally,
by implementing the `HasWebdriver` interface, Selenium test results will be annotated with a screenshot when test cases fail.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## Installation
Before you start, make sure you have a [recent Java SDK](https://www.oracle.com/java/technologies/downloads/) installed.
### Maven Installation
We recommend installing the TestNG listener in your Java project using Maven. Add it as a dependency to your Maven configuration:
```xml
com.testmonitor
testng-listener
1.0
```
### Manual Installation
If you prefer a standalone JAR library, checkout this repository and run Maven to compile the sources and generate a JAR file:
```sh
$ git checkout https://github.com/testmonitor/testng-listener.git
$ cd testng-listener
$ mvn package
```
Your JAR file will be available in the `target` directory.
## Usage
Start with adding the listener to listeners section in your test suite XML:
```xml
```
Next, create a `testmonitor.properties` file in your project directory and add this configuration (change the values according to your preferences):
```properties
TESTMONITOR_DOMAIN=mydomain.testmonitor.com
TESTMONITOR_TOKEN=itsatoken
TESTMONITOR_PROJECT_ID=1
TESTMONITOR_MILESTONE_ID=1
TESTMONITOR_TEST_RUN_PREFIX=AT
```
In case you are using the Selenium framework, you can optionally implement the `HasWebdriver` in your test cases. This exposes the web driver to the listener, allowing it to take a screenshot if your test case has failed.
Here is an example:
```java
public class MyTestCase implements HasWebdriver {
protected WebDriver driver;
@BeforeMethod(alwaysRun = true)
private void setUp() {
System.setProperty("webdriver.chrome.driver", "/usr/local/bin/chromedriver");
this.driver = new ChromeDriver();
}
@Test
public void myTest() {
this.driver.get("https://www.testmonitor.com/");
}
public WebDriver getDriver() {
return this.driver;
}
}
```
## Contributing
Refer to [CONTRIBUTING](CONTRIBUTING.md) for contributing details.
## Credits
* **Thijs Kok** - *Lead developer* - [ThijsKok](https://github.com/thijskok)
* **Stephan Grootveld** - *Developer* - [Stefanius](https://github.com/stefanius)
* **Muriel Nooder** - *Developer* - [ThaNoodle](https://github.com/thanoodle)
## License
The MIT License (MIT). Refer to the [License](LICENSE.md) for more information.