You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jdo-commits@db.apache.org by mb...@apache.org on 2025/10/07 07:24:28 UTC

(db-jdo) branch JDO-853 created (now 4a642909)

This is an automated email from the ASF dual-hosted git repository.

mbo pushed a change to branch JDO-853
in repository https://gitbox.apache.org/repos/asf/db-jdo.git


      at 4a642909 JDO-853: Update parameter description in README and TCK help text

This branch includes the following new commits:

     new 4a642909 JDO-853: Update parameter description in README and TCK help text

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



(db-jdo) 01/01: JDO-853: Update parameter description in README and TCK help text

Posted by mb...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

mbo pushed a commit to branch JDO-853
in repository https://gitbox.apache.org/repos/asf/db-jdo.git

commit 4a642909827c5ed0e9d3634d85cd172c6ead9702
Author: Michael Bouschen <Mi...@akquinet.de>
AuthorDate: Tue Oct 7 09:24:17 2025 +0200

    JDO-853: Update parameter description in README and TCK help text
---
 README.md                                          | 19 ++++++-
 .../org/apache/jdo/exectck/AbstractTCKMojo.java    | 30 +++++------
 .../src/main/java/org/apache/jdo/exectck/Help.java | 57 +++++++++++++++++---
 .../main/java/org/apache/jdo/exectck/RunTCK.java   | 61 ++++++++++------------
 4 files changed, 110 insertions(+), 57 deletions(-)

diff --git a/README.md b/README.md
index 781d8bbd..9ecbaca6 100644
--- a/README.md
+++ b/README.md
@@ -120,12 +120,27 @@ The *jdo-exectck* Maven plugin has the following options
 * -Djdo.tck.dblist : Overrides the property value in project.properties by supplying one or more comma-separated database names. Currently only derby is supported.
 * -Djdo.tck.identitytypes : 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.impl.logfile : Location of implementation log file. Default: `${user.dir}/datanucleus.txt`
+* -Djdo.tck.doRunTCK : Setting this parameter to false will bypass running the TCK.
 * -Djdo.tck.doInstallSchema : Setting this parameter to *false* will bypass schema installation.
 * -Djdo.tck.doEnhance : Setting this parameter to false will bypass enhancement.
-* -Djdo.tck.doRunTCK : Setting this parameter to false will bypass running the TCK.
 * -Djdo.tck.runTCKVerbose : Setting this parameter to *true* will display test progress and error output while the TCK is running.
+* -Djdo.tck.verbose: Setting this parameter to *true* will run the TCK tests in verbose mode.
 * -Djdo.tck.onFailure : Specifies how test failures are treated. *failFast* will immediately abort the test run. *failGoal* (default) will execute the whole TCK before failing. *logOnly* will report failures to console and logs only but return 'SUCCESS' to the Maven execution environment.
-
+* -Djdo.tck.debugTCK: Setting this parameter to *true* will run the TCK in a debugger.
+* -Djdo.tck.debug.jvmargs: User-supplied arguments for debug directives.
+* -Djdo.tck.pmfproperties: Name of file in src/conf containing pmf properties.
+* -Djdo.tck.excludefile: Name of file in src/conf containing property jdo.tck.exclude, whose value is a list of files to be excluded from testing.
+* -Djdo.tck.signaturefile: Name of the signatute file used to test the signatures of the JDO API classes.
+* -Djdo.tck.cleanupaftertest: Setting this parameter to *false* withh retain test output for debugging.
+* -Djdo.tck.jvmproperties: JVM properties.
+* -Djdo.tck.logfile: Name of the tck log file.
+* -Djdo.tck.testrunner.class: Class used to run a batch of tests.
+* -Djdo.tck.testrunner.details: Output mode for test run. Use one of: none, summary, flat, tree, verbose, testfeed. If `none`is selected, then only the summary and test failures are shown.
+* -Djdo.tck.testrunner.colors: Setting this parameter to *enable* displays colors in the junit result log file.
+* -Djdo.tck.parallel.execution: Setting this parameter to *false* will disable parallel exceution of tck test methods in parallel threads.
+* -Djdo.tck.datastore.supportsQueryCancel: Setting this parameter to *true* indicates whether the datastore supports query canceling.
+* -Dproject.lib.ext.directory: Location of third party libraries such as JNDI.
+* -Ddatabase.runtck.sysproperties: Properties to use in accessing database.
 
 ### Examples
 
