1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
// Copyright 2019 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

use anyhow::Error;

use crate::factory_store::types::{FactoryStoreProvider, ListFilesRequest, ReadFileRequest};

use base64::engine::{general_purpose::STANDARD as BASE64_STANDARD, Engine as _};
use fidl::endpoints::create_proxy;
use fidl_fuchsia_factory::{
    AlphaFactoryStoreProviderMarker, CastCredentialsFactoryStoreProviderMarker,
    MiscFactoryStoreProviderMarker, PlayReadyFactoryStoreProviderMarker,
    WeaveFactoryStoreProviderMarker, WidevineFactoryStoreProviderMarker,
};
use fidl_fuchsia_io as fio;
use fuchsia_component::client::connect_to_protocol;
use fuchsia_fs::directory::{readdir_recursive, DirentKind};
use futures::stream::TryStreamExt;
use serde_json::{from_value, to_value, Value};

/// Facade providing access to FactoryStoreProvider interfaces.
#[derive(Debug)]
pub struct FactoryStoreFacade;
impl FactoryStoreFacade {
    pub fn new() -> Self {
        FactoryStoreFacade {}
    }

    /// Lists the files from a given provider.
    ///
    /// # Arguments
    /// * `args`: A serde_json Value with the following format:
    /// ```json
    /// {
    ///   "provider": string
    /// }
    /// ```
    ///
    /// The provider string is expected to be a value from
    /// `types::FactoryStoreProvider`.
    pub async fn list_files(&self, args: Value) -> Result<Value, Error> {
        let req: ListFilesRequest = from_value(args)?;
        let dir_proxy = self.get_directory_for_provider(req.provider)?;

        let mut file_paths = Vec::new();
        let mut stream = readdir_recursive(&dir_proxy, /*timeout=*/ None);
        while let Some(entry) = stream.try_next().await? {
            if entry.kind == DirentKind::File {
                file_paths.push(entry.name);
            }
        }

        Ok(to_value(file_paths)?)
    }

    /// Reads a file from the given provider.
    ///
    /// # Arguments
    /// * `args`: A serde_json Value with the following format:
    ///
    /// ```json
    /// {
    ///   "provider": string,
    ///   "filename": string
    /// }
    /// ```
    ///
    /// The provider string is expected to match the serialized string of a
    /// value from `types::FactoryStoreProvider`. The filename string is
    /// expected to be a relative file path.
    pub async fn read_file(&self, args: Value) -> Result<Value, Error> {
        let req: ReadFileRequest = from_value(args)?;
        let dir_proxy = self.get_directory_for_provider(req.provider)?;

        let file = fuchsia_fs::directory::open_file_no_describe(
            &dir_proxy,
            &req.filename,
            fio::OpenFlags::RIGHT_READABLE,
        )?;
        let contents = fuchsia_fs::file::read(&file).await?;
        Ok(to_value(BASE64_STANDARD.encode(&contents))?)
    }

