| 1 |
IBX Test Suite
|
| 2 |
==============
|
| 3 |
|
| 4 |
This is the IBX Test Suite. It is intended to provide a set of tests with a pass/fail result determined by a simple inspection of the "diff" file.
|
| 5 |
|
| 6 |
The test suite comprises 28 separate tests, testing 230 identified features present in the IBX non-visual components. It is intended to provide comprehensive test coverage of all test features in order to demonstrate a high degreee of confidence that the software performs as expected and when run on different platforms (32 bit and 64 bit, Linux and Windows) and with different versions of the Firebird database (2.5, 3 and 4). It also supports regression testing. See doc/TestCoverage.pdf for a list of tests and test features and which test covers which test features.
|
| 7 |
|
| 8 |
The test environment requires that a Firebird Server is available and running, and ideally this should also include the Firebird embedded server. The example "employee" database must also be installed. The standard Firebird distributions available from firebirdsql.org are suitable for testing. In order to test the embedded server operation, the "employee" database should be read/writable from the user under which the tests are run.
|
| 9 |
|
| 10 |
-----------------------------------------------------------------------
|
| 11 |
|
| 12 |
Under Linux, the test suite is run from the ibx/testsuite directory using the script "runtest.sh":
|
| 13 |
|
| 14 |
Usage:
|
| 15 |
|
| 16 |
runtest.sh [-L <lazarus root directory> ] -f <fbintf package directory> [-p <SYSDBA password] [-t <testid>]
|
| 17 |
|
| 18 |
Options:
|
| 19 |
|
| 20 |
-L This is used when the lazarus root directory for the installed version of lazarus differs from ~/lazarus. The option is used to introduce the relative or absolute path to the lazarus installation directory.
|
| 21 |
|
| 22 |
-f This is used when the relative path to the fbintf package directory (from ibx/testsuite) is neither ../fbintf or ../../fbintf. The option is used to introduce the relative or absolute path to the fbintf directory.
|
| 23 |
|
| 24 |
-p This is used when the SYSDBA password is not the default "masterkey". The password can also be provided by the environment variable SYSDBAPWD.
|
| 25 |
|
| 26 |
-t This is used to select a specific test (in the range 1..28). If absent then all tests are performed.
|
| 27 |
|
| 28 |
The script compiles the IBX units and test suite and runs the testsuite. The result is saved in the file
|
| 29 |
|
| 30 |
ibx/testsuite/testout.<current time in nanoseconds>.log
|
| 31 |
|
| 32 |
It is compared with a reference log file and the result output to diff.log. The script prints the number of lines in the output diff.
|
| 33 |
|
| 34 |
Separate reference logs are provided for Firebird 2.5, 3 and 4. This reflects the different feature sets of each release. The diff.log needs to be reviewed in order to determine pass/fail. Some differences should be expected e.g. some tests include current timestamps and some print out server statistics. Both vary every time the tests are run. Generally, 200 to 500 lines should be expected for a pass result. More is indicative of failure. Review of the diff should be diagnostic as the logs should only differ in dynamic information.
|
| 35 |
|
| 36 |
The script can also work with the Firebird Server and Client files in a non-standard directory if the FIREBIRD environment variable is set before the script is invoked. For example, if a test version of Firebird is installed in /home/tester/firebird and started locally, then the script may be run as:
|
| 37 |
|
| 38 |
export FIREBIRD=/home/tester/firebird
|
| 39 |
./runtest.sh
|
| 40 |
|
| 41 |
-----------------------------------------------------------------------
|
| 42 |
|
| 43 |
Under Windows, the test suite is run from the ibx\testsuite directory using the script "runtest.bat". This script does not have any command line arguments.
|
| 44 |
|
| 45 |
The script assumes that lazarus is installed in C:\lazarus and includes the FPC compiler and binary tools. If lazarus is installed elsewhere then the script must be edited and the LAZARUS variable updated. e.g.
|
| 46 |
|
| 47 |
set LAZARUS=D:\lazarus
|
| 48 |
|
| 49 |
Similarly, if the SYSDBA password is other than the default "masterkey" the script must be edited and the PASSWORD variable changed to set the actual SYSDBA password.
|
| 50 |
|
| 51 |
Otherwise, the script works similarly to the linux version except that the results are always output to "testout.log".
|
| 52 |
|
