CMakeLists.txt 11.1 KB
Newer Older
Jason Rhinelander's avatar
Jason Rhinelander committed
1
2
3
4
5
6
7
# CMakeLists.txt -- Build system for the pybind11 test suite
#
# Copyright (c) 2015 Wenzel Jakob <wenzel@inf.ethz.ch>
#
# All rights reserved. Use of this source code is governed by a
# BSD-style license that can be found in the LICENSE file.

8
9
cmake_minimum_required(VERSION 3.7)

Henry Schreiner's avatar
Henry Schreiner committed
10
11
12
# The `cmake_minimum_required(VERSION 3.7...3.18)` syntax does not work with
# some versions of VS that have a patched CMake 3.11. This forces us to emulate
# the behavior using the following workaround:
13
if(${CMAKE_VERSION} VERSION_LESS 3.18)
Henry Schreiner's avatar
Henry Schreiner committed
14
  cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION})
15
else()
Henry Schreiner's avatar
Henry Schreiner committed
16
  cmake_policy(VERSION 3.18)
17
18
19
20
endif()

# There's no harm in including a project in a project
project(pybind11_tests CXX)
Jason Rhinelander's avatar
Jason Rhinelander committed
21

Henry Schreiner's avatar
Henry Schreiner committed
22
23
24
# Access FindCatch and more
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/../tools")

Henry Schreiner's avatar
Henry Schreiner committed
25
option(PYBIND11_WERROR "Report all warnings as errors" OFF)
26
option(DOWNLOAD_EIGEN "Download EIGEN (requires CMake 3.11+)" OFF)
Henry Schreiner's avatar
Henry Schreiner committed
27
28
29
set(PYBIND11_TEST_OVERRIDE
    ""
    CACHE STRING "Tests from ;-separated list of *.cpp files will be built instead of all tests")
Jason Rhinelander's avatar
Jason Rhinelander committed
30

31
if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
Henry Schreiner's avatar
Henry Schreiner committed
32
33
34
  # We're being loaded directly, i.e. not via add_subdirectory, so make this
  # work as its own project and load the pybind11Config to get the tools we need
  find_package(pybind11 REQUIRED CONFIG)
Jason Rhinelander's avatar
Jason Rhinelander committed
35
36
endif()

Dean Moldovan's avatar
Dean Moldovan committed
37
38
if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
  message(STATUS "Setting tests build type to MinSizeRel as none was specified")
Henry Schreiner's avatar
Henry Schreiner committed
39
40
41
42
43
  set(CMAKE_BUILD_TYPE
      MinSizeRel
      CACHE STRING "Choose the type of build." FORCE)
  set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel"
                                               "RelWithDebInfo")
Dean Moldovan's avatar
Dean Moldovan committed
44
45
endif()

46
# Full set of test files (you can override these; see below)
Dean Moldovan's avatar
Dean Moldovan committed
47
set(PYBIND11_TEST_FILES
Henry Schreiner's avatar
Henry Schreiner committed
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
    test_async.cpp
    test_buffers.cpp
    test_builtin_casters.cpp
    test_call_policies.cpp
    test_callbacks.cpp
    test_chrono.cpp
    test_class.cpp
    test_constants_and_functions.cpp
    test_copy_move.cpp
    test_custom_type_casters.cpp
    test_docstring_options.cpp
    test_eigen.cpp
    test_enum.cpp
    test_eval.cpp
    test_exceptions.cpp
    test_factory_constructors.cpp
    test_gil_scoped.cpp
    test_iostream.cpp
    test_kwargs_and_defaults.cpp
    test_local_bindings.cpp
    test_methods_and_attributes.cpp
    test_modules.cpp
    test_multiple_inheritance.cpp
    test_numpy_array.cpp
    test_numpy_dtypes.cpp
    test_numpy_vectorize.cpp
    test_opaque_types.cpp
    test_operator_overloading.cpp
    test_pickling.cpp
    test_pytypes.cpp
    test_sequences_and_iterators.cpp
    test_smart_ptr.cpp
    test_stl.cpp
    test_stl_binders.cpp
    test_tagbased_polymorphic.cpp
    test_union.cpp
    test_virtual_functions.cpp)
Dean Moldovan's avatar
Dean Moldovan committed
85

86
# Invoking cmake with something like:
87
#     cmake -DPYBIND11_TEST_OVERRIDE="test_callbacks.cpp;test_picking.cpp" ..
88
89
# lets you override the tests that get compiled and run.  You can restore to all tests with:
#     cmake -DPYBIND11_TEST_OVERRIDE= ..
Henry Schreiner's avatar
Henry Schreiner committed
90
if(PYBIND11_TEST_OVERRIDE)
91
92
93
  set(PYBIND11_TEST_FILES ${PYBIND11_TEST_OVERRIDE})
