Merge pull request #1122 from onekey-sec/ci-cargo-bench

Fix and run `cargo bench` in CI

Author: qkaiser

.github/workflows/CI.yml

@@ -103,6 +103,21 @@ jobs:
           SCCACHE_GHA_ENABLED: "true"
           RUSTC_WRAPPER: "sccache"
         run: cargo test
+      - name: Run benchmark
+        if: matrix.os == 'ubuntu-latest'
+        env:
+          SCCACHE_GHA_ENABLED: "true"
+          RUSTC_WRAPPER: "sccache"
+        run: cargo bench -- --output-format bencher | tee bench.txt
+      - name: Store benchmark result
+        if: matrix.os == 'ubuntu-latest'
+        uses: benchmark-action/github-action-benchmark@v1
+        with:
+          tool: "cargo"
+          output-file-path: bench.txt
+          summary-always: true
+          comment-on-alert: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
 
   build_linux_wheels:
     name: Build wheels (linux)

rust/Cargo.toml

@@ -11,7 +11,10 @@ crate-type = [
   "cdylib", # for Python extension
   "rlib",   # for benchmarking
 ]
-name = "unblob_rust"
+name = "unblob"
+# disable Rust nightly benchmark feature. We use criterion
+# https://bheisler.github.io/criterion.rs/book/faq.html#cargo-bench-gives-unrecognized-option-errors-for-valid-command-line-options
+bench = false
 
 [dependencies]
 log = "0.4.22"

rust/benches/benches_main.rs

@@ -19,7 +19,7 @@ fn shannon_entropy(c: &mut Criterion) {
             BenchmarkId::from_parameter(sample_size),
             &sample_size,
             |b, &size| {
-                b.iter(|| unblob_native::math_tools::shannon_entropy(&sample[0..size]));
+                b.iter(|| unblob::math_tools::shannon_entropy(&sample[0..size]));
             },
         );
     }
@@ -38,7 +38,7 @@ fn chi_square_probability(c: &mut Criterion) {
             BenchmarkId::from_parameter(sample_size),
             &sample_size,
             |b, &size| {
-                b.iter(|| unblob_native::math_tools::chi_square_probability(&sample[0..size]));
+                b.iter(|| unblob::math_tools::chi_square_probability(&sample[0..size]));
             },
         );
     }