Updated Branches: refs/heads/master 24eff24de -> faae29c22
o Added documentation about the new brief summary format Project: http://git-wip-us.apache.org/repos/asf/maven-surefire/repo Commit: http://git-wip-us.apache.org/repos/asf/maven-surefire/commit/faae29c2 Tree: http://git-wip-us.apache.org/repos/asf/maven-surefire/tree/faae29c2 Diff: http://git-wip-us.apache.org/repos/asf/maven-surefire/diff/faae29c2 Branch: refs/heads/master Commit: faae29c22a2ef18b4169b2a61007388521b17632 Parents: 24eff24 Author: Kristian Rosenvold <krosenv...@apache.org> Authored: Tue Dec 18 16:43:20 2012 +0100 Committer: Kristian Rosenvold <krosenv...@apache.org> Committed: Tue Dec 18 16:43:20 2012 +0100 ---------------------------------------------------------------------- .../src/site/markdown/newerrorsummary.md | 45 +++++++++++++++ maven-surefire-plugin/src/site/site.xml | 1 + pom.xml | 5 ++ 3 files changed, 51 insertions(+), 0 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/faae29c2/maven-surefire-plugin/src/site/markdown/newerrorsummary.md ---------------------------------------------------------------------- diff --git a/maven-surefire-plugin/src/site/markdown/newerrorsummary.md b/maven-surefire-plugin/src/site/markdown/newerrorsummary.md new file mode 100644 index 0000000..f33a2d6 --- /dev/null +++ b/maven-surefire-plugin/src/site/markdown/newerrorsummary.md @@ -0,0 +1,45 @@ +The 1-line error summary +======================== + +Surefire 2.13 introduced a compact one-line format for quickly being able to locate test failures. This format +is intended to give an overview and does necessarily lose some details, which can be found in the main +report of the run or the files on disk. + +### Example output: + + Failed tests: + Test1#assertion1(59) Bending maths expected:<[123]> but was:<[312]> + Test1#assertion2(64) True is false + + Tests in error: + Test1#nullPointerInLibrary(38) >> NullPointerException + Test1#failInNestedLibInMethod(54).nestedLibFailure(72) >> NullPointerException + Test1#failInLibInMethod(48) >> NullPointerException + Test1#failInMethod(43).innerFailure(68) NullPointerException Fail here + Test2#test6281(33) RuntimeException FailHere + +The format of the report is quite "packed", so some explanation is required, there are three different formats: + + +### Format 1, assertion failure. +#### Class#method(line number)...methodN(lineN) "Assertion failure message" + + Test1#assertion2(64) True is false + Test1#assertion1(59) Bending maths expected:<[123]> but was:<[312]> + +### Format 2, Exception in test. +#### Class#method(line number)...methodN(lineN) Exception "Message" +In this case the exception was actually thrown on the line in question. + + Test1#failInMethod(43).innerFailure(68) NullPointerException Fail here + Test2#test6281(33) RuntimeException FailHere + +### Format 3: Exception in code called by test. +#### Same format as 2 but >> added before exception +In this case the exception is thrown inside some code that was called from this line of the +test. We do not show where the actual exception happened, only which line(s) of the test +that were involved in the call. + + Test1#failInLibInMethod(48) >> NullPointerException + Test1#failInNestedLibInMethod(54).nestedLibFailure(72) >> NullPointerException + http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/faae29c2/maven-surefire-plugin/src/site/site.xml ---------------------------------------------------------------------- diff --git a/maven-surefire-plugin/src/site/site.xml b/maven-surefire-plugin/src/site/site.xml index 78db8d6..aa4b476 100644 --- a/maven-surefire-plugin/src/site/site.xml +++ b/maven-surefire-plugin/src/site/site.xml @@ -47,6 +47,7 @@ <item name="System Properties" href="examples/system-properties.html"/> <item name="Configuring the Classpath" href="examples/configuring-classpath.html"/> <item name="Selecting providers" href="examples/providers.html"/> + <item name="New error summary" href="newerrorsummary.html"/> </menu> </body> </project> http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/faae29c2/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 5079ce8..0d3d386 100644 --- a/pom.xml +++ b/pom.xml @@ -375,6 +375,11 @@ <artifactId>surefire-shadefire</artifactId> <version>${project.version}</version> </dependency> + <dependency> + <groupId>org.apache.maven.doxia</groupId> + <artifactId>doxia-module-markdown</artifactId> + <version>1.3</version> + </dependency> </dependencies> </plugin> </plugins>