package jmri.jmrit.beantable;

import javax.swing.JFrame;

import jmri.util.JUnitUtil;
import jmri.util.junit.annotations.ToDo;

import org.junit.jupiter.api.*;
import org.netbeans.jemmy.operators.JFrameOperator;

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

/**
 * This is an abstract base class for testing bean table action objects derived
 * from AbstractTableTabAction. This contains a base level of testing for these
 * objects. Derived classes should set the "a" variable in their setUp method.
 *
 * @author Paul Bender Copyright (C) 2017
 */
public abstract class AbstractTableTabActionBase {

    protected AbstractTableTabAction<? extends jmri.NamedBean> a = null;
    protected String helpTarget = "index"; // index is default value specified in AbstractTableTabAction.

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

    @Test
    @Disabled("test causes an NPE while executing a.actionPerformed")
    @jmri.util.junit.annotations.DisabledIfHeadless
    @ToDo("The underlying class under test inherits the actionPerformed method from AbstractTableAction, which expects a model to be set by createModel(), which doesn't happen for AbstractTableTabAction classes")
    public void testExecute() {
        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 does not
     * provide a panel, its test implementation needs to override this method.
     */
    @Test
    public void testGetPanel() {
        assertNotNull( a.getPanel(), "Default getPanel does not return 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");
    }

    /**
     * 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(AbstractTableTabActionBase.class);
}