capabilities-contract 0.1.0__py3-none-any.whl

capabilities_contract/__init__.py

@@ -0,0 +1,5 @@
+"""The capabilities contract as a library. Its first part is `capabilities_contract.db`."""
+
+from capabilities_contract.version import __version__
+
+__all__ = ["__version__"]

capabilities_contract/db/__init__.py

@@ -0,0 +1,31 @@
+"""The shared database layer: read the machine's store setting, connect bound to its
+schema, and migrate each owner's tables once under a ledger.
+
+Importing this module does not import psycopg; `connect` and `migrate` do.
+"""
+
+from capabilities_contract.db._connect import connect
+from capabilities_contract.db._errors import DbError
+from capabilities_contract.db._migrate import MigrateResult, Step, migrate
+from capabilities_contract.db._setting import (
+    DEFAULT_SCHEMA,
+    SETTING_SCHEMA_V1,
+    SETTING_SCHEMA_V2,
+    Setting,
+    read_setting,
+    setting_files,
+)
+
+__all__ = [
+    "DEFAULT_SCHEMA",
+    "SETTING_SCHEMA_V1",
+    "SETTING_SCHEMA_V2",
+    "DbError",
+    "MigrateResult",
+    "Setting",
+    "Step",
+    "connect",
+    "migrate",
+    "read_setting",
+    "setting_files",
+]

capabilities_contract/db/_connect.py

@@ -0,0 +1,63 @@
+"""A connection bound to the configured schema. psycopg is imported here, lazily."""
+
+from __future__ import annotations
+
+import weakref
+from typing import Any
+
+from capabilities_contract.db._errors import DbError
+from capabilities_contract.db._setting import Setting, check_schema_name, read_setting
+
+# The schema each connection from `connect` is bound to, so `migrate` needs no
+# second argument naming it.
+_BOUND: weakref.WeakKeyDictionary = weakref.WeakKeyDictionary()
+
+
+def _psycopg():
+    try:
+        import psycopg
+        from psycopg import sql
+    except ImportError as exc:  # pragma: no cover - depends on the installed wheels
+        raise DbError("driver_missing", "psycopg is not installed",
+                      "depend on capabilities-contract, which brings psycopg[binary]") from exc
+    return psycopg, sql
+
+
+def bind_search_path(conn: Any, schema: str) -> None:
+    """Set the session's search_path to `schema` alone."""
+    _, sql = _psycopg()
+    conn.execute(sql.SQL("SET search_path TO {}").format(sql.Identifier(schema)))
+
+
+def connect(*, application_name: str, setting: Setting | None = None,
+            connect_timeout: int = 10) -> Any:
+    """A psycopg connection to the store, with search_path set to the configured
+    schema only (never `public`). The schema need not exist yet: `migrate` creates
+    it. The connection is returned idle, outside any transaction."""
+    if not isinstance(application_name, str) or not application_name:
+        raise DbError("bad_application_name", "application_name must be a non-empty string")
+    setting = setting if setting is not None else read_setting()
+    schema = check_schema_name(setting.schema)
+    psycopg, _ = _psycopg()
+    try:
+        conn = psycopg.connect(**setting.connect_kwargs(), application_name=application_name,
+                               connect_timeout=connect_timeout)
+    except psycopg.OperationalError as exc:
+        raise DbError("store_unreachable", f"cannot reach the store: {exc}",
+                      "check the store setting with `capabilities store doctor`") from exc
+    try:
+        bind_search_path(conn, schema)
+        conn.commit()
+    except Exception:
+        conn.close()
+        raise
+    _BOUND[conn] = schema
+    return conn
+
+
+def bound_schema(conn: Any) -> str | None:
+    """The schema `connect` bound this connection to, or None."""
+    try:
+        return _BOUND.get(conn)
+    except TypeError:
+        return None

capabilities_contract/db/_errors.py

@@ -0,0 +1,12 @@
+class DbError(Exception):
+    """Every failure the database layer reports. `slug` is stable and machine-read,
+    `message` says what happened, `hint` (possibly None) says what to do."""
+
+    def __init__(self, slug: str, message: str, hint: str | None = None):
+        super().__init__(message)
+        self.slug = slug
+        self.message = message
+        self.hint = hint
+
+    def __repr__(self) -> str:
+        return f"DbError({self.slug!r}, {self.message!r}, {self.hint!r})"

