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