org.eclipse.epp.mpc.tests/src/org/eclipse/epp/mpc/tests/ui/wizard/MarketplaceClientServiceTest.java

/*******************************************************************************
 * Copyright (c) 2010 The Eclipse Foundation 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:
 *     The Eclipse Foundation - initial API and implementation
 *     Yatta Solutions - bug 432803: public API
 *******************************************************************************/
package org.eclipse.epp.mpc.tests.ui.wizard;

import static org.hamcrest.Matchers.greaterThanOrEqualTo;
import static org.junit.Assert.*;

import java.util.Collections;
import java.util.List;

import org.eclipse.epp.internal.mpc.ui.wizards.MarketplaceClientService;
import org.eclipse.epp.mpc.core.model.ICategory;
import org.eclipse.epp.mpc.core.model.IMarket;
import org.eclipse.epp.mpc.core.service.QueryHelper;
import org.eclipse.epp.mpc.tests.ui.wizard.matcher.NodeMatcher;
import org.eclipse.epp.mpc.ui.IMarketplaceClientConfiguration;
import org.eclipse.epp.mpc.ui.IMarketplaceClientService;
import org.eclipse.epp.mpc.ui.MarketplaceClient;
import org.eclipse.epp.mpc.ui.Operation;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.TabItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.swtbot.swt.finder.SWTBot;
import org.eclipse.swtbot.swt.finder.finders.UIThreadRunnable;
import org.eclipse.swtbot.swt.finder.results.ArrayResult;
import org.eclipse.swtbot.swt.finder.waits.Conditions;
import org.eclipse.swtbot.swt.finder.waits.ICondition;
import org.eclipse.swtbot.swt.finder.waits.WaitForObjectCondition;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotButton;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotCombo;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotShell;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotTabItem;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotText;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotTreeItem;
import org.eclipse.swtbot.swt.finder.widgets.TimeoutException;
import org.eclipse.ui.PlatformUI;
import org.hamcrest.Matchers;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;


public class MarketplaceClientServiceTest {

	private SWTBot bot;

	private Display display;

	private IMarketplaceClientConfiguration config;

	private MarketplaceClientService service;

	@Before
	public void setUp() {
		service = new MarketplaceClientService();
		config = service.newConfiguration();
		display = PlatformUI.getWorkbench().getDisplay();
	}

	protected void initWizardBot() {
		bot = new SWTBot();
		bot.waitUntil(Conditions.shellIsActive("Eclipse Marketplace"));
		bot = bot.shell("Eclipse Marketplace").bot();
		SWTBotButton cancelButton = bot.button("Cancel");
		bot.waitUntil(Conditions.widgetIsEnabled(cancelButton), 30000);
	}

	@After
	public void tearDownBot() {
		if (bot != null) {
			String problem = null;
			try {
				//check if dialog is still open
				SWTBotShell mpcShell = bot.shell("Eclipse Marketplace");
				try {
					//check if any message dialogs are open
					WaitForObjectCondition<Shell> subShellResult = Conditions.waitForShell(Matchers.any(Shell.class),
							mpcShell.widget);
					bot.waitUntil(subShellResult, 100, 60);
					List<Shell> subShells = subShellResult.getAllMatches();
					for (Shell shell : subShells) {
						SWTBotShell botShell = new SWTBotShell(shell);

						//children are unexpected, so let's cry foul...
						if (problem == null) {
							problem = "MPC wizard has open child dialog:";
						}
						problem+="\n    Shell(\""+botShell.getText()+"\")";

						//kill message dialog
						botShell.close();
					}
				} catch (TimeoutException ex) {
				}
				//try killing it softly
				try {
					mpcShell.bot().button("Cancel").click();
					try {
						ICondition shellCloses = Conditions.shellCloses(mpcShell);
						bot.waitUntil(shellCloses);
						return;
					} catch (TimeoutException ex) {
					}
				} catch (TimeoutException ex) {
				}
				//now kill it hard - this is a last resort, because it can cause spurious errors in MPC jobs
				mpcShell.close();
			} catch (TimeoutException e) {
				//no MPC wizard found - maybe a bit strange, but so be it...
			} finally {
				if (problem != null) {
					//something happened
					fail(problem);
				}
			}
		}
	}

	@Test
	public void testClientServiceAvailable() {
		IMarketplaceClientService marketplaceClientService = MarketplaceClient.getMarketplaceClientService();
		assertNotNull(marketplaceClientService);
	}

