Refactor CI jobs. (#699)

* Refactor CI jobs.

* Parallel and verbose tests.

* Cancel in-progress jobs when new commit is pushed.

* Detect coverage better.

Author: hameerabbasi

.codecov.yml

@@ -1,28 +1,18 @@
-comment:
-  layout: "header, diff, changes, uncovered"
-
+comment: false
 coverage:
   status:
     project:
       default:
-          # Total project must not drop by more than 3%
-          target: auto
-          threshold: "3%"
+          # Total project must be 95%
+          target: '100%'
+          threshold: '5%'
 
     patch:
       default:
           # Patch coverage must be 92%
-          target: auto
-          threshold: "92%"
+          target: '100%'
+          threshold: '8%'
 
   precision: 2
   round: down
-  range: 70...98
-
-  ignore:
-    - sparse/tests/
-    - sparse/_version.py
-    - ^(?!sparse\/)
-
-codecov:
-  token: 8de77158-fc37-47be-930c-f98739f9e5bf
+  range: 80...98

.github/workflows/ci.yml

@@ -1,8 +1,13 @@
+defaults:
+  run:
+    shell: bash -leo pipefail {0}
+
+concurrency:
+  group: ${{ github.head_ref }}
+  cancel-in-progress: true
+
 jobs:
   test:
-    defaults:
-      run:
-        shell: bash -el {0}
     strategy:
       matrix:
         os: [ubuntu-latest]
@@ -18,6 +23,7 @@ jobs:
             python: '3.10'
             numba_boundscheck: 1
           - os: ubuntu-latest
+            python: '3.10'
             pip_opts: "--pre -U"
       fail-fast: false
     runs-on: ${{ matrix.os }}
@@ -27,65 +33,33 @@ jobs:
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v4
-      - name: Cache conda
-        uses: actions/cache@v4
-        env:
-          # Increase this value to reset cache if ci/environment.yml has not changed
-          CACHE_NUMBER: 0
-        with:
-          path: ~/conda_pkgs_dir
-          key:
-            test-${{ matrix.os }}-conda-py${{ matrix.python }}-${{ env.CACHE_NUMBER }}-${{
-            hashFiles('ci/environment.yml') }}
-      - uses: julia-actions/setup-julia@v1
-        with:
-          version: '1.10.0'
-      - uses: conda-incubator/setup-miniconda@v3
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
-          activate-environment: sparse-dev
-          allow-softlinks: true
-          environment-file: ci/environment.yml
           python-version: ${{ matrix.python }}
-          miniforge-version: latest
+          cache: 'pip'
       - name: Install package
         run: |
           pip install -e .[tests]
           pip install ${{ matrix.pip_opts }} numpy numba
       - name: Run tests
         run: |
-          SPARSE_BACKEND=Numba pytest --pyargs sparse
-          SPARSE_BACKEND=Finch pytest --pyargs sparse/tests
+          SPARSE_BACKEND=Numba pytest --pyargs sparse --cov-report=xml:coverage_Numba.xml -n 4 -vvv
+          SPARSE_BACKEND=Finch pytest --pyargs sparse/tests --cov-report=xml:coverage_Finch.xml -n 4 -vvv
       - uses: codecov/codecov-action@v4
         if: always()
-      - name: Publish Test Results
-        uses: EnricoMi/publish-unit-test-result-action/composite@v2
-        if: always()
         with:
-          files: "**/test-*.xml"
+          files: ./**/coverage*.xml
   docs:
-    defaults:
-      run:
-        shell: bash -el {0}
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v4
-      - name: Cache conda
-        uses: actions/cache@v4
-        env:
-          # Increase this value to reset cache if ci/environment.yml has not changed
-          CACHE_NUMBER: 0
-        with:
-          path: ~/conda_pkgs_dir
-          key:
-            docs-conda-${{ env.CACHE_NUMBER }}-${{ hashFiles('ci/environment.yml') }}
-      - uses: conda-incubator/setup-miniconda@v3
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
-          activate-environment: sparse-dev
-          allow-softlinks: true
-          environment-file: ci/environment.yml
           python-version: '3.10'
-          miniforge-version: latest
+          cache: 'pip'
       - name: Install package
         run: |
           pip install -e .[docs]
@@ -97,29 +71,15 @@ jobs:
           name: Documentation
           path: _build/html
   benchmarks:
-    defaults:
-      run:
-        shell: bash -el {0}
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v4
-      - name: Cache conda
-        uses: actions/cache@v4
-        env:
-          # Increase this value to reset cache if ci/environment.yml has not changed
-          CACHE_NUMBER: 0
-        with:
-          path: ~/conda_pkgs_dir
-          key:
-            benchmarks-${{ env.CACHE_NUMBER }}-${{ hashFiles('ci/environment.yml') }}
-      - uses: conda-incubator/setup-miniconda@v3
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
-          activate-environment: sparse-dev
-          allow-softlinks: true
-          environment-file: ci/environment.yml
           python-version: '3.10'
-          miniforge-version: latest
+          cache: 'pip'
       - name: Install asv
         run: |
           pip install asv
@@ -133,11 +93,13 @@ jobs:
     - name: Checkout Repo
       uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v5.1.0
+      uses: actions/setup-python@v5
       with:
         python-version: '3.11'
+        cache: 'pip'
     - name: Build and install Sparse
       run: |
+        pip install -U setuptools wheel
         python -m pip install '.[finch]' scipy
     - name: Run examples
       run: |
@@ -159,9 +121,10 @@ jobs:
         submodules: 'true'
         path: 'array-api-tests'
     - name: Set up Python
-      uses: actions/setup-python@v5.1.0
+      uses: actions/setup-python@v5
       with:
         python-version: '3.11'
+        cache: 'pip'
     - name: Install build and test dependencies from PyPI
       run: |
         python -m pip install pytest-xdist -r array-api-tests/requirements.txt

.gitignore

@@ -80,3 +80,6 @@ sandbox.py
 
 # Version file
 sparse/_version.py
+
+# Benchmark Results
+results/

pyproject.toml

@@ -32,6 +32,7 @@ tests = [
     "dask[array]",
     "pytest>=3.5",
     "pytest-cov",
+    "pytest-xdist",
     "pre-commit",
     "scipy",
     "sparse[finch]",

pytest.ini

@@ -1,5 +1,5 @@
 [pytest]
-addopts = --cov-report term-missing --cov-report html --cov-report=xml --cov-report=term --cov sparse --cov-config .coveragerc --junitxml=junit/test-results.xml
+addopts = --cov-report term-missing --cov-report html --cov-report=term:skip-covered --cov sparse --cov-config .coveragerc --junitxml=junit/test-results.xml
 filterwarnings =
     ignore::PendingDeprecationWarning
 testpaths =

sparse/__init__.py

@@ -16,19 +16,19 @@ class BackendType(Enum):
 
 if _ENV_VAR_NAME in os.environ:
     warnings.warn("Selectable backends feature in `sparse` might change in the future.", FutureWarning, stacklevel=1)
-    backend_name = os.environ[_ENV_VAR_NAME]
+    _backend_name = os.environ[_ENV_VAR_NAME]
 else:
-    backend_name = BackendType.Numba.value
+    _backend_name = BackendType.Numba.value
 
-if backend_name not in {BackendType.Numba.value, BackendType.Finch.value}:
-    warnings.warn(f"Invalid backend identifier: {backend_name}. Selecting Numba backend.", UserWarning, stacklevel=1)
-    backend = BackendType.Numba
+if _backend_name not in {BackendType.Numba.value, BackendType.Finch.value}:
+    warnings.warn(f"Invalid backend identifier: {_backend_name}. Selecting Numba backend.", UserWarning, stacklevel=1)
+    BACKEND = BackendType.Numba
 else:
-    backend = BackendType[backend_name]
+    BACKEND = BackendType[_backend_name]
 
-del backend_name
+del _backend_name
 
-if backend == BackendType.Finch:
+if BackendType.Finch == BACKEND:
     from sparse.finch_backend import *  # noqa: F403
     from sparse.finch_backend import __all__
 else:

sparse/tests/conftest.py

@@ -1,5 +1,3 @@
-import os
-
 import sparse
 
 import pytest
@@ -9,7 +7,7 @@
 
 @pytest.fixture(scope="session")
 def backend():
-    yield sparse.BackendType[os.environ[sparse._ENV_VAR_NAME]]
+    yield sparse.BACKEND
 
 
 @pytest.fixture(scope="module")