org.eclipse.swtbot.eclipse.finder.test/src/org/eclipse/swtbot/eclipse/finder/widgets/SWTBotViewTest.java

/*******************************************************************************
 * Copyright (c) 2008, 2017 Ketan Padegaonkar and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Ketan Padegaonkar - initial API and implementation
 *     Frank Schuerer - https://bugs.eclipse.org/bugs/show_bug.cgi?id=424238
 *     Mickael Istria (Red Hat Inc.) - Refactoring for bug 437915
 *     Patrick Tasse - Speed up SWTBot tests
 *                   - SWTBotView does not support dynamic view menus (Bug 489325)
 *******************************************************************************/
package org.eclipse.swtbot.eclipse.finder.widgets;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

import java.util.List;

import org.eclipse.swtbot.eclipse.finder.FinderTestIds;
import org.eclipse.swtbot.eclipse.finder.SWTWorkbenchBot;
import org.eclipse.swtbot.swt.finder.exceptions.WidgetNotFoundException;
import org.eclipse.swtbot.swt.finder.junit.SWTBotJunit4ClassRunner;
import org.eclipse.swtbot.swt.finder.utils.SWTBotPreferences;
import org.eclipse.swtbot.swt.finder.waits.Conditions;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotButton;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotMenu;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotToolbarButton;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotToolbarDropDownButton;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotToolbarRadioButton;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotToolbarToggleButton;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotTree;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotTreeItem;
import org.junit.Test;
import org.junit.runner.RunWith;

/**
 * @author Ketan Padegaonkar <KetanPadegaonkar [at] gmail [dot] com>
 * @version $Id$
 */
@RunWith(SWTBotJunit4ClassRunner.class)
public class SWTBotViewTest extends AbstractSWTBotEclipseTest {

	private SWTWorkbenchBot	bot	= new SWTWorkbenchBot();

	@Test
	public void findsView() throws Exception {
		bot.menu("Help").menu("Welcome").click();
		bot.viewByTitle("Welcome");
	}

	@Test
	public void getsViewTitle() throws Exception {
		bot.menu("Help").menu("Welcome").click();
		assertEquals("Welcome", bot.viewByTitle("Welcome").getTitle());
	}

	@Test
	public void notFindingViewThrowsException() throws Exception {
		try {
			bot.viewByTitle("Non existent view");
			fail("Expecting WidgetNotFoundException");
		} catch (WidgetNotFoundException expected) {
			// pass
		}
	}

	@Test
	public void closesAView() throws Exception {
		bot.menu("Help").menu("Welcome").click();
		SWTBotView view = bot.viewByTitle("Welcome");
		view.close();

		for (SWTBotView aview : bot.views()) {
			if (aview.getTitle().equals("Welcome")) {
				fail("Not expecting Welcome view");
			}
		}
	}

	@Test
	public void openView() throws Exception {
		openSWTBotTestView();
	}

	private void openSWTBotTestView() throws Exception {
		this.bot.sleep(1000);
		this.bot.menu("Window").menu("Show View").menu("Other...").click();
		this.bot.shell("Show View").activate();
		SWTBotTree tree = bot.tree();
		SWTBotTreeItem expandNode = tree.expandNode("SWTBot Test Category");
		expandNode.getNode("SWTBot Test View").click();
		getOkButtonInShowViewDialog().click();
		this.bot.viewByTitle("SWTBot Test View").show();
	}

	@Test
	public void menusAddedProgramatically() throws Exception {
		openSWTBotTestView();
		SWTBotView view = bot.viewByTitle("SWTBot Test View");

		// Runs an action that is an iAction and doesn't contain a contribution id
		view.viewMenu().menu("IAction Type Command").click();
		bot.button("OK").click();

		// Runs an action that is an iAction with ID
		view.viewMenu().menu("IAction with ID Type Command").click();
		bot.button("OK").click();
	};

	@Test
	public void menusExtensionsCommandWithoutParameters() throws Exception {
		openSWTBotTestView();
		SWTBotView view = bot.viewByTitle("SWTBot Test View");

		// Runs an action that has a contribution ID instead of the action.
		view.viewMenu().menu("Contribution Item Command").click();
		bot.button("OK").click();
	}

	/**
	 * Test commands contributed via org.eclipse.ui.menus and org.eclipse.core.commands
	 * that have parameters
	 * @throws Exception
	 */
	@Test
	public void menusExtensionsParameterizedCommand() throws Exception {
		openSWTBotTestView();
		SWTBotView view = bot.viewByTitle("SWTBot Test View");

		// Runs an action that has a contribution ID instead of the action.
		view.viewMenu().menu("Try the Banana").click();
		bot.button("OK").click();
	}

