Fix running benchmarks in CI.

Author: JoeZiminski

.github/workflows/test_and_deploy.yml

@@ -39,6 +39,9 @@ jobs:
     steps:
       # Run tests
       - uses: neuroinformatics-unit/actions/test@v2
+        env:
+          # To not skip test_benchmarks
+          RUN_BENCHMARKS: true
         with:
           python-version: ${{ matrix.python-version }}
           secret-codecov-token: ${{ secrets.CODECOV_TOKEN }}

tests/tests/test_benchmarks.py

@@ -5,8 +5,12 @@
 
 import fancylog
 
+# Set an environment variable to run benchmarks. This
+# is used to selectively run benchmarks through GitHub CI.
+RUN_BENCHMARKS = os.getenv("RUN_BENCHMARKS", "").lower() == "true"
 
-@pytest.mark.skipif(not os.getenv("CI"), reason="Benchmark skipped outside CI")
+
+@pytest.mark.skipif(not RUN_BENCHMARKS, reason="`RUN_BENCHMARKS` was false`")
 def test_benchmark(tmp_path, capsys):
     """
     A very rough benchmark to check for large regressions