Jump to: navigation, search

Difference between revisions of "SWTBot/UsersGuide"

m (added category)
(34 intermediate revisions by 16 users not shown)
Line 1: Line 1:
 +
{{SWTBot}}
 +
 
=SWTBot Users Guide=
 
=SWTBot Users Guide=
 +
 +
Information on this page may be outdated, see [http://swtbot.org/user-guide/ this page] for a more detailed user guide or [http://swtbot.org/cheat-sheet.html the cheat sheet]
 +
 +
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==
 +
 +
=== A Screencast ===
 +
 +
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]
 +
 +
=== 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'''.
 +
 +
[[Image:Swtbot-create-project.gif]]
 +
 
===Configuration===
 
===Configuration===
  
 
* Add the following to your classpath:
 
* Add the following to your classpath:
   net.sf.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
   net.sf.swtbot.eclipse.finder
+
 
 +
[[Image:Swtbot-setup-dependencies.gif]]
  
 
===Getting started with SWTBot===
 
===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]].
+
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]].
  
===Getting started with SWTBot for SWT applications===
+
===Getting started with SWTBot for Eclipse Plugins===
  
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.
+
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:
  
 
<source lang="java">
 
<source lang="java">
import net.sf.swtbot.SWTBotTestCase;
+
package org.eclipsecon.swtbot.example;
import net.sf.swtbot.utils.SWTUtils;
+
import net.sf.swtbot.widgets.TimeoutException;
+
  
import org.eclipse.swt.widgets.Display;
+
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;
  
public class FooBarTest extends SWTBotTestCase {
+
@RunWith(SWTBotJunit4ClassRunner.class)
 +
public class MyFirstTest {
  
  // pull this up into your own superclass that extends SWTBotTestCase and extend from your superclass instead
+
private static SWTWorkbenchBot bot;
  static {
+
    startApplicationInAnotherThread();
+
  }
+
  
  protected void setUp() throws Exception {
+
@BeforeClass
    super.setUp();
+
public static void beforeClass() throws Exception {
    waitForDisplayToAppear(5000); // wait for the display to appear before you do anything
+
bot = new SWTWorkbenchBot();
  }
+
bot.viewByTitle("Welcome").close();
 +
}
  
  public void testClicksOnAButton() throws Exception {
 
    bot.button("click me").click();
 
    bot.button("you just clicked me!").click();
 
  }
 
  
  public void testThisFails() throws Exception {
+
@Test
    bot.button("this does not exist").click();
+
public void canCreateANewJavaProject() throws Exception {
  }
+
bot.menu("File").menu("New").menu("Project...").click();
  
  private void waitForDisplayToAppear(long timeOut) throws TimeoutException, InterruptedException {
+
SWTBotShell shell = bot.shell("New Project");
    long endTime = System.currentTimeMillis() + timeOut;
+
shell.activate();
    while (System.currentTimeMillis() < endTime) { // wait until timeout
+
bot.tree().expandNode("Java").select("Java Project");
      try {
+
bot.button("Next >").click();
        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() {
+
bot.textWithLabel("Project name:").setText("MyFirstProject");
    new Thread(new Runnable() {
+
 
      public void run() {
+
bot.button("Finish").click();
        new MyApplication().main(new String[] { "some", "command", "line", "arguments for your application" });
+
// FIXME: assert that the project is actually created, for later
      }
+
}
    }).start();
+
  }
+
 
 +
@AfterClass
 +
public static void sleep() {
 +
bot.sleep(2000);
 +
}
  
 
}
 
}
 
</source>
 
</source>
  
===Getting started with SWTBot for Eclipse Plugins===
+
===Executing SWTBot Tests for Eclipse Plugins===
  
Once you've put the above classes on your classpath, you can start using SWTBot. Here's a sample usage of SWTBot:
+
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'''
  
<source lang="java">
+
[[Image:run-as-option.jpg]]
import net.sf.swtbot.eclipse.finder.SWTBotTestCase;
+
  
 +
Select the application that you want to test
  
// subclassing SWTBotTestCase gives you an instance of
+
[[Image:run-as-config-options.jpg]]
// 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 SWTBotTestCase {
+
  
  // stuff you can do with Eclipse
+
= Test a GEF application =
  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 ()...");
+
== Intro ==
    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:
+
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
    // 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" });
+
== Configuration ==
  
    // there are a lot of assertions that are very useful
+
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.
    assertEnabled(bot.button("Foo Bar"));
+
    assertVisible(bot.checkBox("This should not visible"));
+
    assertTextContains("I just love this!", bot.textWithLabel("Comments"));
+
  }
+
}
+
</source>
+
  
===Executing SWTBot Tests for Eclipse Plugins===
+
== Getting started with examples ==
  
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...
+
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.
  
[[Image:run-as-option.jpg]]
+
Example folders: http://dev.eclipse.org/viewcvs/index.cgi/trunk/examples/gef/?root=Technology_SWTBot<br/>
 +
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 ==
  
Create a new test under SWTBot Test. Ensure that you're using JUnit 3
+
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")''.
  
[[Image:run-as-config-create.jpg]]
+
Once you have your SWTBotGefEditor, you can perform high level user operations programatically:
  
 +
=== Creation of elements ===
 +
<source lang="java">
 +
// 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);
 +
</source>
  
Select the application that you want to test
+
=== Direct edition of editParts ===
  
[[Image:run-as-config-options.jpg]]
+
<source lang="java">
 +
SWTBotGefEditPart editPart = editor.getEditPart("edit part label"); // select edit part by label
 +
editPart.click();
 +
editor.directEditType("new edit part label");
 +
</source>
 +
 
 +
=== Perform a drag'n'drop ===
 +
 
 +
<source lang="java">
 +
editor.mouseDrag(fromXPosition, fromYPosition, toXPosition, toYPosition)
 +
</source>
 +
 
 +
=== 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]].
  
[[Category:SWTBot]] [[Category:Eclipse Project]]
+
[[Category:Draft Documentation]] [[Category:SWTBot]]

Revision as of 08:12, 13 January 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, see this page for a more detailed user guide or the cheat sheet

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.