org.eclipse.swtbot.swt.finder/src/org/eclipse/swtbot/swt/finder/SWTBotTestCase.java - swtbot/org.eclipse.swtbot - Git at Google

 /*******************************************************************************
  * Copyright (c) 2008-2016 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
  *     Hans Schwaebli - http://swtbot.org/bugzilla/show_bug.cgi?id=108
  *     Hans Schwaebli - http://swtbot.org/bugzilla/show_bug.cgi?id=112
  *     Mickael Istria (Red Hat Inc.) - warn if in UI Thread
  *******************************************************************************/
 package org.eclipse.swtbot.swt.finder;

 import java.io.File;

 import org.apache.log4j.Logger;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Widget;
 import org.eclipse.swtbot.swt.finder.utils.ClassUtils;
 import org.eclipse.swtbot.swt.finder.utils.SWTBotPreferences;
 import org.eclipse.swtbot.swt.finder.utils.SWTUtils;
 import org.eclipse.swtbot.swt.finder.widgets.AbstractSWTBot;
 import org.junit.Before;

 import junit.framework.TestCase;

 /**
  * The SWTBotTestCase extends the JUnit TestCase to provide extra capabilities for comparing widgets and other UI items.
  *
  * @author Ketan Padegaonkar &lt;KetanPadegaonkar [at] gmail [dot] com&gt;
  * @version $Id$
  * @since 1.0
  * @see SWTBotAssert
  */
 public abstract class SWTBotTestCase extends TestCase {

 	/**
 	 * An instance of SWTBot that may be used by extending items.
 	 *
 	 * @since 1.1
 	 */
 	protected SWTBot		bot					= new SWTBot();

 	/** The logger. */
 	private static Logger	log					= Logger.getLogger(SWTBotTestCase.class);

 	/** Counts the screenshots to determine if maximum number is reached. */
 	private static int		screenshotCounter	= 0;

 	@Before
 	public void setUp() {
 		if (Display.getCurrent() != null) {
 			log.warn("SWTBot test needs to run in a non-UI thread.\n" +
                                  "Make sure that \"Run in UI thread\" is unchecked in your launch configuration or that useUIThread is set to false in the pom.xml");
 		}
 	}

 	/**
 	 * Asserts that two widgets do not refer to the same object.
 	 *
 	 * @see #assertNotSame(String, Object, Object)
 	 * @param expected the object you don't expect
 	 * @param actual the object to compare to unexpected
 	 */
 	public static void assertNotSameWidget(Widget expected, Widget actual) {
 		SWTBotAssert.assertNotSameWidget(expected, actual);
 	}

 	/**
 	 * Asserts the two widgets do not refer to the same object. The message will be used if the test fails.
 	 *
 	 * @param message the identifying message or null for the AssertionError
 	 * @param expected the object you don't expect
 	 * @param actual the object to compare to unexpected
 	 */
 	public static void assertNotSameWidget(String message, Widget expected, Widget actual) {
 		SWTBotAssert.assertNotSameWidget(message, expected, actual);
 	}

 	/**
 	 * Asserts that the <code>needle</code> is contained within the <code>hayStack</code>.
 	 *
 	 * @param needle the text to search in the <code>hayStack</code>.
 	 * @param hayStack the text to look within.
 	 */
 	public static void assertContains(String needle, String hayStack) {
 		SWTBotAssert.assertContains(needle, hayStack);
 	}

 	/**
 	 * Asserts that the <code>needle</code> is not present in the <code>hayStack</code>.
 	 *
 	 * @param needle the text to search in the <code>hayStack</code>.
 	 * @param hayStack the text to look within.
 	 */
 	public static void assertDoesNotContain(String needle, String hayStack) {
 		SWTBotAssert.assertDoesNotContain(needle, hayStack);
 	}

 	/**
 	 * Asserts that two widgets refer to the same widget.
 	 *
 	 * @param expected the expected widget
 	 * @param actual the widget to compare to expected
 	 */
 	public static void assertSameWidget(Widget expected, Widget actual) {
 		SWTBotAssert.assertSameWidget(expected, actual);
 	}

 	/**
 	 * Asserts that two widgets refer to the same widgets.
 	 *
 	 * @param message the identifying message or <code>null</code> for the AssertionError
 	 * @param expected the expected widget
 	 * @param actual the widget to compare to expected
 	 */
 	public static void assertSameWidget(String message, Widget expected, Widget actual) {
 		SWTBotAssert.assertSameWidget(message, expected, actual);
 	}

 	/**
 	 * A helper to explicitly convey that the test has passed. Does nothing.
 	 */
 	public static void pass() {
 		// Do nothing
 	}

 	/**
 	 * Assert that the given string is the same as the widgets text.
 	 *
 	 * @param expected the expected text
 	 * @param widget the widget to get the text from to compare.
 	 */
 	public static void assertText(String expected, Widget widget) {
 		SWTBotAssert.assertText(expected, widget);
 	}

 	/**
 	 * Assert that the given string is the same as the widgets text.
 	 *
 	 * @param expected the expected text
 	 * @param widget the widget to get the text from to compare.
 	 */
 	public static void assertText(String expected, AbstractSWTBot<? extends Widget> widget) {
 		SWTBotAssert.assertText(expected, widget);
 	}

 	/**
 	 * Assert that the text on the widget contains the expected text.
 	 *
 	 * @param expected the expected text.
 	 * @param widget the widget
 	 */
 	public static void assertTextContains(String expected, Widget widget) {
 		SWTBotAssert.assertTextContains(expected, widget);
 	}

 	/**
 	 * Assert that the text on the widget contains the expected text.
 	 *
 	 * @param expected the expected text
 	 * @param widget the widget
 	 */
 	public static void assertTextContains(String expected, AbstractSWTBot<? extends Widget> widget) {
 		SWTBotAssert.assertTextContains(expected, widget);
 	}

 	/**
 	 * Assert that the text on the widget does not contain the expected text.
 	 *
 	 * @param expected the expected text
 	 * @param widget the widget
 	 */
 	public static void assertTextDoesNotContain(String expected, Widget widget) {
 		SWTBotAssert.assertTextDoesNotContain(expected, widget);
 	}

 	/**
 	 * Assert that the text on the widget does not contain the expected text.
 	 *
 	 * @param expected the expected text
 	 * @param widget the widget
 	 */
 	public static void assertTextDoesNotContain(String expected, AbstractSWTBot<? extends Widget> widget) {
 		SWTBotAssert.assertTextDoesNotContain(expected, widget);
 	}

 	/**
 	 * Asserts that the widget is enabled.
 	 *
 	 * @param widget the widget.
 	 */
 	public static void assertEnabled(AbstractSWTBot<? extends Widget> widget) {
 		SWTBotAssert.assertEnabled(widget);
 	}

 	/**
 	 * Asserts that the widget is not enabled.
 	 *
 	 * @param widget the widget.
 	 */
 	public static void assertNotEnabled(AbstractSWTBot<? extends Widget> widget) {
 		SWTBotAssert.assertNotEnabled(widget);
 	}

 	/**
 	 * Asserts that the widget is visible.
 	 *
 	 * @param widget the widget.
 	 */
 	public static void assertVisible(AbstractSWTBot<? extends Widget> widget) {
 		SWTBotAssert.assertVisible(widget);
 	}

 	/**
 	 * Asserts that the widget is not visible.
 	 *
 	 * @param widget the widget.
 	 */
 	public static void assertNotVisible(AbstractSWTBot<? extends Widget> widget) {
 		SWTBotAssert.assertNotVisible(widget);
 	}

 	/**
 	 * Overides the runBare method to TestCase to add the ability to capture a screen shot when an error is thrown. The
 	 * screenshot is saved to a file in the current run directory inside a folder called {@code screenshots} that gets
 	 * created if it does not already exist. The screenshot will be saved with the file {@code
 	 * screenshots/screenshot-<classname>.<testname>.png}
 	 *
 	 * @see junit.framework.TestCase#runBare()
 	 * @throws Throwable Thrown if an error occurs during running.
 	 */
 	@Override
 	public void runBare() throws Throwable {
 		Throwable exception = null;
 		try {
 			super.runBare();
 		} catch (Throwable running) {
 			exception = running;
 			captureScreenshot();
 		}
 		if (exception != null)
 			throw exception;
 	}

 	/**
 	 * Helper used by {@link #runBare()}.
 	 *
 	 * @see #runBare()
 	 */
 	private void captureScreenshot() {
 		try {
 			int maximumScreenshots = SWTBotPreferences.MAX_ERROR_SCREENSHOT_COUNT;
 			String fileName = "screenshots/screenshot-" + ClassUtils.simpleClassName(getClass()) + "." + getName() + "." //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
 					+ SWTBotPreferences.SCREENSHOT_FORMAT.toLowerCase();
 			if (++screenshotCounter <= maximumScreenshots) {
 				new File("screenshots").mkdirs(); //$NON-NLS-1$
 				SWTUtils.captureScreenshot(fileName);
 			} else {
 				log.info("No screenshot captured for '" + ClassUtils.simpleClassName(getClass()) + "." + getName() //$NON-NLS-1$ //$NON-NLS-2$
 						+ "' because maximum number of screenshots reached: " + maximumScreenshots); //$NON-NLS-1$
 			}
 		} catch (Exception e) {
 			log.warn("Could not capture screenshot", e); //$NON-NLS-1$
 		}
 	}

 	/**
 	 * Allows the screen shot to be captured and saved to the given file.
 	 *
 	 * @see SWTUtils#captureScreenshot(String)
 	 * @param fileName the filename to save screenshot to.
 	 * @return <code>true</code> if the screenshot was created and saved, <code>false</code> otherwise.
 	 */
 	public static boolean captureScreenshot(String fileName) {
 		return SWTUtils.captureScreenshot(fileName);
 	}

 	/**
 	 * Assert that the widget text matches the regex.
 	 *
 	 * @param regex the regex.
 	 * @param actual the widget.
 	 */
 	public static void assertMatchesRegex(String regex, AbstractSWTBot<? extends Widget> actual) {
 		SWTBotAssert.assertMatchesRegex(regex, actual);
 	}

 	/**
 	 * Assert that the widget text matches the regex.
 	 *
 	 * @param regex the regex.
 	 * @param actual the widget.
 	 */
 	public static void assertMatchesRegex(String regex, Widget actual) {
 		SWTBotAssert.assertMatchesRegex(regex, actual);
 	}

 	/**
 	 * Assert that the widget text matches the regex.
 	 *
 	 * @param regex the regex.
 	 * @param actual the widget.
 	 */
 	public static void assertMatchesRegex(String regex, String actual) {
 		SWTBotAssert.assertMatchesRegex(regex, actual);
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2008-2016 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
	* Hans Schwaebli - http://swtbot.org/bugzilla/show_bug.cgi?id=108
	* Hans Schwaebli - http://swtbot.org/bugzilla/show_bug.cgi?id=112
	* Mickael Istria (Red Hat Inc.) - warn if in UI Thread
	*******************************************************************************/
	package org.eclipse.swtbot.swt.finder;

	import java.io.File;

	import org.apache.log4j.Logger;
	import org.eclipse.swt.widgets.Display;
	import org.eclipse.swt.widgets.Widget;
	import org.eclipse.swtbot.swt.finder.utils.ClassUtils;
	import org.eclipse.swtbot.swt.finder.utils.SWTBotPreferences;
	import org.eclipse.swtbot.swt.finder.utils.SWTUtils;
	import org.eclipse.swtbot.swt.finder.widgets.AbstractSWTBot;
	import org.junit.Before;

	import junit.framework.TestCase;

	/**
	* The SWTBotTestCase extends the JUnit TestCase to provide extra capabilities for comparing widgets and other UI items.
	*
	* @author Ketan Padegaonkar <KetanPadegaonkar [at] gmail [dot] com>
	* @version $Id$
	* @since 1.0
	* @see SWTBotAssert
	*/
	public abstract class SWTBotTestCase extends TestCase {

	/**
	* An instance of SWTBot that may be used by extending items.
	*
	* @since 1.1
	*/
	protected SWTBot bot = new SWTBot();

	/** The logger. */
	private static Logger log = Logger.getLogger(SWTBotTestCase.class);

	/** Counts the screenshots to determine if maximum number is reached. */
	private static int screenshotCounter = 0;

	@Before
	public void setUp() {
	if (Display.getCurrent() != null) {
	log.warn("SWTBot test needs to run in a non-UI thread.\n" +
	"Make sure that \"Run in UI thread\" is unchecked in your launch configuration or that useUIThread is set to false in the pom.xml");
	}
	}

	/**
	* Asserts that two widgets do not refer to the same object.
	*
	* @see #assertNotSame(String, Object, Object)
	* @param expected the object you don't expect
	* @param actual the object to compare to unexpected
	*/
	public static void assertNotSameWidget(Widget expected, Widget actual) {
	SWTBotAssert.assertNotSameWidget(expected, actual);
	}

	/**
	* Asserts the two widgets do not refer to the same object. The message will be used if the test fails.
	*
	* @param message the identifying message or null for the AssertionError
	* @param expected the object you don't expect
	* @param actual the object to compare to unexpected
	*/
	public static void assertNotSameWidget(String message, Widget expected, Widget actual) {
	SWTBotAssert.assertNotSameWidget(message, expected, actual);
	}

	/**
	* Asserts that the <code>needle</code> is contained within the <code>hayStack</code>.
	*
	* @param needle the text to search in the <code>hayStack</code>.
	* @param hayStack the text to look within.
	*/
	public static void assertContains(String needle, String hayStack) {
	SWTBotAssert.assertContains(needle, hayStack);
	}

	/**
	* Asserts that the <code>needle</code> is not present in the <code>hayStack</code>.
	*
	* @param needle the text to search in the <code>hayStack</code>.
	* @param hayStack the text to look within.
	*/
	public static void assertDoesNotContain(String needle, String hayStack) {
	SWTBotAssert.assertDoesNotContain(needle, hayStack);
	}

	/**
	* Asserts that two widgets refer to the same widget.
	*
	* @param expected the expected widget
	* @param actual the widget to compare to expected
	*/
	public static void assertSameWidget(Widget expected, Widget actual) {
	SWTBotAssert.assertSameWidget(expected, actual);
	}

	/**
	* Asserts that two widgets refer to the same widgets.
	*
	* @param message the identifying message or <code>null</code> for the AssertionError
	* @param expected the expected widget
	* @param actual the widget to compare to expected
	*/
	public static void assertSameWidget(String message, Widget expected, Widget actual) {
	SWTBotAssert.assertSameWidget(message, expected, actual);
	}

	/**
	* A helper to explicitly convey that the test has passed. Does nothing.
	*/
	public static void pass() {
	// Do nothing
	}

	/**
	* Assert that the given string is the same as the widgets text.
	*
	* @param expected the expected text
	* @param widget the widget to get the text from to compare.
	*/
	public static void assertText(String expected, Widget widget) {
	SWTBotAssert.assertText(expected, widget);
	}

	/**
	* Assert that the given string is the same as the widgets text.
	*
	* @param expected the expected text
	* @param widget the widget to get the text from to compare.
	*/
	public static void assertText(String expected, AbstractSWTBot<? extends Widget> widget) {
	SWTBotAssert.assertText(expected, widget);
	}

	/**
	* Assert that the text on the widget contains the expected text.
	*
	* @param expected the expected text.
	* @param widget the widget
	*/
	public static void assertTextContains(String expected, Widget widget) {
	SWTBotAssert.assertTextContains(expected, widget);
	}

	/**
	* Assert that the text on the widget contains the expected text.
	*
	* @param expected the expected text
	* @param widget the widget
	*/
	public static void assertTextContains(String expected, AbstractSWTBot<? extends Widget> widget) {
	SWTBotAssert.assertTextContains(expected, widget);
	}

	/**
	* Assert that the text on the widget does not contain the expected text.
	*
	* @param expected the expected text
	* @param widget the widget
	*/
	public static void assertTextDoesNotContain(String expected, Widget widget) {
	SWTBotAssert.assertTextDoesNotContain(expected, widget);
	}

	/**
	* Assert that the text on the widget does not contain the expected text.
	*
	* @param expected the expected text
	* @param widget the widget
	*/
	public static void assertTextDoesNotContain(String expected, AbstractSWTBot<? extends Widget> widget) {
	SWTBotAssert.assertTextDoesNotContain(expected, widget);
	}

	/**
	* Asserts that the widget is enabled.
	*
	* @param widget the widget.
	*/
	public static void assertEnabled(AbstractSWTBot<? extends Widget> widget) {
	SWTBotAssert.assertEnabled(widget);
	}

	/**
	* Asserts that the widget is not enabled.
	*
	* @param widget the widget.
	*/
	public static void assertNotEnabled(AbstractSWTBot<? extends Widget> widget) {
	SWTBotAssert.assertNotEnabled(widget);
	}

	/**
	* Asserts that the widget is visible.
	*
	* @param widget the widget.
	*/
	public static void assertVisible(AbstractSWTBot<? extends Widget> widget) {
	SWTBotAssert.assertVisible(widget);
	}

	/**
	* Asserts that the widget is not visible.
	*
	* @param widget the widget.
	*/
	public static void assertNotVisible(AbstractSWTBot<? extends Widget> widget) {
	SWTBotAssert.assertNotVisible(widget);
	}

	/**
	* Overides the runBare method to TestCase to add the ability to capture a screen shot when an error is thrown. The
	* screenshot is saved to a file in the current run directory inside a folder called {@code screenshots} that gets
	* created if it does not already exist. The screenshot will be saved with the file {@code
	* screenshots/screenshot-<classname>.<testname>.png}
	*
	* @see junit.framework.TestCase#runBare()
	* @throws Throwable Thrown if an error occurs during running.
	*/
	@Override
	public void runBare() throws Throwable {
	Throwable exception = null;
	try {
	super.runBare();
	} catch (Throwable running) {
	exception = running;
	captureScreenshot();
	}
	if (exception != null)
	throw exception;
	}

	/**
	* Helper used by {@link #runBare()}.
	*
	* @see #runBare()
	*/
	private void captureScreenshot() {
	try {
	int maximumScreenshots = SWTBotPreferences.MAX_ERROR_SCREENSHOT_COUNT;
	String fileName = "screenshots/screenshot-" + ClassUtils.simpleClassName(getClass()) + "." + getName() + "." //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	+ SWTBotPreferences.SCREENSHOT_FORMAT.toLowerCase();
	if (++screenshotCounter <= maximumScreenshots) {
	new File("screenshots").mkdirs(); //$NON-NLS-1$
	SWTUtils.captureScreenshot(fileName);
	} else {
	log.info("No screenshot captured for '" + ClassUtils.simpleClassName(getClass()) + "." + getName() //$NON-NLS-1$ //$NON-NLS-2$
	+ "' because maximum number of screenshots reached: " + maximumScreenshots); //$NON-NLS-1$
	}
	} catch (Exception e) {
	log.warn("Could not capture screenshot", e); //$NON-NLS-1$
	}
	}

	/**
	* Allows the screen shot to be captured and saved to the given file.
	*
	* @see SWTUtils#captureScreenshot(String)
	* @param fileName the filename to save screenshot to.
	* @return <code>true</code> if the screenshot was created and saved, <code>false</code> otherwise.
	*/
	public static boolean captureScreenshot(String fileName) {
	return SWTUtils.captureScreenshot(fileName);
	}

	/**
	* Assert that the widget text matches the regex.
	*
	* @param regex the regex.
	* @param actual the widget.
	*/
	public static void assertMatchesRegex(String regex, AbstractSWTBot<? extends Widget> actual) {
	SWTBotAssert.assertMatchesRegex(regex, actual);
	}

	/**
	* Assert that the widget text matches the regex.
	*
	* @param regex the regex.
	* @param actual the widget.
	*/
	public static void assertMatchesRegex(String regex, Widget actual) {
	SWTBotAssert.assertMatchesRegex(regex, actual);
	}

	/**
	* Assert that the widget text matches the regex.
	*
	* @param regex the regex.
	* @param actual the widget.
	*/
	public static void assertMatchesRegex(String regex, String actual) {
	SWTBotAssert.assertMatchesRegex(regex, actual);
	}
	}