refactor: testing utilities

build/bom/pom.xml

@@ -150,23 +150,6 @@
         <type>test-jar</type>
         <version>${version.ai.timefold.solver}</version>
       </dependency>
-      <dependency>
-        <groupId>ai.timefold.solver</groupId>
-        <artifactId>timefold-solver-test</artifactId>
-        <version>${version.ai.timefold.solver}</version>
-      </dependency>
-      <dependency>
-        <groupId>ai.timefold.solver</groupId>
-        <artifactId>timefold-solver-test</artifactId>
-        <version>${version.ai.timefold.solver}</version>
-        <classifier>sources</classifier>
-      </dependency>
-      <dependency>
-        <groupId>ai.timefold.solver</groupId>
-        <artifactId>timefold-solver-test</artifactId>
-        <type>test-jar</type>
-        <version>${version.ai.timefold.solver}</version>
-      </dependency>
       <!-- quarkus-integration -->
       <dependency>
         <groupId>ai.timefold.solver</groupId>

core/src/main/java/ai/timefold/solver/core/api/score/analysis/MatchAnalysis.java

@@ -24,7 +24,7 @@ public record MatchAnalysis<Score_ extends Score<Score_>>(ConstraintRef constrai
         Objects.requireNonNull(constraintRef);
         Objects.requireNonNull(score);
         // Null justification is impossible;
-        // if the fetch policy doesn't requre match analysis, the code shouldn't even get here.
+        // if the fetch policy doesn't require match analysis, the code shouldn't even get here.
         Objects.requireNonNull(justification, () -> """
                 Impossible state: Received a null justification.
                 Maybe check your %s's justifyWith() implementation for that constraint?"""

tools/test/src/main/java/ai/timefold/solver/test/api/score/stream/ConstraintVerifier.java → core/src/main/java/ai/timefold/solver/core/api/score/stream/test/ConstraintVerifier.java

@@ -1,4 +1,4 @@
-package ai.timefold.solver.test.api.score.stream;
+package ai.timefold.solver.core.api.score.stream.test;
 
 import static java.util.Objects.requireNonNull;
 
@@ -13,7 +13,7 @@
 import ai.timefold.solver.core.config.solver.SolverConfig;
 import ai.timefold.solver.core.config.util.ConfigUtils;
 import ai.timefold.solver.core.impl.domain.solution.descriptor.SolutionDescriptor;
-import ai.timefold.solver.test.impl.score.stream.DefaultConstraintVerifier;
+import ai.timefold.solver.core.impl.score.stream.test.DefaultConstraintVerifier;
 
 import org.jspecify.annotations.NonNull;
 

tools/test/src/main/java/ai/timefold/solver/test/api/score/stream/MultiConstraintAssertion.java → core/src/main/java/ai/timefold/solver/core/api/score/stream/test/MultiConstraintAssertion.java

@@ -1,4 +1,4 @@
-package ai.timefold.solver.test.api.score.stream;
+package ai.timefold.solver.core.api.score.stream.test;
 
 import ai.timefold.solver.core.api.score.Score;
 import ai.timefold.solver.core.api.score.stream.ConstraintProvider;

tools/test/src/main/java/ai/timefold/solver/test/api/score/stream/MultiConstraintVerification.java → core/src/main/java/ai/timefold/solver/core/api/score/stream/test/MultiConstraintVerification.java

@@ -1,4 +1,4 @@
-package ai.timefold.solver.test.api.score.stream;
+package ai.timefold.solver.core.api.score.stream.test;
 
 import org.jspecify.annotations.NonNull;
 

tools/test/src/main/java/ai/timefold/solver/test/api/score/stream/ShadowVariableAwareMultiConstraintAssertion.java → core/src/main/java/ai/timefold/solver/core/api/score/stream/test/ShadowVariableAwareMultiConstraintAssertion.java

@@ -1,4 +1,4 @@
-package ai.timefold.solver.test.api.score.stream;
+package ai.timefold.solver.core.api.score.stream.test;
 
 public interface ShadowVariableAwareMultiConstraintAssertion extends MultiConstraintAssertion {
 

tools/test/src/main/java/ai/timefold/solver/test/api/score/stream/ShadowVariableAwareSingleConstraintAssertion.java → core/src/main/java/ai/timefold/solver/core/api/score/stream/test/ShadowVariableAwareSingleConstraintAssertion.java

@@ -1,4 +1,4 @@
-package ai.timefold.solver.test.api.score.stream;
+package ai.timefold.solver.core.api.score.stream.test;
 
 public interface ShadowVariableAwareSingleConstraintAssertion extends SingleConstraintAssertion {
 

tools/test/src/main/java/ai/timefold/solver/test/api/score/stream/SingleConstraintAssertion.java → core/src/main/java/ai/timefold/solver/core/api/score/stream/test/SingleConstraintAssertion.java

@@ -1,4 +1,4 @@
-package ai.timefold.solver.test.api.score.stream;
+package ai.timefold.solver.core.api.score.stream.test;
 
 import java.math.BigDecimal;
 

tools/test/src/main/java/ai/timefold/solver/test/api/score/stream/SingleConstraintVerification.java → core/src/main/java/ai/timefold/solver/core/api/score/stream/test/SingleConstraintVerification.java

@@ -1,4 +1,4 @@
-package ai.timefold.solver.test.api.score.stream;
+package ai.timefold.solver.core.api.score.stream.test;
 
 import ai.timefold.solver.core.api.domain.variable.InverseRelationShadowVariable;
 import ai.timefold.solver.core.api.domain.variable.PlanningListVariable;

tools/test/src/main/java/ai/timefold/solver/test/api/solver/change/MockProblemChangeDirector.java → core/src/main/java/ai/timefold/solver/core/api/solver/change/MockProblemChangeDirector.java

@@ -1,21 +1,18 @@
-package ai.timefold.solver.test.api.solver.change;
+package ai.timefold.solver.core.api.solver.change;
 
 import java.util.IdentityHashMap;
 import java.util.Map;
 import java.util.function.Consumer;
 
-import ai.timefold.solver.core.api.solver.change.ProblemChangeDirector;
-
-import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.NullMarked;
 import org.jspecify.annotations.Nullable;
 
 /**
- * Use for unit-testing {@link ai.timefold.solver.core.api.solver.change.ProblemChange}s.
- *
+ * Use for unit-testing {@link ProblemChange}s.
  * Together with Mockito this class makes it possible to verify that a
- * {@link ai.timefold.solver.core.api.solver.change.ProblemChange} implementation correctly calls methods of
+ * {@link ProblemChange} implementation correctly calls methods of
  * the {@link ProblemChangeDirector}.
- *
+ * <p>
  * Example of usage:
  *
  * <pre>
@@ -27,41 +24,39 @@
  * }
  * </pre>
  */
+@NullMarked
 public class MockProblemChangeDirector implements ProblemChangeDirector {
 
     private Map<Object, Object> lookUpTable = new IdentityHashMap<>();
 
     @Override
-    public <Entity> void addEntity(@NonNull Entity entity, @NonNull Consumer<Entity> entityConsumer) {
+    public <Entity> void addEntity(Entity entity, Consumer<Entity> entityConsumer) {
         entityConsumer.accept(this.lookUpWorkingObject(entity));
     }
 
     @Override
-    public <Entity> void removeEntity(@NonNull Entity entity, Consumer<Entity> entityConsumer) {
+    public <Entity> void removeEntity(Entity entity, Consumer<Entity> entityConsumer) {
         entityConsumer.accept(this.lookUpWorkingObject(entity));
     }
 
     @Override
-    public <Entity> void changeVariable(@NonNull Entity entity, @NonNull String variableName,
-            @NonNull Consumer<Entity> entityConsumer) {
+    public <Entity> void changeVariable(Entity entity, String variableName, Consumer<Entity> entityConsumer) {
         entityConsumer.accept(this.lookUpWorkingObject(entity));
     }
 
     @Override
-    public <ProblemFact> void addProblemFact(@NonNull ProblemFact problemFact,
-            @NonNull Consumer<ProblemFact> problemFactConsumer) {
+    public <ProblemFact> void addProblemFact(ProblemFact problemFact, Consumer<ProblemFact> problemFactConsumer) {
         problemFactConsumer.accept(this.lookUpWorkingObject(problemFact));
     }
 
     @Override
-    public <ProblemFact> void removeProblemFact(@NonNull ProblemFact problemFact,
-            @NonNull Consumer<ProblemFact> problemFactConsumer) {
+    public <ProblemFact> void removeProblemFact(ProblemFact problemFact, Consumer<ProblemFact> problemFactConsumer) {
         problemFactConsumer.accept(this.lookUpWorkingObject(problemFact));
     }
 
     @Override
-    public <EntityOrProblemFact> void changeProblemProperty(@NonNull EntityOrProblemFact problemFactOrEntity,
-            @NonNull Consumer<EntityOrProblemFact> problemFactOrEntityConsumer) {
+    public <EntityOrProblemFact> void changeProblemProperty(EntityOrProblemFact problemFactOrEntity,
+            Consumer<EntityOrProblemFact> problemFactOrEntityConsumer) {
         problemFactOrEntityConsumer.accept(this.lookUpWorkingObject(problemFactOrEntity));
     }
 
@@ -86,7 +81,7 @@ public void updateShadowVariables() {
     /**
      * Defines what {@link #lookUpWorkingObject(Object)} returns.
      */
-    public @NonNull LookUpMockBuilder whenLookingUp(Object forObject) {
+    public LookUpMockBuilder whenLookingUp(Object forObject) {
         return new LookUpMockBuilder(forObject);
     }
 

core/src/main/java/ai/timefold/solver/core/api/solver/change/ProblemChangeDirector.java

@@ -19,6 +19,7 @@
  * To see an example implementation, please refer to the {@link ProblemChange} Javadoc.
  *
  * @see Lookup You may need to perform lookups of working objects from external objects.
+ * @see MockProblemChangeDirector You may need to use this for testing purposes.
  */
 @NullMarked
 public interface ProblemChangeDirector

core/src/main/java/ai/timefold/solver/core/impl/move/DefaultMoveTestContext.java

@@ -5,8 +5,8 @@
 
 import ai.timefold.solver.core.impl.score.director.AbstractScoreDirector;
 import ai.timefold.solver.core.preview.api.move.Move;
-import ai.timefold.solver.core.preview.api.move.MoveTestContext;
 import ai.timefold.solver.core.preview.api.move.SolutionView;
+import ai.timefold.solver.core.preview.api.move.test.MoveTestContext;
 
 import org.jspecify.annotations.NullMarked;
 

core/src/main/java/ai/timefold/solver/core/impl/move/DefaultMoveTester.java

@@ -6,8 +6,8 @@
 import ai.timefold.solver.core.impl.domain.solution.descriptor.DefaultPlanningSolutionMetaModel;
 import ai.timefold.solver.core.impl.score.director.AbstractScoreDirectorFactory;
 import ai.timefold.solver.core.preview.api.domain.metamodel.PlanningSolutionMetaModel;
-import ai.timefold.solver.core.preview.api.move.MoveTestContext;
-import ai.timefold.solver.core.preview.api.move.MoveTester;
+import ai.timefold.solver.core.preview.api.move.test.MoveTestContext;
+import ai.timefold.solver.core.preview.api.move.test.MoveTester;
 
 import org.jspecify.annotations.NullMarked;
 

core/src/main/java/ai/timefold/solver/core/impl/neighborhood/DefaultNeighborhoodTestContext.java

@@ -7,8 +7,8 @@
 import ai.timefold.solver.core.impl.localsearch.scope.LocalSearchPhaseScope;
 import ai.timefold.solver.core.impl.localsearch.scope.LocalSearchStepScope;
 import ai.timefold.solver.core.preview.api.move.Move;
-import ai.timefold.solver.core.preview.api.move.MoveTestContext;
-import ai.timefold.solver.core.preview.api.neighborhood.NeighborhoodTestContext;
+import ai.timefold.solver.core.preview.api.move.test.MoveTestContext;
+import ai.timefold.solver.core.preview.api.neighborhood.test.NeighborhoodTestContext;
 
 import org.jspecify.annotations.NullMarked;
 

core/src/main/java/ai/timefold/solver/core/impl/neighborhood/DefaultNeighborhoodTester.java

@@ -10,10 +10,10 @@
 import ai.timefold.solver.core.impl.neighborhood.stream.DefaultMoveStreamFactory;
 import ai.timefold.solver.core.impl.solver.scope.SolverScope;
 import ai.timefold.solver.core.preview.api.domain.metamodel.PlanningSolutionMetaModel;
-import ai.timefold.solver.core.preview.api.move.MoveTester;
+import ai.timefold.solver.core.preview.api.move.test.MoveTester;
 import ai.timefold.solver.core.preview.api.neighborhood.MoveProvider;
-import ai.timefold.solver.core.preview.api.neighborhood.NeighborhoodTestContext;
-import ai.timefold.solver.core.preview.api.neighborhood.NeighborhoodTester;
+import ai.timefold.solver.core.preview.api.neighborhood.test.NeighborhoodTestContext;
+import ai.timefold.solver.core.preview.api.neighborhood.test.NeighborhoodTester;
 
 import org.jspecify.annotations.NullMarked;
 

tools/test/src/main/java/ai/timefold/solver/test/impl/score/stream/AbstractConstraintAssertion.java → core/src/main/java/ai/timefold/solver/core/impl/score/stream/test/AbstractConstraintAssertion.java

@@ -1,4 +1,4 @@
-package ai.timefold.solver.test.impl.score.stream;
+package ai.timefold.solver.core.impl.score.stream.test;
 
 import java.util.Map;
 

tools/test/src/main/java/ai/timefold/solver/test/impl/score/stream/AbstractConstraintVerification.java → core/src/main/java/ai/timefold/solver/core/impl/score/stream/test/AbstractConstraintVerification.java

@@ -1,4 +1,4 @@
-package ai.timefold.solver.test.impl.score.stream;
+package ai.timefold.solver.core.impl.score.stream.test;
 
 import java.util.Arrays;
 import java.util.Collection;
@@ -29,7 +29,7 @@ protected void assertCorrectArguments(Object... facts) {
                     "Maybe call givenSolution() instead?", facts[0]);
         }
         Arrays.stream(facts)
-                .filter(fact -> fact instanceof Collection)
+                .filter(Collection.class::isInstance)
                 .findFirst()
                 .ifPresent(collection -> LOGGER.warn("Called given() with collection ({}) as argument." +
                         "This will treat the collection itself as a fact, and not its contents.\n" +

tools/test/src/main/java/ai/timefold/solver/test/impl/score/stream/AbstractMultiConstraintAssertion.java → core/src/main/java/ai/timefold/solver/core/impl/score/stream/test/AbstractMultiConstraintAssertion.java

@@ -1,4 +1,4 @@
-package ai.timefold.solver.test.impl.score.stream;
+package ai.timefold.solver.core.impl.score.stream.test;
 
 import static java.util.Objects.requireNonNull;
 
@@ -9,10 +9,10 @@
 import ai.timefold.solver.core.api.score.constraint.ConstraintMatchTotal;
 import ai.timefold.solver.core.api.score.constraint.Indictment;
 import ai.timefold.solver.core.api.score.stream.ConstraintProvider;
+import ai.timefold.solver.core.api.score.stream.test.MultiConstraintAssertion;
 import ai.timefold.solver.core.impl.score.DefaultScoreExplanation;
 import ai.timefold.solver.core.impl.score.director.InnerScore;
 import ai.timefold.solver.core.impl.score.stream.common.AbstractConstraintStreamScoreDirectorFactory;
-import ai.timefold.solver.test.api.score.stream.MultiConstraintAssertion;
 
 import org.jspecify.annotations.NonNull;
 

tools/test/src/main/java/ai/timefold/solver/test/impl/score/stream/AbstractSingleConstraintAssertion.java → core/src/main/java/ai/timefold/solver/core/impl/score/stream/test/AbstractSingleConstraintAssertion.java

@@ -1,4 +1,4 @@
-package ai.timefold.solver.test.impl.score.stream;
+package ai.timefold.solver.core.impl.score.stream.test;
 
 import static java.util.Collections.emptyList;
 import static java.util.Objects.requireNonNull;
@@ -16,14 +16,14 @@
 import ai.timefold.solver.core.api.score.constraint.ConstraintMatchTotal;
 import ai.timefold.solver.core.api.score.constraint.Indictment;
 import ai.timefold.solver.core.api.score.stream.ConstraintJustification;
+import ai.timefold.solver.core.api.score.stream.test.SingleConstraintAssertion;
 import ai.timefold.solver.core.impl.score.DefaultScoreExplanation;
 import ai.timefold.solver.core.impl.score.definition.ScoreDefinition;
 import ai.timefold.solver.core.impl.score.director.InnerScore;
 import ai.timefold.solver.core.impl.score.stream.common.AbstractConstraint;
 import ai.timefold.solver.core.impl.score.stream.common.AbstractConstraintStreamScoreDirectorFactory;
 import ai.timefold.solver.core.impl.score.stream.common.ScoreImpactType;
 import ai.timefold.solver.core.impl.util.Pair;
-import ai.timefold.solver.test.api.score.stream.SingleConstraintAssertion;
 
 import org.jspecify.annotations.NonNull;
 import org.jspecify.annotations.Nullable;
@@ -749,13 +749,11 @@ private String buildNoImpactAssertionErrorMessage(Number actualImpact, String co
     }
 
     private static String getImpactTypeLabel(ScoreImpactType scoreImpactType) {
-        if (scoreImpactType == ScoreImpactType.PENALTY) {
-            return "penalty";
-        } else if (scoreImpactType == ScoreImpactType.REWARD) {
-            return "reward";
-        } else { // Needs to work with null.
-            return "impact";
-        }
+        return switch (scoreImpactType) {
+            case PENALTY -> "penalty";
+            case REWARD -> "reward";
+            case MIXED -> "impact";
+        };
     }
 
 }

tools/test/src/main/java/ai/timefold/solver/test/impl/score/stream/ConfiguredConstraintVerifier.java → core/src/main/java/ai/timefold/solver/core/impl/score/stream/test/ConfiguredConstraintVerifier.java

@@ -1,4 +1,4 @@
-package ai.timefold.solver.test.impl.score.stream;
+package ai.timefold.solver.core.impl.score.stream.test;
 
 import static java.util.Objects.requireNonNull;
 
@@ -10,9 +10,9 @@
 import ai.timefold.solver.core.api.score.stream.Constraint;
 import ai.timefold.solver.core.api.score.stream.ConstraintFactory;
 import ai.timefold.solver.core.api.score.stream.ConstraintProvider;
+import ai.timefold.solver.core.api.score.stream.test.ConstraintVerifier;
 import ai.timefold.solver.core.config.solver.EnvironmentMode;
 import ai.timefold.solver.core.impl.domain.solution.descriptor.SolutionDescriptor;
-import ai.timefold.solver.test.api.score.stream.ConstraintVerifier;
 
 /**
  * Represents a {@link ConstraintVerifier} with pre-set values.

tools/test/src/main/java/ai/timefold/solver/test/impl/score/stream/DefaultConstraintVerifier.java → core/src/main/java/ai/timefold/solver/core/impl/score/stream/test/DefaultConstraintVerifier.java

@@ -1,4 +1,4 @@
-package ai.timefold.solver.test.impl.score.stream;
+package ai.timefold.solver.core.impl.score.stream.test;
 
 import java.util.concurrent.atomic.AtomicReference;
 import java.util.function.BiFunction;
@@ -7,8 +7,8 @@
 import ai.timefold.solver.core.api.score.stream.Constraint;
 import ai.timefold.solver.core.api.score.stream.ConstraintFactory;
 import ai.timefold.solver.core.api.score.stream.ConstraintProvider;
+import ai.timefold.solver.core.api.score.stream.test.ConstraintVerifier;
 import ai.timefold.solver.core.impl.domain.solution.descriptor.SolutionDescriptor;
-import ai.timefold.solver.test.api.score.stream.ConstraintVerifier;
 
 import org.jspecify.annotations.NonNull;
 

tools/test/src/main/java/ai/timefold/solver/test/impl/score/stream/DefaultMultiConstraintAssertion.java → core/src/main/java/ai/timefold/solver/core/impl/score/stream/test/DefaultMultiConstraintAssertion.java

@@ -1,4 +1,4 @@
-package ai.timefold.solver.test.impl.score.stream;
+package ai.timefold.solver.core.impl.score.stream.test;
 
 import java.util.Map;
 

tools/test/src/main/java/ai/timefold/solver/test/impl/score/stream/DefaultMultiConstraintVerification.java → core/src/main/java/ai/timefold/solver/core/impl/score/stream/test/DefaultMultiConstraintVerification.java

@@ -1,9 +1,9 @@
-package ai.timefold.solver.test.impl.score.stream;
+package ai.timefold.solver.core.impl.score.stream.test;
 
 import ai.timefold.solver.core.api.score.Score;
 import ai.timefold.solver.core.api.score.stream.ConstraintProvider;
+import ai.timefold.solver.core.api.score.stream.test.MultiConstraintVerification;
 import ai.timefold.solver.core.impl.score.stream.common.AbstractConstraintStreamScoreDirectorFactory;
-import ai.timefold.solver.test.api.score.stream.MultiConstraintVerification;
 
 import org.jspecify.annotations.NonNull;
 

tools/test/src/main/java/ai/timefold/solver/test/impl/score/stream/DefaultShadowVariableAwareMultiConstraintAssertion.java → core/src/main/java/ai/timefold/solver/core/impl/score/stream/test/DefaultShadowVariableAwareMultiConstraintAssertion.java

@@ -1,15 +1,15 @@
-package ai.timefold.solver.test.impl.score.stream;
+package ai.timefold.solver.core.impl.score.stream.test;
 
 import static java.util.Objects.requireNonNull;
 
 import java.util.Objects;
 
 import ai.timefold.solver.core.api.score.Score;
 import ai.timefold.solver.core.api.score.stream.ConstraintProvider;
+import ai.timefold.solver.core.api.score.stream.test.MultiConstraintAssertion;
+import ai.timefold.solver.core.api.score.stream.test.ShadowVariableAwareMultiConstraintAssertion;
 import ai.timefold.solver.core.impl.score.constraint.ConstraintMatchPolicy;
 import ai.timefold.solver.core.impl.score.stream.common.AbstractConstraintStreamScoreDirectorFactory;
-import ai.timefold.solver.test.api.score.stream.MultiConstraintAssertion;
-import ai.timefold.solver.test.api.score.stream.ShadowVariableAwareMultiConstraintAssertion;
 
 public final class DefaultShadowVariableAwareMultiConstraintAssertion<Solution_, Score_ extends Score<Score_>>
         extends AbstractMultiConstraintAssertion<Solution_, Score_> implements ShadowVariableAwareMultiConstraintAssertion {

tools/test/src/main/java/ai/timefold/solver/test/impl/score/stream/DefaultShadowVariableAwareSingleConstraintAssertion.java → core/src/main/java/ai/timefold/solver/core/impl/score/stream/test/DefaultShadowVariableAwareSingleConstraintAssertion.java

@@ -1,12 +1,12 @@
-package ai.timefold.solver.test.impl.score.stream;
+package ai.timefold.solver.core.impl.score.stream.test;
 
 import java.util.Objects;
 
 import ai.timefold.solver.core.api.score.Score;
+import ai.timefold.solver.core.api.score.stream.test.ShadowVariableAwareSingleConstraintAssertion;
+import ai.timefold.solver.core.api.score.stream.test.SingleConstraintAssertion;
 import ai.timefold.solver.core.impl.score.constraint.ConstraintMatchPolicy;
 import ai.timefold.solver.core.impl.score.stream.common.AbstractConstraintStreamScoreDirectorFactory;
-import ai.timefold.solver.test.api.score.stream.ShadowVariableAwareSingleConstraintAssertion;
-import ai.timefold.solver.test.api.score.stream.SingleConstraintAssertion;
 
 public final class DefaultShadowVariableAwareSingleConstraintAssertion<Solution_, Score_ extends Score<Score_>>
         extends AbstractSingleConstraintAssertion<Solution_, Score_> implements ShadowVariableAwareSingleConstraintAssertion {

tools/test/src/main/java/ai/timefold/solver/test/impl/score/stream/DefaultSingleConstraintAssertion.java → core/src/main/java/ai/timefold/solver/core/impl/score/stream/test/DefaultSingleConstraintAssertion.java

@@ -1,4 +1,4 @@
-package ai.timefold.solver.test.impl.score.stream;
+package ai.timefold.solver.core.impl.score.stream.test;
 
 import java.util.Map;