docs/develop/Development-Environment.md

   1 # Setting up Nominatim for Development
   2
   3 This chapter gives an overview how to set up Nominatim for development
   4 and how to run tests.
   5
   6 !!! Important
   7     This guide assumes you develop under the latest version of Debian/Ubuntu.
   8     You can of course also use your favourite distribution. You just might have
   9     to adapt the commands below slightly, in particular the commands for
  10     installing 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 can be started
  17 via `nominatim serve` is sufficient.
  18
  19 If you want to run Nominatim in a VM via Vagrant, use the default `ubuntu24` 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 for PHP code and pytest for Python code).
  30 It has the following additional requirements:
  31
  32 * [behave test framework](https://behave.readthedocs.io) >= 1.2.6
  33 * [phpunit](https://phpunit.de) (9.5 is known to work)
  34 * [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)
  35 * [Pylint](https://pylint.org/) (CI always runs the latest version from pip)
  36 * [mypy](http://mypy-lang.org/) (plus typing information for external libs)
  37 * [Python Typing Extensions](https://github.com/python/typing_extensions) (for Python < 3.9)
  38 * [pytest](https://pytest.org)
  39 * [pytest-asyncio](https://pytest-asyncio.readthedocs.io)
  40
  41 For testing the Python search frontend, you need to install extra dependencies
  42 depending on your choice of webserver framework:
  43
  44 * [httpx](https://www.python-httpx.org/) (Starlette only)
  45 * [asgi-lifespan](https://github.com/florimondmanca/asgi-lifespan) (Starlette only)
  46
  47 The documentation is built with mkdocs:
  48
  49 * [mkdocs](https://www.mkdocs.org/) >= 1.1.2
  50 * [mkdocstrings](https://mkdocstrings.github.io/) >= 0.25
  51 * [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)
  52
  53 Please be aware that tests always run against the globally installed
  54 osm2pgsql, so you need to have this set up. If you want to test against
  55 the vendored version of osm2pgsql, you need to set the PATH accordingly.
  56
  57 ### Installing prerequisites on Ubuntu/Debian
  58
  59 The Python tools should always be run with the most recent version.
  60 In particular, pylint tends to have a lot of breaking changes between versions.
  61 The easiest way, to handle these Python dependencies is to run your
  62 development from within a virtual environment.
  63
  64 To set up the virtual environment with all necessary packages run:
  65
  66 ```sh
  67 virtualenv ~/nominatim-dev-venv
  68 ~/nominatim-dev-venv/bin/pip install\
  69     psycopg2-binary psutil psycopg[binary] PyICU SQLAlchemy \
  70     python-dotenv jinja2 pyYAML datrie \
  71     behave mkdocs mkdocstrings pytest pytest-asyncio pylint \
  72     types-jinja2 types-markupsafe types-psutil types-psycopg2 \
  73     types-pygments types-pyyaml types-requests types-ujson \
  74     types-urllib3 typing-extensions unicorn falcon
  75 ```
  76
  77 Now enter the virtual environment whenever you want to develop:
  78
  79 ```sh
  80 . ~/nominatim-dev-venv/bin/activate
  81 ```
  82
  83 For installing the PHP development tools, run:
  84
  85 ```sh
  86 sudo apt install php-cgi phpunit php-codesniffer
  87 ```
  88
  89 If your distribution does not have PHPUnit 7.3+, you can install it (as well
  90 as CodeSniffer) via composer:
  91
  92 ```
  93 sudo apt-get install composer
  94 composer global require "squizlabs/php_codesniffer=*"
  95 composer global require "phpunit/phpunit=8.*"
  96 ```
  97
  98 The binaries are found in `.config/composer/vendor/bin`. You need to add this
  99 to your PATH:
 100
 101 ```
 102 echo 'export PATH=~/.config/composer/vendor/bin:$PATH' > ~/.profile
 103 ```
 104
 105 ### Running Nominatim during development
 106
 107 The source code for Nominatim can be found in the `src` directory and can
 108 be run in-place. The source directory features a special script
 109 `nominatim-cli.py` which does the same as the installed 'nominatim' binary
 110 but executes against the code in the source tree. For example:
 111
 112 ```
 113 me@machine:~$ cd Nominatim
 114 me@machine:~Nominatim$ ./nominatim-cli.py --version
 115 Nominatim version 4.4.99-1
 116 ```
 117
 118 Make sure you have activated the virtual environment holding all
 119 necessary dependencies.
 120
 121 ## Executing Tests
 122
 123 All tests are located in the `/test` directory.
 124
 125 To run all tests, run make from the source root:
 126
 127 ```sh
 128 make tests
 129 ```
 130
 131 There are also make targets for executing only parts of the test suite.
 132 For example to run linting only use:
 133
 134 ```sh
 135 make lint
 136 ```
 137
 138 The possible testing targets are: mypy, lint, pytest, bdd.
 139
 140 For more information about the structure of the tests and how to change and
 141 extend the test suite, see the [Testing chapter](Testing.md).
 142
 143 ## Documentation Pages
 144
 145 The [Nominatim documentation](https://nominatim.org/release-docs/develop/) is
 146 built using the [MkDocs](https://www.mkdocs.org/) static site generation
 147 framework. The master branch is automatically deployed every night on
 148 [https://nominatim.org/release-docs/develop/](https://nominatim.org/release-docs/develop/)
 149
 150 To build the documentation, go to the build directory and run
 151
 152 ```
 153 make doc
 154 INFO - Cleaning site directory
 155 INFO - Building documentation to directory: /home/vagrant/build/site-html
 156 ```
 157
 158 This runs `mkdocs build` plus extra transformation of some files and adds
 159 symlinks (see `CMakeLists.txt` for the exact steps).
 160
 161 Now you can start webserver for local testing
 162
 163 ```
 164 build> make serve-doc
 165 [server:296] Serving on http://127.0.0.1:8000
 166 [handlers:62] Start watching changes
 167 ```
 168
 169 If you develop inside a Vagrant virtual machine, use a port that is forwarded
 170 to your host:
 171
 172 ```
 173 build> PYTHONPATH=$SRCDIR mkdocs serve --dev-addr 0.0.0.0:8088
 174 [server:296] Serving on http://0.0.0.0:8088
 175 [handlers:62] Start watching changes
 176 ```