endif()

94
95
# Skip test_async for Python < 3.5
list(FIND PYBIND11_TEST_FILES test_async.cpp PYBIND11_TEST_FILES_ASYNC_I)
Henry Schreiner's avatar
Henry Schreiner committed
96
97
if((PYBIND11_TEST_FILES_ASYNC_I GREATER -1) AND (PYTHON_VERSION VERSION_LESS 3.5))
  message(STATUS "Skipping test_async because Python version ${PYTHON_VERSION} < 3.5")
98
99
100
  list(REMOVE_AT PYBIND11_TEST_FILES ${PYBIND11_TEST_FILES_ASYNC_I})
endif()

101
string(REPLACE ".cpp" ".py" PYBIND11_PYTEST_FILES "${PYBIND11_TEST_FILES}")
Dean Moldovan's avatar
Dean Moldovan committed
102

103
104
105
# Contains the set of test files that require pybind11_cross_module_tests to be
# built; if none of these are built (i.e. because TEST_OVERRIDE is used and
# doesn't include them) the second module doesn't get built.
Henry Schreiner's avatar
Henry Schreiner committed
106
107
set(PYBIND11_CROSS_MODULE_TESTS test_exceptions.py test_local_bindings.py test_stl.py
                                test_stl_binders.py)
108

Henry Schreiner's avatar
Henry Schreiner committed
109
set(PYBIND11_CROSS_MODULE_GIL_TESTS test_gil_scoped.py)
110

111
112
113
114
115
# Check if Eigen is available; if not, remove from PYBIND11_TEST_FILES (but
# keep it in PYBIND11_PYTEST_FILES, so that we get the "eigen is not installed"
# skip message).
list(FIND PYBIND11_TEST_FILES test_eigen.cpp PYBIND11_TEST_FILES_EIGEN_I)
if(PYBIND11_TEST_FILES_EIGEN_I GREATER -1)
Jason Rhinelander's avatar
Jason Rhinelander committed
116
117
118
  # Try loading via newer Eigen's Eigen3Config first (bypassing tools/FindEigen3.cmake).
  # Eigen 3.3.1+ exports a cmake 3.0+ target for handling dependency requirements, but also
  # produces a fatal error if loaded from a pre-3.0 cmake.
Henry Schreiner's avatar
Henry Schreiner committed
119
120
121
122
123
124
125
126
127
128
129
  if(DOWNLOAD_EIGEN)
    if(CMAKE_VERSION VERSION_LESS 3.11)
      message(FATAL_ERROR "CMake 3.11+ required when using DOWNLOAD_EIGEN")
    endif()

    set(EIGEN3_VERSION_STRING "3.3.7")

    include(FetchContent)
    FetchContent_Declare(
      eigen
      GIT_REPOSITORY https://gitlab.com/libeigen/eigen.git
Henry Schreiner's avatar
Henry Schreiner committed
130
      GIT_TAG ${EIGEN3_VERSION_STRING})
Henry Schreiner's avatar
Henry Schreiner committed
131
132
133
134
135
136
137
138
139
140

    FetchContent_GetProperties(eigen)
    if(NOT eigen_POPULATED)
      message(STATUS "Downloading Eigen")
      FetchContent_Populate(eigen)
    endif()

    set(EIGEN3_INCLUDE_DIR ${eigen_SOURCE_DIR})
    set(EIGEN3_FOUND TRUE)
  else()
141
    find_package(Eigen3 3.2.7 QUIET CONFIG)
Henry Schreiner's avatar
Henry Schreiner committed
142
143
    if(EIGEN3_FOUND)
      if(EIGEN3_VERSION_STRING AND NOT EIGEN3_VERSION_STRING VERSION_LESS 3.3.1)
144
        set(PYBIND11_EIGEN_VIA_TARGET TRUE)
Jason Rhinelander's avatar
Jason Rhinelander committed
145
146
      endif()
    endif()
147

Henry Schreiner's avatar
Henry Schreiner committed
148
    if(NOT EIGEN3_FOUND)
Henry Schreiner's avatar
Henry Schreiner committed
149
150
151
152
      # Couldn't load via target, so fall back to allowing module mode finding, which will pick up
      # tools/FindEigen3.cmake
      find_package(Eigen3 3.2.7 QUIET)
    endif()
Jason Rhinelander's avatar
Jason Rhinelander committed
153
  endif()
154
155

  if(EIGEN3_FOUND)
