]> git.openstreetmap.org Git - nominatim.git/blob - CMakeLists.txt
Cleaned tests of exceptions and fix phrase_settings.json test file name.
[nominatim.git] / CMakeLists.txt
1 #-----------------------------------------------------------------------------
2 #
3 #  CMake Config
4 #
5 #  Nominatim
6 #
7 #-----------------------------------------------------------------------------
8
9 cmake_minimum_required(VERSION 3.0 FATAL_ERROR)
10 list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
11
12
13 #-----------------------------------------------------------------------------
14 #
15 #  Project version
16 #
17 #-----------------------------------------------------------------------------
18
19 project(nominatim)
20
21 set(NOMINATIM_VERSION_MAJOR 3)
22 set(NOMINATIM_VERSION_MINOR 6)
23 set(NOMINATIM_VERSION_PATCH 0)
24
25 set(NOMINATIM_VERSION "${NOMINATIM_VERSION_MAJOR}.${NOMINATIM_VERSION_MINOR}.${NOMINATIM_VERSION_PATCH}")
26
27 add_definitions(-DNOMINATIM_VERSION="${NOMINATIM_VERSION}")
28
29
30 #-----------------------------------------------------------------------------
31 #  Configuration
32 #-----------------------------------------------------------------------------
33
34 set(BUILD_IMPORTER on CACHE BOOL "Build everything for importing/updating the database")
35 set(BUILD_API on CACHE BOOL "Build everything for the API server")
36 set(BUILD_MODULE on CACHE BOOL "Build PostgreSQL module")
37 set(BUILD_TESTS on CACHE BOOL "Build test suite")
38 set(BUILD_DOCS on CACHE BOOL "Build documentation")
39 set(BUILD_MANPAGE on CACHE BOOL "Build Manual Page")
40 set(BUILD_OSM2PGSQL on CACHE BOOL "Build osm2pgsql (expert only)")
41
42 #-----------------------------------------------------------------------------
43 #  osm2pgsql (imports/updates only)
44 #-----------------------------------------------------------------------------
45
46 if (BUILD_IMPORTER AND BUILD_OSM2PGSQL)
47     if (NOT EXISTS "${CMAKE_SOURCE_DIR}/osm2pgsql/CMakeLists.txt")
48         message(FATAL_ERROR "The osm2pgsql directory is empty.\
49         Did you forget to check out Nominatim recursively?\
50         \nTry updating submodules with: git submodule update --init")
51     endif()
52     set(BUILD_TESTS_SAVED "${BUILD_TESTS}")
53     set(BUILD_TESTS off)
54     set(WITH_LUA off CACHE BOOL "")
55     add_subdirectory(osm2pgsql)
56     set(BUILD_TESTS ${BUILD_TESTS_SAVED})
57 endif()
58
59
60 #-----------------------------------------------------------------------------
61 #  python (imports/updates only)
62 #-----------------------------------------------------------------------------
63
64 if (BUILD_IMPORTER)
65     find_package(PythonInterp 3.5 REQUIRED)
66 endif()
67
68 #-----------------------------------------------------------------------------
69 # PHP
70 #-----------------------------------------------------------------------------
71
72 # Setting PHP binary variable as to command line (prevailing) or auto detect
73
74 if (BUILD_API OR BUILD_IMPORTER)
75     if (NOT PHP_BIN)
76          find_program (PHP_BIN php)
77     endif()
78     # sanity check if PHP binary exists
79     if (NOT EXISTS ${PHP_BIN})
80         message(FATAL_ERROR "PHP binary not found. Install php or provide location with -DPHP_BIN=/path/php ")
81     else()
82         message (STATUS "Using PHP binary " ${PHP_BIN})
83     endif()
84     if (NOT PHPCGI_BIN)
85         find_program (PHPCGI_BIN php-cgi)
86     endif()
87     # sanity check if PHP binary exists
88     if (NOT EXISTS ${PHPCGI_BIN})
89         message(WARNING "php-cgi binary not found. nominatim tool will not provide query functions.")
90         set (PHPCGI_BIN "")
91     else()
92         message (STATUS "Using php-cgi binary " ${PHPCGI_BIN})
93     endif()
94 endif()
95
96 #-----------------------------------------------------------------------------
97 # import scripts and utilities (importer only)
98 #-----------------------------------------------------------------------------
99
100 if (BUILD_IMPORTER)
101    find_file(COUNTRY_GRID_FILE country_osm_grid.sql.gz
102              PATHS ${PROJECT_SOURCE_DIR}/data
103              NO_DEFAULT_PATH
104              DOC "Location of the country grid file."
105             )
106
107    if (NOT COUNTRY_GRID_FILE)
108        message(FATAL_ERROR "\nYou need to download the country_osm_grid first:\n"
109                            "    wget -O ${PROJECT_SOURCE_DIR}/data/country_osm_grid.sql.gz https://www.nominatim.org/data/country_grid.sql.gz")
110    endif()
111
112    set(CUSTOMSCRIPTS
113        check_import_finished.php
114        country_languages.php
115        export.php
116        query.php
117        setup.php
118        update.php
119        warm.php
120       )
121
122    foreach (script_source ${CUSTOMSCRIPTS})
123        configure_file(${PROJECT_SOURCE_DIR}/cmake/script.tmpl
124                       ${PROJECT_BINARY_DIR}/utils/${script_source})
125    endforeach()
126
127    configure_file(${PROJECT_SOURCE_DIR}/cmake/tool.tmpl
128                   ${PROJECT_BINARY_DIR}/nominatim)
129 endif()
130
131 #-----------------------------------------------------------------------------
132 # Tests
133 #-----------------------------------------------------------------------------
134
135 if (BUILD_TESTS)
136     include(CTest)
137
138     set(TEST_BDD db osm2pgsql api)
139
140     find_program(PYTHON_BEHAVE behave)
141     find_program(PYLINT NAMES pylint3 pylint)
142     find_program(PYTEST NAMES pytest py.test-3 py.test)
143     find_program(PHPCS phpcs)
144     find_program(PHPUNIT phpunit)
145
146     if (PYTHON_BEHAVE)
147         message(STATUS "Using Python behave binary ${PYTHON_BEHAVE}")
148         foreach (test ${TEST_BDD})
149             add_test(NAME bdd_${test}
150                      COMMAND ${PYTHON_BEHAVE} ${test}
151                      WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/bdd)
152             set_tests_properties(bdd_${test}
153                 PROPERTIES ENVIRONMENT "NOMINATIM_DIR=${PROJECT_BINARY_DIR}")
154         endforeach()
155     else()
156         message(WARNING "behave not found. BDD tests disabled." )
157     endif()
158
159     if (PHPUNIT)
160         message(STATUS "Using phpunit binary ${PHPUNIT}")
161         add_test(NAME php
162                  COMMAND ${PHPUNIT} ./
163                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/php)
164     else()
165         message(WARNING "phpunit not found. PHP unit tests disabled." )
166     endif()
167
168     if (PHPCS)
169         message(STATUS "Using phpcs binary ${PHPCS}")
170         add_test(NAME phpcs
171                  COMMAND ${PHPCS} --report-width=120 --colors lib website utils
172                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
173     else()
174         message(WARNING "phpcs not found. PHP linting tests disabled." )
175     endif()
176
177     if (PYLINT)
178         message(STATUS "Using pylint binary ${PYLINT}")
179         add_test(NAME pylint
180                  COMMAND ${PYLINT} nominatim
181                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
182     else()
183         message(WARNING "pylint not found. Python linting tests disabled.")
184     endif()
185
186     if (PYTEST)
187         message(STATUS "Using pytest binary ${PYTEST}")
188         add_test(NAME pytest
189                  COMMAND ${PYTEST} test/python
190                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
191     else()
192         message(WARNING "pytest not found. Python tests disabled." )
193     endif()
194 endif()
195
196 #-----------------------------------------------------------------------------
197 # Postgres module
198 #-----------------------------------------------------------------------------
199
200 if (BUILD_MODULE)
201     add_subdirectory(module)
202 endif()
203
204 #-----------------------------------------------------------------------------
205 # Documentation
206 #-----------------------------------------------------------------------------
207
208 if (BUILD_DOCS)
209    add_subdirectory(docs)
210 endif()
211
212 #-----------------------------------------------------------------------------
213 # Manual page
214 #-----------------------------------------------------------------------------
215
216 if (BUILD_MANPAGE)
217    add_subdirectory(manual)
218 endif()
219
220 #-----------------------------------------------------------------------------
221 # Installation
222 #-----------------------------------------------------------------------------
223
224
225 include(GNUInstallDirs)
226 set(NOMINATIM_DATADIR ${CMAKE_INSTALL_FULL_DATADIR}/${PROJECT_NAME})
227 set(NOMINATIM_LIBDIR ${CMAKE_INSTALL_FULL_LIBDIR}/${PROJECT_NAME})
228 set(NOMINATIM_CONFIGDIR ${CMAKE_INSTALL_FULL_SYSCONFDIR}/${PROJECT_NAME})
229
230 if (BUILD_IMPORTER)
231     configure_file(${PROJECT_SOURCE_DIR}/cmake/tool-installed.tmpl installed.bin)
232     install(PROGRAMS ${PROJECT_BINARY_DIR}/installed.bin
233             DESTINATION ${CMAKE_INSTALL_BINDIR}
234             RENAME nominatim)
235
236     install(DIRECTORY nominatim
237             DESTINATION ${NOMINATIM_LIBDIR}/lib-python
238             FILES_MATCHING PATTERN "*.py"
239             PATTERN __pycache__ EXCLUDE)
240     install(DIRECTORY lib-sql DESTINATION ${NOMINATIM_LIBDIR})
241
242     install(FILES data/country_name.sql
243                   ${COUNTRY_GRID_FILE}
244                   data/words.sql
245             DESTINATION ${NOMINATIM_DATADIR})
246 endif()
247
248 if (BUILD_OSM2PGSQL)
249     if (${CMAKE_VERSION} VERSION_LESS 3.13)
250         # Installation of subdirectory targets was only introduced in 3.13.
251         # So just copy the osm2pgsql file for older versions.
252         install(PROGRAMS ${PROJECT_BINARY_DIR}/osm2pgsql/osm2pgsql
253                 DESTINATION ${NOMINATIM_LIBDIR})
254     else()
255         install(TARGETS osm2pgsql RUNTIME DESTINATION ${NOMINATIM_LIBDIR})
256     endif()
257 endif()
258
259 if (BUILD_MODULE)
260     install(PROGRAMS ${PROJECT_BINARY_DIR}/module/nominatim.so
261             DESTINATION ${NOMINATIM_LIBDIR}/module)
262 endif()
263
264 if (BUILD_API)
265     install(DIRECTORY lib-php DESTINATION ${NOMINATIM_LIBDIR})
266 endif()
267
268 install(FILES settings/env.defaults
269               settings/address-levels.json
270               settings/phrase-settings.json
271               settings/import-admin.style
272               settings/import-street.style
273               settings/import-address.style
274               settings/import-full.style
275               settings/import-extratags.style
276         DESTINATION ${NOMINATIM_CONFIGDIR})