From b88e105282e47f636c543cdf1f727aedfca3ca75 Mon Sep 17 00:00:00 2001 From: Magesh Umasankar Date: Thu, 14 Mar 2002 01:01:18 +0000 Subject: [PATCH] * Add a link to external dependency page. * Remove unnecessary trailing spaces in junit.html. Submitted by: Ylan Segal git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@271841 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/OptionalTasks/junit.html | 116 +++++++++++---------- docs/manual/OptionalTasks/junitreport.html | 4 + 2 files changed, 64 insertions(+), 56 deletions(-) diff --git a/docs/manual/OptionalTasks/junit.html b/docs/manual/OptionalTasks/junit.html index 75ae0e53e..cebafc9a2 100644 --- a/docs/manual/OptionalTasks/junit.html +++ b/docs/manual/OptionalTasks/junit.html @@ -8,10 +8,14 @@

Description

This task runs tests from the JUnit testing framework. The latest -version of the framework can be found at +version of the framework can be found at http://www.junit.org. This task has been tested with JUnit 3.0 up to JUnit 3.7, it won't work with versions prior to JUnit 3.0.

+

Note: This task depends on external libraries not included +in the Ant distribution. See +Library Dependencies for more information. +

Tests are defined by nested test or batchtest tags, see nested @@ -25,7 +29,7 @@ elements.

Required - printsummary + printsummary Print one line statistics for each testcase. Can take the values "on", "off" and "withOutAndErr" - "withOutAndErr" is the same @@ -34,43 +38,43 @@ elements.

No, default is "off" - fork + fork Run the tests in a separate VM. No, default is "off" - haltonerror + haltonerror Stop the build process if an error occurs during the test run. No, default is "off" - errorProperty - The name of a property to set in the event of an error. + errorProperty + The name of a property to set in the event of an error. No. - haltonfailure - Stop the build process if a test fails (errors are + haltonfailure + Stop the build process if a test fails (errors are considered failures as well). No, default is "off" - failureProperty + failureProperty The name of a property to set in the event of a failure - (errors are considered failures as well). + (errors are considered failures as well). No. - filtertrace - Filter out junit and ant stack frames from error and failure stack traces. + filtertrace + Filter out junit and ant stack frames from error and failure stack traces. No, default is "on." - timeout + timeout Cancel the individual tests if the don't finish in the given time (measured in milliseconds). Ignored if fork is - disabled. + disabled. No @@ -148,11 +152,11 @@ The attributes for this element are the same as for exec

Settings will be ignored if fork is disabled.

@@ -180,22 +184,22 @@ can be specified.

Required - type + type Use a predefined formatter (either "xml", "plain" or "brief"). Exactly one of these. - classname + classname Name of a custom formatter class. - extension + extension Extension to append to the output filename. Yes, if classname has been used. - usefile + usefile Boolean that determines whether output should be sent to a file. No, default true. @@ -213,54 +217,54 @@ can be specified.

Required - name + name Name of the test class Yes - fork - Run the tests in a separate VM. + fork + Run the tests in a separate VM. Overrides value set in <junit>. No - haltonerror + haltonerror Stop the build process if an error occurs during the test run. Overrides value set in <junit>. No - errorProperty + errorProperty The name of a property to set in the event of an error. - Overrides value set in <junit>. + Overrides value set in <junit>. No. - haltonfailure - Stop the build process if a test fails (errors are - considered failures as well). Overrides value set in + haltonfailure + Stop the build process if a test fails (errors are + considered failures as well). Overrides value set in <junit>. No - failureProperty + failureProperty The name of a property to set in the event of a failure - (errors are considered failures as well). Overrides value set in <junit>. + (errors are considered failures as well). Overrides value set in <junit>. No. - filtertrace - Filter out junit and ant stack frames from error and failure stack - traces. Overrides value set in <junit> + filtertrace + Filter out junit and ant stack frames from error and failure stack + traces. Overrides value set in <junit> No, default is "on." - todir + todir Directory to write the reports to. No, default is current directory. - outfile + outfile Base name of the test result. The full filename is determined by this attribute and the extension of formatter. @@ -268,12 +272,12 @@ can be specified.

TEST-name using the name attribute. - if + if Only run test if the named property is set. No - unless + unless Only run test if the named property is not set. No @@ -299,54 +303,54 @@ generates a test class name for each file that ends in Required - fork - Run the tests in a separate VM. + fork + Run the tests in a separate VM. Overrides value set in <junit>. No - haltonerror + haltonerror Stop the build process if an error occurs during the test run. Overrides value set in <junit>. No - errorProperty + errorProperty The name of a property to set in the event of an error. - Overrides value set in <junit>. + Overrides value set in <junit>. No. - haltonfailure - Stop the build process if a test fails (errors are - considered failures as well). Overrides value set in + haltonfailure + Stop the build process if a test fails (errors are + considered failures as well). Overrides value set in <junit>. No - failureProperty + failureProperty The name of a property to set in the event of a failure - (errors are considered failures as well). Overrides value set in <junit> + (errors are considered failures as well). Overrides value set in <junit> No. - filtertrace - Filter out junit and ant stack frames from error and failure stack - traces. Overrides value set in <junit> + filtertrace + Filter out junit and ant stack frames from error and failure stack + traces. Overrides value set in <junit> No, default is "on." - todir + todir Directory to write the reports to. No, default is current directory. - if + if Only run tests if the named property is set. No - unless + unless Only run tests if the named property is not set. No @@ -416,7 +420,7 @@ perform setup work (such as starting an external server), execute the test, clean up, and still fail the build in the event of a failure.

The filtertrace attribute condenses error and failure stack traces before reporting them. -It works with the plain and xml formatters. It filters out lines that begin with the following +It works with the plain and xml formatters. It filters out lines that begin with the following string patterns:

    "junit.framework.TestCase"
    "junit.framework.TestResult"
@@ -426,7 +430,7 @@ string patterns:
    "junit.awtui.TestRunner"
    "junit.textui.TestRunner"
    "java.lang.reflect.Method.invoke("
-   "org.apache.tools.ant."
 
+   "org.apache.tools.ant."

Copyright © 2001-2002 Apache Software Foundation. All rights Reserved.

diff --git a/docs/manual/OptionalTasks/junitreport.html b/docs/manual/OptionalTasks/junitreport.html index 213da3fa1..47eb0cd3f 100644 --- a/docs/manual/OptionalTasks/junitreport.html +++ b/docs/manual/OptionalTasks/junitreport.html @@ -9,6 +9,10 @@ Merge the individual XML files generated by the JUnit task and eventually apply a stylesheet on the resulting merged document to provide a browsable report of the testcases results. +

Note: This task depends on external libraries not included in +the Ant distribution. See +Library Dependencies for more information.

+

Requirements

The task will run with either Xalan 2.x or Xalan 1.2.2.