system/service/hal/fake_bluetooth_gatt_interface.h

//
//  Copyright (C) 2015 Google, Inc.
//
//  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.
//

#pragma once

#include <base/macros.h>
#include <base/observer_list.h>

#include "service/hal/bluetooth_gatt_interface.h"

namespace bluetooth {
namespace hal {

class FakeBluetoothGattInterface : public BluetoothGattInterface {
 public:
  // Handles HAL Bluetooth GATT client API calls for testing. Test code can
  // provide a fake or mock implementation of this and all calls will be routed
  // to it.
  class TestClientHandler {
   public:
    virtual ~TestClientHandler() = default;

    virtual bt_status_t RegisterClient(bt_uuid_t* app_uuid) = 0;
    virtual bt_status_t UnregisterClient(int client_if) = 0;
    virtual bt_status_t MultiAdvEnable(
        int client_if, int min_interval, int max_interval, int adv_type,
        int chnl_map, int tx_power, int timeout_s) = 0;
    virtual bt_status_t MultiAdvSetInstData(
        int client_if, bool set_scan_rsp, bool include_name,
        bool incl_txpower, int appearance,
        int manufacturer_len, char* manufacturer_data,
        int service_data_len, char* service_data,
        int service_uuid_len, char* service_uuid) = 0;
    virtual bt_status_t MultiAdvDisable(int client_if) = 0;
  };

  // Handles HAL Bluetooth GATT server API calls for testing. Test code can
  // provide a fake or mock implementation of this and all calls will be routed
  // to it.
  class TestServerHandler {
   public:
    virtual ~TestServerHandler() = default;

    virtual bt_status_t RegisterServer(bt_uuid_t* app_uuid) = 0;
    virtual bt_status_t UnregisterServer(int server_if) = 0;
    virtual bt_status_t AddService(
        int server_if, btgatt_srvc_id_t* srvc_id, int num_handles) = 0;
    virtual bt_status_t AddCharacteristic(int server_if, int srvc_handle,
                                          bt_uuid_t *uuid,
                                          int properties, int permissions) = 0;
    virtual bt_status_t AddDescriptor(int server_if, int srvc_handle,
                                      bt_uuid_t* uuid,
                                      int permissions) = 0;
    virtual bt_status_t StartService(
        int server_if, int srvc_handle, int transport) = 0;
    virtual bt_status_t DeleteService(int server_if, int srvc_handle) = 0;
    virtual bt_status_t SendResponse(int conn_id, int trans_id, int status,
                                     btgatt_response_t* response) = 0;
  };

  // Constructs the fake with the given handlers. Implementations can
  // provide their own handlers or simply pass "nullptr" for the default
  // behavior in which BT_STATUS_FAIL will be returned from all calls.
  FakeBluetoothGattInterface(std::shared_ptr<TestClientHandler> client_handler,
                             std::shared_ptr<TestServerHandler> server_handler);
  ~FakeBluetoothGattInterface();

  // The methods below can be used to notify observers with certain events and
  // given parameters.

  // Client callbacks:
  void NotifyRegisterClientCallback(int status, int client_if,
                                    const bt_uuid_t& app_uuid);
  void NotifyMultiAdvEnableCallback(int client_if, int status);
  void NotifyMultiAdvDataCallback(int client_if, int status);
  void NotifyMultiAdvDisableCallback(int client_if, int status);

  // Server callbacks:
  void NotifyRegisterServerCallback(int status, int server_if,
                                    const bt_uuid_t& app_uuid);
  void NotifyServerConnectionCallback(int conn_id, int server_if,
                                      int connected,
                                      const bt_bdaddr_t& bda);
  void NotifyServiceAddedCallback(int status, int server_if,
                                  const btgatt_srvc_id_t& srvc_id,
                                  int srvc_handle);
  void NotifyCharacteristicAddedCallback(int status, int server_if,
                                         const bt_uuid_t& uuid,
                                         int srvc_handle, int char_handle);
  void NotifyDescriptorAddedCallback(int status, int server_if,
                                     const bt_uuid_t& uuid,
                                     int srvc_handle, int desc_handle);
  void NotifyServiceStartedCallback(int status, int server_if, int srvc_handle);
  void NotifyRequestReadCallback(int conn_id, int trans_id,
                                 const bt_bdaddr_t& bda, int attr_handle,
                                 int offset, bool is_long);
  void NotifyRequestWriteCallback(int conn_id, int trans_id,
                                  const bt_bdaddr_t& bda, int attr_handle,
                                  int offset, int length,
                                  bool need_rsp, bool is_prep, uint8_t* value);
  void NotifyRequestExecWriteCallback(int conn_id, int trans_id,
                                      const bt_bdaddr_t& bda, int exec_write);

  // BluetoothGattInterface overrides:
  void AddClientObserver(ClientObserver* observer) override;
  void RemoveClientObserver(ClientObserver* observer) override;
  void AddClientObserverUnsafe(ClientObserver* observer) override;
  void RemoveClientObserverUnsafe(ClientObserver* observer) override;
  void AddServerObserver(ServerObserver* observer) override;
  void RemoveServerObserver(ServerObserver* observer) override;
  void AddServerObserverUnsafe(ServerObserver* observer) override;
  void RemoveServerObserverUnsafe(ServerObserver* observer) override;
  const btgatt_client_interface_t* GetClientHALInterface() const override;
  const btgatt_server_interface_t* GetServerHALInterface() const override;

 private:
  base::ObserverList<ClientObserver> client_observers_;
  base::ObserverList<ServerObserver> server_observers_;
  std::shared_ptr<TestClientHandler> client_handler_;
  std::shared_ptr<TestServerHandler> server_handler_;

  DISALLOW_COPY_AND_ASSIGN(FakeBluetoothGattInterface);
};

}  // namespace hal
}  // namespace bluetooth