capabilities_contract/db/_migrate.py

@@ -0,0 +1,282 @@
+"""Each owner's tables, migrated once under a ledger.
+
+An owner is the tool that owns a set of tables, named for it: every relation, index,
+sequence, type and function its steps create is named `<owner>` or `<owner>_*`, in
+the configured schema. Two platform tables in the same schema keep the books:
+`schema_ledger` (one row per applied step) and `schema_version` (one row per owner).
+"""
+
+from __future__ import annotations
+
+import hashlib
+import re
+from collections.abc import Iterable, Sequence
+from dataclasses import dataclass, field
+from typing import Any
+
+from capabilities_contract.db._connect import _psycopg, bind_search_path, bound_schema
+from capabilities_contract.db._errors import DbError
+from capabilities_contract.db._setting import check_schema_name
+from capabilities_contract.version import __version__
+
+LEDGER_TABLE = "schema_ledger"
+VERSION_TABLE = "schema_version"
+RESERVED_NAMES = (LEDGER_TABLE, VERSION_TABLE)
+RESERVED_OWNERS = ("schema", "pg")
+
+# No underscore: then no owner's `<owner>_` prefix can cover another owner's.
+_OWNER = re.compile(r"[a-z][a-z0-9]{0,30}")
+_STEP_ID = re.compile(r"[A-Za-z0-9][A-Za-z0-9._-]{0,127}")
+
+
+@dataclass(frozen=True)
+class Step:
+    """One migration step: a stable id and the SQL it runs. The checksum is the
+    SHA-256 of the SQL text exactly as given."""
+
+    id: str
+    sql: str
+
+    @property
+    def checksum(self) -> str:
+        return hashlib.sha256(self.sql.encode("utf-8")).hexdigest()
+
+
+@dataclass
+class MigrateResult:
+    """What `migrate` did. `warnings` is empty unless the store is ahead of the
+    caller in a way the caller may still work with (a newer minor)."""
+
+    owner: str
+    schema: str
+    applied: list[str] = field(default_factory=list)
+    skipped: list[str] = field(default_factory=list)
+    warnings: list[str] = field(default_factory=list)
+    major: int | None = None
+    minor: int | None = None
+
+
+def check_owner(owner: object) -> str:
+    if not isinstance(owner, str) or not _OWNER.fullmatch(owner) or owner in RESERVED_OWNERS:
+        raise DbError("bad_owner", f"owner {owner!r} is not a lowercase identifier",
+                      "use lowercase letters and digits, starting with a letter, "
+                      "no underscore, at most 31 characters")
+    return owner
+
+
+def _check_version_numbers(major: object, minor: object) -> tuple[int, int]:
+    for name, value in (("major", major), ("minor", minor)):
+        if isinstance(value, bool) or not isinstance(value, int) or value < 0:
+            raise DbError("bad_version", f"{name} must be a non-negative integer")
+    return major, minor  # type: ignore[return-value]
+
+
+def _normalise_steps(steps: Iterable[Step | Sequence[str]]) -> list[Step]:
+    out: list[Step] = []
+    seen: set[str] = set()
+    for raw in steps:
+        if isinstance(raw, Step):
+            step = raw
+        elif isinstance(raw, (tuple, list)) and len(raw) == 2:
+            step = Step(raw[0], raw[1])
+        else:
+            raise DbError("bad_step", f"a step is a Step or a (step_id, sql) pair, not {raw!r}")
+        if not isinstance(step.id, str) or not _STEP_ID.fullmatch(step.id):
+            raise DbError("bad_step", f"step id {step.id!r} is not a valid step id",
+                          "letters, digits, '.', '_' and '-', starting with a letter or digit")
+        if not isinstance(step.sql, str) or not step.sql.strip():
+            raise DbError("bad_step", f"step {step.id!r} has no SQL")
+        if step.id in seen:
+            raise DbError("bad_step", f"step id {step.id!r} appears twice")
+        seen.add(step.id)
+        out.append(step)
+    return out
+
+
+_SYSTEM_NS = ("n.nspname NOT IN ('pg_catalog', 'information_schema') "
+              "AND n.nspname NOT LIKE 'pg\\_%'")
+
+# Every named object a step can leave behind in a user schema: relations (tables,
+# indexes, sequences, views, composite types), free-standing types (an array type
+# Postgres makes for another type is skipped), functions and procedures,
+# collations, statistics objects, and schemas themselves.
+_SNAPSHOT = f"""
+SELECT 'relation', c.oid::bigint, n.nspname, c.relname
+  FROM pg_class c JOIN pg_namespace n ON n.oid = c.relnamespace WHERE {_SYSTEM_NS}
+UNION ALL
+SELECT 'type', t.oid::bigint, n.nspname, t.typname
+  FROM pg_type t JOIN pg_namespace n ON n.oid = t.typnamespace
+ WHERE {_SYSTEM_NS} AND t.typrelid = 0
+   AND NOT EXISTS (SELECT 1 FROM pg_type e WHERE e.typarray = t.oid)
+UNION ALL
+SELECT 'function', p.oid::bigint, n.nspname, p.proname
+  FROM pg_proc p JOIN pg_namespace n ON n.oid = p.pronamespace WHERE {_SYSTEM_NS}
+UNION ALL
+SELECT 'collation', o.oid::bigint, n.nspname, o.collname
+  FROM pg_collation o JOIN pg_namespace n ON n.oid = o.collnamespace WHERE {_SYSTEM_NS}
+UNION ALL
+SELECT 'statistics', s.oid::bigint, n.nspname, s.stxname
+  FROM pg_statistic_ext s JOIN pg_namespace n ON n.oid = s.stxnamespace WHERE {_SYSTEM_NS}
+UNION ALL
+SELECT 'schema', n.oid::bigint, n.nspname, n.nspname FROM pg_namespace n WHERE {_SYSTEM_NS}
+"""
+
+
+def _snapshot(conn: Any) -> set[tuple]:
+    return set(conn.execute(_SNAPSHOT).fetchall())
+
+
+def _violations(before: set[tuple], after: set[tuple], owner: str, schema: str) -> list[str]:
+    bad = []
+    for kind, _oid, nspname, name in sorted(after - before, key=lambda r: (r[2], r[3])):
+        if kind == "schema":
+            bad.append(f"schema {name}")
+        elif nspname != schema:
+            bad.append(f"{kind} {nspname}.{name} (outside schema {schema})")
+        elif name in RESERVED_NAMES:
+            bad.append(f"{kind} {name} (reserved)")
+        elif not (name == owner or name.startswith(owner + "_")):
+            bad.append(f"{kind} {name}")
+    return bad
+
+
+def _lock(conn: Any, key: str) -> None:
+    conn.execute("SELECT pg_advisory_xact_lock(hashtextextended(%s, 0))", (key,))
+
+
+def _bootstrap(conn: Any, schema: str) -> None:
+    """Create the schema and the platform tables if missing, under the schema lock.
+    Existence is checked first, so a role that may not create them can still use them
+    once they exist."""
+    _, sql = _psycopg()
+    with conn.transaction():
+        _lock(conn, f"capabilities_contract:{schema}")
+        exists = conn.execute("SELECT 1 FROM pg_namespace WHERE nspname = %s",
+                              (schema,)).fetchone()
+        if not exists:
+            conn.execute(sql.SQL("CREATE SCHEMA {}").format(sql.Identifier(schema)))
+        ledger = conn.execute("SELECT to_regclass(%s)",
+                              (f'"{schema}".{LEDGER_TABLE}',)).fetchone()[0]
+        if ledger is None:
+            conn.execute(sql.SQL(
+                "CREATE TABLE {}.{} (owner text NOT NULL, step text NOT NULL, "
+                "checksum text NOT NULL, applied_at timestamptz NOT NULL DEFAULT now(), "
+                "library_version text NOT NULL, PRIMARY KEY (owner, step))").format(
+                    sql.Identifier(schema), sql.Identifier(LEDGER_TABLE)))
+        version = conn.execute("SELECT to_regclass(%s)",
+                               (f'"{schema}".{VERSION_TABLE}',)).fetchone()[0]
+        if version is None:
+            conn.execute(sql.SQL(
+                "CREATE TABLE {}.{} (owner text PRIMARY KEY, major integer NOT NULL, "
+                "minor integer NOT NULL, updated_at timestamptz NOT NULL DEFAULT now())").format(
+                    sql.Identifier(schema), sql.Identifier(VERSION_TABLE)))
+
+
+def _stored_version(conn: Any, schema: str, owner: str) -> tuple[int, int] | None:
+    _, sql = _psycopg()
+    row = conn.execute(sql.SQL("SELECT major, minor FROM {}.{} WHERE owner = %s").format(
+        sql.Identifier(schema), sql.Identifier(VERSION_TABLE)), (owner,)).fetchone()
+    return (row[0], row[1]) if row else None
+
+
+def _check_version(conn: Any, schema: str, owner: str, major: int, minor: int,
+                   result: MigrateResult) -> tuple[int, int] | None:
+    stored = _stored_version(conn, schema, owner)
+    if stored is None:
+        return None
+    s_major, s_minor = stored
+    if s_major > major:
+        raise DbError("schema_too_new",
+                      f"the store's {owner} tables are at schema version {s_major}.{s_minor}, "
+                      f"newer than the {major}.{minor} this code knows",
+                      f"update the release that owns the {owner} tables to one that knows "
+                      f"schema major {s_major}")
+    if s_major == major and s_minor > minor:
+        warning = (f"the store's {owner} tables are at schema version {s_major}.{s_minor}, "
+                   f"a newer minor than the {major}.{minor} this code knows; "
+                   "it works, but an update is available")
+        if warning not in result.warnings:
+            result.warnings.append(warning)
+    return stored
+
+
+def migrate(conn: Any, owner: str, steps: Iterable[Step | Sequence[str]], *,
+            major: int, minor: int, schema: str | None = None) -> MigrateResult:
+    """Apply `owner`'s steps that are not yet applied, in order, each once.
+
+    `conn` comes from `connect` (its bound schema is used) and must be idle. Each
+    step runs in its own transaction under a per-owner advisory lock, together with
+    its ledger row, so concurrent callers apply it exactly once. Refuses (DbError):
+    a stored major newer than `major` (`schema_too_new`), an applied step whose SQL
+    changed (`checksum_mismatch`), a step that creates an object not named
+    `<owner>`/`<owner>_*` in the schema (`naming_law`, rolled back), and a failing
+    step (`step_failed`, rolled back). A newer stored minor proceeds with a warning
+    in the result. Afterwards the caller's version is recorded unless the store's is
+    newer."""
+    psycopg, sql = _psycopg()
+    owner = check_owner(owner)
+    major, minor = _check_version_numbers(major, minor)
+    schema = check_schema_name(schema if schema is not None else bound_schema(conn))
+    plan = _normalise_steps(steps)
+    if conn.info.transaction_status != psycopg.pq.TransactionStatus.IDLE:
+        raise DbError("connection_busy", "migrate needs an idle connection",
+                      "commit or roll back before migrating")
+    result = MigrateResult(owner=owner, schema=schema)
+    lock_key = f"capabilities_contract:{schema}:{owner}"
+    ledger = sql.SQL("{}.{}").format(sql.Identifier(schema), sql.Identifier(LEDGER_TABLE))
+    versions = sql.SQL("{}.{}").format(sql.Identifier(schema), sql.Identifier(VERSION_TABLE))
+
+    _bootstrap(conn, schema)
+    bind_search_path(conn, schema)
+    conn.commit()
+
+    for step in plan:
+        with conn.transaction():
+            _lock(conn, lock_key)
+            _check_version(conn, schema, owner, major, minor, result)
+            row = conn.execute(sql.SQL("SELECT checksum FROM {} WHERE owner = %s AND step = %s")
+                               .format(ledger), (owner, step.id)).fetchone()
+            if row is not None:
+                if row[0] != step.checksum:
+                    raise DbError("checksum_mismatch",
+                                  f"step {step.id} of {owner} was applied with different SQL",
+                                  "never edit an applied step; add a new step instead")
+                result.skipped.append(step.id)
+                continue
+            before = _snapshot(conn)
+            try:
+                with conn.transaction():
+                    conn.execute(step.sql)
+            except psycopg.Error as exc:
+                raise DbError("step_failed", f"step {step.id} of {owner} failed: {exc}",
+                              "the step was rolled back; fix it and migrate again") from exc
+            if conn.info.transaction_status != psycopg.pq.TransactionStatus.INTRANS:
+                raise DbError("step_failed",
+                              f"step {step.id} of {owner} ended its own transaction",
+                              "a step may not COMMIT or ROLLBACK")
+            bind_search_path(conn, schema)
+            bad = _violations(before, _snapshot(conn), owner, schema)
+            if bad:
+                raise DbError("naming_law",
+                              f"step {step.id} of {owner} creates objects not named "
+                              f"{owner}_*: {', '.join(bad)}",
+                              f"name everything the step creates {owner} or {owner}_* "
+                              f"inside schema {schema}; the step was rolled back")
+            conn.execute(sql.SQL("INSERT INTO {} (owner, step, checksum, library_version) "
+                                 "VALUES (%s, %s, %s, %s)").format(ledger),
+                         (owner, step.id, step.checksum, __version__))
+            result.applied.append(step.id)
+
+    with conn.transaction():
+        _lock(conn, lock_key)
+        stored = _check_version(conn, schema, owner, major, minor, result)
+        if stored is None or (major, minor) >= stored:
+            conn.execute(sql.SQL(
+                "INSERT INTO {} (owner, major, minor) VALUES (%s, %s, %s) "
+                "ON CONFLICT (owner) DO UPDATE SET major = EXCLUDED.major, "
+                "minor = EXCLUDED.minor, updated_at = now()").format(versions),
+                (owner, major, minor))
+            result.major, result.minor = major, minor
+        else:
+            result.major, result.minor = stored
+    return result

