ddadminandClaude Opus 5
aabd339a26
- Зачем:
- слепая линия Кодекса (свежий тред, high) нашла три места, где обещание
контракта не подкреплено: имена для DDS не сверялись ни с чем, порядок
строк документа держался только на нумерации, а комментарий рекламировал
торговые события, которые мастер-спека прямо исключила.
- Что:
- имена для DDS записаны независимо и сверяются целиком: они не выводятся
правилом из имён Метрики, значит осмысленно неверное имя иначе молча
уезжает в опубликованное описание (проверено подменой referer).
- строки документа сверяются парами «номер, колонка»: рендер в другом
порядке больше не проходит зелёным (проверено перевёрнутым рендером).
- productEventType: detail и remove убраны из комментария — раздел 10
мастер-спеки отказался от полного словаря торговых событий Метрики;
стенд шлёт add и purchase.
- Проверка:
- make test (250 тестов), make lint;
- make docs, затем git diff --exit-code docs/ — пусто;
- обе новые проверки проверены мутациями: каждая краснеет своим тестом.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
65 lines
2.6 KiB
Python
65 lines
2.6 KiB
Python
"""Проверки «описания выгрузки»: свежесть документа и полнота таблицы.
|
|
|
|
Документ собирается из контракта, значит расходиться они могут только одним
|
|
способом — контракт правили, документ не пересобрали. Ровно это здесь и
|
|
сторожится.
|
|
"""
|
|
|
|
import re
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
from clickstream_generator.schema import COLUMNS, Column, ColumnGroup
|
|
from clickstream_generator.schema_doc import render
|
|
|
|
REPO_ROOT = Path(__file__).resolve().parents[2]
|
|
DOC_PATH = REPO_ROOT / "docs" / "formats" / "clickstream-event.md"
|
|
|
|
# Номер и имя колонки из строки таблицы: по ним сверяется не только состав
|
|
# документа, но и его порядок — по нему сторона хранилища выпишет колонки.
|
|
TABLE_ROW = re.compile(r"^\| (\d+) \| `([^`]+)` \|", re.MULTILINE)
|
|
|
|
|
|
@pytest.fixture(scope="module")
|
|
def rendered() -> str:
|
|
return render()
|
|
|
|
|
|
def test_doc_is_up_to_date(rendered: str):
|
|
assert DOC_PATH.exists(), f"описание выгрузки не найдено: {DOC_PATH}"
|
|
assert DOC_PATH.read_text(encoding="utf-8") == rendered, (
|
|
"описание выгрузки отстало от контракта — пересоберите: make docs"
|
|
)
|
|
|
|
|
|
def test_every_column_has_a_row(rendered: str):
|
|
assert len(TABLE_ROW.findall(rendered)) == len(COLUMNS)
|
|
|
|
|
|
def test_rows_follow_contract_order(rendered: str):
|
|
"""Строки идут в порядке контракта, а не просто нумеруются с 1 по 47."""
|
|
rows = [(int(number), name) for number, name in TABLE_ROW.findall(rendered)]
|
|
expected = [(number, column.name) for number, column in enumerate(COLUMNS, 1)]
|
|
assert rows == expected
|
|
|
|
|
|
@pytest.mark.parametrize("column", COLUMNS, ids=lambda column: column.name)
|
|
def test_column_is_described_in_full(column: Column, rendered: str):
|
|
"""Колонку описывает одна строка, и в ней всё, что несёт контракт."""
|
|
described = (
|
|
column.name,
|
|
column.clickhouse_type,
|
|
column.numpy_dtype,
|
|
column.dds_name,
|
|
column.comment,
|
|
)
|
|
assert any(
|
|
all(value in line for value in described) for line in rendered.splitlines()
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize("group", list(ColumnGroup), ids=lambda group: group.name)
|
|
def test_group_is_a_heading(group: ColumnGroup, rendered: str):
|
|
assert f"\n## {group.value}\n" in rendered
|