JaCoCo: гейт покрытия 90% + сводка/артефакты репортов в CI #35

Merged
pjandro merged 4 commits from jacoco-coverage into main 2026-10-24 21:56:34 +03:00
3 changed files with 78 additions and 48 deletions
Showing only changes of commit b9ce970d26 - Show all commits
+34 -21
View File
@@ -35,7 +35,7 @@ jobs:
- name: Coverage summary - name: Coverage summary
if: always() if: always()
run: | run: |
python3 - <<'PY' >> "$GITHUB_STEP_SUMMARY" python3 - <<'PY' > coverage-summary.md
import os import os
import xml.etree.ElementTree as ET import xml.etree.ElementTree as ET
def pct(root, kind): def pct(root, kind):
@@ -44,6 +44,7 @@ jobs:
missed, covered = int(c.get("missed")), int(c.get("covered")) missed, covered = int(c.get("missed")), int(c.get("covered"))
return f"{100.0 * covered / (missed + covered):.1f}%" return f"{100.0 * covered / (missed + covered):.1f}%"
return "—" return "—"
print("<!-- jacoco-coverage -->")
print("## Покрытие (JaCoCo)\n") print("## Покрытие (JaCoCo)\n")
print("| Модуль | Строки | Ветви | Порог строк |") print("| Модуль | Строки | Ветви | Порог строк |")
print("|---|---|---|---|") print("|---|---|---|---|")
@@ -55,30 +56,42 @@ jobs:
r = ET.parse(p).getroot() r = ET.parse(p).getroot()
print(f"| {m} | {pct(r, 'LINE')} | {pct(r, 'BRANCH')} | 90% |") print(f"| {m} | {pct(r, 'LINE')} | {pct(r, 'BRANCH')} | 90% |")
PY PY
cat coverage-summary.md >> "$GITHUB_STEP_SUMMARY"
# v3, не v4: артефакт-сервер Gitea говорит по протоколу actions/artifact v1, # Таблица покрытия — комментарием в PR: видно в обсуждении, не открывая run.
# v4+ падает «not currently supported on GHES». Один zip вместо ~150 файлов: # Повторные push обновляют тот же комментарий (поиск по маркеру),
# v1 грузит каждый файл отдельным запросом — поштучно это минуты; # github.token — task-токен раннера, падение не валит job. Артефактов с
# python3 (не zip) — гарантирован на раннере, см. шаг Coverage summary # отчётами НЕТ намеренно: upload-artifact@v4 Gitea не поддерживает, @v3 на
- name: Pack coverage reports # этом стенде висит на загрузке (отменена и с 153 файлами, и с одним zip);
if: always() # HTML — локально в target/site/jacoco. Шаг байт-в-байт одинаков в обоих
# workflow, в main.yml if не срабатывает — нет PR-события
- name: Comment coverage on PR
if: always() && github.event_name == 'pull_request'
continue-on-error: true
env:
GITEA_TOKEN: ${{ github.token }}
API: ${{ github.api_url }}
REPO: ${{ github.repository }}
PR_NUMBER: ${{ github.event.pull_request.number }}
run: | run: |
[ -s coverage-summary.md ] || exit 0
python3 - <<'PY' python3 - <<'PY'
import os, zipfile import json, os, urllib.request
with zipfile.ZipFile("jacoco-html.zip", "w", zipfile.ZIP_DEFLATED) as z: api, repo, pr = os.environ["API"], os.environ["REPO"], os.environ["PR_NUMBER"]
for m in ("wordpdf-core", "wordpdf-app"): token = os.environ["GITEA_TOKEN"]
d = f"{m}/target/site/jacoco" body = open("coverage-summary.md").read()
for root, _, files in os.walk(d): def req(method, url, payload=None):
for f in files: data = json.dumps(payload).encode() if payload is not None else None
p = os.path.join(root, f) r = urllib.request.Request(url, data=data, method=method,
z.write(p, p) headers={"Authorization": f"token {token}",
"Content-Type": "application/json"})
return json.loads(urllib.request.urlopen(r).read() or "null")
base = f"{api}/repos/{repo}/issues/{pr}/comments"
existing = next((c["id"] for c in req("GET", base)
if "<!-- jacoco-coverage -->" in c.get("body", "")), None)
req("PATCH" if existing else "POST",
f"{base}/{existing}" if existing else base, {"body": body})
PY PY
- name: Upload coverage reports
if: always()
uses: actions/upload-artifact@v3
with:
name: jacoco-html
path: jacoco-html.zip
web: web:
runs-on: ubuntu-latest runs-on: ubuntu-latest
+34 -21
View File
@@ -34,7 +34,7 @@ jobs:
- name: Coverage summary - name: Coverage summary
if: always() if: always()
run: | run: |
python3 - <<'PY' >> "$GITHUB_STEP_SUMMARY" python3 - <<'PY' > coverage-summary.md
import os import os
import xml.etree.ElementTree as ET import xml.etree.ElementTree as ET
def pct(root, kind): def pct(root, kind):
@@ -43,6 +43,7 @@ jobs:
missed, covered = int(c.get("missed")), int(c.get("covered")) missed, covered = int(c.get("missed")), int(c.get("covered"))
return f"{100.0 * covered / (missed + covered):.1f}%" return f"{100.0 * covered / (missed + covered):.1f}%"
return "—" return "—"
print("<!-- jacoco-coverage -->")
print("## Покрытие (JaCoCo)\n") print("## Покрытие (JaCoCo)\n")
print("| Модуль | Строки | Ветви | Порог строк |") print("| Модуль | Строки | Ветви | Порог строк |")
print("|---|---|---|---|") print("|---|---|---|---|")
@@ -54,30 +55,42 @@ jobs:
r = ET.parse(p).getroot() r = ET.parse(p).getroot()
print(f"| {m} | {pct(r, 'LINE')} | {pct(r, 'BRANCH')} | 90% |") print(f"| {m} | {pct(r, 'LINE')} | {pct(r, 'BRANCH')} | 90% |")
PY PY
cat coverage-summary.md >> "$GITHUB_STEP_SUMMARY"
# v3, не v4: артефакт-сервер Gitea говорит по протоколу actions/artifact v1, # Таблица покрытия — комментарием в PR: видно в обсуждении, не открывая run.
# v4+ падает «not currently supported on GHES». Один zip вместо ~150 файлов: # Повторные push обновляют тот же комментарий (поиск по маркеру),
# v1 грузит каждый файл отдельным запросом — поштучно это минуты; # github.token — task-токен раннера, падение не валит job. Артефактов с
# python3 (не zip) — гарантирован на раннере, см. шаг Coverage summary # отчётами НЕТ намеренно: upload-artifact@v4 Gitea не поддерживает, @v3 на
- name: Pack coverage reports # этом стенде висит на загрузке (отменена и с 153 файлами, и с одним zip);
if: always() # HTML — локально в target/site/jacoco. Шаг байт-в-байт одинаков в обоих
# workflow, в main.yml if не срабатывает — нет PR-события
- name: Comment coverage on PR
if: always() && github.event_name == 'pull_request'
continue-on-error: true
env:
GITEA_TOKEN: ${{ github.token }}
API: ${{ github.api_url }}
REPO: ${{ github.repository }}
PR_NUMBER: ${{ github.event.pull_request.number }}
run: | run: |
[ -s coverage-summary.md ] || exit 0
python3 - <<'PY' python3 - <<'PY'
import os, zipfile import json, os, urllib.request
with zipfile.ZipFile("jacoco-html.zip", "w", zipfile.ZIP_DEFLATED) as z: api, repo, pr = os.environ["API"], os.environ["REPO"], os.environ["PR_NUMBER"]
for m in ("wordpdf-core", "wordpdf-app"): token = os.environ["GITEA_TOKEN"]
d = f"{m}/target/site/jacoco" body = open("coverage-summary.md").read()
for root, _, files in os.walk(d): def req(method, url, payload=None):
for f in files: data = json.dumps(payload).encode() if payload is not None else None
p = os.path.join(root, f) r = urllib.request.Request(url, data=data, method=method,
z.write(p, p) headers={"Authorization": f"token {token}",
"Content-Type": "application/json"})
return json.loads(urllib.request.urlopen(r).read() or "null")
base = f"{api}/repos/{repo}/issues/{pr}/comments"
existing = next((c["id"] for c in req("GET", base)
if "<!-- jacoco-coverage -->" in c.get("body", "")), None)
req("PATCH" if existing else "POST",
f"{base}/{existing}" if existing else base, {"body": body})
PY PY
- name: Upload coverage reports
if: always()
uses: actions/upload-artifact@v3
with:
name: jacoco-html
path: jacoco-html.zip
web: web:
runs-on: ubuntu-latest runs-on: ubuntu-latest
+10 -6
View File
@@ -58,7 +58,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)| |`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-alpine** (musl) — chart-движку нужен только модуль java.desktop (Graphics2D, он внутри JRE); fontconfig и системные шрифты рантайму не нужны — текст рисуется глифами fontbox, см. `fonts/GlyphFont` (проверено на musl-стенде без libfontconfig/`/etc/fonts`); HEALTHCHECK busybox `wget` (curl/apt не ставим), non-root uid 10001); compose app+web+gateway: web-образ со своим HEALTHCHECK (`wget /`), в обоих compose `depends_on web: condition: service_healthy`; прод-compose не в репо — его рендерит job `deploy` (лимиты запекаются из Variables); podman-специфика обоих compose: `x-podman.name_separator_compat` (docker-style имена), явные `healthcheck` app/web (дубли Containerfile-HEALTHCHECK — OCI-выгрузка его теряет; app-хелсчеки — `wget`, как в Containerfile), зафиксированная подсеть `10.113.0.0/24` gw `10.113.0.1` под резолвер aardvark-dns; два repo-стенда одновременно не поднять (общая подсеть)| |корневые `Containerfile`, `compose.yml`, `compose.dev.yml`, `gateway/nginx.conf`|образ бэкенда (multi-stage maven:3.9-temurin-21 → temurin-**21-jre-alpine** (musl) — chart-движку нужен только модуль java.desktop (Graphics2D, он внутри JRE); fontconfig и системные шрифты рантайму не нужны — текст рисуется глифами fontbox, см. `fonts/GlyphFont` (проверено на musl-стенде без libfontconfig/`/etc/fonts`); HEALTHCHECK busybox `wget` (curl/apt не ставим), non-root uid 10001); compose app+web+gateway: web-образ со своим HEALTHCHECK (`wget /`), в обоих compose `depends_on web: condition: service_healthy`; прод-compose не в репо — его рендерит job `deploy` (лимиты запекаются из Variables); podman-специфика обоих compose: `x-podman.name_separator_compat` (docker-style имена), явные `healthcheck` app/web (дубли Containerfile-HEALTHCHECK — OCI-выгрузка его теряет; app-хелсчеки — `wget`, как в Containerfile), зафиксированная подсеть `10.113.0.0/24` gw `10.113.0.1` под резолвер aardvark-dns; два repo-стенда одновременно не поднять (общая подсеть)|
|корневой `.env.example`|шаблон env для локальных/compose-стендов: `WORDPDF_API_KEY` (`openssl rand -hex 32`), закомментированные `WORDPDF_MAX_MB`/`WORDPDF_MAX_PAGES` (пустое значение ломает старт — binding long/int); проду `.env` **не нужен**: ключ и лимиты подаёт job `deploy` из Gitea Secrets/Variables, legacy-`.env` на проде удаляется деплоем| |корневой `.env.example`|шаблон env для локальных/compose-стендов: `WORDPDF_API_KEY` (`openssl rand -hex 32`), закомментированные `WORDPDF_MAX_MB`/`WORDPDF_MAX_PAGES` (пустое значение ломает старт — binding long/int); проду `.env` **не нужен**: ключ и лимиты подаёт job `deploy` из Gitea Secrets/Variables, legacy-`.env` на проде удаляется деплоем|
|`.gitea/workflows/`|Gitea Actions: `pr.yml` (PR checks), `main.yml` (тесты + coverage-сводка/артефакты JaCoCo → `images-app`/`images-web` (build+push в Nexus) → deploy (рендер прод-конфигов + pull) → autotests → rollback)| |`.gitea/workflows/`|Gitea Actions: `pr.yml` (PR checks), `main.yml` (тесты + coverage-сводка и комментарий в PR → `images-app`/`images-web` (build+push в Nexus) → deploy (рендер прод-конфигов + pull) → autotests → rollback)|
|корневой `GITEA-vars.md`|инструкция владельца: Secrets/Variables, защита ветки, перезапуск — только имена переменных, без значений| |корневой `GITEA-vars.md`|инструкция владельца: Secrets/Variables, защита ветки, перезапуск — только имена переменных, без значений|
|корневой `prod-autotests/`|прод-автотесты API (pytest + requests, 21 проверка): конфигурация стенда **только env** (`WORDPDF_BASE_URL` обязателен, `WORDPDF_API_KEY`/`WORDPDF_MAX_PAGES`/`WORDPDF_MAX_MB`/`WORDPDF_SAMPLES_DIR` факультативны) — прод-хостов/ключей в коде нет; окружение — mise (`mise.toml`: python 3.15 + автосоздаваемый `.venv`); прод-раннер вне git — `/home/pjandro/prod/java-word-pdf/run-prod-tests.sh`| |корневой `prod-autotests/`|прод-автотесты API (pytest + requests, 21 проверка): конфигурация стенда **только env** (`WORDPDF_BASE_URL` обязателен, `WORDPDF_API_KEY`/`WORDPDF_MAX_PAGES`/`WORDPDF_MAX_MB`/`WORDPDF_SAMPLES_DIR` факультативны) — прод-хостов/ключей в коде нет; окружение — mise (`mise.toml`: python 3.15 + автосоздаваемый `.venv`); прод-раннер вне git — `/home/pjandro/prod/java-word-pdf/run-prod-tests.sh`|
|`develop/` (вне git, gitignored)|рабочие материалы и эталоны Word для ручного сравнения — **не фикстуры**, в тесты/jar не подключать; на 2026-10 директория пуста (эталоны вынесены, пиксельные замеры зашиты числами в chart-тестах)| |`develop/` (вне git, gitignored)|рабочие материалы и эталоны Word для ручного сравнения — **не фикстуры**, в тесты/jar не подключать; на 2026-10 директория пуста (эталоны вынесены, пиксельные замеры зашиты числами в chart-тестах)|
@@ -91,11 +91,15 @@ java -cp wordpdf-core/target/test-classes:$(cat /tmp/cp.txt) \
Два workflow. `.gitea/workflows/pr.yml` — `PR checks` (`pull_request` + `workflow_dispatch`): Два workflow. `.gitea/workflows/pr.yml` — `PR checks` (`pull_request` + `workflow_dispatch`):
job `java` (temurin 21, кеш `~/.m2` через `actions/cache`, Maven 3.9.16 ставится вручную с dlcdn, `mvn -B clean verify`, job `java` (temurin 21, кеш `~/.m2` через `actions/cache`, Maven 3.9.16 ставится вручную с dlcdn, `mvn -B clean verify`,
затем `Coverage summary` — разбор `target/site/jacoco/jacoco.xml` python-сниппетом в лог job'а и затем `Coverage summary` — разбор `target/site/jacoco/jacoco.xml` python-сниппетом в файл
`Pack coverage reports` (python3 `zipfile` — один `jacoco-html.zip`) и `actions/upload-artifact@v3` `coverage-summary.md` + step summary job'а и `Comment coverage on PR` — тот же текст
артефактом `jacoco-html`; именно v3 и именно один zip — артефакт-сервер Gitea не понимает протокол комментарием в PR (создаётся один раз, повторные push обновляют по маркеру
v4 («not currently supported on GHES»), а v1 грузит каждый файл отдельным запросом (~150 HTML-файлов `<!-- jacoco-coverage -->`; `continue-on-error` — падение комментария не валит job;
поштучно = минуты простоя)) в `main.yml` шаг продублирован байт-в-байт, но `if: github.event_name == 'pull_request'`
там не срабатывает). **Артефактов покрытия нет намеренно**: `upload-artifact@v4` Gitea
не поддерживает («not currently supported on GHES»), `@v3` на этом стенде зависает на
загрузке (проверено: отменена и с ~150 файлов, и с одним zip); HTML-отчёт — локально
`target/site/jacoco/`)
и `web` (кеш `~/.npm`, `npm ci`/`build`/`lint`). `.gitea/workflows/main.yml` — `Main: tests, и `web` (кеш `~/.npm`, `npm ci`/`build`/`lint`). `.gitea/workflows/main.yml` — `Main: tests,
deploy, autotests` (`push` в `main` + `workflow_dispatch`): те же `java`/`web` (байт-в-байт deploy, autotests` (`push` в `main` + `workflow_dispatch`): те же `java`/`web` (байт-в-байт
дубль — файлы самодостаточны, reusable-workflow не вводить), затем `images-app`/`images-web` дубль — файлы самодостаточны, reusable-workflow не вводить), затем `images-app`/`images-web`