CMakeLists.txt 17.3 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
cmake_minimum_required(VERSION 3.4)
9

10
# The `cmake_minimum_required(VERSION 3.4...3.18)` syntax does not work with
Henry Schreiner's avatar
Henry Schreiner committed
11
12
# 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.21)
Henry Schreiner's avatar
Henry Schreiner committed
14
  cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION})
15
else()
16
  cmake_policy(VERSION 3.21)
17
18
endif()

19
20
21
22
23
24
25
26
# Only needed for CMake < 3.5 support
include(CMakeParseArguments)

# Filter out items; print an optional message if any items filtered
#
# Usage:
#   pybind11_filter_tests(LISTNAME file1.cpp file2.cpp ... MESSAGE "")
#
27
macro(pybind11_filter_tests LISTNAME)
28
29
30
31
32
33
34
35
36
37
38
39
40
41
  cmake_parse_arguments(ARG "" "MESSAGE" "" ${ARGN})
  set(PYBIND11_FILTER_TESTS_FOUND OFF)
  foreach(filename IN LISTS ARG_UNPARSED_ARGUMENTS)
    list(FIND ${LISTNAME} ${filename} _FILE_FOUND)
    if(_FILE_FOUND GREATER -1)
      list(REMOVE_AT ${LISTNAME} ${_FILE_FOUND})
      set(PYBIND11_FILTER_TESTS_FOUND ON)
    endif()
  endforeach()
  if(PYBIND11_FILTER_TESTS_FOUND AND ARG_MESSAGE)
    message(STATUS "${ARG_MESSAGE}")
  endif()
endmacro()

42
43
44
45
46
47
48
49
macro(possibly_uninitialized)
  foreach(VARNAME ${ARGN})
    if(NOT DEFINED "${VARNAME}")
      set("${VARNAME}" "")
    endif()
  endforeach()
endmacro()

50
51
52
53
54
55
# New Python support
if(DEFINED Python_EXECUTABLE)
  set(PYTHON_EXECUTABLE "${Python_EXECUTABLE}")
  set(PYTHON_VERSION "${Python_VERSION}")
endif()

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

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

Henry Schreiner's avatar
Henry Schreiner committed
62
option(PYBIND11_WERROR "Report all warnings as errors" OFF)
63
option(DOWNLOAD_EIGEN "Download EIGEN (requires CMake 3.11+)" OFF)
64
option(PYBIND11_CUDA_TESTS "Enable building CUDA tests (requires CMake 3.12+)" OFF)
Henry Schreiner's avatar
Henry Schreiner committed
65
66
67
set(PYBIND11_TEST_OVERRIDE
    ""
    CACHE STRING "Tests from ;-separated list of *.cpp files will be built instead of all tests")
68
69
70
set(PYBIND11_TEST_FILTER
    ""
    CACHE STRING "Tests from ;-separated list of *.cpp files will be removed from all tests")
Jason Rhinelander's avatar
Jason Rhinelander committed
71

72
if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
Henry Schreiner's avatar
Henry Schreiner committed
73
74
75
  # 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
76
77
endif()

78
if(NOT CMAKE_BUILD_TYPE AND NOT DEFINED CMAKE_CONFIGURATION_TYPES)
Dean Moldovan's avatar
Dean Moldovan committed
79
  message(STATUS "Setting tests build type to MinSizeRel as none was specified")
Henry Schreiner's avatar
Henry Schreiner committed
80
81
82
83
84
  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
85
86
endif()

87
88
89
90
91
92
93
94
if(PYBIND11_CUDA_TESTS)
  enable_language(CUDA)
  if(DEFINED CMAKE_CXX_STANDARD)
    set(CMAKE_CUDA_STANDARD ${CMAKE_CXX_STANDARD})
  endif()
  set(CMAKE_CUDA_STANDARD_REQUIRED ON)
endif()

95
# Full set of test files (you can override these; see below)
Dean Moldovan's avatar
Dean Moldovan committed
96
set(PYBIND11_TEST_FILES
Henry Schreiner's avatar
Henry Schreiner committed
97
98
99
100
101
102
103
104
105
106
    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
107
    test_custom_type_setup.cpp
Henry Schreiner's avatar
Henry Schreiner committed
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
    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
133
    test_thread.cpp
Henry Schreiner's avatar
Henry Schreiner committed
134
135
    test_union.cpp
    test_virtual_functions.cpp)
Dean Moldovan's avatar
Dean Moldovan committed
136

