Welcome to the new Sahi Forums!

Sahi Tutorial

Sahi Tutorial


Sahi is an open source testing tool for web applications, with the facility to record and playback scripts. Developed in Javaâ„¢ and Javascript, this tool uses simple Javascript to execute events in the browser.


In-browser controls
Intelligent recorder
Text-based scripts
Ant support for playback of suites of tests
Multi-threaded playback from a command line
HTTP and HTTPS support
AJAX support

Sahi runs as a proxy server which intercepts traffic from the web browser and records the web browsing actions. Sahi can play back those recorded actions by injecting Javascript into the browser so it can access elements in the web page. This makes the tool independent of the website/ web application.

Sahi is similar to Selenium (http://www.openqa.org/selenium-ide/) but is not browser specific like Selenium is. Sahi works with Firefox, Internet Explorer, Opera, and Safari whereas Selenium is Firefox only. In addition, Selenium has to be deployed to the server the web application resides on. Sahi just needs a browser that can display the web application.

Sahi is released under the Apache License, Version 2.0.


Sahi requires Java 1.4 and above. You can get Java here.

Installing Sahi

You can download Sahi and the source code from here. The latest build (the one at the top of the list) is the one you want.

Unzip sahi.zip to a convenient directory of your choosing. That's it!

Running Sahi

Navigate to the Sahi directory you extracted and:

Windows: Go to \bin and run sahi.bat
Linux and Mac: Go to /bin and run sahi.sh

The Sahi proxy server will start and begin listening for traffic on port 9999.

NOTE: by default Sahi uses port 9999. This can be modified through sahi.properties in the \config directory.

Now that the Sahi proxy server is running, it's time to configure the web browser to use it.

Configuring the browser

Go to Tools > Options > Advanced > Connection Settings >
Set to "Manual Proxy Configuration"
Set "HTTP Proxy" to "localhost"
Set "Port" to "9999".
Do the same for "SSL Proxy" too, if you wish to record and playback HTTPS traffic
Keep "Use the same proxy for all protocol" unchecked as Sahi does not understand protocols other than HTTP

NOTE: "No Proxy for" should NOT have localhost or or the domain of the test application in it.

Internet Explorer:

Go to Tools > Internet Options > Connections > LAN Settings >
In "Proxy server" section, check "Use a proxy server for your LAN"
Set "Address" to "localhost"
Set "Port" to "9999"
Leave "Bypass proxy server for local addresses" unchecked
Click OK > OK


Go to Tools > Preferences > Network
Click "Proxy servers" button
Check "HTTP"
Enter localhost in the textbox
Enter "9999" for Port
Click Ok > Ok
Repeat the above if you wish to record and playback HTTPS traffic


Go to Edit > Preferences
Select "Advanced"
click "Change Settings" for Proxies
Click "LAN Settings" button
In "Proxy server" section, check "Use a proxy server for your LAN"
Set "Address" to "localhost"
Set "Port" to "9999"
Leave "Bypass proxy server for local addresses" unchecked
Click OK > OK

Testing with Sahi

Now that the Sahi proxy server is running and the web browser is configured to talk to the proxy, it is time to start using Sahi! We'll start out by using Sahi to navigate a webpage:

Open http://www.Google.com/ in your web browser
After Google loads, hold down the Ctrl and Alt keys and then double-click the web page.

The Sahi Controller should now appear:


The Sahi Controller has two tabs: Record and Playback. We will start by recording the navigation steps.

The "Script Directory" field shows you where the script will be saved. By default Sahi saves to the "scripts" directory.

NOTE: This directory can be changed via sahi.properties in the "config" directory.

Enter "Test" in the "Script Name" text field and press the "Record" button
In the web browser, enter "Sahi" in the Google search box
Now click the "Google Search" button
Click the "Stop" button in the Sahi Controller

So far, so good!

Now to play back what we just recorded:

Click the "Playback" tab in the Sahi Controller
Select "Test.sah" in the "File" selection list
Enter "http://www.Google.com/" in the "Start URL" text field
Click the "Set" button
Wait for the web page in the browser to reload
Click the "Play" button


The web browser loads the Google search page, "Sahi" is entered in the search box, and the button "Google Search" is clicked.

Clicking "Set" loaded the test script and opened the target page for the start of the test.

Sahi entered "Shai" into the textbox named "q" using the following statement:
_setValue(_textbox("q"), "Sahi");

After the text was entered, Sahi click the submit button labeled "Google Search" with this statement:
_click(_submit("Google Search"));

And finally Sahi signaled that the test was successful:
--Stopped Playback: SUCCESS--

Leave the Google results page open and we'll add a test to find an image on the page....

Click the "Record" tab again
Enter "Test" in the "Script Name" text box
Click the "Record" button
Hold down the "Ctrl" key and move the mouse cursor over the link for "Sahi" in the search results
Click the "Assert" button
Click the "Text -->" button
Click the "Apend to Script" button
Finally, click the Stop button


Notice that the "Accessor" and "Alternative" fields have been filled in.

The "Accessor" indicates that Sahi found the link by the text it contains.

The "Alternative" indicates where Sahi found the link in the Document Object Model hierarchy.

Clicking the "Assert" button added a condition stating that we believe the link "Sahi" exists on the web page. By clicking the "Test -->" button, we asked Sahi to verify that the link existed. The link did exist and to Sahi answered "true". We added the assert to the script.
Let's run the script again with the assert added to it:



We are now able to open a web page, fill in a form, submit the form, and test the results.

You are encouraged to experiment with setting assertions for different web page elements and testing for them with Sahi scripts.

A Closer Look At The Sahi Controller

Let's find out what the other buttons on the Record tab do...

Open http://www.Google.com/ in the browser again
Click the "Record" tab in the Sahi Controller
Hold down the "Ctrl" key and hover the mouse over the Google search box.
Click the "Props" button in the Sahi Controller

The "evaluate expression" box displays the properties of the Google search box.

You can expand the Sahi Controller by dragging the corners if you need more reading area.

Click the "Hilight" button

A red box highlights the search box. This is good technique to use if other people will be using your Sahi scripts so they know what is being tested.

In the "Value" text box, enter "Sahi is great"
Click the "Set" button

The Sahi Controller enters "Sahi" in to the Google search box.

Hold down the "Ctrl" key and hover the mouse over the "Google Search" button
Click the "Click" button

The Sahi Controller clicks the button for you and the browser navigates to the search results.

If for some reason you need a Sahi script to pause, you can insert a "Wait" for a specified number of milliseconds (1000 ms = 1 second).


You can also add comments to your script to denote sections, what you are trying to test, etc.... A comment is started with "//".


Click the "API List" text box and enter an "_" to view a list of the functions you can use to drive the web browser.

Let's go check out the rest of the Playback tab...


At the top of the tab you have the option telling Sahi where to load the test scripts from.

By default, Sahi loads scripts from the location listed. This directory can be changed via sahi.properties in the "config" directory

You can share tests across a team by putting the test scripts on a web server instead of copying the tests to each workstation.

Click the "from url" link at the top of the "Playback" tab


Enter the URL of the test script (e.g. http://www.example.com/Test.sah)
Enter the "Start URL" (e.g. http://www.Google.com/)
Click "Set"

The process should be familiar to you...

At the bottom of the Playback tab you will find:

View Script
View Parsed Script
View Queue
View Logs

Click "View Script" and a copy of the test script currently loaded for play back is displayed in the web brower.

"View Parsed Script" will display the actual code that will executed by Sahi. This is used for debugging and is not much use unless you are actively developing Sahi features.

"View Queue" will display the commands being processed by Sahi. Again, this is used for debugging and is not much use unless you are actively developing Sahi features.

The "View Logs" link is interesting. Clicking it will display a web page with links to the results of test runs performed by Sahi. The test logs are stored by default in the Sahi "/logs/playback" directory.

As usual, you can change where Sahi stores the execution logs by modifying sahi.properties in the "config" directory.


That wraps up the tutorial for Sahi!

You should now know how to:

Install Sahi
Configure your browser to use Sahi
Use Sahi to record scripts
Find page web page elements
Test for success using assertions
View test logs

You are encouraged to review the Sahi API. Sahi provides a robust feature set to assist you in automating your web application testing efforts.

You are also encouraged to visit the support forum at http://sahi.co.in/forums/index.php for help and to contribute to the Sahi community.

Good luck!


  • Hi StringyLow,

    Thats really great! It will help all the first timers looking for a tutorial on Sahi.
    Thanks on behalf of everyone. :)

  • Another Great Job for StringyLow!

    By the way, can we actually have a node here in the forums both for StringyLow and Narayan?
  • Administrators

    I did not understand that comment. Could you explain please?
  • Members
    Hi StringlyLow,

    I have followed same thing.

    Internet Explorer:

    Go to Tools > Internet Options > Connections > LAN Settings >
  • Administrators

    Use machine name instead of localhost if on IE 7.
  • Members
    i used and checked with machine name instead of localhost

    even though i am not able to bring up controller
  • Not able to bring up controller except for google.co.in
    What am I doing wrong here?
  • Good Job! But could you explain what the "Props" button does? What is "Props" short for?
    It looks like it prints HTML or something when pressed. Thanks!

  • Hi Robin,

    It prints the properties (Props)/attributes of the selected element/accessor and also the functions supported/applicable by/to it.

  • Administrators
    Realized that the tutorial had been truncated to just 2 lines after migration to the new forums.
    Resurrected from database. Thanks again StringyLow.
  • Hi

    Thank you for the simple tutorial. But the 2nd portion did not work for me. Is it possible to contact you via email or something to clarify on this. I hope you will respond back. Thank you Teresa
  • Members
    I want to join in with multilevel user, and when I run a continuous recording, when I logout first user and then login, I get as _popup("_self393")._setValue(_textbox("userDto.userName"), "test"); so when I play back, only the first user can login. Can any one help plz........ It is very urgent
  • Hi StringyLow,

    The tutorial is very helpful for quick learning. I wish to learn Sahi completely please suggest how can i move and what i have to know? please reply
    Thanks in advance.

  • Administrators
    Hi prasad,
    For a quick understanding of the basics of how Sahi Works, you can look at the following video:

    The video has been made for Sahi Pro so some of its funtionalities might not be available in Sahi OS.

    Again, you can know about all the APIs of Sahi from the folloing link:

    I hope this helps.

Sign In or Register to comment.