CMakeLists.txt 9.37 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
set(PYBIND11_TEST_FILES
29
  test_alias_initialization.cpp
Dean Moldovan's avatar
Dean Moldovan committed
30
  test_buffers.cpp
31
  test_builtin_casters.cpp
Dean Moldovan's avatar
Dean Moldovan committed
32
  test_call_policies.cpp
Dean Moldovan's avatar
Dean Moldovan committed
33
  test_callbacks.cpp
34
  test_chrono.cpp
35
  test_class.cpp
Dean Moldovan's avatar
Dean Moldovan committed
36
  test_constants_and_functions.cpp
37
  test_copy_move.cpp
38
  test_docstring_options.cpp
39
  test_eigen.cpp
40
  test_enum.cpp
Dean Moldovan's avatar
Dean Moldovan committed
41
42
43
44
45
46
  test_eval.cpp
  test_exceptions.cpp
  test_inheritance.cpp
  test_kwargs_and_defaults.cpp
  test_methods_and_attributes.cpp
  test_modules.cpp
Dean Moldovan's avatar
Dean Moldovan committed
47
  test_multiple_inheritance.cpp
48
  test_numpy_array.cpp
Dean Moldovan's avatar
Dean Moldovan committed
49
50
51
52
53
  test_numpy_dtypes.cpp
  test_numpy_vectorize.cpp
  test_opaque_types.cpp
  test_operator_overloading.cpp
  test_pickling.cpp
54
  test_pytypes.cpp
Dean Moldovan's avatar
Dean Moldovan committed
55
  test_sequences_and_iterators.cpp
Dean Moldovan's avatar
Dean Moldovan committed
56
  test_smart_ptr.cpp
57
  test_stl.cpp
Dean Moldovan's avatar
Dean Moldovan committed
58
59
60
61
  test_stl_binders.cpp
  test_virtual_functions.cpp
)

62
# Invoking cmake with something like:
63
#     cmake -DPYBIND11_TEST_OVERRIDE="test_callbacks.cpp;test_picking.cpp" ..
64
65
66
67
68
69
# 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()

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

72
73
74
75
76
# 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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
  # 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()
93
94

  if(EIGEN3_FOUND)
Jason Rhinelander's avatar
Jason Rhinelander committed
95
96
97
98
99
100
    # 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()
101
102
103
104
105
    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
106
107
endif()

Jason Rhinelander's avatar
Jason Rhinelander committed
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# 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()


Dean Moldovan's avatar
Dean Moldovan committed
126
# Create the binding library
127
pybind11_add_module(pybind11_tests THIN_LTO pybind11_tests.cpp
128
129
  ${PYBIND11_TEST_FILES} ${PYBIND11_HEADERS})

Dean Moldovan's avatar
Dean Moldovan committed
130
131
pybind11_enable_warnings(pybind11_tests)

132
133
134
135
if(MSVC)
  target_compile_options(pybind11_tests PRIVATE /utf-8)
endif()

Dean Moldovan's avatar
Dean Moldovan committed
136
if(EIGEN3_FOUND)
Jason Rhinelander's avatar
Jason Rhinelander committed
137
138
139
140
141
  if (PYBIND11_EIGEN_VIA_TARGET)
    target_link_libraries(pybind11_tests PRIVATE Eigen3::Eigen)
  else()
    target_include_directories(pybind11_tests PRIVATE ${EIGEN3_INCLUDE_DIR})
  endif()
Dean Moldovan's avatar
Dean Moldovan committed
142
143
144
  target_compile_definitions(pybind11_tests PRIVATE -DPYBIND11_TEST_EIGEN)
endif()

Jason Rhinelander's avatar
Jason Rhinelander committed
145
set(testdir ${CMAKE_CURRENT_SOURCE_DIR})
Dean Moldovan's avatar
Dean Moldovan committed
146
147
148
149
150
151
152
153
154
155

# Always write the output file directly into the 'tests' directory (even on MSVC)
if(NOT CMAKE_LIBRARY_OUTPUT_DIRECTORY)
  set_target_properties(pybind11_tests PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${testdir})
  foreach(config ${CMAKE_CONFIGURATION_TYPES})
    string(TOUPPER ${config} config)
    set_target_properties(pybind11_tests PROPERTIES LIBRARY_OUTPUT_DIRECTORY_${config} ${testdir})
  endforeach()
endif()

156
# Make sure pytest is found or produce a fatal error
157
if(NOT PYBIND11_PYTEST_FOUND)
158
159
160
161
162
163
164
165
  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)")
