From 47fb2c9126c0731deb00ddeb22049302ea55bf6e Mon Sep 17 00:00:00 2001 From: Sarah Hoffmann Date: Sun, 26 Apr 2020 14:17:21 +0200 Subject: [PATCH] cmake: restructure splitting between modules Make a clear distinction between parts used for the importer and parts used for the API. --- CMakeLists.txt | 136 ++++++++++++++++++++++++++------------------ docs/CMakeLists.txt | 36 +++++++++--- 2 files changed, 109 insertions(+), 63 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 31a572d6..ae611885 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -28,29 +28,39 @@ add_definitions(-DNOMINATIM_VERSION="${NOMINATIM_VERSION}") #----------------------------------------------------------------------------- -# -# Find external dependencies -# +# Configuration #----------------------------------------------------------------------------- -set(BUILD_TESTS off CACHE BOOL "Build test suite" FORCE) -set(WITH_LUA off CACHE BOOL "Build with lua support" FORCE) -set(BUILD_DOCS on CACHE BOOL "Build documentation") -set(BUILD_SERVER on CACHE BOOL "Build API server") +set(BUILD_IMPORTER on CACHE BOOL "Build everything for importing/updating the database") +set(BUILD_API on CACHE BOOL "Build everything for the API server") set(BUILD_MODULE on CACHE BOOL "Build PostgreSQL module") -set(BUILD_NOMINATIM on CACHE BOOL "Build Nominatim executable") -set(BUILD_OSM2PGSQL on CACHE BOOL "Build osm2pgsql") - -if (BUILD_SERVER) - if (BUILD_OSM2PGSQL) - if (NOT EXISTS "${CMAKE_SOURCE_DIR}/osm2pgsql/CMakeLists.txt") - message(FATAL_ERROR "The osm2pgsql directory is empty.\ - Did you forget to check out Nominatim recursively?\ - \nTry updating submodules with: git submodule update --init") - endif() - add_subdirectory(osm2pgsql) +set(BUILD_TESTS on CACHE BOOL "Build test suite") +set(BUILD_DOCS on CACHE BOOL "Build documentation") +set(BUILD_OSM2PGSQL on CACHE BOOL "Build osm2pgsql (expert only)") + +#----------------------------------------------------------------------------- +# osm2pgsql (imports/updates only) +#----------------------------------------------------------------------------- + +if (BUILD_IMPORTER AND BUILD_OSM2PGSQL) + if (NOT EXISTS "${CMAKE_SOURCE_DIR}/osm2pgsql/CMakeLists.txt") + message(FATAL_ERROR "The osm2pgsql directory is empty.\ + Did you forget to check out Nominatim recursively?\ + \nTry updating submodules with: git submodule update --init") endif() + set(BUILD_TESTS_SAVED "${BUILD_TESTS}") + set(BUILD_TESTS off) + set(WITH_LUA off CACHE BOOL "") + add_subdirectory(osm2pgsql) + set(BUILD_TESTS ${BUILD_TESTS_SAVED}) +endif() + + +#----------------------------------------------------------------------------- +# python and pyosmium (imports/updates only) +#----------------------------------------------------------------------------- +if (BUILD_IMPORTER) find_package(PythonInterp 3) find_program(PYOSMIUM pyosmium-get-changes) @@ -61,37 +71,28 @@ if (BUILD_SERVER) set(PYOSMIUM_PATH "${PYOSMIUM}") message(STATUS "Using pyosmium-get-changes at ${PYOSMIUM_PATH}") endif() +endif() + +#----------------------------------------------------------------------------- +# PHP +#----------------------------------------------------------------------------- +# Setting PHP binary variable as to command line (prevailing) or auto detect - # Setting PHP binary variable as to command line (prevailing) or auto detect - if (NOT PHP_BIN) - find_program (PHP_BIN php) - endif() - # sanity check if PHP binary exists - if (NOT EXISTS ${PHP_BIN}) - message(FATAL_ERROR "PHP binary not found. Install php or provide location with -DPHP_BIN=/path/php ") - endif() - message (STATUS "Using PHP binary " ${PHP_BIN}) +if (NOT PHP_BIN) + find_program (PHP_BIN php) +endif() +# sanity check if PHP binary exists +if (NOT EXISTS ${PHP_BIN}) + message(FATAL_ERROR "PHP binary not found. Install php or provide location with -DPHP_BIN=/path/php ") endif() +message (STATUS "Using PHP binary " ${PHP_BIN}) #----------------------------------------------------------------------------- -# -# Setup settings and paths -# +# import scripts and utilities (importer only) #----------------------------------------------------------------------------- -if (BUILD_SERVER) - set(WEBSITESCRIPTS - website/deletable.php - website/details.php - website/hierarchy.php - website/lookup.php - website/polygons.php - website/reverse.php - website/search.php - website/status.php - ) - +if (BUILD_IMPORTER) set(CUSTOMSCRIPTS utils/country_languages.php utils/importWikipedia.php @@ -107,15 +108,29 @@ if (BUILD_SERVER) configure_file(${PROJECT_SOURCE_DIR}/cmake/script.tmpl ${PROJECT_BINARY_DIR}/${script_source}) endforeach() +endif() + +#----------------------------------------------------------------------------- +# webserver scripts (API only) +#----------------------------------------------------------------------------- + +if (BUILD_API) + set(WEBSITESCRIPTS + website/deletable.php + website/details.php + website/hierarchy.php + website/lookup.php + website/polygons.php + website/reverse.php + website/search.php + website/status.php + ) foreach (script_source ${WEBSITESCRIPTS}) configure_file(${PROJECT_SOURCE_DIR}/cmake/website.tmpl ${PROJECT_BINARY_DIR}/${script_source}) endforeach() - configure_file(${PROJECT_SOURCE_DIR}/settings/defaults.php - ${PROJECT_BINARY_DIR}/settings/settings.php) - set(WEBPATHS css images js) foreach (wp ${WEBPATHS}) @@ -126,9 +141,14 @@ if (BUILD_SERVER) endif() #----------------------------------------------------------------------------- -# +# default settings +#----------------------------------------------------------------------------- + +configure_file(${PROJECT_SOURCE_DIR}/settings/defaults.php + ${PROJECT_BINARY_DIR}/settings/settings.php) + +#----------------------------------------------------------------------------- # Tests -# #----------------------------------------------------------------------------- if (BUILD_TESTS) @@ -138,27 +158,33 @@ if (BUILD_TESTS) foreach (test ${TEST_BDD}) add_test(NAME bdd_${test} - COMMAND lettuce features/${test} - WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/tests) + COMMAND behave ${test} + WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/bdd) set_tests_properties(bdd_${test} PROPERTIES ENVIRONMENT "NOMINATIM_DIR=${PROJECT_BINARY_DIR}") endforeach() add_test(NAME php COMMAND phpunit ./ - WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/tests-php) + WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/php) + + add_test(NAME phpcs + COMMAND phpcs --report-width=120 --colors lib website utils + WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}) endif() +#----------------------------------------------------------------------------- +# Postgres module #----------------------------------------------------------------------------- if (BUILD_MODULE) add_subdirectory(module) endif() -if (BUILD_NOMINATIM) - add_subdirectory(nominatim) -endif() + +#----------------------------------------------------------------------------- +# Documentation +#----------------------------------------------------------------------------- + if (BUILD_DOCS) add_subdirectory(docs) endif() - -#----------------------------------------------------------------------------- diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index bdba63db..2735733a 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -7,19 +7,39 @@ configure_file(mkdocs.yml ../mkdocs.yml) file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/appendix) file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/data-sources) -ADD_CUSTOM_TARGET(doc - COMMAND ${CMAKE_COMMAND} -E create_symlink ${CMAKE_CURRENT_SOURCE_DIR}/admin ${CMAKE_CURRENT_BINARY_DIR}/admin - COMMAND ${CMAKE_COMMAND} -E create_symlink ${CMAKE_CURRENT_SOURCE_DIR}/develop ${CMAKE_CURRENT_BINARY_DIR}/develop - COMMAND ${CMAKE_COMMAND} -E create_symlink ${CMAKE_CURRENT_SOURCE_DIR}/api ${CMAKE_CURRENT_BINARY_DIR}/api - COMMAND ${CMAKE_COMMAND} -E create_symlink ${CMAKE_CURRENT_SOURCE_DIR}/index.md ${CMAKE_CURRENT_BINARY_DIR}/index.md - COMMAND ${CMAKE_COMMAND} -E create_symlink ${CMAKE_CURRENT_SOURCE_DIR}/extra.css ${CMAKE_CURRENT_BINARY_DIR}/extra.css - COMMAND ${CMAKE_COMMAND} -E create_symlink ${CMAKE_CURRENT_SOURCE_DIR}/styles.css ${CMAKE_CURRENT_BINARY_DIR}/styles.css - COMMAND ${CMAKE_COMMAND} -E create_symlink ${CMAKE_CURRENT_SOURCE_DIR}/data-sources/overview.md ${CMAKE_CURRENT_BINARY_DIR}/data-sources/overview.md +set (DOC_SOURCES + admin + develop + api + index.md + extra.css + styles.css + data-sources/overview.md + ) + +foreach (src ${DOC_SOURCES}) + execute_process( + COMMAND ${CMAKE_COMMAND} -E create_symlink ${CMAKE_CURRENT_SOURCE_DIR}/${src} ${CMAKE_CURRENT_BINARY_DIR}/${src} + ) +endforeach() + +execute_process( COMMAND ${CMAKE_COMMAND} -E create_symlink ${PROJECT_SOURCE_DIR}/data-sources/us-tiger/README.md ${CMAKE_CURRENT_BINARY_DIR}/data-sources/US-Tiger.md +) +execute_process( COMMAND ${CMAKE_COMMAND} -E create_symlink ${PROJECT_SOURCE_DIR}/data-sources/gb-postcodes/README.md ${CMAKE_CURRENT_BINARY_DIR}/data-sources/GB-Postcodes.md +) +execute_process( COMMAND ${CMAKE_COMMAND} -E create_symlink ${PROJECT_SOURCE_DIR}/data-sources/country-grid/README.md ${CMAKE_CURRENT_BINARY_DIR}/data-sources/Country-Grid.md +) +execute_process( COMMAND ${CMAKE_COMMAND} -E create_symlink ${PROJECT_SOURCE_DIR}/data-sources/country-grid/mexico.quad.png ${CMAKE_CURRENT_BINARY_DIR}/data-sources/mexico.quad.png +) +execute_process( COMMAND ${CMAKE_COMMAND} -E create_symlink ${PROJECT_SOURCE_DIR}/data-sources/wikipedia-wikidata/README.md ${CMAKE_CURRENT_BINARY_DIR}/data-sources/Wikipedia-Wikidata.md +) + +ADD_CUSTOM_TARGET(doc COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/bash2md.sh ${PROJECT_SOURCE_DIR}/vagrant/Install-on-Centos-7.sh ${CMAKE_CURRENT_BINARY_DIR}/appendix/Install-on-Centos-7.md COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/bash2md.sh ${PROJECT_SOURCE_DIR}/vagrant/Install-on-Ubuntu-16.sh ${CMAKE_CURRENT_BINARY_DIR}/appendix/Install-on-Ubuntu-16.md COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/bash2md.sh ${PROJECT_SOURCE_DIR}/vagrant/Install-on-Ubuntu-18.sh ${CMAKE_CURRENT_BINARY_DIR}/appendix/Install-on-Ubuntu-18.md -- 2.39.5