driver_tools/subcommands/list/

mod.rs

// Copyright 2022 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.

pub mod args;

use anyhow::{Context, Result};
use args::ListCommand;
use flex_fuchsia_driver_development as fdd;
#[cfg(feature = "fdomain")]
use fuchsia_driver_dev_fdomain as fuchsia_driver_dev;
use futures::join;
use std::collections::HashSet;
use std::io::Write;

pub async fn list(
    cmd: ListCommand,
    writer: &mut dyn Write,
    driver_development_proxy: fdd::ManagerProxy,
) -> Result<()> {
    if cmd.verbose {
        writeln!(
            writer,
            "WARNING: The verbose flag is deprecated. Use `ffx driver show` instead."
        )?;
        return Ok(());
    }

    let empty: [String; 0] = [];
    let driver_info = fuchsia_driver_dev::get_driver_info(&driver_development_proxy, &empty);

    let driver_info = if cmd.loaded || cmd.running {
        // Query devices and create a hash set of loaded drivers.
        let device_info = fuchsia_driver_dev::get_device_info(
            &driver_development_proxy,
            &empty,
            /* exact_match= */ false,
        );

        // Await the futures concurrently.
        let (driver_info, device_info) = join!(driver_info, device_info);

        let loaded_driver_set: HashSet<String> = HashSet::from_iter(
            device_info?
                .into_iter()
                .filter(|device_info| {
                    if cmd.running {
                        device_info.is_running.unwrap_or(false)
                            && device_info.driver_host_koid.is_some()
                    } else {
                        true
                    }
                })
                .filter_map(|device_info| device_info.bound_driver_url),
        );

        // Filter the driver list by the hash set.
        driver_info?
            .into_iter()
            .filter(|driver| {
                let mut loaded = false;
                if let Some(ref url) = driver.url {
                    if loaded_driver_set.contains(url) {
                        loaded = true
                    }
                }
                loaded
            })
            .collect()
    } else {
        driver_info.await.context("Failed to get driver info")?
    };

    for driver in driver_info {
        if let Some(name) = driver.name {
            let url = driver.url.unwrap_or_default();
            writeln!(writer, "{:<20}: {}", name, url)?;
        } else {
            let url = driver.url.unwrap_or_default();
            writeln!(writer, "{}", url)?;
        }
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use argh::FromArgs;
    use flex_client::fidl::ServerEnd;
    use flex_fuchsia_driver_framework as fdf;
    use fuchsia_async as fasync;
    use futures::future::{Future, FutureExt};
    use futures::stream::StreamExt;
    #[cfg(feature = "fdomain")]
    use std::sync::Arc;

    /// Invokes `list` with `cmd` and runs a mock driver development server that
    /// invokes `on_driver_development_request` whenever it receives a request.
    /// The output of `list` that is normally written to its `writer` parameter
    /// is returned.
    async fn test_list<F, Fut>(
        #[cfg(feature = "fdomain")] client: Arc<flex_client::Client>,
        cmd: ListCommand,
        on_driver_development_request: F,
    ) -> Result<String>
    where
        F: Fn(fdd::ManagerRequest) -> Fut + Send + Sync + 'static,
        Fut: Future<Output = Result<()>> + Send + Sync,
    {
        #[cfg(not(feature = "fdomain"))]
        let client = flex_client::fidl::ZirconClient;
        let (driver_development_proxy, mut driver_development_requests) =
            client.create_proxy_and_stream::<fdd::ManagerMarker>();

        // Run the command and mock driver development server.
        let mut writer = Vec::new();
        let request_handler_task = fasync::Task::spawn(async move {
            while let Some(res) = driver_development_requests.next().await {
                let request = res.unwrap();
                on_driver_development_request(request).await.context("Failed to handle request")?;
            }
            anyhow::bail!("Driver development request stream unexpectedly closed");
        });
        futures::select! {
            res = request_handler_task.fuse() => {
                res?;
                anyhow::bail!("Request handler task unexpectedly finished");
            }
            res = list(cmd, &mut writer, driver_development_proxy).fuse() => res.context("List command failed")?,
        }

        String::from_utf8(writer).context("Failed to convert list output to a string")
    }

    async fn run_driver_info_iterator_server(
        mut driver_infos: Vec<fdf::DriverInfo>,
        iterator: ServerEnd<fdd::DriverInfoIteratorMarker>,
    ) -> Result<()> {
        let mut iterator = iterator.into_stream();
        while let Some(res) = iterator.next().await {
            let request = res.unwrap();
            match request {
                fdd::DriverInfoIteratorRequest::GetNext { responder } => {
                    responder.send(&driver_infos).unwrap();
                    driver_infos.clear();
                }
            }
        }
        Ok(())
    }

    async fn run_node_info_iterator_server(
        mut node_infos: Vec<fdd::NodeInfo>,
        iterator: ServerEnd<fdd::NodeInfoIteratorMarker>,
    ) -> Result<()> {
        let mut iterator = iterator.into_stream();
        while let Some(res) = iterator.next().await {
            let request = res.unwrap();
            match request {
                fdd::NodeInfoIteratorRequest::GetNext { responder } => {
                    responder.send(&node_infos).unwrap();
                    node_infos.clear();
                }
            }
        }
        Ok(())
    }

    fn mock_driver_infos() -> Vec<fdf::DriverInfo> {
        vec![
            fdf::DriverInfo {
                name: Some("running".to_owned()),
                url: Some("fuchsia-pkg://fuchsia.com/running#meta/running.cm".to_owned()),
                ..Default::default()
            },
            fdf::DriverInfo {
                name: Some("binding".to_owned()),
                url: Some("fuchsia-pkg://fuchsia.com/binding#meta/binding.cm".to_owned()),
                ..Default::default()
            },
            fdf::DriverInfo {
                name: Some("starting".to_owned()),
                url: Some("fuchsia-pkg://fuchsia.com/starting#meta/starting.cm".to_owned()),
                ..Default::default()
            },
            fdf::DriverInfo {
                name: Some("quarantined".to_owned()),
                url: Some("fuchsia-pkg://fuchsia.com/quarantined#meta/quarantined.cm".to_owned()),
                ..Default::default()
            },
            fdf::DriverInfo {
                name: Some("unloaded".to_owned()),
                url: Some("fuchsia-pkg://fuchsia.com/unloaded#meta/unloaded.cm".to_owned()),
                ..Default::default()
            },
        ]
    }

    fn mock_node_infos() -> Vec<fdd::NodeInfo> {
        vec![
            fdd::NodeInfo {
                bound_driver_url: Some(
                    "fuchsia-pkg://fuchsia.com/running#meta/running.cm".to_owned(),
                ),
                driver_host_koid: Some(12345),
                is_running: Some(true),
                quarantined: Some(false),
                ..Default::default()
            },
            fdd::NodeInfo {
                bound_driver_url: Some(
                    "fuchsia-pkg://fuchsia.com/binding#meta/binding.cm".to_owned(),
                ),
                driver_host_koid: Some(12345),
                is_running: Some(false),
                quarantined: Some(false),
                ..Default::default()
            },
            fdd::NodeInfo {
                bound_driver_url: Some(
                    "fuchsia-pkg://fuchsia.com/starting#meta/starting.cm".to_owned(),
                ),
                driver_host_koid: None,
                is_running: Some(false),
                quarantined: Some(false),
                ..Default::default()
            },
            fdd::NodeInfo {
                bound_driver_url: Some(
                    "fuchsia-pkg://fuchsia.com/quarantined#meta/quarantined.cm".to_owned(),
                ),
                driver_host_koid: None,
                is_running: Some(false),
                quarantined: Some(true),
                ..Default::default()
            },
        ]
    }

    #[fuchsia::test]
    async fn test_list_all() {
        #[cfg(feature = "fdomain")]
        let client = fdomain_local::local_client_empty();
        let cmd = ListCommand::from_args(&["list"], &[]).unwrap();

        let output = test_list(
            #[cfg(feature = "fdomain")]
            client,
            cmd,
            |request: fdd::ManagerRequest| async move {
                match request {
                    fdd::ManagerRequest::GetDriverInfo {
                        driver_filter: _,
                        iterator,
                        control_handle: _,
                    } => run_driver_info_iterator_server(
                        vec![fdf::DriverInfo {
                            name: Some("foo".to_owned()),
                            url: Some(
                                "fuchsia-pkg://fuchsia.com/foo-package#meta/foo.cm".to_owned(),
                            ),
                            ..Default::default()
                        }],
                        iterator,
                    )
                    .await
                    .context("Failed to run driver info iterator server")?,
                    _ => {}
                }
                Ok(())
            },
        )
        .await
        .unwrap();

        assert_eq!(
            output,
            "foo                 : fuchsia-pkg://fuchsia.com/foo-package#meta/foo.cm\n"
        );
    }

    #[fuchsia::test]
    async fn test_list_loaded() {
        #[cfg(feature = "fdomain")]
        let client = fdomain_local::local_client_empty();
        let cmd = ListCommand::from_args(&["list"], &["--loaded"]).unwrap();

        let output = test_list(
            #[cfg(feature = "fdomain")]
            client,
            cmd,
            |request: fdd::ManagerRequest| async move {
                match request {
                    fdd::ManagerRequest::GetDriverInfo {
                        driver_filter: _,
                        iterator,
                        control_handle: _,
                    } => run_driver_info_iterator_server(mock_driver_infos(), iterator)
                        .await
                        .context("Failed to run driver info iterator server")?,
                    fdd::ManagerRequest::GetNodeInfo {
                        node_filter: _,
                        iterator,
                        exact_match: _,
                        control_handle: _,
                    } => run_node_info_iterator_server(mock_node_infos(), iterator)
                        .await
                        .context("Failed to run node info iterator server")?,
                    _ => {}
                }
                Ok(())
            },
        )
        .await
        .unwrap();

        assert_eq!(
            output,
            concat!(
                "running             : fuchsia-pkg://fuchsia.com/running#meta/running.cm\n",
                "binding             : fuchsia-pkg://fuchsia.com/binding#meta/binding.cm\n",
                "starting            : fuchsia-pkg://fuchsia.com/starting#meta/starting.cm\n",
                "quarantined         : fuchsia-pkg://fuchsia.com/quarantined#meta/quarantined.cm\n",
            )
        );
    }

    #[fuchsia::test]
    async fn test_list_running() {
        #[cfg(feature = "fdomain")]
        let client = fdomain_local::local_client_empty();
        let cmd = ListCommand::from_args(&["list"], &["--running"]).unwrap();

        let output = test_list(
            #[cfg(feature = "fdomain")]
            client,
            cmd,
            |request: fdd::ManagerRequest| async move {
                match request {
                    fdd::ManagerRequest::GetDriverInfo {
                        driver_filter: _,
                        iterator,
                        control_handle: _,
                    } => run_driver_info_iterator_server(mock_driver_infos(), iterator)
                        .await
                        .context("Failed to run driver info iterator server")?,
                    fdd::ManagerRequest::GetNodeInfo {
                        node_filter: _,
                        iterator,
                        exact_match: _,
                        control_handle: _,
                    } => run_node_info_iterator_server(mock_node_infos(), iterator)
                        .await
                        .context("Failed to run node info iterator server")?,
                    _ => {}
                }
                Ok(())
            },
        )
        .await
        .unwrap();

        assert_eq!(
            output,
            "running             : fuchsia-pkg://fuchsia.com/running#meta/running.cm\n"
        );
    }

    #[fuchsia::test]
    async fn test_verbose_deprecated() {
        #[cfg(feature = "fdomain")]
        let client = fdomain_local::local_client_empty();
        let cmd = ListCommand::from_args(&["list"], &["--verbose"]).unwrap();

        let output = test_list(
            #[cfg(feature = "fdomain")]
            Arc::clone(&client),
            cmd,
            |request: fdd::ManagerRequest| async move {
                match request {
                    fdd::ManagerRequest::GetDriverInfo {
                        driver_filter: _,
                        iterator,
                        control_handle: _,
                    } => run_driver_info_iterator_server(
                        vec![fdf::DriverInfo {
                            name: Some("foo".to_owned()),
                            url: Some(
                                "fuchsia-pkg://fuchsia.com/foo-package#meta/foo.cm".to_owned(),
                            ),
                            ..Default::default()
                        }],
                        iterator,
                    )
                    .await
                    .context("Failed to run driver info iterator server")?,
                    _ => {}
                }
                Ok(())
            },
        )
        .await
        .unwrap();

        assert_eq!(
            output,
            "WARNING: The verbose flag is deprecated. Use `ffx driver show` instead.\n"
        );
    }
}