X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/a74e736283c7871a2c47494f18cc65da6b43bccb..1e86dc1d932a672f1c83b5abc2906016b7500de1:/docs/develop/Testing.md diff --git a/docs/develop/Testing.md b/docs/develop/Testing.md index 7990bf9e..e2b01b8d 100644 --- a/docs/develop/Testing.md +++ b/docs/develop/Testing.md @@ -21,14 +21,15 @@ This test directory is sturctured as follows: | +- api Tests for API endpoints (search, reverse, etc.) | +- php PHP unit tests + +- python Python unit tests +- scenes Geometry test data +- testdb Base data for generating API test database ``` ## PHP Unit Tests (`test/php`) -Unit tests can be found in the php/ directory. They test selected php functions. -Very low coverage. +Unit tests for PHP code can be found in the `php/` directory. They test selected +PHP functions. Very low coverage. To execute the test suite run @@ -36,11 +37,26 @@ To execute the test suite run 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. +strip and sets 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'. +## Python Unit Tests (`test/python`) + +Unit tests for Python code can be found in the `python/` directory. The goal is +to have complete coverage of the Python library in `nominatim`. + +To execute the tests run + + py.test-3 test/python + +or + + pytest test/python + +The name of the pytest binary depends on your installation. + ## BDD Functional Tests (`test/bdd`) Functional tests are written as BDD instructions. For more information on