Merge branch 'test-shared-lib-loading' into 'master'

Work around library loading issues and test shared lib loading

See merge request ogs/ogs!5384

Author: Dmitri Naumov

CMakeLists.txt

@@ -287,3 +287,11 @@ if(OGS_BUILD_WHEEL)
         message(FATAL_ERROR "Binary list comparison failed. Please update binaries_list in provide_ogs_cli_tools_via_wheel.py!")
     endif()
 endif()
+
+if(TARGET ogs_test_dlopen)
+    # Has to come last in this top-level CMakeLists.txt to add tests for all shared libraries.
+    # We pass ${Python_LIBRARIES} as additional lib(s) to load, because many OGS libs
+    # (e.g. each process, because of a cyclic dependency between the generic process lib and (Python) BCs)
+    # depend on them and they are not explicitly linked against.
+    for_each_subdir("${PROJECT_SOURCE_DIR}" add_dlopen_tests ${Python_LIBRARIES})
+endif()

ProcessLib/ProcessVariable.cpp

@@ -213,11 +213,6 @@ ProcessVariable::ProcessVariable(
 
 ProcessVariable::ProcessVariable(ProcessVariable&&) = default;
 
-std::string const& ProcessVariable::getName() const
-{
-    return _name;
-}
-
 MeshLib::Mesh const& ProcessVariable::getMesh() const
 {
     return _mesh;

ProcessLib/ProcessVariable.h

@@ -72,7 +72,7 @@ class ProcessVariable
 
     ProcessVariable(ProcessVariable&&);
 
-    std::string const& getName() const;
+    std::string const& getName() const { return _name; }
 
     /// Returns a mesh on which the process variable is defined.
     MeshLib::Mesh const& getMesh() const;

Tests/CMakeLists.txt

@@ -198,3 +198,5 @@ endif()
 # cmake-format: on
 
 unset(CMAKE_FOLDER)
+
+add_subdirectory(Dlopen)

Tests/Dlopen/CMakeLists.txt

@@ -0,0 +1,41 @@
+if(LINUX)
+    add_executable(ogs_test_dlopen dlopen.cpp)
+
+    # Adds ogs_test_dlopen tests for each shared library in the passed dir.
+    # Any surplus arguments (${ARGN}) are added as commandline arguments to the test command.
+    function(add_dlopen_tests dir)
+        get_directory_property(_targets DIRECTORY "${dir}" BUILDSYSTEM_TARGETS)
+
+        foreach(target IN LISTS _targets)
+            get_target_property(_type ${target} TYPE)
+            if(_type STREQUAL "SHARED_LIBRARY")
+                add_test(
+                    NAME "dlopen_${target}"
+                    COMMAND $<TARGET_FILE:ogs_test_dlopen> ${ARGN} $<TARGET_FILE:${target}>)
+                set_tests_properties("dlopen_${target}" PROPERTIES DEPENDS ogs_test_dlopen)
+            endif()
+        endforeach()
+    endfunction()
+
+    # Invokes the passed callback for each subdirectory of the passed directory (and for dir itself).
+    # Only subdirectories of the ${PROJECT_SOURCE_DIR} are considered.
+    # Any surplus arguments (${ARGN}) are passed on to the callback.
+    function(for_each_subdir dir callback)
+        if(COMMAND ${callback})
+            cmake_language(CALL "${callback}" "${dir}" ${ARGN})
+        else()
+            message(FATAL_ERROR "Callback ${callback} is not a valid function")
+        endif()
+
+        get_directory_property(_subdirs DIRECTORY "${dir}" SUBDIRECTORIES)
+
+        foreach(subdir IN LISTS _subdirs)
+            string(FIND "${subdir}" "${PROJECT_SOURCE_DIR}" _index)
+            if(NOT _index EQUAL 0)
+                continue()
+            endif()
+
+            for_each_subdir("${subdir}" "${callback}" ${ARGN})
+        endforeach()
+    endfunction()
+endif()

Tests/Dlopen/dlopen.cpp

@@ -0,0 +1,45 @@
+/**
+ * \file
+ * \copyright
+ * Copyright (c) 2012-2025, OpenGeoSys Community (http://www.opengeosys.org)
+ *            Distributed under a Modified BSD License.
+ *              See accompanying file LICENSE.txt or
+ *              http://www.opengeosys.org/project/license
+ *
+ */
+
+#include <dlfcn.h>
+
+#include <cassert>
+#include <iostream>
+
+void* load(char const* lib)
+{
+    void* handle = dlopen(lib, RTLD_NOW | RTLD_GLOBAL);
+
+    if (!handle)
+    {
+        std::cerr << dlerror() << '\n';
+        std::exit(EXIT_FAILURE);
+    }
+
+    dlerror(); /* Clear any existing error */
+
+    return handle;
+}
+
+int main(int argc, char** argv)
+{
+    if (argc < 2)
+    {
+        std::cerr << "you invoked this command without arguments\n";
+        std::exit(EXIT_FAILURE);
+    }
+
+    for (int i = 1; i < argc; ++i)
+    {
+        void* handle = load(argv[i]);
+        std::cout << "lib address of " << argv[i] << " is: " << handle
+                  << std::endl;
+    }
+}

scripts/ci/extends/test-artifacts.yml

@@ -3,6 +3,7 @@
     when: always
     paths:
       - build/*/logs
+      - build/*/Testing/Temporary/LastTestsFailed*.log
       - build/*/Tests/ctest-junit.xml
       - build/*/Tests/testrunner.xml
       - build/*/make.txt

scripts/ci/jobs/package.yml

@@ -70,12 +70,26 @@ aggregate ctest logs:
   tags: [envinf, shell]
   script:
     - |
+      out_root=build/log_summary
       python -m venv .venv_custom_job
       . .venv_custom_job/bin/activate
       pip install pandas
       mkdir -p build/log_summary
       set -x
-      Applications/Python/ogs/dev/ogs_log_summary.py --snippet-out --out build/log_summary/ -v build/*/logs &>build/log_summary/ogs_log_summary.txt
+      Applications/Python/ogs/dev/ogs_log_summary.py --snippet-out --out "$out_root" -v build/*/logs &>"$out_root/ogs_log_summary.txt"
+      #
+      # summarize failed ctests
+      #
+      function exists() {
+        [ -e "$1" ]
+      }
+      if exists build/*/Testing/Temporary/LastTestsFailed*.log
+      then
+        out_dir="$out_root/Testing/Temporary"
+        mkdir -p "$out_dir"
+        echo "### Failed ctests from all jobs (and number of jobs where they failed):"
+        cut -d':' -f2- build/*/Testing/Temporary/LastTestsFailed*.log | sort | uniq -c | tee "$out_dir/LastTestsFailed.log"
+      fi
   rules:
     - when: always
   artifacts: