Add Arbitrary to Glob

.github/workflows/ci.yml

@@ -215,3 +215,22 @@ jobs:
         env:
           RUSTDOCFLAGS: -D warnings
         run: cargo doc --no-deps --document-private-items --workspace
+
+  fuzz_testing:
+    name: Run Fuzz Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install packages (Ubuntu)
+        run: |
+          sudo apt-get update
+          sudo apt-get install g++ --yes
+
+      - uses: dtolnay/rust-toolchain@nightly
+
+      - run: cargo fuzz_install
+        working-directory: fuzz
+
+      - run: ./scripts/run-all.sh
+        working-directory: fuzz

Cargo.toml

@@ -20,6 +20,7 @@ exclude = [
   "/pkg/brew",
   "/benchsuite/",
   "/scripts/",
+  "/crates/fuzz",
 ]
 build = "build.rs"
 autotests = false

ci/ubuntu-install-packages

@@ -11,4 +11,4 @@ if ! command -V sudo; then
 fi
 sudo apt-get update
 sudo apt-get install -y --no-install-recommends \
-  zsh xz-utils liblz4-tool musl-tools brotli zstd
+  zsh xz-utils liblz4-tool musl-tools brotli zstd g++

crates/globset/Cargo.toml

@@ -21,6 +21,7 @@ bench = false
 
 [dependencies]
 aho-corasick = "1.1.1"
+arbitrary = { version = "1.3.2", optional = true, features = ["derive"] }
 bstr = { version = "1.6.2", default-features = false, features = ["std"] }
 log = { version = "0.4.20", optional = true }
 serde = { version = "1.0.188", optional = true }
@@ -41,6 +42,7 @@ serde_json = "1.0.107"
 
 [features]
 default = ["log"]
+arbitrary = ["dep:arbitrary"]
 # DEPRECATED. It is a no-op. SIMD is done automatically through runtime
 # dispatch.
 simd-accel = []

crates/globset/src/glob.rs

@@ -71,6 +71,7 @@ impl MatchStrategy {
 /// It cannot be used directly to match file paths, but it can be converted
 /// to a regular expression string or a matcher.
 #[derive(Clone, Debug, Eq)]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
 pub struct Glob {
     glob: String,
     re: String,
@@ -193,6 +194,7 @@ pub struct GlobBuilder<'a> {
 }
 
 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
 struct GlobOptions {
     /// Whether to match case insensitively.
     case_insensitive: bool,
@@ -219,6 +221,7 @@ impl GlobOptions {
 }
 
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
 struct Tokens(Vec<Token>);
 
 impl std::ops::Deref for Tokens {
@@ -235,6 +238,7 @@ impl std::ops::DerefMut for Tokens {
 }
 
 #[derive(Clone, Debug, Eq, PartialEq)]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
 enum Token {
     Literal(char),
     Any,

crates/globset/src/lib.rs

@@ -16,6 +16,19 @@ globs as matching.
 
 This example shows how to match a single glob against a single file path.
 
+
+# Crate features
+
+This crate includes optional features that can be enabled if necessary. These features are
+not required but may be useful depending on the use case.
+
+The following features are available:
+
+* **arbitrary** -
+  Enabling this feature introduces a public dependency on the
+  [`arbitrary`](https://crates.io/crates/arbitrary)
+  crate. Namely, it implements the `Arbitrary` trait from that crate for the
+  [`Glob`] type. This feature is disabled by default.
 ```
 use globset::Glob;
 

fuzz/.cargo/config.toml

@@ -0,0 +1,4 @@
+[alias]
+fuzz_install = "install cargo-fuzz"
+fuzz_list = "fuzz list"
+fuzz_run = "fuzz run"

fuzz/.gitignore

@@ -0,0 +1,4 @@
+target
+corpus
+artifacts
+coverage

fuzz/Cargo.toml

@@ -0,0 +1,25 @@
+[package]
+name = "fuzz"
+version = "0.0.1"
+publish = false
+edition = "2021"
+
+[package.metadata]
+cargo-fuzz = true
+
+[dependencies]
+libfuzzer-sys = "0.4"
+globset = { path = "../crates/globset", features = ["arbitrary"] }
+
+# Prevent this from interfering with workspaces
+[workspace]
+members = ["."]
+
+[profile.release]
+debug = 1
+
+[[bin]]
+name = "fuzz_glob"
+path = "fuzz_targets/fuzz_glob.rs"
+test = false
+doc = false