test/README.md

   1 This directory contains functional and unit tests for the Nominatim API.
   2
   3 Prerequisites
   4 =============
   5
   6  * Python 3 (https://www.python.org/)
   7  * behave test framework >= 1.2.5 (https://github.com/behave/behave)
   8  * nose (https://nose.readthedocs.org)
   9  * pytidylib (http://countergram.com/open-source/pytidylib)
  10  * psycopg2 (http://initd.org/psycopg/)
  11
  12 To get the prerequisites on a a fresh Ubuntu LTS 16.04 run:
  13
  14      [sudo] apt-get install python3-dev python3-pip python3-psycopg2 python3-tidylib phpunit php-cgi
  15      pip3 install --user behave nose
  16
  17
  18 Overall structure
  19 =================
  20
  21 There are two kind of tests in this test suite. There are functional tests
  22 which test the API interface using a BDD test framework and there are unit
  23 tests for specific PHP functions.
  24
  25 This test directory is sturctured as follows:
  26
  27 ```
  28  -+-   bdd         Functional API tests
  29   | \
  30   | +-  steps      Step implementations for test descriptions
  31   | +-  osm2pgsql  Tests for data import via osm2pgsql
  32   | +-  db         Tests for internal data processing on import and update
  33   | +-  api        Tests for API endpoints (search, reverse, etc.)
  34   |
  35   +-   php         PHP unit tests
  36   +-   scenes      Geometry test data
  37   +-   testdb      Base data for generating API test database
  38 ```
  39
  40 PHP Unit Tests
  41 ==============
  42
  43 Unit tests can be found in the php/ directory and tests selected php functions.
  44 Very low coverage.
  45
  46 To execute the test suite run
  47
  48     cd test/php
  49     UNIT_TEST_DSN='pgsql:dbname=nominatim_unit_tests' phpunit ../
  50
  51 It will read phpunit.xml which points to the library, test path, bootstrap
  52 strip and set other parameters.
  53
  54 It will use (and destroy) a local database 'nominatim_unit_tests'. You can set
  55 a different connection string with e.g. UNIT_TEST_DSN='pgsql:dbname=foo_unit_tests'.
  56
  57 BDD Functional Tests
  58 ====================
  59
  60 Functional tests are written as BDD instructions. For more information on
  61 the philosophy of BDD testing, see http://pythonhosted.org/behave/philosophy.html
  62
  63 Usage
  64 -----
  65
  66 To run the functional tests, do
  67
  68     cd test/bdd
  69     behave
  70
  71 The tests can be configured with a set of environment variables (`behave -D key=val`):
  72
  73  * `BUILDDIR` - build directory of Nominatim installation to test
  74  * `TEMPLATE_DB` - name of template database used as a skeleton for
  75                    the test databases (db tests)
  76  * `TEST_DB` - name of test database (db tests)
  77  * `API_TEST_DB` - name of the database containing the API test data (api tests)
  78  * `DB_HOST` - (optional) hostname of database host
  79  * `DB_PORT` - (optional) port of database on host
  80  * `DB_USER` - (optional) username of database login
  81  * `DB_PASS` - (optional) password for database login
  82  * `SERVER_MODULE_PATH` - (optional) path on the Postgres server to Nominatim
  83                           module shared library file
  84  * `TEST_SETTINGS_TEMPLATE` - file to write temporary Nominatim settings to
  85  * `REMOVE_TEMPLATE` - if true, the template database will not be reused during
  86                        the next run. Reusing the base templates speeds up tests
  87                        considerably but might lead to outdated errors for some
  88                        changes in the database layout.
  89  * `KEEP_TEST_DB` - if true, the test database will not be dropped after a test
  90                     is finished. Should only be used if one single scenario is
  91                     run, otherwise the result is undefined.
  92
  93 Logging can be defined through command line parameters of behave itself. Check
  94 out `behave --help` for details. Also keep an eye out for the 'work-in-progress'
  95 feature of behave which comes in handy when writing new tests.
  96
  97 Writing Tests
  98 -------------
  99
 100 The following explanation assume that the reader is familiar with the BDD
 101 notations of features, scenarios and steps.
 102
 103 All possible steps can be found in the `steps` directory and should ideally
 104 be documented.
 105
 106 ### API Tests (`test/bdd/api`)
 107
 108 These tests are meant to test the different API endpoints and their parameters.
 109 They require a preimported test database, which consists of the import of a
 110 planet extract. A precompiled PBF with the necessary data can be downloaded from
 111 https://www.nominatim.org/data/test/nominatim-api-testdata.pbf
 112
 113 You need at least 2GB RAM and 10GB discspace.
 114
 115 The polygons defining the extract can be found in the test/testdb
 116 directory. There is also a reduced set of wikipedia data for this extract,
 117 which you need to import as well. For Tiger tests the data of South Dakota
 118 is required. Get the Tiger files `46*`.
 119
 120     cd Nominatim/data
 121     wget https://nominatim.org/data/tiger2018-nominatim-preprocessed.tar.gz
 122     tar xvf tiger2018-nominatim-preprocessed.tar.gz --wildcards --no-anchored '46*'
 123     rm tiger2018-nominatim-preprocessed.tar.gz
 124
 125 The official test dataset is derived from the 180924 planet. Newer
 126 planets are likely to work as well but you may see isolated test
 127 failures where the data has changed. To recreate the input data
 128 for the test database run:
 129
 130     wget https://ftp5.gwdg.de/pub/misc/openstreetmap/planet.openstreetmap.org/pbf/planet-180924.osm.pbf
 131     osmconvert planet-180924.osm.pbf -B=test/testdb/testdb.polys -o=testdb.pbf
 132
 133 Before importing make sure to add the following to your local settings:
 134
 135     @define('CONST_Database_DSN', 'pgsql://@/test_api_nominatim');
 136     @define('CONST_Wikipedia_Data_Path', CONST_BasePath.'/test/testdb');
 137
 138 #### Code Coverage
 139
 140 The API tests also support code coverage tests. You need to install
 141 [PHP_CodeCoverage](https://github.com/sebastianbergmann/php-code-coverage).
 142 On Debian/Ubuntu run:
 143
 144     apt-get install php-codecoverage php-xdebug
 145
 146 The run the API tests as follows:
 147
 148     behave api -DPHPCOV=<coverage output dir>
 149
 150 The output directory must be an absolute path. To generate reports, you can use
 151 the [phpcov](https://github.com/sebastianbergmann/phpcov) tool:
 152
 153     phpcov merge --html=<report output dir> <coverage output dir>
 154
 155 ### Indexing Tests (`test/bdd/db`)
 156
 157 These tests check the import and update of the Nominatim database. They do not
 158 test the correctness of osm2pgsql. Each test will write some data into the `place`
 159 table (and optionally `the planet_osm_*` tables if required) and then run
 160 Nominatim's processing functions on that.
 161
 162 These tests need to create their own test databases. By default they will be
 163 called `test_template_nominatim` and `test_nominatim`. Names can be changed with
 164 the environment variables `TEMPLATE_DB` and `TEST_DB`. The user running the tests
 165 needs superuser rights for postgres.
 166
 167 ### Import Tests (`test/bdd/osm2pgsql`)
 168
 169 These tests check that data is imported correctly into the place table. They
 170 use the same template database as the Indexing tests, so the same remarks apply.