|Version 61 (modified by 8 years ago) ( diff ),|
Automated Tests - Selenium
Table of Contents
Selenium provides the ability to test Sahana Eden as users see it - namely through a web browser. This therefore does end-to-end Functional Testing, however it can also be used as Unit Testing
We are building our framework around the new Selenium WebDriver, despite having some legacy code in the older format:
The tests are stored in
Installation of the testing environment in your machine
In order to execute the automated Selenium powered test scripts, you must install the Selenium Web Drivers into Python.
*Web2py will need to be installed, and should come with the installation of Sahana Eden.
Download and install the latest Selenium package, which can be found at http://pypi.python.org/pypi/selenium#downloads:
wget http://pypi.python.org/packages/source/s/selenium/selenium-2.25.0.tar.gz tar zxvf selenium-2.25.0.tar.gz cd selenium-2.25.0 python setup.py install
pip install -U selenium
Running / Executing Automated test scripts:
models/000_config.py, uncomment the lines that disable confirmation popups:
# Should user be prompted to save before navigating away? settings.ui.navigate_away_confirm = False # Should user be prompted to confirm actions? settings.ui.confirm = False
Make sure that following settings are enabled in 000_config.py file.
settings.base.migrate = True settings.base.debug = True
Then you will need to re-populate: delete the contents of databases/* , errors/* and sessions/*
cd web2py/applications/eden rm databases/* sessions/* errors/* # To re-populate cd ../../ # Change the template to IFRC in models/000_config.py sed -i "s/settings.base.template = \".*\"/settings.base.template = \"IFRC\" /" applications/eden/models/000_config.py # If the above command does not work(on Mac OS X), then open models/000_config.py and change the following - settings.base.template = "IFRC" python web2py.py -S eden -M -R applications/eden/static/scripts/tools/noop.py
Currently, the tests can run on the following templates -
After the above re-population of the database, change the template to any of the above templates on which you wish to run the Selenium tests.
Start the Web2py server at 127.0.0.1:8000. (Selenium will start a captive browser, which it will direct to contact the server at 127.0.0.1:8000.)
Run the whole test suite for the current template:
cd web2py python web2py.py -S eden -M -R applications/eden/modules/tests/suite.py
Note : These tests don't run on Firefox 17 and above. So, if you have your default browser set as Firefox 17 or above, you will have to run them on Chrome. To do so, add
-A --browser=Chrome to the command.
So, it becomes
python web2py.py -S eden -M -R applications/eden/modules/tests/suite.py -A --browser=Chrome
Run a class and all tests in that class:
cd web2py python web2py.py -S eden -M -R applications/eden/modules/tests/suite.py -A -C mytestclass
Run just one test within a class:
cd web2py python web2py.py -S eden -M -R applications/eden/modules/tests/suite.py -A -C mytestclass -M mytestmethod
Command Line Arguments
A number of command line arguments have been added and more are being added so to get the latest list of available options use the --help switch, which you can quickly do as follows:
python web2py.py -S eden -M -R applications/eden/modules/tests/suite.py -A --help
Important options include:
-C for class to run
-M for test method within a class to run, when you use this option either use the -C option or provide the method in the format class.method
If you have HTMLTestRunner installed then a nicely formatted html report will be generated, should you want to disable this then use the --nohtml option. The HTML report will be written to the path given by the switch --html_path which by default will the web2py folder since that is where the tests scripts are run from. The file name will have a timestamp appended to it, if you want you can have just a date by using the option html_name_date.
The option --suite will run certain predefined tests. At the moment it supports smoke, which runs a test to look for broken urls otherwise it will run all the tests. If a class or method are selected then this option is ignored. For the smoke test to work you need to install two packages, twill and mechanize, since twill uses mechanize if you install via a package manager then you probably only need to install twill.
Writing / Creating your own test scripts:
We aim to make it as easy as possible to write additional tests, which can easily be plugged into the Sahana Eden Testing System Framework.
New tests should be stored in a subfolder per module, adding the foldername to
eden/modules/tests/__init__.py & creating an
__init__.py in the subfolder.
A walk-through example: Creating a Record
The canonical example is:
We want to make an automated test script to test the Create Staff module. Create Staff falls under Staff feature, therefore we must add this test script module file in the subfolder /staff (eden/modules/tests/staff/)
Steps of automated the test for Create Staff:
1) Let's call this test file: create_staff.py and save it in the subfolder /staff.
2) We must now make sure we add the file name in the init.py Open file init.py in the subfolder /staff and add:
from create_staff import *
from tests.web2unittest import SeleniumUnitTest class CreateStaff(SeleniumUnitTest): def test_hrm001_create_staff(self): """ @case: HRM001 @description: Create a Staff @TestDoc: https://docs.google.com/spreadsheet/ccc?key=0AmB3hMcgB-3idG1XNGhhRG9QWF81dUlKLXpJaFlCMFE @Test Wiki: http://eden.sahanafoundation.org/wiki/DeveloperGuidelines/Testing """ print "\n" self.login(account="admin", nexturl="hrm/staff/create") self.create("hrm_human_resource", [( "organisation_id", "International Federation of Red Cross and Red Crescent Societies"), ( "site_id", "AP Zone (Office)"), ( "first_name", "Robert", "pr_person"), ( "middle_name", "James", "pr_person"), ( "last_name", "Lemon", "pr_person"), ( "email", "firstname.lastname@example.org", "pr_person"), ( "job_title_id", "Warehouse Manager"), ] )
- The create function takes 2 arguments -
table_name- The name of the database table in which we want to insert the record.
data- The list which contains the record to be inserted.
- Each tuple in the above list contains information about each individual field.
- Eg -
( "organisation_id","International Federation of Red Cross and Red Crescent Societies"). Here,
organisation_idis the label of the field in which we want to insert data
International Federation of Red Cross and Red Crescent Societies
- Eg -
4) To run this automated test script.
Determine the template(s) on which you wish to run this test on. The tests for each template are defined in
Open tests.py for these templates and append the class name of the test to the list so it can be executed. (NOTE: We add the class name, not the function name).
5) Run your test script. (Refer above on how to run/execute test scripts from the Test Suite).
Splitting Test Functions:
We aim to keep the test script as clean and understandable as possible. Therefore, we must separate the test functions which drives the a particular test script to another file. As you can see with the Inventory feature tests, there is a file in the INV subdirectory called helper.py. This file contains all functions which helps drive the Inventory module tests such as send_item.py, receive_item.py and so forth.
Other information on the Test System framework:
The key is to make tests which are as least fragile as possible through:
- State (we should be able to run individual tests easilty, which check their current state as-required)
This suggests refactoring tests to centralise common elements into a library to mean fixes should only happen in 1 place.
There are a number of possible selectors to use to find your elements...the 'ID' may be the most stable, so don't be afraid of patching the code to add IDs where you'd like to be able to reach them reliably:
- http://code.google.com/p/selenium/wiki/PageObjects - Style suggestion