DRAFT Version 0.1
+18-Jan-2006
+Overview
+In order to demonstrate compliance with the Java Data Objects +specification, an implementation must successfully run all of the TCK +tests that are not on the âexcludedâ list. +
+The results should be posted on the JDO supplier's web site for +examination by the public. The posting includes the output of the +test run, which consists of multiple log files, configuration +information, and results. For an example of the required posting, +please see http://db.apache.org/jdo/tck/final.
+Prerequisites
+In order to run the TCK, you must install maven 1.0.2. Maven +http://maven.apache.org/maven-1.x/ +is the +driver of the test programs. Note that Maven 2 is not supported.
+You must test the JDO implementation on all configurations that +the implementation supports. This includes different hardware and +operating systems, different versions of Java, and different +datastores. The TCK supports Java versions from JDK 1.3 to 1.5.
+Installation
+Download the zip file from the distribution at the Java Community +Process web site http://jcp.org/en/jsr/detail?id=243. Unpack the zip +file into a directory of your choice. In this directory you will +find: this RunRules.html, some configuration files, and several +directories:
+maven.xml, project.properties, project.xml â the maven + definition of the project. These files must not be modified.
+assertions â contains the assertions file identifying the + assertions tested by the tests. This is for reference.
+target â this directory contains artifacts of compiling and + running the tests. It does not exist in the distribution and will be + created upon installation.
+iut_jars â this directory is where the JDO implementation + jars are installed. It is empty in the distribution. To use the + maven targets runtck.iut (required for an implementation to prove + compliance), copy the JDO implementation jar files into this + directory. Alternatively, update the build.properties file to refer + to an existing location of the IUT jar files.
+test â this directory contains the test configuration files + and directories:
+testdata â this directory contains data (represented as + .xml files) loaded into the datastore for tests. These files must + not be modified.
+sql â this directory contains DDL to define the tables + used in the tests. These files may be modified only if the DDL for + the database under test is not provided. +
+jdo â this directory contains .jdo metadata files for the + persistent classes used in the tests. These files must not be + modified.
+orm â this directory contains .orm metadata files to map + the persistent classes to the sql tables. These files must not be + modified except to add DDL-generation information (which is not + used by the TCK).
+java â this directory contains the source code to the TCK + tests. These files must not be modified.
+conf â this directory contains the configuration + information for the test runs. The file iut-pmf.properties must be + changed to provide properties for the persistence manager factory. + Other files must not be modified, except to put a successfully + challenged test case into the trunk/tck20/test/conf/exclude.list. + Please see below.
+lib â this directory contains a directory ext that contains + jar files fscontext.jar + and providerutil.jar used by the JNDI tests. + They + can be found at
+http://java.sun.com/products/jndi/downloads/index.html. +Choose "File System Service Provider, 1.2 Beta 3" from the +"Download JNDI 1.2.1 & More" page. Install them into +the lib/ext directory.
+Modifying +the Configuration
+The Implementation Under Test (IUT) must be installed into the +directory <install-dir>/iut_jars. Any .jar files in this +directory are added to the class path used to run the tests.
+There are two properties files that must be modified to be +IUT-specific. The <install-dir>/iut.properties file contains +information used to configure the execution environment of the IUT. +The <install-dir>/iutpmf.properties file contains information +used to construct the PersistenceManagerFactory used in the tests.
+Sample configuration files are provided for the sql configuration. +These files may be modified in order to suit the JDO implementation +under test.
+Running +the Tests
+From the installation directory, call maven tck20.build which will +build the jar files used in the tests, create the Derby database, +install the schema into the Derby database, and run the TCK on the +Reference Implementation.
+From the installation directory, change to the tck20 directory. +Then call maven runtck.iut to run the tests on the Implementation +Under Test. This will produce console output plus a directory in the +trunk/tck20/target/logs directory with the date/time the tests were +started. This directory contains the output of the tests. This is the +directory to be published.
+Modifying +the IUT while debugging the TCK tests
+If you make a change to the IUT while debugging the TCK tests, +including modifying the enhancer (for implementations that use an +enhancer) you must remove the target/classes directory before +continuing in order to make sure that the classes are re-enhanced by +the changed code.
+Publishing +the Results of the TCK Tests
+With a successful test run, the log directory with the results of +the tests must be published on a publicly-available web site. The +unmodified directory is the self-certification of the successful TCK +test run.
+Challenging +the Validity of a Test or Configuration
+If any test does not pass on the JDO implementation under test, +this may be due to an error in the implementation or in the TCK test. +If you believe that the failure is due to an error in the TCK test, +you may challenge the test. To do so, send email to: +jdo-dev@db.apache.org with +a subject line containing âCHALLENGEâ and the name of the test +program, e.g. +org.apache.jdo.tck.api.persistencemanager.ThreadSafe.java; and the +body of the email containing the details of the challenge.
+If the issue is found by the Maintenance Lead to be due to an +error in the test case, then the test may be put into the +trunk/tck20/test/conf/exclude.list and it will not be run as part of +the TCK.
+Decisions of the Maintenance Lead may be appealed to the full +expert group. A vote of the full expert group will be conducted by +the Maintenance Lead, and a majority of votes cast will decide the +issue. The Maintenance Lead has one vote, as does each member of the +expert group at the time of the vote.
+ + \ No newline at end of file