Reorganize the CMake configuration for the tests (#428)

* Fix repeated download of test inputs if they are alrady present

* Split tests into subdirectories to declutter things a bit

* Move test utility functionality into dedicated file

- Introduce PODIO_SET_TEST_ENV function to set consistent test environment

* Move dumpmodel roundtrip tests into separate subfolder

* Move commonly used declaration to separate header (Fixes clang-tidy not being able to find an included header otherwise)

CMakeLists.txt

@@ -169,12 +169,13 @@ install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/NOTICE
         DESTINATION ${CMAKE_INSTALL_DOCDIR})
 
 #--- project specific subdirectories -------------------------------------------
-add_subdirectory(python)
 add_subdirectory(src)
 if(BUILD_TESTING)
+  include(cmake/podioTest.cmake)
   add_subdirectory(tests)
 endif()
 add_subdirectory(tools)
+add_subdirectory(python)
 
 #--- add CMake infrastructure --------------------------------------------------
 include(cmake/podioCreateConfig.cmake)

cmake/podioTest.cmake

@@ -0,0 +1,52 @@
+#--- small utility helper function to set a consistent test environment for the passed test
+
+function(PODIO_SET_TEST_ENV test)
+  # We need to convert this into a list of arguments that can be used as environment variable
+  list(JOIN PODIO_IO_HANDLERS " " IO_HANDLERS)
+  set_property(TEST ${test}
+    PROPERTY ENVIRONMENT
+      LD_LIBRARY_PATH=${CMAKE_BINARY_DIR}/tests:${CMAKE_BINARY_DIR}/src:$<TARGET_FILE_DIR:ROOT::Tree>:$<$<TARGET_EXISTS:SIO::sio>:$<TARGET_FILE_DIR:SIO::sio>>:$ENV{LD_LIBRARY_PATH}
+      PYTHONPATH=${CMAKE_SOURCE_DIR}/python:$ENV{PYTHONPATH}
+      PODIO_SIOBLOCK_PATH=${CMAKE_BINARY_DIR}/tests
+      ROOT_INCLUDE_PATH=${CMAKE_BINARY_DIR}/tests/datamodel:${CMAKE_SOURCE_DIR}/include
+      SKIP_SIO_TESTS=$<NOT:$<BOOL:${ENABLE_SIO}>>
+      IO_HANDLERS=${IO_HANDLERS}
+      PODIO_USE_CLANG_FORMAT=${PODIO_USE_CLANG_FORMAT}
+      PODIO_BASE=${CMAKE_SOURCE_DIR}
+      ENABLE_SIO=${ENABLE_SIO}
+  )
+endfunction()
+
+#--- small utility helper function to allow for a more terse definition of tests below
+function(CREATE_PODIO_TEST sourcefile additional_libs)
+  string( REPLACE ".cpp" "" name ${sourcefile} )
+  add_executable( ${name} ${sourcefile} )
+  add_test(NAME ${name} COMMAND ${name})
+
+  target_link_libraries(${name} PRIVATE TestDataModel ExtensionDataModel ${additional_libs})
+  PODIO_SET_TEST_ENV(${name})
+endfunction()
+
+#--- utility macro to facilitate the downloading of legacy input data
+macro(PODIO_DOWNLOAD_LEGACY_INPUTS)
+  # Avoid fetching these everytime cmake is run by caching the directory the first
+  # time the inputs are fetched or if the expected file does not exist in the
+  # expected directory
+  if (NOT DEFINED CACHE{PODIO_TEST_INPUT_DATA_DIR} OR NOT EXISTS ${PODIO_TEST_INPUT_DATA_DIR}/v00-16-05/example_frame.root)
+    message(STATUS "Getting test input files")
+    execute_process(
+      COMMAND bash ${CMAKE_SOURCE_DIR}/tests/scripts/get_test_inputs.sh
+      OUTPUT_VARIABLE podio_test_input_data_dir
+      RESULT_VARIABLE test_inputs_available
+    )
+    if (NOT "${test_inputs_available}" STREQUAL "0")
+      message(WARNING "Could not get test input files. Will skip some tests that depend on these")
+      # Catch cases where the variable is cached but the file no longer exists
+      unset(PODIO_TEST_INPUT_DATA_DIR CACHE)
+    else()
+      message(STATUS "Test inputs stored in: " ${podio_test_input_data_dir})
+      set(PODIO_TEST_INPUT_DATA_DIR ${podio_test_input_data_dir} CACHE INTERNAL "input dir for test inputs fetched from remote sources")
+      mark_as_advanced(PODIO_TEST_INPUT_DATA_DIR)
+    endif()
+  endif()
+endmacro()

