CTest Environment Update (#756)

* Update test/tools/json-tool.cpp

- push/pop ppid as external correlation id instead of pid

* Update environment variables for tests and samples

* Revert to old CDash dashboard in run-ci.py

* Revert to new CDash dashboard in run-ci.py

samples/advanced_thread_trace/CMakeLists.txt

@@ -44,16 +44,11 @@ target_link_libraries(
     advanced-thread-trace PRIVATE advanced-thread-trace-client Threads::Threads
                                   rocprofiler::samples-build-flags)
 
+rocprofiler_samples_get_preload_env(PRELOAD_ENV advanced-thread-trace-client)
+
 add_test(NAME advanced-thread-trace COMMAND $<TARGET_FILE:advanced-thread-trace>)
 
 set_tests_properties(
     advanced-thread-trace
-    PROPERTIES
-        TIMEOUT
-        45
-        LABELS
-        "samples"
-        ENVIRONMENT
-        "${ROCPROFILER_MEMCHECK_PRELOAD_ENV};HSA_TOOLS_LIB=$<TARGET_FILE:rocprofiler::rocprofiler-shared-library>"
-        FAIL_REGULAR_EXPRESSION
-        "threw an exception")
+    PROPERTIES TIMEOUT 45 LABELS "samples" ENVIRONMENT "${PRELOAD_ENV}"
+               FAIL_REGULAR_EXPRESSION "threw an exception")

samples/api_buffered_tracing/CMakeLists.txt

@@ -43,16 +43,14 @@ target_link_libraries(
     buffered-api-tracing PRIVATE buffered-api-tracing-client Threads::Threads
                                  rocprofiler::samples-build-flags)
 
+rocprofiler_samples_get_preload_env(PRELOAD_ENV buffered-api-tracing-client)
+rocprofiler_samples_get_ld_library_path_env(LIBRARY_PATH_ENV)
+
+set(buffered-api-tracing-env ${PRELOAD_ENV} ${LIBRARY_PATH_ENV})
+
 add_test(NAME buffered-api-tracing COMMAND $<TARGET_FILE:buffered-api-tracing>)
 
 set_tests_properties(
     buffered-api-tracing
-    PROPERTIES
-        TIMEOUT
-        45
-        LABELS
-        "samples"
-        ENVIRONMENT
-        "${ROCPROFILER_MEMCHECK_PRELOAD_ENV};HSA_TOOLS_LIB=$<TARGET_FILE:rocprofiler::rocprofiler-shared-library>"
-        FAIL_REGULAR_EXPRESSION
-        "${ROCPROFILER_DEFAULT_FAIL_REGEX}")
+    PROPERTIES TIMEOUT 45 LABELS "samples" ENVIRONMENT "${buffered-api-tracing-env}"
+               FAIL_REGULAR_EXPRESSION "${ROCPROFILER_DEFAULT_FAIL_REGEX}")

samples/api_callback_tracing/CMakeLists.txt

@@ -46,13 +46,13 @@ target_link_libraries(
     PRIVATE callback-api-tracing-client Threads::Threads
             rocprofiler-sdk-roctx::rocprofiler-sdk-roctx rocprofiler::samples-build-flags)
 
-add_test(NAME callback-api-tracing COMMAND $<TARGET_FILE:callback-api-tracing>)
+rocprofiler_samples_get_preload_env(PRELOAD_ENV callback-api-tracing-client)
+rocprofiler_samples_get_ld_library_path_env(
+    LIBRARY_PATH_ENV rocprofiler-sdk-roctx::rocprofiler-sdk-roctx-shared-library)
 
