/*
* Copyright 2021 The Android Open Source Project
*
* 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.
*/
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include "bta/dm/bta_dm_device_search_int.h"
#include "bta/dm/bta_dm_disc.h"
#include "bta/dm/bta_dm_int.h"
#include "bta/dm/bta_dm_pm.cc"
#include "bta/dm/bta_dm_sec_int.h"
#include "bta/hf_client/bta_hf_client_int.h"
#include "bta/include/bta_api.h"
#include "bta/test/bta_test_fixtures.h"
#include "hci/controller_interface_mock.h"
#include "hci/le_rand_callback.h"
#include "stack/include/btm_status.h"
#include "test/common/main_handler.h"
#include "test/common/mock_functions.h"
#include "test/mock/mock_main_shim_entry.h"
#include "test/mock/mock_osi_alarm.h"
#include "test/mock/mock_osi_allocator.h"
#include "test/mock/mock_osi_properties.h"
#include "test/mock/mock_stack_acl.h"
#include "test/mock/mock_stack_btm_interface.h"
#define TEST_BT com::android::bluetooth::flags
using namespace std::chrono_literals;
using namespace bluetooth;
namespace {
constexpr uint8_t kUnusedTimer = BTA_ID_MAX;
const RawAddress kRawAddress({0x11, 0x22, 0x33, 0x44, 0x55, 0x66});
const RawAddress kRawAddress2({0x12, 0x34, 0x56, 0x78, 0x9a, 0xbc});
constexpr char kRemoteName[] = "TheRemoteName";
} // namespace
namespace bluetooth::legacy::testing {
tBTA_DM_SEARCH_CB& bta_dm_disc_search_cb();
void bta_dm_deinit_cb();
void bta_dm_init_cb();
void bta_dm_remote_name_cmpl(const tBTA_DM_REMOTE_NAME& remote_name_msg);
} // namespace bluetooth::legacy::testing
class BtaDmTest : public BtaWithContextTest {
protected:
void SetUp() override {
BtaWithContextTest::SetUp();
ON_CALL(controller_, LeRand).WillByDefault([](bluetooth::hci::LeRandCallback cb) {
cb(0x1234);
});
bluetooth::hci::testing::mock_controller_ = &controller_;
BTA_dm_init();
bluetooth::legacy::testing::bta_dm_init_cb();
for (int i = 0; i < BTA_DM_NUM_PM_TIMER; i++) {
for (int j = 0; j < BTA_DM_PM_MODE_TIMER_MAX; j++) {
bta_dm_cb.pm_timer[i].srvc_id[j] = kUnusedTimer;
}
}
}
void TearDown() override {
bluetooth::legacy::testing::bta_dm_deinit_cb();
BtaWithContextTest::TearDown();
bluetooth::hci::testing::mock_controller_ = nullptr;
}
bluetooth::hci::testing::MockControllerInterface controller_;
};
class BtaDmCustomAlarmTest : public BtaDmTest {
protected:
void SetUp() override {
BtaDmTest::SetUp();
test::mock::osi_alarm::alarm_set_on_mloop.body =
[this](alarm_t* alarm, uint64_t /*interval_ms*/, alarm_callback_t cb, void* data) {
ASSERT_TRUE(alarm != nullptr);
this->alarm_callback = cb;
this->alarm_data = data;
};
}
void TearDown() override {
test::mock::osi_alarm::alarm_set_on_mloop = {};
BtaDmTest::TearDown();
}
alarm_callback_t alarm_callback;
void* alarm_data{nullptr};
};
TEST_F(BtaDmTest, nop) {
bool status = true;
ASSERT_EQ(true, status);
}
TEST_F(BtaDmCustomAlarmTest, disable_no_acl_links) {
bta_dm_cb.disabling = true;
bta_dm_disable(); // Waiting for all ACL connections to drain
ASSERT_EQ(0, get_func_call_count("btm_remove_acl"));
ASSERT_EQ(1, get_func_call_count("alarm_set_on_mloop"));
// Execute timer callback
alarm_callback(this->alarm_data);
ASSERT_EQ(1, get_func_call_count("alarm_set_on_mloop"));
ASSERT_EQ(0, get_func_call_count("BTIF_dm_disable"));
ASSERT_EQ(1, get_func_call_count("future_ready"));
ASSERT_TRUE(!bta_dm_cb.disabling);
}
TEST_F(BtaDmCustomAlarmTest, disable_first_pass_with_acl_links) {
test::mock::stack_acl::BTM_GetNumAclLinks.body = []() { return 1; };
bta_dm_cb.disabling = true;
// ACL link is open
bta_dm_cb.device_list.count = 1;
bta_dm_disable(); // Waiting for all ACL connections to drain
ASSERT_EQ(1, get_func_call_count("alarm_set_on_mloop"));
ASSERT_EQ(0, get_func_call_count("BTIF_dm_disable"));
test::mock::stack_acl::BTM_GetNumAclLinks.body = []() { return 0; };
// First disable pass
alarm_callback(this->alarm_data);
ASSERT_EQ(1, get_func_call_count("alarm_set_on_mloop"));
ASSERT_EQ(1, get_func_call_count("BTIF_dm_disable"));
ASSERT_TRUE(!bta_dm_cb.disabling);
test::mock::stack_acl::BTM_GetNumAclLinks = {};
}
TEST_F(BtaDmCustomAlarmTest, disable_second_pass_with_acl_links) {
test::mock::stack_acl::BTM_GetNumAclLinks.body = []() { return 1; };
bta_dm_cb.disabling = true;
// ACL link is open
bta_dm_cb.device_list.count = 1;
bta_dm_disable(); // Waiting for all ACL connections to drain
ASSERT_EQ(1, get_func_call_count("alarm_set_on_mloop"));
ASSERT_EQ(0, get_func_call_count("BTIF_dm_disable"));
// First disable pass
alarm_callback(alarm_data);
ASSERT_EQ(2, get_func_call_count("alarm_set_on_mloop"));
ASSERT_EQ(0, get_func_call_count("BTIF_dm_disable"));
ASSERT_EQ(1, get_func_call_count("btm_remove_acl"));
// Second disable pass
alarm_callback(alarm_data);
ASSERT_EQ(1, get_func_call_count("BTIF_dm_disable"));
ASSERT_TRUE(!bta_dm_cb.disabling);
test::mock::stack_acl::BTM_GetNumAclLinks = {};
}
namespace {
struct BTA_DM_ENCRYPT_CBACK_parms {
const RawAddress bd_addr;
tBT_TRANSPORT transport;
tBTA_STATUS result;
};
std::queue BTA_DM_ENCRYPT_CBACK_queue;
void BTA_DM_ENCRYPT_CBACK(const RawAddress& bd_addr, tBT_TRANSPORT transport, tBTA_STATUS result) {
BTA_DM_ENCRYPT_CBACK_queue.push({bd_addr, transport, result});
}
} // namespace
namespace bluetooth {
namespace legacy {
namespace testing {
tBTA_DM_PEER_DEVICE* allocate_device_for(const RawAddress& bd_addr, tBT_TRANSPORT transport);
void bta_dm_remname_cback(const tBTM_REMOTE_DEV_NAME* p);
tBT_TRANSPORT bta_dm_determine_discovery_transport(const RawAddress& remote_bd_addr);
tBTM_STATUS bta_dm_sp_cback(tBTM_SP_EVT event, tBTM_SP_EVT_DATA* p_data);
void BTA_dm_on_hw_on();
} // namespace testing
} // namespace legacy
} // namespace bluetooth
TEST_F(BtaDmTest, bta_dm_set_encryption) {
const tBT_TRANSPORT transport{BT_TRANSPORT_LE};
const tBTM_BLE_SEC_ACT sec_act{BTM_BLE_SEC_NONE};
// Callback not provided
bta_dm_set_encryption(kRawAddress, transport, nullptr, sec_act);
// Device connection does not exist
bta_dm_set_encryption(kRawAddress, transport, BTA_DM_ENCRYPT_CBACK, sec_act);
// Setup a connected device
tBTA_DM_PEER_DEVICE* device =
bluetooth::legacy::testing::allocate_device_for(kRawAddress, transport);
ASSERT_TRUE(device != nullptr);
device->p_encrypt_cback = nullptr;
// Setup a device that is busy with another encryption
// Fake indication that the encryption is in progress with non-null callback
device->p_encrypt_cback = BTA_DM_ENCRYPT_CBACK;
bta_dm_set_encryption(kRawAddress, transport, BTA_DM_ENCRYPT_CBACK, sec_act);
ASSERT_EQ(0, get_func_call_count("BTM_SetEncryption"));
ASSERT_EQ(1UL, BTA_DM_ENCRYPT_CBACK_queue.size());
auto params = BTA_DM_ENCRYPT_CBACK_queue.front();
BTA_DM_ENCRYPT_CBACK_queue.pop();
ASSERT_EQ(BTA_BUSY, params.result);
device->p_encrypt_cback = nullptr;
// Setup a device that fails encryption
mock_btm_client_interface.security.BTM_SetEncryption =
[](const RawAddress& /*bd_addr*/, tBT_TRANSPORT /*transport*/,
tBTM_SEC_CALLBACK* /*p_callback*/, void* /*p_ref_data*/,
tBTM_BLE_SEC_ACT /*sec_act*/) -> tBTM_STATUS {
inc_func_call_count("BTM_SetEncryption");
return tBTM_STATUS::BTM_MODE_UNSUPPORTED;
};
bta_dm_set_encryption(kRawAddress, transport, BTA_DM_ENCRYPT_CBACK, sec_act);
ASSERT_EQ(1, get_func_call_count("BTM_SetEncryption"));
ASSERT_EQ(0UL, BTA_DM_ENCRYPT_CBACK_queue.size());
device->p_encrypt_cback = nullptr;
// Setup a device that successfully starts encryption
mock_btm_client_interface.security.BTM_SetEncryption =
[](const RawAddress& /*bd_addr*/, tBT_TRANSPORT /*transport*/,
tBTM_SEC_CALLBACK* /*p_callback*/, void* /*p_ref_data*/,
tBTM_BLE_SEC_ACT /*sec_act*/) -> tBTM_STATUS {
inc_func_call_count("BTM_SetEncryption");
return tBTM_STATUS::BTM_CMD_STARTED;
};
bta_dm_set_encryption(kRawAddress, transport, BTA_DM_ENCRYPT_CBACK, sec_act);
ASSERT_EQ(2, get_func_call_count("BTM_SetEncryption"));
ASSERT_EQ(0UL, BTA_DM_ENCRYPT_CBACK_queue.size());
ASSERT_NE(nullptr, device->p_encrypt_cback);
BTA_DM_ENCRYPT_CBACK_queue = {};
}
void bta_dm_encrypt_cback(RawAddress bd_addr, tBT_TRANSPORT transport, void* /* p_ref_data */,
tBTM_STATUS result);
TEST_F(BtaDmTest, bta_dm_encrypt_cback) {
const tBT_TRANSPORT transport{BT_TRANSPORT_LE};
// Setup a connected device
tBTA_DM_PEER_DEVICE* device =
bluetooth::legacy::testing::allocate_device_for(kRawAddress, transport);
ASSERT_TRUE(device != nullptr);
// Encryption with no callback set
device->p_encrypt_cback = nullptr;
bta_dm_encrypt_cback(kRawAddress, transport, nullptr, tBTM_STATUS::BTM_SUCCESS);
ASSERT_EQ(0UL, BTA_DM_ENCRYPT_CBACK_queue.size());
// Encryption with callback
device->p_encrypt_cback = BTA_DM_ENCRYPT_CBACK;
bta_dm_encrypt_cback(kRawAddress, transport, nullptr, tBTM_STATUS::BTM_SUCCESS);
device->p_encrypt_cback = BTA_DM_ENCRYPT_CBACK;
bta_dm_encrypt_cback(kRawAddress, transport, nullptr, tBTM_STATUS::BTM_WRONG_MODE);
device->p_encrypt_cback = BTA_DM_ENCRYPT_CBACK;
bta_dm_encrypt_cback(kRawAddress, transport, nullptr, tBTM_STATUS::BTM_NO_RESOURCES);
device->p_encrypt_cback = BTA_DM_ENCRYPT_CBACK;
bta_dm_encrypt_cback(kRawAddress, transport, nullptr, tBTM_STATUS::BTM_BUSY);
device->p_encrypt_cback = BTA_DM_ENCRYPT_CBACK;
bta_dm_encrypt_cback(kRawAddress, transport, nullptr, tBTM_STATUS::BTM_ILLEGAL_VALUE);
ASSERT_EQ(5UL, BTA_DM_ENCRYPT_CBACK_queue.size());
auto params_BTM_SUCCESS = BTA_DM_ENCRYPT_CBACK_queue.front();
BTA_DM_ENCRYPT_CBACK_queue.pop();
ASSERT_EQ(BTA_SUCCESS, params_BTM_SUCCESS.result);
auto params_BTM_WRONG_MODE = BTA_DM_ENCRYPT_CBACK_queue.front();
BTA_DM_ENCRYPT_CBACK_queue.pop();
ASSERT_EQ(BTA_WRONG_MODE, params_BTM_WRONG_MODE.result);
auto params_BTM_NO_RESOURCES = BTA_DM_ENCRYPT_CBACK_queue.front();
BTA_DM_ENCRYPT_CBACK_queue.pop();
ASSERT_EQ(BTA_NO_RESOURCES, params_BTM_NO_RESOURCES.result);
auto params_BTM_BUSY = BTA_DM_ENCRYPT_CBACK_queue.front();
BTA_DM_ENCRYPT_CBACK_queue.pop();
ASSERT_EQ(BTA_BUSY, params_BTM_BUSY.result);
auto params_BTM_ILLEGAL_VALUE = BTA_DM_ENCRYPT_CBACK_queue.front();
BTA_DM_ENCRYPT_CBACK_queue.pop();
ASSERT_EQ(BTA_FAILURE, params_BTM_ILLEGAL_VALUE.result);
}
TEST_F(BtaDmTest, bta_dm_remname_cback__typical) {
tBTA_DM_SEARCH_CB& search_cb = bluetooth::legacy::testing::bta_dm_disc_search_cb();
search_cb.peer_bdaddr = kRawAddress;
search_cb.name_discover_done = false;
tBTM_REMOTE_DEV_NAME name = {
.bd_addr = kRawAddress,
.remote_bd_name = {},
.btm_status = tBTM_STATUS::BTM_SUCCESS,
.hci_status = HCI_SUCCESS,
};
bd_name_from_char_pointer(name.remote_bd_name, kRemoteName);
bluetooth::legacy::testing::bta_dm_remname_cback(&name);
sync_main_handler();
ASSERT_TRUE(bluetooth::legacy::testing::bta_dm_disc_search_cb().name_discover_done);
}
TEST_F(BtaDmTest, bta_dm_remname_cback__wrong_address) {
tBTA_DM_SEARCH_CB& search_cb = bluetooth::legacy::testing::bta_dm_disc_search_cb();
search_cb.p_device_search_cback = nullptr;
search_cb.peer_bdaddr = kRawAddress;
search_cb.name_discover_done = false;
tBTM_REMOTE_DEV_NAME name = {
.bd_addr = kRawAddress2,
.remote_bd_name = {},
.btm_status = tBTM_STATUS::BTM_SUCCESS,
.hci_status = HCI_SUCCESS,
};
bd_name_from_char_pointer(name.remote_bd_name, kRemoteName);
bluetooth::legacy::testing::bta_dm_remname_cback(&name);
sync_main_handler();
}
TEST_F(BtaDmTest, bta_dm_remname_cback__HCI_ERR_CONNECTION_EXISTS) {
tBTA_DM_SEARCH_CB& search_cb = bluetooth::legacy::testing::bta_dm_disc_search_cb();
search_cb.peer_bdaddr = kRawAddress;
search_cb.name_discover_done = false;
tBTM_REMOTE_DEV_NAME name = {
.bd_addr = RawAddress::kEmpty,
.remote_bd_name = {},
.btm_status = tBTM_STATUS::BTM_SUCCESS,
.hci_status = HCI_ERR_CONNECTION_EXISTS,
};
bd_name_from_char_pointer(name.remote_bd_name, kRemoteName);
bluetooth::legacy::testing::bta_dm_remname_cback(&name);
sync_main_handler();
ASSERT_TRUE(bluetooth::legacy::testing::bta_dm_disc_search_cb().name_discover_done);
}
TEST_F(BtaDmTest, bta_dm_determine_discovery_transport__BR_EDR) {
tBTA_DM_SEARCH_CB& search_cb = bluetooth::legacy::testing::bta_dm_disc_search_cb();
mock_btm_client_interface.peer.BTM_ReadDevInfo = [](const RawAddress& /*remote_bda*/,
tBT_DEVICE_TYPE* p_dev_type,
tBLE_ADDR_TYPE* p_addr_type) {
*p_dev_type = BT_DEVICE_TYPE_BREDR;
*p_addr_type = BLE_ADDR_PUBLIC;
};
ASSERT_EQ(BT_TRANSPORT_BR_EDR,
bluetooth::legacy::testing::bta_dm_determine_discovery_transport(kRawAddress));
}
TEST_F(BtaDmTest, bta_dm_determine_discovery_transport__BLE__PUBLIC) {
tBTA_DM_SEARCH_CB& search_cb = bluetooth::legacy::testing::bta_dm_disc_search_cb();
mock_btm_client_interface.peer.BTM_ReadDevInfo = [](const RawAddress& /*remote_bda*/,
tBT_DEVICE_TYPE* p_dev_type,
tBLE_ADDR_TYPE* p_addr_type) {
*p_dev_type = BT_DEVICE_TYPE_BLE;
*p_addr_type = BLE_ADDR_PUBLIC;
};
ASSERT_EQ(BT_TRANSPORT_LE,
bluetooth::legacy::testing::bta_dm_determine_discovery_transport(kRawAddress));
}
TEST_F(BtaDmTest, bta_dm_determine_discovery_transport__DUMO) {
tBTA_DM_SEARCH_CB& search_cb = bluetooth::legacy::testing::bta_dm_disc_search_cb();
mock_btm_client_interface.peer.BTM_ReadDevInfo = [](const RawAddress& /*remote_bda*/,
tBT_DEVICE_TYPE* p_dev_type,
tBLE_ADDR_TYPE* p_addr_type) {
*p_dev_type = BT_DEVICE_TYPE_DUMO;
*p_addr_type = BLE_ADDR_PUBLIC;
};
ASSERT_EQ(BT_TRANSPORT_BR_EDR,
bluetooth::legacy::testing::bta_dm_determine_discovery_transport(kRawAddress));
}
TEST_F(BtaDmTest, bta_dm_search_evt_text) {
std::vector> events = {
std::make_pair(BTA_DM_INQ_RES_EVT, "BTA_DM_INQ_RES_EVT"),
std::make_pair(BTA_DM_INQ_CMPL_EVT, "BTA_DM_INQ_CMPL_EVT"),
std::make_pair(BTA_DM_DISC_CMPL_EVT, "BTA_DM_DISC_CMPL_EVT"),
std::make_pair(BTA_DM_SEARCH_CANCEL_CMPL_EVT, "BTA_DM_SEARCH_CANCEL_CMPL_EVT"),
std::make_pair(BTA_DM_NAME_READ_EVT, "BTA_DM_NAME_READ_EVT"),
};
for (const auto& event : events) {
ASSERT_STREQ(event.second.c_str(), bta_dm_search_evt_text(event.first).c_str());
}
ASSERT_STREQ(std::format("UNKNOWN[{}]", std::numeric_limits::max()).c_str(),
bta_dm_search_evt_text(
static_cast(std::numeric_limits::max()))
.c_str());
}
TEST_F(BtaDmTest, bta_dm_remote_name_cmpl) {
reset_mock_btm_client_interface();
mock_btm_client_interface.db.BTM_InqDbRead = [](const RawAddress& /*bd_addr*/) -> tBTM_INQ_INFO* {
inc_func_call_count("BTM_InqDbRead");
return nullptr;
};
tBTA_DM_REMOTE_NAME remote_name_msg{
// tBTA_DM_REMOTE_NAME
.bd_addr = kRawAddress,
.bd_name = {0},
.hci_status = HCI_SUCCESS,
};
bluetooth::legacy::testing::bta_dm_remote_name_cmpl(remote_name_msg);
ASSERT_EQ(1, get_func_call_count("BTM_InqDbRead"));
}
TEST_F(BtaDmTest, bta_dm_disc_start__true) { bta_dm_disc_start(true); }
TEST_F(BtaDmTest, bta_dm_disc_start__false) { bta_dm_disc_start(false); }
TEST_F(BtaDmTest, bta_dm_disc_stop) { bta_dm_disc_stop(); }
TEST_F(BtaDmCustomAlarmTest, bta_dm_sniff_cback) {
// Setup a connected device
const tBT_TRANSPORT transport{BT_TRANSPORT_BR_EDR};
tBTA_DM_PEER_DEVICE* device =
bluetooth::legacy::testing::allocate_device_for(kRawAddress, transport);
ASSERT_TRUE(device != nullptr);
// Trigger a sniff timer
bta_dm_pm_start_timer(&bta_dm_cb.pm_timer[0], bta_pm_action_to_timer_idx(BTA_DM_PM_SNIFF), 10, 1,
BTA_DM_PM_SNIFF);
bta_dm_cb.pm_timer[0].peer_bdaddr = kRawAddress;
ASSERT_EQ(1, get_func_call_count("alarm_set_on_mloop"));
// Trigger reset sniff
bta_dm_sniff_cback(BTA_ID_JV, 1, kRawAddress);
ASSERT_EQ(1, get_func_call_count("alarm_cancel"));
ASSERT_EQ(2, get_func_call_count("alarm_set_on_mloop"));
}
TEST_F(BtaDmCustomAlarmTest, sniff_offload_feature__test_sysprop) {
bool is_property_enabled = true;
test::mock::osi_properties::osi_property_get_bool.body =
[&](const char* /*key*/, bool /*default_value*/) -> int { return is_property_enabled; };
// Expect not to trigger bta_dm_init_pm due to sysprop enabled
// and reset the value of .srvc_id.
is_property_enabled = true;
bluetooth::legacy::testing::BTA_dm_on_hw_on();
ASSERT_EQ(0, bta_dm_cb.pm_timer[0].srvc_id[0]);
// Expect to trigger bta_dm_init_pm and init the value of .srvc_id to
// BTA_ID_MAX due to sysprop disabled.
is_property_enabled = false;
bluetooth::legacy::testing::BTA_dm_on_hw_on();
ASSERT_EQ((uint8_t)BTA_ID_MAX, bta_dm_cb.pm_timer[0].srvc_id[0]);
// Shouldn't crash even there's no active timer when calling
// bta_dm_disable_pm.
bta_dm_cb.pm_timer[0].in_use = false;
bta_dm_cb.pm_timer[0].srvc_id[0] = kUnusedTimer;
bta_dm_disable_pm();
}