How to use Sikuli in my C# coded tests?

Overview

Sikuli Integrator is an open source framework which gives you the ability to use Sikuli in C# code.

Requirements

•  java 1.6 – tested with jre-6u35-windows-i586.exe
• Microsoft .NET 4.5
• NuGet

Add JAVA_HOME environment variable with value = path to installed JRE bin folder.

Installation

You can get a StartUp project,  or can create a new project by follow next steps:

1. Create new project in Visual Studio 2012
2. In the “Solution Explorer” – right-click on the solution
3. Choose  “Manage NuGet Packages for Solution…”
4. Search for “SikuliIntegrator” and install it
5. After the installation “JSikuliModule.jar” should be part of your solution, together with some additional files
6. Right-Click on “JSikuliModule.jar” and choose “Properties”
7. Set “Copy to Output Directory” property to “Copy always”

All set!

If you want to use latest version, check it out from SVN repository: https://sikuli-integrator.googlecode.com/svn/trunk/SikuliModule

Step 6 and 7 should be applied to all image patterns.

How to use it?

Sikuli Integrator currently support some of Sikuli features which can be called:

SikuliAction.[ACTION](ARGUMENTS);

• Exists

if (SikuliAction.Exists(pattern).IsEmpty)
{
      Console.WriteLine("Nope! It's gone...");
}
else
{
      Console.WriteLine("Yep! It's there...");
}

Where pattern is path to image.

• Click

SikuliAction.Click(pattern);

• Double Click

SikuliAction.DoubleClick(pattern);

• Right Click

SikuliAction.RightClick(pattern);

• Hover

SikuliAction.Hover(pattern);

• Wait

SikuliAction.Wait(pattern, timeout);

• WaitVanish

SikuliAction.WaitVanish(pattern, timeout);

• Drag And Drop

SikuliAction.DragAndDrop(fromPattern, toPattern);

• FindAll

//There are 3 patterns on the test image
List points = SikuliAction.FindAll(findAllPattern);
if (points != null)
{
	foreach (Point point in points)
	{
		Console.WriteLine("X:" + point.X + "  Y: " + point.Y);
	}
	if (points.Count == 3)
	{
		Console.WriteLine("Yep! They are 3...");
	}
	else
	{
		Console.WriteLine("Nope! They are NOT 3, they are " + points.Count);
	}
}
else
{
	Console.WriteLine("Nope! There is a problem...");
}