Fix #438, add three PDI deactivation option through CMake

.github/actions/test/action.yml

@@ -38,13 +38,12 @@ runs:
   steps:
     - id: test
       shell: bash
-      run: |
+      run: | # not using ' export CTEST_FLAGS="--output-junit /tmp/tests.xml" ' anymore because of paths appending error for ubuntu/focal, for multiples junit output files
         cat<<-'EOF' > run.sh
           set -xe
           JOBID="$(echo "${{github.run_id}}"|md5sum|cut -b 1)"
           if [[ "01234567" == *"${JOBID}"* ]]; then export PDI_PLUGIN_PATH=/tmp/pdi_plugins; fi
           export MAKEFLAGS='-j 4'
-          export CTEST_FLAGS="--output-junit /tmp/tests.xml"
           export TEST_DIR="/tmp_dir_test"
           /src/bin/build_and_run_all_tests
         EOF
@@ -54,11 +53,11 @@ runs:
           --tmpfs /tmp_dir_test:exec \
           ${{inputs.image}} \
           bash /src/run.sh
-        if docker cp "$(cat docker.cid)":/tmp/tests.xml tests.xml
+        if docker cp "$(cat docker.cid)":/tmp/. ./
         then echo "with_report=true" >> "$GITHUB_OUTPUT"
         else echo "with_report=false" >> "$GITHUB_OUTPUT"
         fi
     - id: Publish
       uses: mikepenz/action-junit-report@v4
       if: always() && steps.test.outputs.with_report == 'true' # always run even if the previous step fails
-      with: { report_paths: 'tests.xml' }
+      with: { report_paths: 'tests*.xml' }

.github/pull_request_template.md

@@ -6,7 +6,8 @@ Before merging your code, please check the following:
 
 * [ ] you have added a line describing your changes to the Changelog;
 * [ ] you have added unit tests for any new or improved feature;
-* [ ] In case you updated dependencies, you have checked pdi/docs/CheckList.md
+* [ ] in case you updated dependencies, you have checked pdi/docs/CheckList.md;
+* [ ] in case of a change in pdi.h, this same change must be reflected in no-pdi/include/pdi.h;
 * you have checked your code format:
   - [ ] you have checked that you respect all conventions specified in CONTRIBUTING.md;
   - [ ] you have checked that the indentation and formatting conforms to the `.clang-format`;

AUTHORS

@@ -7,7 +7,8 @@ each sub-project (including PDI itself) is located in the dedicated sub-project
 AUTHORS file.
 
 Julian Auriac - CEA ([email protected])
-* fix CI bug where tests.xml file could not be written
+* Add pdi deactivation option
+* Fix CI bug where tests.xml file could not be written
 
 Julien Bigot - CEA ([email protected])
 * Maintainer (Dec. 2014 - ...)
@@ -25,7 +26,7 @@ François-Xavier Mordant - CEA ([email protected])
 * Bug fix, JSON plugin
 
 Jacques Morice - CEA ([email protected])
-* fix the directory of hdf5 library for rhel
+* Fix the directory of hdf5 library for rhel
 
 Thomas Padioleau - CEA ([email protected])
 * Added macOS CI

CHANGELOG.md

@@ -11,6 +11,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## [Unreleased]
 
 ### Added
