unittests: start introducing unit tests in Idefix (currently for the lookupTable) by svalat · Pull Request #419 · idefix-code/idefix

svalat · 2026-10-14T14:35:06Z

This PR introduces the usage of GoogleTest in the Idefix sources via the first use case about the LookupTable.

In the build system

GoogleTest is automatically downloaded by the CMake script in version 1.18.0 via the function GoogleTestDownloadAndLink() implemented in cmake/HandleDeps.cmake.

Due to the limitation discussed in next part I cannot safely use the system GoogleTest because I don't know the version on which I fall on form the sources.

The core functions of Idefix has been moved into libidefix-core to be linked to idefix as for the new unittests exacultable.

GTest limitation with KOKKOS_LAMBDA

When building a unit test defined via TEST(..., ...) with a KOKKOS_LAMDA inside we cannot compile with
NVCC because it complains about the fact the the function generated by TEST() is private.

A fix has been proposed to Google in 2022 but they rejected it due to non standard
behavior of the compiler : google/googletest#4104

I currently override inside Idefix the GTEST_TEST_ macro applying the private -> public change but to be safe
it makes the code sticked to a specific version of GoogleTest.

With this fix everything is working as long as we #include "gtest-idfx.hpp" in each test file.

Idefix & MPI & Kokkos init

A new main() has been defined in gtest-idfx.cpp to be used to launch the unit tests with Kokkos and MPI initialized.

Extra assertions

When we will progress in unit testing Idefix we will need to validation some IdefixXDArrays. I already defined some dedicated macros
to get a simple semantic reusing all the matchers provided by
GoogleTest & GoogleMock.

#include "gtest-idfx.hpp"

//check all 5 static
ASSERT_THAT_1D_ARRAY(a, testing::Eq, 6);

//compare both array
ASSERT_THAT_1D_ARRAYS(a, testing::Eq, b);

//compare with near
ASSERT_THAT_1D_ARRAYS_ARGS(a, testing::DoubleNear, b, 0.001);

There is a full example of use in src/test/testArrays.hpp.

First ported tests

The LoopkupTable test has been translated to GoogeTest and is first real
test in Idefix.

Building and launching

You need to activate -DIdefix_GTEST=ON to build the unit tests.

# configure
mkdir build-unittests
cd build-unittests
cmake .. -DIdefix_GTEST=ON -DIdefix_PROBLEM_DIR=../test/MHD/AxisFluxTube/

# build
make

# run all
./unittest

Intégration in github actions

I patched the github action scripts so they first build & run the unittests
for each mode (CUDA / Intel / gcc).

It currently run first the unit tests then run the integration tests the time
to validate. I will revert that behavior before doing the final merge.

TODO

Revert the unittest priority in github action before merging.

…lookupTable)

… download GoogleTest if not found on the system

…d IdefixXDArray 1D,2D,3D,4D

…cmake + add a missing test file

…() + remove some useless redundant tests

…mem representation

…fix required

…ease debugging

…ix target not in libidefix-core

…x-core splitting

glesur

Already addressed in this branch: the UnitTests job in .github/workflows/idefix-ci-jobs.yml was inserted as the first job; it is now moved back to the end of the jobs: list, restoring the previous ordering (per the PR TODO).

Change requests

cmake/ReplaceIdefixSource.cmake:16 — broken for non-main.cpp replacements since the core split. The match/uniqueness check queries get_target_property(fullsource idefix SOURCES), but core sources now live in idefix-core (the idefix target only holds main.cpp + the problem setup.cpp). Any non-main.cpp replacement now trips the spurious SEND_ERROR "no source file match". Fix: compute _target_name first and use get_target_property(fullsource ${_target_name} SOURCES). (Only test/skeleton uses this today, with main.cpp, which is why CI is green.)
CMake minimum vs. the GTEST path. CMakeLists.txt:19 declares cmake_minimum_required(VERSION 3.16), but the GTEST path uses cmake_policy(SET CMP0135 NEW) (cmake/HandleDeps.cmake:21, requires CMake ≥ 3.27 — hard configure error on older versions) and cmake --fresh (scripts/ci/run-unit-tests:87, requires ≥ 3.24). Please guard with if(POLICY CMP0135) / drop --fresh, or raise the minimum when Idefix_GTEST=ON.
doc/source/programmingguide.rst:733 — stale pointer. "Usage examples are provided in test/utils/lookupTable" — that directory is deleted by this PR. Point to src/utils/tests/testLookupTable.cpp instead.