137
# Invoking cmake with something like:
138
#     cmake -DPYBIND11_TEST_OVERRIDE="test_callbacks.cpp;test_pickling.cpp" ..
139
140
# 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
141
if(PYBIND11_TEST_OVERRIDE)
142
143
144
  set(PYBIND11_TEST_FILES ${PYBIND11_TEST_OVERRIDE})
endif()

145
146
147
148
149
150
151
152
# You can also filter tests:
if(PYBIND11_TEST_FILTER)
  pybind11_filter_tests(PYBIND11_TEST_FILES ${PYBIND11_TEST_FILTER})
endif()

if(PYTHON_VERSION VERSION_LESS 3.5)
  pybind11_filter_tests(PYBIND11_TEST_FILES test_async.cpp MESSAGE
                        "Skipping test_async on Python 2")
153
154
endif()

155
156
157
# Skip tests for CUDA check:
# /pybind11/tests/test_constants_and_functions.cpp(125):
#   error: incompatible exception specifications
158
159
160
161
if(PYBIND11_CUDA_TESTS)
  pybind11_filter_tests(
    PYBIND11_TEST_FILES test_constants_and_functions.cpp MESSAGE
    "Skipping test_constants_and_functions due to incompatible exception specifications")
162
163
endif()

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

166
167
168
# 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
169
170
set(PYBIND11_CROSS_MODULE_TESTS test_exceptions.py test_local_bindings.py test_stl.py
                                test_stl_binders.py)
171

Henry Schreiner's avatar
Henry Schreiner committed
172
set(PYBIND11_CROSS_MODULE_GIL_TESTS test_gil_scoped.py)
173

174
175
176
set(PYBIND11_EIGEN_REPO
    "https://gitlab.com/libeigen/eigen.git"
    CACHE STRING "Eigen repository to use for tests")
177
178
179
180
181
182
183
184
# Always use a hash for reconfigure speed and security reasons
# Include the version number for pretty printing (keep in sync)
set(PYBIND11_EIGEN_VERSION_AND_HASH
    "3.4.0;929bc0e191d0927b1735b9a1ddc0e8b77e3a25ec"
    CACHE STRING "Eigen version to use for tests, format: VERSION;HASH")

list(GET PYBIND11_EIGEN_VERSION_AND_HASH 0 PYBIND11_EIGEN_VERSION_STRING)
list(GET PYBIND11_EIGEN_VERSION_AND_HASH 1 PYBIND11_EIGEN_VERSION_HASH)
185

186
187
188
189
190
# 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
191
192
193
  # 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
194
195
196
197
198
199
200
201
  if(DOWNLOAD_EIGEN)
    if(CMAKE_VERSION VERSION_LESS 3.11)
      message(FATAL_ERROR "CMake 3.11+ required when using DOWNLOAD_EIGEN")
    endif()

    include(FetchContent)
    FetchContent_Declare(
      eigen
202
      GIT_REPOSITORY "${PYBIND11_EIGEN_REPO}"
203
      GIT_TAG "${PYBIND11_EIGEN_VERSION_HASH}")
Henry Schreiner's avatar
Henry Schreiner committed
204
205
206

    FetchContent_GetProperties(eigen)
    if(NOT eigen_POPULATED)
207
208
209
210
      message(
        STATUS
          "Downloading Eigen ${PYBIND11_EIGEN_VERSION_STRING} (${PYBIND11_EIGEN_VERSION_HASH}) from ${PYBIND11_EIGEN_REPO}"
      )
Henry Schreiner's avatar
Henry Schreiner committed
211
212
213
214
215
      FetchContent_Populate(eigen)
    endif()

    set(EIGEN3_INCLUDE_DIR ${eigen_SOURCE_DIR})
    set(EIGEN3_FOUND TRUE)
216
217
218
    # When getting locally, the version is not visible from a superprojet,
    # so just force it.
    set(EIGEN3_VERSION "${PYBIND11_EIGEN_VERSION_STRING}")
219

Henry Schreiner's avatar
Henry Schreiner committed
220
  else()
221
222
    find_package(Eigen3 3.2.7 QUIET CONFIG)

Henry Schreiner's avatar
Henry Schreiner committed
223
    if(NOT EIGEN3_FOUND)
Henry Schreiner's avatar
Henry Schreiner committed
224
225
226
227
      # 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
228
  endif()
229
230

  if(EIGEN3_FOUND)
231
232
233
234
235
236
    if(NOT TARGET Eigen3::Eigen)
      add_library(Eigen3::Eigen IMPORTED INTERFACE)
      set_property(TARGET Eigen3::Eigen PROPERTY INTERFACE_INCLUDE_DIRECTORIES
                                                 "${EIGEN3_INCLUDE_DIR}")
    endif()

