CMakeLists.txt revision 14299
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 2914299Sbbruce@ucdavis.edu test_async.cpp 3011986Sandreas.sandberg@arm.com test_buffers.cpp 3112391Sjason@lowepower.com test_builtin_casters.cpp 3212391Sjason@lowepower.com test_call_policies.cpp 3311986Sandreas.sandberg@arm.com test_callbacks.cpp 3411986Sandreas.sandberg@arm.com test_chrono.cpp 3512391Sjason@lowepower.com test_class.cpp 3611986Sandreas.sandberg@arm.com test_constants_and_functions.cpp 3712391Sjason@lowepower.com test_copy_move.cpp 3811986Sandreas.sandberg@arm.com test_docstring_options.cpp 3911986Sandreas.sandberg@arm.com test_eigen.cpp 4011986Sandreas.sandberg@arm.com test_enum.cpp 4111986Sandreas.sandberg@arm.com test_eval.cpp 4211986Sandreas.sandberg@arm.com test_exceptions.cpp 4312391Sjason@lowepower.com test_factory_constructors.cpp 4414299Sbbruce@ucdavis.edu test_gil_scoped.cpp 4512391Sjason@lowepower.com test_iostream.cpp 4611986Sandreas.sandberg@arm.com test_kwargs_and_defaults.cpp 4712391Sjason@lowepower.com test_local_bindings.cpp 4811986Sandreas.sandberg@arm.com test_methods_and_attributes.cpp 4911986Sandreas.sandberg@arm.com test_modules.cpp 5011986Sandreas.sandberg@arm.com test_multiple_inheritance.cpp 5111986Sandreas.sandberg@arm.com test_numpy_array.cpp 5211986Sandreas.sandberg@arm.com test_numpy_dtypes.cpp 5311986Sandreas.sandberg@arm.com test_numpy_vectorize.cpp 5411986Sandreas.sandberg@arm.com test_opaque_types.cpp 5511986Sandreas.sandberg@arm.com test_operator_overloading.cpp 5611986Sandreas.sandberg@arm.com test_pickling.cpp 5712391Sjason@lowepower.com test_pytypes.cpp 5811986Sandreas.sandberg@arm.com test_sequences_and_iterators.cpp 5911986Sandreas.sandberg@arm.com test_smart_ptr.cpp 6012391Sjason@lowepower.com test_stl.cpp 6111986Sandreas.sandberg@arm.com test_stl_binders.cpp 6214299Sbbruce@ucdavis.edu test_tagbased_polymorphic.cpp 6314299Sbbruce@ucdavis.edu test_union.cpp 6411986Sandreas.sandberg@arm.com test_virtual_functions.cpp 6511986Sandreas.sandberg@arm.com) 6611986Sandreas.sandberg@arm.com 6711986Sandreas.sandberg@arm.com# Invoking cmake with something like: 6812391Sjason@lowepower.com# cmake -DPYBIND11_TEST_OVERRIDE="test_callbacks.cpp;test_picking.cpp" .. 6911986Sandreas.sandberg@arm.com# lets you override the tests that get compiled and run. You can restore to all tests with: 7011986Sandreas.sandberg@arm.com# cmake -DPYBIND11_TEST_OVERRIDE= .. 7111986Sandreas.sandberg@arm.comif (PYBIND11_TEST_OVERRIDE) 7211986Sandreas.sandberg@arm.com set(PYBIND11_TEST_FILES ${PYBIND11_TEST_OVERRIDE}) 7311986Sandreas.sandberg@arm.comendif() 7411986Sandreas.sandberg@arm.com 7514299Sbbruce@ucdavis.edu# Skip test_async for Python < 3.5 7614299Sbbruce@ucdavis.edulist(FIND PYBIND11_TEST_FILES test_async.cpp PYBIND11_TEST_FILES_ASYNC_I) 7714299Sbbruce@ucdavis.eduif((PYBIND11_TEST_FILES_ASYNC_I GREATER -1) AND ("${PYTHON_VERSION_MAJOR}.${PYTHON_VERSION_MINOR}" VERSION_LESS 3.5)) 7814299Sbbruce@ucdavis.edu message(STATUS "Skipping test_async because Python version ${PYTHON_VERSION_MAJOR}.${PYTHON_VERSION_MINOR} < 3.5") 7914299Sbbruce@ucdavis.edu list(REMOVE_AT PYBIND11_TEST_FILES ${PYBIND11_TEST_FILES_ASYNC_I}) 8014299Sbbruce@ucdavis.eduendif() 8114299Sbbruce@ucdavis.edu 8211986Sandreas.sandberg@arm.comstring(REPLACE ".cpp" ".py" PYBIND11_PYTEST_FILES "${PYBIND11_TEST_FILES}") 8311986Sandreas.sandberg@arm.com 8412391Sjason@lowepower.com# Contains the set of test files that require pybind11_cross_module_tests to be 8512391Sjason@lowepower.com# built; if none of these are built (i.e. because TEST_OVERRIDE is used and 8612391Sjason@lowepower.com# doesn't include them) the second module doesn't get built. 8712391Sjason@lowepower.comset(PYBIND11_CROSS_MODULE_TESTS 8812391Sjason@lowepower.com test_exceptions.py 8912391Sjason@lowepower.com test_local_bindings.py 9012391Sjason@lowepower.com test_stl.py 9112391Sjason@lowepower.com test_stl_binders.py 9212391Sjason@lowepower.com) 9312391Sjason@lowepower.com 9414299Sbbruce@ucdavis.eduset(PYBIND11_CROSS_MODULE_GIL_TESTS 9514299Sbbruce@ucdavis.edu test_gil_scoped.py 9614299Sbbruce@ucdavis.edu) 9714299Sbbruce@ucdavis.edu 9811986Sandreas.sandberg@arm.com# Check if Eigen is available; if not, remove from PYBIND11_TEST_FILES (but 9911986Sandreas.sandberg@arm.com# keep it in PYBIND11_PYTEST_FILES, so that we get the "eigen is not installed" 10011986Sandreas.sandberg@arm.com# skip message). 10111986Sandreas.sandberg@arm.comlist(FIND PYBIND11_TEST_FILES test_eigen.cpp PYBIND11_TEST_FILES_EIGEN_I) 10211986Sandreas.sandberg@arm.comif(PYBIND11_TEST_FILES_EIGEN_I GREATER -1) 10312037Sandreas.sandberg@arm.com # Try loading via newer Eigen's Eigen3Config first (bypassing tools/FindEigen3.cmake). 10412037Sandreas.sandberg@arm.com # Eigen 3.3.1+ exports a cmake 3.0+ target for handling dependency requirements, but also 10512037Sandreas.sandberg@arm.com # produces a fatal error if loaded from a pre-3.0 cmake. 10612037Sandreas.sandberg@arm.com if (NOT CMAKE_VERSION VERSION_LESS 3.0) 10714299Sbbruce@ucdavis.edu find_package(Eigen3 3.2.7 QUIET CONFIG) 10812037Sandreas.sandberg@arm.com if (EIGEN3_FOUND) 10912037Sandreas.sandberg@arm.com if (EIGEN3_VERSION_STRING AND NOT EIGEN3_VERSION_STRING VERSION_LESS 3.3.1) 11012037Sandreas.sandberg@arm.com set(PYBIND11_EIGEN_VIA_TARGET 1) 11112037Sandreas.sandberg@arm.com endif() 11212037Sandreas.sandberg@arm.com endif() 11312037Sandreas.sandberg@arm.com endif() 11412037Sandreas.sandberg@arm.com if (NOT EIGEN3_FOUND) 11512037Sandreas.sandberg@arm.com # Couldn't load via target, so fall back to allowing module mode finding, which will pick up 11612037Sandreas.sandberg@arm.com # tools/FindEigen3.cmake 11714299Sbbruce@ucdavis.edu find_package(Eigen3 3.2.7 QUIET) 11812037Sandreas.sandberg@arm.com endif() 11911986Sandreas.sandberg@arm.com 12011986Sandreas.sandberg@arm.com if(EIGEN3_FOUND) 12112037Sandreas.sandberg@arm.com # Eigen 3.3.1+ cmake sets EIGEN3_VERSION_STRING (and hard codes the version when installed 12212037Sandreas.sandberg@arm.com # rather than looking it up in the cmake script); older versions, and the 12312037Sandreas.sandberg@arm.com # tools/FindEigen3.cmake, set EIGEN3_VERSION instead. 12412037Sandreas.sandberg@arm.com if(NOT EIGEN3_VERSION AND EIGEN3_VERSION_STRING) 12512037Sandreas.sandberg@arm.com set(EIGEN3_VERSION ${EIGEN3_VERSION_STRING}) 12612037Sandreas.sandberg@arm.com endif() 12711986Sandreas.sandberg@arm.com message(STATUS "Building tests with Eigen v${EIGEN3_VERSION}") 12811986Sandreas.sandberg@arm.com else() 12911986Sandreas.sandberg@arm.com list(REMOVE_AT PYBIND11_TEST_FILES ${PYBIND11_TEST_FILES_EIGEN_I}) 13011986Sandreas.sandberg@arm.com message(STATUS "Building tests WITHOUT Eigen") 13111986Sandreas.sandberg@arm.com endif() 13211986Sandreas.sandberg@arm.comendif() 13311986Sandreas.sandberg@arm.com 13412391Sjason@lowepower.com# Optional dependency for some tests (boost::variant is only supported with version >= 1.56) 13512391Sjason@lowepower.comfind_package(Boost 1.56) 13612391Sjason@lowepower.com 13712037Sandreas.sandberg@arm.com# Compile with compiler warnings turned on 13812037Sandreas.sandberg@arm.comfunction(pybind11_enable_warnings target_name) 13912037Sandreas.sandberg@arm.com if(MSVC) 14012037Sandreas.sandberg@arm.com target_compile_options(${target_name} PRIVATE /W4) 14114299Sbbruce@ucdavis.edu elseif(CMAKE_CXX_COMPILER_ID MATCHES "(GNU|Intel|Clang)") 14214299Sbbruce@ucdavis.edu target_compile_options(${target_name} PRIVATE -Wall -Wextra -Wconversion -Wcast-qual -Wdeprecated) 14312037Sandreas.sandberg@arm.com endif() 14412037Sandreas.sandberg@arm.com 14512037Sandreas.sandberg@arm.com if(PYBIND11_WERROR) 14612037Sandreas.sandberg@arm.com if(MSVC) 14712037Sandreas.sandberg@arm.com target_compile_options(${target_name} PRIVATE /WX) 14814299Sbbruce@ucdavis.edu elseif(CMAKE_CXX_COMPILER_ID MATCHES "(GNU|Intel|Clang)") 14912037Sandreas.sandberg@arm.com target_compile_options(${target_name} PRIVATE -Werror) 15012037Sandreas.sandberg@arm.com endif() 15112037Sandreas.sandberg@arm.com endif() 15212037Sandreas.sandberg@arm.comendfunction() 15312037Sandreas.sandberg@arm.com 15412391Sjason@lowepower.comset(test_targets pybind11_tests) 15512037Sandreas.sandberg@arm.com 15612391Sjason@lowepower.com# Build pybind11_cross_module_tests if any test_whatever.py are being built that require it 15712391Sjason@lowepower.comforeach(t ${PYBIND11_CROSS_MODULE_TESTS}) 15812391Sjason@lowepower.com list(FIND PYBIND11_PYTEST_FILES ${t} i) 15912391Sjason@lowepower.com if (i GREATER -1) 16012391Sjason@lowepower.com list(APPEND test_targets pybind11_cross_module_tests) 16112391Sjason@lowepower.com break() 16212037Sandreas.sandberg@arm.com endif() 16312391Sjason@lowepower.comendforeach() 16411986Sandreas.sandberg@arm.com 16514299Sbbruce@ucdavis.eduforeach(t ${PYBIND11_CROSS_MODULE_GIL_TESTS}) 16614299Sbbruce@ucdavis.edu list(FIND PYBIND11_PYTEST_FILES ${t} i) 16714299Sbbruce@ucdavis.edu if (i GREATER -1) 16814299Sbbruce@ucdavis.edu list(APPEND test_targets cross_module_gil_utils) 16914299Sbbruce@ucdavis.edu break() 17014299Sbbruce@ucdavis.edu endif() 17114299Sbbruce@ucdavis.eduendforeach() 17214299Sbbruce@ucdavis.edu 17312037Sandreas.sandberg@arm.comset(testdir ${CMAKE_CURRENT_SOURCE_DIR}) 17412391Sjason@lowepower.comforeach(target ${test_targets}) 17512391Sjason@lowepower.com set(test_files ${PYBIND11_TEST_FILES}) 17612391Sjason@lowepower.com if(NOT target STREQUAL "pybind11_tests") 17712391Sjason@lowepower.com set(test_files "") 17812391Sjason@lowepower.com endif() 17911986Sandreas.sandberg@arm.com 18012391Sjason@lowepower.com # Create the binding library 18112391Sjason@lowepower.com pybind11_add_module(${target} THIN_LTO ${target}.cpp ${test_files} ${PYBIND11_HEADERS}) 18212391Sjason@lowepower.com pybind11_enable_warnings(${target}) 18312391Sjason@lowepower.com 18412391Sjason@lowepower.com if(MSVC) 18512391Sjason@lowepower.com target_compile_options(${target} PRIVATE /utf-8) 18612391Sjason@lowepower.com endif() 18712391Sjason@lowepower.com 18812391Sjason@lowepower.com if(EIGEN3_FOUND) 18912391Sjason@lowepower.com if (PYBIND11_EIGEN_VIA_TARGET) 19012391Sjason@lowepower.com target_link_libraries(${target} PRIVATE Eigen3::Eigen) 19112391Sjason@lowepower.com else() 19212391Sjason@lowepower.com target_include_directories(${target} PRIVATE ${EIGEN3_INCLUDE_DIR}) 19312391Sjason@lowepower.com endif() 19412391Sjason@lowepower.com target_compile_definitions(${target} PRIVATE -DPYBIND11_TEST_EIGEN) 19512391Sjason@lowepower.com endif() 19612391Sjason@lowepower.com 19712391Sjason@lowepower.com if(Boost_FOUND) 19812391Sjason@lowepower.com target_include_directories(${target} PRIVATE ${Boost_INCLUDE_DIRS}) 19912391Sjason@lowepower.com target_compile_definitions(${target} PRIVATE -DPYBIND11_TEST_BOOST) 20012391Sjason@lowepower.com endif() 20112391Sjason@lowepower.com 20212391Sjason@lowepower.com # Always write the output file directly into the 'tests' directory (even on MSVC) 20312391Sjason@lowepower.com if(NOT CMAKE_LIBRARY_OUTPUT_DIRECTORY) 20412391Sjason@lowepower.com set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${testdir}) 20512391Sjason@lowepower.com foreach(config ${CMAKE_CONFIGURATION_TYPES}) 20612391Sjason@lowepower.com string(TOUPPER ${config} config) 20712391Sjason@lowepower.com set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY_${config} ${testdir}) 20812391Sjason@lowepower.com endforeach() 20912391Sjason@lowepower.com endif() 21012391Sjason@lowepower.comendforeach() 21111986Sandreas.sandberg@arm.com 21211986Sandreas.sandberg@arm.com# Make sure pytest is found or produce a fatal error 21311986Sandreas.sandberg@arm.comif(NOT PYBIND11_PYTEST_FOUND) 21412037Sandreas.sandberg@arm.com execute_process(COMMAND ${PYTHON_EXECUTABLE} -c "import pytest; print(pytest.__version__)" 21512037Sandreas.sandberg@arm.com RESULT_VARIABLE pytest_not_found OUTPUT_VARIABLE pytest_version ERROR_QUIET) 21612037Sandreas.sandberg@arm.com if(pytest_not_found) 21712037Sandreas.sandberg@arm.com message(FATAL_ERROR "Running the tests requires pytest. Please install it manually" 21812037Sandreas.sandberg@arm.com " (try: ${PYTHON_EXECUTABLE} -m pip install pytest)") 21912037Sandreas.sandberg@arm.com elseif(pytest_version VERSION_LESS 3.0) 22012037Sandreas.sandberg@arm.com message(FATAL_ERROR "Running the tests requires pytest >= 3.0. Found: ${pytest_version}" 22112037Sandreas.sandberg@arm.com "Please update it (try: ${PYTHON_EXECUTABLE} -m pip install -U pytest)") 22211986Sandreas.sandberg@arm.com endif() 22311986Sandreas.sandberg@arm.com set(PYBIND11_PYTEST_FOUND TRUE CACHE INTERNAL "") 22411986Sandreas.sandberg@arm.comendif() 22511986Sandreas.sandberg@arm.com 22612391Sjason@lowepower.comif(CMAKE_VERSION VERSION_LESS 3.2) 22712391Sjason@lowepower.com set(PYBIND11_USES_TERMINAL "") 22812391Sjason@lowepower.comelse() 22912391Sjason@lowepower.com set(PYBIND11_USES_TERMINAL "USES_TERMINAL") 23012391Sjason@lowepower.comendif() 23112391Sjason@lowepower.com 23211986Sandreas.sandberg@arm.com# A single command to compile and run the tests 23312037Sandreas.sandberg@arm.comadd_custom_target(pytest COMMAND ${PYTHON_EXECUTABLE} -m pytest ${PYBIND11_PYTEST_FILES} 23412391Sjason@lowepower.com DEPENDS ${test_targets} WORKING_DIRECTORY ${testdir} ${PYBIND11_USES_TERMINAL}) 23511986Sandreas.sandberg@arm.com 23611986Sandreas.sandberg@arm.comif(PYBIND11_TEST_OVERRIDE) 23711986Sandreas.sandberg@arm.com add_custom_command(TARGET pytest POST_BUILD 23811986Sandreas.sandberg@arm.com COMMAND ${CMAKE_COMMAND} -E echo "Note: not all tests run: -DPYBIND11_TEST_OVERRIDE is in effect") 23911986Sandreas.sandberg@arm.comendif() 24011986Sandreas.sandberg@arm.com 24112037Sandreas.sandberg@arm.com# Add a check target to run all the tests, starting with pytest (we add dependencies to this below) 24212037Sandreas.sandberg@arm.comadd_custom_target(check DEPENDS pytest) 24312037Sandreas.sandberg@arm.com 24412037Sandreas.sandberg@arm.com# The remaining tests only apply when being built as part of the pybind11 project, but not if the 24512037Sandreas.sandberg@arm.com# tests are being built independently. 24612037Sandreas.sandberg@arm.comif (NOT PROJECT_NAME STREQUAL "pybind11") 24712037Sandreas.sandberg@arm.com return() 24811986Sandreas.sandberg@arm.comendif() 24911986Sandreas.sandberg@arm.com 25012391Sjason@lowepower.com# Add a post-build comment to show the primary test suite .so size and, if a previous size, compare it: 25111986Sandreas.sandberg@arm.comadd_custom_command(TARGET pybind11_tests POST_BUILD 25212037Sandreas.sandberg@arm.com COMMAND ${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/tools/libsize.py 25312037Sandreas.sandberg@arm.com $<TARGET_FILE:pybind11_tests> ${CMAKE_CURRENT_BINARY_DIR}/sosize-$<TARGET_FILE_NAME:pybind11_tests>.txt) 25412037Sandreas.sandberg@arm.com 25512391Sjason@lowepower.com# Test embedding the interpreter. Provides the `cpptest` target. 25612391Sjason@lowepower.comadd_subdirectory(test_embed) 25712391Sjason@lowepower.com 25812037Sandreas.sandberg@arm.com# Test CMake build using functions and targets from subdirectory or installed location 25912391Sjason@lowepower.comadd_subdirectory(test_cmake_build) 260