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