Selenium

Selenium Remote Control (RC) is a test tool that allows you to write automated web application user interface tests in any programming language against any HTTP website using any mainstream JavaScript-enabled browser. Selenium RC comes in two parts.

This section describes how you can use SpiraTest / SpiraTeam (hereafter SpiraTeam) together with RemoteLaunch to schedule and remotely launch instances of Selenium-RC (hereafter just referred to as Selenium) on different computers and have the testing results be transmitted back to SpiraTeam. This allows you to extend your SpiraTeam's test management capabilities to include automated Selenium web tests.

Note: This integration requires at least version 3.0 of SpiraTest/Team and version 1.0 of Selenium-Remote Control.

Installing the Selenium Engine

This section assumes that you already have a working installation of SpiraTest or SpiraTeam and have installed RemoteLaunch on the various test automation hosts following the instructions in RemoteLaunch Guide. Once those prerequisites are in place, please follow these steps:

Advanced Settings

You can modify the Selenium configuration for each of the specific automation hosts, by right-clicking on the RemoteLaunch icon in the system tray and choosing "Configuration". That will bring up the RemoteLaunch configuration page.

a) Selenium-RC 1.0

The Selenium 1.0 engine adds its own tab to this page which allows you to configure how Selenium operates:

The following fields can be specified on this screen:

a) Selenium WebDriver 2.x

The Selenium 2.x engine adds its own tab to this page which allows you to configure how Selenium operates:

The following fields can be specified on this screen:

Browser Type -- This needs to be set to the type of browser that the Selenium webdriver will launch.

Browser URL -- This needs to be the initial URL that you want the browser to open to

Setting up the Automated Test Cases

This section describes the process for setting up a test case in SpiraTeam for automation and either linking it to an existing Selenium test script file or entering a Selenium test script directly into SpiraTeam.

Attaching a Selenium Test Script

First you need to display the list of test cases in SpiraTeam (by clicking Testing > Test Cases) and then add a new test case. Once you have added the new test case, click on it and select the "Automation" tab:

You need to enter the following fields:

A complete sample script is illustrated below:

open||http://www.google.com/webhp

assertTitle||Google

type|q|${query}

click|btnG

waitForPageToLoad||5000

isTextPresent||${matchtext}

Once you are happy with the values, click [Save] to update the test case. Now you are ready to schedule the automated test case for execution.

Linking a Selenium Test Script

First you need to display the list of test cases in SpiraTeam (by clicking Testing > Test Cases) and then add a new test case. Once you have added the new test case, click on it and select the "Automation" tab:

You need to enter the following fields:

The linked test script needs to be an HTML document that contains a table with three columns. Each row corresponds to a single Selenium action. Each of the columns in the row corresponds to the three Selenium command components:

An example Selenium test script is illustrated below:

<html>
    <body>
        <table>
            <tr>
                <td>
                    open
                </td>
                <td>                    
                </td>
                <td>
                    http://www.google.com/webhp
                </td>
            </tr>
            <tr>
                <td>
                    assertTitle</td>
                <td>                    
                    &nbsp;</td>
                <td>
                    Google</td>
            </tr>
            <tr>
                <td>
                    type</td>
                <td>                    
                    q</td>
                <td>
                    ${query}</td>
            </tr>
            <tr>
                <td>
                    click</td>
                <td>                    
                    btnG</td>
                <td>
                    &nbsp;</td>
            </tr>
            <tr>
                <td>
                    waitForPageToLoad</td>
                <td>                    
                    &nbsp;</td>
                <td>
                    5000</td>
            </tr>
            <tr>
                <td>
                    isTextPresent</td>
                <td>                    
                    &nbsp;</td>
                <td>
                    ${matchtext}</td>
            </tr>
        </table>
    </body>
</html>

When opened in an HTML editing tool it looks like:

open http://www.google.com/webhp
assertTitle   Google
type q ${query}
click btnG  
waitForPageToLoad   5000
isTextPresent   ${matchtext}

If you would like to have SpiraTeam pass any parameter values to this test script (this will be discussed in more detail later) you can specify them by using the syntax ${parameterName}.

