Add thunder_test_support static library for plugin integration testing

.github/workflows/Test_Thunder_Test_Support.yml

@@ -0,0 +1,185 @@
+name: Test Thunder Test Support Library
+
+permissions:
+  contents: read
+
+on:
+  workflow_dispatch:
+
+  pull_request:
+    branches: ["R5_3", "development/test-support"]
+
+jobs:
+  SmokeTest:
+    runs-on: ubuntu-24.04
+
+    strategy:
+      matrix:
+        build_type: [Debug, Release]
+
+    name: Smoke Test - ${{matrix.build_type}}
+
+    steps:
+    - name: Install necessary packages
+      uses: nick-fields/retry@v3
+      with:
+        timeout_minutes: 10
+        max_attempts: 10
+        command: |
+          sudo gem install apt-spy2
+          sudo apt-spy2 fix --commit --launchpad --country=US
+          sudo apt-get update
+          sudo apt-get install -y python3-pip build-essential cmake ninja-build libusb-1.0-0-dev zlib1g-dev libssl-dev libgtest-dev
+          python3 -m venv venv
+          source venv/bin/activate
+          pip install jsonref
+
+# ----- Checkout -----
+    - name: Checkout Thunder
+      uses: actions/checkout@v4
+      with:
+        path: Thunder
+        # ref: ${{ github.event.pull_request.head.sha || github.sha }}
+
+    - name: Checkout ThunderTools - default
+      if: ${{ !contains(github.event.pull_request.body, '[DependsOn=ThunderTools:') }}
+      uses: actions/checkout@v4
+      with:
+        path: ThunderTools
+        repository: rdkcentral/ThunderTools
+        ref: R5.3.0
+
+    - name: Regex ThunderTools
+      if: ${{ contains(github.event.pull_request.body, '[DependsOn=ThunderTools:') }}
+      id: tools
+      uses: AsasInnab/regex-action@v1
+      with:
+        regex_pattern: '(?<=\[DependsOn=ThunderTools:).*(?=\])'
+        regex_flags: 'gim'
+        search_string: ${{github.event.pull_request.body}}
+
+    - name: Checkout ThunderTools - ${{steps.tools.outputs.first_match}}
+      if: ${{ contains(github.event.pull_request.body, '[DependsOn=ThunderTools:') }}
+      uses: actions/checkout@v4
+      with:
+        path: ThunderTools
+        repository: rdkcentral/ThunderTools
+        ref: ${{steps.tools.outputs.first_match}}
+
+    - name: Checkout ThunderInterfaces - default
+      if: ${{ !contains(github.event.pull_request.body, '[DependsOn=ThunderInterfaces:') }}
+      uses: actions/checkout@v4
+      with:
+        path: ThunderInterfaces
+        repository: rdkcentral/ThunderInterfaces
+        # TODO: Remove ref once qa_interfaces changes are merged to master
+        ref: development/test-support
+
+    - name: Regex ThunderInterfaces
+      if: ${{ contains(github.event.pull_request.body, '[DependsOn=ThunderInterfaces:') }}
+      id: interfaces
+      uses: AsasInnab/regex-action@v1
+      with:
+        regex_pattern: '(?<=\[DependsOn=ThunderInterfaces:).*(?=\])'
+        regex_flags: 'gim'
+        search_string: ${{github.event.pull_request.body}}
+
+    - name: Checkout ThunderInterfaces - ${{steps.interfaces.outputs.first_match}}
+      if: ${{ contains(github.event.pull_request.body, '[DependsOn=ThunderInterfaces:') }}
+      uses: actions/checkout@v4
+      with:
+        path: ThunderInterfaces
+        repository: rdkcentral/ThunderInterfaces
+        ref: ${{steps.interfaces.outputs.first_match}}
+
+    - name: Checkout ThunderNanoServices - default
+      if: ${{ !contains(github.event.pull_request.body, '[DependsOn=ThunderNanoServices:') }}
+      uses: actions/checkout@v4
+      with:
+        path: ThunderNanoServices
+        repository: rdkcentral/ThunderNanoServices
+        # TODO: Remove ref once TestPlugin changes are merged to master
+        ref: development/test-support
+
+    - name: Regex ThunderNanoServices
+      if: ${{ contains(github.event.pull_request.body, '[DependsOn=ThunderNanoServices:') }}
+      id: nanoservices
+      uses: AsasInnab/regex-action@v1
+      with:
+        regex_pattern: '(?<=\[DependsOn=ThunderNanoServices:).*(?=\])'
+        regex_flags: 'gim'
+        search_string: ${{github.event.pull_request.body}}
+
+    - name: Checkout ThunderNanoServices - ${{steps.nanoservices.outputs.first_match}}
+      if: ${{ contains(github.event.pull_request.body, '[DependsOn=ThunderNanoServices:') }}
+      uses: actions/checkout@v4
+      with:
+        path: ThunderNanoServices
+        repository: rdkcentral/ThunderNanoServices
+        ref: ${{steps.nanoservices.outputs.first_match}}
+
+# ----- Build -----
+    - name: Build ThunderTools
+      run: |
+        source venv/bin/activate
+        cmake -G Ninja -S ThunderTools -B ${{matrix.build_type}}/build/ThunderTools \
+          -DCMAKE_INSTALL_PREFIX="${{matrix.build_type}}/install/usr"
+        cmake --build ${{matrix.build_type}}/build/ThunderTools --target install
+
+    - name: Build Thunder with test support
+      run: |
+        source venv/bin/activate
+        cmake -G Ninja -S Thunder -B ${{matrix.build_type}}/build/Thunder \
+          -DBINDING="127.0.0.1" \
+          -DCMAKE_BUILD_TYPE=${{matrix.build_type}} \
+          -DCMAKE_INSTALL_PREFIX="${{matrix.build_type}}/install/usr" \
+          -DCMAKE_MODULE_PATH="${PWD}/${{matrix.build_type}}/install/usr/include/Thunder/Modules" \
+          -DPORT="0" \
+          -DENABLE_TEST_RUNTIME=ON
+        cmake --build ${{matrix.build_type}}/build/Thunder --target install
+
+    - name: Build ThunderInterfaces
+      run: |
+        source venv/bin/activate
+        cmake -G Ninja -S ThunderInterfaces -B ${{matrix.build_type}}/build/ThunderInterfaces \
+          -DCMAKE_BUILD_TYPE=${{matrix.build_type}} \
+          -DCMAKE_INSTALL_PREFIX="${{matrix.build_type}}/install/usr" \
+          -DCMAKE_MODULE_PATH="${PWD}/${{matrix.build_type}}/install/usr/include/Thunder/Modules" \
+          -DCMAKE_PREFIX_PATH="${PWD}/${{matrix.build_type}}/install/usr"
+        cmake --build ${{matrix.build_type}}/build/ThunderInterfaces --target install
+
+    - name: Build ThunderNanoServices TestPlugin + test
+      run: |
+        source venv/bin/activate
+        cmake -G Ninja -S ThunderNanoServices/tests -B ${{matrix.build_type}}/build/ThunderNanoServicesTests \
+          -DCMAKE_BUILD_TYPE=${{matrix.build_type}} \
+          -DCMAKE_INSTALL_PREFIX="${{matrix.build_type}}/install/usr" \
+          -DCMAKE_MODULE_PATH="${PWD}/${{matrix.build_type}}/install/usr/include/Thunder/Modules" \
+          -DCMAKE_PREFIX_PATH="${PWD}/${{matrix.build_type}}/install/usr" \
+          -DPLUGIN_TESTPLUGIN=ON \
+          -DTEST_PLUGIN_PATH="${PWD}/${{matrix.build_type}}/install/usr/lib/thunder/plugins"
+        cmake --build ${{matrix.build_type}}/build/ThunderNanoServicesTests --target install
+
+# ----- Run smoke test -----
+    - name: Run smoke test
+      run: |
+        LD_LIBRARY_PATH="${{matrix.build_type}}/install/usr/lib:$LD_LIBRARY_PATH" \
+        ${{matrix.build_type}}/build/Thunder/Tests/test_support/tests/thunder_test_runtime_smoke \
+          --gtest_output="xml:smoke-test-results.xml" \
+          --gtest_color=yes
+
+# ----- Run plugin test -----
+    - name: Run plugin test (COM-RPC + JSON-RPC + events)
+      run: |
+        LD_LIBRARY_PATH="${{matrix.build_type}}/install/usr/lib:${PWD}/${{matrix.build_type}}/install/usr/lib/thunder/plugins:$LD_LIBRARY_PATH" \
+        ${{matrix.build_type}}/build/ThunderNanoServicesTests/TestPlugin/test/thunder_testplugin_test \
+          --gtest_output="xml:plugin-test-results.xml" \
+          --gtest_color=yes
+
+    - name: Upload test results
+      uses: actions/upload-artifact@v4
+      with:
+        name: test-results-${{matrix.build_type}}
+        path: |
+          smoke-test-results.xml
+          plugin-test-results.xml

