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