Run benchmarks as unit tests on CI (#61)

* Run benchmarks as unit tests on CI

* Run cargo test with --release for linux and pypy jobs

* Fix test_cramjam_snappy_de_compress_into

.github/workflows/CI.yml

@@ -118,7 +118,7 @@ jobs:
     - name: Build
       run: cargo build --release
     - name: Tests
-      run: cargo test --no-default-features
+      run: cargo test --no-default-features --release
     - uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
@@ -139,6 +139,12 @@ jobs:
       run: |
         pip uninstall numpy -y
         python -m pytest tests/test_no_numpy.py
+    - name: Test benchmarks
+      if: matrix.target == 'x86_64'
+      run: |
+        sudo apt-get install -y libsnappy-dev
+        pip install -r benchmark-requirements.txt
+        make test-bench
     - name: Upload wheels
       uses: actions/upload-artifact@v2
       with:
@@ -211,7 +217,7 @@ jobs:
     - name: Build
       run: cargo build --release
     - name: Tests
-      run: cargo test --no-default-features
+      run: cargo test --no-default-features --release
     - uses: actions/setup-python@v2
       with:
         python-version: pypy-3.6

Makefile

@@ -3,6 +3,9 @@ BASE_BENCH_CMD = python -m pytest -v --benchmark-sort name --benchmark-only benc
 test:
 	python -m pytest tests -v --ignore benchmarks
 
+test-bench:
+	python -m pytest -v --benchmark-disable benchmarks/
+
 bench:
 	python -m pytest -v --benchmark-only --benchmark-sort name benchmarks/
 

benchmark-requirements.txt

@@ -3,3 +3,5 @@ python-snappy==0.5.4
 lz4==3.1.0
 brotlipy==0.7.0
 zstd==1.4.5.1
+numpy
+memory-profiler

benchmarks/test_bench.py

@@ -97,7 +97,7 @@ def test_snappy_framed(benchmark, file, use_cramjam: bool):
         )
 
 
-@pytest.mark.parametrize("op", ("decompress_raw_into", "compress_raw_into"))
+@pytest.mark.parametrize("op", ("decompress_into", "compress_into"))
 @pytest.mark.parametrize("file", FILES, ids=lambda val: val.name)
 def test_cramjam_snappy_de_compress_into(benchmark, op, file):
     """
@@ -110,7 +110,8 @@ def test_cramjam_snappy_de_compress_into(benchmark, op, file):
 
     operation = getattr(snappy, op)
     buffer = np.zeros(
-        len(data) if op == "decompress_into" else len(compressed_data), dtype=np.uint8
+        len(data) if op == "decompress_into" else len(compressed_data),
+        dtype=np.uint8,
     )
 
     benchmark(
@@ -187,7 +188,10 @@ def test_lz4_block(benchmark, file, use_cramjam: bool):
         )
     else:
         benchmark(
-            round_trip, compress=block.compress, decompress=block.decompress, data=data,
+            round_trip,
+            compress=block.compress,
+            decompress=block.decompress,
+            data=data,
         )
 
 
@@ -240,7 +244,10 @@ def test_zstd(benchmark, file, use_cramjam: bool):
         )
     else:
         benchmark(
-            round_trip, compress=zstd.compress, decompress=zstd.decompress, data=data,
+            round_trip,
+            compress=zstd.compress,
+            decompress=zstd.decompress,
+            data=data,
         )
 
 

dev-requirements.txt

@@ -1,4 +1,4 @@
-black==19.10b0
+black==21.5b1
 maturin
 numpy
 pytest>=5.3.0