Files
plm-lottery/tests/unit/test_migrations.py
T
davideandClaude Sonnet 5.5 daa85cf4f0 Give every payout a bump reserve output and refuse configs that cannot pay a round (B-79, RND-21, RND-23, RND-24, RND-27, RND-38, RND-40, DAT-73, API-31, API-36, TX-11, ADR-17, ADR-29)
The pool normally holds exactly the round's bet outputs and the payout spent them all for
exactly the pool amount, so it had no change output: bump_fee could never accelerate it,
and a payout stuck in a mempool (never abandoned while a server knows it) kept the round in
`paying_out` and the whole lottery stopped.

- build_payout_transaction always has three outputs: winner, fee address, and a bump reserve
  of max(DUST_LIMIT_SATS, estimate_vsize(inputs, 3) * 10 sat/vB) paid to the reserve address
  m/84'/746'/0'/1/0. The reserve comes out of the platform's 30%, the network fee still out
  of the winner's 70%. Input value beyond winner share + commission (only rounds opened
  before the per-round pool address) is folded into the reserve output if >= dust, left to
  the network fee otherwise. `change_address` is replaced by `reserve_address`.
- `rounds.bump_reserve_sats` (Alembic e5a91c3d7b26, plain add_column) is written with the
  payout intent before the broadcast; /admin/rounds returns it.
- bump_fee takes the increase from the reserve output for a payout
  (_find_reducible_output; a payout already in flight with a change to the pool still falls
  back to that), never from the winner or fee-address outputs.
- payout_config_problem / rounds_can_open (RND-40): a bet amount and fee rate under which a
  round of 1 or of MAX_PARTICIPANTS_PER_ROUND participants could not cover the network fee,
  the reserve and dust outputs opens no round (lottery_configured=false); PUT /admin/config
  refuses such a bet amount or fee rate with 422 config_not_payable, judged on the resulting
  values, since the payout reads the fee rate live.

Ambiguity resolved: the reserve output and any excess input are one output (RND-23 says one
output to the reserve address), and bump_reserve_sats records that output's initial value.
DAT-22's "abandon clears all amounts" stays with B-96.

Tests changed because the spec changed: the four test_payout_builder tests asserted the old
two/three-output shape with change to the pool and the fee address receiving the whole 30%;
the whitespace fee_address test now spells out the amounts rounds_can_open reads. New: reserve
sizing, payout with 1 and with 400 participants (inputs = outputs + fee to the satoshi),
exact commission/reserve/dust boundary, excess folded or left to the fee, a real payout bumped
out of its reserve with the other outputs byte-identical and bumped five times, the old
reserve-less shape still raising RbfError, the scheduler output addresses and recorded
amounts, payability boundaries found independently by bisection, no round / unconfigured flag
for an unpayable config, a round in progress surviving it, PUT /admin/config refusals and the
migration column. Mutation-checked: dropping the reserve lookup in bump_fee and the payability
check in rounds_can_open each fail tests.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-16 13:55:51 +02:00

206 lines
10 KiB
Python

