]> git.openstreetmap.org Git - nominatim.git/blob - docs/develop/Development-Environment.md
updates to admin and develop documentation
[nominatim.git] / docs / develop / Development-Environment.md
1 # Setting up Nominatim for Development
2
3 This chapter gives an overview how to set up Nominatim for developement
4 and how to run tests.
5
6 !!! Important
7     This guide assumes that you develop under the latest version of Ubuntu. You
8     can of course also use your favourite distribution. You just might have to
9     adapt the commands below slightly, in particular the commands for installing
10     additional software.
11
12 ## Installing Nominatim
13
14 The first step is to install Nominatim itself. Please follow the installation
15 instructions in the [Admin section](../admin/Installation.md). You don't need
16 to set up a webserver for development, the webserver that is included with PHP
17 is sufficient.
18
19 If you want to run Nominatim in a VM via Vagrant, use the default `ubuntu` setup.
20 Vagrant's libvirt provider runs out-of-the-box under Ubuntu. You also need to
21 install an NFS daemon to enable directory sharing between host and guest. The
22 following packages should get you started:
23
24     sudo apt install vagrant vagrant-libvirt libvirt-daemon nfs-kernel-server
25
26 ## Prerequisites for testing and documentation
27
28 The Nominatim test suite consists of behavioural tests (using behave) and
29 unit tests (using PHPUnit). It has the following additional requirements:
30
31 * [behave test framework](https://behave.readthedocs.io) >= 1.2.5
32 * [nose](https://nose.readthedocs.io)
33 * [phpunit](https://phpunit.de) >= 7.3
34 * [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)
35
36 The documentation is built with mkdocs:
37
38 * [mkdocs](https://www.mkdocs.org/) >= 1.1.2
39
40 ### Installing prerequisites on Ubuntu/Debian
41
42 Some of the Python packages require the newest version which is not yet
43 available with the current distributions. Therefore it is recommended to
44 install pip to get the newest versions.
45
46 To install all necessary packages run:
47
48 ```sh
49 sudo apt install php-cgi phpunit php-codesniffer \
50                  python3-pip python3-setuptools python3-dev
51
52 pip3 install --user behave nose mkdocs
53 ```
54
55 The `mkdocs` executable will be located in `.local/bin`. You may have to add
56 this directory to your path, for example by running:
57
58 ```
59 echo 'export PATH=~/.local/bin:$PATH' > ~/.profile
60 ```
61
62 If your distribution does not have PHPUnit 7.3+, you can install it (as well
63 as CodeSniffer) via composer:
64
65 ```
66 sudo apt-get install composer
67 composer global require "squizlabs/php_codesniffer=*"
68 composer global require "phpunit/phpunit=8.*"
69 ```
70
71 The binaries are found in `.config/composer/vendor/bin`. You need to add this
72 to your PATH as well:
73
74 ```
75 echo 'export PATH=~/.config/composer/vendor/bin:$PATH' > ~/.profile
76 ```
77
78
79 ## Executing Tests
80
81 All tests are located in the `\test` directory.
82
83 ### Preparing the test database
84
85 Some of the behavioural test expect a test database to be present. You need at
86 least 2GB RAM and 10GB disk space to create the database.
87
88 First create a separate directory for the test DB and fetch the test planet
89 data and the Tiger data for South Dakota:
90
91 ```
92 mkdir testdb
93 cd testdb
94 wget https://www.nominatim.org/data/test/nominatim-api-testdata.pbf
95 wget -O - https://nominatim.org/data/tiger2018-nominatim-preprocessed.tar.gz | tar xz --wildcards --no-anchored '46*'
96 ```
97
98 Configure and build Nominatim in the usual way:
99
100 ```
101 cmake $USERNAME/Nominatim
102 make
103 ```
104
105 Copy the test settings:
106
107 ```
108 cp $USERNAME/Nominatim/test/testdb/local.php settings/
109 ```
110
111 Inspect the file to check that all settings are correct for your local setup.
112
113 Now you can import the test database:
114
115 ```
116 dropdb --if-exists test_api_nominatim
117 ./utils/setup.php --all --osm-file nominatim-api-testdb.pbf 2>&1 | tee import.log
118 ./utils/specialphrases.php --wiki-import | psql -d test_api_nominatim 2>&1 | tee -a import.log
119 ./utils/setup.php --import-tiger-data 2>&1 | tee -a import.log
120 ```
121
122 ### Running the tests
123
124 To run all tests just go to the test directory and run make:
125
126 ```sh
127 cd test
128 make
129 ```
130
131 To skip tests that require the test database, run `make no-test-db` instead.
132
133 For more information about the structure of the tests and how to change and
134 extend the test suite, see the [Testing chapter](Testing.md).
135
136 ## Documentation Pages
137
138 The [Nominatim documentation](https://nominatim.org/release-docs/develop/) is
139 built using the [MkDocs](https://www.mkdocs.org/) static site generation
140 framework. The master branch is automatically deployed every night on
141 [https://nominatim.org/release-docs/develop/](https://nominatim.org/release-docs/develop/)
142
143 To build the documentation, go to the build directory and run
144
145 ```
146 make doc
147 INFO - Cleaning site directory
148 INFO - Building documentation to directory: /home/vagrant/build/site-html
149 ```
150
151 This runs `mkdocs build` plus extra transformation of some files and adds
152 symlinks (see `CMakeLists.txt` for the exact steps).
153
154 Now you can start webserver for local testing
155
156 ```
157 build> mkdocs serve
158 [server:296] Serving on http://127.0.0.1:8000
159 [handlers:62] Start watching changes
160 ```
161
162 If you develop inside a Vagrant virtual machine, use a port that is forwarded
163 to your host:
164
165 ```
166 build> mkdocs serve --dev-addr 0.0.0.0:8088
167 [server:296] Serving on http://0.0.0.0:8088
168 [handlers:62] Start watching changes
169 ```