Nits

CMakeLists.txt:34: stray ) in the Idefix_GTEST option help string.
CMakeLists.txt:116: optional modernization — add_test(NAME unittests COMMAND unittests).
cmake/HandleDeps.cmake:16,20: typos — "verison" → "version"; "# it not, download it internally" → "# if not found on the system, download it internally".
Wrong Source file header paths: src/gtest-idfx.hpp:4 and src/gtest-idfx.cpp:4 say src/utils/gtest-idfx.hpp (files live in src/); src/tests/testKokkos.cpp:4 and src/tests/testArrays.cpp:4 say .hpp (they are .cpp); src/utils/tests/testLookupTable.cpp:4 says src/utils/testLookupTable.hpp; src/utils/tests/data/gendata.py:4 still says test/utils/lookupTable/testmelib.py after the move/rename.
src/gtest-idfx.hpp:388: "GEST_TEST_" → "GTEST_TEST_"; doc comments say "patcher matcher" (×12) and "recieve" (×6); src/gtest-idfx.cpp says "environnement" (×3).
src/utils/tests/testLookupTable.cpp: leftover commented-out //idfx::cout debug lines (200, 222, 235, 249, 302, 332, 502, 509, 547, 569) — remove them, or keep deliberately as debugging aids.

glesur · 2026-11-01T20:05:26Z

@@ -16,6 +16,12 @@ function(replace_idefix_source _old_source _new_source)
  get_target_property(fullsource idefix SOURCES)


Since the idefix-core split, this query looks at the wrong target: idefix no longer holds the core sources (only main.cpp + problem setup.cpp). Any non-main.cpp replacement now hits the spurious SEND_ERROR "no source file match" below. Fix: move the _target_name computation (lines 19-23) above this line and use get_target_property(fullsource ${_target_name} SOURCES).

glesur · 2026-11-01T20:05:26Z

+  set(gtest_version "1.18.0")
+
+  # it not, download it internally to the project
+  cmake_policy(SET CMP0135 NEW)


cmake_minimum_required(VERSION 3.16) in the root CMakeLists.txt, but CMP0135 requires CMake >= 3.27 and hard-errors at configure time on older versions. Please guard with if(POLICY CMP0135) ... endif() or raise the minimum when Idefix_GTEST=ON.

glesur · 2026-11-01T20:05:26Z

+######################################################################################
+
+function(GoogleTestDownloadAndLink)
+  # CAUTION: if you change this verison, you should also check if you need to adapt


Typo: "verison" -> "version". (Line 20: "# it not, download it internally" -> "# if not found on the system, download it internally".)

glesur · 2026-11-01T20:05:26Z

+display_and_run mkdir -p build-unittests
+
+# configure via cmake
+display_and_run cmake . -B ./build-unittests -DIdefix_GTEST=ON -DIdefix_PROBLEM_DIR=$PWD/test/MHD/AxisFluxTube/ $(gen_cmake_options "$@") --fresh


--fresh requires CMake >= 3.24, but the project declares cmake_minimum_required(VERSION 3.16). Consider dropping --fresh (the build dir is already created above) or documenting the requirement.

glesur · 2026-11-01T20:05:26Z

 option(Idefix_MPI "enable Message Passing Interface parallelisation" OFF)
 option(Idefix_HIGH_ORDER_FARGO "Force Fargo to use a PPM reconstruction scheme" OFF)
 option(Idefix_DEBUG "Enable Idefix debug features (makes the code very slow)" OFF)
+option(Idefix_GTEST "Enable building unittests with GoogleTest framework)" OFF)


Stray ) at the end of the option help string: "Enable building unittests with GoogleTest framework)".

glesur · 2026-11-01T20:05:26Z

