Merge pull request intel#105 from elbeno/add-pytest-deps

✨ Allow extra dependencies to be specified for python tests

Author: lukevalenty

cmake/coverage.cmake

@@ -50,10 +50,10 @@ else()
     )
 endif()
 
-function(add_coverage_target name)
+function(add_test_coverage_target name)
     message(
         STATUS
-            "add_coverage_target(${name}) is disabled because CMAKE_CXX_COMPILER_ID is ${CMAKE_CXX_COMPILER_ID}."
+            "add_test_coverage_target(${name}) is disabled because CMAKE_CXX_COMPILER_ID is ${CMAKE_CXX_COMPILER_ID}."
     )
 endfunction()
 

cmake/test.cmake

@@ -229,7 +229,7 @@ endfunction()
 
 function(add_python_test_target name)
     set(multiValueArgs FILES INCLUDE_FILES INCLUDE_DIRECTORIES LIBRARIES
-                       EXTRA_ARGS)
+                       EXTRA_ARGS EXTRA_DEPS)
     cmake_parse_arguments(UNIT "" "" "${multiValueArgs}" ${ARGN})
     list(TRANSFORM UNIT_FILES PREPEND "${CMAKE_CURRENT_SOURCE_DIR}/")
     list(TRANSFORM UNIT_INCLUDE_FILES PREPEND "${CMAKE_CURRENT_SOURCE_DIR}/")
@@ -253,13 +253,21 @@ function(add_python_test_target name)
     string(PREPEND name "PYTHON.")
     add_test(NAME ${name} COMMAND ${target_test_command} COMMAND_EXPAND_LISTS)
 
+    foreach(file ${UNIT_FILES})
+        get_filename_component(this_dir ${file} DIRECTORY)
+        if(EXISTS "${this_dir}/conftest.py")
+            list(APPEND auto_dependencies "${this_dir}/conftest.py")
+        endif()
+    endforeach()
+
     add_custom_target(all_${name} ALL DEPENDS run_${name})
     add_custom_target(run_${name} DEPENDS ${name}.passed)
     add_custom_command(
         OUTPUT ${name}.passed
         COMMAND ${target_test_command}
         COMMAND ${CMAKE_COMMAND} "-E" "touch" "${name}.passed"
-        DEPENDS ${UNIT_FILES} ${UNIT_LIBRARIES}
+        DEPENDS ${UNIT_FILES} ${UNIT_LIBRARIES} ${UNIT_EXTRA_DEPS}
+                ${auto_dependencies}
         COMMAND_EXPAND_LISTS)
 
     add_dependencies(python_tests "run_${name}")

docs/testing.adoc

@@ -52,7 +52,8 @@ add_unit_test(
   my_test
   PYTEST
   FILES my_test.py
-  LIBRARIES my_lib)
+  LIBRARIES my_lib
+  EXTRA_DEPS my_header.hpp)
 ----
 
 `add_unit_test` also supports running tests using https://pytest.org[pytest]. In
@@ -62,6 +63,11 @@ handled with pytest's
 https://docs.pytest.org/en/8.0.x/reference/reference.html#pytest.hookspec.pytest_addoption[`addoption`
 hook].
 
+NOTE: The `EXTRA_DEPS` argument allows python tests to specify extra
+dependencies that are not part of the CMake dependency tree. A `conftest.py`
+file in the same directory as any of the `FILE`​s is automatically discovered as
+such a dependency.
+
 === Fuzz tests
 
 [source,cmake]