From jdo-commits-return-2976-apmail-db-jdo-commits-archive=www.apache.org@db.apache.org Sat Feb 18 08:21:52 2012 Return-Path: X-Original-To: apmail-db-jdo-commits-archive@www.apache.org Delivered-To: apmail-db-jdo-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 92FCD99C7 for ; Sat, 18 Feb 2012 08:21:52 +0000 (UTC) Received: (qmail 69818 invoked by uid 500); 18 Feb 2012 08:21:52 -0000 Mailing-List: contact jdo-commits-help@db.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: jdo-dev@db.apache.org Delivered-To: mailing list jdo-commits@db.apache.org Received: (qmail 69808 invoked by uid 99); 18 Feb 2012 08:21:52 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 18 Feb 2012 08:21:52 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 18 Feb 2012 08:21:51 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 5D18023888D2; Sat, 18 Feb 2012 08:21:31 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1245886 - /db/jdo/trunk/README.html Date: Sat, 18 Feb 2012 08:21:31 -0000 To: jdo-commits@db.apache.org From: andyj@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20120218082131.5D18023888D2@eris.apache.org> 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 @@ JDO 3 TCK README -

The JDO 3 Technology Compatibility Kit

+

The JDO 3.x Technology Compatibility Kit

-

Overview of the JDO 3 Technology Compatibility Kit

+

Overview of the JDO 3.x Technology Compatibility Kit

The JDO 3 project includes the JDO 3 TCK and its dependencies:

    -
  • api contains source to build jdo-api-3.0.jar, which defines the JDO API version 3.0 for Java 1.5 and later.
    • -
  • tck contains the JDO 3.0 Technology Compatibility Kit for Java 1.5 and later.
    • +
  • api contains source to build jdo-api-3.x.jar, which defines the JDO API version 3.x for Java 1.5 and later.
    • +
  • tck contains the JDO 3.x Technology Compatibility Kit for Java 1.5 and later.

JDO releases may be downloaded from the Apache JDO downloads page. Minor updates of releases are only available as source from the Subversion repository. Follow the instructions below to build the TCK from source. @@ -77,7 +74,7 @@ Note that Apache JDO uses the apache com

Maven

-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

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. -

- -

Building the TCK from Source

-For instructions for checking out the JDO source, see the Apache JDO source code page. -

-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 -

-maven tck.default
-
-Then change to the "tck" directory and run -
-maven build
-
-When execution completes, you are ready to run the TCK. +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 into tck/lib/ext. It includes the jars fscontext.jar and providerutil.jar. +

+ + +

Building the API

+For instructions for checking out the JDO source, see the Apache JDO +source code page.

- +To build the API, change to the "api" directory of the branch you are working in (or trunk) and run +

mvn clean install
+This will build the jdo-api artifact and install it in your local Maven2 repository. +

+ +

Running the TCK

-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 +

mvn clean install
This builds and installs the "jdo-exectck" Maven plugin in your +local Maven2 repository. +

+

+Change to the "tck" directory of the branch you are working in (or trunk) and run +

mvn clean install
and this will run the TCK (via the "jdo-exectck" plugin) on the RI on all supported databases and identitytypes.

-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.

Custom Goals

-
help -
displays help text describing custom goals and options -
runtck.jdori -
runs the TCK on the JDO Reference Implementation -
runtck.iut -
runs the TCK on the implementation under test -
installSchema -
installs the database schema -
enhance.jdori -
enhances the class files using the JDO RI enhancer -
enhance.iut -
enhances the class files using the implementation under test's enhancer -
debugtck.jdori -
waits for a debugger to attach and then runs the TCK on the JDO RI -
debugtck.iut -
waits for a debugger to attach and then runs the TCK on the implementation under test -
cleanClasses -
deletes classes and enhanced classes +
help
+
Displays help text describing custom goals and options
+
installSchema
+
Installs the database schema
+
enhance
+
enhances the test classes being used
+
runtck
+
Runs the TCK