166
  endif()
Wenzel Jakob's avatar
Wenzel Jakob committed
167
  set(PYBIND11_PYTEST_FOUND TRUE CACHE INTERNAL "")
168
169
endif()

170
171
172
173
174
175
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
176
# A single command to compile and run the tests
177
add_custom_target(pytest COMMAND ${PYTHON_EXECUTABLE} -m pytest ${PYBIND11_PYTEST_FILES}
178
                  DEPENDS pybind11_tests WORKING_DIRECTORY ${testdir} ${PYBIND11_USES_TERMINAL})
179

180
181
182
183
184
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
185
186
187
188
189
190
191
192
193
194
# 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()

# Add a post-build comment to show the .so size and, if a previous size, compare it:
195
add_custom_command(TARGET pybind11_tests POST_BUILD
196
  COMMAND ${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/tools/libsize.py
197
198
  $<TARGET_FILE:pybind11_tests> ${CMAKE_CURRENT_BINARY_DIR}/sosize-$<TARGET_FILE_NAME:pybind11_tests>.txt)

199
200
201
# Test embedding the interpreter. Provides the `cpptest` target.
add_subdirectory(test_embed)

202
203
204
205
# Test CMake build using functions and targets from subdirectory or installed location
add_custom_target(test_cmake_build)
if(NOT CMAKE_VERSION VERSION_LESS 3.1)
  # 3.0 needed for interface library for subdirectory_target/installed_target
Lori A. Burns's avatar
Lori A. Burns committed
206
  # 3.1 needed for cmake -E env for testing
207
208
209
210
211
212
213

  include(CMakeParseArguments)
  function(pybind11_add_build_test name)
    cmake_parse_arguments(ARG "INSTALL" "" "" ${ARGN})

    set(build_options "-DCMAKE_PREFIX_PATH=${PROJECT_BINARY_DIR}/mock_install"
                      "-DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}"
214
                      "-DPYTHON_EXECUTABLE:FILEPATH=${PYTHON_EXECUTABLE}"
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
                      "-DPYBIND11_CPP_STANDARD=${PYBIND11_CPP_STANDARD}")
    if(NOT ARG_INSTALL)
      list(APPEND build_options "-DPYBIND11_PROJECT_DIR=${PROJECT_SOURCE_DIR}")
    endif()

    add_custom_target(test_${name} ${CMAKE_CTEST_COMMAND}
      --quiet --output-log test_cmake_build/${name}.log
      --build-and-test "${CMAKE_CURRENT_SOURCE_DIR}/test_cmake_build/${name}"
                       "${CMAKE_CURRENT_BINARY_DIR}/test_cmake_build/${name}"
      --build-config Release
      --build-noclean
      --build-generator ${CMAKE_GENERATOR}
      $<$<BOOL:${CMAKE_GENERATOR_PLATFORM}>:--build-generator-platform> ${CMAKE_GENERATOR_PLATFORM}
      --build-makeprogram ${CMAKE_MAKE_PROGRAM}
      --build-target check
      --build-options ${build_options}
Lori A. Burns's avatar
Lori A. Burns committed
231
    )
232
233
234
235
236
237
238
239
    if(ARG_INSTALL)
      add_dependencies(test_${name} mock_install)
    endif()
    add_dependencies(test_cmake_build test_${name})
  endfunction()

  pybind11_add_build_test(subdirectory_function)
  pybind11_add_build_test(subdirectory_target)
240
241
242
  if(NOT ${PYTHON_MODULE_EXTENSION} MATCHES "pypy")
    pybind11_add_build_test(subdirectory_embed)
  endif()
243
244
245
246
247

  if(PYBIND11_INSTALL)
    add_custom_target(mock_install ${CMAKE_COMMAND}
      "-DCMAKE_INSTALL_PREFIX=${PROJECT_BINARY_DIR}/mock_install"
      -P "${PROJECT_BINARY_DIR}/cmake_install.cmake"
Lori A. Burns's avatar
Lori A. Burns committed
248
    )
249
250
251

    pybind11_add_build_test(installed_function INSTALL)
    pybind11_add_build_test(installed_target INSTALL)
252
253
254
    if(NOT ${PYTHON_MODULE_EXTENSION} MATCHES "pypy")
      pybind11_add_build_test(installed_embed INSTALL)
    endif()
Lori A. Burns's avatar
Lori A. Burns committed
255
256
  endif()
endif()
257

Jason Rhinelander's avatar
Jason Rhinelander committed
258
add_dependencies(check test_cmake_build)