/*******************************************************************************
 * Copyright (c) 2010, 2019 THALES GLOBAL SERVICES.
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *    Obeo - initial API and implementation
 *******************************************************************************/
package org.eclipse.sirius.tests.swtbot.tree;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.anyOf;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.nullValue;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.eclipse.sirius.tests.swtbot.Activator;
import org.eclipse.sirius.tests.swtbot.support.api.business.UILocalSession;
import org.eclipse.sirius.tests.swtbot.support.api.business.UIResource;
import org.eclipse.sirius.tests.swtbot.support.api.editor.SWTBotSiriusHelper;
import org.eclipse.sirius.tests.swtbot.support.api.editor.SWTBotVSMEditor;
import org.eclipse.sirius.tests.swtbot.support.utils.SWTBotUtils;
import org.eclipse.sirius.tree.DTree;
import org.eclipse.sirius.tree.ui.provider.TreeUIPlugin;
import org.eclipse.sirius.tree.ui.tools.api.preferences.SiriusTreeUiPreferencesKeys;
import org.eclipse.sirius.ui.tools.api.color.VisualBindingManager;
import org.eclipse.sirius.viewpoint.FontFormat;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.FontData;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.TreeItem;
import org.eclipse.swtbot.eclipse.finder.widgets.SWTBotEditor;
import org.eclipse.swtbot.eclipse.finder.widgets.SWTBotView;
import org.eclipse.swtbot.swt.finder.SWTBot;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotTree;
import org.eclipse.ui.PlatformUI;
import org.junit.Test;

/**
 * Test Style description item. Test automatic refresh and manual refresh. Test undo/redo after each test type Test
 * opening and closing model or editor to verify that all changes are effective
 * 
 * @author jdupont
 */
public class TreeItemStyleDescriptionTest extends AbstractTreeSiriusSWTBotGefTestCase {

    /**
     * Sirius Specific Model.
     */
    private static final String VSM = "ecore.odesign";

    /**
     * 
     */
    private static final String ODESIGN = "platform:/resource/DesignerTestProject/" + VSM;

    /**
     * Test repository.
     */
    private static final String DATA_UNIT_DIR = "data/unit/tree/";

    /**
     * Session file.
     */
    private static final String SESSION_FILE = "tree.aird";

    /**
     * UML File.
     */
    private static final String ECORE_FILE = "tree.ecore";

    /**
     * File directory.
     */
    private static final String FILE_DIR = "/";

    /**
     * Sirius Group.
     */
    private static final String GROUP = "Ecore Editing Workbench V4.6";

    /**
     * Properties view tab color.
     */
    private static final String COLOR = "Color";

    /**
     * Properties view tab Label.
     */
    private static final String LABEL = "Label";

    /**
     * Representation name.
     */
    private static final String REPRESENTATION_NAME = "Tree";

    /**
     * Semantic model instance.
     */
    private static final String REPRESENTATION_INSTANCE_NAME = "new Tree";

    /**
     * Contextual menu undo.
     */
    private static final String UNDO = "Undo Refresh representation";

    /**
     * Contextual menu redo.
     */
    private static final String REDO = "Redo Refresh representation";

    /**
     * Constant value for 'new EClass 1'
     */
    private static final String NEWECLASS1 = "new EClass 1";

    /**
     * Current editor.
     */
    protected SWTBotEditor editor;

    /**
     * Session.
     */
    private UIResource sessionAirdResource;

    /**
     * Local Session.
     */
    private UILocalSession localSession;

    /**
     * Blue color value RGB.
     */
    private final Color blue = VisualBindingManager.getDefault().getColorFromName(MAPCOLORVALUE.get(2));

    /**
     * Light green color valur RGB.
     */
    private final Color lightGreen = VisualBindingManager.getDefault().getColorFromName(MAPCOLORVALUE.get(13));

    /**
     * Black color valur RGB.
     */
    private final Color black = VisualBindingManager.getDefault().getColorFromName(MAPCOLORVALUE.get(1));

    /**
     * Light yellow color valur RGB.
     */
    private final Color lightYellow = VisualBindingManager.getDefault().getColorFromName(MAPCOLORVALUE.get(17));

    /**
     * The label color value.
     */
    private Color labelColor;

