You can download the dependencies from https://swtbot.svn.sourceforge.net/svnroot/swtbot/branches/java-1.5-api-spike/org.eclipse.swtbot.releng/externals/plugins/ for now (and put them in .releng/externals/plugins)

+

=== Creating A Project ===

−

A patched version of the eclipse test framework is available at https://swtbot.svn.sourceforge.net/svnroot/swtbot/branches/java-1.5-api-spike/org.eclipse.swtbot.releng/test-sandbox/eclipse-test-framework-3.3.zip (you'll need to put this into .releng/externals)

+

Create a new project by clicking on '''File>New>Project'''. On the '''New Project Dialog''', search for "plug-in", select '''New Plug-in Project''' and click '''Next'''. Create a new plugin project named '''org.eclipsecon.swtbot.example'''.

+

[[Image:Swtbot-create-project.gif]]

+

+

===Configuration===

* Add the following to your classpath:

* Add the following to your classpath:

−

org.eclipse.swtbot.finder

+

org.eclipse.swtbot.eclipse.core

+

org.eclipse.swtbot.eclipse.finder

+

org.eclipse.swtbot.junit4_x

+

org.hamcrest

org.apache.commons.collections

org.apache.commons.collections

+

org.junit4

org.apache.log4j

org.apache.log4j

−

* These are useful if you are using SWTBot to test Eclipse plugins

+

org.eclipse.ui

−

org.eclipse.swtbot.eclipse.finder

+

−

===Installation from the GIT Repository===

+

[[Image:Swtbot-setup-dependencies.gif]]

−

If you expect to be making changes to the SWTBot source code then the you should consider using GIT. The SWTBot Subversion repository is mirrored to a GIT repository. Although GIT has a higher learning curve than Subversion, you will find it easier to manage your changes and it will be easier for others to pull your changes.

+

===Getting started with SWTBot===

−

The GIT repository is at git://github.com/ketan/swtbot.git.

+

SWTBot requires that tests run on a non-UI thread, so that '''PlatformUI.getWorkbench()''' will return you null and that traditional unit-test code won't work. If you run tests on the UI thread, they will eventually block the UI at some point in time. Take a look into the FAQ for [[SWTBot/FAQ#Why do tests run on a non-UI thread?|explanations]] and [[SWTBot/FAQ#How do I execute parts of tests that need UI thread?|workaround]].

−

If you clone this repository and import the projects into Eclipse, you will find a few errors. These can be fixed as follows:

+

===Getting started with SWTBot for Eclipse Plugins===

−

org.eclipse.swtbot.eclipse.ui contains two versions of the .classpath file. These are named _classpath.eclipse_3.4 and _classpath.eclipse_3.5. Copy one of these to .classpath, depending on which version of Eclipse is being used in your runtime environment. The build errors for this plug-in should go away. There are also two versions of the build.properties file. You will need to copy one of these too if you are going to do PDE builds or create your own update site.

+

To use SWTBot along with your eclipse plugin application you have to add the below plugins to your dependencies. You can download the example from the swtbot download site http://download.eclipse.org/technology/swtbot/docs/eclipsecon2009/examples.zip.

+

+

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

−

org.eclipse.swtbot.junit4_x contains two versions each of .classpath and MANIFEST.MF in the META-INF directory. Depending on the version of JUnit you are using, copy one of _classpath.junit4_3 or _classpath.junit4_5 to .classpath and in the META-INF directory copy one of MANIFEST.MF_junit4_3 or MANIFEST.MF_junit4_5 to MANIFEST.MF. The build errors for this plug-in should go away.

+

<source lang="java">

+

package org.eclipsecon.swtbot.example;

−

Note that the org.hamcrest and com.thoughtworks bundles are checked into the SWTBot GIT repository and can be found in the org.eclipse.swtbot.releng project in externals/plugins. So you don't have to fetch these separately as you would if using the Subversion repository at eclipse.org.

+

import org.eclipse.swtbot.eclipse.finder.SWTWorkbenchBot;

+

import org.eclipse.swtbot.swt.finder.junit.SWTBotJunit4ClassRunner;

+

import org.eclipse.swtbot.swt.finder.widgets.SWTBotShell;

+

import org.junit.AfterClass;

+

import org.junit.BeforeClass;

+

import org.junit.Test;

+

import org.junit.runner.RunWith;

−

===Building an SWTBot Update Site===

+

@RunWith(SWTBotJunit4ClassRunner.class)

+

