switch to camino

Author: sunshowers

Cargo.lock

@@ -11,6 +11,7 @@ categories = ["development-tools::testing"]
 keywords = ["datatest", "data-driven-tests", "test-harness"]
 
 [dependencies]
+camino = "1.1.6"
 libtest-mimic = "0.6.1"
 regex = "1.5.4"
 walkdir = "2.3.2"

Cargo.toml

@@ -30,7 +30,8 @@ harness = false
 2. Call the `datatest_stable::harness!(testfn, root, pattern)` macro with the following
 parameters:
 * `testfn` - The test function to be executed on each matching input. This function must have
-  the type `fn(&Path) -> datatest_stable::Result<()>`
+  the type `fn(&Utf8Path) -> datatest_stable::Result<()>`. (`Utf8Path` is part of the
+  [`camino`](https://docs.rs/camino) library.)
 * `root` - The path to the root directory where the input files (fixtures) live. This path is
   relative to the root of the crate.
 * `pattern` - the regex used to match against and select each file to be tested.
@@ -43,9 +44,9 @@ The three parameters can be repeated if you have multiple sets of data-driven te
 This is an example test. Use it with `harness = false`.
 
 ```rust
-use std::path::Path;
+use datatest_stable::Utf8Path;
 
-fn my_test(path: &Path) -> datatest_stable::Result<()> {
+fn my_test(path: &Utf8Path) -> datatest_stable::Result<()> {
     // ... write test here
 
     Ok(())
@@ -61,8 +62,8 @@ version update; at any time, at least the last 3 stable versions of Rust will be
 
 ## See also
 
-* [`datatest`](https://crates.io/crates/datatest): the original inspiration for this crate,
-  with a better UI and more features but targeting nightly Rust
+* [`datatest`](https://crates.io/crates/datatest): the original inspiration for this crate, with
+  a better UI and more features but targeting nightly Rust
 * [Data-driven testing](https://en.wikipedia.org/wiki/Data-driven_testing)
 
 ## License

README.md

@@ -27,7 +27,8 @@
 //! 2. Call the `datatest_stable::harness!(testfn, root, pattern)` macro with the following
 //! parameters:
 //! * `testfn` - The test function to be executed on each matching input. This function must have
-//!   the type `fn(&Path) -> datatest_stable::Result<()>`
+//!   the type `fn(&Utf8Path) -> datatest_stable::Result<()>`. (`Utf8Path` is part of the
+//!   [`camino`](https://docs.rs/camino) library.)
 //! * `root` - The path to the root directory where the input files (fixtures) live. This path is
 //!   relative to the root of the crate.
 //! * `pattern` - the regex used to match against and select each file to be tested.
@@ -40,9 +41,9 @@
 //! This is an example test. Use it with `harness = false`.
 //!
 //! ```rust
-//! use std::path::Path;
+//! use datatest_stable::Utf8Path;
 //!
-//! fn my_test(path: &Path) -> datatest_stable::Result<()> {
+//! fn my_test(path: &Utf8Path) -> datatest_stable::Result<()> {
 //!     // ... write test here
 //!
 //!     Ok(())
@@ -58,8 +59,8 @@
 //!
 //! # See also
 //!
-//! * [`datatest`](https://crates.io/crates/datatest): the original inspiration for this crate,
-//!   with a better UI and more features but targeting nightly Rust
+//! * [`datatest`](https://crates.io/crates/datatest): the original inspiration for this crate, with
+//!   a better UI and more features but targeting nightly Rust
 //! * [Data-driven testing](https://en.wikipedia.org/wiki/Data-driven_testing)
 
 #![warn(missing_docs)]
@@ -71,4 +72,10 @@ mod utils;
 /// The result type for `datatest-stable` tests.
 pub type Result<T> = std::result::Result<T, Box<dyn std::error::Error>>;
 
+/// A re-export of this type from the `camino` crate, since it forms part of function signatures.
+#[doc(no_inline)]
+pub use camino::Utf8Path;
+
+/// Not part of the public API, just used for macros.
+#[doc(hidden)]
 pub use self::runner::{runner, Requirements};

src/lib.rs

@@ -16,7 +16,7 @@ macro_rules! harness {
                     $crate::Requirements::new(
                         $name,
                         stringify!($name).to_string(),
-                        $root.to_string(),
+                        $root.to_string().into(),
                         $pattern.to_string()
                     )
                 );

src/macros.rs

@@ -4,8 +4,8 @@
 #![allow(clippy::integer_arithmetic)]
 
 use crate::{utils, Result};
+use camino::{Utf8Path, Utf8PathBuf};
 use libtest_mimic::{Arguments, Trial};
-use std::path::Path;
 
 #[doc(hidden)]
 pub fn runner(requirements: &[Requirements]) {
@@ -19,18 +19,18 @@ pub fn runner(requirements: &[Requirements]) {
 
 #[doc(hidden)]
 pub struct Requirements {
-    test: fn(&Path) -> Result<()>,
+    test: fn(&Utf8Path) -> Result<()>,
     test_name: String,
-    root: String,
+    root: Utf8PathBuf,
     pattern: String,
 }
 
 impl Requirements {
     #[doc(hidden)]
     pub fn new(
-        test: fn(&Path) -> Result<()>,
+        test: fn(&Utf8Path) -> Result<()>,
         test_name: String,
-        root: String,
+        root: Utf8PathBuf,
         pattern: String,
     ) -> Self {
         Self {
@@ -44,17 +44,15 @@ impl Requirements {
     /// Scans all files in a given directory, finds matching ones and generates a test descriptor
     /// for each of them.
     fn expand(&self) -> Vec<Trial> {
-        let root = Path::new(&self.root).to_path_buf();
-
         let re = regex::Regex::new(&self.pattern)
             .unwrap_or_else(|_| panic!("invalid regular expression: '{}'", self.pattern));
 
-        let tests: Vec<_> = utils::iterate_directory(&root)
-            .filter_map(|path| {
-                let input_path = path.to_string_lossy();
-                if re.is_match(&input_path) {
+        let tests: Vec<_> = utils::iterate_directory(&self.root)
+            .filter_map(|path_res| {
+                let path = path_res.expect("error while iterating directory");
+                if re.is_match(path.as_str()) {
                     let testfn = self.test;
-                    let name = utils::derive_test_name(&root, &path, &self.test_name);
+                    let name = utils::derive_test_name(&self.root, &path, &self.test_name);
                     Some(Trial::test(name, move || {
                         (testfn)(&path).map_err(|err| format!("{:?}", err).into())
                     }))

src/runner.rs

@@ -1,32 +1,35 @@
 // Copyright (c) The Diem Core Contributors
 // SPDX-License-Identifier: MIT OR Apache-2.0
 
-use std::path::{Path, PathBuf};
+use camino::{Utf8Path, Utf8PathBuf};
 
 /// Helper function to iterate through all the files in the given directory, skipping hidden files,
 /// and return an iterator of their paths.
-pub fn iterate_directory(path: &Path) -> impl Iterator<Item = PathBuf> {
+pub fn iterate_directory(path: &Utf8Path) -> impl Iterator<Item = std::io::Result<Utf8PathBuf>> {
     walkdir::WalkDir::new(path)
         .into_iter()
-        .map(::std::result::Result::unwrap)
-        .filter(|entry| {
-            entry.file_type().is_file()
-                && entry
-                    .file_name()
-                    .to_str()
-                    .map_or(false, |s| !s.starts_with('.')) // Skip hidden files
+        .filter(|res| {
+            // Continue to bubble up all errors to the parent.
+            res.as_ref().map_or(true, |entry| {
+                entry.file_type().is_file()
+                    && entry
+                        .file_name()
+                        .to_str()
+                        .map_or(false, |s| !s.starts_with('.')) // Skip hidden files
+            })
+        })
+        .map(|res| match res {
+            Ok(entry) => {
+                Utf8PathBuf::try_from(entry.into_path()).map_err(|error| error.into_io_error())
+            }
+            Err(error) => Err(error.into()),
         })
-        .map(|entry| entry.path().to_path_buf())
 }
 
-pub fn derive_test_name(root: &Path, path: &Path, test_name: &str) -> String {
-    let relative = path.strip_prefix(root).unwrap_or_else(|_| {
-        panic!(
-            "failed to strip prefix '{}' from path '{}'",
-            root.display(),
-            path.display()
-        )
-    });
+pub fn derive_test_name(root: &Utf8Path, path: &Utf8Path, test_name: &str) -> String {
+    let relative = path
+        .strip_prefix(root)
+        .unwrap_or_else(|_| panic!("failed to strip prefix '{}' from path '{}'", root, path));
 
-    format!("{}::{}", test_name, relative.display())
+    format!("{}::{}", test_name, relative)
 }

src/utils.rs

@@ -1,10 +1,11 @@
 // Copyright (c) The Diem Core Contributors
 // SPDX-License-Identifier: MIT OR Apache-2.0
 
+use camino::Utf8Path;
 use datatest_stable::Result;
-use std::{fs::File, io::Read, path::Path};
+use std::{fs::File, io::Read};
 
-fn test_artifact(path: &Path) -> Result<()> {
+fn test_artifact(path: &Utf8Path) -> Result<()> {
     let mut file = File::open(path)?;
     let mut contents = String::new();
     file.read_to_string(&mut contents)?;