"""B-97 (DAT-75, DAT-56, ARC-62, ARC-64): the Alembic chain is executed, not assumed.
The two expression indexes that carry invariants — `ix_rounds_single_active` ("at
most one active round", B-09) and `ix_users_username_lower` ("usernames are
case-insensitive", B-57) — are invisible to autogenerate, and `batch_alter_table`
on SQLite rebuilds the table and drops them with only a warning. Every other test
builds its schema with `Base.metadata.create_all`, so a migration that lost one of
them would reach production unnoticed. This one runs `alembic upgrade head` on an
empty database, exactly as the container does at startup.
Alembic runs in a subprocess: env.py calls `asyncio.run` and `fileConfig`, neither of
which belongs inside the pytest process.
"""
import os
import re
import sqlite3
import subprocess
import sys
from pathlib import Path
import pytest
_ROOT = Path(__file__).resolve().parents[2]
@pytest.fixture(scope="module")
def migrated_db(tmp_path_factory) -> Path:
db_path = tmp_path_factory.mktemp("migrations") / "migrated.db"
env = {**os.environ, "DATABASE_URL": f"sqlite+aiosqlite:///{db_path}"}
result = subprocess.run(
[sys.executable, "-m", "alembic", "upgrade", "head"],
cwd=_ROOT,
env=env,
capture_output=True,
text=True,
timeout=120,
)
assert result.returncode == 0, f"alembic upgrade head failed:\n{result.stderr[-3000:]}"
return db_path
def _index_sql(db_path: Path, name: str) -> str | None:
with sqlite3.connect(db_path) as conn:
row = conn.execute("SELECT sql FROM sqlite_master WHERE type = 'index' AND name = ?", (name,)).fetchone()
return re.sub(r"\s+", " ", row[0]).lower() if row else None
def test_the_expression_indexes_survive_the_whole_migration_chain(migrated_db):
"""DAT-75 / ARC-62 / B-97: both indexes exist, with their definition, at head."""
single_active = _index_sql(migrated_db, "ix_rounds_single_active")
assert single_active is not None, "ix_rounds_single_active was lost by a migration"
assert "unique index" in single_active
assert "on rounds ((1))" in single_active
for status in ("open", "closing", "drawing", "paying_out"):
assert f"'{status}'" in single_active
username_lower = _index_sql(migrated_db, "ix_users_username_lower")
assert username_lower is not None, "ix_users_username_lower was lost by a migration"
assert "unique index" in username_lower
assert "lower(username)" in username_lower
def test_the_migrated_database_still_enforces_both_invariants(migrated_db):
"""DAT-75 / B-97: a second active round and a case-variant username are refused."""
with sqlite3.connect(migrated_db) as conn:
conn.execute("INSERT INTO rounds (status, opened_at) VALUES ('open', '2026-01-01 00:00:00')")
with pytest.raises(sqlite3.IntegrityError):
conn.execute("INSERT INTO rounds (status, opened_at) VALUES ('closing', '2026-01-01 00:00:00')")
# A closed round is not active, so any number of them may coexist.
conn.execute("INSERT INTO rounds (status, opened_at) VALUES ('closed', '2026-01-01 00:00:00')")
columns = "(username, password_hash, derivation_index, address, cached_balance_sats, token_version, created_at)"
conn.execute(f"INSERT INTO users {columns} VALUES ('Alice', 'x', 0, 'plm1qa', 0, 0, '2026-01-01 00:00:00')")
with pytest.raises(sqlite3.IntegrityError):
conn.execute(f"INSERT INTO users {columns} VALUES ('aLICE', 'x', 1, 'plm1qb', 0, 0, '2026-01-01 00:00:00')")
def _alembic(db_path: Path, *args: str) -> None:
env = {**os.environ, "DATABASE_URL": f"sqlite+aiosqlite:///{db_path}"}
result = subprocess.run(
[sys.executable, "-m", "alembic", *args], cwd=_ROOT, env=env, capture_output=True, text=True, timeout=120
)
assert result.returncode == 0, f"alembic {' '.join(args)} failed:\n{result.stderr[-3000:]}"
def test_pending_transaction_txids_table_matches_the_model(migrated_db):
"""B-77 (DAT-70): the migrated table has the model's columns, the unique txid and the
index on the owning row."""
from app.db.models import PendingTransactionTxid
with sqlite3.connect(migrated_db) as conn:
columns = {row[1]: row for row in conn.execute("PRAGMA table_info(pending_transaction_txids)")}
sql = conn.execute("SELECT sql FROM sqlite_master WHERE name = 'pending_transaction_txids'").fetchone()[0]
indexes = {row[1] for row in conn.execute("PRAGMA index_list(pending_transaction_txids)")}
assert set(columns) == {c.name for c in PendingTransactionTxid.__table__.columns}
assert "unique" in sql.lower()
assert "ix_pending_transaction_txids_pending_transaction_id" in indexes
def test_existing_pending_transactions_are_backfilled_with_the_txids_they_remember(tmp_path):
"""B-77 (DAT-70): upgrading a database that already has rows records each one's
current txid with its raw transaction, and the txid a bump replaced with an empty
raw_hex — and the expression indexes survive the step."""
db_path = tmp_path / "old.db"
_alembic(db_path, "upgrade", "477bddae1a84")
with sqlite3.connect(db_path) as conn:
columns = (
"(kind, current_txid, fee_rate_sat_vb, raw_tx_hex, broadcast_at, last_broadcast_at, status, "
"replaced_by_txid, attempt_count, updated_at)"
)
stamp = "'2026-01-01 00:00:00'"
conn.execute(
f"INSERT INTO pending_transactions {columns} VALUES "
f"('bet', 'cc', 2, 'rawcc', {stamp}, {stamp}, 'pending', 'bb', 2, {stamp})"
)
conn.execute(
f"INSERT INTO pending_transactions {columns} VALUES "
f"('withdrawal', 'dd', 1, 'rawdd', {stamp}, {stamp}, 'building', NULL, 1, {stamp})"
)
_alembic(db_path, "upgrade", "head")
with sqlite3.connect(db_path) as conn:
rows = sorted(conn.execute("SELECT pending_transaction_id, txid, raw_hex FROM pending_transaction_txids"))
assert rows == [(1, "bb", ""), (1, "cc", "rawcc"), (2, "dd", "rawdd")]
assert _index_sql(db_path, "ix_rounds_single_active") is not None
assert _index_sql(db_path, "ix_users_username_lower") is not None
def test_failed_at_and_paused_reason_are_backfilled_for_existing_rows(tmp_path):
"""B-78 (DAT-36, DAT-69, DAT-72): rows that are already failed start their 14-day
watch from their last update, and an instance that is already paused was paused by its
operator; the expression indexes survive the add_column steps."""
db_path = tmp_path / "old.db"
_alembic(db_path, "upgrade", "a3f5c2d9b7e1")
with sqlite3.connect(db_path) as conn:
columns = (
"(kind, current_txid, fee_rate_sat_vb, raw_tx_hex, broadcast_at, last_broadcast_at, status, "
"attempt_count, updated_at)"
)
conn.execute(
f"INSERT INTO pending_transactions {columns} VALUES "
"('bet', 'aa', 1, 'raw', '2026-01-01 00:00:00', '2026-01-01 00:00:00', 'failed', 1, '2026-02-03 04:05:06')"
)
conn.execute(
f"INSERT INTO pending_transactions {columns} VALUES "
"('bet', 'bb', 1, 'raw', '2026-01-01 00:00:00', '2026-01-01 00:00:00', 'pending', 1, '2026-02-03 04:05:06')"
)
round_config = [r[1] for r in conn.execute("PRAGMA table_info(round_config)")]
assert "paused_reason" not in round_config
conn.execute(
"INSERT INTO round_config (fee_address, bet_amount_sats, round_duration_seconds, round_cooldown_seconds, "
"fee_rate_sat_vb, rbf_timeout_seconds, draw_animation_seconds, paused, updated_at) "
"VALUES ('', 1000000000, 600, 30, 1, 900, 20, 1, '2026-01-01 00:00:00')"
)
_alembic(db_path, "upgrade", "head")
with sqlite3.connect(db_path) as conn:
failed_at = dict(conn.execute("SELECT current_txid, failed_at FROM pending_transactions"))
reason = conn.execute("SELECT paused_reason FROM round_config").fetchone()[0]
assert failed_at == {"aa": "2026-02-03 04:05:06", "bb": None}
assert reason == "operator"
assert _index_sql(db_path, "ix_rounds_single_active") is not None
assert _index_sql(db_path, "ix_users_username_lower") is not None
def test_the_commit_reveal_columns_and_the_draw_position_index_exist_at_head(migrated_db):
"""B-73 (DAT-62 … DAT-66): the new columns, their defaults and the unique position index."""
with sqlite3.connect(migrated_db) as conn:
rounds = {r[1]: r for r in conn.execute("PRAGMA table_info(rounds)")}
for column in ("server_seed_enc", "server_seed", "server_seed_hash", "participants_hash", "draw_height"):
assert column in rounds and rounds[column][3] == 0 # nullable
assert rounds["draw_confirmations"][3] == 1 and rounds["draw_confirmations"][4] in ("3", "'3'")
participants = {r[1]: r for r in conn.execute("PRAGMA table_info(round_participants)")}
assert participants["bet_vout"][3] == 1 and participants["bet_vout"][4] in ("0", "'0'")
assert participants["draw_position"][3] == 0
config = {r[1]: r for r in conn.execute("PRAGMA table_info(round_config)")}
assert config["draw_confirmations"][4] in ("3", "'3'")
sql = _index_sql(migrated_db, "ux_round_participants_round_draw_position")
assert sql is not None and "unique" in sql and "(round_id, draw_position)" in sql
def test_two_participants_cannot_share_a_draw_position_but_null_positions_coexist(migrated_db):
with sqlite3.connect(migrated_db) as conn:
conn.execute("INSERT INTO rounds (status, opened_at) VALUES ('closed', '2026-01-01 00:00:00')")
round_id = conn.execute("SELECT max(id) FROM rounds").fetchone()[0]
columns = "(round_id, user_id, bet_amount_sats, bet_txid, broadcast_at, status, draw_position)"
def insert(user_id, position):
conn.execute(
f"INSERT INTO round_participants {columns} VALUES (?, ?, 1, 'tx', '2026-01-01 00:00:00', 'confirmed', ?)",
(round_id, user_id, position),
)
insert(1, None)
insert(2, None) # NULLs do not collide
insert(3, 0)
with pytest.raises(sqlite3.IntegrityError):
insert(4, 0)
def test_the_bump_reserve_column_exists_at_head_and_is_nullable(migrated_db): # B-79 (DAT-73)
with sqlite3.connect(migrated_db) as conn:
rounds = {r[1]: r for r in conn.execute("PRAGMA table_info(rounds)")}
assert "bump_reserve_sats" in rounds and rounds["bump_reserve_sats"][3] == 0
assert _index_sql(migrated_db, "ix_rounds_single_active") is not None