fuchsia_driver_test/
lib.rs

1// Copyright 2021 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
5use anyhow::{Context as _, Result};
6use fuchsia_component_test::{Capability, ChildOptions, RealmBuilder, RealmInstance, Ref, Route};
7use {
8    fidl_fuchsia_component_test as ftest, fidl_fuchsia_driver_test as fdt, fidl_fuchsia_io as fio,
9};
10
11pub const COMPONENT_NAME: &str = "driver_test_realm";
12pub const DRIVER_TEST_REALM_URL: &str = "#meta/driver_test_realm.cm";
13
14#[async_trait::async_trait]
15pub trait DriverTestRealmBuilder {
16    /// Set up the DriverTestRealm component in the RealmBuilder realm.
17    /// This configures proper input/output routing of capabilities.
18    /// This takes a `manifest_url` to use, which is used by tests that need to
19    /// specify a custom driver test realm.
20    async fn driver_test_realm_manifest_setup(&self, manifest_url: &str) -> Result<&Self>;
21    /// Set up the DriverTestRealm component in the RealmBuilder realm.
22    /// This configures proper input/output routing of capabilities.
23    async fn driver_test_realm_setup(&self) -> Result<&Self>;
24
25    /// For use in conjunction with `fuchsia.driver.test.RealmArgs/dtr_exposes` defined in
26    /// `sdk/fidl/fuchsia.driver.test/realm.fidl`.
27    /// Whenever a dtr_exposes is going to be provided to the RealmArgs, the user MUST call this
28    /// function with a reference to the same dtr_exposes vector it intends to use. This will
29    /// setup the necessary expose declarations inside the driver test realm and add the necessary
30    /// realm_builder routes to support it.
31    async fn driver_test_realm_add_dtr_exposes(
32        &self,
33        dtr_exposes: &Vec<ftest::Capability>,
34    ) -> Result<&Self>;
35
36    /// For use in conjunction with `fuchsia.driver.test.RealmArgs/dtr_offers` defined in
37    /// `sdk/fidl/fuchsia.driver.test/realm.fidl`.
38    /// Whenever a dtr_offers is going to be provided to the RealmArgs, the user MUST call this
39    /// function with a reference to the same dtr_offers vector it intends to use. This will
40    /// setup the necessary offers declarations inside the driver test realm and add the necessary
41    /// realm_builder routes to support it.
42    async fn driver_test_realm_add_dtr_offers(
43        &self,
44        dtr_offers: &Vec<ftest::Capability>,
45        from: Ref,
46    ) -> Result<&Self>;
47}
48
49#[async_trait::async_trait]
50impl DriverTestRealmBuilder for RealmBuilder {
51    async fn driver_test_realm_manifest_setup(&self, manifest_url: &str) -> Result<&Self> {
52        let driver_realm =
53            self.add_child(COMPONENT_NAME, manifest_url, ChildOptions::new().eager()).await?;
54
55        // Keep the rust and c++ realm_builders in sync with the driver_test_realm manifest.
56        // LINT.IfChange
57        // Uses from the driver_test_realm manifest.
58        self.add_route(
59            Route::new()
60                .capability(Capability::protocol_by_name("fuchsia.logger.LogSink"))
61                .capability(Capability::protocol_by_name("fuchsia.inspect.InspectSink"))
62                .capability(Capability::protocol_by_name("fuchsia.diagnostics.ArchiveAccessor"))
63                .capability(Capability::protocol_by_name(
64                    "fuchsia.component.resolution.Resolver-hermetic",
65                ))
66                .capability(Capability::protocol_by_name("fuchsia.pkg.PackageResolver-hermetic"))
67                .capability(Capability::dictionary("diagnostics"))
68                .from(Ref::parent())
69                .to(&driver_realm),
70        )
71        .await?;
72        // Exposes from the the driver_test_realm manifest.
73        self.add_route(
74            Route::new()
75                .capability(Capability::directory("dev-class").rights(fio::R_STAR_DIR))
76                .capability(Capability::directory("dev-topological").rights(fio::R_STAR_DIR))
77                .capability(Capability::protocol_by_name("fuchsia.system.state.Administrator"))
78                .capability(Capability::protocol_by_name("fuchsia.driver.development.Manager"))
79                .capability(Capability::protocol_by_name(
80                    "fuchsia.driver.framework.CompositeNodeManager",
81                ))
82                .capability(Capability::protocol_by_name(
83                    "fuchsia.driver.registrar.DriverRegistrar",
84                ))
85                .capability(Capability::protocol_by_name("fuchsia.driver.test.Realm"))
86                .from(&driver_realm)
87                .to(Ref::parent()),
88        )
89        .await?;
90        // LINT.ThenChange(/sdk/lib/driver_test_realm/realm_builder/cpp/lib.cc)
91        Ok(&self)
92    }
93
94    async fn driver_test_realm_setup(&self) -> Result<&Self> {
95        self.driver_test_realm_manifest_setup(DRIVER_TEST_REALM_URL).await
96    }
97
98    async fn driver_test_realm_add_dtr_exposes(
99        &self,
100        dtr_exposes: &Vec<ftest::Capability>,
101    ) -> Result<&Self> {
102        let mut decl = self.get_component_decl(COMPONENT_NAME).await?;
103        for expose in dtr_exposes {
104            let name = match expose {
105                fidl_fuchsia_component_test::Capability::Protocol(p) => p.name.as_ref(),
106                fidl_fuchsia_component_test::Capability::Directory(d) => d.name.as_ref(),
107                fidl_fuchsia_component_test::Capability::Storage(s) => s.name.as_ref(),
108                fidl_fuchsia_component_test::Capability::Service(s) => s.name.as_ref(),
109                fidl_fuchsia_component_test::Capability::EventStream(e) => e.name.as_ref(),
110                fidl_fuchsia_component_test::Capability::Config(c) => c.name.as_ref(),
111                fidl_fuchsia_component_test::Capability::Dictionary(d) => d.name.as_ref(),
112                _ => None,
113            };
114            let expose_parsed = name
115                .expect("No name found in capability.")
116                .parse::<cm_types::Name>()
117                .expect("Not a valid capability name");
118
119            decl.exposes.push(cm_rust::ExposeDecl::Service(cm_rust::ExposeServiceDecl {
120                source: cm_rust::ExposeSource::Collection(
121                    "realm_builder".parse::<cm_types::Name>().unwrap(),
122                ),
123                source_name: expose_parsed.clone(),
124                source_dictionary: Default::default(),
125                target_name: expose_parsed.clone(),
126                target: cm_rust::ExposeTarget::Parent,
127                availability: cm_rust::Availability::Required,
128            }));
129        }
130        self.replace_component_decl(COMPONENT_NAME, decl).await?;
131
132        for expose in dtr_exposes {
133            // Add the route through the realm builder.
134            self.add_route(
135                Route::new()
136                    .capability(expose.clone())
137                    .from(Ref::child(COMPONENT_NAME))
138                    .to(Ref::parent()),
139            )
140            .await?;
141        }
142
143        Ok(&self)
144    }
145
146    async fn driver_test_realm_add_dtr_offers(
147        &self,
148        dtr_offers: &Vec<ftest::Capability>,
149        from: Ref,
150    ) -> Result<&Self> {
151        let mut decl = self.get_component_decl(COMPONENT_NAME).await?;
152        for offer in dtr_offers {
153            let name = match offer {
154                fidl_fuchsia_component_test::Capability::Protocol(p) => p.name.as_ref(),
155                fidl_fuchsia_component_test::Capability::Directory(d) => d.name.as_ref(),
156                fidl_fuchsia_component_test::Capability::Storage(s) => s.name.as_ref(),
157                fidl_fuchsia_component_test::Capability::Service(s) => s.name.as_ref(),
158                fidl_fuchsia_component_test::Capability::EventStream(e) => e.name.as_ref(),
159                fidl_fuchsia_component_test::Capability::Config(c) => c.name.as_ref(),
160                fidl_fuchsia_component_test::Capability::Dictionary(d) => d.name.as_ref(),
161                _ => None,
162            };
163            let offer_parsed = name
164                .expect("No name found in capability.")
165                .parse::<cm_types::Name>()
166                .expect("Not a valid capability name");
167
168            decl.offers.push(cm_rust::OfferDecl::Protocol(cm_rust::OfferProtocolDecl {
169                source: cm_rust::OfferSource::Parent,
170                source_name: offer_parsed.clone(),
171                source_dictionary: Default::default(),
172                target_name: offer_parsed.clone(),
173                target: cm_rust::OfferTarget::Collection(
174                    "realm_builder".parse::<cm_types::Name>().unwrap(),
175                ),
176                dependency_type: cm_rust::DependencyType::Strong,
177                availability: cm_rust::Availability::Required,
178            }));
179        }
180        self.replace_component_decl(COMPONENT_NAME, decl).await?;
181
182        for offer in dtr_offers {
183            // Add the route through the realm builder.
184            self.add_route(
185                Route::new()
186                    .capability(offer.clone())
187                    .from(from.clone())
188                    .to(Ref::child(COMPONENT_NAME)),
189            )
190            .await?;
191        }
192
193        Ok(&self)
194    }
195}
196
197#[async_trait::async_trait]
198pub trait DriverTestRealmInstance {
199    /// Connect to the DriverTestRealm in this Instance and call Start with `args`.
200    async fn driver_test_realm_start(&self, args: fdt::RealmArgs) -> Result<()>;
201
202    /// Connect to the /dev/ directory hosted by  DriverTestRealm in this Instance.
203    fn driver_test_realm_connect_to_dev(&self) -> Result<fio::DirectoryProxy>;
204}
205
206#[async_trait::async_trait]
207impl DriverTestRealmInstance for RealmInstance {
208    async fn driver_test_realm_start(&self, args: fdt::RealmArgs) -> Result<()> {
209        let config = self.root.connect_to_protocol_at_exposed_dir::<fdt::RealmMarker>()?;
210        let () = config
211            .start(args)
212            .await
213            .context("DriverTestRealm Start failed")?
214            .map_err(zx_status::Status::from_raw)
215            .context("DriverTestRealm Start failed")?;
216        Ok(())
217    }
218
219    fn driver_test_realm_connect_to_dev(&self) -> Result<fio::DirectoryProxy> {
220        fuchsia_fs::directory::open_directory_async(
221            self.root.get_exposed_dir(),
222            "dev-topological",
223            fio::Flags::empty(),
224        )
225        .map_err(Into::into)
226    }
227}
fuchsia_driver_test/lib.rs

fuchsia_driver_test/
lib.rs
