https://github.com/jamf/testrail-reporting
Easily send results of your tests to Test Rail.
https://github.com/jamf/testrail-reporting
jamf java junit spock testng testrail testrail-reporting
Last synced: 11 months ago
JSON representation
Easily send results of your tests to Test Rail.
- Host: GitHub
- URL: https://github.com/jamf/testrail-reporting
- Owner: jamf
- License: mit
- Created: 2019-03-22T07:23:51.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-11-30T09:00:53.000Z (over 3 years ago)
- Last Synced: 2024-05-02T02:55:39.181Z (about 2 years ago)
- Topics: jamf, java, junit, spock, testng, testrail, testrail-reporting
- Language: Groovy
- Homepage:
- Size: 186 KB
- Stars: 3
- Watchers: 10
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Overview
Testrail-reporting is a library that provides a common and simplified way of sending results to [TestRail](https://www.gurock.com/testrail).
The library "attaches" itself on post-test actions and gathers results from tests. At the end of suite results are sent to TestRail.
Tests are matched with test cases by name, both tests and sections will be created if don't already exist.
Test case format includes FQCN as well as method name and also parameter if needed. Case names can look like:
- `com.jamf.reporting.VerifySpockListener[success]`
- `com.jamf.reporting.VerifySpockListener[parameterised (1 ?? 1)]`
- `VerifyTestNGListener[parameterised:param1]`
- `VerifyJUnitListener[parameterised:[1] param 1]`
General pattern is: `FQCN[methodName:parameter]`, there are two exceptions:
- Spock parameterised test method name already provides params, so we actually can't use colon as a delimiter
- JUnit parameterised test does not deliver "user friendly" information about parameters, so we have to use `[paramIndex] parameter` format instead
# Contributing
In order to contribute to this project, please read carefully [CONTRIBUTING.md](./CONTRIBUTING.md) first.
# Checkstyle
To scan main sources:
```bash
./gradlew checkstyleMain
```
To scan test sources:
```bash
./gradlew checkstyleTest
```
# Building
```bash
./gradlew build
```
# Deploying to local .m2
```bash
./gradlew publishToMavenLocal
```
or, if you'd like to publish it with custom version
```bash
./gradlew clean build -PcurrentVersion=XXX publishToMavenLocal
```
# Testing
```bash
./gradlew test
```
# Using
## Setup
- add repository from which library should be pulled ([MORE INFO](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#using-a-published-package))
```groovy
repositories {
maven {
url = uri("https://maven.pkg.github.com/jamf/testrail-reporting")
credentials {
username = XXX #github username
password = YYY #github token with ability to pull packages
}
}
}
```
- add gradle dependency, targeting test runner you use
```groovy
testCompile('com.jamf.reporting:junit:1.0.0')
```
- add `@ReportResults` annotation
```java
# Spock example
@ReportSpockResults
class BaseATSpec extends Specification { ...
}
# JUnit5 example
@ReportJUnitResults
public class BaseAT { ...
}
# TestNG example
@Listeners(value = {TestNGTestRunListener.class, TestNGTestSuiteListener.class})
public class BaseAT { ...
}
```
## configuration
## testRail.properties
You can use dedicated properties file to configure where test results should be reported.
Put `testRail.properties` in `test/resources`, and specify below configuration.
```properties
testrail.url=#url to testrail REST api ex: https://sometestrailserver.com/testrail
testrail.username=#username used to report results
testrail.password=#password used to report results
testrail.projectId=#under which results will be saved
testrail.sectionId=#where tests will be created (used interchangeably with testrail.section_name)
testrail.section_name=#where tests will be created (used interchangeably with testrail.sectionId)
testrail.suiteId=suiteId in case your testrail project uses multiple suites setup (used interchangeably with testrail.suite_name)
testrail.suite_name=suiteId in case your testrail project uses multiple suites setup (used interchangeably with testrail.suiteID)
testrail.send=#should results be sent or not
testrail.run_name=#what should the test run be named, this parameter is required if testrail.send is true
testrail.run_description=#optional description that should be added to test run
```
All above properties can be set as system properties instead.
# Known limitations
Not all features ara available for all test frameworks.
- TestNG does not allow for wrapping it's `@Listeners` annotation with custom one, that's why native one has to be used
- JUnit 5 does not invoke any callbacks for `@Disabled` (skipped) tests, which means, results for such tests won't be gathered and published
- In order to workaround this issue use custom [`@Disabled`](./src/main/java/com/jamf/reporting/junit/Disabled.java) annotation.