splent-framework 1.30.0__tar.gz → 1.30.2__tar.gz

{splent_framework-1.30.0/src/splent_framework.egg-info → splent_framework-1.30.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splent_framework
-Version: 1.30.0
+Version: 1.30.2
 Summary: SPLENT-FRAMEWORK is a set of libraries for agile product development within SPLENT.
 Author-email: DiversoLab <diversolab@us.es>
 License-Expression: LGPL-3.0-or-later
@@ -33,6 +33,7 @@ Requires-Dist: rq<3,>=2.0; extra == "rq"
 Provides-Extra: dev
 Requires-Dist: pytest>=8.3; extra == "dev"
 Requires-Dist: pytest-cov>=6.0; extra == "dev"
+Requires-Dist: pytest-xdist>=3.6; extra == "dev"
 Requires-Dist: Faker>=33.0; extra == "dev"
 Requires-Dist: rq<3,>=2.0; extra == "dev"
 Requires-Dist: fakeredis[lua]>=2.20; extra == "dev"

{splent_framework-1.30.0 → splent_framework-1.30.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "splent_framework"
-version = "1.30.0"
+version = "1.30.2"
 description = "SPLENT-FRAMEWORK is a set of libraries for agile product development within SPLENT."
 readme = "README.md"
 requires-python = ">=3.13"
@@ -38,6 +38,7 @@ rq = ["rq>=2.0,<3"]
 dev = [
     "pytest>=8.3",
     "pytest-cov>=6.0",
+    "pytest-xdist>=3.6",
     "Faker>=33.0",
     "rq>=2.0,<3",
     "fakeredis[lua]>=2.20",

splent_framework-1.30.2/src/splent_framework/__init__.py

@@ -0,0 +1,12 @@
+__all__ = ["create_splent_app"]
+
+
+def __getattr__(name):
+    # Importing any splent_framework module runs this file first. Loading the
+    # app factory here pulled Flask, SQLAlchemy and Alembic into every import,
+    # so it is loaded when asked for.
+    if name == "create_splent_app":
+        from splent_framework.app_factory import create_splent_app
+
+        return create_splent_app
+    raise AttributeError(f"module 'splent_framework' has no attribute {name!r}")

splent_framework-1.30.2/src/splent_framework/fixtures/fixtures.py

@@ -0,0 +1,180 @@
+import hashlib
+
+import pytest
+from sqlalchemy import inspect, text
+from splent_framework.db import db
+from splent_framework.decorators.decorators import isolated_access_policies
+from splent_framework.managers.migration_manager import SPLENT_MIGRATIONS_TABLE
+from splent_framework.utils.app_loader import get_create_app_in_testing_mode
+
+# What the database looked like right after the last full reset, per
+# database URL. While it still looks the same, emptying the tables is
+# enough.
+_schema_after_reset: dict[str, str] = {}
+
+_SCHEMA_QUERIES = tuple(
+    text(sql)
+    for sql in (
+        "SELECT TABLE_NAME, TABLE_COLLATION FROM information_schema.TABLES "
+        "WHERE TABLE_SCHEMA = DATABASE() ORDER BY TABLE_NAME",
+        "SELECT TABLE_NAME, COLUMN_NAME, COLUMN_TYPE, IS_NULLABLE, COLUMN_KEY, "
+        "COLLATION_NAME, COLUMN_DEFAULT, EXTRA FROM information_schema.COLUMNS "
+        "WHERE TABLE_SCHEMA = DATABASE() ORDER BY TABLE_NAME, ORDINAL_POSITION",
+        "SELECT TABLE_NAME, INDEX_NAME, NON_UNIQUE, SEQ_IN_INDEX, COLUMN_NAME "
+        "FROM information_schema.STATISTICS WHERE TABLE_SCHEMA = DATABASE() "
+        "ORDER BY TABLE_NAME, INDEX_NAME, SEQ_IN_INDEX",
+        "SELECT TABLE_NAME, CONSTRAINT_NAME, COLUMN_NAME, REFERENCED_TABLE_NAME, "
+        "REFERENCED_COLUMN_NAME FROM information_schema.KEY_COLUMN_USAGE "
+        "WHERE TABLE_SCHEMA = DATABASE() "
+        "ORDER BY TABLE_NAME, CONSTRAINT_NAME, ORDINAL_POSITION",
+        "SELECT TRIGGER_NAME, EVENT_OBJECT_TABLE, ACTION_TIMING, "
+        "EVENT_MANIPULATION, ACTION_STATEMENT FROM information_schema.TRIGGERS "
+        "WHERE TRIGGER_SCHEMA = DATABASE() ORDER BY TRIGGER_NAME",
+    )
+)
+
+_TABLES_WITH_MOVED_COUNTER = text(
+    "SELECT TABLE_NAME FROM information_schema.TABLES "
+    "WHERE TABLE_SCHEMA = DATABASE() AND AUTO_INCREMENT > 1"
+)
+
+
+def _schema(conn):
+    """A digest of the database's schema and of the tables the app declares."""
+    rows = [conn.execute(query).all() for query in _SCHEMA_QUERIES]
+    declared = [
+        (table.name, [column.name for column in table.columns])
+        for table in db.metadata.sorted_tables
+    ]
+    return hashlib.sha1(repr((rows, declared)).encode()).hexdigest()
+
+
+def _drop_and_create():
+    """Drop every table of the test database and create the app's.
+
+    The test database is shared: a product's tests and the neutral app of
+    a feature's release gate, which loads a few features, run against the
+    same one. Dropping only the app's own tables left the other apps'
+    behind, with the rows their last test left, and those pointed at the
+    ids the reset hands out again: a neutral app recreated ``user``, the
+    user_profile row of the previous product run then named its new user
+    1, and deleting that account failed on the foreign key. splent_migrations,
+    which the app made when it started, stays.
+    """
+    with db.engine.connect() as conn:
+        conn.execute(text("SET FOREIGN_KEY_CHECKS=0"))
+        db.metadata.drop_all(bind=conn)
+        quote = conn.dialect.identifier_preparer.quote
+        for name in inspect(conn).get_table_names():
+            if name != SPLENT_MIGRATIONS_TABLE:
+                conn.execute(
+                    text(f"DROP TABLE {quote(name)}")
+                )  # splent: allow sql-from-string
+        conn.execute(text("SET FOREIGN_KEY_CHECKS=1"))
+        db.metadata.create_all(bind=conn)
+        conn.commit()
+
+
+def _empty_tables(conn):
+    """Delete every row of the app's tables and restart the id counters
+    that moved, so the next test sees what a fresh create_all leaves."""
+    quote = conn.dialect.identifier_preparer.quote
+    conn.execute(text("SET FOREIGN_KEY_CHECKS=0"))
+    for table in db.metadata.sorted_tables:
+        conn.execute(
+            text(f"DELETE FROM {quote(table.name)}")
+        )  # splent: allow sql-from-string
+    for (name,) in conn.execute(_TABLES_WITH_MOVED_COUNTER).all():
+        conn.execute(
+            text(f"ALTER TABLE {quote(name)} AUTO_INCREMENT = 1")
+        )  # splent: allow sql-from-string
+    conn.execute(text("SET FOREIGN_KEY_CHECKS=1"))
+
+
+def _reset_db():
+    """Leave the test database with the app's tables, empty.
+
+    Dropping and creating every table costs most of a short test, so it
+    happens once per process and database. After that the tables are only
+    emptied, as long as the schema still matches the one the full reset
+    left: if a migration test, another app sharing the database or a model
+    declared later changed it, the tables are dropped and created again.
+    Databases other than MariaDB and MySQL always get the full reset.
+    """
+    db.session.remove()
+    engine = db.engine
+    if engine.dialect.name != "mysql":
+        _drop_and_create()
+        return
+    key = str(engine.url)
+    with engine.begin() as conn:
+        if not getattr(engine.dialect, "is_mariadb", False):
+            # MySQL 8 caches AUTO_INCREMENT in information_schema for a day.
+            conn.execute(text("SET SESSION information_schema_stats_expiry = 0"))
+        if _schema_after_reset.get(key) == _schema(conn):
+            _empty_tables(conn)
+            return
+    _drop_and_create()
+    with engine.connect() as conn:
+        _schema_after_reset[key] = _schema(conn)
+
+
+@pytest.fixture(scope="session")
+def test_app():
+    """
+    Creates and initializes the Flask app for the test session.
+    Drops and creates all tables once per session.
+    """
+    app = get_create_app_in_testing_mode()
+    with app.app_context():
+        _reset_db()
+    yield app
+
+
+@pytest.fixture(scope="function")
+def test_client(test_app):
+    """
+    Provides a test client with a clean database for each test.
+    Tables are dropped and recreated before the test runs.
+    """
+    with test_app.app_context():
+        _reset_db()
+    with test_app.test_client() as client:
+        yield client
+
+
+@pytest.fixture(scope="module")
+def test_client_module(test_app):
+    """
+    Shared test client for the entire module.
+    Resets the database once at the start of the module.
+    Tests within the module share database state.
+    """
+    with test_app.app_context():
+        _reset_db()
+
+        with test_app.test_client() as client:
+            yield client
+
+
+@pytest.fixture(scope="function")
+def clean_database(test_app):
+    """
+    Manually resets the database within a test.
+    Combine with test_client_module when you need a selective
+    reset inside a module-scoped session.
+    """
+    with test_app.app_context():
+        _reset_db()
+        yield
+
+
+@pytest.fixture(scope="function")
+def no_access_policies():
+    """
+    Runs the test with no access policies registered, and restores the ones
+    other features registered at startup when it ends. Use it to test a
+    feature's own role gate, or register a policy inside the test.
+    """
+    with isolated_access_policies():
+        yield

{splent_framework-1.30.0 → splent_framework-1.30.2/src/splent_framework.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splent_framework
-Version: 1.30.0
+Version: 1.30.2
 Summary: SPLENT-FRAMEWORK is a set of libraries for agile product development within SPLENT.
 Author-email: DiversoLab <diversolab@us.es>
 License-Expression: LGPL-3.0-or-later
@@ -33,6 +33,7 @@ Requires-Dist: rq<3,>=2.0; extra == "rq"
 Provides-Extra: dev
 Requires-Dist: pytest>=8.3; extra == "dev"
 Requires-Dist: pytest-cov>=6.0; extra == "dev"
+Requires-Dist: pytest-xdist>=3.6; extra == "dev"
 Requires-Dist: Faker>=33.0; extra == "dev"
 Requires-Dist: rq<3,>=2.0; extra == "dev"
 Requires-Dist: fakeredis[lua]>=2.20; extra == "dev"

{splent_framework-1.30.0 → splent_framework-1.30.2}/src/splent_framework.egg-info/SOURCES.txt

@@ -182,6 +182,7 @@ tests/test_i18n_text.py
 tests/test_icons.py
 tests/test_isolated.py
 tests/test_keys.py
+tests/test_lazy_package_init.py
 tests/test_locale_manager.py
 tests/test_locustfile_bootstrap.py
 tests/test_mapper_guard.py

{splent_framework-1.30.0 → splent_framework-1.30.2}/src/splent_framework.egg-info/requires.txt

@@ -20,6 +20,7 @@ pygments>=2.17
 [dev]
 pytest>=8.3
 pytest-cov>=6.0
+pytest-xdist>=3.6
 Faker>=33.0
 rq<3,>=2.0
 fakeredis[lua]>=2.20

splent_framework-1.30.2/tests/test_fixtures_reset_db.py

@@ -0,0 +1,167 @@
+"""The test fixtures start every test on an empty test database.
+
+The full reset drops and creates every table once per process and database;
+after that the tables are only emptied while the schema stays the one the
+full reset left.
+
+The full reset used to drop and recreate only the tables of the app under test. The
+test database is shared by a product's tests and by the neutral app a
+feature's release gate builds, which loads a few features: the tables only
+the product knows survived a neutral run with the rows their last test
+left, pointing at the ids the reset hands out again. legal's test that
+deletes an account failed on a user_profile row of user 1 left by the
+product's run.
+
+Run on SQLite with the app's db replaced, the MariaDB statements read as
+SQLite's.
+"""
+
+from contextlib import contextmanager
+from types import SimpleNamespace
+
+import sqlalchemy as sa
+from sqlalchemy import text
+
+from splent_framework.fixtures import fixtures
+from splent_framework.managers.migration_manager import SPLENT_MIGRATIONS_TABLE
+
+
+def _engine(path):
+    engine = sa.create_engine(f"sqlite:///{path}")
+
+    @sa.event.listens_for(engine, "before_cursor_execute", retval=True)
+    def as_sqlite(conn, cursor, statement, parameters, context, executemany):
+        if statement.startswith("SET FOREIGN_KEY_CHECKS"):
+            state = "OFF" if statement.rstrip().endswith("0") else "ON"
+            statement = f"PRAGMA foreign_keys={state}"
+        return statement, parameters
+
+    return engine
+
+
+def test_the_tables_another_app_left_are_dropped(tmp_path, monkeypatch):
+    engine = _engine(tmp_path / "test.db")
+    with engine.begin() as conn:
+        conn.execute(text("CREATE TABLE user (id INTEGER PRIMARY KEY)"))
+        conn.execute(
+            text(
+                "CREATE TABLE user_profile (id INTEGER PRIMARY KEY, "
+                "user_id INTEGER REFERENCES user (id))"
+            )
+        )
+        conn.execute(
+            text(f"CREATE TABLE {SPLENT_MIGRATIONS_TABLE} (feature TEXT PRIMARY KEY)")
+        )
+        conn.execute(text("INSERT INTO user VALUES (1)"))
+        conn.execute(text("INSERT INTO user_profile VALUES (1, 1)"))
+    ours = sa.MetaData()
+    sa.Table("user", ours, sa.Column("id", sa.Integer, primary_key=True))
+    monkeypatch.setattr(
+        fixtures,
+        "db",
+        SimpleNamespace(
+            session=SimpleNamespace(remove=lambda: None), engine=engine, metadata=ours
+        ),
+    )
+
+    fixtures._reset_db()
+
+    # The app's tables, empty, and the table the app makes when it starts.
+    assert sorted(sa.inspect(engine).get_table_names()) == sorted(
+        [SPLENT_MIGRATIONS_TABLE, "user"]
+    )
+    with engine.connect() as conn:
+        assert conn.execute(text("SELECT COUNT(*) FROM user")).scalar() == 0
+
+
+class _Engine:
+    """Just what _reset_db reads from an engine: dialect, url and begin()."""
+
+    def __init__(self, name="mysql", url="mysql://test/db_test", mariadb=True):
+        self.dialect = SimpleNamespace(name=name, is_mariadb=mariadb)
+        self.url = url
+        self.statements = []
+
+    @contextmanager
+    def begin(self):
+        yield SimpleNamespace(execute=lambda st: self.statements.append(str(st)))
+
+    connect = begin
+
+
+def _wire(monkeypatch, engine, schema):
+    calls = []
+    monkeypatch.setattr(
+        fixtures,
+        "db",
+        SimpleNamespace(session=SimpleNamespace(remove=lambda: None), engine=engine),
+    )
+    monkeypatch.setattr(fixtures, "_schema_after_reset", {})
+    monkeypatch.setattr(fixtures, "_schema", lambda conn: schema[0])
+    monkeypatch.setattr(fixtures, "_drop_and_create", lambda: calls.append("full"))
+    monkeypatch.setattr(fixtures, "_empty_tables", lambda conn: calls.append("empty"))
+    return calls
+
+
+def test_the_tables_are_emptied_while_the_schema_stays(monkeypatch):
+    schema = ["a"]
+    calls = _wire(monkeypatch, _Engine(), schema)
+
+    fixtures._reset_db()
+    fixtures._reset_db()
+    fixtures._reset_db()
+
+    assert calls == ["full", "empty", "empty"]
+
+
+def test_a_changed_schema_gets_the_full_reset_again(monkeypatch):
+    schema = ["a"]
+    calls = _wire(monkeypatch, _Engine(), schema)
+
+    fixtures._reset_db()
+    schema[0] = "b"  # a migration test altered a table
+    fixtures._reset_db()
+    fixtures._reset_db()
+
+    assert calls == ["full", "full", "empty"]
+
+
+def test_each_database_gets_its_own_first_full_reset(monkeypatch):
+    schema = ["a"]
+    first = _Engine(url="mysql://test/db_test")
+    calls = _wire(monkeypatch, first, schema)
+
+    fixtures._reset_db()
+    fixtures.db.engine = _Engine(url="mysql://test/db_test_2")
+    fixtures._reset_db()
+    fixtures.db.engine = first
+    fixtures._reset_db()
+
+    assert calls == ["full", "full", "empty"]
+
+
+def test_other_databases_always_get_the_full_reset(monkeypatch):
+    calls = _wire(monkeypatch, _Engine(name="sqlite"), ["a"])
+
+    fixtures._reset_db()
+    fixtures._reset_db()
+
+    assert calls == ["full", "full"]
+
+
+def test_mysql_reads_the_id_counters_uncached(monkeypatch):
+    mysql = _Engine(mariadb=False)
+    _wire(monkeypatch, mysql, ["a"])
+
+    fixtures._reset_db()
+
+    assert "SET SESSION information_schema_stats_expiry = 0" in mysql.statements
+
+
+def test_mariadb_needs_no_stats_setting(monkeypatch):
+    mariadb = _Engine()
+    _wire(monkeypatch, mariadb, ["a"])
+
+    fixtures._reset_db()
+
+    assert not any("stats_expiry" in st for st in mariadb.statements)

splent_framework-1.30.2/tests/test_lazy_package_init.py

@@ -0,0 +1,27 @@
+"""Importing a framework module does not load the app factory and its stack."""
+
+import subprocess
+import sys
+
+
+def _run(code):
+    return subprocess.run(
+        [sys.executable, "-c", code], capture_output=True, text=True, check=True
+    ).stdout.strip()
+
+
+def test_a_framework_module_imports_without_flask():
+    loaded = _run(
+        "import sys, splent_framework.utils.path_utils;"
+        "print('flask' in sys.modules, 'splent_framework.app_factory' in sys.modules)"
+    )
+    assert loaded == "False False"
+
+
+def test_the_app_factory_is_still_importable_from_the_package():
+    assert (
+        _run(
+            "from splent_framework import create_splent_app; print(create_splent_app.__name__)"
+        )
+        == "create_splent_app"
+    )

splent_framework-1.30.0/src/splent_framework/__init__.py

@@ -1,3 +0,0 @@
-from splent_framework.app_factory import create_splent_app
-
-__all__ = ["create_splent_app"]

splent_framework-1.30.0/src/splent_framework/fixtures/fixtures.py

@@ -1,95 +0,0 @@
-import pytest
-from sqlalchemy import inspect, text
-from splent_framework.db import db
-from splent_framework.decorators.decorators import isolated_access_policies
-from splent_framework.managers.migration_manager import SPLENT_MIGRATIONS_TABLE
-from splent_framework.utils.app_loader import get_create_app_in_testing_mode
-
-
-def _reset_db():
-    """Drop every table of the test database and create the app's.
-    Disables FK checks for MariaDB.
-
-    The test database is shared: a product's tests and the neutral app of
-    a feature's release gate, which loads a few features, run against the
-    same one. Dropping only the app's own tables left the other apps'
-    behind, with the rows their last test left, and those pointed at the
-    ids the reset hands out again: a neutral app recreated ``user``, the
-    user_profile row of the previous product run then named its new user
-    1, and deleting that account failed on the foreign key. splent_migrations,
-    which the app made when it started, stays.
-    """
-    db.session.remove()
-    with db.engine.connect() as conn:
-        conn.execute(text("SET FOREIGN_KEY_CHECKS=0"))
-        db.metadata.drop_all(bind=conn)
-        quote = conn.dialect.identifier_preparer.quote
-        for name in inspect(conn).get_table_names():
-            if name != SPLENT_MIGRATIONS_TABLE:
-                conn.execute(
-                    text(f"DROP TABLE {quote(name)}")
-                )  # splent: allow sql-from-string
-        conn.execute(text("SET FOREIGN_KEY_CHECKS=1"))
-        db.metadata.create_all(bind=conn)
-        conn.commit()
-
-
-@pytest.fixture(scope="session")
-def test_app():
-    """
-    Creates and initializes the Flask app for the test session.
-    Drops and creates all tables once per session.
-    """
-    app = get_create_app_in_testing_mode()
-    with app.app_context():
-        _reset_db()
-    yield app
-
-
-@pytest.fixture(scope="function")
-def test_client(test_app):
-    """
-    Provides a test client with a clean database for each test.
-    Tables are dropped and recreated before the test runs.
-    """
-    with test_app.app_context():
-        _reset_db()
-    with test_app.test_client() as client:
-        yield client
-
-
-@pytest.fixture(scope="module")
-def test_client_module(test_app):
-    """
-    Shared test client for the entire module.
-    Resets the database once at the start of the module.
-    Tests within the module share database state.
-    """
-    with test_app.app_context():
-        _reset_db()
-
-        with test_app.test_client() as client:
-            yield client
-
-
-@pytest.fixture(scope="function")
-def clean_database(test_app):
-    """
-    Manually resets the database within a test.
-    Combine with test_client_module when you need a selective
-    reset inside a module-scoped session.
-    """
-    with test_app.app_context():
-        _reset_db()
-        yield
-
-
-@pytest.fixture(scope="function")
-def no_access_policies():
-    """
-    Runs the test with no access policies registered, and restores the ones
-    other features registered at startup when it ends. Use it to test a
-    feature's own role gate, or register a policy inside the test.
-    """
-    with isolated_access_policies():
-        yield

splent_framework-1.30.0/tests/test_fixtures_reset_db.py

@@ -1,69 +0,0 @@
-"""The test fixtures start every test on an empty test database.
-
-_reset_db dropped and recreated the tables of the app under test only. The
-test database is shared by a product's tests and by the neutral app a
-feature's release gate builds, which loads a few features: the tables only
-the product knows survived a neutral run with the rows their last test
-left, pointing at the ids the reset hands out again. legal's test that
-deletes an account failed on a user_profile row of user 1 left by the
-product's run.
-
-Run on SQLite with the app's db replaced, the MariaDB statements read as
-SQLite's.
-"""
-
-from types import SimpleNamespace
-
-import sqlalchemy as sa
-from sqlalchemy import text
-
-from splent_framework.fixtures import fixtures
-from splent_framework.managers.migration_manager import SPLENT_MIGRATIONS_TABLE
-
-
-def _engine(path):
-    engine = sa.create_engine(f"sqlite:///{path}")
-
-    @sa.event.listens_for(engine, "before_cursor_execute", retval=True)
-    def as_sqlite(conn, cursor, statement, parameters, context, executemany):
-        if statement.startswith("SET FOREIGN_KEY_CHECKS"):
-            state = "OFF" if statement.rstrip().endswith("0") else "ON"
-            statement = f"PRAGMA foreign_keys={state}"
-        return statement, parameters
-
-    return engine
-
-
-def test_the_tables_another_app_left_are_dropped(tmp_path, monkeypatch):
-    engine = _engine(tmp_path / "test.db")
-    with engine.begin() as conn:
-        conn.execute(text("CREATE TABLE user (id INTEGER PRIMARY KEY)"))
-        conn.execute(
-            text(
-                "CREATE TABLE user_profile (id INTEGER PRIMARY KEY, "
-                "user_id INTEGER REFERENCES user (id))"
-            )
-        )
-        conn.execute(
-            text(f"CREATE TABLE {SPLENT_MIGRATIONS_TABLE} (feature TEXT PRIMARY KEY)")
-        )
-        conn.execute(text("INSERT INTO user VALUES (1)"))
-        conn.execute(text("INSERT INTO user_profile VALUES (1, 1)"))
-    ours = sa.MetaData()
-    sa.Table("user", ours, sa.Column("id", sa.Integer, primary_key=True))
-    monkeypatch.setattr(
-        fixtures,
-        "db",
-        SimpleNamespace(
-            session=SimpleNamespace(remove=lambda: None), engine=engine, metadata=ours
-        ),
-    )
-
-    fixtures._reset_db()
-
-    # The app's tables, empty, and the table the app makes when it starts.
-    assert sorted(sa.inspect(engine).get_table_names()) == sorted(
-        [SPLENT_MIGRATIONS_TABLE, "user"]
-    )
-    with engine.connect() as conn:
-        assert conn.execute(text("SELECT COUNT(*) FROM user")).scalar() == 0