svn commit: r514373 - in /maven/surefire/trunk/surefire-api/src/site: ./ apt/ apt/index.apt

[br...@apache.org]

Author: brett
Date: Sun Mar  4 00:48:25 2007
New Revision: 514373

URL: http://svn.apache.org/viewvc?view=rev&rev=514373
Log:
start to document agreed terminology

Added:
    maven/surefire/trunk/surefire-api/src/site/
    maven/surefire/trunk/surefire-api/src/site/apt/
    maven/surefire/trunk/surefire-api/src/site/apt/index.apt

Added: maven/surefire/trunk/surefire-api/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/surefire/trunk/surefire-api/src/site/apt/index.apt?view=auto&rev=514373
==============================================================================
--- maven/surefire/trunk/surefire-api/src/site/apt/index.apt (added)
+++ maven/surefire/trunk/surefire-api/src/site/apt/index.apt Sun Mar  4 00:48:25 2007
@@ -0,0 +1,33 @@
+ -----
+ Surefire API Design
+ -----
+ Brett Porter
+ -----
+ 3 March 2007
+ -----
+
+Surefire API
+
+* Definitions
+
+*-------------+-----------------------------------------------+
+| test method | individual test method within a class         |
+*-------------+-----------------------------------------------+
+| test        | 1..N test methods in 1 or more classes.       |
+*-------------+-----------------------------------------------+
+| suite       | 1..N tests.                                   |
+*-------------+-----------------------------------------------+
+| group       | A named subset of test methods within a test. |
+*-------------+-----------------------------------------------+
+
+  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.
+
+  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.
+
+   See {{{providers/index.html}}} for more information on specific providers. |
+
+~~TODO: fix up URLs, move some to providers/javadoc.