public class MyFirstTest {

−

If you are using SWTBot in a project with many developers, and you want those other developers to run and maintain test, and you have made modifications to SWTBot then you will want to make those modifications easily available to the other developers. The easiest way to do this is to set up an update site that contains SWTBot with your modifications.

+

private static SWTWorkbenchBot bot;

−

To create an update site, follow the instructions in MakingARelease.HOWTO in the org.eclipse.swtbot.releng bundle. Do not use the org.eclipse.swtbot.updatesite bundle. That is old stuff that creates an old-style update site (it predates Equinox p2). You should ensure unique versions, generally done by including your company name or project name in the version string.

+

@BeforeClass

+

public static void beforeClass() throws Exception {

+

bot = new SWTWorkbenchBot();

+

bot.viewByTitle("Welcome").close();

+

}

−

===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 [[SWTBot/FAQ|FAQ]].

+

@Test

+

public void canCreateANewJavaProject() throws Exception {

+

bot.menu("File").menu("New").menu("Project...").click();

−

===Getting started with SWTBot for SWT applications===

+

SWTBotShell shell = bot.shell("New Project");

+

shell.activate();

+

bot.tree().expandNode("Java").select("Java Project");

+

bot.button("Next >").click();

−

Because SWTBot tests need to [[SWTBot/FAQ#Why_do_tests_run_on_a_non-UI_thread.3F|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.

+

bot.textWithLabel("Project name:").setText("MyFirstProject");

−

<source lang="java">

+

bot.button("Finish").click();

−

import net.sf.swtbot.SWTBotTestCase;

+

// FIXME: assert that the project is actually created, for later

−

import net.sf.swtbot.utils.SWTUtils;

+

}

−

import net.sf.swtbot.widgets.TimeoutException;

+

−

import org.eclipse.swt.widgets.Display;

+

@AfterClass

+

public static void sleep() {

+

bot.sleep(2000);

+

}

−

public class FooBarTest extends SWTBotTestCase {

+

}

+

</source>

−

// pull this up into your own superclass that extends SWTBotTestCase and extend from your superclass instead

+

===Executing SWTBot Tests for Eclipse Plugins===

−

static {

+

−

startApplicationInAnotherThread();

+

−

}

+

−

protected void setUp() throws Exception {

+

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 > SWTBot Test'''

−

super.setUp();

+

−

waitForDisplayToAppear(5000); // wait for the display to appear before you do anything

SWT has a plugin that allows to manipulate GEF/GMF diagrams, editors and editParts as easily as you can manipulate SWT widgets with SWTBot. Then you can easily create some repeatable user-level UI interations and check their effects on the diagram

−

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

+

== Configuration ==

−

+

−

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:

+

The configuration is similar to the one describe before for SWTBot, except that you also have to add '''org.eclipse.swtbot.eclipse.gef.finder''' plugin and some other dependencies, such as '''org.eclipse.ui'''. In most case, you'll also like to use GEF and/or GMF plugins to make some checks on diagram.

−

<source lang="java">

+

== Getting started with examples ==

−

import junit.framework.TestCase;

+

−

import org.eclipse.swtbot.eclipse.finder.SWTEclipseBot;

+

If you like to get started with working examples, you can take a look at the following URL, or [[SWTBot/Contributing#Getting the source | check them out]] in your workspace.

Everything is almost the same as using SWTBot, except that some classes change in order to give you the ability to manipulate DiagramEditors. The SWTBotTestCase superclass must be replaced by '''SWTBotGefTestCase'''. From the inside of your SWTBotTestCase, you can access your '''SWTGefBot''' ''bot'' field to play with your GEF editor. Then you retrieve a '''SWTBotGefEditor''' by using ''bot.getEditor("label of my editor tab")''.

−

* This testcase will create a new java project in

+

−

* your workspace.

+

−

*/

+

−

public void testCreateJavaProject() {

+

−

try {

+

Once you have your SWTBotGefEditor, you can perform high level user operations programatically:

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

A Screencast

Creating A Project

Create a new project by clicking on File>New>Project. On the New Project Dialog, search for "plug-in", select New Plug-in Project and click Next. Create a new plugin project named org.eclipsecon.swtbot.example.

Getting started with SWTBot

SWTBot requires that tests run on a non-UI thread, so that PlatformUI.getWorkbench() will return you null and that traditional unit-test code won't work. If you run tests on the UI thread, they will eventually block the UI at some point in time. Take a look into the FAQ for explanations and workaround.

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 > SWTBot Test

Select the application that you want to test

GEF/GMF-based editor testing

Intro

SWT has a plugin that allows to manipulate GEF/GMF diagrams, editors and editParts as easily as you can manipulate SWT widgets with SWTBot. Then you can easily create some repeatable user-level UI interations and check their effects on the diagram

Configuration

The configuration is similar to the one describe before for SWTBot, except that you also have to add org.eclipse.swtbot.eclipse.gef.finder plugin and some other dependencies, such as org.eclipse.ui. In most case, you'll also like to use GEF and/or GMF plugins to make some checks on diagram.

Getting started with examples

If you like to get started with working examples, you can take a look at the following URL, or check them out in your workspace.

General principles

Everything is almost the same as using SWTBot, except that some classes change in order to give you the ability to manipulate DiagramEditors. The SWTBotTestCase superclass must be replaced by SWTBotGefTestCase. From the inside of your SWTBotTestCase, you can access your SWTGefBotbot field to play with your GEF editor. Then you retrieve a SWTBotGefEditor by using bot.getEditor("label of my editor tab").

Once you have your SWTBotGefEditor, you can perform high level user operations programatically: