Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move documentation from Wiki to GitHub #122

Merged
merged 3 commits into from Oct 23, 2019
Merged

Move documentation from Wiki to GitHub #122

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb673a9
Move documentation from Wiki to GitHub
oleg-nenashev Jul 25, 2019
df82fef
Use backticks
oleg-nenashev Jul 25, 2019
e837edd
Change URL to GitHub to enable publishing of Docs from GitHub
oleg-nenashev Sep 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
@@ -0,0 +1,31 @@
# JUnit Plugin for Jenkins

[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/junit.svg)](https://plugins.jenkins.io/junit)
[![GitHub release](https://img.shields.io/github/release/jenkinsci/junit-plugin.svg?label=release)](https://github.com/jenkinsci/junit-plugin/releases/latest)
[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/junit.svg?color=blue)](https://plugins.jenkins.io/junit)

The JUnit plugin provides a publisher that consumes XML test reports generated during the builds and provides some graphical visualization of the historical test results
(see [JUnit graph](https://wiki.jenkins.io/display/JENKINS/JUnit+graph) for a sample)
as well as a web UI for viewing test reports, tracking failures, and so on.
Jenkins understands the JUnit test report XML format (which is also used by TestNG).
When this option is configured, Jenkins can provide useful information about test results, such as trends.

The plugin also provides a generic API for other unit-test publisher plugins in Jenkins. This functionality was part of the Jenkins Core until it was split out to this plugin in version in 1.577.

## Configuration

The JUnit publisher is configured at the job level by adding a Publish JUnit test result report post build action. The configuration parameters include:

* **Test report XMLs:** Specify the path to JUnit XML files in the Ant glob syntax, such as **/build/test-reports/*.xml.
oleg-nenashev marked this conversation as resolved.
Show resolved Hide resolved
Be sure not to include any non-report files into this pattern.
You can specify multiple patterns of files separated by commas.
The base directory of the fileset is the workspace root.
* **Retain long standard output/error:** If checked, any standard output or error from a test suite will be retained in the test results after the build completes.
(This refers only to additional messages printed to console, not to a failure stack trace).
Such output is always kept if the test failed, but by default lengthy output from passing tests is truncated to save space.
Check this option if you need to see every log message from even passing tests, but beware that Jenkins's memory consumption can substantially increase as a result, even if you never look at the test results!
* **Health report amplification factor:** The amplification factor to apply to test failures when computing the test result contribution to the build health score.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this sort of detailed help is best left in help*.html files in the product. Will just go stale here. The online docs should focus on higher-level guidelines and suggestions.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... but this is just a port of the Wiki page, so fine for now.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, did not want to spend much time rewording. Subject for contributions

The default factor is 1.0. A factor of 0.0 will disable the test result contribution to build health score, and, as an example, a factor of 0.5 means that 10% of tests failing will score 95% health.
The factor is persisted with the build results, so changes will only be reflected in new builds.
* **Allow empty results:** If checked, the default behavior of failing a build on missing test result files or empty test results is changed to not affect the status of the build.
Please note that this setting make it harder to spot misconfigured jobs or build failures where the test tool does not exit with an error code when not producing test report files.