X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/bf1f6a997ccdb115f7c77ab8ded34e80dca7abeb..06683edaae8bfa517e488375d710ca6532336725:/docs/develop/Testing.md?ds=inline diff --git a/docs/develop/Testing.md b/docs/develop/Testing.md index be13d949..c220f4e4 100644 --- a/docs/develop/Testing.md +++ b/docs/develop/Testing.md @@ -10,7 +10,7 @@ There are two kind of tests in this test suite. There are functional tests which test the API interface using a BDD test framework and there are unit tests for specific PHP functions. -This test directory is sturctured as follows: +This test directory is structured as follows: ``` -+- bdd Functional API tests @@ -78,7 +78,6 @@ To run the functional tests, do The tests can be configured with a set of environment variables (`behave -D key=val`): - * `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) @@ -91,7 +90,7 @@ The tests can be configured with a set of environment variables (`behave -D key= * `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 + module shared library file (only needed for legacy tokenizer) * `REMOVE_TEMPLATE` - if true, the template and API database will not be reused during the next run. Reusing the base templates speeds up tests considerably but might lead to outdated errors @@ -122,23 +121,6 @@ and compromises the following data: API tests should only be testing the functionality of the website PHP code. Most tests should be formulated as BDD DB creation tests (see below) instead. -#### Code Coverage (PHP engine only) - -The API tests also support code coverage tests. You need to install -[PHP_CodeCoverage](https://github.com/sebastianbergmann/php-code-coverage). -On Debian/Ubuntu run: - - apt-get install php-codecoverage php-xdebug - -Then run the API tests as follows: - - behave api -DPHPCOV= - -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= - ### DB Creation Tests (`test/bdd/db`) These tests check the import and update of the Nominatim database. They do not