Jason Rhinelander's avatar
Jason Rhinelander committed
237
238
239
240
241
242
    # 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()
243
244
245
    message(STATUS "Building tests with Eigen v${EIGEN3_VERSION}")
  else()
    list(REMOVE_AT PYBIND11_TEST_FILES ${PYBIND11_TEST_FILES_EIGEN_I})
246
247
    message(
      STATUS "Building tests WITHOUT Eigen, use -DDOWNLOAD_EIGEN=ON on CMake 3.11+ to download")
248
  endif()
Dean Moldovan's avatar
Dean Moldovan committed
249
250
endif()

251
252
# Optional dependency for some tests (boost::variant is only supported with version >= 1.56)
find_package(Boost 1.56)
253

254
255
if(Boost_FOUND)
  if(NOT TARGET Boost::headers)
256
    add_library(Boost::headers IMPORTED INTERFACE)
257
258
    if(TARGET Boost::boost)
      # Classic FindBoost
259
      set_property(TARGET Boost::boost PROPERTY INTERFACE_LINK_LIBRARIES Boost::boost)
260
261
262
263
264
265
266
267
    else()
      # Very old FindBoost, or newer Boost than CMake in older CMakes
      set_property(TARGET Boost::headers PROPERTY INTERFACE_INCLUDE_DIRECTORIES
                                                  ${Boost_INCLUDE_DIRS})
    endif()
  endif()
endif()

268
# Check if we need to add -lstdc++fs or -lc++fs or nothing
269
270
271
if(DEFINED CMAKE_CXX_STANDARD AND CMAKE_CXX_STANDARD LESS 17)
  set(STD_FS_NO_LIB_NEEDED TRUE)
elseif(MSVC)
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
  set(STD_FS_NO_LIB_NEEDED TRUE)
else()
  file(
    WRITE ${CMAKE_CURRENT_BINARY_DIR}/main.cpp
    "#include <filesystem>\nint main(int argc, char ** argv) {\n  std::filesystem::path p(argv[0]);\n  return p.string().length();\n}"
  )
  try_compile(
    STD_FS_NO_LIB_NEEDED ${CMAKE_CURRENT_BINARY_DIR}
    SOURCES ${CMAKE_CURRENT_BINARY_DIR}/main.cpp
    COMPILE_DEFINITIONS -std=c++17)
  try_compile(
    STD_FS_NEEDS_STDCXXFS ${CMAKE_CURRENT_BINARY_DIR}
    SOURCES ${CMAKE_CURRENT_BINARY_DIR}/main.cpp
    COMPILE_DEFINITIONS -std=c++17
    LINK_LIBRARIES stdc++fs)
  try_compile(
    STD_FS_NEEDS_CXXFS ${CMAKE_CURRENT_BINARY_DIR}
    SOURCES ${CMAKE_CURRENT_BINARY_DIR}/main.cpp
    COMPILE_DEFINITIONS -std=c++17
    LINK_LIBRARIES c++fs)
endif()

if(${STD_FS_NEEDS_STDCXXFS})
  set(STD_FS_LIB stdc++fs)
elseif(${STD_FS_NEEDS_CXXFS})
  set(STD_FS_LIB c++fs)
elseif(${STD_FS_NO_LIB_NEEDED})
  set(STD_FS_LIB "")
else()
301
  message(WARNING "Unknown C++17 compiler - not passing -lstdc++fs")
302
303
304
  set(STD_FS_LIB "")
endif()

Jason Rhinelander's avatar
Jason Rhinelander committed
305
306
307
308
# Compile with compiler warnings turned on
function(pybind11_enable_warnings target_name)
  if(MSVC)
    target_compile_options(${target_name} PRIVATE /W4)
309
  elseif(CMAKE_CXX_COMPILER_ID MATCHES "(GNU|Intel|Clang)" AND NOT PYBIND11_CUDA_TESTS)
310
311
312
313
314
315
316
317
318
    target_compile_options(
      ${target_name}
      PRIVATE -Wall
              -Wextra
              -Wconversion
              -Wcast-qual
              -Wdeprecated
              -Wundef
              -Wnon-virtual-dtor)
Jason Rhinelander's avatar
Jason Rhinelander committed
319
320
321
322
323
  endif()

  if(PYBIND11_WERROR)
    if(MSVC)
      target_compile_options(${target_name} PRIVATE /WX)
324
325
    elseif(PYBIND11_CUDA_TESTS)
      target_compile_options(${target_name} PRIVATE "SHELL:-Werror all-warnings")