Jason Rhinelander's avatar
Jason Rhinelander committed
156
157
158
159
160
161
    # Eigen 3.3.1+ cmake sets EIGEN3_VERSION_STRING (and hard codes the version when installed
    # rather than looking it up in the cmake script); older versions, and the
    # tools/FindEigen3.cmake, set EIGEN3_VERSION instead.
    if(NOT EIGEN3_VERSION AND EIGEN3_VERSION_STRING)
      set(EIGEN3_VERSION ${EIGEN3_VERSION_STRING})
    endif()
162
163
164
    message(STATUS "Building tests with Eigen v${EIGEN3_VERSION}")
  else()
    list(REMOVE_AT PYBIND11_TEST_FILES ${PYBIND11_TEST_FILES_EIGEN_I})
Henry Schreiner's avatar
Henry Schreiner committed
165
    message(STATUS "Building tests WITHOUT Eigen, use -DDOWNLOAD_EIGEN on CMake 3.11+ to download")
166
  endif()
Dean Moldovan's avatar
Dean Moldovan committed
167
168
endif()

169
170
# Optional dependency for some tests (boost::variant is only supported with version >= 1.56)
find_package(Boost 1.56)
171

Jason Rhinelander's avatar
Jason Rhinelander committed
172
173
174
175
# Compile with compiler warnings turned on
function(pybind11_enable_warnings target_name)
  if(MSVC)
    target_compile_options(${target_name} PRIVATE /W4)
176
  elseif(CMAKE_CXX_COMPILER_ID MATCHES "(GNU|Intel|Clang)")
Henry Schreiner's avatar
Henry Schreiner committed
177
178
    target_compile_options(${target_name} PRIVATE -Wall -Wextra -Wconversion -Wcast-qual
                                                  -Wdeprecated)
Jason Rhinelander's avatar
Jason Rhinelander committed
179
180
181
182
183
  endif()

  if(PYBIND11_WERROR)
    if(MSVC)
      target_compile_options(${target_name} PRIVATE /WX)
184
    elseif(CMAKE_CXX_COMPILER_ID MATCHES "(GNU|Intel|Clang)")
Jason Rhinelander's avatar
Jason Rhinelander committed
185
186
187
      target_compile_options(${target_name} PRIVATE -Werror)
    endif()
  endif()
188

189
  # Needs to be readded since the ordering requires these to be after the ones above
Henry Schreiner's avatar
Henry Schreiner committed
190
191
192
  if(CMAKE_CXX_STANDARD
     AND CMAKE_CXX_COMPILER_ID MATCHES "Clang"
     AND PYTHON_VERSION VERSION_LESS 3.0)
193
    if(CMAKE_CXX_STANDARD LESS 17)
194
      target_compile_options(${target_name} PUBLIC -Wno-deprecated-register)
195
    else()
196
197
198
      target_compile_options(${target_name} PUBLIC -Wno-register)
    endif()
  endif()
Jason Rhinelander's avatar
Jason Rhinelander committed
199
200
endfunction()

201
set(test_targets pybind11_tests)
Jason Rhinelander's avatar
Jason Rhinelander committed
202

203
204
205
# Build pybind11_cross_module_tests if any test_whatever.py are being built that require it
foreach(t ${PYBIND11_CROSS_MODULE_TESTS})
  list(FIND PYBIND11_PYTEST_FILES ${t} i)
Henry Schreiner's avatar
Henry Schreiner committed
206
  if(i GREATER -1)
207
208
209
210
    list(APPEND test_targets pybind11_cross_module_tests)
    break()
  endif()
endforeach()
211

212
213
foreach(t ${PYBIND11_CROSS_MODULE_GIL_TESTS})
  list(FIND PYBIND11_PYTEST_FILES ${t} i)
Henry Schreiner's avatar
Henry Schreiner committed
214
  if(i GREATER -1)
215
216
217
218
219
    list(APPEND test_targets cross_module_gil_utils)
    break()
  endif()
endforeach()

220
set(testdir ${CMAKE_CURRENT_SOURCE_DIR})
221
foreach(target ${test_targets})
222
  set(test_files ${PYBIND11_TEST_FILES})
223
  if(NOT "${target}" STREQUAL "pybind11_tests")
224
225
    set(test_files "")
  endif()
Dean Moldovan's avatar
Dean Moldovan committed
226

227
  # Create the binding library
228
229
  pybind11_add_module(${target} THIN_LTO ${target}.cpp ${test_files} ${PYBIND11_HEADERS})
  pybind11_enable_warnings(${target})
230
231

  if(MSVC)
232
    target_compile_options(${target} PRIVATE /utf-8)
Jason Rhinelander's avatar
Jason Rhinelander committed
233
  endif()