An example parameterized command is displayed in the third and sixth rows of the table above (${query} and ${matchtext}).

Once you are happy with the values, click [Save] to update the test case. Now you are ready to schedule the automated test case for execution.

Using Parameterized Test Cases

There is an advanced feature of SpiraTest/Team and RemoteLaunch that lets you pass parameters from SpiraTeam to your Selenium automated test script. This is very useful if you want to have a data-driven Selenium test script that be executed multiple times with different parameter values.

To setup the automated test case for parameters, click on the "Test Steps" tab and click on "Edit Parameters":

The name of the parameter ${login} needs to match the name of the input parameter defined within the Selenium script.

Executing the Selenium Test Sets from SpiraTeam

There are two ways to execute automated test cases in SpiraTeam:

  1. Schedule the test cases to be executed on a specific computer (local or remote) at a date/time in the future

  2. Execute the test cases right now on the local computer.

We shall outline both of these two scenarios in this section. However first we need to setup the appropriate automation hosts and test sets in SpiraTeam:

Configuring the Automation Hosts and Test Sets

Go to Testing > Automation Hosts in SpiraTeam to display the list of automation hosts:

Make sure that you have created an Automation Host for each computer that is going to run an automated test case. The name and description can be set to anything meaningful, but the Token field must be set to the same token that is specified in the RemoteLaunch application on that specific machine.

Once you have at least one Automation Host configured, go to Testing > Test Sets to create the test sets that will contain the automated test case:

Note: Unlike manual test cases, automated test cases must be executed within a test set -- they cannot be executed directly from the test case.

Create a new Test Set to hold the Selenium automated test cases and click on its hyperlink to display the test set details page:

You need to add at least one automated test case to the test set and then configure the following fields:

If you have parameterized test cases inside the automated test set you can set their values in three different ways:

You set these values, by right-clicking on a row and choosing "Edit Parameters":

Executing the Test Sets

Once you have set the various test set fields (as described above), the Remote Launch instances will periodically poll SpiraTeam for new test sets. Once they retrieve the new test set, they will add it to their list of test sets to be execute. Once execution begins they will change the status of the test set to "In Progress", and once test execution is done, the status of the test set will change to either "Completed" -- the automation engine could be launched and the test has completed -- or "Blocked" -- RemoteLaunch was not able to start the automation engine.

If you want to immediately execute the test case on your local computer, instead of setting the "Automation Host", "Status" and "Planned Date" fields, you can instead click the [Execute] icon on the test set itself. This will cause RemoteLaunch on the local computer to immediately start executing the current test set.

In either case, once all the test cases in the test set have been completed, the status of the test set will switch to "Completed" and the individual test cases in the set will display a status based on the results of the Selenium test:

Passed -- The Selenium automated test ran successfully and all the test conditions in the test script passed

Failed -- The Selenium automated test ran successfully, but at least one test condition in the test script failed.

Blocked -- The Selenium automated test did not run successfully

If you receive the "Blocked" status for either the test set or the test cases you should open up the Windows Application Event Log on the computer running RemoteLaunch and look in the event log for error messages.

Note: While the tests are executing you may see browser windows launch as the Selenium server executes the appropriate tests.

Once the tests have completed, you can log back into SpiraTeam and see the execution status of your test cases. If you click on a Test Run that was generated by Selenium, you will see the following information:

This screen indicates the status of the test run that was reported back from Selenium together with any messages or other information. The execution status will be set to PASSED if all the Selenium commands report back OK and all the tests passed. If any of the commands failed or the tests don't pass, the overall execution status will be listed as FAILED.

The Message field will contain a summary of the number of commands executed and the number of failed commands, with the large details box containing the full command execution log as reported back from Selenium:

open (, http://www.google.com/webhp) - OK

assertTitle (, Google) - OK

type (q, Philomene Long) - OK

click (btnG, ) - OK

waitForPageToLoad (, 5000) - OK

isTextPresent (, Philomene Long) - OK,true

Congratulations... You are now able to run Selenium automated web tests and have the results be recorded within SpiraTest / SpiraTeam.