]> git.openstreetmap.org Git - nominatim.git/blob - test/README.md
Merge remote-tracking branch 'upstream/master'
[nominatim.git] / 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     phpunit ../
50
51 It will read phpunit.xml which points to the library, test path, bootstrap
52 strip and set other parameters.
53
54
55 BDD Functional Tests
56 ====================
57
58 Functional tests are written as BDD instructions. For more information on
59 the philosophy of BDD testing, see http://pythonhosted.org/behave/philosophy.html
60
61 Usage
62 -----
63
64 To run the functional tests, do
65
66     cd test/bdd
67     behave
68
69 The tests can be configured with a set of environment variables:
70
71  * `BUILD_DIR` - build directory of Nominatim installation to test
72  * `TEMPLATE_DB` - name of template database used as a skeleton for
73                    the test databases (db tests)
74  * `TEST_DB` - name of test database (db tests)
75  * `API_TEST_DB` - name of the database containing the API test data (api tests)
76  * `DB_HOST` - (optional) hostname of database host
77  * `DB_USER` - (optional) username of database login
78  * `DB_PASS` - (optional) password for database login
79  * `SERVER_MODULE_PATH` - (optional) path on the Postgres server to Nominatim
80                           module shared library file
81  * `TEST_SETTINGS_TEMPLATE` - file to write temporary Nominatim settings to
82  * `REMOVE_TEMPLATE` - if true, the template database will not be reused during
83                        the next run. Reusing the base templates speeds up tests
84                        considerably but might lead to outdated errors for some
85                        changes in the database layout.
86  * `KEEP_TEST_DB` - if true, the test database will not be dropped after a test
87                     is finished. Should only be used if one single scenario is
88                     run, otherwise the result is undefined.
89
90 Logging can be defined through command line parameters of behave itself. Check
91 out `behave --help` for details. Also keep an eye out for the 'work-in-progress'
92 feature of behave which comes in handy when writing new tests.
93
94 Writing Tests
95 -------------
96
97 The following explanation assume that the reader is familiar with the BDD
98 notations of features, scenarios and steps.
99
100 All possible steps can be found in the `steps` directory and should ideally
101 be documented.
102
103 ### API Tests (`test/bdd/api`)
104
105 These tests are meant to test the different API endpoints and their parameters.
106 They require a preimported test database, which consists of the import of a
107 planet extract. A precompiled PBF with the necessary data can be downloaded from
108 https://www.nominatim.org/data/test/nominatim-api-testdata.pbf
109
110 The polygons defining the extract can be found in the test/testdb
111 directory. There is also a reduced set of wikipedia data for this extract,
112 which you need to import as well. For Tiger tests the data of South Dakota
113 is required. Get the Tiger files `46*`.
114
115 The official test dataset is derived from the 160725 planet. Newer
116 planets are likely to work as well but you may see isolated test
117 failures where the data has changed. To recreate the input data
118 for the test database run:
119
120     wget https://ftp5.gwdg.de/pub/misc/openstreetmap/planet.openstreetmap.org/pbf/planet-180924.osm.pbf
121     osmconvert planet-180924.osm.pbf -B=test/testdb/testdb.polys -o=testdb.pbf
122
123 Before importing make sure to add the following to your local settings:
124
125     @define('CONST_Database_DSN', 'pgsql://@/test_api_nominatim');
126     @define('CONST_Wikipedia_Data_Path', CONST_BasePath.'/test/testdb');
127
128 #### Code Coverage
129
130 The API tests also support code coverage tests. You need to install
131 [PHP_CodeCoverage](https://github.com/sebastianbergmann/php-code-coverage).
132 On Debian/Ubuntu run:
133
134     apt-get install php-codecoverage php-xdebug
135
136 The run the API tests as follows:
137
138     behave api -DPHPCOV=<coverage output dir>
139
140 The output directory must be an absolute path. To generate reports, you can use
141 the [phpcov](https://github.com/sebastianbergmann/phpcov) tool:
142
143     phpcov merge --html=<report output dir> <coverage output dir>
144
145 ### Indexing Tests (`test/bdd/db`)
146
147 These tests check the import and update of the Nominatim database. They do not
148 test the correctness of osm2pgsql. Each test will write some data into the `place`
149 table (and optionally `the planet_osm_*` tables if required) and then run
150 Nominatim's processing functions on that.
151
152 These tests need to create their own test databases. By default they will be
153 called `test_template_nominatim` and `test_nominatim`. Names can be changed with
154 the environment variables `TEMPLATE_DB` and `TEST_DB`. The user running the tests
155 needs superuser rights for postgres.
156
157 ### Import Tests (`test/bdd/osm2pgsql`)
158
159 These tests check that data is imported correctly into the place table. They
160 use the same template database as the Indexing tests, so the same remarks apply.