	@Test
	public void testOpenDefault() throws Exception {
		Display display = PlatformUI.getWorkbench().getDisplay();
		display.asyncExec(new Runnable() {

			public void run() {
				service.open(config);
			}
		});

		initWizardBot();
		checkSelectedTab("Search");
	}

	@Test
	public void testOpenInstalled() throws Exception {
		display.asyncExec(new Runnable() {

			public void run() {
				service.openInstalled(config);
			}
		});

		initWizardBot();
		checkSelectedTab("Installed");
		//We should get a message dialog here. Let's check that and close it.
		bot.shell("No Extensions Found").close();
	}

	@Test
	public void testOpenNodes() throws Exception {
		display.asyncExec(new Runnable() {

			public void run() {
				service.open(config, Collections.singleton(QueryHelper.nodeById("206")));
			}
		});

		initWizardBot();
		checkSelectedTab("Search");
		itemBot("206");
	}

	@Test
	public void testOpenSearch() throws Exception {
		final IMarket toolsMarket = QueryHelper.marketByName("Tools");
		final ICategory mylynCategory = QueryHelper.categoryByName("Mylyn Connectors");

		display.asyncExec(new Runnable() {

			public void run() {
				service.openSearch(config, toolsMarket, mylynCategory, "WikiText");
			}
		});

		initWizardBot();
		checkSelectedTab("Search");

		SWTBotCombo marketCombo = bot.comboBox(0);
		SWTBotCombo categoryCombo = bot.comboBox(1);
		assertEquals("Tools", marketCombo.getText());
		assertEquals("Mylyn Connectors", categoryCombo.getText());

		SWTBotText searchText = bot.text(0);
		assertEquals("WikiText", searchText.getText());

		itemBot(NodeMatcher.withNameRegex(".*WikiText.*"));

	}

	@Test
	public void testOpenWithSelection() throws Exception {
		config.setInitialOperations(Collections.singletonMap("206", Operation.INSTALL));

		display.asyncExec(new Runnable() {

			public void run() {
				service.open(config);
			}
		});

		initWizardBot();
		checkSelectedTab("Search");
		SWTBot itemBot = itemBot("206");
		itemBot.button("Install Pending").isEnabled();
		bot.button("Install Now >").isEnabled();
	}

	@Test
	public void testOpenSelected() throws Exception {
		config.setInitialOperations(Collections.singletonMap("206", Operation.INSTALL));

		display.asyncExec(new Runnable() {

			public void run() {
				service.openSelected(config);
			}
		});

		initWizardBot();
		checkSelectedTab("Search");
		SWTBot itemBot = itemBot("206");
		itemBot.button("Install Pending").isEnabled();
		bot.button("Install Now >").isEnabled();
	}

	@Test
	public void testOpenProvisioning() throws Exception {
		config.setInitialOperations(Collections.singletonMap("206", Operation.INSTALL));

		display.asyncExec(new Runnable() {

			public void run() {
				service.openProvisioning(config);
			}
		});

		initWizardBot();

		//make sure we are on the second page and can proceed
		bot.label("Confirm Selected Features");
		bot.button("< Install More").isEnabled();
		bot.button("Confirm >").isEnabled();

		//make sure we have one top-level item with multiple children
		SWTBotTreeItem[] nodeItems = bot.tree().getAllItems();
		assertEquals(1, nodeItems.length);
		SWTBotTreeItem[] featureItems = nodeItems[0].getItems();
		assertTrue(featureItems.length > 0);
	}

	protected SWTBot itemBot(NodeMatcher<? extends Widget> matcher) {
		List<? extends Widget> controls = bot.getFinder().findControls(matcher);
		assertThat(controls.size(), greaterThanOrEqualTo(1));
		Widget firstItem = controls.get(0);
		return new SWTBot(firstItem);
	}

	protected SWTBot itemBot(String id) {
		return itemBot(NodeMatcher.withId(id));
	}

	protected void checkSelectedTab(String tabLabel) {
		SWTBotTabItem searchTab = bot.tabItem(tabLabel);
		final TabItem tab = searchTab.widget;
		TabItem[] selection = UIThreadRunnable.syncExec(new ArrayResult<TabItem>() {

			public TabItem[] run() {
				return tab.getParent().getSelection();
			}
		});
		assertEquals(1, selection.length);
		assertSame(tab, selection[0]);
	}
}