  ------
  Introduction
  ------
  Allan Ramirez
  ------
  July 2006
  ------

~~ Copyright 2006 The Apache Software Foundation.
~~
~~ Licensed under the Apache License, Version 2.0 (the "License");
~~ you may not use this file except in compliance with the License.
~~ You may obtain a copy of the License at
~~
~~      http://www.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing, software
~~ distributed under the License is distributed on an "AS IS" BASIS,
~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~~ See the License for the specific language governing permissions and
~~ limitations under the License.

~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html

Maven Surefire Report Plugin

  The Surefire Report Plugin parses the generated <<<TEST-*.xml>>> files under
  <<<$\{basedir\}/target/surefire-reports>>> and renders them using DOXIA,
  which creates the web interface version of the test results.

*---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
||Roadmap                                     ||Release Targets                                                                                                                                                              \ |
*---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                                             | Maven API 3.0 and Java 1.7                                                                                                                                                   \ |
|                                             |                                                                                                                                                                              \ |
| 3.0.0-M1                                    | {{{https://issues.apache.org/jira/browse/SUREFIRE-1493}Maven Plugin API 3.0}}                                                                                                \ |
|                                             | {{{https://issues.apache.org/jira/browse/SUREFIRE-1474}Java 1.7 as minimum}}                                                                                                 \ |
|                                             | {{{https://issues.apache.org/jira/projects/SUREFIRE/versions/12342871}See the Release Notes for the version 3.0.0-M1}}                                                       \ |
*---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|                                             | Fixed JDK9 and Windows Class-Path issues, 3.0 and Legacy Report XSD, 3.0.0-M2 shadefire                                                                                      \ |
|                                             |                                                                                                                                                                              \ |
| 3.0.0-M2                                    | {{{https://issues.apache.org/jira/browse/SUREFIRE-1590}3.0 and Legacy Report XSD}}                                                                                           \ |
|                                             | {{{https://issues.apache.org/jira/browse/SUREFIRE-1600}3.0.0-M2 shadefire}}                                                                                                  \ |
|                                             | {{{https://issues.apache.org/jira/projects/SUREFIRE/versions/12344396}See the Release Notes for the version 3.0.0-M2}}                                                       \ |
*---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 3.0.0-M3                                    | New interprocess communication and TCP/IP which fixes current blocker and critical bugs. Support of Java 11.                                                                 \ |
*---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 3.0.0-M4                                    |                                                                                                                                                                              \ |
*---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 3.0.0-M5                                    | Breaking backwards compatibility with system properties in configuration parameters, removing deprecated configuration parameters and removing deprecated code, etc.         \ |
*---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 3.0.0-M6                                    | The plugin supports Java 1.8 and Maven Plugin API 3.2.5. Many bug fixes.                                                                                                     \ |
|                                             | {{{https://issues.apache.org/jira/issues/?jql=project%20%3D%20SUREFIRE%20AND%20fixVersion%20%3D%203.0.0-M6%20ORDER%20BY%20priority%20DESC%2C%20key}ASF Release versions}}    \ |
*---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 3.0.0-M7                                    | {{{https://issues.apache.org/jira/issues/?jql=project%20%3D%20SUREFIRE%20AND%20fixVersion%20%3D%203.0.0-M7%20ORDER%20BY%20priority%20DESC%2C%20key}ASF Release versions}}    \ |
*---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 3.0.0                                       | {{{https://issues.apache.org/jira/issues/?jql=project%20%3D%20SUREFIRE%20AND%20fixVersion%20%3D%203.0%20ORDER%20BY%20priority%20DESC%2C%20key}ASF Release versions}}         \ |
*---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

* Upcoming Incompatibility Notice

  With a future minor version several mojos and output filenames will change for alignment with other
  reporting plugins from <<<org.apache.maven.plugins>>>.
  To make you aware of that, see the following table for the upcoming changes:

*------------------------------*--------------------------*-----------------------*-----------------*
|| Mojo Class Name            || New Mojo Class Name     || Output name          || New Output Name |
*------------------------------+--------------------------+-----------------------+-----------------+
| <<<FailsafeReportMojo>>>     | <<<FailsafeOnlyReport>>> | <<<failsafe-report>>> | <<<failsafe>>>  |
*------------------------------+--------------------------+-----------------------+-----------------+
| <<<SurefireReportMojo>>>     | <<<SurefireReport>>>     | <<<suresafe-report>>> | <<<surefire>>>  |
*------------------------------+--------------------------+-----------------------+-----------------+
| <<<SurefireReportOnlyMojo>>> | <<<SurefireOnlyReport>>> | <<<suresafe-report>>> | <<<surefire>>>  |
*------------------------------+--------------------------+-----------------------+-----------------+

  Details about this change can be found in {{{https://issues.apache.org/jira/browse/SUREFIRE-2161}SUREFIRE-2161}}.

* Goals Overview

  The Surefire Report Plugin has three goals:

  * {{{./report-mojo.html}surefire-report:report}} Generates the test
  results report into HTML format.

  * {{{./report-only-mojo.html}surefire-report:report-only}} This goal does
  not run the tests, it only builds the report. It is provided as a work
  around for {{{https://issues.apache.org/jira/browse/SUREFIRE-257}SUREFIRE-257}}

  * {{{./failsafe-report-only-mojo.html}surefire-report:failsafe-report-only}} This goal does not
  run the tests, it only builds the IT reports. See {{{https://issues.apache.org/jira/browse/SUREFIRE-257}SUREFIRE-257}}

  []

  <Note:> As of version 2.8 this plugin requires Maven Site Plugin 2.1 or newer to work properly. Version 2.7.2 and
  older are still compatible with newer Surefire versions, so mixing is possible.

* Usage

  General instructions on how to use the Surefire Report Plugin can be found on the {{{./usage.html}usage page}}. Some more
  specific use cases are described in the examples listed below. Additionally, users can contribute to the
  {{{https://github.com/apache/maven-surefire}GitHub project}}.

  In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel
  free to contact the {{{./mailing-lists.html}user mailing list}}. The posts to the mailing list are archived and could
  already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
  the {{{./mailing-lists.html}mail archive}}.

  If you feel like the plugin is missing a feature or has a defect, you can file a feature request or bug report in our
  {{{./issue-management.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
  concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
  entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
  Of course, patches are welcome, too. Contributors can check out the project from our
  {{{./scm.html}source repository}} and will find supplementary information in the
  {{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.

* Examples

  The following examples show how to use the Surefire Report Plugin in more advanced use cases:

  * {{{./examples/show-failures.html}Showing Only Failed Tests}}

  * {{{./examples/changing-report-name.html}Changing the Report Name}}

  * {{{./examples/report-custom-location.html}Configuring the Output Location of the Report}}

  * {{{./examples/cross-referencing.html}Source Code Cross Reference}}

  []
