CMakeLists.txt

   1 #-----------------------------------------------------------------------------
   2 #
   3 #  CMake Config
   4 #
   5 #  Nominatim
   6 #
   7 #-----------------------------------------------------------------------------
   8
   9 cmake_minimum_required(VERSION 2.8 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 and pyosmium (imports/updates only)
  61 #-----------------------------------------------------------------------------
  62
  63 if (BUILD_IMPORTER)
  64     find_package(PythonInterp 3.5 REQUIRED)
  65
  66     find_program(PYOSMIUM pyosmium-get-changes)
  67     if (NOT EXISTS "${PYOSMIUM}")
  68         set(PYOSMIUM_PATH "")
  69             message(WARNING "pyosmium-get-changes not found (required for updates)")
  70     else()
  71         set(PYOSMIUM_PATH "${PYOSMIUM}")
  72         message(STATUS "Using pyosmium-get-changes at ${PYOSMIUM_PATH}")
  73     endif()
  74 endif()
  75
  76 #-----------------------------------------------------------------------------
  77 # PHP
  78 #-----------------------------------------------------------------------------
  79
  80 # Setting PHP binary variable as to command line (prevailing) or auto detect
  81
  82 if (BUILD_API OR BUILD_IMPORTER)
  83     if (NOT PHP_BIN)
  84          find_program (PHP_BIN php)
  85     endif()
  86     # sanity check if PHP binary exists
  87     if (NOT EXISTS ${PHP_BIN})
  88         message(FATAL_ERROR "PHP binary not found. Install php or provide location with -DPHP_BIN=/path/php ")
  89     else()
  90         message (STATUS "Using PHP binary " ${PHP_BIN})
  91     endif()
  92     if (NOT PHPCGI_BIN)
  93         find_program (PHPCGI_BIN php-cgi)
  94     endif()
  95     # sanity check if PHP binary exists
  96     if (NOT EXISTS ${PHPCGI_BIN})
  97         message(WARNING "php-cgi binary not found. nominatim tool will not provide query functions.")
  98         set (PHPCGI_BIN "")
  99     else()
 100         message (STATUS "Using php-cgi binary " ${PHPCGI_BIN})
 101     endif()
 102 endif()
 103
 104 #-----------------------------------------------------------------------------
 105 # import scripts and utilities (importer only)
 106 #-----------------------------------------------------------------------------
 107
 108 if (BUILD_IMPORTER)
 109    set(CUSTOMSCRIPTS
 110        check_import_finished.php
 111        country_languages.php
 112        export.php
 113        query.php
 114        setup.php
 115        specialphrases.php
 116        update.php
 117        warm.php
 118       )
 119
 120    foreach (script_source ${CUSTOMSCRIPTS})
 121        configure_file(${PROJECT_SOURCE_DIR}/cmake/script.tmpl
 122                       ${PROJECT_BINARY_DIR}/utils/${script_source})
 123    endforeach()
 124
 125    configure_file(${PROJECT_SOURCE_DIR}/cmake/tool.tmpl
 126                   ${PROJECT_BINARY_DIR}/nominatim)
 127 endif()
 128
 129 #-----------------------------------------------------------------------------
 130 # Targets for running a development webserver from the build directory.
 131 #-----------------------------------------------------------------------------
 132
 133 if (BUILD_API)
 134    add_custom_target(serve
 135            php -S 127.0.0.1:8088
 136            WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/website
 137    )
 138
 139    add_custom_target(serve-global
 140            php -S 0.0.0.0:8088
 141            WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/website
 142    )
 143 endif()
 144
 145 #-----------------------------------------------------------------------------
 146 # Tests
 147 #-----------------------------------------------------------------------------
 148
 149 if (BUILD_TESTS)
 150     include(CTest)
 151
 152     set(TEST_BDD db osm2pgsql api)
 153
 154     find_program(PYTHON_BEHAVE behave)
 155     find_program(PYLINT NAMES pylint3 pylint)
 156     find_program(PYTEST NAMES pytest py.test-3 py.test)
 157     find_program(PHPCS phpcs)
 158     find_program(PHPUNIT phpunit)
 159
 160     if (PYTHON_BEHAVE)
 161         message(STATUS "Using Python behave binary ${PYTHON_BEHAVE}")
 162         foreach (test ${TEST_BDD})
 163             add_test(NAME bdd_${test}
 164                      COMMAND ${PYTHON_BEHAVE} ${test}
 165                      WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/bdd)
 166             set_tests_properties(bdd_${test}
 167                 PROPERTIES ENVIRONMENT "NOMINATIM_DIR=${PROJECT_BINARY_DIR}")
 168         endforeach()
 169     else()
 170         message(WARNING "behave not found. BDD tests disabled." )
 171     endif()
 172
 173     if (PHPUNIT)
 174         message(STATUS "Using phpunit binary ${PHPUNIT}")
 175         add_test(NAME php
 176                  COMMAND ${PHPUNIT} ./
 177                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/test/php)
 178     else()
 179         message(WARNING "phpunit not found. PHP unit tests disabled." )
 180     endif()
 181
 182     if (PHPCS)
 183         message(STATUS "Using phpcs binary ${PHPCS}")
 184         add_test(NAME phpcs
 185                  COMMAND ${PHPCS} --report-width=120 --colors lib website utils
 186                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 187     else()
 188         message(WARNING "phpcs not found. PHP linting tests disabled." )
 189     endif()
 190
 191     if (PYLINT)
 192         message(STATUS "Using pylint binary ${PYLINT}")
 193         add_test(NAME pylint
 194                  COMMAND ${PYLINT} --extension-pkg-whitelist=osmium nominatim
 195                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 196     else()
 197         message(WARNING "pylint not found. Python linting tests disabled.")
 198     endif()
 199
 200     if (PYTEST)
 201         message(STATUS "Using pytest binary ${PYTEST}")
 202         add_test(NAME pytest
 203                  COMMAND ${PYTEST} test/python
 204                  WORKING_DIRECTORY ${PROJECT_SOURCE_DIR})
 205     else()
 206         message(WARNING "pytest not found. Python tests disabled." )
 207     endif()
 208 endif()
 209
 210 #-----------------------------------------------------------------------------
 211 # Postgres module
 212 #-----------------------------------------------------------------------------
 213
 214 if (BUILD_MODULE)
 215     add_subdirectory(module)
 216 endif()
 217
 218 #-----------------------------------------------------------------------------
 219 # Documentation
 220 #-----------------------------------------------------------------------------
 221
 222 if (BUILD_DOCS)
 223    add_subdirectory(docs)
 224 endif()