Merge pull request #70 from dav-og/feature/testing-framework

test(build,docs): integrate testing framework; migrate regression suites; add Windows build script

- Introduces regression testing framework and helpers.
- Migrates suites: sphere decay, RM3, OSWEC, F3OF DT1/DT2/DT3.
- Unifies reference data and comparison scripts; improves test logging.
- Adds `quick-build.ps1` and `build-config.example.json`; ignores machine-local `build-config.json`.
- Updates README with config-driven Windows build instructions and DLL notes.
- CMake: link Chrono/Eigen as imported targets (PUBLIC) and make include discovery robust when `Chrono_DIR` points to a build tree.
- Updates `.gitignore`.

No known breaking changes.

Author: dav-og

.gitignore

@@ -1,7 +1,6 @@
 # IDE Specific
 .vs/
 *.launch
-*.json
 .editorconfig
 
 # Compiled source
@@ -50,3 +49,8 @@ demos/F3OF/f3of/
 sandbox/
 Testing/Temporary/CTestCostData.txt
 Testing/Temporary/LastTest.log
+
+# Test results (ignore all results/ directories)
+results/
+**/results/
+build-config.json

CMakeLists.txt

@@ -35,7 +35,7 @@ endif()
 #--------------------------------------------------------------
 
 project(HydroChrono 
-	VERSION 0.2.5
+	VERSION 0.2.6
 	DESCRIPTION "A hydrodynamic library for use with Project Chrono."
 	LANGUAGES CXX
 )
@@ -59,6 +59,7 @@ option (HYDROCHRONO_ENABLE_IRRLICHT "Enable irrlicht visualization library" ON)
 option (HYDROCHRONO_ENABLE_DEMOS "Enable demo executables" ON)
 option (HYDROCHRONO_ENABLE_USER_DOC "User's documentation" OFF)
 option (HYDROCHRONO_ENABLE_PROG_DOC "Programmer's documentation" OFF)
+option (HYDROCHRONO_ENABLE_LOGGING "Enable debug logging" OFF)
 
 
 # find required packages and libraries to make HydroChrono library
@@ -74,8 +75,44 @@ else(HYDROCHRONO_ENABLE_IRRLICHT)
 endif(HYDROCHRONO_ENABLE_IRRLICHT)
 
 set(HDF5_USE_STATIC_LIBRARIES ON)
+
+# Configure HDF5 to find its dependencies from its installation
+set(HDF5_ROOT "${HDF5_ROOT}" CACHE PATH "HDF5 root directory")
+
 find_package(HDF5 REQUIRED COMPONENTS CXX)
 
+# ---- Eigen: support both CONFIG and module modes ----
+find_package(Eigen3 QUIET CONFIG)
+if (NOT Eigen3_FOUND)
+  find_package(Eigen3 REQUIRED)  # module mode -> EIGEN3_INCLUDE_DIR
+endif()
+
+# ---- Chrono include path: prefer imported target; fall back to vars; fall back to build tree ----
+set(HC_CHRONO_INCLUDE_DIRS "")
+
+# Prefer INTERFACE includes from an imported target, if provided
+if (TARGET Chrono::Chrono_core)
+  get_target_property(HC_CHRONO_INCLUDE_DIRS Chrono::Chrono_core INTERFACE_INCLUDE_DIRECTORIES)
+endif()
+
+# Fallback to legacy variable if the package sets it
+if (NOT HC_CHRONO_INCLUDE_DIRS AND DEFINED CHRONO_INCLUDE_DIRS)
+  set(HC_CHRONO_INCLUDE_DIRS ${CHRONO_INCLUDE_DIRS})
+endif()
+
+# Derive from Chrono_DIR when using Chrono from a build tree (headers live under <chrono_root>/src)
+if (NOT HC_CHRONO_INCLUDE_DIRS AND DEFINED Chrono_DIR)
+  get_filename_component(_CHR_CMAKE_DIR "${Chrono_DIR}" ABSOLUTE)     # .../chrono/build/cmake
+  get_filename_component(_CHR_BUILD_DIR "${_CHR_CMAKE_DIR}" DIRECTORY)# .../chrono/build
+  get_filename_component(_CHR_ROOT      "${_CHR_BUILD_DIR}" DIRECTORY)# .../chrono
+  set(_CHR_INC_CAND "${_CHR_ROOT}/src")
+  if (EXISTS "${_CHR_INC_CAND}/chrono/core/ChMatrix.h")
+    set(HC_CHRONO_INCLUDE_DIRS "${_CHR_INC_CAND}")
+  endif()
+endif()
+
+
+
 
 #-----------------------------------------------------------------------------
 # Fix for VS 2017 15.8 and newer to handle alignment specification with Eigen