Tests/CMakeLists.txt

@@ -5,6 +5,7 @@ option(FILE_UNLINK_TEST "File unlink test" OFF)
 option(REDIRECT_TEST "Test stream redirection" OFF)
 option(MESSAGEBUFFER_TEST "Test message buffer" OFF)
 option(UNRAVELLER "reveal thread details" OFF)
+option(ENABLE_TEST_RUNTIME "Build the in-process Thunder test runtime library" OFF)
 
 if(BUILD_TESTS)
     add_subdirectory(unit)
@@ -40,4 +41,8 @@ endif()
 
 if(UNRAVELLER)
     add_subdirectory(unraveller)
+endif()
+
+if(ENABLE_TEST_RUNTIME)
+    add_subdirectory(test_support)
 endif()

Tests/test_support/CMakeLists.txt

@@ -0,0 +1,184 @@
+# ==========================================================================
+# thunder_test_support — static library for in-process Thunder plugin testing
+#
+# Compiles the test runtime together with the subset of Source/Thunder
+# objects needed to host an embedded PluginHost::Server.  The resulting
+# archive is linked via whole-archive so that MODULE_NAME_DECLARATION
+# statics are not dropped by the linker.
+# ==========================================================================
+
+find_package(Threads REQUIRED)
+
+set(THUNDER_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../Source/Thunder")
+
+set(THREADPOOL_COUNT "4" CACHE STRING "The number of threads in the thread pool for test runtime")
+
+set(TARGET thunder_test_support)
+
+add_library(${TARGET} STATIC
+    ThunderTestRuntime.cpp
+    Module.cpp
+    ${THUNDER_SOURCE_DIR}/PluginServer.cpp
+    ${THUNDER_SOURCE_DIR}/Controller.cpp
+    ${THUNDER_SOURCE_DIR}/SystemInfo.cpp
+    ${THUNDER_SOURCE_DIR}/PostMortem.cpp
+    ${THUNDER_SOURCE_DIR}/Probe.cpp
+)
+
+target_include_directories(${TARGET}
+    PUBLIC
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
+        $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}/${NAMESPACE}>
+    PRIVATE
+        ${THUNDER_SOURCE_DIR}
+        $<BUILD_INTERFACE:${CMAKE_BINARY_DIR}/Source/plugins/generated/jsonrpc>
+        $<BUILD_INTERFACE:${CMAKE_BINARY_DIR}/Source/Thunder/generated>
+)
+
+target_compile_definitions(${TARGET}
+    PRIVATE
+        NAMESPACE=${NAMESPACE}
+        APPLICATION_NAME=ThunderTestRuntime
+        MODULE_NAME=ThunderTestRuntime
+        THREADPOOL_COUNT=${THREADPOOL_COUNT}
+        DEFAULT_SYSTEM_PATH="${SYSTEM_PATH}"
+        DEFAULT_PROXYSTUB_PATH="${PROXYSTUB_PATH}"
+)
+
+target_compile_options(${TARGET} PRIVATE -Wno-psabi)
+
+set_target_properties(${TARGET} PROPERTIES
+    CXX_STANDARD 11
+    CXX_STANDARD_REQUIRED YES
+)
+
+target_link_libraries(${TARGET}
+    PRIVATE
+        CompileSettings::CompileSettings
+        CompileSettingsDebug::CompileSettingsDebug
+)
+
+if(EXCEPTION_CATCHING)
+    set_source_files_properties(${THUNDER_SOURCE_DIR}/PluginServer.cpp PROPERTIES COMPILE_FLAGS "-fexceptions")
+endif()
+
+target_link_libraries(${TARGET}
+    PUBLIC
+        ${NAMESPACE}Core::${NAMESPACE}Core
+        ${NAMESPACE}Cryptalgo::${NAMESPACE}Cryptalgo
+        ${NAMESPACE}COM::${NAMESPACE}COM
+        ${NAMESPACE}Messaging::${NAMESPACE}Messaging
+        ${NAMESPACE}WebSocket::${NAMESPACE}WebSocket
+        ${NAMESPACE}Plugins::${NAMESPACE}Plugins
+        Threads::Threads
+)
+
+# COMProcess is an INTERFACE library carrying only a compile definition.
+# It is not in any export set, so we absorb its effect directly.
+target_compile_definitions(${TARGET} PRIVATE HOSTING_COMPROCESS=ThunderPlugin)
+
+# ------------------------------------------------------------------
+# Whole-archive link.  Ensures that the MODULE_NAME_DECLARATION
+# constructors from the Server objects are not discarded.
+# BUILD_INTERFACE only — installed consumers get this via the
+# custom Config.cmake.in template instead.
+# ------------------------------------------------------------------
+if(APPLE)
+    target_link_options(${TARGET} INTERFACE
+        "$<BUILD_INTERFACE:SHELL:-Wl,-force_load,$<TARGET_FILE:${TARGET}>>"
+    )
+else()
+    target_link_options(${TARGET} INTERFACE
+        "$<BUILD_INTERFACE:SHELL:-Wl,--whole-archive $<TARGET_FILE:${TARGET}> -Wl,--no-whole-archive>"
+    )
+endif()
+
+# ------------------------------------------------------------------
+# Optional features – only link when enabled in the main build.
+# ------------------------------------------------------------------
+if(WARNING_REPORTING)
+    target_sources(${TARGET}
+        PRIVATE
+            ${THUNDER_SOURCE_DIR}/WarningReportingCategories.cpp
+    )
+endif()
+
+if(PROCESSCONTAINERS)
+    target_link_libraries(${TARGET}
+        PUBLIC
+            ${NAMESPACE}ProcessContainers::${NAMESPACE}ProcessContainers
+    )
+    target_compile_definitions(${TARGET}
+        PUBLIC
+            PROCESSCONTAINERS_ENABLED=1
+    )
+endif()
+
+if(HIBERNATESUPPORT)
+    target_link_libraries(${TARGET}
+        PUBLIC
+            ${NAMESPACE}Hibernate::${NAMESPACE}Hibernate
+    )
+    target_compile_definitions(${TARGET}
+        PUBLIC
+            HIBERNATE_SUPPORT_ENABLED=1
+    )
+endif()
+
+# ------------------------------------------------------------------
+# Install the library and header so external projects can use it
+# via find_package(thunder_test_support)
+# ------------------------------------------------------------------
+install(
+    FILES ThunderTestRuntime.h
+    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/${NAMESPACE}/test_support
+    COMPONENT ${NAMESPACE}_Development
+)
+
+install(
+    TARGETS ${TARGET} EXPORT ${TARGET}Targets
+    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} COMPONENT ${NAMESPACE}_Development
+    INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/${NAMESPACE}
+)
+
+# ------------------------------------------------------------------
+# thunder_test_main — GTest main() that calls _Exit() after
+# RUN_ALL_TESTS() to avoid static destruction order crashes when
+# external plugin .so files are loaded.
+#
+# Plugin tests link this instead of GTest::Main.
+# ------------------------------------------------------------------
+set(MAIN_TARGET thunder_test_main)
+
+add_library(${MAIN_TARGET} STATIC
+    ThunderTestMain.cpp
+)
+
+target_link_libraries(${MAIN_TARGET}
+    PUBLIC
+        GTest::GTest
+)
+
+set_target_properties(${MAIN_TARGET} PROPERTIES
+    CXX_STANDARD 11
+    CXX_STANDARD_REQUIRED YES
+)
+
+install(
+    TARGETS ${MAIN_TARGET} EXPORT ${MAIN_TARGET}Targets
+    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} COMPONENT ${NAMESPACE}_Development
+)
+
+InstallCMakeConfig(
+    TARGETS ${TARGET}
+    TEMPLATE ${CMAKE_CURRENT_SOURCE_DIR}/thunder_test_supportConfig.cmake.in
+)
+
+InstallCMakeConfig(
+    TARGETS ${MAIN_TARGET}
+)
+
+# ------------------------------------------------------------------
+# Smoke test sub-directory
+# ------------------------------------------------------------------
+add_subdirectory(tests)

Tests/test_support/Module.cpp

@@ -0,0 +1,3 @@
+#include "Module.h"
+
+MODULE_NAME_ARCHIVE_DECLARATION