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