@@ -101,6 +138,27 @@ if(MSVC)
     add_compile_options(/wd4251)                   # class needs to have dll-interface
 endif()
 
+# --------------------------------------------------
+# Global output directory structure
+# --------------------------------------------------
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+
+# Replicate for multi-config generators (e.g. Visual Studio, Xcode, Ninja Multi-Config)
+if(CMAKE_CONFIGURATION_TYPES)
+  foreach(cfg ${CMAKE_CONFIGURATION_TYPES})
+    string(TOUPPER "${cfg}" cfg_uc)
+    set(CMAKE_RUNTIME_OUTPUT_DIRECTORY_${cfg_uc} ${CMAKE_RUNTIME_OUTPUT_DIRECTORY})
+    set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_${cfg_uc} ${CMAKE_LIBRARY_OUTPUT_DIRECTORY})
+    set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_${cfg_uc} ${CMAKE_ARCHIVE_OUTPUT_DIRECTORY})
+  endforeach()
+endif()
+
+# Category-specific output folders
+set(HYDROCHRONO_DEMO_OUTPUT_DIR ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/demos CACHE PATH "Output directory for demo executables")
+set(HYDROCHRONO_TEST_OUTPUT_DIR ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/tests CACHE PATH "Output directory for test executables")
+
 # =======================
 # HydroChrono Library
 # =======================
@@ -111,33 +169,46 @@ set(HYDROCHRONO_SOURCES
 	src/hydro_forces.cpp
 	src/helper.cpp
 	src/wave_types.cpp
+	src/logging.cpp
 
 )
 
 add_library(HydroChrono STATIC ${HYDROCHRONO_SOURCES} )
 
 target_compile_features(HydroChrono PUBLIC cxx_std_17)
 
