SmokeTestAll: utilize command-line arguments

Author: stephengold

build.gradle

@@ -369,6 +369,7 @@ model {
 }
 
 dependencies {
+    testImplementation(libs.jcommander)  // to parse command-line arguments
     testImplementation(libs.jsnaploader) // to identify the OS and CPU
     testImplementation(libs.junit4)      // framework for automated testing
     testRuntimeOnly(libs.log4j.impl)
@@ -488,6 +489,7 @@ tasks.register('runRagdollSinglePile', JavaExec) {
     mainClass = 'testjoltjni.app.performancetest.PerformanceTest'
 }
 tasks.register('runSmokeTestAll', JavaExec) {
+    args '-n', '99'
     dependsOn('unpackHairStraight', 'unpackJoltAssets')
     description = 'Performs a "smoke test" of each of the Samples tests.'
     mainClass = 'testjoltjni.app.samples.SmokeTestAll'

gradle/libs.versions.toml

@@ -7,6 +7,7 @@ checkstyle = "13.4.2"
 
 [libraries]
 
+jcommander = "org.jcommander:jcommander:1.85"
 jsnaploader = "io.github.electrostat-lab:snaploader:1.1.1-stable"
 junit4 = "junit:junit:4.13.2"
 log4j-impl = "org.apache.logging.log4j:log4j-slf4j2-impl:2.25.4"

src/test/java/testjoltjni/app/samples/SmokeTestAll.java

@@ -21,6 +21,7 @@ of this software and associated documentation files (the "Software"), to deal
  */
 package testjoltjni.app.samples;
 
+import com.beust.jcommander.JCommander;
 import com.github.stephengold.joltjni.*;
 import com.github.stephengold.joltjni.enumerate.EPhysicsUpdateError;
 import com.github.stephengold.joltjni.std.OfStream;
@@ -47,14 +48,6 @@ of this software and associated documentation files (the "Software"), to deal
  * @author Stephen Gold sgold@sonic.net
  */
 final public class SmokeTestAll {
-    // *************************************************************************
-    // constants
-
-    /**
-     * default number of physics steps to simulate during each invocation of
-     * {@code smokeTest()}
-     */
-    final private static int defaultNumSteps = 66;
     // *************************************************************************
     // fields
 
@@ -78,19 +71,33 @@ final public class SmokeTestAll {
      * allocator shared by all physics test objects
      */
     private static TempAllocator tempAllocator;
+    /**
+     * parameters parsed from the command line
+     */
+    final private static TestParameters globalParameters = new TestParameters();
     // *************************************************************************
     // new methods exposed
 
     /**
      * Main entry point for the SmokeTestAll application.
      *
-     * @param arguments array of command-line arguments (not {@code null})
+     * @param arguments the command-line arguments (not {@code null})
      */
     public static void main(String... arguments) {
-        //TestUtils.traceAllocations = true;
+        // Parse the command-line arguments:
+        JCommander jCommander = new JCommander(globalParameters);
+        jCommander.parse(arguments);
+        jCommander.setProgramName("SmokeTestAll");
+        if (globalParameters.helpOnly()) {
+            jCommander.usage();
+            System.exit(0);
+        }
+
+        TestUtils.traceAllocations = globalParameters.traceAllocations();
         TestUtils.loadNativeLibrary();
         TestUtils.initializeNativeLibrary();
 
+        // Log the configuration:
         System.out.println(Jolt.getConfigurationString());
         System.out.print(" built-in compute systems:");
         System.out.print(Jolt.implementsComputeCpu() ? " CPU" : "");
@@ -219,7 +226,7 @@ private static PhysicsSystem newPhysicsSystem(int maxBodies) {
      * @param test the Test object to use (not {@code null})
      */
     private static void smokeTest(Test test) {
-        smokeTest(test, defaultNumSteps);
+        smokeTest(test, globalParameters.numSteps());
     }
 
     /**
@@ -259,16 +266,29 @@ private static void smokeTest(Test test, int numSteps) {
         test.Initialize();
 
         // Single-step the physics numSteps times:
-        for (int i = 0; i < numSteps; ++i) {
+        for (int stepIndex = 1; stepIndex <= numSteps; ++stepIndex) {
+            if (globalParameters.verboseLogging()) {
+                System.out.printf(
+                        "---- step #%d%n      pre-update%n", stepIndex);
+                System.out.flush();
+            }
             PreUpdateParams params = new PreUpdateParams();
             params.mDeltaTime = 0.02f;
             test.PrePhysicsUpdate(params);
 
+            if (globalParameters.verboseLogging()) {
+                System.out.printf("      update%n");
+                System.out.flush();
+            }
             int collisionSteps = 1;
             int errors = physicsSystem.update(params.mDeltaTime, collisionSteps,
                     tempAllocator, jobSystem);
             assert errors == EPhysicsUpdateError.None : errors;
 
+            if (globalParameters.verboseLogging()) {
+                System.out.printf("      post-update%n");
+                System.out.flush();
+            }
             test.PostPhysicsUpdate(params.mDeltaTime);
         }
 

src/test/java/testjoltjni/app/samples/TestParameters.java

@@ -0,0 +1,97 @@
+/*
+Copyright (c) 2026 Stephen Gold
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+ */
+package testjoltjni.app.samples;
+
+import com.beust.jcommander.Parameter;
+
+/**
+ * Command-line parameters of the SmokeTestAll application.
+ *
+ * @author Stephen Gold sgold@sonic.net
+ */
+class TestParameters {
+    // *************************************************************************
+    // fields
+
+    /**
+     * whether to simply display the usage message and exit
+     */
+    @Parameter(names = {"-h", "--help"},
+            description = "Display this usage message and then exit.")
+    private boolean helpOnly;
+    /**
+     * number of physics steps to simulate for each test
+     */
+    @Parameter(names = {"-n", "--numSteps"},
+            description = "Number of physics steps to simulate for each test.")
+    private int numSteps = 1;
+    /**
+     * whether to trace heap allocations in the JNI glue code
+     */
+    @Parameter(names = {"-t", "--traceAllocations"},
+            description = "Trace heap allocations in JNI glue code.")
+    private boolean traceAllocations;
+    /**
+     * whether log output should be verbose
+     */
+    @Parameter(names = {"-v", "--verbose"},
+            description = "Generate additional log output.")
+    private boolean verboseLogging;
+    // *************************************************************************
+    // new methods exposed
+
+    /**
+     * Test whether to display the usage message and then exit.
+     *
+     * @return {@code true} to display the message, otherwise {@code false}
+     */
+    boolean helpOnly() {
+        return helpOnly;
+    }
+
+    /**
+     * Return the number of physics steps to simulate for each test.
+     *
+     * @return the number
+     */
+    int numSteps() {
+        return numSteps;
+    }
+
+    /**
+     * Test whether to trace heap allocations in the JNI glue code.
+     *
+     * @return {@code true} to trace, otherwise {@code false}
+     */
+    boolean traceAllocations() {
+        return traceAllocations;
+    }
+
+    /**
+     * Test whether the verbose-logging option was specified.
+     *
+     * @return true if specified, otherwise false
+     */
+    boolean verboseLogging() {
+        return verboseLogging;
+    }
+}