    @Override
    protected void onSetUpBeforeClosingWelcomePage() throws Exception {
        copyFileToTestProject(Activator.PLUGIN_ID, DATA_UNIT_DIR, VSM, SESSION_FILE, ECORE_FILE);
    }

    @Override
    protected void onSetUpAfterOpeningDesignerPerspective() throws Exception {
        sessionAirdResource = new UIResource(designerProject, FILE_DIR, SESSION_FILE);
        localSession = designerPerspective.openSessionFromFile(sessionAirdResource);

    }

    /**
     * Test automatic refresh when tree editor is open when modify odesign.
     */
    @Test
    public void testAutomaticRefreshWithEditorOpen() {
        disableAutoRefresh();
        enableAutoRefresh();
        disableRefreshOnOpeningRepresentation();
        enableRefreshOnOpeningRepresentation();

        // Open editor
        editor = openRepresentation(localSession.getOpenedSession(), REPRESENTATION_NAME, REPRESENTATION_INSTANCE_NAME, DTree.class);

        // the session is already open and opening odesign
        SWTBotVSMEditor odesignEditor = openViewpointSpecificationModel(VSM);

        modifyVSM(odesignEditor);

        bot.sleep(500);

        // Test editor refresh
        refreshEditorTest();

        VisualBindingManager.getDefault().getColorFromName(MAPCOLORVALUE.get(13));

        // Test undo and redo on refreh
        undoRedoRefresh();

        if (odesignEditor.isDirty()) {
            closeAndSaveViewpointSpecificationModel(VSM);
        } else {
            odesignEditor.close();
        }

    }

    /**
     * Test automatic refresh when session is open before modify odesign.
     */
    @Test
    public void testAutomaticRefreshWithSessionOpen() {
        disableAutoRefresh();
        enableAutoRefresh();
        disableRefreshOnOpeningRepresentation();
        enableRefreshOnOpeningRepresentation();

        // the session is already open and opening odesign
        SWTBotVSMEditor odesignEditor = openViewpointSpecificationModel(VSM);

        // Modify VSM
        modifyVSM(odesignEditor);

        // Open editor
        editor = openRepresentation(localSession.getOpenedSession(), REPRESENTATION_NAME, REPRESENTATION_INSTANCE_NAME, DTree.class);

        // Test editor refresh
        refreshEditorTest();

        // Test undo and redo on refreh
        undoRedoRefresh();

        // close session
        localSession.close(true);
    }

    /**
     * Test automatic refresh when session is close during modify odesign.
     */
    @Test
    public void testAutomaticRefreshWithSessionClose() {
        disableAutoRefresh();
        enableAutoRefresh();
        disableRefreshOnOpeningRepresentation();
        enableRefreshOnOpeningRepresentation();

        // the session is already open and opening odesign
        SWTBotVSMEditor odesignEditor = openViewpointSpecificationModel(VSM);

        // the session is close and the odesign is open
        if (localSession.isDirty()) {
            localSession.close(true);
        } else {
            localSession.closeNoDirty();
        }

        // Modify VSM
        modifyVSM(odesignEditor);

        // Wait for the refresh of the vsm is over.
        try {
            Thread.sleep(500);
        } catch (InterruptedException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }

        // Open session
        localSession = designerPerspective.openSessionFromFile(sessionAirdResource);

        // Open editor
        editor = openRepresentation(localSession.getOpenedSession(), REPRESENTATION_NAME, REPRESENTATION_INSTANCE_NAME, DTree.class);

        // Test editor refresh
        refreshEditorTest();

        // Test undo and redo on refreh
        undoRedoRefresh();

        localSession.close(true);
    }

    /**
     * Test manual refresh.
     */
    @Test
    public void testStyleDescriptionManualRefresh() {
        disableAutoRefresh();
        disableRefreshOnOpeningRepresentation();

        // open Odesign
        SWTBotVSMEditor odesignEditor = openViewpointSpecificationModel(VSM);

        modifyVSM(odesignEditor);

        // Open editor
        editor = openRepresentation(localSession.getOpenedSession(), REPRESENTATION_NAME, REPRESENTATION_INSTANCE_NAME, DTree.class);

        editor.save();
        SWTBotUtils.waitProgressMonitorClose("Progress Information");

        TreeItem widgetNewEclass1 = null;

        if (editor.bot().tree().getTreeItem(NEWECLASS1).widget instanceof TreeItem) {
            widgetNewEclass1 = editor.bot().tree().getTreeItem(NEWECLASS1).widget;
        }

        assertNotNull("The tree item for the class is null", widgetNewEclass1);

        checkTreeItemStyle(widgetNewEclass1, false, 8, NEWECLASS1, lightGreen, lightYellow, false, "bold");

        // Manual refresh with click context menu
        editor.bot().tree().contextMenu(REFRESH_TREE).click();
        SWTBotUtils.waitProgressMonitorClose("Progress Information");

        refreshEditorTest();

        localSession.closeNoDirty();
    }