diff --git a/exectck/src/main/java/org/apache/jdo/exectck/AbstractTCKMojo.java b/exectck/src/main/java/org/apache/jdo/exectck/AbstractTCKMojo.java
index 95de4216..cbeb3072 100644
--- a/exectck/src/main/java/org/apache/jdo/exectck/AbstractTCKMojo.java
+++ b/exectck/src/main/java/org/apache/jdo/exectck/AbstractTCKMojo.java
@@ -66,6 +66,13 @@ public abstract class AbstractTCKMojo extends AbstractMojo {
    */
   @Parameter protected Collection<String> cfgs;
 
+  /**
+   * Implementation to be tested (jdori or iut). Any value other than "jdori" will test an
+   * appropriately configured IUT
+   */
+  @Parameter(property = "jdo.tck.impl", defaultValue = "jdori", required = true)
+  protected String impl;
+
   /**
    * List of configuration files, each describing a test configuration. Allows command line override
    * of configured cfgs value.
@@ -77,12 +84,14 @@ public abstract class AbstractTCKMojo extends AbstractMojo {
   @Parameter(property = "jdo.tck.dblist", defaultValue = "derby", required = true)
   protected String dblist;
 
-  /**
-   * Implementation to be tested (jdori or iut). Any value other than "jdori" will test an
-   * appropriately configured IUT
-   */
-  @Parameter(property = "jdo.tck.impl", defaultValue = "jdori", required = true)
-  protected String impl;
+  /** List of identity types to be tested. */
+  @Parameter(
+      property = "jdo.tck.identitytypes",
+      defaultValue = "applicationidentity datastoreidentity",
+      required = true)
+  protected String identitytypes;
+
+  protected Collection<String> idtypes = new HashSet<>();
 
   /** Location of implementation log file. */
   @Parameter(
@@ -97,15 +106,6 @@ public abstract class AbstractTCKMojo extends AbstractMojo {
 
   protected Collection<String> dbs = new HashSet<>();
 
-  /** List of identity types to be tested. */
-  @Parameter(
-      property = "jdo.tck.identitytypes",
-      defaultValue = "applicationidentity datastoreidentity",
-      required = true)
-  protected String identitytypes;
-
-  protected Collection<String> idtypes = new HashSet<>();
-
   /**
    * Convenience method to set the cfgList from the file
    * "src/main/resources/conf/configurations.list".
diff --git a/exectck/src/main/java/org/apache/jdo/exectck/Help.java b/exectck/src/main/java/org/apache/jdo/exectck/Help.java
index 8a3abda2..db5c183e 100644
--- a/exectck/src/main/java/org/apache/jdo/exectck/Help.java
+++ b/exectck/src/main/java/org/apache/jdo/exectck/Help.java
@@ -65,27 +65,68 @@ public class Help extends AbstractMojo {
     msg.append("  Default value is \"applicationidentity datastoreidentity\"\n");
     msg.append("* jdo.tck.impl.logfile\n");
     msg.append("  Location of implementation log file. Default: ${user.dir}/datanucleus.txt\n");
+    msg.append("* jdo.tck.doRunTCK\n");
+    msg.append("  Setting this parameter to false will bypass running the TCK.\n");
     msg.append("* jdo.tck.doInstallSchema\n");
     msg.append("  Setting this parameter to false will bypass schema installation.\n");
     msg.append("* jdo.tck.doEnhance\n");
     msg.append("  Setting this parameter to false will bypass enhancement.\n");
-    msg.append("* jdo.tck.doRunTCK\n");
-    msg.append("  Setting this parameter to false will bypass running the TCK.\n");
     msg.append("* jdo.tck.runTCKVerbose\n");
     msg.append(
         "  Setting this parameter to true will display test progress and"
             + "error output while the TCK is running.\n");
+    msg.append("* jdo.tck.verbose:\n");
+    msg.append("  Setting this parameter to true will run the TCK tests in verbose mode.\n");
     msg.append("* jdo.tck.onFailure\n");
     msg.append(
-        "  Specifies how test failures are treated. \"failFast\" will immediately abort the test run. "
-            + "\"failGoal\" (default) will execute the whole TCK (maven goal) before failing. "
-            + "\"logOnly\" will report failures to console and logs only but return 'SUCCESS' to the "
+        "  Specifies how test failures are treated.\n"
+            + "    \"failFast\" will immediately abort the test run.\n"
+            + "    \"failGoal\" (default) will execute the whole TCK (maven goal) before failing.\n"
+            + "    \"logOnly\" will report failures to console and logs only but return 'SUCCESS' to the "
             + "Maven execution environment.\n");
+    msg.append("* jdo.tck.debugTCK:\n");
+    msg.append("  Setting this parameter to true will run the TCK in a debugger.\n");
+    msg.append("* jdo.tck.debug.jvmargs:\n");
+    msg.append("  User-supplied arguments for debug directives.\n");
+    msg.append("* jdo.tck.pmfproperties:\n");
+    msg.append("  Name of file in src/conf containing pmf properties.\n");
+    msg.append("* jdo.tck.excludefile:\n");
+    msg.append(
+        "  Name of file in src/conf containing property jdo.tck.exclude, "
+            + "whose value is a list of files to be excluded from testing.\n");
+    msg.append("* jdo.tck.signaturefile:\n");
+    msg.append(
+        "  Name of the signatute file used to test the signatures of the JDO API classes.\n");
+    msg.append("* jdo.tck.cleanupaftertest:\n");
+    msg.append("  Setting this parameter to false withh retain test output for debugging.\n");
+    msg.append("* jdo.tck.jvmproperties:\n");
+    msg.append("  JVM properties.\n");
+    msg.append("* jdo.tck.logfile:\n");
+    msg.append("  Name of the tck log file.\n");
+    msg.append("* jdo.tck.testrunner.class:\n");
+    msg.append("  Class used to run a batch of tests.\n");
+    msg.append("* jdo.tck.testrunner.details:\n");
+    msg.append(
+        "  Output mode for test run. Use one of: none, summary, flat, tree, verbose, testfeed.\n"
+            + "  If none is selected, then only the summary and test failures are shown.\n");
+    msg.append("* jdo.tck.testrunner.colors:\n");
+    msg.append(
+        "  Setting this parameter to enable displays colors in the junit result log file.\n");
+    msg.append("* jdo.tck.parallel.execution:\n");
+    msg.append(
+        "  Setting this parameter to false will disable parallel exceution of tck test methods in parallel threads.\n");
+    msg.append("* jdo.tck.datastore.supportsQueryCancel:\n");
+    msg.append(
+        "  Setting this parameter to true indicates whether the datastore supports query canceling.\n");
+    msg.append("* project.lib.ext.directory:\n");
+    msg.append("  Location of third party libraries such as JNDI.\n");
+    msg.append("* database.runtck.sysproperties:\n");
+    msg.append("  Properties to use in accessing database.\n");
     msg.append(
         "\n  To run the TCK on an implementation under test, \n"
-            + "      edit the pom.xml in tck and add the iut dependencies to the iut profile\n"
-            + "      and set jdo.tck.impl to iut:\n");
-    msg.append("     mvn integration-test -D jdo.tck.impl=\"iut\"\n\n");
+            + "  edit the pom.xml in tck and add the iut dependencies to the iut profile\n"
+            + "  and set jdo.tck.impl to iut:\n");
+    msg.append("     mvn integration-test -D jdo.tck.impl=\"iut\"\n");
     msg.append("\n END EXECTCK HELP INFORMATION\n");
 
     System.out.println(msg.toString());
diff --git a/exectck/src/main/java/org/apache/jdo/exectck/RunTCK.java b/exectck/src/main/java/org/apache/jdo/exectck/RunTCK.java
index b2528e13..eb0f05fa 100644
--- a/exectck/src/main/java/org/apache/jdo/exectck/RunTCK.java
+++ b/exectck/src/main/java/org/apache/jdo/exectck/RunTCK.java
@@ -62,6 +62,10 @@ public class RunTCK extends AbstractTCKMojo {
   @Parameter(property = "jdo.tck.runTCKVerbose", defaultValue = "false", required = true)
   private boolean runtckVerbose;
 
+  /** Run the TCK tests in verbose mode. */
+  @Parameter(property = "jdo.tck.verbose", defaultValue = "false")
+  private String verbose;
+
   /** Define handling of TCK failures. */
   @Parameter(property = "jdo.tck.onFailure", defaultValue = "failGoal", required = true)
   private String onFailure;
@@ -70,12 +74,12 @@ public class RunTCK extends AbstractTCKMojo {
   @Parameter(property = "jdo.tck.debugTCK", defaultValue = "false", required = true)
   private boolean debugTCK;
 
-  /** Location of third party libraries such as JNDI. */
+  /** User-supplied arguments for debug directives. */
   @Parameter(
-      property = "project.lib.ext.directory",
-      defaultValue = "${basedir}/../lib/ext",
-      required = true)
-  private String extLibsDirectory;
+      property = "jdo.tck.debug.jvmargs",
+      defaultValue =
+          "-Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=${jdo.tck.debug.port}")
+  private String debugDirectives;
 
   /** Name of file in src/conf containing pmf properties. */
   @Parameter(property = "jdo.tck.pmfproperties", defaultValue = "jdori-pmf.properties")
@@ -88,37 +92,20 @@ public class RunTCK extends AbstractTCKMojo {
   @Parameter(property = "jdo.tck.excludefile", defaultValue = "exclude.list", required = true)
   private String exclude;
 
-  /** Run the TCK tests in verbose mode. */
-  @Parameter(property = "jdo.tck.verbose", defaultValue = "false")
-  private String verbose;
-
-  /** To retain test output for debugging, set to false. */
-  @Parameter(property = "jdo.tck.cleanupaftertest", defaultValue = "true")
-  private String cleanupaftertest;
-
-  /** Properties to use in accessing database. */
-  @Parameter(
-      property = "database.runtck.sysproperties",
-      defaultValue = "-Dderby.system.home=${basedir}/target/database/derby")
-  private String dbproperties; // NOTE: only allows for one db
-
-  /** Properties to use in accessing database. */
+  /** Name of the signatute file used to test the signatures of the JDO API classes. */
   @Parameter(
       property = "jdo.tck.signaturefile",
       defaultValue = "${basedir}/src/main/resources/conf/jdo-signatures.txt")
   private String signaturefile;
 
+  /** To retain test output for debugging, set to false. */
+  @Parameter(property = "jdo.tck.cleanupaftertest", defaultValue = "true")
+  private String cleanupaftertest;
+
   /** JVM properties. */
   @Parameter(property = "jdo.tck.jvmproperties", defaultValue = "-Xmx512m")
   private String jvmproperties;
 
-  /** User-supplied arguments for debug directives. */
-  @Parameter(
-      property = "jdo.tck.debug.jvmargs",
-      defaultValue =
-          "-Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=${jdo.tck.debug.port}")
-  private String debugDirectives;
-
   /** Location of tck log file. */
   @Parameter(
       property = "jdo.tck.logfile",
@@ -147,17 +134,27 @@ public class RunTCK extends AbstractTCKMojo {
   @Parameter(property = "jdo.tck.testrunner.colors", defaultValue = "disable", required = true)
   private String testRunnerColors;
 
-  /**
-   * Whether to display colors in the junit result log file (jdo.tck.testrunner.colors=enable) or
-   * not (jdo.tck.testrunner.colors=disable).
-   */
+  /** Whether to run the tck test cases in parallel threads or not. */
   @Parameter(property = "jdo.tck.parallel.execution", defaultValue = "true", required = true)
   private boolean testParallelExecution;
 
-  /** Whether the datastore support query canceling. */
+  /** Whether the datastore supports query canceling. */
   @Parameter(property = "jdo.tck.datastore.supportsQueryCancel", required = false)
   private String datastoreSupportsQueryCancel;
 
+  /** Location of third party libraries such as JNDI. */
+  @Parameter(
+      property = "project.lib.ext.directory",
+      defaultValue = "${basedir}/../lib/ext",
+      required = true)
+  private String extLibsDirectory;
+
+  /** Properties to use in accessing database. */
+  @Parameter(
+      property = "database.runtck.sysproperties",
+      defaultValue = "-Dderby.system.home=${basedir}/target/database/derby")
+  private String dbproperties; // NOTE: only allows for one db
+
   /**
    * Helper method returning the trimmed value of the specified property.
    *