Jump to: navigation, search

Difference between revisions of "SWTBot/UsersGuide"

(Building an SWTBot Update Site)
(SWTBot Users Guide)
(24 intermediate revisions by 11 users not shown)
Line 1: Line 1:
 +
{{SWTBot}}
 +
 
=SWTBot Users Guide=
 
=SWTBot Users Guide=
 +
 +
Information on this page may be outdated.
 +
 +
Note that this page is for first time users. {{SWTBotLink|AdvancedUsers|Advanced Users}} click here.
 +
 
==Introduction==
 
==Introduction==
  
Line 10: Line 17:
 
SWTBot can run on all platforms that SWT runs on. Very few other testing tools provide such a wide variety of platforms.
 
SWTBot can run on all platforms that SWT runs on. Very few other testing tools provide such a wide variety of platforms.
 
==Quick Start==
 
==Quick Start==
===Configuration===
 
  
SWTBot comes with a releng project and things generally work out of the box. The build instructions are available in the readme in the releng project.
+
=== A Screencast ===
  
There are dependencies on org.hamcrest and com.thoughtworks. These are not checked into the SWTBot repository and nor are they in orbit yet.
+
Videos speak louder than pictures and words put together:
 +
* [http://download.eclipse.org/technology/swtbot/docs/videos/beginners/SWTBotGettingStartedIn5Minutes A 5 minute quick quick tutorial on how to get started with swtbot]
 +
* [http://download.eclipse.org/technology/swtbot/docs/videos/beginners/SWTBotHeadlessTestingForNovices Running SWTBot tests from the command line]
  
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();
 +
}
  
The build.xml file contains the script for building the update site.  However you must first ensure you have all the dependencies.  A separate script is provided to install the dependencies.  This script requires eclipse.sdk.url and eclipse.sdk.archive properties to be set to the location and name of the Eclipse SDK archive file.  Once those are set, you can install the dependencies by running:
 
  
ant -file download-dependencies.xml download-dependencies
+
@Test
 +
public void canCreateANewJavaProject() throws Exception {
 +
bot.menu("File").menu("New").menu("Project...").click();
  
===Getting started with SWTBot===
+
SWTBotShell shell = bot.shell("New Project");
 +
shell.activate();
 +
bot.tree().expandNode("Java").select("Java Project");
 +
bot.button("Next >").click();
  
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]].
+
bot.textWithLabel("Project name:").setText("MyFirstProject");
  
===Getting started with SWTBot for SWT applications===
+
bot.button("Finish").click();
 +
// FIXME: assert that the project is actually created, for later
 +
}
 +
  
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.
+
@AfterClass
 +
public static void sleep() {
 +
bot.sleep(2000);
 +
}
  
<source lang="java">
+
}
import net.sf.swtbot.SWTBotTestCase;
+
</source>
import net.sf.swtbot.utils.SWTUtils;
+
import net.sf.swtbot.widgets.TimeoutException;
+
  
import org.eclipse.swt.widgets.Display;
+
===Executing SWTBot Tests for Eclipse Plugins===
  
