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 pytest). It has the following additional requirements:
  30
  31 * [behave test framework](https://behave.readthedocs.io) >= 1.2.6
  32 * [Pylint](https://pylint.org/) (CI always runs the latest version from pip)
  33 * [mypy](http://mypy-lang.org/) (plus typing information for external libs)
  34 * [Python Typing Extensions](https://github.com/python/typing_extensions) (for Python < 3.9)
  35 * [pytest](https://pytest.org)
  36 * [pytest-asyncio](https://pytest-asyncio.readthedocs.io)
  37
  38 For testing the Python search frontend, you need to install extra dependencies
  39 depending on your choice of webserver framework:
  40
  41 * [httpx](https://www.python-httpx.org/) (Starlette only)
  42 * [asgi-lifespan](https://github.com/florimondmanca/asgi-lifespan) (Starlette only)
  43
  44 The documentation is built with mkdocs:
  45
  46 * [mkdocs](https://www.mkdocs.org/) >= 1.1.2
  47 * [mkdocstrings](https://mkdocstrings.github.io/) >= 0.25
  48 * [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)
  49 * [mkdocs-gen-files](https://oprypin.github.io/mkdocs-gen-files/)
  50
  51 Please be aware that tests always run against the globally installed
  52 osm2pgsql, so you need to have this set up. If you want to test against
  53 the vendored version of osm2pgsql, you need to set the PATH accordingly.
  54
  55 ### Installing prerequisites on Ubuntu/Debian
  56
  57 The Python tools should always be run with the most recent version.
  58 In particular, pylint tends to have a lot of breaking changes between versions.
  59 The easiest way, to handle these Python dependencies is to run your
  60 development from within a virtual environment.
  61
  62 ```sh
  63 sudo apt install libsqlite3-mod-spatialite
  64 ```
  65
  66 To set up the virtual environment with all necessary packages run:
  67
  68 ```sh
  69 virtualenv ~/nominatim-dev-venv
  70 ~/nominatim-dev-venv/bin/pip install\
  71     psutil psycopg[binary] PyICU SQLAlchemy \
  72     python-dotenv jinja2 pyYAML datrie behave \
  73     mkdocs mkdocstrings mkdocs-gen-files pytest pytest-asyncio pylint \
  74     types-jinja2 types-markupsafe types-psutil types-psycopg2 \
  75     types-pygments types-pyyaml types-requests types-ujson \
  76     types-urllib3 typing-extensions unicorn falcon starlette \
  77     uvicorn mypy osmium aiosqlite
  78 ```
  79
  80 Now enter the virtual environment whenever you want to develop:
  81
  82 ```sh
  83 . ~/nominatim-dev-venv/bin/activate
  84 ```
  85
  86 ### Running Nominatim during development
  87
  88 The source code for Nominatim can be found in the `src` directory and can
  89 be run in-place. The source directory features a special script
  90 `nominatim-cli.py` which does the same as the installed 'nominatim' binary
  91 but executes against the code in the source tree. For example:
  92
  93 ```
  94 me@machine:~$ cd Nominatim
  95 me@machine:~Nominatim$ ./nominatim-cli.py --version
  96 Nominatim version 4.4.99-1
  97 ```
  98
  99 Make sure you have activated the virtual environment holding all
 100 necessary dependencies.
 101
 102 ## Executing Tests
 103
 104 All tests are located in the `/test` directory.
 105
 106 To run all tests, run make from the source root:
 107
 108 ```sh
 109 make tests
 110 ```
 111
 112 There are also make targets for executing only parts of the test suite.
 113 For example to run linting only use:
 114
 115 ```sh
 116 make lint
 117 ```
 118
 119 The possible testing targets are: mypy, lint, pytest, bdd.
 120
 121 For more information about the structure of the tests and how to change and
 122 extend the test suite, see the [Testing chapter](Testing.md).
 123
 124 ## Documentation Pages
 125
 126 The [Nominatim documentation](https://nominatim.org/release-docs/develop/) is
 127 built using the [MkDocs](https://www.mkdocs.org/) static site generation
 128 framework. The master branch is automatically deployed every night on
 129 [https://nominatim.org/release-docs/develop/](https://nominatim.org/release-docs/develop/)
 130
 131 To build the documentation run
 132
 133 ```
 134 make doc
 135 ```
 136
 137
 138 For local testing, you can start webserver:
 139
 140 ```
 141 build> make serve-doc
 142 [server:296] Serving on http://127.0.0.1:8000
 143 [handlers:62] Start watching changes
 144 ```
 145
 146 If you develop inside a Vagrant virtual machine, use a port that is forwarded
 147 to your host:
 148
 149 ```
 150 build> mkdocs serve --dev-addr 0.0.0.0:8088
 151 [server:296] Serving on http://0.0.0.0:8088
 152 [handlers:62] Start watching changes
 153 ```