JIMRI/java/test/jmri/implementation/DoubleTurnoutSignalHeadTest.java

package jmri.implementation;

import java.lang.reflect.InvocationTargetException;

import javax.swing.SwingUtilities;

import jmri.InstanceManager;
import jmri.NamedBeanHandle;
import jmri.SignalHead;
import jmri.Turnout;
import jmri.TurnoutManager;
import jmri.util.JUnitUtil;
import jmri.util.PropertyChangeListenerScaffold;

import org.junit.jupiter.api.*;
import org.junit.Assert;

/**
 *
 * @author Paul Bender Copyright (C) 2017
 * @author Balazs Racz Copyright (C) 2017
 */
public class DoubleTurnoutSignalHeadTest extends AbstractSignalHeadTestBase {

    protected PropertyChangeListenerScaffold l;

    @Test
    public void testCTor() {
        Turnout it = (InstanceManager.getDefault(TurnoutManager.class)).provideTurnout("IT1");
        NamedBeanHandle<Turnout> green = new NamedBeanHandle<>("green handle", it);
        Turnout it2 = (InstanceManager.getDefault(TurnoutManager.class)).provideTurnout("IT1"); // deliberately use same system name?
        NamedBeanHandle<Turnout> red = new NamedBeanHandle<>("red handle", it2);
        Assertions.assertNotNull(new DoubleTurnoutSignalHead("Test Head", green, red));
    }

    void createHead() {
        mGreenTurnout = (InstanceManager.getDefault(TurnoutManager.class)).provideTurnout("IT1");
        NamedBeanHandle<Turnout> green = new NamedBeanHandle<>("green handle", mGreenTurnout);
        mRedTurnout = (InstanceManager.getDefault(TurnoutManager.class)).provideTurnout("IT2");
        NamedBeanHandle<Turnout> red = new NamedBeanHandle<>("red handle", mRedTurnout);
        mHead = new DoubleTurnoutSignalHead("Test Head", green, red);
    }

    void waitForTimer() {
        if (mHead.readUpdateTimer == null) return;
        while (mHead.readUpdateTimer.isRunning()) {
            JUnitUtil.waitFor(60);
        }
        // Makes sure that the timer's callback is not still pending in the Swing execution
        // thread by scheduling an execution there and waiting for it.
        try {
            SwingUtilities.invokeAndWait(() -> {
            });
        } catch (InterruptedException e) {
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        }
    }

    private Turnout mRedTurnout;
    private Turnout mGreenTurnout;
    private DoubleTurnoutSignalHead mHead;

    @Test
    public void testSetAppearance() {
        createHead();

        mHead.setAppearance(SignalHead.RED);
        Assert.assertEquals(Turnout.THROWN, mRedTurnout.getKnownState());
        Assert.assertEquals(Turnout.CLOSED, mGreenTurnout.getKnownState());
        mHead.setAppearance(SignalHead.GREEN);
        Assert.assertEquals(Turnout.CLOSED, mRedTurnout.getKnownState());
        Assert.assertEquals(Turnout.THROWN, mGreenTurnout.getKnownState());
        mHead.setAppearance(SignalHead.YELLOW);
        Assert.assertEquals(Turnout.THROWN, mRedTurnout.getKnownState());
        Assert.assertEquals(Turnout.THROWN, mGreenTurnout.getKnownState());
        mHead.setAppearance(SignalHead.RED);
        Assert.assertEquals(Turnout.THROWN, mRedTurnout.getKnownState());
        Assert.assertEquals(Turnout.CLOSED, mGreenTurnout.getKnownState());
    }

    @Test
    public void testNotify() {
        createHead();
        mHead.setAppearance(SignalHead.RED);
        mHead.addPropertyChangeListener(l);

        mHead.setAppearance(SignalHead.YELLOW);
        JUnitUtil.waitFor( () -> { return l.getPropertyChanged(); }, "prop change to yellow triggered" );
        Assert.assertEquals("called once",1,l.getCallCount());

        waitForTimer();
        Assert.assertEquals("called once",1,l.getCallCount());

        mHead.setAppearance(SignalHead.GREEN);
        JUnitUtil.waitFor( () -> { return l.getPropertyChanged(); }, "prop change to green triggered" );
        Assert.assertEquals("called twice",2,l.getCallCount());

        waitForTimer();
        Assert.assertEquals("called twice",2,l.getCallCount());
    }