326
    elseif(CMAKE_CXX_COMPILER_ID MATCHES "(GNU|Clang|IntelLLVM)")
Jason Rhinelander's avatar
Jason Rhinelander committed
327
      target_compile_options(${target_name} PRIVATE -Werror)
328
329
330
331
332
333
334
    elseif(CMAKE_CXX_COMPILER_ID STREQUAL "Intel")
      target_compile_options(
        ${target_name}
        PRIVATE
          -Werror-all
          # "Inlining inhibited by limit max-size", "Inlining inhibited by limit max-total-size"
          -diag-disable 11074,11076)
Jason Rhinelander's avatar
Jason Rhinelander committed
335
336
    endif()
  endif()
337

338
  # Needs to be re-added since the ordering requires these to be after the ones above
Henry Schreiner's avatar
Henry Schreiner committed
339
340
341
  if(CMAKE_CXX_STANDARD
     AND CMAKE_CXX_COMPILER_ID MATCHES "Clang"
     AND PYTHON_VERSION VERSION_LESS 3.0)
342
    if(CMAKE_CXX_STANDARD LESS 17)
343
      target_compile_options(${target_name} PUBLIC -Wno-deprecated-register)
344
    else()
345
346
347
      target_compile_options(${target_name} PUBLIC -Wno-register)
    endif()
  endif()
Jason Rhinelander's avatar
Jason Rhinelander committed
348
349
endfunction()

350
set(test_targets pybind11_tests)
Jason Rhinelander's avatar
Jason Rhinelander committed
351

352
353
354
# 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
355
  if(i GREATER -1)
356
357
358
359
    list(APPEND test_targets pybind11_cross_module_tests)
    break()
  endif()
endforeach()
360

361
362
foreach(t ${PYBIND11_CROSS_MODULE_GIL_TESTS})
  list(FIND PYBIND11_PYTEST_FILES ${t} i)
Henry Schreiner's avatar
Henry Schreiner committed
363
  if(i GREATER -1)
364
365
366
367
368
    list(APPEND test_targets cross_module_gil_utils)
    break()
  endif()
endforeach()

369
370
371
372
373
# Support CUDA testing by forcing the target file to compile with NVCC
if(PYBIND11_CUDA_TESTS)
  set_property(SOURCE ${PYBIND11_TEST_FILES} PROPERTY LANGUAGE CUDA)
endif()

374
foreach(target ${test_targets})
375
  set(test_files ${PYBIND11_TEST_FILES})
376
  if(NOT "${target}" STREQUAL "pybind11_tests")
377
378
    set(test_files "")
  endif()
Dean Moldovan's avatar
Dean Moldovan committed
379

380
381
382
383
384
  # Support CUDA testing by forcing the target file to compile with NVCC
  if(PYBIND11_CUDA_TESTS)
    set_property(SOURCE ${target}.cpp PROPERTY LANGUAGE CUDA)
  endif()

385
  # Create the binding library
386
387
  pybind11_add_module(${target} THIN_LTO ${target}.cpp ${test_files} ${PYBIND11_HEADERS})
  pybind11_enable_warnings(${target})
388

389
390
391
392
393
394
395
396
397
398
399
400
  if(NOT CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_CURRENT_BINARY_DIR)
    get_property(
      suffix
      TARGET ${target}
      PROPERTY SUFFIX)
    set(source_output "${CMAKE_CURRENT_SOURCE_DIR}/${target}${suffix}")
    if(suffix AND EXISTS "${source_output}")
      message(WARNING "Output file also in source directory; "
                      "please remove to avoid confusion: ${source_output}")
    endif()
  endif()

401
  if(MSVC)
402
    target_compile_options(${target} PRIVATE /utf-8)
Jason Rhinelander's avatar
Jason Rhinelander committed
403
  endif()
Dean Moldovan's avatar
Dean Moldovan committed
404

405
  if(EIGEN3_FOUND)
406
    target_link_libraries(${target} PRIVATE Eigen3::Eigen)
407
408
409
410
    target_compile_definitions(${target} PRIVATE -DPYBIND11_TEST_EIGEN)
  endif()

  if(Boost_FOUND)
411
    target_link_libraries(${target} PRIVATE Boost::headers)
412
    target_compile_definitions(${target} PRIVATE -DPYBIND11_TEST_BOOST)
413
  endif()
Dean Moldovan's avatar
Dean Moldovan committed
414

415
416
  target_link_libraries(${target} PRIVATE ${STD_FS_LIB})

417
418
  # Always write the output file directly into the 'tests' directory (even on MSVC)
  if(NOT CMAKE_LIBRARY_OUTPUT_DIRECTORY)
