X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/2cf1ff41c02729156821afbb6170243b8fd79422..143fa6e6b5f9f236de18c87c725cfd884ada613e:/test/README.md diff --git a/test/README.md b/test/README.md index 2a357e40..ab5f7f4c 100644 --- a/test/README.md +++ b/test/README.md @@ -66,13 +66,19 @@ To run the functional tests, do cd test/bdd behave -The tests can be configured with a set of environment variables: +The tests can be configured with a set of environment variables (`behave -D key=val`): - * `BUILD_DIR` - build directory of Nominatim installation to test + * `BUILDDIR` - build directory of Nominatim installation to test * `TEMPLATE_DB` - name of template database used as a skeleton for the test databases (db tests) * `TEST_DB` - name of test database (db tests) - * `ABI_TEST_DB` - name of the database containing the API test data (api tests) + * `API_TEST_DB` - name of the database containing the API test data (api tests) + * `DB_HOST` - (optional) hostname of database host + * `DB_PORT` - (optional) port of database on host + * `DB_USER` - (optional) username of database login + * `DB_PASS` - (optional) password for database login + * `SERVER_MODULE_PATH` - (optional) path on the Postgres server to Nominatim + module shared library file * `TEST_SETTINGS_TEMPLATE` - file to write temporary Nominatim settings to * `REMOVE_TEMPLATE` - if true, the template database will not be reused during the next run. Reusing the base templates speeds up tests @@ -102,18 +108,25 @@ They require a preimported test database, which consists of the import of a planet extract. A precompiled PBF with the necessary data can be downloaded from https://www.nominatim.org/data/test/nominatim-api-testdata.pbf +You need at least 2GB RAM and 10GB discspace. + The polygons defining the extract can be found in the test/testdb directory. There is also a reduced set of wikipedia data for this extract, which you need to import as well. For Tiger tests the data of South Dakota is required. Get the Tiger files `46*`. -The official test dataset is derived from the 160725 planet. Newer + cd Nominatim/data + wget https://nominatim.org/data/tiger2018-nominatim-preprocessed.tar.gz + tar xvf tiger2018-nominatim-preprocessed.tar.gz --wildcards --no-anchored '46*' + rm tiger2018-nominatim-preprocessed.tar.gz + +The official test dataset is derived from the 180924 planet. Newer planets are likely to work as well but you may see isolated test failures where the data has changed. To recreate the input data for the test database run: - wget https://free.nchc.org.tw/osm.planet/pbf/planet-160725.osm.pbf - osmconvert planet-160725.osm.pbf -B=test/testdb/testdb.polys -o=testdb.pbf + wget https://ftp5.gwdg.de/pub/misc/openstreetmap/planet.openstreetmap.org/pbf/planet-180924.osm.pbf + osmconvert planet-180924.osm.pbf -B=test/testdb/testdb.polys -o=testdb.pbf Before importing make sure to add the following to your local settings: