taskflow-meter 1.2.0__tar.gz → 1.3.0__tar.gz

{taskflow_meter-1.2.0 → taskflow_meter-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: taskflow-meter
-Version: 1.2.0
+Version: 1.3.0
 Summary: Monitoring interfaces (ASGI, WSGI, datasource) for OpenStack TaskFlow flow execution progress
 Project-URL: Homepage, https://github.com/daipham3213/taskflow.meter
 Project-URL: Source, https://github.com/daipham3213/taskflow.meter

{taskflow_meter-1.2.0 → taskflow_meter-1.3.0}/taskflow_meter/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '1.2.0'
-__version_tuple__ = version_tuple = (1, 2, 0)
+__version__ = version = '1.3.0'
+__version_tuple__ = version_tuple = (1, 3, 0)
 
 __commit_id__ = commit_id = None

{taskflow_meter-1.2.0 → taskflow_meter-1.3.0}/taskflow_meter/datasource/sqlalchemy/__init__.py

@@ -16,6 +16,7 @@ from __future__ import annotations
 
 from taskflow_meter.datasource.sqlalchemy.models import metadata
 from taskflow_meter.datasource.sqlalchemy.source import SQLADataSource
+from taskflow_meter.datasource.sqlalchemy.source import alembic_config
 from taskflow_meter.datasource.sqlalchemy.source import upgrade
 
-__all__ = ["SQLADataSource", "metadata", "upgrade"]
+__all__ = ["SQLADataSource", "alembic_config", "metadata", "upgrade"]

{taskflow_meter-1.2.0 → taskflow_meter-1.3.0}/taskflow_meter/datasource/sqlalchemy/migrations/env.py

@@ -13,16 +13,21 @@
 """Alembic environment for the meter's own schema.
 
 Driven programmatically by :func:`taskflow_meter.datasource.sqlalchemy
-.upgrade`, so the URL arrives through the config rather than from an
-``alembic.ini`` a deployment would have to carry.
+.upgrade`, so the connection arrives through the config rather than from
+an ``alembic.ini`` a deployment would have to carry.
+
+Everything variable is read from ``config.attributes``, never from a
+main option: alembic passes main options through configparser, which
+treats ``%`` as an interpolation and rejects a percent-encoded password.
+See :func:`~taskflow_meter.datasource.sqlalchemy.source.alembic_config`.
 """
 
 from __future__ import annotations
 
 from typing import Any
 
+import sqlalchemy as sa
 from alembic import context
-from sqlalchemy import engine_from_config
 from sqlalchemy import pool
 
 from taskflow_meter.datasource.sqlalchemy.models import metadata
@@ -39,12 +44,26 @@ DEFAULT_VERSION_TABLE = "alembic_version"
 
 
 def _version_table() -> str:
-    return config.get_main_option("version_table", DEFAULT_VERSION_TABLE)
+    return config.attributes.get("version_table") or DEFAULT_VERSION_TABLE
+
+
+def _url() -> str | None:
+    """Where to connect, when no live connection was handed over.
+
+    Falls back to the main option so that running these migrations from
+    a hand-written ``alembic.ini`` still works.  Escaping ``%`` is the
+    ini author's problem there, and ``%%`` is the documented convention
+    for it.
+    """
+    url = config.attributes.get("url")
+    if url is not None:
+        return str(url)
+    return config.get_main_option("sqlalchemy.url", None)
 
 
 def run_migrations_offline() -> None:
     context.configure(
-        url=config.get_main_option("sqlalchemy.url"),
+        url=_url(),
         target_metadata=target_metadata,
         literal_binds=True,
         dialect_opts={"paramstyle": "named"},
@@ -55,17 +74,29 @@ def run_migrations_offline() -> None:
 
 
 def run_migrations_online() -> None:
-    connectable = config.attributes.get("connection", None)
-    if connectable is None:
-        connectable = engine_from_config(
-            config.get_section(config.config_ini_section, {}),
-            prefix="sqlalchemy.",
-            poolclass=pool.NullPool,
-        )
-        with connectable.connect() as connection:
-            _run(connection)
+    connection = config.attributes.get("connection")
+    if connection is not None:
+        # The usual path: somebody else owns the connection and the
+        # transaction around it.
+        _run(connection)
         return
-    _run(connectable)
+
+    url = _url()
+    if url is None:
+        # Reached only by a config built by hand that set neither.
+        # Saying so beats whatever SQLAlchemy makes of ``None``.
+        msg = (
+            "no connection and no url to migrate: build the config with "
+            "taskflow_meter.datasource.sqlalchemy.alembic_config()"
+        )
+        raise RuntimeError(msg)
+
+    engine = sa.create_engine(url, poolclass=pool.NullPool)
+    try:
+        with engine.connect() as owned:
+            _run(owned)
+    finally:
+        engine.dispose()
 
 
 def _run(connection: Any) -> None:

{taskflow_meter-1.2.0 → taskflow_meter-1.3.0}/taskflow_meter/datasource/sqlalchemy/source.py

@@ -30,10 +30,14 @@ from collections.abc import Iterable
 from collections.abc import Iterator
 from dataclasses import asdict
 from pathlib import Path
+from typing import TYPE_CHECKING
 from typing import Any
 
 import sqlalchemy as sa
 
+if TYPE_CHECKING:
+    from alembic.config import Config
+
 from taskflow_meter.datasource.base import DEFAULT_EVENT_LIMIT
 from taskflow_meter.datasource.base import DEFAULT_FLOW_LIMIT
 from taskflow_meter.datasource.base import EventPage
@@ -371,11 +375,55 @@ def upgrade(
     database -- changing it later looks exactly like an unmigrated one.
     """
     from alembic import command
+
+    engine = sa.create_engine(url)
+    try:
+        # One live connection, handed over in ``attributes``.  The URL is
+        # parsed by SQLAlchemy, which understands URLs, and never by
+        # configparser, which does not.
+        with engine.begin() as connection:
+            config = alembic_config(
+                connection=connection, version_table=version_table
+            )
+            command.upgrade(config, revision)
+    finally:
+        engine.dispose()
+
+
+def alembic_config(
+    *,
+    url: str | None = None,
+    connection: sa.Connection | None = None,
+    version_table: str | None = None,
+) -> Config:
+    """Build the config this package's migrations run under.
+
+    Public because ``upgrade`` is not the only thing an operator runs:
+    ``downgrade``, ``stamp`` and ``--sql`` mode all need a config, and
+    building one by hand is how the escaping rule below gets forgotten.
+
+    Everything variable travels in ``config.attributes`` rather than as
+    a main option, because alembic hands main options to configparser,
+    which reads ``%`` as the start of an interpolation and rejects
+    anything that is not one. Escaping it to ``%%`` does work, but
+    only for whoever remembers; keeping the value out of configparser
+    altogether cannot be forgotten.
+
+    Pass *connection* for a live migration, or *url* for ``--sql`` mode,
+    which has no connection to offer.
+    """
     from alembic.config import Config
 
     config = Config()
-    config.set_main_option("script_location", str(MIGRATIONS))
-    config.set_main_option("sqlalchemy.url", url)
-    if version_table is not None:
-        config.set_main_option("version_table", version_table)
-    command.upgrade(config, revision)
+    # script_location has to be a main option -- alembic reads it from
+    # there to find the scripts.  It is a path inside this package
+    # rather than anything a caller supplies, but an install prefix
+    # containing "%" is unusual rather than impossible, so it gets the
+    # escaping that the URL no longer needs.
+    config.set_main_option(
+        "script_location", str(MIGRATIONS).replace("%", "%%")
+    )
+    config.attributes["url"] = url
+    config.attributes["connection"] = connection
+    config.attributes["version_table"] = version_table
+    return config

{taskflow_meter-1.2.0 → taskflow_meter-1.3.0}/tests/functional/test_migrations.py

@@ -25,18 +25,20 @@ import sqlalchemy as sa
 from alembic import command
 from alembic.config import Config
 
-from taskflow_meter.datasource.sqlalchemy.source import MIGRATIONS
 from taskflow_meter.datasource.sqlalchemy.source import SQLADataSource
+from taskflow_meter.datasource.sqlalchemy.source import alembic_config
 from taskflow_meter.datasource.sqlalchemy.source import upgrade
 from taskflow_meter.events import Event
 from taskflow_meter.events import EventKind
 
 
 def config_for(url: str) -> Config:
-    config = Config()
-    config.set_main_option("script_location", str(MIGRATIONS))
-    config.set_main_option("sqlalchemy.url", url)
-    return config
+    """What an operator building their own config should call.
+
+    A second, hand-rolled config here is how the tests would stop
+    covering the one that ships.
+    """
+    return alembic_config(url=url)
 
 
 def tables_of(url: str) -> set[str]:
@@ -61,6 +63,20 @@ def test_upgrading_creates_the_tables(url: str) -> None:
     }
 
 
+def test_a_percent_encoded_url_is_not_read_as_interpolation(
+    tmp_path: Path,
+) -> None:
+    """``Fci%40123%21`` is a password, not a configparser substitution."""
+    url = f"sqlite:///{tmp_path / 'me%40ter.db'}"
+
+    upgrade(url)
+
+    assert tables_of(url) == {
+        "taskflow_meter_flows",
+        "taskflow_meter_events",
+    }
+
+
 def test_downgrading_removes_them_again(url: str) -> None:
     # A migration whose downgrade is wrong is worse than one with none:
     # it fails halfway through somebody's rollback.
@@ -99,3 +115,55 @@ def test_the_revision_is_recorded(url: str) -> None:
             sa.text("SELECT version_num FROM alembic_version")
         ).scalar()
     assert version == "0001"
+
+
+def test_offline_sql_also_survives_a_percent_encoded_url(
+    tmp_path: Path, capsys: pytest.CaptureFixture[str]
+) -> None:
+    """The half the old ``%%`` escape did not reach.
+
+    ``upgrade`` escaped the URL itself, so it coped; anyone building a
+    config for ``--sql`` got a ValueError out of configparser instead.
+    """
+    url = f"sqlite:///{tmp_path / 'me%40ter.db'}"
+
+    command.upgrade(alembic_config(url=url), "head", sql=True)
+
+    assert "CREATE TABLE taskflow_meter_flows" in capsys.readouterr().out
+
+
+def test_the_url_never_reaches_configparser() -> None:
+    """The structural reason the percent tests pass.
+
+    Not an implementation detail: the moment a URL goes back into a
+    main option, every percent-encoded password breaks again.
+    """
+    url = "mysql+pymysql://u:abc%40123%21%40%23@127.0.0.1:3306/grimoire"
+
+    config = alembic_config(url=url)
+
+    assert config.attributes["url"] == url
+    assert config.get_main_option("sqlalchemy.url", None) is None
+    # And nothing in the ini section carries it either.
+    section = dict(config.get_section(config.config_ini_section, {}))
+    assert not any(url in str(value) for value in section.values())
+
+
+def test_a_percent_encoded_url_needs_no_escaping_by_the_caller() -> None:
+    """The whole point: hand it over exactly as it arrived."""
+    url = "mysql+pymysql://u:abc%40123%21%40%23@db.internal:3306/grimoire"
+    assert alembic_config(url=url).attributes["url"] == url
+
+
+def test_a_borrowed_connection_is_used_rather_than_a_new_one(
+    url: str,
+) -> None:
+    """``upgrade`` hands alembic a live connection, not a URL to open."""
+    upgrade(url)
+
+    engine = sa.create_engine(url)
+    with engine.begin() as connection:
+        command.downgrade(alembic_config(connection=connection), "base")
+    engine.dispose()
+
+    assert tables_of(url) == set()