net_cli/
lib.rs

1// Copyright 2018 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5mod filter;
6mod opts;
7mod ser;
8
9use anyhow::{Context as _, Error, anyhow};
10use fidl_fuchsia_net_stack_ext::{self as fstack_ext, FidlReturn as _};
11use futures::{FutureExt as _, StreamExt as _, TryFutureExt as _, TryStreamExt as _};
12use itertools::Itertools as _;
13use log::{info, warn};
14use net_types::ip::{Ip, Ipv4, Ipv6};
15use netfilter::FidlReturn as _;
16use prettytable::{Row, Table, cell, format, row};
17use ser::AddressAssignmentState;
18use serde_json::json;
19use serde_json::value::Value;
20use std::borrow::Cow;
21use std::collections::hash_map::HashMap;
22use std::convert::TryFrom as _;
23use std::iter::FromIterator as _;
24use std::ops::Deref;
25use std::pin::pin;
26use std::str::FromStr as _;
27use writer::ToolIO as _;
28use {
29    fidl_fuchsia_net as fnet, fidl_fuchsia_net_debug as fdebug, fidl_fuchsia_net_dhcp as fdhcp,
30    fidl_fuchsia_net_ext as fnet_ext, fidl_fuchsia_net_filter as fnet_filter,
31    fidl_fuchsia_net_filter_deprecated as ffilter_deprecated,
32    fidl_fuchsia_net_interfaces as finterfaces,
33    fidl_fuchsia_net_interfaces_admin as finterfaces_admin,
34    fidl_fuchsia_net_interfaces_ext as finterfaces_ext,
35    fidl_fuchsia_net_matchers_ext as fnet_matchers_ext, fidl_fuchsia_net_name as fname,
36    fidl_fuchsia_net_neighbor as fneighbor, fidl_fuchsia_net_neighbor_ext as fneighbor_ext,
37    fidl_fuchsia_net_root as froot, fidl_fuchsia_net_routes as froutes,
38    fidl_fuchsia_net_routes_ext as froutes_ext, fidl_fuchsia_net_stack as fstack,
39    fidl_fuchsia_net_stackmigrationdeprecated as fnet_migration, zx_status as zx,
40};
41
42pub use opts::{
43    Command, CommandEnum, UserFacingError, underlying_user_facing_error, user_facing_error,
44};
45
46macro_rules! filter_fidl {
47    ($method:expr, $context:expr) => {
48        $method.await.transform_result().context($context)
49    };
50}
51
52fn add_row(t: &mut Table, row: Row) {
53    let _: &mut Row = t.add_row(row);
54}
55
56/// An interface for acquiring a proxy to a FIDL service.
57#[async_trait::async_trait]
58pub trait ServiceConnector<S: fidl::endpoints::ProtocolMarker> {
59    /// Acquires a proxy to the parameterized FIDL interface.
60    async fn connect(&self) -> Result<S::Proxy, Error>;
61}
62
63/// An interface for acquiring all system dependencies required by net-cli.
64///
65/// FIDL dependencies are specified as supertraits. These supertraits are a complete enumeration of
66/// all FIDL dependencies required by net-cli.
67pub trait NetCliDepsConnector:
68    ServiceConnector<fdebug::InterfacesMarker>
69    + ServiceConnector<froot::InterfacesMarker>
70    + ServiceConnector<froot::FilterMarker>
71    + ServiceConnector<fdhcp::Server_Marker>
72    + ServiceConnector<ffilter_deprecated::FilterMarker>
73    + ServiceConnector<finterfaces::StateMarker>
74    + ServiceConnector<finterfaces_admin::InstallerMarker>
75    + ServiceConnector<fneighbor::ControllerMarker>
76    + ServiceConnector<fneighbor::ViewMarker>
77    + ServiceConnector<fstack::LogMarker>
78    + ServiceConnector<fstack::StackMarker>
79    + ServiceConnector<froutes::StateV4Marker>
80    + ServiceConnector<froutes::StateV6Marker>
81    + ServiceConnector<fname::LookupMarker>
82    + ServiceConnector<fnet_migration::ControlMarker>
83    + ServiceConnector<fnet_migration::StateMarker>
84    + ServiceConnector<fnet_filter::StateMarker>
85{
86}
87
88impl<O> NetCliDepsConnector for O where
89    O: ServiceConnector<fdebug::InterfacesMarker>
90        + ServiceConnector<froot::InterfacesMarker>
91        + ServiceConnector<froot::FilterMarker>
92        + ServiceConnector<fdhcp::Server_Marker>
93        + ServiceConnector<ffilter_deprecated::FilterMarker>
94        + ServiceConnector<finterfaces::StateMarker>
95        + ServiceConnector<finterfaces_admin::InstallerMarker>
96        + ServiceConnector<fneighbor::ControllerMarker>
97        + ServiceConnector<fneighbor::ViewMarker>
98        + ServiceConnector<fstack::LogMarker>
99        + ServiceConnector<fstack::StackMarker>
100        + ServiceConnector<froutes::StateV4Marker>
101        + ServiceConnector<froutes::StateV6Marker>
102        + ServiceConnector<fname::LookupMarker>
103        + ServiceConnector<fnet_migration::ControlMarker>
104        + ServiceConnector<fnet_migration::StateMarker>
105        + ServiceConnector<fnet_filter::StateMarker>
106{
107}
108
109pub async fn do_root<C: NetCliDepsConnector>(
110    mut out: writer::JsonWriter<serde_json::Value>,
111    Command { cmd }: Command,
112    connector: &C,
113) -> Result<(), Error> {
114    match cmd {
115        CommandEnum::If(opts::If { if_cmd: cmd }) => {
116            do_if(&mut out, cmd, connector).await.context("failed during if command")
117        }
118        CommandEnum::Route(opts::Route { route_cmd: cmd }) => {
119            do_route(&mut out, cmd, connector).await.context("failed during route command")
120        }
121        CommandEnum::Rule(opts::Rule { rule_cmd: cmd }) => {
122            do_rule(&mut out, cmd, connector).await.context("failed during rule command")
123        }
124        CommandEnum::FilterDeprecated(opts::FilterDeprecated { filter_cmd: cmd }) => {
125            do_filter_deprecated(out, cmd, connector)
126                .await
127                .context("failed during filter-deprecated command")
128        }
129        CommandEnum::Filter(opts::filter::Filter { filter_cmd: cmd }) => {
130            filter::do_filter(out, cmd, connector).await.context("failed during filter command")
131        }
132        CommandEnum::Log(opts::Log { log_cmd: cmd }) => {
133            do_log(cmd, connector).await.context("failed during log command")
134        }
135        CommandEnum::Dhcp(opts::Dhcp { dhcp_cmd: cmd }) => {
136            do_dhcp(cmd, connector).await.context("failed during dhcp command")
137        }
138        CommandEnum::Dhcpd(opts::dhcpd::Dhcpd { dhcpd_cmd: cmd }) => {
139            do_dhcpd(cmd, connector).await.context("failed during dhcpd command")
140        }
141        CommandEnum::Neigh(opts::Neigh { neigh_cmd: cmd }) => {
142            do_neigh(out, cmd, connector).await.context("failed during neigh command")
143        }
144        CommandEnum::Dns(opts::dns::Dns { dns_cmd: cmd }) => {
145            do_dns(out, cmd, connector).await.context("failed during dns command")
146        }
147        CommandEnum::NetstackMigration(opts::NetstackMigration { cmd }) => {
148            do_netstack_migration(out, cmd, connector)
149                .await
150                .context("failed during migration command")
151        }
152    }
153}
154
155fn shortlist_interfaces(
156    name_pattern: &str,
157    interfaces: &mut HashMap<
158        u64,
159        finterfaces_ext::PropertiesAndState<(), finterfaces_ext::AllInterest>,
160    >,
161) {
162    interfaces.retain(|_: &u64, properties_and_state| {
163        properties_and_state.properties.name.contains(name_pattern)
164    })
165}
166
167fn write_tabulated_interfaces_info<
168    W: std::io::Write,
169    I: IntoIterator<Item = ser::InterfaceView>,
170>(
171    mut out: W,
172    interfaces: I,
173) -> Result<(), Error> {
174    let mut t = Table::new();
175    t.set_format(format::FormatBuilder::new().padding(2, 2).build());
176    for (
177        i,
178        ser::InterfaceView {
179            nicid,
180            name,
181            device_class,
182            online,
183            addresses,
184            mac,
185            has_default_ipv4_route,
186            has_default_ipv6_route,
187            port_identity_koid,
188        },
189    ) in interfaces.into_iter().enumerate()
190    {
191        if i > 0 {
192            add_row(&mut t, row![]);
193        }
194
195        add_row(&mut t, row!["nicid", nicid]);
196        add_row(&mut t, row!["name", name]);
197        add_row(
198            &mut t,
199            row![
200                "device class",
201                match device_class {
202                    ser::DeviceClass::Loopback => "loopback",
203                    ser::DeviceClass::Blackhole => "blackhole",
204                    ser::DeviceClass::Virtual => "virtual",
205                    ser::DeviceClass::Ethernet => "ethernet",
206                    ser::DeviceClass::WlanClient => "wlan-client",
207                    ser::DeviceClass::Ppp => "ppp",
208                    ser::DeviceClass::Bridge => "bridge",
209                    ser::DeviceClass::WlanAp => "wlan-ap",
210                    ser::DeviceClass::Lowpan => "lowpan",
211                }
212            ],
213        );
214        add_row(&mut t, row!["online", online]);
215
216        let default_routes: std::borrow::Cow<'_, _> =
217            if has_default_ipv4_route || has_default_ipv6_route {
218                itertools::Itertools::intersperse(
219                    has_default_ipv4_route
220                        .then_some("IPv4")
221                        .into_iter()
222                        .chain(has_default_ipv6_route.then_some("IPv6")),
223                    ",",
224                )
225                .collect::<String>()
226                .into()
227            } else {
228                "-".into()
229            };
230        add_row(&mut t, row!["default routes", default_routes]);
231
232        for ser::Address {
233            subnet: ser::Subnet { addr, prefix_len },
234            valid_until,
235            assignment_state,
236        } in addresses.all_addresses()
237        {
238            let valid_until = valid_until.map(|v| {
239                let v = std::time::Duration::from_nanos(v.try_into().unwrap_or(0)).as_secs_f32();
240                std::borrow::Cow::Owned(format!("valid until [{v}s]"))
241            });
242            let assignment_state: Option<std::borrow::Cow<'_, _>> = match assignment_state {
243                AddressAssignmentState::Assigned => None,
244                AddressAssignmentState::Tentative => Some("TENTATIVE".into()),
245                AddressAssignmentState::Unavailable => Some("UNAVAILABLE".into()),
246            };
247            let extra_bits = itertools::Itertools::intersperse(
248                assignment_state.into_iter().chain(valid_until),
249                " ".into(),
250            )
251            .collect::<String>();
252
253            add_row(&mut t, row!["addr", format!("{addr}/{prefix_len}"), extra_bits]);
254        }
255        match mac {
256            None => add_row(&mut t, row!["mac", "-"]),
257            Some(mac) => add_row(&mut t, row!["mac", mac]),
258        }
259        match port_identity_koid {
260            None => add_row(&mut t, row!["port_identity_koid", "-"]),
261            Some(port_identity_koid) => {
262                add_row(&mut t, row!["port_identity_koid", port_identity_koid])
263            }
264        }
265    }
266    writeln!(out, "{}", t)?;
267    Ok(())
268}
269
270pub(crate) async fn connect_with_context<S, C>(connector: &C) -> Result<S::Proxy, Error>
271where
272    C: ServiceConnector<S>,
273    S: fidl::endpoints::ProtocolMarker,
274{
275    connector.connect().await.with_context(|| format!("failed to connect to {}", S::DEBUG_NAME))
276}
277
278async fn get_control<C>(connector: &C, id: u64) -> Result<finterfaces_ext::admin::Control, Error>
279where
280    C: ServiceConnector<froot::InterfacesMarker>,
281{
282    let root_interfaces = connect_with_context::<froot::InterfacesMarker, _>(connector).await?;
283    let (control, server_end) = finterfaces_ext::admin::Control::create_endpoints()
284        .context("create admin control endpoints")?;
285    root_interfaces.get_admin(id, server_end).context("send get admin request")?;
286    Ok(control)
287}
288
289fn configuration_with_ip_forwarding_set(
290    ip_version: fnet::IpVersion,
291    forwarding: bool,
292) -> finterfaces_admin::Configuration {
293    match ip_version {
294        fnet::IpVersion::V4 => finterfaces_admin::Configuration {
295            ipv4: Some(finterfaces_admin::Ipv4Configuration {
296                unicast_forwarding: Some(forwarding),
297                ..Default::default()
298            }),
299            ..Default::default()
300        },
301        fnet::IpVersion::V6 => finterfaces_admin::Configuration {
302            ipv6: Some(finterfaces_admin::Ipv6Configuration {
303                unicast_forwarding: Some(forwarding),
304                ..Default::default()
305            }),
306            ..Default::default()
307        },
308    }
309}
310
311fn extract_ip_forwarding(
312    finterfaces_admin::Configuration {
313        ipv4: ipv4_config, ipv6: ipv6_config, ..
314    }: finterfaces_admin::Configuration,
315    ip_version: fnet::IpVersion,
316) -> Result<bool, Error> {
317    match ip_version {
318        fnet::IpVersion::V4 => {
319            let finterfaces_admin::Ipv4Configuration { unicast_forwarding, .. } =
320                ipv4_config.context("get IPv4 configuration")?;
321            unicast_forwarding.context("get IPv4 forwarding configuration")
322        }
323        fnet::IpVersion::V6 => {
324            let finterfaces_admin::Ipv6Configuration { unicast_forwarding, .. } =
325                ipv6_config.context("get IPv6 configuration")?;
326            unicast_forwarding.context("get IPv6 forwarding configuration")
327        }
328    }
329}
330
331fn extract_igmp_version(
332    finterfaces_admin::Configuration { ipv4: ipv4_config, .. }: finterfaces_admin::Configuration,
333) -> Result<Option<finterfaces_admin::IgmpVersion>, Error> {
334    let finterfaces_admin::Ipv4Configuration { igmp, .. } =
335        ipv4_config.context("get IPv4 configuration")?;
336    let finterfaces_admin::IgmpConfiguration { version: igmp_version, .. } =
337        igmp.context("get IGMP configuration")?;
338    Ok(igmp_version)
339}
340
341fn extract_mld_version(
342    finterfaces_admin::Configuration { ipv6: ipv6_config, .. }: finterfaces_admin::Configuration,
343) -> Result<Option<finterfaces_admin::MldVersion>, Error> {
344    let finterfaces_admin::Ipv6Configuration { mld, .. } =
345        ipv6_config.context("get IPv6 configuration")?;
346    let finterfaces_admin::MldConfiguration { version: mld_version, .. } =
347        mld.context("get MLD configuration")?;
348    Ok(mld_version)
349}
350
351fn extract_nud_config(
352    finterfaces_admin::Configuration { ipv4, ipv6, .. }: finterfaces_admin::Configuration,
353    ip_version: fnet::IpVersion,
354) -> Result<finterfaces_admin::NudConfiguration, Error> {
355    match ip_version {
356        fnet::IpVersion::V4 => {
357            let finterfaces_admin::Ipv4Configuration { arp, .. } =
358                ipv4.context("get IPv4 configuration")?;
359            let finterfaces_admin::ArpConfiguration { nud, .. } =
360                arp.context("get ARP configuration")?;
361            nud.context("get NUD configuration")
362        }
363        fnet::IpVersion::V6 => {
364            let finterfaces_admin::Ipv6Configuration { ndp, .. } =
365                ipv6.context("get IPv6 configuration")?;
366            let finterfaces_admin::NdpConfiguration { nud, .. } =
367                ndp.context("get NDP configuration")?;
368            nud.context("get NUD configuration")
369        }
370    }
371}
372
373async fn do_if<C: NetCliDepsConnector>(
374    out: &mut writer::JsonWriter<serde_json::Value>,
375    cmd: opts::IfEnum,
376    connector: &C,
377) -> Result<(), Error> {
378    match cmd {
379        opts::IfEnum::List(opts::IfList { name_pattern }) => {
380            let root_interfaces =
381                connect_with_context::<froot::InterfacesMarker, _>(connector).await?;
382            let interface_state =
383                connect_with_context::<finterfaces::StateMarker, _>(connector).await?;
384            let stream = finterfaces_ext::event_stream_from_state::<finterfaces_ext::AllInterest>(
385                &interface_state,
386                Default::default(),
387            )?;
388            let mut response = finterfaces_ext::existing(
389                stream,
390                HashMap::<u64, finterfaces_ext::PropertiesAndState<(), _>>::new(),
391            )
392            .await?;
393            if let Some(name_pattern) = name_pattern {
394                shortlist_interfaces(&name_pattern, &mut response);
395            }
396            let response = response.into_values().map(
397                |finterfaces_ext::PropertiesAndState { properties, state: () }| async {
398                    let mac = root_interfaces
399                        .get_mac(properties.id.get())
400                        .await
401                        .context("call get_mac")?;
402                    Ok::<_, Error>((properties, mac))
403                },
404            );
405            let response = futures::future::try_join_all(response).await?;
406            let mut response: Vec<_> = response
407                .into_iter()
408                .filter_map(|(properties, mac)| match mac {
409                    Err(froot::InterfacesGetMacError::NotFound) => None,
410                    Ok(mac) => {
411                        let mac = mac.map(|box_| *box_);
412                        Some((properties, mac).into())
413                    }
414                })
415                .collect();
416            response.sort_by_key(|ser::InterfaceView { nicid, .. }| *nicid);
417            if out.is_machine() {
418                out.machine(&serde_json::to_value(&response)?)?;
419            } else {
420                write_tabulated_interfaces_info(out, response.into_iter())
421                    .context("error tabulating interface info")?;
422            }
423        }
424        opts::IfEnum::Get(opts::IfGet { interface }) => {
425            let id = interface.find_nicid(connector).await?;
426            let root_interfaces =
427                connect_with_context::<froot::InterfacesMarker, _>(connector).await?;
428            let interface_state =
429                connect_with_context::<finterfaces::StateMarker, _>(connector).await?;
430            let stream = finterfaces_ext::event_stream_from_state::<finterfaces_ext::AllInterest>(
431                &interface_state,
432                Default::default(),
433            )?;
434            let response = finterfaces_ext::existing(
435                stream,
436                finterfaces_ext::InterfaceState::<(), _>::Unknown(id),
437            )
438            .await?;
439            match response {
440                finterfaces_ext::InterfaceState::Unknown(id) => {
441                    return Err(user_facing_error(format!("interface with id={} not found", id)));
442                }
443                finterfaces_ext::InterfaceState::Known(finterfaces_ext::PropertiesAndState {
444                    properties,
445                    state: _,
446                }) => {
447                    let finterfaces_ext::Properties { id, .. } = &properties;
448                    let mac = root_interfaces.get_mac(id.get()).await.context("call get_mac")?;
449                    match mac {
450                        Err(froot::InterfacesGetMacError::NotFound) => {
451                            return Err(user_facing_error(format!(
452                                "interface with id={} not found",
453                                id
454                            )));
455                        }
456                        Ok(mac) => {
457                            let mac = mac.map(|box_| *box_);
458                            let view = (properties, mac).into();
459                            if out.is_machine() {
460                                out.machine(&serde_json::to_value(&view)?)?;
461                            } else {
462                                write_tabulated_interfaces_info(out, std::iter::once(view))
463                                    .context("error tabulating interface info")?;
464                            }
465                        }
466                    };
467                }
468            }
469        }
470        opts::IfEnum::Igmp(opts::IfIgmp { cmd }) => match cmd {
471            opts::IfIgmpEnum::Get(opts::IfIgmpGet { interface }) => {
472                let id = interface.find_nicid(connector).await.context("find nicid")?;
473                let control = get_control(connector, id).await.context("get control")?;
474                let configuration = control
475                    .get_configuration()
476                    .await
477                    .map_err(anyhow::Error::new)
478                    .and_then(|res| {
479                        res.map_err(|e: finterfaces_admin::ControlGetConfigurationError| {
480                            anyhow!("{:?}", e)
481                        })
482                    })
483                    .context("get configuration")?;
484
485                out.line(format!("IGMP configuration on interface {}:", id))?;
486                out.line(format!(
487                    "    Version: {:?}",
488                    extract_igmp_version(configuration).context("get IGMP version")?
489                ))?;
490            }
491            opts::IfIgmpEnum::Set(opts::IfIgmpSet { interface, version }) => {
492                let id = interface.find_nicid(connector).await.context("find nicid")?;
493                let control = get_control(connector, id).await.context("get control")?;
494                let prev_config = control
495                    .set_configuration(&finterfaces_admin::Configuration {
496                        ipv4: Some(finterfaces_admin::Ipv4Configuration {
497                            igmp: Some(finterfaces_admin::IgmpConfiguration {
498                                version,
499                                ..Default::default()
500                            }),
501                            ..Default::default()
502                        }),
503                        ..Default::default()
504                    })
505                    .await
506                    .map_err(anyhow::Error::new)
507                    .and_then(|res| {
508                        res.map_err(|e: finterfaces_admin::ControlSetConfigurationError| {
509                            anyhow!("{:?}", e)
510                        })
511                    })
512                    .context("set configuration")?;
513
514                info!(
515                    "IGMP version set to {:?} on interface {}; previously set to {:?}",
516                    version,
517                    id,
518                    extract_igmp_version(prev_config).context("set IGMP version")?,
519                );
520            }
521        },
522        opts::IfEnum::Mld(opts::IfMld { cmd }) => match cmd {
523            opts::IfMldEnum::Get(opts::IfMldGet { interface }) => {
524                let id = interface.find_nicid(connector).await.context("find nicid")?;
525                let control = get_control(connector, id).await.context("get control")?;
526                let configuration = control
527                    .get_configuration()
528                    .await
529                    .map_err(anyhow::Error::new)
530                    .and_then(|res| {
531                        res.map_err(|e: finterfaces_admin::ControlGetConfigurationError| {
532                            anyhow!("{:?}", e)
533                        })
534                    })
535                    .context("get configuration")?;
536
537                out.line(format!("MLD configuration on interface {}:", id))?;
538                out.line(format!(
539                    "    Version: {:?}",
540                    extract_mld_version(configuration).context("get MLD version")?
541                ))?;
542            }
543            opts::IfMldEnum::Set(opts::IfMldSet { interface, version }) => {
544                let id = interface.find_nicid(connector).await.context("find nicid")?;
545                let control = get_control(connector, id).await.context("get control")?;
546                let prev_config = control
547                    .set_configuration(&finterfaces_admin::Configuration {
548                        ipv6: Some(finterfaces_admin::Ipv6Configuration {
549                            mld: Some(finterfaces_admin::MldConfiguration {
550                                version,
551                                ..Default::default()
552                            }),
553                            ..Default::default()
554                        }),
555                        ..Default::default()
556                    })
557                    .await
558                    .map_err(anyhow::Error::new)
559                    .and_then(|res| {
560                        res.map_err(|e: finterfaces_admin::ControlSetConfigurationError| {
561                            anyhow!("{:?}", e)
562                        })
563                    })
564                    .context("set configuration")?;
565
566                info!(
567                    "MLD version set to {:?} on interface {}; previously set to {:?}",
568                    version,
569                    id,
570                    extract_mld_version(prev_config).context("set MLD version")?,
571                );
572            }
573        },
574        opts::IfEnum::IpForward(opts::IfIpForward { cmd }) => match cmd {
575            opts::IfIpForwardEnum::Get(opts::IfIpForwardGet { interface, ip_version }) => {
576                let id = interface.find_nicid(connector).await.context("find nicid")?;
577                let control = get_control(connector, id).await.context("get control")?;
578                let configuration = control
579                    .get_configuration()
580                    .await
581                    .map_err(anyhow::Error::new)
582                    .and_then(|res| {
583                        res.map_err(|e: finterfaces_admin::ControlGetConfigurationError| {
584                            anyhow!("{:?}", e)
585                        })
586                    })
587                    .context("get configuration")?;
588
589                out.line(format!(
590                    "IP forwarding for {:?} is {} on interface {}",
591                    ip_version,
592                    extract_ip_forwarding(configuration, ip_version)
593                        .context("extract IP forwarding configuration")?,
594                    id
595                ))?;
596            }
597            opts::IfIpForwardEnum::Set(opts::IfIpForwardSet { interface, ip_version, enable }) => {
598                let id = interface.find_nicid(connector).await.context("find nicid")?;
599                let control = get_control(connector, id).await.context("get control")?;
600                let prev_config = control
601                    .set_configuration(&configuration_with_ip_forwarding_set(ip_version, enable))
602                    .await
603                    .map_err(anyhow::Error::new)
604                    .and_then(|res| {
605                        res.map_err(|e: finterfaces_admin::ControlSetConfigurationError| {
606                            anyhow!("{:?}", e)
607                        })
608                    })
609                    .context("set configuration")?;
610                info!(
611                    "IP forwarding for {:?} set to {} on interface {}; previously set to {}",
612                    ip_version,
613                    enable,
614                    id,
615                    extract_ip_forwarding(prev_config, ip_version)
616                        .context("set IP forwarding configuration")?
617                );
618            }
619        },
620        opts::IfEnum::Enable(opts::IfEnable { interface }) => {
621            let id = interface.find_nicid(connector).await?;
622            let control = get_control(connector, id).await?;
623            let did_enable = control
624                .enable()
625                .await
626                .map_err(anyhow::Error::new)
627                .and_then(|res| {
628                    res.map_err(|e: finterfaces_admin::ControlEnableError| anyhow!("{:?}", e))
629                })
630                .context("error enabling interface")?;
631            if did_enable {
632                info!("Interface {} enabled", id);
633            } else {
634                info!("Interface {} already enabled", id);
635            }
636        }
637        opts::IfEnum::Disable(opts::IfDisable { interface }) => {
638            let id = interface.find_nicid(connector).await?;
639            let control = get_control(connector, id).await?;
640            let did_disable = control
641                .disable()
642                .await
643                .map_err(anyhow::Error::new)
644                .and_then(|res| {
645                    res.map_err(|e: finterfaces_admin::ControlDisableError| anyhow!("{:?}", e))
646                })
647                .context("error disabling interface")?;
648            if did_disable {
649                info!("Interface {} disabled", id);
650            } else {
651                info!("Interface {} already disabled", id);
652            }
653        }
654        opts::IfEnum::Addr(opts::IfAddr { addr_cmd }) => match addr_cmd {
655            opts::IfAddrEnum::Add(opts::IfAddrAdd { interface, addr, prefix, no_subnet_route }) => {
656                let id = interface.find_nicid(connector).await?;
657                let control = get_control(connector, id).await?;
658                let addr = fnet_ext::IpAddress::from_str(&addr)?.into();
659                let subnet = fnet_ext::Subnet { addr, prefix_len: prefix };
660                let (address_state_provider, server_end) = fidl::endpoints::create_proxy::<
661                    finterfaces_admin::AddressStateProviderMarker,
662                >();
663                control
664                    .add_address(
665                        &subnet.into(),
666                        &finterfaces_admin::AddressParameters {
667                            add_subnet_route: Some(!no_subnet_route),
668                            ..Default::default()
669                        },
670                        server_end,
671                    )
672                    .context("call add address")?;
673
674                address_state_provider.detach().context("detach address lifetime")?;
675                let state_stream =
676                    finterfaces_ext::admin::assignment_state_stream(address_state_provider);
677
678                state_stream
679                    .try_filter_map(|state| {
680                        futures::future::ok(match state {
681                            finterfaces::AddressAssignmentState::Tentative => None,
682                            finterfaces::AddressAssignmentState::Assigned => Some(()),
683                            finterfaces::AddressAssignmentState::Unavailable => Some(()),
684                        })
685                    })
686                    .try_next()
687                    .await
688                    .context("error after adding address")?
689                    .ok_or_else(|| {
690                        anyhow!(
691                            "Address assignment state stream unexpectedly ended \
692                                 before reaching Assigned or Unavailable state. \
693                                 This is probably a bug."
694                        )
695                    })?;
696
697                info!("Address {}/{} added to interface {}", addr, prefix, id);
698            }
699            opts::IfAddrEnum::Del(opts::IfAddrDel { interface, addr, prefix }) => {
700                let id = interface.find_nicid(connector).await?;
701                let control = get_control(connector, id).await?;
702                let addr = fnet_ext::IpAddress::from_str(&addr)?;
703                let did_remove = {
704                    let addr = addr.into();
705                    let subnet = fnet::Subnet {
706                        addr,
707                        prefix_len: prefix.unwrap_or_else(|| {
708                            8 * u8::try_from(match addr {
709                                fnet::IpAddress::Ipv4(fnet::Ipv4Address { addr }) => addr.len(),
710                                fnet::IpAddress::Ipv6(fnet::Ipv6Address { addr }) => addr.len(),
711                            })
712                            .expect("prefix length doesn't fit u8")
713                        }),
714                    };
715                    control
716                        .remove_address(&subnet)
717                        .await
718                        .map_err(anyhow::Error::new)
719                        .and_then(|res| {
720                            res.map_err(|e: finterfaces_admin::ControlRemoveAddressError| {
721                                anyhow!("{:?}", e)
722                            })
723                        })
724                        .context("call remove address")?
725                };
726                if !did_remove {
727                    return Err(user_facing_error(format!(
728                        "Address {} not found on interface {}",
729                        addr, id
730                    )));
731                }
732                info!("Address {} deleted from interface {}", addr, id);
733            }
734            opts::IfAddrEnum::Wait(opts::IfAddrWait { interface, ipv6 }) => {
735                let id = interface.find_nicid(connector).await?;
736                let interfaces_state =
737                    connect_with_context::<finterfaces::StateMarker, _>(connector).await?;
738                let mut state = finterfaces_ext::InterfaceState::<(), _>::Unknown(id);
739
740                let assigned_addr = finterfaces_ext::wait_interface_with_id(
741                    finterfaces_ext::event_stream_from_state::<finterfaces_ext::AllInterest>(
742                        &interfaces_state,
743                        Default::default(),
744                    )?,
745                    &mut state,
746                    |finterfaces_ext::PropertiesAndState { properties, state: _ }| {
747                        let finterfaces_ext::Properties { addresses, .. } = properties;
748                        let addr = if ipv6 {
749                            addresses.iter().find_map(
750                                |finterfaces_ext::Address {
751                                     addr: fnet::Subnet { addr, .. },
752                                     ..
753                                 }| {
754                                    match addr {
755                                        fnet::IpAddress::Ipv4(_) => None,
756                                        fnet::IpAddress::Ipv6(_) => Some(addr),
757                                    }
758                                },
759                            )
760                        } else {
761                            addresses.first().map(
762                                |finterfaces_ext::Address {
763                                     addr: fnet::Subnet { addr, .. },
764                                     ..
765                                 }| addr,
766                            )
767                        };
768                        addr.map(|addr| {
769                            let fnet_ext::IpAddress(addr) = (*addr).into();
770                            addr
771                        })
772                    },
773                )
774                .await
775                .context("wait for assigned address")?;
776
777                out.line(format!("{assigned_addr}"))?;
778                info!("Address {} assigned on interface {}", assigned_addr, id);
779            }
780        },
781        opts::IfEnum::Bridge(opts::IfBridge { interfaces }) => {
782            let stack = connect_with_context::<fstack::StackMarker, _>(connector).await?;
783            let build_name_to_id_map = || async {
784                let interface_state =
785                    connect_with_context::<finterfaces::StateMarker, _>(connector).await?;
786                let stream = finterfaces_ext::event_stream_from_state::<
787                    finterfaces_ext::AllInterest,
788                >(&interface_state, Default::default())?;
789                let response = finterfaces_ext::existing(stream, HashMap::new()).await?;
790                Ok::<HashMap<String, u64>, Error>(
791                    response
792                        .into_iter()
793                        .map(
794                            |(
795                                id,
796                                finterfaces_ext::PropertiesAndState {
797                                    properties: finterfaces_ext::Properties { name, .. },
798                                    state: (),
799                                },
800                            )| (name, id),
801                        )
802                        .collect(),
803                )
804            };
805
806            let num_interfaces = interfaces.len();
807
808            let (_name_to_id, ids): (Option<HashMap<String, u64>>, Vec<u64>) =
809                futures::stream::iter(interfaces)
810                    .map(Ok::<_, Error>)
811                    .try_fold(
812                        (None, Vec::with_capacity(num_interfaces)),
813                        |(name_to_id, mut ids), interface| async move {
814                            let (name_to_id, id) = match interface {
815                                opts::InterfaceIdentifier::Id(id) => (name_to_id, id),
816                                opts::InterfaceIdentifier::Name(name) => {
817                                    let name_to_id = match name_to_id {
818                                        Some(name_to_id) => name_to_id,
819                                        None => build_name_to_id_map().await?,
820                                    };
821                                    let id = name_to_id.get(&name).copied().ok_or_else(|| {
822                                        user_facing_error(format!("no interface named {}", name))
823                                    })?;
824                                    (Some(name_to_id), id)
825                                }
826                            };
827                            ids.push(id);
828                            Ok((name_to_id, ids))
829                        },
830                    )
831                    .await?;
832
833            let (bridge, server_end) = fidl::endpoints::create_proxy();
834            stack.bridge_interfaces(&ids, server_end).context("bridge interfaces")?;
835            let bridge_id = bridge.get_id().await.context("get bridge id")?;
836            // Detach the channel so it won't cause bridge destruction on exit.
837            bridge.detach().context("detach bridge")?;
838            info!("network bridge created with id {}", bridge_id);
839        }
840        opts::IfEnum::Config(opts::IfConfig { interface, cmd }) => {
841            let id = interface.find_nicid(connector).await.context("find nicid")?;
842            let control = get_control(connector, id).await.context("get control")?;
843
844            match cmd {
845                opts::IfConfigEnum::Set(opts::IfConfigSet { options }) => {
846                    do_if_config_set(control, options).await?;
847                }
848                opts::IfConfigEnum::Get(opts::IfConfigGet {}) => {
849                    let configuration = control
850                        .get_configuration()
851                        .await
852                        .map_err(anyhow::Error::new)
853                        .and_then(|res| {
854                            res.map_err(|e: finterfaces_admin::ControlGetConfigurationError| {
855                                anyhow::anyhow!("{:?}", e)
856                            })
857                        })
858                        .context("get configuration")?;
859                    // TODO(https://fxbug.dev/368806554): Print these with the same names used when
860                    // setting each property.
861                    out.line(format!("{:#?}", configuration))?;
862                }
863            }
864        }
865        opts::IfEnum::Add(opts::IfAdd {
866            cmd: opts::IfAddEnum::Blackhole(opts::IfBlackholeAdd { name }),
867        }) => {
868            let installer =
869                ServiceConnector::<finterfaces_admin::InstallerMarker>::connect(connector)
870                    .await
871                    .expect("connect should succeed");
872
873            let (control, server_end) = finterfaces_ext::admin::Control::create_endpoints()
874                .context("create admin control endpoints")?;
875            installer
876                .install_blackhole_interface(
877                    server_end,
878                    finterfaces_admin::Options { name: Some(name), ..Default::default() },
879                )
880                .expect("install blackhole interface should succeed");
881            control.detach().expect("detach should succeed");
882        }
883        opts::IfEnum::Remove(opts::IfRemove { interface }) => {
884            let id = interface.find_nicid(connector).await.context("find nicid")?;
885            let control = get_control(connector, id).await.context("get control")?;
886            control
887                .remove()
888                .await
889                .expect("should not get FIDL error")
890                .expect("remove should succeed");
891        }
892    }
893    Ok(())
894}
895
896async fn do_if_config_set(
897    control: finterfaces_ext::admin::Control,
898    options: Vec<String>,
899) -> Result<(), Error> {
900    if options.len() % 2 != 0 {
901        return Err(user_facing_error(format!(
902            "if config set expects property value pairs and thus an even number of arguments"
903        )));
904    }
905    let config = options.iter().tuples().try_fold(
906        finterfaces_admin::Configuration::default(),
907        |mut config, (property, value)| {
908            match property.as_str() {
909                "ipv6.ndp.slaac.temporary_address_enabled" => {
910                    let enabled = value.parse::<bool>().map_err(|e| {
911                        user_facing_error(format!("failed to parse {value} as bool: {e}"))
912                    })?;
913                    config
914                        .ipv6
915                        .get_or_insert_default()
916                        .ndp
917                        .get_or_insert_default()
918                        .slaac
919                        .get_or_insert_default()
920                        .temporary_address = Some(enabled);
921                }
922                "ipv6.ndp.dad.transmits" => {
923                    let transmits = value.parse::<u16>().map_err(|e| {
924                        user_facing_error(format!("failed to parse {value} as u16: {e}"))
925                    })?;
926                    config
927                        .ipv6
928                        .get_or_insert_default()
929                        .ndp
930                        .get_or_insert_default()
931                        .dad
932                        .get_or_insert_default()
933                        .transmits = Some(transmits);
934                }
935                unknown_property => {
936                    return Err(user_facing_error(format!(
937                        "unknown configuration parameter: {unknown_property}"
938                    )));
939                }
940            }
941            Ok(config)
942        },
943    )?;
944
945    // TODO(https://fxbug.dev/368806554): Print the returned configuration
946    // struct to give feedback to user about which parameters changed.
947    let _: finterfaces_admin::Configuration = control
948        .set_configuration(&config)
949        .await
950        .map_err(anyhow::Error::new)
951        .and_then(|res| {
952            res.map_err(|e: finterfaces_admin::ControlSetConfigurationError| {
953                anyhow::anyhow!("{:?}", e)
954            })
955        })
956        .context("set configuration")?;
957
958    Ok(())
959}
960
961async fn do_route<C: NetCliDepsConnector>(
962    out: &mut writer::JsonWriter<serde_json::Value>,
963    cmd: opts::RouteEnum,
964    connector: &C,
965) -> Result<(), Error> {
966    match cmd {
967        opts::RouteEnum::List(opts::RouteList {}) => do_route_list(out, connector).await?,
968        opts::RouteEnum::Add(route) => {
969            let stack = connect_with_context::<fstack::StackMarker, _>(connector).await?;
970            let nicid = route.interface.find_u32_nicid(connector).await?;
971            let entry = route.into_route_table_entry(nicid);
972            fstack_ext::exec_fidl!(
973                stack.add_forwarding_entry(&entry),
974                "error adding next-hop forwarding entry"
975            )?;
976        }
977        opts::RouteEnum::Del(route) => {
978            let stack = connect_with_context::<fstack::StackMarker, _>(connector).await?;
979            let nicid = route.interface.find_u32_nicid(connector).await?;
980            let entry = route.into_route_table_entry(nicid);
981            fstack_ext::exec_fidl!(
982                stack.del_forwarding_entry(&entry),
983                "error removing forwarding entry"
984            )?;
985        }
986    }
987    Ok(())
988}
989
990async fn do_route_list<C: NetCliDepsConnector>(
991    out: &mut writer::JsonWriter<serde_json::Value>,
992    connector: &C,
993) -> Result<(), Error> {
994    let ipv4_route_event_stream = pin!({
995        let state_v4 = connect_with_context::<froutes::StateV4Marker, _>(connector)
996            .await
997            .context("failed to connect to fuchsia.net.routes/StateV4")?;
998        froutes_ext::event_stream_from_state::<Ipv4>(&state_v4)
999            .context("failed to initialize a `WatcherV4` client")?
1000            .fuse()
1001    });
1002    let ipv6_route_event_stream = pin!({
1003        let state_v6 = connect_with_context::<froutes::StateV6Marker, _>(connector)
1004            .await
1005            .context("failed to connect to fuchsia.net.routes/StateV6")?;
1006        froutes_ext::event_stream_from_state::<Ipv6>(&state_v6)
1007            .context("failed to initialize a `WatcherV6` client")?
1008            .fuse()
1009    });
1010    let (v4_routes, v6_routes) = futures::future::join(
1011        froutes_ext::collect_routes_until_idle::<_, Vec<_>>(ipv4_route_event_stream),
1012        froutes_ext::collect_routes_until_idle::<_, Vec<_>>(ipv6_route_event_stream),
1013    )
1014    .await;
1015    let mut v4_routes = v4_routes.context("failed to collect all existing IPv4 routes")?;
1016    let mut v6_routes = v6_routes.context("failed to collect all existing IPv6 routes")?;
1017
1018    fn group_by_table_id_and_sort<I: net_types::ip::Ip>(
1019        routes: &mut Vec<froutes_ext::InstalledRoute<I>>,
1020    ) {
1021        routes.sort_unstable_by_key(|r| r.table_id);
1022        for chunk in routes.chunk_by_mut(|a, b| a.table_id == b.table_id) {
1023            chunk.sort();
1024        }
1025    }
1026    group_by_table_id_and_sort(&mut v4_routes);
1027    group_by_table_id_and_sort(&mut v6_routes);
1028
1029    if out.is_machine() {
1030        fn to_ser<I: net_types::ip::Ip>(
1031            route: froutes_ext::InstalledRoute<I>,
1032        ) -> Option<ser::ForwardingEntry> {
1033            route.try_into().map_err(|e| warn!("failed to convert route: {:?}", e)).ok()
1034        }
1035        let routes = v4_routes
1036            .into_iter()
1037            .filter_map(to_ser)
1038            .chain(v6_routes.into_iter().filter_map(to_ser))
1039            .collect::<Vec<_>>();
1040        out.machine(&serde_json::to_value(routes)?).context("serialize")?;
1041    } else {
1042        let mut t = Table::new();
1043        t.set_format(format::FormatBuilder::new().padding(2, 2).build());
1044
1045        // TODO(https://fxbug.dev/342413894): Populate the table name.
1046        t.set_titles(row!["Destination", "Gateway", "NICID", "Metric", "TableId"]);
1047        fn write_route<I: net_types::ip::Ip>(t: &mut Table, route: froutes_ext::InstalledRoute<I>) {
1048            let froutes_ext::InstalledRoute {
1049                route: froutes_ext::Route { destination, action, properties: _ },
1050                effective_properties: froutes_ext::EffectiveRouteProperties { metric },
1051                table_id,
1052            } = route;
1053            let (device_id, next_hop) = match action {
1054                froutes_ext::RouteAction::Forward(froutes_ext::RouteTarget {
1055                    outbound_interface,
1056                    next_hop,
1057                }) => (outbound_interface, next_hop),
1058                froutes_ext::RouteAction::Unknown => {
1059                    warn!("observed route with unknown RouteAction.");
1060                    return;
1061                }
1062            };
1063            let next_hop = next_hop.map(|next_hop| next_hop.to_string());
1064            let next_hop = next_hop.as_ref().map_or("-", |s| s.as_str());
1065            add_row(t, row![destination, next_hop, device_id, metric, table_id]);
1066        }
1067
1068        for route in v4_routes {
1069            write_route(&mut t, route);
1070        }
1071        for route in v6_routes {
1072            write_route(&mut t, route);
1073        }
1074
1075        let _lines_printed: usize = t.print(out)?;
1076        out.line("")?;
1077    }
1078    Ok(())
1079}
1080
1081async fn do_rule<C: NetCliDepsConnector>(
1082    out: &mut writer::JsonWriter<serde_json::Value>,
1083    cmd: opts::RuleEnum,
1084    connector: &C,
1085) -> Result<(), Error> {
1086    match cmd {
1087        opts::RuleEnum::List(opts::RuleList {}) => do_rule_list(out, connector).await,
1088    }
1089}
1090
1091async fn do_rule_list<C: NetCliDepsConnector>(
1092    out: &mut writer::JsonWriter<serde_json::Value>,
1093    connector: &C,
1094) -> Result<(), Error> {
1095    let ipv4_rule_event_stream = pin!({
1096        let state_v4 = connect_with_context::<froutes::StateV4Marker, _>(connector)
1097            .await
1098            .context("failed to connect to fuchsia.net.routes/StateV4")?;
1099        froutes_ext::rules::rule_event_stream_from_state::<Ipv4>(&state_v4)
1100            .context("failed to initialize a `RuleWatcherV4` client")?
1101            .fuse()
1102    });
1103    let ipv6_rule_event_stream = pin!({
1104        let state_v6 = connect_with_context::<froutes::StateV6Marker, _>(connector)
1105            .await
1106            .context("failed to connect to fuchsia.net.routes/StateV6")?;
1107        froutes_ext::rules::rule_event_stream_from_state::<Ipv6>(&state_v6)
1108            .context("failed to initialize a `RuleWatcherV6` client")?
1109            .fuse()
1110    });
1111    let (v4_rules, v6_rules) = futures::future::join(
1112        froutes_ext::rules::collect_rules_until_idle::<Ipv4, Vec<_>>(ipv4_rule_event_stream),
1113        froutes_ext::rules::collect_rules_until_idle::<Ipv6, Vec<_>>(ipv6_rule_event_stream),
1114    )
1115    .await;
1116    let mut v4_rules = v4_rules.context("failed to collect all existing IPv4 rules")?;
1117    let mut v6_rules = v6_rules.context("failed to collect all existing IPv6 rules")?;
1118
1119    v4_rules.sort_by_key(|r| (r.priority, r.index));
1120    v6_rules.sort_by_key(|r| (r.priority, r.index));
1121
1122    fn format_matcher(matcher: fnet_matchers_ext::Mark) -> Cow<'static, str> {
1123        match matcher {
1124            fnet_matchers_ext::Mark::Unmarked => Cow::Borrowed("unmarked"),
1125            fnet_matchers_ext::Mark::Marked { mask, between, invert: _ } => {
1126                format!("{mask:#010x}:{:#010x}..{:#010x}", between.start(), between.end()).into()
1127            }
1128        }
1129    }
1130
1131    struct FormatRule {
1132        rule_set_priority: u32,
1133        index: u32,
1134        from: Option<String>,
1135        locally_generated: Option<String>,
1136        bound_device: Option<String>,
1137        mark_1: Option<Cow<'static, str>>,
1138        mark_2: Option<Cow<'static, str>>,
1139        action: Cow<'static, str>,
1140    }
1141
1142    impl FormatRule {
1143        fn from<I: Ip>(rule: froutes_ext::rules::InstalledRule<I>) -> Self {
1144            let froutes_ext::rules::InstalledRule {
1145                priority: rule_set_priority,
1146                index,
1147                matcher:
1148                    froutes_ext::rules::RuleMatcher {
1149                        from,
1150                        locally_generated,
1151                        bound_device,
1152                        mark_1,
1153                        mark_2,
1154                    },
1155                action,
1156            } = rule;
1157
1158            let rule_set_priority = u32::from(rule_set_priority);
1159            let index = u32::from(index);
1160            let from = from.map(|from| from.to_string());
1161            let locally_generated = locally_generated.map(|x| x.to_string());
1162            let bound_device = bound_device.map(|matcher| match matcher {
1163                fnet_matchers_ext::BoundInterface::Bound(fnet_matchers_ext::Interface::Name(
1164                    name,
1165                )) => format!("name:{name}"),
1166                fnet_matchers_ext::BoundInterface::Bound(fnet_matchers_ext::Interface::Id(id)) => {
1167                    format!("id:{id}")
1168                }
1169                fnet_matchers_ext::BoundInterface::Bound(
1170                    fnet_matchers_ext::Interface::PortClass(class),
1171                ) => format!("class:{class:?}"),
1172                fnet_matchers_ext::BoundInterface::Unbound => "unbound".into(),
1173            });
1174            let mark_1 = mark_1.map(format_matcher);
1175            let mark_2 = mark_2.map(format_matcher);
1176            let action = match action {
1177                froutes_ext::rules::RuleAction::Unreachable => Cow::Borrowed("unreachable"),
1178                froutes_ext::rules::RuleAction::Lookup(table_id) => {
1179                    format!("lookup {table_id}").into()
1180                }
1181            };
1182
1183            FormatRule {
1184                rule_set_priority,
1185                index,
1186                from,
1187                locally_generated,
1188                bound_device,
1189                mark_1,
1190                mark_2,
1191                action,
1192            }
1193        }
1194    }
1195
1196    if out.is_machine() {
1197        fn rule_to_json<I: Ip>(rule: froutes_ext::rules::InstalledRule<I>) -> serde_json::Value {
1198            let FormatRule {
1199                rule_set_priority,
1200                index,
1201                from,
1202                locally_generated,
1203                bound_device,
1204                mark_1,
1205                mark_2,
1206                action,
1207            } = FormatRule::from(rule);
1208
1209            serde_json::json!({
1210                "rule_set_priority": rule_set_priority,
1211                "index": index,
1212                "from": from,
1213                "locally_generated": locally_generated,
1214                "bound_device": bound_device,
1215                "mark_1": mark_1,
1216                "mark_2": mark_2,
1217                "action": action,
1218            })
1219        }
1220
1221        let rules = v4_rules
1222            .into_iter()
1223            .map(rule_to_json)
1224            .chain(v6_rules.into_iter().map(rule_to_json))
1225            .collect::<Vec<_>>();
1226        out.machine(&serde_json::Value::Array(rules)).context("serialize")?;
1227    } else {
1228        let mut t = Table::new();
1229        t.set_format(format::FormatBuilder::new().padding(2, 2).build());
1230        t.set_titles(row![
1231            "RuleSetPriority",
1232            "RuleIndex",
1233            "From",
1234            "LocallyGenerated",
1235            "BoundDevice",
1236            "Mark1Matcher",
1237            "Mark2Matcher",
1238            "Action"
1239        ]);
1240
1241        fn option<D: Deref<Target = str>>(string: &Option<D>) -> &str {
1242            string.as_ref().map_or("-", |s| s.deref())
1243        }
1244
1245        fn write_rule<I: Ip>(t: &mut Table, rule: froutes_ext::rules::InstalledRule<I>) {
1246            let FormatRule {
1247                rule_set_priority,
1248                index,
1249                from,
1250                locally_generated,
1251                bound_device,
1252                mark_1,
1253                mark_2,
1254                action,
1255            } = FormatRule::from(rule);
1256
1257            add_row(
1258                t,
1259                row![
1260                    rule_set_priority,
1261                    index,
1262                    option(&from),
1263                    option(&locally_generated),
1264                    option(&bound_device),
1265                    option(&mark_1),
1266                    option(&mark_2),
1267                    action,
1268                ],
1269            );
1270        }
1271
1272        for rule in v4_rules {
1273            write_rule(&mut t, rule);
1274        }
1275
1276        for rule in v6_rules {
1277            write_rule(&mut t, rule);
1278        }
1279
1280        let _lines_printed: usize = t.print(out)?;
1281        out.line("")?;
1282    }
1283    Ok(())
1284}
1285
1286async fn do_filter_deprecated<C: NetCliDepsConnector, W: std::io::Write>(
1287    mut out: W,
1288    cmd: opts::FilterDeprecatedEnum,
1289    connector: &C,
1290) -> Result<(), Error> {
1291    let filter = connect_with_context::<ffilter_deprecated::FilterMarker, _>(connector).await?;
1292    match cmd {
1293        opts::FilterDeprecatedEnum::GetRules(opts::FilterGetRules {}) => {
1294            let (rules, generation): (Vec<ffilter_deprecated::Rule>, u32) =
1295                filter.get_rules().await?;
1296            writeln!(out, "{:?} (generation {})", rules, generation)?;
1297        }
1298        opts::FilterDeprecatedEnum::SetRules(opts::FilterSetRules { rules }) => {
1299            let (_cur_rules, generation) = filter.get_rules().await?;
1300            let rules = netfilter::parser_deprecated::parse_str_to_rules(&rules)?;
1301            filter_fidl!(filter.update_rules(&rules, generation), "error setting filter rules")?;
1302            info!("successfully set filter rules");
1303        }
1304        opts::FilterDeprecatedEnum::GetNatRules(opts::FilterGetNatRules {}) => {
1305            let (rules, generation): (Vec<ffilter_deprecated::Nat>, u32) =
1306                filter.get_nat_rules().await?;
1307            writeln!(out, "{:?} (generation {})", rules, generation)?;
1308        }
1309        opts::FilterDeprecatedEnum::SetNatRules(opts::FilterSetNatRules { rules }) => {
1310            let (_cur_rules, generation) = filter.get_nat_rules().await?;
1311            let rules = netfilter::parser_deprecated::parse_str_to_nat_rules(&rules)?;
1312            filter_fidl!(filter.update_nat_rules(&rules, generation), "error setting NAT rules")?;
1313            info!("successfully set NAT rules");
1314        }
1315        opts::FilterDeprecatedEnum::GetRdrRules(opts::FilterGetRdrRules {}) => {
1316            let (rules, generation): (Vec<ffilter_deprecated::Rdr>, u32) =
1317                filter.get_rdr_rules().await?;
1318            writeln!(out, "{:?} (generation {})", rules, generation)?;
1319        }
1320        opts::FilterDeprecatedEnum::SetRdrRules(opts::FilterSetRdrRules { rules }) => {
1321            let (_cur_rules, generation) = filter.get_rdr_rules().await?;
1322            let rules = netfilter::parser_deprecated::parse_str_to_rdr_rules(&rules)?;
1323            filter_fidl!(filter.update_rdr_rules(&rules, generation), "error setting RDR rules")?;
1324            info!("successfully set RDR rules");
1325        }
1326    }
1327    Ok(())
1328}
1329
1330async fn do_log<C: NetCliDepsConnector>(cmd: opts::LogEnum, connector: &C) -> Result<(), Error> {
1331    let log = connect_with_context::<fstack::LogMarker, _>(connector).await?;
1332    match cmd {
1333        opts::LogEnum::SetPackets(opts::LogSetPackets { enabled }) => {
1334            log.set_log_packets(enabled).await.context("error setting log packets")?;
1335            info!("log packets set to {:?}", enabled);
1336        }
1337    }
1338    Ok(())
1339}
1340
1341async fn do_dhcp<C: NetCliDepsConnector>(cmd: opts::DhcpEnum, connector: &C) -> Result<(), Error> {
1342    let stack = connect_with_context::<fstack::StackMarker, _>(connector).await?;
1343    match cmd {
1344        opts::DhcpEnum::Start(opts::DhcpStart { interface }) => {
1345            let id = interface.find_nicid(connector).await?;
1346            fstack_ext::exec_fidl!(
1347                stack.set_dhcp_client_enabled(id, true),
1348                "error stopping DHCP client"
1349            )?;
1350            info!("dhcp client started on interface {}", id);
1351        }
1352        opts::DhcpEnum::Stop(opts::DhcpStop { interface }) => {
1353            let id = interface.find_nicid(connector).await?;
1354            fstack_ext::exec_fidl!(
1355                stack.set_dhcp_client_enabled(id, false),
1356                "error stopping DHCP client"
1357            )?;
1358            info!("dhcp client stopped on interface {}", id);
1359        }
1360    }
1361    Ok(())
1362}
1363
1364async fn do_dhcpd<C: NetCliDepsConnector>(
1365    cmd: opts::dhcpd::DhcpdEnum,
1366    connector: &C,
1367) -> Result<(), Error> {
1368    let dhcpd_server = connect_with_context::<fdhcp::Server_Marker, _>(connector).await?;
1369    match cmd {
1370        opts::dhcpd::DhcpdEnum::Start(opts::dhcpd::Start {}) => {
1371            Ok(do_dhcpd_start(dhcpd_server).await?)
1372        }
1373        opts::dhcpd::DhcpdEnum::Stop(opts::dhcpd::Stop {}) => {
1374            Ok(do_dhcpd_stop(dhcpd_server).await?)
1375        }
1376        opts::dhcpd::DhcpdEnum::Get(get_arg) => Ok(do_dhcpd_get(get_arg, dhcpd_server).await?),
1377        opts::dhcpd::DhcpdEnum::Set(set_arg) => Ok(do_dhcpd_set(set_arg, dhcpd_server).await?),
1378        opts::dhcpd::DhcpdEnum::List(list_arg) => Ok(do_dhcpd_list(list_arg, dhcpd_server).await?),
1379        opts::dhcpd::DhcpdEnum::Reset(reset_arg) => {
1380            Ok(do_dhcpd_reset(reset_arg, dhcpd_server).await?)
1381        }
1382        opts::dhcpd::DhcpdEnum::ClearLeases(opts::dhcpd::ClearLeases {}) => {
1383            Ok(do_dhcpd_clear_leases(dhcpd_server).await?)
1384        }
1385    }
1386}
1387
1388async fn do_neigh<C: NetCliDepsConnector>(
1389    out: writer::JsonWriter<serde_json::Value>,
1390    cmd: opts::NeighEnum,
1391    connector: &C,
1392) -> Result<(), Error> {
1393    match cmd {
1394        opts::NeighEnum::Add(opts::NeighAdd { interface, ip, mac }) => {
1395            let interface = interface.find_nicid(connector).await?;
1396            let controller =
1397                connect_with_context::<fneighbor::ControllerMarker, _>(connector).await?;
1398            do_neigh_add(interface, ip.into(), mac.into(), controller)
1399                .await
1400                .context("failed during neigh add command")?;
1401            info!("Added entry ({}, {}) for interface {}", ip, mac, interface);
1402        }
1403        opts::NeighEnum::Clear(opts::NeighClear { interface, ip_version }) => {
1404            let interface = interface.find_nicid(connector).await?;
1405            let controller =
1406                connect_with_context::<fneighbor::ControllerMarker, _>(connector).await?;
1407            do_neigh_clear(interface, ip_version, controller)
1408                .await
1409                .context("failed during neigh clear command")?;
1410            info!("Cleared entries for interface {}", interface);
1411        }
1412        opts::NeighEnum::Del(opts::NeighDel { interface, ip }) => {
1413            let interface = interface.find_nicid(connector).await?;
1414            let controller =
1415                connect_with_context::<fneighbor::ControllerMarker, _>(connector).await?;
1416            do_neigh_del(interface, ip.into(), controller)
1417                .await
1418                .context("failed during neigh del command")?;
1419            info!("Deleted entry {} for interface {}", ip, interface);
1420        }
1421        opts::NeighEnum::List(opts::NeighList {}) => {
1422            let view = connect_with_context::<fneighbor::ViewMarker, _>(connector).await?;
1423            print_neigh_entries(out, false /* watch_for_changes */, view)
1424                .await
1425                .context("error listing neighbor entries")?;
1426        }
1427        opts::NeighEnum::Watch(opts::NeighWatch {}) => {
1428            let view = connect_with_context::<fneighbor::ViewMarker, _>(connector).await?;
1429            print_neigh_entries(out, true /* watch_for_changes */, view)
1430                .await
1431                .context("error watching for changes to the neighbor table")?;
1432        }
1433        opts::NeighEnum::Config(opts::NeighConfig { neigh_config_cmd }) => match neigh_config_cmd {
1434            opts::NeighConfigEnum::Get(opts::NeighGetConfig { interface, ip_version }) => {
1435                let interface = interface.find_nicid(connector).await?;
1436                let control = get_control(connector, interface).await.context("get control")?;
1437                let configuration = control
1438                    .get_configuration()
1439                    .await
1440                    .map_err(anyhow::Error::new)
1441                    .and_then(|res| {
1442                        res.map_err(|e: finterfaces_admin::ControlGetConfigurationError| {
1443                            anyhow!("{:?}", e)
1444                        })
1445                    })
1446                    .context("get configuration")?;
1447                let nud = extract_nud_config(configuration, ip_version)?;
1448                println!("{:#?}", nud);
1449            }
1450            opts::NeighConfigEnum::Update(opts::NeighUpdateConfig {
1451                interface,
1452                ip_version,
1453                base_reachable_time,
1454            }) => {
1455                let interface = interface.find_nicid(connector).await?;
1456                let control = get_control(connector, interface).await.context("get control")?;
1457                let nud_config = finterfaces_admin::NudConfiguration {
1458                    base_reachable_time,
1459                    ..Default::default()
1460                };
1461                let config = match ip_version {
1462                    fnet::IpVersion::V4 => finterfaces_admin::Configuration {
1463                        ipv4: Some(finterfaces_admin::Ipv4Configuration {
1464                            arp: Some(finterfaces_admin::ArpConfiguration {
1465                                nud: Some(nud_config),
1466                                ..Default::default()
1467                            }),
1468                            ..Default::default()
1469                        }),
1470                        ..Default::default()
1471                    },
1472                    fnet::IpVersion::V6 => finterfaces_admin::Configuration {
1473                        ipv6: Some(finterfaces_admin::Ipv6Configuration {
1474                            ndp: Some(finterfaces_admin::NdpConfiguration {
1475                                nud: Some(nud_config),
1476                                ..Default::default()
1477                            }),
1478                            ..Default::default()
1479                        }),
1480                        ..Default::default()
1481                    },
1482                };
1483                let prev_config = control
1484                    .set_configuration(&config)
1485                    .await
1486                    .map_err(anyhow::Error::new)
1487                    .and_then(|res| {
1488                        res.map_err(|e: finterfaces_admin::ControlSetConfigurationError| {
1489                            anyhow!("{:?}", e)
1490                        })
1491                    })
1492                    .context("set configuration")?;
1493                let prev_nud = extract_nud_config(prev_config, ip_version)?;
1494                info!("Updated config for interface {}; previously was: {:?}", interface, prev_nud);
1495            }
1496        },
1497    }
1498    Ok(())
1499}
1500
1501async fn do_neigh_add(
1502    interface: u64,
1503    neighbor: fnet::IpAddress,
1504    mac: fnet::MacAddress,
1505    controller: fneighbor::ControllerProxy,
1506) -> Result<(), Error> {
1507    controller
1508        .add_entry(interface, &neighbor.into(), &mac.into())
1509        .await
1510        .context("FIDL error adding neighbor entry")?
1511        .map_err(zx::Status::from_raw)
1512        .context("error adding neighbor entry")
1513}
1514
1515async fn do_neigh_clear(
1516    interface: u64,
1517    ip_version: fnet::IpVersion,
1518    controller: fneighbor::ControllerProxy,
1519) -> Result<(), Error> {
1520    controller
1521        .clear_entries(interface, ip_version)
1522        .await
1523        .context("FIDL error clearing neighbor table")?
1524        .map_err(zx::Status::from_raw)
1525        .context("error clearing neighbor table")
1526}
1527
1528async fn do_neigh_del(
1529    interface: u64,
1530    neighbor: fnet::IpAddress,
1531    controller: fneighbor::ControllerProxy,
1532) -> Result<(), Error> {
1533    controller
1534        .remove_entry(interface, &neighbor.into())
1535        .await
1536        .context("FIDL error removing neighbor entry")?
1537        .map_err(zx::Status::from_raw)
1538        .context("error removing neighbor entry")
1539}
1540
1541fn unpack_neigh_iter_item(
1542    item: fneighbor::EntryIteratorItem,
1543) -> Result<(&'static str, Option<fneighbor_ext::Entry>), Error> {
1544    let displayed_state_change_status = ser::DISPLAYED_NEIGH_ENTRY_VARIANTS.select(&item);
1545
1546    Ok((
1547        displayed_state_change_status,
1548        match item {
1549            fneighbor::EntryIteratorItem::Existing(entry)
1550            | fneighbor::EntryIteratorItem::Added(entry)
1551            | fneighbor::EntryIteratorItem::Changed(entry)
1552            | fneighbor::EntryIteratorItem::Removed(entry) => {
1553                Some(fneighbor_ext::Entry::try_from(entry)?)
1554            }
1555            fneighbor::EntryIteratorItem::Idle(fneighbor::IdleEvent) => None,
1556        },
1557    ))
1558}
1559
1560fn jsonify_neigh_iter_item(
1561    item: fneighbor::EntryIteratorItem,
1562    include_entry_state: bool,
1563) -> Result<Value, Error> {
1564    let (state_change_status, entry) = unpack_neigh_iter_item(item)?;
1565    let entry_json = entry
1566        .map(ser::NeighborTableEntry::from)
1567        .map(serde_json::to_value)
1568        .map(|res| res.map_err(Error::new))
1569        .unwrap_or_else(|| Err(anyhow!("failed to jsonify NeighborTableEntry")))?;
1570    if include_entry_state {
1571        Ok(json!({
1572            "state_change_status": state_change_status,
1573            "entry": entry_json,
1574        }))
1575    } else {
1576        Ok(entry_json)
1577    }
1578}
1579
1580async fn print_neigh_entries(
1581    mut out: writer::JsonWriter<serde_json::Value>,
1582    watch_for_changes: bool,
1583    view: fneighbor::ViewProxy,
1584) -> Result<(), Error> {
1585    let (it_client, it_server) =
1586        fidl::endpoints::create_endpoints::<fneighbor::EntryIteratorMarker>();
1587    let it = it_client.into_proxy();
1588
1589    view.open_entry_iterator(it_server, &fneighbor::EntryIteratorOptions::default())
1590        .context("error opening a connection to the entry iterator")?;
1591
1592    let out_ref = &mut out;
1593    if watch_for_changes {
1594        neigh_entry_stream(it, watch_for_changes)
1595            .map_ok(|item| {
1596                write_neigh_entry(out_ref, item, /* include_entry_state= */ watch_for_changes)
1597                    .context("error writing entry")
1598            })
1599            .try_fold((), |(), r| futures::future::ready(r))
1600            .await?;
1601    } else {
1602        let results: Vec<Result<fneighbor::EntryIteratorItem, _>> =
1603            neigh_entry_stream(it, watch_for_changes).collect().await;
1604        if out.is_machine() {
1605            let jsonified_items: Value =
1606                itertools::process_results(results.into_iter(), |items| {
1607                    itertools::process_results(
1608                        items.map(|item| {
1609                            jsonify_neigh_iter_item(
1610                                item,
1611                                /* include_entry_state= */ watch_for_changes,
1612                            )
1613                        }),
1614                        |json_values| Value::from_iter(json_values),
1615                    )
1616                })??;
1617            out.machine(&jsonified_items)?;
1618        } else {
1619            itertools::process_results(results.into_iter(), |mut items| {
1620                items.try_for_each(|item| {
1621                    write_tabular_neigh_entry(
1622                        &mut out,
1623                        item,
1624                        /* include_entry_state= */ watch_for_changes,
1625                    )
1626                })
1627            })??;
1628        }
1629    }
1630
1631    Ok(())
1632}
1633
1634fn neigh_entry_stream(
1635    iterator: fneighbor::EntryIteratorProxy,
1636    watch_for_changes: bool,
1637) -> impl futures::Stream<Item = Result<fneighbor::EntryIteratorItem, Error>> {
1638    futures::stream::try_unfold(iterator, |iterator| {
1639        iterator
1640            .get_next()
1641            .map_ok(|items| Some((items, iterator)))
1642            .map(|r| r.context("error getting items from iterator"))
1643    })
1644    .map_ok(|items| futures::stream::iter(items.into_iter().map(Ok)))
1645    .try_flatten()
1646    .take_while(move |item| {
1647        futures::future::ready(item.as_ref().is_ok_and(|item| {
1648            if let fneighbor::EntryIteratorItem::Idle(fneighbor::IdleEvent {}) = item {
1649                watch_for_changes
1650            } else {
1651                true
1652            }
1653        }))
1654    })
1655}
1656
1657fn write_tabular_neigh_entry<W: std::io::Write>(
1658    mut f: W,
1659    item: fneighbor::EntryIteratorItem,
1660    include_entry_state: bool,
1661) -> Result<(), Error> {
1662    let (state_change_status, entry) = unpack_neigh_iter_item(item)?;
1663    match entry {
1664        Some(entry) => {
1665            if include_entry_state {
1666                writeln!(
1667                    &mut f,
1668                    "{:width$} | {}",
1669                    state_change_status,
1670                    entry,
1671                    width = ser::DISPLAYED_NEIGH_ENTRY_VARIANTS
1672                        .into_iter()
1673                        .map(|s| s.len())
1674                        .max()
1675                        .unwrap_or(0),
1676                )?
1677            } else {
1678                writeln!(&mut f, "{}", entry)?
1679            }
1680        }
1681        None => writeln!(&mut f, "{}", state_change_status)?,
1682    }
1683    Ok(())
1684}
1685
1686fn write_neigh_entry(
1687    f: &mut writer::JsonWriter<serde_json::Value>,
1688    item: fneighbor::EntryIteratorItem,
1689    include_entry_state: bool,
1690) -> Result<(), Error> {
1691    if f.is_machine() {
1692        let entry = jsonify_neigh_iter_item(item, include_entry_state)?;
1693        f.machine(&entry)?;
1694    } else {
1695        write_tabular_neigh_entry(f, item, include_entry_state)?
1696    }
1697    Ok(())
1698}
1699
1700async fn do_dhcpd_start(server: fdhcp::Server_Proxy) -> Result<(), Error> {
1701    server.start_serving().await?.map_err(zx::Status::from_raw).context("failed to start server")
1702}
1703
1704async fn do_dhcpd_stop(server: fdhcp::Server_Proxy) -> Result<(), Error> {
1705    server.stop_serving().await.context("failed to stop server")
1706}
1707
1708async fn do_dhcpd_get(get_arg: opts::dhcpd::Get, server: fdhcp::Server_Proxy) -> Result<(), Error> {
1709    match get_arg.arg {
1710        opts::dhcpd::GetArg::Option(opts::dhcpd::OptionArg { name }) => {
1711            let res = server
1712                .get_option(name.clone().into())
1713                .await?
1714                .map_err(zx::Status::from_raw)
1715                .with_context(|| format!("get_option({:?}) failed", name))?;
1716            println!("{:#?}", res);
1717        }
1718        opts::dhcpd::GetArg::Parameter(opts::dhcpd::ParameterArg { name }) => {
1719            let res = server
1720                .get_parameter(name.clone().into())
1721                .await?
1722                .map_err(zx::Status::from_raw)
1723                .with_context(|| format!("get_parameter({:?}) failed", name))?;
1724            println!("{:#?}", res);
1725        }
1726    };
1727    Ok(())
1728}
1729
1730async fn do_dhcpd_set(set_arg: opts::dhcpd::Set, server: fdhcp::Server_Proxy) -> Result<(), Error> {
1731    match set_arg.arg {
1732        opts::dhcpd::SetArg::Option(opts::dhcpd::OptionArg { name }) => {
1733            server
1734                .set_option(&name.clone().into())
1735                .await?
1736                .map_err(zx::Status::from_raw)
1737                .with_context(|| format!("set_option({:?}) failed", name))?;
1738        }
1739        opts::dhcpd::SetArg::Parameter(opts::dhcpd::ParameterArg { name }) => {
1740            server
1741                .set_parameter(&name.clone().into())
1742                .await?
1743                .map_err(zx::Status::from_raw)
1744                .with_context(|| format!("set_parameter({:?}) failed", name))?;
1745        }
1746    };
1747    Ok(())
1748}
1749
1750async fn do_dhcpd_list(
1751    list_arg: opts::dhcpd::List,
1752    server: fdhcp::Server_Proxy,
1753) -> Result<(), Error> {
1754    match list_arg.arg {
1755        opts::dhcpd::ListArg::Option(opts::dhcpd::OptionToken {}) => {
1756            let res = server
1757                .list_options()
1758                .await?
1759                .map_err(zx::Status::from_raw)
1760                .context("list_options() failed")?;
1761
1762            println!("{:#?}", res);
1763        }
1764        opts::dhcpd::ListArg::Parameter(opts::dhcpd::ParameterToken {}) => {
1765            let res = server
1766                .list_parameters()
1767                .await?
1768                .map_err(zx::Status::from_raw)
1769                .context("list_parameters() failed")?;
1770            println!("{:#?}", res);
1771        }
1772    };
1773    Ok(())
1774}
1775
1776async fn do_dhcpd_reset(
1777    reset_arg: opts::dhcpd::Reset,
1778    server: fdhcp::Server_Proxy,
1779) -> Result<(), Error> {
1780    match reset_arg.arg {
1781        opts::dhcpd::ResetArg::Option(opts::dhcpd::OptionToken {}) => {
1782            server
1783                .reset_options()
1784                .await?
1785                .map_err(zx::Status::from_raw)
1786                .context("reset_options() failed")?;
1787        }
1788        opts::dhcpd::ResetArg::Parameter(opts::dhcpd::ParameterToken {}) => {
1789            server
1790                .reset_parameters()
1791                .await?
1792                .map_err(zx::Status::from_raw)
1793                .context("reset_parameters() failed")?;
1794        }
1795    };
1796    Ok(())
1797}
1798
1799async fn do_dhcpd_clear_leases(server: fdhcp::Server_Proxy) -> Result<(), Error> {
1800    server.clear_leases().await?.map_err(zx::Status::from_raw).context("clear_leases() failed")
1801}
1802
1803async fn do_dns<W: std::io::Write, C: NetCliDepsConnector>(
1804    mut out: W,
1805    cmd: opts::dns::DnsEnum,
1806    connector: &C,
1807) -> Result<(), Error> {
1808    let lookup = connect_with_context::<fname::LookupMarker, _>(connector).await?;
1809    let opts::dns::DnsEnum::Lookup(opts::dns::Lookup { hostname, ipv4, ipv6, sort }) = cmd;
1810    let result = lookup
1811        .lookup_ip(
1812            &hostname,
1813            &fname::LookupIpOptions {
1814                ipv4_lookup: Some(ipv4),
1815                ipv6_lookup: Some(ipv6),
1816                sort_addresses: Some(sort),
1817                ..Default::default()
1818            },
1819        )
1820        .await?
1821        .map_err(|e| anyhow!("DNS lookup failed: {:?}", e))?;
1822    let fname::LookupResult { addresses, .. } = result;
1823    let addrs = addresses.context("`addresses` not set in response from DNS resolver")?;
1824    for addr in addrs {
1825        writeln!(out, "{}", fnet_ext::IpAddress::from(addr))?;
1826    }
1827    Ok(())
1828}
1829
1830async fn do_netstack_migration<W: std::io::Write, C: NetCliDepsConnector>(
1831    mut out: W,
1832    cmd: opts::NetstackMigrationEnum,
1833    connector: &C,
1834) -> Result<(), Error> {
1835    match cmd {
1836        opts::NetstackMigrationEnum::Set(opts::NetstackMigrationSet { version }) => {
1837            let control =
1838                connect_with_context::<fnet_migration::ControlMarker, _>(connector).await?;
1839            control
1840                .set_user_netstack_version(Some(&fnet_migration::VersionSetting { version }))
1841                .await
1842                .context("failed to set stack version")
1843        }
1844        opts::NetstackMigrationEnum::Clear(opts::NetstackMigrationClear {}) => {
1845            let control =
1846                connect_with_context::<fnet_migration::ControlMarker, _>(connector).await?;
1847            control.set_user_netstack_version(None).await.context("failed to set stack version")
1848        }
1849        opts::NetstackMigrationEnum::Get(opts::NetstackMigrationGet {}) => {
1850            let state = connect_with_context::<fnet_migration::StateMarker, _>(connector).await?;
1851            let fnet_migration::InEffectVersion { current_boot, user, automated, .. } =
1852                state.get_netstack_version().await.context("failed to get stack version")?;
1853            writeln!(out, "current_boot = {current_boot:?}")?;
1854            writeln!(out, "user = {user:?}")?;
1855            writeln!(out, "automated = {automated:?}")?;
1856            Ok(())
1857        }
1858    }
1859}
1860
1861#[cfg(test)]
1862mod testutil {
1863    use fidl::endpoints::ProtocolMarker;
1864
1865    use super::*;
1866
1867    #[derive(Default)]
1868    pub(crate) struct TestConnector {
1869        pub debug_interfaces: Option<fdebug::InterfacesProxy>,
1870        pub dhcpd: Option<fdhcp::Server_Proxy>,
1871        pub interfaces_state: Option<finterfaces::StateProxy>,
1872        pub stack: Option<fstack::StackProxy>,
1873        pub root_interfaces: Option<froot::InterfacesProxy>,
1874        pub root_filter: Option<froot::FilterProxy>,
1875        pub routes_v4: Option<froutes::StateV4Proxy>,
1876        pub routes_v6: Option<froutes::StateV6Proxy>,
1877        pub name_lookup: Option<fname::LookupProxy>,
1878        pub filter: Option<fnet_filter::StateProxy>,
1879        pub installer: Option<finterfaces_admin::InstallerProxy>,
1880    }
1881
1882    #[async_trait::async_trait]
1883    impl ServiceConnector<fdebug::InterfacesMarker> for TestConnector {
1884        async fn connect(
1885            &self,
1886        ) -> Result<<fdebug::InterfacesMarker as ProtocolMarker>::Proxy, Error> {
1887            self.debug_interfaces
1888                .as_ref()
1889                .cloned()
1890                .ok_or_else(|| anyhow!("connector has no dhcp server instance"))
1891        }
1892    }
1893
1894    #[async_trait::async_trait]
1895    impl ServiceConnector<froot::InterfacesMarker> for TestConnector {
1896        async fn connect(
1897            &self,
1898        ) -> Result<<froot::InterfacesMarker as ProtocolMarker>::Proxy, Error> {
1899            self.root_interfaces
1900                .as_ref()
1901                .cloned()
1902                .ok_or_else(|| anyhow!("connector has no root interfaces instance"))
1903        }
1904    }
1905
1906    #[async_trait::async_trait]
1907    impl ServiceConnector<froot::FilterMarker> for TestConnector {
1908        async fn connect(&self) -> Result<<froot::FilterMarker as ProtocolMarker>::Proxy, Error> {
1909            self.root_filter
1910                .as_ref()
1911                .cloned()
1912                .ok_or_else(|| anyhow!("connector has no root filter instance"))
1913        }
1914    }
1915
1916    #[async_trait::async_trait]
1917    impl ServiceConnector<fdhcp::Server_Marker> for TestConnector {
1918        async fn connect(&self) -> Result<<fdhcp::Server_Marker as ProtocolMarker>::Proxy, Error> {
1919            self.dhcpd
1920                .as_ref()
1921                .cloned()
1922                .ok_or_else(|| anyhow!("connector has no dhcp server instance"))
1923        }
1924    }
1925
1926    #[async_trait::async_trait]
1927    impl ServiceConnector<ffilter_deprecated::FilterMarker> for TestConnector {
1928        async fn connect(
1929            &self,
1930        ) -> Result<<ffilter_deprecated::FilterMarker as ProtocolMarker>::Proxy, Error> {
1931            Err(anyhow!("connect filter_deprecated unimplemented for test connector"))
1932        }
1933    }
1934
1935    #[async_trait::async_trait]
1936    impl ServiceConnector<finterfaces::StateMarker> for TestConnector {
1937        async fn connect(
1938            &self,
1939        ) -> Result<<finterfaces::StateMarker as ProtocolMarker>::Proxy, Error> {
1940            self.interfaces_state
1941                .as_ref()
1942                .cloned()
1943                .ok_or_else(|| anyhow!("connector has no interfaces state instance"))
1944        }
1945    }
1946
1947    #[async_trait::async_trait]
1948    impl ServiceConnector<finterfaces_admin::InstallerMarker> for TestConnector {
1949        async fn connect(
1950            &self,
1951        ) -> Result<<finterfaces_admin::InstallerMarker as ProtocolMarker>::Proxy, Error> {
1952            self.installer
1953                .as_ref()
1954                .cloned()
1955                .ok_or_else(|| anyhow!("connector has no fuchsia.net.interfaces.admin.Installer"))
1956        }
1957    }
1958
1959    #[async_trait::async_trait]
1960    impl ServiceConnector<fneighbor::ControllerMarker> for TestConnector {
1961        async fn connect(
1962            &self,
1963        ) -> Result<<fneighbor::ControllerMarker as ProtocolMarker>::Proxy, Error> {
1964            Err(anyhow!("connect neighbor controller unimplemented for test connector"))
1965        }
1966    }
1967
1968    #[async_trait::async_trait]
1969    impl ServiceConnector<fneighbor::ViewMarker> for TestConnector {
1970        async fn connect(&self) -> Result<<fneighbor::ViewMarker as ProtocolMarker>::Proxy, Error> {
1971            Err(anyhow!("connect neighbor view unimplemented for test connector"))
1972        }
1973    }
1974
1975    #[async_trait::async_trait]
1976    impl ServiceConnector<fstack::LogMarker> for TestConnector {
1977        async fn connect(&self) -> Result<<fstack::LogMarker as ProtocolMarker>::Proxy, Error> {
1978            Err(anyhow!("connect log unimplemented for test connector"))
1979        }
1980    }
1981
1982    #[async_trait::async_trait]
1983    impl ServiceConnector<fstack::StackMarker> for TestConnector {
1984        async fn connect(&self) -> Result<<fstack::StackMarker as ProtocolMarker>::Proxy, Error> {
1985            self.stack.as_ref().cloned().ok_or_else(|| anyhow!("connector has no stack instance"))
1986        }
1987    }
1988
1989    #[async_trait::async_trait]
1990    impl ServiceConnector<froutes::StateV4Marker> for TestConnector {
1991        async fn connect(
1992            &self,
1993        ) -> Result<<froutes::StateV4Marker as ProtocolMarker>::Proxy, Error> {
1994            self.routes_v4
1995                .as_ref()
1996                .cloned()
1997                .ok_or_else(|| anyhow!("connector has no routes_v4 instance"))
1998        }
1999    }
2000
2001    #[async_trait::async_trait]
2002    impl ServiceConnector<froutes::StateV6Marker> for TestConnector {
2003        async fn connect(
2004            &self,
2005        ) -> Result<<froutes::StateV6Marker as ProtocolMarker>::Proxy, Error> {
2006            self.routes_v6
2007                .as_ref()
2008                .cloned()
2009                .ok_or_else(|| anyhow!("connector has no routes_v6 instance"))
2010        }
2011    }
2012
2013    #[async_trait::async_trait]
2014    impl ServiceConnector<fname::LookupMarker> for TestConnector {
2015        async fn connect(&self) -> Result<<fname::LookupMarker as ProtocolMarker>::Proxy, Error> {
2016            self.name_lookup
2017                .as_ref()
2018                .cloned()
2019                .ok_or_else(|| anyhow!("connector has no name lookup instance"))
2020        }
2021    }
2022
2023    #[async_trait::async_trait]
2024    impl ServiceConnector<fnet_migration::ControlMarker> for TestConnector {
2025        async fn connect(
2026            &self,
2027        ) -> Result<<fnet_migration::ControlMarker as ProtocolMarker>::Proxy, Error> {
2028            unimplemented!("stack migration not supported");
2029        }
2030    }
2031
2032    #[async_trait::async_trait]
2033    impl ServiceConnector<fnet_migration::StateMarker> for TestConnector {
2034        async fn connect(
2035            &self,
2036        ) -> Result<<fnet_migration::StateMarker as ProtocolMarker>::Proxy, Error> {
2037            unimplemented!("stack migration not supported");
2038        }
2039    }
2040
2041    #[async_trait::async_trait]
2042    impl ServiceConnector<fnet_filter::StateMarker> for TestConnector {
2043        async fn connect(
2044            &self,
2045        ) -> Result<<fnet_filter::StateMarker as ProtocolMarker>::Proxy, Error> {
2046            self.filter.as_ref().cloned().ok_or_else(|| anyhow!("connector has no filter instance"))
2047        }
2048    }
2049}
2050
2051#[cfg(test)]
2052mod tests {
2053    use std::convert::TryInto as _;
2054    use std::fmt::Debug;
2055
2056    use assert_matches::assert_matches;
2057    use fuchsia_async::{self as fasync, TimeoutExt as _};
2058    use net_declare::{fidl_ip, fidl_ip_v4, fidl_mac, fidl_subnet};
2059    use test_case::test_case;
2060    use {fidl_fuchsia_net_routes as froutes, fidl_fuchsia_net_routes_ext as froutes_ext};
2061
2062    use super::testutil::TestConnector;
2063    use super::*;
2064
2065    const IF_ADDR_V4: fnet::Subnet = fidl_subnet!("192.168.0.1/32");
2066    const IF_ADDR_V6: fnet::Subnet = fidl_subnet!("fd00::1/64");
2067
2068    const MAC_1: fnet::MacAddress = fidl_mac!("01:02:03:04:05:06");
2069    const MAC_2: fnet::MacAddress = fidl_mac!("02:03:04:05:06:07");
2070
2071    fn trim_whitespace_for_comparison(s: &str) -> String {
2072        s.trim().lines().map(|s| s.trim()).collect::<Vec<&str>>().join("\n")
2073    }
2074
2075    fn get_fake_interface(
2076        id: u64,
2077        name: &'static str,
2078        port_class: finterfaces_ext::PortClass,
2079        octets: Option<[u8; 6]>,
2080    ) -> (finterfaces_ext::Properties<finterfaces_ext::AllInterest>, Option<fnet::MacAddress>) {
2081        let port_identity_koid = match port_class {
2082            finterfaces_ext::PortClass::Loopback => None,
2083            finterfaces_ext::PortClass::Virtual
2084            | finterfaces_ext::PortClass::Ethernet
2085            | finterfaces_ext::PortClass::WlanClient
2086            | finterfaces_ext::PortClass::WlanAp
2087            | finterfaces_ext::PortClass::Ppp
2088            | finterfaces_ext::PortClass::Bridge
2089            | finterfaces_ext::PortClass::Lowpan
2090            | finterfaces_ext::PortClass::Blackhole => {
2091                Some(finterfaces_ext::PortIdentityKoid::from_raw(id))
2092            }
2093        };
2094        (
2095            finterfaces_ext::Properties {
2096                id: id.try_into().unwrap(),
2097                name: name.to_string(),
2098                port_class,
2099                online: true,
2100                addresses: Vec::new(),
2101                has_default_ipv4_route: false,
2102                has_default_ipv6_route: false,
2103                port_identity_koid,
2104            },
2105            octets.map(|octets| fnet::MacAddress { octets }),
2106        )
2107    }
2108
2109    fn shortlist_interfaces_by_nicid(name_pattern: &str) -> Vec<u64> {
2110        let mut interfaces = [
2111            get_fake_interface(1, "lo", finterfaces_ext::PortClass::Loopback, None),
2112            get_fake_interface(
2113                10,
2114                "eth001",
2115                finterfaces_ext::PortClass::Ethernet,
2116                Some([1, 2, 3, 4, 5, 6]),
2117            ),
2118            get_fake_interface(
2119                20,
2120                "eth002",
2121                finterfaces_ext::PortClass::Ethernet,
2122                Some([1, 2, 3, 4, 5, 7]),
2123            ),
2124            get_fake_interface(
2125                30,
2126                "eth003",
2127                finterfaces_ext::PortClass::Ethernet,
2128                Some([1, 2, 3, 4, 5, 8]),
2129            ),
2130            get_fake_interface(
2131                100,
2132                "wlan001",
2133                finterfaces_ext::PortClass::WlanClient,
2134                Some([2, 2, 3, 4, 5, 6]),
2135            ),
2136            get_fake_interface(
2137                200,
2138                "wlan002",
2139                finterfaces_ext::PortClass::WlanClient,
2140                Some([2, 2, 3, 4, 5, 7]),
2141            ),
2142            get_fake_interface(
2143                300,
2144                "wlan003",
2145                finterfaces_ext::PortClass::WlanClient,
2146                Some([2, 2, 3, 4, 5, 8]),
2147            ),
2148        ]
2149        .into_iter()
2150        .map(|(properties, _): (_, Option<fnet::MacAddress>)| {
2151            let finterfaces_ext::Properties { id, .. } = &properties;
2152            (id.get(), finterfaces_ext::PropertiesAndState { properties, state: () })
2153        })
2154        .collect();
2155        shortlist_interfaces(name_pattern, &mut interfaces);
2156        let mut interfaces: Vec<_> = interfaces.into_keys().collect();
2157        interfaces.sort();
2158        interfaces
2159    }
2160
2161    #[test]
2162    fn test_shortlist_interfaces() {
2163        assert_eq!(vec![1, 10, 20, 30, 100, 200, 300], shortlist_interfaces_by_nicid(""));
2164        assert_eq!(vec![0_u64; 0], shortlist_interfaces_by_nicid("no such thing"));
2165
2166        assert_eq!(vec![1], shortlist_interfaces_by_nicid("lo"));
2167        assert_eq!(vec![10, 20, 30], shortlist_interfaces_by_nicid("eth"));
2168        assert_eq!(vec![10, 20, 30], shortlist_interfaces_by_nicid("th"));
2169        assert_eq!(vec![100, 200, 300], shortlist_interfaces_by_nicid("wlan"));
2170        assert_eq!(vec![10, 100], shortlist_interfaces_by_nicid("001"));
2171    }
2172
2173    #[test_case(fnet::IpVersion::V4, true ; "IPv4 enable routing")]
2174    #[test_case(fnet::IpVersion::V4, false ; "IPv4 disable routing")]
2175    #[test_case(fnet::IpVersion::V6, true ; "IPv6 enable routing")]
2176    #[test_case(fnet::IpVersion::V6, false ; "IPv6 disable routing")]
2177    #[fasync::run_singlethreaded(test)]
2178    async fn if_ip_forward(ip_version: fnet::IpVersion, enable: bool) {
2179        let interface1 = TestInterface { nicid: 1, name: "interface1" };
2180        let (root_interfaces, mut requests) =
2181            fidl::endpoints::create_proxy_and_stream::<froot::InterfacesMarker>();
2182        let connector =
2183            TestConnector { root_interfaces: Some(root_interfaces), ..Default::default() };
2184
2185        let requests_fut = set_configuration_request(
2186            &mut requests,
2187            interface1.nicid,
2188            |c| extract_ip_forwarding(c, ip_version).expect("extract IP forwarding configuration"),
2189            enable,
2190        );
2191        let buf = writer::TestBuffers::default();
2192        let mut out = writer::JsonWriter::new_test(None, &buf);
2193        let do_if_fut = do_if(
2194            &mut out,
2195            opts::IfEnum::IpForward(opts::IfIpForward {
2196                cmd: opts::IfIpForwardEnum::Set(opts::IfIpForwardSet {
2197                    interface: interface1.identifier(false /* use_ifname */),
2198                    ip_version,
2199                    enable,
2200                }),
2201            }),
2202            &connector,
2203        );
2204        let ((), ()) = futures::future::try_join(do_if_fut, requests_fut.map(Ok))
2205            .await
2206            .expect("setting interface ip forwarding should succeed");
2207
2208        let requests_fut = get_configuration_request(
2209            &mut requests,
2210            interface1.nicid,
2211            configuration_with_ip_forwarding_set(ip_version, enable),
2212        );
2213        let buf = writer::TestBuffers::default();
2214        let mut out = writer::JsonWriter::new_test(None, &buf);
2215        let do_if_fut = do_if(
2216            &mut out,
2217            opts::IfEnum::IpForward(opts::IfIpForward {
2218                cmd: opts::IfIpForwardEnum::Get(opts::IfIpForwardGet {
2219                    interface: interface1.identifier(false /* use_ifname */),
2220                    ip_version,
2221                }),
2222            }),
2223            &connector,
2224        );
2225        let ((), ()) = futures::future::try_join(do_if_fut, requests_fut.map(Ok))
2226            .await
2227            .expect("getting interface ip forwarding should succeed");
2228        let got_output = buf.into_stdout_str();
2229        pretty_assertions::assert_eq!(
2230            trim_whitespace_for_comparison(&got_output),
2231            trim_whitespace_for_comparison(&format!(
2232                "IP forwarding for {:?} is {} on interface {}",
2233                ip_version, enable, interface1.nicid
2234            )),
2235        )
2236    }
2237
2238    async fn set_configuration_request<
2239        O: Debug + PartialEq,
2240        F: FnOnce(finterfaces_admin::Configuration) -> O,
2241    >(
2242        requests: &mut froot::InterfacesRequestStream,
2243        expected_nicid: u64,
2244        extract_config: F,
2245        expected_config: O,
2246    ) {
2247        let (id, control, _control_handle) = requests
2248            .next()
2249            .await
2250            .expect("root request stream not ended")
2251            .expect("root request stream not error")
2252            .into_get_admin()
2253            .expect("get admin request");
2254        assert_eq!(id, expected_nicid);
2255
2256        let mut control: finterfaces_admin::ControlRequestStream = control.into_stream();
2257        let (configuration, responder) = control
2258            .next()
2259            .await
2260            .expect("control request stream not ended")
2261            .expect("control request stream not error")
2262            .into_set_configuration()
2263            .expect("set configuration request");
2264        assert_eq!(extract_config(configuration), expected_config);
2265        // net-cli does not check the returned configuration so we do not
2266        // return a populated one.
2267        responder.send(Ok(&Default::default())).expect("responder.send should succeed");
2268    }
2269
2270    async fn get_configuration_request(
2271        requests: &mut froot::InterfacesRequestStream,
2272        expected_nicid: u64,
2273        config: finterfaces_admin::Configuration,
2274    ) {
2275        let (id, control, _control_handle) = requests
2276            .next()
2277            .await
2278            .expect("root request stream not ended")
2279            .expect("root request stream not error")
2280            .into_get_admin()
2281            .expect("get admin request");
2282        assert_eq!(id, expected_nicid);
2283
2284        let mut control: finterfaces_admin::ControlRequestStream = control.into_stream();
2285        let responder = control
2286            .next()
2287            .await
2288            .expect("control request stream not ended")
2289            .expect("control request stream not error")
2290            .into_get_configuration()
2291            .expect("get configuration request");
2292        responder.send(Ok(&config)).expect("responder.send should succeed");
2293    }
2294
2295    #[test_case(finterfaces_admin::IgmpVersion::V1)]
2296    #[test_case(finterfaces_admin::IgmpVersion::V2)]
2297    #[test_case(finterfaces_admin::IgmpVersion::V3)]
2298    #[fasync::run_singlethreaded(test)]
2299    async fn if_igmp(igmp_version: finterfaces_admin::IgmpVersion) {
2300        let interface1 = TestInterface { nicid: 1, name: "interface1" };
2301        let (root_interfaces, mut requests) =
2302            fidl::endpoints::create_proxy_and_stream::<froot::InterfacesMarker>();
2303        let connector =
2304            TestConnector { root_interfaces: Some(root_interfaces), ..Default::default() };
2305
2306        let requests_fut = set_configuration_request(
2307            &mut requests,
2308            interface1.nicid,
2309            |c| extract_igmp_version(c).unwrap(),
2310            Some(igmp_version),
2311        );
2312        let buffers = writer::TestBuffers::default();
2313        let mut out = writer::JsonWriter::new_test(None, &buffers);
2314        let do_if_fut = do_if(
2315            &mut out,
2316            opts::IfEnum::Igmp(opts::IfIgmp {
2317                cmd: opts::IfIgmpEnum::Set(opts::IfIgmpSet {
2318                    interface: interface1.identifier(false /* use_ifname */),
2319                    version: Some(igmp_version),
2320                }),
2321            }),
2322            &connector,
2323        );
2324        let ((), ()) = futures::future::try_join(do_if_fut, requests_fut.map(Ok))
2325            .await
2326            .expect("setting interface IGMP configuration should succeed");
2327
2328        let requests_fut = get_configuration_request(
2329            &mut requests,
2330            interface1.nicid,
2331            finterfaces_admin::Configuration {
2332                ipv4: Some(finterfaces_admin::Ipv4Configuration {
2333                    igmp: Some(finterfaces_admin::IgmpConfiguration {
2334                        version: Some(igmp_version),
2335                        ..Default::default()
2336                    }),
2337                    ..Default::default()
2338                }),
2339                ..Default::default()
2340            },
2341        );
2342        let buffers = writer::TestBuffers::default();
2343        let mut output_buf = writer::JsonWriter::new_test(None, &buffers);
2344        let do_if_fut = do_if(
2345            &mut output_buf,
2346            opts::IfEnum::Igmp(opts::IfIgmp {
2347                cmd: opts::IfIgmpEnum::Get(opts::IfIgmpGet {
2348                    interface: interface1.identifier(false /* use_ifname */),
2349                }),
2350            }),
2351            &connector,
2352        );
2353        let ((), ()) = futures::future::try_join(do_if_fut, requests_fut.map(Ok))
2354            .await
2355            .expect("getting interface IGMP configuration should succeed");
2356        let got_output = buffers.into_stdout_str();
2357        pretty_assertions::assert_eq!(
2358            trim_whitespace_for_comparison(&got_output),
2359            trim_whitespace_for_comparison(&format!(
2360                "IGMP configuration on interface {}:\n    Version: {:?}",
2361                interface1.nicid,
2362                Some(igmp_version),
2363            )),
2364        )
2365    }
2366
2367    #[test_case(finterfaces_admin::MldVersion::V1)]
2368    #[test_case(finterfaces_admin::MldVersion::V2)]
2369    #[fasync::run_singlethreaded(test)]
2370    async fn if_mld(mld_version: finterfaces_admin::MldVersion) {
2371        let interface1 = TestInterface { nicid: 1, name: "interface1" };
2372        let (root_interfaces, mut requests) =
2373            fidl::endpoints::create_proxy_and_stream::<froot::InterfacesMarker>();
2374        let connector =
2375            TestConnector { root_interfaces: Some(root_interfaces), ..Default::default() };
2376
2377        let requests_fut = set_configuration_request(
2378            &mut requests,
2379            interface1.nicid,
2380            |c| extract_mld_version(c).unwrap(),
2381            Some(mld_version),
2382        );
2383        let buffers = writer::TestBuffers::default();
2384        let mut out = writer::JsonWriter::new_test(None, &buffers);
2385        let do_if_fut = do_if(
2386            &mut out,
2387            opts::IfEnum::Mld(opts::IfMld {
2388                cmd: opts::IfMldEnum::Set(opts::IfMldSet {
2389                    interface: interface1.identifier(false /* use_ifname */),
2390                    version: Some(mld_version),
2391                }),
2392            }),
2393            &connector,
2394        );
2395        let ((), ()) = futures::future::try_join(do_if_fut, requests_fut.map(Ok))
2396            .await
2397            .expect("setting interface MLD configuration should succeed");
2398
2399        let requests_fut = get_configuration_request(
2400            &mut requests,
2401            interface1.nicid,
2402            finterfaces_admin::Configuration {
2403                ipv6: Some(finterfaces_admin::Ipv6Configuration {
2404                    mld: Some(finterfaces_admin::MldConfiguration {
2405                        version: Some(mld_version),
2406                        ..Default::default()
2407                    }),
2408                    ..Default::default()
2409                }),
2410                ..Default::default()
2411            },
2412        );
2413        let buffers = writer::TestBuffers::default();
2414        let mut output_buf = writer::JsonWriter::new_test(None, &buffers);
2415        let do_if_fut = do_if(
2416            &mut output_buf,
2417            opts::IfEnum::Mld(opts::IfMld {
2418                cmd: opts::IfMldEnum::Get(opts::IfMldGet {
2419                    interface: interface1.identifier(false /* use_ifname */),
2420                }),
2421            }),
2422            &connector,
2423        );
2424        let ((), ()) = futures::future::try_join(do_if_fut, requests_fut.map(Ok))
2425            .await
2426            .expect("getting interface MLD configuration should succeed");
2427        let got_output = buffers.into_stdout_str();
2428        pretty_assertions::assert_eq!(
2429            trim_whitespace_for_comparison(&got_output),
2430            trim_whitespace_for_comparison(&format!(
2431                "MLD configuration on interface {}:\n    Version: {:?}",
2432                interface1.nicid,
2433                Some(mld_version),
2434            )),
2435        )
2436    }
2437
2438    async fn always_answer_with_interfaces(
2439        interfaces_state_requests: finterfaces::StateRequestStream,
2440        interfaces: Vec<finterfaces::Properties>,
2441    ) {
2442        interfaces_state_requests
2443            .try_for_each(|request| {
2444                let interfaces = interfaces.clone();
2445                async move {
2446                    let (finterfaces::WatcherOptions { .. }, server_end, _): (
2447                        _,
2448                        _,
2449                        finterfaces::StateControlHandle,
2450                    ) = request.into_get_watcher().expect("request type should be GetWatcher");
2451
2452                    let mut watcher_request_stream: finterfaces::WatcherRequestStream =
2453                        server_end.into_stream();
2454
2455                    for event in interfaces
2456                        .into_iter()
2457                        .map(finterfaces::Event::Existing)
2458                        .chain(std::iter::once(finterfaces::Event::Idle(finterfaces::Empty)))
2459                    {
2460                        watcher_request_stream
2461                            .try_next()
2462                            .await
2463                            .expect("watcher watch FIDL error")
2464                            .expect("watcher request stream should not have ended")
2465                            .into_watch()
2466                            .expect("request should be of type Watch")
2467                            .send(&event)
2468                            .expect("responder.send should succeed");
2469                    }
2470
2471                    assert_matches!(
2472                        watcher_request_stream.try_next().await.expect("watcher watch FIDL error"),
2473                        None,
2474                        "remaining watcher request stream should be empty"
2475                    );
2476                    Ok(())
2477                }
2478            })
2479            .await
2480            .expect("interfaces state FIDL error")
2481    }
2482
2483    #[derive(Clone)]
2484    struct TestInterface {
2485        nicid: u64,
2486        name: &'static str,
2487    }
2488
2489    impl TestInterface {
2490        fn identifier(&self, use_ifname: bool) -> opts::InterfaceIdentifier {
2491            let Self { nicid, name } = self;
2492            if use_ifname {
2493                opts::InterfaceIdentifier::Name(name.to_string())
2494            } else {
2495                opts::InterfaceIdentifier::Id(*nicid)
2496            }
2497        }
2498    }
2499
2500    #[test_case(true, false ; "when interface is up, and adding subnet route")]
2501    #[test_case(true, true ; "when interface is up, and not adding subnet route")]
2502    #[test_case(false, false ; "when interface is down, and adding subnet route")]
2503    #[test_case(false, true ; "when interface is down, and not adding subnet route")]
2504    #[fasync::run_singlethreaded(test)]
2505    async fn if_addr_add(interface_is_up: bool, no_subnet_route: bool) {
2506        const TEST_PREFIX_LENGTH: u8 = 64;
2507
2508        let interface1 = TestInterface { nicid: 1, name: "interface1" };
2509        let (root_interfaces, mut requests) =
2510            fidl::endpoints::create_proxy_and_stream::<froot::InterfacesMarker>();
2511
2512        let connector =
2513            TestConnector { root_interfaces: Some(root_interfaces), ..Default::default() };
2514        let buffers = writer::TestBuffers::default();
2515        let mut out = writer::JsonWriter::new_test(None, &buffers);
2516        let do_if_fut = do_if(
2517            &mut out,
2518            opts::IfEnum::Addr(opts::IfAddr {
2519                addr_cmd: opts::IfAddrEnum::Add(opts::IfAddrAdd {
2520                    interface: interface1.identifier(false /* use_ifname */),
2521                    addr: fnet_ext::IpAddress::from(IF_ADDR_V6.addr).to_string(),
2522                    prefix: TEST_PREFIX_LENGTH,
2523                    no_subnet_route,
2524                }),
2525            }),
2526            &connector,
2527        )
2528        .map(|res| res.expect("success"));
2529
2530        let admin_fut = async {
2531            let (id, control, _control_handle) = requests
2532                .next()
2533                .await
2534                .expect("root request stream not ended")
2535                .expect("root request stream not error")
2536                .into_get_admin()
2537                .expect("get admin request");
2538            assert_eq!(id, interface1.nicid);
2539
2540            let mut control: finterfaces_admin::ControlRequestStream = control.into_stream();
2541            let (
2542                addr,
2543                addr_params,
2544                address_state_provider_server_end,
2545                _admin_control_control_handle,
2546            ) = control
2547                .next()
2548                .await
2549                .expect("control request stream not ended")
2550                .expect("control request stream not error")
2551                .into_add_address()
2552                .expect("add address request");
2553            assert_eq!(addr, IF_ADDR_V6);
2554            assert_eq!(
2555                addr_params,
2556                finterfaces_admin::AddressParameters {
2557                    add_subnet_route: Some(!no_subnet_route),
2558                    ..Default::default()
2559                }
2560            );
2561
2562            let mut address_state_provider_request_stream =
2563                address_state_provider_server_end.into_stream();
2564            async fn next_request(
2565                stream: &mut finterfaces_admin::AddressStateProviderRequestStream,
2566            ) -> finterfaces_admin::AddressStateProviderRequest {
2567                stream
2568                    .next()
2569                    .await
2570                    .expect("address state provider request stream not ended")
2571                    .expect("address state provider request stream not error")
2572            }
2573
2574            let _address_state_provider_control_handle =
2575                next_request(&mut address_state_provider_request_stream)
2576                    .await
2577                    .into_detach()
2578                    .expect("detach request");
2579
2580            for _ in 0..3 {
2581                next_request(&mut address_state_provider_request_stream)
2582                    .await
2583                    .into_watch_address_assignment_state()
2584                    .expect("watch address assignment state request")
2585                    .send(finterfaces::AddressAssignmentState::Tentative)
2586                    .expect("send address assignment state succeeds");
2587            }
2588
2589            next_request(&mut address_state_provider_request_stream)
2590                .await
2591                .into_watch_address_assignment_state()
2592                .expect("watch address assignment state request")
2593                .send(if interface_is_up {
2594                    finterfaces::AddressAssignmentState::Assigned
2595                } else {
2596                    finterfaces::AddressAssignmentState::Unavailable
2597                })
2598                .expect("send address assignment state succeeds");
2599        };
2600
2601        let ((), ()) = futures::join!(admin_fut, do_if_fut);
2602    }
2603
2604    #[test_case(false ; "providing nicids")]
2605    #[test_case(true ; "providing interface names")]
2606    #[fasync::run_singlethreaded(test)]
2607    async fn if_del_addr(use_ifname: bool) {
2608        let interface1 = TestInterface { nicid: 1, name: "interface1" };
2609        let interface2 = TestInterface { nicid: 2, name: "interface2" };
2610
2611        let (root_interfaces, mut requests) =
2612            fidl::endpoints::create_proxy_and_stream::<froot::InterfacesMarker>();
2613        let (interfaces_state, interfaces_requests) =
2614            fidl::endpoints::create_proxy_and_stream::<finterfaces::StateMarker>();
2615
2616        let (interface1_properties, _mac) = get_fake_interface(
2617            interface1.nicid,
2618            interface1.name,
2619            finterfaces_ext::PortClass::Ethernet,
2620            None,
2621        );
2622
2623        let interfaces_fut =
2624            always_answer_with_interfaces(interfaces_requests, vec![interface1_properties.into()])
2625                .fuse();
2626        let mut interfaces_fut = pin!(interfaces_fut);
2627
2628        let connector = TestConnector {
2629            root_interfaces: Some(root_interfaces),
2630            interfaces_state: Some(interfaces_state),
2631            ..Default::default()
2632        };
2633
2634        let buffers = writer::TestBuffers::default();
2635        let mut out = writer::JsonWriter::new_test(None, &buffers);
2636        // Make the first request.
2637        let succeeds = do_if(
2638            &mut out,
2639            opts::IfEnum::Addr(opts::IfAddr {
2640                addr_cmd: opts::IfAddrEnum::Del(opts::IfAddrDel {
2641                    interface: interface1.identifier(use_ifname),
2642                    addr: fnet_ext::IpAddress::from(IF_ADDR_V4.addr).to_string(),
2643                    prefix: None, // The prefix should be set to the default of 32 for IPv4.
2644                }),
2645            }),
2646            &connector,
2647        )
2648        .map(|res| res.expect("success"));
2649        let handler_fut = async {
2650            let (id, control, _control_handle) = requests
2651                .next()
2652                .await
2653                .expect("root request stream not ended")
2654                .expect("root request stream not error")
2655                .into_get_admin()
2656                .expect("get admin request");
2657            assert_eq!(id, interface1.nicid);
2658            let mut control = control.into_stream();
2659            let (addr, responder) = control
2660                .next()
2661                .await
2662                .expect("control request stream not ended")
2663                .expect("control request stream not error")
2664                .into_remove_address()
2665                .expect("del address request");
2666            assert_eq!(addr, IF_ADDR_V4);
2667            responder.send(Ok(true)).expect("responder send");
2668        };
2669
2670        futures::select! {
2671            () = interfaces_fut => panic!("interfaces_fut should never complete"),
2672            ((), ()) = futures::future::join(handler_fut, succeeds).fuse() => {},
2673        }
2674
2675        let buffers = writer::TestBuffers::default();
2676        let mut out = writer::JsonWriter::new_test(None, &buffers);
2677        // Make the second request.
2678        let fails = do_if(
2679            &mut out,
2680            opts::IfEnum::Addr(opts::IfAddr {
2681                addr_cmd: opts::IfAddrEnum::Del(opts::IfAddrDel {
2682                    interface: interface2.identifier(use_ifname),
2683                    addr: fnet_ext::IpAddress::from(IF_ADDR_V6.addr).to_string(),
2684                    prefix: Some(IF_ADDR_V6.prefix_len),
2685                }),
2686            }),
2687            &connector,
2688        )
2689        .map(|res| res.expect_err("failure"));
2690
2691        if use_ifname {
2692            // The caller will have failed to find an interface matching the name,
2693            // so we don't expect any requests to make it to us.
2694            futures::select! {
2695                () = interfaces_fut => panic!("interfaces_fut should never complete"),
2696                e = fails.fuse() => {
2697                    assert_eq!(e.to_string(), format!("No interface with name {}", interface2.name));
2698                },
2699            }
2700        } else {
2701            let handler_fut = async {
2702                let (id, control, _control_handle) = requests
2703                    .next()
2704                    .await
2705                    .expect("root request stream not ended")
2706                    .expect("root request stream not error")
2707                    .into_get_admin()
2708                    .expect("get admin request");
2709                assert_eq!(id, interface2.nicid);
2710                let mut control = control.into_stream();
2711                let (addr, responder) = control
2712                    .next()
2713                    .await
2714                    .expect("control request stream not ended")
2715                    .expect("control request stream not error")
2716                    .into_remove_address()
2717                    .expect("del address request");
2718                assert_eq!(addr, IF_ADDR_V6);
2719                responder.send(Ok(false)).expect("responder send");
2720            };
2721            futures::select! {
2722                () = interfaces_fut => panic!("interfaces_fut should never complete"),
2723                ((), e) = futures::future::join(handler_fut, fails).fuse() => {
2724                    let fnet_ext::IpAddress(addr) = IF_ADDR_V6.addr.into();
2725                    assert_eq!(e.to_string(), format!("Address {} not found on interface {}", addr, interface2.nicid));
2726                },
2727            }
2728        }
2729    }
2730
2731    const INTERFACE_NAME: &str = "if1";
2732
2733    fn interface_properties(
2734        addrs: Vec<(fnet::Subnet, finterfaces::AddressAssignmentState)>,
2735    ) -> finterfaces::Properties {
2736        finterfaces_ext::Properties {
2737            id: INTERFACE_ID.try_into().unwrap(),
2738            name: INTERFACE_NAME.to_string(),
2739            port_class: finterfaces_ext::PortClass::Ethernet,
2740            online: true,
2741            addresses: addrs
2742                .into_iter()
2743                .map(|(addr, assignment_state)| finterfaces_ext::Address::<
2744                    finterfaces_ext::AllInterest,
2745                > {
2746                    addr,
2747                    assignment_state,
2748                    valid_until: finterfaces_ext::PositiveMonotonicInstant::INFINITE_FUTURE,
2749                    preferred_lifetime_info:
2750                        finterfaces_ext::PreferredLifetimeInfo::preferred_forever(),
2751                })
2752                .collect(),
2753            has_default_ipv4_route: false,
2754            has_default_ipv6_route: false,
2755            port_identity_koid: None,
2756        }
2757        .into()
2758    }
2759
2760    #[test_case(
2761        false,
2762        vec![
2763            finterfaces::Event::Existing(interface_properties(vec![])),
2764            finterfaces::Event::Idle(finterfaces::Empty),
2765            finterfaces::Event::Changed(interface_properties(vec![
2766                (fidl_subnet!("192.168.0.1/32"), finterfaces::AddressAssignmentState::Assigned)
2767            ])),
2768        ],
2769        "192.168.0.1";
2770        "wait for an address to be assigned"
2771    )]
2772    #[test_case(
2773        false,
2774        vec![
2775            finterfaces::Event::Existing(interface_properties(vec![
2776                (fidl_subnet!("192.168.0.1/32"), finterfaces::AddressAssignmentState::Assigned),
2777                (fidl_subnet!("fd00::1/64"), finterfaces::AddressAssignmentState::Assigned),
2778            ])),
2779        ],
2780        "192.168.0.1";
2781        "prefer first when any address requested"
2782    )]
2783    #[test_case(
2784        true,
2785        vec![
2786            finterfaces::Event::Existing(interface_properties(vec![
2787                (fidl_subnet!("192.168.0.1/32"), finterfaces::AddressAssignmentState::Assigned)
2788            ])),
2789            finterfaces::Event::Idle(finterfaces::Empty),
2790            finterfaces::Event::Changed(interface_properties(vec![
2791                (fidl_subnet!("fd00::1/64"), finterfaces::AddressAssignmentState::Assigned)
2792            ])),
2793        ],
2794        "fd00::1";
2795        "wait for IPv6 when IPv6 address requested"
2796    )]
2797    #[fasync::run_singlethreaded(test)]
2798    async fn if_addr_wait(ipv6: bool, events: Vec<finterfaces::Event>, expected_output: &str) {
2799        let interface = TestInterface { nicid: INTERFACE_ID, name: INTERFACE_NAME };
2800
2801        let (interfaces_state, mut request_stream) =
2802            fidl::endpoints::create_proxy_and_stream::<finterfaces::StateMarker>();
2803
2804        let interfaces_handler = async move {
2805            let (finterfaces::WatcherOptions { include_non_assigned_addresses, .. }, server_end, _) =
2806                request_stream
2807                    .next()
2808                    .await
2809                    .expect("should call state")
2810                    .expect("should succeed")
2811                    .into_get_watcher()
2812                    .expect("request should be GetWatcher");
2813            assert_eq!(include_non_assigned_addresses, Some(false));
2814            let mut request_stream: finterfaces::WatcherRequestStream = server_end.into_stream();
2815            for event in events {
2816                request_stream
2817                    .next()
2818                    .await
2819                    .expect("should call watcher")
2820                    .expect("should succeed")
2821                    .into_watch()
2822                    .expect("request should be Watch")
2823                    .send(&event)
2824                    .expect("send response");
2825            }
2826        };
2827
2828        let connector =
2829            TestConnector { interfaces_state: Some(interfaces_state), ..Default::default() };
2830        let buffers = writer::TestBuffers::default();
2831        let mut out = writer::JsonWriter::new_test(None, &buffers);
2832        let run_command = do_if(
2833            &mut out,
2834            opts::IfEnum::Addr(opts::IfAddr {
2835                addr_cmd: opts::IfAddrEnum::Wait(opts::IfAddrWait {
2836                    interface: interface.identifier(false),
2837                    ipv6,
2838                }),
2839            }),
2840            &connector,
2841        )
2842        .map(|r| r.expect("command should succeed"));
2843
2844        let ((), ()) = futures::future::join(interfaces_handler, run_command).await;
2845
2846        let output = buffers.into_stdout_str();
2847        pretty_assertions::assert_eq!(
2848            trim_whitespace_for_comparison(&output),
2849            trim_whitespace_for_comparison(expected_output),
2850        );
2851    }
2852
2853    fn wanted_net_if_list_json() -> String {
2854        json!([
2855            {
2856                "addresses": {
2857                    "ipv4": [],
2858                    "ipv6": [],
2859                },
2860                "device_class": "Loopback",
2861                "mac": "00:00:00:00:00:00",
2862                "name": "lo",
2863                "nicid": 1,
2864                "online": true,
2865                "has_default_ipv4_route": false,
2866                "has_default_ipv6_route": false,
2867                "port_identity_koid": null,
2868            },
2869            {
2870                "addresses": {
2871                    "ipv4": [],
2872                    "ipv6": [],
2873                },
2874                "device_class": "Ethernet",
2875                "mac": "01:02:03:04:05:06",
2876                "name": "eth001",
2877                "nicid": 10,
2878                "online": true,
2879                "has_default_ipv4_route": false,
2880                "has_default_ipv6_route": false,
2881                "port_identity_koid": 10,
2882            },
2883            {
2884                "addresses": {
2885                    "ipv4": [],
2886                    "ipv6": [],
2887                },
2888                "device_class": "Virtual",
2889                "mac": null,
2890                "name": "virt001",
2891                "nicid": 20,
2892                "online": true,
2893                "has_default_ipv4_route": false,
2894                "has_default_ipv6_route": false,
2895                "port_identity_koid": 20,
2896            },
2897            {
2898                "addresses": {
2899                    "ipv4": [
2900                        {
2901                            "addr": "192.168.0.1",
2902                            "assignment_state": "Tentative",
2903                            "prefix_len": 24,
2904                            "valid_until": 2500000000_u64,
2905                        }
2906                    ],
2907                    "ipv6": [],
2908                },
2909                "device_class": "Ethernet",
2910                "mac": null,
2911                "name": "eth002",
2912                "nicid": 30,
2913                "online": true,
2914                "has_default_ipv4_route": false,
2915                "has_default_ipv6_route": true,
2916                "port_identity_koid": null,
2917            },
2918            {
2919                "addresses": {
2920                    "ipv4": [],
2921                    "ipv6": [{
2922                        "addr": "2001:db8::1",
2923                        "assignment_state": "Unavailable",
2924                        "prefix_len": 64,
2925                        "valid_until": null,
2926                    }],
2927                },
2928                "device_class": "Ethernet",
2929                "mac": null,
2930                "name": "eth003",
2931                "nicid": 40,
2932                "online": true,
2933                "has_default_ipv4_route": true,
2934                "has_default_ipv6_route": true,
2935                "port_identity_koid": null,
2936            },
2937        ])
2938        .to_string()
2939    }
2940
2941    fn wanted_net_if_list_tabular() -> String {
2942        String::from(
2943            r#"
2944nicid                 1
2945name                  lo
2946device class          loopback
2947online                true
2948default routes        -
2949mac                   00:00:00:00:00:00
2950port_identity_koid    -
2951
2952nicid                 10
2953name                  eth001
2954device class          ethernet
2955online                true
2956default routes        -
2957mac                   01:02:03:04:05:06
2958port_identity_koid    10
2959
2960nicid                 20
2961name                  virt001
2962device class          virtual
2963online                true
2964default routes        -
2965mac                   -
2966port_identity_koid    20
2967
2968nicid                 30
2969name                  eth002
2970device class          ethernet
2971online                true
2972default routes        IPv6
2973addr                  192.168.0.1/24       TENTATIVE valid until [2.5s]
2974mac                   -
2975port_identity_koid    -
2976
2977nicid                 40
2978name                  eth003
2979device class          ethernet
2980online                true
2981default routes        IPv4,IPv6
2982addr                  2001:db8::1/64       UNAVAILABLE
2983mac                   -
2984port_identity_koid    -
2985"#,
2986        )
2987    }
2988
2989    #[test_case(true, wanted_net_if_list_json() ; "in json format")]
2990    #[test_case(false, wanted_net_if_list_tabular() ; "in tabular format")]
2991    #[fasync::run_singlethreaded(test)]
2992    async fn if_list(json: bool, wanted_output: String) {
2993        let (root_interfaces, root_interfaces_stream) =
2994            fidl::endpoints::create_proxy_and_stream::<froot::InterfacesMarker>();
2995        let (interfaces_state, interfaces_state_stream) =
2996            fidl::endpoints::create_proxy_and_stream::<finterfaces::StateMarker>();
2997
2998        let buffers = writer::TestBuffers::default();
2999        let mut output = if json {
3000            writer::JsonWriter::new_test(Some(writer::Format::Json), &buffers)
3001        } else {
3002            writer::JsonWriter::new_test(None, &buffers)
3003        };
3004        let output_ref = &mut output;
3005
3006        let do_if_fut = async {
3007            let connector = TestConnector {
3008                root_interfaces: Some(root_interfaces),
3009                interfaces_state: Some(interfaces_state),
3010                ..Default::default()
3011            };
3012            do_if(output_ref, opts::IfEnum::List(opts::IfList { name_pattern: None }), &connector)
3013                .map(|res| res.expect("if list"))
3014                .await
3015        };
3016        let watcher_stream = interfaces_state_stream
3017            .and_then(|req| match req {
3018                finterfaces::StateRequest::GetWatcher {
3019                    options: _,
3020                    watcher,
3021                    control_handle: _,
3022                } => futures::future::ready(Ok(watcher.into_stream())),
3023            })
3024            .try_flatten()
3025            .map(|res| res.expect("watcher stream error"));
3026        let (interfaces, mac_addresses): (Vec<_>, HashMap<_, _>) = [
3027            get_fake_interface(
3028                1,
3029                "lo",
3030                finterfaces_ext::PortClass::Loopback,
3031                Some([0, 0, 0, 0, 0, 0]),
3032            ),
3033            get_fake_interface(
3034                10,
3035                "eth001",
3036                finterfaces_ext::PortClass::Ethernet,
3037                Some([1, 2, 3, 4, 5, 6]),
3038            ),
3039            get_fake_interface(20, "virt001", finterfaces_ext::PortClass::Virtual, None),
3040            (
3041                finterfaces_ext::Properties {
3042                    id: 30.try_into().unwrap(),
3043                    name: "eth002".to_string(),
3044                    port_class: finterfaces_ext::PortClass::Ethernet,
3045                    online: true,
3046                    addresses: vec![finterfaces_ext::Address {
3047                        addr: fidl_subnet!("192.168.0.1/24"),
3048                        valid_until: i64::try_from(
3049                            std::time::Duration::from_millis(2500).as_nanos(),
3050                        )
3051                        .unwrap()
3052                        .try_into()
3053                        .unwrap(),
3054                        assignment_state: finterfaces::AddressAssignmentState::Tentative,
3055                        preferred_lifetime_info:
3056                            finterfaces_ext::PreferredLifetimeInfo::preferred_forever(),
3057                    }],
3058                    has_default_ipv4_route: false,
3059                    has_default_ipv6_route: true,
3060                    port_identity_koid: None,
3061                },
3062                None,
3063            ),
3064            (
3065                finterfaces_ext::Properties {
3066                    id: 40.try_into().unwrap(),
3067                    name: "eth003".to_string(),
3068                    port_class: finterfaces_ext::PortClass::Ethernet,
3069                    online: true,
3070                    addresses: vec![finterfaces_ext::Address {
3071                        addr: fidl_subnet!("2001:db8::1/64"),
3072                        valid_until: finterfaces_ext::PositiveMonotonicInstant::INFINITE_FUTURE,
3073                        assignment_state: finterfaces::AddressAssignmentState::Unavailable,
3074                        preferred_lifetime_info:
3075                            finterfaces_ext::PreferredLifetimeInfo::preferred_forever(),
3076                    }],
3077                    has_default_ipv4_route: true,
3078                    has_default_ipv6_route: true,
3079                    port_identity_koid: None,
3080                },
3081                None,
3082            ),
3083        ]
3084        .into_iter()
3085        .map(|(properties, mac)| {
3086            let finterfaces_ext::Properties { id, .. } = &properties;
3087            let id = *id;
3088            (properties, (id, mac))
3089        })
3090        .unzip();
3091        let interfaces =
3092            futures::stream::iter(interfaces.into_iter().map(Some).chain(std::iter::once(None)));
3093        let watcher_fut = watcher_stream.zip(interfaces).for_each(|(req, properties)| match req {
3094            finterfaces::WatcherRequest::Watch { responder } => {
3095                let event = properties.map_or(
3096                    finterfaces::Event::Idle(finterfaces::Empty),
3097                    |finterfaces_ext::Properties {
3098                         id,
3099                         name,
3100                         port_class,
3101                         online,
3102                         addresses,
3103                         has_default_ipv4_route,
3104                         has_default_ipv6_route,
3105                         port_identity_koid,
3106                     }| {
3107                        finterfaces::Event::Existing(finterfaces::Properties {
3108                            id: Some(id.get()),
3109                            name: Some(name),
3110                            port_class: Some(port_class.into()),
3111                            online: Some(online),
3112                            addresses: Some(
3113                                addresses.into_iter().map(finterfaces::Address::from).collect(),
3114                            ),
3115                            has_default_ipv4_route: Some(has_default_ipv4_route),
3116                            has_default_ipv6_route: Some(has_default_ipv6_route),
3117                            port_identity_koid: port_identity_koid.map(|p| p.raw_koid()),
3118                            ..Default::default()
3119                        })
3120                    },
3121                );
3122                responder.send(&event).expect("send watcher event");
3123                futures::future::ready(())
3124            }
3125        });
3126        let root_fut = root_interfaces_stream
3127            .map(|res| res.expect("root interfaces stream error"))
3128            .for_each_concurrent(None, |req| {
3129                let (id, responder) = req.into_get_mac().expect("get_mac request");
3130                responder
3131                    .send(
3132                        mac_addresses
3133                            .get(&id.try_into().unwrap())
3134                            .map(Option::as_ref)
3135                            .ok_or(froot::InterfacesGetMacError::NotFound),
3136                    )
3137                    .expect("send get_mac response");
3138                futures::future::ready(())
3139            });
3140        let ((), (), ()) = futures::future::join3(do_if_fut, watcher_fut, root_fut).await;
3141
3142        let got_output = buffers.into_stdout_str();
3143
3144        if json {
3145            let got: Value = serde_json::from_str(&got_output).unwrap();
3146            let want: Value = serde_json::from_str(&wanted_output).unwrap();
3147            pretty_assertions::assert_eq!(got, want);
3148        } else {
3149            pretty_assertions::assert_eq!(
3150                trim_whitespace_for_comparison(&got_output),
3151                trim_whitespace_for_comparison(&wanted_output),
3152            );
3153        }
3154    }
3155
3156    async fn test_do_dhcp(cmd: opts::DhcpEnum) {
3157        let (stack, mut requests) =
3158            fidl::endpoints::create_proxy_and_stream::<fstack::StackMarker>();
3159        let connector = TestConnector { stack: Some(stack), ..Default::default() };
3160        let op = do_dhcp(cmd.clone(), &connector);
3161        let op_succeeds = async move {
3162            let (expected_id, expected_enable) = match cmd {
3163                opts::DhcpEnum::Start(opts::DhcpStart { interface }) => (interface, true),
3164                opts::DhcpEnum::Stop(opts::DhcpStop { interface }) => (interface, false),
3165            };
3166            let request = requests
3167                .try_next()
3168                .await
3169                .expect("start FIDL error")
3170                .expect("request stream should not have ended");
3171            let (received_id, enable, responder) = request
3172                .into_set_dhcp_client_enabled()
3173                .expect("request should be of type StopDhcpClient");
3174            assert_eq!(opts::InterfaceIdentifier::Id(u64::from(received_id)), expected_id);
3175            assert_eq!(enable, expected_enable);
3176            responder.send(Ok(())).map_err(anyhow::Error::new)
3177        };
3178        let ((), ()) =
3179            futures::future::try_join(op, op_succeeds).await.expect("dhcp command should succeed");
3180    }
3181
3182    #[fasync::run_singlethreaded(test)]
3183    async fn dhcp_start() {
3184        test_do_dhcp(opts::DhcpEnum::Start(opts::DhcpStart { interface: 1.into() })).await;
3185    }
3186
3187    #[fasync::run_singlethreaded(test)]
3188    async fn dhcp_stop() {
3189        test_do_dhcp(opts::DhcpEnum::Stop(opts::DhcpStop { interface: 1.into() })).await;
3190    }
3191
3192    async fn test_modify_route(cmd: opts::RouteEnum) {
3193        let expected_interface = match &cmd {
3194            opts::RouteEnum::List(_) => panic!("test_modify_route should not take a List command"),
3195            opts::RouteEnum::Add(opts::RouteAdd { interface, .. }) => interface,
3196            opts::RouteEnum::Del(opts::RouteDel { interface, .. }) => interface,
3197        }
3198        .clone();
3199        let expected_id = match expected_interface {
3200            opts::InterfaceIdentifier::Id(ref id) => *id,
3201            opts::InterfaceIdentifier::Name(_) => {
3202                panic!("expected test to work only with ids")
3203            }
3204        };
3205
3206        let (stack, mut requests) =
3207            fidl::endpoints::create_proxy_and_stream::<fstack::StackMarker>();
3208        let connector = TestConnector { stack: Some(stack), ..Default::default() };
3209        let buffers = writer::TestBuffers::default();
3210        let mut out = writer::JsonWriter::new_test(None, &buffers);
3211        let op = do_route(&mut out, cmd.clone(), &connector);
3212        let op_succeeds = async move {
3213            match cmd {
3214                opts::RouteEnum::List(opts::RouteList {}) => {
3215                    panic!("test_modify_route should not take a List command")
3216                }
3217                opts::RouteEnum::Add(route) => {
3218                    let expected_entry = route.into_route_table_entry(
3219                        expected_id.try_into().expect("nicid does not fit in u32"),
3220                    );
3221                    let (entry, responder) = requests
3222                        .try_next()
3223                        .await
3224                        .expect("add route FIDL error")
3225                        .expect("request stream should not have ended")
3226                        .into_add_forwarding_entry()
3227                        .expect("request should be of type AddRoute");
3228                    assert_eq!(entry, expected_entry);
3229                    responder.send(Ok(()))
3230                }
3231                opts::RouteEnum::Del(route) => {
3232                    let expected_entry = route.into_route_table_entry(
3233                        expected_id.try_into().expect("nicid does not fit in u32"),
3234                    );
3235                    let (entry, responder) = requests
3236                        .try_next()
3237                        .await
3238                        .expect("del route FIDL error")
3239                        .expect("request stream should not have ended")
3240                        .into_del_forwarding_entry()
3241                        .expect("request should be of type DelRoute");
3242                    assert_eq!(entry, expected_entry);
3243                    responder.send(Ok(()))
3244                }
3245            }?;
3246            Ok(())
3247        };
3248        let ((), ()) =
3249            futures::future::try_join(op, op_succeeds).await.expect("dhcp command should succeed");
3250    }
3251
3252    #[fasync::run_singlethreaded(test)]
3253    async fn route_add() {
3254        // Test arguments have been arbitrarily selected.
3255        test_modify_route(opts::RouteEnum::Add(opts::RouteAdd {
3256            destination: std::net::IpAddr::V4(std::net::Ipv4Addr::new(192, 168, 1, 0)),
3257            prefix_len: 24,
3258            gateway: None,
3259            interface: 2.into(),
3260            metric: 100,
3261        }))
3262        .await;
3263    }
3264
3265    #[fasync::run_singlethreaded(test)]
3266    async fn route_del() {
3267        // Test arguments have been arbitrarily selected.
3268        test_modify_route(opts::RouteEnum::Del(opts::RouteDel {
3269            destination: std::net::IpAddr::V4(std::net::Ipv4Addr::new(192, 168, 1, 0)),
3270            prefix_len: 24,
3271            gateway: None,
3272            interface: 2.into(),
3273            metric: 100,
3274        }))
3275        .await;
3276    }
3277
3278    fn wanted_route_list_json() -> String {
3279        json!([
3280            {
3281                "destination":{"addr":"0.0.0.0","prefix_len":0},
3282                "gateway":"127.0.0.1",
3283                "metric":4,
3284                "nicid":3,
3285                "table_id":0,
3286            },
3287            {
3288                "destination":{"addr":"1.1.1.0","prefix_len":24},
3289                "gateway":"1.1.1.2",
3290                "metric":4,
3291                "nicid":3,
3292                "table_id":0,
3293            },
3294            {
3295                "destination":{"addr":"10.10.10.0","prefix_len":24},
3296                "gateway":"10.10.10.20",
3297                "metric":40,
3298                "nicid":30,
3299                "table_id":1,
3300            },
3301            {
3302                "destination":{"addr":"11.11.11.0","prefix_len":28},
3303                "gateway":null,
3304                "metric":40,
3305                "nicid":30,
3306                "table_id":1,
3307            },
3308            {
3309                "destination":{"addr":"ff00::","prefix_len":8},
3310                "gateway":null,
3311                "metric":400,
3312                "nicid":300,
3313                "table_id":2,
3314            },
3315            {
3316                "destination":{"addr":"fe80::","prefix_len":64},
3317                "gateway":null,
3318                "metric":400,
3319                "nicid":300,
3320                "table_id":2,
3321            },
3322        ])
3323        .to_string()
3324    }
3325
3326    fn wanted_route_list_tabular() -> String {
3327        "Destination      Gateway        NICID    Metric    TableId
3328         0.0.0.0/0        127.0.0.1      3        4         0
3329         1.1.1.0/24       1.1.1.2        3        4         0
3330         10.10.10.0/24    10.10.10.20    30       40        1
3331         11.11.11.0/28    -              30       40        1
3332         ff00::/8         -              300      400       2
3333         fe80::/64        -              300      400       2
3334         "
3335        .to_string()
3336    }
3337
3338    #[test_case(true, wanted_route_list_json() ; "in json format")]
3339    #[test_case(false, wanted_route_list_tabular() ; "in tabular format")]
3340    #[fasync::run_singlethreaded(test)]
3341    async fn route_list(json: bool, wanted_output: String) {
3342        let (routes_v4_controller, mut routes_v4_state_stream) =
3343            fidl::endpoints::create_proxy_and_stream::<froutes::StateV4Marker>();
3344        let (routes_v6_controller, mut routes_v6_state_stream) =
3345            fidl::endpoints::create_proxy_and_stream::<froutes::StateV6Marker>();
3346        let connector = TestConnector {
3347            routes_v4: Some(routes_v4_controller),
3348            routes_v6: Some(routes_v6_controller),
3349            ..Default::default()
3350        };
3351
3352        let buffers = writer::TestBuffers::default();
3353        let mut output = if json {
3354            writer::JsonWriter::new_test(Some(writer::Format::Json), &buffers)
3355        } else {
3356            writer::JsonWriter::new_test(None, &buffers)
3357        };
3358
3359        let do_route_fut =
3360            do_route(&mut output, opts::RouteEnum::List(opts::RouteList {}), &connector);
3361
3362        let v4_route_events = vec![
3363            froutes::EventV4::Existing(froutes::InstalledRouteV4 {
3364                route: Some(froutes::RouteV4 {
3365                    destination: net_declare::fidl_ip_v4_with_prefix!("1.1.1.0/24"),
3366                    action: froutes::RouteActionV4::Forward(froutes::RouteTargetV4 {
3367                        outbound_interface: 3,
3368                        next_hop: Some(Box::new(net_declare::fidl_ip_v4!("1.1.1.2"))),
3369                    }),
3370                    properties: froutes::RoutePropertiesV4 {
3371                        specified_properties: Some(froutes::SpecifiedRouteProperties {
3372                            metric: Some(froutes::SpecifiedMetric::ExplicitMetric(4)),
3373                            ..Default::default()
3374                        }),
3375                        ..Default::default()
3376                    },
3377                }),
3378                effective_properties: Some(froutes::EffectiveRouteProperties {
3379                    metric: Some(4),
3380                    ..Default::default()
3381                }),
3382                table_id: Some(0),
3383                ..Default::default()
3384            }),
3385            froutes::EventV4::Existing(froutes::InstalledRouteV4 {
3386                route: Some(froutes::RouteV4 {
3387                    destination: net_declare::fidl_ip_v4_with_prefix!("10.10.10.0/24"),
3388                    action: froutes::RouteActionV4::Forward(froutes::RouteTargetV4 {
3389                        outbound_interface: 30,
3390                        next_hop: Some(Box::new(net_declare::fidl_ip_v4!("10.10.10.20"))),
3391                    }),
3392                    properties: froutes::RoutePropertiesV4 {
3393                        specified_properties: Some(froutes::SpecifiedRouteProperties {
3394                            metric: Some(froutes::SpecifiedMetric::ExplicitMetric(40)),
3395                            ..Default::default()
3396                        }),
3397                        ..Default::default()
3398                    },
3399                }),
3400                effective_properties: Some(froutes::EffectiveRouteProperties {
3401                    metric: Some(40),
3402                    ..Default::default()
3403                }),
3404                table_id: Some(1),
3405                ..Default::default()
3406            }),
3407            froutes::EventV4::Existing(froutes::InstalledRouteV4 {
3408                route: Some(froutes::RouteV4 {
3409                    destination: net_declare::fidl_ip_v4_with_prefix!("0.0.0.0/0"),
3410                    action: froutes::RouteActionV4::Forward(froutes::RouteTargetV4 {
3411                        outbound_interface: 3,
3412                        next_hop: Some(Box::new(net_declare::fidl_ip_v4!("127.0.0.1"))),
3413                    }),
3414                    properties: froutes::RoutePropertiesV4 {
3415                        specified_properties: Some(froutes::SpecifiedRouteProperties {
3416                            metric: Some(froutes::SpecifiedMetric::ExplicitMetric(4)),
3417                            ..Default::default()
3418                        }),
3419                        ..Default::default()
3420                    },
3421                }),
3422                effective_properties: Some(froutes::EffectiveRouteProperties {
3423                    metric: Some(4),
3424                    ..Default::default()
3425                }),
3426                table_id: Some(0),
3427                ..Default::default()
3428            }),
3429            froutes::EventV4::Existing(froutes::InstalledRouteV4 {
3430                route: Some(froutes::RouteV4 {
3431                    destination: net_declare::fidl_ip_v4_with_prefix!("11.11.11.0/28"),
3432                    action: froutes::RouteActionV4::Forward(froutes::RouteTargetV4 {
3433                        outbound_interface: 30,
3434                        next_hop: None,
3435                    }),
3436                    properties: froutes::RoutePropertiesV4 {
3437                        specified_properties: Some(froutes::SpecifiedRouteProperties {
3438                            metric: Some(froutes::SpecifiedMetric::ExplicitMetric(40)),
3439                            ..Default::default()
3440                        }),
3441                        ..Default::default()
3442                    },
3443                }),
3444                effective_properties: Some(froutes::EffectiveRouteProperties {
3445                    metric: Some(40),
3446                    ..Default::default()
3447                }),
3448                table_id: Some(1),
3449                ..Default::default()
3450            }),
3451            froutes::EventV4::Idle(froutes::Empty),
3452        ];
3453        let v6_route_events = vec![
3454            froutes::EventV6::Existing(froutes::InstalledRouteV6 {
3455                route: Some(froutes::RouteV6 {
3456                    destination: net_declare::fidl_ip_v6_with_prefix!("fe80::/64"),
3457                    action: froutes::RouteActionV6::Forward(froutes::RouteTargetV6 {
3458                        outbound_interface: 300,
3459                        next_hop: None,
3460                    }),
3461                    properties: froutes::RoutePropertiesV6 {
3462                        specified_properties: Some(froutes::SpecifiedRouteProperties {
3463                            metric: Some(froutes::SpecifiedMetric::ExplicitMetric(400)),
3464                            ..Default::default()
3465                        }),
3466                        ..Default::default()
3467                    },
3468                }),
3469                effective_properties: Some(froutes::EffectiveRouteProperties {
3470                    metric: Some(400),
3471                    ..Default::default()
3472                }),
3473                table_id: Some(2),
3474                ..Default::default()
3475            }),
3476            froutes::EventV6::Existing(froutes::InstalledRouteV6 {
3477                route: Some(froutes::RouteV6 {
3478                    destination: net_declare::fidl_ip_v6_with_prefix!("ff00::/8"),
3479                    action: froutes::RouteActionV6::Forward(froutes::RouteTargetV6 {
3480                        outbound_interface: 300,
3481                        next_hop: None,
3482                    }),
3483                    properties: froutes::RoutePropertiesV6 {
3484                        specified_properties: Some(froutes::SpecifiedRouteProperties {
3485                            metric: Some(froutes::SpecifiedMetric::ExplicitMetric(400)),
3486                            ..Default::default()
3487                        }),
3488                        ..Default::default()
3489                    },
3490                }),
3491                effective_properties: Some(froutes::EffectiveRouteProperties {
3492                    metric: Some(400),
3493                    ..Default::default()
3494                }),
3495                table_id: Some(2),
3496                ..Default::default()
3497            }),
3498            froutes::EventV6::Idle(froutes::Empty),
3499        ];
3500
3501        let route_v4_fut = routes_v4_state_stream.select_next_some().then(|request| {
3502            froutes_ext::testutil::serve_state_request::<Ipv4>(
3503                request,
3504                futures::stream::once(futures::future::ready(v4_route_events)),
3505            )
3506        });
3507        let route_v6_fut = routes_v6_state_stream.select_next_some().then(|request| {
3508            froutes_ext::testutil::serve_state_request::<Ipv6>(
3509                request,
3510                futures::stream::once(futures::future::ready(v6_route_events)),
3511            )
3512        });
3513
3514        let ((), (), ()) =
3515            futures::try_join!(do_route_fut, route_v4_fut.map(Ok), route_v6_fut.map(Ok))
3516                .expect("listing forwarding table entries should succeed");
3517
3518        let got_output = buffers.into_stdout_str();
3519
3520        if json {
3521            let got: Value = serde_json::from_str(&got_output).unwrap();
3522            let want: Value = serde_json::from_str(&wanted_output).unwrap();
3523            pretty_assertions::assert_eq!(got, want);
3524        } else {
3525            pretty_assertions::assert_eq!(
3526                trim_whitespace_for_comparison(&got_output),
3527                trim_whitespace_for_comparison(&wanted_output),
3528            );
3529        }
3530    }
3531
3532    #[test_case(false ; "providing nicids")]
3533    #[test_case(true ; "providing interface names")]
3534    #[fasync::run_singlethreaded(test)]
3535    async fn bridge(use_ifname: bool) {
3536        let (stack, mut stack_requests) =
3537            fidl::endpoints::create_proxy_and_stream::<fstack::StackMarker>();
3538        let (interfaces_state, interfaces_state_requests) =
3539            fidl::endpoints::create_proxy_and_stream::<finterfaces::StateMarker>();
3540        let connector = TestConnector {
3541            interfaces_state: Some(interfaces_state),
3542            stack: Some(stack),
3543            ..Default::default()
3544        };
3545
3546        let bridge_ifs = vec![
3547            TestInterface { nicid: 1, name: "interface1" },
3548            TestInterface { nicid: 2, name: "interface2" },
3549            TestInterface { nicid: 3, name: "interface3" },
3550        ];
3551
3552        let interface_fidls = bridge_ifs
3553            .iter()
3554            .map(|interface| {
3555                let (interface, _mac) = get_fake_interface(
3556                    interface.nicid,
3557                    interface.name,
3558                    finterfaces_ext::PortClass::Ethernet,
3559                    None,
3560                );
3561                interface.into()
3562            })
3563            .collect::<Vec<_>>();
3564
3565        let interfaces_fut =
3566            always_answer_with_interfaces(interfaces_state_requests, interface_fidls);
3567
3568        let bridge_id = 4;
3569        let buffers = writer::TestBuffers::default();
3570        let mut out = writer::JsonWriter::new_test(None, &buffers);
3571        let bridge = do_if(
3572            &mut out,
3573            opts::IfEnum::Bridge(opts::IfBridge {
3574                interfaces: bridge_ifs
3575                    .iter()
3576                    .map(|interface| interface.identifier(use_ifname))
3577                    .collect(),
3578            }),
3579            &connector,
3580        );
3581
3582        let bridge_succeeds = async move {
3583            let (requested_ifs, bridge_server_end, _control_handle) = stack_requests
3584                .try_next()
3585                .await
3586                .expect("stack requests FIDL error")
3587                .expect("request stream should not have ended")
3588                .into_bridge_interfaces()
3589                .expect("request should be of type BridgeInterfaces");
3590            assert_eq!(
3591                requested_ifs,
3592                bridge_ifs.iter().map(|interface| interface.nicid).collect::<Vec<_>>()
3593            );
3594            let mut bridge_requests = bridge_server_end.into_stream();
3595            let responder = bridge_requests
3596                .try_next()
3597                .await
3598                .expect("bridge requests FIDL error")
3599                .expect("request stream should not have ended")
3600                .into_get_id()
3601                .expect("request should be get_id");
3602            responder.send(bridge_id).expect("responding with bridge ID should succeed");
3603            let _control_handle = bridge_requests
3604                .try_next()
3605                .await
3606                .expect("bridge requests FIDL error")
3607                .expect("request stream should not have ended")
3608                .into_detach()
3609                .expect("request should be detach");
3610            Ok(())
3611        };
3612        futures::select! {
3613            () = interfaces_fut.fuse() => panic!("interfaces_fut should never complete"),
3614            result = futures::future::try_join(bridge, bridge_succeeds).fuse() => {
3615                let ((), ()) = result.expect("if bridge should succeed");
3616            }
3617        }
3618    }
3619
3620    async fn test_get_neigh_entries(
3621        watch_for_changes: bool,
3622        batches: Vec<Vec<fneighbor::EntryIteratorItem>>,
3623        want: String,
3624    ) {
3625        let (it, mut requests) =
3626            fidl::endpoints::create_proxy_and_stream::<fneighbor::EntryIteratorMarker>();
3627
3628        let server = async {
3629            for items in batches {
3630                let responder = requests
3631                    .try_next()
3632                    .await
3633                    .expect("neigh FIDL error")
3634                    .expect("request stream should not have ended")
3635                    .into_get_next()
3636                    .expect("request should be of type GetNext");
3637                responder.send(&items).expect("responder.send should succeed");
3638            }
3639        }
3640        .on_timeout(std::time::Duration::from_secs(60), || panic!("server responder timed out"));
3641
3642        let client = async {
3643            let mut stream = neigh_entry_stream(it, watch_for_changes);
3644
3645            let item_to_string = |item| {
3646                let buffers = writer::TestBuffers::default();
3647                let mut buf = writer::JsonWriter::new_test(None, &buffers);
3648                write_neigh_entry(&mut buf, item, watch_for_changes)
3649                    .expect("write_neigh_entry should succeed");
3650                buffers.into_stdout_str()
3651            };
3652
3653            // Check each string sent by get_neigh_entries
3654            for want_line in want.lines() {
3655                let got = stream
3656                    .next()
3657                    .await
3658                    .map(|item| item_to_string(item.expect("neigh_entry_stream should succeed")));
3659                assert_eq!(got, Some(format!("{}\n", want_line)));
3660            }
3661
3662            // When listing entries, the sender should close after sending all existing entries.
3663            if !watch_for_changes {
3664                match stream.next().await {
3665                    Some(Ok(item)) => {
3666                        panic!("unexpected item from stream: {}", item_to_string(item))
3667                    }
3668                    Some(Err(err)) => panic!("unexpected error from stream: {}", err),
3669                    None => {}
3670                }
3671            }
3672        };
3673
3674        let ((), ()) = futures::future::join(client, server).await;
3675    }
3676
3677    async fn test_neigh_none(watch_for_changes: bool, want: String) {
3678        test_get_neigh_entries(
3679            watch_for_changes,
3680            vec![vec![fneighbor::EntryIteratorItem::Idle(fneighbor::IdleEvent {})]],
3681            want,
3682        )
3683        .await
3684    }
3685
3686    #[fasync::run_singlethreaded(test)]
3687    async fn neigh_list_none() {
3688        test_neigh_none(false /* watch_for_changes */, "".to_string()).await
3689    }
3690
3691    #[fasync::run_singlethreaded(test)]
3692    async fn neigh_watch_none() {
3693        test_neigh_none(true /* watch_for_changes */, "IDLE".to_string()).await
3694    }
3695
3696    fn timestamp_60s_ago() -> i64 {
3697        let now = std::time::SystemTime::now()
3698            .duration_since(std::time::SystemTime::UNIX_EPOCH)
3699            .expect("failed to get duration since epoch");
3700        let past = now - std::time::Duration::from_secs(60);
3701        i64::try_from(past.as_nanos()).expect("failed to convert duration to i64")
3702    }
3703
3704    async fn test_neigh_one(watch_for_changes: bool, want: fn(fneighbor_ext::Entry) -> String) {
3705        fn new_entry(updated_at: i64) -> fneighbor::Entry {
3706            fneighbor::Entry {
3707                interface: Some(1),
3708                neighbor: Some(IF_ADDR_V4.addr),
3709                state: Some(fneighbor::EntryState::Reachable),
3710                mac: Some(MAC_1),
3711                updated_at: Some(updated_at),
3712                ..Default::default()
3713            }
3714        }
3715
3716        let updated_at = timestamp_60s_ago();
3717
3718        test_get_neigh_entries(
3719            watch_for_changes,
3720            vec![vec![
3721                fneighbor::EntryIteratorItem::Existing(new_entry(updated_at)),
3722                fneighbor::EntryIteratorItem::Idle(fneighbor::IdleEvent {}),
3723            ]],
3724            want(fneighbor_ext::Entry::try_from(new_entry(updated_at)).unwrap()),
3725        )
3726        .await
3727    }
3728
3729    #[fasync::run_singlethreaded(test)]
3730    async fn neigh_list_one() {
3731        test_neigh_one(false /* watch_for_changes */, |entry| format!("{}\n", entry)).await
3732    }
3733
3734    #[fasync::run_singlethreaded(test)]
3735    async fn neigh_watch_one() {
3736        test_neigh_one(true /* watch_for_changes */, |entry| {
3737            format!(
3738                "EXISTING | {}\n\
3739                 IDLE\n",
3740                entry
3741            )
3742        })
3743        .await
3744    }
3745
3746    async fn test_neigh_many(
3747        watch_for_changes: bool,
3748        want: fn(fneighbor_ext::Entry, fneighbor_ext::Entry) -> String,
3749    ) {
3750        fn new_entry(
3751            ip: fnet::IpAddress,
3752            mac: fnet::MacAddress,
3753            updated_at: i64,
3754        ) -> fneighbor::Entry {
3755            fneighbor::Entry {
3756                interface: Some(1),
3757                neighbor: Some(ip),
3758                state: Some(fneighbor::EntryState::Reachable),
3759                mac: Some(mac),
3760                updated_at: Some(updated_at),
3761                ..Default::default()
3762            }
3763        }
3764
3765        let updated_at = timestamp_60s_ago();
3766        let offset = i64::try_from(std::time::Duration::from_secs(60).as_nanos())
3767            .expect("failed to convert duration to i64");
3768
3769        test_get_neigh_entries(
3770            watch_for_changes,
3771            vec![vec![
3772                fneighbor::EntryIteratorItem::Existing(new_entry(
3773                    IF_ADDR_V4.addr,
3774                    MAC_1,
3775                    updated_at,
3776                )),
3777                fneighbor::EntryIteratorItem::Existing(new_entry(
3778                    IF_ADDR_V6.addr,
3779                    MAC_2,
3780                    updated_at - offset,
3781                )),
3782                fneighbor::EntryIteratorItem::Idle(fneighbor::IdleEvent {}),
3783            ]],
3784            want(
3785                fneighbor_ext::Entry::try_from(new_entry(IF_ADDR_V4.addr, MAC_1, updated_at))
3786                    .unwrap(),
3787                fneighbor_ext::Entry::try_from(new_entry(
3788                    IF_ADDR_V6.addr,
3789                    MAC_2,
3790                    updated_at - offset,
3791                ))
3792                .unwrap(),
3793            ),
3794        )
3795        .await
3796    }
3797
3798    #[fasync::run_singlethreaded(test)]
3799    async fn neigh_list_many() {
3800        test_neigh_many(false /* watch_for_changes */, |a, b| format!("{}\n{}\n", a, b)).await
3801    }
3802
3803    #[fasync::run_singlethreaded(test)]
3804    async fn neigh_watch_many() {
3805        test_neigh_many(true /* watch_for_changes */, |a, b| {
3806            format!(
3807                "EXISTING | {}\n\
3808                 EXISTING | {}\n\
3809                 IDLE\n",
3810                a, b
3811            )
3812        })
3813        .await
3814    }
3815
3816    fn wanted_neigh_list_json() -> String {
3817        json!({
3818            "interface": 1,
3819            "mac": "01:02:03:04:05:06",
3820            "neighbor": "192.168.0.1",
3821            "state": "REACHABLE",
3822        })
3823        .to_string()
3824    }
3825
3826    fn wanted_neigh_watch_json() -> String {
3827        json!({
3828            "entry": {
3829                "interface": 1,
3830                "mac": "01:02:03:04:05:06",
3831                "neighbor": "192.168.0.1",
3832                "state": "REACHABLE",
3833            },
3834            "state_change_status": "EXISTING",
3835        })
3836        .to_string()
3837    }
3838
3839    #[test_case(true, false, &wanted_neigh_list_json() ; "in json format, not including entry state")]
3840    #[test_case(false, false, "Interface 1 | IP 192.168.0.1 | MAC 01:02:03:04:05:06 | REACHABLE" ; "in tabular format, not including entry state")]
3841    #[test_case(true, true, &wanted_neigh_watch_json() ; "in json format, including entry state")]
3842    #[test_case(false, true, "EXISTING | Interface 1 | IP 192.168.0.1 | MAC 01:02:03:04:05:06 | REACHABLE" ; "in tabular format, including entry state")]
3843    fn neigh_write_entry(json: bool, include_entry_state: bool, wanted_output: &str) {
3844        let entry = fneighbor::EntryIteratorItem::Existing(fneighbor::Entry {
3845            interface: Some(1),
3846            neighbor: Some(IF_ADDR_V4.addr),
3847            state: Some(fneighbor::EntryState::Reachable),
3848            mac: Some(MAC_1),
3849            updated_at: Some(timestamp_60s_ago()),
3850            ..Default::default()
3851        });
3852
3853        let buffers = writer::TestBuffers::default();
3854        let mut output = if json {
3855            writer::JsonWriter::new_test(Some(writer::Format::Json), &buffers)
3856        } else {
3857            writer::JsonWriter::new_test(None, &buffers)
3858        };
3859        write_neigh_entry(&mut output, entry, include_entry_state)
3860            .expect("write_neigh_entry should succeed");
3861        let got_output = buffers.into_stdout_str();
3862        pretty_assertions::assert_eq!(
3863            trim_whitespace_for_comparison(&got_output),
3864            trim_whitespace_for_comparison(wanted_output),
3865        );
3866    }
3867
3868    const INTERFACE_ID: u64 = 1;
3869    const IP_VERSION: fnet::IpVersion = fnet::IpVersion::V4;
3870
3871    #[fasync::run_singlethreaded(test)]
3872    async fn neigh_add() {
3873        let (controller, mut requests) =
3874            fidl::endpoints::create_proxy_and_stream::<fneighbor::ControllerMarker>();
3875        let neigh = do_neigh_add(INTERFACE_ID, IF_ADDR_V4.addr, MAC_1, controller);
3876        let neigh_succeeds = async {
3877            let (got_interface_id, got_ip_address, got_mac, responder) = requests
3878                .try_next()
3879                .await
3880                .expect("neigh FIDL error")
3881                .expect("request stream should not have ended")
3882                .into_add_entry()
3883                .expect("request should be of type AddEntry");
3884            assert_eq!(got_interface_id, INTERFACE_ID);
3885            assert_eq!(got_ip_address, IF_ADDR_V4.addr);
3886            assert_eq!(got_mac, MAC_1);
3887            responder.send(Ok(())).expect("responder.send should succeed");
3888            Ok(())
3889        };
3890        let ((), ()) = futures::future::try_join(neigh, neigh_succeeds)
3891            .await
3892            .expect("neigh add should succeed");
3893    }
3894
3895    #[fasync::run_singlethreaded(test)]
3896    async fn neigh_clear() {
3897        let (controller, mut requests) =
3898            fidl::endpoints::create_proxy_and_stream::<fneighbor::ControllerMarker>();
3899        let neigh = do_neigh_clear(INTERFACE_ID, IP_VERSION, controller);
3900        let neigh_succeeds = async {
3901            let (got_interface_id, got_ip_version, responder) = requests
3902                .try_next()
3903                .await
3904                .expect("neigh FIDL error")
3905                .expect("request stream should not have ended")
3906                .into_clear_entries()
3907                .expect("request should be of type ClearEntries");
3908            assert_eq!(got_interface_id, INTERFACE_ID);
3909            assert_eq!(got_ip_version, IP_VERSION);
3910            responder.send(Ok(())).expect("responder.send should succeed");
3911            Ok(())
3912        };
3913        let ((), ()) = futures::future::try_join(neigh, neigh_succeeds)
3914            .await
3915            .expect("neigh clear should succeed");
3916    }
3917
3918    #[fasync::run_singlethreaded(test)]
3919    async fn neigh_del() {
3920        let (controller, mut requests) =
3921            fidl::endpoints::create_proxy_and_stream::<fneighbor::ControllerMarker>();
3922        let neigh = do_neigh_del(INTERFACE_ID, IF_ADDR_V4.addr, controller);
3923        let neigh_succeeds = async {
3924            let (got_interface_id, got_ip_address, responder) = requests
3925                .try_next()
3926                .await
3927                .expect("neigh FIDL error")
3928                .expect("request stream should not have ended")
3929                .into_remove_entry()
3930                .expect("request should be of type RemoveEntry");
3931            assert_eq!(got_interface_id, INTERFACE_ID);
3932            assert_eq!(got_ip_address, IF_ADDR_V4.addr);
3933            responder.send(Ok(())).expect("responder.send should succeed");
3934            Ok(())
3935        };
3936        let ((), ()) = futures::future::try_join(neigh, neigh_succeeds)
3937            .await
3938            .expect("neigh remove should succeed");
3939    }
3940
3941    #[test_case(opts::dhcpd::DhcpdEnum::Get(opts::dhcpd::Get {
3942            arg: opts::dhcpd::GetArg::Option(
3943                opts::dhcpd::OptionArg {
3944                    name: opts::dhcpd::Option_::SubnetMask(
3945                        opts::dhcpd::SubnetMask { mask: None }) }),
3946        }); "get option")]
3947    #[test_case(opts::dhcpd::DhcpdEnum::Get(opts::dhcpd::Get {
3948            arg: opts::dhcpd::GetArg::Parameter(opts::dhcpd::ParameterArg {
3949                name: opts::dhcpd::Parameter::LeaseLength(
3950                    opts::dhcpd::LeaseLength { default: None, max: None }),
3951            }),
3952        }); "get parameter")]
3953    #[test_case(opts::dhcpd::DhcpdEnum::Set(opts::dhcpd::Set {
3954            arg: opts::dhcpd::SetArg::Option(opts::dhcpd::OptionArg {
3955                name: opts::dhcpd::Option_::SubnetMask(opts::dhcpd::SubnetMask {
3956                    mask: Some(net_declare::std_ip_v4!("255.255.255.0")),
3957                }),
3958            }),
3959        }); "set option")]
3960    #[test_case(opts::dhcpd::DhcpdEnum::Set(opts::dhcpd::Set {
3961            arg: opts::dhcpd::SetArg::Parameter(opts::dhcpd::ParameterArg {
3962                name: opts::dhcpd::Parameter::LeaseLength(
3963                    opts::dhcpd::LeaseLength { max: Some(42), default: Some(42) }),
3964            }),
3965        }); "set parameter")]
3966    #[test_case(opts::dhcpd::DhcpdEnum::List(opts::dhcpd::List { arg:
3967        opts::dhcpd::ListArg::Option(opts::dhcpd::OptionToken {}) }); "list option")]
3968    #[test_case(opts::dhcpd::DhcpdEnum::List(
3969        opts::dhcpd::List { arg: opts::dhcpd::ListArg::Parameter(opts::dhcpd::ParameterToken {}) });
3970        "list parameter")]
3971    #[test_case(opts::dhcpd::DhcpdEnum::Reset(opts::dhcpd::Reset {
3972        arg: opts::dhcpd::ResetArg::Option(opts::dhcpd::OptionToken {}) }); "reset option")]
3973    #[test_case(opts::dhcpd::DhcpdEnum::Reset(
3974        opts::dhcpd::Reset {
3975            arg: opts::dhcpd::ResetArg::Parameter(opts::dhcpd::ParameterToken {}) });
3976        "reset parameter")]
3977    #[test_case(opts::dhcpd::DhcpdEnum::ClearLeases(opts::dhcpd::ClearLeases {}); "clear leases")]
3978    #[test_case(opts::dhcpd::DhcpdEnum::Start(opts::dhcpd::Start {}); "start")]
3979    #[test_case(opts::dhcpd::DhcpdEnum::Stop(opts::dhcpd::Stop {}); "stop")]
3980    #[fasync::run_singlethreaded(test)]
3981    async fn test_do_dhcpd(cmd: opts::dhcpd::DhcpdEnum) {
3982        let (dhcpd, mut requests) =
3983            fidl::endpoints::create_proxy_and_stream::<fdhcp::Server_Marker>();
3984
3985        let connector = TestConnector { dhcpd: Some(dhcpd), ..Default::default() };
3986        let op = do_dhcpd(cmd.clone(), &connector);
3987        let op_succeeds = async move {
3988            let req = requests
3989                .try_next()
3990                .await
3991                .expect("receiving request")
3992                .expect("request stream should not have ended");
3993            match cmd {
3994                opts::dhcpd::DhcpdEnum::Get(opts::dhcpd::Get { arg }) => match arg {
3995                    opts::dhcpd::GetArg::Option(opts::dhcpd::OptionArg { name }) => {
3996                        let (code, responder) =
3997                            req.into_get_option().expect("request should be of type get option");
3998                        assert_eq!(
3999                            <opts::dhcpd::Option_ as Into<fdhcp::OptionCode>>::into(name),
4000                            code
4001                        );
4002                        // We don't care what the value is here, we just need something to give as
4003                        // an argument to responder.send().
4004                        let dummy_result = fdhcp::Option_::SubnetMask(fidl_ip_v4!("255.255.255.0"));
4005                        responder.send(Ok(&dummy_result)).expect("responder.send should succeed");
4006                        Ok(())
4007                    }
4008                    opts::dhcpd::GetArg::Parameter(opts::dhcpd::ParameterArg { name }) => {
4009                        let (param, responder) = req
4010                            .into_get_parameter()
4011                            .expect("request should be of type get parameter");
4012                        assert_eq!(
4013                            <opts::dhcpd::Parameter as Into<fdhcp::ParameterName>>::into(name),
4014                            param
4015                        );
4016                        // We don't care what the value is here, we just need something to give as
4017                        // an argument to responder.send().
4018                        let dummy_result = fdhcp::Parameter::Lease(fdhcp::LeaseLength::default());
4019                        responder.send(Ok(&dummy_result)).expect("responder.send should succeed");
4020                        Ok(())
4021                    }
4022                },
4023                opts::dhcpd::DhcpdEnum::Set(opts::dhcpd::Set { arg }) => match arg {
4024                    opts::dhcpd::SetArg::Option(opts::dhcpd::OptionArg { name }) => {
4025                        let (opt, responder) =
4026                            req.into_set_option().expect("request should be of type set option");
4027                        assert_eq!(<opts::dhcpd::Option_ as Into<fdhcp::Option_>>::into(name), opt);
4028                        responder.send(Ok(())).expect("responder.send should succeed");
4029                        Ok(())
4030                    }
4031                    opts::dhcpd::SetArg::Parameter(opts::dhcpd::ParameterArg { name }) => {
4032                        let (opt, responder) = req
4033                            .into_set_parameter()
4034                            .expect("request should be of type set parameter");
4035                        assert_eq!(
4036                            <opts::dhcpd::Parameter as Into<fdhcp::Parameter>>::into(name),
4037                            opt
4038                        );
4039                        responder.send(Ok(())).expect("responder.send should succeed");
4040                        Ok(())
4041                    }
4042                },
4043                opts::dhcpd::DhcpdEnum::List(opts::dhcpd::List { arg }) => match arg {
4044                    opts::dhcpd::ListArg::Option(opts::dhcpd::OptionToken {}) => {
4045                        let responder = req
4046                            .into_list_options()
4047                            .expect("request should be of type list options");
4048                        responder.send(Ok(&[])).expect("responder.send should succeed");
4049                        Ok(())
4050                    }
4051                    opts::dhcpd::ListArg::Parameter(opts::dhcpd::ParameterToken {}) => {
4052                        let responder = req
4053                            .into_list_parameters()
4054                            .expect("request should be of type list options");
4055                        responder.send(Ok(&[])).expect("responder.send should succeed");
4056                        Ok(())
4057                    }
4058                },
4059                opts::dhcpd::DhcpdEnum::Reset(opts::dhcpd::Reset { arg }) => match arg {
4060                    opts::dhcpd::ResetArg::Option(opts::dhcpd::OptionToken {}) => {
4061                        let responder = req
4062                            .into_reset_options()
4063                            .expect("request should be of type reset options");
4064                        responder.send(Ok(())).expect("responder.send should succeed");
4065                        Ok(())
4066                    }
4067                    opts::dhcpd::ResetArg::Parameter(opts::dhcpd::ParameterToken {}) => {
4068                        let responder = req
4069                            .into_reset_parameters()
4070                            .expect("request should be of type reset parameters");
4071                        responder.send(Ok(())).expect("responder.send should succeed");
4072                        Ok(())
4073                    }
4074                },
4075                opts::dhcpd::DhcpdEnum::ClearLeases(opts::dhcpd::ClearLeases {}) => {
4076                    let responder =
4077                        req.into_clear_leases().expect("request should be of type clear leases");
4078                    responder.send(Ok(())).expect("responder.send should succeed");
4079                    Ok(())
4080                }
4081                opts::dhcpd::DhcpdEnum::Start(opts::dhcpd::Start {}) => {
4082                    let responder =
4083                        req.into_start_serving().expect("request should be of type start serving");
4084                    responder.send(Ok(())).expect("responder.send should succeed");
4085                    Ok(())
4086                }
4087                opts::dhcpd::DhcpdEnum::Stop(opts::dhcpd::Stop {}) => {
4088                    let responder =
4089                        req.into_stop_serving().expect("request should be of type stop serving");
4090                    responder.send().expect("responder.send should succeed");
4091                    Ok(())
4092                }
4093            }
4094        };
4095        let ((), ()) = futures::future::try_join(op, op_succeeds)
4096            .await
4097            .expect("dhcp server command should succeed");
4098    }
4099
4100    #[fasync::run_singlethreaded(test)]
4101    async fn dns_lookup() {
4102        let (lookup, mut requests) =
4103            fidl::endpoints::create_proxy_and_stream::<fname::LookupMarker>();
4104        let connector = TestConnector { name_lookup: Some(lookup), ..Default::default() };
4105
4106        let cmd = opts::dns::DnsEnum::Lookup(opts::dns::Lookup {
4107            hostname: "example.com".to_string(),
4108            ipv4: true,
4109            ipv6: true,
4110            sort: true,
4111        });
4112        let mut output = Vec::new();
4113        let dns_command = do_dns(&mut output, cmd.clone(), &connector)
4114            .map(|result| result.expect("dns command should succeed"));
4115
4116        let handle_request = async move {
4117            let (hostname, options, responder) = requests
4118                .try_next()
4119                .await
4120                .expect("FIDL error")
4121                .expect("request stream should not have ended")
4122                .into_lookup_ip()
4123                .expect("request should be of type LookupIp");
4124            let opts::dns::DnsEnum::Lookup(opts::dns::Lookup {
4125                hostname: want_hostname,
4126                ipv4,
4127                ipv6,
4128                sort,
4129            }) = cmd;
4130            let want_options = fname::LookupIpOptions {
4131                ipv4_lookup: Some(ipv4),
4132                ipv6_lookup: Some(ipv6),
4133                sort_addresses: Some(sort),
4134                ..Default::default()
4135            };
4136            assert_eq!(
4137                hostname, want_hostname,
4138                "received IP lookup request for unexpected hostname"
4139            );
4140            assert_eq!(options, want_options, "received unexpected IP lookup options");
4141
4142            responder
4143                .send(Ok(&fname::LookupResult {
4144                    addresses: Some(vec![fidl_ip!("203.0.113.1"), fidl_ip!("2001:db8::1")]),
4145                    ..Default::default()
4146                }))
4147                .expect("send response");
4148        };
4149        let ((), ()) = futures::future::join(dns_command, handle_request).await;
4150
4151        const WANT_OUTPUT: &str = "
4152203.0.113.1
41532001:db8::1
4154";
4155        let got_output = std::str::from_utf8(&output).unwrap();
4156        pretty_assertions::assert_eq!(
4157            trim_whitespace_for_comparison(got_output),
4158            trim_whitespace_for_comparison(WANT_OUTPUT),
4159        );
4160    }
4161}