    /**
     * Tests that the Sirius tree item's font size is the runtime one and not the VSM one when the option
     * {@link SiriusTreeUiPreferencesKeys#PREF_ALWAYS_USE_STANDARD_FONT_SIZE} is set to true.
     */
    @Test
    public void testTreeItemStyleWithStandardFontSizeOptionActivated() {
        boolean originalStandardFontSizePrefValue = TreeUIPlugin.getPlugin().getPreferenceStore().getBoolean(SiriusTreeUiPreferencesKeys.PREF_ALWAYS_USE_STANDARD_FONT_SIZE.name());
        try {
            TreeUIPlugin.getPlugin().getPreferenceStore().setValue(SiriusTreeUiPreferencesKeys.PREF_ALWAYS_USE_STANDARD_FONT_SIZE.name(), true);

            // Open editor
            editor = openRepresentation(localSession.getOpenedSession(), REPRESENTATION_NAME, REPRESENTATION_INSTANCE_NAME, DTree.class);
            editor.save();
            SWTBotUtils.waitProgressMonitorClose("Progress Information");

            TreeItem widgetNewEclass1 = null;

            if (editor.bot().tree().getTreeItem(NEWECLASS1).widget instanceof TreeItem) {
                widgetNewEclass1 = editor.bot().tree().getTreeItem(NEWECLASS1).widget;
            }

            assertNotNull("The tree item for the class is null", widgetNewEclass1);

            checkTreeItemStyle(widgetNewEclass1, false, syncExec(() -> {
                Font defaultFont = PlatformUI.getWorkbench().getDisplay().getSystemFont();
                FontData fontData = defaultFont.getFontData()[0];
                return fontData.getHeight();
            }), NEWECLASS1, lightGreen, lightYellow, true, "bold");
        } finally {
            TreeUIPlugin.getPlugin().getPreferenceStore().setValue(SiriusTreeUiPreferencesKeys.PREF_ALWAYS_USE_STANDARD_FONT_SIZE.name(), originalStandardFontSizePrefValue);
        }
    }

    /**
     * Undo and redo on refresh action.
     */
    private void undoRedoRefresh() {
        TreeItem widgetNewEclass1 = null;
        String treeItemName = null;

        if (editor.bot().tree().getAllItems().length > 0) {
            treeItemName = editor.bot().tree().getAllItems()[0].getText();
        }
        if (treeItemName != null) {
            widgetNewEclass1 = editor.bot().tree().getTreeItem(treeItemName).widget;
        }

        labelColor = getLabelColor(widgetNewEclass1);
        assertThat(labelColor, equalTo(blue));
        assertThat(getWidgetLabelColor(widgetNewEclass1), equalTo(blue));

        SWTBotUtils.waitAllUiEvents();

        // Undo
        bot.menu("Edit").menu(UNDO).click();
        SWTBotUtils.waitAllUiEvents();
        bot.waitUntil(new CheckTreeItemColor(widgetNewEclass1, lightGreen));
        labelColor = getLabelColor(widgetNewEclass1);
        assertThat(labelColor, equalTo(lightGreen));
        assertThat(getWidgetLabelColor(widgetNewEclass1), equalTo(lightGreen));

        // ReDo
        bot.menu("Edit").menu(REDO).click();
        SWTBotUtils.waitAllUiEvents();
        bot.waitUntil(new CheckTreeItemColor(widgetNewEclass1, blue));
        labelColor = getLabelColor(widgetNewEclass1);
        assertThat(labelColor, equalTo(blue));
        assertThat(getWidgetLabelColor(widgetNewEclass1), equalTo(blue));
    }

