on: [ push, pull_request ]
jobs:
+ create-archive:
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ submodules: true
+
+ - uses: actions/cache@v4
+ with:
+ path: |
+ data/country_osm_grid.sql.gz
+ key: nominatim-country-data-1
+
+ - name: Package tarball
+ run: |
+ if [ ! -f data/country_osm_grid.sql.gz ]; then
+ wget --no-verbose -O data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz
+ fi
+ cd ..
+ tar czf nominatim-src.tar.bz2 Nominatim
+ mv nominatim-src.tar.bz2 Nominatim
+
+ - name: 'Upload Artifact'
+ uses: actions/upload-artifact@v4
+ with:
+ name: full-source
+ path: nominatim-src.tar.bz2
+ retention-days: 1
+
tests:
+ needs: create-archive
strategy:
matrix:
- ubuntu: [18, 20]
+ flavour: ["ubuntu-20", "ubuntu-24"]
include:
- - ubuntu: 18
- postgresql: 9.5
- postgis: 2.5
- pytest: pytest
- - ubuntu: 20
- postgresql: 13
+ - flavour: ubuntu-20
+ ubuntu: 20
+ postgresql: 12
postgis: 3
- pytest: py.test-3
+ lua: '5.1'
+ - flavour: ubuntu-24
+ ubuntu: 24
+ postgresql: 17
+ postgis: 3
+ lua: '5.3'
runs-on: ubuntu-${{ matrix.ubuntu }}.04
steps:
- - uses: actions/checkout@v2
+ - uses: actions/download-artifact@v4
with:
- submodules: true
- path: Nominatim
+ name: full-source
- - name: Setup PHP
- uses: shivammathur/setup-php@v2
- with:
- php-version: '7.4'
- tools: phpunit, phpcs, composer
+ - name: Unpack Nominatim
+ run: tar xf nominatim-src.tar.bz2
- - uses: actions/setup-python@v2
+ - uses: actions/setup-python@v5
with:
- python-version: 3.6
- if: matrix.ubuntu == 18
-
- - name: Get Date
- id: get-date
- run: |
- echo "::set-output name=date::$(/bin/date -u "+%Y%W")"
- shell: bash
-
- - uses: actions/cache@v2
- with:
- path: |
- country_grid.sql.gz
- key: nominatim-country-data-${{ steps.get-date.outputs.date }}
+ python-version: 3.7
+ if: matrix.flavour == 'oldstuff'
- uses: ./Nominatim/.github/actions/setup-postgresql
with:
- uses: ./Nominatim/.github/actions/build-nominatim
with:
- ubuntu: ${{ matrix.ubuntu }}
+ flavour: ${{ matrix.flavour }}
+ lua: ${{ matrix.lua }}
- - name: Install test prerequsites
- run: sudo apt-get install -y -qq php-codesniffer pylint python3-pytest python3-behave python3-pytest-cov php-codecoverage php-xdebug
- if: matrix.ubuntu == 20
+ - name: Install test prerequisites
+ run: pip3 install behave==1.2.6
- - name: Install test prerequsites
- run: |
- sudo apt-get install -y -qq php-codesniffer php-codecoverage php-xdebug
- pip3 install pylint==2.6.0 pytest pytest-cov behave==1.2.6
- if: matrix.ubuntu == 18
+ - name: Install test prerequisites
+ run: sudo apt-get install -y -qq python3-pytest python3-pytest-asyncio uvicorn
- - name: PHP linting
- run: phpcs --report-width=120 .
- working-directory: Nominatim
+ - name: Install newer pytest-asyncio
+ run: pip3 install -U pytest-asyncio
+ if: matrix.flavour == 'ubuntu-20'
+
+ - name: Install Python webservers
+ run: pip3 install falcon starlette asgi_lifespan
+
+ - name: Install latest flake8
+ run: pip3 install -U flake8
- name: Python linting
- run: pylint nominatim
+ run: python3 -m flake8 src
working-directory: Nominatim
- - name: PHP unit tests
- run: phpunit --coverage-clover ../../coverage-php.xml ./
- working-directory: Nominatim/test/php
-
- name: Python unit tests
- run: $PYTEST --cov=nominatim --cov-report=xml test/python
+ run: python3 -m pytest test/python
working-directory: Nominatim
- env:
- PYTEST: ${{ matrix.pytest }}
- name: BDD tests
run: |
- mkdir cov
- behave -DREMOVE_TEMPLATE=1 -DBUILDDIR=$GITHUB_WORKSPACE/build --format=progress3 -DPHPCOV=./cov
- composer require phpunit/phpcov:7.0.2
- vendor/bin/phpcov merge --clover ../../coverage-bdd.xml ./cov
+ export PATH=$GITHUB_WORKSPACE/build/osm2pgsql:$PATH
+ python3 -m behave -DREMOVE_TEMPLATE=1 --format=progress3
working-directory: Nominatim/test/bdd
- - name: BDD tests (legacy_icu tokenizer)
- run: |
- behave -DREMOVE_TEMPLATE=1 -DBUILDDIR=$GITHUB_WORKSPACE/build -DTOKENIZER=legacy_icu --format=progress3
- working-directory: Nominatim/test/bdd
+ - name: Install mypy and typechecking info
+ run: pip3 install -U mypy osmium uvicorn types-PyYAML types-jinja2 types-psycopg2 types-psutil types-requests types-ujson types-Pygments typing-extensions
+
+ - name: Python static typechecking
+ run: python3 -m mypy --strict --python-version 3.8 src
+ working-directory: Nominatim
+
+ install:
+ runs-on: ubuntu-latest
+ needs: create-archive
- - name: Upload coverage to Codecov
- uses: codecov/codecov-action@v1
- with:
- files: ./Nominatim/coverage*.xml
- directory: ./
- name: codecov-umbrella
- fail_ci_if_error: false
- path_to_write_report: ./coverage/codecov_report.txt
- verbose: true
-
- import:
strategy:
matrix:
- ubuntu: [18, 20]
+ name: [Ubuntu-22, Ubuntu-24]
include:
- - ubuntu: 18
- postgresql: 9.5
- postgis: 2.5
- - ubuntu: 20
- postgresql: 13
- postgis: 3
-
- runs-on: ubuntu-${{ matrix.ubuntu }}.04
+ - name: Ubuntu-22
+ image: "ubuntu:22.04"
+ ubuntu: 22
+ install_mode: install-apache
+ - name: Ubuntu-24
+ image: "ubuntu:24.04"
+ ubuntu: 24
+ install_mode: install-apache
+
+ container:
+ image: ${{ matrix.image }}
+ env:
+ LANG: en_US.UTF-8
+
+ defaults:
+ run:
+ shell: sudo -Hu nominatim bash --noprofile --norc -eo pipefail {0}
steps:
- - uses: actions/checkout@v2
- with:
- submodules: true
- path: Nominatim
+ - name: Prepare container (Ubuntu)
+ run: |
+ export APT_LISTCHANGES_FRONTEND=none
+ export DEBIAN_FRONTEND=noninteractive
+ apt-get update -qq
+ apt-get install -y git sudo wget
+ ln -snf /usr/share/zoneinfo/$CONTAINER_TIMEZONE /etc/localtime && echo $CONTAINER_TIMEZONE > /etc/timezone
+ shell: bash
- - name: Get Date
- id: get-date
+ - name: Setup import user
run: |
- echo "::set-output name=date::$(/bin/date -u "+%Y%W")"
+ useradd -m nominatim
+ echo 'nominatim ALL=(ALL:ALL) NOPASSWD: ALL' > /etc/sudoers.d/nominiatim
+ echo "/home/nominatim/Nominatim/vagrant/Install-on-${OS}.sh no $INSTALL_MODE" > /home/nominatim/vagrant.sh
shell: bash
+ env:
+ OS: ${{ matrix.name }}
+ INSTALL_MODE: ${{ matrix.install_mode }}
- - uses: actions/cache@v2
+ - uses: actions/download-artifact@v4
with:
- path: |
- country_grid.sql.gz
- key: nominatim-country-data-${{ steps.get-date.outputs.date }}
+ name: full-source
+ path: /home/nominatim
- - uses: actions/cache@v2
- with:
- path: |
- monaco-latest.osm.pbf
- key: nominatim-test-data-${{ steps.get-date.outputs.date }}
+ - name: Install Nominatim
+ run: |
+ export USERNAME=nominatim
+ export USERHOME=/home/nominatim
+ export NOSYSTEMD=yes
+ export HAVE_SELINUX=no
+ tar xf nominatim-src.tar.bz2
+ . vagrant.sh
+ working-directory: /home/nominatim
- - uses: actions/setup-python@v2
- with:
- python-version: 3.6
- if: matrix.ubuntu == 18
+ - name: Prepare import environment
+ run: |
+ mv Nominatim/test/testdb/apidb-test-data.pbf test.pbf
+ mv Nominatim/settings/flex-base.lua flex-base.lua
+ mv Nominatim/settings/import-extratags.lua import-extratags.lua
+ mv Nominatim/settings/taginfo.lua taginfo.lua
+ rm -rf Nominatim
+ mkdir data-env-reverse
+ working-directory: /home/nominatim
+
+ - name: Add nominatim to path
+ run: |
+ sudo ln -s /home/nominatim/nominatim-venv/bin/nominatim /usr/local/bin/nominatim
+ if: matrix.ubuntu == 24
- - uses: ./Nominatim/.github/actions/setup-postgresql
- with:
- postgresql-version: ${{ matrix.postgresql }}
- postgis-version: ${{ matrix.postgis }}
- - uses: ./Nominatim/.github/actions/build-nominatim
- with:
- ubuntu: ${{ matrix.ubuntu }}
+ - name: Need lua binary
+ run: |
+ sudo apt-get install -y lua5.4 lua-dkjson
+ if: matrix.ubuntu == 24
- - name: Clean installation
- run: rm -rf Nominatim build
- shell: bash
+ - name: Print version
+ run: nominatim --version
+ working-directory: /home/nominatim/nominatim-project
- - name: Prepare import environment
- run: |
- if [ ! -f monaco-latest.osm.pbf ]; then
- wget --no-verbose https://download.geofabrik.de/europe/monaco-latest.osm.pbf
- fi
- mkdir data-env
- cd data-env
- shell: bash
+ - name: Print taginfo
+ run: lua taginfo.lua
+ working-directory: /home/nominatim
+
+ - name: Collect host OS information
+ run: nominatim admin --collect-os-info
+ working-directory: /home/nominatim/nominatim-project
- name: Import
- run: nominatim import --osm-file ../monaco-latest.osm.pbf
- shell: bash
- working-directory: data-env
+ run: nominatim import --osm-file ../test.pbf
+ working-directory: /home/nominatim/nominatim-project
- name: Import special phrases
run: nominatim special-phrases --import-from-wiki
- working-directory: data-env
+ working-directory: /home/nominatim/nominatim-project
- name: Check full import
run: nominatim admin --check-database
- working-directory: data-env
+ working-directory: /home/nominatim/nominatim-project
- name: Warm up database
run: nominatim admin --warm
- working-directory: data-env
+ working-directory: /home/nominatim/nominatim-project
+
+ - name: Prepare update (Ubuntu)
+ run: apt-get install -y python3-pip
+ shell: bash
+
+ - name: Install osmium (Ubuntu 22)
+ run: |
+ pip3 install --user osmium
+ if: matrix.ubuntu == 22
+
+ - name: Install osmium (Ubuntu 24)
+ run: |
+ /home/nominatim/nominatim-venv/bin/pip install osmium
+ if: matrix.ubuntu == 24
- name: Run update
run: |
- nominatim replication --init
- nominatim replication --once
- working-directory: data-env
+ nominatim replication --init
+ NOMINATIM_REPLICATION_MAX_DIFF=1 nominatim replication --once
+ working-directory: /home/nominatim/nominatim-project
+
+ - name: Clean up database
+ run: nominatim refresh --postcodes --word-tokens
+ working-directory: /home/nominatim/nominatim-project
- name: Run reverse-only import
- run : nominatim import --osm-file ../monaco-latest.osm.pbf --reverse-only --no-updates
- working-directory: data-env
- env:
- NOMINATIM_DATABASE_DSN: pgsql:dbname=reverse
+ run : |
+ echo 'NOMINATIM_DATABASE_DSN="pgsql:dbname=reverse"' >> .env
+ nominatim import --osm-file ../test.pbf --reverse-only --no-updates
+ working-directory: /home/nominatim/data-env-reverse
- - name: Check reverse import
+ - name: Check reverse-only import
run: nominatim admin --check-database
- working-directory: data-env
+ working-directory: /home/nominatim/data-env-reverse
+
+ - name: Clean up database (reverse-only import)
+ run: nominatim refresh --postcodes --word-tokens
+ working-directory: /home/nominatim/nominatim-project
+
+ install-no-superuser:
+ runs-on: ubuntu-latest
+ needs: create-archive
+
+ steps:
+ - uses: actions/download-artifact@v4
+ with:
+ name: full-source
+
+ - name: Unpack Nominatim
+ run: tar xf nominatim-src.tar.bz2
+
+ - uses: ./Nominatim/.github/actions/setup-postgresql
+ with:
+ postgresql-version: 16
+ postgis-version: 3
+
+ - uses: ./Nominatim/.github/actions/build-nominatim
+ with:
+ flavour: ubuntu-22
+ lua: 5.3
+
+ - name: Prepare import environment
+ run: |
+ mv Nominatim/test/testdb/apidb-test-data.pbf test.pbf
+ rm -rf Nominatim
+
+ - name: Prepare Database
+ run: |
+ nominatim import --prepare-database
+
+ - name: Create import user
+ run: |
+ sudo -u postgres createuser osm-import
+ psql -d nominatim -c "ALTER USER \"osm-import\" WITH PASSWORD 'osm-import'"
+ psql -d nominatim -c 'GRANT CREATE ON SCHEMA public TO "osm-import"'
+
+ - name: Run import
+ run: |
+ NOMINATIM_DATABASE_DSN="pgsql:host=127.0.0.1;dbname=nominatim;user=osm-import;password=osm-import" nominatim import --continue import-from-file --osm-file test.pbf
+
+ - name: Check full import
+ run: nominatim admin --check-database
+
+ migrate:
+ runs-on: ubuntu-24.04
+ needs: create-archive
+
+ steps:
+ - uses: actions/download-artifact@v4
+ with:
+ name: full-source
+
+ - name: Unpack Nominatim
+ run: tar xf nominatim-src.tar.bz2
+
+ - uses: ./Nominatim/.github/actions/setup-postgresql
+ with:
+ postgresql-version: 17
+ postgis-version: 3
+
+ - name: Install Python dependencies
+ run: |
+ sudo apt-get install --no-install-recommends virtualenv osm2pgsql
+
+ - name: Install Nominatim master version
+ run: |
+ virtualenv master
+ cd Nominatim
+ ../master/bin/pip install packaging/nominatim-db
+
+ - name: Install Nominatim from pypi
+ run: |
+ virtualenv release
+ ./release/bin/pip install nominatim-db
+
+ - name: Import Nominatim database using release
+ run: |
+ ./release/bin/nominatim import --osm-file Nominatim/test/testdb/apidb-test-data.pbf
+ ./release/bin/nominatim add-data --file Nominatim/test/testdb/additional_api_test.data.osm
+
+ - name: Migrate to master version
+ run: |
+ ./master/bin/nominatim admin --migrate
+ ./release/bin/nominatim add-data --file Nominatim/test/testdb/additional_api_test.data.osm
+
+ codespell:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: codespell-project/actions-codespell@v2
+ with:
+ only_warn: 1