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 * [mkdocs-gen-files](https://oprypin.github.io/mkdocs-gen-files/)
  53
  54 Please be aware that tests always run against the globally installed
  55 osm2pgsql, so you need to have this set up. If you want to test against
  56 the vendored version of osm2pgsql, you need to set the PATH accordingly.
  57
  58 ### Installing prerequisites on Ubuntu/Debian
  59
  60 The Python tools should always be run with the most recent version.
  61 In particular, pylint tends to have a lot of breaking changes between versions.
  62 The easiest way, to handle these Python dependencies is to run your
  63 development from within a virtual environment.
  64
  65 ```sh
  66 sudo apt install libsqlite3-mod-spatialite php-cli
  67 ```
  68
  69 To set up the virtual environment with all necessary packages run:
  70
  71 ```sh
  72 virtualenv ~/nominatim-dev-venv
  73 ~/nominatim-dev-venv/bin/pip install\
  74     psutil psycopg[binary] PyICU SQLAlchemy \
  75     python-dotenv jinja2 pyYAML datrie behave \
  76     mkdocs mkdocstrings mkdocs-gen-files pytest pytest-asyncio pylint \
  77     types-jinja2 types-markupsafe types-psutil types-psycopg2 \
  78     types-pygments types-pyyaml types-requests types-ujson \
  79     types-urllib3 typing-extensions unicorn falcon starlette \
  80     uvicorn mypy osmium aiosqlite
  81 ```
  82
  83 Now enter the virtual environment whenever you want to develop:
  84
  85 ```sh
  86 . ~/nominatim-dev-venv/bin/activate
  87 ```
  88
  89 For installing the PHP development tools, run:
  90
  91 ```sh
  92 sudo apt install php-cgi phpunit php-codesniffer
  93 ```
  94
  95 If your distribution does not have PHPUnit 7.3+, you can install it (as well
  96 as CodeSniffer) via composer:
  97
  98 ```
  99 sudo apt-get install composer
 100 composer global require "squizlabs/php_codesniffer=*"
 101 composer global require "phpunit/phpunit=8.*"
 102 ```
 103
 104 The binaries are found in `.config/composer/vendor/bin`. You need to add this
 105 to your PATH:
 106
 107 ```
 108 echo 'export PATH=~/.config/composer/vendor/bin:$PATH' > ~/.profile
 109 ```
 110
 111 ### Running Nominatim during development
 112
 113 The source code for Nominatim can be found in the `src` directory and can
 114 be run in-place. The source directory features a special script
 115 `nominatim-cli.py` which does the same as the installed 'nominatim' binary
 116 but executes against the code in the source tree. For example:
 117
 118 ```
 119 me@machine:~$ cd Nominatim
 120 me@machine:~Nominatim$ ./nominatim-cli.py --version
 121 Nominatim version 4.4.99-1
 122 ```
 123
 124 Make sure you have activated the virtual environment holding all
 125 necessary dependencies.
 126
 127 ## Executing Tests
 128
 129 All tests are located in the `/test` directory.
 130
 131 To run all tests, run make from the source root:
 132
 133 ```sh
 134 make tests
 135 ```
 136
 137 There are also make targets for executing only parts of the test suite.
 138 For example to run linting only use:
 139
 140 ```sh
 141 make lint
 142 ```
 143
 144 The possible testing targets are: mypy, lint, pytest, bdd.
 145
 146 For more information about the structure of the tests and how to change and
 147 extend the test suite, see the [Testing chapter](Testing.md).
 148
 149 ## Documentation Pages
 150
 151 The [Nominatim documentation](https://nominatim.org/release-docs/develop/) is
 152 built using the [MkDocs](https://www.mkdocs.org/) static site generation
 153 framework. The master branch is automatically deployed every night on
 154 [https://nominatim.org/release-docs/develop/](https://nominatim.org/release-docs/develop/)
 155
 156 To build the documentation run
 157
 158 ```
 159 make doc
 160 ```
 161
 162
 163 For local testing, you can start webserver:
 164
 165 ```
 166 build> make serve-doc
 167 [server:296] Serving on http://127.0.0.1:8000
 168 [handlers:62] Start watching changes
 169 ```
 170
 171 If you develop inside a Vagrant virtual machine, use a port that is forwarded
 172 to your host:
 173
 174 ```
 175 build> mkdocs serve --dev-addr 0.0.0.0:8088
 176 [server:296] Serving on http://0.0.0.0:8088
 177 [handlers:62] Start watching changes
 178 ```