Jump to: navigation, search

SWTBot/UsersGuide

SWTBot Users Guide

Introduction

SWTBot is an open-source Java based functional testing tool for testing SWT and Eclipse based applications.

SWTBot provides APIs that are simple to read and write. The APIs also hide the complexities involved with SWT and Eclipse. This makes it suitable for functional testing by everyone. SWTBot also provides its own set of assertions that are useful for SWT. You can also use your own assertion framework with SWTBot.

SWTBot can record and playback tests and integrates with Eclipse, and also provides for ant tasks so that you can run your builds from within CruiseControl or any other CI tool that you use.

SWTBot can run on all platforms that SWT runs on. Very few other testing tools provide such a wide variety of platforms.

Quick Start

Configuration

  • Add the following to your classpath:
  org.eclipse.swtbot.finder
  org.apache.commons.collections
  org.apache.log4j
  • These are useful if you are using SWTBot to test Eclipse plugins
  org.eclipse.swtbot.eclipse.finder

Getting started with SWTBot

SWTBot requires that tests run on a non-UI thread. If you run tests on the UI thread, they will eventually block the UI at some point in time. More info on this behavior available in the FAQ.

Getting started with SWTBot for SWT applications

Because SWTBot tests need to run in a non-UI thread, it is essential that the application starts off in another thread. The example below uses a simple mechanism to start the tests in another thread. You could use any other mechanism to do this instead.

import net.sf.swtbot.SWTBotTestCase;
import net.sf.swtbot.utils.SWTUtils;
import net.sf.swtbot.widgets.TimeoutException;
 
import org.eclipse.swt.widgets.Display;
 
public class FooBarTest extends SWTBotTestCase {
 
  // pull this up into your own superclass that extends SWTBotTestCase and extend from your superclass instead
  static { 
    startApplicationInAnotherThread();
  }
 
  protected void setUp() throws Exception {
    super.setUp();
    waitForDisplayToAppear(5000); // wait for the display to appear before you do anything
  }
 
  public void testClicksOnAButton() throws Exception {
    bot.button("click me").click();
    bot.button("you just clicked me!").click();
  }
 
  public void testThisFails() throws Exception {
    bot.button("this does not exist").click();
  }
 
  private void waitForDisplayToAppear(long timeOut) throws TimeoutException, InterruptedException {
    long endTime = System.currentTimeMillis() + timeOut;
    while (System.currentTimeMillis() < endTime) { // wait until timeout
      try {
        Display display = SWTUtils.display();
        if (display != null)
          return;
      } catch (Exception e) {
        // did not find a display? no problems, try again
      }
      Thread.sleep(100); // sleep for a while and try again
    }
    throw new TimeoutException("timed out");
  }
 
  private static void startApplicationInAnotherThread() {
    new Thread(new Runnable() {
      public void run() {
        new MyApplication().main(new String[] { "some", "command", "line", "arguments for your application" });
      }
    }).start();
  }
 
}

Getting started with SWTBot for Eclipse Plugins

To use SWTBot along with your eclipse plugin application you have to add the below plugins to your dependencies.

  org.eclipse.swtbot.swt.finder
  org.eclipse.swtbot.eclipse.finder
  org.junit4

Now you can start using SWTBot. Below you can find a sample SWTBot testcase:

import junit.framework.TestCase;
 
import org.eclipse.swtbot.eclipse.finder.SWTEclipseBot;
import org.eclipse.swtbot.swt.finder.exceptions.WidgetNotFoundException;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotTree;
 
/**
 * 
 * This is a sample swtbot testcase for an eclipse application.
 * 
 */
public class TestSampleDialog extends TestCase {
 
           	/**
	         * In future you do not need to create this instance. 
	         * You need to extend SWTBotEclipseTestCase which holds an instance of 
	         * SWTEclipseBot.
	         */
	        protected SWTEclipseBot	bot = new SWTEclipseBot();
 
 
		/**
		 * This testcase will create a new java project in 
		 * your workspace.
		 */
		public void testCreateJavaProject(){
 
			try{
				bot.view("Welcome").close() ;
			}catch (WidgetNotFoundException e) {
				System.out.println("Welcome window not found!!!");
			}
 
			//This will open the the menu File > New > Project wizard
			bot.menu("File").menu("New").menu("Project...").click();
			bot.sleep(1000);
 
			//Select the java project from the wizard tree.
			SWTBotTree projectSelectionTree = bot.tree();
			projectSelectionTree.select("Java Project");
			bot.sleep(1000);
 
			//Click Next button
			bot.button("Next >");
			bot.sleep(1000);
 
			//'com.swtbot.test.project' is the java project name to create
			bot.textWithLabel("Project name:").setText("com.swtbot.test.project");
			bot.sleep(1000);
 
			//Click the Finish button
			bot.button("Finish").click();
			bot.sleep(1000);
 
			//Now the project is created in your workspace.
 
		}
 
		/**
		 * This testcase will set the focus on a view.
		 */
		public void testFocusView() {
			try{
				bot.view("Welcome").close() ;
			}catch (WidgetNotFoundException e) {
				System.out.println("Welcome window not found!!!");
			}
			//This will set focus on the Problems view
			//The view is identified using the title of the view.
			bot.view("Problems").setFocus();
			//The sleep command can be used to slow down the testcase 
			//execution so that you can see it or you can wait for a
			//background process to complete.
			bot.sleep(2000);
		}
 
}

You can find one more SWTBot Testcase snippet below,

// subclassing SWTBotTestCase gives you an instance of
// SWTBot that offers a lot of convinience api
// this class also has a lot of assertions that are suited for ui operations
public class FooTest extends SWTBotEclipseTestCase {
 
  // stuff you can do with Eclipse
  public void testDoSomethingInterestingWithEclipse() throws Exception {
    bot.view("Package Explorer").close();
    bot.editor("HelloWorld.java").save();
    bot.editor("FooBar.java").close();
 
    bot.activeEditor().typeText("public static void main ()...");
    bot.activeEditor().quickfix("Rename in file");
 
    // will insert "System.out.println();" in the currently open editor
    bot.activeEditor().autoCompleteProposal("sys", "sysout - print to standard out");
  }
 
  // stuff you can do with SWT
  public void testDoSomethingInterestingWithSWT() throws Exception {
 
    // there are two parts to SWTBot:
    // one to find a control (the subject)
    // and the action to be performed on the control (the verb)
    bot.shell("Address Book - Untitled").activate();
    bot.button("Hello World").click();
    bot.menu("File").menu("New").click();
    bot.captureScreenshot("myscreenshot.png");
 
    bot.listWithLabel("My Items").select(new String[] { "foo", "bar", "baz" });
 
    // there are a lot of assertions that are very useful
    assertEnabled(bot.button("Foo Bar"));
    assertVisible(bot.checkBox("This should not visible"));
    assertTextContains("I just love this!", bot.textWithLabel("Comments"));
  }
}

Executing SWTBot Tests for Eclipse Plugins

Now that you've written the great test that you'd always wanted to, lets now see it run. In order to run the test, right click on the test and select Run As > Run Configurations...

Run-as-option.jpg


Create a new test under SWTBot Test. Ensure that you're using JUnit 3

Run-as-config-create.jpg


Select the application that you want to test

Run-as-config-options.jpg