capabilities_contract/db/_setting.py

@@ -0,0 +1,184 @@
+"""The machine's store setting, read exactly as the manager's store tier reads it.
+
+The manager is the one writer: `capabilities store set` writes the non-secret values
+to `$XDG_CONFIG_HOME/capabilities/store.json` and the password to
+`$XDG_CONFIG_HOME/capabilities/credentials.env` as `CAPABILITIES_STORE_PASSWORD`.
+This module reads both and writes nothing. `CAPABILITIES_STORE_URL`, when set, is the
+store in force and wins over the setting.
+
+A `capabilities.store.v1` setting binds the default schema `agentkit`. A
+`capabilities.store.v2` setting may name another one in `db_schema`; the document's
+own `schema` key already holds the setting's id, so the schema name has its own key.
+"""
+
+from __future__ import annotations
+
+import json
+import os
+import re
+from dataclasses import dataclass, field
+from pathlib import Path
+from urllib.parse import urlparse
+
+from capabilities_contract.db._errors import DbError
+
+SETTING_SCHEMA_V1 = "capabilities.store.v1"
+SETTING_SCHEMA_V2 = "capabilities.store.v2"
+SETTING_SCHEMAS = (SETTING_SCHEMA_V1, SETTING_SCHEMA_V2)
+PASSWORD_KEY = "CAPABILITIES_STORE_PASSWORD"
+URL_ENV = "CAPABILITIES_STORE_URL"
+SSLMODES = ("require", "verify-ca", "verify-full")
+SSLMODES_REFUSED = ("disable", "allow", "prefer")
+SETTING_FIELDS = ("host", "port", "database", "user", "sslmode", "sslrootcert")
+SCHEMA_FIELD = "db_schema"
+DEFAULT_SCHEMA = "agentkit"
+
+_IDENTIFIER = re.compile(r"[a-z_][a-z0-9_]{0,62}")
+_SYSTEM_SCHEMAS = ("public", "information_schema")
+
+NOT_CONFIGURED_HINT = "run capabilities store set"
+
+
+def check_schema_name(name: object) -> str:
+    """A schema name the library may bind: a lowercase identifier, never `public`
+    and never a system schema."""
+    if not isinstance(name, str) or not _IDENTIFIER.fullmatch(name):
+        raise DbError("bad_schema_name",
+                      f"schema name {name!r} is not a lowercase identifier",
+                      "use letters, digits and underscores, starting with a letter or _")
+    if name in _SYSTEM_SCHEMAS or name.startswith("pg_"):
+        raise DbError("bad_schema_name", f"schema {name!r} is reserved",
+                      "name a schema of the store's own, such as agentkit")
+    return name
+
+
+@dataclass(frozen=True)
+class Setting:
+    """Where the store is and which schema it binds.
+
+    Either `url` (from `CAPABILITIES_STORE_URL`) or the host fields are set. `source`
+    is `CAPABILITIES_STORE_URL` or the setting file's path. The password and URL are
+    never shown in the repr."""
+
+    schema: str = DEFAULT_SCHEMA
+    source: str = ""
+    url: str | None = field(default=None, repr=False)
+    host: str | None = None
+    port: int | None = None
+    database: str | None = None
+    user: str | None = None
+    sslmode: str | None = None
+    sslrootcert: str | None = None
+    password: str | None = field(default=None, repr=False)
+
+    def connect_kwargs(self) -> dict:
+        """Arguments for `psycopg.connect`: a conninfo string, or keyword values."""
+        if self.url is not None:
+            return {"conninfo": self.url}
+        out = {"host": self.host, "port": self.port, "dbname": self.database,
+               "user": self.user, "sslmode": self.sslmode}
+        if self.sslrootcert:
+            out["sslrootcert"] = self.sslrootcert
+        if self.password:
+            out["password"] = self.password
+        return out
+
+
+def setting_files(config_home: Path | str | None = None) -> tuple[Path, Path]:
+    """The setting file and the password file, in that order."""
+    home = Path(config_home or os.environ.get("XDG_CONFIG_HOME")
+                or os.path.join(os.path.expanduser("~"), ".config"))
+    return (home / "capabilities" / "store.json",
+            home / "capabilities" / "credentials.env")
+
+
+def check_setting(values: dict) -> dict:
+    """The setting's non-secret values, checked and normalised, or DbError. The same
+    rules as the manager's store tier: no unknown field, host/database/user without
+    whitespace, port 1-65535, sslmode at least `require`."""
+    if not isinstance(values, dict):
+        raise DbError("bad_store_setting", "the store setting is not an object")
+    unknown = sorted(set(values) - set(SETTING_FIELDS))
+    if unknown:
+        raise DbError("bad_store_setting",
+                      f"the store setting carries unknown fields: {', '.join(unknown)}")
+    out: dict = {}
+    for name in ("host", "database", "user"):
+        value = values.get(name)
+        if not isinstance(value, str) or not value or any(
+                ch.isspace() or ch == "\0" for ch in value):
+            raise DbError("bad_store_setting",
+                          f"the store setting needs a {name} with no whitespace")
+        out[name] = value
+    port = values.get("port", 5432)
+    if isinstance(port, str) and port.isdigit():
+        port = int(port)
+    if isinstance(port, bool) or not isinstance(port, int) or not 0 < port < 65536:
+        raise DbError("bad_store_setting", "the store port must be 1-65535")
+    out["port"] = port
+    sslmode = values.get("sslmode")
+    if sslmode in SSLMODES_REFUSED:
+        raise DbError("sslmode_too_weak",
+                      f"sslmode {sslmode!r} lets the store be reached without TLS",
+                      f"use one of {', '.join(SSLMODES)}")
+    if sslmode not in SSLMODES:
+        raise DbError("bad_store_setting", f"unknown sslmode {sslmode!r}",
+                      f"use one of {', '.join(SSLMODES)}")
+    out["sslmode"] = sslmode
+    root = values.get("sslrootcert")
+    if root is not None:
+        if not isinstance(root, str) or not root or "\n" in root:
+            raise DbError("bad_store_setting",
+                          "sslrootcert must be a certificate file path or `system`")
+        out["sslrootcert"] = root
+    return out
+
+
+def read_setting(config_home: Path | str | None = None) -> Setting:
+    """The store in force on this machine.
+
+    `CAPABILITIES_STORE_URL` first, then the manager's setting. With neither, raises
+    DbError `store_not_configured`. Reads only; never creates a file."""
+    url = os.environ.get(URL_ENV)
+    if url:
+        scheme = urlparse(url).scheme
+        if scheme not in ("postgres", "postgresql"):
+            raise DbError("store_not_postgres",
+                          f"{URL_ENV} names a {scheme or 'file'} store, not Postgres",
+                          f"point {URL_ENV} at a postgresql:// URL or unset it")
+        return Setting(url=url, schema=DEFAULT_SCHEMA, source=URL_ENV)
+    setting_file, password_file = setting_files(config_home)
+    try:
+        raw = setting_file.read_text()
+    except FileNotFoundError:
+        raise DbError("store_not_configured", "this machine has no store setting",
+                      NOT_CONFIGURED_HINT) from None
+    except OSError as exc:
+        raise DbError("store_setting_unreadable",
+                      f"cannot read the store setting {setting_file}: {exc}") from exc
+    try:
+        data = json.loads(raw)
+    except ValueError as exc:
+        raise DbError("bad_store_setting", f"{setting_file} is not a store setting",
+                      "rewrite it with `capabilities store set`") from exc
+    if not isinstance(data, dict) or data.get("schema") not in SETTING_SCHEMAS:
+        raise DbError("bad_store_setting",
+                      f"{setting_file} is not a {' or '.join(SETTING_SCHEMAS)} setting",
+                      "rewrite it with `capabilities store set`")
+    values = check_setting({k: v for k, v in data.items() if k in SETTING_FIELDS})
+    schema = DEFAULT_SCHEMA
+    if data["schema"] == SETTING_SCHEMA_V2 and data.get(SCHEMA_FIELD) is not None:
+        schema = check_schema_name(data[SCHEMA_FIELD])
+    password = None
+    try:
+        lines = password_file.read_text().splitlines()
+    except FileNotFoundError:
+        lines = []
+    except OSError as exc:
+        raise DbError("store_setting_unreadable",
+                      f"cannot read the store password file {password_file}: {exc}") from exc
+    prefix = PASSWORD_KEY + "="
+    for line in lines:
+        if line.startswith(prefix):
+            password = line[len(prefix):] or None
+    return Setting(schema=schema, source=str(setting_file), password=password, **values)

