bt_test_harness/
host_watcher.rs

// Copyright 2021 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

use anyhow::{format_err, Context, Error};
use fidl_fuchsia_bluetooth_sys::{HostWatcherMarker, HostWatcherProxy};
use fidl_fuchsia_hardware_bluetooth::EmulatorProxy;
use fuchsia_bluetooth::expectation::asynchronous::{
    expectable, Expectable, ExpectableExt, ExpectableState, ExpectableStateExt,
};
use fuchsia_bluetooth::expectation::Predicate;
use fuchsia_bluetooth::types::{Address, HostId, HostInfo};

use futures::future::{self, BoxFuture, FutureExt, TryFutureExt};
use hci_emulator_client::Emulator;
use std::collections::HashMap;
use std::ops::{Deref, DerefMut};
use std::sync::Arc;
use test_harness::{SharedState, TestHarness, SHARED_STATE_TEST_COMPONENT_INDEX};
use tracing::error;

use crate::core_realm::{CoreRealm, SHARED_STATE_INDEX};
use crate::timeout_duration;

#[derive(Clone, Default)]
pub struct HostWatcherState {
    /// Current hosts
    pub hosts: HashMap<HostId, HostInfo>,
}

#[derive(Clone)]
pub struct HostWatcherHarness {
    pub expect: Expectable<HostWatcherState, HostWatcherProxy>,
    pub realm: Arc<CoreRealm>,
}

impl Deref for HostWatcherHarness {
    type Target = Expectable<HostWatcherState, HostWatcherProxy>;

    fn deref(&self) -> &Self::Target {
        &self.expect
    }
}

impl DerefMut for HostWatcherHarness {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.expect
    }
}

async fn watch_hosts(harness: HostWatcherHarness) -> Result<(), Error> {
    let proxy = harness.aux().clone();
    loop {
        let hosts = proxy
            .watch()
            .await
            .context("Error calling fuchsia.bluetooth.sys.HostWatcher.watch()")?;
        let hosts: HashMap<HostId, HostInfo> = hosts
            .into_iter()
            .map(|info| {
                let info = HostInfo::try_from(info).expect("valid host");
                (info.id, info)
            })
            .collect();
        harness.write_state().hosts = hosts;
        harness.notify_state_changed();
    }
}

pub async fn new_host_watcher_harness(realm: Arc<CoreRealm>) -> Result<HostWatcherHarness, Error> {
    let proxy = realm
        .instance()
        .connect_to_protocol_at_exposed_dir::<HostWatcherMarker>()
        .context("Failed to connect to host_watcher service")?;

    Ok(HostWatcherHarness { expect: expectable(Default::default(), proxy), realm })
}

impl TestHarness for HostWatcherHarness {
    type Env = Arc<CoreRealm>;
    type Runner = BoxFuture<'static, Result<(), Error>>;

    fn init(
        shared_state: &Arc<SharedState>,
    ) -> BoxFuture<'static, Result<(Self, Self::Env, Self::Runner), Error>> {
        let shared_state = shared_state.clone();
        async move {
            let test_component: Arc<String> = shared_state
                .get(SHARED_STATE_TEST_COMPONENT_INDEX)
                .expect("SharedState must have TEST-COMPONENT")?;
            let inserter = move || CoreRealm::create(test_component.to_string());
            let realm = shared_state.get_or_insert_with(SHARED_STATE_INDEX, inserter).await?;
            let harness = new_host_watcher_harness(realm.clone()).await?;
            let run_host_watcher = watch_hosts(harness.clone())
                .map_err(|e| e.context("Error running HostWatcher harness"))
                .boxed();
            Ok((harness, realm, run_host_watcher))
        }
        .boxed()
    }
    fn terminate(_env: Self::Env) -> BoxFuture<'static, Result<(), Error>> {
        future::ok(()).boxed()
    }
}

/// An activated fake host.
/// Must be released with `host.release().await` before drop.
pub struct ActivatedFakeHost {
    host_watcher: HostWatcherHarness,
    host: HostId,
    hci: Option<Emulator>,
}

// All Fake HCI Devices have this address
pub const FAKE_HCI_ADDRESS: Address = Address::Public([0, 0, 0, 0, 0, 0]);

/// Create and publish an emulated HCI device, and wait until the host is bound and registered to
/// bt-gap
pub async fn activate_fake_host(
    host_watcher: HostWatcherHarness,
) -> Result<(HostId, Emulator), Error> {
    let initial_hosts: Vec<HostId> = host_watcher.read().hosts.keys().cloned().collect();
    let initial_hosts_ = initial_hosts.clone();

    let dev_dir = host_watcher.realm.dev().context("failed to open dev directory")?;
    let hci = Emulator::create_and_publish(dev_dir).await?;

    let host_watcher_state = host_watcher
        .when_satisfied(
            expectation::host_exists(Predicate::predicate(
                move |host: &HostInfo| {
                    host.addresses.contains(&FAKE_HCI_ADDRESS) && !initial_hosts_.contains(&host.id)
                },
                &format!("A fake host that is not in {:?}", initial_hosts),
            )),
            timeout_duration(),
        )
        .await?;

    let host = host_watcher_state
        .hosts
        .iter()
        .find(|(id, host)| {
            host.addresses.contains(&FAKE_HCI_ADDRESS) && !initial_hosts.contains(id)
        })
        .unwrap()
        .1
        .id; // We can safely unwrap here as this is guarded by the previous expectation

    let fut = host_watcher.aux().set_active(&host.into());
    fut.await?
        .or_else(zx::Status::ok)
        .map_err(|e| format_err!("failed to set active host to emulator: {}", e))?;

    let _ = host_watcher
        .when_satisfied(expectation::active_host_is(host.clone()), timeout_duration())
        .await?;
    Ok((host, hci))
}

impl ActivatedFakeHost {
    pub async fn new(realm: Arc<CoreRealm>) -> Result<ActivatedFakeHost, Error> {
        let host_watcher = new_host_watcher_harness(realm).await?;
        fuchsia_async::Task::spawn(
            watch_hosts(host_watcher.clone())
                .unwrap_or_else(|e| error!("Error watching hosts: {:?}", e)),
        )
        .detach();
        let (host, hci) = activate_fake_host(host_watcher.clone()).await?;
        Ok(ActivatedFakeHost { host_watcher, host, hci: Some(hci) })
    }

    pub async fn release(mut self) -> Result<(), Error> {
        // Wait for the test device to be destroyed.
        if let Some(hci) = &mut self.hci {
            hci.destroy_and_wait().await?;
        }
        self.hci = None;

        // Wait for BT-GAP to unregister the associated fake host
        let _ = self
            .host_watcher
            .when_satisfied(expectation::host_not_present(self.host.clone()), timeout_duration())
            .await?;
        Ok(())
    }

    pub fn emulator(&self) -> &EmulatorProxy {
        self.hci.as_ref().expect("emulator proxy requested after shut down").emulator()
    }
}

impl Drop for ActivatedFakeHost {
    fn drop(&mut self) {
        assert!(self.hci.is_none());
    }
}

pub mod expectation {
    use super::*;

    pub(crate) fn host_not_present(id: HostId) -> Predicate<HostWatcherState> {
        let msg = format!("Host not present: {}", id);
        Predicate::predicate(move |state: &HostWatcherState| !state.hosts.contains_key(&id), &msg)
    }

    pub(crate) fn host_exists(p: Predicate<HostInfo>) -> Predicate<HostWatcherState> {
        let msg = format!("Host exists satisfying {:?}", p);
        Predicate::predicate(
            move |state: &HostWatcherState| state.hosts.iter().any(|(_, host)| p.satisfied(&host)),
            &msg,
        )
    }

    pub(crate) fn active_host_is(id: HostId) -> Predicate<HostWatcherState> {
        let msg = format!("Active host is: {}", id);
        Predicate::predicate(
            move |state: &HostWatcherState| {
                state.hosts.get(&id).and_then(|h| Some(h.active)) == Some(true)
            },
            &msg,
        )
    }
}
bt_test_harness/host_watcher.rs

bt_test_harness/
host_watcher.rs
