test: add e2e tests requesting live api

Author: afuetterer

.github/workflows/e2e_test.yml

@@ -0,0 +1,34 @@
+name: End-to-end tests
+
+on:
+  schedule:
+    # run once a month at midnight of the first day of the month
+  - cron: 0 0 1 * *
+  workflow_dispatch: # run manually from actions tab
+
+# Set permissions at the job level.
+permissions: {}
+
+env:
+  PYTHONUNBUFFERED: 1
+  FORCE_COLOR: 1
+  UV_LOCKED: true # do not update the lockfile during `uv sync` and `uv run` commands
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-24.04
+    steps:
+    - name: Set up just
+      uses: extractions/setup-just@e33e0265a09d6d736e2ee1e0eb685ef1de4669ff # v3
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+    - name: Set up uv
+      uses: astral-sh/setup-uv@f94ec6bedd8674c4426838e6b50417d36b6ab231 # v5.3.1
+      with:
+        python-version: '3.13'
+        enable-cache: true
+        prune-cache: false
+    - name: Install project, including dev dependencies
+      run: just sync
+    - name: Run e2e tests
+      run: just e2e-test

.github/workflows/test.yml

@@ -34,6 +34,9 @@ jobs:
       run: just cov
       env:
         TERM: dumb # keep rich from printing escape sequences, which made testing CLI outputs messy
+    - name: Run e2e tests
+      run: just e2e-test
+      if: matrix.python-version == '3.13'
     - name: Generate coverage report
       run: |
         export TOTAL_COV=$(hatch run cov-total)

justfile

@@ -31,6 +31,10 @@ check: lint typecheck
 test:
     uv run pytest tests
 
+[group('test')]
+e2e-test:
+    uv run pytest -m e2e
+
 [group('test')]
 cov:
     uv run pytest --cov=src

pyproject.toml

@@ -170,6 +170,7 @@ addopts = [
   "--showlocals",
   "--strict-markers",
   "--strict-config",
+  "-m not e2e",       # default behaviour: do not run e2e tests
 ]
 asyncio_mode = "auto"
 filterwarnings = [
@@ -178,6 +179,9 @@ filterwarnings = [
 log_cli_level = "INFO"
 xfail_strict = true
 testpaths = "tests"
+markers = [
+  "e2e: marks tests as end-to-end tests, requesting the live api",
+]
 
 [tool.coverage.run] # Ref: https://coverage.readthedocs.io/en/latest/config.html
 branch = true

tests/e2e/test_live_api.py

@@ -0,0 +1,26 @@
+# SPDX-FileCopyrightText: 2025 Heinz-Alexander Fütterer
+#
+# SPDX-License-Identifier: MIT
+
+from __future__ import annotations
+
+import pytest
+
+import re3data
+from re3data._resources import Repository, RepositoryName, RepositorySummary
+
+pytestmark = pytest.mark.e2e
+
+
+def test_get_single_repository(zenodo_id: str) -> None:
+    response = re3data.repositories.get(zenodo_id)
+    assert isinstance(response, Repository)
+    assert response.id == zenodo_id
+    assert isinstance(response.repository_name, RepositoryName)
+    assert response.repository_name.value == "Zenodo"
+
+
+def test_list_repositories_query_string() -> None:
+    response = re3data.repositories.list(query="biosharing")
+    assert isinstance(response, list)
+    assert isinstance(response[0], RepositorySummary)