https://github.com/guidewire-oss/fern-junit-gradle-plugin
Gradle plugin to upload JUnit test files to a Fern test reporting server
https://github.com/guidewire-oss/fern-junit-gradle-plugin
fern gradle gradle-plugin groovy java junit jvm kotlin reporter test-reporter testing testing-tools
Last synced: 2 months ago
JSON representation
Gradle plugin to upload JUnit test files to a Fern test reporting server
- Host: GitHub
- URL: https://github.com/guidewire-oss/fern-junit-gradle-plugin
- Owner: guidewire-oss
- License: apache-2.0
- Created: 2025-03-24T18:41:27.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-04-04T19:28:16.000Z (2 months ago)
- Last Synced: 2025-04-04T19:49:55.891Z (2 months ago)
- Topics: fern, gradle, gradle-plugin, groovy, java, junit, jvm, kotlin, reporter, test-reporter, testing, testing-tools
- Language: Kotlin
- Homepage:
- Size: 90.8 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fern JUnit Gradle Plugin
A Gradle plugin for publishing JUnit test results to a Fern test reporting instance.
## Overview
This plugin simplifies the process of collecting JUnit XML test reports and publishing them to a Fern test reporting service. It parses JUnit XML reports, converts them to Fern's data model, and sends them to your Fern instance through its API.
To learn more about Fern, check out [its repository](https://github.com/guidewire-oss/fern-reporter)
## Features
- Parse JUnit XML test reports in various formats
- Group test suites and test cases into a cohesive test run
- Track test execution time and status
- Support for test tags
- Configurable verbosity for debugging
## Installation
Add the plugin to your `build.gradle.kts` file:
```kotlin
plugins {
id("com.guidewire.fern-publisher") version "1.0.0"
}
```
Or in `build.gradle`:
```groovy
plugins {
id 'com.guidewire.fern-publisher' version '1.0.0'
}
```
## Configuration
Configure the plugin in your build script:
```kotlin
fernPublisher {
fernUrl.set("https://your-fern-instance.example.com")
projectName.set("my-project")
reportPaths.set(listOf("build/test-results/**/*.xml"))
fernTags.set(listOf("automated", "integration"))
verbose.set(false)
}
```
### Parameters
| Property | Description | Required | Default |
|-------------|----------------------------------------------|----------|------------|
| fernUrl | URL of your Fern instance | Yes | - |
| projectName | Name of your project in Fern | Yes | - |
| reportPaths | Glob patterns for locating JUnit XML reports | Yes | - |
| fernTags | Tags to apply to all tests | No | empty list |
| verbose | Enable verbose logging | No | false |
## Usage
Run the task to publish test results:
```
./gradlew publishToFern
```
You can also make it run automatically after your tests:
```kotlin
tasks.named("test") {
finalizedBy("publishToFern")
}
```
## Examples
### Basic Configuration
```kotlin
fernPublisher {
fernUrl.set("https://fern.example.com")
projectName.set("backend-api")
reportPaths.set(listOf("build/test-results/**/*.xml"))
}
```
### Multiple Report Sources
```kotlin
fernPublisher {
fernUrl.set("https://fern.example.com")
projectName.set("full-stack")
reportPaths.set(
listOf(
"${project.buildDir}/test-results/test/**/*.xml",
"frontend/build/test-results/*.xml"
)
)
fernTags.set(listOf("ci", "nightly"))
}
```
## Compatibility
- Gradle 6.1 or later
- Kotlin 1.4 or later
- JUnit 4 and JUnit 5 XML report formats
## Building from Source
```bash
git clone https://github.com/your-org/fern-junit-publisher.git
cd fern-junit-publisher
./gradlew build
```
## Development
You can build and publish this plugin for use locally with the command
```bash
./gradlew publishToMavenLocal
```
You should see the plugin in your local `.m2` repository.
From there you can set up a test project to use the plugin. Make sure to edit your `settings.gradle` file to use plugins
found in your local m2 repository.
```gradle
pluginManagement {
repositories {
mavenLocal()
mavenCentral()
}
}
```