[QC-515] Fix analysis json generation in Example and stop polluting src dir (#584)

Author: Barthelemy

Modules/Example/CMakeLists.txt

@@ -25,14 +25,19 @@ install(TARGETS QcExample
         ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
         RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
 
+# ---- Workflows for analysis ----
+
 # Install the config files for the analysis.
 # The command "install" cannot be used because it would be executed after o2_add_qc_workflow which relies on
 # the config files being already installed in the right place.
+# Note: There is an issue with ninja when a "configured" file is deleted. https://gitlab.kitware.com/cmake/cmake/-/issues/18985
+#       The set_property should fix it.
 configure_file("etc/analysisDirect.json" "${CMAKE_INSTALL_PREFIX}/etc/analysisDirect.json")
+set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${CMAKE_INSTALL_PREFIX}/etc/analysisDirect.json")
 configure_file("etc/analysisDerived.json" "${CMAKE_INSTALL_PREFIX}/etc/analysisDerived.json")
+set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${CMAKE_INSTALL_PREFIX}/etc/analysisDerived.json")
 
-# ---- Workflows for analysis ----
-
+# We cannot point to the json files in the source dir because the path will be reused in the produced json.
 o2_add_qc_workflow(WORKFLOW_NAME o2-qc-example-analysis-direct CONFIG_FILE_PATH ${CMAKE_INSTALL_PREFIX}/etc/analysisDirect.json)
 o2_add_qc_workflow(WORKFLOW_NAME o2-qc-example-analysis-derived CONFIG_FILE_PATH ${CMAKE_INSTALL_PREFIX}/etc/analysisDerived.json)
 

cmake/AddQCWorkflow.cmake

@@ -19,30 +19,6 @@ include_guard()
 # under share/dpl directory
 #
 
-#function(o2_add_qc_workflow workflowName configurationFile)
-#
-#  set(jsonDumpFile ${workflowName}.json)
-#  set(qcExecutable o2-qc)
-#
-#  install(CODE "message(\"Generating a workflow dump with the command: ${CMAKE_INSTALL_PREFIX}/bin/${qcExecutable} -b --config json:/${CMAKE_INSTALL_PREFIX}/${configurationFile} --dump-workflow --dump-workflow-file ${CMAKE_CURRENT_BINARY_DIR}/${jsonDumpFile}\")")
-#  install(CODE "execute_process(
-#    COMMAND ${CMAKE_INSTALL_PREFIX}/bin/${qcExecutable} -b --config json:/${CMAKE_INSTALL_PREFIX}/${configurationFile} --dump-workflow --dump-workflow-file ${CMAKE_CURRENT_BINARY_DIR}/${jsonDumpFile}
-#    )")
-##  install(CODE "execute_process(
-##    COMMAND echo 'QUALITYCONTROL_ROOT: ${QUALITYCONTROL_ROOT}'
-##  )")
-##  install(CODE "execute_process(
-##    COMMAND pwd
-##  )")
-##  install(CODE "execute_process(
-##    COMMAND which bin/o2-qc
-##  )")
-#  install(
-#    FILES ${CMAKE_CURRENT_BINARY_DIR}/${jsonDumpFile}
-#    DESTINATION ${CMAKE_INSTALL_DATADIR}/dpl)
-#
-#endfunction()
-
 function(o2_add_qc_workflow)
 
   cmake_parse_arguments(
@@ -56,10 +32,8 @@ function(o2_add_qc_workflow)
   if(NOT PARSED_ARGS_WORKFLOW_NAME OR NOT PARSED_ARGS_CONFIG_FILE_PATH)
     message(FATAL_ERROR "You must provide a workflow name and a config file path")
   endif()
-  message(STATUS "o2_add_qc_workflow called with config file ${PARSED_ARGS_CONFIG_FILE_PATH} to generate ${PARSED_ARGS_WORKFLOW_NAME}")
-
-  set(jsonDumpFile ${CMAKE_CURRENT_SOURCE_DIR}/${PARSED_ARGS_WORKFLOW_NAME}.json)
-  message(STATUS "jsonDumpFile: ${jsonDumpFile}" )
+  set(jsonDumpFile ${CMAKE_CURRENT_BINARY_DIR}/${PARSED_ARGS_WORKFLOW_NAME}.json)
+  message(STATUS "o2_add_qc_workflow called with config file ${PARSED_ARGS_CONFIG_FILE_PATH} to generate ${jsonDumpFile}")
   set(qcExecutable o2-qc)
 
   add_custom_command(
@@ -73,7 +47,6 @@ function(o2_add_qc_workflow)
   add_custom_target(${filename} ALL DEPENDS ${jsonDumpFile})
 
   # will install the rootmap and pcm files alongside the target's lib
-  install(FILES ${jsonDumpFile}
-    DESTINATION ${CMAKE_INSTALL_DATADIR}/dpl)
+  install(FILES ${jsonDumpFile} DESTINATION ${CMAKE_INSTALL_DATADIR}/dpl)
 
 endfunction()