public class FooBarTest extends SWTBotTestCase {
+
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'''
  
  // pull this up into your own superclass that extends SWTBotTestCase and extend from your superclass instead
+
[[Image:run-as-option.jpg]]
  static {
+
    startApplicationInAnotherThread();
+
  }
+
  
  protected void setUp() throws Exception {
+
Select the application that you want to test
    super.setUp();
+
    waitForDisplayToAppear(5000); // wait for the display to appear before you do anything
+
  }
+
  
  public void testClicksOnAButton() throws Exception {
+
[[Image:run-as-config-options.jpg]]
    bot.button("click me").click();
+
    bot.button("you just clicked me!").click();
+
  }
+
  
  public void testThisFails() throws Exception {
+
= Test a GEF application =
    bot.button("this does not exist").click();
+
  }
+
  
  private void waitForDisplayToAppear(long timeOut) throws TimeoutException, InterruptedException {
+
== Intro ==
    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() {
+
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
    new Thread(new Runnable() {
+
      public void run() {
+
        new MyApplication().main(new String[] { "some", "command", "line", "arguments for your application" });
+
      }
+
    }).start();
+
  }
+
  
}
+
== Configuration ==
</source>
+
  
===Getting started with SWTBot for Eclipse Plugins===
+
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.
  
To use SWTBot along with your eclipse plugin application you have to add the below plugins to your dependencies.
+
== Getting started with examples ==
 
+
  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:
+
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.
  
<source lang="java">
+
Example folders: http://dev.eclipse.org/viewcvs/index.cgi/trunk/examples/gef/?root=Technology_SWTBot<br/>
import junit.framework.TestCase;
+
Example test case: http://dev.eclipse.org/viewcvs/index.cgi/trunk/examples/gef/org.eclipse.gef.examples.logic.test/src/org/eclipse/gef/examples/logic/test/OpenGefEditorTest.java?root=Technology_SWTBot&view=markup
  
import org.eclipse.swtbot.eclipse.finder.SWTEclipseBot;
+
== General principles ==
import org.eclipse.swtbot.swt.finder.exceptions.WidgetNotFoundException;
+
import org.eclipse.swtbot.swt.finder.widgets.SWTBotTree;
+
  
/**
+
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 is a sample swtbot testcase for an eclipse application.
+
*
+
*/
+
public class TestSampleDialog extends TestCase {
+
  
  /**
+
Once you have your SWTBotGefEditor, you can perform high level user operations programatically:
  * In future you will not need to create this instance.
+
  * You need to extend SWTBotEclipseTestCase which holds an instance of
+
  * SWTEclipseBot.
+
  */
+
  protected SWTEclipseBot bot = new SWTEclipseBot();
+
  
  /**
+
=== Creation of elements ===
  * This testcase will create a new java project in
+
<source lang="java">
  * your workspace.
+
// retrieve editor
  */
+
SWTBotGefEditor editor = bot.gefEditor("test.logic"); // editor must be already open
  public void testCreateJavaProject() {
+
// Simulate creation of element from palette
 +
editor.activateTool("Circuit");  // "Circuit" is the label of the tool in palette
 +
editor.mouseDrag(55, 55, 150, 100);
 +
editor.activateTool("Circuit");
 +
editor.mouseMoveLeftClick(150, 150);
 +
editor.activateTool("Connection");
 +
editor.mouseMoveLeftClick(150, 150);
 +
editor.mouseMoveLeftClick(55, 55);
 +
</source>
  
    try {
+
=== Direct edition of editParts ===
      bot.view("Welcome").close() ;
+
    } catch (WidgetNotFoundException e) {
+
      fail("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 >").click();
+
    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) {
+
      fail("Welcome window not found.");
+
    }
+
  
    //This will set focus on the Problems view
+
<source lang="java">
    //The view is identified using the title of the view.
+
SWTBotGefEditPart editPart = editor.getEditPart("edit part label"); // select edit part by label
    bot.view("Problems").setFocus();
+
editPart.click();
 
+
editor.directEditType("new edit part label");
    //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);
+
  }
+
}
+
 
</source>
 
</source>
  
You can find one more SWTBot Testcase snippet below,
+
=== Perform a drag'n'drop ===
  
 
<source lang="java">
 
<source lang="java">
// subclassing SWTBotTestCase gives you an instance of
+
editor.mouseDrag(fromXPosition, fromYPosition, toXPosition, toYPosition)
// 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"));
+
  }
+
}
+
 
</source>
 
</source>
  
===Executing SWTBot Tests for Eclipse Plugins===
+
=== Mix it with GEF/GMF to perform checks ===
  
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...
+
TODO: create an example that ensure that creation of a specific element is not possible on mainEditPart
  
[[Image:run-as-option.jpg]]
+
== Recorder and Generator ==
  
 +
SWTBot comes with a tool that generates some code based on events performed at runtime. It makes writing tests easier and faster. See [[SWTBot/Generator]].
  
Create a new test under SWTBot Test. Ensure that you're using JUnit 3
+
[[Category:Draft Documentation]] [[Category:SWTBot]]
 
+
[[Image:run-as-config-create.jpg]]
+
 
+
 
+
Select the application that you want to test
+
 
+
[[Image:run-as-config-options.jpg]]
+
 
+
[[Category:SWTBot]]
+

Revision as of 16:36, 7 March 2013


SWTBot
Website
Update Sites
Community
Mailing List
Forums/Newsgroups
IRC
Contribute
Open Bugzilla tickets
Open Gerrit reviews
Browse Source
Continuous Integration


SWTBot Users Guide

Information on this page may be outdated.

Note that this page is for first time users. Advanced Users click here.

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

Videos speak louder than pictures and words put together:

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.

Swtbot-create-project.gif

Configuration

  • Add the following to your classpath:
  org.eclipse.swtbot.eclipse.core
  org.eclipse.swtbot.eclipse.finder
  org.eclipse.swtbot.junit4_x
  org.hamcrest
  org.apache.commons.collections
  org.junit4
  org.apache.log4j
  org.eclipse.ui

Swtbot-setup-dependencies.gif

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.

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. 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:

package org.eclipsecon.swtbot.example;
 
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;
 
@RunWith(SWTBotJunit4ClassRunner.class)
public class MyFirstTest {
 
	private static SWTWorkbenchBot	bot;
 
	@BeforeClass
	public static void beforeClass() throws Exception {
		bot = new SWTWorkbenchBot();
		bot.viewByTitle("Welcome").close();
	}
 
 
	@Test
	public void canCreateANewJavaProject() throws Exception {
		bot.menu("File").menu("New").menu("Project...").click();
 
		SWTBotShell shell = bot.shell("New Project");
		shell.activate();
		bot.tree().expandNode("Java").select("Java Project");
		bot.button("Next >").click();
 
		bot.textWithLabel("Project name:").setText("MyFirstProject");
 
		bot.button("Finish").click();
		// FIXME: assert that the project is actually created, for later
	}
 
 
	@AfterClass
	public static void sleep() {
		bot.sleep(2000);
	}
 
}

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

Run-as-option.jpg

Select the application that you want to test

Run-as-config-options.jpg

Test a GEF application

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.

Example folders: http://dev.eclipse.org/viewcvs/index.cgi/trunk/examples/gef/?root=Technology_SWTBot
Example test case: http://dev.eclipse.org/viewcvs/index.cgi/trunk/examples/gef/org.eclipse.gef.examples.logic.test/src/org/eclipse/gef/examples/logic/test/OpenGefEditorTest.java?root=Technology_SWTBot&view=markup

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 SWTGefBot bot 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:

Creation of elements

	// retrieve editor
	SWTBotGefEditor editor = bot.gefEditor("test.logic"); // editor must be already open
	// Simulate creation of element from palette
	editor.activateTool("Circuit");  // "Circuit" is the label of the tool in palette
	editor.mouseDrag(55, 55, 150, 100);
	editor.activateTool("Circuit");
	editor.mouseMoveLeftClick(150, 150);
	editor.activateTool("Connection");
	editor.mouseMoveLeftClick(150, 150);
	editor.mouseMoveLeftClick(55, 55);

Direct edition of editParts

	SWTBotGefEditPart editPart = editor.getEditPart("edit part label"); // select edit part by label
	editPart.click();
	editor.directEditType("new edit part label");

Perform a drag'n'drop

	editor.mouseDrag(fromXPosition, fromYPosition, toXPosition, toYPosition)

Mix it with GEF/GMF to perform checks

TODO: create an example that ensure that creation of a specific element is not possible on mainEditPart

Recorder and Generator

SWTBot comes with a tool that generates some code based on events performed at runtime. It makes writing tests easier and faster. See SWTBot/Generator.