db-jdo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From an...@apache.org
Subject svn commit: r1245886 - /db/jdo/trunk/README.html
Date Sat, 18 Feb 2012 08:21:31 GMT
Author: andyj
Date: Sat Feb 18 08:21:30 2012
New Revision: 1245886

URL: http://svn.apache.org/viewvc?rev=1245886&view=rev
Log:
Approximately up to date with jdo-exectck plugin details

Modified:
    db/jdo/trunk/README.html

Modified: db/jdo/trunk/README.html
URL: http://svn.apache.org/viewvc/db/jdo/trunk/README.html?rev=1245886&r1=1245885&r2=1245886&view=diff
==============================================================================
--- db/jdo/trunk/README.html (original)
+++ db/jdo/trunk/README.html Sat Feb 18 08:21:30 2012
@@ -21,20 +21,17 @@
 	<TITLE>JDO 3 TCK README</TITLE>
 </HEAD>
 <BODY LANG="en-US" DIR="LTR">
-<H1>The JDO 3 Technology Compatibility Kit</H1>
+<H1>The JDO 3.x Technology Compatibility Kit</H1>
 <UL>
     <LI><a href="#overview">Overview</a></LI>
-    <!-- For minor release change documentation
-    <LI><a href="#changes">Changes since the last release</a></LI>
-    -->
     <LI><a href="#prereqs">Prerequisites</a>
     <UL>
         <LI><a href="#maven">Maven</a></LI>
-        <LI><a href="#jndi">JNDI Implementation</a></LI>
+        <LI><a href="#jndi">JNDI Implementation (for TCK)</a></LI>
     </UL>
     </LI>
-    <LI><a href="#building">Building the TCK from source</a></LI>
-    <LI><a href="#running">Running the TCK</a>
+	<LI><a href="#api">Building the API</a></LI>
+    <LI><a href="#tck">Running the TCK</a>
     <UL>
         <LI><a href="#goals">Custom Goals</a></LI>
         <LI><a href="#cli">Command Line Options</a></LI>
@@ -43,13 +40,13 @@
     </UL></LI>
     </UL>
 <a name="overview"></a>
-<H2>Overview of the JDO 3 Technology Compatibility Kit</H2>
+<H2>Overview of the JDO 3.x Technology Compatibility Kit</H2>
 <p>
 The JDO 3 project includes the JDO 3 TCK and its dependencies:
 </p>
 <UL>
-    <LI>api contains source to build jdo-api-3.0.jar, which defines the JDO API version
3.0 for Java 1.5 and later.</LI>
-    <LI>tck contains the JDO 3.0 Technology Compatibility Kit for Java 1.5 and later.</LI>
+    <LI>api contains source to build jdo-api-3.x.jar, which defines the JDO API version
3.x for Java 1.5 and later.</LI>
+    <LI>tck contains the JDO 3.x Technology Compatibility Kit for Java 1.5 and later.</LI>
 </UL>
 <p>
 JDO releases may be downloaded from <a href="http://db.apache.org/jdo/downloads.html">the
Apache JDO downloads page</a>. Minor updates of releases are only available as source
from the Subversion repository. Follow the instructions <a href="#building">below</a>
to build the TCK from source.
@@ -77,7 +74,7 @@ Note that Apache JDO uses the apache com
 <a name="maven"></a>
 <h3>Maven</h3>
 <p>
-You must have Maven version 1.1 to build the projects from source and to execute
+You must have Maven version 2+ to build the projects from source and to execute
 the TCK. You can download maven from http://maven.apache.org/start/download.html
 </p><p>
 Note that maven uses the user.home system property for the location
@@ -101,69 +98,60 @@ execute goals.
 The JNDI test cases in tck need a JNDI implementation.
 The TCK is configured to use Sun's JNDI implementation.
 To use your own implementation, put the implementation
-jar files into lib/ext and update jndi.properties in the TCK directory
+jar files into tck/lib/ext and update jndi.properties in the TCK directory
 src/conf.  To download Sun's implementation, go to 
