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  * `DB_HOST` - (optional) hostname of database host
  71  * `DB_PORT` - (optional) port of database on host
  72  * `DB_USER` - (optional) username of database login
  73  * `DB_PASS` - (optional) password for database login
  74  * `SERVER_MODULE_PATH` - (optional) path on the Postgres server to Nominatim
  75                           module shared library file
  76  * `TEST_SETTINGS_TEMPLATE` - file to write temporary Nominatim settings to
  77  * `REMOVE_TEMPLATE` - if true, the template database will not be reused during
  78                        the next run. Reusing the base templates speeds up tests
  79                        considerably but might lead to outdated errors for some
  80                        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.
  93 See the [Development Setup chapter](Development-Environment.md#preparing-the-test-database)
  94 for instructions on how to set up this database.
  95
  96 The official test dataset was derived from the 180924 planet (note: such
  97 file no longer exists at https://planet.openstreetmap.org/planet/2018/).
  98 Newer planets are likely to work as well but you may see isolated test
  99 failures where the data has changed.
 100
 101 The official test dataset can always be downloaded from
 102 [nominatim.org](https://www.nominatim.org/data/test/nominatim-api-testdata.pbf)
 103 To recreate the input data for the test database run:
 104
 105 ```
 106 wget https://ftp5.gwdg.de/pub/misc/openstreetmap/planet.openstreetmap.org/pbf/planet-180924.osm.pbf
 107 osmconvert planet-180924.osm.pbf -B=test/testdb/testdb.polys -o=testdb.pbf
 108 ```
 109
 110 #### Code Coverage
 111
 112 The API tests also support code coverage tests. You need to install
 113 [PHP_CodeCoverage](https://github.com/sebastianbergmann/php-code-coverage).
 114 On Debian/Ubuntu run:
 115
 116     apt-get install php-codecoverage php-xdebug
 117
 118 Then run the API tests as follows:
 119
 120     behave api -DPHPCOV=<coverage output dir>
 121
 122 The output directory must be an absolute path. To generate reports, you can use
 123 the [phpcov](https://github.com/sebastianbergmann/phpcov) tool:
 124
 125     phpcov merge --html=<report output dir> <coverage output dir>
 126
 127 ### DB Creation Tests (`test/bdd/db`)
 128
 129 These tests check the import and update of the Nominatim database. They do not
 130 test the correctness of osm2pgsql. Each test will write some data into the `place`
 131 table (and optionally the `planet_osm_*` tables if required) and then run
 132 Nominatim's processing functions on that.
 133
 134 These tests need to create their own test databases. By default they will be
 135 called `test_template_nominatim` and `test_nominatim`. Names can be changed with
 136 the environment variables `TEMPLATE_DB` and `TEST_DB`. The user running the tests
 137 needs superuser rights for postgres.
 138
 139 ### Import Tests (`test/bdd/osm2pgsql`)
 140
 141 These tests check that data is imported correctly into the place table. They
 142 use the same template database as the DB Creation tests, so the same remarks apply.