Merge pull request #321 from Dr-Emann/push-npzxvmvqlorl

Add fuzzing to compare against croaring-rs

Author: Kerollmops

.github/workflows/test.yml

@@ -33,6 +33,9 @@ jobs:
           toolchain: ${{ matrix.rust }}
           components: rustfmt, clippy
 
+      - name: Caching
+        uses: Swatinem/rust-cache@v2
+
       - name: Check
         # clippy will also do a build check
         # so we don't need to run `cargo check` or `cargo build`
@@ -68,11 +71,21 @@ jobs:
             features: simd
     env:
       RUSTFLAGS: "-C target-cpu=native -C opt-level=3"
+      ROARINGRS_BENCH_OFFLINE: "true"
 
     steps:
       - name: Checkout roaring-rs
         uses: actions/checkout@v4
 
+      - name: Checkout benchmark datasets
+        uses: actions/checkout@v4
+        with:
+          repository: "RoaringBitmap/real-roaring-datasets"
+          path: "benchmarks/real-roaring-datasets"
+
+      - name: Caching
+        uses: Swatinem/rust-cache@v2
+
       - name: Initialize rust toolchain
         uses: dtolnay/rust-toolchain@master
         with:
@@ -82,6 +95,10 @@ jobs:
         if: matrix.features == 'default'
         run: cargo test -p roaring --features serde
 
+      - name: Test Benches
+        if: matrix.rust != '1.71.1' && matrix.features == 'default'
+        run: cargo test -p benchmarks --benches
+
       - name: Test no default features
         if: matrix.features == 'no-std'
         run: cargo test -p roaring --no-default-features
@@ -107,43 +124,43 @@ jobs:
           toolchain: nightly
           components: miri
 
+      - name: Caching
+        uses: Swatinem/rust-cache@v2
+
       - name: Setup miri
         run: cargo miri setup
 
       - name: Test bit endian
         run: cargo miri test --target s390x-unknown-linux-gnu -p roaring --lib -- bitmap::serialization::test::test_from_lsb0_bytes
 
-  bench:
+  fuzz:
     runs-on: ubuntu-latest
     needs: build
-    strategy:
-      matrix:
-        rust:
-          - stable
-          - nightly
-        features:
-          - default
-        include:
-          - rust: nightly
-            features: simd
     env:
       RUSTFLAGS: "-C target-cpu=native -C opt-level=3"
-      ROARINGRS_BENCH_OFFLINE: "true"
 
     steps:
       - name: Checkout roaring-rs
         uses: actions/checkout@v4
 
-      - name: Checkout benchmark datasets
-        uses: actions/checkout@v4
-        with:
-          repository: "RoaringBitmap/real-roaring-datasets"
-          path: "benchmarks/real-roaring-datasets"
-
       - name: Initialize rust toolchain
         uses: dtolnay/rust-toolchain@master
         with:
-          toolchain: ${{ matrix.rust }}
+          toolchain: nightly
+
+      - name: Caching
+        uses: Swatinem/rust-cache@v2
+
+      - name: Install cargo fuzz
+        run: cargo install cargo-fuzz
+
+      - name: Setup Cache for corpus and artifacts
+        uses: actions/cache@v4
+        with:
+          key: always
+          path: |
+            fuzz/artifacts
+            fuzz/corpus
 
-      - name: Bench
-        run: cargo bench --features "${{ matrix.features }}"
+      - name: Run Fuzzer vs croaring for 30 minutes
+        run: cargo fuzz run against_croaring -s none -- -timeout=5 -max_total_time=1800

fuzz/.gitignore

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

fuzz/Cargo.lock

@@ -0,0 +1,22 @@
+[package]
+name = "roaring-fuzz"
+version = "0.0.0"
+publish = false
+edition = "2021"
+
+[package.metadata]
+cargo-fuzz = true
+
+[dependencies]
+libfuzzer-sys = { version = "0.4.9", features = ["arbitrary-derive"] }
+roaring = { path = "../roaring" }
+croaring = "2.0"
+
+[[bin]]
+name = "against_croaring"
+path = "fuzz_targets/against_croaring.rs"
+test = false
+doc = false
+bench = false
+
+[workspace]

fuzz/Cargo.toml

@@ -0,0 +1,38 @@
+#![no_main]
+
+mod arbitrary_ops;
+
+use libfuzzer_sys::arbitrary::{self, Arbitrary};
+use libfuzzer_sys::fuzz_target;
+
+use crate::arbitrary_ops::{check_equal, Operation};
+
+#[derive(Arbitrary, Debug)]
+struct FuzzInput<'a> {
+    ops: Vec<Operation>,
+    initial_input: &'a [u8],
+}
+
+fuzz_target!(|input: FuzzInput| {
+    let lhs_c = croaring::Bitmap::try_deserialize::<croaring::Portable>(input.initial_input);
+    let lhs_r = roaring::RoaringBitmap::deserialize_from(input.initial_input).ok();
+
+    let (mut lhs_c, mut lhs_r) = match (lhs_c, lhs_r) {
+        (Some(lhs_c), Some(lhs_r)) => {
+            check_equal(&lhs_c, &lhs_r);
+            (lhs_c, lhs_r)
+        }
+        (None, None) => Default::default(),
+        (Some(_), None) => panic!("croaring deserialized, but roaring failed"),
+        (None, Some(_)) => panic!("roaring deserialized, but croaring failed"),
+    };
+
+    let mut rhs_c = croaring::Bitmap::new();
+    let mut rhs_r = roaring::RoaringBitmap::new();
+
+    for op in input.ops {
+        op.apply(&mut lhs_c, &mut rhs_c, &mut lhs_r, &mut rhs_r);
+    }
+    check_equal(&lhs_c, &lhs_r);
+    check_equal(&rhs_c, &rhs_r);
+});