-http://java.sun.com/products/jndi/downloads/index.html,
-click the Download button at 'Download JNDI 1.2.1 & More', accept a license 
-agreement, download 'File System Service Provider, 1.2 Beta 3' and then unpack
-the downloaded zip. It includes the jars fscontext.jar and providerutil.jar.
-</p>
-<a name="building"></a>
-<h2>Building the TCK from Source</h2>
-For instructions for checking out the JDO source, see the Apache JDO <a href="http://db.apache.org/jdo/svn.html">source
code</a> page.
-<p>
-To build the TCK dependencies, change to the top level directory of the branch you are working
in (or trunk if you are using the latest unreleased code) and run
-<pre>
-maven tck.default
-</pre>
-Then change to the "tck" directory and run
-<pre>
-maven build
-</pre>
-When execution completes, you are ready to run the TCK.
+<a href="http://java.sun.com/products/jndi/downloads/index.html">http://java.sun.com/products/jndi/downloads/index.html</a>,
+click the Download button at <b>Download JNDI 1.2.1 &amp; More</b>, accept
a license 
+agreement, download <b>File System Service Provider, 1.2 Beta 3</b> and then
unpack
+the downloaded zip into <i>tck/lib/ext</i>. It includes the jars fscontext.jar
and providerutil.jar.
+</p>
+
+<a name="api"></a>
+<h2>Building the API</h2>
+For instructions for checking out the JDO source, see the Apache JDO 
+<a href="http://db.apache.org/jdo/svn.html">source code</a> page.
 <p>
-<a name="running"></a>
+To build the API, change to the "api" directory of the branch you are working in (or trunk)
and run
+<pre>mvn clean install</pre>
+This will build the <i>jdo-api</i> artifact and install it in your local Maven2
repository.
+</p>
+
+<a name="tck"></a>
 <h2>Running the TCK</h2>
 <p>
-In the tck project, run "maven build" to build the tck.  This will 
-compile, enhance, install the schemas, and run all the tests on the RI on all 
+Change to the "exectck" directory of the branch you are working in (or trunk) and run
+<pre>mvn clean install</pre> This builds and installs the "jdo-exectck" Maven
plugin in your
+local Maven2 repository.
+</p>
+<p>
+Change to the "tck" directory of the branch you are working in (or trunk) and run
+<pre>mvn clean install</pre> and this will run the TCK (via the "jdo-exectck"
plugin) on the RI on all 
 supported databases and identitytypes.
 </p>
 <p>
-You may use the following custom goals and command line options
-with the tck project:
+The "jdo-exectck" plugin has various options so you can run other implementations, or
+only run particular tests.
 </p>
 <a name="goals"></a>
 <h3>Custom Goals</h3>
 <DL>
-    <DT>help
-    <DD>displays help text describing custom goals and options
-    <DT>runtck.jdori
-    <DD>runs the TCK on the JDO Reference Implementation
-    <DT>runtck.iut
-    <DD>runs the TCK on the implementation under test
-    <DT>installSchema
-    <DD>installs the database schema
-    <DT>enhance.jdori
-    <DD>enhances the class files using the JDO RI enhancer
-    <DT>enhance.iut
-    <DD>enhances the class files using the implementation under test's enhancer
-    <DT>debugtck.jdori
-    <DD>waits for a debugger to attach and then runs the TCK on the JDO RI
-    <DT>debugtck.iut
-    <DD>waits for a debugger to attach and then runs the TCK on the implementation
under test
-    <DT>cleanClasses
-    <DD>deletes classes and enhanced classes
+    <DT>help</DT>
+    <DD>Displays help text describing custom goals and options</DD>
+    <DT>installSchema</DT>
+    <DD>Installs the database schema</DD>
+    <DT>enhance</DT>
+    <DD>enhances the test classes being used</DD>
+    <DT>runtck</DT>
+    <DD>Runs the TCK</DD>
 </DL>
 
 <a name="cli"></a>
     <h3>Command Line Options</h3>
     <DL>
+        <DT>-Djdo.tck.impl=<DD>either ri or iut for the implementation under
test.
         <DT>-Djdo.tck.cfglist=<i>configuration file list</i><DD>Overrides
the definition of jdo.tck.cfglist found in tck/src/conf/configuration.list by supplying one
or more comma-separated test configuration files. Test configuration files typically have
the .conf extension. To run a single test, create a .conf file (copy an existing file) and
put the test into the jdo.tck.classes property.
         <DT>-Djdo.tck.dblist=<i>database list</i><DD>Overrides the
