- Зачем:
- смоук перестал быть быстрым: 42 секунды из 48 съедали шесть проверок,
которые ждут службу — запуск DAG, вход в Superset, Kafka с машины.
- имена целей врали: смоуком звались и глубокая проверка кластера, и
интеграционные проверки; префикс достался им от общего происхождения.
- нигде не было записано, зачем в репозитории каждая цель и куда класть
новую проверку, — без записи скрипт дорастёт снова.
- Что:
- ось деления — кого спрашивают, а не сколько стоит: make smoke (стенд
собран), make check-clickhouse (спрашивают у ClickHouse), новая
make check-services (службы работают).
- шесть тяжёлых проверок переехали в scripts/stand-services.sh; общее —
счёт, обращение к Compose, зависимости машины и check_containers_survived
— вынесено в scripts/stand-common.sh, копипасты нет.
- smoke-cluster переименована в check-clickhouse; имя файла скрипта не
тронуто (в него встраивается проверка договора со схемой), расхождение
названо в карте.
- смоук и check-services печатают своё время в строке ИТОГ; порога по
времени нет — по доводу ADR 0004.
- docs/architecture/testing.md: карта всех семи целей, правило быстрого
смоука словами, лесенка по частоте и правило про краснеющую проверку,
переехавшее из README; указатель из AGENTS.md.
- README: описания целей сокращены, карта не дублируется; быстрый старт
показывает работающий стенд, а не только собранный.
- планка приёмки этапа в спеке названа поимённо: три цели вместо
«smoke-проверки».
- Проверка:
- make config-test, make smoke (19 проверок, 6 с), make check-clickhouse
(8 проверок, 7 с), make check-services (7 проверок, 44 с) — зелёные.
- 19 + 7 = 25 разных проверок, как и до деления: check_containers_survived
считается дважды намеренно.
- краснеют обе разделённые цели: со снятым prometheus смоук дал три ошибки,
с подменённым UUID подключения Superset покраснел check-services.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
219 lines
10 KiB
Bash
Executable File
219 lines
10 KiB
Bash
Executable File
#!/usr/bin/env bash
|
||
# make smoke — стенд собран: службы живы, порты отвечают, подключения настроены
|
||
# друг на друга. Проверка идёт вширь и по касательной к каждой службе, ждать
|
||
# службу здесь не полагается. Карта целей и правило быстрого смоука —
|
||
# docs/architecture/testing.md.
|
||
set -uo pipefail
|
||
|
||
source "$(dirname "${BASH_SOURCE[0]}")/stand-common.sh" || exit 1
|
||
|
||
check_container_health() {
|
||
local container_id
|
||
local service="$1"
|
||
local state
|
||
|
||
container_id="$(compose ps --all --quiet "$service" 2>/dev/null || true)"
|
||
if [[ -z "$container_id" ]]; then
|
||
fail "сервис ${service} не создан"
|
||
return
|
||
fi
|
||
state="$(docker inspect --format '{{.State.Status}}/{{if .State.Health}}{{.State.Health.Status}}{{else}}нет проверки состояния{{end}}' "$container_id" 2>/dev/null || true)"
|
||
if [[ "$state" == 'running/healthy' ]]; then
|
||
pass "сервис ${service} запущен и здоров"
|
||
else
|
||
fail "сервис ${service} нездоров: ${state:-состояние неизвестно}"
|
||
fi
|
||
}
|
||
|
||
keeper_exec() {
|
||
timeout 20s "${COMPOSE_CMD[@]}" --project-directory "$ROOT_DIR" \
|
||
exec -T clickhouse-keeper "$@" 2>/dev/null
|
||
}
|
||
|
||
# Три настройки keeper объявлены в compose.yaml: свой пользователь, свой предел
|
||
# на открытые файлы и свой том под /var/lib/clickhouse. Проверка спрашивает у
|
||
# живого контейнера, дошли ли они до процесса — здоровым keeper выглядит и без
|
||
# них, а каталог координации, однажды созданный от чужого пользователя,
|
||
# следующий запуск уже не откроет.
|
||
check_keeper_runtime() {
|
||
local keeper_nofile
|
||
local keeper_owner
|
||
local keeper_user
|
||
|
||
keeper_user="$(keeper_exec id -un)"
|
||
keeper_nofile="$(keeper_exec \
|
||
awk '$1 == "Max" && $2 == "open" && $3 == "files" {print $4}' /proc/1/limits)"
|
||
keeper_owner="$(keeper_exec stat -c '%U:%G' /var/lib/clickhouse/coordination)"
|
||
if [[ "$keeper_user" == 'clickhouse' ]] && \
|
||
[[ "$keeper_nofile" -ge 262144 ]] && \
|
||
[[ "$keeper_owner" == 'clickhouse:clickhouse' ]]; then
|
||
pass 'keeper работает от clickhouse с nofile 262144 и своим каталогом данных'
|
||
else
|
||
fail "неверное окружение keeper: пользователь=${keeper_user:-нет ответа}, nofile=${keeper_nofile:-нет ответа}, владелец каталога=${keeper_owner:-нет ответа}"
|
||
fi
|
||
}
|
||
|
||
check_prometheus_targets() {
|
||
local port
|
||
local response
|
||
local targets_response
|
||
|
||
port="$(published_port prometheus 9090)"
|
||
response="$(curl -sf "http://127.0.0.1:${port}/api/v1/query?query=up" 2>/dev/null || true)"
|
||
targets_response="$(curl -sf "http://127.0.0.1:${port}/api/v1/targets?state=active" 2>/dev/null || true)"
|
||
if jq -e '
|
||
.status == "success" and
|
||
(.data.result | length == 3) and
|
||
([.data.result[].metric.instance] | sort ==
|
||
["clickhouse-01:9363", "clickhouse-02:9363", "clickhouse-keeper:9363"]) and
|
||
all(.data.result[]; .value[1] == "1")
|
||
' >/dev/null 2>&1 <<<"$response" && jq -e '
|
||
.status == "success" and
|
||
(.data.activeTargets | length == 3) and
|
||
([.data.activeTargets[].scrapeUrl] | sort == [
|
||
"http://clickhouse-01:9363/metrics",
|
||
"http://clickhouse-02:9363/metrics",
|
||
"http://clickhouse-keeper:9363/metrics"
|
||
]) and
|
||
all(.data.activeTargets[]; .health == "up" and .lastError == "")
|
||
' >/dev/null 2>&1 <<<"$targets_response"; then
|
||
pass 'Prometheus видит ровно три цели ClickHouse, все со значением up=1'
|
||
else
|
||
fail 'Prometheus не видит ровно три здоровые цели: clickhouse-01, clickhouse-02 и clickhouse-keeper'
|
||
fi
|
||
}
|
||
|
||
check_grafana_datasource() {
|
||
local config
|
||
local password
|
||
local port
|
||
local datasource
|
||
local provisioning_file_ok=0
|
||
local response
|
||
local user
|
||
|
||
config="$(compose config --format json 2>/dev/null || true)"
|
||
user="$(jq -r '.services.grafana.environment.GF_SECURITY_ADMIN_USER // empty' <<<"$config")"
|
||
password="$(jq -r '.services.grafana.environment.GF_SECURITY_ADMIN_PASSWORD // empty' <<<"$config")"
|
||
port="$(published_port grafana 3000)"
|
||
timeout 20s "${COMPOSE_CMD[@]}" --project-directory "$ROOT_DIR" \
|
||
exec -T grafana sh -ec '
|
||
file=/etc/grafana/provisioning/datasources/prometheus.yml
|
||
test -r "$file"
|
||
grep -Eq "^[[:space:]]+uid: prometheus$" "$file"
|
||
grep -Eq "^[[:space:]]+type: prometheus$" "$file"
|
||
grep -Eq "^[[:space:]]+url: http://prometheus:9090$" "$file"
|
||
grep -Eq "^[[:space:]]+isDefault: true$" "$file"
|
||
grep -Eq "^[[:space:]]+editable: false$" "$file"
|
||
' >/dev/null 2>&1 && provisioning_file_ok=1
|
||
datasource="$(curl -sf -u "${user}:${password}" \
|
||
"http://127.0.0.1:${port}/api/datasources/uid/prometheus" 2>/dev/null || true)"
|
||
response="$(curl -sf -u "${user}:${password}" \
|
||
"http://127.0.0.1:${port}/api/datasources/uid/prometheus/health" 2>/dev/null || true)"
|
||
if [[ "$provisioning_file_ok" -eq 1 ]] && jq -e '
|
||
.uid == "prometheus" and
|
||
.type == "prometheus" and
|
||
.url == "http://prometheus:9090" and
|
||
.access == "proxy" and
|
||
.isDefault == true and
|
||
.readOnly == true
|
||
' >/dev/null 2>&1 <<<"$datasource" && \
|
||
jq -e '.status == "OK"' >/dev/null 2>&1 <<<"$response"; then
|
||
pass 'Grafana проверила файл настройки и подготовленный источник Prometheus с uid=prometheus'
|
||
else
|
||
fail 'Grafana не смогла проверить файл настройки и подготовленный источник Prometheus с uid=prometheus'
|
||
fi
|
||
}
|
||
|
||
# Три вопроса о связности, и все три Airflow отвечает сразу. Запуск пробников —
|
||
# другое дело: он ждёт такта планировщика и живёт в make check-services.
|
||
check_airflow() {
|
||
local airflow_port
|
||
local airflow_token
|
||
local config
|
||
local connection
|
||
local dag
|
||
local dag_id
|
||
local health
|
||
local password
|
||
local response
|
||
local user
|
||
|
||
config="$(compose config --format json 2>/dev/null || true)"
|
||
user="$(jq -r '.services["airflow-apiserver"].environment.AIRFLOW_ADMIN_USER // empty' <<<"$config")"
|
||
password="$(jq -r '.services["airflow-apiserver"].environment.AIRFLOW_ADMIN_PASSWORD // empty' <<<"$config")"
|
||
airflow_port="$(published_port airflow-apiserver 8080)"
|
||
|
||
health="$(curl -sf --max-time 10 \
|
||
"http://127.0.0.1:${airflow_port}/api/v2/monitor/health" 2>/dev/null || true)"
|
||
if jq -e '
|
||
.metadatabase.status == "healthy" and
|
||
.scheduler.status == "healthy" and
|
||
.dag_processor.status == "healthy"
|
||
' >/dev/null 2>&1 <<<"$health"; then
|
||
pass 'API Airflow отвечает; база метаданных, планировщик и обработчик DAG здоровы'
|
||
else
|
||
fail 'API Airflow не подтвердил здоровье базы метаданных, планировщика и обработчика DAG'
|
||
fi
|
||
|
||
response="$(curl -sf --max-time 10 -X POST \
|
||
-H 'Content-Type: application/json' \
|
||
-d "$(jq -cn --arg username "$user" --arg password "$password" \
|
||
'{username: $username, password: $password}')" \
|
||
"http://127.0.0.1:${airflow_port}/auth/token" 2>/dev/null || true)"
|
||
airflow_token="$(jq -r '.access_token // empty' <<<"$response")"
|
||
if [[ -z "$airflow_token" ]]; then
|
||
fail 'Airflow не принял учётные данные администратора'
|
||
return
|
||
fi
|
||
for dag_id in test_clickhouse test_kafka; do
|
||
dag="$(curl -sf --max-time 10 \
|
||
-H "Authorization: Bearer ${airflow_token}" \
|
||
"http://127.0.0.1:${airflow_port}/api/v2/dags/${dag_id}" \
|
||
2>/dev/null || true)"
|
||
if ! jq -e --arg dag_id "$dag_id" '.dag_id == $dag_id' \
|
||
>/dev/null 2>&1 <<<"$dag"; then
|
||
fail "Airflow не показал пробник ${dag_id}"
|
||
return
|
||
fi
|
||
done
|
||
pass 'учётные данные администратора Airflow принимаются, оба пробника видны через API'
|
||
|
||
connection="$(curl -sf --max-time 10 \
|
||
-H "Authorization: Bearer ${airflow_token}" \
|
||
"http://127.0.0.1:${airflow_port}/api/v2/connections/clickhouse_default" \
|
||
2>/dev/null || true)"
|
||
if jq -e '
|
||
.connection_id == "clickhouse_default" and
|
||
.host == "clickhouse-01" and
|
||
.port == 8123 and
|
||
.login == "default" and
|
||
.schema == "default"
|
||
' >/dev/null 2>&1 <<<"$connection" && \
|
||
timeout 20s "${COMPOSE_CMD[@]}" --project-directory "$ROOT_DIR" \
|
||
exec -T airflow-scheduler \
|
||
curl -sf 'http://clickhouse-01:8123/?query=SELECT%201' \
|
||
2>/dev/null | grep -qx '1'; then
|
||
pass 'подготовленное подключение Airflow указывает на clickhouse-01, нода доступна из контейнера'
|
||
else
|
||
fail 'подключение Airflow не указывает на clickhouse-01 или нода недоступна из контейнера'
|
||
fi
|
||
}
|
||
|
||
if require_host_dependencies; then
|
||
pass 'на машине доступны Docker, Docker Compose, curl, jq, awk, grep, sed, tail, sleep и timeout'
|
||
for service in "${LONG_LIVED_SERVICES[@]}"; do
|
||
check_container_health "$service"
|
||
done
|
||
check_keeper_runtime
|
||
check_prometheus_targets
|
||
check_grafana_datasource
|
||
check_airflow
|
||
check_containers_survived
|
||
else
|
||
fail 'проверки контейнеров, Airflow, Prometheus и Grafana пропущены без зависимостей машины'
|
||
fi
|
||
|
||
print_total
|
||
[[ "$failed" -eq 0 ]]
|