Command Line Options

+
-Djdo.tck.impl=
either ri or iut for the implementation under test.
-Djdo.tck.cfglist=configuration file list
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.
-Djdo.tck.dblist=database list
Overrides the property value in project.properties by supplying one or more comma-separated database names -
-Djdo.tck.identitytypes=identity type list
Overrides the property value in project.properties by supplying one or more comma-separated identity types (applicationidentity or datastoreidentity) to use for this run. -
-Djdo.tck.cleanupaftertest=boolean
When false, data is retained in the database after the test. This allows inspection of data after test is run. Default is true. -
-Djdo.tck.debug.port=port number
Sets the port number the JVM should listen for a debugger on. Default is 8787. +
-Djdo.tck.identitytypes=identity type list
Overrides the identity types to be run, supplying one or more comma-separated identity types ("applicationidentity" or "datastoreidentity") to use for this run.
-Djdo.tck.debug.jvmargs=args
Sets the "-Xdebug ..." arguments to allow you to supply your own debug directives.
@@ -175,16 +163,16 @@ with the tck project:
  • test configuration files (*.conf)
    Each of these files sets values for
    -
    jdo.tck.testdescription -
    An optional string describing the purpose of these tests -
    jdo.tck.classes -
    A list of one or more test classes (required) -
    jdo.tck.testdata -
    The fully qualified file name of the xml test data file(optional) -
    jdo.tck.standarddata -
    The fully qualified file name of the xml test data file(optional) -
    jdo.tck.mapping -
    The file designator that maven.xml uses to build a javax.jdo.option.Mapping value and corresponding schema name (required) +
    jdo.tck.testdescription
    +
    An optional string describing the purpose of these tests
    +
    jdo.tck.classes
    +
    A list of one or more test classes (required)
    +
    jdo.tck.testdata
    +
    The fully qualified file name of the xml test data file(optional)
    +
    jdo.tck.standarddata
    +
    The fully qualified file name of the xml test data file(optional)
    +
    jdo.tck.mapping
    +
    The file designator that maven.xml uses to build a javax.jdo.option.Mapping value and corresponding schema name (required)
  • exclude.list
    A list of test classes NOT to execute during a TCK test run
    • @@ -192,27 +180,20 @@ with the tck project:

    Examples

    -
    maven -Djdo.tck.identitytypes=datastoreidentity installSchema +
    mvn -Djdo.tck.identitytypes=datastoreidentity jdo-exectck:installSchema
    Installs the database schema for datastore identity for all supported databases -
    maven -Djdo.tck.cfglist="alltests.conf cfg1.conf" runtck.jdori -
    Runs the test configurations specified in alltests.conf and cfg1.conf on the JDORI, using all supported identity types and databases. - -
    maven -Djdo.tck.cfglist=detach.conf debugtck.jdori -
    Runs the test detach.conf configuration, waiting for a debugger to attach on the default port - -
    maven -Djdo.tck.cfglist=detach.conf -Djdo.tck.debug.port=9343 debugtck.jdori -
    Runs the test detach.conf configuration, waiting for a debugger to attach on port 9343 +
    mvn -Djdo.tck.cfglist="alltests.conf cfg1.conf" jdo-exectck:runtck +
    Runs the test configurations specified in alltests.conf and cfg1.conf on the JDORI, using all supported identity types and databases.

    Note:

    • By default, the database schema is NOT installed when the custom goals runtck.iut and runtck.jdori are run.
      • -
    • maven build installs the database schema and runs the TCK on the JDO Reference Implementation.
      • -
    • Enhancement is always done before running the TCK when the enhanced classes are not up to date.
      • +
    • "mvn install" installs the database schema and runs the TCK on the JDO Reference Implementation.
      • +
    • Enhancement is always done before running the TCK when the enhanced classes are not up to date.
    - - - + + \ No newline at end of file