property value in project.properties by supplying one or more comma-separated database names
-        <DT>-Djdo.tck.identitytypes=<i>identity type list</i><DD>Overrides
the property value in project.properties by supplying one or more comma-separated identity
types (applicationidentity or datastoreidentity) to use for this run.
-        <DT>-Djdo.tck.cleanupaftertest=<i>boolean</i><DD>When false,
data is retained in the database after the test. This allows inspection of data after test
is run. Default is true.
-        <DT>-Djdo.tck.debug.port=<i>port number</i><DD>Sets the port
number the JVM should listen for a debugger on. Default is 8787.
+        <DT>-Djdo.tck.identitytypes=<i>identity type list</i><DD>Overrides
the identity types to be run, supplying one or more comma-separated identity types ("applicationidentity"
or "datastoreidentity") to use for this run.
         <DT>-Djdo.tck.debug.jvmargs=<i>args</i><DD>Sets the "-Xdebug
..." arguments to allow you to supply your own debug directives.
 </DL>
 <a name="files"></a>
@@ -175,16 +163,16 @@ with the tck project:
     <LI>test configuration files (*.conf)
     <br>Each of these files sets values for
     <DL>
-        <DT>jdo.tck.testdescription 
-        <DD>An optional string describing the purpose of these tests
-        <DT>jdo.tck.classes 
-        <DD>A list of one or more test classes (required)
-        <DT>jdo.tck.testdata 
-        <DD>The fully qualified file name of the xml test data file(optional)
-        <DT>jdo.tck.standarddata 
-        <DD>The fully qualified file name of the xml test data file(optional)
-        <DT>jdo.tck.mapping 
-        <DD>The file designator that maven.xml uses to build a javax.jdo.option.Mapping
value and corresponding schema name (required)
+        <DT>jdo.tck.testdescription</DT>
+        <DD>An optional string describing the purpose of these tests</DD>
+        <DT>jdo.tck.classes</DT>
+        <DD>A list of one or more test classes (required)</DD>
+        <DT>jdo.tck.testdata</DT>
+        <DD>The fully qualified file name of the xml test data file(optional)</DD>
+        <DT>jdo.tck.standarddata </DT>
+        <DD>The fully qualified file name of the xml test data file(optional)</DD>
+        <DT>jdo.tck.mapping </DT>
+        <DD>The file designator that maven.xml uses to build a javax.jdo.option.Mapping
value and corresponding schema name (required)</DD>
 </DL></LI>
      <LI>exclude.list
         <br>A list of test classes NOT to execute during a TCK test run</LI>
@@ -192,27 +180,20 @@ with the tck project:
 <a name="examples"></a>
 <h3>Examples</h3>
 <DL>
-    <DT>maven -Djdo.tck.identitytypes=datastoreidentity installSchema
+    <DT>mvn -Djdo.tck.identitytypes=datastoreidentity jdo-exectck:installSchema
     <DD>Installs the database schema for datastore identity for all supported databases
 
-     <DT>maven -Djdo.tck.cfglist="alltests.conf cfg1.conf" runtck.jdori
-     <DD>Runs the test configurations specified in alltests.conf and cfg1.conf on the
JDORI, using all supported identity types and databases.
-
-     <DT>maven -Djdo.tck.cfglist=detach.conf debugtck.jdori
-     <DD>Runs the test detach.conf configuration, waiting for a debugger to attach
on the default port
-
-     <DT>maven -Djdo.tck.cfglist=detach.conf -Djdo.tck.debug.port=9343 debugtck.jdori
-     <DD>Runs the test detach.conf configuration, waiting for a debugger to attach
on port 9343
+    <DT>mvn -Djdo.tck.cfglist="alltests.conf cfg1.conf" jdo-exectck:runtck
+    <DD>Runs the test configurations specified in alltests.conf and cfg1.conf on the
JDORI, using all supported identity types and databases.
 </DL>
 <p>
 Note:
 </p>
 <UL>
     <LI type="none">By default, the database schema is NOT installed when the custom
goals runtck.iut and runtck.jdori are run.</LI>
-     <LI type="none">maven build installs the database schema and runs the TCK on the
JDO Reference Implementation.</LI>
-     <LI type="none">Enhancement is always done before running the TCK when the enhanced
classes are not up to date.</LI>
+    <LI type="none">"mvn install" installs the database schema and runs the TCK on
the JDO Reference Implementation.</LI>
+    <LI type="none">Enhancement is always done before running the TCK when the enhanced
classes are not up to date.</LI>
 </UL>
 
- </BODY>
- </HTML>
-
+</BODY>
+</HTML>
\ No newline at end of file



Mime
View raw message