python/CMakeLists.txt

@@ -1,6 +1,5 @@
 SET(podio_PYTHON_INSTALLDIR python)
 SET(podio_PYTHON_INSTALLDIR ${podio_PYTHON_INSTALLDIR} PARENT_SCOPE)
-SET(podio_PYTHON_DIR ${CMAKE_CURRENT_LIST_DIR} PARENT_SCOPE)
 
 set(to_install
   podio_class_generator.py
@@ -27,3 +26,14 @@ endif()
 #--- install templates ---------------------------------------------------------
 install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/templates
   DESTINATION ${podio_PYTHON_INSTALLDIR})
+
+IF (BUILD_TESTING)
+  add_test( NAME pyunittest COMMAND python3 -m unittest discover -s ${CMAKE_SOURCE_DIR}/python/podio)
+  PODIO_SET_TEST_ENV(pyunittest)
+
+  set_property(TEST pyunittest PROPERTY DEPENDS write write_frame_root)
+  if (TARGET write_sio)
+    set_property(TEST pyunittest PROPERTY DEPENDS write_sio write_frame_sio)
+  endif()
+  set_property(TEST pyunittest PROPERTY WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/tests)
+ENDIF()

python/podio/test_EventStoreRoot.py

@@ -14,9 +14,9 @@ class EventStoreRootTestCase(EventStoreBaseTestCaseMixin, unittest.TestCase):
   """Test cases for root input files"""
   def setUp(self):
     """Setup an EventStore reading from a ROOT file"""
-    self.filename = 'example.root'
+    self.filename = 'root_io/example.root'
     self.assertTrue(os.path.isfile(self.filename))
-    self.store = EventStore(['example.root'])
+    self.store = EventStore([self.filename])
 
   def test_chain(self):
     self.store = EventStore([self.filename,

python/podio/test_EventStoreSio.py

@@ -14,7 +14,7 @@ class EventStoreSioTestCase(EventStoreBaseTestCaseMixin, unittest.TestCase):
   """Test cases for root input files"""
   def setUp(self):
     """setup an EventStore reading an SIO file"""
-    self.filename = 'example.sio'
+    self.filename = 'sio_io/example.sio'
     self.assertTrue(os.path.isfile(self.filename))
     self.store = EventStore([self.filename])
 

python/podio/test_Frame.py

@@ -46,7 +46,7 @@ def setUp(self):
     Reading only one event/Frame of each category here as looping and other
     basic checks are already handled by the Reader tests
     """
-    reader = Reader('example_frame.root')
+    reader = Reader('root_io/example_frame.root')
     self.event = reader.get('events')[0]
     self.other_event = reader.get('other_events')[7]
 

python/podio/test_ReaderRoot.py

@@ -11,11 +11,11 @@ class RootReaderTestCase(ReaderTestCaseMixin, unittest.TestCase):
   """Test cases for root input files"""
   def setUp(self):
     """Setup the corresponding reader"""
-    self.reader = Reader('example_frame.root')
+    self.reader = Reader('root_io/example_frame.root')
 
 
 class RootLegacyReaderTestCase(LegacyReaderTestCaseMixin, unittest.TestCase):
   """Test cases for the legacy root input files and reader."""
   def setUp(self):
     """Setup a reader, reading from the example files"""
-    self.reader = LegacyReader('example.root')
+    self.reader = LegacyReader('root_io/example.root')

python/podio/test_ReaderSio.py

@@ -13,7 +13,7 @@ class SioReaderTestCase(ReaderTestCaseMixin, unittest.TestCase):
   def setUp(self):
     """Setup the corresponding reader"""
     from podio.sio_io import Reader  # pylint: disable=import-outside-toplevel
-    self.reader = Reader('example_frame.sio')
+    self.reader = Reader('sio_io/example_frame.sio')
 
 
 @unittest.skipIf(SKIP_SIO_TESTS, "no SIO support")
@@ -22,4 +22,4 @@ class SIOLegacyReaderTestCase(LegacyReaderTestCaseMixin, unittest.TestCase):
   def setUp(self):
     """Setup a reader, reading from the example files"""
     from podio.sio_io import LegacyReader  # pylint: disable=import-outside-toplevel
-    self.reader = LegacyReader('example.sio')
+    self.reader = LegacyReader('sio_io/example.sio')