X-Git-Url: https://git.openstreetmap.org/nominatim.git/blobdiff_plain/cce57139cf47ffe7d857a4c0a5743c100262ce5e..9e35e5c2b02887e361972ffbb20e65bbba0d02c7:/test/README.md diff --git a/test/README.md b/test/README.md index f6c1ac2a..0487fd40 100644 --- a/test/README.md +++ b/test/README.md @@ -73,6 +73,11 @@ The tests can be configured with a set of environment variables: 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) + * `DB_HOST` - (optional) hostname of database 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 @@ -100,7 +105,7 @@ be documented. These tests are meant to test the different API endpoints and their parameters. 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 -http://www.nominatim.org/data/test/nominatim-api-testdata.pbf +https://www.nominatim.org/data/test/nominatim-api-testdata.pbf 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, @@ -112,7 +117,7 @@ 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 http://free.nchc.org.tw/osm.planet/pbf/planet-160725.osm.pbf + 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 Before importing make sure to add the following to your local settings: @@ -123,15 +128,17 @@ Before importing make sure to add the following to your local settings: #### Code Coverage The API tests also support code coverage tests. You need to install -PHP_CodeCoverage. On Debian/Ubuntu run: +[PHP_CodeCoverage](https://github.com/sebastianbergmann/php-code-coverage). +On Debian/Ubuntu run: - apt-get install php-codecoverage + apt-get install php-codecoverage php-xdebug The run the API tests as follows: behave api -DPHPCOV= -To generate reports, you can use the phpcov tool: +The output directory must be an absolute path. To generate reports, you can use +the [phpcov](https://github.com/sebastianbergmann/phpcov) tool: phpcov merge --html=