docs/develop/Testing.md

   1 # Nominatim Test Suite
   2
   3 This chapter describes the tests in the `/test` directory, how they are
   4 structured and how to extend them. For a quick introduction on how to run
   5 the tests, see the [Development setup chapter](Development-Environment.md).
   6
   7 ## Overall structure
   8
   9 There are two kind of tests in this test suite. There are functional tests
  10 which test the API interface using a BDD test framework and there are unit
  11 tests for specific PHP functions.
  12
  13 This test directory is sturctured as follows:
  14
  15 ```
  16  -+-   bdd         Functional API tests
  17   | \
  18   | +-  steps      Step implementations for test descriptions
  19   | +-  osm2pgsql  Tests for data import via osm2pgsql
  20   | +-  db         Tests for internal data processing on import and update
  21   | +-  api        Tests for API endpoints (search, reverse, etc.)
  22   |
  23   +-   php         PHP unit tests
  24   +-   scenes      Geometry test data
  25   +-   testdb      Base data for generating API test database
  26 ```
  27
  28 ## PHP Unit Tests (`test/php`)
  29
  30 Unit tests can be found in the php/ directory. They test selected php functions.
  31 Very low coverage.
  32
  33 To execute the test suite run
  34
  35     cd test/php
  36     UNIT_TEST_DSN='pgsql:dbname=nominatim_unit_tests' phpunit ../
  37
  38 It will read phpunit.xml which points to the library, test path, bootstrap
  39 strip and set other parameters.
  40
  41 It will use (and destroy) a local database 'nominatim_unit_tests'. You can set
  42 a different connection string with e.g. UNIT_TEST_DSN='pgsql:dbname=foo_unit_tests'.
  43
  44 ## BDD Functional Tests (`test/bdd`)
  45
  46 Functional tests are written as BDD instructions. For more information on
  47 the philosophy of BDD testing, see the
  48 [Behave manual](http://pythonhosted.org/behave/philosophy.html).
  49
  50 The following explanation assume that the reader is familiar with the BDD
  51 notations of features, scenarios and steps.
  52
  53 All possible steps can be found in the `steps` directory and should ideally
  54 be documented.
  55
  56 ### General Usage
  57
  58 To run the functional tests, do
  59
  60     cd test/bdd
  61     behave
  62
  63 The tests can be configured with a set of environment variables (`behave -D key=val`):
  64
  65  * `BUILDDIR` - build directory of Nominatim installation to test
  66  * `TEMPLATE_DB` - name of template database used as a skeleton for
  67                    the test databases (db tests)
  68  * `TEST_DB` - name of test database (db tests)
  69  * `API_TEST_DB` - name of the database containing the API test data (api tests)
  70  * `API_TEST_FILE` - OSM file to be imported into the API test database (api tests)
  71  * `DB_HOST` - (optional) hostname of database host
  72  * `DB_PORT` - (optional) port of database on host
  73  * `DB_USER` - (optional) username of database login
  74  * `DB_PASS` - (optional) password for database login
  75  * `SERVER_MODULE_PATH` - (optional) path on the Postgres server to Nominatim
  76                           module shared library file
  77  * `REMOVE_TEMPLATE` - if true, the template and API database will not be reused
  78                        during the next run. Reusing the base templates speeds
  79                        up tests considerably but might lead to outdated errors
  80                        for some changes in the database layout.
  81  * `KEEP_TEST_DB` - if true, the test database will not be dropped after a test
  82                     is finished. Should only be used if one single scenario is
  83                     run, otherwise the result is undefined.
  84
  85 Logging can be defined through command line parameters of behave itself. Check
  86 out `behave --help` for details. Also have a look at the 'work-in-progress'
  87 feature of behave which comes in handy when writing new tests.
  88
  89 ### API Tests (`test/bdd/api`)
  90
  91 These tests are meant to test the different API endpoints and their parameters.
  92 They require to import several datasets into a test database. This is normally
  93 done automatically during setup of the test. The API test database is then
  94 kept around and reused in subsequent runs of behave. Use `behave -DREMOVE_TEMPLATE`
  95 to force a reimport of the database.
  96
  97 The official test dataset is saved in the file `test/testdb/apidb-test-data.pbf`
  98 and compromises the following data:
  99
 100  * Geofabrik extract of Liechtenstein
 101  * extract of Autauga country, Alabama, US (for tests against Tiger data)
 102  * additional data from `test/testdb/additional_api_test.data.osm`
 103
 104 API tests should only be testing the functionality of the website PHP code.
 105 Most tests should be formulated as BDD DB creation tests (see below) instead.
 106
 107 #### Code Coverage
 108
 109 The API tests also support code coverage tests. You need to install
 110 [PHP_CodeCoverage](https://github.com/sebastianbergmann/php-code-coverage).
 111 On Debian/Ubuntu run:
 112
 113     apt-get install php-codecoverage php-xdebug
 114
 115 Then run the API tests as follows:
 116
 117     behave api -DPHPCOV=<coverage output dir>
 118
 119 The output directory must be an absolute path. To generate reports, you can use
 120 the [phpcov](https://github.com/sebastianbergmann/phpcov) tool:
 121
 122     phpcov merge --html=<report output dir> <coverage output dir>
 123
 124 ### DB Creation Tests (`test/bdd/db`)
 125
 126 These tests check the import and update of the Nominatim database. They do not
 127 test the correctness of osm2pgsql. Each test will write some data into the `place`
 128 table (and optionally the `planet_osm_*` tables if required) and then run
 129 Nominatim's processing functions on that.
 130
 131 These tests need to create their own test databases. By default they will be
 132 called `test_template_nominatim` and `test_nominatim`. Names can be changed with
 133 the environment variables `TEMPLATE_DB` and `TEST_DB`. The user running the tests
 134 needs superuser rights for postgres.
 135
 136 ### Import Tests (`test/bdd/osm2pgsql`)
 137
 138 These tests check that data is imported correctly into the place table. They
 139 use the same template database as the DB Creation tests, so the same remarks apply.
 140
 141 Note that most testing of the gazetteer output of osm2pgsql is done in the tests
 142 of osm2pgsql itself. The BDD tests are just there to ensure compatibility of
 143 the osm2pgsql and Nominatim code.