mirror of
https://github.com/kuhyx/utils.git
synced 2026-11-11 21:53:59 +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
92 lines
3.3 KiB
Python
92 lines
3.3 KiB
Python
"""Tests for merge_logs, including its CRDT convergence properties."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING
|
|
|
|
from crdt_sync import Hlc, Record, merge_logs
|
|
|
|
if TYPE_CHECKING:
|
|
from collections.abc import Callable
|
|
|
|
from crdt_sync import Log
|
|
|
|
|
|
class TestMergeLogs:
|
|
"""Merge logs."""
|
|
|
|
def test_returns_the_union_of_disjoint_ids(
|
|
self, make_hlc: Callable[..., Hlc]
|
|
) -> None:
|
|
"""Returns the union of disjoint ids."""
|
|
local = {"a": Record(id="a", fields={"text": ("a", make_hlc(100))})}
|
|
remote = {"b": Record(id="b", fields={"text": ("b", make_hlc(100))})}
|
|
assert merge_logs(local, remote) == {**local, **remote}
|
|
|
|
def test_merges_a_shared_id_field_by_field(
|
|
self, make_hlc: Callable[..., Hlc]
|
|
) -> None:
|
|
"""Merges a shared id field by field."""
|
|
local = {"a": Record(id="a", fields={"text": ("old", make_hlc(100))})}
|
|
remote = {"a": Record(id="a", fields={"text": ("new", make_hlc(200))})}
|
|
merged = merge_logs(local, remote)
|
|
assert merged["a"].fields["text"] == ("new", make_hlc(200))
|
|
|
|
def test_a_delete_on_one_side_survives_the_merge(
|
|
self, make_hlc: Callable[..., Hlc]
|
|
) -> None:
|
|
"""A delete on one side survives the merge."""
|
|
local = {
|
|
"a": Record(id="a", fields={}, deleted=True, deleted_hlc=make_hlc(200))
|
|
}
|
|
remote = {"a": Record(id="a", fields={"text": ("still here", make_hlc(100))})}
|
|
assert merge_logs(local, remote)["a"].deleted is True
|
|
|
|
def test_does_not_mutate_either_input(self, make_hlc: Callable[..., Hlc]) -> None:
|
|
"""Does not mutate either input."""
|
|
local = {"a": Record(id="a", fields={"text": ("a", make_hlc(100))})}
|
|
remote = {"b": Record(id="b", fields={"text": ("b", make_hlc(100))})}
|
|
local_before = dict(local)
|
|
remote_before = dict(remote)
|
|
merge_logs(local, remote)
|
|
assert local == local_before
|
|
assert remote == remote_before
|
|
|
|
|
|
class TestConvergenceProperties:
|
|
"""Convergence properties."""
|
|
|
|
def _sample_logs(self, make_hlc: Callable[..., Hlc]) -> tuple[Log, Log]:
|
|
a = {
|
|
"shared": Record(
|
|
id="shared", fields={"text": ("a-version", make_hlc(100))}
|
|
),
|
|
"only-in-a": Record(id="only-in-a", fields={"text": ("a", make_hlc(50))}),
|
|
}
|
|
b = {
|
|
"shared": Record(
|
|
id="shared", fields={"text": ("b-version", make_hlc(200))}
|
|
),
|
|
"only-in-b": Record(id="only-in-b", fields={"text": ("b", make_hlc(50))}),
|
|
}
|
|
return a, b
|
|
|
|
def test_is_commutative(self, make_hlc: Callable[..., Hlc]) -> None:
|
|
"""Is commutative."""
|
|
a, b = self._sample_logs(make_hlc)
|
|
assert merge_logs(a, b) == merge_logs(b, a)
|
|
|
|
def test_is_idempotent(self, make_hlc: Callable[..., Hlc]) -> None:
|
|
"""Is idempotent."""
|
|
a, _ = self._sample_logs(make_hlc)
|
|
assert merge_logs(a, a) == a
|
|
|
|
def test_repeated_merge_of_the_same_remote_is_a_no_op(
|
|
self, make_hlc: Callable[..., Hlc]
|
|
) -> None:
|
|
"""Repeated merge of the same remote is a no op."""
|
|
a, b = self._sample_logs(make_hlc)
|
|
once = merge_logs(a, b)
|
|
twice = merge_logs(once, b)
|
|
assert once == twice
|