    /**
     * Check the tree item style.
     * 
     * @param widgetNewEclass1
     */
    private void checkTreeItemStyle(TreeItem widgetNewEclass1, boolean expectedShowIcon, int expectedFontSize, String expectedLabel, Color expectedLabelColor, Color expectedBackgroundColor,
            boolean checkOnlyTreeItemFontStyle, String... expectedFontFormat) {
        assertNotNull(widgetNewEclass1);
        List<String> actual = getLabelFormat(widgetNewEclass1);
        List<String> expected = Arrays.asList(expectedFontFormat);
        if (!checkOnlyTreeItemFontStyle) {
            // Retrieve show icon, label size, label expression, label
            // alignment,
            // label format, color background, label color of 'new EClass 1'
            boolean showIcon = isShowIcon(widgetNewEclass1);
            int labelSize = getLabelSize(widgetNewEclass1);
            String labelExpression = getWidgetLabelExpression(widgetNewEclass1);
            String iconPath = getIconPath(widgetNewEclass1);
            // String labelAlignment = getLabelAlignment(widgetNewEclass1);

            // Check the DTreeItem and its style
            assertEquals(expectedShowIcon, showIcon);
            assertEquals(expectedFontSize, labelSize);
            assertEquals(expectedLabel, labelExpression);
            // assertThat(labelAlignment, equalTo("RIGHT"));

            assertThat(actual, is(expected));
            assertThat(iconPath, anyOf(equalTo(""), nullValue()));
            assertEquals(expectedBackgroundColor, getLabelBackgroundColor(widgetNewEclass1));
            assertEquals(expectedLabelColor, getLabelColor(widgetNewEclass1));
        }

        // Check the widget
        actual = getFontFormatLiterals(SWTBotUtils.getWidgetFormat(widgetNewEclass1));
        assertThat(actual, is(expected));
        assertThat(getWidgetBackgroundColor(widgetNewEclass1), equalTo(expectedBackgroundColor));
        assertThat(getWidgetLabelColor(widgetNewEclass1), equalTo(expectedLabelColor));
        assertThat(getWidgetSize(widgetNewEclass1), equalTo(expectedFontSize));
        Image widgetImage = getWidgetImage(widgetNewEclass1);
        if (expectedShowIcon) {
            assertNotNull(widgetImage);
        } else {
            assertNull(widgetImage);
        }
    }

    private static List<String> getFontFormatLiterals(List<FontFormat> fontFormat) {
        List<String> expected = new ArrayList<String>();
        for (FontFormat style : fontFormat) {
            expected.add(style.getName());
        }
        return expected;
    }

    /**
     * Modify all fields in properties view of tree item style description in viewpoint specific model (.odesign).
     * 
     * @param odesignEditor
     *            the odesign editor.
     */
    private void modifyVSM(SWTBotVSMEditor odesignEditor) {
        // expand the tree : Tree Item Style Description 8
        SWTBotTree tree = odesignEditor.bot().tree();
        tree.expandNode(ODESIGN).expandNode(GROUP).expandNode("Design").expandNode("Tree").expandNode("Class").expandNode("feature:name").select();

        // accesses to property view
        SWTBotView viewByTitle = bot.viewByTitle(PROPERTIES);
        viewByTitle.setFocus();
        SWTBot propertiesViewBot = viewByTitle.bot();

        // accesses to tab Label
        SWTBotSiriusHelper.selectPropertyTabItem(LABEL, propertiesViewBot);
        changeShowIcon(propertiesViewBot);
        changeAndTestPropertyTabLabel(8, 12, "feature:name", "aql:'Test' + self.name", 0, 1, propertiesViewBot);
        SWTBotUtils.waitAllUiEvents();
        // Save odesign
        saveViewpointSpecificationModel(VSM);
        SWTBotUtils.waitAllUiEvents();

        // accesses to tab Color
        SWTBotSiriusHelper.selectPropertyTabItem(COLOR, propertiesViewBot);
        changeAndTestPropertyTabColor(17, 1, 13, 2, propertiesViewBot);

        // Save odesign
        saveViewpointSpecificationModel(VSM);
        SWTBotUtils.waitAllUiEvents();
        SWTBotUtils.waitProgressMonitorClose("Progress Information");
    }

