 | This section concerns only the latest version of the plugin. You are welcome to download it directly from public TeamCity server. |
General Info
| Vendor | JetBrains |
| License | Apache 2.0 |
| Type | free, open-source |
| XML Test Reporting Plugin was bundled with TeamCity 4.5. |
Plugin Description
Plugin adds support for reporting tests in TeamCity from JUnit Ant task XML reports, Maven Surefire XML reports, NUnit-Console XML reports. Plugin also supports reporting code inspections from FindBugs, PMD and Checkstyle (Since 5.1) XML reports.
Plugin Development Status
Production quality.
TeamCity Versions Compatibility
The current plugin version is designed to work with TeamCity 4.5.1 and later.
Download
Directly from public TeamCity server: last nightly build
Documentation
Installation instructions
TeamCity versions 4.x
- Put xml-report-plugin.zip into <TeamCity Data Directory>/plugins folder.
- Restart the server.
Plugin usage
The plugin can be used with Ant, Command Line, Ipr, Maven2, MSBuild, NAnt, Rake, sln2003, sln2005, sln2008 runners. For some runners the plugin adds "XML Report Processing" UI options. The plugin can be used with any runner with the help of the service message.
Plugin monitors the specified reports paths and when the matching files are detected, they are parsed according to the report type specified. The results are then sent to the TeamCity server. When possible, parsing of partly written files is supported, so the reporting is started as soon as first data is avaialble and more data is reported as it is written to the report files.
The plugin considers only the files updated since the build start (this is determined by last modification file timestamp).
Сonfiguring plugin via UI options
The plugin adds its configuration settings panel to the runner settings page: choose report type and specify paths to reports, separating them by comma or new line. Support ant-style wildcards like dir/*/.zip. To ensure monitoring swiftness specify more concrete paths.
Check Verbose output option to enable detailed logging to build log.
For FindBugs report processing it is necessary to specify path to FindBugs installation on agent. It will be used for retrieving actual bug patterns, categories and their messages.
For FindBugs, PMD and Checkstyle code inspections reports processing you can specify maximum errors and warnings limits, exceeding which will cause the build failure. Leave these fields blank, if there are no limits.
To exclude some paths from parsing - use xmlReportParsing.exclude system property. It should contain new line or comma separated absolute or checkout directory relative paths or ant-style masks.
Service messages support
| This section describes the current plugin features. If you cannot make a feature work please update the plugin to the most recent version available as the first step. |
You can send a service message ##teamcity[importData type='sometype' path='somepath'] to initiate the plugin watching somepath directory for reports or parse somepath file. Supported reportType attribute values are:
- junit for JUnit Ant task XML reports
- surefire for Maven Surefire XML reports
- nunit for NUnit-Console XML reports
- findBugs for FindBugs inspections XML reports
- pmd for PMD inspections XML reports
- checkstyle for Checkstyle inspections XML reports
For FindBugs reports type there must be a findBugsHome attribute specified.
To enable detailed logging into the build log, add verbose='true' parameter to the service message.
To parse all the files and not only those updated during the build (is determined by last modification timestamp), add the following parameter to the message: parseOutOfDate='true'.
To specify errors and warnings limits for FindBugs, PMD or Checkstyle reports processing add errorLimit and warningLimit attributes.
To initiate monitoring several directories or parse several types of the report, send the corresponding service messages one after another.
Feedback/Support
If you believe you've faced a bug: Issue Tracker (project: TeamCity)
If you want to ask a question or discuss: Forum
Development links
Sources in JetBrains Subversion repository.
Builds at JetBrains public TeamCity instance.
Related Materials
Issue in TeamCity tracker.