io_conformance_util/
test_harness.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 crate::flags::Rights;
6use fidl::endpoints::create_proxy;
7use {
8    fidl_fuchsia_component as fcomponent, fidl_fuchsia_component_decl as fdecl,
9    fidl_fuchsia_io as fio, fidl_fuchsia_io_test as io_test,
10};
11
12/// Helper struct for connecting to an io1 test harness and running a conformance test on it.
13pub struct TestHarness {
14    /// FIDL proxy to the io1 test harness.
15    pub proxy: io_test::TestHarnessProxy,
16
17    /// Config for the filesystem.
18    pub config: io_test::HarnessConfig,
19
20    /// All [`io_test::Directory`] rights supported by the filesystem.
21    pub dir_rights: Rights,
22
23    /// All [`io_test::File`] rights supported by the filesystem.
24    pub file_rights: Rights,
25
26    /// All [`io_test::ExecutableFile`] rights supported by the filesystem.
27    pub executable_file_rights: Rights,
28}
29
30impl TestHarness {
31    /// Connects to the test harness and returns a `TestHarness` struct.
32    pub async fn new() -> TestHarness {
33        let proxy = connect_to_harness().await;
34        let config = proxy.get_config().await.expect("Could not get config from proxy");
35
36        // Validate configuration options for consistency, disallow invalid combinations.
37        if config.supports_modify_directory {
38            assert!(
39                config.supports_get_token,
40                "GetToken must be supported for testing Rename/Link!"
41            );
42        }
43        if config.supports_append {
44            assert!(config.supports_mutable_file, "Files supporting append must also be mutable.");
45        }
46        if config.supports_truncate {
47            assert!(
48                config.supports_mutable_file,
49                "Files supporting truncate must also be mutable."
50            );
51        }
52
53        // Generate set of supported open rights for each object type.
54        let dir_rights = Rights::new(get_supported_dir_rights(&config));
55        let file_rights = Rights::new(get_supported_file_rights(&config));
56        let executable_file_rights = Rights::new(fio::Rights::READ_BYTES | fio::Rights::EXECUTE);
57
58        TestHarness { proxy, config, dir_rights, file_rights, executable_file_rights }
59    }
60
61    /// Creates a [`fio::DirectoryProxy`] with the given root directory structure.
62    pub fn get_directory(
63        &self,
64        entries: Vec<io_test::DirectoryEntry>,
65        flags: fio::Flags,
66    ) -> fio::DirectoryProxy {
67        let contents: Vec<Option<Box<io_test::DirectoryEntry>>> =
68            entries.into_iter().map(|e| Some(Box::new(e))).collect();
69        let (client, server) = create_proxy::<fio::DirectoryMarker>();
70        self.proxy
71            .create_directory(contents, flags, server)
72            .expect("Cannot get directory from test harness");
73        client
74    }
75
76    /// Helper function which gets service directory from the harness as a [`fio::DirectoryProxy`].
77    /// Requires that the harness supports service directories, otherwise will panic.
78    pub async fn open_service_directory(&self) -> fio::DirectoryProxy {
79        assert!(self.config.supports_services);
80        let client_end = self.proxy.open_service_directory().await.unwrap();
81        client_end.into_proxy()
82    }
83
84    /// Returns the abilities [`io_test::File`] objects should have for the harness.
85    pub fn supported_file_abilities(&self) -> fio::Abilities {
86        let mut abilities = fio::Abilities::READ_BYTES | fio::Abilities::GET_ATTRIBUTES;
87        if self.config.supports_mutable_file {
88            abilities |= fio::Abilities::WRITE_BYTES;
89        }
90        if self.supports_mutable_attrs() {
91            abilities |= fio::Abilities::UPDATE_ATTRIBUTES;
92        }
93        abilities
94    }
95
96    /// Returns the abilities [`io_test::Directory`] objects should have for the harness.
97    pub fn supported_dir_abilities(&self) -> fio::Abilities {
98        if self.config.supports_modify_directory {
99            fio::Abilities::GET_ATTRIBUTES
100                | fio::Abilities::UPDATE_ATTRIBUTES
101                | fio::Abilities::ENUMERATE
102                | fio::Abilities::TRAVERSE
103                | fio::Abilities::MODIFY_DIRECTORY
104        } else {
105            fio::Abilities::GET_ATTRIBUTES | fio::Abilities::ENUMERATE | fio::Abilities::TRAVERSE
106        }
107    }
108
109    /// Returns true if the harness supports at least one mutable attribute, false otherwise.
110    ///
111    /// *NOTE*: To allow testing both the io1 SetAttrs and io2 UpdateAttributes methods, harnesses
112    /// that support mutable attributes must support [`fio::NodeAttributesQuery::CREATION_TIME`]
113    /// and [`fio::NodeAttributesQuery::MODIFICATION_TIME`].
114    pub fn supports_mutable_attrs(&self) -> bool {
115        supports_mutable_attrs(&self.config)
116    }
117}
118
119async fn connect_to_harness() -> io_test::TestHarnessProxy {
120    // Connect to the realm to get access to the outgoing directory for the harness.
121    let (client, server) = zx::Channel::create();
122    fuchsia_component::client::connect_channel_to_protocol::<fcomponent::RealmMarker>(server)
123        .expect("Cannot connect to Realm service");
124    let realm = fcomponent::RealmSynchronousProxy::new(client);
125    // fs_test is the name of the child component defined in the manifest.
126    let child_ref = fdecl::ChildRef { name: "fs_test".to_string(), collection: None };
127    let (client, server) = zx::Channel::create();
128    realm
129        .open_exposed_dir(
130            &child_ref,
131            fidl::endpoints::ServerEnd::<fio::DirectoryMarker>::new(server),
132            zx::MonotonicInstant::INFINITE,
133        )
134        .expect("FIDL error when binding to child in Realm")
135        .expect("Cannot bind to test harness child in Realm");
136
137    let exposed_dir = fio::DirectoryProxy::new(fidl::AsyncChannel::from_channel(client));
138
139    fuchsia_component::client::connect_to_protocol_at_dir_root::<io_test::TestHarnessMarker>(
140        &exposed_dir,
141    )
142    .expect("Cannot connect to test harness protocol")
143}
144
145// Returns the aggregate of all rights that are supported for [`io_test::Directory`] objects.
146// Note that rights are specific to a connection (abilities are properties of the node).
147fn get_supported_dir_rights(config: &io_test::HarnessConfig) -> fio::Rights {
148    fio::R_STAR_DIR
149        | fio::W_STAR_DIR
150        | if config.supports_executable_file { fio::X_STAR_DIR } else { fio::Rights::empty() }
151}
152
153// Returns the aggregate of all rights that are supported for [`io_test::File`] objects.
154// Note that rights are specific to a connection (abilities are properties of the node).
155fn get_supported_file_rights(config: &io_test::HarnessConfig) -> fio::Rights {
156    let mut rights = fio::Rights::READ_BYTES | fio::Rights::GET_ATTRIBUTES;
157    if config.supports_mutable_file {
158        rights |= fio::Rights::WRITE_BYTES;
159    }
160    if supports_mutable_attrs(&config) {
161        rights |= fio::Rights::WRITE_BYTES;
162    }
163    rights
164}
165
166// Returns true if the harness supports at least one mutable attribute, false otherwise.
167//
168// *NOTE*: To allow testing both the io1 SetAttrs and io2 UpdateAttributes methods, harnesses
169// that support mutable attributes must support [`fio::NodeAttributesQuery::CREATION_TIME`]
170// and [`fio::NodeAttributesQuery::MODIFICATION_TIME`].
171fn supports_mutable_attrs(config: &io_test::HarnessConfig) -> bool {
172    let all_mutable_attrs: fio::NodeAttributesQuery = fio::NodeAttributesQuery::ACCESS_TIME
173        | fio::NodeAttributesQuery::MODIFICATION_TIME
174        | fio::NodeAttributesQuery::CREATION_TIME
175        | fio::NodeAttributesQuery::MODE
176        | fio::NodeAttributesQuery::GID
177        | fio::NodeAttributesQuery::UID
178        | fio::NodeAttributesQuery::RDEV;
179    if config.supported_attributes.intersects(all_mutable_attrs) {
180        assert!(
181            config.supported_attributes.contains(
182                fio::NodeAttributesQuery::CREATION_TIME
183                    | fio::NodeAttributesQuery::MODIFICATION_TIME
184            ),
185            "Harnesses must support at least CREATION_TIME if attributes are mutable."
186        );
187        return true;
188    }
189    false
190}
io_conformance_util/test_harness.rs

io_conformance_util/
test_harness.rs
