test_manager_lib/
above_root_capabilities.rs

1// Copyright 2022 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 crate::constants::{
6    HERMETIC_RESOLVER_REALM_NAME, TEST_ROOT_COLLECTION, TEST_TYPE_REALM_MAP, WRAPPER_REALM_NAME,
7};
8use anyhow::{format_err, Error};
9use fuchsia_component_test::error::Error as RealmBuilderError;
10use fuchsia_component_test::{Capability, RealmBuilder, Ref, Route, SubRealmBuilder};
11use std::collections::HashMap;
12use {fidl_fuchsia_component_decl as fdecl, fidl_fuchsia_component_test as ftest};
13
14#[derive(Default)]
15struct CollectionData {
16    capabilities: Vec<ftest::Capability>,
17    required_event_streams: RequiredEventStreams,
18}
19
20#[derive(Default)]
21struct RequiredEventStreams {
22    capability_requested: bool,
23}
24
25impl RequiredEventStreams {
26    fn validate(&self) -> bool {
27        self.capability_requested
28    }
29}
30
31pub struct AboveRootCapabilitiesForTest {
32    collection_data: HashMap<&'static str, CollectionData>,
33}
34
35impl AboveRootCapabilitiesForTest {
36    pub async fn new(manifest_name: &str) -> Result<Self, Error> {
37        let path = format!("/pkg/meta/{}", manifest_name);
38        let file_proxy = fuchsia_fs::file::open_in_namespace(&path, fuchsia_fs::PERM_READABLE)?;
39        let component_decl = fuchsia_fs::file::read_fidl::<fdecl::Component>(&file_proxy).await?;
40        let collection_data = Self::load(component_decl);
41        Ok(Self { collection_data })
42    }
43
44    #[cfg(test)]
45    pub fn new_empty_for_tests() -> Self {
46        let empty_collection_data = HashMap::new();
47        Self { collection_data: empty_collection_data }
48    }
49
50    pub fn validate(&self, collection: &str) -> Result<(), Error> {
51        match self.collection_data.get(collection) {
52            Some(c) if !c.required_event_streams.validate() => {
53                return Err(format_err!(
54                    "The collection `{collection}` must be routed the events \
55                `capability_requested` from `parent` scoped \
56                to it"
57                ));
58            }
59            _ => Ok(()),
60        }
61    }
62
63    pub async fn apply(
64        &self,
65        collection: &str,
66        builder: &RealmBuilder,
67        wrapper_realm: &SubRealmBuilder,
68    ) -> Result<(), RealmBuilderError> {
69        if !self.collection_data.contains_key(collection) {
70            return Ok(());
71        }
72        for capability in &self.collection_data[collection].capabilities {
73            let (capability_for_test_wrapper, capability_for_test_root) =
74                if let ftest::Capability::EventStream(event_stream) = &capability {
75                    let mut test_wrapper_event_stream = event_stream.clone();
76                    test_wrapper_event_stream.scope =
77                        Some(vec![Ref::child(WRAPPER_REALM_NAME).into()]);
78                    let mut test_root_event_stream = event_stream.clone();
79                    test_root_event_stream.scope = Some(vec![
80                        Ref::collection(TEST_ROOT_COLLECTION).into(),
81                        Ref::child(HERMETIC_RESOLVER_REALM_NAME).into(),
82                    ]);
83                    (
84                        ftest::Capability::EventStream(test_wrapper_event_stream),
85                        ftest::Capability::EventStream(test_root_event_stream),
86                    )
87                } else {
88                    (capability.clone(), capability.clone())
89                };
90            builder
91                .add_route(
92                    Route::new()
93                        .capability(capability_for_test_wrapper.clone())
94                        .from(Ref::parent())
95                        .to(wrapper_realm),
96                )
97                .await?;
98            wrapper_realm
99                .add_route(
100                    Route::new()
101                        .capability(capability_for_test_root.clone())
102                        .from(Ref::parent())
103                        .to(Ref::collection(TEST_ROOT_COLLECTION)),
104                )
105                .await?;
106        }
107        Ok(())
108    }
109
110    fn load(decl: fdecl::Component) -> HashMap<&'static str, CollectionData> {
111        let mut collection_data: HashMap<_, _> =
112            TEST_TYPE_REALM_MAP.values().map(|v| (*v, CollectionData::default())).collect();
113        for offer_decl in decl.offers.unwrap_or(vec![]) {
114            match offer_decl {
115                fdecl::Offer::Protocol(fdecl::OfferProtocol {
116                    target: Some(fdecl::Ref::Collection(fdecl::CollectionRef { name })),
117                    target_name: Some(target_name),
118                    ..
119                }) if collection_data.contains_key(name.as_str())
120                    && target_name != "fuchsia.logger.LogSink"
121                    && target_name != "fuchsia.inspect.InspectSink" =>
122                {
123                    collection_data.get_mut(name.as_str()).unwrap().capabilities.push(
124                        Capability::protocol_by_name(target_name)
125                            .availability_same_as_target()
126                            .into(),
127                    );
128                }
129                fdecl::Offer::Directory(fdecl::OfferDirectory {
130                    target: Some(fdecl::Ref::Collection(fdecl::CollectionRef { name })),
131                    target_name: Some(target_name),
132                    ..
133                }) if collection_data.contains_key(name.as_str()) => {
134                    collection_data.get_mut(name.as_str()).unwrap().capabilities.push(
135                        Capability::directory(target_name).availability_same_as_target().into(),
136                    );
137                }
138                fdecl::Offer::Storage(fdecl::OfferStorage {
139                    target: Some(fdecl::Ref::Collection(fdecl::CollectionRef { name })),
140                    target_name: Some(target_name),
141                    ..
142                }) if collection_data.contains_key(name.as_str()) => {
143                    let use_path = format!("/{}", target_name);
144                    collection_data.get_mut(name.as_str()).unwrap().capabilities.push(
145                        Capability::storage(target_name)
146                            .path(use_path)
147                            .availability_same_as_target()
148                            .into(),
149                    );
150                }
151                fdecl::Offer::EventStream(fdecl::OfferEventStream {
152                    target: Some(fdecl::Ref::Collection(fdecl::CollectionRef { name })),
153                    target_name: Some(target_name),
154                    source: Some(source),
155                    scope,
156                    ..
157                }) if collection_data.contains_key(name.as_str()) => {
158                    collection_data
159                        .get_mut(name.as_str())
160                        .unwrap()
161                        .capabilities
162                        .push(Capability::event_stream(target_name.clone()).into());
163
164                    // Keep track of relevant event streams being offered from parent to the
165                    // collection scoped to it.
166                    let coll_ref =
167                        fdecl::Ref::Collection(fdecl::CollectionRef { name: name.clone() });
168                    if target_name == "capability_requested"
169                        && matches!(source, fdecl::Ref::Parent(_))
170                        && scope.map(|s| s.contains(&coll_ref)).unwrap_or(false)
171                    {
172                        let entry = collection_data.get_mut(name.as_str()).unwrap();
173                        entry.required_event_streams.capability_requested =
174                            entry.required_event_streams.capability_requested
175                                || target_name == "capability_requested";
176                    }
177                }
178                fdecl::Offer::Service(fdecl::OfferService {
179                    target: Some(fdecl::Ref::Collection(fdecl::CollectionRef { name })),
180                    target_name: Some(target_name),
181                    ..
182                }) if collection_data.contains_key(name.as_str()) => {
183                    collection_data.get_mut(name.as_str()).unwrap().capabilities.push(
184                        Capability::service_by_name(target_name)
185                            .availability_same_as_target()
186                            .into(),
187                    );
188                }
189                fdecl::Offer::Runner(fdecl::OfferRunner {
190                    target: Some(fdecl::Ref::Collection(fdecl::CollectionRef { name })),
191                    ..
192                })
193                | fdecl::Offer::Resolver(fdecl::OfferResolver {
194                    target: Some(fdecl::Ref::Collection(fdecl::CollectionRef { name })),
195                    ..
196                }) if collection_data.contains_key(name.as_str()) => {
197                    unimplemented!("Runners and resolvers are not supported by realm builder");
198                }
199                _ => {
200                    // Ignore anything else that is not routed to test collections
201                }
202            }
203        }
204        collection_data
205    }
206}
test_manager_lib/above_root_capabilities.rs

test_manager_lib/
above_root_capabilities.rs
