/*
* Copyright 2012 JBoss Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.optaplanner.core.impl.heuristic.selector.move.decorator;
import java.util.Random;
import org.junit.Test;
import org.optaplanner.core.config.heuristic.selector.common.SelectionCacheType;
import org.optaplanner.core.impl.heuristic.move.DummyMove;
import org.optaplanner.core.impl.heuristic.selector.SelectorTestUtils;
import org.optaplanner.core.impl.heuristic.selector.move.MoveSelector;
import org.optaplanner.core.impl.phase.scope.AbstractPhaseScope;
import org.optaplanner.core.impl.phase.scope.AbstractStepScope;
import org.optaplanner.core.impl.solver.scope.DefaultSolverScope;
import static org.mockito.Mockito.*;
import static org.optaplanner.core.impl.testdata.util.PlannerAssert.*;
public class CachingMoveSelectorTest {
@Test
public void originalSelectionCacheTypeSolver() {
runOriginalSelection(SelectionCacheType.SOLVER, 1);
}
@Test
public void originalSelectionCacheTypePhase() {
runOriginalSelection(SelectionCacheType.PHASE, 2);
}
@Test
public void originalSelectionCacheTypeStep() {
runOriginalSelection(SelectionCacheType.STEP, 5);
}
public void runOriginalSelection(SelectionCacheType cacheType, int timesCalled) {
MoveSelector childMoveSelector = SelectorTestUtils.mockMoveSelector(DummyMove.class,
new DummyMove("a1"), new DummyMove("a2"), new DummyMove("a3"));
CachingMoveSelector moveSelector = new CachingMoveSelector(childMoveSelector, cacheType, false);
verify(childMoveSelector, times(1)).isNeverEnding();
DefaultSolverScope solverScope = mock(DefaultSolverScope.class);
moveSelector.solvingStarted(solverScope);
AbstractPhaseScope phaseScopeA = mock(AbstractPhaseScope.class);
when(phaseScopeA.getSolverScope()).thenReturn(solverScope);
moveSelector.phaseStarted(phaseScopeA);
AbstractStepScope stepScopeA1 = mock(AbstractStepScope.class);
when(stepScopeA1.getPhaseScope()).thenReturn(phaseScopeA);
moveSelector.stepStarted(stepScopeA1);
assertAllCodesOfMoveSelector(moveSelector, "a1", "a2", "a3");
moveSelector.stepEnded(stepScopeA1);
AbstractStepScope stepScopeA2 = mock(AbstractStepScope.class);
when(stepScopeA2.getPhaseScope()).thenReturn(phaseScopeA);
moveSelector.stepStarted(stepScopeA2);
assertAllCodesOfMoveSelector(moveSelector, "a1", "a2", "a3");
moveSelector.stepEnded(stepScopeA2);
moveSelector.phaseEnded(phaseScopeA);
AbstractPhaseScope phaseScopeB = mock(AbstractPhaseScope.class);
when(phaseScopeB.getSolverScope()).thenReturn(solverScope);
moveSelector.phaseStarted(phaseScopeB);
AbstractStepScope stepScopeB1 = mock(AbstractStepScope.class);
when(stepScopeB1.getPhaseScope()).thenReturn(phaseScopeB);
moveSelector.stepStarted(stepScopeB1);
assertAllCodesOfMoveSelector(moveSelector, "a1", "a2", "a3");
moveSelector.stepEnded(stepScopeB1);
AbstractStepScope stepScopeB2 = mock(AbstractStepScope.class);
when(stepScopeB2.getPhaseScope()).thenReturn(phaseScopeB);
moveSelector.stepStarted(stepScopeB2);
assertAllCodesOfMoveSelector(moveSelector, "a1", "a2", "a3");
moveSelector.stepEnded(stepScopeB2);
AbstractStepScope stepScopeB3 = mock(AbstractStepScope.class);
when(stepScopeB3.getPhaseScope()).thenReturn(phaseScopeB);
moveSelector.stepStarted(stepScopeB3);
assertAllCodesOfMoveSelector(moveSelector, "a1", "a2", "a3");
moveSelector.stepEnded(stepScopeB3);
moveSelector.phaseEnded(phaseScopeB);
moveSelector.solvingEnded(solverScope);
verifyPhaseLifecycle(childMoveSelector, 1, 2, 5);
verify(childMoveSelector, times(timesCalled)).iterator();
verify(childMoveSelector, times(timesCalled)).getSize();
}
@Test
public void randomSelectionCacheTypeSolver() {
runRandomSelection(SelectionCacheType.SOLVER, 1);
}
@Test
public void randomSelectionCacheTypePhase() {
runRandomSelection(SelectionCacheType.PHASE, 2);
}
@Test
public void randomSelectionCacheTypeStep() {
runRandomSelection(SelectionCacheType.STEP, 3);
}
public void runRandomSelection(SelectionCacheType cacheType, int timesCalled) {
MoveSelector childMoveSelector = SelectorTestUtils.mockMoveSelector(DummyMove.class,
new DummyMove("a1"), new DummyMove("a2"), new DummyMove("a3"));
CachingMoveSelector moveSelector = new CachingMoveSelector(childMoveSelector, cacheType, true);
verify(childMoveSelector, times(1)).isNeverEnding();
Random workingRandom = mock(Random.class);
DefaultSolverScope solverScope = mock(DefaultSolverScope.class);
when(solverScope.getWorkingRandom()).thenReturn(workingRandom);
moveSelector.solvingStarted(solverScope);
AbstractPhaseScope phaseScopeA = mock(AbstractPhaseScope.class);
when(phaseScopeA.getSolverScope()).thenReturn(solverScope);
when(phaseScopeA.getWorkingRandom()).thenReturn(workingRandom);
moveSelector.phaseStarted(phaseScopeA);
AbstractStepScope stepScopeA1 = mock(AbstractStepScope.class);
when(stepScopeA1.getPhaseScope()).thenReturn(phaseScopeA);
when(stepScopeA1.getWorkingRandom()).thenReturn(workingRandom);
moveSelector.stepStarted(stepScopeA1);
when(workingRandom.nextInt(3)).thenReturn(1, 0, 2);
assertCodesOfNeverEndingMoveSelector(moveSelector, 3L, "a2", "a1", "a3");
moveSelector.stepEnded(stepScopeA1);
AbstractStepScope stepScopeA2 = mock(AbstractStepScope.class);
when(stepScopeA2.getPhaseScope()).thenReturn(phaseScopeA);
when(stepScopeA2.getWorkingRandom()).thenReturn(workingRandom);
moveSelector.stepStarted(stepScopeA2);
when(workingRandom.nextInt(3)).thenReturn(2, 0, 1);
assertCodesOfNeverEndingMoveSelector(moveSelector, 3L, "a3", "a1", "a2");
moveSelector.stepEnded(stepScopeA2);
moveSelector.phaseEnded(phaseScopeA);
AbstractPhaseScope phaseScopeB = mock(AbstractPhaseScope.class);
when(phaseScopeB.getSolverScope()).thenReturn(solverScope);
when(phaseScopeB.getWorkingRandom()).thenReturn(workingRandom);
moveSelector.phaseStarted(phaseScopeB);
AbstractStepScope stepScopeB1 = mock(AbstractStepScope.class);
when(stepScopeB1.getPhaseScope()).thenReturn(phaseScopeB);
when(stepScopeB1.getWorkingRandom()).thenReturn(workingRandom);
moveSelector.stepStarted(stepScopeB1);
when(workingRandom.nextInt(3)).thenReturn(1, 2, 0);
assertCodesOfNeverEndingMoveSelector(moveSelector, 3L, "a2", "a3", "a1");
moveSelector.stepEnded(stepScopeB1);
moveSelector.phaseEnded(phaseScopeB);
moveSelector.solvingEnded(solverScope);
verifyPhaseLifecycle(childMoveSelector, 1, 2, 3);
verify(childMoveSelector, times(timesCalled)).iterator();
verify(childMoveSelector, times(timesCalled)).getSize();
}
}