Add a memcheck cmake target

- Add a memcheck cmake target
- Reformat cmake
- Appease the formatting overlords - they are angry
- Format CMake valgrind target decently

Author: bstaletic

tests/CMakeLists.txt

@@ -370,10 +370,30 @@ endif()
 string(REPLACE "test_" "${CMAKE_CURRENT_SOURCE_DIR}/test_" PYBIND11_ABS_PYTEST_FILES
                "${PYBIND11_PYTEST_FILES}")
 
+if(NOT PYBIND11_MEMCHECK)
+  set(PYBIND11_TEST_PREFIX_COMMAND "")
+else()
+  # cmake-format: off
+  set(PYBIND11_TEST_PREFIX_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)
+  # cmake-format: on
+endif()
+
 # A single command to compile and run the tests
 add_custom_target(
   pytest
-  COMMAND ${PYTHON_EXECUTABLE} -m pytest ${PYBIND11_ABS_PYTEST_FILES}
+  COMMAND ${PYBIND11_TEST_PREFIX_COMMAND} ${PYTHON_EXECUTABLE} -m pytest
+          ${PYBIND11_ABS_PYTEST_FILES}
   DEPENDS ${test_targets}
   WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
   USES_TERMINAL)
@@ -386,6 +406,11 @@ if(PYBIND11_TEST_OVERRIDE)
             "Note: not all tests run: -DPYBIND11_TEST_OVERRIDE is in effect")
 endif()
 
+add_custom_target(
+  memcheck
+  DEPENDS pytest
+  WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
+
 # Add a check target to run all the tests, starting with pytest (we add dependencies to this below)
 add_custom_target(check DEPENDS pytest)
 

tests/valgrind-python.supp

@@ -115,3 +115,21 @@
    fun:_PyImport_FindSharedFuncptr
    fun:_PyImport_LoadDynamicModuleWithSpec
 }
+
+# Not really CPython-specific, see link
+{
+   dlopen leak (https://stackoverflow.com/questions/1542457/memory-leak-reported-by-valgrind-in-dlopen)
+   Memcheck:Leak
+   fun:malloc
+   ...
+   fun:dl_open_worker
+   fun:_dl_catch_exception
+   fun:_dl_open
+   fun:dlopen_doit
+   fun:_dl_catch_exception
+   fun:_dl_catch_error
+   fun:_dlerror_run
+   fun:dlopen@@GLIBC_2.2.5
+   fun:_PyImport_FindSharedFuncptr
+   fun:_PyImport_LoadDynamicModuleWithSpec
+}