JIMRI/java/test/jmri/jmrit/operations/trains/gui/TrainConductorFrameTest.java

package jmri.jmrit.operations.trains.gui;

import java.awt.GraphicsEnvironment;

import org.junit.Assert;
import org.junit.Assume;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.netbeans.jemmy.operators.JButtonOperator;
import org.netbeans.jemmy.operators.JFrameOperator;

import jmri.InstanceManager;
import jmri.jmrit.operations.OperationsTestCase;
import jmri.jmrit.operations.locations.Location;
import jmri.jmrit.operations.locations.LocationManager;
import jmri.jmrit.operations.locations.Track;
import jmri.jmrit.operations.rollingstock.cars.Car;
import jmri.jmrit.operations.rollingstock.cars.CarManager;
import jmri.jmrit.operations.rollingstock.engines.Engine;
import jmri.jmrit.operations.rollingstock.engines.EngineManager;
import jmri.jmrit.operations.routes.Route;
import jmri.jmrit.operations.routes.RouteLocation;
import jmri.jmrit.operations.setup.Setup;
import jmri.jmrit.operations.trains.*;
import jmri.util.JUnitOperationsUtil;
import jmri.util.JUnitUtil;
import jmri.util.swing.JemmyUtil;

/**
 *
 * @author Paul Bender Copyright (C) 2017
 */
public class TrainConductorFrameTest extends OperationsTestCase {

    @Test
    public void testCTor() {
        Assume.assumeFalse(GraphicsEnvironment.isHeadless());
        TrainConductorFrame t = new TrainConductorFrame(null);
        Assert.assertNotNull("exists", t);
        JUnitUtil.dispose(t);
    }

    @Test
    public void testMoveButton() {
        Assume.assumeFalse(GraphicsEnvironment.isHeadless());

        EngineManager emanager = InstanceManager.getDefault(EngineManager.class);
        Engine e1 = emanager.getByRoadAndNumber("PC", "5016");
        Engine e2 = emanager.getByRoadAndNumber("PC", "5019");

        Location northend = InstanceManager.getDefault(LocationManager.class).getLocationById("1");
        Track northendStaging1 = northend.getTrackById("1s1");

        // Place Engines on Staging tracks
        Assert.assertEquals("Place e1", Track.OKAY, e1.setLocation(northend, northendStaging1));
        Assert.assertEquals("Place e2", Track.OKAY, e2.setLocation(northend, northendStaging1));

        // improve test coverage by using utility car
        CarManager cmanager = InstanceManager.getDefault(CarManager.class);
        Car c1 = cmanager.getByRoadAndNumber("CP", "X10001");
        c1.setUtility(true);

        // Create local move
        Location locationNorthIndustries = InstanceManager.getDefault(LocationManager.class).getLocationById("20");
        Track spur = locationNorthIndustries.addTrack("Spur", Track.SPUR);
        spur.setLength(300);
        Car car = cmanager.getByRoadAndNumber("CP", "777");
        car.setFinalDestination(locationNorthIndustries);
        car.setFinalDestinationTrack(spur);
        car.setUtility(true);

        Train train2 = InstanceManager.getDefault(TrainManager.class).getTrainById("2");
        train2.setNumberEngines("2");

        TrainConductorFrame f = new TrainConductorFrame(train2);
        TrainConductorPanel p = (TrainConductorPanel) f.getContentPane();
        Assert.assertNotNull(p);
        JemmyUtil.waitFor(f);

        train2.build();

        // update panel by building train
        Assert.assertTrue(train2.build());
        Assert.assertTrue(train2.isBuilt());

        // it can take awhile before the train is built and the GUI updated
        jmri.util.JUnitUtil.waitFor(() -> {
            return p.modifyButton.isEnabled();
        }, "wait for modify button to be enabled");

        Assert.assertEquals("confirm train name", train2.getName(), p.textTrainName.getText());

        // Find conductor window by name
        JFrameOperator jfoc = new JFrameOperator(
                Bundle.getMessage("TitleTrainConductor") + " (" + train2.getName() + ")");
        Assert.assertNotNull(jfoc);

        // Need to select all before moving train
        JButtonOperator jboSelectAll = new JButtonOperator(jfoc, Bundle.getMessage("SelectAll"));
        jmri.util.JUnitUtil.waitFor(() -> {
            return jboSelectAll.isEnabled();
        }, "wait for button to be enabled");
        jboSelectAll.doClick();

        JButtonOperator jboMove = new JButtonOperator(jfoc, Bundle.getMessage("Move"));
        jmri.util.JUnitUtil.waitFor(() -> {
            return jboMove.isEnabled();
        }, "wait for move button to be enabled 3");

        // Move train using conductor window
        jboMove.doClick();
        Assert.assertEquals("Train moved", "North Industries", train2.getCurrentLocationName());

        // move to next location
        Assert.assertTrue("confirm button is enabled", jboSelectAll.isEnabled());
        jboSelectAll.doClick();
        jmri.util.JUnitUtil.waitFor(() -> {
            return jboMove.isEnabled();
        }, "wait for move button to be enabled 4");
        jboMove.doClick();
        Assert.assertEquals("Train moved", "South End Staging", train2.getCurrentLocationName());

        // terminate train
        Assert.assertTrue("confirm button is enabled", jboSelectAll.isEnabled());
        jboSelectAll.doClick();
        jmri.util.JUnitUtil.waitFor(() -> {
            return jboMove.isEnabled();
        }, "wait for move button to be enabled 5");
        jboMove.doClick();
        Assert.assertFalse(train2.isBuilt());

        JUnitUtil.dispose(f);
        JUnitOperationsUtil.checkOperationsShutDownTask();
    }

