1 // Copyright 2020, The Android Open Source Project
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 //! Implements TempDir which aids in creating an cleaning up temporary directories for testing.
16
17 use std::fs::{create_dir, remove_dir_all};
18 use std::io::ErrorKind;
19 use std::path::{Path, PathBuf};
20 use std::{env::temp_dir, ops::Deref};
21
22 use android_system_keystore2::aidl::android::system::keystore2::IKeystoreService::IKeystoreService;
23
24 pub mod authorizations;
25 pub mod key_generations;
26 pub mod run_as;
27
28 static KS2_SERVICE_NAME: &str = "android.system.keystore2.IKeystoreService/default";
29
30 /// Represents the lifecycle of a temporary directory for testing.
31 #[derive(Debug)]
32 pub struct TempDir {
33 path: std::path::PathBuf,
34 do_drop: bool,
35 }
36
37 impl TempDir {
38 /// Creates a temporary directory with a name of the form <prefix>_NNNNN where NNNNN is a zero
39 /// padded random number with 5 figures. The prefix must not contain file system separators.
40 /// The location of the directory cannot be chosen.
41 /// The directory with all of its content is removed from the file system when the resulting
42 /// object gets dropped.
new(prefix: &str) -> std::io::Result<Self>43 pub fn new(prefix: &str) -> std::io::Result<Self> {
44 let tmp = loop {
45 let mut tmp = temp_dir();
46 let number: u16 = rand::random();
47 tmp.push(format!("{}_{:05}", prefix, number));
48 match create_dir(&tmp) {
49 Err(e) => match e.kind() {
50 ErrorKind::AlreadyExists => continue,
51 _ => return Err(e),
52 },
53 Ok(()) => break tmp,
54 }
55 };
56 Ok(Self { path: tmp, do_drop: true })
57 }
58
59 /// Returns the absolute path of the temporary directory.
path(&self) -> &Path60 pub fn path(&self) -> &Path {
61 &self.path
62 }
63
64 /// Returns a path builder for convenient extension of the path.
65 ///
66 /// ## Example:
67 ///
68 /// ```
69 /// let tdir = TempDir::new("my_test")?;
70 /// let temp_foo_bar = tdir.build().push("foo").push("bar");
71 /// ```
72 /// `temp_foo_bar` derefs to a Path that represents "<tdir.path()>/foo/bar"
build(&self) -> PathBuilder73 pub fn build(&self) -> PathBuilder {
74 PathBuilder(self.path.clone())
75 }
76
77 /// When a test is failing you can set this to false in order to inspect
78 /// the directory structure after the test failed.
79 #[allow(dead_code)]
do_not_drop(&mut self)80 pub fn do_not_drop(&mut self) {
81 println!("Disabled automatic cleanup for: {:?}", self.path);
82 log::info!("Disabled automatic cleanup for: {:?}", self.path);
83 self.do_drop = false;
84 }
85 }
86
87 impl Drop for TempDir {
drop(&mut self)88 fn drop(&mut self) {
89 if self.do_drop {
90 remove_dir_all(&self.path).expect("Cannot delete temporary dir.");
91 }
92 }
93 }
94
95 /// Allows for convenient building of paths from a TempDir. See TempDir.build() for more details.
96 pub struct PathBuilder(PathBuf);
97
98 impl PathBuilder {
99 /// Adds another segment to the end of the path. Consumes, modifies and returns self.
push(mut self, segment: &str) -> Self100 pub fn push(mut self, segment: &str) -> Self {
101 self.0.push(segment);
102 self
103 }
104 }
105
106 impl Deref for PathBuilder {
107 type Target = Path;
108
deref(&self) -> &Self::Target109 fn deref(&self) -> &Self::Target {
110 &self.0
111 }
112 }
113
114 /// Get Keystore2 service.
get_keystore_service() -> binder::Strong<dyn IKeystoreService>115 pub fn get_keystore_service() -> binder::Strong<dyn IKeystoreService> {
116 binder::get_interface(KS2_SERVICE_NAME).unwrap()
117 }
118