= EdenTest =
[[TOC]]

!EdenTest is a Robot Framework based testsuite used for automated testing in Sahana Eden. The project was initiated by Redsin as [https://github.com/nerdis/edentest EdenTest]. It is located in the eden codebase under directory '''eden/tests'''.

== About Robot Framework ==

[http://robotframework.org/ Robot Framework] is a Python-based, extensible keyword-driven (keywords are methods in Robot Framework) test automation framework used for testing. It provides many features that make writing tests, reading their results and finding errors hassle free. Some of its key features are:
* Enables easy-to-use tabular syntax for creating test cases in a uniform way.
* Provides ability to create reusable higher-level keywords from the existing keywords.
* Provides easy-to-read result reports and logs in HTML format.
* Is platform and application independent.

== Installation guidelines == 

!EdenTest requires three python packages.

* [https://code.google.com/p/robotframework/wiki/Installation robotframework] 
* [https://github.com/rtomac/robotframework-selenium2library robotframework-selenium2library]
* [http://franz-see.github.io/Robotframework-Database-Library/ robotframework-databaselibrary]

All the three packages mentioned above are available with two most commonly used python package installation tools, namely, [http://pip.readthedocs.org/en/latest/installing.html pip] and [https://pypi.python.org/pypi/setuptools easy_install]. 

=== Installation using pip ===

{{{
pip install robotframework
pip install robotframework-selenium2library
pip install robotframework-databaselibrary
}}}

=== Installation using easy_install ===

{{{
easy_install robotframework
easy_install robotframework-selenium2library
easy_install robotframework-databaselibrary
}}}

If you have successfully installed the packages, you should be able to run !EdenTest. If for some reason, you can not install the packages using either of the two methods mentioned above, please visit the three links given above. Manual install instructions for each package are given there.


== Directory structure ==

Before running !EdenTest, it is important to have a mental picture of the directory structure of !EdenTest and the importance of its sub-directories. 

{{{
/tests
├── docs
│   ├── auth.html
 |     ...
│   ├── main.html
│   └── widgets.html
├── execution
│   ├── config.example.py
│   └── config.py
└── implementation
    ├── libs
    ├── resources
    │   ├── auth.txt
     |     ...
    │   ├── main.txt
    │   └── widgets.txt
    └── testsuites
        ├── __init__.txt
        ├── hrm
        │   └── human_resource.txt
        ├── ...
                 
        └── project
            ├── project_project.txt
            └── variables.py


}}}
We distinguish between the implementation and the execution of the tests. 

* '''docs''': It contains the documentation of keywords in html format. The name of the file is same as the keyword file present in resources sub-directory. The documentation is extracted from the text written next to the `[Documentation]` setting below the keyword definition. 
* '''execution''': Execution directory contains the settings local to your system to run the tests. It has a file config.example.py using which config.py file is created. config.py is not under version control. It has settings variables like server address, valid username, valid password etc.
* '''implementation''': It contains the implementation aspects.
 * '''libs''':  This will be used to check-in Eden specific test libraries implemented in python, but it might be also used to store ready-made libraries to ensure they are kept stable for example the selenium2library.
 * '''resources''': It is imperative from a test-design point of view to have higher-level keywords. These are kept in the resource files. The keywords are stored in a file as per the function they serve for eg: Keyword `Login To Eden` is kept in '''auth.txt'''.
  * '''main.txt''': It is the center resource file. All the resource files like auth.txt, settings like config.py are imported in this file. Further, this file is imported in the tests. 
 * '''testsuites''': Testsuites directory contains all the different testsuites differentiated based on the basis of functionality they test eg: '''hrm'''. Inside each testcase, there is at least one .txt file which contains the testcases.

== Using !EdenTest == 

=== Start Sahana Eden ===
1. Make sure your have Sahana Eden running.

2. Populate the database

   Delete the contents of databases/* , errors/* and sessions/* in your eden directory.

   E.g. for Linux, cd to your eden directory and do:
   {{{
    rm databases/* sessions/* errors/*
   }}}

   On Windows, use Explorer to delete the contents of the eden\databases, eden\errors, and eden\sessions folders.

   To re-populate the database, for either Linux or Windows (using a command prompt window), cd to the web2py       directory, and do:
   {{{
   python web2py.py -S eden -M -R applications/eden/static/scripts/tools/noop.py
   }}}

=== Creating config.py ===
Before running the tests, there has to exist a '''config.py''' file inside the execution directory. It contains the various settings variables that are imported by !EdenTest. Copy the config.example.py into config.py by
[assuming the current working directory is /tests/]
{{{
cp execution/config.example.py execution/config.py
}}}
Edit the config.py file according to your requirements.


=== Running !EdenTest ===

Robot Framework test cases are executed from the command line. The command used to run the tests is [http://robotframework.googlecode.com/hg/doc/userguide/RobotFrameworkUserGuide.html?r=2.8.4#all-command-line-options pybot]. The link redirects to the wiki where the command line arguments are documented. You can also use `pybot --help` for the same.

The end result is, by default, an [http://robotframework.googlecode.com/hg/doc/userguide/RobotFrameworkUserGuide.html?r=2.8.4#output-file output file] in XML format and an HTML [http://robotframework.googlecode.com/hg/doc/userguide/RobotFrameworkUserGuide.html?r=2.8.4#report-file report] and a [http://robotframework.googlecode.com/hg/doc/userguide/RobotFrameworkUserGuide.html?r=2.8.4#log-file log]. These three files are created in the current working directory by default.

 * '''report.html''': Report files contain an overview of the test execution results in HTML format. They have statistics based on tags and executed test suites, as well as a list of all executed test cases. When both reports and logs are generated, the report has links to the log file for easy navigation to more detailed information. It is easy to see the overall test execution status from report, because its background color is green, if all critical tests pass, and bright red otherwise.

 * '''log.html''': Log files contain details about the executed test cases in HTML format. They have a hierarchical structure showing test suite, test case and keyword details. Log files are needed nearly every time when test results are to be investigated in detail. Even though log files also have statistics, reports are better for getting an higher-level overview.
 * '''output.xml''': Output files contain all the test execution results in machine readable XML format. 


__'''Some common usages'''__ 

[Assuming the current working directory is /tests]

* Run all the testsuites
{{{
pybot implementation/testsuites
}}}
   This will run all the testsuites found under the testsuites folder.

* Run a specific testsuite file
{{{
pybot implementation/testsuites/hrm/human_resource.txt
}}}
* Change the execution speed of selenium
{{{
pybot --variable DELAY:10 implementation/testsuites
}}}

   Similarly, other variables like ''BASEURL'', ''HOMEPAGE'' etc can be manipulated from the command line. `-V` flag can be used to give a path of a file containing a list of variables. The format of the file should be similar to '''config.py'''.
* Run a specific testcase
{{{
pybot -t Create_Organisation implementation/testsuites
}}}
   `-t` flag is used to select the testcase.

* Run a specific testsuite 
{{{
pybot -s project_project implementation/testsuites
}}}
  `-s` flag is used to select the testsuite.

* Change the output directory
{{{
pybot -d [path to the directory] implementation/testsuites
}}}


To read the results after running the tests, open ''report.html'' in your browser.
 
== Writing a testcase ==

Please see the tutorial [http://eden.sahanafoundation.org/wiki/DeveloperGuidelines/EdenTest/WriteTestcase How to write a testcase for EdenTest?]

For more advanced usage, please refer to [http://eden.sahanafoundation.org/wiki/DeveloperGuidelines/EdenTest/WriteTestcase/Advanced Advanced Test Design].