    @Test
//    @Disabled("Intermittent hang on Windows CI Test")
    public void testModifyButton() {
        Assume.assumeFalse(GraphicsEnvironment.isHeadless());

        Setup.setPrintLoadsAndEmptiesEnabled(true);
        Setup.setTabEnabled(true);

        Train train2 = InstanceManager.getDefault(TrainManager.class).getTrainById("2");

        // improve test coverage
        train2.setRailroadName("SFF Railroad Name");

        // to prevent dead lock
//        train2.setComment("SFF comment for testing");

        Assert.assertTrue(train2.build()); // build train
        Assert.assertTrue(train2.isBuilt());

        TrainConductorFrame f = new TrainConductorFrame(train2);
        TrainConductorPanel p = (TrainConductorPanel) f.getContentPane();
        JemmyUtil.waitFor(f);
        JemmyUtil.enterClickAndLeaveThreadSafe(p.modifyButton);

        // dialog window should appear
        JemmyUtil.pressDialogButton(Bundle.getMessage("AddCarsToTrain?"), Bundle.getMessage("ButtonNo"));
        JemmyUtil.waitFor(f);

        Assert.assertFalse(p.selectButton.isEnabled());
        Assert.assertFalse(p.clearButton.isEnabled());
        // the modify button text becomes "Done"
        Assert.assertEquals("Button text", Bundle.getMessage("Done"), p.modifyButton.getText());
        Assert.assertTrue("confirm button is enabled", p.modifyButton.isEnabled());
        JemmyUtil.enterClickAndLeave(p.modifyButton);
        Assert.assertTrue(p.selectButton.isEnabled());
        Assert.assertTrue(p.clearButton.isEnabled());
        
        JemmyUtil.enterClickAndLeave(p.selectButton);
        Assert.assertTrue(p.moveButton.isEnabled());
        JemmyUtil.enterClickAndLeave(p.clearButton);
        Assert.assertFalse(p.moveButton.isEnabled());

        JUnitUtil.dispose(f);
        JUnitOperationsUtil.checkOperationsShutDownTask();
    }

    // test fails with 5,000 loops without any JTextPane access
    // However each loop produces 5 lines of null pointer text to console.
    
//    @Test
//    public void testLoop() {
//        for (int i = 0; i < 1000; i++) {
//            setUp();
//            testModifyButton();
//            tearDown();
//        }
//    }

    // Passes Window CI test with train, but no JTextPane() modifications. 149s
    // Passes Window CI test in 132s when train is null.

//    @Test
//    public void testLoop2() {
//        for (int i = 0; i < 1000; i++) {
//            setUp();
//            testMoveButton();
//            tearDown();
//        }
//    }

    @BeforeEach
    @Override
    public void setUp() {
        super.setUp();

        // disable build messages
        InstanceManager.getDefault(TrainManager.class).setBuildMessagesEnabled(false);

        JUnitOperationsUtil.initOperationsData();
        // need to disable all references to JTextPane() so test dead locks don't occur
        // on Windows CI tests
        Setup.setPrintRouteCommentsEnabled(false);
        Setup.setPrintLocationCommentsEnabled(false);
        Train train2 = InstanceManager.getDefault(TrainManager.class).getTrainById("2");
        Route route = train2.getRoute();
        RouteLocation rl = route.getDepartsRouteLocation();
        rl.setComment(RouteLocation.NONE);
        Location l = rl.getLocation();
        Track t = l.getTrackByName("North End 1", null);
        t.setCommentBoth(Track.NONE);
        t.setCommentPickup(Track.NONE);
        t.setCommentSetout(Track.NONE);
        rl = route.getRouteLocationBySequenceNumber(2);
        l = rl.getLocation();
        t = l.getTrackByName("NI Yard", null);
        t.setCommentBoth(Track.NONE);
        t.setCommentPickup(Track.NONE);
        t.setCommentSetout(Track.NONE);
    }
}