CMakeLists.txt revision 12391
112037Sandreas.sandberg@arm.com# CMakeLists.txt -- Build system for the pybind11 test suite 212037Sandreas.sandberg@arm.com# 312037Sandreas.sandberg@arm.com# Copyright (c) 2015 Wenzel Jakob <wenzel@inf.ethz.ch> 412037Sandreas.sandberg@arm.com# 512037Sandreas.sandberg@arm.com# All rights reserved. Use of this source code is governed by a 612037Sandreas.sandberg@arm.com# BSD-style license that can be found in the LICENSE file. 712037Sandreas.sandberg@arm.com 812037Sandreas.sandberg@arm.comcmake_minimum_required(VERSION 2.8.12) 912037Sandreas.sandberg@arm.com 1012037Sandreas.sandberg@arm.comoption(PYBIND11_WERROR "Report all warnings as errors" OFF) 1112037Sandreas.sandberg@arm.com 1212037Sandreas.sandberg@arm.comif (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) 1312037Sandreas.sandberg@arm.com # We're being loaded directly, i.e. not via add_subdirectory, so make this 1412037Sandreas.sandberg@arm.com # work as its own project and load the pybind11Config to get the tools we need 1512391Sjason@lowepower.com project(pybind11_tests CXX) 1612037Sandreas.sandberg@arm.com 1712037Sandreas.sandberg@arm.com find_package(pybind11 REQUIRED CONFIG) 1812037Sandreas.sandberg@arm.comendif() 1912037Sandreas.sandberg@arm.com 2011986Sandreas.sandberg@arm.comif(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) 2111986Sandreas.sandberg@arm.com message(STATUS "Setting tests build type to MinSizeRel as none was specified") 2211986Sandreas.sandberg@arm.com set(CMAKE_BUILD_TYPE MinSizeRel CACHE STRING "Choose the type of build." FORCE) 2311986Sandreas.sandberg@arm.com set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" 2411986Sandreas.sandberg@arm.com "MinSizeRel" "RelWithDebInfo") 2511986Sandreas.sandberg@arm.comendif() 2611986Sandreas.sandberg@arm.com 2711986Sandreas.sandberg@arm.com# Full set of test files (you can override these; see below) 2811986Sandreas.sandberg@arm.comset(PYBIND11_TEST_FILES 2911986Sandreas.sandberg@arm.com test_buffers.cpp 3012391Sjason@lowepower.com test_builtin_casters.cpp 3112391Sjason@lowepower.com test_call_policies.cpp 3211986Sandreas.sandberg@arm.com test_callbacks.cpp 3311986Sandreas.sandberg@arm.com test_chrono.cpp 3412391Sjason@lowepower.com test_class.cpp 3511986Sandreas.sandberg@arm.com test_constants_and_functions.cpp 3612391Sjason@lowepower.com test_copy_move.cpp 3711986Sandreas.sandberg@arm.com test_docstring_options.cpp 3811986Sandreas.sandberg@arm.com test_eigen.cpp 3911986Sandreas.sandberg@arm.com test_enum.cpp 4011986Sandreas.sandberg@arm.com test_eval.cpp 4111986Sandreas.sandberg@arm.com test_exceptions.cpp 4212391Sjason@lowepower.com test_factory_constructors.cpp 4312391Sjason@lowepower.com test_iostream.cpp 4411986Sandreas.sandberg@arm.com test_kwargs_and_defaults.cpp 4512391Sjason@lowepower.com test_local_bindings.cpp 4611986Sandreas.sandberg@arm.com test_methods_and_attributes.cpp 4711986Sandreas.sandberg@arm.com test_modules.cpp 4811986Sandreas.sandberg@arm.com test_multiple_inheritance.cpp 4911986Sandreas.sandberg@arm.com test_numpy_array.cpp 5011986Sandreas.sandberg@arm.com test_numpy_dtypes.cpp 5111986Sandreas.sandberg@arm.com test_numpy_vectorize.cpp 5211986Sandreas.sandberg@arm.com test_opaque_types.cpp 5311986Sandreas.sandberg@arm.com test_operator_overloading.cpp 5411986Sandreas.sandberg@arm.com test_pickling.cpp 5512391Sjason@lowepower.com test_pytypes.cpp 5611986Sandreas.sandberg@arm.com test_sequences_and_iterators.cpp 5711986Sandreas.sandberg@arm.com test_smart_ptr.cpp 5812391Sjason@lowepower.com test_stl.cpp 5911986Sandreas.sandberg@arm.com test_stl_binders.cpp 6011986Sandreas.sandberg@arm.com test_virtual_functions.cpp 6111986Sandreas.sandberg@arm.com) 6211986Sandreas.sandberg@arm.com 6311986Sandreas.sandberg@arm.com# Invoking cmake with something like: 6412391Sjason@lowepower.com# cmake -DPYBIND11_TEST_OVERRIDE="test_callbacks.cpp;test_picking.cpp" .. 6511986Sandreas.sandberg@arm.com# lets you override the tests that get compiled and run. You can restore to all tests with: 6611986Sandreas.sandberg@arm.com# cmake -DPYBIND11_TEST_OVERRIDE= .. 6711986Sandreas.sandberg@arm.comif (PYBIND11_TEST_OVERRIDE) 6811986Sandreas.sandberg@arm.com set(PYBIND11_TEST_FILES ${PYBIND11_TEST_OVERRIDE}) 6911986Sandreas.sandberg@arm.comendif() 7011986Sandreas.sandberg@arm.com 7111986Sandreas.sandberg@arm.comstring(REPLACE ".cpp" ".py" PYBIND11_PYTEST_FILES "${PYBIND11_TEST_FILES}") 7211986Sandreas.sandberg@arm.com 7312391Sjason@lowepower.com# Contains the set of test files that require pybind11_cross_module_tests to be 7412391Sjason@lowepower.com# built; if none of these are built (i.e. because TEST_OVERRIDE is used and 7512391Sjason@lowepower.com# doesn't include them) the second module doesn't get built. 7612391Sjason@lowepower.comset(PYBIND11_CROSS_MODULE_TESTS 7712391Sjason@lowepower.com test_exceptions.py 7812391Sjason@lowepower.com test_local_bindings.py 7912391Sjason@lowepower.com test_stl.py 8012391Sjason@lowepower.com test_stl_binders.py 8112391Sjason@lowepower.com) 8212391Sjason@lowepower.com 8311986Sandreas.sandberg@arm.com# Check if Eigen is available; if not, remove from PYBIND11_TEST_FILES (but 8411986Sandreas.sandberg@arm.com# keep it in PYBIND11_PYTEST_FILES, so that we get the "eigen is not installed" 8511986Sandreas.sandberg@arm.com# skip message). 8611986Sandreas.sandberg@arm.comlist(FIND PYBIND11_TEST_FILES test_eigen.cpp PYBIND11_TEST_FILES_EIGEN_I) 8711986Sandreas.sandberg@arm.comif(PYBIND11_TEST_FILES_EIGEN_I GREATER -1) 8812037Sandreas.sandberg@arm.com # Try loading via newer Eigen's Eigen3Config first (bypassing tools/FindEigen3.cmake). 8912037Sandreas.sandberg@arm.com # Eigen 3.3.1+ exports a cmake 3.0+ target for handling dependency requirements, but also 9012037Sandreas.sandberg@arm.com # produces a fatal error if loaded from a pre-3.0 cmake. 9112037Sandreas.sandberg@arm.com if (NOT CMAKE_VERSION VERSION_LESS 3.0) 9212037Sandreas.sandberg@arm.com find_package(Eigen3 QUIET CONFIG) 9312037Sandreas.sandberg@arm.com if (EIGEN3_FOUND) 9412037Sandreas.sandberg@arm.com if (EIGEN3_VERSION_STRING AND NOT EIGEN3_VERSION_STRING VERSION_LESS 3.3.1) 9512037Sandreas.sandberg@arm.com set(PYBIND11_EIGEN_VIA_TARGET 1) 9612037Sandreas.sandberg@arm.com endif() 9712037Sandreas.sandberg@arm.com endif() 9812037Sandreas.sandberg@arm.com endif() 9912037Sandreas.sandberg@arm.com if (NOT EIGEN3_FOUND) 10012037Sandreas.sandberg@arm.com # Couldn't load via target, so fall back to allowing module mode finding, which will pick up 10112037Sandreas.sandberg@arm.com # tools/FindEigen3.cmake 10212037Sandreas.sandberg@arm.com find_package(Eigen3 QUIET) 10312037Sandreas.sandberg@arm.com endif() 10411986Sandreas.sandberg@arm.com 10511986Sandreas.sandberg@arm.com if(EIGEN3_FOUND) 10612037Sandreas.sandberg@arm.com # Eigen 3.3.1+ cmake sets EIGEN3_VERSION_STRING (and hard codes the version when installed 10712037Sandreas.sandberg@arm.com # rather than looking it up in the cmake script); older versions, and the 10812037Sandreas.sandberg@arm.com # tools/FindEigen3.cmake, set EIGEN3_VERSION instead. 10912037Sandreas.sandberg@arm.com if(NOT EIGEN3_VERSION AND EIGEN3_VERSION_STRING) 11012037Sandreas.sandberg@arm.com set(EIGEN3_VERSION ${EIGEN3_VERSION_STRING}) 11112037Sandreas.sandberg@arm.com endif() 11211986Sandreas.sandberg@arm.com message(STATUS "Building tests with Eigen v${EIGEN3_VERSION}") 11311986Sandreas.sandberg@arm.com else() 11411986Sandreas.sandberg@arm.com list(REMOVE_AT PYBIND11_TEST_FILES ${PYBIND11_TEST_FILES_EIGEN_I}) 11511986Sandreas.sandberg@arm.com message(STATUS "Building tests WITHOUT Eigen") 11611986Sandreas.sandberg@arm.com endif() 11711986Sandreas.sandberg@arm.comendif() 11811986Sandreas.sandberg@arm.com 11912391Sjason@lowepower.com# Optional dependency for some tests (boost::variant is only supported with version >= 1.56) 12012391Sjason@lowepower.comfind_package(Boost 1.56) 12112391Sjason@lowepower.com 12212037Sandreas.sandberg@arm.com# Compile with compiler warnings turned on 12312037Sandreas.sandberg@arm.comfunction(pybind11_enable_warnings target_name) 12412037Sandreas.sandberg@arm.com if(MSVC) 12512037Sandreas.sandberg@arm.com target_compile_options(${target_name} PRIVATE /W4) 12612037Sandreas.sandberg@arm.com else() 12712037Sandreas.sandberg@arm.com target_compile_options(${target_name} PRIVATE -Wall -Wextra -Wconversion -Wcast-qual) 12812037Sandreas.sandberg@arm.com endif() 12912037Sandreas.sandberg@arm.com 13012037Sandreas.sandberg@arm.com if(PYBIND11_WERROR) 13112037Sandreas.sandberg@arm.com if(MSVC) 13212037Sandreas.sandberg@arm.com target_compile_options(${target_name} PRIVATE /WX) 13312037Sandreas.sandberg@arm.com else() 13412037Sandreas.sandberg@arm.com target_compile_options(${target_name} PRIVATE -Werror) 13512037Sandreas.sandberg@arm.com endif() 13612037Sandreas.sandberg@arm.com endif() 13712037Sandreas.sandberg@arm.comendfunction() 13812037Sandreas.sandberg@arm.com 13912391Sjason@lowepower.comset(test_targets pybind11_tests) 14012037Sandreas.sandberg@arm.com 14112391Sjason@lowepower.com# Build pybind11_cross_module_tests if any test_whatever.py are being built that require it 14212391Sjason@lowepower.comforeach(t ${PYBIND11_CROSS_MODULE_TESTS}) 14312391Sjason@lowepower.com list(FIND PYBIND11_PYTEST_FILES ${t} i) 14412391Sjason@lowepower.com if (i GREATER -1) 14512391Sjason@lowepower.com list(APPEND test_targets pybind11_cross_module_tests) 14612391Sjason@lowepower.com break() 14712037Sandreas.sandberg@arm.com endif() 14812391Sjason@lowepower.comendforeach() 14911986Sandreas.sandberg@arm.com 15012037Sandreas.sandberg@arm.comset(testdir ${CMAKE_CURRENT_SOURCE_DIR}) 15112391Sjason@lowepower.comforeach(target ${test_targets}) 15212391Sjason@lowepower.com set(test_files ${PYBIND11_TEST_FILES}) 15312391Sjason@lowepower.com if(NOT target STREQUAL "pybind11_tests") 15412391Sjason@lowepower.com set(test_files "") 15512391Sjason@lowepower.com endif() 15611986Sandreas.sandberg@arm.com 15712391Sjason@lowepower.com # Create the binding library 15812391Sjason@lowepower.com pybind11_add_module(${target} THIN_LTO ${target}.cpp ${test_files} ${PYBIND11_HEADERS}) 15912391Sjason@lowepower.com pybind11_enable_warnings(${target}) 16012391Sjason@lowepower.com 16112391Sjason@lowepower.com if(MSVC) 16212391Sjason@lowepower.com target_compile_options(${target} PRIVATE /utf-8) 16312391Sjason@lowepower.com endif() 16412391Sjason@lowepower.com 16512391Sjason@lowepower.com if(EIGEN3_FOUND) 16612391Sjason@lowepower.com if (PYBIND11_EIGEN_VIA_TARGET) 16712391Sjason@lowepower.com target_link_libraries(${target} PRIVATE Eigen3::Eigen) 16812391Sjason@lowepower.com else() 16912391Sjason@lowepower.com target_include_directories(${target} PRIVATE ${EIGEN3_INCLUDE_DIR}) 17012391Sjason@lowepower.com endif() 17112391Sjason@lowepower.com target_compile_definitions(${target} PRIVATE -DPYBIND11_TEST_EIGEN) 17212391Sjason@lowepower.com endif() 17312391Sjason@lowepower.com 17412391Sjason@lowepower.com if(Boost_FOUND) 17512391Sjason@lowepower.com target_include_directories(${target} PRIVATE ${Boost_INCLUDE_DIRS}) 17612391Sjason@lowepower.com target_compile_definitions(${target} PRIVATE -DPYBIND11_TEST_BOOST) 17712391Sjason@lowepower.com endif() 17812391Sjason@lowepower.com 17912391Sjason@lowepower.com # Always write the output file directly into the 'tests' directory (even on MSVC) 18012391Sjason@lowepower.com if(NOT CMAKE_LIBRARY_OUTPUT_DIRECTORY) 18112391Sjason@lowepower.com set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${testdir}) 18212391Sjason@lowepower.com foreach(config ${CMAKE_CONFIGURATION_TYPES}) 18312391Sjason@lowepower.com string(TOUPPER ${config} config) 18412391Sjason@lowepower.com set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY_${config} ${testdir}) 18512391Sjason@lowepower.com endforeach() 18612391Sjason@lowepower.com endif() 18712391Sjason@lowepower.comendforeach() 18811986Sandreas.sandberg@arm.com 18911986Sandreas.sandberg@arm.com# Make sure pytest is found or produce a fatal error 19011986Sandreas.sandberg@arm.comif(NOT PYBIND11_PYTEST_FOUND) 19112037Sandreas.sandberg@arm.com execute_process(COMMAND ${PYTHON_EXECUTABLE} -c "import pytest; print(pytest.__version__)" 19212037Sandreas.sandberg@arm.com RESULT_VARIABLE pytest_not_found OUTPUT_VARIABLE pytest_version ERROR_QUIET) 19312037Sandreas.sandberg@arm.com if(pytest_not_found) 19412037Sandreas.sandberg@arm.com message(FATAL_ERROR "Running the tests requires pytest. Please install it manually" 19512037Sandreas.sandberg@arm.com " (try: ${PYTHON_EXECUTABLE} -m pip install pytest)") 19612037Sandreas.sandberg@arm.com elseif(pytest_version VERSION_LESS 3.0) 19712037Sandreas.sandberg@arm.com message(FATAL_ERROR "Running the tests requires pytest >= 3.0. Found: ${pytest_version}" 19812037Sandreas.sandberg@arm.com "Please update it (try: ${PYTHON_EXECUTABLE} -m pip install -U pytest)") 19911986Sandreas.sandberg@arm.com endif() 20011986Sandreas.sandberg@arm.com set(PYBIND11_PYTEST_FOUND TRUE CACHE INTERNAL "") 20111986Sandreas.sandberg@arm.comendif() 20211986Sandreas.sandberg@arm.com 20312391Sjason@lowepower.comif(CMAKE_VERSION VERSION_LESS 3.2) 20412391Sjason@lowepower.com set(PYBIND11_USES_TERMINAL "") 20512391Sjason@lowepower.comelse() 20612391Sjason@lowepower.com set(PYBIND11_USES_TERMINAL "USES_TERMINAL") 20712391Sjason@lowepower.comendif() 20812391Sjason@lowepower.com 20911986Sandreas.sandberg@arm.com# A single command to compile and run the tests 21012037Sandreas.sandberg@arm.comadd_custom_target(pytest COMMAND ${PYTHON_EXECUTABLE} -m pytest ${PYBIND11_PYTEST_FILES} 21112391Sjason@lowepower.com DEPENDS ${test_targets} WORKING_DIRECTORY ${testdir} ${PYBIND11_USES_TERMINAL}) 21211986Sandreas.sandberg@arm.com 21311986Sandreas.sandberg@arm.comif(PYBIND11_TEST_OVERRIDE) 21411986Sandreas.sandberg@arm.com add_custom_command(TARGET pytest POST_BUILD 21511986Sandreas.sandberg@arm.com COMMAND ${CMAKE_COMMAND} -E echo "Note: not all tests run: -DPYBIND11_TEST_OVERRIDE is in effect") 21611986Sandreas.sandberg@arm.comendif() 21711986Sandreas.sandberg@arm.com 21812037Sandreas.sandberg@arm.com# Add a check target to run all the tests, starting with pytest (we add dependencies to this below) 21912037Sandreas.sandberg@arm.comadd_custom_target(check DEPENDS pytest) 22012037Sandreas.sandberg@arm.com 22112037Sandreas.sandberg@arm.com# The remaining tests only apply when being built as part of the pybind11 project, but not if the 22212037Sandreas.sandberg@arm.com# tests are being built independently. 22312037Sandreas.sandberg@arm.comif (NOT PROJECT_NAME STREQUAL "pybind11") 22412037Sandreas.sandberg@arm.com return() 22511986Sandreas.sandberg@arm.comendif() 22611986Sandreas.sandberg@arm.com 22712391Sjason@lowepower.com# Add a post-build comment to show the primary test suite .so size and, if a previous size, compare it: 22811986Sandreas.sandberg@arm.comadd_custom_command(TARGET pybind11_tests POST_BUILD 22912037Sandreas.sandberg@arm.com COMMAND ${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/tools/libsize.py 23012037Sandreas.sandberg@arm.com $<TARGET_FILE:pybind11_tests> ${CMAKE_CURRENT_BINARY_DIR}/sosize-$<TARGET_FILE_NAME:pybind11_tests>.txt) 23112037Sandreas.sandberg@arm.com 23212391Sjason@lowepower.com# Test embedding the interpreter. Provides the `cpptest` target. 23312391Sjason@lowepower.comadd_subdirectory(test_embed) 23412391Sjason@lowepower.com 23512037Sandreas.sandberg@arm.com# Test CMake build using functions and targets from subdirectory or installed location 23612391Sjason@lowepower.comadd_subdirectory(test_cmake_build) 237