blob: 9927e220127a928ab7fc2de6f886bf46317e3c73 [file] [log] [blame]
/******************************************************************************
*
* Copyright (C) 2016 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 <gmock/gmock.h>
#include <gtest/gtest.h>
#include "device/include/controller.h"
#include "stack/btm/ble_advertiser_hci_interface.h"
#include "stack/include/ble_advertiser.h"
using ::testing::_;
using ::testing::Args;
using ::testing::ElementsAreArray;
using ::testing::Exactly;
using ::testing::IsEmpty;
using ::testing::SaveArg;
using status_cb = BleAdvertiserHciInterface::status_cb;
const int num_adv_instances = 16;
/* Below are methods that must be implemented if we don't want to compile the
* whole stack. They will be removed, or changed into mocks one by one in the
* future, as the refactoring progresses */
bool BTM_BleLocalPrivacyEnabled() { return true; }
uint16_t BTM_ReadDiscoverability(uint16_t* p_window, uint16_t* p_interval) {
return true;
}
bool SMP_Encrypt(uint8_t* key, uint8_t key_len, uint8_t* plain_text,
uint8_t pt_len, tSMP_ENC* p_out) {
return true;
}
void BTM_GetDeviceIDRoot(BT_OCTET16 irk) {}
void btm_ble_update_dmt_flag_bits(uint8_t* flag_value,
const uint16_t connect_mode,
const uint16_t disc_mode) {}
void btm_acl_update_conn_addr(uint8_t conn_handle, BD_ADDR address) {}
void btm_gen_resolvable_private_addr(void* p_cmd_cplt_cback) {
// TODO(jpawlowski): should call p_cmd_cplt_cback();
}
void alarm_set_on_queue(alarm_t* alarm, period_ms_t interval_ms,
alarm_callback_t cb, void* data, fixed_queue_t* queue) {
}
void alarm_cancel(alarm_t* alarm) {}
alarm_t* alarm_new_periodic(const char* name) { return nullptr; }
alarm_t* alarm_new(const char* name) { return nullptr; }
void alarm_free(alarm_t* alarm) {}
const controller_t* controller_get_interface() { return nullptr; }
fixed_queue_t* btu_general_alarm_queue = nullptr;
namespace {
class AdvertiserHciMock : public BleAdvertiserHciInterface {
public:
AdvertiserHciMock() = default;
~AdvertiserHciMock() override = default;
MOCK_METHOD1(ReadInstanceCount,
void(base::Callback<void(uint8_t /* inst_cnt*/)>));
MOCK_METHOD1(SetAdvertisingEventObserver,
void(AdvertisingEventObserver* observer));
MOCK_METHOD6(SetAdvertisingData,
void(uint8_t, uint8_t, uint8_t, uint8_t, uint8_t*, status_cb));
MOCK_METHOD6(SetScanResponseData,
void(uint8_t, uint8_t, uint8_t, uint8_t, uint8_t*, status_cb));
MOCK_METHOD3(SetRandomAddress, void(uint8_t, BD_ADDR, status_cb));
MOCK_METHOD5(Enable, void(uint8_t, uint8_t, uint16_t, uint8_t, status_cb));
MOCK_METHOD9(SetParameters1,
void(uint8_t, uint16_t, uint32_t, uint32_t, uint8_t, uint8_t,
uint8_t, BD_ADDR, uint8_t));
MOCK_METHOD7(SetParameters2, void(int8_t, uint8_t, uint8_t, uint8_t, uint8_t,
uint8_t, status_cb));
void SetParameters(uint8_t handle, uint16_t properties, uint32_t adv_int_min,
uint32_t adv_int_max, uint8_t channel_map,
uint8_t own_address_type, uint8_t peer_address_type,
BD_ADDR peer_address, uint8_t filter_policy,
int8_t tx_power, uint8_t primary_phy,
uint8_t secondary_max_skip, uint8_t secondary_phy,
uint8_t advertising_sid,
uint8_t scan_request_notify_enable,
status_cb cmd_complete) override {
SetParameters1(handle, properties, adv_int_min, adv_int_max, channel_map,
own_address_type, peer_address_type, peer_address,
filter_policy);
SetParameters2(tx_power, primary_phy, secondary_max_skip, secondary_phy,
advertising_sid, scan_request_notify_enable, cmd_complete);
};
private:
DISALLOW_COPY_AND_ASSIGN(AdvertiserHciMock);
};
} // namespace
class BleAdvertisingManagerTest : public testing::Test {
protected:
int reg_inst_id = -1;
int reg_status = -1;
int set_params_status = -1;
int set_data_status = -1;
int enable_status = -1;
int start_advertising_status = -1;
std::unique_ptr<AdvertiserHciMock> hci_mock;
virtual void SetUp() {
hci_mock.reset(new AdvertiserHciMock());
base::Callback<void(uint8_t)> inst_cnt_Cb;
EXPECT_CALL(*hci_mock, ReadInstanceCount(_))
.Times(Exactly(1))
.WillOnce(SaveArg<0>(&inst_cnt_Cb));
BleAdvertisingManager::Initialize(hci_mock.get());
// we are a truly gracious fake controller, let the command succeed!
inst_cnt_Cb.Run(num_adv_instances);
::testing::Mock::VerifyAndClearExpectations(hci_mock.get());
}
virtual void TearDown() {
BleAdvertisingManager::CleanUp();
hci_mock.reset();
}
public:
void RegistrationCb(uint8_t inst_id, uint8_t status) {
reg_inst_id = inst_id;
reg_status = status;
}
void SetParametersCb(uint8_t status) { set_params_status = status; }
void SetDataCb(uint8_t status) { set_data_status = status; }
void EnableCb(uint8_t status) { enable_status = status; }
void StartAdvertisingCb(uint8_t status) { start_advertising_status = status; }
};
TEST_F(BleAdvertisingManagerTest, test_registration) {
for (int i = 0; i < num_adv_instances; i++) {
BleAdvertisingManager::Get()->RegisterAdvertiser(base::Bind(
&BleAdvertisingManagerTest::RegistrationCb, base::Unretained(this)));
EXPECT_EQ(BTM_BLE_MULTI_ADV_SUCCESS, reg_status);
EXPECT_EQ(i, reg_inst_id);
}
// This call should return an error - no more advertisers left.
BleAdvertisingManager::Get()->RegisterAdvertiser(base::Bind(
&BleAdvertisingManagerTest::RegistrationCb, base::Unretained(this)));
EXPECT_EQ(ADVERTISE_FAILED_TOO_MANY_ADVERTISERS, reg_status);
// Don't bother checking inst_id, it doesn't matter
// This will currently trigger a mock message about a call to Enable(). This
// should be fixed in the future- we shouldn't disable non-enabled scan.
BleAdvertisingManager::Get()->Unregister(5);
// One advertiser was freed, so should be able to register one now
BleAdvertisingManager::Get()->RegisterAdvertiser(base::Bind(
&BleAdvertisingManagerTest::RegistrationCb, base::Unretained(this)));
EXPECT_EQ(BTM_BLE_MULTI_ADV_SUCCESS, reg_status);
EXPECT_EQ(5, reg_inst_id);
}
/* This test verifies that the following flow is working correctly: register,
* set parameters, set data, enable, ... (advertise) ..., unregister*/
TEST_F(BleAdvertisingManagerTest, test_android_flow) {
BleAdvertisingManager::Get()->RegisterAdvertiser(base::Bind(
&BleAdvertisingManagerTest::RegistrationCb, base::Unretained(this)));
EXPECT_EQ(BTM_BLE_MULTI_ADV_SUCCESS, reg_status);
int advertiser_id = reg_inst_id;
status_cb set_params_cb;
tBTM_BLE_ADV_PARAMS params;
EXPECT_CALL(*hci_mock, SetParameters1(advertiser_id, _, _, _, _, _, _, _, _))
.Times(1);
EXPECT_CALL(*hci_mock, SetParameters2(_, _, _, _, _, _, _))
.Times(1)
.WillOnce(SaveArg<6>(&set_params_cb));
BleAdvertisingManager::Get()->SetParameters(
advertiser_id, &params,
base::Bind(&BleAdvertisingManagerTest::SetParametersCb,
base::Unretained(this)));
// we are a truly gracious fake controller, let the command succeed!
set_params_cb.Run(0);
EXPECT_EQ(BTM_BLE_MULTI_ADV_SUCCESS, set_params_status);
::testing::Mock::VerifyAndClearExpectations(hci_mock.get());
status_cb set_data_cb;
EXPECT_CALL(*hci_mock, SetAdvertisingData(advertiser_id, _, _, _, _, _))
.Times(1)
.WillOnce(SaveArg<5>(&set_data_cb));
BleAdvertisingManager::Get()->SetData(
advertiser_id, false, std::vector<uint8_t>(),
base::Bind(&BleAdvertisingManagerTest::SetDataCb,
base::Unretained(this)));
set_data_cb.Run(0);
EXPECT_EQ(BTM_BLE_MULTI_ADV_SUCCESS, set_data_status);
::testing::Mock::VerifyAndClearExpectations(hci_mock.get());
status_cb enable_cb;
EXPECT_CALL(*hci_mock, Enable(0x01 /* enable */, advertiser_id, _, _, _))
.Times(1)
.WillOnce(SaveArg<4>(&enable_cb));
BleAdvertisingManager::Get()->Enable(
advertiser_id, true,
base::Bind(&BleAdvertisingManagerTest::EnableCb, base::Unretained(this)),
0, base::Callback<void(uint8_t)>());
enable_cb.Run(0);
EXPECT_EQ(BTM_BLE_MULTI_ADV_SUCCESS, enable_status);
::testing::Mock::VerifyAndClearExpectations(hci_mock.get());
/* fake controller should be advertising */
EXPECT_CALL(*hci_mock, Enable(0x00 /* disable */, advertiser_id, _, _, _))
.Times(1)
.WillOnce(SaveArg<4>(&enable_cb));
BleAdvertisingManager::Get()->Unregister(advertiser_id);
enable_cb.Run(0);
::testing::Mock::VerifyAndClearExpectations(hci_mock.get());
}
/* This test verifies that when advertising data is set, tx power and flags will
* be properly filled. */
TEST_F(BleAdvertisingManagerTest, test_adv_data_filling) {
BleAdvertisingManager::Get()->RegisterAdvertiser(base::Bind(
&BleAdvertisingManagerTest::RegistrationCb, base::Unretained(this)));
EXPECT_EQ(BTM_BLE_MULTI_ADV_SUCCESS, reg_status);
int advertiser_id = reg_inst_id;
status_cb set_params_cb;
tBTM_BLE_ADV_PARAMS params;
params.advertising_event_properties =
BleAdvertisingManager::advertising_prop_legacy_connectable;
params.tx_power = -15;
EXPECT_CALL(*hci_mock, SetParameters1(advertiser_id, _, _, _, _, _, _, _, _))
.Times(1);
EXPECT_CALL(*hci_mock, SetParameters2(params.tx_power, _, _, _, _, _, _))
.Times(1)
.WillOnce(SaveArg<6>(&set_params_cb));
BleAdvertisingManager::Get()->SetParameters(
advertiser_id, &params,
base::Bind(&BleAdvertisingManagerTest::SetParametersCb,
base::Unretained(this)));
// let the set parameters command succeed!
set_params_cb.Run(0);
EXPECT_EQ(BTM_BLE_MULTI_ADV_SUCCESS, set_params_status);
::testing::Mock::VerifyAndClearExpectations(hci_mock.get());
status_cb set_data_cb;
/* verify that flags will be added, and tx power filled, if call to SetData
* contained only tx power, and the advertisement is connectable */
uint8_t expected_adv_data[] = {
0x02 /* len */, 0x01 /* flags */,
0x02 /* flags value */, 0x02 /* len */,
0x0A /* tx_power */, static_cast<uint8_t>(params.tx_power)};
EXPECT_CALL(*hci_mock, SetAdvertisingData(advertiser_id, _, _, _, _, _))
.With(Args<4, 3>(ElementsAreArray(expected_adv_data)))
.Times(1)
.WillOnce(SaveArg<5>(&set_data_cb));
BleAdvertisingManager::Get()->SetData(
advertiser_id, false,
std::vector<uint8_t>({0x02 /* len */, 0x0A /* tx_power */, 0x00}),
base::Bind(&BleAdvertisingManagerTest::SetDataCb,
base::Unretained(this)));
set_data_cb.Run(0);
EXPECT_EQ(BTM_BLE_MULTI_ADV_SUCCESS, set_data_status);
::testing::Mock::VerifyAndClearExpectations(hci_mock.get());
}
/* This test verifies that when advertising is non-connectable, flags will not
* be added. */
TEST_F(BleAdvertisingManagerTest, test_adv_data_not_filling) {
BleAdvertisingManager::Get()->RegisterAdvertiser(base::Bind(
&BleAdvertisingManagerTest::RegistrationCb, base::Unretained(this)));
EXPECT_EQ(BTM_BLE_MULTI_ADV_SUCCESS, reg_status);
int advertiser_id = reg_inst_id;
status_cb set_params_cb;
tBTM_BLE_ADV_PARAMS params;
params.advertising_event_properties =
BleAdvertisingManager::advertising_prop_legacy_non_connectable;
params.tx_power = -15;
EXPECT_CALL(*hci_mock, SetParameters1(advertiser_id, _, _, _, _, _, _, _, _))
.Times(1);
EXPECT_CALL(*hci_mock,
SetParameters2((uint8_t)params.tx_power, _, _, _, _, _, _))
.Times(1)
.WillOnce(SaveArg<6>(&set_params_cb));
BleAdvertisingManager::Get()->SetParameters(
advertiser_id, &params,
base::Bind(&BleAdvertisingManagerTest::SetParametersCb,
base::Unretained(this)));
// let the set parameters command succeed!
set_params_cb.Run(0);
EXPECT_EQ(BTM_BLE_MULTI_ADV_SUCCESS, set_params_status);
::testing::Mock::VerifyAndClearExpectations(hci_mock.get());
status_cb set_data_cb;
/* verify that flags will not be added */
uint8_t expected_adv_data[] = {
0x02 /* len */, 0xFF /* manufacturer specific */, 0x01 /* data */};
EXPECT_CALL(*hci_mock, SetAdvertisingData(advertiser_id, _, _, _, _, _))
.With(Args<4, 3>(ElementsAreArray(expected_adv_data)))
.Times(1)
.WillOnce(SaveArg<5>(&set_data_cb));
BleAdvertisingManager::Get()->SetData(
advertiser_id, false, std::vector<uint8_t>({0x02 /* len */, 0xFF, 0x01}),
base::Bind(&BleAdvertisingManagerTest::SetDataCb,
base::Unretained(this)));
set_data_cb.Run(0);
EXPECT_EQ(BTM_BLE_MULTI_ADV_SUCCESS, set_data_status);
::testing::Mock::VerifyAndClearExpectations(hci_mock.get());
}
TEST_F(BleAdvertisingManagerTest, test_reenabling) {
BleAdvertisingManager::Get()->RegisterAdvertiser(base::Bind(
&BleAdvertisingManagerTest::RegistrationCb, base::Unretained(this)));
EXPECT_EQ(BTM_BLE_MULTI_ADV_SUCCESS, reg_status);
EXPECT_EQ(0, reg_inst_id);
uint8_t advertiser_id = reg_inst_id;
status_cb enable_cb;
EXPECT_CALL(*hci_mock, Enable(0x01 /* enable */, advertiser_id, _, _, _))
.Times(1)
.WillOnce(SaveArg<4>(&enable_cb));
BleAdvertisingManager::Get()->OnAdvertisingSetTerminated(advertiser_id, 0x00,
0x05, 0x00);
enable_cb.Run(0);
::testing::Mock::VerifyAndClearExpectations(hci_mock.get());
}
/* Make sure that instance is not reenabled if it's already disabled */
TEST_F(BleAdvertisingManagerTest, test_reenabling_disabled_instance) {
uint8_t advertiser_id = 1; // any unregistered value
EXPECT_CALL(*hci_mock, Enable(_, _, _, _, _)).Times(Exactly(0));
BleAdvertisingManager::Get()->OnAdvertisingSetTerminated(advertiser_id, 0x00,
0x05, 0x00);
::testing::Mock::VerifyAndClearExpectations(hci_mock.get());
}
/* This test verifies that the only flow that is currently used on Android, is
* working correctly in happy case scenario. */
TEST_F(BleAdvertisingManagerTest, test_start_advertising) {
BleAdvertisingManager::Get()->RegisterAdvertiser(base::Bind(
&BleAdvertisingManagerTest::RegistrationCb, base::Unretained(this)));
EXPECT_EQ(BTM_BLE_MULTI_ADV_SUCCESS, reg_status);
int advertiser_id = reg_inst_id;
std::vector<uint8_t> adv_data;
std::vector<uint8_t> scan_resp;
tBTM_BLE_ADV_PARAMS params;
status_cb set_params_cb;
status_cb set_data_cb;
status_cb set_scan_resp_data_cb;
status_cb enable_cb;
EXPECT_CALL(*hci_mock, SetParameters1(advertiser_id, _, _, _, _, _, _, _, _))
.Times(1);
EXPECT_CALL(*hci_mock, SetParameters2(_, _, _, _, _, _, _))
.Times(1)
.WillOnce(SaveArg<6>(&set_params_cb));
EXPECT_CALL(*hci_mock, SetAdvertisingData(advertiser_id, _, _, _, _, _))
.Times(1)
.WillOnce(SaveArg<5>(&set_data_cb));
EXPECT_CALL(*hci_mock, SetScanResponseData(advertiser_id, _, _, _, _, _))
.Times(1)
.WillOnce(SaveArg<5>(&set_scan_resp_data_cb));
EXPECT_CALL(*hci_mock, Enable(0x01 /* enable */, advertiser_id, _, _, _))
.Times(1)
.WillOnce(SaveArg<4>(&enable_cb));
BleAdvertisingManager::Get()->StartAdvertising(
advertiser_id, base::Bind(&BleAdvertisingManagerTest::StartAdvertisingCb,
base::Unretained(this)),
&params, adv_data, scan_resp, 0, base::Callback<void(uint8_t)>());
// we are a truly gracious fake controller, let the commands succeed!
set_params_cb.Run(0);
set_data_cb.Run(0);
set_scan_resp_data_cb.Run(0);
enable_cb.Run(0);
EXPECT_EQ(BTM_BLE_MULTI_ADV_SUCCESS, start_advertising_status);
::testing::Mock::VerifyAndClearExpectations(hci_mock.get());
// ... advertising ...
// Disable advertiser
status_cb disable_cb;
EXPECT_CALL(*hci_mock, Enable(0x00 /* disable */, advertiser_id, _, _, _))
.Times(1)
.WillOnce(SaveArg<4>(&disable_cb));
BleAdvertisingManager::Get()->Unregister(advertiser_id);
disable_cb.Run(0);
::testing::Mock::VerifyAndClearExpectations(hci_mock.get());
}
TEST_F(BleAdvertisingManagerTest, test_start_advertising_set_params_failed) {
BleAdvertisingManager::Get()->RegisterAdvertiser(base::Bind(
&BleAdvertisingManagerTest::RegistrationCb, base::Unretained(this)));
EXPECT_EQ(BTM_BLE_MULTI_ADV_SUCCESS, reg_status);
int advertiser_id = reg_inst_id;
std::vector<uint8_t> adv_data;
std::vector<uint8_t> scan_resp;
tBTM_BLE_ADV_PARAMS params;
status_cb set_params_cb;
EXPECT_CALL(*hci_mock, SetParameters1(advertiser_id, _, _, _, _, _, _, _, _))
.Times(1);
EXPECT_CALL(*hci_mock, SetParameters2(_, _, _, _, _, _, _))
.Times(1)
.WillOnce(SaveArg<6>(&set_params_cb));
EXPECT_CALL(*hci_mock, SetAdvertisingData(advertiser_id, _, _, _, _, _))
.Times(Exactly(0));
BleAdvertisingManager::Get()->StartAdvertising(
advertiser_id, base::Bind(&BleAdvertisingManagerTest::StartAdvertisingCb,
base::Unretained(this)),
&params, adv_data, scan_resp, 0, base::Callback<void(uint8_t)>());
// set params failed
set_params_cb.Run(0x01);
// Expect the whole flow to fail right away
EXPECT_EQ(BTM_BLE_MULTI_ADV_FAILURE, start_advertising_status);
::testing::Mock::VerifyAndClearExpectations(hci_mock.get());
}