What is Sikuli?

Sikuli is a visual technology to automate and test graphical user interfaces (GUI) using screenshots. You may read more about it here: http://sikuli.org

Installing Sikuli:

You can get the latest version from here: http://sikuli.org/download.shtml

Note: If you are using linux you will need to have wmctrl, and OpenCV 2.1 installed.

Using Sikuli with Twist:

There are two distinct parts to using Sikuli with Twist. The first part involves wiring Twist up to use the Sikuli jars. The second involves getting the screenshots you will require to automate your application.

To wire Twist up with Sikuli:

The Sikuli IDE you downloaded has a jar file called sikuli-script.jar. You can find this jar file under the lib directory of your Sikuli installation. You will need to copy this jar file into a directory called libs(create "libs" if it is not already present) in the Twist project where you intend to use Sikuli.

Now you can let the Twist project know that you have inserted a new library. You may do this by right clicking on the project, selecting "Properties>Java Build Path" and selecting the "Libraries" tab. Click on "Add JARs" and select the sikuli-script.jar by navigating to the libs folder under your twist project. Click on Ok.

The final part of wiring up Sikuli involves the creation of beans in your applicationContext-suite.xml file. Doing this will let Twist know how to instantiate your driver and make it available to your test code. Add the following right at the end of the applicationContext-suite.xml file, just before where it says </beans>:

<bean id="sikuli" class="org.sikuli.script.Screen"/>

This bean will make the "Screen" object available to your test code. You will use the Screen object to interact with your applications.

Now that Sikuli is wired into Twist you will be able to use it in any fixture. To test it, open a scenario you have written, or write a new scenario with a single workflow step under a fixture. Implement the fixture and navigate to the code. Create a constructor for your fixture and introduce the Screen object as a parameter in your constructor. The best way to do this is to type Scree and then press Ctrl-Space to pick from a list of suggestions(make sure you pick the option that has org.sikuli.script in it). Your constructor will then look something like:

public FixtureName(..., Screen screen) {....

If you just typed "Screen screen" instead of using suggestions, you will see Screen underlined in red. This is just letting you know that you haven't included an import statement to import Screen. This is easily remedied by typing the following at the top of your java file:

import org.sikuli.script.Screen;

Automating with Sikuli:

Sikuli works by using screenshots of specific parts of your application(buttons/textboxes etc) and performing actions on them. It is therefore imperative to have those screenshots in your Twist project. You may use the Sikuli IDE to capture the relevant screenshots for the application you are testing and then copy those over to your Twist project under a folder called "images" or something appropriate.

Once these screenshots are in place, the rest of it involves making appropriate calls to Sikuli.

For example if you have captured the Windows "Start" button as one of your screenshots, you can get Twist to click it by using:

screen.click("images/start.png");

inside one of your workflow steps.

Sikuli works very well where your application has common visual components across multiple screens but does not have a driver to easily access these controls. Flash based applications are a good class of applications that can be tested with Sikuli.

Happy testing.

I have a case where in the Login class I want to know which type of browser I am using. What is the mobile server address. What is the version of browser and other settings defined in twist.Properties

I am using the default system web browser instantiated by the twist. Twist version is 2.4.0.12621

Please let me know how to implement this or procedure for the same.

Thanks,

Sarita.