    @Test
    public void testReadOutput() {
        createHead();

        mHead.setAppearance(SignalHead.RED);
        mHead.addPropertyChangeListener(l);
        Assert.assertEquals(SignalHead.RED, mHead.getAppearance());

        mRedTurnout.setCommandedState(Turnout.CLOSED);
        mGreenTurnout.setCommandedState(Turnout.THROWN);
        Assert.assertEquals(SignalHead.RED, mHead.getAppearance());
        Assert.assertEquals("not called",0,l.getCallCount());
        Assert.assertNotNull(mHead.readUpdateTimer); // Should be running.

        waitForTimer();
        JUnitUtil.waitFor( () -> { return l.getPropertyChanged(); }, "prop change to green triggered" );
        Assert.assertEquals(SignalHead.GREEN, mHead.getAppearance());
        l.resetPropertyChanged();

        mRedTurnout.setCommandedState(Turnout.THROWN);
        Assert.assertEquals("not called",0,l.getCallCount());
        waitForTimer();
        JUnitUtil.waitFor( () -> { return l.getPropertyChanged(); }, "prop change to yellow triggered" );
        Assert.assertEquals(SignalHead.YELLOW, mHead.getAppearance());
        Assert.assertEquals("called once",1,l.getCallCount());

        mRedTurnout.setCommandedState(Turnout.CLOSED);
        mGreenTurnout.setCommandedState(Turnout.CLOSED);
        Assert.assertEquals("called once",1,l.getCallCount());
        waitForTimer();
        JUnitUtil.waitFor( () -> { return l.getPropertyChanged(); }, "prop change triggered");
    }

    @Test
    public void testFlashingIgnoresTurnoutFeedback() {
        createHead();
        mHead.setAppearance(SignalHead.FLASHRED);
        mHead.addPropertyChangeListener(l);
        Assert.assertEquals(Turnout.THROWN, mRedTurnout.getKnownState());
        Assert.assertEquals(Turnout.CLOSED, mGreenTurnout.getKnownState());
        Assert.assertEquals(SignalHead.FLASHRED, mHead.getAppearance());
        // Should not be running, since all commands came from us.
        Assert.assertNull(mHead.readUpdateTimer);
        Assert.assertEquals("not called",0,l.getCallCount());

        // Wait for the flash
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
        }
        Assert.assertEquals(SignalHead.FLASHRED, mHead.getAppearance()); // hasn't changed
        Assert.assertEquals("not called",0,l.getCallCount());

        Assert.assertEquals(Turnout.CLOSED, mRedTurnout.getKnownState());
        Assert.assertEquals(Turnout.CLOSED, mGreenTurnout.getKnownState());

        mGreenTurnout.setCommandedState(Turnout.THROWN);
        Assert.assertEquals("not called",0,l.getCallCount());
        Assert.assertNotNull(mHead.readUpdateTimer); // now it's started
        waitForTimer();
        Assert.assertEquals("not called",0,l.getCallCount());
        Assert.assertEquals(SignalHead.FLASHRED, mHead.getAppearance()); // hasn't changed
    }    
    
    @Override
    public SignalHead getHeadToTest() {
        createHead();
        return mHead;
    }

    @BeforeEach
    public void setUp() {
        JUnitUtil.setUp();
        JUnitUtil.initInternalTurnoutManager();
        l = new PropertyChangeListenerScaffold();
    }

    @AfterEach
    public void tearDown() {
        l = null;
        JUnitUtil.tearDown();
    }

    //private static final Logger log = LoggerFactory.getLogger(DoubleTurnoutSignalHeadTest.class);

}