-set(callback-api-tracing-env
-    ${ROCPROFILER_MEMCHECK_PRELOAD_ENV}
-    "HSA_TOOLS_LIB=$<TARGET_FILE:rocprofiler::rocprofiler-shared-library>"
-    "LD_LIBRARY_PATH=$<TARGET_FILE_DIR:rocprofiler-sdk-roctx::rocprofiler-sdk-roctx-shared-library>:$ENV{LD_LIBRARY_PATH}"
-    )
+set(callback-api-tracing-env ${PRELOAD_ENV} ${LIBRARY_PATH_ENV})
+
+add_test(NAME callback-api-tracing COMMAND $<TARGET_FILE:callback-api-tracing>)
 
 set_tests_properties(
     callback-api-tracing

samples/code_object_isa_decode/CMakeLists.txt

@@ -41,12 +41,6 @@ add_test(NAME code-object-isa-decode COMMAND $<TARGET_FILE:code-object-isa-decod
 
 set_tests_properties(
     code-object-isa-decode
-    PROPERTIES
-        TIMEOUT
-        45
-        LABELS
-        "samples"
-        ENVIRONMENT
-        "${ROCPROFILER_MEMCHECK_PRELOAD_ENV};HSA_TOOLS_LIB=$<TARGET_FILE:rocprofiler::rocprofiler-shared-library>"
-        FAIL_REGULAR_EXPRESSION
-        "threw an exception")
+    PROPERTIES TIMEOUT 45 LABELS "samples" ENVIRONMENT
+               "${ROCPROFILER_MEMCHECK_PRELOAD_ENV}" FAIL_REGULAR_EXPRESSION
+               "threw an exception")

samples/code_object_tracing/CMakeLists.txt

@@ -47,12 +47,6 @@ add_test(NAME code-object-tracing COMMAND $<TARGET_FILE:code-object-tracing>)
 
 set_tests_properties(
     code-object-tracing
-    PROPERTIES
-        TIMEOUT
-        45
-        LABELS
-        "samples"
-        ENVIRONMENT
-        "${ROCPROFILER_MEMCHECK_PRELOAD_ENV};HSA_TOOLS_LIB=$<TARGET_FILE:rocprofiler::rocprofiler-shared-library>"
-        FAIL_REGULAR_EXPRESSION
-        "${ROCPROFILER_DEFAULT_FAIL_REGEX}")
+    PROPERTIES TIMEOUT 45 LABELS "samples" ENVIRONMENT
+               "${ROCPROFILER_MEMCHECK_PRELOAD_ENV}" FAIL_REGULAR_EXPRESSION
+               "${ROCPROFILER_DEFAULT_FAIL_REGEX}")

samples/common/CMakeLists.txt

@@ -40,3 +40,47 @@ if(EXISTS ${EXTERNAL_SUBMODULE_DIR}/filesystem/include/ghc/filesystem.hpp)
         rocprofiler-samples-common-library SYSTEM
         INTERFACE $<BUILD_INTERFACE:${EXTERNAL_SUBMODULE_DIR}/filesystem/include>)
 endif()
+
+# function for getting the LD_PRELOAD environment variable
+function(rocprofiler_samples_get_preload_env _VAR)
+    set(_PRELOAD_ENV_LIBS ${ROCPROFILER_MEMCHECK_PRELOAD_ENV_VALUE} $ENV{LD_PRELOAD})
+
+    foreach(_TARG ${ARGN})
+        if(NOT TARGET ${_TARG})
+            message(
+                FATAL_ERROR
+                    "rocprofiler_samples_get_preload_env: '${_TARG}' is not a valid target"
+                )
+        endif()
+        list(APPEND _PRELOAD_ENV_LIBS $<TARGET_FILE:${_TARG}>)
+    endforeach()
+
+    if(_PRELOAD_ENV_LIBS)
+        string(REPLACE ";" ":" _PRELOAD_ENV "LD_PRELOAD=${_PRELOAD_ENV_LIBS}")
+    endif()
+
+    set(${_VAR}
+        "${_PRELOAD_ENV}"
+        PARENT_SCOPE)
+endfunction()
+
+# function for getting the LD_LIBRARY_PATH environment variable
+function(rocprofiler_samples_get_ld_library_path_env _VAR)
+
+    set(_LDLIB_PATH "LD_LIBRARY_PATH=")
+    foreach(_TARG ${ARGN})
+        if(NOT TARGET ${_TARG})
+            message(
+                FATAL_ERROR
+                    "rocprofiler_samples_get_ld_library_path_env: '${_TARG}' is not a valid target"
+                )
+        endif()
+        string(APPEND _LDLIB_PATH "$<TARGET_FILE_DIR:${_TARG}>:")
+    endforeach()
+    # append the environments current LD_LIBRARY_PATH
+    string(APPEND _LDLIB_PATH "$ENV{LD_LIBRARY_PATH}")
+
+    set(${_VAR}
+        "${_LDLIB_PATH}"
+        PARENT_SCOPE)
+endfunction()

samples/counter_collection/CMakeLists.txt

@@ -40,19 +40,18 @@ target_sources(counter-collection-buffer PRIVATE main.cpp)
 target_link_libraries(counter-collection-buffer PRIVATE counter-collection-buffer-client
                                                         Threads::Threads)
 
+rocprofiler_samples_get_ld_library_path_env(LIBRARY_PATH_ENV)
+rocprofiler_samples_get_preload_env(PRELOAD_ENV counter-collection-buffer-client)
+
+set(counter-collection-buffer-env "${PRELOAD_ENV}" "${LIBRARY_PATH_ENV}")
+
 add_test(NAME counter-collection-buffer COMMAND $<TARGET_FILE:counter-collection-buffer>)
 
 set_tests_properties(
     counter-collection-buffer
-    PROPERTIES
-        TIMEOUT
-        120
-        LABELS
-        "samples"
-        ENVIRONMENT
-        "${ROCPROFILER_MEMCHECK_PRELOAD_ENV};HSA_TOOLS_LIB=$<TARGET_FILE:rocprofiler::rocprofiler-shared-library>"
-        FAIL_REGULAR_EXPRESSION
-        "${ROCPROFILER_DEFAULT_FAIL_REGEX}")
+    PROPERTIES TIMEOUT 120 LABELS "samples" ENVIRONMENT
+               "${counter-collection-buffer-env}" FAIL_REGULAR_EXPRESSION
+               "${ROCPROFILER_DEFAULT_FAIL_REGEX}")
 
 add_library(counter-collection-callback-client SHARED)
 target_sources(counter-collection-callback-client PRIVATE callback_client.cpp client.hpp)