-target_include_directories(
-	HydroChrono
-
-	PUBLIC
-	$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
-	$<INSTALL_INTERFACE:include>
-	${CHRONO_INCLUDE_DIRS}
-
-	PRIVATE
-	${CMAKE_CURRENT_SOURCE_DIR}/
-	${CMAKE_CURRENT_SOURCE_DIR}/include
-	${HDF5_INCLUDE_DIRS}
+# target_include_directories(
+	# HydroChrono
+
+	# PUBLIC
+	# $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+	# $<INSTALL_INTERFACE:include>
+	# ${CHRONO_INCLUDE_DIRS}
+
+	# PRIVATE
+	# ${CMAKE_CURRENT_SOURCE_DIR}/
+	# ${CMAKE_CURRENT_SOURCE_DIR}/include
+	# ${HDF5_INCLUDE_DIRS}
+# )
+
+target_include_directories(HydroChrono
+  PUBLIC
+    $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+    $<INSTALL_INTERFACE:include>
+    ${HC_CHRONO_INCLUDE_DIRS}     # <— ensures chrono/ headers are visible
+  PRIVATE
+    ${CMAKE_CURRENT_SOURCE_DIR}
+    ${CMAKE_CURRENT_SOURCE_DIR}/include
+    ${HDF5_INCLUDE_DIRS}
 )
 
 target_compile_definitions(HydroChrono
-
 	PUBLIC
 		CHRONO_DATA_DIR=\"${CHRONO_DATA_DIR}\"
+		HYDROCHRONO_VERSION=\"${PROJECT_VERSION}\"
+		HYDROCHRONO_BUILD_TYPE=\"$<IF:$<CONFIG:Debug>,Debug,$<IF:$<CONFIG:Release>,Release,$<IF:$<CONFIG:RelWithDebInfo>,RelWithDebInfo,$<IF:$<CONFIG:MinSizeRel>,MinSizeRel,Unknown>>>>\"
 	PRIVATE 
-		
+		$<$<BOOL:${HYDROCHRONO_ENABLE_LOGGING}>:HYDROCHRONO_ENABLE_LOGGING=1>
 )
 
 target_compile_options(HydroChrono BEFORE 
@@ -155,14 +226,19 @@ set_target_properties(HydroChrono
 	POSITION_INDEPENDENT_CODE ON
 )
 
-target_link_libraries(HydroChrono 
-	PUBLIC
-		${CHRONO_LIBRARIES}		
-	PRIVATE
-		${HDF5_LIBRARIES}
-
+target_link_libraries(HydroChrono
+  PUBLIC
+    ${CHRONO_TARGETS}             # Chrono::Chrono_core;Chrono::Chrono_irrlicht;...
+    $<$<TARGET_EXISTS:Eigen3::Eigen>:Eigen3::Eigen>
+  PRIVATE
+    ${HDF5_LIBRARIES}
 )
 
+# If Eigen is module-mode (no imported target), include its dir
+if (NOT TARGET Eigen3::Eigen AND DEFINED EIGEN3_INCLUDE_DIR)
+  target_include_directories(HydroChrono PUBLIC ${EIGEN3_INCLUDE_DIR})
+endif()
+
 # ====================
 # Irrlicht GUI helper
 # ====================
@@ -179,13 +255,11 @@ target_sources(
 target_compile_features(HydroChronoGUI PUBLIC cxx_std_17)
 
 
-target_include_directories(
-	HydroChronoGUI
-
-	PUBLIC
-		$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
-		$<INSTALL_INTERFACE:include>
-		${CHRONO_INCLUDE_DIRS}
+target_include_directories(HydroChronoGUI
+  PUBLIC
+    $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+    $<INSTALL_INTERFACE:include>
+    ${HC_CHRONO_INCLUDE_DIRS}
 )
 
 target_compile_options(HydroChronoGUI BEFORE
@@ -199,10 +273,15 @@ target_link_options(HydroChronoGUI BEFORE
 )
 
 target_link_libraries(HydroChronoGUI
-	PRIVATE
-		${CHRONO_LIBRARIES}
+  PUBLIC
+    ${CHRONO_TARGETS}
+    $<$<TARGET_EXISTS:Eigen3::Eigen>:Eigen3::Eigen>
 )
 
+if (NOT TARGET Eigen3::Eigen AND DEFINED EIGEN3_INCLUDE_DIR)
+  target_include_directories(HydroChronoGUI PUBLIC ${EIGEN3_INCLUDE_DIR})
+endif()
+
 
 
 # ====================
@@ -227,8 +306,13 @@ if(HYDROCHRONO_ENABLE_TESTS)
 
 	include(CTest)
 	enable_testing()
+    
+    set(CHRONO_DLL_DIR "${Chrono_DIR}/../bin/Release")
+    set(IRRLICHT_DLL_DIR "C:/libs/irrlicht-1.8.4/bin/Win64-VisualStudio")
+    set(TEST_ENVIRONMENT "PATH=${CHRONO_DLL_DIR};${IRRLICHT_DLL_DIR};$ENV{PATH}")
 
 	add_subdirectory(tests)
+	add_subdirectory(tests/regression)
 
 endif(HYDROCHRONO_ENABLE_TESTS)
 
@@ -280,3 +364,6 @@ export(
     FILE "${CMAKE_CURRENT_BINARY_DIR}/cmake/HydroChronoTargets.cmake"
     NAMESPACE HydroChrono::
 )
+
+# Set build type to Release but enable debug symbols
+set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /Zi /O2")