Fix #438, add a deactivation option through CMake

.github/actions/test/action.yml

@@ -44,21 +44,22 @@ runs:
           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 CTEST_DIR="/tmp/tests_output"
           export TEST_DIR="/tmp_dir_test"
           /src/bin/build_and_run_all_tests
         EOF
         docker run \
           --cidfile='docker.cid' \
           -v ${PWD}:/src:ro \
-          --tmpfs /tmp_dir_test:exec \
+          --tmpfs /tmp_dir_test:exec,mode=1777 \
           ${{inputs.image}} \
           bash /src/run.sh
-        if docker cp "$(cat docker.cid)":/tmp/tests.xml tests.xml
+        if docker cp "$(cat docker.cid)":/tmp/tests_output ./
         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' }
+      uses: mikepenz/action-junit-report@v5
+      if: always() && steps.test.outputs.with_report == 'true'
+      with:
+        report_paths: 'tests_output/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`;

.github/workflows/tests-macos.yml

@@ -52,6 +52,7 @@ jobs:
       PDI_SYSTEM: macos
       PDI_COMPILER: clang
       PDI_MPI: openmpi
+      CTEST_DIR: "/tmp/tests_output"
     steps:
     - run: brew install open-mpi
     - uses: actions/checkout@v4
@@ -63,4 +64,4 @@ jobs:
       uses: mikepenz/action-junit-report@v5
       if: ( success() || failure() )  # always run even if the previous step fails
       with:
-        report_paths: '${{github.workspace}}/tests.xml'
+        report_paths: '/tmp/tests_output/tests_*.xml'

AUTHORS

@@ -7,7 +7,8 @@ each sub-project (including PDI itself) is located in the dedicated sub-project
 AUTHORS file.
 
 Julian Auriac - CEA (julian.auriac@cea.fr)
-* 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 (julien.bigot@cea.fr)
 * Maintainer (Dec. 2014 - ...)
@@ -25,7 +26,7 @@ François-Xavier Mordant - CEA (francois-xavier.mordant@cea.fr)
 * Bug fix, JSON plugin
 
 Jacques Morice - CEA (jacques.morice@cea.fr)
-* fix the directory of hdf5 library for rhel
+* Fix the directory of hdf5 library for rhel
 
 Thomas Padioleau - CEA (thomas.padioleau@cea.fr)
 * 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

@@ -75,9 +75,9 @@ option(BUILD_PYTHON             "Build with Python support" "${BUILD_UNSTABLE}")
 option(BUILD_SET_VALUE_PLUGIN   "Build Set_value plug-in" ON)
 option(BUILD_SERIALIZE_PLUGIN   "Build Serialize plug-in" ON)
 option(BUILD_SHARED_LIBS        "Build shared libraries rather than static ones" ON)
-option(BUILD_TRACE_PLUGIN       "Build Trace plugin" ON)
-option(BUILD_USER_CODE_PLUGIN   "Build User-code plugin" ON)
-option(BUILD_JSON_PLUGIN        "Build JSON plugin" OFF)
+option(BUILD_TRACE_PLUGIN       "Build Trace plug-in" ON)
+option(BUILD_USER_CODE_PLUGIN   "Build User-code plug-in" ON)
+option(BUILD_JSON_PLUGIN        "Build JSON plug-in" OFF)
 option(BUILD_DEISA_PLUGIN   	"Build Deisa plug-in" OFF)
 
 
@@ -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,20 +33,28 @@ set -xe
 
 
 
-# Make our work dirs
+# Make work directories
 
 SRCDIR="${PWD}"
 
 TEST_DIR="${TEST_DIR:-${PWD}}"
 cd "${TEST_DIR}"
 cd "$(mktemp -d pdibuild.XXXXX)"
-TEST_DIR="${PWD}"
+TEST_DIR="${PWD}" 	# TEST_DIR is pdibuild.<XXXXX>
+
+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}"
+PDI_ROOT="${PWD}" 	# PDI_ROOT is the root of the pdi repository, 
+					# which contains pdi, no-pdi, and test_api among others
 
 
 
@@ -122,8 +130,29 @@ fi
 
 
 
-# Configure, build & test
+# Create directory for ctest output files.
+mkdir -p ${CTEST_DIR}
+
+# Configure, build & test for pdi, including example and test_api
+
+cd "${TEST_DIR_WITH_PDI}"
+cmake -DDIST_PROFILE=Devel ${CMAKE_FLAGS} "${PDI_ROOT}"
+make ${MAKEFLAGS}
+ctest --output-on-failure --timeout 90 ${CTEST_FLAGS} ${CTEST_DIR:+--output-junit "${CTEST_DIR}/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 if Paraconf is available
+
+if [[ "x${PDI_LIBS}" = "xprovided" ]]; then
+
+	cd "${TEST_DIR_NO_PDI}"
+	cmake -DCMAKE_PREFIX_PATH="${PDI_ROOT}/no-pdi" "${PDI_ROOT}/example"
+	make ${MAKEFLAGS}
+	ctest --output-on-failure --timeout 90 ${CTEST_FLAGS} ${CTEST_DIR:+--output-junit "${CTEST_DIR}/tests_no-pdi_example.xml"} ${EXCLUDED_PDI_TESTS:+-E $EXCLUDED_PDI_TESTS}
+fi
+
+# Configure, build & test for pdi's API specific tests with CMAKE_PREFIX_PATH (find_package) for no-pdi, with or without Paraconf
 
-cmake -DDIST_PROFILE=Devel ${CMAKE_FLAGS} "${SRCDIR}"
+cd "${TEST_DIR_API}"
+cmake -DCMAKE_PREFIX_PATH="${PDI_ROOT}/no-pdi" "${PDI_ROOT}/test_api"
 make ${MAKEFLAGS}
-ctest --output-on-failure --timeout 90 ${CTEST_FLAGS} ${EXCLUDED_PDI_TESTS:+-E $EXCLUDED_PDI_TESTS}
+ctest --output-on-failure --timeout 90 ${CTEST_FLAGS} ${CTEST_DIR:+--output-junit "${CTEST_DIR}/tests_no-pdi_api.xml"} ${EXCLUDED_PDI_TESTS:+-E $EXCLUDED_PDI_TESTS}

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 plug-in"         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)

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,60 @@
+#=============================================================================
+# 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.
+#=============================================================================
+
+# Check for available but not supported components
+if(DEFINED PDI_FIND_COMPONENTS)
+    foreach(component ${PDI_FIND_COMPONENTS})
+        if(NOT component STREQUAL "C")
+            message(FATAL_ERROR 
+                "no-PDI configuration: The component '${component}' is not supported. 
+                Only the C component is supported.")
+        endif()
+    endforeach()
+endif()
+
+# Create the PDI_C target only once
+if(NOT TARGET PDI_C)
+    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"
+    )
+
+    if(NOT TARGET paraconf::paraconf)
+        find_package(paraconf QUIET COMPONENTS C)
+    endif()
+
+    if("${paraconf_FOUND}")
+        target_link_libraries(PDI_C INTERFACE paraconf::paraconf)
+        target_compile_definitions(PDI_C INTERFACE PARACONF_FOUND)
+    endif()
+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")