Dean Moldovan's avatar
Dean Moldovan committed
234

235
  if(EIGEN3_FOUND)
Henry Schreiner's avatar
Henry Schreiner committed
236
    if(PYBIND11_EIGEN_VIA_TARGET)
237
      target_link_libraries(${target} PRIVATE Eigen3::Eigen)
238
    else()
239
      target_include_directories(${target} SYSTEM PRIVATE ${EIGEN3_INCLUDE_DIR})
240
    endif()
241
242
243
244
    target_compile_definitions(${target} PRIVATE -DPYBIND11_TEST_EIGEN)
  endif()

  if(Boost_FOUND)
245
    target_include_directories(${target} SYSTEM PRIVATE ${Boost_INCLUDE_DIRS})
246
    target_compile_definitions(${target} PRIVATE -DPYBIND11_TEST_BOOST)
247
  endif()
Dean Moldovan's avatar
Dean Moldovan committed
248

249
250
  # Always write the output file directly into the 'tests' directory (even on MSVC)
  if(NOT CMAKE_LIBRARY_OUTPUT_DIRECTORY)
251
    set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${testdir}")
252
253
    foreach(config ${CMAKE_CONFIGURATION_TYPES})
      string(TOUPPER ${config} config)
254
      set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY_${config} "${testdir}")
255
256
257
    endforeach()
  endif()
endforeach()
Dean Moldovan's avatar
Dean Moldovan committed
258

259
# Make sure pytest is found or produce a fatal error
260
if(NOT PYBIND11_PYTEST_FOUND)
Henry Schreiner's avatar
Henry Schreiner committed
261
262
263
264
265
  execute_process(
    COMMAND ${PYTHON_EXECUTABLE} -c "import pytest; print(pytest.__version__)"
    RESULT_VARIABLE pytest_not_found
    OUTPUT_VARIABLE pytest_version
    ERROR_QUIET)
266
267
268
  if(pytest_not_found)
    message(FATAL_ERROR "Running the tests requires pytest. Please install it manually"
                        " (try: ${PYTHON_EXECUTABLE} -m pip install pytest)")
269
270
  elseif(pytest_version VERSION_LESS 3.1)
    message(FATAL_ERROR "Running the tests requires pytest >= 3.1. Found: ${pytest_version}"
271
                        "Please update it (try: ${PYTHON_EXECUTABLE} -m pip install -U pytest)")
272
  endif()
Henry Schreiner's avatar
Henry Schreiner committed
273
274
275
  set(PYBIND11_PYTEST_FOUND
      TRUE
      CACHE INTERNAL "")
276
277
endif()

Dean Moldovan's avatar
Dean Moldovan committed
278
# A single command to compile and run the tests
Henry Schreiner's avatar
Henry Schreiner committed
279
280
281
282
283
284
add_custom_target(
  pytest
  COMMAND ${PYTHON_EXECUTABLE} -m pytest ${PYBIND11_PYTEST_FILES}
  DEPENDS ${test_targets}
  WORKING_DIRECTORY ${testdir}
  USES_TERMINAL)
285

286
if(PYBIND11_TEST_OVERRIDE)
Henry Schreiner's avatar
Henry Schreiner committed
287
288
289
290
291
  add_custom_command(
    TARGET pytest
    POST_BUILD
    COMMAND ${CMAKE_COMMAND} -E echo
            "Note: not all tests run: -DPYBIND11_TEST_OVERRIDE is in effect")
292
293
endif()

Jason Rhinelander's avatar
Jason Rhinelander committed
294
295
296
297
298
# Add a check target to run all the tests, starting with pytest (we add dependencies to this below)
add_custom_target(check DEPENDS pytest)

# The remaining tests only apply when being built as part of the pybind11 project, but not if the
# tests are being built independently.
299
if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
Jason Rhinelander's avatar
Jason Rhinelander committed
300
301
302
  return()
endif()

303
# Add a post-build comment to show the primary test suite .so size and, if a previous size, compare it:
304
add_custom_command(
Henry Schreiner's avatar
Henry Schreiner committed
305
306
307
308
  TARGET pybind11_tests
  POST_BUILD
  COMMAND
    ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/../tools/libsize.py
309
310
    $<TARGET_FILE:pybind11_tests>
    ${CMAKE_CURRENT_BINARY_DIR}/sosize-$<TARGET_FILE_NAME:pybind11_tests>.txt)
311

312
313
314
# Test embedding the interpreter. Provides the `cpptest` target.
add_subdirectory(test_embed)

315
# Test CMake build using functions and targets from subdirectory or installed location
316
add_subdirectory(test_cmake_build)