@@ -67,20 +66,18 @@ target_sources(counter-collection-callback PRIVATE main.cpp)
 target_link_libraries(counter-collection-callback
                       PRIVATE counter-collection-callback-client Threads::Threads)
 
+rocprofiler_samples_get_preload_env(PRELOAD_ENV counter-collection-callback-client)
+
+set(counter-collection-callback-env "${PRELOAD_ENV}" "${LIBRARY_PATH_ENV}")
+
 add_test(NAME counter-collection-callback
          COMMAND $<TARGET_FILE:counter-collection-callback>)
 
 set_tests_properties(
     counter-collection-callback
-    PROPERTIES
-        TIMEOUT
-        120
-        LABELS
-        "samples"
-        ENVIRONMENT
-        "${ROCPROFILER_MEMCHECK_PRELOAD_ENV};HSA_TOOLS_LIB=$<TARGET_FILE:rocprofiler::rocprofiler-shared-library>"
-        FAIL_REGULAR_EXPRESSION
-        "${ROCPROFILER_DEFAULT_FAIL_REGEX}")
+    PROPERTIES TIMEOUT 120 LABELS "samples" ENVIRONMENT
+               "${counter-collection-callback-env}" FAIL_REGULAR_EXPRESSION
+               "${ROCPROFILER_DEFAULT_FAIL_REGEX}")
 
 add_library(counter-collection-functional-counter-client SHARED)
 target_sources(counter-collection-functional-counter-client
@@ -96,17 +93,16 @@ target_link_libraries(
     counter-collection-print-functional-counters
     PRIVATE counter-collection-functional-counter-client Threads::Threads)
 
+rocprofiler_samples_get_preload_env(PRELOAD_ENV
+                                    counter-collection-functional-counter-client)
+
+set(counter-collection-functional-counter-env "${PRELOAD_ENV}" "${LIBRARY_PATH_ENV}")
+
 add_test(NAME counter-collection-print-functional-counters
          COMMAND $<TARGET_FILE:counter-collection-print-functional-counters>)
 
 set_tests_properties(
     counter-collection-print-functional-counters
-    PROPERTIES
-        TIMEOUT
-        120
-        LABELS
-        "samples"
-        ENVIRONMENT
-        "${ROCPROFILER_MEMCHECK_PRELOAD_ENV};HSA_TOOLS_LIB=$<TARGET_FILE:rocprofiler::rocprofiler-shared-library>"
-        FAIL_REGULAR_EXPRESSION
-        "${ROCPROFILER_DEFAULT_FAIL_REGEX}")
+    PROPERTIES TIMEOUT 120 LABELS "samples" ENVIRONMENT
+               "${counter-collection-functional-counter-env}" FAIL_REGULAR_EXPRESSION
+               "${ROCPROFILER_DEFAULT_FAIL_REGEX}")

samples/intercept_table/CMakeLists.txt

@@ -42,16 +42,14 @@ target_sources(intercept-table PRIVATE main.cpp)
 target_link_libraries(intercept-table PRIVATE intercept-table-client Threads::Threads
                                               rocprofiler::samples-build-flags)
 
+rocprofiler_samples_get_preload_env(PRELOAD_ENV intercept-table-client)
+rocprofiler_samples_get_ld_library_path_env(LIBRARY_PATH_ENV)
+
+set(intercept-table-env ${PRELOAD_ENV} ${LIBRARY_PATH_ENV})
+
 add_test(NAME intercept-table COMMAND $<TARGET_FILE:intercept-table>)
 
 set_tests_properties(
     intercept-table
-    PROPERTIES
-        TIMEOUT
-        45
-        LABELS
-        "samples"
-        ENVIRONMENT
-        "${ROCPROFILER_MEMCHECK_PRELOAD_ENV};HSA_TOOLS_LIB=$<TARGET_FILE:rocprofiler::rocprofiler-shared-library>"
-        FAIL_REGULAR_EXPRESSION
-        "${ROCPROFILER_DEFAULT_FAIL_REGEX}")
+    PROPERTIES TIMEOUT 45 LABELS "samples" ENVIRONMENT "${intercept-table-env}"
+               FAIL_REGULAR_EXPRESSION "${ROCPROFILER_DEFAULT_FAIL_REGEX}")