[tmapi-commit] SF.net SVN: tmapi:[190] trunk/README.txt

[<lh...@us...>]

Revision: 190
          http://tmapi.svn.sourceforge.net/tmapi/?rev=190&view=rev
Author:   lheuer
Date:     2010-09-14 14:41:34 +0000 (Tue, 14 Sep 2010)

Log Message:
-----------
Added section about testing TMAPI processors to README.txt. Contributed by Benjamin Bock
<https://sourceforge.net/tracker/?func=detail&aid=3065991&group_id=39237&atid=424688>

Modified Paths:
--------------
    trunk/README.txt

Modified: trunk/README.txt
===================================================================
--- trunk/README.txt	2010-09-01 18:04:56 UTC (rev 189)
+++ trunk/README.txt	2010-09-14 14:41:34 UTC (rev 190)
@@ -3,9 +3,11 @@
 
 1. What is TMAPI?
 2. How do I run it?
-3. Reporting Bugs
-4. Legal stuff
+3. How do I test my own Topic Maps processor implementation?
+4. Reporting Bugs
+5. Legal stuff
 
+
 1. What is TMAPI?
 -----------------
 TMAPI is an open-source effort to define a set of common APIs for programming 
@@ -26,6 +28,7 @@
 interface packages for topic map parsers; query engines; and other Topic Maps
 processing tools as needed.
 
+
 2. How do I run it?
 -------------------
 TMAPI is NOT a Topic Maps processor! There is really nothing to run except for 
@@ -34,7 +37,35 @@
 implementations available. Up-to-date details can be found on the TMAPI website
 at http://www.tmapi.org/2.0/
 
-3. Reporting Bugs
+
+3. How do I test my own Topic Maps processor implementation?
+------------------------------------------------------------
+Instead of copying the TMAPI test suite to your project you should run the
+org.tmapi.AllTests Suite. This suite includes both the core tests and the index
+tests but not the TMAPI-internal self-tests like e.g. TestTopicMapSystemFactory.
+
+Your minimal test suite could look as follows:
+
+    public class TestTMAPI extends TestSuite {
+
+        public static void main(String[] args) {
+            junit.textui.TestRunner.run(suite());
+        }
+
+        public static Test suite() {
+            TestSuite suite = new TestSuite();
+            suite.addTest(org.tmapi.AllTests.suite());
+            return suite;
+        }
+    }
+
+The test suite expects to find your engine's TopicMapSystemFactory which it uses
+to instantiate your TopicMapSystem, so you should provide this information in the
+META-INF/services/org.tmapi.core.TopicMapSystemFactory resource file in your project.
+If your project uses Maven, the META-INF directory should be in src/main/resources/.
+
+
+4. Reporting Bugs
 -----------------
 If an implementation does not behave as you expect it to, please DO NOT TELL US! 
 Tell the vendor/author of the implementation.
@@ -46,9 +77,9 @@
 tma...@li... (you may need to register for this list 
 before posting - go the http://sourceforge.net/projects/tmapi and click on Lists).
 
-4. Legal Stuff
+
+5. Legal Stuff
 --------------
-
 TMAPI is Public Domain software. See the file LICENSE.txt that is part of this 
 distribution.
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.