Merge pull request #14 from toirl/test-coverage

100% test coverage

Author: cjw296

.github/workflows/ci.yml

@@ -87,18 +87,32 @@ jobs:
           cache-dependency-glob: "**/pyproject.toml"
           cache-suffix: ${{ matrix.uv-resolution }}
 
-      - name: Run tests with SQLite
-        if: matrix.database == 'sqlite'
-        run: |
-          uv run --all-extras --dev --resolution ${{ matrix.uv-resolution }} -m pytest --sqlalchemy-connect-url="sqlite:///foo.sqlite"
+      - name: Install the project and dependencies
+        run: uv sync --all-extras --dev --resolution ${{ matrix.uv-resolution }}
 
-      - name: Run tests with PostgreSQL
-        if: matrix.database == 'postgres'
+      - name: Run tests
         run: |
-          uv run --all-extras --dev --with psycopg2 --resolution ${{ matrix.uv-resolution }} -m pytest --sqlalchemy-connect-url="postgresql://postgres:postgres@localhost:5432/test_db"
+          # Install software and run tests
+          if [ "${{ matrix.database }}" = "postgres" ]; then
+            export WITH='--with psycopg2-binary'
+            export DB_URL=postgresql://postgres:postgres@localhost:5432/test_db
+          elif [ "${{ matrix.database }}" = "mysql" ]; then
+            export WITH='--with mysqlclient'
+            # 127.0.0.1 is to persuade mysqlclient to use tcp rather than the domain socket :-/
+            export DB_URL=mysql://root:mysql@127.0.0.1:3306/test_db
+          fi
+          uv run --no-sync $WITH --resolution ${{ matrix.uv-resolution }} -m coverage run -m pytest --sqlalchemy-connect-url=$DB_URL
 
-      - name: Run tests with MySQL
-        if: matrix.database == 'mysql'
-        # 127.0.0.1 is to persuade mysqlclient to use tcp rather than the domain socket :-/
-        run: |
-          uv run  --all-extras --dev --with mysqlclient --resolution ${{ matrix.uv-resolution }} -m pytest --sqlalchemy-connect-url="mysql://root:mysql@127.0.0.1:3306/test_db"
+      - name: Upload coverage data
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-data-${{ matrix.python-version }}-${{ matrix.uv-resolution }}-${{ matrix.database }}
+          path: .coverage.*
+          include-hidden-files: true
+          if-no-files-found: ignore
+
+  coverage:
+    needs: tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: cjw296/python-action/check-coverage@v1

pyproject.toml

@@ -15,9 +15,10 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
+    "coverage>=7.8.0",
     "pytest>=8.0",
     "sqlalchemy>=1.4",
-    "SQLAlchemy-Utils>=0.41"
+    "SQLAlchemy-Utils>=0.41",
 ]
 
 [project.urls]
@@ -29,3 +30,15 @@ sqlalchemy = "pytest_sqlalchemy"
 [build-system]
 requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
+
+[tool.coverage.run]
+source = ["pytest_sqlalchemy", "tests"]
+parallel = true
+
+[tool.pytest.ini_options]
+norecursedirs = ["tests/examples"]
+
+[dependency-groups]
+dev = [
+    "pytest-xdist>=3.6.1",
+]

pytest_sqlalchemy.py

@@ -28,10 +28,11 @@ def engine(request, sqlalchemy_connect_url, app_config):
         raise RuntimeError("Can not establish a connection to the database")
 
     # Put a suffix like _gw0, _gw1 etc on xdist processes
-    xdist_suffix = getattr(request.config, 'slaveinput', {}).get('slaveid')
+    xdist_suffix = getattr(request.config, 'workerinput', {}).get('workerid')
+    print(xdist_suffix)
     if engine.url.database != ':memory:' and xdist_suffix is not None:
-        engine.url.database = '{}_{}'.format(engine.url.database, xdist_suffix)
-        engine = create_engine(engine.url)  # override engine
+        url = engine.url.set(database=f'{engine.url.database}_{xdist_suffix}')
+        engine = create_engine(url)  # override engine
 
     def fin():
         print ("Disposing engine")

tests/conftest.py

@@ -0,0 +1,17 @@
+import os
+from pathlib import Path
+
+import pytest
+
+pytest_plugins = ["pytester"]
+
+
+@pytest.fixture()
+def db_url(tmp_path: Path) -> str:
+    return os.environ.get("DB_URL", "sqlite:///" + str(tmp_path / "test.db"))
+
+
+@pytest.fixture()
+def new_db_url(db_url: str) -> str:
+    """A db_url pointing at a database that does not exist"""
+    return db_url + '_new'

tests/examples/test_connect_uri.py

@@ -0,0 +1,2 @@
+def test_uri(connect_uri):
+    assert isinstance(connect_uri, str)

tests/examples/test_db_schema.py

@@ -0,0 +1,7 @@
+from sqlalchemy.engine import Connection
+from sqlalchemy_utils import database_exists
+
+
+def test_db_schema(db_schema, engine):
+    assert db_schema is None  # Not very helpful?
+    assert database_exists(engine.url)

tests/examples/test_dbsession.py

@@ -0,0 +1,5 @@
+from sqlalchemy.orm import Session
+
+
+def test_session(dbsession):
+    assert isinstance(dbsession, Session)

tests/examples/test_minimal.py

@@ -0,0 +1,6 @@
+from sqlalchemy.engine import Connection
+
+
+def test_connection(connection):
+    assert isinstance(connection, Connection)
+    assert not connection.in_transaction()

tests/examples/test_transaction.py

@@ -0,0 +1,6 @@
+from sqlalchemy.engine import Connection
+
+
+def test_transaction(transaction):
+    assert isinstance(transaction, Connection)
+    assert transaction.in_transaction()

tests/examples/test_xdist.py

@@ -0,0 +1,5 @@
+def test_one(engine):
+    assert '_gw' in engine.url.database
+
+def test_two(engine):
+    assert '_gw' in engine.url.database