test/README.md

   1 This directory contains functional and unit tests for the Nominatim API.
   2
   3 Prerequisites
   4 =============
   5
   6  * Python 3 (https://www.python.org/)
   7  * behave test framework >= 1.2.5 (https://github.com/behave/behave)
   8  * nose (https://nose.readthedocs.org)
   9  * pytidylib (http://countergram.com/open-source/pytidylib)
  10  * psycopg2 (http://initd.org/psycopg/)
  11
  12 To get the prerequisites on a a fresh Ubuntu LTS 16.04 run:
  13
  14      [sudo] apt-get install python3-dev python3-pip python3-psycopg2 python3-tidylib phpunit
  15      pip3 install --user behave nose
  16
  17
  18 Overall structure
  19 =================
  20
  21 There are two kind of tests in this test suite. There are functional tests
  22 which test the API interface using a BDD test framework and there are unit
  23 tests for specific PHP functions.
  24
  25 This test directory is sturctured as follows:
  26
  27  -+-   bdd         Functional API tests
  28   | \
  29   | +-  steps      Step implementations for test descriptions
  30   | +-  osm2pgsql  Tests for data import via osm2pgsql
  31   | +-  db         Tests for internal data processing on import and update
  32   | +-  api        Tests for API endpoints (search, reverse, etc.)
  33   |
  34   +-   php         PHP unit tests
  35   +-   scenes      Geometry test data
  36   +-   testdb      Base data for generating API test database
  37
  38
  39 PHP Unit Tests
  40 ==============
  41
  42 Unit tests can be found in the php/ directory and tests selected php functions.
  43 Very low coverage.
  44
  45 To execute the test suite run
  46
  47    cd test/php
  48    phpunit ../
  49
  50 It will read phpunit.xml which points to the library, test path, bootstrap
  51 strip and set other parameters.
  52
  53
  54 BDD Functional Tests
  55 ====================
  56
  57 Functional tests are written as BDD instructions. For more information on
  58 the philosophy of BDD testing, see http://pythonhosted.org/behave/philosophy.html
  59
  60 Usage
  61 -----
  62
  63 To run the functional tests, do
  64
  65     cd test/bdd
  66     behave
  67
  68 The tests can be configured with a set of environment variables:
  69
  70  * `BUILD_DIR` - build directory of Nominatim installation to test
  71  * `TEMPLATE_DB` - name of template database used as a skeleton for
  72                    the test databases (db tests)
  73  * `TEST_DB` - name of test database (db tests)
  74  * `ABI_TEST_DB` - name of the database containing the API test data (api tests)
  75  * `TEST_SETTINGS_TEMPLATE` - file to write temporary Nominatim settings to
  76  * `REMOVE_TEMPLATE` - if true, the template database will not be reused during
  77                        the next run. Reusing the base templates speeds up tests
  78                        considerably but might lead to outdated errors for some
  79                        changes in the database layout.
  80  * `KEEP_TEST_DB` - if true, the test database will not be dropped after a test
  81                     is finished. Should only be used if one single scenario is
  82                     run, otherwise the result is undefined.
  83
  84 Logging can be defined through command line parameters of behave itself. Check
  85 out `behave --help` for details. Also keep an eye out for the 'work-in-progress'
  86 feature of behave which comes in handy when writing new tests.
  87
  88 Writing Tests
  89 -------------
  90
  91 The following explanation assume that the reader is familiar with the BDD
  92 notations of features, scenarios and steps.
  93
  94 All possible steps can be found in the `steps` directory and should ideally
  95 be documented.
  96
  97 ### API Tests (`test/bdd/api`)
  98
  99 These tests are meant to test the different API endpoints and their parameters.
 100 They require a preimported test database, which consists of the import of a
 101 planet extract. The polygons defining the extract can be found in the test/testdb
 102 directory. There is also a reduced set of wikipedia data for this extract,
 103 which you need to import as well.
 104
 105 The official test dataset is derived from the 160725 planet. Newer
 106 planets are likely to work as well but you may see isolated test
 107 failures where the data has changed. To recreate the input data
 108 for the test database run:
 109
 110     wget http://free.nchc.org.tw/osm.planet/pbf/planet-160725.osm.pbf
 111     osmconvert planet-160725.osm.pbf -B=test/testdb/testdb.polys -o=testdb.pbf
 112
 113 Before importing make sure to add the following to your local settings:
 114
 115     @define('CONST_Database_DSN', 'pgsql://@/test_api_nominatim');
 116     @define('CONST_Wikipedia_Data_Path', CONST_BasePath.'/test/testdb');
 117
 118 ### Indexing Tests (`test/bdd/db`)
 119
 120 These tests check the import and update of the Nominatim database. They do not
 121 test the correctness of osm2pgsql. Each test will write some data into the `place`
 122 table (and optionally `the planet_osm_*` tables if required) and then run
 123 Nominatim's processing functions on that.
 124
 125 These tests need to create their own test databases. By default they will be
 126 called `test_template_nominatim` and `test_nominatim`. Names can be changed with
 127 the environment variables `TEMPLATE_DB` and `TEST_DB`. The user running the tests
 128 needs superuser rights for postgres.
 129
 130 ### Import Tests (`test/bdd/osm2pgsql`)
 131
 132 These tests check that data is imported correctly into the place table. They
 133 use the same template database as the Indexing tests, so the same remarks apply.