Backport PR #3082 on branch 1.2.x (ci: Add optional and internet test…

…s) (#3084)

Backport PR #3082: ci: Add optional and internet tests

---------

Co-authored-by: Ori Kronfeld <[email protected]>

.github/workflows/test_linux_cuda.yml

@@ -34,7 +34,7 @@ jobs:
     container:
       image: ghcr.io/scverse/scvi-tools:py3.12-cu12-base
       #image: ghcr.io/scverse/scvi-tools:py3.12-cu12-${{ env.BRANCH_NAME }}-base
-      options: --user root --gpus all
+      options: --user root --gpus all --pull always
 
     name: integration
 

.github/workflows/test_linux_internet.yml

@@ -0,0 +1,77 @@
+name: test (internet)
+
+on:
+  pull_request:
+    branches: [main, "[0-9]+.[0-9]+.x"]
+    types: [labeled, synchronize, opened]
+  schedule:
+    - cron: "0 10 * * *" # runs at 10:00 UTC (03:00 PST) every day
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    # if PR has label "internet tests" or "all tests" or if scheduled or manually triggered or on push
+    if: >-
+      (
+        contains(github.event.pull_request.labels.*.name, 'internet tests') ||
+        contains(github.event.pull_request.labels.*.name, 'all tests') ||
+        contains(github.event_name, 'schedule') ||
+        contains(github.event_name, 'workflow_dispatch') ||
+        contains(github.event_name, 'push')
+      )
+
+    runs-on: ${{ matrix.os }}
+
+    defaults:
+      run:
+        shell: bash -e {0} # -e to fail on error
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python: ["3.12"]
+
+    permissions:
+      id-token: write
+
+    name: unit
+
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: ${{ matrix.python }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+          cache: "pip"
+          cache-dependency-path: "**/pyproject.toml"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip wheel uv
+          python -m uv pip install --system "scvi-tools[tests] @ ."
+          python -m pip install tiledb
+          python -m pip install tiledbsoma
+          python -m pip install cellxgene-census
+
+      - name: Run pytest
+        env:
+          MPLBACKEND: agg
+          PLATFORM: ${{ matrix.os }}
+          DISPLAY: :42
+          COLUMNS: 120
+        run: |
+          coverage run -m pytest -v --color=yes --internet-tests
+          coverage report
+
+      - uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/test_linux_optional.yml

@@ -0,0 +1,74 @@
+name: test (optional)
+
+on:
+  pull_request:
+    branches: [main, "[0-9]+.[0-9]+.x"]
+    types: [labeled, synchronize, opened]
+  schedule:
+    - cron: "0 10 * * *" # runs at 10:00 UTC (03:00 PST) every day
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    # if PR has label "optional tests" or "all tests" or if scheduled or manually triggered or on push
+    if: >-
+      (
+        contains(github.event.pull_request.labels.*.name, 'optional tests') ||
+        contains(github.event.pull_request.labels.*.name, 'all tests') ||
+        contains(github.event_name, 'schedule') ||
+        contains(github.event_name, 'workflow_dispatch') ||
+        contains(github.event_name, 'push')
+      )
+
+    runs-on: ${{ matrix.os }}
+
+    defaults:
+      run:
+        shell: bash -e {0} # -e to fail on error
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python: ["3.12"]
+
+    permissions:
+      id-token: write
+
+    name: unit
+
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: ${{ matrix.python }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+          cache: "pip"
+          cache-dependency-path: "**/pyproject.toml"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip wheel uv
+          python -m uv pip install --system "scvi-tools[tests] @ ."
+
+      - name: Run pytest
+        env:
+          MPLBACKEND: agg
+          PLATFORM: ${{ matrix.os }}
+          DISPLAY: :42
+          COLUMNS: 120
+        run: |
+          coverage run -m pytest -v --color=yes --optional
+          coverage report
+
+      - uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

CHANGELOG.md

@@ -16,6 +16,8 @@ to [Semantic Versioning]. Full commit history is available in the
 
 #### Changed
 
+- Updated the CI workflow with internet, private and optional tests {pr}`3082`.
+
 #### Removed
 
 ### 1.2.1 (2024-12-04)

tests/conftest.py

@@ -56,30 +56,39 @@ def pytest_collection_modifyitems(config, items):
     """Docstring for pytest_collection_modifyitems."""
     run_internet = config.getoption("--internet-tests")
     skip_internet = pytest.mark.skip(reason="need --internet-tests option to run")
+    skip_non_internet = pytest.mark.skip(reason="test not having a pytest.mark.internet decorator")
     for item in items:
         # All tests marked with `pytest.mark.internet` get skipped unless
         # `--internet-tests` passed
         if not run_internet and ("internet" in item.keywords):
             item.add_marker(skip_internet)
+        # Skip all tests not marked with `pytest.mark.internet` if `--internet` passed
+        elif run_internet and ("internet" not in item.keywords):
+            item.add_marker(skip_non_internet)
 
     run_optional = config.getoption("--optional")
     skip_optional = pytest.mark.skip(reason="need --optional option to run")
+    skip_non_optional = pytest.mark.skip(reason="test not having a pytest.mark.optional decorator")
     for item in items:
         # All tests marked with `pytest.mark.optional` get skipped unless
         # `--optional` passed
         if not run_optional and ("optional" in item.keywords):
             item.add_marker(skip_optional)
+        # Skip all tests not marked with `pytest.mark.optional` if `--optional` passed
+        elif run_optional and ("optional" not in item.keywords):
+            item.add_marker(skip_non_optional)
 
     run_private = config.getoption("--private")
     skip_private = pytest.mark.skip(reason="need --private option to run")
+    skip_non_private = pytest.mark.skip(reason="test not having a pytest.mark.private decorator")
     for item in items:
         # All tests marked with `pytest.mark.private` get skipped unless
         # `--private` passed
         if not run_private and ("private" in item.keywords):
             item.add_marker(skip_private)
         # Skip all tests not marked with `pytest.mark.private` if `--private` passed
         elif run_private and ("private" not in item.keywords):
-            item.add_marker(skip_private)
+            item.add_marker(skip_non_private)
 
 
 @pytest.fixture(scope="session")

tests/data/test_built_in_data.py

@@ -91,7 +91,7 @@ def test_download_seurat_v4_pbmc(save_path: str):
 
 @pytest.mark.internet
 def test_download_cellxgene(save_path: str):
-    url = "https://cellxgene.cziscience.com/e/8d73847b-33e7-48f0-837f-e3e6579bf12d.cxg/"
+    url = "https://cellxgene.cziscience.com/e/de985818-285f-4f59-9dbd-d74968fddba3.cxg/"
     filename = "cellxgene.h5ad"
     scvi.data.cellxgene(url, save_path=save_path, filename=filename)
     anndata.read_h5ad(os.path.join(save_path, filename))