SwtBot: Unit Testing Made Easy

SWTBot: Unit Testing Made Easy
Eclipse Day India 2011
Ankit Goel
6th May, 2011

Agenda
PART I – About SWTBot
Introduction to SWTBot
SWTBot Features
Supported Widgets
Test Executions
PART II - Integrating SWTBot tests execution with continuous build system
What more?
Limitations

PART I – About SWTBot

Introduction – What is SWTBot?
Java based UI/functional testing tool for testing SWT and Eclipse based applications
Set of API’s to access and manipulate widgets
Cross platform
Free and open source
Still in Incubation Phase in Eclipse

Introduction – Why SWTBot?
Why not QTP? Why not PDE Junit? Why not…
Provides an intuitive way to access and test UI components in Eclipse
UI Testing covers all layers of software
Easy to learn if someone is already familiar with Java and JUnit
Can integrate very well within the IDE and provides excellent support for integration with Ant

Introduction – Who is it for?
Developers
Unit tests
Integration with build ensures quality builds
QA
Test automation
Quality product

Setting up Eclipse environment
SWTBot update site
http://www.eclipse.org/swtbot/downloads.php
Create a plugin project and setup dependencies
org.eclipse.ui
org.eclipse.core.runtime
org.eclipse.swtbot.eclipse.finder
org.eclipse.swtbot.junit4_x
org.eclipse.swtbot.swt.finder
org.junit4
org.hamcrest
Or, create a SWTBot test plugin

How does it work?
SWTBot = bot which acts on SWT components
Entry point: org.eclipse.swtbot.eclipse.finder.SWTWorkbenchBot
Helper classes for widgets
To test:
Instantiate bot
SWTWorkbenchBotbot = new SWTWorkbenchBot();
Click on button
SWTBotButton button = bot.button("Hello, World!“);
button.click();
Congrats! You have just written your first SWTBOT test 

SWTBot Features
Finding controls based on visual cues
Support for simulated mouse and keyboard input
Querying widgets for state
UI specific assertions like: assertEnabled(Widget)
Investigating test failures

SWTBot Features – Finding Controls
Controls can be found based on visual cues like:
Text
Label
Group
Tooltip
Ids
Combination of all or any of the above (Using matchers)
Eg:
Find textbox that has a label 'Username:‘
SWTBotText username = bot.textWithLabel("Username:");
Identify button using tooltip
SWTBotToolbarButton save = bot.toolbarButtonWithTooltip("Save");

SWTBot Features – Using matchers
Simple matchers
withText(“Finish”)
withLabel(“Username:”)
withRegex(“Proceed to step * ”)
widgetOfType(Button.class)
withStyle(SWT.ARROW, “SWT.ARROW”)
Combination of matchers
allOf(matchers)
anyOf(matchers)
not(matchers)

Filtering controls using Matchers
Match : widgets of type 'Label'
with regular expression 'Welcome, <USERNAME>'
Matcher matcher = allOf(
widgetOfType(Label.class),
withRegex("Welcome, .*") );
Get the label that matches the matcher
SWTBotLabel label =
new SWTBotLabel((Label) bot.widget(matcher));

SWTBot Features – Simulate input
SWTBot provides API to simulate actions on widgets
Eg:
Click a button
button.click();
Select a item in combobox
comboBox.select(“Option 12");
Type in a textbox
text.typeText(“This is a demo string");
Expand tree
tree.expandNode("MyProject", "src", "com", "example", "MyClass.java");

SWTBot Features – Querying widgets
Provides operations to query the state of widgets
Some generic queries like: getText(), isEnabled(), isVisible() are available on all widgets
Eg:
Check state of a checkbox
booleanchecked = checkbox.isChecked();
Check if a radio button is selected
boolean selected = radio.isSelected();

SWTBot Features – Investigating test failures
Stack trace in Junit view
Capturing screen shot when test case fails
@RunWith(SWTBotJunit4ClassRunner.class)
publicclassMessageCreateTest{
...
…
}

Supported Widgets
Support for most SWT controls
Support for most UI operations on SWT controls
Support for Eclipse based contributions:
Views
Text Editors (autocompletion, typing, etc)
View Toolbars and View Menus

SWT Test Execution
By launching them from launch configuration (same as Junit execution)
From command line, using shell script or ant

Demo
A small SWTBot example illustrating the simplicity of SWTBot
Your first SWTBot

PART II – Integrating SWTBot tests execution with continuous build system

Integration of test execution with continuous build
Build plugins to be tested
Build SWTBot test plugins
Install plugins to be tested, test plugins and headless testing framework (http://www.eclipse.org/swtbot/downloads.php) into eclipse
Start SWTBot test case execution
Format the generated report and mail if required

Pre-requisite
Each test plugin must contain test.xml
Set appropriate properties
Delegate execution of test to a library file
Test plugins should always be ‘unpacked’

Under the covers…
For each test plugin
Invoke test.xml which will
Set required properties like class name, plugin name, directory to use as temp workspace etc
Invoke target ‘swtbot-test’ of library file located in ‘org.eclipse.swtbot.eclipse.junit4.headless’ plugin which will then launch and execute all test cases
Invoke target ‘collect’ of library file located in ‘org.eclipse.swtbot.eclipse.junit4.headless’ plugin which will consolidate test case results in one file
Format the generated results file (xml file) into desired format (usually html)

Snippet – test.xml
<anttarget="swtbot-test"antfile="${library-file}"dir="${eclipse-home}">
<property name="data-dir"value="${temp-workspace}" />
<propertyname="plugin-name"value="${plugin-name}" />
<propertyname="classname”value=“${class-name}" />
<propertyname="vmargs"value=" -Xms128M -Xmx368M - XX:MaxPermSize=256M" />
</ant>

Still confused ?
This would surely help

What more?
Parse results file and fail build if any of the test fails – ensuring only quality builds go to QA
Code Coverage – write more tests to test uncovered code

Limitations
Less documentation available
Some SWT widgets not supported yet!
No support for other UI toolkits – GEF, Nebula etc

SwtBot: Unit Testing Made Easy

by Ankit Goel on May 12, 2011

Accessibility

Categories

Tags

Upload Details

Usage Rights

1 Embed 357

Statistics

SwtBot: Unit Testing Made Easy — Presentation Transcript