.github/workflows/ci.yml

@@ -20,13 +20,13 @@ jobs:
       - uses: dtolnay/rust-toolchain@stable
         with:
           components: rustfmt, clippy
-      - uses: Swatinem/rust-cache@82a92a6e8fbeee089604da2575dc567ae9ddeaab # v2
+      - uses: Swatinem/rust-cache@720f7e45ccee46c12a7b1d7bed2ab733be9be5a1 # v2
       - name: Lint (clippy)
         run: cargo clippy --all-features --all-targets
       - name: Lint (rustfmt)
         run: cargo xfmt --check
       - name: Install cargo-sync-rdme and just
-        uses: taiki-e/install-action@8484225d9734e230a8bf38421a4ffec1cc249372 # v2
+        uses: taiki-e/install-action@63f2419bb6a642b9973690fd13cf07b750f65635 # v2
         with:
           tool: cargo-sync-rdme,just
       - name: Install nightly toolchain for cargo-sync-rdme
@@ -48,7 +48,7 @@ jobs:
       - uses: dtolnay/rust-toolchain@stable
         with:
           components: rustfmt, clippy
-      - uses: Swatinem/rust-cache@82a92a6e8fbeee089604da2575dc567ae9ddeaab # v2
+      - uses: Swatinem/rust-cache@720f7e45ccee46c12a7b1d7bed2ab733be9be5a1 # v2
       - name: Build rustdoc
         run: cargo doc --all-features
 
@@ -67,11 +67,11 @@ jobs:
       - uses: dtolnay/rust-toolchain@master
         with:
           toolchain: ${{ matrix.rust-version }}
-      - uses: Swatinem/rust-cache@82a92a6e8fbeee089604da2575dc567ae9ddeaab # v2
+      - uses: Swatinem/rust-cache@720f7e45ccee46c12a7b1d7bed2ab733be9be5a1 # v2
         with:
           key: ${{ matrix.rust-version }}
       - name: Install tools
-        uses: taiki-e/install-action@8484225d9734e230a8bf38421a4ffec1cc249372 # v2
+        uses: taiki-e/install-action@63f2419bb6a642b9973690fd13cf07b750f65635 # v2
         with:
           tool: cargo-hack,just,nextest
       - name: Build

.github/workflows/coverage.yml

@@ -23,10 +23,10 @@ jobs:
       - uses: dtolnay/rust-toolchain@nightly
         with:
           components: llvm-tools-preview
-      - uses: Swatinem/rust-cache@82a92a6e8fbeee089604da2575dc567ae9ddeaab # v2
+      - uses: Swatinem/rust-cache@720f7e45ccee46c12a7b1d7bed2ab733be9be5a1 # v2
 
       - name: Install tools
-        uses: taiki-e/install-action@8484225d9734e230a8bf38421a4ffec1cc249372 # v2
+        uses: taiki-e/install-action@63f2419bb6a642b9973690fd13cf07b750f65635 # v2
         with:
           tool: cargo-llvm-cov,just,nextest
 

.github/workflows/release.yml

@@ -17,10 +17,10 @@ jobs:
       - name: Install Rust
         uses: dtolnay/rust-toolchain@stable
       - name: Install cargo release
-        uses: taiki-e/install-action@8484225d9734e230a8bf38421a4ffec1cc249372 # v2
+        uses: taiki-e/install-action@63f2419bb6a642b9973690fd13cf07b750f65635 # v2
         with:
           tool: cargo-release@0.25.0
-      - uses: taiki-e/create-gh-release-action@72d65cee1f8033ef0c8b5d79eaf0c45c7c578ce3 # v1
+      - uses: taiki-e/create-gh-release-action@b7abb0cf5e72cb5500307b577f9ca3fd4c5be9d2 # v1
         with:
           prefix: datatest-stable
           changelog: CHANGELOG.md

CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [0.3.2] - 2024-12-28
+
+### Added
+
+- `pattern` is now optional in the `harness!` macro. If not specified, the default pattern is
+  `r".*"` (match all files).
+
+### Fixed
+
+- Restored the ability to use absolute paths as the `root` argument.
+
+## [0.3.1] - 2024-12-25
+
+### Fixed
+
+Fixed documentation for `include_dir` invocations. They must typically be called
+via `include_dir!("$CARGO_MANIFEST_DIR/path/to/data")`.
+
 ## [0.3.0] - 2024-12-24
 
 ### Added
@@ -62,6 +80,7 @@ Previously, the test functions supported were `fn(&Path) -> Result<()>` and `fn(
 - Switched to the `fancy-regex` crate, which allows for matching against regexes with
   lookahead/behind and backreferences. Thanks [@webbdays](https://github.com/webbdays) for your
   first contribution!
+
 - MSRV updated to Rust 1.66.
 
 ## [0.2.6] - 2024-04-09
@@ -143,6 +162,8 @@ There are no functional changes in this release.
 
 (Version 0.1.0 was yanked because of a metadata issue.)
 
+[0.3.2]: https://github.com/nextest-rs/datatest-stable/releases/tag/datatest-stable-0.3.2
+[0.3.1]: https://github.com/nextest-rs/datatest-stable/releases/tag/datatest-stable-0.3.1
 [0.3.0]: https://github.com/nextest-rs/datatest-stable/releases/tag/datatest-stable-0.3.0
 [0.2.10]: https://github.com/nextest-rs/datatest-stable/releases/tag/datatest-stable-0.2.10
 [0.2.9]: https://github.com/nextest-rs/datatest-stable/releases/tag/datatest-stable-0.2.9

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "datatest-stable"
-version = "0.3.0"
+version = "0.3.2"
 description = "Data-driven tests that work on stable Rust"
 repository = "https://github.com/nextest-rs/datatest-stable"
 license = "MIT OR Apache-2.0"
@@ -36,7 +36,7 @@ libtest-mimic = "0.8.1"
 walkdir = "2.5.0"
 
 [dev-dependencies]
-trybuild = "1.0.101"
+trybuild = "1.0.104"
 
 [target.'cfg(unix)'.dev-dependencies]
 camino-tempfile = "1.1.1"

README.md

@@ -40,7 +40,7 @@ harness = false
 
 ````rust,ignore
 datatest_stable::harness! {
-    { test = my_test, root = "path/to/fixtures", pattern = r"^.*/*" },
+    { test = my_test, root = "path/to/fixtures", pattern = r".*" },
 }
 ````
 
@@ -57,9 +57,8 @@ datatest_stable::harness! {
     extra `Vec<u8>` parameter is specified, the contents of the file will be loaded and passed
     in as a `Vec<u8>` (erroring out if that failed).
 * `root` - The path to the root directory where the input files (fixtures)
-  live. This path is relative to the root of the crate (the directory where
-  the crate’s `Cargo.toml` is located). Absolute paths are not supported, and
-  will panic at runtime.
+  live. Relative paths are resolved relative to the crate root (the directory where the crate’s
+  `Cargo.toml` is located).
 
   `root` is an arbitrary expression that implements
   [`Display`](https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html), such as `&str`, or a function call that
@@ -70,27 +69,34 @@ datatest_stable::harness! {
 
   `pattern` is an arbitrary expression that implements [`Display`](https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html), such as
   `&str`, or a function call that returns a `String`.
+
+  `pattern` is optional, and defaults to `r".*"` (match all files).
 
 The three parameters can be repeated if you have multiple sets of data-driven tests to be run:
 
 ````rust,ignore
 datatest_stable::harness! {
     { test = testfn1, root = root1, pattern = pattern1 },
-    { test = testfn2, root = root2, pattern = pattern2 },
+    { test = testfn2, root = root2 },
 }
 ````
 
-### Relative paths
+Trailing commas are optional.
+
+### Relative and absolute paths
 
 The `pattern` argument is tested against the **relative** path of each file,
 **excluding** the `root` prefix – not the absolute path.
 
-The `Path` and `Utf8Path` passed into the test functions are **relative** to
-the root of the crate, obtained by joining `root` to the relative path of
-the file.
+The `Path` and `Utf8Path` passed into the test functions are created by
+joining `root` to the relative path of the file.
 
-For universality, all relative paths use `/` as the path separator,
-including on Windows.
+* If `root` is **relative**, the paths passed in are relative to the crate root.
+* If `root` is **absolute**, the paths passed in are absolute.
+
+For uniformity, all relative paths use `/` as the path separator,
+including on Windows, and all absolute paths use the platform’s native
+separator throughout.
 
 ### Examples
 
@@ -113,8 +119,12 @@ fn my_test_utf8(path: &Utf8Path, contents: String) -> datatest_stable::Result<()
 }
 
 datatest_stable::harness! {
-    { test = my_test, root = "path/to/fixtures", pattern = r"^.*/*" },
-    { test = my_test_utf8, root = "path/to/fixtures", pattern = r"^.*/*" },
+    { test = my_test, root = "path/to/fixtures" },
+    {
+        test = my_test_utf8,
+        root = "path/to/fixtures",
+        pattern = r"^.*\.txt$",
+    },
 }
 ````
 
@@ -146,7 +156,7 @@ fn my_test(path: &Path, contents: Vec<u8>) -> datatest_stable::Result<()> {
 }
 
 datatest_stable::harness! {
-    { test = my_test, root = include_dir!("tests/files"), pattern = r"^.*/*" },
+    { test = my_test, root = include_dir!("tests/files"), pattern = r"^.*\.json$" },
 }
 ````
 
@@ -156,7 +166,8 @@ You can also use directories published as `static` items in upstream crates:
 use datatest_stable::{include_dir, Utf8Path};
 
 // In the upstream crate:
-pub static FIXTURES: include_dir::Dir<'static> = include_dir!("tests/files");
+pub static FIXTURES: include_dir::Dir<'static> =
+    include_dir!("$CARGO_MANIFEST_DIR/tests/files");
 
 // In your test:
 fn my_test(path: &Utf8Path, contents: String) -> datatest_stable::Result<()> {
@@ -165,13 +176,13 @@ fn my_test(path: &Utf8Path, contents: String) -> datatest_stable::Result<()> {
 }
 
 datatest_stable::harness! {
-    { test = my_test, root = &FIXTURES, pattern = r"^.*/*" },
+    { test = my_test, root = &FIXTURES },
 }
 ````
 
-In this case, the passed-in `Path` and `Utf8Path` are **relative** to the
-root of the included directory. Like elsewhere in `datatest-stable`, these
-relative paths always use forward slashes as separators, including on
+In this case, the passed-in `Path` and `Utf8Path` are always **relative** to
+the root of the included directory. Like elsewhere in `datatest-stable`,
+these relative paths always use forward slashes as separators, including on
 Windows.
 
 Because the files don’t exist on disk, the test functions must accept their
@@ -188,17 +199,24 @@ case, you can use:
 ````rust
 use datatest_stable::Utf8Path;
 
-static FIXTURES: &str = "tests/files";
+// In the library itself:
+pub mod fixtures {
+    #[cfg(feature = "testing")]
+    pub static FIXTURES: &str = "tests/files";
 
-static FIXTURES: include_dir::Dir<'static> = datatest_stable::include_dir!("tests/files");
+    #[cfg(not(feature = "testing"))]
+    pub static FIXTURES: include_dir::Dir<'static> =
+        include_dir::include_dir!("$CARGO_MANIFEST_DIR/tests/files");
+}
 
+// In the test:
 fn my_test(path: &Utf8Path, contents: String) -> datatest_stable::Result<()> {
     // ... write test here
     Ok(())
 }
 
 datatest_stable::harness! {
-    { test = my_test, root = &FIXTURES, pattern = r"^.*/*" },
+    { test = my_test, root = &fixtures::FIXTURES, pattern = r"^inputs/.*$" },
 }
 ````
 

src/data_source.rs

@@ -6,7 +6,7 @@ use camino::{Utf8Component, Utf8Path, Utf8PathBuf};
 #[derive(Debug)]
 #[doc(hidden)]
 pub enum DataSource {
-    // This is relative to the crate root, and stored with forward slashes.
+    // The path has had normalize_slashes applied to it.
     Directory(Utf8PathBuf),
     #[cfg(feature = "include-dir")]
     IncludeDir(std::borrow::Cow<'static, include_dir::Dir<'static>>),
@@ -40,7 +40,7 @@ impl DataSource {
         );
         match self {
             DataSource::Directory(path) => Some(TestEntry {
-                source: TestSource::Path(rel_path_to_forward_slashes(&path.join(&rel_path))),
+                source: TestSource::Path(normalize_slashes(&path.join(&rel_path))),
                 rel_path,
             }),
             #[cfg(feature = "include-dir")]
@@ -83,7 +83,7 @@ fn iter_directory(root: &Utf8Path) -> impl Iterator<Item = std::io::Result<TestE
                     && entry
                         .file_name()
                         .to_str()
-                        .map_or(false, |s| !s.starts_with('.')) // Skip hidden files
+                        .is_some_and(|s| !s.starts_with('.')) // Skip hidden files
             })
         })
         .map(move |res| match res {
@@ -152,7 +152,7 @@ pub(crate) struct TestEntry {
 
 impl TestEntry {
     pub(crate) fn from_full_path(root: &Utf8Path, path: Utf8PathBuf) -> Self {
-        let path = rel_path_to_forward_slashes(&path);
+        let path = normalize_slashes(&path);
         let rel_path =
             rel_path_to_forward_slashes(path.strip_prefix(root).unwrap_or_else(|_| {
                 panic!("failed to strip root '{}' from path '{}'", root, path)
@@ -241,13 +241,29 @@ impl TestEntry {
     }
 }
 
+#[cfg(windows)]
+#[track_caller]
+fn normalize_slashes(path: &Utf8Path) -> Utf8PathBuf {
+    if is_truly_relative(path) {
+        rel_path_to_forward_slashes(path)
+    } else {
+        path.as_str().replace('/', "\\").into()
+    }
+}
+
 #[cfg(windows)]
 #[track_caller]
 fn rel_path_to_forward_slashes(path: &Utf8Path) -> Utf8PathBuf {
     assert!(is_truly_relative(path), "path {path} must be relative");
     path.as_str().replace('\\', "/").into()
 }
 
+#[cfg(not(windows))]
+#[track_caller]
+fn normalize_slashes(path: &Utf8Path) -> Utf8PathBuf {
+    path.to_owned()
+}
+
 #[cfg(not(windows))]
 #[track_caller]
 fn rel_path_to_forward_slashes(path: &Utf8Path) -> Utf8PathBuf {
@@ -309,11 +325,7 @@ pub mod data_source_kinds {
             let s = self.to_string();
             let path = Utf8Path::new(&s);
 
-            if !is_truly_relative(path) {
-                panic!("data source path must be relative: '{}'", s);
-            }
-
-            DataSource::Directory(rel_path_to_forward_slashes(path))
+            DataSource::Directory(normalize_slashes(path))
         }
     }
 
@@ -347,12 +359,6 @@ pub mod data_source_kinds {
 mod tests {
     use super::*;
 
-    #[test]
-    #[should_panic = "data source path must be relative: '/absolute/path'"]
-    fn data_source_absolute_path_panics() {
-        data_source_kinds::AsDirectory::resolve_data_source("/absolute/path");
-    }
-
     #[test]
     fn missing_test_name() {
         assert_eq!(derive_test_path("root".into(), "file", "test_name"), None);