Selenium
Selenium
Using Selenium
Selenium Basics........................................................................................................7
Getting Started Choosing Your Selenium Tool....................................................................................7 Introducing Selenium Commands..........................................................................................................8 Test Suites...........................................................................................................................................11 Commonly Used Selenium Commands................................................................................................11
Selenium-IDE..........................................................................................................13
Introduction...........................................................................................................................................13 Installing the IDE..................................................................................................................................13 Opening the IDE...................................................................................................................................14 IDE Features........................................................................................................................................15 Menu Bar..........................................................................................................................................15 Toolbar..............................................................................................................................................15 Test Case Pane................................................................................................................................17 Log/Reference/UI-Element/Rollup Pane...........................................................................................17 Building Test Cases.............................................................................................................................19 Recording.........................................................................................................................................19 Adding Verifications and Asserts With the Context Menu.................................................................19 Editing...............................................................................................................................................20 Opening and Saving a Test Case.....................................................................................................21 Running Test Cases.............................................................................................................................21 Using Base URL to Run Test Cases in Different Domains...................................................................22 Debugging............................................................................................................................................23 Writing a Test Suite..............................................................................................................................25 User Extensions...................................................................................................................................26 Format..................................................................................................................................................27 Executing Selenium-IDE Tests on Different Browsers.........................................................................27
Selenium Commands..............................................................................................28 2
Introduction to Selenium
Locating Elements................................................................................................................................30 Store Commands and Selenium Variables...........................................................................................34
Selenium-RC........................................................................................................... 36
Introduction...........................................................................................................................................36 How Selenium-RC Works.....................................................................................................................36 Installation............................................................................................................................................38 From Selenese to a Program...............................................................................................................39 Programming Your Test.......................................................................................................................40
Introducing Selenium
To Automate or Not to Automate?
Is automation always advantageous? When should one decide to automate test cases?
3
Introduction to Selenium
It is not always advantageous to automate test cases. There are times when manual testing may be more appropriate. For instance, if the applications user interface will change considerably in the near future, then any automation would need to be rewritten. Also, sometimes there simply is not enough time to build test automation. For the short term, manual testing may be more effective. If an application has a very tight deadline, there is currently no test automation available, and its imperative that the testing get done within that time frame, then manual testing is the best solution. However, automation has specific advantages for improving the long-term efficiency of a software teams testing processes. Test automation supports:
Frequent regression testing Rapid feedback to developers during the development process Virtually unlimited iterations of test case execution Customized reporting of application defects Support for Agile and eXtreme development methodologies Disciplined documentation of test cases Finding defects missed by manual testing
Introduction to Selenium
automation. We hope this guide will assist in getting the word out that quality assurance and software testing have many options beyond what is currently practiced. We hope this users guide and Selenium itself provide a valuable aid to boosting the readers efficiency in his or her software testing processes.
Introducing Selenium
Selenium is a robust set of tools that supports rapid development of test automation for webbased applications. Selenium provides a rich set of testing functions specifically geared to the needs of testing of a web application. These operations are highly flexible, allowing many options for locating UI elements and comparing expected test results against actual application behavior. One of Seleniums key features is the support for executing ones tests on multiple browser platforms.
Selenium Components
Selenium is composed of three major tools. Each one has a specific role in aiding the development of web application test automation.
Selenium-IDE
Selenium-IDE is the Integrated Development Environment for building Selenium test cases. It operates as a Firefox add-on and provides an easy-to-use interface for developing and running individual test cases or entire test suites. Selenium-IDE has a recording feature, which will keep account of user actions as they are performed and store them as a reusable script to play back. It also has a context menu (right-click) integrated with the Firefox browser, which allows the user to pick from a list of assertions and verifications for the selected location. Selenium-IDE also offers full editing of test cases for more precision and control. Although Selenium-IDE is a Firefox only add-on, tests created in it can also be run against other browsers by using Selenium-RC and specifying the name of the test suite on the command line.
Introduction to Selenium
Selenium-RC with a high-level programming language to develop test cases also allows the automated testing to be integrated with a projects automated build environment.
Selenium-Grid
Selenium-Grid allows the Selenium-RC solution to scale for large test suites or test suites that must be run in multiple environments. With Selenium-Grid, multiple instances of Selenium-RC are running on various operating system and browser configurations; Each of these when launching register with a hub. When tests are sent to the hub they are then redirected to an available Selenium-RC, which will launch the browser and run the test. This allows for running tests in parallel, with the entire test suite theoretically taking only as long to run as the longest individual test.
Supported Browsers
Browser Firefox 3.x Firefox 3 Firefox 2 IE 8 IE 7 IE 6 Safari 4 Safari 3 Safari 2 Opera 10 Opera 9 Opera 8 Google Selenium-IDE Selenium-RC Start browser, run Record and playback tests tests Start browser, run Record and playback tests tests Start browser, run Record and playback tests tests Start browser, run Test execution only via Selenium-RC* tests Start browser, run Test execution only via Selenium-RC* tests Start browser, run Test execution only via Selenium-RC* tests Start browser, run Test execution only via Selenium-RC tests Start browser, run Test execution only via Selenium-RC tests Start browser, run Test execution only via Selenium-RC tests Start browser, run Test execution only via Selenium-RC tests Start browser, run Test execution only via Selenium-RC tests Start browser, run Test execution only via Selenium-RC tests Test execution only via Selenium-RC Start browser, run Operating Systems Windows, Linux, Mac Windows, Linux, Mac Windows, Linux, Mac Windows Windows Windows Mac Mac Mac Windows, Linux, Mac Windows, Linux, Mac Windows, Linux, Mac Windows
6
Introduction to Selenium
Chrome Others
As applicable
* Tests developed on Firefox via Selenium-IDE can be executed on any other supported browser via a simple Selenium-RC command line. ** Selenium-RC server can start any executable, but depending on browser security settings there may be technical limitations that would limit certain features.
Selenium Basics
Getting Started Choosing Your Selenium Tool
Most people get started with Selenium-IDE. This is what we recommend. Its an easy way to get familiar with Selenium commands quickly. You can develop your first script in just a few minutes. Selenium-IDE is also very easy to install. See the chapter on Selenium-IDE for specifics. You may also run your scripts from the Selenium-IDE. Its simple to use and is recommended for less-technical users. The IDE allows developing and running tests without the need for programming skills as required by Selenium-RC. The Selenium-IDE can serve as an excellent way to train junior-level employees in test automation. Anyone who understands how to conduct
7
Introduction to Selenium
manual testing of a website can easily transition to using the Selenium-IDE for running and developing tests. Some testing tasks are too complex though for the Selenium-IDE. When programming logic is required Selenium-RC must be used. For example, any tests requiring iteration, such as testing each element of a variable length list requires running the script from a programming language. Selenium-IDE does not support iteration or condition statements. Finally, Selenium-Core is another way of running tests. One can run test scripts from a webbrowser using the HTML interface TestRunner.html. This is the original method for running Selenium commands. It has limitations though; similar to Selenium-IDE, it does not support iteration. Selenium-Core also cannot switch between http and https protocols. Since the development of Selenium-IDE and Selenium-RC, more people are using these tools rather than Selenium-Core. At the time of writing (April 09) it is still available and may be convenient for some. However, the Selenium community is encouraging the use of Selenium-IDE and RC and discouraging the use of Selenium-Core. Support for Selenium-Core is becoming less available and it may even be deprecated in a future release.
Actions are commands that generally manipulate the state of the application. They do things like click this link and select that option. If an Action fails, or has an error, the execution of the current test is stopped. Many Actions can be called with the AndWait suffix, e.g. clickAndWait. This suffix tells Selenium that the action will cause the browser to make a call to the server, and that Selenium should wait for a new page to load.
8
Introduction to Selenium
Accessors examine the state of the application and store the results in variables, e.g. storeTitle. They are also used to automatically generate Assertions. Assertions are like Accessors, but they verify that the state of the application conforms to what is expected. Examples include make sure the page title is X and verify that this checkbox is checked. All Selenium Assertions can be used in 3 modes: assert, verify, and waitFor. For example, you can assertText, verifyText and waitForText. When an assert fails, the test is aborted. When a verify fails, the test will continue execution, logging the failure. This allows a single assert to ensure that the application is on the correct page, followed by a bunch of verify assertions to test form field values, labels, etc. waitFor commands wait for some condition to become true (which can be useful for testing Ajax applications). They will succeed immediately if the condition is already true. However, they will fail and halt the test if the condition does not become true within the current timeout setting (see the setTimeout action below).
Script Syntax
Selenium commands are simple, they consist of the command and two parameters. For example: verifyText //div//a[2] Login The parameters are not always required; it depends on the command. In some cases both are required, in others one parameter is required, and in still others the command may take no parameters at all. Here are a couple more examples: goBackAndWait verifyTextPresent Welcome to My Home Page type id=phone (555) 666-7066 type id=address1 ${myVariableAddress} The command reference describes the parameter requirements for each command. Parameters vary, however they are typically:
a locator for identifying a UI element within a page. a text pattern for verifying or asserting expected page content a text pattern or a selenium variable for entering text in an input field or for selecting an option from an option list.
Locators, text patterns, selenium variables, and the commands themselves are described in considerable detail in the section on Selenium Commands.
9
Introduction to Selenium
Selenium scripts that will be run from Selenium-IDE will be be stored in an HTML text file format. This consists of an HTML table with three columns. The first column identifies the Selenium command, the second is a target, and the final column contains a value. The second and third columns may not require values depending on the chosen Selenium command, but they should be present. Each table row represents a new Selenium command. Here is an example of a test that opens a page, asserts the page title and then verifies some content on the page:
<table> <tr><td>open</td><td></td><td>/download/</td></tr> <tr><td>assertTitle</td><td></td><td>Downloads</td></tr> <tr><td>verifyText</td><td>//h2</td><td>Downloads</td></tr> </table>
Rendered as a table in a browser this would look like the following: open /download/ assertTitle Downloads verifyText //h2 Downloads The Selenese HTML syntax can be used to write and run tests without requiring knowledge of a programming language. With a basic knowledge of selenese and Selenium-IDE you can quickly produce and run test cases.
10
Introduction to Selenium
Test Suites
A test suite is a collection of tests. Often one will run all the tests in a test suite as one continuous batch-job. When using Selenium-IDE, test suites also can be defined using a simple HTML file. The syntax again is simple. An HTML table defines a list of tests where each row defines the filesystem path to each test. An example tells it all.
<html> <head> <title>Test Suite Function Tests - Priority 1</title> </head> <body> <table> <tr><td><b>Suite Of Tests</b></td></tr> <tr><td><a href="./Login.html">Login</a></td></tr> <tr><td><a href="./SearchValues.html">Test Searching for Values</a></td></tr> <tr><td><a href="./SaveValues.html">Test Save</a></td></tr> </table> </body> </html>
A file similar to this would allow running the tests all at once, one after another, from the Selenium-IDE. Test suites can also be maintained when using Selenium-RC. This is done via programming and can be done a number of ways. Commonly Junit is used to maintain a test suite if one is using Selenium-RC with Java. Additionally, if C# is the chosen language, Nunit could be employed. If using an interpreted language like Python with Selenium-RC than some simple programming would be involved in setting up a test suite. Since the whole reason for using Sel-RC is to make use of programming logic for your testing this usually isnt a problem.
Introduction to Selenium
verifyElementPresent verifies an expected UI element, as defined by its HTML tag, is present on the page. verifyText verifies expected text and its corresponding HTML tag are present on the page. verifyTable verifies a tables expected contents. waitForPageToLoad pauses execution until an expected new page loads. Called automatically when clickAndWait is used. waitForElementPresent pauses execution until an expected UI element, as defined by its HTML tag, is present on the page.
12
Introduction to Selenium
Selenium-IDE
Introduction
The Selenium-IDE (Integrated Development Environment) is the tool you use to develop your Selenium test cases. Its an easy-to-use Firefox plug-in and is generally the most efficient way to develop test cases. It also contains a context menu that allows you to first select a UI element from the browsers currently displayed page and then select from a list of Selenium commands with parameters pre-defined according to the context of the selected UI element. This is not only a time-saver, but also an excellent way of learning Selenium script syntax. This chapter is all about the Selenium IDE and how to use it effectively.
Select Install Now. The Firefox Add-ons window pops up, first showing a progress bar, and when the download is complete, displays the following.
13
Introduction to Selenium
Restart Firefox. After Firefox reboots you will find the Selenium-IDE listed under the Firefox Tools menu.
Introduction to Selenium
To run the Selenium-IDE, simply select it from the Firefox Tools menu. It opens as follows with an empty script-editing window and a menu for loading, or creating new test cases.
IDE Features
Menu Bar
The File menu allows you to create, open, and save test case and test suite files. The Edit menu allows copy, paste, delete, undo, and select all operations for editing the commands in your test case. The Options menu allows the changing of settings. You can set the timeout value for certain commands, add user-defined user extensions to the base set of Selenium commands, and specify the format (language) used when saving your test cases. The Help menu is the standard Firefox Help menu; only one item on this menuUI-Element Documentationpertains to Selenium-IDE.
Toolbar
15
Introduction to Selenium
The toolbar contains buttons for controlling the execution of your test cases, including a step feature for debugging your test cases. The right-most button, the one with the red-dot, is the record button.
Run All: Runs the entire test suite when a test suite with multiple test cases is loaded.
Run: Runs the currently selected test. When only a single test is loaded this button and the Run All button have the same effect.
Step: Allows you to step through a test case by running it one command at a time. Use for debugging test cases.
TestRunner Mode: Allows you to run the test case in a browser loaded with the Selenium-Core TestRunner. The TestRunner is not commonly used now and is likely to be deprecated. This button is for evaluating test cases for backwards compatibility with the TestRunner. Most users will probably not need this button.
Apply Rollup Rules: This advanced feature allows repetitive sequences of Selenium commands to be grouped into a single action. Detailed documentation on rollup rules can be found in the UI-Element Documentation on the Help menu.
16
The other tab - Source displays the test case in the native format in which the file will be stored. By default, this is HTML although it can be changed to a programming language such as Java or C#, or a scripting language like Python. See the Options menu for details. The Source view also allows one to edit the test case in its raw form, including copy, cut and paste operations. The Command, Target, and Value entry fields display the currently selected command along with its parameters. These are entry fields where you can modify the currently selected command. The first parameter specified for a command in the Reference tab of the bottom pane always goes in the Target field. If a second parameter is specified by the Reference tab, it always goes in the Value field.
If you start typing in the Command field, a drop-down list will be populated based on the first characters you type; you can then select your desired command from the drop-down.
Log/Reference/UI-Element/Rollup Pane
The bottom pane is used for four different functionsLog, Reference, UI-Element, and Rollup depending on which tab is selected.
Log
17
Introduction to Selenium
When you run your test case, error messages and information messages showing the progress are displayed in this pane automatically, even if you do not first select the Log tab. These messages are often useful for test case debugging. Notice the Clear button for clearing the Log. Also notice the Info button is a drop-down allowing selection of different levels of information to log.
Reference
The Reference tab is the default selection whenever you are entering or modifying Selenese commands and parameters in Table mode. In Table mode, the Reference pane will display documentation on the current command. When entering or modifying commands, whether from Table or Source mode, it is critically important to ensure that the parameters specified in the Target and Value fields match those specified in the parameter list in the Reference pane. The number of parameters provided must match the number specified, the order of parameters provided must match the order specified, and the type of parameters provided must match the type specified. If there is a mismatch in any of these three areas, the command will not run correctly.
While the Reference tab is invaluable as a quick reference, it is still often necessary to consult the Selenium Reference document.
UI-Element and Rollup
Detailed information on these two panes (which cover advanced features) can be found in the UI-Element Documentation on the Help menu of Selenium-IDE.
18
Introduction to Selenium
Recording
Many first-time users begin by recording a test case from their interactions with a website. When Selenium-IDE is first opened, the record button is ON by default. Note This can be set to OFF as a default with an available user extension. During recording, Selenium-IDE will automatically insert commands into your test case based on your actions. Typically, this will include:
clicking a link - click or clickAndWait commands entering values - type command selecting options from a drop-down listbox - select command clicking checkboxes or radio buttons - click command
The type command may require clicking on some other area of the web page for it to record. Following a link usually records a click command. You will often need to change this to clickAndWait to ensure your test case pauses until the new page is completely loaded. Otherwise, your test case will continue running commands before the page has loaded all its UI elements. This will cause unexpected test case failures.
Introduction to Selenium
Lets see how this works. Open a web-page of your choosing and select a block of text on the page. A paragraph or a heading will work fine. Now, right-click the selected text. The context menu should give you a verifyTextPresent command and the suggested parameter should be the text itself. Also, notice the Show All Available Commands menu option. This shows many, many more commands, again, along with suggested parameters, for testing your currently selected UI element. Try a few more UI elements. Try right-clicking an image, or a user control like a button or a checkbox. You may need to use Show All Available Commands to see options other than verifyTextPresent. Once you select these other options, the more commonly used ones will show up on the primary context menu. For example, selecting verifyElementPresent for an image should later cause that command to be available on the primary context menu the next time you select an image and right-click. Again, these commands will be explained in detail in the chapter on Selenium commands. For now though, feel free to use the IDE to record and select commands into a test case and then run it. You can learn a lot about the Selenium commands simply by experimenting though the IDE.
Editing
Insert Command Table View
Select the point in your test case where you want to insert the command. To do this, in the Test Case Pane, left-click on the line where you want to insert a new command. Right-click and select Insert Command; the IDE will add a blank line just ahead of the line you selected. Now use the command editing text fields to enter your new command and its parameters.
Source View
Select the point in your test case where you want to insert the command. To do this, in the Test Case Pane, left-click between the commands where you want to insert a new command, and enter the HTML tags needed to create a 3-column row containing the Command, first parameter (if one is required by the Command), and second parameter (again, if one is required). Be sure to save your test before switching back to Table view.
Insert Comment
Comments may be added to make your test case more readable. These comments are ignored when the test case is run.
20
Introduction to Selenium
Comments may also be used to add vertical white space (one or more blank lines) in your tests; just create empty comments. An empty command will cause an error during execution; an empty comment wont.
Table View
Select the line in your test case where you want to insert the comment. Right-click and select Insert Comment. Now use the Command field to enter the comment. Your comment will appear in purple font.
Source View
Select the point in your test case where you want to insert the comment. Add an HTML-style comment, i.e., <! your comment here >.
Edit a Command or Comment Table View
Simply select the line to be changed and edit it using the Command, Target, and Value fields.
Source View
Since Source view provides the equivalent of a WYSIWYG editor, simply modify which line you wishcommand, parameter, or comment.
21
Introduction to Selenium
The IDE allows many options for running your test case. You can run a test case all at once, stop and start it, run it one line at a time, run a single command you are currently developing, and you can do a batch run of an entire test suite. Execution of test cases is very flexible in the IDE.
Run a Test Case Click the Run button to run the currently displayed test case. Run a Test Suite Click the Run All button to run all the test cases in the currently loaded test suite. Stop and Start The Pause button can be used to stop the test case while it is running. The icon of this button then changes to indicate the Resume button. To continue click Resume. Stop in the Middle You can set a breakpoint in the test case to cause it to stop on a particular command. This is useful for debugging your test case. To set a breakpoint, select a command, right-click, and from the context menu select Toggle Breakpoint. Start from the Middle You can tell the IDE to begin running from a specific command in the middle of the test case. This also is used for debugging. To set a startpoint, select a command, right-click, and from the context menu select Set/Clear Start Point. Run Any Single Command Double-click any single command to run it by itself. This is useful when writing a single command. It lets you immediately test a command you are constructing, when you are not sure if it is correct. You can double-click it to see if it runs correctly. This is also available from the context menu.
Introduction to Selenium
absolute URL by appending the open commands argument onto the end of the value of Base URL. For example, the test case below would be run against http://news.portal.com/about.html:
This same test case with a modified Base URL setting would be run against http://beta.news.portal.com/about.html:
Debugging
Debugging means finding and fixing errors in your test case. This is a normal part of test case development. We wont teach debugging here as most new users to Selenium will already have some basic experience with debugging. If this is new to you, we recommend you ask one of the developers in your organization.
Breakpoints and Startpoints
The Sel-IDE supports the setting of breakpoints and the ability to start and stop the running of a test case, from any point within the test case. That is, one can run up to a specific command in the middle of the test case and inspect how the test case behaves at that point. To do this, set a breakpoint on the command just before the one to be examined. To set a breakpoint, select a command, right-click, and from the context menu select Toggle Breakpoint. Then click the Run button to run your test case from the beginning up to the breakpoint.
23
Introduction to Selenium
It is also sometimes useful to run a test case from somewhere in the middle to the end of the test case or up to a breakpoint that follows the starting point. For example, suppose your test case first logs into the website and then performs a series of tests and you are trying to debug one of those tests. However, you only need to login once, but you need to keep rerunning your tests as you are developing them. You can login once, then run your test case from a startpoint placed after the login portion of your test case. That will prevent you from having to manually logout each time you rerun your test case. To set a startpoint, select a command, right-click, and from the context menu select Set/Clear Start Point. Then click the Run button to execute the test case beginning at that startpoint.
Stepping Through a Testcase
To execute a test case one command at a time (step through it), follow these steps:
1. Start the test case running with the Run button from the toolbar.
2. Immediately pause the executing test case with the Pause button.
Find Button
The Find button is used to see which UI element on the currently displayed webpage (in the browser) is used in the currently selected Selenium command. This is useful when building a locator for a commands first parameter (see the section on locators in the Selenium Commands chapter). It can be used with any command that identifies a UI element on a webpage, i.e. click, clickAndWait, type, and certain assert and verify commands, among others. From Table view, select any command that has a locator parameter. Click the Find button. Now look on the webpage: There should be a bright green rectangle enclosing the element specified by the locator parameter.
Page Source for Debugging
Often, when debugging a test case, you simply must look at the page source (the HTML for the webpage youre trying to test) to determine a problem. Firefox makes this easy. Simply rightclick the webpage and select View->Page Source. The HTML opens in a separate window. Use its Search feature (Edit=>Find) to search for a keyword to find the HTML for the UI element youre trying to test.
24
Introduction to Selenium
Alternatively, select just that portion of the webpage for which you want to see the source. Then right-click the webpage and select View Selection Source. In this case, the separate HTML window will contain just a small amount of source, with highlighting on the portion representing your selection.
Locator Assistance
Whenever Selenium-IDE records a locator-type argument, it stores additional information which allows the user to view other possible locator-type arguments that could be used instead. This feature can be very useful for learning more about locators, and is often needed to help one build a different type of locator than the type that was recorded. This locator assistance is presented on the Selenium-IDE window as a drop-down list accessible at the right end of the Target field (only when the Target field contains a recorded locator-type argument). Below is a snapshot showing the contents of this drop-down for one command. Note that the first column of the drop-down provides alternative locators, whereas the second column indicates the type of each alternative.
25
Introduction to Selenium
The test suite pane will be automatically opened when an existing test suite is opened or when the user selects the New Test Case item from the File menu. In the latter case, the new test case will appear immediately below the previous test case. Selenium-IDE does not yet support loading pre-existing test cases into a test suite. Users who want to create or modify a test suite by adding pre-existing test cases must manually edit a test suite file. A test suite file is an HTML file containing a one-column table. Each cell of each row in the <tbody> section contains a link to a test case. The example below is of a test suite containing four test cases:
<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Sample Selenium Test Suite</title> </head> <body> <table cellpadding="1" cellspacing="1" border="1"> <thead> <tr><td>Test Cases for De Anza A-Z Directory Links</td></tr> </thead> <tbody> <tr><td><a href="./a.html">A Links</a></td></tr> <tr><td><a href="./b.html">B Links</a></td></tr> <tr><td><a href="./c.html">C Links</a></td></tr> <tr><td><a href="./d.html">D Links</a></td></tr> </tbody> </table> </body> </html>
Note Test case files should not have to be co-located with the test suite file that invokes them. And on Mac OS and Linux systems, that is indeed the case. However, at the time of this writing, a bug prevents Windows users from being able to place the test cases elsewhere than with the test suite that invokes them.
User Extensions
User extensions are JavaScript files that allow one to create his or her own customizations and features to add additional functionality. Often this is in the form of customized commands although this extensibility is not limited to additional commands. There are a number of useful extensions created by users. Perhaps the most popular of all Selenium-IDE extensions is one which provides flow control in the form of while loops and primitive conditionals. This extension is the goto_sel_ide.js. For an
26
Introduction to Selenium
example of how to use the functionality provided by this extension, look at the page created by its author. To install this extension, put the pathname to its location on your computer in the Selenium Core extensions field of Selenium-IDEs Options=>Options=>General tab.
After selecting the OK button, you must close and reopen Selenium-IDE in order for the extensions file to be read. Any change you make to an extension will also require you to close and reopen Selenium-IDE. Information on writing your own extensions can be found near the bottom of the Selenium Reference document.
Format
Format, under the Options menu, allows you to select a language for saving and displaying the test case. The default is HTML. If you will be using Selenium-RC to run your test cases, this feature is used to translate your test case into a programming language. Select the language, i.e. Java, PHP, you will be using with Selenium-RC for developing your test programs. Then simply save the test case using File=>Save. Your test case will be translated into a series of functions in the language you choose. Essentially, program code supporting your test is generated for you by Selenium-IDE. Also, note that if the generated code does not suit your needs, you can alter it by editing a configuration file which defines the generation process. Each supported language has configuration settings which are editable. This is under the Options=>Options=>Format tab. Note At the time of this writing, this feature is not yet supported by the Selenium developers. However the author has altered the C# format in a limited manner and it has worked well.
Introduction to Selenium
While Selenium-IDE can only run tests against Firefox, tests developed with Selenium-IDE can be run against other browsers, using a simple command-line interface that invokes the SeleniumRC server. This topic is covered in the Run Selenese tests section on Selenium-RC chapter. The -htmlSuite command-line option is the particular feature of interest.
Selenium Commands
Selenium commands, often called selenese, are the set of commands that run your tests. A sequence of these commands is a test script. Here we explain those commands in detail, and we present the many choices you have in testing your web application when using Selenium.
Assertion or Verification?
Choosing between assert and verify comes down to convenience and management of failures. Theres very little point checking that the first paragraph on the page is the correct one if your test has already failed when checking that the browser is displaying the expected page. If youre not on the correct page, youll probably want to abort your test case so that you can investigate the cause and fix the issue(s) promptly. On the other hand, you may want to check many attributes of a page without aborting the test case on the first failure as this will allow you to review all failures on the page and take the appropriate action. Effectively an assert will fail the test and abort the current test case, whereas a verify will fail the test and continue to run the test case. The best use of this feature is to logically group your test commands, and start each group with an assert followed by one or more verify test commands. An example follows:
28
Introduction to Selenium
Value
The above example first opens a page and then asserts that the correct page is loaded by comparing the title with the expected value. Only if this passes will the following command run and verify that the text is present in the expected location. The test case then asserts the first column in the second row of the first table contains the expected value, and only if this passed will the remaining cells in that row be verified.
verifyTextPresent
The command verifyTextPresent is used to verify specific text exists somewhere on the page. It takes a single argumentthe text pattern to be verified. For example: Command Target Value verifyTextPresent Marketing Analysis This would cause Selenium to search for, and verify, that the text string Marketing Analysis appears somewhere on the page currently being tested. Use verifyTextPresent when you are interested in only the text itself being present on the page. Do not use this when you also need to test where the text occurs on the page.
verifyElementPresent
Use this command when you must test for the presence of a specific UI element, rather then its content. This verification does not check the text, only the HTML tag. One common use is to check for the presence of an image. Command Target Value verifyElementPresent //div/p/img This command verifies that an image, specified by the existence of an <img> HTML tag, is present on the page, and that it follows a <div> tag and a <p> tag. The first (and only) parameter is a locator for telling the Selenese command how to find the element. Locators are explained in the next section.
29
Introduction to Selenium
can be used to check the existence of any HTML tag within the page. You can check the existence of links, paragraphs, divisions <div>, etc. Here are a few more examples.
verifyElementPresent
Value
These examples illustrate the variety of ways a UI element may be tested. Again, locators are explained in the next section.
verifyText
Use verifyText when both the text and its UI element must be tested. verifyText must use a locator. If you choose an XPath or DOM locator, you can verify that specific text appears at a specific location on the page relative to other UI components on the page. Command Target Value verifyText //table/tr/td/div/p This is my text and it occurs right after the div inside the table.
Locating Elements
For many Selenium commands, a target is required. This target identifies an element in the content of the web application, and consists of the location strategy followed by the location in the format locatorType=location. The locator type can be omitted in many cases. The various locator types are explained below with examples for each.
Locating by Identifier
This is probably the most common method of locating elements and is the catch-all default when no recognised locator type is used. With this strategy, the first element with the id attribute value matching the location will be used. If no element has a matching id attribute, then the first element with a name attribute matching the location will be used. For instance, your page source could have id and name attributes as follows:
1 <html> 2 <body> 3 <form id="loginForm">
30
Introduction to Selenium
4 <input name="username" type="text" /> 5 <input name="password" type="password" /> 6 <input name="continue" type="submit" value="Login" /> 7 </form> 8 </body> 9 <html>
The following locator strategies would return the elements from the HTML snippet above indicated by line number:
identifier=loginForm (3) identifier=username (4) identifier=continue (5) continue (5)
Since the identifier type of locator is the default, the identifier= in the first three examples above is not necessary.
Locating by Id
This type of locator is more limited than the identifier locator type, but also more explicit. Use this when you know an elements id attribute.
1 <html> 2 <body> 3 <form id="loginForm"> 4 <input name="username" 5 <input name="password" 6 <input name="continue" 7 <input name="continue" 8 </form> 9 </body> 10 <html> id=loginForm
type="text" /> type="password" /> type="submit" value="Login" /> type="button" value="Clear" />
(3)
Locating by Name
The name locator type will locate the first element with a matching name attribute. If multiple elements have the same value for a name attribute, then you can use filters to further refine your location strategy. The default filter type is value (matching the value attribute).
1 <html> 2 <body> 3 <form id="loginForm"> 4 <input name="username" 5 <input name="password" 6 <input name="continue" 7 <input name="continue" 8 </form>
type="text" /> type="password" /> type="submit" value="Login" /> type="button" value="Clear" />
31
Introduction to Selenium
9 </body> 10 <html> name=username (4) name=continue value=Clear name=continue Clear (7) name=continue type=button
(7) (7)
Note Unlike some types of XPath and DOM locators, the three types of locators above allow Selenium to test a UI element independent of its location on the page. So if the page structure and organization is altered, the test will still pass. You may or may not want to also test whether the page structure changes. In the case where web designers frequently alter the page, but its functionality must be regression tested, testing via id and name attributes, or really via any HTML property, becomes very important.
Locating by XPath
XPath is the language used for locating nodes in an XML document. As HTML can be an implementation of XML (XHTML), Selenium users can leverage this powerful language to target elements in their web applications. XPath extends beyond (as well as supporting) the simple methods of locating by id or name attributes, and opens up all sorts of new possibilities such as locating the third checkbox on the page. One of the main reasons for using XPath is when you dont have a suitable id or name attribute for the element you wish to locate. You can use XPath to either locate the element in absolute terms (not advised), or relative to an element that does have an id or name attribute. XPath locators can also be used to specify elements via attributes other than id and name. Absolute XPaths contain the location of all elements from the root (html) and as a result are likely to fail with only the slightest adjustment to the application. By finding a nearby element with an id or name attribute (ideally a parent element) you can locate your target element based on the relationship. This is much less likely to change and can make your tests more robust. Since only xpath locators start with //, it is not necessary to include the xpath= label when specifying an XPath locator.
1 <html> 2 <body> 3 <form id="loginForm"> 4 <input name="username" 5 <input name="password" 6 <input name="continue" 7 <input name="continue" 8 </form> 9 </body> 10 <html>
type="text" /> type="password" /> type="submit" value="Login" /> type="button" value="Clear" />
32
Introduction to Selenium
(3) - Absolute path (would break if the HTML was changed only slightly) //form[1] (3) - First form element in the HTML xpath=//form[@id='loginForm'] (3) - The form element with attribute named id and the value loginForm xpath=//form[input/\@name='username'] (4) - First form element with an input child element with attribute named name and the value username //input[@name='username'] (4) - First input element with attribute named name and the value username //form[@id='loginForm']/input[1] (4) - First input child element of the form element with attribute named id and the value loginForm //input[@name='continue'][@type='button'] (7) - Input with attribute named name and the value continue and attribute named type and the value button //form[@id='loginForm']/input[4] (7) - Fourth input child element of the form element with attribute named id and value loginForm
xpath=/html/body/form[1]
These examples cover some basics, but in order to learn more, the following references are recommended:
W3Schools XPath Tutorial W3C XPath Recommendation XPath Tutorial - with interactive examples.
There are also a couple of very useful Firefox Add-ons that can assist in discovering the XPath of an element:
XPath Checker - suggests XPath and can be used to test XPath results. Firebug - XPath suggestions are just one of the many powerful features of this very useful add-on.
33
Introduction to Selenium
storeElementPresent
This corresponds to verifyElementPresent. It simply stores a boolean valuetrue or false depending on whether the UI element is found.
storeText
StoreText corresponds to verifyText. It uses a locater to identify specific page text. The text, if found, is stored in the variable. StoreText can be used to extract text from the page being tested.
34
Introduction to Selenium
storeEval
This command takes a script as its first parameter. Embedding JavaScript within Selenese is covered in the next section. StoreEval allows the test to store the result of running the script in a variable.
35
Introduction to Selenium
Selenium-RC
Introduction
Selenium-RC is the solution for tests that need more than simple browser actions and linear execution. Selenium-RC uses the full power of programming languages to create more complex tests like reading and writing files, querying a database, and emailing test results. Youll want to use Selenium-RC whenever your test requires logic not supported by SeleniumIDE. What logic could this be? For example, Selenium-IDE does not directly support:
condition statements iteration logging and reporting of test results error handling, particularly unexpected errors database testing test case grouping re-execution of failed tests test case dependency screenshot capture of test failures
Although these tasks are not supported by Selenium directly, all of them can be achieved by using programming techniques with a language-specific Selenium-RC.
RC Components
Selenium-RC components are:
The Selenium Server which launches and kills browsers, interprets and runs the Selenese commands passed from the test program, and acts as an HTTP proxy, intercepting and verifying HTTP messages passed between the browser and the AUT. Client libraries which provide the interface between each programming language and the Selenium-RC Server.
Introduction to Selenium
The diagram shows the client libraries communicate with the Server passing each Selenium command for execution. Then the server passes the Selenium command to the browser using Selenium-Core JavaScript commands. The browser, using its JavaScript interpreter, executes the Selenium command. This runs the Selenese action or verification you specified in your test script.
Selenium Server
Selenium Server receives Selenium commands from your test program, interprets them, and reports back to your program the results of running those tests. The RC server bundles Selenium Core and automatically injects it into the browser. This occurs when your test program opens the browser (using a client library API function). Selenium-Core is a JavaScript program, actually a set of JavaScript functions which interprets and executes Selenese commands using the browsers built-in JavaScript interpreter.
37
Introduction to Selenium
The Server receives the Selenese commands from your test program using simple HTTP GET/POST requests. This means you can use any programming language that can send HTTP requests to automate Selenium tests on the browser.
Client Libraries
The client libraries provide the programming support that allows you to run Selenium commands from a program of your own design. There is a different client library for each supported language. A Selenium client library provides a programming interface (API), i.e., a set of functions, which run Selenium commands from your own program. Within each interface, there is a programming function that supports each Selenese command. The client library takes a Selenese command and passes it to the Selenium Server for processing a specific action or test against the application under test (AUT). The client library also receives the result of that command and passes it back to your program. Your program can receive the result and store it into a program variable and report it as a success or failure, or possibly take corrective action if it was an unexpected error. So to create a test program, you simply write a program that runs a set of Selenium commands using a client library API. And, optionally, if you already have a Selenese test script created in the Selenium-IDE, you can generate the Selenium-RC code. The Selenium-IDE can translate (using its Export menu item) its Selenium commands into a client-drivers API function calls. See the Selenium-IDE chapter for specifics on exporting RC code from Selenium-IDE.
Installation
After downloading the Selenium-RC zip file from the downloads page, youll notice it has several sub-folders. These folders have all the components you need for using Selenium-RC with the programming language of your choice. Once youve chosen a language to work with, you simply need to:
Install the Selenium-RC Server. Set up a programming project using a language specific client driver.
Introduction to Selenium
java -jar selenium-server.jar This can be simplified by creating a batch or shell executable file (.bat on Windows and .sh on Linux) containing the command above. Then make a shortcut to that executable on your desktop and simply double-click the icon to start the server. For the server to run youll need Java installed and the PATH environment variable correctly configured to run it from the console. You can check that you have Java correctly installed by running the following on a console:
java -version
If you get a version number (which needs to be 1.5 or later), youre ready to start using Selenium-RC.
Download Selenium-RC from the SeleniumHQ downloads page Extract the folder Download and install NUnit ( Note: You can use NUnit as your test engine. If youre not familiar yet with NUnit, you can also write a simple main() function to run your tests; however NUnit is very useful as a test engine.) Open your desired .Net IDE (Visual Studio, SharpDevelop, MonoDevelop) Create a class library (.dll) Add references to the following DLLs: nmock.dll, nunit.core.dll, nunit. framework.dll, ThoughtWorks.Selenium.Core.dll, ThoughtWorks.Selenium. IntegrationTests.dll and ThoughtWorks.Selenium.UnitTests.dll Write your Selenium test in a .Net language (C#, VB.Net), or export a script from Selenium-IDE to a C# file and copy this code into the class file you just created. Write your own simple main() program or you can include NUnit in your project for running your test. These concepts are explained later in this chapter. Run Selenium server from console Run your test either from the IDE, from the NUnit GUI or from the command line
For specific details on .NET client driver configuration with Visual Studio, see the appendix .NET client driver configuration.
Introduction to Selenium
Lets start with an example Selenese test script. Imagine recording the following test with Selenium-IDE. open type clickAndWait assertTextPresent / q selenium rc btnG Results * for selenium rc
Note: This example would work with the Google search page http://www.google.com
Generate your script into a programming language from Selenium-IDE, optionally modifying the result. Write a very simple main program that executes the generated code.
Optionally, you can adopt a test engine platform like JUnit or TestNG for Java, or NUnit for .NET if you are using one of those languages.
C#
The .NET Client Driver works with Microsoft.NET. It can be used with any .NET testing framework like NUnit or the Visual Studio 2005 Team System. Selenium-IDE assumes you will use NUnit as your testing framework. You can see this in the generated code below. It includes the using statement for NUnit along with corresponding NUnit attributes identifying the role for each member function of the test class. You will probably have to rename the test class from NewTest to something of your own choosing. Also, you will need to change the browser-open parameters in the statement:
selenium = new DefaultSelenium("localhost", 4444, "*iehta", "http://www.google.com/");
40
Introduction to Selenium
namespace SeleniumTests { [TestFixture] public class NewTest { private ISelenium selenium; private StringBuilder verificationErrors; [SetUp] public void SetupTest() { selenium = new DefaultSelenium("localhost", 4444, "*iehta", "http://www.google.com/"); selenium.Start(); verificationErrors = new StringBuilder(); } [TearDown] public void TeardownTest() { try { selenium.Stop(); } catch (Exception) { // Ignore errors if unable to close the browser } Assert.AreEqual("", verificationErrors.ToString()); } [Test] public void TheNewTest() { // Open Google search engine. selenium.Open("http://www.google.com/");
41
Introduction to Selenium
// Assert Title of page. Assert.AreEqual("Google", selenium.GetTitle()); // Provide search term as "Selenium OpenQA" selenium.Type("q", "Selenium OpenQA"); // Read the keyed search term and assert it. Assert.AreEqual("Selenium OpenQA", selenium.GetValue("q")); // Click on Search button. selenium.Click("btnG"); // Wait for page to load. selenium.WaitForPageToLoad("5000"); // Assert that "www.openqa.org" is available in search results. Assert.IsTrue(selenium.IsTextPresent("www.openqa.org")); // Assert that page title is - "Selenium OpenQA - Google Search" Assert.AreEqual("Selenium OpenQA - Google Search", selenium.GetTitle()); } } }
You can allow NUnit to manage the execution of your tests. Or alternatively, you can write a simple main() program that instantiates the test object and runs each of the three methods, SetupTest(), TheNewTest(), and TeardownTest() in turn.
42
Introduction to Selenium
What to Test?
What parts of your application should you test? That depends on aspects of your project: user expectations, time allowed for the project, priorities set by the project manager and so on. Once the project boundaries are defined though, you, the tester, will certainly make many decisions on what to test. We will define some terms here to help us categorize the types of testing typical for a webapplication. These terms are by no means standard, although the concepts we present here are typical for web-application testing. Weve created a few terms here of our own for the purposes of categorizing the types of test you may perform on your web application.
Does each page have its expected page title? This can be used to verify your test found an expected page after following a link. Does each page of the website contain a footer area with links to the company contact page, privacy policy, and trademarks information? Does each page begin with heading text using the <h1> tag? And, does each page have the correct text within that header?
You may or may not need content tests. If your page content is not likely to be affected then it may be more efficient to test page content manually. If, however, your application will be undergoing platform changes, or files will likely be moved to different locations, content tests may prove valuable.
Testing Links
43
Introduction to Selenium
A frequent source of errors for web-sites is broken links and missing pages behind those broken links. Testing for these involves clicking each link and verifying the expected page behind that link loads correctly.
Function Tests
These would be tests of a specific function within your application, requiring some type of user input, and returning some type of results. Often a function test will involve multiple pages with a form-based input page containing a collection of input fields, Submit and Cancel operations, and one or more response pages. User input can be via text-input fields, checkboxes, drop-down lists, or any other browser-supported input.
44