package apps;

import java.awt.GraphicsEnvironment;
import java.io.File;
import java.io.IOException;

import org.apache.commons.io.FileUtils;
import org.junit.jupiter.api.*;

import jmri.InstanceManager;
import jmri.ShutDownManager;
import jmri.util.*;

/**
 * Base implementation for a test that launches and tests complete JMRI apps
 * from prebuilt profile directories.
 * All implementing classes are currently disabled, previously replaced by Cucumber tests.
 *
 * @author Bob Jacobsen 2018
 */
@Timeout(40)
abstract public class LaunchJmriAppBase {

    /**
     * Run one application.
     * @param tempFolder  temp folder
     *
     * @param profileName       Name of the Profile folder to copy from
     *                          java/test/apps/PanelPro/profiles/
     * @param frameName         Application (frame) title
     * @param startMessageStart Start of the "we're up!" message as seen in System Console
     */
    protected void runOne(File tempFolder, String profileName, String frameName, String startMessageStart) {
        Assumptions.assumeFalse(GraphicsEnvironment.isHeadless());

        try {
            // create a custom profile
            File profileDir = new File(tempFolder.getAbsolutePath() + File.separator + profileName);
            Assertions.assertTrue(profileDir.mkdir());
            System.setProperty("jmri.prefsdir", tempFolder.getAbsolutePath());
            FileUtils.copyDirectory(new File("java/test/apps/PanelPro/profiles/" + profileName), profileDir);
            System.setProperty("org.jmri.profile", profileDir.getAbsolutePath());

            // launch!
            launch(new String[]{profileName});

            JUnitUtil.waitFor(() -> {
                return JmriJFrame.getFrame(frameName) != null;
            }, "the application window is up");

            JUnitUtil.waitFor(() -> {
                return JUnitAppender.checkForMessageStartingWith(startMessageStart) != null;
            }, "first Info line seen in Console after startup");

            extraChecks();

            // maybe have it run a script to indicate that it's really up?

            // now clean up frames, depending on what's actually left
            cleanup();

            // gracefully shutdown, but don't exit
            ShutDownManager sdm = InstanceManager.getDefault(ShutDownManager.class);
            if (sdm instanceof MockShutDownManager) {
                // ShutDownManagers other than MockShutDownManager really shutdown
                sdm.shutdown();
            }
        }  catch (IOException ex) {
            Assertions.fail(ex);
        } finally {
            // wait for threads, etc
            JUnitUtil.waitFor(40);
        }
    }

    abstract protected void launch(String[] args);

    protected void extraChecks() {
    }

    protected void cleanup() {
    }

    @BeforeEach
    public void setUp() {
        JUnitUtil.setUp();
        JUnitUtil.clearShutDownManager();
        JUnitUtil.resetApplication();
    }

    @AfterEach
    public void tearDown() {
        JUnitUtil.clearShutDownManager();
        JUnitUtil.tearDown();
    }

}