From ee49993affca1cd138fb98175c3876d8e207b534 Mon Sep 17 00:00:00 2001 From: Pjandro Date: Mon, 19 Oct 2026 22:31:44 +0000 Subject: [PATCH] =?UTF-8?q?tests:=20prod-autotests=20=E2=80=94=20pytest-?= =?UTF-8?q?=D0=BD=D0=B0=D0=B1=D0=BE=D1=80=20=D0=B0=D0=B2=D1=82=D0=BE=D1=82?= =?UTF-8?q?=D0=B5=D1=81=D1=82=D0=BE=D0=B2=20API=20=D0=BF=D1=80=D0=BE=D0=B4?= =?UTF-8?q?=D0=B0=20(env-=D0=BA=D0=BE=D0=BD=D1=84=D0=B8=D0=B3=D1=83=D1=80?= =?UTF-8?q?=D0=B0=D1=86=D0=B8=D1=8F,=20mise-=D0=BE=D0=BA=D1=80=D1=83=D0=B6?= =?UTF-8?q?=D0=B5=D0=BD=D0=B8=D0=B5)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 18 проверок gateway → Spring Boot + SPA: открытые пути (actuator, SPA, springdoc), граница X-API-Key (401), конвертация (PDF, RFC 5987 filename*), отказы входа (400/422), лимит страниц — limit-aware через WORDPDF_MAX_PAGES. Стенд задаётся только env; прод-раннер живёт вне git. --- .gitignore | 5 + AGENTS.md | 1 + prod-autotests/conftest.py | 86 +++++++++++ prod-autotests/mise.toml | 5 + prod-autotests/requirements.txt | 2 + prod-autotests/test_prod_api.py | 250 ++++++++++++++++++++++++++++++++ 6 files changed, 349 insertions(+) create mode 100644 prod-autotests/conftest.py create mode 100644 prod-autotests/mise.toml create mode 100644 prod-autotests/requirements.txt create mode 100644 prod-autotests/test_prod_api.py diff --git a/.gitignore b/.gitignore index d684903..5a9e4fc 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,11 @@ dependency-reduced-pom.xml node_modules/ wordpdf-web/dist/ +# Python (prod-autotests) +.venv/ +__pycache__/ +.pytest_cache/ + # IDE .idea/ *.iml diff --git a/AGENTS.md b/AGENTS.md index 55c15ca..3ebdebd 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -57,6 +57,7 @@ Java2D → PNG 300 dpi (`ChartRenderer.DPI = 300`, `PADDING = 4.0`, растр |`wordpdf-web/src/`|SPA (React 19 + TS + Vite + Tailwind): `api.ts` (вся сеть), `components/` (App, ApiKeyGate, PdfPreview, StatusMessage, DropZone, Logo)| |корневые `Containerfile`, `compose.yml`, `compose.dev.yml`, `gateway/nginx.conf`|образ бэкенда (multi-stage maven:3.9-temurin-21 → temurin-21-jre, non-root, HEALTHCHECK actuator); compose app+web+gateway: web-образ со своим HEALTHCHECK (`wget /`), в обоих compose `depends_on web: condition: service_healthy` (без health web gateway не стартует); прод-compose интерполирует `WORDPDF_MAX_BYTES:-5242880`/`WORDPDF_MAX_PAGES:-100`; podman-специфика обоих compose: `x-podman.name_separator_compat` (docker-style имена контейнеров), явные `healthcheck` app/web (дубли Containerfile-HEALTHCHECK — OCI-выгрузка его теряет), зафиксированная подсеть `10.113.0.0/24` gw `10.113.0.1` под резолвер aardvark-dns; два repo-стенда одновременно не поднять (общая подсеть)| |корневой `.env.example`|шаблон env: `WORDPDF_API_KEY` (`openssl rand -hex 32`), закомментированные `WORDPDF_MAX_BYTES`/`WORDPDF_MAX_PAGES`; реальный прод `.env` — на прод-сервере (координаты: `/home/pjandro/prod/java-word-pdf/DEPLOY.md`, вне репо)| +|корневой `prod-autotests/`|прод-автотесты API (pytest + requests, 18 проверок): конфигурация стенда **только env** (`WORDPDF_BASE_URL` обязателен, `WORDPDF_API_KEY`/`WORDPDF_MAX_PAGES`/`WORDPDF_SAMPLES_DIR` факультативны) — прод-хостов/ключей в коде нет; окружение — mise (`mise.toml`: python 3.15 + автосоздаваемый `.venv`, в venv от uv pip досеивается `ensurepip`); прод-раннер вне git — `/home/pjandro/prod/java-word-pdf/run-prod-tests.sh` (знает прод-настройки: base URL, лимит 1000 стр., ключ из соседнего `.env`)| |`develop/` (вне git)|рабочие материалы и эталоны Word 365 (`word.docx`+`word.pdf`, `word-export.*`, `convert.pdf`, `1212.pdf`, `diff/`) — **ручное сравнение, не фикстуры**, в тесты/jar не подключать| ## Development Commands diff --git a/prod-autotests/conftest.py b/prod-autotests/conftest.py new file mode 100644 index 0000000..6205b2c --- /dev/null +++ b/prod-autotests/conftest.py @@ -0,0 +1,86 @@ +"""Автотесты прода wordpdf: стенд задаётся исключительно переменными окружения. + +Запуск из этого каталога (подхватывается mise.toml — python + venv + зависимости): + + WORDPDF_BASE_URL=<стенд> [WORDPDF_API_KEY=<ключ>] mise exec -- python -m pytest -q . + +WORDPDF_BASE_URL обязателен: без него все проверки падают — набор принципиально +не знает ни одного хоста. WORDPDF_API_KEY факультативен: без него проверки, +где есть заголовок ключа или ожидается 401, пропускаются (без локального ключа +нельзя знать, включена ли аутентификация на стенде). WORDPDF_MAX_PAGES — ожидаемый +лимит страниц стенда (конфигурация сервера, не константа набора; дефолт 100 = +дефолт ядра). .docx-фикстуры — из wordpdf-core/src/test/resources/samples, +либо из WORDPDF_SAMPLES_DIR. +""" + +import os +from pathlib import Path + +import pytest + +# (connect, read): read 180 с — с запасом над серверным wordpdf.convert-timeout=2m +# (504 по таймауту — тоже ответ сервера, но до него не доходим). +TIMEOUT = (10, 180) + +# Навешивается на все проверки с заголовком ключа или ожиданием 401: на стенде +# без аутентификации (dev) они дали бы ложный FAIL, а не честный SKIP. +needs_key = pytest.mark.skipif( + not os.environ.get("WORDPDF_API_KEY", "").strip(), + reason="WORDPDF_API_KEY не задан — стенд без аутентификации или ключ не передан", +) + + +@pytest.fixture(scope="session") +def base_url(): + """Корень стенда только из env; пустой — провал, а не дефолт-хост.""" + url = os.environ.get("WORDPDF_BASE_URL", "").strip().rstrip("/") + if not url: + pytest.fail("WORDPDF_BASE_URL не задан — набор привязан к стенду только этой переменной") + return url + + +@pytest.fixture(scope="session") +def url(base_url): + """Единая склейка base + путь — все запросы тестов идут через неё.""" + + def join(path): + return base_url + path + + return join + + +@pytest.fixture(scope="session") +def max_pages(): + """Ожидаемый лимит страниц стенда: серверная конфигурация, не константа набора.""" + return int(os.environ.get("WORDPDF_MAX_PAGES", "100")) + + +@pytest.fixture(scope="session") +def api_key(): + return os.environ.get("WORDPDF_API_KEY", "").strip() + + +@pytest.fixture(scope="session") +def key_header(api_key): + return {"X-API-Key": api_key} if api_key else {} + + +@pytest.fixture(scope="session") +def samples(): + """Каталог закоммиченных .docx-фикстур ядра (только чтение).""" + env = os.environ.get("WORDPDF_SAMPLES_DIR", "").strip() + d = Path(env) if env else ( + Path(__file__).resolve().parents[1] + / "wordpdf-core" / "src" / "test" / "resources" / "samples" + ) + if not (d / "en-plain.docx").is_file(): + pytest.fail("фикстуры не найдены: укажите WORDPDF_SAMPLES_DIR") + return d + + +@pytest.fixture +def notzip_docx(tmp_path): + """Файл с валидным .docx-суффиксом и случайным содержимым — граница «не zip → 400, а не 500».""" + p = tmp_path / "notzip.docx" + p.write_bytes(os.urandom(2048)) + return p diff --git a/prod-autotests/mise.toml b/prod-autotests/mise.toml new file mode 100644 index 0000000..32a24c7 --- /dev/null +++ b/prod-autotests/mise.toml @@ -0,0 +1,5 @@ +[tools] +python = "3.15" + +[env] +_.python.venv = { path = ".venv", create = true } diff --git a/prod-autotests/requirements.txt b/prod-autotests/requirements.txt new file mode 100644 index 0000000..bbd5498 --- /dev/null +++ b/prod-autotests/requirements.txt @@ -0,0 +1,2 @@ +pytest==9.1.1 +requests==2.34.2 diff --git a/prod-autotests/test_prod_api.py b/prod-autotests/test_prod_api.py new file mode 100644 index 0000000..b3178b5 --- /dev/null +++ b/prod-autotests/test_prod_api.py @@ -0,0 +1,250 @@ +"""Проверки прода-API wordpdf: gateway → Spring Boot (`POST /api/v1/convert` за X-API-Key) + SPA. + +Коды и тела ответов соответствуют ApiExceptionHandler / ApiKeyFilter / +ConvertController на main. Флаги конвертации передаются только в query-строке +(контроллер принимает и form, но query детерминированнее). +""" + +import requests + +from conftest import TIMEOUT, needs_key + +CONVERT = "/api/v1/convert" + + +# --- открытые пути (ключ не нужен ни при каком стенде) ----------------------- + + +def test_health(url): + """Живость: actuator health открыт без ключа (HEALTHCHECK контейнера).""" + r = requests.get(url("/actuator/health"), timeout=TIMEOUT) + assert r.status_code == 200 + assert r.json()["status"] == "UP" + + +def test_spa_root(url): + """SPA отдаётся гейтваем: корень — HTML приложения с монтажным узлом.""" + r = requests.get(url("/"), timeout=TIMEOUT) + assert r.status_code == 200 + assert "text/html" in r.headers["content-type"] + assert 'id="root"' in r.text + + +def test_swagger_ui_open_without_key(url): + """Документация открыта без ключа — регрессия docsOpenWithoutKey.""" + r = requests.get(url("/swagger-ui.html"), timeout=TIMEOUT) + assert r.status_code == 200 + + +def test_api_docs_spec(url): + """Спек OpenAPI открыт без ключа и описывает единственный эндпоинт.""" + r = requests.get(url("/v3/api-docs"), timeout=TIMEOUT) + assert r.status_code == 200 + assert "/api/v1/convert" in r.text + + +# --- дальше все проверки требуют переданный ключ ---------------------------- + + +@needs_key +def test_no_key_rejected(url, samples): + """Граница доступа: запрос без заголовка X-API-Key — 401 от ApiKeyFilter.""" + r = requests.post( + url(CONVERT), + files={"file": ("en-plain.docx", (samples / "en-plain.docx").read_bytes())}, + timeout=TIMEOUT, + ) + assert r.status_code == 401 + assert "X-API-Key" in r.json()["error"] + + +@needs_key +def test_wrong_key_rejected(url, samples): + """Граница доступа: неверный ключ — тот же 401, без различения «нет/неверен».""" + r = requests.post( + url(CONVERT), + headers={"X-API-Key": "wrong-key-000"}, + files={"file": ("en-plain.docx", (samples / "en-plain.docx").read_bytes())}, + timeout=TIMEOUT, + ) + assert r.status_code == 401 + + +@needs_key +def test_convert_returns_pdf(url, samples, key_header): + """Основной путь: .docx → PDF-аттачмент с ASCII-именем в filename*.""" + r = requests.post( + url(CONVERT), + headers=key_header, + files={"file": ("en-plain.docx", (samples / "en-plain.docx").read_bytes())}, + timeout=TIMEOUT, + ) + assert r.status_code == 200 + assert "application/pdf" in r.headers["content-type"] + assert r.content[:4] == b"%PDF" + disp = r.headers["content-disposition"] + assert "attachment" in disp + assert "filename*=UTF-8''en-plain.pdf" in disp + + +@needs_key +def test_convert_cyrillic_filename_rfc5987(url, samples, key_header): + """Кириллическое имя части → RFC 5987 filename* (safeBaseName), заголовок не режется наружным nginx. + + Если стенд вернёт filename*=UTF-8''document.pdf — Tomcat не раскодировал + UTF-8 имя части (имя теряется на стенде); тогда ассерт фиксирует фактическое значение. + """ + r = requests.post( + url(CONVERT), + headers=key_header, + files={"file": ("тест документ.docx", (samples / "en-plain.docx").read_bytes())}, + timeout=TIMEOUT, + ) + assert r.status_code == 200 + assert ( + "filename*=UTF-8''%D1%82%D0%B5%D1%81%D1%82%20" + "%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.pdf" + in r.headers["content-disposition"] + ) + + +@needs_key +def test_too_many_pages_vs_limit(url, samples, key_header, max_pages): + """too-many-pages.docx (151 стр.): сверх лимита стенда — 400 до рендера; ниже лимита — конвертится. + + Лимит страниц — конфигурация сервера (env WORDPDF_MAX_PAGES), не константа + набора: прод идёт со 1000, там фикстура — валидный вход; 400-ветка покрыта + Java-регрессией WordPdfConverterTest#staleCachePageCountRejectedBeforeRender. + """ + r = requests.post( + url(CONVERT), + headers=key_header, + files={"file": ("too-many-pages.docx", (samples / "too-many-pages.docx").read_bytes())}, + timeout=TIMEOUT, + ) + if max_pages < 151: + assert r.status_code == 400 + assert "error" in r.json() + else: + assert r.status_code == 200 + assert r.content[:4] == b"%PDF" + + +@needs_key +def test_stale_cache_vs_limit(url, samples, key_header, max_pages): + """stale-cache.docx (кэш 1 + 110 lastRenderedPageBreak = 111 стр.): валидатор считает разрывы, не кэш. + + Сверх лимита — 400 (заниженный кэш не спасает), ниже лимита — 200; + ветки те же, что у test_too_many_pages_vs_limit. + """ + r = requests.post( + url(CONVERT), + headers=key_header, + files={"file": ("stale-cache.docx", (samples / "stale-cache.docx").read_bytes())}, + timeout=TIMEOUT, + ) + if max_pages < 111: + assert r.status_code == 400 + assert "error" in r.json() + else: + assert r.status_code == 200 + assert r.content[:4] == b"%PDF" + + +@needs_key +def test_not_a_zip_rejected(url, notzip_docx, key_header): + """Граница «сломанный контейнер → 400, а не 500»: .docx-суффикс, содержимое — мусор.""" + r = requests.post( + url(CONVERT), + headers=key_header, + files={"file": (notzip_docx.name, notzip_docx.read_bytes())}, + timeout=TIMEOUT, + ) + assert r.status_code == 400 + assert "error" in r.json() + + +@needs_key +def test_wrong_extension_rejected(url, samples, key_header): + """Расширение проверяет контроллер (ядро байтов его не видит) — регрессия nonDocxFilename_rejected.""" + r = requests.post( + url(CONVERT), + headers=key_header, + files={"file": ("file.txt", (samples / "en-plain.docx").read_bytes())}, + timeout=TIMEOUT, + ) + assert r.status_code == 400 + assert ".docx" in r.json()["error"] + + +@needs_key +def test_empty_file_rejected(url, key_header): + """Пустая часть — некорректный вход (400), а не ошибка рендера.""" + r = requests.post( + url(CONVERT), + headers=key_header, + files={"file": ("empty.docx", b"")}, + timeout=TIMEOUT, + ) + assert r.status_code == 400 + assert "error" in r.json() + + +@needs_key +def test_missing_part_rejected(url, key_header): + """Партиты `file` нет в multipart — 400 от MissingServletRequestPartException.""" + r = requests.post( + url(CONVERT), + headers=key_header, + files={"junk": ("x", b"1")}, + timeout=TIMEOUT, + ) + assert r.status_code == 400 + assert "file" in r.json()["error"] + + +@needs_key +def test_unknown_path_not_found(url, key_header): + """Неизвестный путь под ключом — 404 JSON, а не 500 (regression unknownPath_notFound).""" + r = requests.get(url("/api/v1/nope"), headers=key_header, timeout=TIMEOUT) + assert r.status_code == 404 + assert "error" in r.json() + + +@needs_key +def test_error_on_charts_rejected(url, samples, key_header): + """errorOnCharts при выключенном renderCharts — 422 (DrawingRejectedException); render-флаг приоритетнее.""" + r = requests.post( + url(CONVERT) + "?errorOnCharts=true&renderCharts=false", + headers=key_header, + files={"file": ("charts-smartart.docx", (samples / "charts-smartart.docx").read_bytes())}, + timeout=TIMEOUT, + ) + assert r.status_code == 422 + assert "error" in r.json() + + +@needs_key +def test_render_flags_off_converts(url, samples, key_header): + """Оба render-флага выключены — диаграммы/SmartArt пропускаются до рендера, PDF без них.""" + r = requests.post( + url(CONVERT) + "?renderCharts=false&renderSmartArt=false", + headers=key_header, + files={"file": ("charts-smartart.docx", (samples / "charts-smartart.docx").read_bytes())}, + timeout=TIMEOUT, + ) + assert r.status_code == 200 + assert r.content[:4] == b"%PDF" + + +@needs_key +def test_charts_full_render(url, samples, key_header): + """Дефолтные флаги — полный Java2D-путь диаграмм/SmartArt в PNG — фикстура charts-smartart.docx.""" + r = requests.post( + url(CONVERT), + headers=key_header, + files={"file": ("charts-smartart.docx", (samples / "charts-smartart.docx").read_bytes())}, + timeout=TIMEOUT, + ) + assert r.status_code == 200 + assert r.content[:4] == b"%PDF" -- 2.56.1