Minor renames and class removal refactorings.

Author: dweiss

etc/junit4-missing-features.txt

@@ -15,6 +15,8 @@
      randomBoolean(), randomFloat(), etc.
    - Encourages testing over a broad input domain rather than fixed values
 
+* utility rules (require assertions, etc.)
+
 [possibly doable with a custom test engine]
 
 - predictably shuffled test execution order
@@ -27,4 +29,4 @@
 - how are jupiter timeouts working together with leaked threads ext.?
 - maybe bring back thread leak zombies annotation (if we can't cleanly terminate leaked threads, ignore all remaining tests).
 - maybe move some of the implementation details to a non-exposed package?
-- regenerate the javadocs with public API only.
+- regenerate the javadocs with public API only.

etc/problems-thoughts.md

@@ -12,8 +12,8 @@
  * This annotation should be placed on classes or methods that are {@link Randomized} and would like
  * to use a constant seed (for reproducing a problem or other reasons).
  *
- * <p>Note that seed fixing is always possible by setting {@link
- * RandomizedContextExtension.SysProps#TESTS_SEED} system property, this is just convenience.
+ * <p>Note that seed fixing is always possible by setting {@link SysProps#TESTS_SEED} system
+ * property, this is just convenience.
  */
 @Target({ElementType.TYPE, ElementType.METHOD})
 @Documented

randomizedtesting-jupiter/src/main/java/com/carrotsearch/randomizedtesting/jupiter/FixSeed.java

@@ -0,0 +1,47 @@
+package com.carrotsearch.randomizedtesting.jupiter;
+
+import com.carrotsearch.randomizedtesting.jupiter.internals.Xoroshiro128PlusRandom;
+import java.util.Locale;
+import java.util.Random;
+import java.util.function.LongFunction;
+import java.util.function.Supplier;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+/** The supplier of {@link Random} instances. */
+public enum RandomInstanceFactory implements Supplier<LongFunction<Random>> {
+  /** The default, built-in {@link Random}. There may be some synchronization overhead. */
+  JDK,
+
+  /**
+   * Xoroshiro128PlusRandom. Not synchronized anywhere.
+   *
+   * @see "https://prng.di.unimi.it/"
+   */
+  XOROSHIRO_128_PLUS;
+
+  public static RandomInstanceFactory parse(String v) {
+    try {
+      return RandomInstanceFactory.valueOf(v.toUpperCase(Locale.ROOT));
+    } catch (IllegalArgumentException e) {
+      throw new IllegalArgumentException(
+          "Can't parse "
+              + SysProps.TESTS_RANDOM_FACTORY.propertyKey
+              + " property: "
+              + v
+              + " [valid values: "
+              + Stream.of(RandomInstanceFactory.values())
+                  .map(vv -> vv.name().toLowerCase(Locale.ROOT))
+                  .collect(Collectors.joining(", "))
+              + "]");
+    }
+  }
+
+  @Override
+  public LongFunction<Random> get() {
+    return switch (this) {
+      case JDK -> Random::new;
+      case XOROSHIRO_128_PLUS -> Xoroshiro128PlusRandom::new;
+    };
+  }
+}

randomizedtesting-jupiter/src/main/java/com/carrotsearch/randomizedtesting/jupiter/RandomInstanceFactory.java

@@ -0,0 +1,29 @@
+package com.carrotsearch.randomizedtesting.jupiter;
+
+import java.util.Random;
+
+/** System properties controlling the runtime behavior of this project extensions. */
+public enum SysProps {
+  /** Initial root seed value. If empty, a random value is picked for the root seed. */
+  TESTS_SEED("tests.seed"),
+
+  /**
+   * String name of the factory used to create {@link Random} instances (see {@link
+   * RandomInstanceFactory} for named implementations).
+   *
+   * @see RandomInstanceFactory
+   */
+  TESTS_RANDOM_FACTORY("tests.random.factory"),
+
+  /**
+   * A boolean property that enables stricter sanity assertions (including forbidding thread-shared
+   * access to the returned {@link Random} instances, which makes tests more predictable).
+   */
+  TESTS_RANDOM_ASSERTING("tests.random.asserting");
+
+  public final String propertyKey;
+
+  SysProps(String key) {
+    this.propertyKey = key;
+  }
+}

randomizedtesting-jupiter/src/main/java/com/carrotsearch/randomizedtesting/jupiter/SysProps.java

@@ -1,18 +1,17 @@
 package com.carrotsearch.randomizedtesting.jupiter.internals;
 
+import com.carrotsearch.randomizedtesting.jupiter.RandomInstanceFactory;
 import com.carrotsearch.randomizedtesting.jupiter.RandomizedContext;
 import com.carrotsearch.randomizedtesting.jupiter.Seed;
 import com.carrotsearch.randomizedtesting.jupiter.SeedChain;
+import com.carrotsearch.randomizedtesting.jupiter.SysProps;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
-import java.util.Locale;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.Random;
-import java.util.function.Supplier;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
+import java.util.function.LongFunction;
 import org.junit.jupiter.api.extension.BeforeAllCallback;
 import org.junit.jupiter.api.extension.ExtensionContext;
 import org.junit.jupiter.api.extension.LifecycleMethodExecutionExceptionHandler;
@@ -31,71 +30,14 @@ public class RandomizedContextExtension
 
   private static final String CTX_KEY_RANDOMIZED_CONTEXT = "randomizedContext";
 
-  /** System properties controlling the extension. */
-  public enum SysProps {
-    /** Initial root seed value. If empty, a random value is picked for the root seed. */
-    TESTS_SEED("tests.seed"),
-
-    /**
-     * String name of the factory used to create {@link Random} instances (see {@link
-     * RandomFactoryType} for named implementations).
-     *
-     * @see RandomFactoryType
-     */
-    TESTS_RANDOM_FACTORY("tests.random.factory"),
-
-    /**
-     * A boolean property that enables stricter sanity assertions (including forbidding
-     * thread-shared access to the returned {@link Random} instances, which makes tests more
-     * predictable).
-     */
-    TESTS_RANDOM_ASSERTING("tests.random.asserting");
-
-    public final String propertyKey;
-
-    SysProps(String key) {
-      this.propertyKey = key;
-    }
-  }
-
-  public enum RandomFactoryType implements Supplier<RandomFactory> {
-    JDK,
-    XOROSHIRO_128_PLUS;
-
-    public static RandomFactoryType parse(String v) {
-      try {
-        return RandomFactoryType.valueOf(v.toUpperCase(Locale.ROOT));
-      } catch (IllegalArgumentException e) {
-        throw new IllegalArgumentException(
-            "Can't parse "
-                + SysProps.TESTS_RANDOM_FACTORY.propertyKey
-                + " property: "
-                + v
-                + " [valid values: "
-                + Stream.of(RandomFactoryType.values())
-                    .map(vv -> vv.name().toLowerCase(Locale.ROOT))
-                    .collect(Collectors.joining(", "))
-                + "]");
-      }
-    }
-
-    @Override
-    public RandomFactory get() {
-      return switch (this) {
-        case JDK -> Random::new;
-        case XOROSHIRO_128_PLUS -> Xoroshiro128PlusRandom::new;
-      };
-    }
-  }
-
   //
   // before-all (class-level context setup).
   //
 
   @Override
   public void beforeAll(ExtensionContext extensionContext) {
     // Set up Random factory.
-    RandomFactory randomFactory = initializeRandomFactory(extensionContext);
+    var randomFactory = initializeRandomFactory(extensionContext);
 
     // Bootstrap the root store's context. Don't know if this can be done
     // in a more elegant way.
@@ -121,12 +63,12 @@ public void beforeAll(ExtensionContext extensionContext) {
             });
   }
 
-  private static RandomFactory initializeRandomFactory(ExtensionContext extensionContext) {
-    RandomFactory randomFactory =
+  private static LongFunction<Random> initializeRandomFactory(ExtensionContext extensionContext) {
+    var randomFactory =
         extensionContext
             .getConfigurationParameter(SysProps.TESTS_RANDOM_FACTORY.propertyKey)
-            .map(RandomFactoryType::parse)
-            .orElse(RandomFactoryType.XOROSHIRO_128_PLUS)
+            .map(RandomInstanceFactory::parse)
+            .orElse(RandomInstanceFactory.XOROSHIRO_128_PLUS)
             .get();
 
     if (extensionContext

randomizedtesting-jupiter/src/main/java/com/carrotsearch/randomizedtesting/jupiter/internals/RandomFactory.java

@@ -5,13 +5,15 @@
 import com.carrotsearch.randomizedtesting.jupiter.RandomizedContext;
 import com.carrotsearch.randomizedtesting.jupiter.Seed;
 import com.carrotsearch.randomizedtesting.jupiter.SeedChain;
+import com.carrotsearch.randomizedtesting.jupiter.SysProps;
 import java.io.Closeable;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Locale;
 import java.util.Objects;
 import java.util.Random;
+import java.util.function.LongFunction;
 import org.junit.jupiter.api.extension.ExtensionContext;
 
 public final class RandomizedContextImpl implements Closeable, RandomizedContext {
@@ -22,12 +24,12 @@ public final class RandomizedContextImpl implements Closeable, RandomizedContext
   private final SeedChain remainingSeedChain;
 
   private final Random random;
-  private final RandomFactory randomFactory;
+  private final LongFunction<Random> randomFactory;
 
   RandomizedContextImpl(
       String contextId,
       RandomizedContextImpl parent,
-      RandomFactory randomFactory,
+      LongFunction<Random> randomFactory,
       Seed seed,
       SeedChain remainingSeedChain) {
     this.contextId = contextId;
@@ -61,7 +63,7 @@ private RandomizedContextImpl getParent() {
 
   /**
    * @return Returns the root seed (randomization source).
-   * @see RandomizedContextExtension.SysProps#TESTS_SEED
+   * @see SysProps#TESTS_SEED
    */
   @Override
   public Seed getRootSeed() {

randomizedtesting-jupiter/src/main/java/com/carrotsearch/randomizedtesting/jupiter/internals/RandomizedContextExtension.java

@@ -6,6 +6,7 @@
 import com.carrotsearch.randomizedtesting.jupiter.Randomized;
 import com.carrotsearch.randomizedtesting.jupiter.RandomizedContext;
 import com.carrotsearch.randomizedtesting.jupiter.SeedChain;
+import com.carrotsearch.randomizedtesting.jupiter.SysProps;
 import com.carrotsearch.randomizedtesting.jupiter.internals.RandomizedContextExtension;
 import com.carrotsearch.randomizedtesting.tests.infra.IgnoreInStandaloneRuns;
 import java.io.PrintWriter;
@@ -35,8 +36,7 @@ class TestFixedSeedInjection {
     public void testAllHooks() {
       collectExecutionResults(
               testKitBuilder(T1.class)
-                  .configurationParameter(
-                      RandomizedContextExtension.SysProps.TESTS_SEED.propertyKey, "dead:beef:cafe"))
+                  .configurationParameter(SysProps.TESTS_SEED.propertyKey, "dead:beef:cafe"))
           .results()
           .allEvents()
           .assertThatEvents()
@@ -162,8 +162,7 @@ public void identicalDerivedSeedWithTestFiltering() {
       var executionResult1 =
           collectExecutionResults(
               testKitBuilder(TestIdenticalRandomWithTestFiltering.class)
-                  .configurationParameter(
-                      RandomizedContextExtension.SysProps.TESTS_SEED.propertyKey, "deadbeed"));
+                  .configurationParameter(SysProps.TESTS_SEED.propertyKey, "deadbeed"));
 
       // select just one of the tests and pick it by its unique id. then re-run it.
       // the seed/ random should be identical because the re-run starts from the same root
@@ -173,8 +172,7 @@ public void identicalDerivedSeedWithTestFiltering() {
       var executionResult2 =
           collectExecutionResults(
               testKitBuilder()
-                  .configurationParameter(
-                      RandomizedContextExtension.SysProps.TESTS_SEED.propertyKey, "deadbeed")
+                  .configurationParameter(SysProps.TESTS_SEED.propertyKey, "deadbeed")
                   .selectors(DiscoverySelectors.selectUniqueId(pickedTest)));
 
       String o1 = executionResult1.capturedOutput().get(pickedTest);

randomizedtesting-jupiter/src/main/java/com/carrotsearch/randomizedtesting/jupiter/internals/RandomizedContextImpl.java

@@ -6,6 +6,7 @@
 
 import com.carrotsearch.randomizedtesting.jupiter.Randomized;
 import com.carrotsearch.randomizedtesting.jupiter.RandomizedContext;
+import com.carrotsearch.randomizedtesting.jupiter.SysProps;
 import com.carrotsearch.randomizedtesting.jupiter.internals.RandomizedContextExtension;
 import com.carrotsearch.randomizedtesting.tests.infra.IgnoreInStandaloneRuns;
 import java.util.stream.Stream;
@@ -27,8 +28,7 @@ class TestRootSeedIsAvailable {
     public void checkAtMethodLevel() {
       collectExecutionResults(
               testKitBuilder(AtTestLevel.class)
-                  .configurationParameter(
-                      RandomizedContextExtension.SysProps.TESTS_SEED.propertyKey, "dead"))
+                  .configurationParameter(SysProps.TESTS_SEED.propertyKey, "dead"))
           .results()
           .testEvents()
           .finished()
@@ -62,8 +62,7 @@ Stream<DynamicTest> dynamicTestsFromIterator() {
     private void runCheck(Check e) {
       collectExecutionResults(
               testKitBuilder(e.clazz())
-                  .configurationParameter(
-                      RandomizedContextExtension.SysProps.TESTS_SEED.propertyKey, "dead:beef:cafe"))
+                  .configurationParameter(SysProps.TESTS_SEED.propertyKey, "dead:beef:cafe"))
           .results()
           .allEvents()
           .finished()