mirror of
https://github.com/kuhyx/utils.git
synced 2026-11-10 20:27:15 +01:00
Krzysztof kuhy Rudnicki
1b8c99d2e1
pylint scored the suite at 8.58/10, and 277 of the ~300 findings were missing docstrings -- every one of them in crdt_sync/tests/, none in library code. ruff exempts tests from the docstring rules, so the two linters disagreed and the score sat well below the bar. Rather than silence pylint to match ruff, every test class, test function and stub method now says what it pins. Stub arguments that exist only to match a real signature are underscore-prefixed, which is the documented way to say "deliberately unused" and clears the unused-argument findings too. No behaviour change: 259 tests, still 100% branch coverage. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VCucBhUkHBBHHbsY7bSdGV
97 lines
3.0 KiB
Python
97 lines
3.0 KiB
Python
"""Tests for local Log persistence (dump/load and atomic file read/write)."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
from typing import TYPE_CHECKING
|
|
|
|
import pytest
|
|
|
|
from crdt_sync import (
|
|
Record,
|
|
dump_log,
|
|
load_log,
|
|
read_log,
|
|
write_log,
|
|
)
|
|
|
|
if TYPE_CHECKING:
|
|
from collections.abc import Callable
|
|
from pathlib import Path
|
|
|
|
from crdt_sync import Hlc, Log
|
|
|
|
|
|
def _sample_log(make_hlc: Callable[..., Hlc]) -> Log:
|
|
return {
|
|
"a": Record(id="a", fields={"text": ("alpha", make_hlc(100))}),
|
|
"b": Record(id="b", fields={}, deleted=True, deleted_hlc=make_hlc(200)),
|
|
}
|
|
|
|
|
|
class TestDumpLoad:
|
|
"""Dump load."""
|
|
|
|
def test_round_trips_a_log(self, make_hlc: Callable[..., Hlc]) -> None:
|
|
"""Round trips a log."""
|
|
log = _sample_log(make_hlc)
|
|
assert load_log(dump_log(log)) == log
|
|
|
|
def test_load_raises_on_non_json(self) -> None:
|
|
# json.loads raises JSONDecodeError (a ValueError subclass).
|
|
"""Load raises on non JSON."""
|
|
with pytest.raises(json.JSONDecodeError):
|
|
load_log("{not json")
|
|
|
|
def test_load_raises_typeerror_on_wrong_shape(self) -> None:
|
|
# Valid JSON, but a list where an id->record map is expected.
|
|
"""Load raises typeerror on wrong shape."""
|
|
with pytest.raises(TypeError):
|
|
load_log("[]")
|
|
|
|
|
|
class TestReadWrite:
|
|
"""Read write."""
|
|
|
|
def test_write_then_read_round_trips(
|
|
self, tmp_path: Path, make_hlc: Callable[..., Hlc]
|
|
) -> None:
|
|
"""Write then read round trips."""
|
|
log = _sample_log(make_hlc)
|
|
path = tmp_path / "nested" / "log.json"
|
|
write_log(path, log)
|
|
assert read_log(path) == log
|
|
|
|
def test_write_creates_parent_directories(
|
|
self, tmp_path: Path, make_hlc: Callable[..., Hlc]
|
|
) -> None:
|
|
"""Write creates parent directories."""
|
|
path = tmp_path / "deep" / "nested" / "log.json"
|
|
write_log(path, _sample_log(make_hlc))
|
|
assert path.exists()
|
|
|
|
def test_write_overwrites_atomically(
|
|
self, tmp_path: Path, make_hlc: Callable[..., Hlc]
|
|
) -> None:
|
|
"""Write overwrites atomically."""
|
|
path = tmp_path / "log.json"
|
|
write_log(path, {"a": Record(id="a", fields={})})
|
|
write_log(path, _sample_log(make_hlc))
|
|
assert set(read_log(path)) == {"a", "b"}
|
|
|
|
def test_read_of_missing_file_is_empty(self, tmp_path: Path) -> None:
|
|
"""Read of missing file is empty."""
|
|
assert read_log(tmp_path / "nope.json") == {}
|
|
|
|
def test_read_of_corrupt_file_is_empty(self, tmp_path: Path) -> None:
|
|
"""Read of corrupt file is empty."""
|
|
path = tmp_path / "log.json"
|
|
path.write_text("{not json", encoding="utf-8")
|
|
assert read_log(path) == {}
|
|
|
|
def test_read_of_wrong_shape_file_is_empty(self, tmp_path: Path) -> None:
|
|
"""Read of wrong shape file is empty."""
|
|
path = tmp_path / "log.json"
|
|
path.write_text("[]", encoding="utf-8")
|
|
assert read_log(path) == {}
|