RDKEMW-18412: integrate common helpers#73
Open
preeja33 wants to merge 3 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Integrates the previously in-repo helpers/ utilities into a shared external helpers package (entservices-helpers), updating build/test wiring to consume the external helpers and removing the local copies.
Changes:
- Remove the local
helpers/(WebSockets + assorted utility headers/sources) so helpers are provided byentservices-helpers. - Update Bluetooth and L1 test build configuration to reference the external helpers.
- Extend CI and dependency build scripts to fetch/build
entservices-helpers.
Reviewed changes
Copilot reviewed 51 out of 51 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| Tests/L1Tests/CMakeLists.txt | Stops using the in-repo helpers include path and updates Bluetooth test includes toward entservices-helpers. |
| Bluetooth/CMakeLists.txt | Adds find_package(${NAMESPACE}Helpers) and links against the external helpers target instead of ../helpers. |
| cmake/FindWPEFrameworkHelpers.cmake | Adds a CMake find-module for locating the Helpers library/headers. |
| build_dependencies.sh | Clones and builds entservices-helpers as an additional dependency. |
| .github/workflows/L1-tests.yml | Updates L1 CI to checkout/build entservices-helpers and adjusts include paths accordingly. |
| helpers/WebSockets/WSEndpoint.h | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/WSEndpoint.cpp | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/Roles/SingleClientServer.h | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/Roles/Client.h | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/PingPong/PingPongEnabled.h | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/PingPong/PingPongDisabled.h | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/JsonRpc/Response.h | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/JsonRpc/Response.cpp | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/JsonRpc/Request.h | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/JsonRpc/Request.cpp | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/JsonRpc/Notification.h | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/JsonRpc/Notification.cpp | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/Encryption/TlsEnabled.h | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/Encryption/NoEncryption.h | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/ConnectionInitializationResult.h | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/CommunicationInterface/JsonRpcInterface.h | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/CommunicationInterface/CommandInterface.h | Removed local helper implementation (migrated to shared helpers). |
| helpers/WebSockets/CommunicationInterface/BinaryInterface.h | Removed local helper implementation (migrated to shared helpers). |
| helpers/UtilsUnused.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsThreadRAII.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsTelemetry.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilssyncPersistFile.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsSynchroIarm.hpp | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsSynchro.hpp | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsString.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsSearchRDKProfile.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsProcess.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsLogging.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsLOG_MILESTONE.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsJsonRpc.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsisValidInt.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsInputValidator.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsIarm.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsgetRFCConfig.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsgetFileContent.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsfileExists.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsFile.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsCStr.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsController.h | Removed local helper header (migrated to shared helpers). |
| helpers/UtilsBIT.h | Removed local helper header (migrated to shared helpers). |
| helpers/tptimer.h | Removed local helper header (migrated to shared helpers). |
| helpers/PowerManagerInterface.h | Removed local helper header (migrated to shared helpers). |
| helpers/PluginInterfaceBuilder.h | Removed local helper header (migrated to shared helpers). |
| helpers/frontpanel.h | Removed local helper implementation (migrated to shared helpers). |
| helpers/frontpanel.cpp | Removed local helper implementation (migrated to shared helpers). |
| helpers/cSettings.h | Removed local helper header (migrated to shared helpers). |
Comment on lines
32
to
36
| ${NAMESPACE}Plugins::${NAMESPACE}Plugins | ||
| ) | ||
|
|
||
| set (TEST_INC ../../helpers) | ||
| set (TEST_INC) | ||
|
|
Comment on lines
104
to
107
| # PLUGIN_BLUETOOTH | ||
| set (BLUETOOTH_INC ${CMAKE_SOURCE_DIR}/../entservices-connectivity/Bluetooth ${CMAKE_SOURCE_DIR}/../entservices-connectivity/helpers) | ||
| set (BLUETOOTH_INC ${CMAKE_SOURCE_DIR}/../entservices-connectivity/Bluetooth ${CMAKE_SOURCE_DIR}/../entservices-helpers/helpers) | ||
| set (BLUETOOTH_LIBS ${NAMESPACE}Bluetooth) | ||
| add_plugin_test_ex(PLUGIN_BLUETOOTH tests/test_Bluetooth.cpp "${BLUETOOTH_INC}" "${BLUETOOTH_LIBS}") |
| WPEFrameworkHelpers_LIBRARIES) | ||
|
|
||
| if(WPEFrameworkHelpers_FOUND AND NOT TARGET WPEFramework::WPEFrameworkHelpers) | ||
| add_library(WPEFramework::WPEFrameworkHelpers SHARED IMPORTED) |
Comment on lines
+36
to
+38
| cd .. | ||
| git clone --branch feature/RDKEMW-16743 https://github.com/rdkcentral/entservices-helpers.git | ||
| cd "$GITHUB_WORKSPACE" |
Comment on lines
121
to
127
| - name: Checkout entservices-testframework | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| repository: rdkcentral/entservices-testframework | ||
| path: entservices-testframework | ||
| ref: 1.0.1 | ||
| ref: feature/helpers_v1 | ||
|
|
| ) | ||
|
|
||
| set (TEST_INC ../../helpers) | ||
| set (TEST_INC) |
Comment on lines
+8
to
+16
| # WPEFramework::WPEFrameworkHelpers | ||
|
|
||
| find_library(WPEFrameworkHelpers_LIBRARIES | ||
| NAMES WPEFrameworkHelpers | ||
| PATH_SUFFIXES wpeframework/plugins) | ||
|
|
||
| find_path(WPEFrameworkHelpers_INCLUDE_DIRS | ||
| NAMES UtilsLogging.h | ||
| PATH_SUFFIXES wpeframework/helpers) |
| WPEFrameworkHelpers_LIBRARIES) | ||
|
|
||
| if(WPEFrameworkHelpers_FOUND AND NOT TARGET WPEFramework::WPEFrameworkHelpers) | ||
| add_library(WPEFramework::WPEFrameworkHelpers SHARED IMPORTED) |
| git clone --branch develop https://github.com/rdkcentral/entservices-apis.git | ||
|
|
||
| cd .. | ||
| git clone --branch feature/RDKEMW-16743 https://github.com/rdkcentral/entservices-helpers.git |
Comment on lines
122
to
142
| uses: actions/checkout@v3 | ||
| with: | ||
| repository: rdkcentral/entservices-testframework | ||
| path: entservices-testframework | ||
| ref: 1.0.1 | ||
| ref: feature/helpers_v1 | ||
|
|
||
| - name: Checkout entservices-connectivity | ||
| if: ${{ inputs.caller_source == 'local' }} | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| path: entservices-connectivity | ||
|
|
||
| - name: Checkout entservices-connectivity-testframework | ||
| if: ${{ inputs.caller_source == 'testframework' }} | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| repository: rdkcentral/entservices-connectivity | ||
| path: entservices-connectivity | ||
| ref: develop | ||
| ref: feature/RDKEMW-16743 | ||
|
|
||
| - name: Checkout googletest |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reason for change: Integrate common helpers
Test Procedure: check the ticket
Risks: Medium
Priority: P1
version: Patch