419
420
    set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY
                                               "${CMAKE_CURRENT_BINARY_DIR}")
421
422
423
424
425
426
427
428

    if(DEFINED CMAKE_CONFIGURATION_TYPES)
      foreach(config ${CMAKE_CONFIGURATION_TYPES})
        string(TOUPPER ${config} config)
        set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY_${config}
                                                   "${CMAKE_CURRENT_BINARY_DIR}")
      endforeach()
    endif()
429
430
  endif()
endforeach()
Dean Moldovan's avatar
Dean Moldovan committed
431

432
# Make sure pytest is found or produce a warning
433
pybind11_find_import(pytest VERSION 3.1)
434

435
436
437
438
439
440
441
442
443
444
445
if(NOT CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_CURRENT_BINARY_DIR)
  # This is not used later in the build, so it's okay to regenerate each time.
  configure_file("${CMAKE_CURRENT_SOURCE_DIR}/pytest.ini" "${CMAKE_CURRENT_BINARY_DIR}/pytest.ini"
                 COPYONLY)
  file(APPEND "${CMAKE_CURRENT_BINARY_DIR}/pytest.ini"
       "\ntestpaths = \"${CMAKE_CURRENT_SOURCE_DIR}\"")

endif()

# cmake 3.12 added list(transform <list> prepend
# but we can't use it yet
446
string(REPLACE "test_" "${CMAKE_CURRENT_SOURCE_DIR}/test_" PYBIND11_ABS_PYTEST_FILES
447
448
               "${PYBIND11_PYTEST_FILES}")

449
450
451
452
set(PYBIND11_TEST_PREFIX_COMMAND
    ""
    CACHE STRING "Put this before pytest, use for checkers and such")

Dean Moldovan's avatar
Dean Moldovan committed
453
# A single command to compile and run the tests
Henry Schreiner's avatar
Henry Schreiner committed
454
455
add_custom_target(
  pytest
456
457
  COMMAND ${PYBIND11_TEST_PREFIX_COMMAND} ${PYTHON_EXECUTABLE} -m pytest
          ${PYBIND11_ABS_PYTEST_FILES}
Henry Schreiner's avatar
Henry Schreiner committed
458
  DEPENDS ${test_targets}
459
  WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
Henry Schreiner's avatar
Henry Schreiner committed
460
  USES_TERMINAL)
461

462
if(PYBIND11_TEST_OVERRIDE)
Henry Schreiner's avatar
Henry Schreiner committed
463
464
465
466
467
  add_custom_command(
    TARGET pytest
    POST_BUILD
    COMMAND ${CMAKE_COMMAND} -E echo
            "Note: not all tests run: -DPYBIND11_TEST_OVERRIDE is in effect")
468
469
endif()

470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
# cmake-format: off
add_custom_target(
  memcheck
  COMMAND
    PYTHONMALLOC=malloc
    valgrind
    --leak-check=full
    --show-leak-kinds=definite,indirect
    --errors-for-leak-kinds=definite,indirect
    --error-exitcode=1
    --read-var-info=yes
    --track-origins=yes
    --suppressions="${CMAKE_CURRENT_SOURCE_DIR}/valgrind-python.supp"
    --suppressions="${CMAKE_CURRENT_SOURCE_DIR}/valgrind-numpy-scipy.supp"
    --gen-suppressions=all
    ${PYTHON_EXECUTABLE} -m pytest ${PYBIND11_ABS_PYTEST_FILES}
  DEPENDS ${test_targets}
  WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
  USES_TERMINAL)
# cmake-format: on

Jason Rhinelander's avatar
Jason Rhinelander committed
491
492
493
494
495
# 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.
496
if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
Jason Rhinelander's avatar
Jason Rhinelander committed
497
498
499
  return()
endif()

500
# Add a post-build comment to show the primary test suite .so size and, if a previous size, compare it:
501
add_custom_command(
Henry Schreiner's avatar
Henry Schreiner committed
502
503
504
505
  TARGET pybind11_tests
  POST_BUILD
  COMMAND
    ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/../tools/libsize.py
506
507
    $<TARGET_FILE:pybind11_tests>
    ${CMAKE_CURRENT_BINARY_DIR}/sosize-$<TARGET_FILE_NAME:pybind11_tests>.txt)
508

509
510
511
if(NOT PYBIND11_CUDA_TESTS)
  # Test embedding the interpreter. Provides the `cpptest` target.
  add_subdirectory(test_embed)
512

513
514
515
  # Test CMake build using functions and targets from subdirectory or installed location
  add_subdirectory(test_cmake_build)
endif()