plugins/org.eclipse.sirius.tests.swtbot.support/src/org/eclipse/sirius/tests/swtbot/support/api/dialog/ViewpointSelectionDialog.java

/**
 * Copyright (c) 2009, 2014 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.support.api.dialog;

import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

import org.eclipse.sirius.tests.swtbot.support.utils.SWTBotUtils;
import org.eclipse.swtbot.eclipse.finder.SWTWorkbenchBot;
import org.eclipse.swtbot.swt.finder.waits.Conditions;
import org.eclipse.swtbot.swt.finder.waits.DefaultCondition;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotButton;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotShell;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotTableItem;
import org.junit.Assert;

/**
 * Wrapper for viewpoints selection dialog.
 * 
 * @author dlecan
 */
public class ViewpointSelectionDialog {
    /**
     * The title of the Viewpoints selection dialog.
     */
    public static final String VIEWPOINT_DIALOG_NAME = "Viewpoints Selection";

    private final SWTWorkbenchBot bot;

    /**
     * Create a new instance.
     * 
     * @param bot
     *            the SWT bot
     */
    public ViewpointSelectionDialog(final SWTWorkbenchBot bot) {
        this.bot = bot;
    }

    /**
     * "Select Viewpoints" operation (when creating a new local session, either
     * via wizard or drag and drop of model in local session view).
     * <p>
     * If a viewpoint is provided in both sets, this viewpoint will be selected.
     * Unselection action will be ignored.
     * </p>
     * 
     * @param viewpointToSelect
     *            Viewpoint to select.
     * @param viewpointToDeselect
     *            Viewpoint to deselect.
     */
    public void selectViewpoint(final Set<String> viewpointToSelect, final Set<String> viewpointToDeselect) {
        bot.waitUntil(Conditions.shellIsActive(ViewpointSelectionDialog.VIEWPOINT_DIALOG_NAME));

        final SWTBotShell shellViewpointsSelection = bot.shell(ViewpointSelectionDialog.VIEWPOINT_DIALOG_NAME);

        if (viewpointToSelect != null && viewpointToDeselect != null) {
            // Put the two lists in new one in order to call
            // remove() on it and failIfMissingViewpoints() at the end
            Set<String> viewpointSelection = new HashSet<String>(viewpointToSelect);
            viewpointSelection.addAll(viewpointToDeselect);

            if (!viewpointSelection.isEmpty()) {
                for (int rowPosition = 0; rowPosition < bot.table().rowCount(); rowPosition++) {

                    final SWTBotTableItem item = bot.table().getTableItem(rowPosition);
                    final String text = item.getText();

                    if (viewpointToSelect.contains(text)) {
                        // select the item
                        item.check();
                        viewpointSelection.remove(text);
                    } else if (viewpointToDeselect.contains(text)) {
                        // deselect the item
                        item.uncheck();
                        viewpointSelection.remove(text);
                    }
                }
                failIfMissingViewpoints(viewpointSelection);

                final SWTBotButton okButton = bot.button("OK");

                bot.waitUntil(new DefaultCondition() {

                    @Override
                    public String getFailureMessage() {
                        return "OK button is not enabled";
                    }

                    @Override
                    public boolean test() throws Exception {
                        return okButton.isEnabled();
                    }

                });
            }
        }
        bot.button("OK").click();
        SWTBotUtils.waitProgressMonitorClose("Progress Information");
        bot.waitUntil(Conditions.shellCloses(shellViewpointsSelection));

        SWTBotUtils.waitProgressMonitorClose("Apply new viewpoints selection");
    }

    /**
     * "Select Viewpoints" operation (when creating a new local session, either
     * via wizard or drag and drop of model in local session view).
     * 
     * @param viewpoints
     *            Viewpoint to select.
     */
    public void selectViewpoint(String... viewpoints) {
        selectViewpoint(new HashSet<String>(Arrays.asList(viewpoints)), Collections.<String> emptySet());
    }

    /**
     * "Select Viewpoints" operation (when creating a new local session, either
     * via wizard or drag and drop of model in local session view).
     *
     * @param viewpoints
     *            Viewpoint to deselect.
     */
    public void deselectViewpoint(String... viewpoints) {
        selectViewpoint(Collections.<String> emptySet(), new HashSet<String>(Arrays.asList(viewpoints)));
    }

    private void failIfMissingViewpoints(final Set<String> remainingViewpoints) {
        final StringBuilder message = new StringBuilder();
        for (final String vpName : remainingViewpoints) {
            message.append("\"");
            message.append(vpName);
            message.append("\" ");
        }
        if (message.length() > 0) {
            message.append(" viewpoint(s) was/were not found");
            Assert.fail(message.toString());
        }
    }

}