capabilities_contract/version.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

capabilities_contract-0.1.0.dist-info/METADATA

@@ -0,0 +1,85 @@
+Metadata-Version: 2.5
+Name: capabilities-contract
+Version: 0.1.0
+Summary: The shared database layer of the capabilities contract: read the machine's store setting, connect bound to its schema, and migrate each owner's tables once under a ledger.
+Project-URL: Homepage, https://github.com/ai-cluster-one/capabilities-contract
+Project-URL: Source, https://github.com/ai-cluster-one/capabilities-contract
+Author: ai-cluster-one
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: capabilities,migrations,postgres,psycopg,schema
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.11
+Requires-Dist: psycopg[binary]<4,>=3.2
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# capabilities-contract
+
+The capabilities contract as a Python library. Its first part, `capabilities_contract.db`, is the one way the capabilities manager, its capabilities and ContextKit reach the shared Postgres database: read the machine's store setting, connect bound to its schema, and migrate each owner's tables once under a ledger. It does nothing else: no SQLite, no project registry, no records.
+
+## Install
+
+```
+pip install capabilities-contract
+```
+
+Its one dependency is `psycopg[binary]>=3.2,<4`, imported lazily: `import capabilities_contract.db` does not import psycopg, only `connect` and `migrate` do. In a PEP 723 script, pin the exact version:
+
+```python
+# /// script
+# dependencies = ["capabilities-contract==0.1.0"]
+# ///
+```
+
+## The store setting
+
+`read_setting()` returns the store in force as a `Setting`, reading and never writing. `CAPABILITIES_STORE_URL`, when set, wins and must be a `postgresql://` URL. Otherwise it reads the manager's setting, written only by `capabilities store set`: the non-secret values in `$XDG_CONFIG_HOME/capabilities/store.json` and the password as `CAPABILITIES_STORE_PASSWORD` in `$XDG_CONFIG_HOME/capabilities/credentials.env`. The fields and their checks are the manager's: `host`, `database`, `user` with no whitespace, `port` 1-65535 (default 5432), `sslmode` one of `require`, `verify-ca`, `verify-full` (`disable`, `allow` and `prefer` are refused as `sslmode_too_weak`), and an optional `sslrootcert`. A `capabilities.store.v1` setting binds the schema `agentkit`; a `capabilities.store.v2` setting may name another schema in `db_schema` (the document's `schema` key is its id). The URL override binds `agentkit`. With neither a setting nor the override, it raises `DbError("store_not_configured", ..., "run capabilities store set")`.
+
+## Connect
+
+```python
+from capabilities_contract.db import DbError, Step, connect, migrate
+
+conn = connect(application_name="automations")
+```
+
+`connect(*, application_name, setting=None)` returns a psycopg 3 connection whose `search_path` is the configured schema alone, never `public`, so unqualified names land in that schema. The schema need not exist yet: `migrate` creates it. Pass `setting=` to use a `Setting` other than the machine's.
+
+## Migrate
+
+```python
+result = migrate(conn, "automations", [
+    Step("0001-runs", "CREATE TABLE automations_runs (id bigint PRIMARY KEY)"),
+    ("0002-runs-host", "ALTER TABLE automations_runs ADD COLUMN host text"),
+], major=1, minor=1)
+for warning in result.warnings:
+    print(warning)
+```
+
+`migrate(conn, owner, steps, *, major, minor)` applies each step that is not yet applied, in order, once. The owner is the tool that owns the tables, a lowercase identifier without underscores. The first call creates the schema and two platform tables in it: `schema_ledger(owner, step, checksum, applied_at, library_version)` and `schema_version(owner, major, minor, updated_at)`. Each step runs in its own transaction under a per-owner advisory lock together with its ledger row, so concurrent processes apply it exactly once. It returns a `MigrateResult` with `applied`, `skipped`, `warnings`, `major` and `minor`.
+
+It refuses with a `DbError`, rolling the step back: an applied step whose SQL changed (`checksum_mismatch`); a step that creates a relation, index, sequence, type, function, collation, statistics object or schema not named `<owner>` or `<owner>_*` inside the configured schema, or named `schema_ledger` or `schema_version` (`naming_law`); a step that fails or ends its own transaction (`step_failed`). A step cannot use statements that refuse a transaction, such as `CREATE INDEX CONCURRENTLY`.
+
+The version rule lets tools at different releases share one database. When the store records a newer major for the owner than the caller's `major`, `migrate` refuses with `schema_too_new` before applying anything, and the hint says to update. When it records the same major with a newer minor, it proceeds and adds a warning to `result.warnings`, keeping the stored version. Otherwise it records the caller's version.
+
+## Errors
+
+Every failure is a `DbError` with `slug` (stable, for the caller to map to an exit code), `message` and `hint` (possibly `None`). Slugs: `store_not_configured`, `store_not_postgres`, `store_setting_unreadable`, `bad_store_setting`, `sslmode_too_weak`, `bad_schema_name`, `store_unreachable`, `driver_missing`, `bad_application_name`, `bad_owner`, `bad_version`, `bad_step`, `connection_busy`, `checksum_mismatch`, `naming_law`, `step_failed`, `schema_too_new`.
+
+## Development
+
+```
+uv venv && uv pip install -e ".[dev]"
+uv run pytest
+```
+
+The suite starts a throwaway PostgreSQL cluster with TLS under a temporary directory (`initdb` and `pg_ctl` on `PATH`, or in `$PG_BIN`) on a random port. Set `CAPABILITIES_CONTRACT_TEST_URL` to a TLS-enabled server's admin URL to run it against that server instead, as CI does. The tests that compare the setting reader with the manager's own run only when `CAPABILITIES_STORE_TIER` names the manager's `contract/store.py`; otherwise they skip.

capabilities_contract-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+capabilities_contract/__init__.py,sha256=Rgfd5Kv-bgbeq2-MW3XY3DLCpATD0xi502Tq37JZM84,174
+capabilities_contract/version.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+capabilities_contract/db/__init__.py,sha256=BZngl-knYaByJwzrNdzltwjQSt6cYAibJO4YEsvIfls,796
+capabilities_contract/db/_connect.py,sha256=bmk28wfifNH4MaxpgBtzqYAnBhvVmYihqTWyxOPXvFw,2447
+capabilities_contract/db/_errors.py,sha256=JFFTm-pKydSQHKuottbgD55_hqZcjbNDmld7OEkJ1ww,483
+capabilities_contract/db/_migrate.py,sha256=C23mfTQJ49RbG0P1E95rRYXwvoxadcM_nRvXNgvuZF8,13237
+capabilities_contract/db/_setting.py,sha256=BjlQMHW0XeQ8bmxTpezjVSaDHQoRlKz1WIM-WuSHeOE,8180
+capabilities_contract-0.1.0.dist-info/METADATA,sha256=bdf35XNbC93zMTKCz5qzy7xJlmcB_BXixSAdSEHVdHc,6162
+capabilities_contract-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+capabilities_contract-0.1.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+capabilities_contract-0.1.0.dist-info/RECORD,,

capabilities_contract-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

capabilities_contract-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.