CMakeLists.txt 8 KB
Newer Older
Jason Rhinelander's avatar
Jason Rhinelander committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# 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.

cmake_minimum_required(VERSION 2.8.12)

option(PYBIND11_WERROR  "Report all warnings as errors"  OFF)

if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
    # 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
    project(pybind11_tests)

    find_package(pybind11 REQUIRED CONFIG)
endif()

Dean Moldovan's avatar
Dean Moldovan committed
20
21
if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
  message(STATUS "Setting tests build type to MinSizeRel as none was specified")
22
23
24
  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
25
26
endif()

27
# Full set of test files (you can override these; see below)
Dean Moldovan's avatar
Dean Moldovan committed
28
29
set(PYBIND11_TEST_FILES
  test_buffers.cpp
30
  test_builtin_casters.cpp
Dean Moldovan's avatar
Dean Moldovan committed
31
  test_call_policies.cpp
Dean Moldovan's avatar
Dean Moldovan committed
32
  test_callbacks.cpp
33
  test_chrono.cpp
34
  test_class.cpp
Dean Moldovan's avatar
Dean Moldovan committed
35
  test_constants_and_functions.cpp
36
  test_copy_move.cpp
37
  test_docstring_options.cpp
38
  test_eigen.cpp
39
  test_enum.cpp
Dean Moldovan's avatar
Dean Moldovan committed
40
41
42
  test_eval.cpp
  test_exceptions.cpp
  test_kwargs_and_defaults.cpp
43
  test_local_bindings.cpp
Dean Moldovan's avatar
Dean Moldovan committed
44
45
  test_methods_and_attributes.cpp
  test_modules.cpp
Dean Moldovan's avatar
Dean Moldovan committed
46
  test_multiple_inheritance.cpp
47
  test_numpy_array.cpp
Dean Moldovan's avatar
Dean Moldovan committed
48
49
50
51
52
  test_numpy_dtypes.cpp
  test_numpy_vectorize.cpp
  test_opaque_types.cpp
  test_operator_overloading.cpp
  test_pickling.cpp
53
  test_pytypes.cpp
Dean Moldovan's avatar
Dean Moldovan committed
54
  test_sequences_and_iterators.cpp
Dean Moldovan's avatar
Dean Moldovan committed
55
  test_smart_ptr.cpp
56
  test_stl.cpp
Dean Moldovan's avatar
Dean Moldovan committed
57
58
59
60
  test_stl_binders.cpp
  test_virtual_functions.cpp
)

61
# Invoking cmake with something like:
62
#     cmake -DPYBIND11_TEST_OVERRIDE="test_callbacks.cpp;test_picking.cpp" ..
63
64
65
66
67
68
# lets you override the tests that get compiled and run.  You can restore to all tests with:
#     cmake -DPYBIND11_TEST_OVERRIDE= ..
if (PYBIND11_TEST_OVERRIDE)
  set(PYBIND11_TEST_FILES ${PYBIND11_TEST_OVERRIDE})
endif()

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

71
72
73
74
# 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.
set(PYBIND11_CROSS_MODULE_TESTS
75
  test_exceptions.py
76
  test_local_bindings.py
77
78
)

79
80
81
82
83
# 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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
  # 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.
  if (NOT CMAKE_VERSION VERSION_LESS 3.0)
    find_package(Eigen3 QUIET CONFIG)
    if (EIGEN3_FOUND)
      if (EIGEN3_VERSION_STRING AND NOT EIGEN3_VERSION_STRING VERSION_LESS 3.3.1)
        set(PYBIND11_EIGEN_VIA_TARGET 1)
      endif()
    endif()
  endif()
  if (NOT EIGEN3_FOUND)
    # Couldn't load via target, so fall back to allowing module mode finding, which will pick up
    # tools/FindEigen3.cmake
    find_package(Eigen3 QUIET)
  endif()
100
101

  if(EIGEN3_FOUND)
Jason Rhinelander's avatar
Jason Rhinelander committed
102
103
104
105
106
107
    # 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()
108
109
110
111
112
    message(STATUS "Building tests with Eigen v${EIGEN3_VERSION}")
  else()
    list(REMOVE_AT PYBIND11_TEST_FILES ${PYBIND11_TEST_FILES_EIGEN_I})
    message(STATUS "Building tests WITHOUT Eigen")
  endif()
Dean Moldovan's avatar
Dean Moldovan committed
113
114
endif()

Jason Rhinelander's avatar
Jason Rhinelander committed
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# Compile with compiler warnings turned on
function(pybind11_enable_warnings target_name)
  if(MSVC)
    target_compile_options(${target_name} PRIVATE /W4)
  else()
      target_compile_options(${target_name} PRIVATE -Wall -Wextra -Wconversion -Wcast-qual)
  endif()

  if(PYBIND11_WERROR)
    if(MSVC)
      target_compile_options(${target_name} PRIVATE /WX)
    else()
      target_compile_options(${target_name} PRIVATE -Werror)
    endif()
  endif()
endfunction()

