Files
mcp-nextcloud/tests/unit/test_storage_logging.py
T
Chris CoutinhoandClaude Opus 4.7 f2b7bf132f fix(storage): address PR #798 review feedback (credentials, asyncpg extra, TLS, pool)
Round-2 fixes after the bot review on PR #798 plus two user follow-ups
(self-signed Postgres support; asyncpg should be a PyPI extra). Folded
into the same PR rather than a follow-up since the work is still
unmerged.

Security
--------
- Mask database credentials in all 5 log call sites (storage.py × 4,
  migrations.py × 1) via a new `mask_db_password()` helper in config.py.
  Uses SQLAlchemy's `make_url(...).render_as_string(hide_password=True)`
  with a regex fallback so the masking path never raises.
- New `tests/unit/test_storage_logging.py` asserts a sentinel password
  never appears in `caplog` during `RefreshTokenStorage.initialize()`.

Distribution
------------
- `asyncpg` moved to `[project.optional-dependencies] postgres` so a
  vanilla `pip install nextcloud-mcp-server` no longer pulls in the
  ~5 MB C extension. The Docker image runs `uv sync --extra postgres`,
  so containerized deployments are unchanged.
- When `DATABASE_URL=postgresql+asyncpg://...` is set on a venv missing
  the extra, `RefreshTokenStorage.initialize()` raises a friendly
  RuntimeError pointing at `[postgres]` rather than the generic
  ModuleNotFoundError.

TLS for the Postgres backend
----------------------------
- New `DATABASE_VERIFY_SSL` + `DATABASE_CA_BUNDLE` env vars mirror the
  existing `NEXTCLOUD_VERIFY_SSL` / `NEXTCLOUD_CA_BUNDLE` pattern
  (validators in Settings.__post_init__, `get_database_ssl()` helper
  alongside `get_nextcloud_ssl_verify()`). `DATABASE_VERIFY_SSL=false`
  wins over `DATABASE_CA_BUNDLE` for incident-response convenience.
- Default is **None** rather than True — keeps PR #798's behavior
  intact for cluster-internal Postgres that runs without TLS. Operators
  opt into verify-full or supply a private CA. ADR-026 records the
  reasoning vs the Nextcloud HTTPS default.
- Engine factory in `storage.py` passes `ssl` via `connect_args` only
  when `get_database_ssl()` returns non-None; otherwise asyncpg's
  default (`prefer`) applies.
- Storage logs which TLS mode is active at INFO (no secret material).

Configurable connection pool
----------------------------
- `DATABASE_POOL_SIZE` (default 10) and `DATABASE_MAX_OVERFLOW`
  (default 20) replace the hardcoded engine values. With many replicas
  this can blow past managed-Postgres `max_connections=100`; tune down
  for large fleets.
- gte-1 / gte-0 validators in __post_init__ reject 0/negative pool
  sizes at startup with the offending value in the error.

Consistency polish
------------------
- Migration 006: convert raw `op.execute("ALTER TABLE ... ADD COLUMN")`
  to `op.batch_alter_table(...).add_column(sa.Column("nonce", sa.Text))`
  for stylistic consistency with the rewritten 001-005. Downgrade now
  drops the column instead of being a no-op.
- `registered_webhooks.created_at` standardized from `sa.Float` to
  `sa.BigInteger` (all other `*_at` columns); `store_webhook()` casts
  `time.time()` → `int`.
- `is_sqlite_url()` made case-insensitive.

Testing
-------
- New `tests/integration/test_storage_postgres.py::test_cleanup_expired_roundtrip`
  exercises `cleanup_expired_tokens`, `cleanup_expired_sessions`, and
  `cleanup_expired_browser_sessions` — relies on DELETE rowcount,
  historically dialect-tricky.
- `tests/unit/test_ssl_config.py` extended with `TestDatabaseSSLSettings`
  + `TestGetDatabaseSSL` classes (9 new tests) mirroring the existing
  Nextcloud SSL tests one-for-one.

