btstack/test/mock/mock_gatt_client.c
2021-06-09 10:50:09 +02:00

470 lines
23 KiB
C

#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include "btstack_debug.h"
#include "mock_gatt_client.h"
#include "CppUTest/TestHarness.h"
#include "CppUTestExt/MockSupport.h"
static enum {
MOCK_QUERY_IDLE = 0,
MOCK_QUERY_DISCOVER_PRIMARY_SERVICES_BY_UUID16,
MOCK_QUERY_DISCOVER_CHARACTERISTICS_BY_UUID16,
MOCK_QUERY_DISCOVER_CHARACTERISTIC_DESCRIPTORS,
MOCK_WRITE_CLIENT_CHARACTERISTIC_CONFIGURATION,
MOCK_READ_VALUE_OF_CHARACTERISTIC_USING_VALUE_HANDLE
} mock_gatt_client_state;
static uint16_t mock_gatt_client_att_handle_generator;
static uint8_t mock_gatt_client_att_error;
static uint16_t mock_gatt_client_uuid;
static uint16_t mock_gatt_client_value_handle;
static uint16_t mock_gatt_client_start_handle;
static uint16_t mock_gatt_client_end_handle;
static gatt_client_t gatt_client;
static btstack_linked_list_t mock_gatt_client_services;
static mock_gatt_client_service_t * mock_gatt_client_last_service;
static mock_gatt_client_characteristic_t * mock_gatt_client_last_characteristic;
void mock_gatt_client_reset(void){
mock_gatt_client_att_error = 0;
mock_gatt_client_state = MOCK_QUERY_IDLE;
mock_gatt_client_att_handle_generator = 0;
mock_gatt_client_last_service = NULL;
btstack_linked_list_iterator_t service_it;
btstack_linked_list_iterator_init(&service_it, &mock_gatt_client_services);
while (btstack_linked_list_iterator_has_next(&service_it)){
mock_gatt_client_service_t * service = (mock_gatt_client_service_t *) btstack_linked_list_iterator_next(&service_it);
btstack_linked_list_remove(&mock_gatt_client_services, (btstack_linked_item_t *) service);
btstack_linked_list_iterator_t characteristic_it;
btstack_linked_list_iterator_init(&characteristic_it, &service->characteristics);
while (btstack_linked_list_iterator_has_next(&characteristic_it)){
mock_gatt_client_characteristic_t * characteristic = (mock_gatt_client_characteristic_t *) btstack_linked_list_iterator_next(&characteristic_it);
btstack_linked_list_remove(&service->characteristics, (btstack_linked_item_t *) characteristic);
btstack_linked_list_iterator_t desc_it;
btstack_linked_list_iterator_init(&desc_it, &characteristic->descriptors);
while (btstack_linked_list_iterator_has_next(&desc_it)){
mock_gatt_client_characteristic_descriptor_t * desc = (mock_gatt_client_characteristic_descriptor_t *) btstack_linked_list_iterator_next(&desc_it);
btstack_linked_list_remove(&characteristic->descriptors, (btstack_linked_item_t *) desc);
free(desc);
}
free(characteristic);
}
free(service);
}
}
void mock_gatt_client_dump_services(void){
btstack_linked_list_iterator_t service_it;
btstack_linked_list_iterator_init(&service_it, &mock_gatt_client_services);
while (btstack_linked_list_iterator_has_next(&service_it)){
mock_gatt_client_service_t * service = (mock_gatt_client_service_t *) btstack_linked_list_iterator_next(&service_it);
printf("0x%02x: START SERVICE 0%02x\n", service->start_group_handle, service->uuid16);
btstack_linked_list_iterator_t characteristic_it;
btstack_linked_list_iterator_init(&characteristic_it, &service->characteristics);
while (btstack_linked_list_iterator_has_next(&characteristic_it)){
mock_gatt_client_characteristic_t * characteristic = (mock_gatt_client_characteristic_t *) btstack_linked_list_iterator_next(&characteristic_it);
printf("0x%02x: START CHR 0%02x\n", characteristic->start_handle, characteristic->uuid16);
printf("0x%02x: VALUE HANDLE CHR 0%02x\n", characteristic->value_handle, characteristic->uuid16);
btstack_linked_list_iterator_t desc_it;
btstack_linked_list_iterator_init(&desc_it, &characteristic->descriptors);
while (btstack_linked_list_iterator_has_next(&desc_it)){
mock_gatt_client_characteristic_descriptor_t * desc = (mock_gatt_client_characteristic_descriptor_t *) btstack_linked_list_iterator_next(&desc_it);
printf("0x%02x: DESC 0x%02x\n", desc->handle, desc->uuid16);
}
printf("0x%02x: END CHR 0%02x\n", characteristic->end_handle, characteristic->uuid16);
}
printf("0x%02x: END SERVICE 0%02x\n", service->end_group_handle, service->uuid16);
}
}
mock_gatt_client_service_t * mock_gatt_client_add_primary_service_uuid16(uint16_t service_uuid){
// set lsat group handle
// create new service
mock_gatt_client_last_service = (mock_gatt_client_service_t * )malloc(sizeof(mock_gatt_client_service_t));
memset(mock_gatt_client_last_service, 0, sizeof(mock_gatt_client_service_t));
mock_gatt_client_last_service->uuid16 = service_uuid;
mock_gatt_client_last_service->start_group_handle = mock_gatt_client_att_handle_generator++;
mock_gatt_client_last_service->end_group_handle = 0xffff;
btstack_linked_list_add_tail(&mock_gatt_client_services, (btstack_linked_item_t*)mock_gatt_client_last_service);
mock_gatt_client_last_characteristic = NULL;
return mock_gatt_client_last_service;
}
mock_gatt_client_characteristic_t * mock_gatt_client_add_characteristic_uuid16(uint16_t characteristic_uuid, uint16_t properties){
btstack_assert(mock_gatt_client_last_service != NULL);
mock_gatt_client_last_characteristic = (mock_gatt_client_characteristic_t * )malloc(sizeof(mock_gatt_client_characteristic_t));
memset(mock_gatt_client_last_characteristic, 0, sizeof(mock_gatt_client_characteristic_t));
mock_gatt_client_last_characteristic->uuid16 = characteristic_uuid;
mock_gatt_client_last_characteristic->properties = properties;
mock_gatt_client_last_characteristic->start_handle = mock_gatt_client_att_handle_generator++;
mock_gatt_client_last_characteristic->value_handle = mock_gatt_client_att_handle_generator++;
mock_gatt_client_last_characteristic->end_handle = mock_gatt_client_last_characteristic->value_handle;
btstack_linked_list_add_tail(&mock_gatt_client_last_service->characteristics, (btstack_linked_item_t*)mock_gatt_client_last_characteristic);
mock_gatt_client_last_service->end_group_handle = mock_gatt_client_att_handle_generator - 1;
return mock_gatt_client_last_characteristic;
}
mock_gatt_client_characteristic_descriptor_t * mock_gatt_client_add_characteristic_descriptor_uuid16(uint16_t descriptor_uuid){
btstack_assert(mock_gatt_client_last_characteristic != NULL);
mock_gatt_client_characteristic_descriptor_t * desc = (mock_gatt_client_characteristic_descriptor_t * )malloc(sizeof(mock_gatt_client_characteristic_descriptor_t));
memset(desc, 0, sizeof(mock_gatt_client_characteristic_descriptor_t));
desc->uuid16 = descriptor_uuid;
desc->handle = mock_gatt_client_att_handle_generator++;
btstack_linked_list_add_tail(&mock_gatt_client_last_characteristic->descriptors, (btstack_linked_item_t*)desc);
mock_gatt_client_last_characteristic->end_handle = mock_gatt_client_att_handle_generator - 1;
mock_gatt_client_last_service->end_group_handle = mock_gatt_client_att_handle_generator - 1;
return desc;
}
static mock_gatt_client_characteristic_t * mock_gatt_client_get_characteristic_for_value_handle(uint16_t value_handle){
btstack_linked_list_iterator_t service_it;
btstack_linked_list_iterator_t characteristic_it;
btstack_linked_list_iterator_init(&service_it, &mock_gatt_client_services);
while (btstack_linked_list_iterator_has_next(&service_it)){
mock_gatt_client_service_t * service = (mock_gatt_client_service_t *) btstack_linked_list_iterator_next(&service_it);
btstack_linked_list_iterator_init(&characteristic_it, &service->characteristics);
while (btstack_linked_list_iterator_has_next(&characteristic_it)){
mock_gatt_client_characteristic_t * characteristic = (mock_gatt_client_characteristic_t *) btstack_linked_list_iterator_next(&characteristic_it);
if (characteristic->value_handle != value_handle) continue;
return characteristic;
}
}
return NULL;
}
static mock_gatt_client_characteristic_descriptor_t * mock_gatt_client_get_characteristic_descriptor_for_handle(uint16_t handle){
btstack_linked_list_iterator_t service_it;
btstack_linked_list_iterator_t characteristic_it;
btstack_linked_list_iterator_init(&service_it, &mock_gatt_client_services);
while (btstack_linked_list_iterator_has_next(&service_it)){
mock_gatt_client_service_t * service = (mock_gatt_client_service_t *) btstack_linked_list_iterator_next(&service_it);
btstack_linked_list_iterator_init(&characteristic_it, &service->characteristics);
while (btstack_linked_list_iterator_has_next(&characteristic_it)){
mock_gatt_client_characteristic_t * characteristic = (mock_gatt_client_characteristic_t *) btstack_linked_list_iterator_next(&characteristic_it);
btstack_linked_list_iterator_t desc_it;
btstack_linked_list_iterator_init(&desc_it, &characteristic->descriptors);
while (btstack_linked_list_iterator_has_next(&desc_it)){
mock_gatt_client_characteristic_descriptor_t * desc = (mock_gatt_client_characteristic_descriptor_t *) btstack_linked_list_iterator_next(&desc_it);
if (desc->handle != handle) continue;
return desc;
}
}
}
return NULL;
}
void mock_gatt_client_set_characteristic_value(mock_gatt_client_characteristic_descriptor_t * descriptor, uint8_t * value_buffer, uint16_t value_len){
btstack_assert(descriptor != NULL);
descriptor->value_buffer = value_buffer;
descriptor->value_len = value_len;
}
// simulate erro
void mock_gatt_client_simulate_att_error(uint8_t att_error){
mock_gatt_client_att_error = att_error;
}
uint8_t gatt_client_discover_primary_services_by_uuid16(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t uuid16){
mock_gatt_client_state = MOCK_QUERY_DISCOVER_PRIMARY_SERVICES_BY_UUID16;
mock_gatt_client_uuid = uuid16;
gatt_client.callback = callback;
gatt_client.con_handle = con_handle;
return ERROR_CODE_SUCCESS;
}
uint8_t gatt_client_discover_characteristics_for_handle_range_by_uuid16(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t start_handle, uint16_t end_handle, uint16_t uuid16){
mock_gatt_client_state = MOCK_QUERY_DISCOVER_CHARACTERISTICS_BY_UUID16;
mock_gatt_client_uuid = uuid16;
mock_gatt_client_start_handle = start_handle;
mock_gatt_client_end_handle = end_handle;
gatt_client.callback = callback;
gatt_client.con_handle = con_handle;
return ERROR_CODE_SUCCESS;
}
uint8_t gatt_client_discover_characteristic_descriptors(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t * characteristic){
mock_gatt_client_state = MOCK_QUERY_DISCOVER_CHARACTERISTIC_DESCRIPTORS;
mock_gatt_client_value_handle = characteristic->value_handle;
gatt_client.callback = callback;
gatt_client.con_handle = con_handle;
return ERROR_CODE_SUCCESS;
}
uint8_t gatt_client_write_client_characteristic_configuration(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t * characteristic, uint16_t configuration){
mock_gatt_client_state = MOCK_WRITE_CLIENT_CHARACTERISTIC_CONFIGURATION;
mock_gatt_client_uuid = characteristic->uuid16;
gatt_client.callback = callback;
gatt_client.con_handle = con_handle;
return ERROR_CODE_SUCCESS;
}
void gatt_client_listen_for_characteristic_value_updates(gatt_client_notification_t * notification, btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t * characteristic){
notification->callback = callback;
notification->con_handle = con_handle;
if (characteristic == NULL){
// 'all characteristics': not used yet
btstack_assert(false);
} else {
notification->attribute_handle = characteristic->value_handle;
}
// finc our characteristic and set point to notification
}
uint8_t gatt_client_read_value_of_characteristic_using_value_handle(btstack_packet_handler_t callback, hci_con_handle_t con_handle, uint16_t value_handle){
mock_gatt_client_state = MOCK_READ_VALUE_OF_CHARACTERISTIC_USING_VALUE_HANDLE;
mock_gatt_client_value_handle = value_handle;
return ERROR_CODE_SUCCESS;
}
uint8_t gatt_client_read_value_of_characteristic(btstack_packet_handler_t callback, hci_con_handle_t con_handle, gatt_client_characteristic_t * characteristic){
btstack_assert(characteristic != NULL);
mock_gatt_client_state = MOCK_READ_VALUE_OF_CHARACTERISTIC_USING_VALUE_HANDLE;
mock_gatt_client_characteristic_t * mock_characteristic = mock_gatt_client_get_characteristic_for_value_handle(characteristic->value_handle);
btstack_assert(mock_characteristic != NULL);
mock_gatt_client_value_handle = mock_characteristic->value_handle;
return ERROR_CODE_SUCCESS;
}
void gatt_client_stop_listening_for_characteristic_value_updates(gatt_client_notification_t * notification){
}
/**
* copied from gatt_client.c - START
*/
void gatt_client_deserialize_service(const uint8_t *packet, int offset, gatt_client_service_t * service){
service->start_group_handle = little_endian_read_16(packet, offset);
service->end_group_handle = little_endian_read_16(packet, offset + 2);
reverse_128(&packet[offset + 4], service->uuid128);
if (uuid_has_bluetooth_prefix(service->uuid128)){
service->uuid16 = big_endian_read_32(service->uuid128, 0);
} else {
service->uuid16 = 0;
}
}
void gatt_client_deserialize_characteristic(const uint8_t * packet, int offset, gatt_client_characteristic_t * characteristic){
characteristic->start_handle = little_endian_read_16(packet, offset);
characteristic->value_handle = little_endian_read_16(packet, offset + 2);
characteristic->end_handle = little_endian_read_16(packet, offset + 4);
characteristic->properties = little_endian_read_16(packet, offset + 6);
reverse_128(&packet[offset+8], characteristic->uuid128);
if (uuid_has_bluetooth_prefix(characteristic->uuid128)){
characteristic->uuid16 = big_endian_read_32(characteristic->uuid128, 0);
} else {
characteristic->uuid16 = 0;
}
}
void gatt_client_deserialize_characteristic_descriptor(const uint8_t * packet, int offset, gatt_client_characteristic_descriptor_t * descriptor){
descriptor->handle = little_endian_read_16(packet, offset);
reverse_128(&packet[offset+2], descriptor->uuid128);
if (uuid_has_bluetooth_prefix(descriptor->uuid128)){
descriptor->uuid16 = big_endian_read_32(descriptor->uuid128, 0);
} else {
descriptor->uuid16 = 0;
}
}
static void emit_event_new(btstack_packet_handler_t callback, uint8_t * packet, uint16_t size){
if (!callback) return;
(*callback)(HCI_EVENT_PACKET, 0, packet, size);
}
static void emit_gatt_complete_event(gatt_client_t * gatt_client, uint8_t att_status){
// @format H1
uint8_t packet[5];
packet[0] = GATT_EVENT_QUERY_COMPLETE;
packet[1] = 3;
little_endian_store_16(packet, 2, gatt_client->con_handle);
packet[4] = att_status;
emit_event_new(gatt_client->callback, packet, sizeof(packet));
}
static void emit_gatt_service_query_result_event(gatt_client_t * gatt_client, uint16_t start_group_handle, uint16_t end_group_handle, const uint8_t * uuid128){
// @format HX
uint8_t packet[24];
packet[0] = GATT_EVENT_SERVICE_QUERY_RESULT;
packet[1] = sizeof(packet) - 2u;
little_endian_store_16(packet, 2, gatt_client->con_handle);
///
little_endian_store_16(packet, 4, start_group_handle);
little_endian_store_16(packet, 6, end_group_handle);
reverse_128(uuid128, &packet[8]);
emit_event_new(gatt_client->callback, packet, sizeof(packet));
}
static void emit_gatt_characteristic_query_result_event(gatt_client_t * gatt_client, uint16_t start_handle, uint16_t value_handle, uint16_t end_handle,
uint16_t properties, const uint8_t * uuid128){
// @format HY
uint8_t packet[28];
packet[0] = GATT_EVENT_CHARACTERISTIC_QUERY_RESULT;
packet[1] = sizeof(packet) - 2u;
little_endian_store_16(packet, 2, gatt_client->con_handle);
///
little_endian_store_16(packet, 4, start_handle);
little_endian_store_16(packet, 6, value_handle);
little_endian_store_16(packet, 8, end_handle);
little_endian_store_16(packet, 10, properties);
reverse_128(uuid128, &packet[12]);
emit_event_new(gatt_client->callback, packet, sizeof(packet));
}
static void emit_gatt_all_characteristic_descriptors_result_event(
gatt_client_t * gatt_client, uint16_t descriptor_handle, const uint8_t * uuid128){
// @format HZ
uint8_t packet[22];
packet[0] = GATT_EVENT_ALL_CHARACTERISTIC_DESCRIPTORS_QUERY_RESULT;
packet[1] = sizeof(packet) - 2u;
little_endian_store_16(packet, 2, gatt_client->con_handle);
///
little_endian_store_16(packet, 4, descriptor_handle);
reverse_128(uuid128, &packet[6]);
emit_event_new(gatt_client->callback, packet, sizeof(packet));
}
static const int characteristic_value_event_header_size = 8;
static uint8_t * setup_characteristic_value_packet(uint8_t type, hci_con_handle_t con_handle, uint16_t attribute_handle, uint8_t * value, uint16_t length){
// before the value inside the ATT PDU
uint8_t * packet = value - characteristic_value_event_header_size;
packet[0] = type;
packet[1] = characteristic_value_event_header_size - 2 + length;
little_endian_store_16(packet, 2, con_handle);
little_endian_store_16(packet, 4, attribute_handle);
little_endian_store_16(packet, 6, length);
return packet;
}
// @note assume that value is part of an l2cap buffer - overwrite parts of the HCI/L2CAP/ATT packet (4/4/3) bytes
static void report_gatt_characteristic_value(gatt_client_t * gatt_client, uint16_t attribute_handle, uint8_t * value, uint16_t length){
uint8_t * packet = setup_characteristic_value_packet(GATT_EVENT_CHARACTERISTIC_VALUE_QUERY_RESULT, gatt_client->con_handle, attribute_handle, value, length);
emit_event_new(gatt_client->callback, packet, characteristic_value_event_header_size + length);
}
/**
* copied from gatt_client.c - END
*/
static void mock_gatt_client_emit_complete(uint8_t status){
mock_gatt_client_state = MOCK_QUERY_IDLE;
emit_gatt_complete_event(&gatt_client, status);
}
void mock_gatt_client_run(void){
btstack_assert(mock_gatt_client_state != MOCK_QUERY_IDLE);
mock_gatt_client_characteristic_t * characteristic;
mock_gatt_client_characteristic_descriptor_t * descriptor;
btstack_linked_list_iterator_t service_it;
btstack_linked_list_iterator_t characteristic_it;
btstack_linked_list_iterator_t descriptor_it;
uint8_t uuid128[16];
while (mock_gatt_client_state != MOCK_QUERY_IDLE){
switch (mock_gatt_client_state){
case MOCK_QUERY_DISCOVER_PRIMARY_SERVICES_BY_UUID16:
// emit GATT_EVENT_SERVICE_QUERY_RESULT for each matching service
btstack_linked_list_iterator_init(&service_it, &mock_gatt_client_services);
while (btstack_linked_list_iterator_has_next(&service_it)){
mock_gatt_client_service_t * service = (mock_gatt_client_service_t *) btstack_linked_list_iterator_next(&service_it);
if (service->uuid16 != mock_gatt_client_uuid) continue;
mock_gatt_client_last_service = service;
uuid_add_bluetooth_prefix(uuid128, service->uuid16);
emit_gatt_service_query_result_event(&gatt_client, service->start_group_handle, service->end_group_handle, uuid128);
}
// emit GATT_EVENT_QUERY_COMPLETE
mock_gatt_client_emit_complete(ATT_ERROR_SUCCESS);
break;
case MOCK_QUERY_DISCOVER_CHARACTERISTICS_BY_UUID16:
// emit GATT_EVENT_CHARACTERISTIC_QUERY_RESULT for each matching characteristic
btstack_linked_list_iterator_init(&service_it, &mock_gatt_client_services);
while (btstack_linked_list_iterator_has_next(&service_it)){
mock_gatt_client_service_t * service = (mock_gatt_client_service_t *) btstack_linked_list_iterator_next(&service_it);
btstack_linked_list_iterator_init(&characteristic_it, &service->characteristics);
while (btstack_linked_list_iterator_has_next(&characteristic_it)){
mock_gatt_client_characteristic_t * characteristic = (mock_gatt_client_characteristic_t *) btstack_linked_list_iterator_next(&characteristic_it);
if (characteristic->uuid16 != mock_gatt_client_uuid) continue;
if (characteristic->start_handle < mock_gatt_client_start_handle) continue;
if (characteristic->end_handle > mock_gatt_client_end_handle) continue;
uuid_add_bluetooth_prefix(uuid128, characteristic->uuid16);
emit_gatt_characteristic_query_result_event(&gatt_client,
characteristic->start_handle, characteristic->value_handle, characteristic->end_handle,
characteristic->properties, uuid128);
}
}
// emit GATT_EVENT_QUERY_COMPLETE
mock_gatt_client_emit_complete(ERROR_CODE_SUCCESS);
break;
case MOCK_QUERY_DISCOVER_CHARACTERISTIC_DESCRIPTORS:
characteristic = mock_gatt_client_get_characteristic_for_value_handle(mock_gatt_client_value_handle);
btstack_assert(characteristic != NULL);
btstack_linked_list_iterator_init(&descriptor_it, &characteristic->descriptors);
while (btstack_linked_list_iterator_has_next(&descriptor_it)){
mock_gatt_client_characteristic_descriptor_t * desc = (mock_gatt_client_characteristic_descriptor_t *) btstack_linked_list_iterator_next(&descriptor_it);
uuid_add_bluetooth_prefix(uuid128, desc->uuid16);
emit_gatt_all_characteristic_descriptors_result_event(&gatt_client, desc->handle, uuid128);
}
// emit GATT_EVENT_QUERY_COMPLETE
mock_gatt_client_emit_complete(ERROR_CODE_SUCCESS);
break;
case MOCK_WRITE_CLIENT_CHARACTERISTIC_CONFIGURATION:
mock_gatt_client_emit_complete(ERROR_CODE_SUCCESS);
break;
case MOCK_READ_VALUE_OF_CHARACTERISTIC_USING_VALUE_HANDLE:
descriptor = mock_gatt_client_get_characteristic_descriptor_for_handle(mock_gatt_client_value_handle);
btstack_assert(descriptor != NULL);
btstack_assert(descriptor->value_buffer != NULL);
report_gatt_characteristic_value(&gatt_client, descriptor->handle, descriptor->value_buffer, descriptor->value_len);
mock_gatt_client_emit_complete(ERROR_CODE_SUCCESS);
break;
default:
btstack_assert(false);
break;
}
}
mock_gatt_client_att_error = ERROR_CODE_SUCCESS;
mock_gatt_client_state = MOCK_QUERY_IDLE;
}