    /**
     * Verify that editor changes made in the odesign.
     */
    private void refreshEditorTest() {
        editor.show();
        editor.save();
        SWTBotUtils.waitProgressMonitorClose("Progress Information");

        TreeItem widgetNewEclass1 = null;
        String treeItemName = null;

        if (editor.bot().tree().getAllItems().length > 0) {
            treeItemName = editor.bot().tree().getAllItems()[0].getText();
        }
        if (treeItemName != null) {
            widgetNewEclass1 = editor.bot().tree().getTreeItem(treeItemName).widget;
        }

        checkTreeItemStyle(widgetNewEclass1, true, 12, "Testnew EClass 1", blue, black, false, "italic", "bold");
    }

    /**
     * Retrieve, test, change and test all fields in General tab.
     * 
     * @param swtBot
     */
    private void changeShowIcon(SWTBot swtBot) {
        // Retrieve show icon check
        assertFalse(swtBot.checkBox(4).isChecked());
        // Check show icon
        swtBot.checkBox(4).click();
        assertTrue(swtBot.checkBox(4).isChecked());
    }

    /**
     * Retrieve, test, change and test all fields in Label tab.
     * 
     * @param valueLabelSize
     *            index of spinner for label size
     * @param newValueLabelSize
     *            index of spinner for new label size
     * @param valueLabelExpression
     *            the value of label expression
     * @param newValueLabelExpression
     *            the value of new label expression
     * @param valueLabelAlignement
     *            the index of radio button for label alignment
     * @param newValueLabelAlignement
     *            the index of radio button for new label alignment
     * @param valueLabelFormat
     *            the index of radio button for label format
     * @param newValueLabelFormat
     *            the index of radio button for new label format
     * @param swtBot
     */
    private void changeAndTestPropertyTabLabel(int valueLabelSize, int newValueLabelSize, String valueLabelExpression, String newValueLabelExpression, int valueLabelFormat, int newValueLabelFormat,
            SWTBot swtBot) {
        // Retrieve label format
        assertTrue(swtBot.checkBox(valueLabelFormat).isChecked());
        // Change label format
        swtBot.checkBox(newValueLabelFormat).click();
        assertTrue(swtBot.checkBox(newValueLabelFormat).isChecked());
        // Retrieve label expression
        assertThat(swtBot.text(0).getText(), equalTo(valueLabelExpression));
        // Retrieve label size
        assertThat(swtBot.spinner(0).getSelection(), equalTo(valueLabelSize));
        // Change label size
        swtBot.spinner(0).setFocus();
        swtBot.spinner(0).setSelection(newValueLabelSize);
        assertThat(swtBot.spinner(0).getSelection(), equalTo(newValueLabelSize));
        SWTBotUtils.pressEnterKey(swtBot.spinner(0).widget);

        // Change label expression
        swtBot.text(0).setFocus();
        swtBot.text(0).setText(newValueLabelExpression);
        assertThat(swtBot.text(0).getText(), equalTo(newValueLabelExpression));
        SWTBotUtils.pressEnterKey(swtBot.spinner(0).widget);
    }

    /**
     * Retrieve, test, change and test all fields in Color tab.
     * 
     * @param backgroundValue
     *            index for the background color
     * @param newBackgroundValue
     *            index for the new background color
     * @param labelColorValue
     *            index for the label color value
     * @param newLabelColorValue
     *            index for the new label color value
     */
    private void changeAndTestPropertyTabColor(int backgroundValue, int newBackgroundValue, int labelColorValue, int newLabelColorValue, SWTBot swtBot) {
        // Retrieve color for Background Color and verify equal to light_yellow
        String backgroundColor = swtBot.ccomboBox(1).selection();
        assertThat(backgroundColor, equalTo(MAPCOLORVALUE.get(backgroundValue)));
        // Choose black color for Background Color
        swtBot.ccomboBox(1).setSelection(newBackgroundValue);
        String newBackgroundColor = swtBot.ccomboBox(1).selection();
        assertThat(newBackgroundColor, equalTo(MAPCOLORVALUE.get(newBackgroundValue)));
        // Retrieve color for Label Color
        String labelColor = swtBot.ccomboBox(0).selection();
        assertThat(labelColor, equalTo(MAPCOLORVALUE.get(labelColorValue)));
        // Choose blue color for Label Color
        swtBot.ccomboBox(0).setSelection(newLabelColorValue);
        String newLabelColor = swtBot.ccomboBox(0).selection();
        assertThat(newLabelColor, equalTo(MAPCOLORVALUE.get(newLabelColorValue)));
    }
}