Merge remote-tracking branch 'upstream/master'

[nominatim.git] / test / README.md

diff --git a/test/README.md b/test/README.md
index 9b777412d20830d77d19800ef2fcc798f3f32699..1f7a33ca47f5b1c5d4ca541a4113ec860733da82 100644 (file)
--- a/test/README.md
+++ b/test/README.md
@@ -46,11 +46,13 @@ Very low coverage.
 To execute the test suite run
 
     cd test/php
 To execute the test suite run
 
     cd test/php

-    phpunit ../
+    UNIT_TEST_DSN='pgsql:dbname=nominatim_unit_tests' phpunit ../

 
 It will read phpunit.xml which points to the library, test path, bootstrap
 strip and set other parameters.
 
 
 It will read phpunit.xml which points to the library, test path, bootstrap
 strip and set other parameters.
 

+It will use (and destroy) a local database 'nominatim_unit_tests'. You can set
+a different connection string with e.g. UNIT_TEST_DSN='pgsql:dbname=foo_unit_tests'.

 
 BDD Functional Tests
 ====================
 
 BDD Functional Tests
 ====================


@@ -66,14 +68,15 @@ To run the functional tests, do
     cd test/bdd
     behave
 
     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)
  * `API_TEST_DB` - name of the database containing the API test data (api tests)
  * `DB_HOST` - (optional) hostname of database host
  * `TEMPLATE_DB` - name of template database used as a skeleton for
                    the test databases (db tests)
  * `TEST_DB` - name of test database (db 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
  * `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


@@ -107,12 +110,19 @@ 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
 
 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 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:
 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: