Add code coverage to CI

.conda/benchcab-dev.yaml

@@ -7,5 +7,5 @@ dependencies:
   - f90nml
   - netcdf4
   - numpy
-  - pytest
+  - pytest-cov
   - pyyaml

.github/workflows/pytest.yaml

@@ -23,4 +23,9 @@ jobs:
           environment-file: .conda/benchcab-dev.yaml
       - name: Test with pytest
         run: |
-          TMPDIR=${{ runner.temp }} pytest
+          pytest --cov=./ --cov-report=xml
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml

README.md

@@ -1,5 +1,7 @@
 # CABLE benchmarking
 
+[![codecov](https://codecov.io/gh/CABLE-LSM/benchcab/branch/master/graph/badge.svg?token=JJYE1YZDXQ)](https://codecov.io/gh/CABLE-LSM/benchcab)
+
 Repository to benchmark CABLE. The benchmark will run the exact same configurations on two CABLE branches specified by the user, e.g. a user branch (with personal changes) against the head of the trunk. The results should be attached with all new [tickets](https://trac.nci.org.au/trac/cable/report/1).
 
 The code will: (i) check out; (ii) build; and (iii) run branches across N standard science configurations. It is possible to produce some plots locally. But the outputs should be uploaded to [the modelevaluation website](https://modelevaluation.org/) for further benchmarking and evaluation.

tests/common.py

@@ -1,9 +1,9 @@
 """Helper functions for `pytest`."""
 
-import os
+import tempfile
 from pathlib import Path
 
-TMP_DIR = Path(os.environ["TMPDIR"], "benchcab_tests")
+TMP_DIR = Path(tempfile.mkdtemp(prefix="benchcab_tests"))
 
 
 def make_barebones_config() -> dict: