RDKEMW-17454 : Bluetooth Migration and Rollback Support

.github/workflows/tests-trigger.yml

@@ -15,3 +15,10 @@ jobs:
       caller_source: local
     secrets:
       RDKCM_RDKE: ${{ secrets.RDKCM_RDKE }}
+
+  trigger-L2:
+    uses: ./.github/workflows/L2-tests.yml
+    with:
+      caller_source: local
+    secrets:
+      RDKCM_RDKE: ${{ secrets.RDKCM_RDKE }}

Bluetooth/Bluetooth.cpp

@@ -1827,6 +1827,9 @@ namespace WPEFramework
             {
                 LOGINFO("Making a call with deviceID=%llu ", deviceID);
                 successFlag = setDeviceVolumeMuteProperties(deviceID, deviceTypeStr, ui8volume, mute);
+                if (successFlag) {
+                    m_bluetoothDeviceManager.setLastVolumeSetting(deviceIDStr, static_cast<long long>(ui8volume));
+                }
             } else {
                 LOGERR("Please specify parameters. Example: \"params\": {\"deviceID\": \"271731989589742\", \"deviceType\": \"HEADPHONES\", \"volume\": \"0-255\", \"mute\": \"0-1\"}");
                 successFlag = false;

Bluetooth/BluetoothDeviceManager.cpp

@@ -25,6 +25,7 @@
 
 #include "BluetoothDeviceManager.h"
 #include "btmgr.h"
+
 #ifdef BLUETOOTH_ENABLE_PERSISTENCE_MIGRATION
 #include "BluetoothPersistenceAdapter.h"
 #endif
@@ -33,7 +34,13 @@
 namespace WPEFramework {
     namespace Plugin {
 
+        inline bool missingFromPersistentStore(Core::hresult result)
+        {
+            return (Core::ERROR_NOT_EXIST == result) || (Core::ERROR_UNKNOWN_KEY == result);
+        }
+
 #ifdef BLUETOOTH_ENABLE_PERSISTENCE_MIGRATION
+
         Core::hresult BluetoothDeviceManager::writeCacheFromFilesystemPersistence()
         {
             BluetoothPersistenceAdapter adapter;
@@ -202,7 +209,7 @@ namespace WPEFramework {
 
                 _adminLock.Unlock();
 
-            } else if (Core::ERROR_NOT_EXIST != result) {
+            } else if (!missingFromPersistentStore(result)) {
                 LOGERR("Failed to load device info from PersistentStore, hresult=%d\n", result);
             }
 
@@ -341,6 +348,22 @@ namespace WPEFramework {
 
         Core::hresult BluetoothDeviceManager::init(PluginHost::IShell* service)
         {
+            LOGINFO("BLUETOOTH_ENABLE_PERSISTENCE_MIGRATION is %s",
+#ifdef BLUETOOTH_ENABLE_PERSISTENCE_MIGRATION
+                "enabled"
+#else
+                "disabled"
+#endif
+            );
+
+            LOGINFO("BLUETOOTH_PERSISTENT_FILE_PATH is '%s'",
+#ifdef BLUETOOTH_PERSISTENT_FILE_PATH
+                BLUETOOTH_PERSISTENT_FILE_PATH
+#else
+             "unavailable"
+#endif
+            );
+
             if (service == nullptr) {
                 return Core::ERROR_GENERAL;
             }
@@ -349,13 +372,13 @@ namespace WPEFramework {
             _service->AddRef();
 
             const Core::hresult storageResult = updateCacheFromStorage();
-            if ((Core::ERROR_NONE != storageResult) && (Core::ERROR_NOT_EXIST != storageResult)) {
+            if ((Core::ERROR_NONE != storageResult) && !missingFromPersistentStore(storageResult)) {
                 LOGERR("PersistentStore read failed (hresult=%d); aborting init to avoid data loss", storageResult);
                 return storageResult;
             }
 
 #ifdef BLUETOOTH_ENABLE_PERSISTENCE_MIGRATION
-            if (Core::ERROR_NOT_EXIST == storageResult) {
+            if (missingFromPersistentStore(storageResult)) {
                 LOGINFO("Migration attempted: PersistentStore device info is missing; trying filesystem persistence import.");
 
                 const Core::hresult migrationResult = writeCacheFromFilesystemPersistence();
@@ -488,6 +511,34 @@ namespace WPEFramework {
             }
         }
 
+        Core::hresult BluetoothDeviceManager::setLastVolumeSetting(const std::string& deviceID, long long volumeSetting)
+        {
+            LOGINFO("deviceID=%s, volumeSetting=%lld\n", deviceID.c_str(), volumeSetting);
+
+            BluetoothDeviceInfo deviceInfo;
+
+            _adminLock.Lock();
+
+            Core::hresult result = getPairedDeviceInfo(deviceID, deviceInfo);
+
+            if (Core::ERROR_NONE != result) {
+                LOGERR("Device info is not found in cache for deviceID: %s", deviceID.c_str());
+                _adminLock.Unlock();
+                return Core::ERROR_NOT_EXIST;
+            }
+
+            deviceInfo.lastVolumeSetting = volumeSetting;
+            _pairedDeviceCache[deviceID] = std::move(deviceInfo);
+            _adminLock.Unlock();
+
+            result = writeStorageFromCache();
+            if (Core::ERROR_NONE != result) {
+                LOGERR("Failed to update storage from cache after setting lastVolumeSetting for deviceID=%s", deviceID.c_str());
+            }
+
+            return result;
+        }
+
         Core::hresult BluetoothDeviceManager::getLastConnectTimeUtc(const std::string& deviceID, std::string& lastConnectTimeUtc)
         {
             LOGINFO("deviceID=%s\n", deviceID.c_str());

Bluetooth/BluetoothDeviceManager.h

@@ -63,6 +63,7 @@ namespace WPEFramework {
                 Core::hresult getAutoConnect(const std::string& deviceID, AutoConnectStatus& status);
                 void setLastConnectTimeUtc(const std::string& deviceID);
                 Core::hresult getLastConnectTimeUtc(const std::string& deviceID, std::string& lastConnectTimeUtc);
+                Core::hresult setLastVolumeSetting(const std::string& deviceID, long long volumeSetting);
                 Core::hresult addDevice(const std::string& deviceID);
                 Core::hresult removeDevice(const std::string& deviceID);
                 std::unordered_map<std::string /* deviceID */, BluetoothDeviceInfo /* deviceInfo */> getPairedDeviceInfos();

CMakeLists.txt

@@ -42,6 +42,10 @@ if(RDK_SERVICES_L1_TEST)
     add_subdirectory(Tests/L1Tests)
 endif()
 
+if(RDK_SERVICE_L2_TEST)
+    add_subdirectory(Tests/L2Tests)
+endif()
+
 if(PLUGIN_BLUETOOTH)
     add_subdirectory(Bluetooth)
 endif()

Tests/L1Tests/tests/test_Bluetooth.cpp

@@ -1280,11 +1280,24 @@ TEST_F(BluetoothLegacyPersistenceMigrationParseTest, legacyPersistenceMigrationS
     EXPECT_TRUE(response.find("\"lastConnectTimeUtc\":\"1700000000\"") != string::npos);
 }
 
-TEST_F(BluetoothLegacyPersistenceMigrationParseTest, legacyPersistenceMigrationMissingStore_ValidFilesystemPersistenceImportPersistsToStore)
+class BluetoothLegacyPersistenceMigrationParseParamTest
+    : public BluetoothLegacyPersistenceMigrationParseTest
+    , public ::testing::WithParamInterface<uint32_t> {
+};
+
+INSTANTIATE_TEST_SUITE_P(
+    StoreKeyNotFound,
+    BluetoothLegacyPersistenceMigrationParseParamTest,
+    ::testing::Values(Core::ERROR_NOT_EXIST, Core::ERROR_UNKNOWN_KEY),
+    [](const ::testing::TestParamInfo<uint32_t>& paramInfo) {
+        return paramInfo.param == Core::ERROR_NOT_EXIST ? "ERROR_NOT_EXIST" : "ERROR_UNKNOWN_KEY";
+    });
+
+TEST_P(BluetoothLegacyPersistenceMigrationParseParamTest, legacyPersistenceMigrationMissingStore_ValidFilesystemPersistenceImportPersistsToStore)
 {
     std::string persistedJson;
     EXPECT_CALL(*p_storeMock, GetValue(::testing::_, ::testing::_, ::testing::_))
-        .WillOnce(::testing::Return(Core::ERROR_NOT_EXIST));
+        .WillOnce(::testing::Return(GetParam()));
     EXPECT_CALL(*p_storeMock, SetValue(::testing::_, ::testing::_, ::testing::_))
         .Times(::testing::AtLeast(1))
         .WillRepeatedly(::testing::DoAll(
@@ -1306,7 +1319,7 @@ TEST_F(BluetoothLegacyPersistenceMigrationParseTest, legacyPersistenceMigrationM
     EXPECT_TRUE(persistedJson.find("\"lastConnectTimeUtc\":\"1712345680\"") != string::npos);
 }
 
-TEST_F(BluetoothLegacyPersistenceMigrationParseTest, legacyPersistenceMigrationMissingStore_MissingFilesystemPersistenceSourceGracefulFallback)
+TEST_P(BluetoothLegacyPersistenceMigrationParseParamTest, legacyPersistenceMigrationMissingStore_MissingFilesystemPersistenceSourceGracefulFallback)
 {
     const std::string seedPayload =
         "{\"pairedDevices\":[{\"deviceAddr\":\"123\",\"deviceType\":\"HEADPHONES\","
@@ -1316,7 +1329,7 @@ TEST_F(BluetoothLegacyPersistenceMigrationParseTest, legacyPersistenceMigrationM
     }
 
     EXPECT_CALL(*p_storeMock, GetValue(::testing::_, ::testing::_, ::testing::_))
-        .WillOnce(::testing::Return(Core::ERROR_NOT_EXIST));
+        .WillOnce(::testing::Return(GetParam()));
 
     EXPECT_TRUE(plugin->Initialize(&service).empty());
 
@@ -1329,10 +1342,10 @@ TEST_F(BluetoothLegacyPersistenceMigrationParseTest, legacyPersistenceMigrationM
     EXPECT_TRUE(syncedFilesystemPersistencePayload.find("\"autoConnectStatus\":true") != string::npos);
 }
 
-TEST_F(BluetoothLegacyPersistenceMigrationParseTest, legacyPersistenceMigrationMissingStore_MalformedFilesystemPersistencePayloadNonFatal)
+TEST_P(BluetoothLegacyPersistenceMigrationParseParamTest, legacyPersistenceMigrationMissingStore_MalformedFilesystemPersistencePayloadNonFatal)
 {
     EXPECT_CALL(*p_storeMock, GetValue(::testing::_, ::testing::_, ::testing::_))
-        .WillOnce(::testing::Return(Core::ERROR_NOT_EXIST));
+        .WillOnce(::testing::Return(GetParam()));
 
     const std::string malformedPayload = "{\"pairedDevices\":[{\"deviceAddr\":\"123\"";
     if (!initializeFromFilesystemPersistencePayload(malformedPayload)) {
@@ -1355,7 +1368,7 @@ TEST_F(BluetoothLegacyPersistenceMigrationParseTest, legacyPersistenceMigrationM
     EXPECT_TRUE(response.find("\"pairedDevices\"") != string::npos);
 }
 
-TEST_F(BluetoothLegacyPersistenceMigrationParseTest, rollbackSyncMutations_WriteFilesystemPersistenceWhenFlagOn)
+TEST_P(BluetoothLegacyPersistenceMigrationParseParamTest, rollbackSyncMutations_WriteFilesystemPersistenceWhenFlagOn)
 {
     const std::string seedPayload =
         "{\"pairedDevices\":[{\"deviceAddr\":\"123\",\"deviceType\":\"HEADPHONES\","
@@ -1365,7 +1378,7 @@ TEST_F(BluetoothLegacyPersistenceMigrationParseTest, rollbackSyncMutations_Write
     }
 
     EXPECT_CALL(*p_storeMock, GetValue(::testing::_, ::testing::_, ::testing::_))
-        .WillOnce(::testing::Return(Core::ERROR_NOT_EXIST));
+        .WillOnce(::testing::Return(GetParam()));
 
     EXPECT_TRUE(plugin->Initialize(&service).empty());
 
@@ -1652,7 +1665,7 @@ TEST_F(BluetoothLegacyPersistenceMigrationParseTest, parse_FriendlyName_Persiste
 // Data mapping tests: write (cache → filesystem file)
 // ============================================================================
 
-TEST_F(BluetoothLegacyPersistenceMigrationParseTest, write_InitialDeviceAutoConnectUnset_WritesAutoConnectFalseToFilesystem)
+TEST_P(BluetoothLegacyPersistenceMigrationParseParamTest, write_InitialDeviceAutoConnectUnset_WritesAutoConnectFalseToFilesystem)
 {
     // A device entry is present in the filesystem file without an explicit autoConnectStatus
     // field (UNSET). Write() must serialize UNSET as false when there is no prior
@@ -1665,7 +1678,7 @@ TEST_F(BluetoothLegacyPersistenceMigrationParseTest, write_InitialDeviceAutoConn
     }
 
     EXPECT_CALL(*p_storeMock, GetValue(::testing::_, ::testing::_, ::testing::_))
-        .WillOnce(::testing::Return(Core::ERROR_NOT_EXIST));
+        .WillOnce(::testing::Return(GetParam()));
 
     EXPECT_TRUE(plugin->Initialize(&service).empty());
 
@@ -1675,7 +1688,7 @@ TEST_F(BluetoothLegacyPersistenceMigrationParseTest, write_InitialDeviceAutoConn
     EXPECT_TRUE(filesystemPayload.find("\"autoConnectStatus\":false") != string::npos);
 }
 
-TEST_F(BluetoothLegacyPersistenceMigrationParseTest, write_LastConnectTimeUtcEmpty_WritesZeroToFilesystem)
+TEST_P(BluetoothLegacyPersistenceMigrationParseParamTest, write_LastConnectTimeUtcEmpty_WritesZeroToFilesystem)
 {
     // When the filesystem file entry has no lastConnectionTimeUTC field, the cache
     // entry has an empty lastConnectTimeUtc. Write() must emit lastConnectionTimeUTC
@@ -1688,7 +1701,7 @@ TEST_F(BluetoothLegacyPersistenceMigrationParseTest, write_LastConnectTimeUtcEmp
     }
 
     EXPECT_CALL(*p_storeMock, GetValue(::testing::_, ::testing::_, ::testing::_))
-        .WillOnce(::testing::Return(Core::ERROR_NOT_EXIST));
+        .WillOnce(::testing::Return(GetParam()));
 
     EXPECT_TRUE(plugin->Initialize(&service).empty());
 

Tests/L2Tests/CMakeLists.txt

@@ -0,0 +1,72 @@
+# If not stated otherwise in this file or this component's LICENSE file the
+# following copyright and licenses apply:
+#
+# Copyright 2025 RDK Management
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+set(PLUGIN_NAME L2TestsBT)
+set(MODULE_NAME ${NAMESPACE}${PLUGIN_NAME})
+set(THUNDER_PORT 9998)
+
+find_package(${NAMESPACE}Plugins REQUIRED)
+
+if(PLUGIN_BLUETOOTH)
+    set(SRC_FILES ${SRC_FILES} tests/Bluetooth_L2Test.cpp)
+endif()
+
+add_library(${MODULE_NAME} SHARED ${SRC_FILES})
+
+set_target_properties(${MODULE_NAME} PROPERTIES
+        CXX_STANDARD 14
+        CXX_STANDARD_REQUIRED YES)
+
+target_compile_definitions(${MODULE_NAME}
+            PRIVATE
+            MODULE_NAME=Plugin_${PLUGIN_NAME}
+            THUNDER_PORT="${THUNDER_PORT}")
+
+target_compile_options(${MODULE_NAME} PRIVATE -Wno-error)
+target_link_libraries(${MODULE_NAME} PRIVATE ${NAMESPACE}Plugins::${NAMESPACE}Plugins)
+
+if (NOT L2_TEST_OOP_RPC)
+    find_library(TESTMOCKLIB_LIBRARIES NAMES TestMocklib)
+    if (TESTMOCKLIB_LIBRARIES)
+        message ("Found mock library - ${TESTMOCKLIB_LIBRARIES}")
+        target_link_libraries(${MODULE_NAME} PRIVATE ${TESTMOCKLIB_LIBRARIES})
+    else (TESTMOCKLIB_LIBRARIES)
+         message ("Require ${TESTMOCKLIB_LIBRARIES} library")
+    endif (TESTMOCKLIB_LIBRARIES)
+endif (NOT L2_TEST_OOP_RPC)
+
+find_library(MOCKACCESSOR_LIBRARIES NAMES MockAccessor)
+if (MOCKACCESSOR_LIBRARIES)
+    message ("Found MockAccessor library - ${MOCKACCESSOR_LIBRARIES}")
+    target_link_libraries(${MODULE_NAME} PRIVATE ${MOCKACCESSOR_LIBRARIES})
+else (MOCKACCESSOR_LIBRARIES)
+     message ("Require ${MOCKACCESSOR_LIBRARIES} library")
+endif (MOCKACCESSOR_LIBRARIES)
+
+target_include_directories(
+    ${MODULE_NAME} PRIVATE ./
+    ../../helpers
+    ../../../entservices-testframework/Tests/mocks
+    ../../../entservices-testframework/Tests/mocks/thunder
+    ../../../entservices-testframework/Tests/mocks/devicesettings
+    ../../../entservices-testframework/Tests/mocks/MockPlugin
+    ../../../entservices-testframework/Tests/L2Tests/L2TestsPlugin
+    ${CMAKE_INSTALL_PREFIX}/include
+    )
+
+install(TARGETS ${MODULE_NAME} DESTINATION lib)