JIMRI/java/test/jmri/jmrit/throttle/ControlPanelTest.java

package jmri.jmrit.throttle;

import java.awt.Container;
import java.awt.Component;
import java.awt.Rectangle;

import javax.swing.JDesktopPane;
import javax.swing.JFrame;
import javax.swing.JPanel;

import jmri.util.JUnitUtil;
import jmri.DccThrottle;
import jmri.InstanceManager;
import jmri.LocoAddress;
import jmri.SpeedStepMode;
import jmri.ThrottleListener;
import jmri.jmrit.throttle.preferences.ThrottlesPreferences;
import jmri.jmrit.throttle.panels.ControlPanel;

import org.junit.jupiter.api.*;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.EnumSource;

import static org.junit.jupiter.api.Assertions.*;

/**
 * Test simple functioning of ControlPanel
 *
 * @author Paul Bender Copyright (C) 2016
 */
@jmri.util.junit.annotations.DisabledIfHeadless
public class ControlPanelTest {

    private ControlPanel panel;
    private JFrame frame;
    private DccThrottle throttle;

    private void setupControlPanel() {
        panel = new ControlPanel();
        assertNotNull( panel, "exists");

        frame = new JFrame("ControlPanelTest");
        frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        frame.setVisible(true);
        frame.setSize(200, 400);

        JPanel mainPanel = new JPanel();
        mainPanel.setOpaque(true);
        mainPanel.add(new JDesktopPane());
        mainPanel.add(panel);
        
        panel.setVisible(true);

        frame.add(mainPanel);
    }

    private void checkFrameOverlap(Container f) {
        synchronized(f.getTreeLock()) {
            int count = f.getComponentCount();
            for (int i1 =0 ; i1 < count; i1++) {
                Component c1 = f.getComponent(i1);
                for (int i2 = i1+1; i2 < count; i2++ ) {
                    Component c2 = f.getComponent(i2);
                    if (c1 == c2) {
                        continue;
                    }
                    if (!c1.isVisible()) {
                        continue;
                    }
                    if (!c2.isVisible()) {
                        continue;
                    }
                    Rectangle r1 = c1.getBounds();
                    Rectangle r2 = c2.getBounds();
                    assertFalse(r1.intersects(r2),
                        () -> String.format("Components %s(%s) and %s(%s) overlap%n",
                            c1.getName(), c1.getClass().getName(),
                            c2.getName(), c2.getClass().getName()));
                }

                if (c1 instanceof Container) {
                    checkFrameOverlap((Container)c1);
                }
            }
        }
    }

    @Test
    public void testCtor() {
        setupControlPanel();

        checkFrameOverlap(panel);
        assertNotNull(panel.getSpeedSlider());

    }

    @Test
    public void testExtendedThrottle() {

        InstanceManager.getDefault(ThrottlesPreferences.class).setUsingFunctionIcon(false);
        setupControlPanel();

        checkFrameOverlap(panel);

        panel.setSpeedController(ControlPanel.STEPDISPLAY);
        checkFrameOverlap(panel);

        panel.setSpeedController(ControlPanel.SLIDERDISPLAY);
        checkFrameOverlap(panel);

        panel.setSpeedController(ControlPanel.SLIDERDISPLAYCONTINUOUS);
        checkFrameOverlap(panel);
    }

    @Test
    public void testIconThrottle() {

        InstanceManager.throttleManagerInstance().supportedSpeedModes();
        InstanceManager.getDefault(ThrottlesPreferences.class).setUsingFunctionIcon(true);
        setupControlPanel();

        checkFrameOverlap(panel);

        panel.setSpeedController(ControlPanel.STEPDISPLAY);
        checkFrameOverlap(panel);

        panel.setSpeedController(ControlPanel.SLIDERDISPLAY);
        checkFrameOverlap(panel);

        panel.setSpeedController(ControlPanel.SLIDERDISPLAYCONTINUOUS);
        checkFrameOverlap(panel);
    }

    @ParameterizedTest
    @EnumSource(SpeedStepMode.class)
    public void testSpeedStepModes(SpeedStepMode mode) {

        InstanceManager.getDefault(ThrottlesPreferences.class).setUsingFunctionIcon(true);
        setupControlPanel();

        InstanceManager.throttleManagerInstance().requestThrottle(3,
            new ThrottleListener(){
              @Override
              public void notifyThrottleFound(DccThrottle t) {
                throttle = t;
                throttle.setSpeedStepMode(mode);
                panel.notifyAddressThrottleFound(t);
              }

              @Override
              public void notifyFailedThrottleRequest(LocoAddress address,
                  String reason) {
              }
              @Override
              public void notifyDecisionRequired(LocoAddress address,
                  DecisionType question) {
              }
            });

        assertNotNull(throttle);
        assertEquals( 0.0, throttle.getSpeedSetting(), 1e-7);
        assertEquals(mode, throttle.getSpeedStepMode());

    }

    @BeforeEach
    public void setUp() {
        JUnitUtil.setUp();
        JUnitUtil.resetProfileManager();
        JUnitUtil.initDebugThrottleManager();
        InstanceManager.getDefault(ThrottlesPreferences.class).setUseExThrottle(true);
        throttle = null;
    }

    @AfterEach
    public void tearDown() {
        if( frame != null ) {
            JUnitUtil.dispose(frame);
            frame = null;
        }

        JUnitUtil.resetWindows(false,false);
        JUnitUtil.tearDown();
    }
}