docs/develop/Testing.md

   1 # Nominatim Test Suite
   2
   3 This chapter describes the tests in the `/test` directory, how they are
   4 structured and how to extend them. For a quick introduction on how to run
   5 the tests, see the [Development setup chapter](Development-Environment.md).
   6
   7 ## Overall structure
   8
   9 There are two kind of tests in this test suite. There are functional tests
  10 which test the API interface using a BDD test framework and there are unit
  11 tests for the Python code.
  12
  13 This test directory is structured as follows:
  14
  15 ```
  16  -+-   bdd         Functional API tests
  17   | \
  18   | +-  steps      Step implementations for test descriptions
  19   | +-  osm2pgsql  Tests for data import via osm2pgsql
  20   | +-  db         Tests for internal data processing on import and update
  21   | +-  api        Tests for API endpoints (search, reverse, etc.)
  22   |
  23   +-   python      Python unit tests
  24   +-   testdb      Base data for generating API test database
  25   +-   testdata    Additional test data used by unit tests
  26 ```
  27
  28 ## Python Unit Tests (`test/python`)
  29
  30 Unit tests for Python code can be found in the `python/` directory. The goal is
  31 to have complete coverage of the Python library in `nominatim`.
  32
  33 To execute the tests run
  34
  35     py.test-3 test/python
  36
  37 or
  38
  39     pytest test/python
  40
  41 The name of the pytest binary depends on your installation.
  42
  43 ## BDD Functional Tests (`test/bdd`)
  44
  45 Functional tests are written as BDD instructions. For more information on
  46 the philosophy of BDD testing, see the
  47 [Behave manual](http://pythonhosted.org/behave/philosophy.html).
  48
  49 The following explanation assume that the reader is familiar with the BDD
  50 notations of features, scenarios and steps.
  51
  52 All possible steps can be found in the `steps` directory and should ideally
  53 be documented.
  54
  55 ### General Usage
  56
  57 To run the functional tests, do
  58
  59     cd test/bdd
  60     behave
  61
  62 The tests can be configured with a set of environment variables (`behave -D key=val`):
  63
  64  * `TEMPLATE_DB` - name of template database used as a skeleton for
  65                    the test databases (db tests)
  66  * `TEST_DB` - name of test database (db tests)
  67  * `API_TEST_DB` - name of the database containing the API test data (api tests)
  68  * `API_TEST_FILE` - OSM file to be imported into the API test database (api tests)
  69  * `API_ENGINE` - webframe to use for running search queries, same values as
  70                   `nominatim serve --engine` parameter
  71  * `DB_HOST` - (optional) hostname of database host
  72  * `DB_PORT` - (optional) port of database on host
  73  * `DB_USER` - (optional) username of database login
  74  * `DB_PASS` - (optional) password for database login
  75  * `SERVER_MODULE_PATH` - (optional) path on the Postgres server to Nominatim
  76                           module shared library file (only needed for legacy tokenizer)
  77  * `REMOVE_TEMPLATE` - if true, the template and API database will not be reused
  78                        during the next run. Reusing the base templates speeds
  79                        up tests considerably but might lead to outdated errors
  80                        for some changes in the database layout.
  81  * `KEEP_TEST_DB` - if true, the test database will not be dropped after a test
  82                     is finished. Should only be used if one single scenario is
  83                     run, otherwise the result is undefined.
  84
  85 Logging can be defined through command line parameters of behave itself. Check
  86 out `behave --help` for details. Also have a look at the 'work-in-progress'
  87 feature of behave which comes in handy when writing new tests.
  88
  89 ### API Tests (`test/bdd/api`)
  90
  91 These tests are meant to test the different API endpoints and their parameters.
  92 They require to import several datasets into a test database. This is normally
  93 done automatically during setup of the test. The API test database is then
  94 kept around and reused in subsequent runs of behave. Use `behave -DREMOVE_TEMPLATE`
  95 to force a reimport of the database.
  96
  97 The official test dataset is saved in the file `test/testdb/apidb-test-data.pbf`
  98 and compromises the following data:
  99
 100  * Geofabrik extract of Liechtenstein
 101  * extract of Autauga country, Alabama, US (for tests against Tiger data)
 102  * additional data from `test/testdb/additional_api_test.data.osm`
 103
 104 API tests should only be testing the functionality of the website frontend code.
 105 Most tests should be formulated as BDD DB creation tests (see below) instead.
 106
 107 ### DB Creation Tests (`test/bdd/db`)
 108
 109 These tests check the import and update of the Nominatim database. They do not
 110 test the correctness of osm2pgsql. Each test will write some data into the `place`
 111 table (and optionally the `planet_osm_*` tables if required) and then run
 112 Nominatim's processing functions on that.
 113
 114 These tests need to create their own test databases. By default they will be
 115 called `test_template_nominatim` and `test_nominatim`. Names can be changed with
 116 the environment variables `TEMPLATE_DB` and `TEST_DB`. The user running the tests
 117 needs superuser rights for postgres.
 118
 119 ### Import Tests (`test/bdd/osm2pgsql`)
 120
 121 These tests check that data is imported correctly into the place table. They
 122 use the same template database as the DB Creation tests, so the same remarks apply.