Docs
----
- `docs/configuration.md` Centralized-Storage section grew the four new
  env vars + a homelab example with a private CA.
- `docs/ADR-026` grew Distribution, TLS, and `alembic/env.py` async-pattern
  subsections explaining the non-obvious design choices.

Helm chart counterpart in cbcoutinho/helm-charts PR #34 (separate
commit on `feat/nextcloud-mcp-server-database-url`).

Verification
------------
- `uv run pytest tests/unit/` — 1025 passed.
- `TEST_DATABASE_URL=... uv run pytest tests/integration/test_storage_postgres.py -m postgres` — 6 passed (including new cleanup test).
- `uv run ruff check && uv run ruff format --check && uv run ty check -- nextcloud_mcp_server` — clean.

Tracked on Astrolabe Cloud POC board, card #99.

---

_This PR was generated with the help of AI, and reviewed by a Human_

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-16 18:53:45 +02:00

81 lines
3.1 KiB
Python

"""Unit tests guarding against DB-credential leakage to logs (PR #798 round 2).
The reviewer of PR #798 flagged that ``self.database_url`` was being logged
verbatim in ``RefreshTokenStorage.initialize()``, exposing any password
embedded in a Postgres URL to stdout/stderr and any log aggregator. These
tests pin the masking down so a future contributor can't silently
reintroduce the leak by adding a new ``logger.info("... %s", database_url)``.
"""
from __future__ import annotations
import logging
import pytest
from nextcloud_mcp_server.auth.storage import RefreshTokenStorage
from nextcloud_mcp_server.config import mask_db_password
pytestmark = pytest.mark.unit
SECRET = "uniqueSecretSentinel123"
def test_mask_db_password_postgres():
"""Postgres URL passwords are replaced with the SQLAlchemy ``***`` token."""
url = f"postgresql+asyncpg://mcp:{SECRET}@db.example.com:5432/mcp"
masked = mask_db_password(url)
assert SECRET not in masked
assert "mcp" in masked # username preserved
assert "db.example.com" in masked # host preserved
def test_mask_db_password_sqlite_passthrough():
"""SQLite URLs have no credentials; the function must not corrupt them."""
url = "sqlite+aiosqlite:////tmp/test-tokens.db"
masked = mask_db_password(url)
assert masked == url
def test_mask_db_password_handles_unparseable_url():
"""Malformed URLs fall back to a regex scrub instead of raising.
A logging path that can raise is worse than a logging path that emits a
less-pretty masked value — never let credentials leak just because the
URL shape was unexpected.
"""
url = f"weird-scheme://user:{SECRET}@host/db?ssl=disable"
masked = mask_db_password(url)
assert SECRET not in masked
async def test_storage_init_does_not_log_password(caplog):
"""Construct + initialize against a Postgres-shaped URL with a password
in the URL and confirm the secret is absent from every captured log."""
# Use a sqlite URL with a fake password-shaped path — we don't need a
# real Postgres up to verify the masking logic, only that no log line
# ever interpolates the raw URL. A sqlite URL doesn't carry a password
# so we test masking by directly invoking the masked log path with a
# constructed Postgres URL via mask_db_password itself.
caplog.set_level(logging.DEBUG, logger="nextcloud_mcp_server.auth.storage")
caplog.set_level(logging.DEBUG, logger="nextcloud_mcp_server.migrations")
import tempfile
from pathlib import Path
with tempfile.TemporaryDirectory() as tmp:
db_path = Path(tmp) / "tokens.db"
storage = RefreshTokenStorage(db_path=str(db_path), encryption_key=None)
await storage.initialize()
# Sanity: the sqlite path was logged at least once.
assert any("token storage" in rec.message.lower() for rec in caplog.records)
# The sentinel should never appear (sqlite URL has no password to leak,
# but if a future change reformatted DATABASE_URL into the message it
# would). Stay paranoid.
for rec in caplog.records:
assert SECRET not in rec.getMessage(), (
f"Credential sentinel leaked into log: {rec.getMessage()!r}"
)