SWTBotTest.java

/*******************************************************************************
 * Copyright (c) 2008 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
 *     Vincent Mahe - http://swtbot.org/bugzilla/show_bug.cgi?id=123
 *******************************************************************************/
package org.eclipse.swtbot.swt.finder;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

import org.eclipse.swtbot.swt.finder.finders.UIThreadRunnable;
import org.eclipse.swtbot.swt.finder.results.VoidResult;
import org.eclipse.swtbot.swt.finder.test.AbstractMenuExampleTest;
import org.eclipse.swtbot.swt.finder.utils.SWTBotPreferences;
import org.eclipse.swtbot.swt.finder.waits.DefaultCondition;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotShell;
import org.eclipse.swtbot.swt.finder.widgets.TimeoutException;
import org.junit.Test;

/**
 * @author Ketan Padegaonkar <KetanPadegaonkar [at] gmail [dot] com>
 * @author Vincent Mahe <vmahe [at] irisa [dot] fr>
 * @version $Id$
 */
public class SWTBotTest extends AbstractMenuExampleTest {

	private SWTBot	bot;

	@Test
	public void waits5SecondsAndFailsForFailingCondition() throws Exception {
		// a custom timeout could have been specified so we save it...
		long currentTimeout = SWTBotPreferences.TIMEOUT;
		// ...and we set it to the expected 5 seconds
		SWTBotPreferences.TIMEOUT = 5000;
		
		final long begin = System.currentTimeMillis();
		try {
			bot.waitUntil(new DefaultCondition() {
				public boolean test() throws Exception {
					return false;
				}

				public String getFailureMessage() {
					return "timed out";
				}
			});
			fail("Expected a timeout exception");
		} catch (TimeoutException expected) {
			final long end = System.currentTimeMillis();
			final long timeout = end - begin;
			assertTrue(timeout >= 5000);
			assertTrue(timeout <= 6000);
			assertEquals("Timeout after: 5000 ms.: timed out", expected.getMessage());
		}
		
		// and we reset the possible custom timeout
		SWTBotPreferences.TIMEOUT = currentTimeout;
	}

	@Test
	public void doesNotWait5SecondsAndPassesForPassingCondition() throws Exception {
		final long begin = System.currentTimeMillis();
		bot.waitUntil(new DefaultCondition() {
			public boolean test() throws Exception {
				return true;
			}

			public String getFailureMessage() {
				return "timed out";
			}
		});
		final long end = System.currentTimeMillis();
		final long timeout = end - begin;
		assertTrue(timeout <= 100);

	}

	@Test
	public void throwsExceptionOnNegativeTimeOut() throws Exception {
		try {
			bot.waitUntil(null, -10);
			fail("expecting an exception");
		} catch (Exception e) {
			assertEquals("assertion failed: timeout value is negative", e.getMessage());
		}
	}

	@Test
	public void getsAllShells() throws Exception {
		assertEquals(2, bot.shells().length);
	}

	@Test
	public void findsShellsById() throws Exception {
		final SWTBotShell shell = bot.shell("Address Book - Untitled");
		UIThreadRunnable.syncExec(new VoidResult() {
			public void run() {
				shell.widget.setData("foo-shell", "bar");
			}
		});

		assertSame(shell.widget, bot.shellWithId("foo-shell", "bar").widget);
	}

	@Test
	public void waitsLessThan5sWhenConditionSwitchToFailing() {
		final long begin = System.currentTimeMillis();
		bot.waitWhile(new DefaultCondition() {

			public String getFailureMessage() {
				return "time out";
			}

			public boolean test() throws Exception {
				if (System.currentTimeMillis() < begin + 2500)
					return true;
				return false;
			}

		});
		final long end = System.currentTimeMillis();
		final long timeout = end - begin;
		assertTrue(timeout >= 2500);
		assertTrue(timeout < 5000);
	}

	@Test
	public void waitsMoreThan5sWhenConditionDoesNotSwitchToFailing() {
		// a custom timeout could have been specified so we save it...
		long currentTimeout = SWTBotPreferences.TIMEOUT;
		// ...and we set it to the expected 5 seconds
		SWTBotPreferences.TIMEOUT = 5000;
		
		final long begin = System.currentTimeMillis();
		try {
			bot.waitWhile(new DefaultCondition() {

				public String getFailureMessage() {
					return "time out";
				}

				public boolean test() throws Exception {
					if (System.currentTimeMillis() < begin + 10000)
						return true;
					return false;
				}

			});
		} catch (TimeoutException expected) {
			final long end = System.currentTimeMillis();
			final long timeout = end - begin;
			assertTrue(timeout >= 5000);
			assertTrue(timeout <= 6000);
			assertEquals("Timeout after: 5000 ms.: time out", expected.getMessage());
		}
		
		// and we reset the possible custom timeout
		SWTBotPreferences.TIMEOUT = currentTimeout;
	}

	public void setUp() throws Exception {
		super.setUp();
		bot = new SWTBot();
	}
}