JAL-1888 updated documentation for unit testing in jalview
authorJim Procter <jprocter@issues.jalview.org>
Fri, 18 Sep 2015 12:57:24 +0000 (13:57 +0100)
committerJim Procter <jprocter@issues.jalview.org>
Fri, 18 Sep 2015 12:57:24 +0000 (13:57 +0100)
doc/UnitTesting.html

index 8969b9d..c4d63ff 100644 (file)
@@ -24,7 +24,7 @@
 <h1> Unit testing in Jalview </h1>
 
 <p>
-In June 2015, the Jalview team adopted <a href=http://testng.org/doc/index.html>TestNG</a> as the favourite unit testing framework. Consequently all existing JUnit tests were ported to TestNG.
+In June 2015, the Jalview team adopted <a href=http://testng.org/doc/index.html>TestNG</a> for handling unit tests, and all existing JUnit tests were ported to TestNG.
 
 
 <h2>Test Groups</h2>
@@ -89,12 +89,11 @@ The TestNG tests for Jalview can be executed in any of the following ways:
        A more detailed guide for installing and executing TestNG in eclipse is available at <a href=http://testng.org/doc/eclipse.html>testng.org/doc/eclipse.html</a> <br>&nbsp;
   </li>
   <li><b>From Ant:</b> 
-        </br> To execute Jalview unit test from ant please take the following steps:
+        </br>The ant task 'testng' will run Jalview's tests. You should:
        <ul>
             <li>Ensure that you have ant installed</li>
             <li>Ensure that your test classes are error free and properly annotated</li>
-            <li>Ensure that the test class or group is available in the TestNG config file. For Jalview this is located in jalview/utils/jalview_testng.xml</li>
-           <li>Add a TestNG run target to your main ant build file, and execute the target.</li>
+            <li>Specify the desired group of tests by passing a comma separated list of one or more groups via -Dtestng-groups=""</li>
         </ul> 
         A more detailed guide for executing TestNG from ant is available at <a href=http://testng.org/doc/ant.html>http://testng.org/doc/ant.html</a>
   </li>