	@Test
	public void getToolbarButtons() throws Exception {
		openSWTBotTestView();
		SWTBotView view = bot.viewByTitle("SWTBot Test View");

		List<SWTBotToolbarButton> items = view.getToolbarButtons();
		assertNotNull(items);
		assertEquals(4, items.size());
	}

	@Test
	public void toolbarPushButton() throws Exception {
		openSWTBotTestView();
		SWTBotView view = bot.viewByTitle("SWTBot Test View");

		SWTBotToolbarButton button = view.toolbarButton("This represents an IAction command.");
		assertNotNull(button);

		button.click();
		bot.button("OK").click();
	}

	@Test
	public void toolbarToogleButton() throws Exception {
		openSWTBotTestView();
		SWTBotView view = bot.viewByTitle("SWTBot Test View");

		SWTBotToolbarToggleButton button = view.toolbarToggleButton("This represents a toggle IAction command.");
		assertNotNull(button);

		button.click();
		bot.button("OK").click();
	}

	@Test
	public void toolbarRadioButton() throws Exception {
		openSWTBotTestView();
		SWTBotView view = bot.viewByTitle("SWTBot Test View");

		SWTBotToolbarRadioButton button = view.toolbarRadioButton("This represents a radio IAction command.");
		assertNotNull(button);

		button.click();
		bot.button("OK").click();
	}

	@Test
	public void toolbarDropDownButton() throws Exception {
		openSWTBotTestView();
		SWTBotView view = bot.viewByTitle("SWTBot Test View");

		SWTBotToolbarDropDownButton button = view.toolbarDropDownButton("This represents a drop down IAction command.");
		assertNotNull(button);

		button.click();
		bot.button("OK").click();
	}

	@Test
	public void toolbarButtonNotFound() throws Exception {
		openSWTBotTestView();
		SWTBotView view = bot.viewByTitle("SWTBot Test View");

		try {
			view.toolbarButton("Tooltip can not exist");
			fail("This should throw an exception of widget not being found");
		} catch (WidgetNotFoundException e) {
			// This is expected.
		}
	}

	@Test
	public void viewBotWidgetScope() {
		try {
			SWTBotPreferences.TIMEOUT = 0;
			bot.perspectiveById(FinderTestIds.PERSPECTIVE_ID_FORM).activate();
			SWTBotView form1 = bot.viewByTitle("Form 1");
			try {
				form1.bot().textWithLabel("Form 2");
				fail("Form 2 text with label should not be reachable in form 1");
			} catch (WidgetNotFoundException e) {
				// expected
			}
			assertEquals("Form 1", form1.bot().textWithLabel("Form 1").getText());

			SWTBotView form2 = bot.viewByTitle("Form 2");
			try {
				form2.bot().textWithLabel("Form 1");
				fail("Form 1 text with label should not be reachable in form 2");
			} catch (WidgetNotFoundException e) {
				// expected
			}
			assertEquals("Form 2", form2.bot().textWithLabel("Form 2").getText());
		} finally {
			SWTBotPreferences.TIMEOUT = 5000;
		}
	}

	@Test
	public void viewActionDelegateWithId() throws Exception {
		openSWTBotTestView();

		SWTBotView view = bot.viewByTitle("SWTBot Test View");
		view.viewMenu().menu("View Action with ID").click();

		bot.button("OK").click();
	}

	@Test
	public void viewMenuDropDown() throws Exception {
		openSWTBotTestView();

		SWTBotView view = bot.viewByTitle("SWTBot Test View");
		SWTBotMenu menu = view.viewMenu().menu("DropDown", "DropDown Toggle");
		assertFalse(menu.isChecked());
		menu.click();
		menu = view.viewMenu().menu("DropDown", "DropDown Toggle");
		assertTrue(menu.isChecked());
		menu.hide();
	}

	@Test
	public void breakpointsViewMenuWorkingSets() {
		this.bot.menu("Window").menu("Show View").menu("Other...").click();
		this.bot.shell("Show View").activate();
		SWTBotTree tree = bot.tree();
		SWTBotTreeItem expandNode = tree.expandNode("Debug");
		bot.waitUntil(Conditions.treeItemHasNode(expandNode, "Breakpoints"));
		expandNode.getNode("Breakpoints").click();
		getOkButtonInShowViewDialog().click();

		SWTBotView breakpointsView = this.bot.viewByTitle("Breakpoints");
		breakpointsView.show();
		breakpointsView.viewMenu().menu("Working Sets...").click();

		bot.button("OK").click();
	}

	private SWTBotButton getOkButtonInShowViewDialog() {
		// Button text was "OK" before Oxygen M7, "Open" since.
		SWTBotButton button = bot.button();
		if (!button.getText().equals("Open") && !button.getText().equals("OK")) {
			button = bot.button(1);
		}
		return button;
	}
}