+if (Idefix_GTEST)
+  add_executable(unittests)
+  target_link_libraries(unittests GTest::gtest GTest::gmock)
+  add_test(unittests unittests)


Optional: modern signature add_test(NAME unittests COMMAND unittests) instead of the positional form.

glesur · 2026-11-01T20:05:26Z

+// ***********************************************************************************
+// Idefix MHD astrophysical code
+//
+// Source file src/utils/gtest-idfx.hpp


Header says Source file src/utils/gtest-idfx.hpp but the file lives in src/. Same in src/gtest-idfx.cpp:4. Also line 388: "GEST_TEST_" -> "GTEST_TEST_"; "patcher matcher"/"recieve" wording in the matcher doc comments.

glesur · 2026-11-01T20:05:26Z

+  int dataIdx[2];
+  csv1D.GetNeighboursHost(xq, xN, dataN);
+  csv1D.GetNeighboursIndxHost(xq, idx, dataIdx);
+  //idfx::cout << "1D: x=" << xN[0] << "," << xN[1] << " data=" << dataN[0] << "," << dataN[1]


Leftover commented-out //idfx::cout debug lines throughout this file (200, 222, 235, 249, 302, 332, 502, 509, 547, 569) - remove them or keep deliberately. Header line 4 also has a wrong path (src/utils/testLookupTable.hpp).

glesur · 2026-11-01T20:11:59Z

Duplicated review (made offline), so marked as resolved the second one :-)

svalat added 22 commits October 5, 2026 16:30

unittests: start introducing unit tests in Idefix (currently for the …

731af59

…lookupTable)

unittest: register ./unitests in "make test"

44847c8

unittest: Port all lookuptable tests in googletest framework

831f174

unittest: Make unit tests optional at build time via Idefix_GTEST and…

51f2aee

… download GoogleTest if not found on the system

tests: Build some examples how to simply compare some Kokkos::view an…

feeff77

…d IdefixXDArray 1D,2D,3D,4D

test: move search GTest in a function and dedicated cmake/HandleDeps.…

96fa3f3

…cmake + add a missing test file

tests: introduce runs of the unit test in github actions

d9e2db9

tests: fix header of cmake/HandleDeps.cmake

94b23fb

tests: remove CPU loop to replace them by idefix_for() & parallel_for…

6cea3f8

…() + remove some useless redundant tests

test: oops fix loop order to have the right inner loop on the idefix …

9ef1ea1

…mem representation

test: fix GoogleTest usage with KOKKOS_LAMBDA

b4d79a4

test: add missing fences when running on GPU

eaac4e4

test: force using downloaded v1.18.0 of googletest due to the Kokkos …

fe0b954

…fix required

test: oops add missing Kokkos::deep_copy() when running on GPU

6f57aa3

test: rename the host variable to reuse the original name + _host to …

87786b3

…ease debugging

unittests: fix argc, argv issues

216d840

unittest: fix test dependencies

44b3f5a

unittests: fix an issue in CMakeLists.txt

01d0568

unittest: due to weak symbol usage, setup.cpp should be build in idef…

af6d87e

…ix target not in libidefix-core

unittest: should apply suppress_fma also on libidefix-core

ba96dff

unittests: fix mistake in replace_idefix_source() due to idefix/idefi…

0aa81b6

…x-core splitting

unittest: remove utils/loopupTable which is now tests in unittests

9e0fbe7

svalat added the enhancement New feature or request label Oct 30, 2026

glesur reviewed Nov 1, 2026

View reviewed changes

		@@ -16,6 +16,12 @@ function(replace_idefix_source _old_source _new_source)
		get_target_property(fullsource idefix SOURCES)

Conversation

svalat commented Oct 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

In the build system

GTest limitation with KOKKOS_LAMBDA

Idefix & MPI & Kokkos init

Extra assertions

First ported tests

Building and launching

Intégration in github actions

TODO

Uh oh!

glesur left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Change requests

Nits

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

glesur commented Nov 1, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

svalat commented Oct 14, 2026 •

edited

Loading

glesur left a comment •

edited

Loading