    /// Gets a `DirectoryProxy` that is connected to the given `provider`.
    ///
    /// # Arguments
    /// * `provider`: The factory store provider that the directory connects to.
    fn get_directory_for_provider(
        &self,
        provider: FactoryStoreProvider,
    ) -> Result<fio::DirectoryProxy, Error> {
        let (dir_proxy, dir_server_end) = create_proxy::<fio::DirectoryMarker>()?;

        match provider {
            FactoryStoreProvider::Alpha => {
                let alpha_svc = connect_to_protocol::<AlphaFactoryStoreProviderMarker>()?;
                alpha_svc.get_factory_store(dir_server_end)?;
            }
            FactoryStoreProvider::Cast => {
                let cast_svc = connect_to_protocol::<CastCredentialsFactoryStoreProviderMarker>()?;
                cast_svc.get_factory_store(dir_server_end)?;
            }
            FactoryStoreProvider::Misc => {
                let misc_svc = connect_to_protocol::<MiscFactoryStoreProviderMarker>()?;
                misc_svc.get_factory_store(dir_server_end)?;
            }
            FactoryStoreProvider::Playready => {
                let playready_svc = connect_to_protocol::<PlayReadyFactoryStoreProviderMarker>()?;
                playready_svc.get_factory_store(dir_server_end)?;
            }
            FactoryStoreProvider::Weave => {
                let weave_svc = connect_to_protocol::<WeaveFactoryStoreProviderMarker>()?;
                weave_svc.get_factory_store(dir_server_end)?;
            }
            FactoryStoreProvider::Widevine => {
                let widevine_svc = connect_to_protocol::<WidevineFactoryStoreProviderMarker>()?;
                widevine_svc.get_factory_store(dir_server_end)?;
            }
        }

        Ok(dir_proxy)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use fuchsia_async as fasync;
    use lazy_static::lazy_static;
    use maplit::hashmap;
    use serde_json::json;
    use std::collections::HashMap;

    lazy_static! {
        static ref GOLDEN_FILE_DATA: HashMap<&'static str, HashMap<&'static str, &'static str>> = hashmap! {
            "alpha" => hashmap! {
                "alpha.file" => "alpha info",
                "alpha/data" => "alpha data"
            },
            "cast" => hashmap! {
                "txt/info.txt" => "cast info.txt",
                "more.extra" => "extra cast stuff",
            },
            "misc" => hashmap! {
                "info/misc" => "misc.info",
                "more.misc" => "more misc stuff"
            },
            "playready" => hashmap! {
                "pr/pr/prinfo.dat" => "playready info",
                "dat.stuff" => "playready stuff"
            },
            "weave" => hashmap! {
                "weave.file" => "weave info",
                "weave/data" => "weave data"
            },
            "widevine" => hashmap! {
                "stuff.log" => "widevine stuff",
                "wv/more_stuff" => "more_stuff from widevine",
            }
        };
    }

    #[fasync::run_singlethreaded(test)]
    async fn list_files_with_no_message_fails() -> Result<(), Error> {
        let factory_store_facade = FactoryStoreFacade::new();
        factory_store_facade.list_files(json!("")).await.unwrap_err();
        Ok(())
    }

    #[fasync::run_singlethreaded(test)]
    async fn list_files_with_unknown_provider_fails() -> Result<(), Error> {
        let factory_store_facade = FactoryStoreFacade::new();
        factory_store_facade.list_files(json!({ "provider": "unknown" })).await.unwrap_err();
        Ok(())
    }

    #[fasync::run_singlethreaded(test)]
    async fn list_files() -> Result<(), Error> {
        let factory_store_facade = FactoryStoreFacade::new();

        for (provider, file_map) in GOLDEN_FILE_DATA.iter() {
            let file_list_json_value =
                factory_store_facade.list_files(json!({ "provider": provider })).await?;

            let mut file_list: Vec<String> = from_value(file_list_json_value)?;
            #[allow(suspicious_double_ref_op)] // TODO(https://fxbug.dev/42176996)
            let mut expected_file_list: Vec<&str> =
                file_map.keys().map(|entry| entry.clone()).collect();

            expected_file_list.sort();
            file_list.sort();
            assert_eq!(expected_file_list, file_list);
        }

        Ok(())
    }

    #[fasync::run_singlethreaded(test)]
    async fn read_file_with_unknown_provider_fails() -> Result<(), Error> {
        let factory_store_facade = FactoryStoreFacade::new();
        factory_store_facade
            .read_file(json!({ "provider": "unknown", "filename": "missing_file"  }))
            .await
            .unwrap_err();
        Ok(())
    }

    #[fasync::run_singlethreaded(test)]
    async fn read_file_with_unknown_file_fails() -> Result<(), Error> {
        let factory_store_facade = FactoryStoreFacade::new();
        factory_store_facade
            .read_file(json!({ "provider": "cast", "filename": "missing_file"  }))
            .await
            .unwrap_err();
        Ok(())
    }

    #[fasync::run_singlethreaded(test)]
    async fn read_files() -> Result<(), Error> {
        let factory_store_facade = FactoryStoreFacade::new();

        for (provider, file_map) in GOLDEN_FILE_DATA.iter() {
            for (filename, expected_contents) in file_map.iter() {
                let contents_value = factory_store_facade
                    .read_file(json!({ "provider": provider, "filename": filename }))
                    .await?;
                let contents_base64: String = from_value(contents_value)?;
                let contents = BASE64_STANDARD.decode(contents_base64.as_bytes())?;
                assert_eq!(expected_contents.as_bytes(), &contents[..]);
            }
        }
        Ok(())
    }
}