132
set(test_targets pybind11_tests)
Jason Rhinelander's avatar
Jason Rhinelander committed
133

134
135
136
137
138
139
140
141
# 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)
  if (i GREATER -1)
    list(APPEND test_targets pybind11_cross_module_tests)
    break()
  endif()
endforeach()
142

143
144
145
146
147
148
set(testdir ${CMAKE_CURRENT_SOURCE_DIR})
foreach(tgt ${test_targets})
  set(test_files ${PYBIND11_TEST_FILES})
  if(NOT tgt STREQUAL "pybind11_tests")
    set(test_files "")
  endif()
Dean Moldovan's avatar
Dean Moldovan committed
149

150
151
152
  # Create the binding library
  pybind11_add_module(${tgt} THIN_LTO ${tgt}.cpp
    ${test_files} ${PYBIND11_HEADERS})
153

154
155
156
157
  pybind11_enable_warnings(${tgt})

  if(MSVC)
    target_compile_options(${tgt} PRIVATE /utf-8)
Jason Rhinelander's avatar
Jason Rhinelander committed
158
  endif()
Dean Moldovan's avatar
Dean Moldovan committed
159

160
161
162
163
164
165
166
167
  if(EIGEN3_FOUND)
    if (PYBIND11_EIGEN_VIA_TARGET)
      target_link_libraries(${tgt} PRIVATE Eigen3::Eigen)
    else()
      target_include_directories(${tgt} PRIVATE ${EIGEN3_INCLUDE_DIR})
    endif()
    target_compile_definitions(${tgt} PRIVATE -DPYBIND11_TEST_EIGEN)
  endif()
Dean Moldovan's avatar
Dean Moldovan committed
168

169
170
171
172
173
174
175
176
177
  # Always write the output file directly into the 'tests' directory (even on MSVC)
  if(NOT CMAKE_LIBRARY_OUTPUT_DIRECTORY)
    set_target_properties(${tgt} PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${testdir})
    foreach(config ${CMAKE_CONFIGURATION_TYPES})
      string(TOUPPER ${config} config)
      set_target_properties(${tgt} PROPERTIES LIBRARY_OUTPUT_DIRECTORY_${config} ${testdir})
    endforeach()
  endif()
endforeach()
Dean Moldovan's avatar
Dean Moldovan committed
178

179
# Make sure pytest is found or produce a fatal error
180
if(NOT PYBIND11_PYTEST_FOUND)
181
182
183
184
185
186
187
188
  execute_process(COMMAND ${PYTHON_EXECUTABLE} -c "import pytest; print(pytest.__version__)"
                  RESULT_VARIABLE pytest_not_found OUTPUT_VARIABLE pytest_version ERROR_QUIET)
  if(pytest_not_found)
    message(FATAL_ERROR "Running the tests requires pytest. Please install it manually"
                        " (try: ${PYTHON_EXECUTABLE} -m pip install pytest)")
  elseif(pytest_version VERSION_LESS 3.0)
    message(FATAL_ERROR "Running the tests requires pytest >= 3.0. Found: ${pytest_version}"
                        "Please update it (try: ${PYTHON_EXECUTABLE} -m pip install -U pytest)")
189
  endif()
Wenzel Jakob's avatar
Wenzel Jakob committed
190
  set(PYBIND11_PYTEST_FOUND TRUE CACHE INTERNAL "")
191
192
endif()

193
194
195
196
197
198
if(CMAKE_VERSION VERSION_LESS 3.2)
  set(PYBIND11_USES_TERMINAL "")
else()
  set(PYBIND11_USES_TERMINAL "USES_TERMINAL")
endif()

Dean Moldovan's avatar
Dean Moldovan committed
199
# A single command to compile and run the tests
200
add_custom_target(pytest COMMAND ${PYTHON_EXECUTABLE} -m pytest ${PYBIND11_PYTEST_FILES}
201
                  DEPENDS ${test_targets} WORKING_DIRECTORY ${testdir} ${PYBIND11_USES_TERMINAL})
202

203
204
205
206
207
if(PYBIND11_TEST_OVERRIDE)
  add_custom_command(TARGET pytest POST_BUILD
    COMMAND ${CMAKE_COMMAND} -E echo "Note: not all tests run: -DPYBIND11_TEST_OVERRIDE is in effect")
endif()

Jason Rhinelander's avatar
Jason Rhinelander committed
208
209
210
211
212
213
214
215
216
# 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.
if (NOT PROJECT_NAME STREQUAL "pybind11")
  return()
endif()

217
# Add a post-build comment to show the primary test suite .so size and, if a previous size, compare it:
218
add_custom_command(TARGET pybind11_tests POST_BUILD
219
  COMMAND ${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/tools/libsize.py
220
221
  $<TARGET_FILE:pybind11_tests> ${CMAKE_CURRENT_BINARY_DIR}/sosize-$<TARGET_FILE_NAME:pybind11_tests>.txt)

222
223
224
# Test embedding the interpreter. Provides the `cpptest` target.
add_subdirectory(test_embed)

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