JIMRI/java/test/jmri/jmrit/beantable/AbstractTableActionBase.java

package jmri.jmrit.beantable;

import javax.swing.JFrame;
import javax.swing.JTextField;

import jmri.NamedBean;
import jmri.util.JUnitUtil;
import jmri.util.ThreadingUtil;
import jmri.util.swing.JemmyUtil;
import jmri.util.junit.annotations.DisabledIfHeadless;

import org.junit.jupiter.api.*;

import org.netbeans.jemmy.QueueTool;
import org.netbeans.jemmy.operators.JFrameOperator;
import org.netbeans.jemmy.operators.JTableOperator;
import org.netbeans.jemmy.operators.JTextFieldOperator;
import org.netbeans.jemmy.util.NameComponentChooser;

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

/**
 * This is an abstract base class for testing bean table action objects derived
 * from AbstractTableAction. This contains a base level of testing for these
 * objects. Derived classes should set the "a" variable in their setUp method.
 *
 * @param <B> supported type of NamedBean
 * @author Paul Bender Copyright (C) 2017
 */
public abstract class AbstractTableActionBase<B extends NamedBean> {

    protected AbstractTableAction<B> a = null;
    protected String helpTarget = "index"; // index is default value specified in AbstractTableAction.

    /**
     * Test that AbstractTableAction subclasses do not create Swing objects when
     * constructed, but defer that to later.
     */
    @Test
    public final void testDeferredCreation() {
        assertNull(a.m);
        assertNull(a.f);
    }

    @Test
    public void testGetTableDataModel() {
        assertNotNull( a.getTableDataModel(), "Table Data Model Exists");
    }

    @Test
    @DisabledIfHeadless
    public void testExecute() {
        ThreadingUtil.runOnGUI( () -> a.actionPerformed(null));
        JFrame f = JFrameOperator.waitJFrame(getTableFrameName(), true, true);
        assertNotNull( f, "failed to find frame");
        JUnitUtil.dispose(f);
    }

    /**
     * @return the table name used to create the window, as returned from the
     *         Bundle.
     */
    abstract public String getTableFrameName();

    /**
     * Check the return value of getPanel. If the class under test provides a
     * panel, its test implementation needs to override this method.
     */
    @Test
    public void testGetPanel() {
        assertNull( a.getPanel(), "Default getPanel returns null");
    }

    /**
     * Check the return value of getDescription. If the class under test
     * provides string descriptor, its test implementation needs to override
     * this method.
     */
    @Test
    public void testGetClassDescription() {
        assertEquals( "Abstract Table Action", a.getClassDescription(), "Default class description");
    }

    /**
     * Check the return value of includeAddButton. If the class under test
     * includes an add button, its test implementation needs to override this
     * method.
     */
    @Test
    public void testIncludeAddButton() {
        assertFalse( a.includeAddButton(), "Default include add button");
    }

    @Test
    public void testHelpTarget() {
        assertEquals( helpTarget, a.helpTarget(), "help target");
    }

    @Test
    @DisabledIfHeadless
    public void testAddButton() {
        Assumptions.assumeTrue(a.includeAddButton());
        ThreadingUtil.runOnGUI( () -> a.actionPerformed(null));
        JFrame f = JFrameOperator.waitJFrame(getTableFrameName(), true, true);

        // find the "Add... " button and press it.
        JemmyUtil.pressButton(new JFrameOperator(f), Bundle.getMessage("ButtonAdd"));
        new QueueTool().waitEmpty();
        JFrame f1 = JFrameOperator.waitJFrame(getAddFrameName(), true, true);
        JemmyUtil.pressButton(new JFrameOperator(f1), Bundle.getMessage("ButtonCancel"));
        JUnitUtil.dispose(f1);
        JUnitUtil.dispose(f);
    }

    /**
     * @return the name of the frame resulting from add being pressed, as
     *         returned from the Bundle.
     */
    abstract public String getAddFrameName();

    /**
     * @return the name of the frame resulting from edit being pressed, as
     *         returned from the Bundle.
     */
    public String getEditFrameName() {
        // defaults to the same as the add frame name
        return getAddFrameName();
    }

    @Test
    @DisabledIfHeadless
    public void testAddThroughDialog() {
        Assumptions.assumeTrue(a.includeAddButton());
        ThreadingUtil.runOnGUI( () -> a.actionPerformed(null));
        JFrame f = JFrameOperator.waitJFrame(getTableFrameName(), true, true);

        // find the "Add... " button and press it.
        JemmyUtil.pressButton(new JFrameOperator(f), Bundle.getMessage("ButtonAdd"));
        JFrame f1 = JFrameOperator.waitJFrame(getAddFrameName(), true, true);
        JFrameOperator jf = new JFrameOperator(f1);
        // Enter 1 in the text field labeled "Hardware address:"
        JTextField hwAddressField = JTextFieldOperator.findJTextField(f1, new NameComponentChooser("hwAddressTextField"));
        assertNotNull( hwAddressField, "hwAddressTextField");

        // set to "1"
        new JTextFieldOperator(hwAddressField).setText("1");

        //and press create
        JemmyUtil.pressButton(jf, Bundle.getMessage("ButtonCreate"));
        JUnitUtil.dispose(f1);
        JUnitUtil.dispose(f);
    }

    @Test
    @DisabledIfHeadless
    public void testEditButton() {
        Assumptions.assumeTrue(a.includeAddButton());
        ThreadingUtil.runOnGUI( () -> a.actionPerformed(null));
        JFrame f = JFrameOperator.waitJFrame(getTableFrameName(), true, true);

        // find the "Add... " button and press it.
        JFrameOperator jfo = new JFrameOperator(f);
        JemmyUtil.pressButton(jfo, Bundle.getMessage("ButtonAdd"));
        JFrame f1 = JFrameOperator.waitJFrame(getEditFrameName(), true, true);
        JFrameOperator jf = new JFrameOperator(f1);
        //Enter 1 in the text field labeled "Hardware address:"
        JTextField hwAddressField = JTextFieldOperator.findJTextField(f1, new NameComponentChooser("hwAddressTextField"));
        assertNotNull( hwAddressField, "hwAddressTextField");

        // set to "1"
        new JTextFieldOperator(hwAddressField).typeText("1");

        //and press create
        JemmyUtil.pressButton(jf, Bundle.getMessage("ButtonCreate"));

        JTableOperator tbl = new JTableOperator(jfo, 0);
        // find the "Edit" button and press it.  This is in the table body.
        tbl.clickOnCell(0, tbl.findColumn(Bundle.getMessage("ButtonEdit")));
        JFrame f2 = JFrameOperator.waitJFrame(getAddFrameName(), true, true);
        JemmyUtil.pressButton(new JFrameOperator(f2), Bundle.getMessage("ButtonCancel"));
        JUnitUtil.dispose(f2);

        JUnitUtil.dispose(f1);
        JUnitUtil.dispose(f);
    }

    /**
     * Derived classes should use this method to set a.
     */
    abstract public void setUp();

    /**
     * Derived classes should use this method to clean up after tests.
     */
    abstract public void tearDown();

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