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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT license.
*/
use std::{
collections::HashSet,
path::{Path, PathBuf},
};
use crate::Any;
/// Shared context for resolving input and output files paths post deserialization.
#[derive(Debug)]
pub struct Checker {
/// Root directories in which to look for files.
///
/// Loading input files will first look to see if the input file is an absolute path.
/// If so, the absolute path will be used.
///
/// Otherwise, the search directories are traversed from beginning to end.
search_directories: Vec<PathBuf>,
/// Root directory (only one permitted) to write output files into
/// and check for output files
output_directory: Option<PathBuf>,
/// The collection of output directories registered so far with the checker.
///
/// This ensures that each job uses a distinct output directory to avoid conflicts.
current_outputs: HashSet<PathBuf>,
/// This crate-private variable is used to store the current input deserialization
/// tag and is referenced when creating new `Any` objects.
///
/// Ensure that the correct tag is present before invoking [`Input::try_deserialize`].
tag: Option<&'static str>,
}
impl Checker {
/// Create a new checker with the list of search directories..
pub(crate) fn new(search_directories: Vec<PathBuf>, output_directory: Option<PathBuf>) -> Self {
Self {
search_directories,
output_directory,
current_outputs: HashSet::new(),
tag: None,
}
}
/// Invoke [`CheckDeserialization`] on `value` and if successful, package it in [`Any`].
pub fn any<T>(&mut self, mut value: T) -> anyhow::Result<Any>
where
T: serde::Serialize + CheckDeserialization + std::fmt::Debug + 'static,
{
value.check_deserialization(self)?;
#[expect(
clippy::expect_used,
reason = "crate infrastructure ensures an untagged Checker is not leaked"
)]
Ok(Any::new(value, self.tag.expect("tag must be set")))
}
/// Return the ordered list of search directories registered with the [`Checker`].
pub fn search_directories(&self) -> &[PathBuf] {
&self.search_directories
}
/// Return the output directory registered with the [`Checker`], if any.
pub fn output_directory(&self) -> Option<&PathBuf> {
self.output_directory.as_ref()
}
/// Register `save_path` as an output directory and resolve `save_path` to an absolute path.
///
/// # NOTE
///
/// The behavior of this function is expected to change in the near future.
pub fn register_output(&mut self, save_path: Option<&Path>) -> anyhow::Result<PathBuf> {
// Check if `save_path` is absolute or relative. If relative, resolve it to an absolute
// path using `self.output_directory.
let resolved_dir = match save_path {
None => {
if let Some(output_dir) = self.output_directory() {
output_dir.clone()
} else {
return Err(anyhow::Error::msg(
"relative save path \"{}\" specified but no output directory was provided",
));
}
}
Some(save_path) => {
if save_path.is_absolute() {
if !(save_path.is_dir()) {
return Err(anyhow::Error::msg(format!(
"absolute save path \"{}\" is not a valid directory",
save_path.display()
)));
}
save_path.to_path_buf()
} else {
// relative path, we concatenate it with the output directory
if let Some(output_dir) = self.output_directory() {
let absolute = output_dir.join(save_path);
if !absolute.is_dir() {
return Err(anyhow::Error::msg(format!(
"relative save path \"{}\" is not a valid directory when combined with output directory \"{}\"",
save_path.display(),
output_dir.display()
)));
}
absolute
} else {
return Err(anyhow::Error::msg(format!(
"relative save path \"{}\" specified but no output directory was provided",
save_path.display()
)));
}
}
}
};
// If the resolved directory already exists - bail.
if !self.current_outputs.insert(resolved_dir.clone()) {
anyhow::bail!(
"output directory {} already being used by another job",
resolved_dir.display()
);
} else {
Ok(resolved_dir)
}
}
/// Try to resolve `path` using the following approach:
///
/// 1. If `path` is absolute - check that it exists and is a valid file. If
/// successful, return `path` unaltered.
///
/// 2. If `path` is relative, work through `self.search_directories()` in order,
/// returning the absolute path first existing file.
pub fn check_path(&self, path: &Path) -> Result<PathBuf, anyhow::Error> {
// Check if the file exists (allowing for relative paths with respect to the current
// directory.
//
// If the path is an absolute path and the file does not exist, then bail.
if path.is_absolute() {
if path.is_file() {
return Ok(path.into());
} else {
return Err(anyhow::Error::msg(format!(
"input file with absolute path \"{}\" either does not exist or is not a file",
path.display()
)));
}
};
// At this point, start searching in the provided directories.
for dir in self.search_directories() {
let absolute = dir.join(path);
if absolute.is_file() {
return Ok(absolute);
}
}
Err(anyhow::Error::msg(format!(
"could not find input file \"{}\" in the search directories \"{:?}\"",
path.display(),
self.search_directories(),
)))
}
pub(crate) fn set_tag(&mut self, tag: &'static str) {
let _ = self.tag.insert(tag);
}
}
/// Perform post-process resolution of input and output files paths.
pub trait CheckDeserialization {
/// Perform any necessary resolution of file paths, returning an error if a problem is
/// discovered.
fn check_deserialization(&mut self, checker: &mut Checker) -> Result<(), anyhow::Error>;
}
///////////
// Tests //
///////////
#[cfg(test)]
mod tests {
use super::*;
use std::fs::{create_dir, File};
#[test]
fn test_constructor() {
let checker = Checker::new(Vec::new(), None);
assert!(checker.search_directories().is_empty());
assert!(checker.output_directory().is_none());
let dir_a: PathBuf = "directory/a".into();
let dir_b: PathBuf = "directory/another/b".into();
let checker = Checker::new(vec![dir_a.clone()], Some(dir_b.clone()));
assert_eq!(checker.search_directories(), vec![dir_a.clone()]);
assert_eq!(checker.output_directory(), Some(&dir_b));
let checker = Checker::new(vec![dir_a.clone(), dir_b.clone()], None);
assert_eq!(
checker.search_directories(),
vec![dir_a.clone(), dir_b.clone()]
);
assert!(checker.output_directory().is_none());
}
#[test]
fn test_check_path() {
// We create a directory that looks like this:
//
// dir/
// file_a.txt
// dir0/
// file_b.txt
// dir1/
// file_c.txt
// dir0/
// file_c.txt
let dir = tempfile::tempdir().unwrap();
let path = dir.path();
File::create(path.join("file_a.txt")).unwrap();
println!("{}", path.join("file_a.txt").is_file());
create_dir(path.join("dir0")).unwrap();
create_dir(path.join("dir1")).unwrap();
create_dir(path.join("dir1/dir0")).unwrap();
File::create(path.join("dir0/file_b.txt")).unwrap();
File::create(path.join("dir1/file_c.txt")).unwrap();
File::create(path.join("dir1/dir0/file_c.txt")).unwrap();
let make_checker = |paths: &[PathBuf]| -> Checker { Checker::new(paths.to_vec(), None) };
// Test absolute path success.
{
let checker = make_checker(&[]);
let absolute = path.join("file_a.txt");
assert_eq!(
checker.check_path(&absolute).unwrap(),
absolute,
"absolute paths should be unmodified if they exist",
);
let absolute = path.join("dir0/file_b.txt");
assert_eq!(
checker.check_path(&absolute).unwrap(),
absolute,
"absolute paths should be unmodified if they exist",
);
}
// Absolute path fail.
{
let checker = make_checker(&[]);
let absolute = path.join("dir0/file_c.txt");
let err = checker.check_path(&absolute).unwrap_err();
let message = err.to_string();
assert!(message.contains("input file with absolute path"));
assert!(message.contains("either does not exist or is not a file"));
}
// Directory search
{
let checker =
make_checker(&[path.join("dir1/dir0"), path.join("dir1"), path.join("dir0")]);
// Directories are searched in order.
let file = &Path::new("file_c.txt");
let resolved = checker.check_path(file).unwrap();
assert_eq!(resolved, path.join("dir1/dir0/file_c.txt"));
let file = &Path::new("file_b.txt");
let resolved = checker.check_path(file).unwrap();
assert_eq!(resolved, path.join("dir0/file_b.txt"));
// Directory search can fail.
let file = &Path::new("file_a.txt");
let err = checker.check_path(file).unwrap_err();
let message = err.to_string();
assert!(message.contains("could not find input file"));
assert!(message.contains("in the search directories"));
// If we give an absolute path, no directory search is performed.
let file = path.join("file_c.txt");
let err = checker.check_path(&file).unwrap_err();
let message = err.to_string();
assert!(message.starts_with("input file with absolute path"));
}
}
}