chore(tests): выкинуты сторожа документации и тест на комментарий
Зачем tests/docs-guards.sh сличал README с образцами текста: одна проверка требовала двух подряд идущих строк дословно, другая — что в отчёте написано «ГБ», а не «GB». Это тесты на вёрстку абзаца, а не на факт: перестановка слов красит их в красный, хотя ничего не сломано. README всё равно предстоит переписать целиком, когда стенд дорастёт до менти, и тогда эти сторожа краснели бы на здоровом изменении. Из той же семьи была проверка в stand-smoke-static.sh, требовавшая, чтобы в scripts/stand-smoke.sh существовал комментарий определённой формулировки. Что - удалён tests/docs-guards.sh и его запуск из цели config-test; - из tests/stand-smoke-static.sh убрана проверка наличия комментария, счётчик итога приведён к двум оставшимся. Оставлены обе содержательные проверки stand-smoke-static.sh: отказ на недоступных compose.yaml и .env.example и то, что скрипт не виснет в сломанном окружении. Ссылка на удалённый файл в ADR 0004 намеренно не правится: там записано, что было сделано в тот день, и подчищать записи решений под сегодняшнее дерево значит перестать им верить. Проверка make config-test — зелено, 5 и 2. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
@@ -1,101 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
# Сторож документации.
|
||||
#
|
||||
# README устаревает молча: порт поменяли в compose.yaml, а в описании остался
|
||||
# старый — и это выясняется через месяц, когда кто-то по нему подключается.
|
||||
# Здесь собраны утверждения README, которые дёшево проверить текстом и дорого
|
||||
# обнаружить сломанными. Стенд поднимать не нужно; запускается в составе
|
||||
# `make config-test`.
|
||||
#
|
||||
# Чего сторож НЕ делает: он не проверяет, что README понятен или полон. Только
|
||||
# то, что перечисленные ниже факты не разошлись с кодом.
|
||||
#
|
||||
# Добавляя проверку, формулируй утверждение так, как оно должно читаться в
|
||||
# отчёте: строка печатается и при успехе, и при провале, поэтому по красной
|
||||
# строке сразу видно, что именно перестало быть правдой.
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
readonly ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||
readonly README="$ROOT_DIR/README.md"
|
||||
passed=0
|
||||
|
||||
fail() {
|
||||
printf 'ОШИБКА: %s\n' "$1" >&2
|
||||
exit 1
|
||||
}
|
||||
|
||||
# check «утверждение» команда... — запускает команду и считает результат.
|
||||
# Успех: «ЗЕЛЁНО: утверждение». Провал: «ОШИБКА: не подтвердилось: утверждение»
|
||||
# и выход с кодом 1. Раньше проверки падали через `set -e` молча: код возврата
|
||||
# был единственным следом, и какая именно проверка не прошла — не сообщалось.
|
||||
check() {
|
||||
local claim="$1"
|
||||
shift
|
||||
if "$@"; then
|
||||
passed=$((passed + 1))
|
||||
printf 'ЗЕЛЁНО: %s\n' "$claim"
|
||||
else
|
||||
fail "не подтвердилось: $claim"
|
||||
fi
|
||||
}
|
||||
|
||||
# Порты обеих нод. Ломается ровно тогда, когда порт поменяли в compose.yaml и
|
||||
# забыли документацию — самая частая причина расхождения.
|
||||
ports_documented() {
|
||||
grep -Eq 'нода 1.*28123.*29000' "$README" &&
|
||||
grep -Eq 'нода 2.*28124.*29001' "$README"
|
||||
}
|
||||
|
||||
# Совет про сброс томов. Пароли Postgres и Grafana применяются при создании
|
||||
# тома: без `make clean` смена значений в .env ничего не даёт, и человек
|
||||
# полчаса ищет, почему его не пускает.
|
||||
clean_advice_present() {
|
||||
grep -Eq 'После первого запуска.*`make clean`' "$README"
|
||||
}
|
||||
|
||||
# Список портов остаётся единым списком. Совпадение точное намеренно: проверка
|
||||
# стережёт не сам факт (он проверен выше), а то, что строку не выдернули из
|
||||
# списка в отдельный абзац при правке соседнего текста.
|
||||
ports_stay_one_list() {
|
||||
grep -Fxq -- '- нода 2 — `http://127.0.0.1:28124`, нативный порт `29001`;' "$README"
|
||||
}
|
||||
|
||||
# Состав `make config-test`. Разбор пробников добавлен в него отдельной
|
||||
# проверкой, и README должен называть её: иначе читатель считает, что дешёвая
|
||||
# ступень трогает только Compose, и гоняет полный стенд ради того, что видно
|
||||
# без него. Проверка стоит на двух соседних строках — см. ниже про перенос.
|
||||
probe_checks_documented() {
|
||||
awk '
|
||||
previous == "`make config-test` проверяет Compose, синтаксис Bash и Python, малые проверки" &&
|
||||
$0 == "логики пробников и пробельные ошибки в diff без запуска стенда." {
|
||||
found = 1
|
||||
}
|
||||
{previous = $0}
|
||||
END {exit !found}
|
||||
' "$README"
|
||||
}
|
||||
|
||||
# Урок из предшественника: `make up` не трогает уже созданные контейнеры, и
|
||||
# после правки настройки метрик серверы молча работают со старой
|
||||
# конфигурацией. README обязан требовать явный перезапуск. Проверка сверяет
|
||||
# две соседние строки целиком, а не подстроку: так фразу нельзя незаметно
|
||||
# разорвать переносом или переписать наполовину.
|
||||
restart_lesson_present() {
|
||||
awk '
|
||||
previous == "После изменения `infra/clickhouse/config.d/prometheus.xml` выполните" &&
|
||||
$0 == "`docker compose restart clickhouse-01 clickhouse-02`: обычный `make up` не" {
|
||||
found = 1
|
||||
}
|
||||
{previous = $0}
|
||||
END {exit !found}
|
||||
' "$README"
|
||||
}
|
||||
|
||||
check 'README перечисляет HTTP- и нативные порты обеих нод' ports_documented
|
||||
check 'README объясняет сброс томов после смены исходных учётных данных' clean_advice_present
|
||||
check 'список портов остаётся единым списком' ports_stay_one_list
|
||||
check 'README перечисляет малые проверки пробников в составе config-test' probe_checks_documented
|
||||
check 'README требует перезапуск ClickHouse после изменения настройки метрик' restart_lesson_present
|
||||
|
||||
printf 'ИТОГ: пройдено %d, ошибок 0\n' "$passed"
|
||||
@@ -46,7 +46,4 @@ else
|
||||
exit 1
|
||||
fi
|
||||
|
||||
grep -Eq '^ # .*подстановки Compose.*\$\$' "$ROOT_DIR/scripts/stand-smoke.sh"
|
||||
printf 'ЗЕЛЁНО: сложный разбор подстановок Compose пояснён рядом с кодом.\n'
|
||||
|
||||
printf 'ИТОГ: пройдено 3, ошибок 0\n'
|
||||
printf 'ИТОГ: пройдено 2, ошибок 0\n'
|
||||
|
||||
Reference in New Issue
Block a user