+* Add "no-pdi", including the header no-pdi/include/pdi.h, which allows to
+  disable PDI effects while keeping code syntax unchanged.
+  [#438](https://github.com/pdidev/pdi/issues/438)
 * Added macOS CI for PDI, decl_hdf5, mpi, serialize, set_value, user_code and
   trace plugins [#556](https://github.com/pdidev/pdi/issues/556)
 

CMakeLists.txt

@@ -558,3 +558,11 @@ sbuild_add_module(PDI_TESTS
 	INSTALL_COMMAND ""
 	SUBSTEPS test
 )
+
+sbuild_add_module(PDI_TEST_API
+	ENABLE_BUILD_FLAG BUILD_TESTING
+	SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/test_api"
+	DEPENDS PDI
+	INSTALL_COMMAND ""
+	SUBSTEPS test
+)

bin/build_and_run_all_tests

@@ -33,7 +33,7 @@ set -xe
 
 
 
-# Make our work dirs
+# Make work directories
 
 SRCDIR="${PWD}"
 
@@ -42,12 +42,19 @@ cd "${TEST_DIR}"
 cd "$(mktemp -d pdibuild.XXXXX)"
 TEST_DIR="${PWD}"
 
+TEST_DIR_WITH_PDI="${TEST_DIR}/with_pdi"
+mkdir "${TEST_DIR_WITH_PDI}"
+
+TEST_DIR_NO_PDI="${TEST_DIR}/no_pdi"
+mkdir "${TEST_DIR_NO_PDI}"
+
+TEST_DIR_API="${TEST_DIR}/api"
+mkdir "${TEST_DIR_API}"
+
 cd "${SRCDIR}"
 cd "$(dirname "$0")/.."
 SRCDIR="${PWD}"
 
-cd "${TEST_DIR}"
-
 
 
 # Gather options
@@ -122,8 +129,26 @@ fi
 
 
 
-# Configure, build & test
+# Configure, build & test for pdi, including example and test_api
 
+cd "${TEST_DIR_WITH_PDI}"
 cmake -DDIST_PROFILE=Devel ${CMAKE_FLAGS} "${SRCDIR}"
 make ${MAKEFLAGS}
-ctest --output-on-failure --timeout 90 ${CTEST_FLAGS} ${EXCLUDED_PDI_TESTS:+-E $EXCLUDED_PDI_TESTS}
+ctest --output-on-failure --timeout 90 --output-junit /tmp/tests_pdi.xml ${EXCLUDED_PDI_TESTS:+-E $EXCLUDED_PDI_TESTS}
+
+# Configure, build & test for pdi's example with CMAKE_PREFIX_PATH (find_package) for no-pdi, only with Paraconf
+
+if [[ "x${PDI_LIBS}" = "xprovided" ]]; then
+
+	cd "${TEST_DIR_NO_PDI}"
+	cmake -DCMAKE_PREFIX_PATH="${SRCDIR}/no-pdi" "${SRCDIR}/example"
+	make ${MAKEFLAGS}
+	ctest --output-on-failure --timeout 90 --output-junit /tmp/tests_no-pdi_example.xml -R PDI_example_trace_C
+fi
+
+# Configure, build & test for pdi's API specific tests with CMAKE_PREFIX_PATH (find_package) for no-pdi, with or without Paraconf
+
+cd "${TEST_DIR_API}"
+cmake -DCMAKE_PREFIX_PATH="${SRCDIR}/no-pdi" "${SRCDIR}/test_api"
+make ${MAKEFLAGS}
+ctest --output-on-failure --timeout 90 --output-junit /tmp/tests_no-pdi_api.xml

example/CMakeLists.txt

@@ -1,5 +1,5 @@
 #=============================================================================
-# Copyright (C) 2015-2024 Commissariat a l'energie atomique et aux energies alternatives (CEA)
+# Copyright (C) 2015-2025 Commissariat a l'energie atomique et aux energies alternatives (CEA)
 # Copyright (C) 2020 Institute of Bioorganic Chemistry Polish Academy of Science (PSNC)
 # All rights reserved.
 #
@@ -32,11 +32,20 @@ project(pdi_examples LANGUAGES C)
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")
 
 set(MPI_COMPONENTS C)
+set(paraconf_COMPONENTS C)
 set(PDI_COMPONENTS C)
 
+option(BUILD_DECL_HDF5_PLUGIN   "Build Decl'HDF5 plug-in"    OFF)
+option(BUILD_DECL_NETCDF_PLUGIN "Build Decl'NetCDF plug-in"  OFF)
+option(BUILD_FORTRAN            "Build with Fortran support" OFF)
+option(BUILD_PYCALL_PLUGIN      "Build Pycall plug-in"       OFF)
+option(BUILD_PYTHON             "Build with Python support"  OFF)
+option(BUILD_JSON_PLUGIN        "Build JSON plugin"          OFF)
+
 if("${BUILD_FORTRAN}")
 	enable_language(Fortran)
 	list(APPEND MPI_COMPONENTS Fortran)
+	list(APPEND PARACONF_COMPONENTS "f90")
 	list(APPEND PDI_COMPONENTS f90)
 endif()
 
@@ -48,6 +57,7 @@ endif()
 # Includes
 include(CTest)
 find_package(MPI REQUIRED COMPONENTS ${MPI_COMPONENTS})
+find_package(paraconf REQUIRED COMPONENTS ${paraconf_COMPONENTS})
 find_package(PDI REQUIRED COMPONENTS ${PDI_COMPONENTS})
 find_library(LIB_M m DOC "The math library")
 
@@ -77,7 +87,8 @@ endif()
 
 
 add_executable(PDI_example_C example.c)
-target_link_libraries(PDI_example_C PDI::PDI_C MPI::MPI_C m)
+target_link_libraries(PDI_example_C paraconf::paraconf PDI::PDI_C MPI::MPI_C m)
+
 
 if("${BUILD_FORTRAN}")
 add_executable(PDI_example_F example.F90)

example/README.md

@@ -117,3 +117,10 @@ Above instruction will share `iter` and `main_field`, call `newiter` event and t
 This is the place when plugins will read/write our data.
 
 We have covered the logic behind the %PDI example. Now you can start the \ref Hands_on.
+
+## PDI deactivation {#pdi_deactivation}
+
+Use `no-pdi` instead of `pdi` when building with:
+```bash
+cmake -DCMAKE_MODULE_PATH=<ABSOLUTE_PATH_TO>/no-pdi ..
+```

no-pdi/CMakeLists.txt

@@ -0,0 +1,33 @@
+#=============================================================================
+# Copyright (C) 2025 Commissariat a l'energie atomique et aux energies alternatives (CEA)
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the names of CEA, nor the names of the contributors may be used to
+#   endorse or promote products derived from this software without specific
+#   prior written  permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#=============================================================================
+
+cmake_minimum_required(VERSION 3.16...3.29)
+project(PDI LANGUAGES C)
+
+include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/PDIConfig.cmake")

no-pdi/cmake/PDIConfig.cmake

@@ -0,0 +1,43 @@
+#=============================================================================
+# Copyright (C) 2025 Commissariat a l'energie atomique et aux energies alternatives (CEA)
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the names of CEA, nor the names of the contributors may be used to
+#   endorse or promote products derived from this software without specific
+#   prior written  permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#=============================================================================
+
+add_library(PDI_C INTERFACE)
+add_library(PDI::pdi   ALIAS PDI_C)
+add_library(PDI::PDI_C ALIAS PDI_C)
+
+set_target_properties(PDI_C PROPERTIES
+    INTERFACE_INCLUDE_DIRECTORIES "${CMAKE_CURRENT_LIST_DIR}/../include"
+)
+
+find_package(paraconf QUIET COMPONENTS C)
+
+if(paraconf_FOUND)
+    target_link_libraries(PDI_C INTERFACE paraconf::paraconf)
+    target_compile_definitions(PDI_C INTERFACE PARACONF_FOUND)
+endif()

no-pdi/cmake/PDIConfigVersion.cmake

@@ -0,0 +1,30 @@
+#=============================================================================
+# Copyright (C) 2025 Commissariat a l'energie atomique et aux energies alternatives (CEA)
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the names of CEA, nor the names of the contributors may be used to
+#   endorse or promote products derived from this software without specific
+#   prior written  permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#=============================================================================
+
+set(PDI_VERSION "1.9.2")