Repository: maven-surefire Updated Branches: refs/heads/master c8858944c -> 7a50aee24
http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/22eb7362/maven-surefire-report-plugin/src/site/apt/index.apt ---------------------------------------------------------------------- diff --git a/maven-surefire-report-plugin/src/site/apt/index.apt b/maven-surefire-report-plugin/src/site/apt/index.apt index 4630fbe..737c509 100644 --- a/maven-surefire-report-plugin/src/site/apt/index.apt +++ b/maven-surefire-report-plugin/src/site/apt/index.apt @@ -26,12 +26,12 @@ Maven Surefire Report Plugin The Surefire Report Plugin parses the generated <<<TEST-*.xml>>> files under - <<<$\{basedir\}/target/surefire-reports>>> and renders them to DOXIA + <<<$\{basedir\}/target/surefire-reports>>> and renders them using DOXIA, which creates the web interface version of the test results. * Goals Overview - Surefire Report Plugin only has one goal (the other is a workaround): + The Surefire Report Plugin only has one goal (the other is a workaround): * {{{./report-mojo.html}surefire-report:report}} Generates the test results report into HTML format. @@ -40,15 +40,15 @@ Maven Surefire Report Plugin not run the tests, it only builds the reports. It is provided as a work around for {{{http://jira.codehaus.org/browse/SUREFIRE-257}SUREFIRE-257}} - <Note:> As of version 2.8 this plugin requires Maven Site Plugin 2.1 or higher to work properly. Version 2.7.2 and - older are still compatible with newer surefire versions, so mixing is possible. - [] + <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 given below. Last but not least, users occasionally contribute + specific use cases are described in the examples listed below. Last but not least, users occasionally contribute additional examples, tips or errata to the {{{http://docs.codehaus.org/display/MAVENUSER/Surefire+Report+Plugin}plugin's wiki page}}. @@ -57,7 +57,7 @@ Maven Surefire Report Plugin already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the {{{./mail-lists.html}mail archive}}. - If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our + 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-tracking.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. @@ -67,11 +67,11 @@ Maven Surefire Report Plugin * Examples - The following examples show how to use the Surefire Report Plugin in more advanced usecases: + The following examples show how to use the Surefire Report Plugin in more advanced use cases: - * {{{./examples/show-failures.html}Showing Failure Tests}} + * {{{./examples/show-failures.html}Showing Only Failed Tests}} - * {{{./examples/changing-report-name.html}Changing Report Name}} + * {{{./examples/changing-report-name.html}Changing the Report Name}} * {{{./examples/report-custom-location.html}Configuring the Output Location of the Report}} http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/22eb7362/maven-surefire-report-plugin/src/site/apt/usage.apt.vm ---------------------------------------------------------------------- diff --git a/maven-surefire-report-plugin/src/site/apt/usage.apt.vm b/maven-surefire-report-plugin/src/site/apt/usage.apt.vm index ef71d13..d5af182 100644 --- a/maven-surefire-report-plugin/src/site/apt/usage.apt.vm +++ b/maven-surefire-report-plugin/src/site/apt/usage.apt.vm @@ -25,10 +25,10 @@ Usage -* Generate the report as part of Project Reports +* Generate the Report as Part of Project Reports To generate the Surefire report as part of the site generation, add the following in - the \<reporting\> section of your POM: + the <<<\<reporting\>>>> section of your POM: +---+ <project> @@ -46,14 +46,14 @@ Usage </project> +---+ - When the <<<mvn site>>> is invoked, the report will be automatically + When <<<mvn site>>> is invoked, the report will automatically be included in the Project Reports menu as shown in the figure below. [images/surefire-sample1.PNG] Sample Surefire Report -* Generate the report as standalone +* Generate the Report in a Standalone Fashion - The Surefire report can also generate the report using its standalone goal: + The plugin can also generate the report using its standalone goal: +---+ mvn surefire-report:report http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/22eb7362/maven-surefire-report-plugin/src/site/fml/faq.fml ---------------------------------------------------------------------- diff --git a/maven-surefire-report-plugin/src/site/fml/faq.fml b/maven-surefire-report-plugin/src/site/fml/faq.fml index 70305de..e461038 100644 --- a/maven-surefire-report-plugin/src/site/fml/faq.fml +++ b/maven-surefire-report-plugin/src/site/fml/faq.fml @@ -22,13 +22,12 @@ under the License. <faqs id="FAQ" title="Frequently Asked Questions"> <part id="General"> <faq id="question"> - <question>The Surefire Report Plugin reruns test. Is this its desired behavior?</question> + <question>The Surefire Report Plugin reruns tests. Is this its desired behavior?</question> <answer> <p> - No. This is a very known issue for the plugin. Please see + No. This is a well-known issue with older versions of the plugin. Please see <a href="http://jira.codehaus.org/browse/SUREFIRE-257";>SUREFIRE-257</a> - for - details. + for details. Upgrading to version 2.7.2 or newer will resolve this issue. </p> </answer> </faq> http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/22eb7362/maven-surefire-report-plugin/src/site/site.xml ---------------------------------------------------------------------- diff --git a/maven-surefire-report-plugin/src/site/site.xml b/maven-surefire-report-plugin/src/site/site.xml index 65ad070..4a22043 100644 --- a/maven-surefire-report-plugin/src/site/site.xml +++ b/maven-surefire-report-plugin/src/site/site.xml @@ -29,8 +29,8 @@ <item name="FAQ" href="faq.html"/> </menu> <menu name="Examples"> - <item name="Showing Failure Tests" href="examples/show-failures.html"/> - <item name="Changing Report Name" href="examples/changing-report-name.html"/> + <item name="Showing Only Failed Tests" href="examples/show-failures.html"/> + <item name="Changing the Report Name" href="examples/changing-report-name.html"/> <item name="Configuring the Output Location of the Report" href="examples/report-custom-location.html"/> <item name="Source Code Cross Reference" href="examples/cross-referencing.html"/> </menu> http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/22eb7362/surefire-api/src/site/apt/index.apt ---------------------------------------------------------------------- diff --git a/surefire-api/src/site/apt/index.apt b/surefire-api/src/site/apt/index.apt index 7be89de..f83f0ba 100644 --- a/surefire-api/src/site/apt/index.apt +++ b/surefire-api/src/site/apt/index.apt @@ -28,7 +28,7 @@ Surefire API * Definitions *-------------+-----------------------------------------------+ -| test method | individual test method within a class | +| test method | Individual test method within a class | *-------------+-----------------------------------------------+ | test | 1..N test methods in 1 or more classes. | *-------------+-----------------------------------------------+ @@ -39,11 +39,13 @@ Surefire API How each definition is applied depends on the provider, and the test suite being used. - Directory test suite: this constructs a single suite from a directory file set. Each discovered class is treated as a test. + * Directory test suite: this constructs a single suite from a directory file set. Each discovered class is treated as a test. - TestNG XML test suite: this constructs a single suite from a testng.xml file. The definitions inside the file will match those above. + * TestNG XML test suite: this constructs a single suite from a <<<testng.xml>>> file. The definitions inside the file will match those above. - JUnit 3.x: Groups are not supported. + * JUnit 3.x: Groups are not supported. + + [] See {{{../surefire-providers/index.html}Surefire Providers}} for more information on specific providers. http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/22eb7362/surefire-report-parser/pom.xml ---------------------------------------------------------------------- diff --git a/surefire-report-parser/pom.xml b/surefire-report-parser/pom.xml index 79c34ec..b44d6c8 100644 --- a/surefire-report-parser/pom.xml +++ b/surefire-report-parser/pom.xml @@ -31,7 +31,7 @@ <artifactId>surefire-report-parser</artifactId> <name>Surefire Report Parser</name> - <description>Parses report output files from surefire</description> + <description>Parses report output files from surefire.</description> <prerequisites> <maven>2.0.9</maven> http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/22eb7362/surefire-shadefire/pom.xml ---------------------------------------------------------------------- diff --git a/surefire-shadefire/pom.xml b/surefire-shadefire/pom.xml index 4f94e6f..21aff20 100644 --- a/surefire-shadefire/pom.xml +++ b/surefire-shadefire/pom.xml @@ -32,7 +32,7 @@ <name>ShadeFire JUnit3 Provider</name> <description>A super-shaded junit3 provider that is used by surefire to build itself, that basically has ALL classes relocated to facilitate no API-conflict whatsoever with ourself. - The only remaining point of conflict is around the booter properties file format + The only remaining point of conflict is around the booter properties file format. </description> <licenses> <license>
